asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
c95ebdfdb30ca0a227ef3ad245c90e1e3bf0c7b0
medusa-store/docs/content/references/services/classes/SalesChannelService.md
github-actions[bot] c95ebdfdb3 chore(docs): Generated Services Reference (automated) (#4055) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-05-09 17:53:18 +03:00

512 lines
12 KiB
Markdown
Raw Blame History

# Class: SalesChannelService
## Hierarchy
- `TransactionBaseService`
↳ **`SalesChannelService`**
## Constructors
### constructor
• **new SalesChannelService**(`__namedParameters`)
#### Parameters
| Name | Type |
| :------ | :------ |
| `__namedParameters` | `InjectedDependencies` |
#### Overrides
TransactionBaseService.constructor
#### Defined in
[medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L34)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
• `Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
• `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
#### Inherited from
TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### eventBusService\_
• `Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L31)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
#### Inherited from
TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/27ff5a7f5/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`\> }
#### Defined in
[medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L30)
___
### storeService\_
• `Protected` `Readonly` **storeService\_**: [`StoreService`](StoreService.md)
#### Defined in
[medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L32)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
### Events
▪ `Static` **Events**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `CREATED` | `string` |
| `DELETED` | `string` |
| `UPDATED` | `string` |
#### Defined in
[medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/27ff5a7f5/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/27ff5a7f5/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### addProducts
▸ **addProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\>
Add a batch of product to a sales channel
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `salesChannelId` | `string` | The id of the sales channel on which to add the products |
| `productIds` | `string`[] | The products ids to attach to the sales channel |
#### Returns
`Promise`<`SalesChannel`\>
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/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L332)
___
### atomicPhase\_
▸ `Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type parameters
| Name |
| :------ |
| `TResult` |
| `TError` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `work` | (`transactionManager`: `EntityManager`) => `Promise`<`TResult`\> | the transactional work to be done |
| `isolationOrErrorHandler?` | `IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | the isolation level to be used for the work. |
| `maybeErrorHandlerOrDontFail?` | (`error`: `TError`) => `Promise`<`void` \| `TResult`\> | Potential error handler |
#### Returns
`Promise`<`TResult`\>
the result of the transactional work
#### Inherited from
TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### create
▸ **create**(`data`): `Promise`<`SalesChannel`\>
Creates a SalesChannel
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 |
| :------ | :------ |
| `data` | `CreateSalesChannelInput` |
#### Returns
`Promise`<`SalesChannel`\>
the created channel
#### Defined in
[medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L168)
___
### createDefault
▸ **createDefault**(): `Promise`<`SalesChannel`\>
Creates a default sales channel, if this does not already exist.
#### Returns
`Promise`<`SalesChannel`\>
the sales channel
#### Defined in
[medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L258)
___
### delete
▸ **delete**(`salesChannelId`): `Promise`<`void`\>
Deletes a sales channel from
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 | Description |
| :------ | :------ | :------ |
| `salesChannelId` | `string` | the id of the sales channel to delete |
#### Returns
`Promise`<`void`\>
#### Defined in
[medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L219)
___
### listAndCount
▸ **listAndCount**(`selector`, `config?`): `Promise`<[`SalesChannel`[], `number`]\>
Lists sales channels based on the provided parameters and includes the count of
sales channels that match the query.
#### Parameters
| Name | Type |
| :------ | :------ |
| `selector` | `QuerySelector`<`SalesChannel`\> |
| `config` | `FindConfig`<`SalesChannel`\> |
#### Returns
`Promise`<[`SalesChannel`[], `number`]\>
an array containing the sales channels as
the first element and the total count of sales channels that matches the query
as the second element.
#### Defined in
[medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L134)
___
### removeProducts
▸ **removeProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\>
Remove a batch of product from a sales channel
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `salesChannelId` | `string` | The id of the sales channel on which to remove the products |
| `productIds` | `string`[] | The products ids to remove from the sales channel |
#### Returns
`Promise`<`SalesChannel`\>
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/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L311)
___
### retrieve
▸ **retrieve**(`salesChannelId`, `config?`): `Promise`<`SalesChannel`\>
Retrieve a SalesChannel by id
#### Parameters
| 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
`Promise`<`SalesChannel`\>
a sales channel
#### Defined in
[medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L92)
___
### 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
[medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L113)
___
### retrieveDefault
▸ **retrieveDefault**(): `Promise`<`SalesChannel`\>
Retrieves the default sales channel.
#### Returns
`Promise`<`SalesChannel`\>
the sales channel
#### Defined in
[medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L288)
___
### 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
[medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L54)
___
### shouldRetryTransaction\_
▸ `Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### update
▸ **update**(`salesChannelId`, `data`): `Promise`<`SalesChannel`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `salesChannelId` | `string` |
| `data` | `Partial`<`CreateSalesChannelInput`\> |
#### Returns
`Promise`<`SalesChannel`\>
#### Defined in
[medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/services/sales-channel.ts#L185)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`SalesChannelService`](SalesChannelService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`SalesChannelService`](SalesChannelService.md)
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/27ff5a7f5/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
Reference in New Issue View Git Blame Copy Permalink