chore(docs): Generated References (#5743)

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>
2023-11-27 18:58:52 +00:00
parent dc6b815b12
commit cdd42dbdcd
1383 changed files with 18978 additions and 20154 deletions
--- a/www/apps/docs/content/references/services/classes/OrderService.mdx
+++ b/www/apps/docs/content/references/services/classes/OrderService.mdx
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"

 ## Constructors

-### constructor
+#### constructor

 `**new OrderService**(«destructured»)`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -420,33 +420,17 @@ 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

-### addShippingMethod
+#### addShippingMethod

 `**addShippingMethod**(orderId, optionId, data?, config?): Promise&#60;[Order](Order.mdx)&#62;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -487,7 +471,7 @@ EntityManager
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -505,14 +489,14 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### archive
+#### archive

 `**archive**(orderId): Promise&#60;[Order](Order.mdx)&#62;`

 Archives an order. It only alloved, if the order has been fulfilled
 and payment has been captured.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -526,7 +510,7 @@ and payment has been captured.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -544,7 +528,7 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### atomicPhase\_
+#### atomicPhase\_

 `Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;`

@@ -552,6 +536,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",
@@ -573,7 +559,7 @@ transaction manager is created.
  }
 ]} />

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -605,7 +591,7 @@ transaction manager is created.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;TResult&#62;

@@ -623,7 +609,7 @@ Promise&#60;TResult&#62;

 ___

-### cancel
+#### cancel

 `**cancel**(orderId): Promise&#60;[Order](Order.mdx)&#62;`

@@ -631,7 +617,7 @@ Cancels an order.
 Throws if fulfillment process has been initiated.
 Throws if payment process has been initiated.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -645,7 +631,7 @@ Throws if payment process has been initiated.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -663,13 +649,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### cancelFulfillment
+#### cancelFulfillment

 `**cancelFulfillment**(fulfillmentId): Promise&#60;[Order](Order.mdx)&#62;`

 Cancels a fulfillment (if related to an order)

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -683,7 +669,7 @@ Cancels a fulfillment (if related to an order)
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -701,13 +687,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### capturePayment
+#### capturePayment

 `**capturePayment**(orderId): Promise&#60;[Order](Order.mdx)&#62;`

 Captures payment for an order.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -721,7 +707,7 @@ Captures payment for an order.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -739,11 +725,11 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### completeOrder
+#### completeOrder

 `**completeOrder**(orderId): Promise&#60;[Order](Order.mdx)&#62;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -757,7 +743,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -775,13 +761,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### createFromCart
+#### createFromCart

 `**createFromCart**(cartOrId): Promise&#60;[Order](Order.mdx)&#62;`

 Creates an order from a cart

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -795,7 +781,7 @@ Creates an order from a cart
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -813,7 +799,7 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### createFulfillment
+#### createFulfillment

 `**createFulfillment**(orderId, itemsToFulfill, config?): Promise&#60;[Order](Order.mdx)&#62;`

@@ -822,7 +808,7 @@ In a situation where the order has more than one shipping method,
 we need to partition the order items, such that they can be sent
 to their respective fulfillment provider.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -881,7 +867,7 @@ to their respective fulfillment provider.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -899,11 +885,11 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### createGiftCardsFromLineItem\_
+#### createGiftCardsFromLineItem\_

 `Protected **createGiftCardsFromLineItem_**(order, lineItem, manager): Promise&#60;[GiftCard](GiftCard.mdx)&#62;[]`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -935,7 +921,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[GiftCard](GiftCard.mdx)&#62;[]

@@ -953,13 +939,13 @@ Promise&#60;[GiftCard](GiftCard.mdx)&#62;[]

 ___

-### createRefund
+#### createRefund

 `**createRefund**(orderId, refundAmount, reason, note?, config?): Promise&#60;[Order](Order.mdx)&#62;`

 Refunds a given amount back to the customer.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1018,7 +1004,7 @@ Refunds a given amount back to the customer.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1036,7 +1022,7 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### createShipment
