medusa-store/docs/content/references/services/classes/RegionService.md

Class: RegionService

Hierarchy

• "medusa-interfaces"

  ↳ RegionService

Constructors

constructor

• new RegionService(__namedParameters)

Parameters

Name	Type
__namedParameters	Object

Overrides

BaseService.constructor

Defined in

services/region.js:16

Properties

Events

▪ Static Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
UPDATED	string

Defined in

services/region.js:10

Methods

addCountry

▸ addCountry(regionId, code): Promise<any>

Parameters

Name	Type	Description
regionId	string
code	string

Returns

Promise<any>

Defined in

services/region.js:462

---

addFulfillmentProvider

▸ addFulfillmentProvider(regionId, providerId): Promise<any>

Parameters

Name	Type	Description
regionId	string
providerId	string

Returns

Promise<any>

Defined in

services/region.js:582

---

addPaymentProvider

▸ addPaymentProvider(regionId, providerId): Promise<any>

Parameters

Name	Type	Description
regionId	string
providerId	string

Returns

Promise<any>

Defined in

services/region.js:535

---

create

▸ create(regionObject): Region

Parameters

Name	Type	Description
regionObject	Region

Returns

Region

Defined in

services/region.js:95

---

delete

▸ delete(regionId): Promise<any>

Parameters

Name	Type	Description
regionId	string

Returns

Promise<any>

Defined in

services/region.js:432

---

list

▸ list(selector?, config?): Promise<any>

Parameters

Name	Type	Description
selector	any
config	any

Returns

Promise<any>

Defined in

services/region.js:420

---

removeCountry

▸ removeCountry(regionId, code): Promise<any>

Parameters

Name	Type	Description
regionId	string
code	string

Returns

Promise<any>

Defined in

services/region.js:499

---

removeFulfillmentProvider

▸ removeFulfillmentProvider(regionId, providerId): Promise<any>

Parameters

Name	Type	Description
regionId	string
providerId	string

Returns

Promise<any>

Defined in

services/region.js:660

---

removePaymentProvider

▸ removePaymentProvider(regionId, providerId): Promise<any>

Parameters

Name	Type	Description
regionId	string
providerId	string

Returns

Promise<any>

Defined in

services/region.js:626

---

retrieve

▸ retrieve(regionId, config?): Region

Parameters

Name	Type	Description
regionId	string
config	any

Returns

Region

Defined in

services/region.js:396

---

retrieveByCountryCode

▸ retrieveByCountryCode(code, config?): Promise<Region>

Parameters

Name	Type
code	any
config	Object

Returns

Promise<Region>

Defined in

services/region.js:362

---

update

▸ update(regionId, update): Promise<any>

Parameters

Name	Type	Description
regionId	string
update	any

Returns

Promise<any>

Defined in

services/region.js:153

---

validateCountry_

▸ validateCountry_(code, regionId): Promise<any>

Parameters

Name	Type	Description
code	string
regionId	string

Returns

Promise<any>

Defined in

services/region.js:323

---

validateCurrency_

▸ validateCurrency_(currencyCode): Promise<void>

Parameters

Name	Type	Description
currencyCode	string

Returns

Promise<void>

Defined in

services/region.js:302

---

validateFields_

▸ validateFields_(region, id?): any

Parameters

Name	Type	Default value	Description
region	any	undefined
id	null | string	undefined

Returns

any

Defined in

services/region.js:213

---

validateTaxRate_

▸ validateTaxRate_(taxRate): void

Parameters

Name	Type	Description
taxRate	number

Returns

void

Defined in

services/region.js:289

---

withTransaction

▸ withTransaction(transactionManager): RegionService

Parameters

Name	Type
transactionManager	any

Returns

RegionService

Defined in

services/region.js:65