chore(docs): Generated Services Reference (automated) (#3261)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
4fb22e8ba5
commit
ef148cb9f4
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L84)
|
||||
[packages/medusa/src/services/claim.ts:89](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L89)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/1bfbe27b9/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/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:66](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L66)
|
||||
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L71)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:70](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L70)
|
||||
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L75)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:67](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L67)
|
||||
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L72)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +106,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:71](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L71)
|
||||
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L76)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +116,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:72](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L72)
|
||||
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L77)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +126,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L73)
|
||||
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L78)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +136,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L69)
|
||||
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L74)
|
||||
|
||||
___
|
||||
|
||||
@@ -146,7 +146,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:74](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L74)
|
||||
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L79)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +160,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:63](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L63)
|
||||
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L68)
|
||||
|
||||
___
|
||||
|
||||
@@ -170,7 +170,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:75](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L75)
|
||||
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L80)
|
||||
|
||||
___
|
||||
|
||||
@@ -180,7 +180,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L82)
|
||||
[packages/medusa/src/services/claim.ts:87](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L87)
|
||||
|
||||
___
|
||||
|
||||
@@ -190,7 +190,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:76](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L76)
|
||||
[packages/medusa/src/services/claim.ts:81](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
@@ -200,7 +200,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:77](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L77)
|
||||
[packages/medusa/src/services/claim.ts:82](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L82)
|
||||
|
||||
___
|
||||
|
||||
@@ -210,7 +210,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:68](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L68)
|
||||
[packages/medusa/src/services/claim.ts:73](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L73)
|
||||
|
||||
___
|
||||
|
||||
@@ -220,7 +220,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:78](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L78)
|
||||
[packages/medusa/src/services/claim.ts:83](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L83)
|
||||
|
||||
___
|
||||
|
||||
@@ -230,7 +230,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:79](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L79)
|
||||
[packages/medusa/src/services/claim.ts:84](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L84)
|
||||
|
||||
___
|
||||
|
||||
@@ -240,7 +240,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:80](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L80)
|
||||
[packages/medusa/src/services/claim.ts:85](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -254,7 +254,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:64](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L64)
|
||||
[packages/medusa/src/services/claim.ts:69](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
@@ -275,7 +275,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:54](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L54)
|
||||
[packages/medusa/src/services/claim.ts:59](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L59)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -314,7 +314,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -334,7 +334,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:760](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L760)
|
||||
[packages/medusa/src/services/claim.ts:808](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L808)
|
||||
|
||||
___
|
||||
|
||||
@@ -354,7 +354,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:608](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L608)
|
||||
[packages/medusa/src/services/claim.ts:656](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L656)
|
||||
|
||||
___
|
||||
|
||||
@@ -380,7 +380,7 @@ created claim
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:214](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L214)
|
||||
[packages/medusa/src/services/claim.ts:337](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L337)
|
||||
|
||||
___
|
||||
|
||||
@@ -405,7 +405,7 @@ created claim
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:462](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L462)
|
||||
[packages/medusa/src/services/claim.ts:510](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L510)
|
||||
|
||||
___
|
||||
|
||||
@@ -430,7 +430,37 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:680](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L680)
|
||||
[packages/medusa/src/services/claim.ts:728](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L728)
|
||||
|
||||
___
|
||||
|
||||
### getRefundTotalForClaimLinesOnOrder
|
||||
|
||||
▸ `Protected` **getRefundTotalForClaimLinesOnOrder**(`order`, `claimItems`): `Promise`<`number`\>
|
||||
|
||||
Finds claim line items on an order and calculates the refund amount.
|
||||
There are three places too look:
|
||||
- Order items
|
||||
- Swap items
|
||||
- Claim items (from previous claims)
|
||||
Note, it will attempt to return early from each of these places to avoid having to iterate over all items every time.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `order` | `Order` | the order to find claim lines on |
|
||||
| `claimItems` | `CreateClaimItemInput`[] | the claim items to match against |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`number`\>
|
||||
|
||||
the refund amount
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:279](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L279)
|
||||
|
||||
___
|
||||
|
||||
@@ -453,7 +483,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:816](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L816)
|
||||
[packages/medusa/src/services/claim.ts:864](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L864)
|
||||
|
||||
___
|
||||
|
||||
@@ -473,7 +503,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:634](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L634)
|
||||
[packages/medusa/src/services/claim.ts:682](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L682)
|
||||
|
||||
___
|
||||
|
||||
@@ -498,7 +528,7 @@ the order document
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:836](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L836)
|
||||
[packages/medusa/src/services/claim.ts:884](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L884)
|
||||
|
||||
___
|
||||
|
||||
@@ -522,7 +552,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -543,7 +573,27 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:126](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/services/claim.ts#L126)
|
||||
[packages/medusa/src/services/claim.ts:131](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L131)
|
||||
|
||||
___
|
||||
|
||||
### validateCreateClaimInput
|
||||
|
||||
▸ `Protected` **validateCreateClaimInput**(`data`): `Promise`<`void`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `data` | `CreateClaimInput` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/claim.ts:212](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/services/claim.ts#L212)
|
||||
|
||||
___
|
||||
|
||||
@@ -567,4 +617,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/f8d635845/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/1bfbe27b9/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
|
||||
Reference in New Issue
Block a user