docs: added entity reference (#2047)

* added entity reference

* chore: added github action

* added link to reference
This commit is contained in:
Shahed Nasser
2022-08-15 15:54:48 +03:00
committed by GitHub
parent 4a89961fd4
commit 4a416e7fa5
101 changed files with 12704 additions and 4 deletions
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: AllocationType
## Enumeration Members
### ITEM
**ITEM** = ``"item"``
#### Defined in
[models/discount-rule.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L16)
___
### TOTAL
• **TOTAL** = ``"total"``
#### Defined in
[models/discount-rule.ts:15](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L15)
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: CartType
## Enumeration Members
### CLAIM
**CLAIM** = ``"claim"``
#### Defined in
[models/cart.ts:208](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L208)
___
### DEFAULT
• **DEFAULT** = ``"default"``
#### Defined in
[models/cart.ts:204](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L204)
___
### DRAFT\_ORDER
• **DRAFT\_ORDER** = ``"draft_order"``
#### Defined in
[models/cart.ts:206](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L206)
___
### PAYMENT\_LINK
• **PAYMENT\_LINK** = ``"payment_link"``
#### Defined in
[models/cart.ts:207](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L207)
___
### SWAP
• **SWAP** = ``"swap"``
#### Defined in
[models/cart.ts:205](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/cart.ts#L205)
@@ -0,0 +1,95 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimFulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/claim-order.ts:45](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L45)
___
### FULFILLED
• **FULFILLED** = ``"fulfilled"``
#### Defined in
[models/claim-order.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L40)
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
[models/claim-order.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L38)
___
### PARTIALLY\_FULFILLED
• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
#### Defined in
[models/claim-order.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L39)
___
### PARTIALLY\_RETURNED
• **PARTIALLY\_RETURNED** = ``"partially_returned"``
#### Defined in
[models/claim-order.ts:43](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L43)
___
### PARTIALLY\_SHIPPED
• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
#### Defined in
[models/claim-order.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L41)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/claim-order.ts:46](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L46)
___
### RETURNED
• **RETURNED** = ``"returned"``
#### Defined in
[models/claim-order.ts:44](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L44)
___
### SHIPPED
• **SHIPPED** = ``"shipped"``
#### Defined in
[models/claim-order.ts:42](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L42)
@@ -0,0 +1,35 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimPaymentStatus
## Enumeration Members
### NA
**NA** = ``"na"``
#### Defined in
[models/claim-order.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L32)
___
### NOT\_REFUNDED
• **NOT\_REFUNDED** = ``"not_refunded"``
#### Defined in
[models/claim-order.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L33)
___
### REFUNDED
• **REFUNDED** = ``"refunded"``
#### Defined in
[models/claim-order.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L34)
@@ -0,0 +1,45 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimReason
## Enumeration Members
### MISSING\_ITEM
**MISSING\_ITEM** = ``"missing_item"``
#### Defined in
[models/claim-item.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L23)
___
### OTHER
• **OTHER** = ``"other"``
#### Defined in
[models/claim-item.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L26)
___
### PRODUCTION\_FAILURE
• **PRODUCTION\_FAILURE** = ``"production_failure"``
#### Defined in
[models/claim-item.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L25)
___
### WRONG\_ITEM
• **WRONG\_ITEM** = ``"wrong_item"``
#### Defined in
[models/claim-item.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-item.ts#L24)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ClaimType
## Enumeration Members
### REFUND
**REFUND** = ``"refund"``
#### Defined in
[models/claim-order.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L27)
___
### REPLACE
• **REPLACE** = ``"replace"``
#### Defined in
[models/claim-order.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/claim-order.ts#L28)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountConditionOperator
## Enumeration Members
### IN
**IN** = ``"in"``
#### Defined in
[models/discount-condition.ts:32](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L32)
___
### NOT\_IN
• **NOT\_IN** = ``"not_in"``
#### Defined in
[models/discount-condition.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L33)
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountConditionType
## Enumeration Members
### CUSTOMER\_GROUPS
**CUSTOMER\_GROUPS** = ``"customer_groups"``
#### Defined in
[models/discount-condition.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L28)
___
### PRODUCTS
• **PRODUCTS** = ``"products"``
#### Defined in
[models/discount-condition.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L24)
___
### PRODUCT\_COLLECTIONS
• **PRODUCT\_COLLECTIONS** = ``"product_collections"``
#### Defined in
[models/discount-condition.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L26)
___
### PRODUCT\_TAGS
• **PRODUCT\_TAGS** = ``"product_tags"``
#### Defined in
[models/discount-condition.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L27)
___
### PRODUCT\_TYPES
• **PRODUCT\_TYPES** = ``"product_types"``
#### Defined in
[models/discount-condition.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-condition.ts#L25)
@@ -0,0 +1,35 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DiscountRuleType
## Enumeration Members
### FIXED
**FIXED** = ``"fixed"``
#### Defined in
[models/discount-rule.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L9)
___
### FREE\_SHIPPING
• **FREE\_SHIPPING** = ``"free_shipping"``
#### Defined in
[models/discount-rule.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L11)
___
### PERCENTAGE
• **PERCENTAGE** = ``"percentage"``
#### Defined in
[models/discount-rule.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/discount-rule.ts#L10)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: DraftOrderStatus
## Enumeration Members
### COMPLETED
**COMPLETED** = ``"completed"``
#### Defined in
[models/draft-order.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L24)
___
### OPEN
• **OPEN** = ``"open"``
#### Defined in
[models/draft-order.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/draft-order.ts#L23)
@@ -0,0 +1,95 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: FulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:62](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L62)
___
### FULFILLED
• **FULFILLED** = ``"fulfilled"``
#### Defined in
[models/order.ts:57](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L57)
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
[models/order.ts:55](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L55)
___
### PARTIALLY\_FULFILLED
• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
#### Defined in
[models/order.ts:56](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L56)
___
### PARTIALLY\_RETURNED
• **PARTIALLY\_RETURNED** = ``"partially_returned"``
#### Defined in
[models/order.ts:60](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L60)
___
### PARTIALLY\_SHIPPED
• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
#### Defined in
[models/order.ts:58](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L58)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:63](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L63)
___
### RETURNED
• **RETURNED** = ``"returned"``
#### Defined in
[models/order.ts:61](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L61)
___
### SHIPPED
• **SHIPPED** = ``"shipped"``
#### Defined in
[models/order.ts:59](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L59)
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: OrderStatus
## Enumeration Members
### ARCHIVED
**ARCHIVED** = ``"archived"``
#### Defined in
[models/order.ts:49](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L49)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:50](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L50)
___
### COMPLETED
• **COMPLETED** = ``"completed"``
#### Defined in
[models/order.ts:48](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L48)
___
### PENDING
• **PENDING** = ``"pending"``
#### Defined in
[models/order.ts:47](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L47)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:51](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L51)
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: PaymentSessionStatus
## Enumeration Members
### AUTHORIZED
**AUTHORIZED** = ``"authorized"``
#### Defined in
[models/payment-session.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L17)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/payment-session.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L21)
___
### ERROR
• **ERROR** = ``"error"``
#### Defined in
[models/payment-session.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L20)
___
### PENDING
• **PENDING** = ``"pending"``
#### Defined in
[models/payment-session.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L18)
___
### REQUIRES\_MORE
• **REQUIRES\_MORE** = ``"requires_more"``
#### Defined in
[models/payment-session.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/payment-session.ts#L19)
@@ -0,0 +1,75 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: PaymentStatus
## Enumeration Members
### AWAITING
**AWAITING** = ``"awaiting"``
#### Defined in
[models/order.ts:68](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L68)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/order.ts:72](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L72)
___
### CAPTURED
• **CAPTURED** = ``"captured"``
#### Defined in
[models/order.ts:69](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L69)
___
### NOT\_PAID
• **NOT\_PAID** = ``"not_paid"``
#### Defined in
[models/order.ts:67](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L67)
___
### PARTIALLY\_REFUNDED
• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
#### Defined in
[models/order.ts:70](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L70)
___
### REFUNDED
• **REFUNDED** = ``"refunded"``
#### Defined in
[models/order.ts:71](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L71)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/order.ts:73](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/order.ts#L73)
@@ -0,0 +1,45 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ProductStatus
## Enumeration Members
### DRAFT
**DRAFT** = ``"draft"``
#### Defined in
[models/product.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L28)
___
### PROPOSED
• **PROPOSED** = ``"proposed"``
#### Defined in
[models/product.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L29)
___
### PUBLISHED
• **PUBLISHED** = ``"published"``
#### Defined in
[models/product.ts:30](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L30)
___
### REJECTED
• **REJECTED** = ``"rejected"``
#### Defined in
[models/product.ts:31](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/product.ts#L31)
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: RefundReason
## Enumeration Members
### CLAIM
**CLAIM** = ``"claim"``
#### Defined in
[models/refund.ts:19](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L19)
___
### DISCOUNT
• **DISCOUNT** = ``"discount"``
#### Defined in
[models/refund.ts:16](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L16)
___
### OTHER
• **OTHER** = ``"other"``
#### Defined in
[models/refund.ts:20](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L20)
___
### RETURN
• **RETURN** = ``"return"``
#### Defined in
[models/refund.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L17)
___
### SWAP
• **SWAP** = ``"swap"``
#### Defined in
[models/refund.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/refund.ts#L18)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: RequirementType
## Enumeration Members
### MAX\_SUBTOTAL
**MAX\_SUBTOTAL** = ``"max_subtotal"``
#### Defined in
[models/shipping-option-requirement.ts:18](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L18)
___
### MIN\_SUBTOTAL
• **MIN\_SUBTOTAL** = ``"min_subtotal"``
#### Defined in
[models/shipping-option-requirement.ts:17](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option-requirement.ts#L17)
@@ -0,0 +1,45 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ReturnStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/return.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L25)
___
### RECEIVED
• **RECEIVED** = ``"received"``
#### Defined in
[models/return.ts:23](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L23)
___
### REQUESTED
• **REQUESTED** = ``"requested"``
#### Defined in
[models/return.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L22)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/return.ts:24](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/return.ts#L24)
@@ -0,0 +1,25 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ShippingOptionPriceType
## Enumeration Members
### CALCULATED
**CALCULATED** = ``"calculated"``
#### Defined in
[models/shipping-option.ts:22](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L22)
___
### FLAT\_RATE
• **FLAT\_RATE** = ``"flat_rate"``
#### Defined in
[models/shipping-option.ts:21](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-option.ts#L21)
@@ -0,0 +1,35 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: ShippingProfileType
## Enumeration Members
### CUSTOM
**CUSTOM** = ``"custom"``
#### Defined in
[models/shipping-profile.ts:12](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L12)
___
### DEFAULT
• **DEFAULT** = ``"default"``
#### Defined in
[models/shipping-profile.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L10)
___
### GIFT\_CARD
• **GIFT\_CARD** = ``"gift_card"``
#### Defined in
[models/shipping-profile.ts:11](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/shipping-profile.ts#L11)
@@ -0,0 +1,55 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: SwapFulfillmentStatus
## Enumeration Members
### CANCELED
**CANCELED** = ``"canceled"``
#### Defined in
[models/swap.ts:28](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L28)
___
### FULFILLED
• **FULFILLED** = ``"fulfilled"``
#### Defined in
[models/swap.ts:26](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L26)
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
[models/swap.ts:25](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L25)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/swap.ts:29](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L29)
___
### SHIPPED
• **SHIPPED** = ``"shipped"``
#### Defined in
[models/swap.ts:27](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L27)
@@ -0,0 +1,95 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: SwapPaymentStatus
## Enumeration Members
### AWAITING
**AWAITING** = ``"awaiting"``
#### Defined in
[models/swap.ts:34](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L34)
___
### CANCELED
• **CANCELED** = ``"canceled"``
#### Defined in
[models/swap.ts:37](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L37)
___
### CAPTURED
• **CAPTURED** = ``"captured"``
#### Defined in
[models/swap.ts:35](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L35)
___
### CONFIRMED
• **CONFIRMED** = ``"confirmed"``
#### Defined in
[models/swap.ts:36](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L36)
___
### DIFFERENCE\_REFUNDED
• **DIFFERENCE\_REFUNDED** = ``"difference_refunded"``
#### Defined in
[models/swap.ts:38](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L38)
___
### NOT\_PAID
• **NOT\_PAID** = ``"not_paid"``
#### Defined in
[models/swap.ts:33](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L33)
___
### PARTIALLY\_REFUNDED
• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
#### Defined in
[models/swap.ts:39](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L39)
___
### REFUNDED
• **REFUNDED** = ``"refunded"``
#### Defined in
[models/swap.ts:40](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L40)
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
[models/swap.ts:41](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/swap.ts#L41)
@@ -0,0 +1,35 @@
---
displayed_sidebar: entitiesSidebar
---
# Enumeration: UserRoles
## Enumeration Members
### ADMIN
**ADMIN** = ``"admin"``
#### Defined in
[models/user.ts:8](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L8)
___
### DEVELOPER
• **DEVELOPER** = ``"developer"``
#### Defined in
[models/user.ts:10](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L10)
___
### MEMBER
• **MEMBER** = ``"member"``
#### Defined in
[models/user.ts:9](https://github.com/medusajs/medusa/blob/0703dd94e/packages/medusa/src/models/user.ts#L9)