3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
12 KiB
Class: AdminRegionsResource
Hierarchy
-
default↳
AdminRegionsResource
Methods
addCountry
▸ addCountry(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>
description adds a country to the list of countries in a region
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
region id |
payload |
AdminPostRegionsRegionCountriesReq |
country data |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
updated region
Defined in
packages/medusa-js/src/resources/admin/regions.ts:120
addFulfillmentProvider
▸ addFulfillmentProvider(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>
description adds a fulfillment provider to a region
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
region id |
payload |
AdminPostRegionsRegionFulfillmentProvidersReq |
fulfillment provider data |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
updated region
Defined in
packages/medusa-js/src/resources/admin/regions.ts:152
addPaymentProvider
▸ addPaymentProvider(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>
description adds a payment provider to a region
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
region id |
payload |
AdminPostRegionsRegionPaymentProvidersReq |
payment provider data |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
updated region
Defined in
packages/medusa-js/src/resources/admin/regions.ts:198
create
▸ create(payload, customHeaders?): ResponsePromise<AdminRegionsRes>
description creates a region.
Parameters
| Name | Type |
|---|---|
payload |
AdminPostRegionsReq |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
created region.
Defined in
packages/medusa-js/src/resources/admin/regions.ts:25
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
description deletes a region
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of region to delete. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
Deleted response
Defined in
packages/medusa-js/src/resources/admin/regions.ts:52
deleteCountry
▸ deleteCountry(id, country_code, customHeaders?): ResponsePromise<AdminRegionsRes>
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<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
updated region
Defined in
packages/medusa-js/src/resources/admin/regions.ts:136
deleteFulfillmentProvider
▸ deleteFulfillmentProvider(id, provider_id, customHeaders?): ResponsePromise<AdminRegionsRes>
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<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
updated region
Defined in
packages/medusa-js/src/resources/admin/regions.ts:168
deleteMetadata
▸ deleteMetadata(id, key, customHeaders?): ResponsePromise<AdminRegionsRes>
description delete a region's metadata key value pair
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
region id |
key |
string |
metadata key |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
updated region
Defined in
packages/medusa-js/src/resources/admin/regions.ts:108
deletePaymentProvider
▸ deletePaymentProvider(id, provider_id, customHeaders?): ResponsePromise<AdminRegionsRes>
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<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
updated region
Defined in
packages/medusa-js/src/resources/admin/regions.ts:214
list
▸ list(query?, customHeaders?): ResponsePromise<AdminRegionsListRes>
description lists regions matching a query
Parameters
| Name | Type | Description |
|---|---|---|
query? |
AdminGetRegionsParams |
query for searching regions |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsListRes>
a list of regions matching the query.
Defined in
packages/medusa-js/src/resources/admin/regions.ts:74
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminRegionsRes>
description get a region
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the region to retrieve. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
the region with the given id
Defined in
packages/medusa-js/src/resources/admin/regions.ts:63
retrieveFulfillmentOptions
▸ retrieveFulfillmentOptions(id, customHeaders?): ResponsePromise<AdminGetRegionsRegionFulfillmentOptionsRes>
description retrieves the list of fulfillment options available in a region
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
region id |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminGetRegionsRegionFulfillmentOptionsRes>
list of fulfillment options
Defined in
packages/medusa-js/src/resources/admin/regions.ts:183
setMetadata
▸ setMetadata(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>
description adds metadata to a region
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
region id |
payload |
AdminPostRegionsRegionMetadata |
metadata |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
updated region
Defined in
packages/medusa-js/src/resources/admin/regions.ts:92
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>
description updates a region
Parameters
| Name | Type | Description |
|---|---|---|
id |
string |
id of the region to update. |
payload |
AdminPostRegionsRegionReq |
update to apply to region. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminRegionsRes>
the updated region.