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

chore(docs): Generated References (#5743)

Browse Source 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

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-27 18:58:52 +00:00
committed by GitHub
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
www/apps/docs/content/references/services/classes/SalesChannelService.mdx
View File

@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Constructors
### constructor
#### constructor
`**new SalesChannelService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -141,35 +141,19 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Accessors
### activeManager\_
#### activeManager\_
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
`Protected` **activeManager\_**: [object Object]
## Methods
### addProducts
#### addProducts
`**addProducts**(salesChannelId, productIds): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
Add a batch of product to a sales channel
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -192,7 +176,7 @@ Add a batch of product to a sales channel
}
]} />
#### Returns
##### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -210,7 +194,7 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -218,6 +202,8 @@ 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
<ParameterTypes parameters={[
{
"name": "TResult",
@@ -239,7 +225,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -271,7 +257,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -289,7 +275,7 @@ Promise&#60;TResult&#62;
___
### create
#### create
`**create**(data): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
@@ -298,7 +284,7 @@ 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
##### Parameters
<ParameterTypes parameters={[
{
@@ -312,7 +298,7 @@ To use this feature please enable the corresponding feature flag in your medusa
}
]} />
#### Returns
##### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -330,13 +316,13 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
### createDefault
#### createDefault
`**createDefault**(): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
Creates a default sales channel, if this does not already exist.
#### Returns
##### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -354,7 +340,7 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
### delete
#### delete
`**delete**(salesChannelId): Promise&#60;void&#62;`
@@ -362,7 +348,7 @@ 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
##### Parameters
<ParameterTypes parameters={[
{
@@ -376,7 +362,7 @@ To use this feature please enable the corresponding feature flag in your medusa
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -394,14 +380,14 @@ Promise&#60;void&#62;
___
### listAndCount
#### listAndCount
`**listAndCount**(selector, config?): Promise&#60;[[SalesChannel](SalesChannel.mdx)[], number]&#62;`
Lists sales channels based on the provided parameters and includes the count of
sales channels that match the query.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -424,7 +410,7 @@ sales channels that match the query.
}
]} />
#### Returns
##### Returns
Promise&#60;[[SalesChannel](SalesChannel.mdx)[], number]&#62;
@@ -442,13 +428,13 @@ Promise&#60;[[SalesChannel](SalesChannel.mdx)[], number]&#62;
___
### listProductIdsBySalesChannelIds
#### listProductIdsBySalesChannelIds
`**listProductIdsBySalesChannelIds**(salesChannelIds): Promise&#60;&#123; [salesChannelId: string]: string[]; &#125;&#62;`
List all product ids that belongs to the sales channels ids
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -462,7 +448,7 @@ List all product ids that belongs to the sales channels ids
}
]} />
#### Returns
##### Returns
Promise&#60;&#123; [salesChannelId: string]: string[]; &#125;&#62;
@@ -480,13 +466,13 @@ Promise&#60;&#123; [salesChannelId: string]: string[]; &#125;&#62;
___
### removeProducts
#### removeProducts
`**removeProducts**(salesChannelId, productIds): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
Remove a batch of product from a sales channel
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -509,7 +495,7 @@ Remove a batch of product from a sales channel
}
]} />
#### Returns
##### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -527,13 +513,13 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
### retrieve
#### retrieve
`**retrieve**(salesChannelId, config?): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
Retrieve a SalesChannel by id
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -556,7 +542,7 @@ Retrieve a SalesChannel by id
}
]} />
#### Returns
##### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -574,13 +560,13 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
### retrieveByName
#### retrieveByName
`**retrieveByName**(name, config?): Promise&#60;unknown&#62;`
Find a sales channel by name.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -603,7 +589,7 @@ Find a sales channel by name.
}
]} />
#### Returns
##### Returns
Promise&#60;unknown&#62;
@@ -621,13 +607,13 @@ Promise&#60;unknown&#62;
___
### retrieveDefault
#### retrieveDefault
`**retrieveDefault**(): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
Retrieves the default sales channel.
#### Returns
##### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -645,13 +631,13 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
### retrieve\_
#### retrieve\_
`Protected **retrieve_**(selector, config?): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
A generic retrieve used to find a sales channel by different attributes.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -674,7 +660,7 @@ A generic retrieve used to find a sales channel by different attributes.
}
]} />
#### Returns
##### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -692,11 +678,11 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -710,7 +696,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -728,11 +714,11 @@ ___
___
### update
#### update
`**update**(salesChannelId, data): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -755,7 +741,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -773,11 +759,11 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [SalesChannelService](SalesChannelService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -791,7 +777,7 @@ ___
}
]} />
#### Returns
##### Returns
[SalesChannelService](SalesChannelService.mdx)