Skip to main content
Skip to main content

IRegionModuleService

Methods​

create​

**create**(data, sharedContext?): Promise<[RegionDTO](/references/types/interfaces/types.RegionDTO)[]>

Parameters​

dataCreateRegionDTO[]Required
sharedContextContext

Returns​

PromisePromise<RegionDTO[]>Required

**create**(data, sharedContext?): Promise&#60;[RegionDTO](/references/types/interfaces/types.RegionDTO)&#62;

Parameters​

dataCreateRegionDTORequired
sharedContextContext

Returns​

PromisePromise<RegionDTO>Required

update​

**update**(data, sharedContext?): Promise&#60;[RegionDTO](/references/types/interfaces/types.RegionDTO)[]&#62;

Parameters​

dataUpdateRegionDTO[]Required
sharedContextContext

Returns​

PromisePromise<RegionDTO[]>Required

**update**(data, sharedContext?): Promise&#60;[RegionDTO](/references/types/interfaces/types.RegionDTO)&#62;

Parameters​

dataUpdateRegionDTORequired
sharedContextContext

Returns​

PromisePromise<RegionDTO>Required

delete​

**delete**(ids, sharedContext?): Promise&#60;void&#62;

Parameters​

idsstring[]Required
sharedContextContext

Returns​

PromisePromise<void>Required

**delete**(id, sharedContext?): Promise&#60;void&#62;

Parameters​

idstringRequired
sharedContextContext

Returns​

PromisePromise<void>Required

retrieve​

Parameters​

idstringRequired
configFindConfig<RegionDTO>
sharedContextContext

Returns​

PromisePromise<RegionDTO>Required

list​

Parameters​

Returns​

PromisePromise<RegionDTO[]>Required

listAndCount​

Parameters​

Returns​

PromisePromise<[RegionDTO[], number]>Required

retrieveCountry​

Parameters​

countryIdstringRequired
configFindConfig<RegionCountryDTO>
sharedContextContext

Returns​

PromisePromise<RegionCountryDTO>Required

listCountries​

Parameters​

Returns​

PromisePromise<RegionCountryDTO[]>Required

retrieveCurrency​

Parameters​

currencyIdstringRequired
configFindConfig<RegionCountryDTO>
sharedContextContext

Returns​

PromisePromise<RegionCurrencyDTO>Required

listAndCountCountries​

Parameters​

Returns​

PromisePromise<[RegionCountryDTO[], number]>Required

listCurrencies​

Parameters​

Returns​

PromisePromise<RegionCurrencyDTO[]>Required

listAndCountCurrencies​

Parameters​

Returns​

PromisePromise<[RegionCurrencyDTO[], number]>Required

softDelete​

Type Parameters​

TReturnableLinkableKeysstringRequired

Parameters​

regionIdsstring[]Required
configSoftDeleteReturn<TReturnableLinkableKeys>
sharedContextContext

Returns​

PromisePromise<void | Record<string, string[]>>Required

restore​

Type Parameters​

TReturnableLinkableKeysstringRequired

Parameters​

regionIdsstring[]Required
configRestoreReturn<TReturnableLinkableKeys>
sharedContextContext

Returns​

PromisePromise<void | Record<string, string[]>>Required

createDefaultCountriesAndCurrencies​

Parameters​

sharedContextContext

Returns​

PromisePromise<void>Required
Was this section helpful?
© 2024 Medusa, Inc. All rights reserved.