Class: AdminRegionsResource
Hierarchy
defaultCopy to Clipboard↳
AdminRegionsResourceCopy to Clipboard
Methods
addCountry
▸ addCountry(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
adds a country to the list of countries in a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | region id |
payloadCopy to Clipboard | AdminPostRegionsRegionCountriesReqCopy to Clipboard | country data |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:103
addFulfillmentProvider
▸ addFulfillmentProvider(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
adds a fulfillment provider to a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | region id |
payloadCopy to Clipboard | AdminPostRegionsRegionFulfillmentProvidersReqCopy to Clipboard | fulfillment provider data |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:135
addPaymentProvider
▸ addPaymentProvider(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
adds a payment provider to a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | region id |
payloadCopy to Clipboard | AdminPostRegionsRegionPaymentProvidersReqCopy to Clipboard | payment provider data |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:181
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
creates a region.
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostRegionsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
created region.
Defined in
medusa-js/src/resources/admin/regions.ts:24
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
DescriptionCopy to Clipboard
deletes a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of region to delete. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
Deleted response
Defined in
medusa-js/src/resources/admin/regions.ts:54
deleteCountry
▸ deleteCountry(idCopy to Clipboard, country_codeCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
remove a country from a region's list of coutnries
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | region id |
country_codeCopy to Clipboard | stringCopy to Clipboard | the 2 character ISO code for the Country. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:119
deleteFulfillmentProvider
▸ deleteFulfillmentProvider(idCopy to Clipboard, provider_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
remove a fulfillment provider from a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | region id |
provider_idCopy to Clipboard | stringCopy to Clipboard | the if of the fulfillment provider |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:151
deletePaymentProvider
▸ deletePaymentProvider(idCopy to Clipboard, provider_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
removes a payment provider from a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | region id |
provider_idCopy to Clipboard | stringCopy to Clipboard | the id of the payment provider |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
updated region
Defined in
medusa-js/src/resources/admin/regions.ts:197
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsListResCopy to Clipboard>
DescriptionCopy to Clipboard
lists regions matching a query
Parameters
| Name | Type | Description |
|---|---|---|
query?Copy to Clipboard | AdminGetRegionsParamsCopy to Clipboard | query for searching regions |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsListResCopy to Clipboard>
a list of regions matching the query.
Defined in
medusa-js/src/resources/admin/regions.ts:82
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
get a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the region to retrieve. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
the region with the given id
Defined in
medusa-js/src/resources/admin/regions.ts:68
retrieveFulfillmentOptions
▸ retrieveFulfillmentOptions(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminGetRegionsRegionFulfillmentOptionsResCopy to Clipboard>
DescriptionCopy to Clipboard
retrieves the list of fulfillment options available in a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | region id |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminGetRegionsRegionFulfillmentOptionsResCopy to Clipboard>
list of fulfillment options
Defined in
medusa-js/src/resources/admin/regions.ts:166
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
DescriptionCopy to Clipboard
updates a region
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the region to update. |
payloadCopy to Clipboard | AdminPostRegionsRegionReqCopy to Clipboard | update to apply to region. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminRegionsResCopy to Clipboard>
the updated region.