Class: AdminRegionsResource
Hierarchy
default
Copy to Clipboard↳
AdminRegionsResource
Copy to Clipboard
Methods
addCountry
▸ addCountry(id
Copy to Clipboard, payload
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
adds a country to the list of countries in a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | region id |
payload Copy to Clipboard | AdminPostRegionsRegionCountriesReq Copy to Clipboard | country data |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:103
addFulfillmentProvider
▸ addFulfillmentProvider(id
Copy to Clipboard, payload
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
adds a fulfillment provider to a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | region id |
payload Copy to Clipboard | AdminPostRegionsRegionFulfillmentProvidersReq Copy to Clipboard | fulfillment provider data |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:135
addPaymentProvider
▸ addPaymentProvider(id
Copy to Clipboard, payload
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
adds a payment provider to a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | region id |
payload Copy to Clipboard | AdminPostRegionsRegionPaymentProvidersReq Copy to Clipboard | payment provider data |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:181
create
▸ create(payload
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
creates a region.
Parameters
Name | Type |
---|---|
payload Copy to Clipboard | AdminPostRegionsReq Copy to Clipboard |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
created region.
Defined in
medusa-js/src/resources/admin/regions.ts:24
delete
▸ delete(id
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<DeleteResponse
Copy to Clipboard>
Description
Copy to Clipboard
deletes a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | id of region to delete. |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<DeleteResponse
Copy to Clipboard>
Deleted response
Defined in
medusa-js/src/resources/admin/regions.ts:54
deleteCountry
▸ deleteCountry(id
Copy to Clipboard, country_code
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
remove a country from a region's list of coutnries
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | region id |
country_code Copy to Clipboard | string Copy to Clipboard | the 2 character ISO code for the Country. |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:119
deleteFulfillmentProvider
▸ deleteFulfillmentProvider(id
Copy to Clipboard, provider_id
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
remove a fulfillment provider from a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | region id |
provider_id Copy to Clipboard | string Copy to Clipboard | the if of the fulfillment provider |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:151
deletePaymentProvider
▸ deletePaymentProvider(id
Copy to Clipboard, provider_id
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
removes a payment provider from a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | region id |
provider_id Copy to Clipboard | string Copy to Clipboard | the id of the payment provider |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:197
list
▸ list(query?
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsListRes
Copy to Clipboard>
Description
Copy to Clipboard
lists regions matching a query
Parameters
Name | Type | Description |
---|---|---|
query? Copy to Clipboard | AdminGetRegionsParams Copy to Clipboard | query for searching regions |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsListRes
Copy to Clipboard>
a list of regions matching the query.
Defined in
medusa-js/src/resources/admin/regions.ts:82
retrieve
▸ retrieve(id
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
get a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | id of the region to retrieve. |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
the region with the given id
Defined in
medusa-js/src/resources/admin/regions.ts:68
retrieveFulfillmentOptions
▸ retrieveFulfillmentOptions(id
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminGetRegionsRegionFulfillmentOptionsRes
Copy to Clipboard>
Description
Copy to Clipboard
retrieves the list of fulfillment options available in a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | region id |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminGetRegionsRegionFulfillmentOptionsRes
Copy to Clipboard>
list of fulfillment options
Defined in
medusa-js/src/resources/admin/regions.ts:166
update
▸ update(id
Copy to Clipboard, payload
Copy to Clipboard, customHeaders?
Copy to Clipboard): ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
Description
Copy to Clipboard
updates a region
Parameters
Name | Type | Description |
---|---|---|
id Copy to Clipboard | string Copy to Clipboard | id of the region to update. |
payload Copy to Clipboard | AdminPostRegionsRegionReq Copy to Clipboard | update to apply to region. |
customHeaders Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, any Copy to Clipboard> |
Returns
ResponsePromise
Copy to Clipboard<AdminRegionsRes
Copy to Clipboard>
the updated region.