chore(docs): Generated Services Reference (automated) (#2152)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
70139d0bbb
commit
c65d6f0630
@@ -24,7 +24,7 @@ TransactionBaseService.constructor
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L37)
|
||||
[packages/medusa/src/services/sales-channel.ts:37](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L37)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -38,7 +38,7 @@ TransactionBaseService.\_\_configModule\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:10](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L10)
|
||||
|
||||
___
|
||||
|
||||
@@ -52,7 +52,7 @@ TransactionBaseService.\_\_container\_\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:9](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L9)
|
||||
|
||||
___
|
||||
|
||||
@@ -62,7 +62,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L34)
|
||||
[packages/medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L34)
|
||||
|
||||
___
|
||||
|
||||
@@ -76,7 +76,7 @@ TransactionBaseService.manager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L30)
|
||||
[packages/medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L30)
|
||||
|
||||
___
|
||||
|
||||
@@ -86,7 +86,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L33)
|
||||
[packages/medusa/src/services/sales-channel.ts:33](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L33)
|
||||
|
||||
___
|
||||
|
||||
@@ -96,7 +96,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L35)
|
||||
[packages/medusa/src/services/sales-channel.ts:35](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@@ -110,7 +110,7 @@ TransactionBaseService.transactionManager\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L31)
|
||||
[packages/medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -128,7 +128,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L24)
|
||||
[packages/medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L24)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -153,7 +153,7 @@ the sales channel on which the products have been added
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:277](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L277)
|
||||
[packages/medusa/src/services/sales-channel.ts:310](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L310)
|
||||
|
||||
___
|
||||
|
||||
@@ -192,7 +192,7 @@ TransactionBaseService.atomicPhase\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:50](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L50)
|
||||
|
||||
___
|
||||
|
||||
@@ -219,7 +219,7 @@ the created channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L134)
|
||||
[packages/medusa/src/services/sales-channel.ts:167](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L167)
|
||||
|
||||
___
|
||||
|
||||
@@ -237,7 +237,7 @@ the sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:224](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L224)
|
||||
[packages/medusa/src/services/sales-channel.ts:257](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L257)
|
||||
|
||||
___
|
||||
|
||||
@@ -261,7 +261,7 @@ To use this feature please enable the corresponding feature flag in your medusa
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L185)
|
||||
[packages/medusa/src/services/sales-channel.ts:218](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L218)
|
||||
|
||||
___
|
||||
|
||||
@@ -289,7 +289,7 @@ an array containing the sales channels as
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:99](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L99)
|
||||
[packages/medusa/src/services/sales-channel.ts:132](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L132)
|
||||
|
||||
___
|
||||
|
||||
@@ -314,7 +314,7 @@ the sales channel on which the products have been removed
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:256](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L256)
|
||||
[packages/medusa/src/services/sales-channel.ts:289](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L289)
|
||||
|
||||
___
|
||||
|
||||
@@ -324,15 +324,12 @@ ___
|
||||
|
||||
Retrieve a SalesChannel by id
|
||||
|
||||
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.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `salesChannelId` | `string` |
|
||||
| `config` | `FindConfig`<`SalesChannel`\> |
|
||||
| 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. |
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -342,7 +339,57 @@ a sales channel
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:64](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L64)
|
||||
[packages/medusa/src/services/sales-channel.ts:104](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L104)
|
||||
|
||||
___
|
||||
|
||||
### retrieveByName
|
||||
|
||||
▸ **retrieveByName**(`name`, `config?`): `Promise`<`unknown`\>
|
||||
|
||||
Find a sales channel by name.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `name` | `string` | of the sales channel |
|
||||
| `config` | `FindConfig`<`SalesChannel`\> | find config |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`unknown`\>
|
||||
|
||||
a sales channel with matching name
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:118](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L118)
|
||||
|
||||
___
|
||||
|
||||
### retrieve\_
|
||||
|
||||
▸ `Protected` **retrieve_**(`selector`, `config?`): `Promise`<`SalesChannel`\>
|
||||
|
||||
A generic retrieve used to find a sales channel by different attributes.
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `selector` | `Selector`<`SalesChannel`\> | SC selector |
|
||||
| `config` | `FindConfig`<`SalesChannel`\> | find config |
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`<`SalesChannel`\>
|
||||
|
||||
a single SC matching the query or throws
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:64](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L64)
|
||||
|
||||
___
|
||||
|
||||
@@ -366,7 +413,7 @@ TransactionBaseService.shouldRetryTransaction\_
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:31](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
@@ -387,7 +434,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/services/sales-channel.ts:151](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/services/sales-channel.ts#L151)
|
||||
[packages/medusa/src/services/sales-channel.ts:184](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/services/sales-channel.ts#L184)
|
||||
|
||||
___
|
||||
|
||||
@@ -411,4 +458,4 @@ TransactionBaseService.withTransaction
|
||||
|
||||
#### Defined in
|
||||
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
[packages/medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
|
||||
|
||||
Reference in New Issue
Block a user