chore(docs): Generated Services Reference (automated) (#3719)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-04-04 21:01:53 +03:00
committed by GitHub
parent 3838067a54
commit 198f39f8d4
60 changed files with 3569 additions and 2425 deletions

View File

@@ -24,7 +24,7 @@ TransactionBaseService.constructor
#### Defined in
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L37)
[medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L34)
## Properties
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:11](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L11)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
@@ -76,7 +76,7 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L34)
[medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L31)
___
@@ -84,23 +84,23 @@ ___
`Protected` **manager\_**: `EntityManager`
#### Overrides
#### Inherited from
TransactionBaseService.manager\_
#### Defined in
[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L30)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
___
### salesChannelRepository\_
`Protected` `Readonly` **salesChannelRepository\_**: typeof `SalesChannelRepository`
`Protected` `Readonly` **salesChannelRepository\_**: `Repository`<`SalesChannel`\> & { `addProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `ExtendedFindConfig`<`SalesChannel`\>) => `Promise`<[`SalesChannel`[], `number`]\> ; `removeProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> }
#### Defined in
[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L33)
[medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L30)
___
@@ -110,7 +110,7 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L35)
[medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L32)
___
@@ -118,13 +118,13 @@ ___
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Overrides
#### Inherited from
TransactionBaseService.transactionManager\_
#### Defined in
[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L31)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
@@ -142,7 +142,25 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L24)
[medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L24)
## Accessors
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
@@ -167,7 +185,7 @@ the sales channel on which the products have been added
#### Defined in
[packages/medusa/src/services/sales-channel.ts:344](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L344)
[medusa/src/services/sales-channel.ts:332](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L332)
___
@@ -206,7 +224,7 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
@@ -233,7 +251,7 @@ the created channel
#### Defined in
[packages/medusa/src/services/sales-channel.ts:180](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L180)
[medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L168)
___
@@ -251,7 +269,7 @@ the sales channel
#### Defined in
[packages/medusa/src/services/sales-channel.ts:270](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L270)
[medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L258)
___
@@ -275,21 +293,7 @@ To use this feature please enable the corresponding feature flag in your medusa
#### Defined in
[packages/medusa/src/services/sales-channel.ts:231](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L231)
___
### getManager
`Private` **getManager**(): `EntityManager`
#### Returns
`EntityManager`
#### Defined in
[packages/medusa/src/services/sales-channel.ts:52](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L52)
[medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L219)
___
@@ -317,7 +321,7 @@ an array containing the sales channels as
#### Defined in
[packages/medusa/src/services/sales-channel.ts:145](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L145)
[medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L134)
___
@@ -342,7 +346,7 @@ the sales channel on which the products have been removed
#### Defined in
[packages/medusa/src/services/sales-channel.ts:323](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L323)
[medusa/src/services/sales-channel.ts:311](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L311)
___
@@ -367,7 +371,7 @@ a sales channel
#### Defined in
[packages/medusa/src/services/sales-channel.ts:103](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L103)
[medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L92)
___
@@ -392,7 +396,7 @@ a sales channel with matching name
#### Defined in
[packages/medusa/src/services/sales-channel.ts:124](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L124)
[medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L113)
___
@@ -410,7 +414,7 @@ the sales channel
#### Defined in
[packages/medusa/src/services/sales-channel.ts:300](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L300)
[medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L288)
___
@@ -435,7 +439,7 @@ a single SC matching the query or throws
#### Defined in
[packages/medusa/src/services/sales-channel.ts:63](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L63)
[medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L54)
___
@@ -459,7 +463,7 @@ TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
@@ -480,7 +484,7 @@ ___
#### Defined in
[packages/medusa/src/services/sales-channel.ts:197](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/services/sales-channel.ts#L197)
[medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/services/sales-channel.ts#L185)
___
@@ -504,4 +508,4 @@ TransactionBaseService.withTransaction
#### Defined in
[packages/medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/a4575c391/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/66c59d54f/packages/medusa/src/interfaces/transaction-base-service.ts#L20)