asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

190
www/apps/docs/content/references/services/classes/RegionService.mdx
View File

@@ -12,14 +12,14 @@ Provides layer to manipulate regions.
### constructor
**new RegionService**(`«destructured»`)
`**new RegionService**(«destructured»)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "[`InjectedDependencies`](../types/InjectedDependencies-30.mdx)",
"type": "[InjectedDependencies](../types/InjectedDependencies-30.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -33,7 +33,7 @@ Provides layer to manipulate regions.
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -51,7 +51,7 @@ Provides layer to manipulate regions.
},
{
"name": "__moduleDeclaration__",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
@@ -60,7 +60,7 @@ Provides layer to manipulate regions.
},
{
"name": "countryRepository_",
"type": "`Repository`<[`Country`](Country.mdx)\\>",
"type": "Repository&#60;[Country](Country.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -69,7 +69,7 @@ Provides layer to manipulate regions.
},
{
"name": "currencyRepository_",
"type": "`Repository`<[`Currency`](Currency.mdx)\\>",
"type": "Repository&#60;[Currency](Currency.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -78,7 +78,7 @@ Provides layer to manipulate regions.
},
{
"name": "eventBus_",
"type": "[`EventBusService`](EventBusService.mdx)",
"type": "[EventBusService](EventBusService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -87,7 +87,7 @@ Provides layer to manipulate regions.
},
{
"name": "featureFlagRouter_",
"type": "[`FlagRouter`](FlagRouter.mdx)",
"type": "[FlagRouter](FlagRouter.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -96,7 +96,7 @@ Provides layer to manipulate regions.
},
{
"name": "fulfillmentProviderRepository_",
"type": "`Repository`<[`FulfillmentProvider`](FulfillmentProvider.mdx)\\>",
"type": "Repository&#60;[FulfillmentProvider](FulfillmentProvider.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -105,7 +105,7 @@ Provides layer to manipulate regions.
},
{
"name": "fulfillmentProviderService_",
"type": "[`FulfillmentProviderService`](FulfillmentProviderService.mdx)",
"type": "[FulfillmentProviderService](FulfillmentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -114,7 +114,7 @@ Provides layer to manipulate regions.
},
{
"name": "manager_",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -123,7 +123,7 @@ Provides layer to manipulate regions.
},
{
"name": "paymentProviderRepository_",
"type": "`Repository`<[`PaymentProvider`](PaymentProvider.mdx)\\>",
"type": "Repository&#60;[PaymentProvider](PaymentProvider.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -132,7 +132,7 @@ Provides layer to manipulate regions.
},
{
"name": "paymentProviderService_",
"type": "[`PaymentProviderService`](PaymentProviderService.mdx)",
"type": "[PaymentProviderService](PaymentProviderService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -141,7 +141,7 @@ Provides layer to manipulate regions.
},
{
"name": "regionRepository_",
"type": "`Repository`<[`Region`](Region.mdx)\\>",
"type": "Repository&#60;[Region](Region.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -150,7 +150,7 @@ Provides layer to manipulate regions.
},
{
"name": "storeService_",
"type": "[`StoreService`](StoreService.mdx)",
"type": "[StoreService](StoreService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -159,7 +159,7 @@ Provides layer to manipulate regions.
},
{
"name": "taxProviderRepository_",
"type": "`Repository`<[`TaxProvider`](TaxProvider.mdx)\\>",
"type": "Repository&#60;[TaxProvider](TaxProvider.mdx)&#62;",
"description": "",
"optional": false,
"defaultValue": "",
@@ -168,7 +168,7 @@ Provides layer to manipulate regions.
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"type": "`undefined` \\| EntityManager",
"description": "",
"optional": false,
"defaultValue": "",
@@ -217,16 +217,16 @@ Provides layer to manipulate regions.
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected get**activeManager_**(): EntityManager`
#### Returns
`EntityManager`
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
@@ -239,7 +239,7 @@ Provides layer to manipulate regions.
### addCountry
**addCountry**(`regionId`, `code`): `Promise`<[`Region`](Region.mdx)\>
`**addCountry**(regionId, code): Promise&#60;[Region](Region.mdx)&#62;`
Adds a country to the region.
@@ -268,12 +268,12 @@ Adds a country to the region.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated Region",
@@ -286,7 +286,7 @@ ___
### addFulfillmentProvider
**addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](Region.mdx)\>
`**addFulfillmentProvider**(regionId, providerId): Promise&#60;[Region](Region.mdx)&#62;`
Adds a fulfillment provider that is available in the region. Fails if the
provider doesn't exist.
@@ -316,12 +316,12 @@ provider doesn't exist.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated Region",
@@ -334,7 +334,7 @@ ___
### addPaymentProvider
**addPaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](Region.mdx)\>
`**addPaymentProvider**(regionId, providerId): Promise&#60;[Region](Region.mdx)&#62;`
Adds a payment provider that is available in the region. Fails if the
provider doesn't exist.
@@ -364,12 +364,12 @@ provider doesn't exist.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated Region",
@@ -382,7 +382,7 @@ ___
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
@@ -414,7 +414,7 @@ transaction manager is created.
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => `Promise`<`TResult`\\>",
"type": "(`transactionManager`: EntityManager) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
@@ -423,7 +423,7 @@ transaction manager is created.
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
@@ -432,7 +432,7 @@ transaction manager is created.
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => `Promise`<`void` \\| `TResult`\\>",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
@@ -443,12 +443,12 @@ transaction manager is created.
#### Returns
`Promise`<`TResult`\>
Promise&#60;TResult&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`TResult`\\>",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
@@ -461,7 +461,7 @@ ___
### create
**create**(`data`): `Promise`<[`Region`](Region.mdx)\>
`**create**(data): Promise&#60;[Region](Region.mdx)&#62;`
Creates a region.
@@ -470,7 +470,7 @@ Creates a region.
<ParameterTypes parameters={[
{
"name": "data",
"type": "[`CreateRegionInput`](../types/CreateRegionInput.mdx)",
"type": "[CreateRegionInput](../types/CreateRegionInput.mdx)",
"description": "the unvalidated region",
"optional": false,
"defaultValue": "",
@@ -481,12 +481,12 @@ Creates a region.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the newly created region",
@@ -499,7 +499,7 @@ ___
### delete
**delete**(`regionId`): `Promise`<`void`\>
`**delete**(regionId): Promise&#60;void&#62;`
Deletes a region.
@@ -519,12 +519,12 @@ Deletes a region.
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation",
@@ -537,7 +537,7 @@ ___
### list
**list**(`selector?`, `config?`): `Promise`<[`Region`](Region.mdx)[]\>
`**list**(selector?, config?): Promise&#60;[Region](Region.mdx)[]&#62;`
Lists all regions based on a query
@@ -546,7 +546,7 @@ Lists all regions based on a query
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`Region`](Region.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[Region](Region.mdx)&#62;",
"description": "query object for find",
"optional": false,
"defaultValue": "{}",
@@ -555,7 +555,7 @@ Lists all regions based on a query
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Region`](Region.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Region](Region.mdx)&#62;",
"description": "configuration settings",
"optional": false,
"defaultValue": "",
@@ -566,12 +566,12 @@ Lists all regions based on a query
#### Returns
`Promise`<[`Region`](Region.mdx)[]\>
Promise&#60;[Region](Region.mdx)[]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)[]\\>",
"type": "Promise&#60;[Region](Region.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "result of the find operation",
@@ -584,7 +584,7 @@ ___
### listAndCount
**listAndCount**(`selector?`, `config?`): `Promise`<[[`Region`](Region.mdx)[], `number`]\>
`**listAndCount**(selector?, config?): Promise&#60;[[Region](Region.mdx)[], number]&#62;`
Lists all regions based on a query and returns them along with count
@@ -593,7 +593,7 @@ Lists all regions based on a query and returns them along with count
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[`Selector`](../types/Selector.mdx)<[`Region`](Region.mdx)\\>",
"type": "[Selector](../types/Selector.mdx)&#60;[Region](Region.mdx)&#62;",
"description": "query object for find",
"optional": false,
"defaultValue": "{}",
@@ -602,7 +602,7 @@ Lists all regions based on a query and returns them along with count
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Region`](Region.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Region](Region.mdx)&#62;",
"description": "configuration settings",
"optional": false,
"defaultValue": "",
@@ -613,12 +613,12 @@ Lists all regions based on a query and returns them along with count
#### Returns
`Promise`<[[`Region`](Region.mdx)[], `number`]\>
Promise&#60;[[Region](Region.mdx)[], number]&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[[`Region`](Region.mdx)[], `number`]\\>",
"type": "Promise&#60;[[Region](Region.mdx)[], number]&#62;",
"optional": false,
"defaultValue": "",
"description": "result of the find operation",
@@ -631,7 +631,7 @@ ___
### removeCountry
**removeCountry**(`regionId`, `code`): `Promise`<[`Region`](Region.mdx)\>
`**removeCountry**(regionId, code): Promise&#60;[Region](Region.mdx)&#62;`
Removes a country from a Region.
@@ -660,12 +660,12 @@ Removes a country from a Region.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated Region",
@@ -678,7 +678,7 @@ ___
### removeFulfillmentProvider
**removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](Region.mdx)\>
`**removeFulfillmentProvider**(regionId, providerId): Promise&#60;[Region](Region.mdx)&#62;`
Removes a fulfillment provider from a region. Is idempotent.
@@ -707,12 +707,12 @@ Removes a fulfillment provider from a region. Is idempotent.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated Region",
@@ -725,7 +725,7 @@ ___
### removePaymentProvider
**removePaymentProvider**(`regionId`, `providerId`): `Promise`<[`Region`](Region.mdx)\>
`**removePaymentProvider**(regionId, providerId): Promise&#60;[Region](Region.mdx)&#62;`
Removes a payment provider from a region. Is idempotent.
@@ -754,12 +754,12 @@ Removes a payment provider from a region. Is idempotent.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the updated Region",
@@ -772,7 +772,7 @@ ___
### retrieve
**retrieve**(`regionId`, `config?`): `Promise`<[`Region`](Region.mdx)\>
`**retrieve**(regionId, config?): Promise&#60;[Region](Region.mdx)&#62;`
Retrieves a region by its id.
@@ -790,7 +790,7 @@ Retrieves a region by its id.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Region`](Region.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Region](Region.mdx)&#62;",
"description": "configuration settings",
"optional": false,
"defaultValue": "{}",
@@ -801,12 +801,12 @@ Retrieves a region by its id.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the region",
@@ -819,7 +819,7 @@ ___
### retrieveByCountryCode
**retrieveByCountryCode**(`code`, `config?`): `Promise`<[`Region`](Region.mdx)\>
`**retrieveByCountryCode**(code, config?): Promise&#60;[Region](Region.mdx)&#62;`
Retrieve a region by country code.
@@ -837,7 +837,7 @@ Retrieve a region by country code.
},
{
"name": "config",
"type": "[`FindConfig`](../interfaces/FindConfig.mdx)<[`Region`](Region.mdx)\\>",
"type": "[FindConfig](../interfaces/FindConfig.mdx)&#60;[Region](Region.mdx)&#62;",
"description": "region find config",
"optional": false,
"defaultValue": "{}",
@@ -848,12 +848,12 @@ Retrieve a region by country code.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "a Region with country code",
@@ -866,7 +866,7 @@ ___
### retrieveByName
**retrieveByName**(`name`): `Promise`<[`Region`](Region.mdx)\>
`**retrieveByName**(name): Promise&#60;[Region](Region.mdx)&#62;`
Retrieves a region by name.
@@ -886,12 +886,12 @@ Retrieves a region by name.
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "region with the matching name",
@@ -904,14 +904,14 @@ ___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "Record<`string`, `unknown`\\> \\| { `code`: `string` }",
"type": "`Record<string, unknown>` \\| `&#123; code: string &#125;`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -940,7 +940,7 @@ ___
### update
**update**(`regionId`, `update`): `Promise`<[`Region`](Region.mdx)\>
`**update**(regionId, update): Promise&#60;[Region](Region.mdx)&#62;`
Updates a region
@@ -958,7 +958,7 @@ Updates a region
},
{
"name": "update",
"type": "[`UpdateRegionInput`](../types/UpdateRegionInput.mdx)",
"type": "[UpdateRegionInput](../types/UpdateRegionInput.mdx)",
"description": "the data to update the region with",
"optional": false,
"defaultValue": "",
@@ -969,12 +969,12 @@ Updates a region
#### Returns
`Promise`<[`Region`](Region.mdx)\>
Promise&#60;[Region](Region.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Region`](Region.mdx)\\>",
"type": "Promise&#60;[Region](Region.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the update operation",
@@ -987,7 +987,7 @@ ___
### validateCountry
`Protected` **validateCountry**(`code`, `regionId`): `Promise`<[`Country`](Country.mdx)\>
`Protected **validateCountry**(code, regionId): Promise&#60;[Country](Country.mdx)&#62;`
Validates a country code. Will normalize the code before checking for
existence.
@@ -1017,12 +1017,12 @@ existence.
#### Returns
`Promise`<[`Country`](Country.mdx)\>
Promise&#60;[Country](Country.mdx)&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<[`Country`](Country.mdx)\\>",
"type": "Promise&#60;[Country](Country.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the validated Country",
@@ -1035,7 +1035,7 @@ ___
### validateCurrency
`Protected` **validateCurrency**(`currencyCode`): `Promise`<`void`\>
`Protected **validateCurrency**(currencyCode): Promise&#60;void&#62;`
Validates a currency code. Will throw if the currency code doesn't exist.
@@ -1055,12 +1055,12 @@ Validates a currency code. Will throw if the currency code doesn't exist.
#### Returns
`Promise`<`void`\>
Promise&#60;void&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`void`\\>",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "void",
@@ -1077,7 +1077,7 @@ ___
### validateFields
`Protected` **validateFields**<`T`\>(`regionData`, `id?`): `Promise`<`DeepPartial`<[`Region`](Region.mdx)\>\>
`Protected **validateFields**<TypeParameter T>(regionData, id?): Promise&#60;DeepPartial&#60;[Region](Region.mdx)&#62;&#62;`
Validates fields for creation and updates. If the region already exists
the id can be passed to check that country updates are allowed.
@@ -1085,7 +1085,7 @@ the id can be passed to check that country updates are allowed.
<ParameterTypes parameters={[
{
"name": "T",
"type": "[`UpdateRegionInput`](../types/UpdateRegionInput.mdx) \\| [`CreateRegionInput`](../types/CreateRegionInput.mdx)",
"type": "[UpdateRegionInput](../types/UpdateRegionInput.mdx) \\| [CreateRegionInput](../types/CreateRegionInput.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
@@ -1099,7 +1099,7 @@ the id can be passed to check that country updates are allowed.
<ParameterTypes parameters={[
{
"name": "regionData",
"type": "[`Omit`](../types/Omit.mdx)<`T`, ``\"metadata\"`` \\| ``\"currency_code\"``\\>",
"type": "[Omit](../types/Omit.mdx)&#60;T, `\"metadata\"` \\| `\"currency_code\"`&#62;",
"description": "the region data to validate",
"optional": false,
"defaultValue": "",
@@ -1108,7 +1108,7 @@ the id can be passed to check that country updates are allowed.
},
{
"name": "id",
"type": "`T` extends [`UpdateRegionInput`](../types/UpdateRegionInput.mdx) ? `string` : `undefined`",
"type": "`T` extends [UpdateRegionInput](../types/UpdateRegionInput.mdx) ? `string` : `undefined`",
"description": "optional id of the region to check against",
"optional": true,
"defaultValue": "",
@@ -1119,12 +1119,12 @@ the id can be passed to check that country updates are allowed.
#### Returns
`Promise`<`DeepPartial`<[`Region`](Region.mdx)\>\>
Promise&#60;DeepPartial&#60;[Region](Region.mdx)&#62;&#62;
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "`Promise`<`DeepPartial`<[`Region`](Region.mdx)\\>\\>",
"type": "Promise&#60;DeepPartial&#60;[Region](Region.mdx)&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "the validated region data",
@@ -1137,7 +1137,7 @@ ___
### validateTaxRate
`Protected` **validateTaxRate**(`taxRate`): `void`
`Protected **validateTaxRate**(taxRate): void`
Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
@@ -1179,14 +1179,14 @@ ___
### withTransaction
**withTransaction**(`transactionManager?`): [`RegionService`](RegionService.mdx)
`**withTransaction**(transactionManager?): [RegionService](RegionService.mdx)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"type": "EntityManager",
"description": "",
"optional": true,
"defaultValue": "",
@@ -1197,12 +1197,12 @@ ___
#### Returns
[`RegionService`](RegionService.mdx)
[RegionService](RegionService.mdx)
<ParameterTypes parameters={[
{
"name": "RegionService",
"type": "[`RegionService`](RegionService.mdx)",
"type": "[RegionService](RegionService.mdx)",
"optional": false,
"defaultValue": "",
"description": "",