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

114
www/apps/docs/content/references/services/classes/FulfillmentProviderService.mdx
View File

@@ -10,11 +10,11 @@ Helps retrieve fulfillment providers
## Constructors
### constructor
#### constructor
`**new FulfillmentProviderService**(container)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -98,29 +98,13 @@ Helps retrieve fulfillment providers
## 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
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -128,6 +112,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",
@@ -149,7 +135,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -181,7 +167,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -199,11 +185,11 @@ Promise&#60;TResult&#62;
___
### calculatePrice
#### calculatePrice
`**calculatePrice**(option, data, cart?): Promise&#60;number&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -235,7 +221,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;number&#62;
@@ -253,11 +239,11 @@ Promise&#60;number&#62;
___
### canCalculate
#### canCalculate
`**canCalculate**(option): Promise&#60;boolean&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -271,7 +257,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -289,11 +275,11 @@ Promise&#60;boolean&#62;
___
### cancelFulfillment
#### cancelFulfillment
`**cancelFulfillment**(fulfillment): Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -307,7 +293,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;
@@ -325,11 +311,11 @@ Promise&#60;[Fulfillment](Fulfillment.mdx)&#62;
___
### createFulfillment
#### createFulfillment
`**createFulfillment**(method, items, order, fulfillment): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -370,7 +356,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -388,11 +374,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### createReturn
#### createReturn
`**createReturn**(returnOrder): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -406,7 +392,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -424,11 +410,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### list
#### list
`**list**(): Promise&#60;[FulfillmentProvider](FulfillmentProvider.mdx)[]&#62;`
#### Returns
##### Returns
Promise&#60;[FulfillmentProvider](FulfillmentProvider.mdx)[]&#62;
@@ -446,11 +432,11 @@ Promise&#60;[FulfillmentProvider](FulfillmentProvider.mdx)[]&#62;
___
### listFulfillmentOptions
#### listFulfillmentOptions
`**listFulfillmentOptions**(providerIds): Promise&#60;[FulfillmentOptions](../types/FulfillmentOptions.mdx)[]&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -464,7 +450,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;[FulfillmentOptions](../types/FulfillmentOptions.mdx)[]&#62;
@@ -482,11 +468,11 @@ Promise&#60;[FulfillmentOptions](../types/FulfillmentOptions.mdx)[]&#62;
___
### registerInstalledProviders
#### registerInstalledProviders
`**registerInstalledProviders**(providers): Promise&#60;void&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -500,7 +486,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;void&#62;
@@ -518,13 +504,13 @@ Promise&#60;void&#62;
___
### retrieveDocuments
#### retrieveDocuments
`**retrieveDocuments**(providerId, fulfillmentData, documentType): Promise&#60;any&#62;`
Fetches documents from the fulfillment provider
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -556,7 +542,7 @@ Fetches documents from the fulfillment provider
}
]} />
#### Returns
##### Returns
Promise&#60;any&#62;
@@ -574,11 +560,11 @@ Promise&#60;any&#62;
___
### retrieveProvider
#### retrieveProvider
`**retrieveProvider**(providerId): any`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -592,7 +578,7 @@ ___
}
]} />
#### Returns
##### Returns
`any`
@@ -610,11 +596,11 @@ ___
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -628,7 +614,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -646,11 +632,11 @@ ___
___
### validateFulfillmentData
#### validateFulfillmentData
`**validateFulfillmentData**(option, data, cart): Promise&#60;Record&#60;string, unknown&#62;&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -682,7 +668,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;Record&#60;string, unknown&#62;&#62;
@@ -700,11 +686,11 @@ Promise&#60;Record&#60;string, unknown&#62;&#62;
___
### validateOption
#### validateOption
`**validateOption**(option): Promise&#60;boolean&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -718,7 +704,7 @@ ___
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -736,11 +722,11 @@ Promise&#60;boolean&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [FulfillmentProviderService](FulfillmentProviderService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -754,7 +740,7 @@ ___
}
]} />
#### Returns
##### Returns
[FulfillmentProviderService](FulfillmentProviderService.mdx)