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

116
docs/content/references/services/classes/ClaimService.md
View File

@@ -27,7 +27,7 @@ TransactionBaseService<
#### Defined in
[services/claim.ts:85](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L85)
[packages/medusa/src/services/claim.ts:85](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L85)
## Properties
@@ -37,7 +37,7 @@ TransactionBaseService<
#### Defined in
[services/claim.ts:68](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L68)
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L68)
___
@@ -47,7 +47,7 @@ ___
#### Defined in
[services/claim.ts:72](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L72)
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L72)
___
@@ -57,7 +57,7 @@ ___
#### Defined in
[services/claim.ts:69](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L69)
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L69)
___
@@ -69,6 +69,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
@@ -79,6 +83,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)
___
### eventBus\_
@@ -87,7 +95,7 @@ ___
#### Defined in
[services/claim.ts:73](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L73)
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L73)
___
@@ -97,7 +105,7 @@ ___
#### Defined in
[services/claim.ts:74](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L74)
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L74)
___
@@ -107,7 +115,7 @@ ___
#### Defined in
[services/claim.ts:75](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L75)
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L75)
___
@@ -117,7 +125,7 @@ ___
#### Defined in
[services/claim.ts:76](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L76)
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L76)
___
@@ -127,7 +135,7 @@ ___
#### Defined in
[services/claim.ts:71](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L71)
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L71)
___
@@ -137,7 +145,7 @@ ___
#### Defined in
[services/claim.ts:77](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L77)
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L77)
___
@@ -151,7 +159,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/claim.ts:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L65)
[packages/medusa/src/services/claim.ts:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L65)
___
@@ -161,7 +169,7 @@ ___
#### Defined in
[services/claim.ts:78](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L78)
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L78)
___
@@ -171,7 +179,7 @@ ___
#### Defined in
[services/claim.ts:79](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L79)
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L79)
___
@@ -181,7 +189,7 @@ ___
#### Defined in
[services/claim.ts:80](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L80)
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L80)
___
@@ -191,7 +199,7 @@ ___
#### Defined in
[services/claim.ts:70](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L70)
[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L70)
___
@@ -201,7 +209,7 @@ ___
#### Defined in
[services/claim.ts:81](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L81)
[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L81)
___
@@ -211,7 +219,7 @@ ___
#### Defined in
[services/claim.ts:82](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L82)
[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L82)
___
@@ -221,7 +229,7 @@ ___
#### Defined in
[services/claim.ts:83](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L83)
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L83)
___
@@ -235,7 +243,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/claim.ts:66](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L66)
[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L66)
___
@@ -256,7 +264,7 @@ ___
#### Defined in
[services/claim.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L56)
[packages/medusa/src/services/claim.ts:56](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L56)
## Methods
@@ -264,6 +272,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 |
@@ -275,21 +287,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)
___
@@ -309,7 +323,7 @@ ___
#### Defined in
[services/claim.ts:753](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L753)
[packages/medusa/src/services/claim.ts:753](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L753)
___
@@ -329,7 +343,7 @@ ___
#### Defined in
[services/claim.ts:602](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L602)
[packages/medusa/src/services/claim.ts:602](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L602)
___
@@ -337,19 +351,25 @@ ___
▸ **create**(`data`): `Promise`<`ClaimOrder`\>
Creates a Claim on an Order. Claims consists of items that are claimed and
optionally items to be sent as replacement for the claimed items. The
shipping address that the new items will be shipped to
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `data` | `CreateClaimInput` | |
| `data` | `CreateClaimInput` | the object containing all data required to create a claim |
#### Returns
`Promise`<`ClaimOrder`\>
created claim
#### Defined in
[services/claim.ts:217](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L217)
[packages/medusa/src/services/claim.ts:217](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L217)
___
@@ -361,18 +381,20 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `Object` | |
| `config.metadata?` | `Record`<`string`, `unknown`\> | |
| `config.no_notification?` | `boolean` | |
| `id` | `string` | the object containing all data required to create a claim |
| `config` | `Object` | config object |
| `config.metadata?` | `Record`<`string`, `unknown`\> | config metadata |
| `config.no_notification?` | `boolean` | config no notification |
#### Returns
`Promise`<`ClaimOrder`\>
created claim
#### Defined in
[services/claim.ts:456](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L456)
[packages/medusa/src/services/claim.ts:456](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L456)
___
@@ -397,7 +419,7 @@ ___
#### Defined in
[services/claim.ts:674](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L674)
[packages/medusa/src/services/claim.ts:674](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L674)
___
@@ -409,16 +431,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `FindConfig`<`ClaimOrder`\> | |
| `selector` | `any` | the query object for find |
| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings |
#### Returns
`Promise`<`ClaimOrder`[]\>
the result of the find operation
#### Defined in
[services/claim.ts:809](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L809)
[packages/medusa/src/services/claim.ts:809](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L809)
___
@@ -438,7 +462,7 @@ ___
#### Defined in
[services/claim.ts:628](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L628)
[packages/medusa/src/services/claim.ts:628](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L628)
___
@@ -446,20 +470,24 @@ ___
▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimOrder`\>
Gets an order by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | |
| `config` | `FindConfig`<`ClaimOrder`\> | |
| `id` | `string` | id of the claim order to retrieve |
| `config` | `FindConfig`<`ClaimOrder`\> | the config object containing query settings |
#### Returns
`Promise`<`ClaimOrder`\>
the order document
#### Defined in
[services/claim.ts:834](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L834)
[packages/medusa/src/services/claim.ts:829](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L829)
___
@@ -483,7 +511,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)
___
@@ -504,7 +532,7 @@ ___
#### Defined in
[services/claim.ts:127](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/claim.ts#L127)
[packages/medusa/src/services/claim.ts:127](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/claim.ts#L127)
___
@@ -528,4 +556,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)