chore(docs): Generated Services Reference (automated) (#2399)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
35df4962f8
commit
23bf4eb192
@@ -1,10 +1,8 @@
|
||||
# Class: ProductVariantService
|
||||
|
||||
Provides layer to manipulate product variants.
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `"medusa-interfaces"`
|
||||
- `TransactionBaseService`
|
||||
|
||||
↳ **`ProductVariantService`**
|
||||
|
||||
@@ -22,101 +20,147 @@ Provides layer to manipulate product variants.
|
||||
|
||||
#### Overrides
|
||||
|
||||
BaseService.constructor
|
||||
TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L53)
|
||||
[packages/medusa/src/services/product-variant.ts:53](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L53)
|
||||
|
||||
## Properties
|
||||
|
||||
### cartRepository\_
|
||||
### \_\_configModule\_\_
|
||||
|
||||
• `Private` **cartRepository\_**: typeof `CartRepository`
|
||||
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L51)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
### \_\_container\_\_
|
||||
|
||||
• `Protected` `Readonly` **\_\_container\_\_**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
### cartRepository\_
|
||||
|
||||
• `Protected` `Readonly` **cartRepository\_**: typeof `CartRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:51](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### eventBus\_
|
||||
|
||||
• `Private` **eventBus\_**: [`EventBusService`](EventBusService.md)
|
||||
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L46)
|
||||
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L46)
|
||||
|
||||
___
|
||||
|
||||
### manager\_
|
||||
|
||||
• `Private` **manager\_**: `EntityManager`
|
||||
• `Protected` **manager\_**: `EntityManager`
|
||||
|
||||
#### Overrides
|
||||
|
||||
TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L43)
|
||||
[packages/medusa/src/services/product-variant.ts:41](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### moneyAmountRepository\_
|
||||
|
||||
• `Private` **moneyAmountRepository\_**: typeof `MoneyAmountRepository`
|
||||
• `Protected` `Readonly` **moneyAmountRepository\_**: typeof `MoneyAmountRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L49)
|
||||
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### priceSelectionStrategy\_
|
||||
|
||||
• `Private` **priceSelectionStrategy\_**: `IPriceSelectionStrategy`
|
||||
• `Protected` `Readonly` **priceSelectionStrategy\_**: `IPriceSelectionStrategy`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L48)
|
||||
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### productOptionValueRepository\_
|
||||
|
||||
• `Private` **productOptionValueRepository\_**: typeof `ProductOptionValueRepository`
|
||||
• `Protected` `Readonly` **productOptionValueRepository\_**: typeof `ProductOptionValueRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L50)
|
||||
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### productRepository\_
|
||||
|
||||
• `Private` **productRepository\_**: typeof `ProductRepository`
|
||||
• `Protected` `Readonly` **productRepository\_**: typeof `ProductRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L45)
|
||||
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
### productVariantRepository\_
|
||||
|
||||
• `Private` **productVariantRepository\_**: typeof `ProductVariantRepository`
|
||||
• `Protected` `Readonly` **productVariantRepository\_**: typeof `ProductVariantRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L44)
|
||||
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L44)
|
||||
|
||||
___
|
||||
|
||||
### regionService\_
|
||||
|
||||
• `Private` **regionService\_**: [`RegionService`](RegionService.md)
|
||||
• `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L47)
|
||||
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L47)
|
||||
|
||||
___
|
||||
|
||||
### transactionManager\_
|
||||
|
||||
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
|
||||
|
||||
#### Overrides
|
||||
|
||||
TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L42)
|
||||
|
||||
___
|
||||
|
||||
@@ -134,7 +178,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:37](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L37)
|
||||
[packages/medusa/src/services/product-variant.ts:35](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L35)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -164,7 +208,46 @@ the result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:536](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L536)
|
||||
[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L498)
|
||||
|
||||
___
|
||||
|
||||
### atomicPhase\_
|
||||
|
||||
▸ `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 |
|
||||
| :------ |
|
||||
| `TResult` |
|
||||
| `TError` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| 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 |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TResult`\>
|
||||
|
||||
the result of the transactional work
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -190,7 +273,7 @@ resolves to the creation result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:184](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L184)
|
||||
[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L147)
|
||||
|
||||
___
|
||||
|
||||
@@ -215,7 +298,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:689](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L689)
|
||||
[packages/medusa/src/services/product-variant.ts:651](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L651)
|
||||
|
||||
___
|
||||
|
||||
@@ -241,7 +324,7 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:563](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L563)
|
||||
[packages/medusa/src/services/product-variant.ts:525](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L525)
|
||||
|
||||
___
|
||||
|
||||
@@ -269,13 +352,13 @@ an array containing the products as the first element and the total
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:795](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L795)
|
||||
[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L724)
|
||||
|
||||
___
|
||||
|
||||
### getRegionPrice
|
||||
|
||||
▸ **getRegionPrice**(`variantId`, `context`): `Promise`<`number`\>
|
||||
▸ **getRegionPrice**(`variantId`, `context`): `Promise`<``null`` \| `number`\>
|
||||
|
||||
Gets the price specific to a region. If no region specific money amount
|
||||
exists the function will try to use a currency price. If no default
|
||||
@@ -290,13 +373,13 @@ currency price exists the function will throw an error.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`number`\>
|
||||
`Promise`<``null`` \| `number`\>
|
||||
|
||||
the price specific to the region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:411](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L411)
|
||||
[packages/medusa/src/services/product-variant.ts:374](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L374)
|
||||
|
||||
___
|
||||
|
||||
@@ -319,7 +402,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:631](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L631)
|
||||
[packages/medusa/src/services/product-variant.ts:593](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L593)
|
||||
|
||||
___
|
||||
|
||||
@@ -342,7 +425,7 @@ the result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:590](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L590)
|
||||
[packages/medusa/src/services/product-variant.ts:552](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L552)
|
||||
|
||||
___
|
||||
|
||||
@@ -374,7 +457,7 @@ an object containing the query, relations and free-text
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:756](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L756)
|
||||
[packages/medusa/src/services/product-variant.ts:685](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L685)
|
||||
|
||||
___
|
||||
|
||||
@@ -399,7 +482,7 @@ the product document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:118](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L118)
|
||||
[packages/medusa/src/services/product-variant.ts:83](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L83)
|
||||
|
||||
___
|
||||
|
||||
@@ -424,7 +507,7 @@ the product document.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:148](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L148)
|
||||
[packages/medusa/src/services/product-variant.ts:111](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L111)
|
||||
|
||||
___
|
||||
|
||||
@@ -449,32 +532,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:477](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L477)
|
||||
|
||||
___
|
||||
|
||||
### setMetadata\_
|
||||
|
||||
▸ **setMetadata_**(`variant`, `metadata`): `Record`<`string`, `unknown`\>
|
||||
|
||||
Dedicated method to set metadata for a variant.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `variant` | `ProductVariant` | the variant to set metadata for. |
|
||||
| `metadata` | `object` | the metadata to set |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Record`<`string`, `unknown`\>
|
||||
|
||||
updated metadata object
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:724](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L724)
|
||||
[packages/medusa/src/services/product-variant.ts:439](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L439)
|
||||
|
||||
___
|
||||
|
||||
@@ -499,7 +557,31 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:440](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L440)
|
||||
[packages/medusa/src/services/product-variant.ts:403](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L403)
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -526,7 +608,7 @@ resolves to the update result.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:292](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L292)
|
||||
[packages/medusa/src/services/product-variant.ts:255](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L255)
|
||||
|
||||
___
|
||||
|
||||
@@ -553,7 +635,7 @@ the result of the update operation.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:498](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L498)
|
||||
[packages/medusa/src/services/product-variant.ts:460](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L460)
|
||||
|
||||
___
|
||||
|
||||
@@ -579,24 +661,28 @@ empty promise
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:370](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L370)
|
||||
[packages/medusa/src/services/product-variant.ts:333](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/services/product-variant.ts#L333)
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
▸ **withTransaction**(`transactionManager`): [`ProductVariantService`](ProductVariantService.md)
|
||||
▸ **withTransaction**(`transactionManager?`): [`ProductVariantService`](ProductVariantService.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `transactionManager` | `EntityManager` |
|
||||
| `transactionManager?` | `EntityManager` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ProductVariantService`](ProductVariantService.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/product-variant.ts:90](https://github.com/medusajs/medusa/blob/6225aa57b/packages/medusa/src/services/product-variant.ts#L90)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/35df4962f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
Reference in New Issue
Block a user