chore(docs): Generated Services Reference (automated) (#4206)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
96468739dd
commit
5c8ef2d370
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L42)
|
||||
[medusa/src/services/pricing.ts:42](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L42)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L40)
|
||||
[medusa/src/services/pricing.ts:40](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L40)
|
||||
|
||||
___
|
||||
|
||||
@@ -92,7 +92,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -102,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L38)
|
||||
[medusa/src/services/pricing.ts:38](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L38)
|
||||
|
||||
___
|
||||
|
||||
@@ -112,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L39)
|
||||
[medusa/src/services/pricing.ts:39](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
@@ -122,7 +122,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L36)
|
||||
[medusa/src/services/pricing.ts:36](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
@@ -132,7 +132,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L37)
|
||||
[medusa/src/services/pricing.ts:37](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -146,7 +146,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -164,7 +164,7 @@ TransactionBaseService.activeManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -203,7 +203,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -228,7 +228,7 @@ The tax related variant prices.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:101](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L101)
|
||||
[medusa/src/services/pricing.ts:101](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
@@ -253,7 +253,7 @@ The pricing context
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:65](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L65)
|
||||
[medusa/src/services/pricing.ts:65](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L65)
|
||||
|
||||
___
|
||||
|
||||
@@ -279,7 +279,7 @@ A map of variant ids to their corresponding prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:388](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L388)
|
||||
[medusa/src/services/pricing.ts:419](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L419)
|
||||
|
||||
___
|
||||
|
||||
@@ -304,29 +304,28 @@ A map of variant ids to their corresponding prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:406](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L406)
|
||||
[medusa/src/services/pricing.ts:437](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L437)
|
||||
|
||||
___
|
||||
|
||||
### getProductPricing\_
|
||||
|
||||
▸ `Private` **getProductPricing_**(`productId`, `variants`, `context`): `Promise`<`Record`<`string`, `ProductVariantPricing`\>\>
|
||||
▸ `Private` **getProductPricing_**(`data`, `context`): `Promise`<`Map`<`string`, `Record`<`string`, `ProductVariantPricing`\>\>\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `productId` | `string` |
|
||||
| `variants` | `ProductVariant`[] |
|
||||
| `data` | { `productId`: `string` ; `variants`: `ProductVariant`[] }[] |
|
||||
| `context` | `PricingContext` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Record`<`string`, `ProductVariantPricing`\>\>
|
||||
`Promise`<`Map`<`string`, `Record`<`string`, `ProductVariantPricing`\>\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:349](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L349)
|
||||
[medusa/src/services/pricing.ts:362](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L362)
|
||||
|
||||
___
|
||||
|
||||
@@ -340,7 +339,7 @@ Gets the prices for a product variant.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `variant` | `Pick`<`ProductVariant`, ``"id"`` \| ``"product_id"``\> | the id of the variant to get prices for |
|
||||
| `variant` | `Pick`<`ProductVariant`, ``"id"`` \| ``"product_id"``\> | |
|
||||
| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use |
|
||||
|
||||
#### Returns
|
||||
@@ -351,7 +350,7 @@ The product variant prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:212](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L212)
|
||||
[medusa/src/services/pricing.ts:216](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L216)
|
||||
|
||||
___
|
||||
|
||||
@@ -380,61 +379,53 @@ The product variant prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:251](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L251)
|
||||
[medusa/src/services/pricing.ts:265](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L265)
|
||||
|
||||
___
|
||||
|
||||
### getProductVariantPricing\_
|
||||
|
||||
▸ `Private` **getProductVariantPricing_**(`variantId`, `taxRates`, `context`): `Promise`<`ProductVariantPricing`\>
|
||||
▸ `Private` **getProductVariantPricing_**(`data`, `context`): `Promise`<`Map`<`string`, `ProductVariantPricing`\>\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `variantId` | `string` |
|
||||
| `taxRates` | `TaxServiceRate`[] |
|
||||
| `data` | { `quantity?`: `number` ; `variantId`: `string` }[] |
|
||||
| `context` | `PricingContext` |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`ProductVariantPricing`\>
|
||||
`Promise`<`Map`<`string`, `ProductVariantPricing`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:163](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L163)
|
||||
[medusa/src/services/pricing.ts:163](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L163)
|
||||
|
||||
___
|
||||
|
||||
### getProductVariantsPricing
|
||||
|
||||
▸ **getProductVariantsPricing**<`T`, `TOutput`\>(`variantIds`, `context`): `Promise`<`TOutput`\>
|
||||
▸ **getProductVariantsPricing**(`data`, `context`): `Promise`<{ `[variant_id: string]`: `ProductVariantPricing`; }\>
|
||||
|
||||
Gets the prices for a collection of variants.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `string` \| `string`[] |
|
||||
| `TOutput` | `T` extends `string` ? `ProductVariantPricing` : { `[variant_id: string]`: `ProductVariantPricing`; } |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `variantIds` | `T` | the id of the variants to get the prices for |
|
||||
| `data` | { `quantity?`: `number` ; `variantId`: `string` }[] | |
|
||||
| `context` | `PriceSelectionContext` \| `PricingContext` | the price selection context to use |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TOutput`\>
|
||||
`Promise`<{ `[variant_id: string]`: `ProductVariantPricing`; }\>
|
||||
|
||||
The product variant prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:292](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L292)
|
||||
[medusa/src/services/pricing.ts:310](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L310)
|
||||
|
||||
___
|
||||
|
||||
@@ -459,7 +450,7 @@ The shipping option prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:486](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L486)
|
||||
[medusa/src/services/pricing.ts:526](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L526)
|
||||
|
||||
___
|
||||
|
||||
@@ -484,7 +475,7 @@ A list of products with variants decorated with prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:450](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L450)
|
||||
[medusa/src/services/pricing.ts:486](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L486)
|
||||
|
||||
___
|
||||
|
||||
@@ -509,7 +500,7 @@ A list of shipping options with prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:548](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L548)
|
||||
[medusa/src/services/pricing.ts:588](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L588)
|
||||
|
||||
___
|
||||
|
||||
@@ -523,7 +514,7 @@ Set additional prices on a list of product variants.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `variants` | `ProductVariant`[] | list of variants on which to set additional prices |
|
||||
| `variants` | `ProductVariant`[] | |
|
||||
| `context` | `PriceSelectionContext` | the price selection context to use |
|
||||
|
||||
#### Returns
|
||||
@@ -534,7 +525,7 @@ A list of products with variants decorated with prices
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/pricing.ts:424](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/services/pricing.ts#L424)
|
||||
[medusa/src/services/pricing.ts:459](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/services/pricing.ts#L459)
|
||||
|
||||
___
|
||||
|
||||
@@ -558,7 +549,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -582,4 +573,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/5a42c1152/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/d61d0d4cb/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
|
||||
Reference in New Issue
Block a user