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

docs: added reference for JS Client (#1629)

Browse Source 
* added reference for JS Client

* added reference for JS Client

* added reference for JS Client
This commit is contained in:
Shahed Nasser
2022-07-08 18:21:46 +03:00
committed by GitHub
parent 371682b4f7
commit 3b28f46705
357 changed files with 32911 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
docs/content/references/js-client/classes/AddressesResource.md Normal file
View File

@@ -0,0 +1,77 @@
# Class: AddressesResource
## Hierarchy
- `default`
↳ **`AddressesResource`**
## Methods
### addAddress
▸ **addAddress**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
Adds an address to a customers saved addresses
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerAddressesReq`](internal.StorePostCustomersCustomerAddressesReq.md) | contains information to create an address |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/addresses.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L16)
___
### deleteAddress
▸ **deleteAddress**(`address_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
Deletes an address of a customer
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `address_id` | `string` | id of the address to delete |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/addresses.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L29)
___
### updateAddress
▸ **updateAddress**(`address_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
Update an address of a customer
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `address_id` | `string` | id of customer |
| `payload` | [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md) | address update |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/addresses.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/addresses.ts#L41)

267
docs/content/references/js-client/classes/Admin.md Normal file
View File

@@ -0,0 +1,267 @@
# Class: Admin
## Hierarchy
- `default`
↳ **`Admin`**
## Properties
### auth
• **auth**: [`AdminAuthResource`](AdminAuthResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L30)
___
### collections
• **collections**: [`AdminCollectionsResource`](AdminCollectionsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:34](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L34)
___
### customerGroups
• **customerGroups**: [`AdminCustomerGroupsResource`](AdminCustomerGroupsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L32)
___
### customers
• **customers**: [`AdminCustomersResource`](AdminCustomersResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L31)
___
### discounts
• **discounts**: [`AdminDiscountsResource`](AdminDiscountsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L33)
___
### draftOrders
• **draftOrders**: [`AdminDraftOrdersResource`](AdminDraftOrdersResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L35)
___
### giftCards
• **giftCards**: [`AdminGiftCardsResource`](AdminGiftCardsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L36)
___
### invites
• **invites**: [`AdminInvitesResource`](AdminInvitesResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L37)
___
### notes
• **notes**: [`AdminNotesResource`](AdminNotesResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L38)
___
### notifications
• **notifications**: [`AdminNotificationsResource`](AdminNotificationsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:53](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L53)
___
### orders
• **orders**: [`AdminOrdersResource`](AdminOrdersResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:45](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L45)
___
### priceLists
• **priceLists**: [`AdminPriceListResource`](AdminPriceListResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L39)
___
### productTags
• **productTags**: [`AdminProductTagsResource`](AdminProductTagsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L41)
___
### productTypes
• **productTypes**: [`AdminProductTypesResource`](AdminProductTypesResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:42](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L42)
___
### products
• **products**: [`AdminProductsResource`](AdminProductsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L40)
___
### regions
• **regions**: [`AdminRegionsResource`](AdminRegionsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L52)
___
### returnReasons
• **returnReasons**: [`AdminReturnReasonsResource`](AdminReturnReasonsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L46)
___
### returns
• **returns**: [`AdminReturnsResource`](AdminReturnsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:44](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L44)
___
### shippingOptions
• **shippingOptions**: [`AdminShippingOptionsResource`](AdminShippingOptionsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L51)
___
### shippingProfiles
• **shippingProfiles**: [`AdminShippingProfilesResource`](AdminShippingProfilesResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:49](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L49)
___
### store
• **store**: [`AdminStoresResource`](AdminStoresResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L50)
___
### swaps
• **swaps**: [`AdminSwapsResource`](AdminSwapsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L48)
___
### taxRates
• **taxRates**: [`AdminTaxRatesResource`](AdminTaxRatesResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:54](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L54)
___
### uploads
• **uploads**: [`AdminUploadsResource`](AdminUploadsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:55](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L55)
___
### users
• **users**: [`AdminUsersResource`](AdminUsersResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L43)
___
### variants
• **variants**: [`AdminVariantsResource`](AdminVariantsResource.md)
#### Defined in
[packages/medusa-js/src/resources/admin/index.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/index.ts#L47)

75
docs/content/references/js-client/classes/AdminAuthResource.md Normal file
View File

@@ -0,0 +1,75 @@
# Class: AdminAuthResource
## Hierarchy
- `default`
↳ **`AdminAuthResource`**
## Methods
### createSession
▸ **createSession**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\>
**`description`** Creates an authenticated session
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostAuthReq`](internal.AdminPostAuthReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/auth.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L33)
___
### deleteSession
▸ **deleteSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
**`description`** destroys an authenticated session
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
#### Defined in
[packages/medusa-js/src/resources/admin/auth.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L22)
___
### getSession
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\>
**`description`** Retrieves an authenticated session
Usually used to check if authenticated session is alive.
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminAuthRes`](../modules/internal.md#adminauthres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/auth.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/auth.ts#L12)

133
docs/content/references/js-client/classes/AdminCollectionsResource.md Normal file
View File

@@ -0,0 +1,133 @@
# Class: AdminCollectionsResource
## Hierarchy
- `default`
↳ **`AdminCollectionsResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
**`description`** Creates a collection.
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostCollectionsReq`](internal.AdminPostCollectionsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
Created collection.
#### Defined in
[packages/medusa-js/src/resources/admin/collections.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L20)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** deletes a collection
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of collection to delete. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
Deleted response
#### Defined in
[packages/medusa-js/src/resources/admin/collections.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L50)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal.md#admincollectionslistres)\>
**`description`** Lists collections matching a query
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetCollectionsParams`](internal.AdminGetCollectionsParams.md) | Query for searching collections |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsListRes`](../modules/internal.md#admincollectionslistres)\>
a list of collections matching the query.
#### Defined in
[packages/medusa-js/src/resources/admin/collections.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L72)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
**`description`** get a collection
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the collection to retrieve. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
the collection with the given id
#### Defined in
[packages/medusa-js/src/resources/admin/collections.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L61)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
**`description`** Updates a collection
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the collection to update. |
| `payload` | [`AdminPostCollectionsCollectionReq`](internal.AdminPostCollectionsCollectionReq.md) | update to apply to collection. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCollectionsRes`](../modules/internal.md#admincollectionsres)\>
the updated collection.
#### Defined in
[packages/medusa-js/src/resources/admin/collections.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/collections.ts#L35)

196
docs/content/references/js-client/classes/AdminCustomerGroupsResource.md Normal file
View File

@@ -0,0 +1,196 @@
# Class: AdminCustomerGroupsResource
## Hierarchy
- `default`
↳ **`AdminCustomerGroupsResource`**
## Methods
### addCustomers
▸ **addCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
Add multiple customers to a customer group.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | customer group id |
| `payload` | [`AdminPostCustomerGroupsGroupCustomersBatchReq`](internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md) | an object which contains an array of customer ids which will be added to the group |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customer-groups.ts:112](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L112)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
Create a customer group.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`AdminPostCustomerGroupsReq`](internal.AdminPostCustomerGroupsReq.md) | customer group info |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customer-groups.ts:26](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L26)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
Deletes a customer group.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the customer group |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customer-groups.ts:77](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L77)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal.md#admincustomergroupslistres)\>
Lists customer groups.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetCustomerGroupsParams`](internal.AdminGetCustomerGroupsParams.md) | optional |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsListRes`](../modules/internal.md#admincustomergroupslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customer-groups.ts:91](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L91)
___
### listCustomers
▸ **listCustomers**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\>
List and count customers that belong to provided customer groups.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | customer group id |
| `query?` | [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md) | params for filtering customers |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customer-groups.ts:144](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L144)
___
### removeCustomers
▸ **removeCustomers**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
Remove multiple customers from a customer group.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | customer group id |
| `payload` | [`AdminDeleteCustomerGroupsGroupCustomerBatchReq`](internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md) | an object which contains an array of customers ids which will be removed from the group |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customer-groups.ts:128](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L128)
___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
Retrieves a customer group.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | customer group id |
| `query?` | [`AdminGetCustomerGroupsGroupParams`](internal.AdminGetCustomerGroupsGroupParams.md) | pass query options such as "expand", "fields" etc. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customer-groups.ts:41](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L41)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
Updates a customer group
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | customer group id |
| `payload` | [`AdminPostCustomerGroupsGroupReq`](internal.AdminPostCustomerGroupsGroupReq.md) | data to update customer group with |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomerGroupsRes`](../modules/internal.md#admincustomergroupsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customer-groups.ts:62](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customer-groups.ts#L62)

100
docs/content/references/js-client/classes/AdminCustomersResource.md Normal file
View File

@@ -0,0 +1,100 @@
# Class: AdminCustomersResource
## Hierarchy
- `default`
↳ **`AdminCustomersResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
Creates a customer
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`AdminPostCustomersReq`](internal.AdminPostCustomersReq.md) | information of customer |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customers.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L18)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\>
Lists customers
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md) | optional |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersListRes`](../modules/internal.md#admincustomerslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customers.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L59)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
Retrieves a customer
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | customer id |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customers.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L46)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
Updates a customer
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | customer id |
| `payload` | [`AdminPostCustomersCustomerReq`](internal.AdminPostCustomersCustomerReq.md) | data to update customer with |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminCustomersRes`](../modules/internal.md#admincustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/customers.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/customers.ts#L32)

342
docs/content/references/js-client/classes/AdminDiscountsResource.md Normal file
View File

@@ -0,0 +1,342 @@
# Class: AdminDiscountsResource
## Hierarchy
- `default`
↳ **`AdminDiscountsResource`**
## Methods
### addRegion
▸ **addRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Adds region to discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `regionId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L24)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Creates discounts
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostDiscountsReq`](internal.AdminPostDiscountsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L36)
___
### createCondition
▸ **createCondition**(`discountId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** creates a discount condition
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `payload` | [`AdminPostDiscountsDiscountConditions`](internal.AdminPostDiscountsDiscountConditions.md) |
| `query` | [`AdminPostDiscountsDiscountConditionsParams`](internal.AdminPostDiscountsDiscountConditionsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:145](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L145)
___
### createDynamicCode
▸ **createDynamicCode**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Creates a dynamic discount code
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostDiscountsDiscountDynamicCodesReq`](internal.AdminPostDiscountsDiscountDynamicCodesReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L59)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** Deletes a discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:71](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L71)
___
### deleteCondition
▸ **deleteCondition**(`discountId`, `conditionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** Removes a condition from a discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `conditionId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:184](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L184)
___
### deleteDynamicCode
▸ **deleteDynamicCode**(`id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Deletes a dynamic discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `code` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:82](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L82)
___
### getCondition
▸ **getCondition**(`discountId`, `conditionId`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal.md#admindiscountconditionsres)\>
**`description`** Gets a condition from a discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `conditionId` | `string` |
| `query?` | [`AdminGetDiscountsDiscountConditionsConditionParams`](internal.AdminGetDiscountsDiscountConditionsConditionParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountConditionsRes`](../modules/internal.md#admindiscountconditionsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:196](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L196)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal.md#admindiscountslistres)\>
**`description`** Lists discounts
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetDiscountsParams`](internal.AdminGetDiscountsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsListRes`](../modules/internal.md#admindiscountslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:116](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L116)
___
### removeRegion
▸ **removeRegion**(`id`, `regionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Removes a region from a discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `regionId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:133](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L133)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Retrieves a discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:94](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L94)
___
### retrieveByCode
▸ **retrieveByCode**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Retrieves a discount by code
#### Parameters
| Name | Type |
| :------ | :------ |
| `code` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:105](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L105)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Updates discount
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostDiscountsDiscountReq`](internal.AdminPostDiscountsDiscountReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L47)
___
### updateCondition
▸ **updateCondition**(`discountId`, `conditionId`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
**`description`** Updates a discount condition
#### Parameters
| Name | Type |
| :------ | :------ |
| `discountId` | `string` |
| `conditionId` | `string` |
| `payload` | [`AdminPostDiscountsDiscountConditionsCondition`](internal.AdminPostDiscountsDiscountConditionsCondition.md) |
| `query` | [`AdminPostDiscountsDiscountConditionsConditionParams`](internal.AdminPostDiscountsDiscountConditionsConditionParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDiscountsRes`](../modules/internal.md#admindiscountsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/discounts.ts:164](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/discounts.ts#L164)

219
docs/content/references/js-client/classes/AdminDraftOrdersResource.md Normal file
View File

@@ -0,0 +1,219 @@
# Class: AdminDraftOrdersResource
## Hierarchy
- `default`
↳ **`AdminDraftOrdersResource`**
## Methods
### addLineItem
▸ **addLineItem**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
**`description`** Add line item to draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsReq`](internal.AdminPostDraftOrdersDraftOrderLineItemsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:29](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L29)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
**`description`** Creates a draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal.AdminPostDraftOrdersDraftOrderReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L19)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** Delete draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:40](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L40)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal.md#admindraftorderslistres)\>
**`description`** Lists draft orders
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetDraftOrdersParams`](internal.AdminGetDraftOrdersParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersListRes`](../modules/internal.md#admindraftorderslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:67](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L67)
___
### markPaid
▸ **markPaid**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal.md#adminpostdraftordersdraftorderregisterpaymentres)\>
**`description`** Mark a draft order as paid
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPostDraftOrdersDraftOrderRegisterPaymentRes`](../modules/internal.md#adminpostdraftordersdraftorderregisterpaymentres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:83](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L83)
___
### removeLineItem
▸ **removeLineItem**(`id`, `itemId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
**`description`** Remove line item
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `itemId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L48)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
**`description`** Retrieves a draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L59)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
**`description`** Update draft order
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostDraftOrdersDraftOrderReq`](internal.AdminPostDraftOrdersDraftOrderReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:94](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L94)
___
### updateLineItem
▸ **updateLineItem**(`id`, `itemId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
**`description`** Update draft order line item
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `itemId` | `string` |
| `payload` | [`AdminPostDraftOrdersDraftOrderLineItemsItemReq`](internal.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminDraftOrdersRes`](../modules/internal.md#admindraftordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/draft-orders.ts:105](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/draft-orders.ts#L105)

123
docs/content/references/js-client/classes/AdminGiftCardsResource.md Normal file
View File

@@ -0,0 +1,123 @@
# Class: AdminGiftCardsResource
## Hierarchy
- `default`
↳ **`AdminGiftCardsResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
**`description`** Creates a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostGiftCardsReq`](internal.AdminPostGiftCardsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L17)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** Deletes a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L36)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal.md#admingiftcardslistres)\>
**`description`** Lists gift cards
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetGiftCardsParams`](internal.AdminGetGiftCardsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsListRes`](../modules/internal.md#admingiftcardslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L52)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
**`description`** Deletes a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:44](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L44)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
**`description`** Updates a gift card
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostGiftCardsGiftCardReq`](internal.AdminPostGiftCardsGiftCardReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGiftCardsRes`](../modules/internal.md#admingiftcardsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/gift-cards.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/gift-cards.ts#L25)

111
docs/content/references/js-client/classes/AdminInvitesResource.md Normal file
View File

@@ -0,0 +1,111 @@
# Class: AdminInvitesResource
## Hierarchy
- `default`
↳ **`AdminInvitesResource`**
## Methods
### accept
▸ **accept**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostInvitesInviteAcceptReq`](internal.AdminPostInvitesInviteAcceptReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Defined in
[packages/medusa-js/src/resources/admin/invites.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L10)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostInvitesPayload`](../modules/internal.md#adminpostinvitespayload) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Defined in
[packages/medusa-js/src/resources/admin/invites.ts:15](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L15)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/invites.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L20)
___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal.md#adminlistinvitesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminListInvitesRes`](../modules/internal.md#adminlistinvitesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/invites.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L25)
___
### resend
▸ **resend**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Defined in
[packages/medusa-js/src/resources/admin/invites.ts:30](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/invites.ts#L30)

113
docs/content/references/js-client/classes/AdminNotesResource.md Normal file
View File

@@ -0,0 +1,113 @@
# Class: AdminNotesResource
## Hierarchy
- `default`
↳ **`AdminNotesResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostNotesReq`](internal.AdminPostNotesReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/notes.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L14)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/notes.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L27)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal.md#adminnoteslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetNotesParams`](internal.AdminGetNotesParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesListRes`](../modules/internal.md#adminnoteslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/notes.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L37)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/notes.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L32)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostNotesNoteReq`](internal.AdminPostNotesNoteReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotesRes`](../modules/internal.md#adminnotesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/notes.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notes.ts#L19)

