chore(docs): Generated Services Reference (automated) (#2891)
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
8cbd627fb7
commit
a32a2c4cf1
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L47)
|
||||
[packages/medusa/src/services/gift-card.ts:47](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L47)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -64,7 +64,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L38)
|
||||
[packages/medusa/src/services/gift-card.ts:38](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -74,7 +74,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L34)
|
||||
[packages/medusa/src/services/gift-card.ts:34](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -84,7 +84,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L36)
|
||||
[packages/medusa/src/services/gift-card.ts:36](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L40)
|
||||
[packages/medusa/src/services/gift-card.ts:40](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L37)
|
||||
[packages/medusa/src/services/gift-card.ts:37](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -122,7 +122,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L41)
|
||||
[packages/medusa/src/services/gift-card.ts:41](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -138,7 +138,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L43)
|
||||
[packages/medusa/src/services/gift-card.ts:43](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L43)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -177,7 +177,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -201,7 +201,7 @@ the result of the create operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L153)
|
||||
[packages/medusa/src/services/gift-card.ts:153](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L153)
|
||||
|
||||
___
|
||||
|
||||
@@ -221,7 +221,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L138)
|
||||
[packages/medusa/src/services/gift-card.ts:138](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L138)
|
||||
|
||||
___
|
||||
|
||||
@@ -245,7 +245,7 @@ the result of the delete operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:283](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L283)
|
||||
[packages/medusa/src/services/gift-card.ts:322](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L322)
|
||||
|
||||
___
|
||||
|
||||
@@ -268,7 +268,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L114)
|
||||
[packages/medusa/src/services/gift-card.ts:114](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L114)
|
||||
|
||||
___
|
||||
|
||||
@@ -291,7 +291,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L85)
|
||||
[packages/medusa/src/services/gift-card.ts:85](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -316,7 +316,7 @@ the gift card
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:217](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L217)
|
||||
[packages/medusa/src/services/gift-card.ts:242](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L242)
|
||||
|
||||
___
|
||||
|
||||
@@ -337,7 +337,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:224](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L224)
|
||||
[packages/medusa/src/services/gift-card.ts:256](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L256)
|
||||
|
||||
___
|
||||
|
||||
@@ -358,7 +358,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:183](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L183)
|
||||
[packages/medusa/src/services/gift-card.ts:208](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L208)
|
||||
|
||||
___
|
||||
|
||||
@@ -382,7 +382,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -407,7 +407,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:237](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L237)
|
||||
[packages/medusa/src/services/gift-card.ts:276](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L276)
|
||||
|
||||
___
|
||||
|
||||
@@ -431,7 +431,7 @@ 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)
|
||||
|
||||
___
|
||||
|
||||
@@ -449,4 +449,30 @@ the generated gift card code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa/src/services/gift-card.ts#L69)
|
||||
[packages/medusa/src/services/gift-card.ts:69](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L69)
|
||||
|
||||
___
|
||||
|
||||
### resolveTaxRate
|
||||
|
||||
▸ `Static` `Protected` **resolveTaxRate**(`giftCardTaxRate`, `region`): ``null`` \| `number`
|
||||
|
||||
The tax_rate of the giftcard can depend on whether regions tax gift cards, an input
|
||||
provided by the user or the tax rate. Based on these conditions, tax_rate changes.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `giftCardTaxRate` | ``null`` \| `number` |
|
||||
| `region` | `Region` |
|
||||
|
||||
#### Returns
|
||||
|
||||
``null`` \| `number`
|
||||
|
||||
the tax rate for the gift card
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/gift-card.ts:189](https://github.com/medusajs/medusa/blob/d843bc102/packages/medusa/src/services/gift-card.ts#L189)
|
||||
|
||||
Reference in New Issue
Block a user