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
www/apps/docs/content/references/services/classes/SwapService.mdx
+87 -67
View File
@@ -8,13 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Handles swaps
## Constructors
#### constructor
## constructor
`**new SwapService**(«destructured»)`
##### Parameters
### Parameters
<ParameterTypes parameters={[
{
@@ -28,6 +26,8 @@ Handles swaps
}
]} />
___
## Properties
<ParameterTypes parameters={[
@@ -285,19 +285,39 @@ Handles swaps
}
]} />
___
## 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
#### areReturnItemsValid
### areReturnItemsValid
`Protected **areReturnItemsValid**(returnItems): Promise&#60;boolean&#62;`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -311,7 +331,7 @@ Handles swaps
}
]} />
##### Returns
#### Returns
Promise&#60;boolean&#62;
@@ -329,7 +349,7 @@ Promise&#60;boolean&#62;
___
#### atomicPhase\_
### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -337,7 +357,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={[
{
@@ -360,7 +380,7 @@ transaction manager is created.
}
]} />
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -392,7 +412,7 @@ transaction manager is created.
}
]} />
##### Returns
#### Returns
Promise&#60;TResult&#62;
@@ -410,7 +430,7 @@ Promise&#60;TResult&#62;
___
#### cancel
### cancel
`**cancel**(swapId): Promise&#60;[Swap](Swap.mdx)&#62;`
@@ -418,7 +438,7 @@ Cancels a given swap if possible. A swap can only be canceled if all
related returns, fulfillments, and payments have been canceled. If a swap
is associated with a refund, it cannot be canceled.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -432,7 +452,7 @@ is associated with a refund, it cannot be canceled.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -450,13 +470,13 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### cancelFulfillment
### cancelFulfillment
`**cancelFulfillment**(fulfillmentId): Promise&#60;[Swap](Swap.mdx)&#62;`
Cancels a fulfillment (if related to a swap)
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -470,7 +490,7 @@ Cancels a fulfillment (if related to a swap)
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -488,14 +508,14 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### create
### create
`**create**(order, returnItems, additionalItems?, returnShipping?, custom?): Promise&#60;[Swap](Swap.mdx)&#62;`
Creates a swap from an order, with given return items, additional items
and an optional return shipping method.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -599,7 +619,7 @@ and an optional return shipping method.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -617,7 +637,7 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### createCart
### createCart
`**createCart**(swapId, customShippingOptions?, context?): Promise&#60;[Swap](Swap.mdx)&#62;`
@@ -626,7 +646,7 @@ for differences associated with the swap. The swap represented by the
swapId must belong to the order. Fails if there is already a cart on the
swap.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -667,7 +687,7 @@ swap.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -685,14 +705,14 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### createFulfillment
### createFulfillment
`**createFulfillment**(swapId, config?): Promise&#60;[Swap](Swap.mdx)&#62;`
Fulfills the additional items associated with the swap. Will call the
fulfillment providers associated with the shipping methods.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -715,7 +735,7 @@ fulfillment providers associated with the shipping methods.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -733,13 +753,13 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### createShipment
### createShipment
`**createShipment**(swapId, fulfillmentId, trackingLinks?, config?): Promise&#60;[Swap](Swap.mdx)&#62;`
Marks a fulfillment as shipped and attaches tracking numbers.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -780,7 +800,7 @@ Marks a fulfillment as shipped and attaches tracking numbers.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -798,13 +818,13 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### deleteMetadata
### deleteMetadata
`**deleteMetadata**(swapId, key): Promise&#60;[Swap](Swap.mdx)&#62;`
Dedicated method to delete metadata for a swap.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -827,7 +847,7 @@ Dedicated method to delete metadata for a swap.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -845,13 +865,13 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### list
### list
`**list**(selector, config?): Promise&#60;[Swap](Swap.mdx)[]&#62;`
List swaps.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -874,7 +894,7 @@ List swaps.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)[]&#62;
@@ -892,13 +912,13 @@ Promise&#60;[Swap](Swap.mdx)[]&#62;
___
#### listAndCount
### listAndCount
`**listAndCount**(selector, config?): Promise&#60;[[Swap](Swap.mdx)[], number]&#62;`
List swaps.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -921,7 +941,7 @@ List swaps.
}
]} />
##### Returns
#### Returns
Promise&#60;[[Swap](Swap.mdx)[], number]&#62;
@@ -939,13 +959,13 @@ Promise&#60;[[Swap](Swap.mdx)[], number]&#62;
___
#### processDifference
### processDifference
`**processDifference**(swapId): Promise&#60;[Swap](Swap.mdx)&#62;`
Process difference for the requested swap.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -959,7 +979,7 @@ Process difference for the requested swap.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -977,13 +997,13 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### registerCartCompletion
### registerCartCompletion
`**registerCartCompletion**(swapId): Promise&#60;[Swap](Swap.mdx)&#62;`
Register a cart completion
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -997,7 +1017,7 @@ Register a cart completion
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1015,14 +1035,14 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### registerReceived
### registerReceived
`**registerReceived**(id): Promise&#60;[Swap](Swap.mdx)&#62;`
Registers the swap return items as received so that they cannot be used
as a part of other swaps/returns.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1036,7 +1056,7 @@ as a part of other swaps/returns.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1054,13 +1074,13 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### retrieve
### retrieve
`**retrieve**(swapId, config?): Promise&#60;[Swap](Swap.mdx)&#62;`
Retrieves a swap with the given id.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1083,7 +1103,7 @@ Retrieves a swap with the given id.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1101,13 +1121,13 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### retrieveByCartId
### retrieveByCartId
`**retrieveByCartId**(cartId, relations?): Promise&#60;[Swap](Swap.mdx)&#62;`
Retrieves a swap based on its associated cart id
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1130,7 +1150,7 @@ Retrieves a swap based on its associated cart id
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1148,11 +1168,11 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### shouldRetryTransaction\_
### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1166,7 +1186,7 @@ ___
}
]} />
##### Returns
#### Returns
`boolean`
@@ -1184,13 +1204,13 @@ ___
___
#### transformQueryForCart
### transformQueryForCart
`Protected **transformQueryForCart**(config): [Omit](../types/Omit.mdx)&#60;[FindConfig](../interfaces/FindConfig.mdx)&#60;[Swap](Swap.mdx)&#62;, "select"&#62; & &#123; select?: string[] &#125; & &#123; cartRelations: undefined \| string[] ; cartSelects: undefined \| keyof [Cart](Cart.mdx)[] &#125;`
Transform find config object for retrieval.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1204,7 +1224,7 @@ Transform find config object for retrieval.
}
]} />
##### Returns
#### Returns
[Omit](../types/Omit.mdx)&#60;[FindConfig](../interfaces/FindConfig.mdx)&#60;[Swap](Swap.mdx)&#62;, "select"&#62; & ``{ select?: string[] }`` & ``{ cartRelations: undefined \| string[] ; cartSelects: undefined \| keyof [Cart](Cart.mdx)[] }``
@@ -1222,13 +1242,13 @@ Transform find config object for retrieval.
___
#### update
### update
`**update**(swapId, update): Promise&#60;[Swap](Swap.mdx)&#62;`
Update the swap record.
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1251,7 +1271,7 @@ Update the swap record.
}
]} />
##### Returns
#### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1269,11 +1289,11 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
#### withTransaction
### withTransaction
`**withTransaction**(transactionManager?): [SwapService](SwapService.mdx)`
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -1287,7 +1307,7 @@ ___
}
]} />
##### Returns
#### Returns
[SwapService](SwapService.mdx)