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

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

130
docs/content/references/services/classes/DraftOrderService.md
View File

@@ -1,5 +1,9 @@
# Class: DraftOrderService
Handles draft orders
**`Implements`**
## Hierarchy
- `TransactionBaseService`<[`DraftOrderService`](DraftOrderService.md)\>
@@ -24,7 +28,7 @@ TransactionBaseService&lt;DraftOrderService\&gt;.constructor
#### Defined in
[services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L51)
[packages/medusa/src/services/draft-order.ts:51](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L51)
## Properties
@@ -34,7 +38,7 @@ TransactionBaseService&lt;DraftOrderService\&gt;.constructor
#### Defined in
[services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L46)
[packages/medusa/src/services/draft-order.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L46)
___
@@ -46,6 +50,10 @@ ___
TransactionBaseService.configModule
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### container
@@ -56,6 +64,10 @@ ___
TransactionBaseService.container
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:12](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L12)
___
### draftOrderRepository\_
@@ -64,7 +76,7 @@ ___
#### Defined in
[services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L42)
[packages/medusa/src/services/draft-order.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L42)
___
@@ -74,7 +86,7 @@ ___
#### Defined in
[services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L45)
[packages/medusa/src/services/draft-order.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L45)
___
@@ -84,7 +96,7 @@ ___
#### Defined in
[services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L47)
[packages/medusa/src/services/draft-order.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L47)
___
@@ -98,7 +110,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L39)
[packages/medusa/src/services/draft-order.ts:39](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L39)
___
@@ -108,7 +120,7 @@ ___
#### Defined in
[services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L44)
[packages/medusa/src/services/draft-order.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L44)
___
@@ -118,7 +130,7 @@ ___
#### Defined in
[services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L43)
[packages/medusa/src/services/draft-order.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L43)
___
@@ -128,7 +140,7 @@ ___
#### Defined in
[services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L48)
[packages/medusa/src/services/draft-order.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L48)
___
@@ -138,7 +150,7 @@ ___
#### Defined in
[services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L49)
[packages/medusa/src/services/draft-order.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L49)
___
@@ -152,7 +164,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L40)
[packages/medusa/src/services/draft-order.ts:40](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L40)
___
@@ -169,7 +181,7 @@ ___
#### Defined in
[services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L34)
[packages/medusa/src/services/draft-order.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L34)
## Methods
@@ -177,6 +189,10 @@ ___
▸ `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 |
@@ -188,21 +204,23 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `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/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[packages/medusa/src/interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -210,19 +228,23 @@ ___
▸ **create**(`data`): `Promise`<`DraftOrder`\>
Creates a draft order.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `AdminPostDraftOrdersReq` | |
| `data` | `AdminPostDraftOrdersReq` | data to create draft order from |
#### Returns
`Promise`<`DraftOrder`\>
the created draft order
#### Defined in
[services/draft-order.ts:257](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L257)
[packages/medusa/src/services/draft-order.ts:245](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L245)
___
@@ -230,19 +252,23 @@ ___
▸ **delete**(`draftOrderId`): `Promise`<`undefined` \| `DraftOrder`\>
Deletes draft order idempotently.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `draftOrderId` | `string` | |
| `draftOrderId` | `string` | id of draft order to delete |
#### Returns
`Promise`<`undefined` \| `DraftOrder`\>
empty promise
#### Defined in
[services/draft-order.ts:150](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L150)
[packages/medusa/src/services/draft-order.ts:144](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L144)
___
@@ -250,20 +276,24 @@ ___
▸ **list**(`selector`, `config?`): `Promise`<`DraftOrder`[]\>
Lists draft orders
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `FindConfig`<`DraftOrder`\> | |
| `selector` | `any` | query object for find |
| `config` | `FindConfig`<`DraftOrder`\> | configurable attributes for find |
#### Returns
`Promise`<`DraftOrder`[]\>
list of draft orders
#### Defined in
[services/draft-order.ts:231](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L231)
[packages/medusa/src/services/draft-order.ts:222](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L222)
___
@@ -271,20 +301,24 @@ ___
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`DraftOrder`[], `number`]\>
Lists draft orders alongside the count
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `FindConfig`<`DraftOrder`\> | |
| `selector` | `any` | query selector to filter draft orders |
| `config` | `FindConfig`<`DraftOrder`\> | query config |
#### Returns
`Promise`<[`DraftOrder`[], `number`]\>
draft orders
#### Defined in
[services/draft-order.ts:174](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L174)
[packages/medusa/src/services/draft-order.ts:168](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L168)
___
@@ -292,20 +326,24 @@ ___
▸ **registerCartCompletion**(`draftOrderId`, `orderId`): `Promise`<`UpdateResult`\>
Registers a draft order as completed, when an order has been completed.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `draftOrderId` | `string` | |
| `orderId` | `string` | |
| `draftOrderId` | `string` | id of draft order to complete |
| `orderId` | `string` | id of order completed from draft order cart |
#### Returns
`Promise`<`UpdateResult`\>
the created order
#### Defined in
[services/draft-order.ts:363](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L363)
[packages/medusa/src/services/draft-order.ts:351](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L351)
___
@@ -313,20 +351,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`DraftOrder`\>
Retrieves a draft order with the given id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`DraftOrder`\> | |
| `id` | `string` | id of the draft order to retrieve |
| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |
#### Returns
`Promise`<`DraftOrder`\>
the draft order
#### Defined in
[services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L91)
[packages/medusa/src/services/draft-order.ts:91](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L91)
___
@@ -334,20 +376,24 @@ ___
▸ **retrieveByCartId**(`cartId`, `config?`): `Promise`<`DraftOrder`\>
Retrieves a draft order based on its associated cart id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cartId` | `string` | |
| `config` | `FindConfig`<`DraftOrder`\> | |
| `cartId` | `string` | cart id that the draft orders's cart has |
| `config` | `FindConfig`<`DraftOrder`\> | query object for findOne |
#### Returns
`Promise`<`DraftOrder`\>
the draft order
#### Defined in
[services/draft-order.ts:121](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L121)
[packages/medusa/src/services/draft-order.ts:118](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L118)
___
@@ -371,7 +417,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[packages/medusa/src/interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -379,21 +425,25 @@ ___
▸ **update**(`id`, `data`): `Promise`<`DraftOrder`\>
Updates a draft order with the given data
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `data` | `Object` | |
| `id` | `string` | id of the draft order |
| `data` | `Object` | values to update the order with |
| `data.no_notification_order` | `boolean` | - |
#### Returns
`Promise`<`DraftOrder`\>
the updated draft order
#### Defined in
[services/draft-order.ts:392](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/draft-order.ts#L392)
[packages/medusa/src/services/draft-order.ts:380](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/draft-order.ts#L380)
___
@@ -417,4 +467,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[packages/medusa/src/interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/interfaces/transaction-base-service.ts#L16)