asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore(docs): Generated References (#5516)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/SalesChannelLocationService.md
+69 -61
View File
@@ -1,4 +1,4 @@
# Class: SalesChannelLocationService
# SalesChannelLocationService
Service for managing the stock locations of sales channels
@@ -12,12 +12,12 @@ Service for managing the stock locations of sales channels
### constructor
• **new SalesChannelLocationService**(`«destructured»`)
**new SalesChannelLocationService**(`«destructured»`)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `«destructured»` | `InjectedDependencies` |
#### Overrides
@@ -26,13 +26,13 @@ TransactionBaseService.constructor
#### Defined in
[medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel-location.ts#L24)
[medusa/src/services/sales-channel-location.ts:24](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel-location.ts#L24)
## Properties
### \_\_configModule\_\_
• `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: `Record`<`string`, `unknown`\>
`Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>
#### Inherited from
@@ -40,13 +40,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
@@ -54,13 +54,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
@@ -68,23 +68,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\_**: `IEventBusService`
`Protected` `Readonly` **eventBusService\_**: `IEventBusService`
#### Defined in
[medusa/src/services/sales-channel-location.ts:21](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel-location.ts#L21)
[medusa/src/services/sales-channel-location.ts:21](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel-location.ts#L21)
___
### manager\_
• `Protected` **manager\_**: `EntityManager`
`Protected` **manager\_**: `EntityManager`
#### Inherited from
@@ -92,33 +92,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)
___
### salesChannelService\_
• `Protected` `Readonly` **salesChannelService\_**: [`SalesChannelService`](SalesChannelService.md)
`Protected` `Readonly` **salesChannelService\_**: [`SalesChannelService`](SalesChannelService.md)
#### Defined in
[medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel-location.ts#L20)
[medusa/src/services/sales-channel-location.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel-location.ts#L20)
___
### stockLocationService\_
• `Protected` `Readonly` **stockLocationService\_**: `IStockLocationService`
`Protected` `Readonly` **stockLocationService\_**: `IStockLocationService`
#### Defined in
[medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel-location.ts#L22)
[medusa/src/services/sales-channel-location.ts:22](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel-location.ts#L22)
___
### transactionManager\_
• `Protected` **transactionManager\_**: `undefined` \| `EntityManager`
`Protected` **transactionManager\_**: `undefined` \| `EntityManager`
#### Inherited from
@@ -126,38 +126,40 @@ 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)
## 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
### associateLocation
▸ **associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\>
**associateLocation**(`salesChannelId`, `locationId`): `Promise`<`void`\>
Associates a sales channel with a stock location.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `salesChannelId` | `string` | The ID of the sales channel. |
| `locationId` | `string` | The ID of the stock location. |
@@ -165,33 +167,31 @@ Associates a sales channel with a stock location.
`Promise`<`void`\>
A promise that resolves when the association has been created.
-`Promise`: A promise that resolves when the association has been created.
#### Defined in
[medusa/src/services/sales-channel-location.ts:72](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel-location.ts#L72)
[medusa/src/services/sales-channel-location.ts:72](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel-location.ts#L72)
___
### 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 |
@@ -200,7 +200,7 @@ transaction manager is created.
`Promise`<`TResult`\>
the result of the transactional work
-`Promise`: the result of the transactional work
#### Inherited from
@@ -208,68 +208,72 @@ 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)
___
### listLocationIds
▸ **listLocationIds**(`salesChannelId`): `Promise`<`string`[]\>
**listLocationIds**(`salesChannelId`): `Promise`<`string`[]\>
Lists the stock locations associated with a sales channel.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `salesChannelId` | `string` \| `string`[] | The ID of the sales channel. |
#### Returns
`Promise`<`string`[]\>
A promise that resolves with an array of location IDs.
-`Promise`: A promise that resolves with an array of location IDs.
-`string[]`:
-`string`: (optional)
#### Defined in
[medusa/src/services/sales-channel-location.ts:103](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel-location.ts#L103)
[medusa/src/services/sales-channel-location.ts:103](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel-location.ts#L103)
___
### listSalesChannelIds
▸ **listSalesChannelIds**(`locationId`): `Promise`<`string`[]\>
**listSalesChannelIds**(`locationId`): `Promise`<`string`[]\>
Lists the sales channels associated with a stock location.
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `locationId` | `string` |
#### Returns
`Promise`<`string`[]\>
A promise that resolves with an array of sales channel IDs.
-`Promise`: A promise that resolves with an array of sales channel IDs.
-`string[]`:
-`string`: (optional)
#### Defined in
[medusa/src/services/sales-channel-location.ts:132](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel-location.ts#L132)
[medusa/src/services/sales-channel-location.ts:132](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel-location.ts#L132)
___
### removeLocation
▸ **removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\>
**removeLocation**(`locationId`, `salesChannelId?`): `Promise`<`void`\>
Removes an association between a sales channel and a stock location.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| Name | Description |
| :------ | :------ |
| `locationId` | `string` | The ID of the stock location. |
| `salesChannelId?` | `string` | The ID of the sales channel or undefined if all the sales channel will be affected. |
@@ -277,56 +281,60 @@ Removes an association between a sales channel and a stock location.
`Promise`<`void`\>
A promise that resolves when the association has been removed.
-`Promise`: A promise that resolves when the association has been removed.
#### Defined in
[medusa/src/services/sales-channel-location.ts:43](https://github.com/medusajs/medusa/blob/b38f73726/packages/medusa/src/services/sales-channel-location.ts#L43)
[medusa/src/services/sales-channel-location.ts:43](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/sales-channel-location.ts#L43)
___
### 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)
___
### withTransaction
▸ **withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](SalesChannelLocationService.md)
**withTransaction**(`transactionManager?`): [`SalesChannelLocationService`](SalesChannelLocationService.md)
#### Parameters
| Name | Type |
| :------ | :------ |
| Name |
| :------ |
| `transactionManager?` | `EntityManager` |
#### Returns
[`SalesChannelLocationService`](SalesChannelLocationService.md)
-`SalesChannelLocationService`:
#### 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)