chore(docs): Generated References (#5516)

Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-11-02 09:16:47 +00:00
committed by GitHub
parent 80fe362f33
commit aa2bb7a31b
271 changed files with 38146 additions and 9809 deletions

View File

@@ -1,4 +1,4 @@
# Class: SalesChannelService
# SalesChannelService
## Hierarchy
@@ -10,12 +10,12 @@
### constructor
**new SalesChannelService**(`«destructured»`)
**new SalesChannelService**(`«destructured»`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `«destructured»` | `InjectedDependencies` |
#### Overrides
@@ -24,13 +24,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L34)
[medusa/src/services/sales-channel.ts:34](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L34)
## Properties
### \_\_configModule\_\_
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -38,13 +38,13 @@ TransactionBaseService.\_\_configModule\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)
___
### \_\_container\_\_
`Protected` `Readonly` **\_\_container\_\_**: `any`
`Protected` `Readonly` **\_\_container\_\_**: `any`
#### Inherited from
@@ -52,13 +52,13 @@ TransactionBaseService.\_\_container\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)
___
### \_\_moduleDeclaration\_\_
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -66,23 +66,23 @@ TransactionBaseService.\_\_moduleDeclaration\_\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)
___
### eventBusService\_
`Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
`Protected` `Readonly` **eventBusService\_**: [`EventBusService`](EventBusService.md)
#### Defined in
[medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L31)
[medusa/src/services/sales-channel.ts:31](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L31)
___
### manager\_
`Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -90,33 +90,33 @@ TransactionBaseService.manager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L5)
[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/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`]\> ; `listProductIdsBySalesChannelIds`: (`salesChannelIds`: `string` \| `string`[]) => `Promise`<{ `[salesChannelId: string]`: `string`[]; }\> ; `removeProducts`: (`salesChannelId`: `string`, `productIds`: `string`[]) => `Promise`<`DeleteResult`\> }
`Protected` `Readonly` **salesChannelRepository\_**: `Repository`<`SalesChannel`\> & { `addProducts`: Method addProducts ; `getFreeTextSearchResultsAndCount`: Method getFreeTextSearchResultsAndCount ; `listProductIdsBySalesChannelIds`: Method listProductIdsBySalesChannelIds ; `removeProducts`: Method removeProducts }
#### Defined in
[medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L30)
[medusa/src/services/sales-channel.ts:30](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L30)
___
### storeService\_
`Protected` `Readonly` **storeService\_**: [`StoreService`](StoreService.md)
`Protected` `Readonly` **storeService\_**: [`StoreService`](StoreService.md)
#### Defined in
[medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L32)
[medusa/src/services/sales-channel.ts:32](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L32)
___
### transactionManager\_
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -124,13 +124,13 @@ TransactionBaseService.transactionManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)
___
### Events
`Static` **Events**: `Object`
`Static` **Events**: `Object`
#### Type declaration
@@ -142,38 +142,40 @@ ___
#### Defined in
[medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L24)
[medusa/src/services/sales-channel.ts:24](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L24)
## Accessors
### activeManager\_
`Protected` `get` **activeManager_**(): `EntityManager`
`Protected` `get` **activeManager_**(): `EntityManager`
#### Returns
`EntityManager`
-`EntityManager`:
#### Inherited from
TransactionBaseService.activeManager\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)
## Methods
### addProducts
**addProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\>
**addProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\>
Add a batch of product to a sales channel
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | 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 |
@@ -181,33 +183,32 @@ Add a batch of product to a sales channel
`Promise`<`SalesChannel`\>
the sales channel on which the products have been added
-`Promise`: the sales channel on which the products have been added
-`SalesChannel`:
#### Defined in
[medusa/src/services/sales-channel.ts:348](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L348)
[medusa/src/services/sales-channel.ts:348](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L348)
___
### atomicPhase\_
`Protected` **atomicPhase_**<`TResult`, `TError`\>(`work`, `isolationOrErrorHandler?`, `maybeErrorHandlerOrDontFail?`): `Promise`<`TResult`\>
`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` |
| `TResult` | `object` |
| `TError` | `object` |
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | 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 |
@@ -216,7 +217,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -224,13 +225,13 @@ TransactionBaseService.atomicPhase\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)
___
### create
**create**(`data`): `Promise`<`SalesChannel`\>
**create**(`data`): `Promise`<`SalesChannel`\>
Creates a SalesChannel
@@ -239,25 +240,26 @@ To use this feature please enable the corresponding feature flag in your medusa
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `data` | `CreateSalesChannelInput` |
#### Returns
`Promise`<`SalesChannel`\>
the created channel
-`Promise`: the created channel
-`SalesChannel`:
#### Defined in
[medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L168)
[medusa/src/services/sales-channel.ts:168](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L168)
___
### createDefault
**createDefault**(): `Promise`<`SalesChannel`\>
**createDefault**(): `Promise`<`SalesChannel`\>
Creates a default sales channel, if this does not already exist.
@@ -265,17 +267,18 @@ Creates a default sales channel, if this does not already exist.
`Promise`<`SalesChannel`\>
the sales channel
-`Promise`: the sales channel
-`SalesChannel`:
#### Defined in
[medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L258)
[medusa/src/services/sales-channel.ts:258](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L258)
___
### delete
**delete**(`salesChannelId`): `Promise`<`void`\>
**delete**(`salesChannelId`): `Promise`<`void`\>
Deletes a sales channel from
This feature is under development and may change in the future.
@@ -283,31 +286,33 @@ To use this feature please enable the corresponding feature flag in your medusa
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `salesChannelId` | `string` | the id of the sales channel to delete |
#### Returns
`Promise`<`void`\>
-`Promise`:
#### Defined in
[medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L219)
[medusa/src/services/sales-channel.ts:219](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L219)
___
### listAndCount
**listAndCount**(`selector`, `config?`): `Promise`<[`SalesChannel`[], `number`]\>
**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 |
| :------ | :------ |
| Name |
| :------ |
| `selector` | `QuerySelector`<`SalesChannel`\> |
| `config` | `FindConfig`<`SalesChannel`\> |
@@ -315,48 +320,53 @@ sales channels that match the query.
`Promise`<[`SalesChannel`[], `number`]\>
an array containing the sales channels as
-`Promise`: 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.
-`SalesChannel[]`:
-`number`: (optional)
#### Defined in
[medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L134)
[medusa/src/services/sales-channel.ts:134](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L134)
___
### listProductIdsBySalesChannelIds
**listProductIdsBySalesChannelIds**(`salesChannelIds`): `Promise`<{ `[salesChannelId: string]`: `string`[]; }\>
**listProductIdsBySalesChannelIds**(`salesChannelIds`): `Promise`<{ `[salesChannelId: string]`: `string`[]; }\>
List all product ids that belongs to the sales channels ids
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `salesChannelIds` | `string` \| `string`[] |
#### Returns
`Promise`<{ `[salesChannelId: string]`: `string`[]; }\>
-`Promise`:
-``object``: (optional)
#### Defined in
[medusa/src/services/sales-channel.ts:310](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L310)
[medusa/src/services/sales-channel.ts:310](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L310)
___
### removeProducts
**removeProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\>
**removeProducts**(`salesChannelId`, `productIds`): `Promise`<`SalesChannel`\>
Remove a batch of product from a sales channel
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | 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 |
@@ -364,24 +374,25 @@ Remove a batch of product from a sales channel
`Promise`<`SalesChannel`\>
the sales channel on which the products have been removed
-`Promise`: the sales channel on which the products have been removed
-`SalesChannel`:
#### Defined in
[medusa/src/services/sales-channel.ts:327](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L327)
[medusa/src/services/sales-channel.ts:327](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L327)
___
### retrieve
**retrieve**(`salesChannelId`, `config?`): `Promise`<`SalesChannel`\>
**retrieve**(`salesChannelId`, `config?`): `Promise`<`SalesChannel`\>
Retrieve a SalesChannel by id
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | 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. |
@@ -389,24 +400,25 @@ Retrieve a SalesChannel by id
`Promise`<`SalesChannel`\>
a sales channel
-`Promise`: a sales channel
-`SalesChannel`:
#### Defined in
[medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L92)
[medusa/src/services/sales-channel.ts:92](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L92)
___
### retrieveByName
**retrieveByName**(`name`, `config?`): `Promise`<`unknown`\>
**retrieveByName**(`name`, `config?`): `Promise`<`unknown`\>
Find a sales channel by name.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `name` | `string` | of the sales channel |
| `config` | `FindConfig`<`SalesChannel`\> | find config |
@@ -414,17 +426,18 @@ Find a sales channel by name.
`Promise`<`unknown`\>
a sales channel with matching name
-`Promise`: a sales channel with matching name
-`unknown`: (optional)
#### Defined in
[medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L113)
[medusa/src/services/sales-channel.ts:113](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L113)
___
### retrieveDefault
**retrieveDefault**(): `Promise`<`SalesChannel`\>
**retrieveDefault**(): `Promise`<`SalesChannel`\>
Retrieves the default sales channel.
@@ -432,24 +445,25 @@ Retrieves the default sales channel.
`Promise`<`SalesChannel`\>
the sales channel
-`Promise`: the sales channel
-`SalesChannel`:
#### Defined in
[medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L288)
[medusa/src/services/sales-channel.ts:288](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L288)
___
### retrieve\_
`Protected` **retrieve_**(`selector`, `config?`): `Promise`<`SalesChannel`\>
`Protected` **retrieve_**(`selector`, `config?`): `Promise`<`SalesChannel`\>
A generic retrieve used to find a sales channel by different attributes.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `selector` | `Selector`<`SalesChannel`\> | SC selector |
| `config` | `FindConfig`<`SalesChannel`\> | find config |
@@ -457,46 +471,49 @@ A generic retrieve used to find a sales channel by different attributes.
`Promise`<`SalesChannel`\>
a single SC matching the query or throws
-`Promise`: a single SC matching the query or throws
-`SalesChannel`:
#### Defined in
[medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L54)
[medusa/src/services/sales-channel.ts:54](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L54)
___
### shouldRetryTransaction\_
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
`Protected` **shouldRetryTransaction_**(`err`): `boolean`
#### Parameters
| Name | Type |
| :------ | :------ |
| `err` | `Record`<`string`, `unknown`\> \| { `code`: `string` } |
| Name |
| :------ |
| `err` | Record<`string`, `unknown`\> \| { `code`: `string` } |
#### Returns
`boolean`
-`boolean`: (optional)
#### Inherited from
TransactionBaseService.shouldRetryTransaction\_
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)
___
### update
**update**(`salesChannelId`, `data`): `Promise`<`SalesChannel`\>
**update**(`salesChannelId`, `data`): `Promise`<`SalesChannel`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `salesChannelId` | `string` |
| `data` | `Partial`<`CreateSalesChannelInput`\> |
@@ -504,30 +521,35 @@ ___
`Promise`<`SalesChannel`\>
-`Promise`:
-`SalesChannel`:
#### Defined in
[medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel.ts#L185)
[medusa/src/services/sales-channel.ts:185](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel.ts#L185)
___
### withTransaction
**withTransaction**(`transactionManager?`): [`SalesChannelService`](SalesChannelService.md)
**withTransaction**(`transactionManager?`): [`SalesChannelService`](SalesChannelService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`SalesChannelService`](SalesChannelService.md)
-`SalesChannelService`:
#### Inherited from
TransactionBaseService.withTransaction
#### Defined in
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/interfaces/transaction-base-service.ts#L20)
[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L20)