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

chore(docs): Generated Services Reference (automated) (#2891)

Browse Source 
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-12-23 10:20:47 +02:00
committed by GitHub
parent 8cbd627fb7
commit a32a2c4cf1
56 changed files with 2165 additions and 1675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/content/references/services/classes/ClaimItemService.md
View File

@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L30)
[packages/medusa/src/services/claim-item.ts:30](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L30)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
___
@@ -62,7 +62,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L25)
[packages/medusa/src/services/claim-item.ts:25](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L25)
___
@@ -72,7 +72,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L23)
[packages/medusa/src/services/claim-item.ts:23](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L23)
___
@@ -82,7 +82,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L24)
[packages/medusa/src/services/claim-item.ts:24](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L24)
___
@@ -92,7 +92,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L22)
[packages/medusa/src/services/claim-item.ts:22](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L22)
___
@@ -102,7 +102,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L21)
[packages/medusa/src/services/claim-item.ts:21](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L21)
___
@@ -116,7 +116,7 @@ TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L27)
[packages/medusa/src/services/claim-item.ts:27](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L27)
___
@@ -130,7 +130,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L28)
[packages/medusa/src/services/claim-item.ts:28](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L28)
___
@@ -148,7 +148,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L15)
[packages/medusa/src/services/claim-item.ts:15](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L15)
## Methods
@@ -187,7 +187,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
___
@@ -207,7 +207,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L49)
[packages/medusa/src/services/claim-item.ts:49](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L49)
___
@@ -230,13 +230,13 @@ the result of the find operation
#### Defined in
[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L214)
[packages/medusa/src/services/claim-item.ts:214](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L214)
___
### retrieve
▸ **retrieve**(`id`, `config?`): `Promise`<`ClaimItem`\>
▸ **retrieve**(`claimItemId`, `config?`): `Promise`<`ClaimItem`\>
Gets a claim item by id.
@@ -244,7 +244,7 @@ Gets a claim item by id.
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of ClaimItem to retrieve |
| `claimItemId` | `string` | id of ClaimItem to retrieve |
| `config` | `FindConfig`<`ClaimItem`\> | configuration for the find operation |
#### Returns
@@ -255,7 +255,7 @@ the ClaimItem
#### Defined in
[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L233)
[packages/medusa/src/services/claim-item.ts:233](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L233)
___
@@ -279,7 +279,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
___
@@ -300,7 +300,7 @@ ___
#### Defined in
[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/claim-item.ts#L132)
[packages/medusa/src/services/claim-item.ts:132](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/claim-item.ts#L132)
___
@@ -324,4 +324,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/interfaces/transaction-base-service.ts#L13)