chore(docs): Generated JS Client Reference (#5334)
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]
committed by
GitHub
GitHub
parent
378ca1b36e
commit
daea35fe73
@@ -1,3 +1,7 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Class: AdminCollectionsResource
|
||||
|
||||
## Hierarchy
|
||||
@@ -10,11 +14,7 @@
|
||||
|
||||
### addProducts
|
||||
|
||||
▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates products associated with a Product Collection
|
||||
▸ **addProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -22,106 +22,106 @@ Updates products associated with a Product Collection
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | the id of the Collection |
|
||||
| `payload` | [`AdminPostProductsToCollectionReq`](internal-3.AdminPostProductsToCollectionReq.md) | an object which contains an array of Product IDs to add to the Product Collection |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates products associated with a Product Collection
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/collections.ts:100](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L100)
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:101](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L101)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Creates a collection.
|
||||
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payload` | [`AdminPostCollectionsReq`](internal-3.AdminPostCollectionsReq.md) |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
Created collection.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Creates a collection.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/collections.ts:22](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L22)
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a collection
|
||||
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of collection to delete. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`DeleteResponse`](../modules/internal-8.internal.md#deleteresponse)\>
|
||||
|
||||
Deleted response
|
||||
|
||||
**`Description`**
|
||||
|
||||
deletes a collection
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/collections.ts:52](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L52)
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:53](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists collections matching a query
|
||||
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `query?` | [`AdminGetCollectionsParams`](internal-3.AdminGetCollectionsParams.md) | Query for searching collections |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal-3.md#admincollectionslistres)\>
|
||||
|
||||
a list of collections matching the query.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Lists collections matching a query
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/collections.ts:80](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L80)
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:81](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L81)
|
||||
|
||||
___
|
||||
|
||||
### removeProducts
|
||||
|
||||
▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Removes products associated with a Product Collection
|
||||
▸ **removeProducts**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -129,52 +129,52 @@ Removes products associated with a Product Collection
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | the id of the Collection |
|
||||
| `payload` | [`AdminDeleteProductsFromCollectionReq`](internal-3.AdminDeleteProductsFromCollectionReq.md) | an object which contains an array of Product IDs to add to the Product Collection |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal-3.md#deleteresponse)\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminDeleteProductsFromCollectionRes`](../modules/internal-3.md#admindeleteproductsfromcollectionres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Removes products associated with a Product Collection
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/collections.ts:115](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L115)
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:116](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
get a collection
|
||||
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the collection to retrieve. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
the collection with the given id
|
||||
|
||||
**`Description`**
|
||||
|
||||
get a collection
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/collections.ts:66](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L66)
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:67](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L67)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a collection
|
||||
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -182,14 +182,18 @@ Updates a collection
|
||||
| :------ | :------ | :------ |
|
||||
| `id` | `string` | id of the collection to update. |
|
||||
| `payload` | [`AdminPostCollectionsCollectionReq`](internal-3.AdminPostCollectionsCollectionReq.md) | update to apply to collection. |
|
||||
| `customHeaders` | `Record`<`string`, `any`\> | |
|
||||
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
[`ResponsePromise`](../modules/internal-12.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal-3.md#admincollectionsres)\>
|
||||
|
||||
the updated collection.
|
||||
|
||||
**`Description`**
|
||||
|
||||
Updates a collection
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/resources/admin/collections.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/resources/admin/collections.ts#L37)
|
||||
[packages/medusa-js/src/resources/admin/collections.ts:38](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/resources/admin/collections.ts#L38)
|
||||
|
||||
Reference in New Issue
Block a user