asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/js-client/enums/internal-1.UserRoles.md
+33
View File
@@ -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
docs/content/references/js-client/enums/internal-2.BatchJobStatus.md
+73
View File
@@ -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
docs/content/references/js-client/enums/internal.AllocationType.md
+5 -5
View File
@@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).AllocationType
## Enumeration members
## Enumeration Members
### ITEM
• **ITEM** = `"item"`
• **ITEM** = ``"item"``
#### Defined in
packages/medusa/dist/models/discount-rule.d.ts:10
medusa/dist/models/discount-rule.d.ts:10
___
### TOTAL
• **TOTAL** = `"total"`
• **TOTAL** = ``"total"``
#### Defined in
packages/medusa/dist/models/discount-rule.d.ts:9
medusa/dist/models/discount-rule.d.ts:9
docs/content/references/js-client/enums/internal.CartType.md
+11 -11
View File
@@ -6,52 +6,52 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).CartType
## Enumeration members
## Enumeration Members
### CLAIM
• **CLAIM** = `"claim"`
• **CLAIM** = ``"claim"``
#### Defined in
packages/medusa/dist/models/cart.d.ts:99
medusa/dist/models/cart.d.ts:100
___
### DEFAULT
• **DEFAULT** = `"default"`
• **DEFAULT** = ``"default"``
#### Defined in
packages/medusa/dist/models/cart.d.ts:95
medusa/dist/models/cart.d.ts:96
___
### DRAFT\_ORDER
• **DRAFT\_ORDER** = `"draft_order"`
• **DRAFT\_ORDER** = ``"draft_order"``
#### Defined in
packages/medusa/dist/models/cart.d.ts:97
medusa/dist/models/cart.d.ts:98
___
### PAYMENT\_LINK
• **PAYMENT\_LINK** = `"payment_link"`
• **PAYMENT\_LINK** = ``"payment_link"``
#### Defined in
packages/medusa/dist/models/cart.d.ts:98
medusa/dist/models/cart.d.ts:99
___
### SWAP
• **SWAP** = `"swap"`
• **SWAP** = ``"swap"``
#### Defined in
packages/medusa/dist/models/cart.d.ts:96
medusa/dist/models/cart.d.ts:97
docs/content/references/js-client/enums/internal.ClaimFulfillmentStatus.md
+19 -19
View File
@@ -6,92 +6,92 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).ClaimFulfillmentStatus
## Enumeration members
## Enumeration Members
### CANCELED
• **CANCELED** = `"canceled"`
• **CANCELED** = ``"canceled"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:26
medusa/dist/models/claim-order.d.ts:26
___
### FULFILLED
• **FULFILLED** = `"fulfilled"`
• **FULFILLED** = ``"fulfilled"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:21
medusa/dist/models/claim-order.d.ts:21
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = `"not_fulfilled"`
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:19
medusa/dist/models/claim-order.d.ts:19
___
### PARTIALLY\_FULFILLED
• **PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:20
medusa/dist/models/claim-order.d.ts:20
___
### PARTIALLY\_RETURNED
• **PARTIALLY\_RETURNED** = `"partially_returned"`
• **PARTIALLY\_RETURNED** = ``"partially_returned"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:24
medusa/dist/models/claim-order.d.ts:24
___
### PARTIALLY\_SHIPPED
• **PARTIALLY\_SHIPPED** = `"partially_shipped"`
• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:22
medusa/dist/models/claim-order.d.ts:22
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = `"requires_action"`
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:27
medusa/dist/models/claim-order.d.ts:27
___
### RETURNED
• **RETURNED** = `"returned"`
• **RETURNED** = ``"returned"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:25
medusa/dist/models/claim-order.d.ts:25
___
### SHIPPED
• **SHIPPED** = `"shipped"`
• **SHIPPED** = ``"shipped"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:23
medusa/dist/models/claim-order.d.ts:23
docs/content/references/js-client/enums/internal.ClaimPaymentStatus.md
+7 -7
View File
@@ -6,32 +6,32 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).ClaimPaymentStatus
## Enumeration members
## Enumeration Members
### NA
• **NA** = `"na"`
• **NA** = ``"na"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:14
medusa/dist/models/claim-order.d.ts:14
___
### NOT\_REFUNDED
• **NOT\_REFUNDED** = `"not_refunded"`
• **NOT\_REFUNDED** = ``"not_refunded"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:15
medusa/dist/models/claim-order.d.ts:15
___
### REFUNDED
• **REFUNDED** = `"refunded"`
• **REFUNDED** = ``"refunded"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:16
medusa/dist/models/claim-order.d.ts:16
docs/content/references/js-client/enums/internal.ClaimReason.md
+9 -9
View File
@@ -6,42 +6,42 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).ClaimReason
## Enumeration members
## Enumeration Members
### MISSING\_ITEM
• **MISSING\_ITEM** = `"missing_item"`
• **MISSING\_ITEM** = ``"missing_item"``
#### Defined in
packages/medusa/dist/models/claim-item.d.ts:8
medusa/dist/models/claim-item.d.ts:8
___
### OTHER
• **OTHER** = `"other"`
• **OTHER** = ``"other"``
#### Defined in
packages/medusa/dist/models/claim-item.d.ts:11
medusa/dist/models/claim-item.d.ts:11
___
### PRODUCTION\_FAILURE
• **PRODUCTION\_FAILURE** = `"production_failure"`
• **PRODUCTION\_FAILURE** = ``"production_failure"``
#### Defined in
packages/medusa/dist/models/claim-item.d.ts:10
medusa/dist/models/claim-item.d.ts:10
___
### WRONG\_ITEM
• **WRONG\_ITEM** = `"wrong_item"`
• **WRONG\_ITEM** = ``"wrong_item"``
#### Defined in
packages/medusa/dist/models/claim-item.d.ts:9
medusa/dist/models/claim-item.d.ts:9
docs/content/references/js-client/enums/internal.ClaimType.md
+5 -5
View File
@@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).ClaimType
## Enumeration members
## Enumeration Members
### REFUND
• **REFUND** = `"refund"`
• **REFUND** = ``"refund"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:10
medusa/dist/models/claim-order.d.ts:10
___
### REPLACE
• **REPLACE** = `"replace"`
• **REPLACE** = ``"replace"``
#### Defined in
packages/medusa/dist/models/claim-order.d.ts:11
medusa/dist/models/claim-order.d.ts:11
docs/content/references/js-client/enums/internal.DiscountConditionOperator.md
+5 -5
View File
@@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).DiscountConditionOperator
## Enumeration members
## Enumeration Members
### IN
• **IN** = `"in"`
• **IN** = ``"in"``
#### Defined in
packages/medusa/dist/models/discount-condition.d.ts:16
medusa/dist/models/discount-condition.d.ts:16
___
### NOT\_IN
• **NOT\_IN** = `"not_in"`
• **NOT\_IN** = ``"not_in"``
#### Defined in
packages/medusa/dist/models/discount-condition.d.ts:17
medusa/dist/models/discount-condition.d.ts:17
docs/content/references/js-client/enums/internal.DiscountConditionType.md
+11 -11
View File
@@ -6,52 +6,52 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).DiscountConditionType
## Enumeration members
## Enumeration Members
### CUSTOMER\_GROUPS
• **CUSTOMER\_GROUPS** = `"customer_groups"`
• **CUSTOMER\_GROUPS** = ``"customer_groups"``
#### Defined in
packages/medusa/dist/models/discount-condition.d.ts:13
medusa/dist/models/discount-condition.d.ts:13
___
### PRODUCTS
• **PRODUCTS** = `"products"`
• **PRODUCTS** = ``"products"``
#### Defined in
packages/medusa/dist/models/discount-condition.d.ts:9
medusa/dist/models/discount-condition.d.ts:9
___
### PRODUCT\_COLLECTIONS
• **PRODUCT\_COLLECTIONS** = `"product_collections"`
• **PRODUCT\_COLLECTIONS** = ``"product_collections"``
#### Defined in
packages/medusa/dist/models/discount-condition.d.ts:11
medusa/dist/models/discount-condition.d.ts:11
___
### PRODUCT\_TAGS
• **PRODUCT\_TAGS** = `"product_tags"`
• **PRODUCT\_TAGS** = ``"product_tags"``
#### Defined in
packages/medusa/dist/models/discount-condition.d.ts:12
medusa/dist/models/discount-condition.d.ts:12
___
### PRODUCT\_TYPES
• **PRODUCT\_TYPES** = `"product_types"`
• **PRODUCT\_TYPES** = ``"product_types"``
#### Defined in
packages/medusa/dist/models/discount-condition.d.ts:10
medusa/dist/models/discount-condition.d.ts:10
docs/content/references/js-client/enums/internal.DiscountRuleType.md
+7 -7
View File
@@ -6,32 +6,32 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).DiscountRuleType
## Enumeration members
## Enumeration Members
### FIXED
• **FIXED** = `"fixed"`
• **FIXED** = ``"fixed"``
#### Defined in
packages/medusa/dist/models/discount-rule.d.ts:4
medusa/dist/models/discount-rule.d.ts:4
___
### FREE\_SHIPPING
• **FREE\_SHIPPING** = `"free_shipping"`
• **FREE\_SHIPPING** = ``"free_shipping"``
#### Defined in
packages/medusa/dist/models/discount-rule.d.ts:6
medusa/dist/models/discount-rule.d.ts:6
___
### PERCENTAGE
• **PERCENTAGE** = `"percentage"`
• **PERCENTAGE** = ``"percentage"``
#### Defined in
packages/medusa/dist/models/discount-rule.d.ts:5
medusa/dist/models/discount-rule.d.ts:5
docs/content/references/js-client/enums/internal.DraftOrderStatus.md
+5 -5
View File
@@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).DraftOrderStatus
## Enumeration members
## Enumeration Members
### COMPLETED
• **COMPLETED** = `"completed"`
• **COMPLETED** = ``"completed"``
#### Defined in
packages/medusa/dist/models/draft-order.d.ts:6
medusa/dist/models/draft-order.d.ts:6
___
### OPEN
• **OPEN** = `"open"`
• **OPEN** = ``"open"``
#### Defined in
packages/medusa/dist/models/draft-order.d.ts:5
medusa/dist/models/draft-order.d.ts:5
docs/content/references/js-client/enums/internal.FulfillmentStatus.md
+19 -19
View File
@@ -6,92 +6,92 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).FulfillmentStatus
## Enumeration members
## Enumeration Members
### CANCELED
• **CANCELED** = `"canceled"`
• **CANCELED** = ``"canceled"``
#### Defined in
packages/medusa/dist/models/order.d.ts:34
medusa/dist/models/order.d.ts:35
___
### FULFILLED
• **FULFILLED** = `"fulfilled"`
• **FULFILLED** = ``"fulfilled"``
#### Defined in
packages/medusa/dist/models/order.d.ts:29
medusa/dist/models/order.d.ts:30
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = `"not_fulfilled"`
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
packages/medusa/dist/models/order.d.ts:27
medusa/dist/models/order.d.ts:28
___
### PARTIALLY\_FULFILLED
• **PARTIALLY\_FULFILLED** = `"partially_fulfilled"`
• **PARTIALLY\_FULFILLED** = ``"partially_fulfilled"``
#### Defined in
packages/medusa/dist/models/order.d.ts:28
medusa/dist/models/order.d.ts:29
___
### PARTIALLY\_RETURNED
• **PARTIALLY\_RETURNED** = `"partially_returned"`
• **PARTIALLY\_RETURNED** = ``"partially_returned"``
#### Defined in
packages/medusa/dist/models/order.d.ts:32
medusa/dist/models/order.d.ts:33
___
### PARTIALLY\_SHIPPED
• **PARTIALLY\_SHIPPED** = `"partially_shipped"`
• **PARTIALLY\_SHIPPED** = ``"partially_shipped"``
#### Defined in
packages/medusa/dist/models/order.d.ts:30
medusa/dist/models/order.d.ts:31
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = `"requires_action"`
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
packages/medusa/dist/models/order.d.ts:35
medusa/dist/models/order.d.ts:36
___
### RETURNED
• **RETURNED** = `"returned"`
• **RETURNED** = ``"returned"``
#### Defined in
packages/medusa/dist/models/order.d.ts:33
medusa/dist/models/order.d.ts:34
___
### SHIPPED
• **SHIPPED** = `"shipped"`
• **SHIPPED** = ``"shipped"``
#### Defined in
packages/medusa/dist/models/order.d.ts:31
medusa/dist/models/order.d.ts:32
docs/content/references/js-client/enums/internal.OrderStatus.md
+11 -11
View File
@@ -6,52 +6,52 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).OrderStatus
## Enumeration members
## Enumeration Members
### ARCHIVED
• **ARCHIVED** = `"archived"`
• **ARCHIVED** = ``"archived"``
#### Defined in
packages/medusa/dist/models/order.d.ts:22
medusa/dist/models/order.d.ts:23
___
### CANCELED
• **CANCELED** = `"canceled"`
• **CANCELED** = ``"canceled"``
#### Defined in
packages/medusa/dist/models/order.d.ts:23
medusa/dist/models/order.d.ts:24
___
### COMPLETED
• **COMPLETED** = `"completed"`
• **COMPLETED** = ``"completed"``
#### Defined in
packages/medusa/dist/models/order.d.ts:21
medusa/dist/models/order.d.ts:22
___
### PENDING
• **PENDING** = `"pending"`
• **PENDING** = ``"pending"``
#### Defined in
packages/medusa/dist/models/order.d.ts:20
medusa/dist/models/order.d.ts:21
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = `"requires_action"`
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
packages/medusa/dist/models/order.d.ts:24
medusa/dist/models/order.d.ts:25
docs/content/references/js-client/enums/internal.PaymentStatus.md
+15 -15
View File
@@ -6,72 +6,72 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).PaymentStatus
## Enumeration members
## Enumeration Members
### AWAITING
• **AWAITING** = `"awaiting"`
• **AWAITING** = ``"awaiting"``
#### Defined in
packages/medusa/dist/models/order.d.ts:39
medusa/dist/models/order.d.ts:40
___
### CANCELED
• **CANCELED** = `"canceled"`
• **CANCELED** = ``"canceled"``
#### Defined in
packages/medusa/dist/models/order.d.ts:43
medusa/dist/models/order.d.ts:44
___
### CAPTURED
• **CAPTURED** = `"captured"`
• **CAPTURED** = ``"captured"``
#### Defined in
packages/medusa/dist/models/order.d.ts:40
medusa/dist/models/order.d.ts:41
___
### NOT\_PAID
• **NOT\_PAID** = `"not_paid"`
• **NOT\_PAID** = ``"not_paid"``
#### Defined in
packages/medusa/dist/models/order.d.ts:38
medusa/dist/models/order.d.ts:39
___
### PARTIALLY\_REFUNDED
• **PARTIALLY\_REFUNDED** = `"partially_refunded"`
• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
#### Defined in
packages/medusa/dist/models/order.d.ts:41
medusa/dist/models/order.d.ts:42
___
### REFUNDED
• **REFUNDED** = `"refunded"`
• **REFUNDED** = ``"refunded"``
#### Defined in
packages/medusa/dist/models/order.d.ts:42
medusa/dist/models/order.d.ts:43
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = `"requires_action"`
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
packages/medusa/dist/models/order.d.ts:44
medusa/dist/models/order.d.ts:45
docs/content/references/js-client/enums/internal.PriceListStatus.md
+5 -5
View File
@@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).PriceListStatus
## Enumeration members
## Enumeration Members
### ACTIVE
• **ACTIVE** = `"active"`
• **ACTIVE** = ``"active"``
#### Defined in
packages/medusa/dist/types/price-list.d.ts:8
medusa/dist/types/price-list.d.ts:8
___
### DRAFT
• **DRAFT** = `"draft"`
• **DRAFT** = ``"draft"``
#### Defined in
packages/medusa/dist/types/price-list.d.ts:9
medusa/dist/types/price-list.d.ts:9
docs/content/references/js-client/enums/internal.PriceListType.md
+5 -5
View File
@@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).PriceListType
## Enumeration members
## Enumeration Members
### OVERRIDE
• **OVERRIDE** = `"override"`
• **OVERRIDE** = ``"override"``
#### Defined in
packages/medusa/dist/types/price-list.d.ts:5
medusa/dist/types/price-list.d.ts:5
___
### SALE
• **SALE** = `"sale"`
• **SALE** = ``"sale"``
#### Defined in
packages/medusa/dist/types/price-list.d.ts:4
medusa/dist/types/price-list.d.ts:4
docs/content/references/js-client/enums/internal.ProductStatus.md
+9 -9
View File
@@ -6,42 +6,42 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).ProductStatus
## Enumeration members
## Enumeration Members
### DRAFT
• **DRAFT** = `"draft"`
• **DRAFT** = ``"draft"``
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:54
medusa/dist/models/product.d.ts:11
___
### PROPOSED
• **PROPOSED** = `"proposed"`
• **PROPOSED** = ``"proposed"``
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:55
medusa/dist/models/product.d.ts:12
___
### PUBLISHED
• **PUBLISHED** = `"published"`
• **PUBLISHED** = ``"published"``
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:56
medusa/dist/models/product.d.ts:13
___
### REJECTED
• **REJECTED** = `"rejected"`
• **REJECTED** = ``"rejected"``
#### Defined in
packages/medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:57
medusa/dist/models/product.d.ts:14
docs/content/references/js-client/enums/internal.RequirementType.md
+5 -5
View File
@@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).RequirementType
## Enumeration members
## Enumeration Members
### MAX\_SUBTOTAL
• **MAX\_SUBTOTAL** = `"max_subtotal"`
• **MAX\_SUBTOTAL** = ``"max_subtotal"``
#### Defined in
packages/medusa/dist/models/shipping-option-requirement.d.ts:4
medusa/dist/models/shipping-option-requirement.d.ts:4
___
### MIN\_SUBTOTAL
• **MIN\_SUBTOTAL** = `"min_subtotal"`
• **MIN\_SUBTOTAL** = ``"min_subtotal"``
#### Defined in
packages/medusa/dist/models/shipping-option-requirement.d.ts:3
medusa/dist/models/shipping-option-requirement.d.ts:3
docs/content/references/js-client/enums/internal.ReturnStatus.md
+9 -9
View File
@@ -6,42 +6,42 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).ReturnStatus
## Enumeration members
## Enumeration Members
### CANCELED
• **CANCELED** = `"canceled"`
• **CANCELED** = ``"canceled"``
#### Defined in
packages/medusa/dist/models/return.d.ts:11
medusa/dist/models/return.d.ts:11
___
### RECEIVED
• **RECEIVED** = `"received"`
• **RECEIVED** = ``"received"``
#### Defined in
packages/medusa/dist/models/return.d.ts:9
medusa/dist/models/return.d.ts:9
___
### REQUESTED
• **REQUESTED** = `"requested"`
• **REQUESTED** = ``"requested"``
#### Defined in
packages/medusa/dist/models/return.d.ts:8
medusa/dist/models/return.d.ts:8
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = `"requires_action"`
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
packages/medusa/dist/models/return.d.ts:10
medusa/dist/models/return.d.ts:10
docs/content/references/js-client/enums/internal.ShippingOptionPriceType.md
+5 -5
View File
@@ -6,22 +6,22 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).ShippingOptionPriceType
## Enumeration members
## Enumeration Members
### CALCULATED
• **CALCULATED** = `"calculated"`
• **CALCULATED** = ``"calculated"``
#### Defined in
packages/medusa/dist/models/shipping-option.d.ts:8
medusa/dist/models/shipping-option.d.ts:8
___
### FLAT\_RATE
• **FLAT\_RATE** = `"flat_rate"`
• **FLAT\_RATE** = ``"flat_rate"``
#### Defined in
packages/medusa/dist/models/shipping-option.d.ts:7
medusa/dist/models/shipping-option.d.ts:7
docs/content/references/js-client/enums/internal.ShippingProfileType.md
+7 -7
View File
@@ -6,32 +6,32 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).ShippingProfileType
## Enumeration members
## Enumeration Members
### CUSTOM
• **CUSTOM** = `"custom"`
• **CUSTOM** = ``"custom"``
#### Defined in
packages/medusa/dist/models/shipping-profile.d.ts:7
medusa/dist/models/shipping-profile.d.ts:7
___
### DEFAULT
• **DEFAULT** = `"default"`
• **DEFAULT** = ``"default"``
#### Defined in
packages/medusa/dist/models/shipping-profile.d.ts:5
medusa/dist/models/shipping-profile.d.ts:5
___
### GIFT\_CARD
• **GIFT\_CARD** = `"gift_card"`
• **GIFT\_CARD** = ``"gift_card"``
#### Defined in
packages/medusa/dist/models/shipping-profile.d.ts:6
medusa/dist/models/shipping-profile.d.ts:6
docs/content/references/js-client/enums/internal.Status.md
-47
View File
@@ -1,47 +0,0 @@
---
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
docs/content/references/js-client/enums/internal.SwapFulfillmentStatus.md
+11 -11
View File
@@ -6,52 +6,52 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).SwapFulfillmentStatus
## Enumeration members
## Enumeration Members
### CANCELED
• **CANCELED** = `"canceled"`
• **CANCELED** = ``"canceled"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:14
medusa/dist/models/swap.d.ts:14
___
### FULFILLED
• **FULFILLED** = `"fulfilled"`
• **FULFILLED** = ``"fulfilled"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:12
medusa/dist/models/swap.d.ts:12
___
### NOT\_FULFILLED
• **NOT\_FULFILLED** = `"not_fulfilled"`
• **NOT\_FULFILLED** = ``"not_fulfilled"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:11
medusa/dist/models/swap.d.ts:11
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = `"requires_action"`
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:15
medusa/dist/models/swap.d.ts:15
___
### SHIPPED
• **SHIPPED** = `"shipped"`
• **SHIPPED** = ``"shipped"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:13
medusa/dist/models/swap.d.ts:13
docs/content/references/js-client/enums/internal.SwapPaymentStatus.md
+19 -19
View File
@@ -6,92 +6,92 @@ displayed_sidebar: jsClientSidebar
[internal](../modules/internal.md).SwapPaymentStatus
## Enumeration members
## Enumeration Members
### AWAITING
• **AWAITING** = `"awaiting"`
• **AWAITING** = ``"awaiting"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:19
medusa/dist/models/swap.d.ts:19
___
### CANCELED
• **CANCELED** = `"canceled"`
• **CANCELED** = ``"canceled"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:22
medusa/dist/models/swap.d.ts:22
___
### CAPTURED
• **CAPTURED** = `"captured"`
• **CAPTURED** = ``"captured"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:20
medusa/dist/models/swap.d.ts:20
___
### CONFIRMED
• **CONFIRMED** = `"confirmed"`
• **CONFIRMED** = ``"confirmed"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:21
medusa/dist/models/swap.d.ts:21
___
### DIFFERENCE\_REFUNDED
• **DIFFERENCE\_REFUNDED** = `"difference_refunded"`
• **DIFFERENCE\_REFUNDED** = ``"difference_refunded"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:23
medusa/dist/models/swap.d.ts:23
___
### NOT\_PAID
• **NOT\_PAID** = `"not_paid"`
• **NOT\_PAID** = ``"not_paid"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:18
medusa/dist/models/swap.d.ts:18
___
### PARTIALLY\_REFUNDED
• **PARTIALLY\_REFUNDED** = `"partially_refunded"`
• **PARTIALLY\_REFUNDED** = ``"partially_refunded"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:24
medusa/dist/models/swap.d.ts:24
___
### REFUNDED
• **REFUNDED** = `"refunded"`
• **REFUNDED** = ``"refunded"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:25
medusa/dist/models/swap.d.ts:25
___
### REQUIRES\_ACTION
• **REQUIRES\_ACTION** = `"requires_action"`
• **REQUIRES\_ACTION** = ``"requires_action"``
#### Defined in
packages/medusa/dist/models/swap.d.ts:26
medusa/dist/models/swap.d.ts:26
docs/content/references/js-client/enums/internal.UserRoles.md
-37
View File
@@ -1,37 +0,0 @@
---
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