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

chore(docs): Generated JS Client Reference (#5334)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
www/apps/docs/content/references/js-client/classes/AdminVariantsResource.md
View File

@@ -1,3 +1,7 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminVariantsResource
## Hierarchy
@@ -8,21 +12,72 @@
## Methods
### list
### getInventory
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-33.md#adminvariantslistres)\>
▸ **getInventory**(`variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../modules/internal-8.internal.md#admingetvariantsvariantinventoryres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetVariantsParams`](internal-33.AdminGetVariantsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
| Name | Type | Description |
| :------ | :------ | :------ |
| `variantId` | `string` | id of the variant to fetch inventory for |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-33.md#adminvariantslistres)\>
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminGetVariantsVariantInventoryRes`](../modules/internal-8.internal.md#admingetvariantsvariantinventoryres)\>
#### Defined in
[medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/variants.ts#L7)
[packages/medusa-js/src/resources/admin/variants.ts:60](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L60)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-8.internal.md#adminvariantslistres)\>
List product variants
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetVariantsParams`](internal-8.internal.AdminGetVariantsParams.md) | Query to filter variants by |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal-8.internal.md#adminvariantslistres)\>
A list of variants satisfying the criteria of the query
#### Defined in
[packages/medusa-js/src/resources/admin/variants.ts:19](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L19)
___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsRes`](../modules/internal-8.internal.md#adminvariantsres)\>
Get a product variant
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | Query to filter variants by |
| `query?` | [`AdminGetVariantParams`](internal-8.internal.AdminGetVariantParams.md) | - |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | custom headers |
#### Returns
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminVariantsRes`](../modules/internal-8.internal.md#adminvariantsres)\>
A list of variants satisfying the criteria of the query
#### Defined in
[packages/medusa-js/src/resources/admin/variants.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/variants.ts#L39)