50
docs/content/references/js-client/classes/AdminNotificationsResource.md Normal file
View File

@@ -0,0 +1,50 @@
# Class: AdminNotificationsResource
## Hierarchy
- `default`
↳ **`AdminNotificationsResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal.md#adminnotificationslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetNotificationsParams`](internal.AdminGetNotificationsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsListRes`](../modules/internal.md#adminnotificationslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/notifications.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notifications.ts#L12)
___
### resend
▸ **resend**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal.md#adminnotificationsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostNotificationsNotificationResendReq`](internal.AdminPostNotificationsNotificationResendReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminNotificationsRes`](../modules/internal.md#adminnotificationsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/notifications.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/notifications.ts#L25)

601
docs/content/references/js-client/classes/AdminOrdersResource.md Normal file
View File

@@ -0,0 +1,601 @@
# Class: AdminOrdersResource
## Hierarchy
- `default`
↳ **`AdminOrdersResource`**
## Methods
### addShippingMethod
▸ **addShippingMethod**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostOrdersOrderShippingMethodsReq`](internal.AdminPostOrdersOrderShippingMethodsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:153](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L153)
___
### archive
▸ **archive**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:162](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L162)
___
### cancel
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:145](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L145)
___
### cancelClaim
▸ **cancelClaim**(`id`, `claimId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `claimId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:226](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L226)
___
### cancelClaimFulfillment
▸ **cancelClaimFulfillment**(`id`, `claimId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `claimId` | `string` |
| `fulfillmentId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:117](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L117)
___
### cancelFulfillment
▸ **cancelFulfillment**(`id`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `fulfillmentId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:98](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L98)
___
### cancelSwap
▸ **cancelSwap**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `swapId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:179](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L179)
___
### cancelSwapFulfillment
▸ **cancelSwapFulfillment**(`id`, `swapId`, `fulfillmentId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `swapId` | `string` |
| `fulfillmentId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:107](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L107)
___
### capturePayment
▸ **capturePayment**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L72)
___
### complete
▸ **complete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:64](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L64)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostOrdersReq`](internal.AdminPostOrdersReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L25)
___
### createClaim
▸ **createClaim**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostOrdersOrderClaimsReq`](internal.AdminPostOrdersOrderClaimsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:217](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L217)
___
### createClaimShipment
▸ **createClaimShipment**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `claimId` | `string` |
| `payload` | [`AdminPostOrdersOrderClaimsClaimShipmentsReq`](internal.AdminPostOrdersOrderClaimsClaimShipmentsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:255](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L255)
___
### createFulfillment
▸ **createFulfillment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostOrdersOrderFulfillmentsReq`](internal.AdminPostOrdersOrderFulfillmentsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L89)
___
### createShipment
▸ **createShipment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostOrdersOrderShipmentReq`](internal.AdminPostOrdersOrderShipmentReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:127](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L127)
___
### createSwap
▸ **createSwap**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostOrdersOrderSwapsReq`](internal.AdminPostOrdersOrderSwapsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:170](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L170)
___
### createSwapShipment
▸ **createSwapShipment**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `swapId` | `string` |
| `payload` | [`AdminPostOrdersOrderSwapsSwapShipmentsReq`](internal.AdminPostOrdersOrderSwapsSwapShipmentsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:198](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L198)
___
### deleteMetadata
▸ **deleteMetadata**(`id`, `key`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `key` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:265](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L265)
___
### fulfillClaim
▸ **fulfillClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `claimId` | `string` |
| `payload` | [`AdminPostOrdersOrderClaimsClaimFulfillmentsReq`](internal.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:245](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L245)
___
### fulfillSwap
▸ **fulfillSwap**(`id`, `swapId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `swapId` | `string` |
| `payload` | [`AdminPostOrdersOrderSwapsSwapFulfillmentsReq`](internal.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:188](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L188)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal.md#adminorderslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetOrdersParams`](internal.AdminGetOrdersParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersListRes`](../modules/internal.md#adminorderslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L50)
___
### processSwapPayment
▸ **processSwapPayment**(`id`, `swapId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `swapId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:208](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L208)
___
### refundPayment
▸ **refundPayment**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostOrdersOrderRefundsReq`](internal.AdminPostOrdersOrderRefundsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:80](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L80)
___
### requestReturn
▸ **requestReturn**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostOrdersOrderReturnsReq`](internal.AdminPostOrdersOrderReturnsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:136](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L136)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:42](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L42)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostOrdersOrderReq`](internal.AdminPostOrdersOrderReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L33)
___
### updateClaim
▸ **updateClaim**(`id`, `claimId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `claimId` | `string` |
| `payload` | [`AdminPostOrdersOrderClaimsClaimReq`](internal.AdminPostOrdersOrderClaimsClaimReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminOrdersRes`](../modules/internal.md#adminordersres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/orders.ts:235](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/orders.ts#L235)

223
docs/content/references/js-client/classes/AdminPriceListResource.md Normal file
View File

@@ -0,0 +1,223 @@
# Class: AdminPriceListResource
## Hierarchy
- `default`
↳ **`AdminPriceListResource`**
## Methods
### addPrices
▸ **addPrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostPriceListPricesPricesReq`](internal.AdminPostPriceListPricesPricesReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:80](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L80)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostPriceListsPriceListReq`](internal.AdminPostPriceListsPriceListReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L18)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L35)
___
### deletePrices
▸ **deletePrices**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminDeletePriceListPricesPricesReq`](internal.AdminDeletePriceListPricesPricesReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L89)
___
### deleteProductPrices
▸ **deleteProductPrices**(`priceListId`, `productId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `priceListId` | `string` |
| `productId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:98](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L98)
___
### deleteVariantPrices
▸ **deleteVariantPrices**(`priceListId`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `priceListId` | `string` |
| `variantId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListDeleteBatchRes`](../modules/internal.md#adminpricelistdeletebatchres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:107](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L107)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal.md#adminpricelistslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetPriceListPaginationParams`](internal.AdminGetPriceListPaginationParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListsListRes`](../modules/internal.md#adminpricelistslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L51)
___
### listProducts
▸ **listProducts**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `query?` | [`AdminGetPriceListsPriceListProductsParams`](internal.AdminGetPriceListsPriceListProductsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:65](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L65)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L43)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostPriceListsPriceListPriceListReq`](internal.AdminPostPriceListsPriceListPriceListReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPriceListRes`](../modules/internal.md#adminpricelistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/price-lists.ts:26](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/price-lists.ts#L26)

27
docs/content/references/js-client/classes/AdminProductTagsResource.md Normal file
View File

@@ -0,0 +1,27 @@
# Class: AdminProductTagsResource
## Hierarchy
- `default`
↳ **`AdminProductTagsResource`**
## Methods
### list
▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal.md#adminproducttagslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetProductTagsParams`](internal.AdminGetProductTagsParams.md) |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTagsListRes`](../modules/internal.md#adminproducttagslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/product-tags.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/product-tags.ts#L10)

27
docs/content/references/js-client/classes/AdminProductTypesResource.md Normal file
View File

@@ -0,0 +1,27 @@
# Class: AdminProductTypesResource
## Hierarchy
- `default`
↳ **`AdminProductTypesResource`**
## Methods
### list
▸ **list**(`query?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal.md#adminproducttypeslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetProductTypesParams`](internal.AdminGetProductTypesParams.md) |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductTypesListRes`](../modules/internal.md#adminproducttypeslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/product-types.ts:10](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/product-types.ts#L10)

309
docs/content/references/js-client/classes/AdminProductsResource.md Normal file
View File

@@ -0,0 +1,309 @@
# Class: AdminProductsResource
## Hierarchy
- `default`
↳ **`AdminProductsResource`**
## Methods
### addOption
▸ **addOption**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostProductsProductOptionsReq`](internal.AdminPostProductsProductOptionsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:121](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L121)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostProductsReq`](internal.AdminPostProductsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:23](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L23)
___
### createVariant
▸ **createVariant**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostProductsProductVariantsReq`](internal.AdminPostProductsProductVariantsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:93](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L93)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal.md#adminproductsdeleteres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteRes`](../modules/internal.md#adminproductsdeleteres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L48)
___
### deleteOption
▸ **deleteOption**(`id`, `optionId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal.md#adminproductsdeleteoptionres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `optionId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteOptionRes`](../modules/internal.md#adminproductsdeleteoptionres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:140](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L140)
___
### deleteVariant
▸ **deleteVariant**(`id`, `variantId`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal.md#adminproductsdeletevariantres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `variantId` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsDeleteVariantRes`](../modules/internal.md#adminproductsdeletevariantres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:112](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L112)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal.md#adminproductslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetProductsParams`](internal.AdminGetProductsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListRes`](../modules/internal.md#adminproductslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:56](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L56)
___
### listTags
▸ **listTags**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal.md#adminproductslisttagsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTagsRes`](../modules/internal.md#adminproductslisttagsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:77](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L77)
___
### listTypes
▸ **listTypes**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal.md#adminproductslisttypesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsListTypesRes`](../modules/internal.md#adminproductslisttypesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:70](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L70)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L31)
___
### setMetadata
▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostProductsProductMetadataReq`](internal.AdminPostProductsProductMetadataReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:84](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L84)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostProductsProductReq`](internal.AdminPostProductsProductReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L39)
___
### updateOption
▸ **updateOption**(`id`, `optionId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `optionId` | `string` |
| `payload` | [`AdminPostProductsProductOptionsOption`](internal.AdminPostProductsProductOptionsOption.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:130](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L130)
___
### updateVariant
▸ **updateVariant**(`id`, `variantId`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `variantId` | `string` |
| `payload` | [`AdminPostProductsProductVariantsVariantReq`](internal.AdminPostProductsProductVariantsVariantReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminProductsRes`](../modules/internal.md#adminproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/products.ts:102](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/products.ts#L102)

366
docs/content/references/js-client/classes/AdminRegionsResource.md Normal file
View File

@@ -0,0 +1,366 @@
# Class: AdminRegionsResource
## Hierarchy
- `default`
↳ **`AdminRegionsResource`**
## Methods
### addCountry
▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** adds a country to the list of countries in a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal.AdminPostRegionsRegionCountriesReq.md) | country data |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
updated region
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:120](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L120)
___
### addFulfillmentProvider
▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** adds a fulfillment provider to a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
updated region
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:152](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L152)
___
### addPaymentProvider
▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** adds a payment provider to a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
updated region
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:198](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L198)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** creates a region.
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostRegionsReq`](internal.AdminPostRegionsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
created region.
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L25)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** deletes a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of region to delete. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
Deleted response
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:52](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L52)
___
### deleteCountry
▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** remove a country from a region's list of coutnries
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `country_code` | `string` | the 2 character ISO code for the Country. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
updated region
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:136](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L136)
___
### deleteFulfillmentProvider
▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** remove a fulfillment provider from a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `provider_id` | `string` | the if of the fulfillment provider |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
updated region
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:168](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L168)
___
### deleteMetadata
▸ **deleteMetadata**(`id`, `key`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** delete a region's metadata key value pair
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `key` | `string` | metadata key |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
updated region
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:108](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L108)
___
### deletePaymentProvider
▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** removes a payment provider from a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `provider_id` | `string` | the id of the payment provider |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
updated region
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:214](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L214)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal.md#adminregionslistres)\>
**`description`** lists regions matching a query
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetRegionsParams`](internal.AdminGetRegionsParams.md) | query for searching regions |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal.md#adminregionslistres)\>
a list of regions matching the query.
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:74](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L74)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** get a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the region to retrieve. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
the region with the given id
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:63](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L63)
___
### retrieveFulfillmentOptions
▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
**`description`** retrieves the list of fulfillment options available in a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
list of fulfillment options
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:183](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L183)
___
### setMetadata
▸ **setMetadata**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** adds metadata to a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionMetadata`](internal.AdminPostRegionsRegionMetadata.md) | metadata |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
updated region
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:92](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L92)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
**`description`** updates a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the region to update. |
| `payload` | [`AdminPostRegionsRegionReq`](internal.AdminPostRegionsRegionReq.md) | update to apply to region. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal.AdminRegionsRes.md)\>
the updated region.
#### Defined in
[packages/medusa-js/src/resources/admin/regions.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/regions.ts#L37)

132
docs/content/references/js-client/classes/AdminReturnReasonsResource.md Normal file
View File

@@ -0,0 +1,132 @@
# Class: AdminReturnReasonsResource
## Hierarchy
- `default`
↳ **`AdminReturnReasonsResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
**`description`** Creates a return reason.
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostReturnReasonsReq`](internal.AdminPostReturnReasonsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
Created return reason.
#### Defined in
[packages/medusa-js/src/resources/admin/return-reasons.ts:18](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L18)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** deletes a return reason
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of return reason to delete. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
Deleted response
#### Defined in
[packages/medusa-js/src/resources/admin/return-reasons.ts:48](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L48)
___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal.md#adminreturnreasonslistres)\>
**`description`** Lists return reasons matching a query
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsListRes`](../modules/internal.md#adminreturnreasonslistres)\>
a list of return reasons matching the query.
#### Defined in
[packages/medusa-js/src/resources/admin/return-reasons.ts:69](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L69)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
**`description`** retrieves a return reason
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the return reason to retrieve. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
the return reason with the given id
#### Defined in
[packages/medusa-js/src/resources/admin/return-reasons.ts:59](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L59)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
**`description`** Updates a return reason
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the return reason to update. |
| `payload` | [`AdminPostReturnReasonsReasonReq`](internal.AdminPostReturnReasonsReasonReq.md) | update to apply to return reason. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnReasonsRes`](../modules/internal.md#adminreturnreasonsres)\>
the updated return reason.
#### Defined in
[packages/medusa-js/src/resources/admin/return-reasons.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/return-reasons.ts#L33)

83
docs/content/references/js-client/classes/AdminReturnsResource.md Normal file
View File

@@ -0,0 +1,83 @@
# Class: AdminReturnsResource
## Hierarchy
- `default`
↳ **`AdminReturnsResource`**
## Methods
### cancel
▸ **cancel**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal.md#adminreturnscancelres)\>
**`description`** cancels a return
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of return to cancel |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsCancelRes`](../modules/internal.md#adminreturnscancelres)\>
the order for which the return was canceled
#### Defined in
[packages/medusa-js/src/resources/admin/returns.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L19)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal.md#adminreturnslistres)\>
**`description`** lists returns matching a query
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetReturnsParams`](internal.AdminGetReturnsParams.md) | query for searching returns |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsListRes`](../modules/internal.md#adminreturnslistres)\>
a list of returns matching the query
#### Defined in
[packages/medusa-js/src/resources/admin/returns.ts:46](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L46)
___
### receive
▸ **receive**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal.md#adminreturnsres)\>
**`description`** receive a return
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the return to receive. |
| `payload` | [`AdminPostReturnsReturnReceiveReq`](internal.AdminPostReturnsReturnReceiveReq.md) | items to receive and an optional refund amount |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminReturnsRes`](../modules/internal.md#adminreturnsres)\>
the return
#### Defined in
[packages/medusa-js/src/resources/admin/returns.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/returns.ts#L31)

133
docs/content/references/js-client/classes/AdminShippingOptionsResource.md Normal file
View File

@@ -0,0 +1,133 @@
# Class: AdminShippingOptionsResource
## Hierarchy
- `default`
↳ **`AdminShippingOptionsResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
**`description`** creates a shipping option.
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostShippingOptionsReq`](internal.AdminPostShippingOptionsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
created shipping option.
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:20](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L20)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** deletes a shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of shipping option to delete. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
deleted response
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L50)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal.md#adminshippingoptionslistres)\>
**`description`** lists shipping options matching a query
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetShippingOptionsParams`](internal.AdminGetShippingOptionsParams.md) | query for searching shipping options |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsListRes`](../modules/internal.md#adminshippingoptionslistres)\>
a list of shipping options matching the query.
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:72](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L72)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
**`description`** get a shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the shipping option to retrieve. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
the shipping option with the given id
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L61)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
**`description`** updates a shipping option
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the shipping option to update. |
| `payload` | [`AdminPostShippingOptionsOptionReq`](internal.AdminPostShippingOptionsOptionReq.md) | update to apply to shipping option. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingOptionsRes`](../modules/internal.md#adminshippingoptionsres)\>
the updated shipping option.
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-options.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-options.ts#L35)

112
docs/content/references/js-client/classes/AdminShippingProfilesResource.md Normal file
View File

@@ -0,0 +1,112 @@
# Class: AdminShippingProfilesResource
## Hierarchy
- `default`
↳ **`AdminShippingProfilesResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostShippingProfilesReq`](internal.AdminPostShippingProfilesReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L12)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L27)
___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal.md#adminshippingprofileslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesListRes`](../modules/internal.md#adminshippingprofileslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:37](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L37)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:32](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L32)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostShippingProfilesProfileReq`](internal.AdminPostShippingProfilesProfileReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminShippingProfilesRes`](../modules/internal.md#adminshippingprofilesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/shipping-profiles.ts:19](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/shipping-profiles.ts#L19)

