asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5516)

Browse Source 
Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-02 09:16:47 +00:00
committed by GitHub
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions
Download Patch File Download Diff File Expand all files Collapse all files

210
www/apps/docs/content/references/services/classes/DraftOrderService.md
View File

@@ -1,8 +1,8 @@
# Class: DraftOrderService
# DraftOrderService
Handles draft orders
**`Implements`**
**Implements**
## Hierarchy
@@ -14,12 +14,12 @@ Handles draft orders
### constructor
• **new DraftOrderService**(`«destructured»`)
**new DraftOrderService**(`«destructured»`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `«destructured»` | `InjectedDependencies` |
#### Overrides
@@ -28,13 +28,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/draft-order.ts:67](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L67)
[medusa/src/services/draft-order.ts:67](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L67)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -42,13 +42,13 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
`Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
@@ -56,13 +56,13 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -70,63 +70,63 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### cartService\_
• `Protected` `Readonly` **cartService\_**: [`CartService`](CartService.md)
`Protected` `Readonly` **cartService\_**: [`CartService`](CartService.md)
#### Defined in
[medusa/src/services/draft-order.ts:61](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L61)
[medusa/src/services/draft-order.ts:61](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L61)
___
### customShippingOptionService\_
• `Protected` `Readonly` **customShippingOptionService\_**: [`CustomShippingOptionService`](CustomShippingOptionService.md)
`Protected` `Readonly` **customShippingOptionService\_**: [`CustomShippingOptionService`](CustomShippingOptionService.md)
#### Defined in
[medusa/src/services/draft-order.ts:65](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L65)
[medusa/src/services/draft-order.ts:65](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L65)
___
### draftOrderRepository\_
• `Protected` `Readonly` **draftOrderRepository\_**: `Repository`<`DraftOrder`\>
`Protected` `Readonly` **draftOrderRepository\_**: `Repository`<`DraftOrder`\>
#### Defined in
[medusa/src/services/draft-order.ts:57](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L57)
[medusa/src/services/draft-order.ts:57](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L57)
___
### eventBus\_
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
`Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[medusa/src/services/draft-order.ts:60](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L60)
[medusa/src/services/draft-order.ts:60](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L60)
___
### lineItemService\_
• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md)
`Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md)
#### Defined in
[medusa/src/services/draft-order.ts:62](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L62)
[medusa/src/services/draft-order.ts:62](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L62)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -134,53 +134,53 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### orderRepository\_
• `Protected` `Readonly` **orderRepository\_**: `Repository`<`Order`\> & { `findOneWithRelations`: (`relations`: `FindOptionsRelations`<`Order`\>, `optionsWithoutRelations`: `Omit`<`FindManyOptions`<`Order`\>, ``"relations"``\>) => `Promise`<`Order`\> ; `findWithRelations`: (`relations`: `FindOptionsRelations`<`Order`\>, `optionsWithoutRelations`: `Omit`<`FindManyOptions`<`Order`\>, ``"relations"``\>) => `Promise`<`Order`[]\> }
`Protected` `Readonly` **orderRepository\_**: `Repository`<`Order`\> & { `findOneWithRelations`: Method findOneWithRelations ; `findWithRelations`: Method findWithRelations }
#### Defined in
[medusa/src/services/draft-order.ts:59](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L59)
[medusa/src/services/draft-order.ts:59](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L59)
___
### paymentRepository\_
• `Protected` `Readonly` **paymentRepository\_**: `Repository`<`Payment`\>
`Protected` `Readonly` **paymentRepository\_**: `Repository`<`Payment`\>
#### Defined in
[medusa/src/services/draft-order.ts:58](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L58)
[medusa/src/services/draft-order.ts:58](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L58)
___
### productVariantService\_
• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](ProductVariantService.md)
`Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](ProductVariantService.md)
#### Defined in
[medusa/src/services/draft-order.ts:63](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L63)
[medusa/src/services/draft-order.ts:63](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L63)
___
### shippingOptionService\_
• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
`Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
#### Defined in
[medusa/src/services/draft-order.ts:64](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L64)
[medusa/src/services/draft-order.ts:64](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L64)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -188,13 +188,13 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
### Events
▪ `Static` `Readonly` **Events**: `Object`
`Static` `Readonly` **Events**: `Object`
#### Type declaration
@@ -205,47 +205,47 @@ ___
#### Defined in
[medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L52)
[medusa/src/services/draft-order.ts:52](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L52)
## Accessors
### activeManager\_
• `Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
-`EntityManager`:
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
| `TResult` | `object` |
| `TError` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
@@ -254,7 +254,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -262,68 +262,70 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### create
▸ **create**(`data`): `Promise`<`DraftOrder`\>
**create**(`data`): `Promise`<`DraftOrder`\>
Creates a draft order.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `data` | `DraftOrderCreateProps` | data to create draft order from |
#### Returns
`Promise`<`DraftOrder`\>
the created draft order
-`Promise`: the created draft order
-`DraftOrder`:
#### Defined in
[medusa/src/services/draft-order.ts:260](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L260)
[medusa/src/services/draft-order.ts:260](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L260)
___
### delete
▸ **delete**(`draftOrderId`): `Promise`<`undefined` \| `DraftOrder`\>
**delete**(`draftOrderId`): `Promise`<`undefined` \| `DraftOrder`\>
Deletes draft order idempotently.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `draftOrderId` | `string` | id of draft order to delete |
#### Returns
`Promise`<`undefined` \| `DraftOrder`\>
empty promise
-`Promise`: empty promise
-`undefined \| DraftOrder`: (optional)
#### Defined in
[medusa/src/services/draft-order.ts:156](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L156)
[medusa/src/services/draft-order.ts:156](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L156)
___
### list
▸ **list**(`selector`, `config?`): `Promise`<`DraftOrder`[]\>
**list**(`selector`, `config?`): `Promise`<`DraftOrder`[]\>
Lists draft orders
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selector` | `any` | query object for find |
| `config` | `FindConfig`<`DraftOrder`\> | configurable attributes for find |
@@ -331,24 +333,26 @@ Lists draft orders
`Promise`<`DraftOrder`[]\>
list of draft orders
-`Promise`: list of draft orders
-`DraftOrder[]`:
-`DraftOrder`:
#### Defined in
[medusa/src/services/draft-order.ts:238](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L238)
[medusa/src/services/draft-order.ts:238](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L238)
___
### listAndCount
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`DraftOrder`[], `number`]\>
**listAndCount**(`selector`, `config?`): `Promise`<[`DraftOrder`[], `number`]\>
Lists draft orders alongside the count
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selector` | `any` | query selector to filter draft orders |
| `config` | `FindConfig`<`DraftOrder`\> | query config |
@@ -356,24 +360,26 @@ Lists draft orders alongside the count
`Promise`<[`DraftOrder`[], `number`]\>
draft orders
-`Promise`: draft orders
-`DraftOrder[]`:
-`number`: (optional)
#### Defined in
[medusa/src/services/draft-order.ts:180](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L180)
[medusa/src/services/draft-order.ts:180](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L180)
___
### registerCartCompletion
▸ **registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\>
**registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\>
Registers a draft order as completed, when an order has been completed.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `draftOrderId` | `string` | id of draft order to complete |
| `orderId` | `string` | id of order completed from draft order cart |
@@ -381,24 +387,25 @@ Registers a draft order as completed, when an order has been completed.
`Promise`<`UpdateResult`\>
the created order
-`Promise`: the created order
-`UpdateResult`:
#### Defined in
[medusa/src/services/draft-order.ts:420](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L420)
[medusa/src/services/draft-order.ts:420](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L420)
___
### retrieve
▸ **retrieve**(`draftOrderId`, `config?`): `Promise`<`DraftOrder`\>
**retrieve**(`draftOrderId`, `config?`): `Promise`<`DraftOrder`\>
Retrieves a draft order with the given id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `draftOrderId` | `string` | id of the draft order to retrieve |
| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |
@@ -406,24 +413,25 @@ Retrieves a draft order with the given id.
`Promise`<`DraftOrder`\>
the draft order
-`Promise`: the draft order
-`DraftOrder`:
#### Defined in
[medusa/src/services/draft-order.ts:98](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L98)
[medusa/src/services/draft-order.ts:98](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L98)
___
### retrieveByCartId
▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<`DraftOrder`\>
**retrieveByCartId**(`cartId`, `config?`): `Promise`<`DraftOrder`\>
Retrieves a draft order based on its associated cart id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `cartId` | `string` | cart id that the draft orders's cart has |
| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |
@@ -431,82 +439,88 @@ Retrieves a draft order based on its associated cart id
`Promise`<`DraftOrder`\>
the draft order
-`Promise`: the draft order
-`DraftOrder`:
#### Defined in
[medusa/src/services/draft-order.ts:131](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L131)
[medusa/src/services/draft-order.ts:131](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L131)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
| Name |
| :------ |
| `err` | Record<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
-`boolean`: (optional)
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### update
▸ **update**(`id`, `data`): `Promise`<`DraftOrder`\>
**update**(`id`, `data`): `Promise`<`DraftOrder`\>
Updates a draft order with the given data
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `id` | `string` | id of the draft order |
| `data` | `Object` | values to update the order with |
| `data.no_notification_order` | `boolean` | - |
| `data` | `object` | values to update the order with |
| `data.no_notification_order` | `boolean` |
#### Returns
`Promise`<`DraftOrder`\>
the updated draft order
-`Promise`: the updated draft order
-`DraftOrder`:
#### Defined in
[medusa/src/services/draft-order.ts:449](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/draft-order.ts#L449)
[medusa/src/services/draft-order.ts:449](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/draft-order.ts#L449)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`DraftOrderService`](DraftOrderService.md)
**withTransaction**(`transactionManager?`): [`DraftOrderService`](DraftOrderService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`DraftOrderService`](DraftOrderService.md)
-`DraftOrderService`:
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L20)