chore(docs): Generated Services Reference (automated) (#5333)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
co-authored by
shahednasser
Shahed Nasser
shahednasser
Shahed Nasser
parent
431782d023
commit
074055acbb
@@ -10,13 +10,13 @@
|
||||
|
||||
### constructor
|
||||
|
||||
• **new SalesChannelService**(`__namedParameters`)
|
||||
• **new SalesChannelService**(`«destructured»`)
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `__namedParameters` | `InjectedDependencies` |
|
||||
| `«destructured»` | `InjectedDependencies` |
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L34)
|
||||
[medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L34)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
___
|
||||
|
||||
@@ -66,7 +66,7 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L31)
|
||||
[medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -90,17 +90,17 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
|
||||
|
||||
___
|
||||
|
||||
### 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`\> }
|
||||
• `Protected` `Readonly` **salesChannelRepository\_**: `Repository`<`SalesChannel`\> & { `addProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`void`\> ; `getFreeTextSearchResultsAndCount`: (`q`: `string`, `options`: `ExtendedFindConfig`<`SalesChannel`\>) => `Promise`<[`SalesChannel`[], `number`]\> ; `listProductIdsBySalesChannelIds`: (`salesChannelIds`: `string` \| `string`[]) => `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> ; `removeProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> }
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L30)
|
||||
[medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,7 +110,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L32)
|
||||
[medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L32)
|
||||
|
||||
___
|
||||
|
||||
@@ -124,7 +124,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
|
||||
|
||||
___
|
||||
|
||||
@@ -142,7 +142,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L24)
|
||||
[medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L24)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -160,7 +160,7 @@ TransactionBaseService.activeManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -185,7 +185,7 @@ the sales channel on which the products have been added
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:332](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L332)
|
||||
[medusa/src/services/sales-channel.ts:348](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L348)
|
||||
|
||||
___
|
||||
|
||||
@@ -224,7 +224,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
@@ -251,7 +251,7 @@ the created channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L168)
|
||||
[medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L168)
|
||||
|
||||
___
|
||||
|
||||
@@ -269,7 +269,7 @@ the sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L258)
|
||||
[medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L258)
|
||||
|
||||
___
|
||||
|
||||
@@ -293,7 +293,7 @@ To use this feature please enable the corresponding feature flag in your medusa
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L219)
|
||||
[medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L219)
|
||||
|
||||
___
|
||||
|
||||
@@ -321,7 +321,29 @@ an array containing the sales channels as
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L134)
|
||||
[medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L134)
|
||||
|
||||
___
|
||||
|
||||
### listProductIdsBySalesChannelIds
|
||||
|
||||
▸ **listProductIdsBySalesChannelIds**(`salesChannelIds`): `Promise`<{ `[salesChannelId: string]`: `string`[]; }\>
|
||||
|
||||
List all product ids that belongs to the sales channels ids
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `salesChannelIds` | `string` \| `string`[] |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<{ `[salesChannelId: string]`: `string`[]; }\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:310](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L310)
|
||||
|
||||
___
|
||||
|
||||
@@ -346,7 +368,7 @@ the sales channel on which the products have been removed
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:311](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L311)
|
||||
[medusa/src/services/sales-channel.ts:327](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L327)
|
||||
|
||||
___
|
||||
|
||||
@@ -361,7 +383,7 @@ Retrieve a SalesChannel by id
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `salesChannelId` | `string` | id of the channel to retrieve |
|
||||
| `config` | `FindConfig`<`SalesChannel`\> | SC config This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project. |
|
||||
| `config` | `FindConfig`<`SalesChannel`\> | SC config This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project. |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -371,7 +393,7 @@ a sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L92)
|
||||
[medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L92)
|
||||
|
||||
___
|
||||
|
||||
@@ -396,7 +418,7 @@ a sales channel with matching name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L113)
|
||||
[medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L113)
|
||||
|
||||
___
|
||||
|
||||
@@ -414,7 +436,7 @@ the sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L288)
|
||||
[medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L288)
|
||||
|
||||
___
|
||||
|
||||
@@ -439,7 +461,7 @@ a single SC matching the query or throws
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L54)
|
||||
[medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L54)
|
||||
|
||||
___
|
||||
|
||||
@@ -463,7 +485,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
|
||||
|
||||
___
|
||||
|
||||
@@ -484,7 +506,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/services/sales-channel.ts#L185)
|
||||
[medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/services/sales-channel.ts#L185)
|
||||
|
||||
___
|
||||
|
||||
@@ -508,4 +530,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/755f9cf30/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/418ff2a33/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
|
||||
|
||||
Reference in New Issue
Block a user