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

docs: migrate guides to TSDoc references (#6100)

Browse Source
This commit is contained in:
Shahed Nasser
2024-01-22 19:38:35 +02:00
committed by GitHub
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/services.RegionService.mdx
-40
View File
@@ -46,8 +46,6 @@ Adds a country to the region.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
___
### addFulfillmentProvider
Adds a fulfillment provider that is available in the region. Fails if the
@@ -61,8 +59,6 @@ provider doesn't exist.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
___
### addPaymentProvider
Adds a payment provider that is available in the region. Fails if the
@@ -76,8 +72,6 @@ provider doesn't exist.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
___
### atomicPhase\_
Wraps some work within a transactional block. If the service already has
@@ -96,8 +90,6 @@ transaction manager is created.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]} />
___
### create
Creates a region.
@@ -110,8 +102,6 @@ Creates a region.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the newly created region","expandable":false,"children":[]}]} />
___
### delete
Deletes a region.
@@ -124,8 +114,6 @@ Deletes a region.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"the result of the delete operation","expandable":false,"children":[]}]} />
___
### list
Lists all regions based on a query
@@ -138,8 +126,6 @@ Lists all regions based on a query
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)[]&#62;","optional":false,"defaultValue":"","description":"result of the find operation","expandable":false,"children":[]}]} />
___
### listAndCount
Lists all regions based on a query and returns them along with count
@@ -152,8 +138,6 @@ Lists all regions based on a query and returns them along with count
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[[Region](../../entities/classes/entities.Region.mdx)[], number]&#62;","optional":false,"defaultValue":"","description":"result of the find operation","expandable":false,"children":[]}]} />
___
### removeCountry
Removes a country from a Region.
@@ -166,8 +150,6 @@ Removes a country from a Region.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
___
### removeFulfillmentProvider
Removes a fulfillment provider from a region. Is idempotent.
@@ -180,8 +162,6 @@ Removes a fulfillment provider from a region. Is idempotent.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
___
### removePaymentProvider
Removes a payment provider from a region. Is idempotent.
@@ -194,8 +174,6 @@ Removes a payment provider from a region. Is idempotent.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the updated Region","expandable":false,"children":[]}]} />
___
### retrieve
Retrieves a region by its id.
@@ -208,8 +186,6 @@ Retrieves a region by its id.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the region","expandable":false,"children":[]}]} />
___
### retrieveByCountryCode
Retrieve a region by country code.
@@ -222,8 +198,6 @@ Retrieve a region by country code.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"a Region with country code","expandable":false,"children":[]}]} />
___
### retrieveByName
Retrieves a region by name.
@@ -236,8 +210,6 @@ Retrieves a region by name.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"region with the matching name","expandable":false,"children":[]}]} />
___
### shouldRetryTransaction\_
#### Parameters
@@ -248,8 +220,6 @@ ___
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} />
___
### update
Updates a region
@@ -262,8 +232,6 @@ Updates a region
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the update operation","expandable":false,"children":[]}]} />
___
### validateCountry
Validates a country code. Will normalize the code before checking for
@@ -277,8 +245,6 @@ existence.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;[Country](../../entities/classes/entities.Country.mdx)&#62;","optional":false,"defaultValue":"","description":"the validated Country","expandable":false,"children":[]}]} />
___
### validateCurrency
Validates a currency code. Will throw if the currency code doesn't exist.
@@ -295,8 +261,6 @@ Validates a currency code. Will throw if the currency code doesn't exist.
if the provided currency code is invalid
___
### validateFields
Validates fields for creation and updates. If the region already exists
@@ -314,8 +278,6 @@ the id can be passed to check that country updates are allowed.
<ParameterTypes parameters={[{"name":"Promise","type":"Promise&#60;DeepPartial&#60;[Region](../../entities/classes/entities.Region.mdx)&#62;&#62;","optional":false,"defaultValue":"","description":"the validated region data","expandable":false,"children":[]}]} />
___
### validateTaxRate
Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
@@ -332,8 +294,6 @@ Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
if the tax rate isn't number between 0-100
___
### withTransaction
#### Parameters