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

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,13 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# SalesChannelService
## Constructors
#### constructor
## constructor
`**new SalesChannelService**(«destructured»)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -26,6 +24,8 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -139,21 +139,41 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
___
## Accessors
#### activeManager\_
### activeManager\_
`Protected` **activeManager\_**: [object Object]
`Protected get**activeManager_**(): EntityManager`
#### Returns
EntityManager
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "EntityManager",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## 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={[
{
@@ -176,7 +196,7 @@ Add a batch of product to a sales channel
}
]} />
##### Returns
#### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -194,7 +214,7 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -202,7 +222,7 @@ 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
#### Type Parameters
<ParameterTypes parameters={[
{
@@ -225,7 +245,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -257,7 +277,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -275,7 +295,7 @@ Promise&#60;TResult&#62;
___
#### create
### create
`**create**(data): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
@@ -284,7 +304,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={[
{
@@ -298,7 +318,7 @@ To use this feature please enable the corresponding feature flag in your medusa
}
]} />
##### Returns
#### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -316,13 +336,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;
@@ -340,7 +360,7 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
#### delete
### delete
`**delete**(salesChannelId): Promise&#60;void&#62;`
@@ -348,7 +368,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={[
{
@@ -362,7 +382,7 @@ To use this feature please enable the corresponding feature flag in your medusa
}
]} />
##### Returns
#### Returns
Promise&#60;void&#62;
@@ -380,14 +400,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={[
{
@@ -410,7 +430,7 @@ sales channels that match the query.
}
]} />
##### Returns
#### Returns
Promise&#60;[[SalesChannel](SalesChannel.mdx)[], number]&#62;
@@ -428,13 +448,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={[
{
@@ -448,7 +468,7 @@ List all product ids that belongs to the sales channels ids
}
]} />
##### Returns
#### Returns
Promise&#60;&#123; [salesChannelId: string]: string[]; &#125;&#62;
@@ -466,13 +486,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={[
{
@@ -495,7 +515,7 @@ Remove a batch of product from a sales channel
}
]} />
##### Returns
#### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -513,13 +533,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={[
{
@@ -542,7 +562,7 @@ Retrieve a SalesChannel by id
}
]} />
##### Returns
#### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -560,13 +580,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={[
{
@@ -589,7 +609,7 @@ Find a sales channel by name.
}
]} />
##### Returns
#### Returns
Promise&#60;unknown&#62;
@@ -607,13 +627,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;
@@ -631,13 +651,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={[
{
@@ -660,7 +680,7 @@ A generic retrieve used to find a sales channel by different attributes.
}
]} />
##### Returns
#### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -678,11 +698,11 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -696,7 +716,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -714,11 +734,11 @@ ___
___
#### update
### update
`**update**(salesChannelId, data): Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -741,7 +761,7 @@ ___
}
]} />
##### Returns
#### Returns
Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
@@ -759,11 +779,11 @@ Promise&#60;[SalesChannel](SalesChannel.mdx)&#62;
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [SalesChannelService](SalesChannelService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -777,7 +797,7 @@ ___
}
]} />
##### Returns
#### Returns
[SalesChannelService](SalesChannelService.mdx)