docs: added reference for JS Client (#1629)
* added reference for JS Client * added reference for JS Client * added reference for JS Client
This commit is contained in:
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: AllocationType
|
||||
|
||||
[internal](../modules/internal.md).AllocationType
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### ITEM
|
||||
|
||||
• **ITEM** = `"item"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount-rule.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### TOTAL
|
||||
|
||||
• **TOTAL** = `"total"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount-rule.d.ts:9
|
||||
57
docs/content/references/js-client/enums/internal.CartType.md
Normal file
57
docs/content/references/js-client/enums/internal.CartType.md
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: CartType
|
||||
|
||||
[internal](../modules/internal.md).CartType
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### CLAIM
|
||||
|
||||
• **CLAIM** = `"claim"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/cart.d.ts:99
|
||||
|
||||
___
|
||||
|
||||
### DEFAULT
|
||||
|
||||
• **DEFAULT** = `"default"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/cart.d.ts:95
|
||||
|
||||
___
|
||||
|
||||
### DRAFT\_ORDER
|
||||
|
||||
• **DRAFT\_ORDER** = `"draft_order"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/cart.d.ts:97
|
||||
|
||||
___
|
||||
|
||||
### PAYMENT\_LINK
|
||||
|
||||
• **PAYMENT\_LINK** = `"payment_link"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/cart.d.ts:98
|
||||
|
||||
___
|
||||
|
||||
### SWAP
|
||||
|
||||
• **SWAP** = `"swap"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/cart.d.ts:96
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: ClaimFulfillmentStatus
|
||||
|
||||
[internal](../modules/internal.md).ClaimFulfillmentStatus
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### CANCELED
|
||||
|
||||
• **CANCELED** = `"canceled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:26
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
• **FULFILLED** = `"fulfilled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
• **NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:19
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_FULFILLED
|
||||
|
||||
• **PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:20
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_RETURNED
|
||||
|
||||
• **PARTIALLY\_RETURNED** = `"partially_returned"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:24
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_SHIPPED
|
||||
|
||||
• **PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:22
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
• **REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:27
|
||||
|
||||
___
|
||||
|
||||
### RETURNED
|
||||
|
||||
• **RETURNED** = `"returned"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:25
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
• **SHIPPED** = `"shipped"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
### NOT\_REFUNDED
|
||||
|
||||
• **NOT\_REFUNDED** = `"not_refunded"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
• **REFUNDED** = `"refunded"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/claim-item.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### OTHER
|
||||
|
||||
• **OTHER** = `"other"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-item.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### PRODUCTION\_FAILURE
|
||||
|
||||
• **PRODUCTION\_FAILURE** = `"production_failure"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/claim-item.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### WRONG\_ITEM
|
||||
|
||||
• **WRONG\_ITEM** = `"wrong_item"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/claim-order.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### REPLACE
|
||||
|
||||
• **REPLACE** = `"replace"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/discount-condition.d.ts:16
|
||||
|
||||
___
|
||||
|
||||
### NOT\_IN
|
||||
|
||||
• **NOT\_IN** = `"not_in"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/discount-condition.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### PRODUCTS
|
||||
|
||||
• **PRODUCTS** = `"products"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount-condition.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_COLLECTIONS
|
||||
|
||||
• **PRODUCT\_COLLECTIONS** = `"product_collections"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount-condition.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_TAGS
|
||||
|
||||
• **PRODUCT\_TAGS** = `"product_tags"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount-condition.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### PRODUCT\_TYPES
|
||||
|
||||
• **PRODUCT\_TYPES** = `"product_types"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/discount-rule.d.ts:4
|
||||
|
||||
___
|
||||
|
||||
### FREE\_SHIPPING
|
||||
|
||||
• **FREE\_SHIPPING** = `"free_shipping"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/discount-rule.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### PERCENTAGE
|
||||
|
||||
• **PERCENTAGE** = `"percentage"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/draft-order.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### OPEN
|
||||
|
||||
• **OPEN** = `"open"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:34
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
• **FULFILLED** = `"fulfilled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:29
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
• **NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:27
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_FULFILLED
|
||||
|
||||
• **PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:28
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_RETURNED
|
||||
|
||||
• **PARTIALLY\_RETURNED** = `"partially_returned"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:32
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_SHIPPED
|
||||
|
||||
• **PARTIALLY\_SHIPPED** = `"partially_shipped"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:30
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
• **REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:35
|
||||
|
||||
___
|
||||
|
||||
### RETURNED
|
||||
|
||||
• **RETURNED** = `"returned"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:33
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
• **SHIPPED** = `"shipped"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:31
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: OrderStatus
|
||||
|
||||
[internal](../modules/internal.md).OrderStatus
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### ARCHIVED
|
||||
|
||||
• **ARCHIVED** = `"archived"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:22
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
• **CANCELED** = `"canceled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:23
|
||||
|
||||
___
|
||||
|
||||
### COMPLETED
|
||||
|
||||
• **COMPLETED** = `"completed"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
### PENDING
|
||||
|
||||
• **PENDING** = `"pending"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:20
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
• **REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:24
|
||||
@@ -0,0 +1,77 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: PaymentStatus
|
||||
|
||||
[internal](../modules/internal.md).PaymentStatus
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### AWAITING
|
||||
|
||||
• **AWAITING** = `"awaiting"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:39
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
• **CANCELED** = `"canceled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:43
|
||||
|
||||
___
|
||||
|
||||
### CAPTURED
|
||||
|
||||
• **CAPTURED** = `"captured"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:40
|
||||
|
||||
___
|
||||
|
||||
### NOT\_PAID
|
||||
|
||||
• **NOT\_PAID** = `"not_paid"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:38
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_REFUNDED
|
||||
|
||||
• **PARTIALLY\_REFUNDED** = `"partially_refunded"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:41
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
• **REFUNDED** = `"refunded"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:42
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
• **REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/order.d.ts:44
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: PriceListStatus
|
||||
|
||||
[internal](../modules/internal.md).PriceListStatus
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### ACTIVE
|
||||
|
||||
• **ACTIVE** = `"active"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### DRAFT
|
||||
|
||||
• **DRAFT** = `"draft"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/types/price-list.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### SALE
|
||||
|
||||
• **SALE** = `"sale"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:54
|
||||
|
||||
___
|
||||
|
||||
### PROPOSED
|
||||
|
||||
• **PROPOSED** = `"proposed"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:55
|
||||
|
||||
___
|
||||
|
||||
### PUBLISHED
|
||||
|
||||
• **PUBLISHED** = `"published"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:56
|
||||
|
||||
___
|
||||
|
||||
### REJECTED
|
||||
|
||||
• **REJECTED** = `"rejected"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:57
|
||||
@@ -0,0 +1,27 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: RequirementType
|
||||
|
||||
[internal](../modules/internal.md).RequirementType
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### MAX\_SUBTOTAL
|
||||
|
||||
• **MAX\_SUBTOTAL** = `"max_subtotal"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/shipping-option-requirement.d.ts:4
|
||||
|
||||
___
|
||||
|
||||
### MIN\_SUBTOTAL
|
||||
|
||||
• **MIN\_SUBTOTAL** = `"min_subtotal"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/return.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### RECEIVED
|
||||
|
||||
• **RECEIVED** = `"received"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/return.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### REQUESTED
|
||||
|
||||
• **REQUESTED** = `"requested"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/return.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
• **REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/shipping-option.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### FLAT\_RATE
|
||||
|
||||
• **FLAT\_RATE** = `"flat_rate"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/shipping-profile.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
### DEFAULT
|
||||
|
||||
• **DEFAULT** = `"default"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/shipping-profile.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### GIFT\_CARD
|
||||
|
||||
• **GIFT\_CARD** = `"gift_card"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/shipping-profile.d.ts:6
|
||||
47
docs/content/references/js-client/enums/internal.Status.md
Normal file
47
docs/content/references/js-client/enums/internal.Status.md
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: Status
|
||||
|
||||
[internal](../modules/internal.md).Status
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### DRAFT
|
||||
|
||||
• **DRAFT** = `"draft"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/product.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### PROPOSED
|
||||
|
||||
• **PROPOSED** = `"proposed"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/product.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### PUBLISHED
|
||||
|
||||
• **PUBLISHED** = `"published"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/product.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### REJECTED
|
||||
|
||||
• **REJECTED** = `"rejected"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/product.d.ts:13
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: SwapFulfillmentStatus
|
||||
|
||||
[internal](../modules/internal.md).SwapFulfillmentStatus
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### CANCELED
|
||||
|
||||
• **CANCELED** = `"canceled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:14
|
||||
|
||||
___
|
||||
|
||||
### FULFILLED
|
||||
|
||||
• **FULFILLED** = `"fulfilled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### NOT\_FULFILLED
|
||||
|
||||
• **NOT\_FULFILLED** = `"not_fulfilled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:11
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
• **REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:15
|
||||
|
||||
___
|
||||
|
||||
### SHIPPED
|
||||
|
||||
• **SHIPPED** = `"shipped"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/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
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:19
|
||||
|
||||
___
|
||||
|
||||
### CANCELED
|
||||
|
||||
• **CANCELED** = `"canceled"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:22
|
||||
|
||||
___
|
||||
|
||||
### CAPTURED
|
||||
|
||||
• **CAPTURED** = `"captured"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:20
|
||||
|
||||
___
|
||||
|
||||
### CONFIRMED
|
||||
|
||||
• **CONFIRMED** = `"confirmed"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:21
|
||||
|
||||
___
|
||||
|
||||
### DIFFERENCE\_REFUNDED
|
||||
|
||||
• **DIFFERENCE\_REFUNDED** = `"difference_refunded"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:23
|
||||
|
||||
___
|
||||
|
||||
### NOT\_PAID
|
||||
|
||||
• **NOT\_PAID** = `"not_paid"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:18
|
||||
|
||||
___
|
||||
|
||||
### PARTIALLY\_REFUNDED
|
||||
|
||||
• **PARTIALLY\_REFUNDED** = `"partially_refunded"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:24
|
||||
|
||||
___
|
||||
|
||||
### REFUNDED
|
||||
|
||||
• **REFUNDED** = `"refunded"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:25
|
||||
|
||||
___
|
||||
|
||||
### REQUIRES\_ACTION
|
||||
|
||||
• **REQUIRES\_ACTION** = `"requires_action"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/swap.d.ts:26
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Enumeration: UserRoles
|
||||
|
||||
[internal](../modules/internal.md).UserRoles
|
||||
|
||||
## Enumeration members
|
||||
|
||||
### ADMIN
|
||||
|
||||
• **ADMIN** = `"admin"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:3
|
||||
|
||||
___
|
||||
|
||||
### DEVELOPER
|
||||
|
||||
• **DEVELOPER** = `"developer"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### MEMBER
|
||||
|
||||
• **MEMBER** = `"member"`
|
||||
|
||||
#### Defined in
|
||||
|
||||
packages/medusa/dist/models/user.d.ts:4
|
||||
Reference in New Issue
Block a user