Files

Shahed Nasser 02d5c1da88 docs: update Typedoc and regenerate references (#1994 )

* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client

2022-08-04 17:29:52 +03:00

9.6 KiB

Raw Blame History

Class: RegionService

Provides layer to manipulate regions.

Hierarchy

"medusa-interfaces"

↳ RegionService

Constructors

constructor

• new RegionService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`Object`

Overrides

BaseService.constructor

Defined in

packages/medusa/src/services/region.js:16

Properties

Events

▪ Static Events: Object

Type declaration

Name	Type
`CREATED`	`string`
`DELETED`	`string`
`UPDATED`	`string`

Defined in

packages/medusa/src/services/region.js:10

Methods

addCountry

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

Adds a country to the region.

Parameters

Name	Type	Description
`regionId`	`string`	the region to add a country to
`code`	`string`	a 2 digit alphanumeric ISO country code.

Returns

Promise<any>

the result of the update operation

Defined in

packages/medusa/src/services/region.js:462

addFulfillmentProvider

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

Adds a fulfillment provider that is available in the region. Fails if the provider doesn't exist.

Parameters

Name	Type	Description
`regionId`	`string`	the region to add the provider to
`providerId`	`string`	the provider to add to the region

Returns

Promise<any>

the result of the update operation

Defined in

packages/medusa/src/services/region.js:582

addPaymentProvider

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

Adds a payment provider that is available in the region. Fails if the provider doesn't exist.

Parameters

Name	Type	Description
`regionId`	`string`	the region to add the provider to
`providerId`	`string`	the provider to add to the region

Returns

Promise<any>

the result of the update operation

Defined in

packages/medusa/src/services/region.js:535

create

▸ create(regionObject): Region

Creates a region.

Parameters

Name	Type	Description
`regionObject`	`Region`	the unvalidated region

Returns

Region

the newly created region

Defined in

packages/medusa/src/services/region.js:95

delete

▸ delete(regionId): Promise<any>

Deletes a region.

Parameters

Name	Type	Description
`regionId`	`string`	the region to delete

Returns

Promise<any>

the result of the delete operation

Defined in

packages/medusa/src/services/region.js:432

list

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

Lists all regions based on a query

Parameters

Name	Type	Description
`selector`	`any`	query object for find
`config`	`any`	configuration settings

Returns

Promise<any>

result of the find operation

Defined in

packages/medusa/src/services/region.js:420

removeCountry

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

Removes a country from a Region

Parameters

Name	Type	Description
`regionId`	`string`	the region to remove from
`code`	`string`	a 2 digit alphanumeric ISO country code to remove

Returns

Promise<any>

the result of the update operation

Defined in

packages/medusa/src/services/region.js:499

removeFulfillmentProvider

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

Removes a fulfillment provider from a region. Is idempotent.

Parameters

Name	Type	Description
`regionId`	`string`	the region to remove the provider from
`providerId`	`string`	the provider to remove from the region

Returns

Promise<any>

the result of the update operation

Defined in

packages/medusa/src/services/region.js:660

removePaymentProvider

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

Removes a payment provider from a region. Is idempotent.

Parameters

Name	Type	Description
`regionId`	`string`	the region to remove the provider from
`providerId`	`string`	the provider to remove from the region

Returns

Promise<any>

the result of the update operation

Defined in

packages/medusa/src/services/region.js:626

retrieve

▸ retrieve(regionId, config?): Region

Retrieves a region by its id.

Parameters

Name	Type	Description
`regionId`	`string`	the id of the region to retrieve
`config`	`any`	configuration settings

Returns

Region

the region

Defined in

packages/medusa/src/services/region.js:396

retrieveByCountryCode

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

Parameters

Name	Type
`code`	`any`
`config`	`Object`

Returns

Promise<Region>

Defined in

packages/medusa/src/services/region.js:362

update

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

Updates a region

Parameters

Name	Type	Description
`regionId`	`string`	the region to update
`update`	`any`	the data to update the region with

Returns

Promise<any>

the result of the update operation

Defined in

packages/medusa/src/services/region.js:153

validateCountry_

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

Validates a country code. Will normalize the code before checking for existence.

Parameters

Name	Type	Description
`code`	`string`	a 2 digit alphanumeric ISO country code
`regionId`	`string`	the id of the current region to check against

Returns

Promise<any>

Defined in

packages/medusa/src/services/region.js:323

validateCurrency_

▸ validateCurrency_(currencyCode): Promise<void>

Validates a currency code. Will throw if the currency code doesn't exist.

Parameters

Name	Type	Description
`currencyCode`	`string`	an ISO currency code

Returns

Promise<void>

Defined in

packages/medusa/src/services/region.js:302

validateFields_

▸ validateFields_(region, id?): any

Validates fields for creation and updates. If the region already exisits the id can be passed to check that country updates are allowed.

Parameters

Name	Type	Default value	Description
`region`	`any`	`undefined`	the region data to validate
`id`	`null` \| `string`	`undefined`	optional id of the region to check against

Returns

any

the validated region data

Defined in

packages/medusa/src/services/region.js:213

validateTaxRate_

▸ validateTaxRate_(taxRate): void

Validates a tax rate. Will throw if the tax rate is not between 0 and 1.

Parameters

Name	Type	Description
`taxRate`	`number`	a number representing the tax rate of the region

Returns

void

Defined in

packages/medusa/src/services/region.js:289

withTransaction

▸ withTransaction(transactionManager): RegionService

Parameters

Name	Type
`transactionManager`	`any`

Returns

RegionService

Defined in

packages/medusa/src/services/region.js:65

9.6 KiB Raw Blame History

Class: RegionService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

Events

Type declaration

Defined in

Methods

addCountry

Parameters

Returns

Defined in

addFulfillmentProvider

Parameters

Returns

Defined in

addPaymentProvider

Parameters

Returns

Defined in

create

Parameters

Returns

Defined in

delete

Parameters

Returns

Defined in

list

Parameters

Returns

Defined in

removeCountry

Parameters

Returns

Defined in

removeFulfillmentProvider

Parameters

Returns

Defined in

removePaymentProvider

Parameters

Returns

Defined in

retrieve

Parameters

Returns

Defined in

retrieveByCountryCode

Parameters

Returns

Defined in

update

Parameters

Returns

Defined in

validateCountry_

Parameters

Returns

Defined in

validateCurrency_

Parameters

Returns

Defined in

validateFields_

Parameters

Returns

Defined in

validateTaxRate_

Parameters

Returns

Defined in

withTransaction

Parameters

Returns

9.6 KiB

Raw Blame History