Skip to main content

Class: AdminRegionsResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

addCountry

addCountry(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

adds a country to the list of countries in a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardregion id
Copy to ClipboardCopy to Clipboardcountry data
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:103


addFulfillmentProvider

addFulfillmentProvider(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

adds a fulfillment provider to a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardregion id
Copy to ClipboardCopy to Clipboardfulfillment provider data
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:135


addPaymentProvider

addPaymentProvider(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

adds a payment provider to a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardregion id
Copy to ClipboardCopy to Clipboardpayment provider data
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:181


create

create(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

creates a region.

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

created region.

Defined in

medusa-js/src/resources/admin/regions.ts:24


delete

delete(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

deletes a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of region to delete.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

Deleted response

Defined in

medusa-js/src/resources/admin/regions.ts:54


deleteCountry

deleteCountry(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

remove a country from a region's list of coutnries

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardregion id
Copy to ClipboardCopy to Clipboardthe 2 character ISO code for the Country.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:119


deleteFulfillmentProvider

deleteFulfillmentProvider(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

remove a fulfillment provider from a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardregion id
Copy to ClipboardCopy to Clipboardthe if of the fulfillment provider
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:151


deletePaymentProvider

deletePaymentProvider(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

removes a payment provider from a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardregion id
Copy to ClipboardCopy to Clipboardthe id of the payment provider
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

updated region

Defined in

medusa-js/src/resources/admin/regions.ts:197


list

list(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

lists regions matching a query

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardquery for searching regions
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

a list of regions matching the query.

Defined in

medusa-js/src/resources/admin/regions.ts:82


retrieve

retrieve(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

get a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the region to retrieve.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the region with the given id

Defined in

medusa-js/src/resources/admin/regions.ts:68


retrieveFulfillmentOptions

retrieveFulfillmentOptions(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

retrieves the list of fulfillment options available in a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardregion id
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

list of fulfillment options

Defined in

medusa-js/src/resources/admin/regions.ts:166


update

update(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

updates a region

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the region to update.
Copy to ClipboardCopy to Clipboardupdate to apply to region.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the updated region.

Defined in

medusa-js/src/resources/admin/regions.ts:39