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
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L53)
|
||||
[packages/medusa/src/services/product-variant.ts:54](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L54)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L51)
|
||||
[packages/medusa/src/services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -72,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L46)
|
||||
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +100,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L41)
|
||||
[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +110,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L49)
|
||||
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -106,7 +120,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L48)
|
||||
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
@@ -116,7 +130,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L50)
|
||||
[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -126,7 +140,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L45)
|
||||
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@@ -136,7 +150,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L44)
|
||||
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
@@ -146,7 +160,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L47)
|
||||
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
@@ -160,7 +174,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L42)
|
||||
[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -178,7 +192,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L35)
|
||||
[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L35)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -208,7 +222,7 @@ the result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L498)
|
||||
[packages/medusa/src/services/product-variant.ts:497](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L497)
|
||||
|
||||
___
|
||||
|
||||
@@ -247,7 +261,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -273,7 +287,7 @@ resolves to the creation result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L147)
|
||||
[packages/medusa/src/services/product-variant.ts:149](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L149)
|
||||
|
||||
___
|
||||
|
||||
@@ -298,7 +312,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:651](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L651)
|
||||
[packages/medusa/src/services/product-variant.ts:650](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L650)
|
||||
|
||||
___
|
||||
|
||||
@@ -324,7 +338,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:525](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L525)
|
||||
[packages/medusa/src/services/product-variant.ts:524](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L524)
|
||||
|
||||
___
|
||||
|
||||
@@ -352,7 +366,7 @@ an array containing the products as the first element and the total
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L724)
|
||||
[packages/medusa/src/services/product-variant.ts:745](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L745)
|
||||
|
||||
___
|
||||
|
||||
@@ -379,7 +393,30 @@ the price specific to the region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:374](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L374)
|
||||
[packages/medusa/src/services/product-variant.ts:373](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L373)
|
||||
|
||||
___
|
||||
|
||||
### isVariantInSalesChannels
|
||||
|
||||
▸ **isVariantInSalesChannels**(`id`, `salesChannelIds`): `Promise`<`boolean`\>
|
||||
|
||||
Check if the variant is assigned to at least one of the provided sales channels.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | product variant id |
|
||||
| `salesChannelIds` | `string`[] | an array of sales channel ids |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`boolean`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:683](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L683)
|
||||
|
||||
___
|
||||
|
||||
@@ -402,7 +439,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:593](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L593)
|
||||
[packages/medusa/src/services/product-variant.ts:592](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L592)
|
||||
|
||||
___
|
||||
|
||||
@@ -425,7 +462,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:552](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L552)
|
||||
[packages/medusa/src/services/product-variant.ts:551](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L551)
|
||||
|
||||
___
|
||||
|
||||
@@ -457,7 +494,7 @@ an object containing the query, relations and free-text
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:685](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L685)
|
||||
[packages/medusa/src/services/product-variant.ts:706](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L706)
|
||||
|
||||
___
|
||||
|
||||
@@ -482,7 +519,7 @@ the product document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:83](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L83)
|
||||
[packages/medusa/src/services/product-variant.ts:85](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L85)
|
||||
|
||||
___
|
||||
|
||||
@@ -507,7 +544,7 @@ the product document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:111](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L111)
|
||||
[packages/medusa/src/services/product-variant.ts:113](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -532,7 +569,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:439](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L439)
|
||||
[packages/medusa/src/services/product-variant.ts:438](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L438)
|
||||
|
||||
___
|
||||
|
||||
@@ -557,7 +594,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:403](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L403)
|
||||
[packages/medusa/src/services/product-variant.ts:402](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L402)
|
||||
|
||||
___
|
||||
|
||||
@@ -581,7 +618,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)
|
||||
|
||||
___
|
||||
|
||||
@@ -608,7 +645,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:255](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L255)
|
||||
[packages/medusa/src/services/product-variant.ts:257](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L257)
|
||||
|
||||
___
|
||||
|
||||
@@ -635,7 +672,7 @@ the result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:460](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L460)
|
||||
[packages/medusa/src/services/product-variant.ts:459](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L459)
|
||||
|
||||
___
|
||||
|
||||
@@ -661,7 +698,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:333](https://github.com/medusajs/medusa/blob/6dafb5154/packages/medusa/src/services/product-variant.ts#L333)
|
||||
[packages/medusa/src/services/product-variant.ts:335](https://github.com/medusajs/medusa/blob/eee928381/packages/medusa/src/services/product-variant.ts#L335)
|
||||
|
||||
___
|
||||
|
||||
@@ -685,4 +722,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