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>
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
@@ -332,7 +332,7 @@ A Money Amount represent a price amount, for example, a product variant's price
},
{
"name": "region_id",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The region's ID",
"optional": false,
"defaultValue": "",
@@ -266,7 +266,7 @@ A Price List represents a set of prices that override the default price for one
},
{
"name": "region_id",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The region's ID",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ A Product Variant represents a Product with a specific set of Product Option con
},
{
"name": "region_id",
"type": "`string`",
"type": "`null` \\| `string`",
"description": "The region's ID",
"optional": false,
"defaultValue": "",
@@ -10,7 +10,7 @@ The scope that the discount should apply to.
## Enumeration Members
### ITEM
#### ITEM
**ITEM** = `"item"`
@@ -18,7 +18,7 @@ The discount should be applied to applicable items in the cart.
___
### TOTAL
#### TOTAL
**TOTAL** = `"total"`
@@ -8,42 +8,42 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
___
### COMPLETED
#### COMPLETED
**COMPLETED** = `"completed"`
___
### CONFIRMED
#### CONFIRMED
**CONFIRMED** = `"confirmed"`
___
### CREATED
#### CREATED
**CREATED** = `"created"`
___
### FAILED
#### FAILED
**FAILED** = `"failed"`
___
### PRE\_PROCESSED
#### PRE\_PROCESSED
**PRE\_PROCESSED** = `"pre_processed"`
___
### PROCESSING
#### PROCESSING
**PROCESSING** = `"processing"`
@@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### CLAIM
#### CLAIM
**CLAIM** = `"claim"`
___
### DEFAULT
#### DEFAULT
**DEFAULT** = `"default"`
___
### DRAFT\_ORDER
#### DRAFT\_ORDER
**DRAFT\_ORDER** = `"draft_order"`
___
### PAYMENT\_LINK
#### PAYMENT\_LINK
**PAYMENT\_LINK** = `"payment_link"`
___
### SWAP
#### SWAP
**SWAP** = `"swap"`
@@ -10,7 +10,7 @@ The claim's fulfillment status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The claim's fulfillments are canceled.
___
### FULFILLED
#### FULFILLED
**FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The claim's replacement items are fulfilled.
___
### NOT\_FULFILLED
#### NOT\_FULFILLED
**NOT\_FULFILLED** = `"not_fulfilled"`
@@ -34,7 +34,7 @@ The claim's replacement items are not fulfilled.
___
### PARTIALLY\_FULFILLED
#### PARTIALLY\_FULFILLED
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
@@ -42,7 +42,7 @@ Some of the claim's replacement items, but not all, are fulfilled.
___
### PARTIALLY\_RETURNED
#### PARTIALLY\_RETURNED
**PARTIALLY\_RETURNED** = `"partially_returned"`
@@ -50,7 +50,7 @@ Some of the claim's items, but not all, are returned.
___
### PARTIALLY\_SHIPPED
#### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
@@ -58,7 +58,7 @@ Some of the claim's replacement items, but not all, are shipped.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -66,7 +66,7 @@ The claim's fulfillment requires action.
___
### RETURNED
#### RETURNED
**RETURNED** = `"returned"`
@@ -74,7 +74,7 @@ The claim's items are returned.
___
### SHIPPED
#### SHIPPED
**SHIPPED** = `"shipped"`
@@ -10,7 +10,7 @@ The claim's payment status
## Enumeration Members
### NA
#### NA
**NA** = `"na"`
@@ -18,7 +18,7 @@ The payment status isn't set, which is typically used when the claim's type is `
___
### NOT\_REFUNDED
#### NOT\_REFUNDED
**NOT\_REFUNDED** = `"not_refunded"`
@@ -26,7 +26,7 @@ The payment isn't refunded.
___
### REFUNDED
#### REFUNDED
**REFUNDED** = `"refunded"`
@@ -8,24 +8,24 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### MISSING\_ITEM
#### MISSING\_ITEM
**MISSING\_ITEM** = `"missing_item"`
___
### OTHER
#### OTHER
**OTHER** = `"other"`
___
### PRODUCTION\_FAILURE
#### PRODUCTION\_FAILURE
**PRODUCTION\_FAILURE** = `"production_failure"`
___
### WRONG\_ITEM
#### WRONG\_ITEM
**WRONG\_ITEM** = `"wrong_item"`
@@ -10,7 +10,7 @@ The claim's type.
## Enumeration Members
### REFUND
#### REFUND
**REFUND** = `"refund"`
@@ -18,7 +18,7 @@ The claim refunds an amount to the customer.
___
### REPLACE
#### REPLACE
**REPLACE** = `"replace"`
@@ -10,7 +10,7 @@ The possible operators used for a discount condition.
## Enumeration Members
### IN
#### IN
**IN** = `"in"`
@@ -18,7 +18,7 @@ The discountable resources are within the specified resources.
___
### NOT\_IN
#### NOT\_IN
**NOT\_IN** = `"not_in"`
@@ -10,7 +10,7 @@ The discount condition's type.
## Enumeration Members
### CUSTOMER\_GROUPS
#### CUSTOMER\_GROUPS
**CUSTOMER\_GROUPS** = `"customer_groups"`
@@ -18,7 +18,7 @@ The discount condition is used for customer groups.
___
### PRODUCTS
#### PRODUCTS
**PRODUCTS** = `"products"`
@@ -26,7 +26,7 @@ The discount condition is used for products.
___
### PRODUCT\_COLLECTIONS
#### PRODUCT\_COLLECTIONS
**PRODUCT\_COLLECTIONS** = `"product_collections"`
@@ -34,7 +34,7 @@ The discount condition is used for product collections.
___
### PRODUCT\_TAGS
#### PRODUCT\_TAGS
**PRODUCT\_TAGS** = `"product_tags"`
@@ -42,7 +42,7 @@ The discount condition is used for product tags.
___
### PRODUCT\_TYPES
#### PRODUCT\_TYPES
**PRODUCT\_TYPES** = `"product_types"`
@@ -10,7 +10,7 @@ The possible types of discount rules.
## Enumeration Members
### FIXED
#### FIXED
**FIXED** = `"fixed"`
@@ -18,7 +18,7 @@ Discounts that reduce the price by a fixed amount.
___
### FREE\_SHIPPING
#### FREE\_SHIPPING
**FREE\_SHIPPING** = `"free_shipping"`
@@ -26,7 +26,7 @@ Discounts that sets the shipping price to `0`.
___
### PERCENTAGE
#### PERCENTAGE
**PERCENTAGE** = `"percentage"`
@@ -10,7 +10,7 @@ The draft order's status.
## Enumeration Members
### COMPLETED
#### COMPLETED
**COMPLETED** = `"completed"`
@@ -18,7 +18,7 @@ The draft order is completed, and an order has been created from it.
___
### OPEN
#### OPEN
**OPEN** = `"open"`
@@ -10,7 +10,7 @@ The order's fulfillment status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The order's fulfillments are canceled.
___
### FULFILLED
#### FULFILLED
**FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The order's items are fulfilled.
___
### NOT\_FULFILLED
#### NOT\_FULFILLED
**NOT\_FULFILLED** = `"not_fulfilled"`
@@ -34,7 +34,7 @@ The order's items are not fulfilled.
___
### PARTIALLY\_FULFILLED
#### PARTIALLY\_FULFILLED
**PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
@@ -42,7 +42,7 @@ Some of the order's items, but not all, are fulfilled.
___
### PARTIALLY\_RETURNED
#### PARTIALLY\_RETURNED
**PARTIALLY\_RETURNED** = `"partially_returned"`
@@ -50,7 +50,7 @@ Some of the order's items, but not all, are returned.
___
### PARTIALLY\_SHIPPED
#### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
@@ -58,7 +58,7 @@ Some of the order's items, but not all, are shipped.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -66,7 +66,7 @@ The order's fulfillment requires action.
___
### RETURNED
#### RETURNED
**RETURNED** = `"returned"`
@@ -74,7 +74,7 @@ The order's items are returned.
___
### SHIPPED
#### SHIPPED
**SHIPPED** = `"shipped"`
@@ -10,7 +10,7 @@ The type of the order edit item change.
## Enumeration Members
### ITEM\_ADD
#### ITEM\_ADD
**ITEM\_ADD** = `"item_add"`
@@ -18,7 +18,7 @@ A new item to be added to the original order.
___
### ITEM\_REMOVE
#### ITEM\_REMOVE
**ITEM\_REMOVE** = `"item_remove"`
@@ -26,7 +26,7 @@ An existing item to be removed from the original order.
___
### ITEM\_UPDATE
#### ITEM\_UPDATE
**ITEM\_UPDATE** = `"item_update"`
@@ -10,7 +10,7 @@ The order edit's status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The order edit is canceled.
___
### CONFIRMED
#### CONFIRMED
**CONFIRMED** = `"confirmed"`
@@ -26,7 +26,7 @@ The order edit is confirmed.
___
### CREATED
#### CREATED
**CREATED** = `"created"`
@@ -34,7 +34,7 @@ The order edit is created.
___
### DECLINED
#### DECLINED
**DECLINED** = `"declined"`
@@ -42,7 +42,7 @@ The order edit is declined.
___
### REQUESTED
#### REQUESTED
**REQUESTED** = `"requested"`
@@ -10,7 +10,7 @@ The order's status.
## Enumeration Members
### ARCHIVED
#### ARCHIVED
**ARCHIVED** = `"archived"`
@@ -18,7 +18,7 @@ The order is archived.
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The order is canceled.
___
### COMPLETED
#### COMPLETED
**COMPLETED** = `"completed"`
@@ -36,7 +36,7 @@ has been captured.
___
### PENDING
#### PENDING
**PENDING** = `"pending"`
@@ -44,7 +44,7 @@ The order is pending.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -10,7 +10,7 @@ The payment collection's status.
## Enumeration Members
### AUTHORIZED
#### AUTHORIZED
**AUTHORIZED** = `"authorized"`
@@ -18,7 +18,7 @@ The payment colleciton is authorized.
___
### AWAITING
#### AWAITING
**AWAITING** = `"awaiting"`
@@ -26,7 +26,7 @@ The payment collection is awaiting payment.
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -34,7 +34,7 @@ The payment collection is canceled.
___
### NOT\_PAID
#### NOT\_PAID
**NOT\_PAID** = `"not_paid"`
@@ -42,7 +42,7 @@ The payment collection isn't paid.
___
### PARTIALLY\_AUTHORIZED
#### PARTIALLY\_AUTHORIZED
**PARTIALLY\_AUTHORIZED** = `"partially_authorized"`
@@ -10,7 +10,7 @@ The payment collection's type.
## Enumeration Members
### ORDER\_EDIT
#### ORDER\_EDIT
**ORDER\_EDIT** = `"order_edit"`
@@ -8,30 +8,30 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### AUTHORIZED
#### AUTHORIZED
**AUTHORIZED** = `"authorized"`
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
___
### ERROR
#### ERROR
**ERROR** = `"error"`
___
### PENDING
#### PENDING
**PENDING** = `"pending"`
___
### REQUIRES\_MORE
#### REQUIRES\_MORE
**REQUIRES\_MORE** = `"requires_more"`
@@ -10,7 +10,7 @@ The order's payment status.
## Enumeration Members
### AWAITING
#### AWAITING
**AWAITING** = `"awaiting"`
@@ -18,7 +18,7 @@ The order's payment is awaiting capturing.
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The order's payment is canceled.
___
### CAPTURED
#### CAPTURED
**CAPTURED** = `"captured"`
@@ -34,7 +34,7 @@ The order's payment is captured.
___
### NOT\_PAID
#### NOT\_PAID
**NOT\_PAID** = `"not_paid"`
@@ -42,7 +42,7 @@ The order's payment is not paid.
___
### PARTIALLY\_REFUNDED
#### PARTIALLY\_REFUNDED
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
@@ -50,7 +50,7 @@ Some of the order's payment amount is refunded.
___
### REFUNDED
#### REFUNDED
**REFUNDED** = `"refunded"`
@@ -58,7 +58,7 @@ The order's payment amount is refunded.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### ACTIVE
#### ACTIVE
**ACTIVE** = `"active"`
___
### DRAFT
#### DRAFT
**DRAFT** = `"draft"`
@@ -8,12 +8,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Enumeration Members
### OVERRIDE
#### OVERRIDE
**OVERRIDE** = `"override"`
___
### SALE
#### SALE
**SALE** = `"sale"`
@@ -10,7 +10,7 @@ The status of a product.
## Enumeration Members
### DRAFT
#### DRAFT
**DRAFT** = `"draft"`
@@ -18,7 +18,7 @@ The product is a draft. It's not viewable by customers.
___
### PROPOSED
#### PROPOSED
**PROPOSED** = `"proposed"`
@@ -26,7 +26,7 @@ The product is proposed, but not yet published.
___
### PUBLISHED
#### PUBLISHED
**PUBLISHED** = `"published"`
@@ -34,7 +34,7 @@ The product is published.
___
### REJECTED
#### REJECTED
**REJECTED** = `"rejected"`
@@ -10,7 +10,7 @@ The reason of the refund.
## Enumeration Members
### CLAIM
#### CLAIM
**CLAIM** = `"claim"`
@@ -18,7 +18,7 @@ The refund is applied because of a created claim.
___
### DISCOUNT
#### DISCOUNT
**DISCOUNT** = `"discount"`
@@ -26,7 +26,7 @@ The refund is applied as a discount.
___
### OTHER
#### OTHER
**OTHER** = `"other"`
@@ -34,7 +34,7 @@ The refund is created for a custom reason.
___
### RETURN
#### RETURN
**RETURN** = `"return"`
@@ -42,7 +42,7 @@ The refund is applied because of a created return.
___
### SWAP
#### SWAP
**SWAP** = `"swap"`
@@ -10,7 +10,7 @@ The type of shipping option requirement.
## Enumeration Members
### MAX\_SUBTOTAL
#### MAX\_SUBTOTAL
**MAX\_SUBTOTAL** = `"max_subtotal"`
@@ -18,7 +18,7 @@ The shipping option can only be applied if the subtotal is less than the require
___
### MIN\_SUBTOTAL
#### MIN\_SUBTOTAL
**MIN\_SUBTOTAL** = `"min_subtotal"`
@@ -10,7 +10,7 @@ The return's status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The return is canceled.
___
### RECEIVED
#### RECEIVED
**RECEIVED** = `"received"`
@@ -26,7 +26,7 @@ The return is received.
___
### REQUESTED
#### REQUESTED
**REQUESTED** = `"requested"`
@@ -34,7 +34,7 @@ The return is requested.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -10,7 +10,7 @@ The type of the shipping option price.
## Enumeration Members
### CALCULATED
#### CALCULATED
**CALCULATED** = `"calculated"`
@@ -18,7 +18,7 @@ The shipping option's price is calculated. In this case, the `amount` field is t
___
### FLAT\_RATE
#### FLAT\_RATE
**FLAT\_RATE** = `"flat_rate"`
@@ -10,7 +10,7 @@ The shipping profile's type.
## Enumeration Members
### CUSTOM
#### CUSTOM
**CUSTOM** = `"custom"`
@@ -18,7 +18,7 @@ The profile used to ship custom items.
___
### DEFAULT
#### DEFAULT
**DEFAULT** = `"default"`
@@ -26,7 +26,7 @@ The default profile used to ship item.
___
### GIFT\_CARD
#### GIFT\_CARD
**GIFT\_CARD** = `"gift_card"`
@@ -10,7 +10,7 @@ The swap's fulfillment status.
## Enumeration Members
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -18,7 +18,7 @@ The swap's fulfillments are canceled.
___
### FULFILLED
#### FULFILLED
**FULFILLED** = `"fulfilled"`
@@ -26,7 +26,7 @@ The swap's items are fulfilled.
___
### NOT\_FULFILLED
#### NOT\_FULFILLED
**NOT\_FULFILLED** = `"not_fulfilled"`
@@ -34,7 +34,7 @@ The swap's items aren't fulfilled.
___
### PARTIALLY\_SHIPPED
#### PARTIALLY\_SHIPPED
**PARTIALLY\_SHIPPED** = `"partially_shipped"`
@@ -42,7 +42,7 @@ Some of the swap's items are shipped.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -50,7 +50,7 @@ The swap's fulfillments require an action.
___
### SHIPPED
#### SHIPPED
**SHIPPED** = `"shipped"`
@@ -10,7 +10,7 @@ The swap's payment status.
## Enumeration Members
### AWAITING
#### AWAITING
**AWAITING** = `"awaiting"`
@@ -18,7 +18,7 @@ The swap is additional awaiting payment.
___
### CANCELED
#### CANCELED
**CANCELED** = `"canceled"`
@@ -26,7 +26,7 @@ The swap's additional payment is canceled.
___
### CAPTURED
#### CAPTURED
**CAPTURED** = `"captured"`
@@ -34,7 +34,7 @@ The swap's additional payment is captured.
___
### CONFIRMED
#### CONFIRMED
**CONFIRMED** = `"confirmed"`
@@ -42,7 +42,7 @@ The swap's additional payment is confirmed.
___
### DIFFERENCE\_REFUNDED
#### DIFFERENCE\_REFUNDED
**DIFFERENCE\_REFUNDED** = `"difference_refunded"`
@@ -50,7 +50,7 @@ The negative difference amount between the returned item(s) and the new one(s) h
___
### NOT\_PAID
#### NOT\_PAID
**NOT\_PAID** = `"not_paid"`
@@ -58,7 +58,7 @@ The swap's additional payment isn't paid.
___
### PARTIALLY\_REFUNDED
#### PARTIALLY\_REFUNDED
**PARTIALLY\_REFUNDED** = `"partially_refunded"`
@@ -66,7 +66,7 @@ Some of the negative difference amount between the returned item(s) and the new
___
### REFUNDED
#### REFUNDED
**REFUNDED** = `"refunded"`
@@ -74,7 +74,7 @@ The amount in the associated order has been refunded.
___
### REQUIRES\_ACTION
#### REQUIRES\_ACTION
**REQUIRES\_ACTION** = `"requires_action"`
@@ -10,7 +10,7 @@ The user's role. These roles don't change the user's capabilities or provide acc
## Enumeration Members
### ADMIN
#### ADMIN
**ADMIN** = `"admin"`
@@ -18,7 +18,7 @@ The user is an admin.
___
### DEVELOPER
#### DEVELOPER
**DEVELOPER** = `"developer"`
@@ -26,7 +26,7 @@ The user is a developer.
___
### MEMBER
#### MEMBER
**MEMBER** = `"member"`
@@ -137,10 +137,12 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Functions
### Boolean
#### Boolean
`**Boolean**<TypeParameter T>(value?): boolean`
##### Type Parameters
<ParameterTypes parameters={[
{
"name": "T",
@@ -153,7 +155,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Parameters
##### Parameters
<ParameterTypes parameters={[
{
@@ -167,7 +169,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
##### Returns
`boolean`
@@ -8,11 +8,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**BatchJobResultError**: `Object`
### Index signature
#### Index signature
▪ [key: `string`]: `unknown`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{
@@ -8,7 +8,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
**BatchJobResultStatDescriptor**: `Object`
### Type declaration
#### Type declaration
<ParameterTypes parameters={[
{
@@ -6,11 +6,11 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
# Record
**Record**`<TypeParameter K, TypeParameter T>`: &#123; [P in K]: T &#125;
**Record**: &#123; [P in K]: T &#125;
Construct a type with a set of properties K of type T
### Type parameters
#### Type Parameters
<ParameterTypes parameters={[
{