fix: overlapping branch names for generated PRs of references (#2097)
* fix overlapping branch names of generated references * regenerate references
This commit is contained in:
@@ -4,7 +4,7 @@ Provides layer to manipulate regions.
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- `"medusa-interfaces"`
|
||||
- `TransactionBaseService`
|
||||
|
||||
↳ **`RegionService`**
|
||||
|
||||
@@ -18,18 +18,174 @@ Provides layer to manipulate regions.
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `__namedParameters` | `Object` |
|
||||
| `__namedParameters` | `InjectedDependencies` |
|
||||
|
||||
#### Overrides
|
||||
|
||||
BaseService.constructor
|
||||
TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L16)
|
||||
[packages/medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L62)
|
||||
|
||||
## Properties
|
||||
|
||||
### \_\_configModule\_\_
|
||||
|
||||
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
### \_\_container\_\_
|
||||
|
||||
• `Protected` `Readonly` **\_\_container\_\_**: `any`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
### countryRepository\_
|
||||
|
||||
• `Protected` `Readonly` **countryRepository\_**: typeof `CountryRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### currencyRepository\_
|
||||
|
||||
• `Protected` `Readonly` **currencyRepository\_**: typeof `CurrencyRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
### eventBus\_
|
||||
|
||||
• `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### fulfillmentProviderRepository\_
|
||||
|
||||
• `Protected` `Readonly` **fulfillmentProviderRepository\_**: typeof `FulfillmentProviderRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
### fulfillmentProviderService\_
|
||||
|
||||
• `Protected` `Readonly` **fulfillmentProviderService\_**: [`FulfillmentProviderService`](FulfillmentProviderService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
### manager\_
|
||||
|
||||
• `Protected` **manager\_**: `EntityManager`
|
||||
|
||||
#### Overrides
|
||||
|
||||
TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:48](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L48)
|
||||
|
||||
___
|
||||
|
||||
### paymentProviderRepository\_
|
||||
|
||||
• `Protected` `Readonly` **paymentProviderRepository\_**: typeof `PaymentProviderRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L58)
|
||||
|
||||
___
|
||||
|
||||
### paymentProviderService\_
|
||||
|
||||
• `Protected` `Readonly` **paymentProviderService\_**: [`PaymentProviderService`](PaymentProviderService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:53](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
### regionRepository\_
|
||||
|
||||
• `Protected` `Readonly` **regionRepository\_**: typeof `RegionRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
### storeService\_
|
||||
|
||||
• `Protected` `Readonly` **storeService\_**: [`StoreService`](StoreService.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
### taxProviderRepository\_
|
||||
|
||||
• `Protected` `Readonly` **taxProviderRepository\_**: typeof `TaxProviderRepository`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L60)
|
||||
|
||||
___
|
||||
|
||||
### transactionManager\_
|
||||
|
||||
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
|
||||
|
||||
#### Overrides
|
||||
|
||||
TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.ts:49](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
### Events
|
||||
|
||||
▪ `Static` **Events**: `Object`
|
||||
@@ -44,13 +200,13 @@ BaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:10](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L10)
|
||||
[packages/medusa/src/services/region.ts:42](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L42)
|
||||
|
||||
## Methods
|
||||
|
||||
### addCountry
|
||||
|
||||
▸ **addCountry**(`regionId`, `code`): `Promise`<`any`\>
|
||||
▸ **addCountry**(`regionId`, `code`): `Promise`<`Region`\>
|
||||
|
||||
Adds a country to the region.
|
||||
|
||||
@@ -63,19 +219,19 @@ Adds a country to the region.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the result of the update operation
|
||||
the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:462](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L462)
|
||||
[packages/medusa/src/services/region.ts:525](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L525)
|
||||
|
||||
___
|
||||
|
||||
### addFulfillmentProvider
|
||||
|
||||
▸ **addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
|
||||
▸ **addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`Region`\>
|
||||
|
||||
Adds a fulfillment provider that is available in the region. Fails if the
|
||||
provider doesn't exist.
|
||||
@@ -89,19 +245,19 @@ provider doesn't exist.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the result of the update operation
|
||||
the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:582](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L582)
|
||||
[packages/medusa/src/services/region.ts:655](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L655)
|
||||
|
||||
___
|
||||
|
||||
### addPaymentProvider
|
||||
|
||||
▸ **addPaymentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
|
||||
▸ **addPaymentProvider**(`regionId`, `providerId`): `Promise`<`Region`\>
|
||||
|
||||
Adds a payment provider that is available in the region. Fails if the
|
||||
provider doesn't exist.
|
||||
@@ -115,19 +271,58 @@ provider doesn't exist.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the result of the update operation
|
||||
the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:535](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L535)
|
||||
[packages/medusa/src/services/region.ts:604](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L604)
|
||||
|
||||
___
|
||||
|
||||
### 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.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `TResult` |
|
||||
| `TError` |
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
|
||||
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
|
||||
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`TResult`\>
|
||||
|
||||
the result of the transactional work
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
### create
|
||||
|
||||
▸ **create**(`regionObject`): `Region`
|
||||
▸ **create**(`data`): `Promise`<`Region`\>
|
||||
|
||||
Creates a region.
|
||||
|
||||
@@ -135,23 +330,23 @@ Creates a region.
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `regionObject` | `Region` | the unvalidated region |
|
||||
| `data` | `CreateRegionInput` | the unvalidated region |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Region`
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the newly created region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:95](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L95)
|
||||
[packages/medusa/src/services/region.ts:108](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L108)
|
||||
|
||||
___
|
||||
|
||||
### delete
|
||||
|
||||
▸ **delete**(`regionId`): `Promise`<`any`\>
|
||||
▸ **delete**(`regionId`): `Promise`<`void`\>
|
||||
|
||||
Deletes a region.
|
||||
|
||||
@@ -163,19 +358,19 @@ Deletes a region.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`void`\>
|
||||
|
||||
the result of the delete operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:432](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L432)
|
||||
[packages/medusa/src/services/region.ts:494](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L494)
|
||||
|
||||
___
|
||||
|
||||
### list
|
||||
|
||||
▸ **list**(`selector?`, `config?`): `Promise`<`any`\>
|
||||
▸ **list**(`selector?`, `config?`): `Promise`<`Region`[]\>
|
||||
|
||||
Lists all regions based on a query
|
||||
|
||||
@@ -183,26 +378,26 @@ Lists all regions based on a query
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `selector` | `any` | query object for find |
|
||||
| `config` | `any` | configuration settings |
|
||||
| `selector` | `Selector`<`Region`\> | query object for find |
|
||||
| `config` | `FindConfig`<`Region`\> | configuration settings |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Region`[]\>
|
||||
|
||||
result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:420](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L420)
|
||||
[packages/medusa/src/services/region.ts:474](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L474)
|
||||
|
||||
___
|
||||
|
||||
### removeCountry
|
||||
|
||||
▸ **removeCountry**(`regionId`, `code`): `Promise`<`any`\>
|
||||
▸ **removeCountry**(`regionId`, `code`): `Promise`<`Region`\>
|
||||
|
||||
Removes a country from a Region
|
||||
Removes a country from a Region.
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -213,19 +408,19 @@ Removes a country from a Region
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the result of the update operation
|
||||
the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:499](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L499)
|
||||
[packages/medusa/src/services/region.ts:563](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L563)
|
||||
|
||||
___
|
||||
|
||||
### removeFulfillmentProvider
|
||||
|
||||
▸ **removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
|
||||
▸ **removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`Region`\>
|
||||
|
||||
Removes a fulfillment provider from a region. Is idempotent.
|
||||
|
||||
@@ -238,19 +433,19 @@ Removes a fulfillment provider from a region. Is idempotent.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the result of the update operation
|
||||
the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:660](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L660)
|
||||
[packages/medusa/src/services/region.ts:743](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L743)
|
||||
|
||||
___
|
||||
|
||||
### removePaymentProvider
|
||||
|
||||
▸ **removePaymentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
|
||||
▸ **removePaymentProvider**(`regionId`, `providerId`): `Promise`<`Region`\>
|
||||
|
||||
Removes a payment provider from a region. Is idempotent.
|
||||
|
||||
@@ -263,19 +458,19 @@ Removes a payment provider from a region. Is idempotent.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the result of the update operation
|
||||
the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:626](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L626)
|
||||
[packages/medusa/src/services/region.ts:704](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L704)
|
||||
|
||||
___
|
||||
|
||||
### retrieve
|
||||
|
||||
▸ **retrieve**(`regionId`, `config?`): `Region`
|
||||
▸ **retrieve**(`regionId`, `config?`): `Promise`<`Region`\>
|
||||
|
||||
Retrieves a region by its id.
|
||||
|
||||
@@ -284,17 +479,17 @@ Retrieves a region by its id.
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `regionId` | `string` | the id of the region to retrieve |
|
||||
| `config` | `any` | configuration settings |
|
||||
| `config` | `FindConfig`<`Region`\> | configuration settings |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Region`
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:396](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L396)
|
||||
[packages/medusa/src/services/region.ts:446](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L446)
|
||||
|
||||
___
|
||||
|
||||
@@ -302,26 +497,54 @@ ___
|
||||
|
||||
▸ **retrieveByCountryCode**(`code`, `config?`): `Promise`<`Region`\>
|
||||
|
||||
Retrieve a region by country code.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `code` | `any` |
|
||||
| `config` | `Object` |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `code` | `string` | a 2 digit alphanumeric ISO country code |
|
||||
| `config` | `FindConfig`<`Region`\> | region find config |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`Region`\>
|
||||
|
||||
a Region with country code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:362](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L362)
|
||||
[packages/medusa/src/services/region.ts:408](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L408)
|
||||
|
||||
___
|
||||
|
||||
### shouldRetryTransaction\_
|
||||
|
||||
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### update
|
||||
|
||||
▸ **update**(`regionId`, `update`): `Promise`<`any`\>
|
||||
▸ **update**(`regionId`, `update`): `Promise`<`Region`\>
|
||||
|
||||
Updates a region
|
||||
|
||||
@@ -330,23 +553,23 @@ Updates a region
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `regionId` | `string` | the region to update |
|
||||
| `update` | `any` | the data to update the region with |
|
||||
| `update` | `UpdateRegionInput` | the data to update the region with |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Region`\>
|
||||
|
||||
the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:153](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L153)
|
||||
[packages/medusa/src/services/region.ts:171](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L171)
|
||||
|
||||
___
|
||||
|
||||
### validateCountry\_
|
||||
### validateCountry
|
||||
|
||||
▸ **validateCountry_**(`code`, `regionId`): `Promise`<`any`\>
|
||||
▸ `Protected` **validateCountry**(`code`, `regionId`): `Promise`<`Country`\>
|
||||
|
||||
Validates a country code. Will normalize the code before checking for
|
||||
existence.
|
||||
@@ -360,20 +583,26 @@ existence.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`any`\>
|
||||
`Promise`<`Country`\>
|
||||
|
||||
the validated Country
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:323](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L323)
|
||||
[packages/medusa/src/services/region.ts:359](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L359)
|
||||
|
||||
___
|
||||
|
||||
### validateCurrency\_
|
||||
### validateCurrency
|
||||
|
||||
▸ **validateCurrency_**(`currencyCode`): `Promise`<`void`\>
|
||||
▸ `Protected` **validateCurrency**(`currencyCode`): `Promise`<`void`\>
|
||||
|
||||
Validates a currency code. Will throw if the currency code doesn't exist.
|
||||
|
||||
**`Throws`**
|
||||
|
||||
if the provided currency code is invalid
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
@@ -384,44 +613,56 @@ Validates a currency code. Will throw if the currency code doesn't exist.
|
||||
|
||||
`Promise`<`void`\>
|
||||
|
||||
void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:302](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L302)
|
||||
[packages/medusa/src/services/region.ts:334](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L334)
|
||||
|
||||
___
|
||||
|
||||
### validateFields\_
|
||||
### validateFields
|
||||
|
||||
▸ **validateFields_**(`region`, `id?`): `any`
|
||||
▸ `Protected` **validateFields**<`T`\>(`regionData`, `id?`): `Promise`<{ `automatic_taxes?`: `boolean` ; `countries?`: (`undefined` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; })[] ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `currency?`: { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; } ; `currency_code?`: `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `fulfillment_providers?`: (`undefined` \| { id?: string \| undefined; is\_installed?: boolean \| undefined; })[] ; `gift_cards_taxable?`: `boolean` ; `id?`: `string` ; `metadata?`: { [x: string]: unknown; } ; `name?`: `string` ; `payment_providers?`: (`undefined` \| { id?: string \| undefined; is\_installed?: boolean \| undefined; })[] ; `tax_code?`: `string` ; `tax_provider?`: { id?: string \| undefined; is\_installed?: boolean \| undefined; } ; `tax_provider_id?`: ``null`` \| `string` ; `tax_rate?`: `number` ; `tax_rates?`: ``null`` \| (`undefined` \| { rate?: number \| null \| undefined; code?: string \| null \| undefined; name?: string \| undefined; region\_id?: string \| undefined; region?: { name?: string \| undefined; currency\_code?: string \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 9 more ...; updated\_at?: { ...; } \| undefin...)[] ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } }\>
|
||||
|
||||
Validates fields for creation and updates. If the region already exisits
|
||||
Validates fields for creation and updates. If the region already exists
|
||||
the id can be passed to check that country updates are allowed.
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | extends `UpdateRegionInput` \| `CreateRegionInput` |
|
||||
|
||||
#### 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 |
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `regionData` | `Omit`<`T`, ``"currency_code"`` \| ``"metadata"``\> | the region data to validate |
|
||||
| `id?` | `T` extends `UpdateRegionInput` ? `string` : `undefined` | optional id of the region to check against |
|
||||
|
||||
#### Returns
|
||||
|
||||
`any`
|
||||
`Promise`<{ `automatic_taxes?`: `boolean` ; `countries?`: (`undefined` \| { id?: number \| undefined; iso\_2?: string \| undefined; iso\_3?: string \| undefined; num\_code?: number \| undefined; name?: string \| undefined; display\_name?: string \| undefined; region\_id?: string \| ... 1 more ... \| undefined; region?: { ...; } \| undefined; })[] ; `created_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `currency?`: { code?: string \| undefined; symbol?: string \| undefined; symbol\_native?: string \| undefined; name?: string \| undefined; } ; `currency_code?`: `string` ; `deleted_at?`: ``null`` \| { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } ; `fulfillment_providers?`: (`undefined` \| { id?: string \| undefined; is\_installed?: boolean \| undefined; })[] ; `gift_cards_taxable?`: `boolean` ; `id?`: `string` ; `metadata?`: { [x: string]: unknown; } ; `name?`: `string` ; `payment_providers?`: (`undefined` \| { id?: string \| undefined; is\_installed?: boolean \| undefined; })[] ; `tax_code?`: `string` ; `tax_provider?`: { id?: string \| undefined; is\_installed?: boolean \| undefined; } ; `tax_provider_id?`: ``null`` \| `string` ; `tax_rate?`: `number` ; `tax_rates?`: ``null`` \| (`undefined` \| { rate?: number \| null \| undefined; code?: string \| null \| undefined; name?: string \| undefined; region\_id?: string \| undefined; region?: { name?: string \| undefined; currency\_code?: string \| undefined; ... 15 more ...; updated\_at?: { ...; } \| undefined; } \| undefined; ... 9 more ...; updated\_at?: { ...; } \| undefin...)[] ; `updated_at?`: { toString?: {} \| undefined; toDateString?: {} \| undefined; toTimeString?: {} \| undefined; toLocaleString?: {} \| undefined; toLocaleDateString?: {} \| undefined; toLocaleTimeString?: {} \| undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} \| undefined; } }\>
|
||||
|
||||
the validated region data
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:213](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L213)
|
||||
[packages/medusa/src/services/region.ts:232](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L232)
|
||||
|
||||
___
|
||||
|
||||
### validateTaxRate\_
|
||||
### validateTaxRate
|
||||
|
||||
▸ **validateTaxRate_**(`taxRate`): `void`
|
||||
▸ `Protected` **validateTaxRate**(`taxRate`): `void`
|
||||
|
||||
Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
|
||||
|
||||
**`Throws`**
|
||||
|
||||
if the tax rate isn't number between 0-100
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
@@ -432,26 +673,32 @@ Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
|
||||
|
||||
`void`
|
||||
|
||||
void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:289](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L289)
|
||||
[packages/medusa/src/services/region.ts:318](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/region.ts#L318)
|
||||
|
||||
___
|
||||
|
||||
### withTransaction
|
||||
|
||||
▸ **withTransaction**(`transactionManager`): [`RegionService`](RegionService.md)
|
||||
▸ **withTransaction**(`transactionManager?`): [`RegionService`](RegionService.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `transactionManager` | `any` |
|
||||
| `transactionManager?` | `EntityManager` |
|
||||
|
||||
#### Returns
|
||||
|
||||
[`RegionService`](RegionService.md)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/region.js:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L65)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
Reference in New Issue
Block a user