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

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
docs/content/references/services/classes/RegionService.md
View File

@@ -1,5 +1,7 @@
# Class: RegionService
Provides layer to manipulate regions.
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/region.js:16](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L16)
[packages/medusa/src/services/region.js:16](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L16)
## Properties
@@ -42,7 +44,7 @@ BaseService.constructor
#### Defined in
[services/region.js:10](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L10)
[packages/medusa/src/services/region.js:10](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L10)
## Methods
@@ -50,20 +52,24 @@ BaseService.constructor
▸ **addCountry**(`regionId`, `code`): `Promise`<`any`\>
Adds a country to the region.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `code` | `string` | |
| `regionId` | `string` | the region to add a country to |
| `code` | `string` | a 2 digit alphanumeric ISO country code. |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:462](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L462)
[packages/medusa/src/services/region.js:462](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L462)
___
@@ -71,20 +77,25 @@ ___
▸ **addFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
Adds a fulfillment provider that is available in the region. Fails if the
provider doesn't exist.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `providerId` | `string` | |
| `regionId` | `string` | the region to add the provider to |
| `providerId` | `string` | the provider to add to the region |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:582](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L582)
[packages/medusa/src/services/region.js:582](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L582)
___
@@ -92,20 +103,25 @@ ___
▸ **addPaymentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
Adds a payment provider that is available in the region. Fails if the
provider doesn't exist.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `providerId` | `string` | |
| `regionId` | `string` | the region to add the provider to |
| `providerId` | `string` | the provider to add to the region |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:535](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L535)
[packages/medusa/src/services/region.js:535](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L535)
___
@@ -113,19 +129,23 @@ ___
▸ **create**(`regionObject`): `Region`
Creates a region.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionObject` | `Region` | |
| `regionObject` | `Region` | the unvalidated region |
#### Returns
`Region`
the newly created region
#### Defined in
[services/region.js:95](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L95)
[packages/medusa/src/services/region.js:95](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L95)
___
@@ -133,19 +153,23 @@ ___
▸ **delete**(`regionId`): `Promise`<`any`\>
Deletes a region.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `regionId` | `string` | the region to delete |
#### Returns
`Promise`<`any`\>
the result of the delete operation
#### Defined in
[services/region.js:432](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L432)
[packages/medusa/src/services/region.js:432](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L432)
___
@@ -153,20 +177,24 @@ ___
▸ **list**(`selector?`, `config?`): `Promise`<`any`\>
Lists all regions based on a query
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | query object for find |
| `config` | `any` | configuration settings |
#### Returns
`Promise`<`any`\>
result of the find operation
#### Defined in
[services/region.js:420](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L420)
[packages/medusa/src/services/region.js:420](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L420)
___
@@ -174,20 +202,24 @@ ___
▸ **removeCountry**(`regionId`, `code`): `Promise`<`any`\>
Removes a country from a Region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `code` | `string` | |
| `regionId` | `string` | the region to remove from |
| `code` | `string` | a 2 digit alphanumeric ISO country code to remove |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:499](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L499)
[packages/medusa/src/services/region.js:499](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L499)
___
@@ -195,20 +227,24 @@ ___
▸ **removeFulfillmentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
Removes a fulfillment provider from a region. Is idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `providerId` | `string` | |
| `regionId` | `string` | the region to remove the provider from |
| `providerId` | `string` | the provider to remove from the region |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:660](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L660)
[packages/medusa/src/services/region.js:660](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L660)
___
@@ -216,20 +252,24 @@ ___
▸ **removePaymentProvider**(`regionId`, `providerId`): `Promise`<`any`\>
Removes a payment provider from a region. Is idempotent.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `providerId` | `string` | |
| `regionId` | `string` | the region to remove the provider from |
| `providerId` | `string` | the provider to remove from the region |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:626](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L626)
[packages/medusa/src/services/region.js:626](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L626)
___
@@ -237,20 +277,24 @@ ___
▸ **retrieve**(`regionId`, `config?`): `Region`
Retrieves a region by its id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `config` | `any` | |
| `regionId` | `string` | the id of the region to retrieve |
| `config` | `any` | configuration settings |
#### Returns
`Region`
the region
#### Defined in
[services/region.js:396](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L396)
[packages/medusa/src/services/region.js:396](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L396)
___
@@ -271,7 +315,7 @@ ___
#### Defined in
[services/region.js:362](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L362)
[packages/medusa/src/services/region.js:362](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L362)
___
@@ -279,20 +323,24 @@ ___
▸ **update**(`regionId`, `update`): `Promise`<`any`\>
Updates a region
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `regionId` | `string` | |
| `update` | `any` | |
| `regionId` | `string` | the region to update |
| `update` | `any` | the data to update the region with |
#### Returns
`Promise`<`any`\>
the result of the update operation
#### Defined in
[services/region.js:153](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L153)
[packages/medusa/src/services/region.js:153](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L153)
___
@@ -300,12 +348,15 @@ ___
▸ **validateCountry_**(`code`, `regionId`): `Promise`<`any`\>
Validates a country code. Will normalize the code before checking for
existence.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `code` | `string` | |
| `regionId` | `string` | |
| `code` | `string` | a 2 digit alphanumeric ISO country code |
| `regionId` | `string` | the id of the current region to check against |
#### Returns
@@ -313,7 +364,7 @@ ___
#### Defined in
[services/region.js:323](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L323)
[packages/medusa/src/services/region.js:323](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L323)
___
@@ -321,11 +372,13 @@ ___
▸ **validateCurrency_**(`currencyCode`): `Promise`<`void`\>
Validates a currency code. Will throw if the currency code doesn't exist.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `currencyCode` | `string` | |
| `currencyCode` | `string` | an ISO currency code |
#### Returns
@@ -333,7 +386,7 @@ ___
#### Defined in
[services/region.js:302](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L302)
[packages/medusa/src/services/region.js:302](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L302)
___
@@ -341,20 +394,25 @@ ___
▸ **validateFields_**(`region`, `id?`): `any`
Validates fields for creation and updates. If the region already exisits
the id can be passed to check that country updates are allowed.
#### Parameters
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `region` | `any` | `undefined` | |
| `id` | ``null`` \| `string` | `undefined` | |
| `region` | `any` | `undefined` | the region data to validate |
| `id` | ``null`` \| `string` | `undefined` | optional id of the region to check against |
#### Returns
`any`
the validated region data
#### Defined in
[services/region.js:213](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L213)
[packages/medusa/src/services/region.js:213](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L213)
___
@@ -362,11 +420,13 @@ ___
▸ **validateTaxRate_**(`taxRate`): `void`
Validates a tax rate. Will throw if the tax rate is not between 0 and 1.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `taxRate` | `number` | |
| `taxRate` | `number` | a number representing the tax rate of the region |
#### Returns
@@ -374,7 +434,7 @@ ___
#### Defined in
[services/region.js:289](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L289)
[packages/medusa/src/services/region.js:289](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L289)
___
@@ -394,4 +454,4 @@ ___
#### Defined in
[services/region.js:65](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/region.js#L65)
[packages/medusa/src/services/region.js:65](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/region.js#L65)