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

chore(docs): Generated JS Client Reference (automated) (#2526)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-11-03 10:08:09 +02:00
committed by GitHub
parent 0b0d50b476
commit 3c6fe30ee7
123 changed files with 1946 additions and 601 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/content/references/js-client/modules/internal-10.md
View File

@@ -31,7 +31,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L47)
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L47)
___
@@ -41,4 +41,4 @@ ___
#### Defined in
[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L45)
[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L45)

24
docs/content/references/js-client/modules/internal-13.md
View File

@@ -6,6 +6,8 @@
- [AdminPostOrderEditsEditLineItemsReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md)
- [AdminPostOrderEditsOrderEditReq](../classes/internal-13.AdminPostOrderEditsOrderEditReq.md)
- [AdminPostOrderEditsReq](../classes/internal-13.AdminPostOrderEditsReq.md)
- [GetOrderEditsOrderEditParams](../classes/internal-13.GetOrderEditsOrderEditParams.md)
- [GetOrderEditsParams](../classes/internal-13.GetOrderEditsParams.md)
## Type Aliases
@@ -23,7 +25,17 @@
#### Defined in
medusa/dist/api/routes/admin/order-edits/index.d.ts:9
medusa/dist/api/routes/admin/order-edits/index.d.ts:12
___
### AdminOrderEditsListRes
Ƭ **AdminOrderEditsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/internal.OrderEdit.md)[] }
#### Defined in
medusa/dist/api/routes/admin/order-edits/index.d.ts:8
___
@@ -40,3 +52,13 @@ ___
#### Defined in
medusa/dist/api/routes/admin/order-edits/index.d.ts:5
## Variables
### GetOrderEditsParams\_base
• `Const` **GetOrderEditsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:61

6
docs/content/references/js-client/modules/internal-15.md
View File

@@ -1,9 +1,5 @@
# Namespace: internal
## Namespaces
- [&quot;/Users/shahednasser/medusa/packages/medusa/dist/types/global&quot;](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md)
## Classes
- [AdminDeletePriceListPricesPricesReq](../classes/internal-15.AdminDeletePriceListPricesPricesReq.md)
@@ -66,7 +62,7 @@ medusa/dist/api/routes/admin/price-lists/index.d.ts:21
### AdminGetPriceListsPriceListProductsParams\_base
• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md)
• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in

2
docs/content/references/js-client/modules/internal-22.md
View File

@@ -39,7 +39,7 @@ medusa/dist/api/routes/admin/sales-channels/index.d.ts:6
### AdminGetSalesChannelsParams\_base
• `Const` **AdminGetSalesChannelsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md)
• `Const` **AdminGetSalesChannelsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in

14
docs/content/references/js-client/modules/internal-29.md
View File

@@ -15,7 +15,7 @@
#### Defined in
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L31)
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L31)
___
@@ -25,7 +25,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L41)
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L41)
___
@@ -67,7 +67,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L28)
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L28)
___
@@ -77,7 +77,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L25)
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L25)
___
@@ -93,7 +93,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L23)
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L23)
___
@@ -103,7 +103,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L39)
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L39)
___
@@ -113,4 +113,4 @@ ___
#### Defined in
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L37)
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L37)

6
docs/content/references/js-client/modules/internal-30.md
View File

@@ -3,13 +3,15 @@
## Classes
- [AdminGetVariantsParams](../classes/internal-30.AdminGetVariantsParams.md)
- [AdminPriceSelectionParams](../classes/internal-30.AdminPriceSelectionParams.md)
- [PriceSelectionParams](../classes/internal-30.PriceSelectionParams.md)
## Type Aliases
### AdminVariantsListRes
Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-18.md#pricedvariant)[] }
#### Defined in
medusa/dist/api/routes/admin/variants/index.d.ts:9
medusa/dist/api/routes/admin/variants/index.d.ts:10

1
docs/content/references/js-client/modules/internal-40.md
View File

@@ -2,7 +2,6 @@
## Classes
- [PriceSelectionParams](../classes/internal-40.PriceSelectionParams.md)
- [StoreGetVariantsParams](../classes/internal-40.StoreGetVariantsParams.md)
## Type Aliases

