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

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

212
docs/content/references/services/classes/ProductVariantService.md
View File

@@ -1,5 +1,7 @@
# Class: ProductVariantService
Provides layer to manipulate product variants.
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L52)
[packages/medusa/src/services/product-variant.ts:52](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L52)
## Properties
@@ -34,7 +36,7 @@ BaseService.constructor
#### Defined in
[services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L50)
[packages/medusa/src/services/product-variant.ts:50](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L50)
___
@@ -44,7 +46,7 @@ ___
#### Defined in
[services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L45)
[packages/medusa/src/services/product-variant.ts:45](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L45)
___
@@ -54,7 +56,7 @@ ___
#### Defined in
[services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L42)
[packages/medusa/src/services/product-variant.ts:42](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L42)
___
@@ -64,7 +66,7 @@ ___
#### Defined in
[services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L48)
[packages/medusa/src/services/product-variant.ts:48](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L48)
___
@@ -74,7 +76,7 @@ ___
#### Defined in
[services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L47)
[packages/medusa/src/services/product-variant.ts:47](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L47)
___
@@ -84,7 +86,7 @@ ___
#### Defined in
[services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L49)
[packages/medusa/src/services/product-variant.ts:49](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L49)
___
@@ -94,7 +96,7 @@ ___
#### Defined in
[services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L44)
[packages/medusa/src/services/product-variant.ts:44](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L44)
___
@@ -104,7 +106,7 @@ ___
#### Defined in
[services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L43)
[packages/medusa/src/services/product-variant.ts:43](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L43)
___
@@ -114,7 +116,7 @@ ___
#### Defined in
[services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L46)
[packages/medusa/src/services/product-variant.ts:46](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L46)
___
@@ -132,7 +134,7 @@ ___
#### Defined in
[services/product-variant.ts:36](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L36)
[packages/medusa/src/services/product-variant.ts:36](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L36)
## Methods
@@ -140,21 +142,29 @@ ___
▸ **addOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<`ProductOptionValue`\>
Adds option value to a varaint.
Fails when product with variant does not exists or
if that product does not have an option with the given
option id. Fails if given variant is not found.
Option value must be of type string or number.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `optionId` | `string` | |
| `optionValue` | `string` | |
| `variantId` | `string` | the variant to decorate. |
| `optionId` | `string` | the option from product. |
| `optionValue` | `string` | option value to add. |
#### Returns
`Promise`<`ProductOptionValue`\>
the result of the update operation.
#### Defined in
[services/product-variant.ts:529](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L529)
[packages/medusa/src/services/product-variant.ts:529](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L529)
___
@@ -162,20 +172,25 @@ ___
▸ **create**(`productOrProductId`, `variant`): `Promise`<`ProductVariant`\>
Creates an unpublished product variant. Will validate against parent product
to ensure that the variant can in fact be created.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `productOrProductId` | `string` \| `Product` | |
| `variant` | `CreateProductVariantInput` | |
| `productOrProductId` | `string` \| `Product` | the product the variant will be added to |
| `variant` | `CreateProductVariantInput` | the variant to create |
#### Returns
`Promise`<`ProductVariant`\>
resolves to the creation result.
#### Defined in
[services/product-variant.ts:183](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L183)
[packages/medusa/src/services/product-variant.ts:183](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L183)
___
@@ -183,19 +198,24 @@ ___
▸ **delete**(`variantId`): `Promise`<`void`\>
Deletes variant.
Will never fail due to delete being idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `variantId` | `string` | the id of the variant to delete. Must be castable as an ObjectId |
#### Returns
`Promise`<`void`\>
empty promise
#### Defined in
[services/product-variant.ts:682](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L682)
[packages/medusa/src/services/product-variant.ts:682](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L682)
___
@@ -203,20 +223,25 @@ ___
▸ **deleteOptionValue**(`variantId`, `optionId`): `Promise`<`void`\>
Deletes option value from given variant.
Will never fail due to delete being idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `optionId` | `string` | |
| `variantId` | `string` | the variant to decorate. |
| `optionId` | `string` | the option from product. |
#### Returns
`Promise`<`void`\>
empty promise
#### Defined in
[services/product-variant.ts:556](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L556)
[packages/medusa/src/services/product-variant.ts:556](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L556)
___
@@ -224,21 +249,27 @@ ___
▸ **getFreeTextQueryBuilder_**(`variantRepo`, `query`, `q?`): `SelectQueryBuilder`<`ProductVariant`\>
Lists variants based on the provided parameters and includes the count of
variants that match the query.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantRepo` | `ProductVariantRepository` | |
| `query` | `FindWithRelationsOptions` | |
| `q?` | `string` | |
| `variantRepo` | `ProductVariantRepository` | the variant repository |
| `query` | `FindWithRelationsOptions` | object that defines the scope for what should be returned |
| `q?` | `string` | free text query |
#### Returns
`SelectQueryBuilder`<`ProductVariant`\>
an array containing the products as the first element and the total
count of products that matches the query as the second element.
#### Defined in
[services/product-variant.ts:788](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L788)
[packages/medusa/src/services/product-variant.ts:788](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L788)
___
@@ -246,20 +277,26 @@ ___
▸ **getRegionPrice**(`variantId`, `context`): `Promise`<`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
currency price exists the function will throw an error.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `context` | `GetRegionPriceContext` | |
| `variantId` | `string` | the id of the variant to get price from |
| `context` | `GetRegionPriceContext` | context for getting region price |
#### Returns
`Promise`<`number`\>
the price specific to the region
#### Defined in
[services/product-variant.ts:404](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L404)
[packages/medusa/src/services/product-variant.ts:404](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L404)
___
@@ -271,16 +308,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductVariantProps` | |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | |
| `selector` | `FilterableProductVariantProps` | the query object for find |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval |
#### Returns
`Promise`<`ProductVariant`[]\>
the result of the find operation
#### Defined in
[services/product-variant.ts:624](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L624)
[packages/medusa/src/services/product-variant.ts:624](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L624)
___
@@ -292,16 +331,18 @@ ___
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductVariantProps` | |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | |
| `selector` | `FilterableProductVariantProps` | the query object for find |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval |
#### Returns
`Promise`<[`ProductVariant`[], `number`]\>
the result of the find operation
#### Defined in
[services/product-variant.ts:583](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L583)
[packages/medusa/src/services/product-variant.ts:583](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L583)
___
@@ -309,17 +350,22 @@ ___
▸ **prepareListQuery_**(`selector`, `config`): `Object`
Creates a query object to be used for list queries.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `FilterableProductVariantProps` | |
| `config` | `FindConfig`<`ProductVariant`\> | |
| `selector` | `FilterableProductVariantProps` | the selector to create the query from |
| `config` | `FindConfig`<`ProductVariant`\> | the config to use for the query |
#### Returns
`Object`
an object containing the query, relations and free-text
search param.
| Name | Type |
| :------ | :------ |
| `q?` | `string` |
@@ -328,7 +374,7 @@ ___
#### Defined in
[services/product-variant.ts:749](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L749)
[packages/medusa/src/services/product-variant.ts:749](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L749)
___
@@ -336,20 +382,24 @@ ___
▸ **retrieve**(`variantId`, `config?`): `Promise`<`ProductVariant`\>
Gets a product variant by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | |
| `variantId` | `string` | the id of the product to get. |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval. |
#### Returns
`Promise`<`ProductVariant`\>
the product document.
#### Defined in
[services/product-variant.ts:117](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L117)
[packages/medusa/src/services/product-variant.ts:117](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L117)
___
@@ -357,20 +407,24 @@ ___
▸ **retrieveBySKU**(`sku`, `config?`): `Promise`<`ProductVariant`\>
Gets a product variant by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `sku` | `string` | |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | |
| `sku` | `string` | The unique stock keeping unit used to identify the product variant. |
| `config` | `FindConfig`<`ProductVariant`\> & `PriceSelectionContext` | query config object for variant retrieval. |
#### Returns
`Promise`<`ProductVariant`\>
the product document.
#### Defined in
[services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L147)
[packages/medusa/src/services/product-variant.ts:147](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L147)
___
@@ -378,20 +432,24 @@ ___
▸ **setCurrencyPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\>
Sets the default price for the given currency.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `price` | `ProductVariantPrice` | |
| `variantId` | `string` | the id of the variant to set prices for |
| `price` | `ProductVariantPrice` | the price for the variant |
#### Returns
`Promise`<`MoneyAmount`\>
the result of the update operation
#### Defined in
[services/product-variant.ts:470](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L470)
[packages/medusa/src/services/product-variant.ts:470](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L470)
___
@@ -399,20 +457,24 @@ ___
▸ **setMetadata_**(`variant`, `metadata`): `Record`<`string`, `unknown`\>
Dedicated method to set metadata for a variant.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variant` | `ProductVariant` | |
| `metadata` | `object` | |
| `variant` | `ProductVariant` | the variant to set metadata for. |
| `metadata` | `object` | the metadata to set |
#### Returns
`Record`<`string`, `unknown`\>
updated metadata object
#### Defined in
[services/product-variant.ts:717](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L717)
[packages/medusa/src/services/product-variant.ts:717](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L717)
___
@@ -420,20 +482,24 @@ ___
▸ **setRegionPrice**(`variantId`, `price`): `Promise`<`MoneyAmount`\>
Sets the default price of a specific region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `price` | `ProductVariantPrice` | |
| `variantId` | `string` | the id of the variant to update |
| `price` | `ProductVariantPrice` | the price for the variant. |
#### Returns
`Promise`<`MoneyAmount`\>
the result of the update operation
#### Defined in
[services/product-variant.ts:433](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L433)
[packages/medusa/src/services/product-variant.ts:433](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L433)
___
@@ -441,20 +507,26 @@ ___
▸ **update**(`variantOrVariantId`, `update`): `Promise`<`ProductVariant`\>
Updates a variant.
Price updates should use dedicated methods.
The function will throw, if price updates are attempted.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantOrVariantId` | `string` \| `Partial`<`ProductVariant`\> | |
| `update` | `UpdateProductVariantInput` | |
| `variantOrVariantId` | `string` \| `Partial`<`ProductVariant`\> | variant or id of a variant. |
| `update` | `UpdateProductVariantInput` | an object with the update values. |
#### Returns
`Promise`<`ProductVariant`\>
resolves to the update result.
#### Defined in
[services/product-variant.ts:288](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L288)
[packages/medusa/src/services/product-variant.ts:288](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L288)
___
@@ -462,21 +534,26 @@ ___
▸ **updateOptionValue**(`variantId`, `optionId`, `optionValue`): `Promise`<`ProductOptionValue`\>
Updates variant's option value.
Option value must be of type string or number.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `optionId` | `string` | |
| `optionValue` | `string` | |
| `variantId` | `string` | the variant to decorate. |
| `optionId` | `string` | the option from product. |
| `optionValue` | `string` | option value to add. |
#### Returns
`Promise`<`ProductOptionValue`\>
the result of the update operation.
#### Defined in
[services/product-variant.ts:491](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L491)
[packages/medusa/src/services/product-variant.ts:491](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L491)
___
@@ -484,20 +561,25 @@ ___
▸ **updateVariantPrices**(`variantId`, `prices`): `Promise`<`void`\>
Updates a variant's prices.
Deletes any prices that are not in the update object, and is not associated with a price list.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | |
| `prices` | `ProductVariantPrice`[] | |
| `variantId` | `string` | the id of variant variant |
| `prices` | `ProductVariantPrice`[] | the update prices |
#### Returns
`Promise`<`void`\>
empty promise
#### Defined in
[services/product-variant.ts:366](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L366)
[packages/medusa/src/services/product-variant.ts:366](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L366)
___
@@ -517,4 +599,4 @@ ___
#### Defined in
[services/product-variant.ts:89](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-variant.ts#L89)
[packages/medusa/src/services/product-variant.ts:89](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-variant.ts#L89)