asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
febbf398ef1ffbbf0f75d55411f768749eaed99e
medusa-store/www/apps/docs/content/references/services/classes/RegionService.md
github-actions[bot] aa2bb7a31b chore(docs): Generated References (#5516) 
Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-02 09:16:47 +00:00

18 KiB
Raw Blame History

RegionService

Provides layer to manipulate regions.

Hierarchy

  • TransactionBaseService

    ↳ RegionService

Constructors

constructor

new RegionService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/region.ts:64

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

countryRepository_

Protected Readonly countryRepository_: Repository<Country>

Defined in

medusa/src/services/region.ts:56

currencyRepository_

Protected Readonly currencyRepository_: Repository<Currency>

Defined in

medusa/src/services/region.ts:57

eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/region.ts:51

featureFlagRouter_

Protected featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/region.ts:49

fulfillmentProviderRepository_

Protected Readonly fulfillmentProviderRepository_: Repository<FulfillmentProvider>

Defined in

medusa/src/services/region.ts:61

fulfillmentProviderService_

Protected Readonly fulfillmentProviderService_: FulfillmentProviderService

Defined in

medusa/src/services/region.ts:54

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

paymentProviderRepository_

Protected Readonly paymentProviderRepository_: Repository<PaymentProvider>

Defined in

medusa/src/services/region.ts:59

paymentProviderService_

Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

medusa/src/services/region.ts:53

regionRepository_

Protected Readonly regionRepository_: Repository<Region>

Defined in

medusa/src/services/region.ts:55

storeService_

Protected Readonly storeService_: StoreService

Defined in

medusa/src/services/region.ts:52

taxProviderRepository_

Protected Readonly taxProviderRepository_: Repository<TaxProvider>

Defined in

medusa/src/services/region.ts:62

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Events

Static Events: Object

Type declaration

Name Type
CREATED string
DELETED string
UPDATED string

Defined in

medusa/src/services/region.ts:43

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

addCountry

addCountry(regionId, code): Promise<Region>

Adds a country to the region.

Parameters

Name Description
regionId string
code string

Returns

Promise<Region>

-Promise: the updated Region -Region:

Defined in

medusa/src/services/region.ts:577

addFulfillmentProvider

addFulfillmentProvider(regionId, providerId): Promise<Region>

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

Parameters

Name Description
regionId string
providerId string

Returns

Promise<Region>

-Promise: the updated Region -Region:

Defined in

medusa/src/services/region.ts:705

addPaymentProvider

addPaymentProvider(regionId, providerId): Promise<Region>

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

Parameters

Name Description
regionId string
providerId string

Returns

Promise<Region>

-Promise: the updated Region -Region:

Defined in

medusa/src/services/region.ts:656

atomicPhase_

Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Name
TResult
TError

Parameters

Name Description
work (transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler? IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail? (error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

create

create(data): Promise<Region>

Creates a region.

Parameters

Name Description
data CreateRegionInput

Returns

Promise<Region>

-Promise: the newly created region -Region:

Defined in

medusa/src/services/region.ts:100

delete

delete(regionId): Promise<void>

Deletes a region.

Parameters

Name Description
regionId string

Returns

Promise<void>

-Promise: the result of the delete operation

Defined in

medusa/src/services/region.ts:546

list

list(selector?, config?): Promise<Region[]>

Lists all regions based on a query

Parameters

Name Description
selector Selector<Region>
config FindConfig<Region>

Returns

Promise<Region[]>

-Promise: result of the find operation -Region[]: -Region:

Defined in

medusa/src/services/region.ts:505

listAndCount

listAndCount(selector?, config?): Promise<[Region[], number]>

Lists all regions based on a query and returns them along with count

Parameters

Name Description
selector Selector<Region>
config FindConfig<Region>

Returns

Promise<[Region[], number]>

-Promise: result of the find operation -Region[]: -number: (optional)

Defined in

medusa/src/services/region.ts:524

removeCountry

removeCountry(regionId, code): Promise<Region>

Removes a country from a Region.

Parameters

Name Description
regionId string
code string

Returns

Promise<Region>

-Promise: the updated Region -Region:

Defined in

medusa/src/services/region.ts:615

removeFulfillmentProvider

removeFulfillmentProvider(regionId, providerId): Promise<Region>

Removes a fulfillment provider from a region. Is idempotent.

Parameters

Name Description
regionId string
providerId string

Returns

Promise<Region>

-Promise: the updated Region -Region:

Defined in

medusa/src/services/region.ts:791

removePaymentProvider

removePaymentProvider(regionId, providerId): Promise<Region>

Removes a payment provider from a region. Is idempotent.

Parameters

Name Description
regionId string
providerId string

Returns

Promise<Region>

-Promise: the updated Region -Region:

Defined in

medusa/src/services/region.ts:752

retrieve

retrieve(regionId, config?): Promise<Region>

Retrieves a region by its id.

Parameters

Name Description
regionId string
config FindConfig<Region>

Returns

Promise<Region>

-Promise: the region -Region:

Defined in

medusa/src/services/region.ts:470

retrieveByCountryCode

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

Retrieve a region by country code.

Parameters

Name Description
code string
config FindConfig<Region>

Returns

Promise<Region>

-Promise: a Region with country code -Region:

Defined in

medusa/src/services/region.ts:416

retrieveByName

retrieveByName(name): Promise<Region>

Retrieves a region by name.

Parameters

Name Description
name string

Returns

Promise<Region>

-Promise: region with the matching name -Region:

Defined in

medusa/src/services/region.ts:450

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

update

update(regionId, update): Promise<Region>

Updates a region

Parameters

Name Description
regionId string
update UpdateRegionInput

Returns

Promise<Region>

-Promise: the result of the update operation -Region:

Defined in

medusa/src/services/region.ts:171

validateCountry

Protected validateCountry(code, regionId): Promise<Country>

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

Parameters

Name Description
code string
regionId string

Returns

Promise<Country>

-Promise: the validated Country -Country:

Defined in

medusa/src/services/region.ts:367

validateCurrency

Protected validateCurrency(currencyCode): Promise<void>

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

Parameters

Name Description
currencyCode string

Returns

Promise<void>

-Promise: void

Throws

if the provided currency code is invalid

Defined in

medusa/src/services/region.ts:342

validateFields

Protected validateFields<T>(regionData, id?): Promise<DeepPartial<Region>>

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

Name Type
T UpdateRegionInput | CreateRegionInput

Parameters

Name Description
regionData Omit<T, "metadata" | "currency_code">
id? T extends UpdateRegionInput ? string : undefined

Returns

Promise<DeepPartial<Region>>

-Promise: the validated region data -DeepPartial: -Region:

Defined in

medusa/src/services/region.ts:240

validateTaxRate

Protected validateTaxRate(taxRate): void

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

Parameters

Name Description
taxRate number

Returns

void

-void: (optional) void

Throws

if the tax rate isn't number between 0-100

Defined in

medusa/src/services/region.ts:326

withTransaction

withTransaction(transactionManager?): RegionService

Parameters

Name
transactionManager?

Returns

RegionService

-RegionService:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

Reference in New Issue View Git Blame Copy Permalink