+#### createShipment

 `**createShipment**(orderId, fulfillmentId, trackingLinks?, config?): Promise&#60;[Order](Order.mdx)&#62;`

@@ -1044,7 +1030,7 @@ Adds a shipment to the order to indicate that an order has left the
 warehouse. Will ask the fulfillment provider for any documents that may
 have been created in regards to the shipment.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1103,7 +1089,7 @@ have been created in regards to the shipment.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1121,13 +1107,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### decorateTotals
+#### decorateTotals

 `**decorateTotals**(order, totalsFields?): Promise&#60;[Order](Order.mdx)&#62;`

 Calculate and attach the different total fields on the object

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1150,7 +1136,7 @@ Calculate and attach the different total fields on the object
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1170,7 +1156,7 @@ Promise&#60;[Order](Order.mdx)&#62;

 Calculate and attach the different total fields on the object

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1193,7 +1179,7 @@ Calculate and attach the different total fields on the object
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1211,11 +1197,11 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### decorateTotalsLegacy
+#### decorateTotalsLegacy

 `Protected **decorateTotalsLegacy**(order, totalsFields?): Promise&#60;[Order](Order.mdx)&#62;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1238,7 +1224,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1256,13 +1242,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### getFulfillmentItems
+#### getFulfillmentItems

 `Protected **getFulfillmentItems**(order, items, transformer): Promise&#60;[LineItem](LineItem.mdx)[]&#62;`

 Retrieves the order line items, given an array of items.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1294,7 +1280,7 @@ Retrieves the order line items, given an array of items.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[LineItem](LineItem.mdx)[]&#62;

@@ -1312,11 +1298,11 @@ Promise&#60;[LineItem](LineItem.mdx)[]&#62;

 ___

-### getTotalsRelations
+#### getTotalsRelations

 `Private **getTotalsRelations**(config): string[]`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1330,7 +1316,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 `string`[]

@@ -1348,11 +1334,11 @@ ___

 ___

-### list
+#### list

 `**list**(selector, config?): Promise&#60;[Order](Order.mdx)[]&#62;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1375,7 +1361,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)[]&#62;

@@ -1393,11 +1379,11 @@ Promise&#60;[Order](Order.mdx)[]&#62;

 ___

-### listAndCount
+#### listAndCount

 `**listAndCount**(selector, config?): Promise&#60;[[Order](Order.mdx)[], number]&#62;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1420,7 +1406,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[[Order](Order.mdx)[], number]&#62;

@@ -1438,7 +1424,7 @@ Promise&#60;[[Order](Order.mdx)[], number]&#62;

 ___

-### registerReturnReceived
+#### registerReturnReceived

 `**registerReturnReceived**(orderId, receivedReturn, customRefundAmount?): Promise&#60;[Order](Order.mdx)&#62;`

@@ -1450,7 +1436,7 @@ returned items are not matching the requested items. Setting the
 allowMismatch argument to true, will process the return, ignoring any
 mismatches.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1482,7 +1468,7 @@ mismatches.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1500,13 +1486,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### retrieve
+#### retrieve

 `**retrieve**(orderId, config?): Promise&#60;[Order](Order.mdx)&#62;`

 Gets an order by id.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1529,7 +1515,7 @@ Gets an order by id.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1547,13 +1533,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### retrieveByCartId
+#### retrieveByCartId

 `**retrieveByCartId**(cartId, config?): Promise&#60;[Order](Order.mdx)&#62;`

 Gets an order by cart id.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1576,7 +1562,7 @@ Gets an order by cart id.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1594,11 +1580,11 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### retrieveByCartIdWithTotals