154
docs/content/references/js-client/classes/AdminStoresResource.md Normal file
View File

@@ -0,0 +1,154 @@
# Class: AdminStoresResource
## Hierarchy
- `default`
↳ **`AdminStoresResource`**
## Methods
### addCurrency
▸ **addCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
**`description`** adds a currency to the store.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `currency_code` | `string` | code of the currency to add |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
updated store.
#### Defined in
[packages/medusa-js/src/resources/admin/store.ts:31](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L31)
___
### deleteCurrency
▸ **deleteCurrency**(`currency_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
**`description`** deletes a currency from the available store currencies
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `currency_code` | `string` | currency code of the currency to delete from the store. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
updated store
#### Defined in
[packages/medusa-js/src/resources/admin/store.ts:45](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L45)
___
### listPaymentProviders
▸ **listPaymentProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal.md#adminpaymentproviderslist)\>
**`description`** Lists the store's payment providers
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminPaymentProvidersList`](../modules/internal.md#adminpaymentproviderslist)\>
a list of payment providers configured on the store
#### Defined in
[packages/medusa-js/src/resources/admin/store.ts:68](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L68)
___
### listTaxProviders
▸ **listTaxProviders**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal.md#admintaxproviderslist)\>
**`description`** Lists the store's payment providers
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxProvidersList`](../modules/internal.md#admintaxproviderslist)\>
a list of payment providers configured on the store
#### Defined in
[packages/medusa-js/src/resources/admin/store.ts:79](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L79)
___
### retrieve
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
**`description`** gets a medusa store
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
a medusa store
#### Defined in
[packages/medusa-js/src/resources/admin/store.ts:57](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L57)
___
### update
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
**`description`** Updates the store
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`AdminPostStoreReq`](internal.AdminPostStoreReq.md) | update to apply to the store. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminStoresRes`](../modules/internal.md#adminstoresres)\>
the updated store.
#### Defined in
[packages/medusa-js/src/resources/admin/store.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/store.ts#L17)

49
docs/content/references/js-client/classes/AdminSwapsResource.md Normal file
View File

@@ -0,0 +1,49 @@
# Class: AdminSwapsResource
## Hierarchy
- `default`
↳ **`AdminSwapsResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal.md#adminswapslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetSwapsParams`](internal.AdminGetSwapsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsListRes`](../modules/internal.md#adminswapslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/swaps.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/swaps.ts#L16)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal.md#adminswapsres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminSwapsRes`](../modules/internal.md#adminswapsres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/swaps.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/swaps.ts#L11)

254
docs/content/references/js-client/classes/AdminTaxRatesResource.md Normal file
View File

@@ -0,0 +1,254 @@
# Class: AdminTaxRatesResource
## Hierarchy
- `default`
↳ **`AdminTaxRatesResource`**
## Methods
### addProductTypes
▸ **addProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateProductTypesReq`](internal.AdminPostTaxRatesTaxRateProductTypesReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:100](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L100)
___
### addProducts
▸ **addProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateProductsReq`](internal.AdminPostTaxRatesTaxRateProductsReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:84](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L84)
___
### addShippingOptions
▸ **addShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateShippingOptionsReq`](internal.AdminPostTaxRatesTaxRateShippingOptionsReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:116](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L116)
___
### create
▸ **create**(`payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostTaxRatesReq`](internal.AdminPostTaxRatesReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:53](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L53)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:180](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L180)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal.md#admintaxrateslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetTaxRatesParams`](internal.AdminGetTaxRatesParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesListRes`](../modules/internal.md#admintaxrateslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:39](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L39)
___
### removeProductTypes
▸ **removeProductTypes**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateProductTypesReq`](internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateProductTypesParams`](internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:148](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L148)
___
### removeProducts
▸ **removeProducts**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateProductsReq`](internal.AdminDeleteTaxRatesTaxRateProductsReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateProductsParams`](internal.AdminDeleteTaxRatesTaxRateProductsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:132](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L132)
___
### removeShippingOptions
▸ **removeShippingOptions**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminDeleteTaxRatesTaxRateShippingOptionsReq`](internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md) |
| `query?` | [`AdminDeleteTaxRatesTaxRateShippingOptionsParams`](internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:164](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L164)
___
### retrieve
▸ **retrieve**(`id`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L24)
___
### update
▸ **update**(`id`, `payload`, `query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `id` | `string` |
| `payload` | [`AdminPostTaxRatesTaxRateReq`](internal.AdminPostTaxRatesTaxRateReq.md) |
| `query?` | [`AdminGetTaxRatesTaxRateParams`](internal.AdminGetTaxRatesTaxRateParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminTaxRatesRes`](../modules/internal.md#admintaxratesres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/tax-rates.ts:68](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/tax-rates.ts#L68)

43
docs/content/references/js-client/classes/AdminUploadsResource.md Normal file
View File

@@ -0,0 +1,43 @@
# Class: AdminUploadsResource
## Hierarchy
- `default`
↳ **`AdminUploadsResource`**
## Properties
### headers
• `Private` **headers**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `Content-Type` | `string` |
#### Defined in
[packages/medusa-js/src/resources/admin/uploads.ts:7](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/uploads.ts#L7)
## Methods
### create
▸ **create**(`file`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadRes`](../modules/internal.md#adminuploadres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `file` | [`IAdminPostUploadsFile`](internal.IAdminPostUploadsFile.md) |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUploadRes`](../modules/internal.md#adminuploadres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/uploads.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/uploads.ts#L11)

178
docs/content/references/js-client/classes/AdminUsersResource.md Normal file
View File

@@ -0,0 +1,178 @@
# Class: AdminUsersResource
## Hierarchy
- `default`
↳ **`AdminUsersResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
**`description`** creates a user with the provided information
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`AdminCreateUserPayload`](../modules/internal.md#admincreateuserpayload) | user creation request body |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
created user
#### Defined in
[packages/medusa-js/src/resources/admin/users.ts:61](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L61)
___
### delete
▸ **delete**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
**`description`** deletes a user
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the user to be deleted |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`DeleteResponse`](../modules/internal.md#deleteresponse)\>
delete response
#### Defined in
[packages/medusa-js/src/resources/admin/users.ts:88](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L88)
___
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal.md#adminuserslistres)\>
**`description`** lists all users
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUsersListRes`](../modules/internal.md#adminuserslistres)\>
a list of all users
#### Defined in
[packages/medusa-js/src/resources/admin/users.ts:97](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L97)
___
### resetPassword
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
**`description`** resets the users password given the correct token.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`AdminResetPasswordRequest`](internal.AdminResetPasswordRequest.md) | reset password information. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/users.ts:36](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L36)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
Retrieves a given user
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the user |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
the user
#### Defined in
[packages/medusa-js/src/resources/admin/users.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L50)
___
### sendResetPasswordToken
▸ **sendResetPasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
**`description`** resets password by re-sending password token.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`AdminResetPasswordTokenRequest`](internal.AdminResetPasswordTokenRequest.md) | payload for generating reset-password token. |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`void`\>
#### Defined in
[packages/medusa-js/src/resources/admin/users.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L22)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
**`description`** updates a given user
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the user to update |
| `payload` | [`AdminUpdateUserPayload`](../modules/internal.md#adminupdateuserpayload) | user update request body |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminUserRes`](../modules/internal.md#adminuserres)\>
the updated user
#### Defined in
[packages/medusa-js/src/resources/admin/users.ts:73](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/users.ts#L73)

28
docs/content/references/js-client/classes/AdminVariantsResource.md Normal file
View File

@@ -0,0 +1,28 @@
# Class: AdminVariantsResource
## Hierarchy
- `default`
↳ **`AdminVariantsResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal.md#adminvariantslistres)\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`AdminGetVariantsParams`](internal.AdminGetVariantsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminVariantsListRes`](../modules/internal.md#adminvariantslistres)\>
#### Defined in
[packages/medusa-js/src/resources/admin/variants.ts:7](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/admin/variants.ts#L7)

76
docs/content/references/js-client/classes/AuthResource.md Normal file
View File

@@ -0,0 +1,76 @@
# Class: AuthResource
## Hierarchy
- `default`
↳ **`AuthResource`**
## Methods
### authenticate
▸ **authenticate**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\>
**`description`** Authenticates a customer using email and password combination
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostAuthReq`](internal.StorePostAuthReq.md) | authentication payload |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\>
#### Defined in
[packages/medusa-js/src/resources/auth.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L16)
___
### exists
▸ **exists**(`email`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal.md#storegetauthemailres)\>
**`description`** Check if email exists
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `email` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGetAuthEmailRes`](../modules/internal.md#storegetauthemailres)\>
#### Defined in
[packages/medusa-js/src/resources/auth.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L38)
___
### getSession
▸ **getSession**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\>
**`description`** Retrieves an authenticated session
Usually used to check if authenticated session is alive.
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreAuthRes`](../modules/internal.md#storeauthres)\>
#### Defined in
[packages/medusa-js/src/resources/auth.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/auth.ts#L27)

285
docs/content/references/js-client/classes/CartsResource.md Normal file
View File

@@ -0,0 +1,285 @@
# Class: CartsResource
## Hierarchy
- `default`
↳ **`CartsResource`**
## Properties
### lineItems
• **lineItems**: [`LineItemsResource`](LineItemsResource.md)
#### Defined in
[packages/medusa-js/src/resources/carts.ts:15](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L15)
## Methods
### addShippingMethod
▸ **addShippingMethod**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Adds a shipping method to cart
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | Id of cart |
| `payload` | [`StorePostCartsCartShippingMethodReq`](internal.StorePostCartsCartShippingMethodReq.md) | Containg id of shipping option and optional data |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L24)
___
### complete
▸ **complete**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal.md#storecompletecartres)\>
Completes a cart.
Payment authorization is attempted and if more work is required, we simply return the cart for further updates.
If payment is authorized and order is not yet created, we make sure to do so.
The completion of a cart can be performed idempotently with a provided header Idempotency-Key.
If not provuided, we will generate one for the request.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCompleteCartRes`](../modules/internal.md#storecompletecartres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:43](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L43)
___
### create
▸ **create**(`payload?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Creates a cart
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload?` | [`StorePostCartReq`](internal.StorePostCartReq.md) | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:58](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L58)
___
### createPaymentSessions
▸ **createPaymentSessions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Creates payment sessions.
Initializes the payment sessions that can be used to pay for the items of the cart.
This is usually called when a customer proceeds to checkout.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:74](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L74)
___
### deleteDiscount
▸ **deleteDiscount**(`cart_id`, `code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Removes a discount from cart.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `code` | `string` | discount code to remove |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:89](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L89)
___
### deletePaymentSession
▸ **deletePaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Removes a payment session from a cart.
Can be useful in case a payment has failed
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `provider_id` | `string` | the provider id of the session e.g. "stripe" |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:106](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L106)
___
### refreshPaymentSession
▸ **refreshPaymentSession**(`cart_id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Refreshes a payment session.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `provider_id` | `string` | the provider id of the session e.g. "stripe" |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:122](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L122)
___
### retrieve
▸ **retrieve**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Retrieves a cart
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:137](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L137)
___
### setPaymentSession
▸ **setPaymentSession**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Refreshes a payment session.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `payload` | [`StorePostCartsCartPaymentSessionReq`](internal.StorePostCartsCartPaymentSessionReq.md) | the provider id of the session e.g. "stripe" |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:152](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L152)
___
### update
▸ **update**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Updates a cart
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `payload` | [`StorePostCartsCartReq`](internal.StorePostCartsCartReq.md) | is required and can contain region_id, email, billing and shipping address |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:168](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L168)
___
### updatePaymentSession
▸ **updatePaymentSession**(`cart_id`, `provider_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Updates the payment method
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `provider_id` | `string` | is required |
| `payload` | [`StorePostCartsCartPaymentSessionUpdateReq`](internal.StorePostCartsCartPaymentSessionUpdateReq.md) | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/carts.ts:185](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/carts.ts#L185)

53
docs/content/references/js-client/classes/CollectionsResource.md Normal file
View File

@@ -0,0 +1,53 @@
# Class: CollectionsResource
## Hierarchy
- `default`
↳ **`CollectionsResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal.md#storecollectionslistres)\>
**`description`** Retrieves a list of collections
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`StoreGetCollectionsParams`](internal.StoreGetCollectionsParams.md) | is optional. Can contain a limit and offset for the returned list |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsListRes`](../modules/internal.md#storecollectionslistres)\>
#### Defined in
[packages/medusa-js/src/resources/collections.ts:28](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/collections.ts#L28)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal.md#storecollectionsres)\>
**`description`** Retrieves a single collection
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the collection |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCollectionsRes`](../modules/internal.md#storecollectionsres)\>
#### Defined in
[packages/medusa-js/src/resources/collections.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/collections.ts#L17)

165
docs/content/references/js-client/classes/CustomerResource.md Normal file
View File

@@ -0,0 +1,165 @@
# Class: CustomerResource
## Hierarchy
- `default`
↳ **`CustomerResource`**
## Properties
### addresses
• **addresses**: [`AddressesResource`](AddressesResource.md)
#### Defined in
[packages/medusa-js/src/resources/customers.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L17)
___
### paymentMethods
• **paymentMethods**: [`PaymentMethodsResource`](PaymentMethodsResource.md)
#### Defined in
[packages/medusa-js/src/resources/customers.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L16)
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
Creates a customer
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostCustomersReq`](internal.StorePostCustomersReq.md) | information of customer |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/customers.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L25)
___
### generatePasswordToken
▸ **generatePasswordToken**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
Generates a reset password token, which can be used to reset the password.
The token is not returned but should be sent out to the customer in an email.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to generate token |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<`any`\>
#### Defined in
[packages/medusa-js/src/resources/customers.ts:100](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L100)
___
### listOrders
▸ **listOrders**(`params?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal.md#storecustomerslistordersres)\>
Retrieve customer orders
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `params?` | [`StoreGetCustomersCustomerOrdersParams`](internal.StoreGetCustomersCustomerOrdersParams.md) | optional params to retrieve orders |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListOrdersRes`](../modules/internal.md#storecustomerslistordersres)\>
#### Defined in
[packages/medusa-js/src/resources/customers.ts:65](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L65)
___
### resetPassword
▸ **resetPassword**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
Resets customer password
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerPasswordTokenReq`](internal.StorePostCustomersCustomerPasswordTokenReq.md) | info used to reset customer password |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/customers.ts:85](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L85)
___
### retrieve
▸ **retrieve**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
Retrieves the customer that is currently logged
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/customers.ts:38](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L38)
___
### update
▸ **update**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
Updates a customer
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostCustomersCustomerReq`](internal.StorePostCustomersCustomerReq.md) | information to update customer with |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersRes`](../modules/internal.md#storecustomersres)\>
#### Defined in
[packages/medusa-js/src/resources/customers.ts:51](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/customers.ts#L51)

30
docs/content/references/js-client/classes/GiftCardsResource.md Normal file
View File

@@ -0,0 +1,30 @@
# Class: GiftCardsResource
## Hierarchy
- `default`
↳ **`GiftCardsResource`**
## Methods
### retrieve
▸ **retrieve**(`code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal.md#storegiftcardsres)\>
**`description`** Retrieves a single GiftCard
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `code` | `string` | code of the gift card |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreGiftCardsRes`](../modules/internal.md#storegiftcardsres)\>
#### Defined in
[packages/medusa-js/src/resources/gift-cards.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/gift-cards.ts#L12)

81
docs/content/references/js-client/classes/LineItemsResource.md Normal file
View File

@@ -0,0 +1,81 @@
# Class: LineItemsResource
## Hierarchy
- `default`
↳ **`LineItemsResource`**
## Methods
### create
▸ **create**(`cart_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Creates a line-item for a cart
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | id of cart |
| `payload` | [`StorePostCartsCartLineItemsReq`](internal.StorePostCartsCartLineItemsReq.md) | details needed to create a line-item |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/line-items.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L17)
___
### delete
▸ **delete**(`cart_id`, `line_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Remove a line-item from a cart
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | id of cart |
| `line_id` | `string` | id of item to remove |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/line-items.ts:50](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L50)
___
### update
▸ **update**(`cart_id`, `line_id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
Updates a line-item.
Only quantity updates are allowed
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | id of cart |
| `line_id` | `string` | id of item to update |
| `payload` | [`StorePostCartsCartLineItemsItemReq`](internal.StorePostCartsCartLineItemsItemReq.md) | details needed to update a line-item |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCartsRes`](../modules/internal.md#storecartsres)\>
#### Defined in
[packages/medusa-js/src/resources/line-items.ts:34](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/line-items.ts#L34)

76
docs/content/references/js-client/classes/OrdersResource.md Normal file
View File

@@ -0,0 +1,76 @@
# Class: OrdersResource
## Hierarchy
- `default`
↳ **`OrdersResource`**
## Methods
### lookupOrder
▸ **lookupOrder**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
**`description`** Look up an order using order details
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StoreGetOrdersParams`](internal.StoreGetOrdersParams.md) | details used to look up the order |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
#### Defined in
[packages/medusa-js/src/resources/orders.ts:35](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L35)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
**`description`** Retrieves an order
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
#### Defined in
[packages/medusa-js/src/resources/orders.ts:13](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L13)
___
### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
**`description`** Retrieves an order by cart id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreOrdersRes`](../modules/internal.md#storeordersres)\>
#### Defined in
[packages/medusa-js/src/resources/orders.ts:24](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/orders.ts#L24)

30
docs/content/references/js-client/classes/PaymentMethodsResource.md Normal file
View File

@@ -0,0 +1,30 @@
# Class: PaymentMethodsResource
## Hierarchy
- `default`
↳ **`PaymentMethodsResource`**
## Methods
### list
▸ **list**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal.md#storecustomerslistpaymentmethodsres)\>
Lists customer payment methods
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of cart |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreCustomersListPaymentMethodsRes`](../modules/internal.md#storecustomerslistpaymentmethodsres)\>
#### Defined in
[packages/medusa-js/src/resources/payment-methods.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/payment-methods.ts#L12)

53
docs/content/references/js-client/classes/ProductVariantsResource.md Normal file
View File

@@ -0,0 +1,53 @@
# Class: ProductVariantsResource
## Hierarchy
- `default`
↳ **`ProductVariantsResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal.md#storevariantslistres)\>
**`description`** Retrieves a list of of Product Variants
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`StoreGetVariantsParams`](internal.StoreGetVariantsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsListRes`](../modules/internal.md#storevariantslistres)\>
#### Defined in
[packages/medusa-js/src/resources/product-variants.ts:28](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/product-variants.ts#L28)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal.md#storevariantsres)\>
**`description`** Retrieves a single product variant
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreVariantsRes`](../modules/internal.md#storevariantsres)\>
#### Defined in
[packages/medusa-js/src/resources/product-variants.ts:17](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/product-variants.ts#L17)

86
docs/content/references/js-client/classes/ProductsResource.md Normal file
View File

@@ -0,0 +1,86 @@
# Class: ProductsResource
## Hierarchy
- `default`
↳ **`ProductsResource`**
## Properties
### variants
• **variants**: [`ProductVariantsResource`](ProductVariantsResource.md)
#### Defined in
[packages/medusa-js/src/resources/products.ts:14](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L14)
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal.md#storeproductslistres)\>
**`description`** Retrieves a list of products
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`StoreGetProductsParams`](internal.StoreGetProductsParams.md) | is optional. Can contain a limit and offset for the returned list |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsListRes`](../modules/internal.md#storeproductslistres)\>
#### Defined in
[packages/medusa-js/src/resources/products.ts:47](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L47)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal.md#storeproductsres)\>
**`description`** Retrieves a single Product
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreProductsRes`](../modules/internal.md#storeproductsres)\>
#### Defined in
[packages/medusa-js/src/resources/products.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L22)
___
### search
▸ **search**(`searchOptions`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal.md#storepostsearchres)\>
**`description`** Searches for products
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `searchOptions` | [`StorePostSearchReq`](internal.StorePostSearchReq.md) | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StorePostSearchRes`](../modules/internal.md#storepostsearchres)\>
#### Defined in
[packages/medusa-js/src/resources/products.ts:33](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/products.ts#L33)

52
docs/content/references/js-client/classes/RegionsResource.md Normal file
View File

@@ -0,0 +1,52 @@
# Class: RegionsResource
## Hierarchy
- `default`
↳ **`RegionsResource`**
## Methods
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal.md#storeregionslistres)\>
**`description`** Retrieves a list of regions
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsListRes`](../modules/internal.md#storeregionslistres)\>
#### Defined in
[packages/medusa-js/src/resources/regions.ts:11](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/regions.ts#L11)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal.md#storeregionsres)\>
**`description`** Retrieves a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreRegionsRes`](../modules/internal.md#storeregionsres)\>
#### Defined in
[packages/medusa-js/src/resources/regions.ts:22](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/regions.ts#L22)

52
docs/content/references/js-client/classes/ReturnReasonsResource.md Normal file
View File

@@ -0,0 +1,52 @@
# Class: ReturnReasonsResource
## Hierarchy
- `default`
↳ **`ReturnReasonsResource`**
## Methods
### list
▸ **list**(`customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal.md#storereturnreasonslistres)\>
Lists return reasons defined in Medusa Admin
#### Parameters
| Name | Type |
| :------ | :------ |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsListRes`](../modules/internal.md#storereturnreasonslistres)\>
#### Defined in
[packages/medusa-js/src/resources/return-reasons.ts:25](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/return-reasons.ts#L25)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal.md#storereturnreasonsres)\>
**`description`** Retrieves a single Return Reason
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | is required |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnReasonsRes`](../modules/internal.md#storereturnreasonsres)\>
#### Defined in
[packages/medusa-js/src/resources/return-reasons.ts:15](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/return-reasons.ts#L15)

30
docs/content/references/js-client/classes/ReturnsResource.md Normal file
View File

@@ -0,0 +1,30 @@
# Class: ReturnsResource
## Hierarchy
- `default`
↳ **`ReturnsResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal.md#storereturnsres)\>
Creates a return request
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `payload` | [`StorePostReturnsReq`](internal.StorePostReturnsReq.md) | details needed to create a return |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreReturnsRes`](../modules/internal.md#storereturnsres)\>
#### Defined in
[packages/medusa-js/src/resources/returns.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/returns.ts#L12)

53
docs/content/references/js-client/classes/ShippingOptionsResource.md Normal file
View File

@@ -0,0 +1,53 @@
# Class: ShippingOptionsResource
## Hierarchy
- `default`
↳ **`ShippingOptionsResource`**
## Methods
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
**`description`** Lists shiping options available
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`StoreGetShippingOptionsParams`](internal.StoreGetShippingOptionsParams.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
#### Defined in
[packages/medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/shipping-options.ts#L27)
___
### listCartOptions
▸ **listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
**`description`** Lists shiping options available for a cart
#### Parameters
| Name | Type |
| :------ | :------ |
| `cart_id` | `string` |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal.md#storeshippingoptionslistres)\>
#### Defined in
[packages/medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/shipping-options.ts#L16)

53
docs/content/references/js-client/classes/SwapsResource.md Normal file
View File

@@ -0,0 +1,53 @@
# Class: SwapsResource
## Hierarchy
- `default`
↳ **`SwapsResource`**
## Methods
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\>
**`description`** Creates a swap from a cart
#### Parameters
| Name | Type |
| :------ | :------ |
| `payload` | [`StorePostSwapsReq`](internal.StorePostSwapsReq.md) |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\>
#### Defined in
[packages/medusa-js/src/resources/swaps.ts:12](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/swaps.ts#L12)
___
### retrieveByCartId
▸ **retrieveByCartId**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\>
**`description`** Retrieves a swap by cart id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `cart_id` | `string` | id of cart |
| `customHeaders` | [`Record`](../modules/internal.md#record)<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreSwapsRes`](../modules/internal.md#storeswapsres)\>
#### Defined in
[packages/medusa-js/src/resources/swaps.ts:23](https://github.com/medusajs/medusa/blob/2eb2126f/packages/medusa-js/src/resources/swaps.ts#L23)

27
docs/content/references/js-client/classes/internal.AdditionalItem.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdditionalItem
[internal](../modules/internal.md).AdditionalItem
## Properties
### quantity
• **quantity**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:112
___
### variant\_id
• **variant\_id**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/orders/create-swap.d.ts:111

219
docs/content/references/js-client/classes/internal.Address.md Normal file
View File

@@ -0,0 +1,219 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: Address
[internal](../modules/internal.md).Address
## Hierarchy
- [`SoftDeletableEntity`](internal.SoftDeletableEntity.md)
↳ **`Address`**
## Properties
### address\_1
• **address\_1**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:37
___
### address\_2
• **address\_2**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:38
___
### beforeInsert
• `Private` **beforeInsert**: `any`
#### Defined in
packages/medusa/dist/models/address.d.ts:46
___
### city
• **city**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:39
___
### company
• **company**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:34
___
### country
• **country**: ``null`` \| [`Country`](internal.Country.md)
#### Defined in
packages/medusa/dist/models/address.d.ts:41
___
### country\_code
• **country\_code**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:40
___
### created\_at
• **created\_at**: [`Date`](../modules/internal.md#date)
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[created_at](internal.SoftDeletableEntity.md#created_at)
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:6
___
### customer
• **customer**: ``null`` \| [`Customer`](internal.Customer.md)
#### Defined in
packages/medusa/dist/models/address.d.ts:33
___
### customer\_id
• **customer\_id**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:32
___
### deleted\_at
• **deleted\_at**: ``null`` \| [`Date`](../modules/internal.md#date)
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[deleted_at](internal.SoftDeletableEntity.md#deleted_at)
#### Defined in
packages/medusa/dist/interfaces/models/soft-deletable-entity.d.ts:3
___
### first\_name
• **first\_name**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:35
___
### id
• **id**: `string`
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[id](internal.SoftDeletableEntity.md#id)
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:5
___
### last\_name
• **last\_name**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:36
___
### metadata
• **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
#### Defined in
packages/medusa/dist/models/address.d.ts:45
___
### phone
• **phone**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:44
___
### postal\_code
• **postal\_code**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:43
___
### province
• **province**: ``null`` \| `string`
#### Defined in
packages/medusa/dist/models/address.d.ts:42
___
### updated\_at
• **updated\_at**: [`Date`](../modules/internal.md#date)
#### Inherited from
[SoftDeletableEntity](internal.SoftDeletableEntity.md).[updated_at](internal.SoftDeletableEntity.md#updated_at)
#### Defined in
packages/medusa/dist/interfaces/models/base-entity.d.ts:7

117
docs/content/references/js-client/classes/internal.AddressCreatePayload.md Normal file
View File

@@ -0,0 +1,117 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AddressCreatePayload
[internal](../modules/internal.md).AddressCreatePayload
## Properties
### address\_1
• **address\_1**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:81
___
### address\_2
• **address\_2**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:82
___
### city
• **city**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:83
___
### company
• **company**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:80
___
### country\_code
• **country\_code**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:84
___
### first\_name
• **first\_name**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:76
___
### last\_name
• **last\_name**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:77
___
### metadata
• **metadata**: `object`
#### Defined in
packages/medusa/dist/types/common.d.ts:79
___
### phone
• **phone**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:78
___
### postal\_code
• **postal\_code**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:86
___
### province
• **province**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:85

123
docs/content/references/js-client/classes/internal.AddressPayload.md Normal file
View File

@@ -0,0 +1,123 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AddressPayload
[internal](../modules/internal.md).AddressPayload
## Hierarchy
- **`AddressPayload`**
↳ [`StorePostCustomersCustomerAddressesAddressReq`](internal.StorePostCustomersCustomerAddressesAddressReq.md)
## Properties
### address\_1
• `Optional` **address\_1**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:68
___
### address\_2
• `Optional` **address\_2**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:69
___
### city
• `Optional` **city**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:70
___
### company
• `Optional` **company**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:67
___
### country\_code
• `Optional` **country\_code**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:71
___
### first\_name
• `Optional` **first\_name**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:63
___
### last\_name
• `Optional` **last\_name**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:64
___
### metadata
• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
#### Defined in
packages/medusa/dist/types/common.d.ts:66
___
### phone
• `Optional` **phone**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:65
___
### postal\_code
• `Optional` **postal\_code**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:73
___
### province
• `Optional` **province**: `string`
#### Defined in
packages/medusa/dist/types/common.d.ts:72

93
docs/content/references/js-client/classes/internal.AdminCreateCondition.md Normal file
View File

@@ -0,0 +1,93 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminCreateCondition
[internal](../modules/internal.md).AdminCreateCondition
## Hierarchy
- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md)
↳ **`AdminCreateCondition`**
## Properties
### customer\_groups
• `Optional` **customer\_groups**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups)
#### Defined in
packages/medusa/dist/types/discount.d.ts:21
___
### operator
• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/create-discount.d.ts:84
___
### product\_collections
• `Optional` **product\_collections**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections)
#### Defined in
packages/medusa/dist/types/discount.d.ts:18
___
### product\_tags
• `Optional` **product\_tags**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags)
#### Defined in
packages/medusa/dist/types/discount.d.ts:20
___
### product\_types
• `Optional` **product\_types**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types)
#### Defined in
packages/medusa/dist/types/discount.d.ts:19
___
### products
• `Optional` **products**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products)
#### Defined in
packages/medusa/dist/types/discount.d.ts:17

57
docs/content/references/js-client/classes/internal.AdminCreateUserRequest.md Normal file
View File

@@ -0,0 +1,57 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminCreateUserRequest
[internal](../modules/internal.md).AdminCreateUserRequest
## Properties
### email
• **email**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/users/create-user.d.ts:46
___
### first\_name
• `Optional` **first\_name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/users/create-user.d.ts:47
___
### last\_name
• `Optional` **last\_name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/users/create-user.d.ts:48
___
### password
• **password**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/users/create-user.d.ts:50
___
### role
• `Optional` **role**: [`UserRoles`](../enums/internal.UserRoles.md)
#### Defined in
packages/medusa/dist/api/routes/admin/users/create-user.d.ts:49

17
docs/content/references/js-client/classes/internal.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md Normal file
View File

@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDeleteCustomerGroupsGroupCustomerBatchReq
[internal](../modules/internal.md).AdminDeleteCustomerGroupsGroupCustomerBatchReq
## Properties
### customer\_ids
• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal.CustomerGroupsBatchCustomer.md)[]
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/delete-customers-batch.d.ts:26

17
docs/content/references/js-client/classes/internal.AdminDeletePriceListPricesPricesReq.md Normal file
View File

@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDeletePriceListPricesPricesReq
[internal](../modules/internal.md).AdminDeletePriceListPricesPricesReq
## Properties
### price\_ids
• **price\_ids**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/delete-prices-batch.d.ts:42

27
docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDeleteTaxRatesTaxRateProductTypesParams
[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductTypesParams
## Properties
### expand
• `Optional` **expand**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:27
___
### fields
• `Optional` **fields**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:28

17
docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductTypesReq.md Normal file
View File

@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDeleteTaxRatesTaxRateProductTypesReq
[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductTypesReq
## Properties
### product\_types
• **product\_types**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-product-types.d.ts:24

27
docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDeleteTaxRatesTaxRateProductsParams
[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductsParams
## Properties
### expand
• `Optional` **expand**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:27
___
### fields
• `Optional` **fields**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:28

17
docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateProductsReq.md Normal file
View File

@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDeleteTaxRatesTaxRateProductsReq
[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateProductsReq
## Properties
### products
• **products**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-products.d.ts:24

27
docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDeleteTaxRatesTaxRateShippingOptionsParams
[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateShippingOptionsParams
## Properties
### expand
• `Optional` **expand**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:27
___
### fields
• `Optional` **fields**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:28

17
docs/content/references/js-client/classes/internal.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md Normal file
View File

@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminDeleteTaxRatesTaxRateShippingOptionsReq
[internal](../modules/internal.md).AdminDeleteTaxRatesTaxRateShippingOptionsReq
## Properties
### shipping\_options
• **shipping\_options**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/remove-from-shipping-options.d.ts:24

33
docs/content/references/js-client/classes/internal.AdminGetCollectionsPaginationParams.md Normal file
View File

@@ -0,0 +1,33 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetCollectionsPaginationParams
[internal](../modules/internal.md).AdminGetCollectionsPaginationParams
## Hierarchy
- **`AdminGetCollectionsPaginationParams`**
↳ [`AdminGetCollectionsParams`](internal.AdminGetCollectionsParams.md)
## Properties
### limit
• **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:31
___
### offset
• **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:32

101
docs/content/references/js-client/classes/internal.AdminGetCollectionsParams.md Normal file
View File

@@ -0,0 +1,101 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetCollectionsParams
[internal](../modules/internal.md).AdminGetCollectionsParams
## Hierarchy
- [`AdminGetCollectionsPaginationParams`](internal.AdminGetCollectionsPaginationParams.md)
↳ **`AdminGetCollectionsParams`**
## Properties
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:37
___
### deleted\_at
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:39
___
### handle
• `Optional` **handle**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:36
___
### limit
• **limit**: `number`
#### Inherited from
[AdminGetCollectionsPaginationParams](internal.AdminGetCollectionsPaginationParams.md).[limit](internal.AdminGetCollectionsPaginationParams.md#limit)
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:31
___
### offset
• **offset**: `number`
#### Inherited from
[AdminGetCollectionsPaginationParams](internal.AdminGetCollectionsPaginationParams.md).[offset](internal.AdminGetCollectionsPaginationParams.md#offset)
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:32
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:40
___
### title
• `Optional` **title**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:35
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/collections/list-collections.d.ts:38

41
docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsGroupParams.md Normal file
View File

@@ -0,0 +1,41 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetCustomerGroupsGroupParams
[internal](../modules/internal.md).AdminGetCustomerGroupsGroupParams
## Hierarchy
- [`FindParams`](internal.FindParams.md)
↳ **`AdminGetCustomerGroupsGroupParams`**
## Properties
### expand
• `Optional` **expand**: `string`
#### Inherited from
[FindParams](internal.FindParams.md).[expand](internal.FindParams.md#expand)
#### Defined in
packages/medusa/dist/types/common.d.ts:89
___
### fields
• `Optional` **fields**: `string`
#### Inherited from
[FindParams](internal.FindParams.md).[fields](internal.FindParams.md#fields)
#### Defined in
packages/medusa/dist/types/common.d.ts:90

123
docs/content/references/js-client/classes/internal.AdminGetCustomerGroupsParams.md Normal file
View File

@@ -0,0 +1,123 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetCustomerGroupsParams
[internal](../modules/internal.md).AdminGetCustomerGroupsParams
## Hierarchy
- [`FilterableCustomerGroupProps`](internal.FilterableCustomerGroupProps.md)
↳ **`AdminGetCustomerGroupsParams`**
## Properties
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Inherited from
[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[created_at](internal.FilterableCustomerGroupProps.md#created_at)
#### Defined in
packages/medusa/dist/types/customer-groups.d.ts:7
___
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:37
___
### id
• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md)
#### Inherited from
[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[id](internal.FilterableCustomerGroupProps.md#id)
#### Defined in
packages/medusa/dist/types/customer-groups.d.ts:3
___
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:36
___
### name
• `Optional` **name**: `string`[]
#### Inherited from
[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[name](internal.FilterableCustomerGroupProps.md#name)
#### Defined in
packages/medusa/dist/types/customer-groups.d.ts:5
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:35
___
### order
• `Optional` **order**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/list-customer-groups.d.ts:34
___
### q
• `Optional` **q**: `string`
#### Inherited from
[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[q](internal.FilterableCustomerGroupProps.md#q)
#### Defined in
packages/medusa/dist/types/customer-groups.d.ts:4
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Inherited from
[FilterableCustomerGroupProps](internal.FilterableCustomerGroupProps.md).[updated_at](internal.FilterableCustomerGroupProps.md#updated_at)
#### Defined in
packages/medusa/dist/types/customer-groups.d.ts:6

71
docs/content/references/js-client/classes/internal.AdminGetCustomersParams.md Normal file
View File

@@ -0,0 +1,71 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetCustomersParams
[internal](../modules/internal.md).AdminGetCustomersParams
## Hierarchy
- [`AdminListCustomerSelector`](internal.AdminListCustomerSelector.md)
↳ **`AdminGetCustomersParams`**
## Properties
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:25
___
### groups
• `Optional` **groups**: `string`[]
#### Inherited from
[AdminListCustomerSelector](internal.AdminListCustomerSelector.md).[groups](internal.AdminListCustomerSelector.md#groups)
#### Defined in
packages/medusa/dist/types/customers.d.ts:3
___
### limit
• **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:23
___
### offset
• **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/list-customers.d.ts:24
___
### q
• `Optional` **q**: `string`
#### Inherited from
[AdminListCustomerSelector](internal.AdminListCustomerSelector.md).[q](internal.AdminListCustomerSelector.md#q)
#### Defined in
packages/medusa/dist/types/customers.d.ts:2

27
docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountConditionsConditionParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetDiscountsDiscountConditionsConditionParams
[internal](../modules/internal.md).AdminGetDiscountsDiscountConditionsConditionParams
## Properties
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/get-condition.d.ts:29
___
### fields
• `Optional` **fields**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/get-condition.d.ts:30

27
docs/content/references/js-client/classes/internal.AdminGetDiscountsDiscountRuleParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetDiscountsDiscountRuleParams
[internal](../modules/internal.md).AdminGetDiscountsDiscountRuleParams
## Properties
### allocation
• `Optional` **allocation**: [`AllocationType`](../enums/internal.AllocationType.md)
#### Defined in
packages/medusa/dist/types/discount.d.ts:14
___
### type
• `Optional` **type**: [`DiscountRuleType`](../enums/internal.DiscountRuleType.md)
#### Defined in
packages/medusa/dist/types/discount.d.ts:13

77
docs/content/references/js-client/classes/internal.AdminGetDiscountsParams.md Normal file
View File

@@ -0,0 +1,77 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetDiscountsParams
[internal](../modules/internal.md).AdminGetDiscountsParams
## Properties
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:36
___
### is\_disabled
• `Optional` **is\_disabled**: `boolean`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:33
___
### is\_dynamic
• `Optional` **is\_dynamic**: `boolean`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:32
___
### limit
• **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:34
___
### offset
• **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:35
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:31
___
### rule
• `Optional` **rule**: [`AdminGetDiscountsDiscountRuleParams`](internal.AdminGetDiscountsDiscountRuleParams.md)
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:30

37
docs/content/references/js-client/classes/internal.AdminGetDraftOrdersParams.md Normal file
View File

@@ -0,0 +1,37 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetDraftOrdersParams
[internal](../modules/internal.md).AdminGetDraftOrdersParams
## Properties
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:23
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:24
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/draft-orders/list-draft-orders.d.ts:22

37
docs/content/references/js-client/classes/internal.AdminGetGiftCardsParams.md Normal file
View File

@@ -0,0 +1,37 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetGiftCardsParams
[internal](../modules/internal.md).AdminGetGiftCardsParams
## Properties
### limit
• **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:24
___
### offset
• **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:25
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/gift-cards/list-gift-cards.d.ts:26

37
docs/content/references/js-client/classes/internal.AdminGetNotesParams.md Normal file
View File

@@ -0,0 +1,37 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetNotesParams
[internal](../modules/internal.md).AdminGetNotesParams
## Properties
### limit
• **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:29
___
### offset
• **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:30
___
### resource\_id
• `Optional` **resource\_id**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/notes/list-notes.d.ts:28

97
docs/content/references/js-client/classes/internal.AdminGetNotificationsParams.md Normal file
View File

@@ -0,0 +1,97 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetNotificationsParams
[internal](../modules/internal.md).AdminGetNotificationsParams
## Properties
### event\_name
• `Optional` **event\_name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:38
___
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:37
___
### fields
• `Optional` **fields**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:36
___
### include\_resends
• `Optional` **include\_resends**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:42
___
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:34
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:35
___
### resource\_id
• `Optional` **resource\_id**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:40
___
### resource\_type
• `Optional` **resource\_type**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:39
___
### to
• `Optional` **to**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/notifications/list-notifications.d.ts:41

263
docs/content/references/js-client/classes/internal.AdminGetOrdersParams.md Normal file
View File

@@ -0,0 +1,263 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetOrdersParams
[internal](../modules/internal.md).AdminGetOrdersParams
## Hierarchy
- [`AdminListOrdersSelector`](internal.AdminListOrdersSelector.md)
↳ **`AdminGetOrdersParams`**
## Properties
### canceled\_at
• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[canceled_at](internal.AdminListOrdersSelector.md#canceled_at)
#### Defined in
packages/medusa/dist/types/orders.d.ts:17
___
### cart\_id
• `Optional` **cart\_id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[cart_id](internal.AdminListOrdersSelector.md#cart_id)
#### Defined in
packages/medusa/dist/types/orders.d.ts:11
___
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[created_at](internal.AdminListOrdersSelector.md#created_at)
#### Defined in
packages/medusa/dist/types/orders.d.ts:18
___
### currency\_code
• `Optional` **currency\_code**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[currency_code](internal.AdminListOrdersSelector.md#currency_code)
#### Defined in
packages/medusa/dist/types/orders.d.ts:15
___
### customer\_id
• `Optional` **customer\_id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[customer_id](internal.AdminListOrdersSelector.md#customer_id)
#### Defined in
packages/medusa/dist/types/orders.d.ts:12
___
### display\_id
• `Optional` **display\_id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[display_id](internal.AdminListOrdersSelector.md#display_id)
#### Defined in
packages/medusa/dist/types/orders.d.ts:10
___
### email
• `Optional` **email**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[email](internal.AdminListOrdersSelector.md#email)
#### Defined in
packages/medusa/dist/types/orders.d.ts:13
___
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:47
___
### fields
• `Optional` **fields**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:48
___
### fulfillment\_status
• `Optional` **fulfillment\_status**: `string`[]
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[fulfillment_status](internal.AdminListOrdersSelector.md#fulfillment_status)
#### Defined in
packages/medusa/dist/types/orders.d.ts:8
___
### id
• `Optional` **id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[id](internal.AdminListOrdersSelector.md#id)
#### Defined in
packages/medusa/dist/types/orders.d.ts:6
___
### limit
• **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:46
___
### offset
• **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/orders/list-orders.d.ts:45
___
### payment\_status
• `Optional` **payment\_status**: `string`[]
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[payment_status](internal.AdminListOrdersSelector.md#payment_status)
#### Defined in
packages/medusa/dist/types/orders.d.ts:9
___
### q
• `Optional` **q**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[q](internal.AdminListOrdersSelector.md#q)
#### Defined in
packages/medusa/dist/types/orders.d.ts:5
___
### region\_id
• `Optional` **region\_id**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[region_id](internal.AdminListOrdersSelector.md#region_id)
#### Defined in
packages/medusa/dist/types/orders.d.ts:14
___
### status
• `Optional` **status**: `string`[]
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[status](internal.AdminListOrdersSelector.md#status)
#### Defined in
packages/medusa/dist/types/orders.d.ts:7
___
### tax\_rate
• `Optional` **tax\_rate**: `string`
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[tax_rate](internal.AdminListOrdersSelector.md#tax_rate)
#### Defined in
packages/medusa/dist/types/orders.d.ts:16
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Inherited from
[AdminListOrdersSelector](internal.AdminListOrdersSelector.md).[updated_at](internal.AdminListOrdersSelector.md#updated_at)
#### Defined in
packages/medusa/dist/types/orders.d.ts:19

193
docs/content/references/js-client/classes/internal.AdminGetPriceListPaginationParams.md Normal file
View File

@@ -0,0 +1,193 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetPriceListPaginationParams
[internal](../modules/internal.md).AdminGetPriceListPaginationParams
## Hierarchy
- [`FilterablePriceListProps`](internal.FilterablePriceListProps.md)
↳ **`AdminGetPriceListPaginationParams`**
## Properties
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[created_at](internal.FilterablePriceListProps.md#created_at)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:19
___
### customer\_groups
• `Optional` **customer\_groups**: `string`[]
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[customer_groups](internal.FilterablePriceListProps.md#customer_groups)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:16
___
### deleted\_at
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[deleted_at](internal.FilterablePriceListProps.md#deleted_at)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:21
___
### description
• `Optional` **description**: `string`
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[description](internal.FilterablePriceListProps.md#description)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:17
___
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:36
___
### id
• `Optional` **id**: `string`
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[id](internal.FilterablePriceListProps.md#id)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:12
___
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:35
___
### name
• `Optional` **name**: `string`
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[name](internal.FilterablePriceListProps.md#name)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:15
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:34
___
### order
• `Optional` **order**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-lists.d.ts:37
___
### q
• `Optional` **q**: `string`
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[q](internal.FilterablePriceListProps.md#q)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:13
___
### status
• `Optional` **status**: [`PriceListStatus`](../enums/internal.PriceListStatus.md)[]
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[status](internal.FilterablePriceListProps.md#status)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:14
___
### type
• `Optional` **type**: [`PriceListType`](../enums/internal.PriceListType.md)[]
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[type](internal.FilterablePriceListProps.md#type)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:18
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Inherited from
[FilterablePriceListProps](internal.FilterablePriceListProps.md).[updated_at](internal.FilterablePriceListProps.md#updated_at)
#### Defined in
packages/medusa/dist/types/price-list.d.ts:20

209
docs/content/references/js-client/classes/internal.AdminGetPriceListsPriceListProductsParams.md Normal file
View File

@@ -0,0 +1,209 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetPriceListsPriceListProductsParams
[internal](../modules/internal.md).AdminGetPriceListsPriceListProductsParams
## Hierarchy
- [`AdminGetProductsPaginationParams`](internal.AdminGetProductsPaginationParams.md)
↳ **`AdminGetPriceListsPriceListProductsParams`**
## Properties
### collection\_id
• `Optional` **collection\_id**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:63
___
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:71
___
### deleted\_at
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:73
___
### description
• `Optional` **description**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:66
___
### expand
• `Optional` **expand**: `string`
#### Inherited from
[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[expand](internal.AdminGetProductsPaginationParams.md#expand)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61
___
### fields
• `Optional` **fields**: `string`
#### Inherited from
[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[fields](internal.AdminGetProductsPaginationParams.md#fields)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62
___
### handle
• `Optional` **handle**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:67
___
### id
• `Optional` **id**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:60
___
### is\_giftcard
• `Optional` **is\_giftcard**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:68
___
### limit
• `Optional` **limit**: `number`
#### Inherited from
[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[limit](internal.AdminGetProductsPaginationParams.md#limit)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60
___
### offset
• `Optional` **offset**: `number`
#### Inherited from
[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[offset](internal.AdminGetProductsPaginationParams.md#offset)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59
___
### order
• `Optional` **order**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:70
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:61
___
### status
• `Optional` **status**: [`ProductStatus`](../enums/internal.ProductStatus.md)[]
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:62
___
### tags
• `Optional` **tags**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:64
___
### title
• `Optional` **title**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:65
___
### type
• `Optional` **type**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:69
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:72

33
docs/content/references/js-client/classes/internal.AdminGetProductTagsPaginationParams.md Normal file
View File

@@ -0,0 +1,33 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetProductTagsPaginationParams
[internal](../modules/internal.md).AdminGetProductTagsPaginationParams
## Hierarchy
- **`AdminGetProductTagsPaginationParams`**
↳ [`AdminGetProductTagsParams`](internal.AdminGetProductTagsParams.md)
## Properties
### limit
• **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:30
___
### offset
• **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:31

101
docs/content/references/js-client/classes/internal.AdminGetProductTagsParams.md Normal file
View File

@@ -0,0 +1,101 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetProductTagsParams
[internal](../modules/internal.md).AdminGetProductTagsParams
## Hierarchy
- [`AdminGetProductTagsPaginationParams`](internal.AdminGetProductTagsPaginationParams.md)
↳ **`AdminGetProductTagsParams`**
## Properties
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:37
___
### id
• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:34
___
### limit
• **limit**: `number`
#### Inherited from
[AdminGetProductTagsPaginationParams](internal.AdminGetProductTagsPaginationParams.md).[limit](internal.AdminGetProductTagsPaginationParams.md#limit)
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:30
___
### offset
• **offset**: `number`
#### Inherited from
[AdminGetProductTagsPaginationParams](internal.AdminGetProductTagsPaginationParams.md).[offset](internal.AdminGetProductTagsPaginationParams.md#offset)
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:31
___
### order
• `Optional` **order**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:39
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:35
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:38
___
### value
• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/product-tags/list-product-tags.d.ts:36

33
docs/content/references/js-client/classes/internal.AdminGetProductTypesPaginationParams.md Normal file
View File

@@ -0,0 +1,33 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetProductTypesPaginationParams
[internal](../modules/internal.md).AdminGetProductTypesPaginationParams
## Hierarchy
- **`AdminGetProductTypesPaginationParams`**
↳ [`AdminGetProductTypesParams`](internal.AdminGetProductTypesParams.md)
## Properties
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:30
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:31

101
docs/content/references/js-client/classes/internal.AdminGetProductTypesParams.md Normal file
View File

@@ -0,0 +1,101 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetProductTypesParams
[internal](../modules/internal.md).AdminGetProductTypesParams
## Hierarchy
- [`AdminGetProductTypesPaginationParams`](internal.AdminGetProductTypesPaginationParams.md)
↳ **`AdminGetProductTypesParams`**
## Properties
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:37
___
### id
• `Optional` **id**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:34
___
### limit
• `Optional` **limit**: `number`
#### Inherited from
[AdminGetProductTypesPaginationParams](internal.AdminGetProductTypesPaginationParams.md).[limit](internal.AdminGetProductTypesPaginationParams.md#limit)
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:30
___
### offset
• `Optional` **offset**: `number`
#### Inherited from
[AdminGetProductTypesPaginationParams](internal.AdminGetProductTypesPaginationParams.md).[offset](internal.AdminGetProductTypesPaginationParams.md#offset)
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:31
___
### order
• `Optional` **order**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:39
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:35
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:38
___
### value
• `Optional` **value**: `string` \| `string`[] \| [`StringComparisonOperator`](internal.StringComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/product-types/list-product-types.d.ts:36

55
docs/content/references/js-client/classes/internal.AdminGetProductsPaginationParams.md Normal file
View File

@@ -0,0 +1,55 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetProductsPaginationParams
[internal](../modules/internal.md).AdminGetProductsPaginationParams
## Hierarchy
- **`AdminGetProductsPaginationParams`**
↳ [`AdminGetPriceListsPriceListProductsParams`](internal.AdminGetPriceListsPriceListProductsParams.md)
↳ [`AdminGetProductsParams`](internal.AdminGetProductsParams.md)
## Properties
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61
___
### fields
• `Optional` **fields**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62
___
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59

219
docs/content/references/js-client/classes/internal.AdminGetProductsParams.md Normal file
View File

@@ -0,0 +1,219 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetProductsParams
[internal](../modules/internal.md).AdminGetProductsParams
## Hierarchy
- [`AdminGetProductsPaginationParams`](internal.AdminGetProductsPaginationParams.md)
↳ **`AdminGetProductsParams`**
## Properties
### collection\_id
• `Optional` **collection\_id**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:68
___
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:77
___
### deleted\_at
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:79
___
### description
• `Optional` **description**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:72
___
### expand
• `Optional` **expand**: `string`
#### Inherited from
[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[expand](internal.AdminGetProductsPaginationParams.md#expand)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:61
___
### fields
• `Optional` **fields**: `string`
#### Inherited from
[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[fields](internal.AdminGetProductsPaginationParams.md#fields)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:62
___
### handle
• `Optional` **handle**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:73
___
### id
• `Optional` **id**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:65
___
### is\_giftcard
• `Optional` **is\_giftcard**: `boolean`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:74
___
### limit
• `Optional` **limit**: `number`
#### Inherited from
[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[limit](internal.AdminGetProductsPaginationParams.md#limit)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:60
___
### offset
• `Optional` **offset**: `number`
#### Inherited from
[AdminGetProductsPaginationParams](internal.AdminGetProductsPaginationParams.md).[offset](internal.AdminGetProductsPaginationParams.md#offset)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:59
___
### order
• `Optional` **order**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:76
___
### price\_list\_id
• `Optional` **price\_list\_id**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:70
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:66
___
### status
• `Optional` **status**: `ProductStatus`[]
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:67
___
### tags
• `Optional` **tags**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:69
___
### title
• `Optional` **title**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:71
___
### type
• `Optional` **type**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:75
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/products/list-products.d.ts:78

33
docs/content/references/js-client/classes/internal.AdminGetRegionsPaginationParams.md Normal file
View File

@@ -0,0 +1,33 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetRegionsPaginationParams
[internal](../modules/internal.md).AdminGetRegionsPaginationParams
## Hierarchy
- **`AdminGetRegionsPaginationParams`**
↳ [`AdminGetRegionsParams`](internal.AdminGetRegionsParams.md)
## Properties
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:56
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:57

71
docs/content/references/js-client/classes/internal.AdminGetRegionsParams.md Normal file
View File

@@ -0,0 +1,71 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetRegionsParams
[internal](../modules/internal.md).AdminGetRegionsParams
## Hierarchy
- [`AdminGetRegionsPaginationParams`](internal.AdminGetRegionsPaginationParams.md)
↳ **`AdminGetRegionsParams`**
## Properties
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:60
___
### deleted\_at
• `Optional` **deleted\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:62
___
### limit
• `Optional` **limit**: `number`
#### Inherited from
[AdminGetRegionsPaginationParams](internal.AdminGetRegionsPaginationParams.md).[limit](internal.AdminGetRegionsPaginationParams.md#limit)
#### Defined in
packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:56
___
### offset
• `Optional` **offset**: `number`
#### Inherited from
[AdminGetRegionsPaginationParams](internal.AdminGetRegionsPaginationParams.md).[offset](internal.AdminGetRegionsPaginationParams.md#offset)
#### Defined in
packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:57
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/regions/list-regions.d.ts:61

17
docs/content/references/js-client/classes/internal.AdminGetRegionsRegionFulfillmentOptionsRes.md Normal file
View File

@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetRegionsRegionFulfillmentOptionsRes
[internal](../modules/internal.md).AdminGetRegionsRegionFulfillmentOptionsRes
## Properties
### fulfillment\_options
• **fulfillment\_options**: [`FulfillmentOption`](internal.FulfillmentOption.md)[]
#### Defined in
packages/medusa/dist/api/routes/admin/regions/index.d.ts:20

27
docs/content/references/js-client/classes/internal.AdminGetReturnsParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetReturnsParams
[internal](../modules/internal.md).AdminGetReturnsParams
## Properties
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/returns/list-returns.d.ts:26
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/returns/list-returns.d.ts:27

37
docs/content/references/js-client/classes/internal.AdminGetShippingOptionsParams.md Normal file
View File

@@ -0,0 +1,37 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetShippingOptionsParams
[internal](../modules/internal.md).AdminGetShippingOptionsParams
## Properties
### admin\_only
• `Optional` **admin\_only**: `boolean`
#### Defined in
packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:45
___
### is\_return
• `Optional` **is\_return**: `boolean`
#### Defined in
packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:44
___
### region\_id
• `Optional` **region\_id**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/shipping-options/list-shipping-options.d.ts:43

27
docs/content/references/js-client/classes/internal.AdminGetSwapsParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetSwapsParams
[internal](../modules/internal.md).AdminGetSwapsParams
## Properties
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:24
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/swaps/list-swaps.d.ts:25

87
docs/content/references/js-client/classes/internal.AdminGetTaxRatesParams.md Normal file
View File

@@ -0,0 +1,87 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetTaxRatesParams
[internal](../modules/internal.md).AdminGetTaxRatesParams
## Properties
### code
• `Optional` **code**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:38
___
### expand
• `Optional` **expand**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:42
___
### fields
• `Optional` **fields**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:43
___
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:41
___
### name
• `Optional` **name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:37
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:40
___
### rate
• `Optional` **rate**: `number` \| [`NumericalComparisonOperator`](internal.NumericalComparisonOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:39
___
### region\_id
• `Optional` **region\_id**: `string` \| `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/list-tax-rates.d.ts:36

27
docs/content/references/js-client/classes/internal.AdminGetTaxRatesTaxRateParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetTaxRatesTaxRateParams
[internal](../modules/internal.md).AdminGetTaxRatesTaxRateParams
## Properties
### expand
• `Optional` **expand**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:24
___
### fields
• `Optional` **fields**: `string`[]
#### Defined in
packages/medusa/dist/api/routes/admin/tax-rates/get-tax-rate.d.ts:25

37
docs/content/references/js-client/classes/internal.AdminGetVariantsParams.md Normal file
View File

@@ -0,0 +1,37 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminGetVariantsParams
[internal](../modules/internal.md).AdminGetVariantsParams
## Properties
### limit
• `Optional` **limit**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:29
___
### offset
• `Optional` **offset**: `number`
#### Defined in
packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:30
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/variants/list-variants.d.ts:28

33
docs/content/references/js-client/classes/internal.AdminListCustomerSelector.md Normal file
View File

@@ -0,0 +1,33 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminListCustomerSelector
[internal](../modules/internal.md).AdminListCustomerSelector
## Hierarchy
- **`AdminListCustomerSelector`**
↳ [`AdminGetCustomersParams`](internal.AdminGetCustomersParams.md)
## Properties
### groups
• `Optional` **groups**: `string`[]
#### Defined in
packages/medusa/dist/types/customers.d.ts:3
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/types/customers.d.ts:2

163
docs/content/references/js-client/classes/internal.AdminListOrdersSelector.md Normal file
View File

@@ -0,0 +1,163 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminListOrdersSelector
[internal](../modules/internal.md).AdminListOrdersSelector
## Hierarchy
- **`AdminListOrdersSelector`**
↳ [`AdminGetOrdersParams`](internal.AdminGetOrdersParams.md)
## Properties
### canceled\_at
• `Optional` **canceled\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/types/orders.d.ts:17
___
### cart\_id
• `Optional` **cart\_id**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:11
___
### created\_at
• `Optional` **created\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/types/orders.d.ts:18
___
### currency\_code
• `Optional` **currency\_code**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:15
___
### customer\_id
• `Optional` **customer\_id**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:12
___
### display\_id
• `Optional` **display\_id**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:10
___
### email
• `Optional` **email**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:13
___
### fulfillment\_status
• `Optional` **fulfillment\_status**: `string`[]
#### Defined in
packages/medusa/dist/types/orders.d.ts:8
___
### id
• `Optional` **id**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:6
___
### payment\_status
• `Optional` **payment\_status**: `string`[]
#### Defined in
packages/medusa/dist/types/orders.d.ts:9
___
### q
• `Optional` **q**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:5
___
### region\_id
• `Optional` **region\_id**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:14
___
### status
• `Optional` **status**: `string`[]
#### Defined in
packages/medusa/dist/types/orders.d.ts:7
___
### tax\_rate
• `Optional` **tax\_rate**: `string`
#### Defined in
packages/medusa/dist/types/orders.d.ts:16
___
### updated\_at
• `Optional` **updated\_at**: [`DateComparisonOperator`](internal.DateComparisonOperator.md)
#### Defined in
packages/medusa/dist/types/orders.d.ts:19

27
docs/content/references/js-client/classes/internal.AdminPostAuthReq.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostAuthReq
[internal](../modules/internal.md).AdminPostAuthReq
## Properties
### email
• **email**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:25
___
### password
• **password**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/auth/create-session.d.ts:26

37
docs/content/references/js-client/classes/internal.AdminPostCollectionsCollectionReq.md Normal file
View File

@@ -0,0 +1,37 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostCollectionsCollectionReq
[internal](../modules/internal.md).AdminPostCollectionsCollectionReq
## Properties
### handle
• `Optional` **handle**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:39
___
### metadata
• `Optional` **metadata**: `object`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:40
___
### title
• `Optional` **title**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/update-collection.d.ts:38

37
docs/content/references/js-client/classes/internal.AdminPostCollectionsReq.md Normal file
View File

@@ -0,0 +1,37 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostCollectionsReq
[internal](../modules/internal.md).AdminPostCollectionsReq
## Properties
### handle
• `Optional` **handle**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:39
___
### metadata
• `Optional` **metadata**: `object`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:40
___
### title
• **title**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/collections/create-collection.d.ts:38

17
docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupCustomersBatchReq.md Normal file
View File

@@ -0,0 +1,17 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostCustomerGroupsGroupCustomersBatchReq
[internal](../modules/internal.md).AdminPostCustomerGroupsGroupCustomersBatchReq
## Properties
### customer\_ids
• **customer\_ids**: [`CustomerGroupsBatchCustomer`](internal.CustomerGroupsBatchCustomer.md)[]
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/add-customers-batch.d.ts:26

27
docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsGroupReq.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostCustomerGroupsGroupReq
[internal](../modules/internal.md).AdminPostCustomerGroupsGroupReq
## Properties
### metadata
• `Optional` **metadata**: `object`
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:27
___
### name
• `Optional` **name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/update-customer-group.d.ts:26

27
docs/content/references/js-client/classes/internal.AdminPostCustomerGroupsReq.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostCustomerGroupsReq
[internal](../modules/internal.md).AdminPostCustomerGroupsReq
## Properties
### metadata
• `Optional` **metadata**: `object`
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:26
___
### name
• **name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customer-groups/create-customer-group.d.ts:25

77
docs/content/references/js-client/classes/internal.AdminPostCustomersCustomerReq.md Normal file
View File

@@ -0,0 +1,77 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostCustomersCustomerReq
[internal](../modules/internal.md).AdminPostCustomersCustomerReq
## Properties
### email
• `Optional` **email**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:60
___
### first\_name
• `Optional` **first\_name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:61
___
### groups
• `Optional` **groups**: [`Group`](internal.Group.md)[]
#### Defined in
packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:66
___
### last\_name
• `Optional` **last\_name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:62
___
### metadata
• `Optional` **metadata**: `object`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:65
___
### password
• `Optional` **password**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:63
___
### phone
• `Optional` **phone**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/update-customer.d.ts:64

67
docs/content/references/js-client/classes/internal.AdminPostCustomersReq.md Normal file
View File

@@ -0,0 +1,67 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostCustomersReq
[internal](../modules/internal.md).AdminPostCustomersReq
## Properties
### email
• **email**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:28
___
### first\_name
• **first\_name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:29
___
### last\_name
• **last\_name**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:30
___
### metadata
• `Optional` **metadata**: `object`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:33
___
### password
• **password**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:31
___
### phone
• `Optional` **phone**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/customers/create-customer.d.ts:32

93
docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditions.md Normal file
View File

@@ -0,0 +1,93 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostDiscountsDiscountConditions
[internal](../modules/internal.md).AdminPostDiscountsDiscountConditions
## Hierarchy
- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md)
↳ **`AdminPostDiscountsDiscountConditions`**
## Properties
### customer\_groups
• `Optional` **customer\_groups**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups)
#### Defined in
packages/medusa/dist/types/discount.d.ts:21
___
### operator
• **operator**: [`DiscountConditionOperator`](../enums/internal.DiscountConditionOperator.md)
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/create-condition.d.ts:53
___
### product\_collections
• `Optional` **product\_collections**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections)
#### Defined in
packages/medusa/dist/types/discount.d.ts:18
___
### product\_tags
• `Optional` **product\_tags**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags)
#### Defined in
packages/medusa/dist/types/discount.d.ts:20
___
### product\_types
• `Optional` **product\_types**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types)
#### Defined in
packages/medusa/dist/types/discount.d.ts:19
___
### products
• `Optional` **products**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products)
#### Defined in
packages/medusa/dist/types/discount.d.ts:17

83
docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsCondition.md Normal file
View File

@@ -0,0 +1,83 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostDiscountsDiscountConditionsCondition
[internal](../modules/internal.md).AdminPostDiscountsDiscountConditionsCondition
## Hierarchy
- [`AdminUpsertConditionsReq`](internal.AdminUpsertConditionsReq.md)
↳ **`AdminPostDiscountsDiscountConditionsCondition`**
## Properties
### customer\_groups
• `Optional` **customer\_groups**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[customer_groups](internal.AdminUpsertConditionsReq.md#customer_groups)
#### Defined in
packages/medusa/dist/types/discount.d.ts:21
___
### product\_collections
• `Optional` **product\_collections**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_collections](internal.AdminUpsertConditionsReq.md#product_collections)
#### Defined in
packages/medusa/dist/types/discount.d.ts:18
___
### product\_tags
• `Optional` **product\_tags**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_tags](internal.AdminUpsertConditionsReq.md#product_tags)
#### Defined in
packages/medusa/dist/types/discount.d.ts:20
___
### product\_types
• `Optional` **product\_types**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[product_types](internal.AdminUpsertConditionsReq.md#product_types)
#### Defined in
packages/medusa/dist/types/discount.d.ts:19
___
### products
• `Optional` **products**: `string`[]
#### Inherited from
[AdminUpsertConditionsReq](internal.AdminUpsertConditionsReq.md).[products](internal.AdminUpsertConditionsReq.md#products)
#### Defined in
packages/medusa/dist/types/discount.d.ts:17

27
docs/content/references/js-client/classes/internal.AdminPostDiscountsDiscountConditionsConditionParams.md Normal file
View File

@@ -0,0 +1,27 @@
---
displayed_sidebar: jsClientSidebar
---
# Class: AdminPostDiscountsDiscountConditionsConditionParams
[internal](../modules/internal.md).AdminPostDiscountsDiscountConditionsConditionParams
## Properties
### expand
• `Optional` **expand**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/update-condition.d.ts:53
___
### fields
• `Optional` **fields**: `string`
#### Defined in
packages/medusa/dist/api/routes/admin/discounts/update-condition.d.ts:54

Some files were not shown because too many files have changed in this diff Show More