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

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/RegionService.mdx
+91 -71
View File
@@ -8,13 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Provides layer to manipulate regions.
## Constructors
#### constructor
## constructor
`**new RegionService**(«destructured»)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -28,6 +26,8 @@ Provides layer to manipulate regions.
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -213,21 +213,41 @@ Provides layer to manipulate regions.
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
`Protected` **activeManager\_**: [object Object]
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
#### addCountry
### addCountry
`**addCountry**(regionId, code): Promise&#60;[Region](Region.mdx)&#62;`
Adds a country to the region.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -250,7 +270,7 @@ Adds a country to the region.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -268,14 +288,14 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### addFulfillmentProvider
### addFulfillmentProvider
`**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.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -298,7 +318,7 @@ provider doesn't exist.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -316,14 +336,14 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### addPaymentProvider
### addPaymentProvider
`**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.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -346,7 +366,7 @@ provider doesn't exist.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -364,7 +384,7 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -372,7 +392,7 @@ 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
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -395,7 +415,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -427,7 +447,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -445,13 +465,13 @@ Promise&#60;TResult&#62;
___
#### create
### create
`**create**(data): Promise&#60;[Region](Region.mdx)&#62;`
Creates a region.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -465,7 +485,7 @@ Creates a region.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -483,13 +503,13 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### delete
### delete
`**delete**(regionId): Promise&#60;void&#62;`
Deletes a region.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -503,7 +523,7 @@ Deletes a region.
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -521,13 +541,13 @@ Promise&#60;void&#62;
___
#### list
### list
`**list**(selector?, config?): Promise&#60;[Region](Region.mdx)[]&#62;`
Lists all regions based on a query
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -550,7 +570,7 @@ Lists all regions based on a query
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)[]&#62;
@@ -568,13 +588,13 @@ Promise&#60;[Region](Region.mdx)[]&#62;
___
#### listAndCount
### listAndCount
`**listAndCount**(selector?, config?): Promise&#60;[[Region](Region.mdx)[], number]&#62;`
Lists all regions based on a query and returns them along with count
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -597,7 +617,7 @@ Lists all regions based on a query and returns them along with count
}
]} />
##### Returns
#### Returns
Promise&#60;[[Region](Region.mdx)[], number]&#62;
@@ -615,13 +635,13 @@ Promise&#60;[[Region](Region.mdx)[], number]&#62;
___
#### removeCountry
### removeCountry
`**removeCountry**(regionId, code): Promise&#60;[Region](Region.mdx)&#62;`
Removes a country from a Region.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -644,7 +664,7 @@ Removes a country from a Region.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -662,13 +682,13 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### removeFulfillmentProvider
### removeFulfillmentProvider
`**removeFulfillmentProvider**(regionId, providerId): Promise&#60;[Region](Region.mdx)&#62;`
Removes a fulfillment provider from a region. Is idempotent.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -691,7 +711,7 @@ Removes a fulfillment provider from a region. Is idempotent.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -709,13 +729,13 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### removePaymentProvider
### removePaymentProvider
`**removePaymentProvider**(regionId, providerId): Promise&#60;[Region](Region.mdx)&#62;`
Removes a payment provider from a region. Is idempotent.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -738,7 +758,7 @@ Removes a payment provider from a region. Is idempotent.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -756,13 +776,13 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### retrieve
### retrieve
`**retrieve**(regionId, config?): Promise&#60;[Region](Region.mdx)&#62;`
Retrieves a region by its id.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -785,7 +805,7 @@ Retrieves a region by its id.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -803,13 +823,13 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### retrieveByCountryCode
### retrieveByCountryCode
`**retrieveByCountryCode**(code, config?): Promise&#60;[Region](Region.mdx)&#62;`
Retrieve a region by country code.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -832,7 +852,7 @@ Retrieve a region by country code.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -850,13 +870,13 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### retrieveByName
### retrieveByName
`**retrieveByName**(name): Promise&#60;[Region](Region.mdx)&#62;`
Retrieves a region by name.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -870,7 +890,7 @@ Retrieves a region by name.
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -888,11 +908,11 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -906,7 +926,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -924,13 +944,13 @@ ___
___
#### update
### update
`**update**(regionId, update): Promise&#60;[Region](Region.mdx)&#62;`
Updates a region
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -953,7 +973,7 @@ Updates a region
}
]} />
##### Returns
#### Returns
Promise&#60;[Region](Region.mdx)&#62;
@@ -971,14 +991,14 @@ Promise&#60;[Region](Region.mdx)&#62;
___
#### validateCountry
### validateCountry
`Protected **validateCountry**(code, regionId): Promise&#60;[Country](Country.mdx)&#62;`
Validates a country code. Will normalize the code before checking for
existence.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1001,7 +1021,7 @@ existence.
}
]} />
##### Returns
#### Returns
Promise&#60;[Country](Country.mdx)&#62;
@@ -1019,13 +1039,13 @@ Promise&#60;[Country](Country.mdx)&#62;
___
#### validateCurrency
### validateCurrency
`Protected **validateCurrency**(currencyCode): Promise&#60;void&#62;`
Validates a currency code. Will throw if the currency code doesn't exist.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1039,7 +1059,7 @@ Validates a currency code. Will throw if the currency code doesn't exist.
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -1061,14 +1081,14 @@ if the provided currency code is invalid
___
#### validateFields
### validateFields
`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.
##### Type Parameters
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -1082,7 +1102,7 @@ the id can be passed to check that country updates are allowed.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1105,7 +1125,7 @@ the id can be passed to check that country updates are allowed.
}
]} />
##### Returns
#### Returns
Promise&#60;DeepPartial&#60;[Region](Region.mdx)&#62;&#62;
@@ -1123,13 +1143,13 @@ Promise&#60;DeepPartial&#60;[Region](Region.mdx)&#62;&#62;
___
#### validateTaxRate
### validateTaxRate
`Protected **validateTaxRate**(taxRate): void`
Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1143,7 +1163,7 @@ Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
}
]} />
##### Returns
#### Returns
`void`
@@ -1165,11 +1185,11 @@ if the tax rate isn't number between 0-100
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [RegionService](RegionService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1183,7 +1203,7 @@ ___
}
]} />
##### Returns
#### Returns
[RegionService](RegionService.mdx)