api-ref: custom API reference (#4770)

* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
2023-08-15 18:07:54 +03:00
parent 16249ec280
commit 914d773d3a
3270 changed files with 22075 additions and 192064 deletions
@@ -0,0 +1,33 @@
+# Enumeration: UserRoles
+
+[internal](../modules/internal-1.md).UserRoles
+
+## Enumeration Members
+
+### ADMIN
+
+• **ADMIN** = ``"admin"``
+
+#### Defined in
+
+medusa/dist/models/user.d.ts:3
+
+___
+
+### DEVELOPER
+
+• **DEVELOPER** = ``"developer"``
+
+#### Defined in
+
+medusa/dist/models/user.d.ts:5
+
+___
+
+### MEMBER
+
+• **MEMBER** = ``"member"``
+
+#### Defined in
+
+medusa/dist/models/user.d.ts:4
@@ -0,0 +1,53 @@
+# Enumeration: RefundReason
+
+[internal](../modules/internal-16.md).RefundReason
+
+## Enumeration Members
+
+### CLAIM
+
+• **CLAIM** = ``"claim"``
+
+#### Defined in
+
+medusa/dist/models/refund.d.ts:8
+
+___
+
+### DISCOUNT
+
+• **DISCOUNT** = ``"discount"``
+
+#### Defined in
+
+medusa/dist/models/refund.d.ts:5
+
+___
+
+### OTHER
+
+• **OTHER** = ``"other"``
+
+#### Defined in
+
+medusa/dist/models/refund.d.ts:9
+
+___
+
+### RETURN
+
+• **RETURN** = ``"return"``
+
+#### Defined in
+
+medusa/dist/models/refund.d.ts:6
+
+___
+
+### SWAP
+
+• **SWAP** = ``"swap"``
+
+#### Defined in
+
+medusa/dist/models/refund.d.ts:7
@@ -0,0 +1,73 @@
+# Enumeration: BatchJobStatus
+
+[internal](../modules/internal-2.md).BatchJobStatus
+
+## Enumeration Members
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/types/batch-job.d.ts:9
+
+___
+
+### COMPLETED
+
+• **COMPLETED** = ``"completed"``
+
+#### Defined in
+
+medusa/dist/types/batch-job.d.ts:8
+
+___
+
+### CONFIRMED
+
+• **CONFIRMED** = ``"confirmed"``
+
+#### Defined in
+
+medusa/dist/types/batch-job.d.ts:6
+
+___
+
+### CREATED
+
+• **CREATED** = ``"created"``
+
+#### Defined in
+
+medusa/dist/types/batch-job.d.ts:4
+
+___
+
+### FAILED
+
+• **FAILED** = ``"failed"``
+
+#### Defined in
+
+medusa/dist/types/batch-job.d.ts:10
+
+___
+
+### PRE\_PROCESSED
+
+• **PRE\_PROCESSED** = ``"pre_processed"``
+
+#### Defined in
+
+medusa/dist/types/batch-job.d.ts:5
+
+___
+
+### PROCESSING
+
+• **PROCESSING** = ``"processing"``
+
+#### Defined in
+
+medusa/dist/types/batch-job.d.ts:7
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: AllocationType
+
+[internal](../modules/internal.md).AllocationType
+
+## Enumeration Members
+
+### ITEM
+
+• **ITEM** = ``"item"``
+
+#### Defined in
+
+medusa/dist/models/discount-rule.d.ts:10
+
+___
+
+### TOTAL
+
+• **TOTAL** = ``"total"``
+
+#### Defined in
+
+medusa/dist/models/discount-rule.d.ts:9
@@ -0,0 +1,57 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: CartType
+
+[internal](../modules/internal.md).CartType
+
+## Enumeration Members
+
+### CLAIM
+
+• **CLAIM** = ``"claim"``
+
+#### Defined in
+
+medusa/dist/models/cart.d.ts:187
+
+___
+
+### DEFAULT
+
+• **DEFAULT** = ``"default"``
+
+#### Defined in
+
+medusa/dist/models/cart.d.ts:183
+
+___
+
+### DRAFT\_ORDER
+
+• **DRAFT\_ORDER** = ``"draft_order"``
+
+#### Defined in
+
+medusa/dist/models/cart.d.ts:185
+
+___
+
+### PAYMENT\_LINK
+
+• **PAYMENT\_LINK** = ``"payment_link"``
+
+#### Defined in
+
+medusa/dist/models/cart.d.ts:186
+
+___
+
+### SWAP
+
+• **SWAP** = ``"swap"``
+
+#### Defined in
+
+medusa/dist/models/cart.d.ts:184
@@ -0,0 +1,97 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: ClaimFulfillmentStatus
+
+[internal](../modules/internal.md).ClaimFulfillmentStatus
+
+## Enumeration Members
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:26
+
+___
+
+### FULFILLED
+
+• **FULFILLED** = ``"fulfilled"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:21
+
+___
+
+### NOT\_FULFILLED
+
+• **NOT\_FULFILLED** = ``"not_fulfilled"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:19
+
+___
+
+### PARTIALLY\_FULFILLED
+
+• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:20
+
+___
+
+### PARTIALLY\_RETURNED
+
+• **PARTIALLY\_RETURNED** = ``"partially_returned"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:24
+
+___
+
+### PARTIALLY\_SHIPPED
+
+• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:22
+
+___
+
+### REQUIRES\_ACTION
+
+• **REQUIRES\_ACTION** = ``"requires_action"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:27
+
+___
+
+### RETURNED
+
+• **RETURNED** = ``"returned"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:25
+
+___
+
+### SHIPPED
+
+• **SHIPPED** = ``"shipped"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:23
@@ -0,0 +1,37 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: ClaimPaymentStatus
+
+[internal](../modules/internal.md).ClaimPaymentStatus
+
+## Enumeration Members
+
+### NA
+
+• **NA** = ``"na"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:14
+
+___
+
+### NOT\_REFUNDED
+
+• **NOT\_REFUNDED** = ``"not_refunded"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:15
+
+___
+
+### REFUNDED
+
+• **REFUNDED** = ``"refunded"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:16
@@ -0,0 +1,47 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: ClaimReason
+
+[internal](../modules/internal.md).ClaimReason
+
+## Enumeration Members
+
+### MISSING\_ITEM
+
+• **MISSING\_ITEM** = ``"missing_item"``
+
+#### Defined in
+
+medusa/dist/models/claim-item.d.ts:8
+
+___
+
+### OTHER
+
+• **OTHER** = ``"other"``
+
+#### Defined in
+
+medusa/dist/models/claim-item.d.ts:11
+
+___
+
+### PRODUCTION\_FAILURE
+
+• **PRODUCTION\_FAILURE** = ``"production_failure"``
+
+#### Defined in
+
+medusa/dist/models/claim-item.d.ts:10
+
+___
+
+### WRONG\_ITEM
+
+• **WRONG\_ITEM** = ``"wrong_item"``
+
+#### Defined in
+
+medusa/dist/models/claim-item.d.ts:9
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: ClaimType
+
+[internal](../modules/internal.md).ClaimType
+
+## Enumeration Members
+
+### REFUND
+
+• **REFUND** = ``"refund"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:10
+
+___
+
+### REPLACE
+
+• **REPLACE** = ``"replace"``
+
+#### Defined in
+
+medusa/dist/models/claim-order.d.ts:11
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: DiscountConditionOperator
+
+[internal](../modules/internal.md).DiscountConditionOperator
+
+## Enumeration Members
+
+### IN
+
+• **IN** = ``"in"``
+
+#### Defined in
+
+medusa/dist/models/discount-condition.d.ts:16
+
+___
+
+### NOT\_IN
+
+• **NOT\_IN** = ``"not_in"``
+
+#### Defined in
+
+medusa/dist/models/discount-condition.d.ts:17
@@ -0,0 +1,57 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: DiscountConditionType
+
+[internal](../modules/internal.md).DiscountConditionType
+
+## Enumeration Members
+
+### CUSTOMER\_GROUPS
+
+• **CUSTOMER\_GROUPS** = ``"customer_groups"``
+
+#### Defined in
+
+medusa/dist/models/discount-condition.d.ts:13
+
+___
+
+### PRODUCTS
+
+• **PRODUCTS** = ``"products"``
+
+#### Defined in
+
+medusa/dist/models/discount-condition.d.ts:9
+
+___
+
+### PRODUCT\_COLLECTIONS
+
+• **PRODUCT\_COLLECTIONS** = ``"product_collections"``
+
+#### Defined in
+
+medusa/dist/models/discount-condition.d.ts:11
+
+___
+
+### PRODUCT\_TAGS
+
+• **PRODUCT\_TAGS** = ``"product_tags"``
+
+#### Defined in
+
+medusa/dist/models/discount-condition.d.ts:12
+
+___
+
+### PRODUCT\_TYPES
+
+• **PRODUCT\_TYPES** = ``"product_types"``
+
+#### Defined in
+
+medusa/dist/models/discount-condition.d.ts:10
@@ -0,0 +1,37 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: DiscountRuleType
+
+[internal](../modules/internal.md).DiscountRuleType
+
+## Enumeration Members
+
+### FIXED
+
+• **FIXED** = ``"fixed"``
+
+#### Defined in
+
+medusa/dist/models/discount-rule.d.ts:4
+
+___
+
+### FREE\_SHIPPING
+
+• **FREE\_SHIPPING** = ``"free_shipping"``
+
+#### Defined in
+
+medusa/dist/models/discount-rule.d.ts:6
+
+___
+
+### PERCENTAGE
+
+• **PERCENTAGE** = ``"percentage"``
+
+#### Defined in
+
+medusa/dist/models/discount-rule.d.ts:5
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: DraftOrderStatus
+
+[internal](../modules/internal.md).DraftOrderStatus
+
+## Enumeration Members
+
+### COMPLETED
+
+• **COMPLETED** = ``"completed"``
+
+#### Defined in
+
+medusa/dist/models/draft-order.d.ts:6
+
+___
+
+### OPEN
+
+• **OPEN** = ``"open"``
+
+#### Defined in
+
+medusa/dist/models/draft-order.d.ts:5
@@ -0,0 +1,97 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: FulfillmentStatus
+
+[internal](../modules/internal.md).FulfillmentStatus
+
+## Enumeration Members
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:36
+
+___
+
+### FULFILLED
+
+• **FULFILLED** = ``"fulfilled"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:31
+
+___
+
+### NOT\_FULFILLED
+
+• **NOT\_FULFILLED** = ``"not_fulfilled"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:29
+
+___
+
+### PARTIALLY\_FULFILLED
+
+• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:30
+
+___
+
+### PARTIALLY\_RETURNED
+
+• **PARTIALLY\_RETURNED** = ``"partially_returned"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:34
+
+___
+
+### PARTIALLY\_SHIPPED
+
+• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:32
+
+___
+
+### REQUIRES\_ACTION
+
+• **REQUIRES\_ACTION** = ``"requires_action"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:37
+
+___
+
+### RETURNED
+
+• **RETURNED** = ``"returned"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:35
+
+___
+
+### SHIPPED
+
+• **SHIPPED** = ``"shipped"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:33
@@ -0,0 +1,37 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: OrderEditItemChangeType
+
+[internal](../modules/internal.md).OrderEditItemChangeType
+
+## Enumeration Members
+
+### ITEM\_ADD
+
+• **ITEM\_ADD** = ``"item_add"``
+
+#### Defined in
+
+medusa/dist/models/order-item-change.d.ts:5
+
+___
+
+### ITEM\_REMOVE
+
+• **ITEM\_REMOVE** = ``"item_remove"``
+
+#### Defined in
+
+medusa/dist/models/order-item-change.d.ts:6
+
+___
+
+### ITEM\_UPDATE
+
+• **ITEM\_UPDATE** = ``"item_update"``
+
+#### Defined in
+
+medusa/dist/models/order-item-change.d.ts:7
@@ -0,0 +1,57 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: OrderEditStatus
+
+[internal](../modules/internal.md).OrderEditStatus
+
+## Enumeration Members
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/order-edit.d.ts:8
+
+___
+
+### CONFIRMED
+
+• **CONFIRMED** = ``"confirmed"``
+
+#### Defined in
+
+medusa/dist/models/order-edit.d.ts:4
+
+___
+
+### CREATED
+
+• **CREATED** = ``"created"``
+
+#### Defined in
+
+medusa/dist/models/order-edit.d.ts:7
+
+___
+
+### DECLINED
+
+• **DECLINED** = ``"declined"``
+
+#### Defined in
+
+medusa/dist/models/order-edit.d.ts:5
+
+___
+
+### REQUESTED
+
+• **REQUESTED** = ``"requested"``
+
+#### Defined in
+
+medusa/dist/models/order-edit.d.ts:6
@@ -0,0 +1,57 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: OrderStatus
+
+[internal](../modules/internal.md).OrderStatus
+
+## Enumeration Members
+
+### ARCHIVED
+
+• **ARCHIVED** = ``"archived"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:24
+
+___
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:25
+
+___
+
+### COMPLETED
+
+• **COMPLETED** = ``"completed"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:23
+
+___
+
+### PENDING
+
+• **PENDING** = ``"pending"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:22
+
+___
+
+### REQUIRES\_ACTION
+
+• **REQUIRES\_ACTION** = ``"requires_action"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:26
@@ -0,0 +1,57 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: PaymentCollectionStatus
+
+[internal](../modules/internal.md).PaymentCollectionStatus
+
+## Enumeration Members
+
+### AUTHORIZED
+
+• **AUTHORIZED** = ``"authorized"``
+
+#### Defined in
+
+medusa/dist/models/payment-collection.d.ts:6
+
+___
+
+### AWAITING
+
+• **AWAITING** = ``"awaiting"``
+
+#### Defined in
+
+medusa/dist/models/payment-collection.d.ts:5
+
+___
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/payment-collection.d.ts:8
+
+___
+
+### NOT\_PAID
+
+• **NOT\_PAID** = ``"not_paid"``
+
+#### Defined in
+
+medusa/dist/models/payment-collection.d.ts:4
+
+___
+
+### PARTIALLY\_AUTHORIZED
+
+• **PARTIALLY\_AUTHORIZED** = ``"partially_authorized"``
+
+#### Defined in
+
+medusa/dist/models/payment-collection.d.ts:7
@@ -0,0 +1,77 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: PaymentStatus
+
+[internal](../modules/internal.md).PaymentStatus
+
+## Enumeration Members
+
+### AWAITING
+
+• **AWAITING** = ``"awaiting"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:41
+
+___
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:45
+
+___
+
+### CAPTURED
+
+• **CAPTURED** = ``"captured"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:42
+
+___
+
+### NOT\_PAID
+
+• **NOT\_PAID** = ``"not_paid"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:40
+
+___
+
+### PARTIALLY\_REFUNDED
+
+• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:43
+
+___
+
+### REFUNDED
+
+• **REFUNDED** = ``"refunded"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:44
+
+___
+
+### REQUIRES\_ACTION
+
+• **REQUIRES\_ACTION** = ``"requires_action"``
+
+#### Defined in
+
+medusa/dist/models/order.d.ts:46
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: PriceListStatus
+
+[internal](../modules/internal.md).PriceListStatus
+
+## Enumeration Members
+
+### ACTIVE
+
+• **ACTIVE** = ``"active"``
+
+#### Defined in
+
+medusa/dist/types/price-list.d.ts:8
+
+___
+
+### DRAFT
+
+• **DRAFT** = ``"draft"``
+
+#### Defined in
+
+medusa/dist/types/price-list.d.ts:9
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: PriceListType
+
+[internal](../modules/internal.md).PriceListType
+
+## Enumeration Members
+
+### OVERRIDE
+
+• **OVERRIDE** = ``"override"``
+
+#### Defined in
+
+medusa/dist/types/price-list.d.ts:5
+
+___
+
+### SALE
+
+• **SALE** = ``"sale"``
+
+#### Defined in
+
+medusa/dist/types/price-list.d.ts:4
@@ -0,0 +1,47 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: ProductStatus
+
+[internal](../modules/internal.md).ProductStatus
+
+## Enumeration Members
+
+### DRAFT
+
+• **DRAFT** = ``"draft"``
+
+#### Defined in
+
+medusa/dist/models/product.d.ts:11
+
+___
+
+### PROPOSED
+
+• **PROPOSED** = ``"proposed"``
+
+#### Defined in
+
+medusa/dist/models/product.d.ts:12
+
+___
+
+### PUBLISHED
+
+• **PUBLISHED** = ``"published"``
+
+#### Defined in
+
+medusa/dist/models/product.d.ts:13
+
+___
+
+### REJECTED
+
+• **REJECTED** = ``"rejected"``
+
+#### Defined in
+
+medusa/dist/models/product.d.ts:14
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: RequirementType
+
+[internal](../modules/internal.md).RequirementType
+
+## Enumeration Members
+
+### MAX\_SUBTOTAL
+
+• **MAX\_SUBTOTAL** = ``"max_subtotal"``
+
+#### Defined in
+
+medusa/dist/models/shipping-option-requirement.d.ts:4
+
+___
+
+### MIN\_SUBTOTAL
+
+• **MIN\_SUBTOTAL** = ``"min_subtotal"``
+
+#### Defined in
+
+medusa/dist/models/shipping-option-requirement.d.ts:3
@@ -0,0 +1,47 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: ReturnStatus
+
+[internal](../modules/internal.md).ReturnStatus
+
+## Enumeration Members
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/return.d.ts:11
+
+___
+
+### RECEIVED
+
+• **RECEIVED** = ``"received"``
+
+#### Defined in
+
+medusa/dist/models/return.d.ts:9
+
+___
+
+### REQUESTED
+
+• **REQUESTED** = ``"requested"``
+
+#### Defined in
+
+medusa/dist/models/return.d.ts:8
+
+___
+
+### REQUIRES\_ACTION
+
+• **REQUIRES\_ACTION** = ``"requires_action"``
+
+#### Defined in
+
+medusa/dist/models/return.d.ts:10
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: ShippingOptionPriceType
+
+[internal](../modules/internal.md).ShippingOptionPriceType
+
+## Enumeration Members
+
+### CALCULATED
+
+• **CALCULATED** = ``"calculated"``
+
+#### Defined in
+
+medusa/dist/models/shipping-option.d.ts:8
+
+___
+
+### FLAT\_RATE
+
+• **FLAT\_RATE** = ``"flat_rate"``
+
+#### Defined in
+
+medusa/dist/models/shipping-option.d.ts:7
@@ -0,0 +1,37 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: ShippingProfileType
+
+[internal](../modules/internal.md).ShippingProfileType
+
+## Enumeration Members
+
+### CUSTOM
+
+• **CUSTOM** = ``"custom"``
+
+#### Defined in
+
+medusa/dist/models/shipping-profile.d.ts:7
+
+___
+
+### DEFAULT
+
+• **DEFAULT** = ``"default"``
+
+#### Defined in
+
+medusa/dist/models/shipping-profile.d.ts:5
+
+___
+
+### GIFT\_CARD
+
+• **GIFT\_CARD** = ``"gift_card"``
+
+#### Defined in
+
+medusa/dist/models/shipping-profile.d.ts:6
@@ -0,0 +1,67 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: SwapFulfillmentStatus
+
+[internal](../modules/internal.md).SwapFulfillmentStatus
+
+## Enumeration Members
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:15
+
+___
+
+### FULFILLED
+
+• **FULFILLED** = ``"fulfilled"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:12
+
+___
+
+### NOT\_FULFILLED
+
+• **NOT\_FULFILLED** = ``"not_fulfilled"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:11
+
+___
+
+### PARTIALLY\_SHIPPED
+
+• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:14
+
+___
+
+### REQUIRES\_ACTION
+
+• **REQUIRES\_ACTION** = ``"requires_action"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:16
+
+___
+
+### SHIPPED
+
+• **SHIPPED** = ``"shipped"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:13
@@ -0,0 +1,97 @@
+---
+displayed_sidebar: jsClientSidebar
+---
+
+# Enumeration: SwapPaymentStatus
+
+[internal](../modules/internal.md).SwapPaymentStatus
+
+## Enumeration Members
+
+### AWAITING
+
+• **AWAITING** = ``"awaiting"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:20
+
+___
+
+### CANCELED
+
+• **CANCELED** = ``"canceled"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:23
+
+___
+
+### CAPTURED
+
+• **CAPTURED** = ``"captured"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:21
+
+___
+
+### CONFIRMED
+
+• **CONFIRMED** = ``"confirmed"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:22
+
+___
+
+### DIFFERENCE\_REFUNDED
+
+• **DIFFERENCE\_REFUNDED** = ``"difference_refunded"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:24
+
+___
+
+### NOT\_PAID
+
+• **NOT\_PAID** = ``"not_paid"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:19
+
+___
+
+### PARTIALLY\_REFUNDED
+
+• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:25
+
+___
+
+### REFUNDED
+
+• **REFUNDED** = ``"refunded"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:26
+
+___
+
+### REQUIRES\_ACTION
+
+• **REQUIRES\_ACTION** = ``"requires_action"``
+
+#### Defined in
+
+medusa/dist/models/swap.d.ts:27