docs: updated services reference (#1809)

2022-07-06 17:11:05 +03:00
parent ae5c88b891
commit 5f6107e505
45 changed files with 4374 additions and 1479 deletions
--- a/docs/content/references/services/classes/DraftOrderService.md
+++ b/docs/content/references/services/classes/DraftOrderService.md
@@ -6,7 +6,7 @@ Handles draft orders

 ## Hierarchy

- `"medusa-interfaces"`
+- `TransactionBaseService`<[`DraftOrderService`](DraftOrderService.md)\>

  ↳ **`DraftOrderService`**

@@ -20,21 +20,149 @@ Handles draft orders

 | Name | Type |
 | :------ | :------ |
-| `__namedParameters` | `Object` |
+| `__namedParameters` | `InjectedDependencies` |

 #### Overrides

-BaseService.constructor
+TransactionBaseService&lt;DraftOrderService\&gt;.constructor

 #### Defined in

-[services/draft-order.js:15](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L15)
+[services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L51)

 ## Properties

+### cartService\_
+
+• `Protected` `Readonly` **cartService\_**: [`CartService`](CartService.md)
+
+#### Defined in
+
+[services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L46)
+
+___
+
+### configModule
+
+• `Protected` `Optional` `Readonly` **configModule**: `Record`<`string`, `unknown`\>
+
+#### Inherited from
+
+TransactionBaseService.configModule
+
+___
+
+### container
+
+• `Protected` `Readonly` **container**: `unknown`
+
+#### Inherited from
+
+TransactionBaseService.container
+
+___
+
+### draftOrderRepository\_
+
+• `Protected` `Readonly` **draftOrderRepository\_**: typeof `DraftOrderRepository`
+
+#### Defined in
+
+[services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L42)
+
+___
+
+### eventBus\_
+
+• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
+
+#### Defined in
+
+[services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L45)
+
+___
+
+### lineItemService\_
+
+• `Protected` `Readonly` **lineItemService\_**: [`LineItemService`](LineItemService.md)
+
+#### Defined in
+
+[services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L47)
+
+___
+
+### manager\_
+
+• `Protected` **manager\_**: `EntityManager`
+
+#### Overrides
+
+TransactionBaseService.manager\_
+
+#### Defined in
+
+[services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L39)
+
+___
+
+### orderRepository\_
+
+• `Protected` `Readonly` **orderRepository\_**: typeof `OrderRepository`
+
+#### Defined in
+
+[services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L44)
+
+___
+
+### paymentRepository\_
+
+• `Protected` `Readonly` **paymentRepository\_**: typeof `PaymentRepository`
+
+#### Defined in
+
+[services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L43)
+
+___
+
+### productVariantService\_
+
+• `Protected` `Readonly` **productVariantService\_**: [`ProductVariantService`](ProductVariantService.md)
+
+#### Defined in
+
+[services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L48)
+
+___
+
+### shippingOptionService\_
+
+• `Protected` `Readonly` **shippingOptionService\_**: [`ShippingOptionService`](ShippingOptionService.md)
+
+#### Defined in
+
+[services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L49)
+
+___
+
+### transactionManager\_
+
+• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
+
+#### Overrides
+
+TransactionBaseService.transactionManager\_
+
+#### Defined in
+
+[services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L40)
+
+___
+
 ### Events

-▪ `Static` **Events**: `Object`
+▪ `Static` `Readonly` **Events**: `Object`

 #### Type declaration

@@ -45,10 +173,49 @@ BaseService.constructor

 #### Defined in

-[services/draft-order.js:10](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L10)
+[services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L34)

 ## Methods

+### atomicPhase\_
+
+▸ `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` |
+
+#### Parameters
+
+| Name | Type | 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 |
+
+#### Returns
+
+`Promise`<`TResult`\>
+
+the result of the transactional work
+
+#### Inherited from
+
+TransactionBaseService.atomicPhase\_
+
+#### Defined in
+
+[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
+
+___
+
 ### create

 ▸ **create**(`data`): `Promise`<`DraftOrder`\>
@@ -59,7 +226,7 @@ Creates a draft order.

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `data` | `any` | data to create draft order from |
+| `data` | `AdminPostDraftOrdersReq` | data to create draft order from |

 #### Returns

@@ -69,13 +236,13 @@ the created draft order

 #### Defined in

-[services/draft-order.js:233](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L233)
+[services/draft-order.ts:257](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L257)

 ___

 ### delete

-▸ **delete**(`draftOrderId`): `Promise`<`any`\>
+▸ **delete**(`draftOrderId`): `Promise`<`undefined` \| `DraftOrder`\>

 Deletes draft order idempotently.

@@ -87,19 +254,19 @@ Deletes draft order idempotently.

 #### Returns

-`Promise`<`any`\>
+`Promise`<`undefined` \| `DraftOrder`\>

 empty promise

 #### Defined in

-[services/draft-order.js:135](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L135)
+[services/draft-order.ts:150](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L150)

 ___

 ### list

-▸ **list**(`selector`, `config?`): `Promise`<`DraftOrder`\>
+▸ **list**(`selector`, `config?`): `Promise`<`DraftOrder`[]\>

 Lists draft orders

@@ -108,23 +275,23 @@ Lists draft orders
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `selector` | `any` | query object for find |
-| `config` | `any` | configurable attributes for find |
+| `config` | `FindConfig`<`DraftOrder`\> | configurable attributes for find |

 #### Returns

-`Promise`<`DraftOrder`\>
+`Promise`<`DraftOrder`[]\>

 list of draft orders

 #### Defined in

-[services/draft-order.js:215](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L215)
+[services/draft-order.ts:231](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L231)

 ___

 ### listAndCount

-▸ **listAndCount**(`selector`, `config?`): `Promise`<`DraftOrder`[]\>
+▸ **listAndCount**(`selector`, `config?`): `Promise`<[`DraftOrder`[], `number`]\>

 Lists draft orders alongside the count

@@ -133,23 +300,23 @@ Lists draft orders alongside the count
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `selector` | `any` | query selector to filter draft orders |
-| `config` | `any` | query config |
+| `config` | `FindConfig`<`DraftOrder`\> | query config |

 #### Returns

-`Promise`<`DraftOrder`[]\>
+`Promise`<[`DraftOrder`[], `number`]\>

 draft orders

 #### Defined in

-[services/draft-order.js:161](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L161)
+[services/draft-order.ts:174](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L174)

 ___

 ### registerCartCompletion

-▸ **registerCartCompletion**(`doId`, `orderId`): `Promise`<`any`\>
+▸ **registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\>

 Registers a draft order as completed, when an order has been completed.

@@ -157,18 +324,18 @@ Registers a draft order as completed, when an order has been completed.

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `doId` | `string` | id of draft order to complete |
+| `draftOrderId` | `string` | id of draft order to complete |
 | `orderId` | `string` | id of order completed from draft order cart |

 #### Returns

-`Promise`<`any`\>
+`Promise`<`UpdateResult`\>

 the created order

 #### Defined in

-[services/draft-order.js:336](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L336)
+[services/draft-order.ts:363](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L363)

 ___

@@ -183,7 +350,7 @@ Retrieves a draft order with the given id.
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `id` | `string` | id of the draft order to retrieve |
-| `config` | `any` | query object for findOne |
+| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |

 #### Returns

@@ -193,7 +360,7 @@ the draft order

 #### Defined in

-[services/draft-order.js:84](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L84)
+[services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L91)

 ___

@@ -208,7 +375,7 @@ Retrieves a draft order based on its associated cart id
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `cartId` | `string` | cart id that the draft orders's cart has |
-| `config` | `any` | query object for findOne |
+| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |

 #### Returns

@@ -218,13 +385,37 @@ the draft order

 #### Defined in

-[services/draft-order.js:111](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L111)
+[services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L121)
+
+___
+
+### shouldRetryTransaction\_
+
+▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string`  } |
+
+#### Returns
+
+`boolean`
+
+#### Inherited from
+
+TransactionBaseService.shouldRetryTransaction\_
+
+#### Defined in
+
+[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L34)

 ___

 ### update

-▸ **update**(`doId`, `data`): `Promise`<`DraftOrder`\>
+▸ **update**(`id`, `data`): `Promise`<`DraftOrder`\>

 Updates a draft order with the given data

@@ -232,8 +423,9 @@ Updates a draft order with the given data

 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `doId` | `string` | id of the draft order |
-| `data` | `DraftOrder` | values to update the order with |
+| `id` | `string` | id of the draft order |
+| `data` | `Object` | values to update the order with |
+| `data.no_notification_order` | `boolean` | - |

 #### Returns

@@ -243,24 +435,28 @@ the updated draft order

 #### Defined in

-[services/draft-order.js:357](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L357)
+[services/draft-order.ts:392](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/draft-order.ts#L392)

 ___

 ### withTransaction

-▸ **withTransaction**(`transactionManager`): [`DraftOrderService`](DraftOrderService.md)
+▸ **withTransaction**(`transactionManager?`): [`DraftOrderService`](DraftOrderService.md)

 #### Parameters

 | Name | Type |
 | :------ | :------ |
-| `transactionManager` | `any` |
+| `transactionManager?` | `EntityManager` |

 #### Returns

 [`DraftOrderService`](DraftOrderService.md)

+#### Inherited from
+
+TransactionBaseService.withTransaction
+
 #### Defined in

-[services/draft-order.js:56](https://github.com/medusajs/medusa/blob/2d3e404f/packages/medusa/src/services/draft-order.js#L56)
+[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L16)