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

146
www/apps/docs/content/references/services/classes/SwapService.mdx
View File

@@ -10,11 +10,11 @@ Handles swaps
## Constructors
### constructor
#### constructor
`**new SwapService**(«destructured»)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -287,33 +287,17 @@ Handles swaps
## 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
### areReturnItemsValid
#### areReturnItemsValid
`Protected **areReturnItemsValid**(returnItems): Promise&#60;boolean&#62;`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -327,7 +311,7 @@ EntityManager
}
]} />
#### Returns
##### Returns
Promise&#60;boolean&#62;
@@ -345,7 +329,7 @@ Promise&#60;boolean&#62;
___
### atomicPhase\_
#### atomicPhase\_
`Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`
@@ -353,6 +337,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",
@@ -374,7 +360,7 @@ transaction manager is created.
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -406,7 +392,7 @@ transaction manager is created.
}
]} />
#### Returns
##### Returns
Promise&#60;TResult&#62;
@@ -424,7 +410,7 @@ Promise&#60;TResult&#62;
___
### cancel
#### cancel
`**cancel**(swapId): Promise&#60;[Swap](Swap.mdx)&#62;`
@@ -432,7 +418,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={[
{
@@ -446,7 +432,7 @@ is associated with a refund, it cannot be canceled.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -464,13 +450,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={[
{
@@ -484,7 +470,7 @@ Cancels a fulfillment (if related to a swap)
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -502,14 +488,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={[
{
@@ -613,7 +599,7 @@ and an optional return shipping method.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -631,7 +617,7 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
### createCart
#### createCart
`**createCart**(swapId, customShippingOptions?, context?): Promise&#60;[Swap](Swap.mdx)&#62;`
@@ -640,7 +626,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={[
{
@@ -681,7 +667,7 @@ swap.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -699,14 +685,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={[
{
@@ -729,7 +715,7 @@ fulfillment providers associated with the shipping methods.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -747,13 +733,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={[
{
@@ -794,7 +780,7 @@ Marks a fulfillment as shipped and attaches tracking numbers.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -812,13 +798,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={[
{
@@ -841,7 +827,7 @@ Dedicated method to delete metadata for a swap.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -859,13 +845,13 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
### list
#### list
`**list**(selector, config?): Promise&#60;[Swap](Swap.mdx)[]&#62;`
List swaps.
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -888,7 +874,7 @@ List swaps.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)[]&#62;
@@ -906,13 +892,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={[
{
@@ -935,7 +921,7 @@ List swaps.
}
]} />
#### Returns
##### Returns
Promise&#60;[[Swap](Swap.mdx)[], number]&#62;
@@ -953,13 +939,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={[
{
@@ -973,7 +959,7 @@ Process difference for the requested swap.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -991,13 +977,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={[
{
@@ -1011,7 +997,7 @@ Register a cart completion
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1029,14 +1015,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={[
{
@@ -1050,7 +1036,7 @@ as a part of other swaps/returns.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1068,13 +1054,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={[
{
@@ -1097,7 +1083,7 @@ Retrieves a swap with the given id.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1115,13 +1101,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={[
{
@@ -1144,7 +1130,7 @@ Retrieves a swap based on its associated cart id
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1162,11 +1148,11 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
### shouldRetryTransaction\_
#### shouldRetryTransaction\_
`Protected **shouldRetryTransaction_**(err): boolean`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1180,7 +1166,7 @@ ___
}
]} />
#### Returns
##### Returns
`boolean`
@@ -1198,13 +1184,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={[
{
@@ -1218,7 +1204,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)[] }``
@@ -1236,13 +1222,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={[
{
@@ -1265,7 +1251,7 @@ Update the swap record.
}
]} />
#### Returns
##### Returns
Promise&#60;[Swap](Swap.mdx)&#62;
@@ -1283,11 +1269,11 @@ Promise&#60;[Swap](Swap.mdx)&#62;
___
### withTransaction
#### withTransaction
`**withTransaction**(transactionManager?): [SwapService](SwapService.mdx)`
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -1301,7 +1287,7 @@ ___
}
]} />
#### Returns
##### Returns
[SwapService](SwapService.mdx)