AdminRegionsResource

admin/regions.AdminRegionsResource

Methods

addCountry

addCountry(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

idstringRequired

region id

payloadAdminPostRegionsRegionCountriesReqRequired

country data

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

updated region

Description

adds a country to the list of countries in a region

---

addFulfillmentProvider

addFulfillmentProvider(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

idstringRequired

region id

payloadAdminPostRegionsRegionFulfillmentProvidersReqRequired

fulfillment provider data

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

updated region

Description

adds a fulfillment provider to a region

---

addPaymentProvider

addPaymentProvider(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

idstringRequired

region id

payloadAdminPostRegionsRegionPaymentProvidersReqRequired

payment provider data

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

updated region

Description

adds a payment provider to a region

---

create

create(payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

payloadAdminPostRegionsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

created region.

Description

creates a region.

---

delete

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters

idstringRequired

id of region to delete.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

Deleted response

Description

deletes a region

---

deleteCountry

deleteCountry(id, country_code, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

idstringRequired

region id

country_codestringRequired

the 2 character ISO code for the Country.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

updated region

Description

remove a country from a region's list of coutnries

---

deleteFulfillmentProvider

deleteFulfillmentProvider(id, provider_id, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

idstringRequired

region id

provider_idstringRequired

the if of the fulfillment provider

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

updated region

Description

remove a fulfillment provider from a region

---

deletePaymentProvider

deletePaymentProvider(id, provider_id, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

idstringRequired

region id

provider_idstringRequired

the id of the payment provider

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

updated region

Description

removes a payment provider from a region

---

list

list(query?, customHeaders?): ResponsePromise<AdminRegionsListRes>

Parameters

queryAdminGetRegionsParams

query for searching regions

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsListRes>

ResponsePromiseResponsePromise<AdminRegionsListRes>Required

a list of regions matching the query.

Description

lists regions matching a query

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

idstringRequired

id of the region to retrieve.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

the region with the given id

Description

get a region

---

retrieveFulfillmentOptions

retrieveFulfillmentOptions(id, customHeaders?): ResponsePromise<AdminGetRegionsRegionFulfillmentOptionsRes>

Parameters

idstringRequired

region id

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminGetRegionsRegionFulfillmentOptionsRes>

ResponsePromiseResponsePromise<AdminGetRegionsRegionFulfillmentOptionsRes>Required

list of fulfillment options

Description

retrieves the list of fulfillment options available in a region

---

update

update(id, payload, customHeaders?): ResponsePromise<AdminRegionsRes>

Parameters

idstringRequired

id of the region to update.

payloadAdminPostRegionsRegionReqRequired

update to apply to region.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminRegionsRes>

ResponsePromiseResponsePromise<AdminRegionsRes>Required

the updated region.

Description

updates a region