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

chore: fixed commit branch on generate reference action (#1857)

Browse Source 
* fixed commit branch

* fixes after yarn upgrade
This commit is contained in:
Shahed Nasser
2022-07-15 18:08:07 +03:00
committed by GitHub
parent 32b066d923
commit e134f6d237
49 changed files with 13599 additions and 11325 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
docs/content/references/services/classes/DiscountService.md
View File

@@ -1,9 +1,5 @@
# Class: DiscountService
Provides layer to manipulate discounts.
**`implements`** {BaseService}
## Hierarchy
- `TransactionBaseService`<[`DiscountService`](DiscountService.md)\>
@@ -28,7 +24,7 @@ TransactionBaseService&lt;DiscountService\&gt;.constructor
#### Defined in
[services/discount.ts:62](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L62)
[services/discount.ts:62](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L62)
## Properties
@@ -58,7 +54,7 @@ ___
#### Defined in
[services/discount.ts:52](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L52)
[services/discount.ts:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L52)
___
@@ -68,7 +64,7 @@ ___
#### Defined in
[services/discount.ts:55](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L55)
[services/discount.ts:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L55)
___
@@ -78,7 +74,7 @@ ___
#### Defined in
[services/discount.ts:56](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L56)
[services/discount.ts:56](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L56)
___
@@ -88,7 +84,7 @@ ___
#### Defined in
[services/discount.ts:51](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L51)
[services/discount.ts:51](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L51)
___
@@ -98,7 +94,7 @@ ___
#### Defined in
[services/discount.ts:53](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L53)
[services/discount.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L53)
___
@@ -108,7 +104,7 @@ ___
#### Defined in
[services/discount.ts:60](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L60)
[services/discount.ts:60](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L60)
___
@@ -118,7 +114,7 @@ ___
#### Defined in
[services/discount.ts:54](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L54)
[services/discount.ts:54](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L54)
___
@@ -132,7 +128,7 @@ TransactionBaseService.manager\_
#### Defined in
[services/discount.ts:48](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L48)
[services/discount.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L48)
___
@@ -142,7 +138,7 @@ ___
#### Defined in
[services/discount.ts:58](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L58)
[services/discount.ts:58](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L58)
___
@@ -152,7 +148,7 @@ ___
#### Defined in
[services/discount.ts:59](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L59)
[services/discount.ts:59](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L59)
___
@@ -162,7 +158,7 @@ ___
#### Defined in
[services/discount.ts:57](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L57)
[services/discount.ts:57](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L57)
___
@@ -176,7 +172,7 @@ TransactionBaseService.transactionManager\_
#### Defined in
[services/discount.ts:49](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L49)
[services/discount.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L49)
## Methods
@@ -184,24 +180,20 @@ TransactionBaseService.transactionManager\_
▸ **addRegion**(`discountId`, `regionId`): `Promise`<`Discount`\>
Adds a region to the discount regions array.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | id of discount |
| `regionId` | `string` | id of region to add |
| `discountId` | `string` | |
| `regionId` | `string` | |
#### Returns
`Promise`<`Discount`\>
the result of the update operation
#### Defined in
[services/discount.ts:477](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L477)
[services/discount.ts:477](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L477)
___
@@ -209,10 +201,6 @@ ___
▸ `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 |
@@ -224,23 +212,21 @@ transaction manager is created.
| Name | Type | Description |
| :------ | :------ | :------ |
| `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 |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | |
#### 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/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
[interfaces/transaction-base-service.ts:53](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L53)
___
@@ -262,7 +248,7 @@ ___
#### Defined in
[services/discount.ts:576](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L576)
[services/discount.ts:576](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L576)
___
@@ -283,7 +269,7 @@ ___
#### Defined in
[services/discount.ts:720](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L720)
[services/discount.ts:720](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L720)
___
@@ -291,24 +277,19 @@ ___
▸ **create**(`discount`): `Promise`<`Discount`\>
Creates a discount with provided data given that the data is validated.
Normalizes discount code to uppercase.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discount` | `CreateDiscountInput` | the discount data to create |
| `discount` | `CreateDiscountInput` | |
#### Returns
`Promise`<`Discount`\>
the result of the create operation
#### Defined in
[services/discount.ts:182](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L182)
[services/discount.ts:182](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L182)
___
@@ -316,24 +297,20 @@ ___
▸ **createDynamicCode**(`discountId`, `data`): `Promise`<`Discount`\>
Creates a dynamic code for a discount id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | the id of the discount to create a code for |
| `data` | `CreateDynamicDiscountInput` | the object containing a code to identify the discount by |
| `discountId` | `string` | |
| `data` | `CreateDynamicDiscountInput` | |
#### Returns
`Promise`<`Discount`\>
the newly created dynamic code
#### Defined in
[services/discount.ts:405](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L405)
[services/discount.ts:405](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L405)
___
@@ -341,23 +318,19 @@ ___
▸ **delete**(`discountId`): `Promise`<`void`\>
Deletes a discount idempotently
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | id of discount to delete |
| `discountId` | `string` | |
#### Returns
`Promise`<`void`\>
the result of the delete operation
#### Defined in
[services/discount.ts:537](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L537)
[services/discount.ts:537](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L537)
___
@@ -365,24 +338,20 @@ ___
▸ **deleteDynamicCode**(`discountId`, `code`): `Promise`<`void`\>
Deletes a dynamic code for a discount id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | the id of the discount to create a code for |
| `code` | `string` | the code to identify the discount by |
| `discountId` | `string` | |
| `code` | `string` | |
#### Returns
`Promise`<`void`\>
the newly created dynamic code
#### Defined in
[services/discount.ts:456](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L456)
[services/discount.ts:456](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L456)
___
@@ -402,7 +371,7 @@ ___
#### Defined in
[services/discount.ts:689](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L689)
[services/discount.ts:689](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L689)
___
@@ -422,7 +391,7 @@ ___
#### Defined in
[services/discount.ts:685](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L685)
[services/discount.ts:685](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L685)
___
@@ -442,7 +411,7 @@ ___
#### Defined in
[services/discount.ts:679](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L679)
[services/discount.ts:679](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L679)
___
@@ -462,7 +431,7 @@ ___
#### Defined in
[services/discount.ts:697](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L697)
[services/discount.ts:697](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L697)
___
@@ -483,7 +452,7 @@ ___
#### Defined in
[services/discount.ts:701](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L701)
[services/discount.ts:701](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L701)
___
@@ -495,18 +464,16 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableDiscountProps` | the query object for find |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
| `selector` | `FilterableDiscountProps` | |
| `config` | `FindConfig`<`Discount`\> | |
#### Returns
`Promise`<`Discount`[]\>
the result of the find operation
#### Defined in
[services/discount.ts:114](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L114)
[services/discount.ts:114](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L114)
___
@@ -518,18 +485,16 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableDiscountProps` | the query object for find |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
| `selector` | `FilterableDiscountProps` | |
| `config` | `FindConfig`<`Discount`\> | |
#### Returns
`Promise`<[`Discount`[], `number`]\>
the result of the find operation
#### Defined in
[services/discount.ts:133](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L133)
[services/discount.ts:133](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L133)
___
@@ -537,24 +502,20 @@ ___
▸ **removeRegion**(`discountId`, `regionId`): `Promise`<`Discount`\>
Removes a region from the discount regions array.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | id of discount |
| `regionId` | `string` | id of region to remove |
| `discountId` | `string` | |
| `regionId` | `string` | |
#### Returns
`Promise`<`Discount`\>
the result of the update operation
#### Defined in
[services/discount.ts:512](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L512)
[services/discount.ts:512](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L512)
___
@@ -562,24 +523,20 @@ ___
▸ **retrieve**(`discountId`, `config?`): `Promise`<`Discount`\>
Gets a discount by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | id of discount to retrieve |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
| `discountId` | `string` | |
| `config` | `FindConfig`<`Discount`\> | |
#### Returns
`Promise`<`Discount`\>
the discount
#### Defined in
[services/discount.ts:247](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L247)
[services/discount.ts:247](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L247)
___
@@ -587,24 +544,20 @@ ___
▸ **retrieveByCode**(`discountCode`, `config?`): `Promise`<`Discount`\>
Gets a discount by discount code.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountCode` | `string` | discount code of discount to retrieve |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |
| `discountCode` | `string` | |
| `config` | `FindConfig`<`Discount`\> | |
#### Returns
`Promise`<`Discount`\>
the discount document
#### Defined in
[services/discount.ts:276](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L276)
[services/discount.ts:276](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L276)
___
@@ -628,7 +581,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
[interfaces/transaction-base-service.ts:34](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L34)
___
@@ -636,24 +589,20 @@ ___
▸ **update**(`discountId`, `update`): `Promise`<`Discount`\>
Updates a discount.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountId` | `string` | discount id of discount to update |
| `update` | `UpdateDiscountInput` | the data to update the discount with |
| `discountId` | `string` | |
| `update` | `UpdateDiscountInput` | |
#### Returns
`Promise`<`Discount`\>
the result of the update operation
#### Defined in
[services/discount.ts:310](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L310)
[services/discount.ts:310](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L310)
___
@@ -674,7 +623,7 @@ ___
#### Defined in
[services/discount.ts:619](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L619)
[services/discount.ts:619](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L619)
___
@@ -695,7 +644,7 @@ ___
#### Defined in
[services/discount.ts:551](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L551)
[services/discount.ts:551](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L551)
___
@@ -703,8 +652,6 @@ ___
▸ **validateDiscountRule_**<`T`\>(`discountRule`): `T`
Creates a discount rule with provided data given that the data is validated.
#### Type parameters
| Name | Type |
@@ -715,17 +662,15 @@ Creates a discount rule with provided data given that the data is validated.
| Name | Type | Description |
| :------ | :------ | :------ |
| `discountRule` | `T` | the discount rule to create |
| `discountRule` | `T` | |
#### Returns
`T`
the result of the create operation
#### Defined in
[services/discount.ts:96](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/services/discount.ts#L96)
[services/discount.ts:96](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/discount.ts#L96)
___
@@ -749,4 +694,4 @@ TransactionBaseService.withTransaction
#### Defined in
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/ae5c88b89/packages/medusa/src/interfaces/transaction-base-service.ts#L16)
[interfaces/transaction-base-service.ts:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/interfaces/transaction-base-service.ts#L16)