docs: migrate guides to TSDoc references (#6100)

2024-01-22 18:38:35 +01:00
parent 85dad169bb
commit 4792c55226
980 changed files with 195537 additions and 160619 deletions
@@ -16,8 +16,6 @@ The scope that the discount should apply to.

 The discount should be applied to applicable items in the cart.

-___
-
 ### TOTAL

 **TOTAL** = `"total"`
@@ -12,26 +12,18 @@ import ParameterTypes from "@site/src/components/ParameterTypes"

 **CLAIM** = `"claim"`

-___
-
 ### DEFAULT

 **DEFAULT** = `"default"`

-___
-
 ### DRAFT\_ORDER

 **DRAFT\_ORDER** = `"draft_order"`

-___
-
 ### PAYMENT\_LINK

 **PAYMENT\_LINK** = `"payment_link"`

-___
-
 ### SWAP

 **SWAP** = `"swap"`
@@ -16,64 +16,48 @@ The claim's fulfillment status.

 The claim's fulfillments are canceled.

-___
-
 ### FULFILLED

 **FULFILLED** = `"fulfilled"`

 The claim's replacement items are fulfilled.

-___
-
 ### NOT\_FULFILLED

 **NOT\_FULFILLED** = `"not_fulfilled"`

 The claim's replacement items are not fulfilled.

-___
-
 ### PARTIALLY\_FULFILLED

 **PARTIALLY\_FULFILLED** = `"partially_fulfilled"`

 Some of the claim's replacement items, but not all, are fulfilled.

-___
-
 ### PARTIALLY\_RETURNED

 **PARTIALLY\_RETURNED** = `"partially_returned"`

 Some of the claim's items, but not all, are returned.

-___
-
 ### PARTIALLY\_SHIPPED

 **PARTIALLY\_SHIPPED** = `"partially_shipped"`

 Some of the claim's replacement items, but not all, are shipped.

-___
-
 ### REQUIRES\_ACTION

 **REQUIRES\_ACTION** = `"requires_action"`

 The claim's fulfillment requires action.

-___
-
 ### RETURNED

 **RETURNED** = `"returned"`

 The claim's items are returned.

-___
-
 ### SHIPPED

 **SHIPPED** = `"shipped"`
@@ -16,16 +16,12 @@ The claim's payment status

 The payment status isn't set, which is typically used when the claim's type is `replace`.

-___
-
 ### NOT\_REFUNDED

 **NOT\_REFUNDED** = `"not_refunded"`

 The payment isn't refunded.

-___
-
 ### REFUNDED

 **REFUNDED** = `"refunded"`
@@ -12,20 +12,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes"

 **MISSING\_ITEM** = `"missing_item"`

-___
-
 ### OTHER

 **OTHER** = `"other"`

-___
-
 ### PRODUCTION\_FAILURE

 **PRODUCTION\_FAILURE** = `"production_failure"`

-___
-
 ### WRONG\_ITEM

 **WRONG\_ITEM** = `"wrong_item"`
@@ -16,8 +16,6 @@ The claim's type.

 The claim refunds an amount to the customer.

-___
-
 ### REPLACE

 **REPLACE** = `"replace"`
@@ -16,8 +16,6 @@ The possible operators used for a discount condition.

 The discountable resources are within the specified resources.

-___
-
 ### NOT\_IN

 **NOT\_IN** = `"not_in"`
@@ -16,32 +16,24 @@ The discount condition's type.

 The discount condition is used for customer groups.

-___
-
 ### PRODUCTS

 **PRODUCTS** = `"products"`

 The discount condition is used for products.

-___
-
 ### PRODUCT\_COLLECTIONS

 **PRODUCT\_COLLECTIONS** = `"product_collections"`

 The discount condition is used for product collections.

-___
-
 ### PRODUCT\_TAGS

 **PRODUCT\_TAGS** = `"product_tags"`

 The discount condition is used for product tags.

-___
-
 ### PRODUCT\_TYPES

 **PRODUCT\_TYPES** = `"product_types"`
@@ -16,16 +16,12 @@ The possible types of discount rules.

 Discounts that reduce the price by a fixed amount.

-___
-
 ### FREE\_SHIPPING

 **FREE\_SHIPPING** = `"free_shipping"`

 Discounts that sets the shipping price to `0`.

-___
-
 ### PERCENTAGE

 **PERCENTAGE** = `"percentage"`
@@ -16,8 +16,6 @@ The draft order's status.

 The draft order is completed, and an order has been created from it.

-___
-
 ### OPEN

 **OPEN** = `"open"`
@@ -16,64 +16,48 @@ The order's fulfillment status.

 The order's fulfillments are canceled.

-___
-
 ### FULFILLED

 **FULFILLED** = `"fulfilled"`

 The order's items are fulfilled.

-___
-
 ### NOT\_FULFILLED

 **NOT\_FULFILLED** = `"not_fulfilled"`

 The order's items are not fulfilled.

-___
-
 ### PARTIALLY\_FULFILLED

 **PARTIALLY\_FULFILLED** = `"partially_fulfilled"`

 Some of the order's items, but not all, are fulfilled.

-___
-
 ### PARTIALLY\_RETURNED

 **PARTIALLY\_RETURNED** = `"partially_returned"`

 Some of the order's items, but not all, are returned.

-___
-
 ### PARTIALLY\_SHIPPED

 **PARTIALLY\_SHIPPED** = `"partially_shipped"`

 Some of the order's items, but not all, are shipped.

-___
-
 ### REQUIRES\_ACTION

 **REQUIRES\_ACTION** = `"requires_action"`

 The order's fulfillment requires action.

-___
-
 ### RETURNED

 **RETURNED** = `"returned"`

 The order's items are returned.

-___
-
 ### SHIPPED

 **SHIPPED** = `"shipped"`
@@ -16,16 +16,12 @@ The type of the order edit item change.

 A new item to be added to the original order.

-___
-
 ### ITEM\_REMOVE

 **ITEM\_REMOVE** = `"item_remove"`

 An existing item to be removed from the original order.

-___
-
 ### ITEM\_UPDATE

 **ITEM\_UPDATE** = `"item_update"`
@@ -16,32 +16,24 @@ The order edit's status.

 The order edit is canceled.

-___
-
 ### CONFIRMED

 **CONFIRMED** = `"confirmed"`

 The order edit is confirmed.

-___
-
 ### CREATED

 **CREATED** = `"created"`

 The order edit is created.

-___
-
 ### DECLINED

 **DECLINED** = `"declined"`

 The order edit is declined.

-___
-
 ### REQUESTED

 **REQUESTED** = `"requested"`
@@ -16,16 +16,12 @@ The order's status.

 The order is archived.

-___
-
 ### CANCELED

 **CANCELED** = `"canceled"`

 The order is canceled.

-___
-
 ### COMPLETED

 **COMPLETED** = `"completed"`
@@ -34,16 +30,12 @@ The order is completed, meaning that
 the items have been fulfilled and the payment
 has been captured.

-___
-
 ### PENDING

 **PENDING** = `"pending"`

 The order is pending.

-___
-
 ### REQUIRES\_ACTION

 **REQUIRES\_ACTION** = `"requires_action"`
@@ -16,32 +16,24 @@ The payment collection's status.

 The payment colleciton is authorized.

-___
-
 ### AWAITING

 **AWAITING** = `"awaiting"`

 The payment collection is awaiting payment.

-___
-
 ### CANCELED

 **CANCELED** = `"canceled"`

 The payment collection is canceled.

-___
-
 ### NOT\_PAID

 **NOT\_PAID** = `"not_paid"`

 The payment collection isn't paid.

-___
-
 ### PARTIALLY\_AUTHORIZED

 **PARTIALLY\_AUTHORIZED** = `"partially_authorized"`
@@ -16,32 +16,24 @@ The status of a payment session.

 The payment is authorized.

-___
-
 ### CANCELED

 **CANCELED** = `"canceled"`

 The payment is canceled.

-___
-
 ### ERROR

 **ERROR** = `"error"`

 An error occurred while processing the payment.

-___
-
 ### PENDING

 **PENDING** = `"pending"`

 The payment is pending.

-___
-
 ### REQUIRES\_MORE

 **REQUIRES\_MORE** = `"requires_more"`
@@ -16,48 +16,36 @@ The order's payment status.

 The order's payment is awaiting capturing.

-___
-
 ### CANCELED

 **CANCELED** = `"canceled"`

 The order's payment is canceled.

-___
-
 ### CAPTURED

 **CAPTURED** = `"captured"`

 The order's payment is captured.

-___
-
 ### NOT\_PAID

 **NOT\_PAID** = `"not_paid"`

 The order's payment is not paid.

-___
-
 ### PARTIALLY\_REFUNDED

 **PARTIALLY\_REFUNDED** = `"partially_refunded"`

 Some of the order's payment amount is refunded.

-___
-
 ### REFUNDED

 **REFUNDED** = `"refunded"`

 The order's payment amount is refunded.

-___
-
 ### REQUIRES\_ACTION

 **REQUIRES\_ACTION** = `"requires_action"`
@@ -16,24 +16,18 @@ The status of a product.

 The product is a draft. It's not viewable by customers.

-___
-
 ### PROPOSED

 **PROPOSED** = `"proposed"`

 The product is proposed, but not yet published.

-___
-
 ### PUBLISHED

 **PUBLISHED** = `"published"`

 The product is published.

-___
-
 ### REJECTED

 **REJECTED** = `"rejected"`
@@ -16,32 +16,24 @@ The reason of the refund.

 The refund is applied because of a created claim.

-___
-
 ### DISCOUNT

 **DISCOUNT** = `"discount"`

 The refund is applied as a discount.

-___
-
 ### OTHER

 **OTHER** = `"other"`

 The refund is created for a custom reason.

-___
-
 ### RETURN

 **RETURN** = `"return"`

 The refund is applied because of a created return.

-___
-
 ### SWAP

 **SWAP** = `"swap"`
@@ -16,8 +16,6 @@ The type of shipping option requirement.

 The shipping option can only be applied if the subtotal is less than the requirement's amont.

-___
-
 ### MIN\_SUBTOTAL

 **MIN\_SUBTOTAL** = `"min_subtotal"`
@@ -16,24 +16,18 @@ The return's status.

 The return is canceled.

-___
-
 ### RECEIVED

 **RECEIVED** = `"received"`

 The return is received.

-___
-
 ### REQUESTED

 **REQUESTED** = `"requested"`

 The return is requested.

-___
-
 ### REQUIRES\_ACTION

 **REQUIRES\_ACTION** = `"requires_action"`
@@ -16,8 +16,6 @@ The type of the shipping option price.

 The shipping option's price is calculated. In this case, the `amount` field is typically `null`.

-___
-
 ### FLAT\_RATE

 **FLAT\_RATE** = `"flat_rate"`
@@ -16,16 +16,12 @@ The shipping profile's type.

 The profile used to ship custom items.

-___
-
 ### DEFAULT

 **DEFAULT** = `"default"`

 The default profile used to ship item.

-___
-
 ### GIFT\_CARD

 **GIFT\_CARD** = `"gift_card"`
@@ -16,40 +16,30 @@ The swap's fulfillment status.

 The swap's fulfillments are canceled.

-___
-
 ### FULFILLED

 **FULFILLED** = `"fulfilled"`

 The swap's items are fulfilled.

-___
-
 ### NOT\_FULFILLED

 **NOT\_FULFILLED** = `"not_fulfilled"`

 The swap's items aren't fulfilled.

-___
-
 ### PARTIALLY\_SHIPPED

 **PARTIALLY\_SHIPPED** = `"partially_shipped"`

 Some of the swap's items are shipped.

-___
-
 ### REQUIRES\_ACTION

 **REQUIRES\_ACTION** = `"requires_action"`

 The swap's fulfillments require an action.

-___
-
 ### SHIPPED

 **SHIPPED** = `"shipped"`
@@ -16,64 +16,48 @@ The swap's payment status.

 The swap is additional awaiting payment.

-___
-
 ### CANCELED

 **CANCELED** = `"canceled"`

 The swap's additional payment is canceled.

-___
-
 ### CAPTURED

 **CAPTURED** = `"captured"`

 The swap's additional payment is captured.

-___
-
 ### CONFIRMED

 **CONFIRMED** = `"confirmed"`

 The swap's additional payment is confirmed.

-___
-
 ### DIFFERENCE\_REFUNDED

 **DIFFERENCE\_REFUNDED** = `"difference_refunded"`

 The negative difference amount between the returned item(s) and the new one(s) has been refuneded.

-___
-
 ### NOT\_PAID

 **NOT\_PAID** = `"not_paid"`

 The swap's additional payment isn't paid.

-___
-
 ### PARTIALLY\_REFUNDED

 **PARTIALLY\_REFUNDED** = `"partially_refunded"`

 Some of the negative difference amount between the returned item(s) and the new one(s) has been refuneded.

-___
-
 ### REFUNDED

 **REFUNDED** = `"refunded"`

 The amount in the associated order has been refunded.

-___
-
 ### REQUIRES\_ACTION

 **REQUIRES\_ACTION** = `"requires_action"`
@@ -16,16 +16,12 @@ The user's role. These roles don't change the user's capabilities or provide acc

 The user is an admin.

-___
-
 ### DEVELOPER

 **DEVELOPER** = `"developer"`

 The user is a developer.

-___
-
 ### MEMBER

 **MEMBER** = `"member"`