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

chore(docs): Generated JS Client Reference (automated) (#2660)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-28 11:02:11 +02:00
committed by GitHub
co-authored by olivermrbl
parent 3cee0bc8fc
commit ee14155eb7
238 changed files with 2768 additions and 1718 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/js-client/classes/AdminRegionsResource.md
+40 -40
View File
@@ -10,7 +10,7 @@
### addCountry
▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **addCountry**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -21,24 +21,24 @@ adds a country to the list of countries in a region
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-19.AdminPostRegionsRegionCountriesReq.md) | country data |
| `payload` | [`AdminPostRegionsRegionCountriesReq`](internal-22.AdminPostRegionsRegionCountriesReq.md) | country data |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region
#### Defined in
[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L103)
[medusa-js/src/resources/admin/regions.ts:103](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L103)
___
### addFulfillmentProvider
▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **addFulfillmentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -49,24 +49,24 @@ adds a fulfillment provider to a region
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data |
| `payload` | [`AdminPostRegionsRegionFulfillmentProvidersReq`](internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md) | fulfillment provider data |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region
#### Defined in
[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L135)
[medusa-js/src/resources/admin/regions.ts:135](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L135)
___
### addPaymentProvider
▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **addPaymentProvider**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -77,24 +77,24 @@ adds a payment provider to a region
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | region id |
| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-19.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data |
| `payload` | [`AdminPostRegionsRegionPaymentProvidersReq`](internal-22.AdminPostRegionsRegionPaymentProvidersReq.md) | payment provider data |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region
#### Defined in
[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L181)
[medusa-js/src/resources/admin/regions.ts:181](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L181)
___
### create
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **create**(`payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -104,18 +104,18 @@ creates a region.
| Name | Type |
| :------ | :------ |
| `payload` | [`AdminPostRegionsReq`](internal-19.AdminPostRegionsReq.md) |
| `payload` | [`AdminPostRegionsReq`](internal-22.AdminPostRegionsReq.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
created region.
#### Defined in
[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L24)
[medusa-js/src/resources/admin/regions.ts:24](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L24)
___
@@ -142,13 +142,13 @@ Deleted response
#### Defined in
[medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L54)
[medusa-js/src/resources/admin/regions.ts:54](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L54)
___
### deleteCountry
▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **deleteCountry**(`id`, `country_code`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -164,19 +164,19 @@ remove a country from a region's list of coutnries
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region
#### Defined in
[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L119)
[medusa-js/src/resources/admin/regions.ts:119](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L119)
___
### deleteFulfillmentProvider
▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **deleteFulfillmentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -192,19 +192,19 @@ remove a fulfillment provider from a region
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region
#### Defined in
[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L151)
[medusa-js/src/resources/admin/regions.ts:151](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L151)
___
### deletePaymentProvider
▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **deletePaymentProvider**(`id`, `provider_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -220,19 +220,19 @@ removes a payment provider from a region
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
updated region
#### Defined in
[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L197)
[medusa-js/src/resources/admin/regions.ts:197](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L197)
___
### list
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-19.md#adminregionslistres)\>
▸ **list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.md#adminregionslistres)\>
**`Description`**
@@ -242,24 +242,24 @@ lists regions matching a query
| Name | Type | Description |
| :------ | :------ | :------ |
| `query?` | [`AdminGetRegionsParams`](internal-19.AdminGetRegionsParams.md) | query for searching regions |
| `query?` | [`AdminGetRegionsParams`](internal-22.AdminGetRegionsParams.md) | query for searching regions |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-19.md#adminregionslistres)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsListRes`](../modules/internal-22.md#adminregionslistres)\>
a list of regions matching the query.
#### Defined in
[medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L82)
[medusa-js/src/resources/admin/regions.ts:82](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L82)
___
### retrieve
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **retrieve**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -274,19 +274,19 @@ get a region
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
the region with the given id
#### Defined in
[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L68)
[medusa-js/src/resources/admin/regions.ts:68](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L68)
___
### retrieveFulfillmentOptions
▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
▸ **retrieveFulfillmentOptions**(`id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
**`Description`**
@@ -301,19 +301,19 @@ retrieves the list of fulfillment options available in a region
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminGetRegionsRegionFulfillmentOptionsRes`](internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)\>
list of fulfillment options
#### Defined in
[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L166)
[medusa-js/src/resources/admin/regions.ts:166](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L166)
___
### update
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
▸ **update**(`id`, `payload`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
**`Description`**
@@ -324,15 +324,15 @@ updates a region
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `string` | id of the region to update. |
| `payload` | [`AdminPostRegionsRegionReq`](internal-19.AdminPostRegionsRegionReq.md) | update to apply to region. |
| `payload` | [`AdminPostRegionsRegionReq`](internal-22.AdminPostRegionsRegionReq.md) | update to apply to region. |
| `customHeaders` | `Record`<`string`, `any`\> | |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-19.AdminRegionsRes.md)\>
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`AdminRegionsRes`](internal-22.AdminRegionsRes.md)\>
the updated region.
#### Defined in
[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/admin/regions.ts#L39)
[medusa-js/src/resources/admin/regions.ts:39](https://github.com/medusajs/medusa/blob/105c68929/packages/medusa-js/src/resources/admin/regions.ts#L39)