chore(docs): Generated Services Reference (automated) (#3227)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
olivermrbl
olivermrbl
parent
eee9283818
commit
91234c14b5
@@ -28,7 +28,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:68](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L68)
|
||||
[packages/medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L69)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -42,7 +42,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -56,7 +56,21 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
### \_\_moduleDeclaration\_\_
|
||||
|
||||
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.\_\_moduleDeclaration\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +80,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L55)
|
||||
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +90,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L59)
|
||||
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +100,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L60)
|
||||
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +110,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:54](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L54)
|
||||
[packages/medusa/src/services/discount.ts:55](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +120,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:56](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L56)
|
||||
[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +130,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L65)
|
||||
[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L66)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +140,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L66)
|
||||
[packages/medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +150,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L57)
|
||||
[packages/medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
@@ -150,7 +164,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L51)
|
||||
[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +174,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L62)
|
||||
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L63)
|
||||
|
||||
___
|
||||
|
||||
@@ -170,7 +184,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L63)
|
||||
[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -180,7 +194,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L64)
|
||||
[packages/medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -190,7 +204,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:61](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L61)
|
||||
[packages/medusa/src/services/discount.ts:62](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -204,7 +218,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:52](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L52)
|
||||
[packages/medusa/src/services/discount.ts:53](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L53)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -229,7 +243,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:487](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L487)
|
||||
[packages/medusa/src/services/discount.ts:513](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L513)
|
||||
|
||||
___
|
||||
|
||||
@@ -268,7 +282,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L48)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -290,7 +304,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:588](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L588)
|
||||
[packages/medusa/src/services/discount.ts:614](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L614)
|
||||
|
||||
___
|
||||
|
||||
@@ -311,7 +325,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L762)
|
||||
[packages/medusa/src/services/discount.ts:793](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L793)
|
||||
|
||||
___
|
||||
|
||||
@@ -336,7 +350,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:186](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L186)
|
||||
[packages/medusa/src/services/discount.ts:187](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L187)
|
||||
|
||||
___
|
||||
|
||||
@@ -361,7 +375,7 @@ the newly created dynamic code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:415](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L415)
|
||||
[packages/medusa/src/services/discount.ts:441](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L441)
|
||||
|
||||
___
|
||||
|
||||
@@ -385,7 +399,7 @@ the result of the delete operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:547](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L547)
|
||||
[packages/medusa/src/services/discount.ts:573](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L573)
|
||||
|
||||
___
|
||||
|
||||
@@ -410,7 +424,7 @@ the newly created dynamic code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:466](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L466)
|
||||
[packages/medusa/src/services/discount.ts:492](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L492)
|
||||
|
||||
___
|
||||
|
||||
@@ -430,7 +444,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:731](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L731)
|
||||
[packages/medusa/src/services/discount.ts:762](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L762)
|
||||
|
||||
___
|
||||
|
||||
@@ -450,7 +464,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:727](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L727)
|
||||
[packages/medusa/src/services/discount.ts:758](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L758)
|
||||
|
||||
___
|
||||
|
||||
@@ -470,7 +484,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:721](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L721)
|
||||
[packages/medusa/src/services/discount.ts:752](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L752)
|
||||
|
||||
___
|
||||
|
||||
@@ -490,7 +504,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:739](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L739)
|
||||
[packages/medusa/src/services/discount.ts:770](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L770)
|
||||
|
||||
___
|
||||
|
||||
@@ -511,7 +525,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:743](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L743)
|
||||
[packages/medusa/src/services/discount.ts:774](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L774)
|
||||
|
||||
___
|
||||
|
||||
@@ -534,7 +548,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:124](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L124)
|
||||
[packages/medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L125)
|
||||
|
||||
___
|
||||
|
||||
@@ -557,7 +571,32 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:140](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L140)
|
||||
[packages/medusa/src/services/discount.ts:141](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L141)
|
||||
|
||||
___
|
||||
|
||||
### listByCodes
|
||||
|
||||
▸ **listByCodes**(`discountCodes`, `config?`): `Promise`<`Discount`[]\>
|
||||
|
||||
List all the discounts corresponding to the given codes
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `discountCodes` | `string`[] | discount codes of discounts to retrieve |
|
||||
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Discount`[]\>
|
||||
|
||||
the discounts
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:314](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L314)
|
||||
|
||||
___
|
||||
|
||||
@@ -582,7 +621,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:522](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L522)
|
||||
[packages/medusa/src/services/discount.ts:548](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L548)
|
||||
|
||||
___
|
||||
|
||||
@@ -607,7 +646,7 @@ the discount
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:252](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L252)
|
||||
[packages/medusa/src/services/discount.ts:253](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L253)
|
||||
|
||||
___
|
||||
|
||||
@@ -615,7 +654,7 @@ ___
|
||||
|
||||
▸ **retrieveByCode**(`discountCode`, `config?`): `Promise`<`Discount`\>
|
||||
|
||||
Gets a discount by discount code.
|
||||
Gets the discount by discount code.
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -628,11 +667,11 @@ Gets a discount by discount code.
|
||||
|
||||
`Promise`<`Discount`\>
|
||||
|
||||
the discount document
|
||||
the discount
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:285](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L285)
|
||||
[packages/medusa/src/services/discount.ts:286](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L286)
|
||||
|
||||
___
|
||||
|
||||
@@ -656,7 +695,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:29](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L29)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -681,7 +720,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:318](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L318)
|
||||
[packages/medusa/src/services/discount.ts:344](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L344)
|
||||
|
||||
___
|
||||
|
||||
@@ -694,7 +733,7 @@ ___
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `cart` | `Cart` |
|
||||
| `discount` | `Discount` |
|
||||
| `discount` | `Discount` \| `Discount`[] |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -702,7 +741,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:661](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L661)
|
||||
[packages/medusa/src/services/discount.ts:687](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L687)
|
||||
|
||||
___
|
||||
|
||||
@@ -723,7 +762,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:561](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L561)
|
||||
[packages/medusa/src/services/discount.ts:587](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L587)
|
||||
|
||||
___
|
||||
|
||||
@@ -753,7 +792,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/discount.ts:106](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/discount.ts#L106)
|
||||
[packages/medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/discount.ts#L107)
|
||||
|
||||
___
|
||||
|
||||
@@ -777,4 +816,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
|
||||
Reference in New Issue
Block a user