+#### retrieveByCartIdWithTotals

 `**retrieveByCartIdWithTotals**(cartId, options?): Promise&#60;[Order](Order.mdx)&#62;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1621,7 +1607,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1639,13 +1625,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### retrieveByExternalId
+#### retrieveByExternalId

 `**retrieveByExternalId**(externalId, config?): Promise&#60;[Order](Order.mdx)&#62;`

 Gets an order by id.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1668,7 +1654,7 @@ Gets an order by id.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1686,11 +1672,11 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### retrieveLegacy
+#### retrieveLegacy

 `Protected **retrieveLegacy**(orderIdOrSelector, config?): Promise&#60;[Order](Order.mdx)&#62;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1713,7 +1699,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1731,11 +1717,11 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### retrieveWithTotals
+#### retrieveWithTotals

 `**retrieveWithTotals**(orderId, options?, context?): Promise&#60;[Order](Order.mdx)&#62;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1767,7 +1753,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1785,11 +1771,11 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### shouldRetryTransaction\_
+#### shouldRetryTransaction\_

 `Protected **shouldRetryTransaction_**(err): boolean`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1803,7 +1789,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 `boolean`

@@ -1821,11 +1807,11 @@ ___

 ___

-### transformQueryForTotals
+#### transformQueryForTotals

 `Protected **transformQueryForTotals**(config): &#123; relations: undefined \| string[] ; select: undefined \| keyof [Order](Order.mdx)[] ; totalsToSelect: undefined \| keyof [Order](Order.mdx)[]  &#125;`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1839,7 +1825,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 `object`

@@ -1887,7 +1873,7 @@ ___

 ___

-### update
+#### update

 `**update**(orderId, update): Promise&#60;[Order](Order.mdx)&#62;`

@@ -1895,7 +1881,7 @@ Updates an order. Metadata updates should
 use dedicated method, e.g. `setMetadata` etc. The function
 will throw errors if metadata updates are attempted.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1918,7 +1904,7 @@ will throw errors if metadata updates are attempted.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;[Order](Order.mdx)&#62;

@@ -1936,13 +1922,13 @@ Promise&#60;[Order](Order.mdx)&#62;

 ___

-### updateBillingAddress
+#### updateBillingAddress

 `Protected **updateBillingAddress**(order, address): Promise&#60;void&#62;`

 Updates the order's billing address.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -1965,7 +1951,7 @@ Updates the order's billing address.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;void&#62;

@@ -1983,13 +1969,13 @@ Promise&#60;void&#62;

 ___

-### updateShippingAddress
+#### updateShippingAddress

 `Protected **updateShippingAddress**(order, address): Promise&#60;void&#62;`

 Updates the order's shipping address.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -2012,7 +1998,7 @@ Updates the order's shipping address.
  }
 ]} />

-#### Returns
+##### Returns

 Promise&#60;void&#62;

@@ -2030,7 +2016,7 @@ Promise&#60;void&#62;

 ___

-### validateFulfillmentLineItem
+#### validateFulfillmentLineItem

 `Protected **validateFulfillmentLineItem**(item, quantity): null \| [LineItem](LineItem.mdx)`

@@ -2039,7 +2025,7 @@ fulfillable quantity is lower than the requested fulfillment quantity.
 Fulfillable quantity is calculated by subtracting the already fulfilled
 quantity from the quantity that was originally purchased.

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -2062,7 +2048,7 @@ quantity from the quantity that was originally purchased.
  }
 ]} />

-#### Returns
+##### Returns

 `null` \| [LineItem](LineItem.mdx)

@@ -2080,11 +2066,11 @@ quantity from the quantity that was originally purchased.

 ___

-### withTransaction
+#### withTransaction

 `**withTransaction**(transactionManager?): [OrderService](OrderService.mdx)`

-#### Parameters
+##### Parameters

 <ParameterTypes parameters={[
  {
@@ -2098,7 +2084,7 @@ ___
  }
 ]} />

-#### Returns
+##### Returns

 [OrderService](OrderService.mdx)