chore(docs): Generated Services Reference (automated) (#4560)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
e8b27b0cde
commit
6ee80794c9
@@ -26,7 +26,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:65](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L65)
|
||||
[medusa/src/services/region.ts:64](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L64)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -40,7 +40,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -54,7 +54,7 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -68,7 +68,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -78,7 +78,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L57)
|
||||
[medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -88,7 +88,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:58](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L58)
|
||||
[medusa/src/services/region.ts:57](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L57)
|
||||
|
||||
___
|
||||
|
||||
@@ -98,7 +98,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L52)
|
||||
[medusa/src/services/region.ts:51](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
@@ -108,7 +108,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:50](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L50)
|
||||
[medusa/src/services/region.ts:49](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L49)
|
||||
|
||||
___
|
||||
|
||||
@@ -118,7 +118,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L62)
|
||||
[medusa/src/services/region.ts:61](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L61)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L55)
|
||||
[medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -142,7 +142,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
@@ -152,7 +152,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:60](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L60)
|
||||
[medusa/src/services/region.ts:59](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@@ -162,7 +162,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:54](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L54)
|
||||
[medusa/src/services/region.ts:53](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L53)
|
||||
|
||||
___
|
||||
|
||||
@@ -172,7 +172,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:56](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L56)
|
||||
[medusa/src/services/region.ts:55](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L55)
|
||||
|
||||
___
|
||||
|
||||
@@ -182,7 +182,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:53](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L53)
|
||||
[medusa/src/services/region.ts:52](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L52)
|
||||
|
||||
___
|
||||
|
||||
@@ -192,7 +192,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:63](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L63)
|
||||
[medusa/src/services/region.ts:62](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L62)
|
||||
|
||||
___
|
||||
|
||||
@@ -206,7 +206,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -224,7 +224,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:44](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L44)
|
||||
[medusa/src/services/region.ts:43](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L43)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -242,7 +242,7 @@ TransactionBaseService.activeManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -267,7 +267,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:559](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L559)
|
||||
[medusa/src/services/region.ts:577](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L577)
|
||||
|
||||
___
|
||||
|
||||
@@ -293,7 +293,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:687](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L687)
|
||||
[medusa/src/services/region.ts:705](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L705)
|
||||
|
||||
___
|
||||
|
||||
@@ -319,7 +319,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:638](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L638)
|
||||
[medusa/src/services/region.ts:656](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L656)
|
||||
|
||||
___
|
||||
|
||||
@@ -358,7 +358,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -382,7 +382,7 @@ the newly created region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:101](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L101)
|
||||
[medusa/src/services/region.ts:100](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L100)
|
||||
|
||||
___
|
||||
|
||||
@@ -406,7 +406,7 @@ the result of the delete operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:528](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L528)
|
||||
[medusa/src/services/region.ts:546](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L546)
|
||||
|
||||
___
|
||||
|
||||
@@ -431,7 +431,32 @@ result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:506](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L506)
|
||||
[medusa/src/services/region.ts:505](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L505)
|
||||
|
||||
___
|
||||
|
||||
### listAndCount
|
||||
|
||||
▸ **listAndCount**(`selector?`, `config?`): `Promise`<[`Region`[], `number`]\>
|
||||
|
||||
Lists all regions based on a query and returns them along with count
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `selector` | `Selector`<`Region`\> | query object for find |
|
||||
| `config` | `FindConfig`<`Region`\> | configuration settings |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<[`Region`[], `number`]\>
|
||||
|
||||
result of the find operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:524](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L524)
|
||||
|
||||
___
|
||||
|
||||
@@ -456,7 +481,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:597](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L597)
|
||||
[medusa/src/services/region.ts:615](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L615)
|
||||
|
||||
___
|
||||
|
||||
@@ -481,7 +506,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:773](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L773)
|
||||
[medusa/src/services/region.ts:791](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L791)
|
||||
|
||||
___
|
||||
|
||||
@@ -506,7 +531,7 @@ the updated Region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:734](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L734)
|
||||
[medusa/src/services/region.ts:752](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L752)
|
||||
|
||||
___
|
||||
|
||||
@@ -531,7 +556,7 @@ the region
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:471](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L471)
|
||||
[medusa/src/services/region.ts:470](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L470)
|
||||
|
||||
___
|
||||
|
||||
@@ -556,7 +581,7 @@ a Region with country code
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:417](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L417)
|
||||
[medusa/src/services/region.ts:416](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L416)
|
||||
|
||||
___
|
||||
|
||||
@@ -580,7 +605,7 @@ region with the matching name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:451](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L451)
|
||||
[medusa/src/services/region.ts:450](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L450)
|
||||
|
||||
___
|
||||
|
||||
@@ -604,7 +629,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -629,7 +654,7 @@ the result of the update operation
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:172](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L172)
|
||||
[medusa/src/services/region.ts:171](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L171)
|
||||
|
||||
___
|
||||
|
||||
@@ -655,7 +680,7 @@ the validated Country
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:368](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L368)
|
||||
[medusa/src/services/region.ts:367](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L367)
|
||||
|
||||
___
|
||||
|
||||
@@ -683,7 +708,7 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:343](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L343)
|
||||
[medusa/src/services/region.ts:342](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L342)
|
||||
|
||||
___
|
||||
|
||||
@@ -715,7 +740,7 @@ the validated region data
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:241](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L241)
|
||||
[medusa/src/services/region.ts:240](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L240)
|
||||
|
||||
___
|
||||
|
||||
@@ -743,7 +768,7 @@ void
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/region.ts:327](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/services/region.ts#L327)
|
||||
[medusa/src/services/region.ts:326](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/services/region.ts#L326)
|
||||
|
||||
___
|
||||
|
||||
@@ -767,4 +792,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/499c3478c/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/95c538c67/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
|
||||
Reference in New Issue
Block a user