6
docs/content/references/js-client/modules/internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md → docs/content/references/js-client/modules/internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md
View File

@@ -1,6 +1,6 @@
# Namespace: "/Users/shahednasser/medusa/packages/medusa/dist/types/global"
# Namespace: "/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"
[internal](internal-15.md)."/Users/shahednasser/medusa/packages/medusa/dist/types/global"
[internal](internal-7.md)."/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"
## Type Aliases
@@ -76,7 +76,7 @@ ___
### MedusaContainer
Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: <T\>(`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md#medusacontainer) }
Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: <T\>(`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#medusacontainer) }
#### Defined in

17
docs/content/references/js-client/modules/internal-7.md
View File

@@ -1,13 +1,20 @@
# Namespace: internal
## Namespaces
- [&quot;/home/runner/work/medusa/medusa/packages/medusa/dist/types/global&quot;](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
## Classes
- [AdminCreateCondition](../classes/internal-7.AdminCreateCondition.md)
- [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md)
- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md)
- [AdminGetDiscountsDiscountRuleParams](../classes/internal-7.AdminGetDiscountsDiscountRuleParams.md)
- [AdminGetDiscountsParams](../classes/internal-7.AdminGetDiscountsParams.md)
- [AdminPostDiscountsDiscountConditions](../classes/internal-7.AdminPostDiscountsDiscountConditions.md)
- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md)
- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md)
- [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md)
- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md)
- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md)
- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md)
@@ -59,3 +66,13 @@ ___
#### Defined in
medusa/dist/api/routes/admin/discounts/index.d.ts:11
## Variables
### AdminGetDiscountsParams\_base
• `Const` **AdminGetDiscountsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:86

4
docs/content/references/js-client/modules/internal-8.md
View File

@@ -6,7 +6,11 @@
- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md)
- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md)
- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md)
- [AdminPostDraftOrdersReq](../classes/internal-8.AdminPostDraftOrdersReq.md)
- [Discount](../classes/internal-8.Discount.md)
- [Discount](../classes/internal-8.Discount-1.md)
- [Item](../classes/internal-8.Item.md)
- [ShippingMethod](../classes/internal-8.ShippingMethod.md)
## Type Aliases

18
docs/content/references/js-client/modules/internal.md
View File

@@ -20,6 +20,7 @@ displayed_sidebar: jsClientSidebar
- [OrderEditItemChangeType](../enums/internal.OrderEditItemChangeType.md)
- [OrderEditStatus](../enums/internal.OrderEditStatus.md)
- [OrderStatus](../enums/internal.OrderStatus.md)
- [PaymentCollectionStatus](../enums/internal.PaymentCollectionStatus.md)
- [PaymentStatus](../enums/internal.PaymentStatus.md)
- [PriceListStatus](../enums/internal.PriceListStatus.md)
- [PriceListType](../enums/internal.PriceListType.md)
@@ -66,6 +67,7 @@ displayed_sidebar: jsClientSidebar
- [OrderEdit](../classes/internal.OrderEdit.md)
- [OrderItemChange](../classes/internal.OrderItemChange.md)
- [Payment](../classes/internal.Payment.md)
- [PaymentCollection](../classes/internal.PaymentCollection.md)
- [PaymentProvider](../classes/internal.PaymentProvider.md)
- [PaymentSession](../classes/internal.PaymentSession.md)
- [PriceList](../classes/internal.PriceList.md)
@@ -119,6 +121,16 @@ displayed_sidebar: jsClientSidebar
- [RetryConfig](../interfaces/internal.RetryConfig.md)
- [TransitionalOptions](../interfaces/internal.TransitionalOptions.md)
## Enumeration Members
### ORDER\_EDIT
• **ORDER\_EDIT**: ``"order_edit"``
#### Defined in
medusa/dist/models/payment-collection.d.ts:16
## Type Aliases
### AxiosRequestHeaders
@@ -157,7 +169,7 @@ ___
#### Defined in
[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L21)
[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/request.ts#L21)
___
@@ -173,7 +185,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L17)
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L17)
___
@@ -189,7 +201,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L21)
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/0b0d50b47/packages/medusa-js/src/typings.ts#L21)
___