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

docs: updated js client reference (#2414)

Browse Source 
* docs: updated js client reference

* docs: fixed link
This commit is contained in:
Shahed Nasser
2022-10-11 16:32:41 +03:00
committed by GitHub
parent b3ebc78b95
commit 8ca9354c50
384 changed files with 5705 additions and 4184 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/references/js-client/modules/internal-10.md
+28 -18
View File
@@ -2,33 +2,43 @@
## Classes
- [AdminGetNotesParams](../classes/internal-10.AdminGetNotesParams.md)
- [AdminPostNotesNoteReq](../classes/internal-10.AdminPostNotesNoteReq.md)
- [AdminPostNotesReq](../classes/internal-10.AdminPostNotesReq.md)
- [Note](../classes/internal-10.Note.md)
- [AdminPostInvitesInviteAcceptReq](../classes/internal-10.AdminPostInvitesInviteAcceptReq.md)
- [AdminPostInvitesInviteAcceptUserReq](../classes/internal-10.AdminPostInvitesInviteAcceptUserReq.md)
- [AdminPostInvitesReq](../classes/internal-10.AdminPostInvitesReq.md)
- [Invite](../classes/internal-10.Invite.md)
## Type Aliases
### AdminNotesListRes
### AdminListInvitesRes
Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-10.Note.md)[] }
#### Defined in
medusa/dist/api/routes/admin/notes/index.d.ts:10
___
### AdminNotesRes
Ƭ **AdminNotesRes**: `Object`
Ƭ **AdminListInvitesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `note` | [`Note`](../classes/internal-10.Note.md) |
| `invites` | [`Invite`](../classes/internal-10.Invite.md)[] |
#### Defined in
medusa/dist/api/routes/admin/notes/index.d.ts:6
medusa/dist/api/routes/admin/invites/index.d.ts:8
___
### AdminPostInvitesPayload
Ƭ **AdminPostInvitesPayload**: `Omit`<[`AdminPostInvitesReq`](../classes/internal-10.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-10.md#inviteuserrolesenum) }
#### Defined in
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L47)
___
### InviteUserRolesEnum
Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\`
#### Defined in
[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L45)
docs/content/references/js-client/modules/internal-11.md
+11 -17
View File
@@ -2,39 +2,33 @@
## Classes
- [AdminGetNotificationsParams](../classes/internal-11.AdminGetNotificationsParams.md)
- [AdminPostNotificationsNotificationResendReq](../classes/internal-11.AdminPostNotificationsNotificationResendReq.md)
- [Notification](../classes/internal-11.Notification.md)
- [NotificationProvider](../classes/internal-11.NotificationProvider.md)
- [AdminGetNotesParams](../classes/internal-11.AdminGetNotesParams.md)
- [AdminPostNotesNoteReq](../classes/internal-11.AdminPostNotesNoteReq.md)
- [AdminPostNotesReq](../classes/internal-11.AdminPostNotesReq.md)
- [Note](../classes/internal-11.Note.md)
## Type Aliases
### AdminNotificationsListRes
### AdminNotesListRes
Ƭ **AdminNotificationsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `notifications` | [`Notification`](../classes/internal-11.Notification.md)[] |
Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-11.Note.md)[] }
#### Defined in
medusa/dist/api/routes/admin/notifications/index.d.ts:8
medusa/dist/api/routes/admin/notes/index.d.ts:10
___
### AdminNotificationsRes
### AdminNotesRes
Ƭ **AdminNotificationsRes**: `Object`
Ƭ **AdminNotesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `notification` | [`Notification`](../classes/internal-11.Notification.md) |
| `note` | [`Note`](../classes/internal-11.Note.md) |
#### Defined in
medusa/dist/api/routes/admin/notifications/index.d.ts:11
medusa/dist/api/routes/admin/notes/index.d.ts:6
docs/content/references/js-client/modules/internal-12.md
+24 -46
View File
@@ -2,61 +2,39 @@
## Classes
- [AdditionalItem](../classes/internal-12.AdditionalItem.md)
- [AdditionalItem](../classes/internal-12.AdditionalItem-1.md)
- [AdminGetOrdersParams](../classes/internal-12.AdminGetOrdersParams.md)
- [AdminListOrdersSelector](../classes/internal-12.AdminListOrdersSelector.md)
- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md)
- [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimReq.md)
- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-12.AdminPostOrdersOrderClaimsClaimShipmentsReq.md)
- [AdminPostOrdersOrderClaimsReq](../classes/internal-12.AdminPostOrdersOrderClaimsReq.md)
- [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderFulfillmentsReq.md)
- [AdminPostOrdersOrderRefundsReq](../classes/internal-12.AdminPostOrdersOrderRefundsReq.md)
- [AdminPostOrdersOrderReq](../classes/internal-12.AdminPostOrdersOrderReq.md)
- [AdminPostOrdersOrderReturnsReq](../classes/internal-12.AdminPostOrdersOrderReturnsReq.md)
- [AdminPostOrdersOrderShipmentReq](../classes/internal-12.AdminPostOrdersOrderShipmentReq.md)
- [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-12.AdminPostOrdersOrderShippingMethodsReq.md)
- [AdminPostOrdersOrderSwapsReq](../classes/internal-12.AdminPostOrdersOrderSwapsReq.md)
- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-12.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md)
- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-12.AdminPostOrdersOrderSwapsSwapShipmentsReq.md)
- [CustomShippingOption](../classes/internal-12.CustomShippingOption.md)
- [Image](../classes/internal-12.Image.md)
- [Item](../classes/internal-12.Item.md)
- [Item](../classes/internal-12.Item-1.md)
- [Item](../classes/internal-12.Item-2.md)
- [OrdersReturnItem](../classes/internal-12.OrdersReturnItem.md)
- [PaymentMethod](../classes/internal-12.PaymentMethod.md)
- [ReturnItem](../classes/internal-12.ReturnItem.md)
- [ReturnShipping](../classes/internal-12.ReturnShipping.md)
- [ReturnShipping](../classes/internal-12.ReturnShipping-1.md)
- [ReturnShipping](../classes/internal-12.ReturnShipping-2.md)
- [ShippingMethod](../classes/internal-12.ShippingMethod.md)
- [ShippingMethod](../classes/internal-12.ShippingMethod-1.md)
- [ShippingMethod](../classes/internal-12.ShippingMethod-2.md)
- [Tag](../classes/internal-12.Tag.md)
- [AdminGetNotificationsParams](../classes/internal-12.AdminGetNotificationsParams.md)
- [AdminPostNotificationsNotificationResendReq](../classes/internal-12.AdminPostNotificationsNotificationResendReq.md)
- [Notification](../classes/internal-12.Notification.md)
- [NotificationProvider](../classes/internal-12.NotificationProvider.md)
## Type Aliases
### AdminOrdersListRes
### AdminNotificationsListRes
Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] }
#### Defined in
medusa/dist/api/routes/admin/orders/index.d.ts:11
___
### AdminOrdersRes
Ƭ **AdminOrdersRes**: `Object`
Ƭ **AdminNotificationsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
| `notifications` | [`Notification`](../classes/internal-12.Notification.md)[] |
#### Defined in
medusa/dist/api/routes/admin/orders/index.d.ts:7
medusa/dist/api/routes/admin/notifications/index.d.ts:8
___
### AdminNotificationsRes
Ƭ **AdminNotificationsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `notification` | [`Notification`](../classes/internal-12.Notification.md) |
#### Defined in
medusa/dist/api/routes/admin/notifications/index.d.ts:11
docs/content/references/js-client/modules/internal-13.md
+13 -44
View File
@@ -1,73 +1,42 @@
# Namespace: internal
## Namespaces
- [&quot;/Users/shahednasser/medusa/packages/medusa/dist/types/global&quot;](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md)
## Classes
- [AdminDeletePriceListPricesPricesReq](../classes/internal-13.AdminDeletePriceListPricesPricesReq.md)
- [AdminGetPriceListPaginationParams](../classes/internal-13.AdminGetPriceListPaginationParams.md)
- [AdminGetPriceListsPriceListProductsParams](../classes/internal-13.AdminGetPriceListsPriceListProductsParams.md)
- [AdminPostPriceListPricesPricesReq](../classes/internal-13.AdminPostPriceListPricesPricesReq.md)
- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-13.AdminPostPriceListsPriceListPriceListReq.md)
- [AdminPostPriceListsPriceListReq](../classes/internal-13.AdminPostPriceListsPriceListReq.md)
- [AdminPriceListPricesCreateReq](../classes/internal-13.AdminPriceListPricesCreateReq.md)
- [AdminPriceListPricesUpdateReq](../classes/internal-13.AdminPriceListPricesUpdateReq.md)
- [CustomerGroup](../classes/internal-13.CustomerGroup.md)
- [CustomerGroup](../classes/internal-13.CustomerGroup-1.md)
- [FilterablePriceListProps](../classes/internal-13.FilterablePriceListProps.md)
- [AdminPostOrderEditsEditLineItemsLineItemReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md)
- [AdminPostOrderEditsEditLineItemsReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md)
- [AdminPostOrderEditsOrderEditReq](../classes/internal-13.AdminPostOrderEditsOrderEditReq.md)
- [AdminPostOrderEditsReq](../classes/internal-13.AdminPostOrderEditsReq.md)
## Type Aliases
### AdminPriceListDeleteBatchRes
### AdminOrderEditItemChangeDeleteRes
Ƭ **AdminPriceListDeleteBatchRes**: `Object`
Ƭ **AdminOrderEditItemChangeDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `ids` | `string`[] |
| `object` | `string` |
| `id` | `string` |
| `object` | ``"item_change"`` |
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:12
medusa/dist/api/routes/admin/order-edits/index.d.ts:9
___
### AdminPriceListRes
### AdminOrderEditsRes
Ƭ **AdminPriceListRes**: `Object`
Ƭ **AdminOrderEditsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `price_list` | [`PriceList`](../classes/internal.PriceList.md) |
| `order_edit` | [`OrderEdit`](../classes/internal.OrderEdit.md) |
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:9
___
### AdminPriceListsListRes
Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] }
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:20
## Variables
### AdminGetPriceListsPriceListProductsParams\_base
• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:143
medusa/dist/api/routes/admin/order-edits/index.d.ts:5
docs/content/references/js-client/modules/internal-14.md
+51 -5
View File
@@ -2,15 +2,61 @@
## Classes
- [AdminGetProductTagsPaginationParams](../classes/internal-14.AdminGetProductTagsPaginationParams.md)
- [AdminGetProductTagsParams](../classes/internal-14.AdminGetProductTagsParams.md)
- [AdditionalItem](../classes/internal-14.AdditionalItem.md)
- [AdditionalItem](../classes/internal-14.AdditionalItem-1.md)
- [AdminGetOrdersParams](../classes/internal-14.AdminGetOrdersParams.md)
- [AdminListOrdersSelector](../classes/internal-14.AdminListOrdersSelector.md)
- [AdminPostOrdersOrderClaimsClaimFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimFulfillmentsReq.md)
- [AdminPostOrdersOrderClaimsClaimReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimReq.md)
- [AdminPostOrdersOrderClaimsClaimShipmentsReq](../classes/internal-14.AdminPostOrdersOrderClaimsClaimShipmentsReq.md)
- [AdminPostOrdersOrderClaimsReq](../classes/internal-14.AdminPostOrdersOrderClaimsReq.md)
- [AdminPostOrdersOrderFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderFulfillmentsReq.md)
- [AdminPostOrdersOrderRefundsReq](../classes/internal-14.AdminPostOrdersOrderRefundsReq.md)
- [AdminPostOrdersOrderReq](../classes/internal-14.AdminPostOrdersOrderReq.md)
- [AdminPostOrdersOrderReturnsReq](../classes/internal-14.AdminPostOrdersOrderReturnsReq.md)
- [AdminPostOrdersOrderShipmentReq](../classes/internal-14.AdminPostOrdersOrderShipmentReq.md)
- [AdminPostOrdersOrderShippingMethodsReq](../classes/internal-14.AdminPostOrdersOrderShippingMethodsReq.md)
- [AdminPostOrdersOrderSwapsReq](../classes/internal-14.AdminPostOrdersOrderSwapsReq.md)
- [AdminPostOrdersOrderSwapsSwapFulfillmentsReq](../classes/internal-14.AdminPostOrdersOrderSwapsSwapFulfillmentsReq.md)
- [AdminPostOrdersOrderSwapsSwapShipmentsReq](../classes/internal-14.AdminPostOrdersOrderSwapsSwapShipmentsReq.md)
- [CustomShippingOption](../classes/internal-14.CustomShippingOption.md)
- [Image](../classes/internal-14.Image.md)
- [Item](../classes/internal-14.Item.md)
- [Item](../classes/internal-14.Item-1.md)
- [Item](../classes/internal-14.Item-2.md)
- [OrdersReturnItem](../classes/internal-14.OrdersReturnItem.md)
- [PaymentMethod](../classes/internal-14.PaymentMethod.md)
- [ReturnItem](../classes/internal-14.ReturnItem.md)
- [ReturnShipping](../classes/internal-14.ReturnShipping.md)
- [ReturnShipping](../classes/internal-14.ReturnShipping-1.md)
- [ReturnShipping](../classes/internal-14.ReturnShipping-2.md)
- [ShippingMethod](../classes/internal-14.ShippingMethod.md)
- [ShippingMethod](../classes/internal-14.ShippingMethod-1.md)
- [ShippingMethod](../classes/internal-14.ShippingMethod-2.md)
- [Tag](../classes/internal-14.Tag.md)
## Type Aliases
### AdminProductTagsListRes
### AdminOrdersListRes
Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] }
Ƭ **AdminOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] }
#### Defined in
medusa/dist/api/routes/admin/product-tags/index.d.ts:9
medusa/dist/api/routes/admin/orders/index.d.ts:11
___
### AdminOrdersRes
Ƭ **AdminOrdersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/admin/orders/index.d.ts:7
docs/content/references/js-client/modules/internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md → docs/content/references/js-client/modules/internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md
+2 -2
View File
@@ -1,6 +1,6 @@
# Namespace: "/Users/shahednasser/medusa/packages/medusa/dist/types/global"
[internal](internal-13.md)."/Users/shahednasser/medusa/packages/medusa/dist/types/global"
[internal](internal-15.md)."/Users/shahednasser/medusa/packages/medusa/dist/types/global"
## Type Aliases
@@ -76,7 +76,7 @@ ___
### MedusaContainer
Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: <T\>(`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md#medusacontainer) }
Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: <T\>(`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md#medusacontainer) }
#### Defined in
docs/content/references/js-client/modules/internal-15.md
+62 -5
View File
@@ -1,16 +1,73 @@
# 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
- [AdminGetProductTypesPaginationParams](../classes/internal-15.AdminGetProductTypesPaginationParams.md)
- [AdminGetProductTypesParams](../classes/internal-15.AdminGetProductTypesParams.md)
- [AdminDeletePriceListPricesPricesReq](../classes/internal-15.AdminDeletePriceListPricesPricesReq.md)
- [AdminGetPriceListPaginationParams](../classes/internal-15.AdminGetPriceListPaginationParams.md)
- [AdminGetPriceListsPriceListProductsParams](../classes/internal-15.AdminGetPriceListsPriceListProductsParams.md)
- [AdminPostPriceListPricesPricesReq](../classes/internal-15.AdminPostPriceListPricesPricesReq.md)
- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-15.AdminPostPriceListsPriceListPriceListReq.md)
- [AdminPostPriceListsPriceListReq](../classes/internal-15.AdminPostPriceListsPriceListReq.md)
- [AdminPriceListPricesCreateReq](../classes/internal-15.AdminPriceListPricesCreateReq.md)
- [AdminPriceListPricesUpdateReq](../classes/internal-15.AdminPriceListPricesUpdateReq.md)
- [CustomerGroup](../classes/internal-15.CustomerGroup.md)
- [CustomerGroup](../classes/internal-15.CustomerGroup-1.md)
- [FilterablePriceListProps](../classes/internal-15.FilterablePriceListProps.md)
## Type Aliases
### AdminProductTypesListRes
### AdminPriceListDeleteBatchRes
Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
Ƭ **AdminPriceListDeleteBatchRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `ids` | `string`[] |
| `object` | `string` |
#### Defined in
medusa/dist/api/routes/admin/product-types/index.d.ts:9
medusa/dist/api/routes/admin/price-lists/index.d.ts:13
___
### AdminPriceListRes
Ƭ **AdminPriceListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `price_list` | [`PriceList`](../classes/internal.PriceList.md) |
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:10
___
### AdminPriceListsListRes
Ƭ **AdminPriceListsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `price_lists`: [`PriceList`](../classes/internal.PriceList.md)[] }
#### Defined in
medusa/dist/api/routes/admin/price-lists/index.d.ts:21
## Variables
### AdminGetPriceListsPriceListProductsParams\_base
• `Const` **AdminGetPriceListsPriceListProductsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:174
docs/content/references/js-client/modules/internal-16.md
+5 -200
View File
@@ -2,210 +2,15 @@
## Classes
- [AdminGetProductsParams](../classes/internal-16.AdminGetProductsParams.md)
- [AdminPostProductsProductMetadataReq](../classes/internal-16.AdminPostProductsProductMetadataReq.md)
- [AdminPostProductsProductOptionsOption](../classes/internal-16.AdminPostProductsProductOptionsOption.md)
- [AdminPostProductsProductOptionsReq](../classes/internal-16.AdminPostProductsProductOptionsReq.md)
- [AdminPostProductsProductReq](../classes/internal-16.AdminPostProductsProductReq.md)
- [AdminPostProductsProductVariantsReq](../classes/internal-16.AdminPostProductsProductVariantsReq.md)
- [AdminPostProductsProductVariantsVariantReq](../classes/internal-16.AdminPostProductsProductVariantsVariantReq.md)
- [AdminPostProductsReq](../classes/internal-16.AdminPostProductsReq.md)
- [FilterableProductProps](../classes/internal-16.FilterableProductProps.md)
- [ProductOptionReq](../classes/internal-16.ProductOptionReq.md)
- [ProductSalesChannelReq](../classes/internal-16.ProductSalesChannelReq.md)
- [ProductTagReq](../classes/internal-16.ProductTagReq.md)
- [ProductTypeReq](../classes/internal-16.ProductTypeReq.md)
- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq.md)
- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-1.md)
- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-2.md)
- [ProductVariantOptionReq](../classes/internal-16.ProductVariantOptionReq-3.md)
- [ProductVariantPricesCreateReq](../classes/internal-16.ProductVariantPricesCreateReq.md)
- [ProductVariantPricesUpdateReq](../classes/internal-16.ProductVariantPricesUpdateReq.md)
- [ProductVariantReq](../classes/internal-16.ProductVariantReq.md)
- [ProductVariantReq](../classes/internal-16.ProductVariantReq-1.md)
- [AdminGetProductTagsPaginationParams](../classes/internal-16.AdminGetProductTagsPaginationParams.md)
- [AdminGetProductTagsParams](../classes/internal-16.AdminGetProductTagsParams.md)
## Type Aliases
### AdminProductsDeleteOptionRes
### AdminProductTagsListRes
Ƭ **AdminProductsDeleteOptionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `object` | ``"option"`` |
| `option_id` | `string` |
| `product` | [`Product`](../classes/internal.Product.md) |
Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] }
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:13
___
### AdminProductsDeleteRes
Ƭ **AdminProductsDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `id` | `string` |
| `object` | ``"product"`` |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:25
___
### AdminProductsDeleteVariantRes
Ƭ **AdminProductsDeleteVariantRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `object` | ``"product-variant"`` |
| `product` | [`Product`](../classes/internal.Product.md) |
| `variant_id` | `string` |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:19
___
### AdminProductsListRes
Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-16.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] }
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:30
___
### AdminProductsListTagsRes
Ƭ **AdminProductsListTagsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:36
___
### AdminProductsListTypesRes
Ƭ **AdminProductsListTypesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `types` | [`ProductType`](../classes/internal.ProductType.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:33
___
### AdminProductsRes
Ƭ **AdminProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:39
___
### PricedProduct
Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-16.md#pricedvariant)[] }
#### Defined in
medusa/dist/types/pricing.d.ts:28
___
### PricedVariant
Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-16.md#productvariantpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:27
___
### ProductVariantPricing
Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-16.md#taxedpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:4
___
### TaxServiceRate
Ƭ **TaxServiceRate**: `Object`
The tax rate object as configured in Medusa. These may have an unspecified
numerical rate as they may be used for lookup purposes in the tax provider
plugin.
#### Type declaration
| Name | Type |
| :------ | :------ |
| `code` | `string` \| ``null`` |
| `name` | `string` |
| `rate?` | `number` \| ``null`` |
#### Defined in
medusa/dist/types/tax-service.d.ts:6
___
### TaxedPricing
Ƭ **TaxedPricing**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `calculated_price_incl_tax` | `number` \| ``null`` |
| `calculated_tax` | `number` \| ``null`` |
| `original_price_incl_tax` | `number` \| ``null`` |
| `original_tax` | `number` \| ``null`` |
| `tax_rates` | [`TaxServiceRate`](internal-16.md#taxservicerate)[] \| ``null`` |
#### Defined in
medusa/dist/types/pricing.d.ts:10
medusa/dist/api/routes/admin/product-tags/index.d.ts:9
docs/content/references/js-client/modules/internal-17.md
+5 -13
View File
@@ -2,23 +2,15 @@
## Classes
- [AdminGetRegionsPaginationParams](../classes/internal-17.AdminGetRegionsPaginationParams.md)
- [AdminGetRegionsParams](../classes/internal-17.AdminGetRegionsParams.md)
- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-17.AdminGetRegionsRegionFulfillmentOptionsRes.md)
- [AdminPostRegionsRegionCountriesReq](../classes/internal-17.AdminPostRegionsRegionCountriesReq.md)
- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-17.AdminPostRegionsRegionFulfillmentProvidersReq.md)
- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-17.AdminPostRegionsRegionPaymentProvidersReq.md)
- [AdminPostRegionsRegionReq](../classes/internal-17.AdminPostRegionsRegionReq.md)
- [AdminPostRegionsReq](../classes/internal-17.AdminPostRegionsReq.md)
- [AdminRegionsRes](../classes/internal-17.AdminRegionsRes.md)
- [FulfillmentOption](../classes/internal-17.FulfillmentOption.md)
- [AdminGetProductTypesPaginationParams](../classes/internal-17.AdminGetProductTypesPaginationParams.md)
- [AdminGetProductTypesParams](../classes/internal-17.AdminGetProductTypesParams.md)
## Type Aliases
### AdminRegionsListRes
### AdminProductTypesListRes
Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] }
Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
#### Defined in
medusa/dist/api/routes/admin/regions/index.d.ts:11
medusa/dist/api/routes/admin/product-types/index.d.ts:9
docs/content/references/js-client/modules/internal-18.md
+183 -10
View File
@@ -2,37 +2,210 @@
## Classes
- [AdminPostReturnReasonsReasonReq](../classes/internal-18.AdminPostReturnReasonsReasonReq.md)
- [AdminPostReturnReasonsReq](../classes/internal-18.AdminPostReturnReasonsReq.md)
- [AdminGetProductsParams](../classes/internal-18.AdminGetProductsParams.md)
- [AdminPostProductsProductMetadataReq](../classes/internal-18.AdminPostProductsProductMetadataReq.md)
- [AdminPostProductsProductOptionsOption](../classes/internal-18.AdminPostProductsProductOptionsOption.md)
- [AdminPostProductsProductOptionsReq](../classes/internal-18.AdminPostProductsProductOptionsReq.md)
- [AdminPostProductsProductReq](../classes/internal-18.AdminPostProductsProductReq.md)
- [AdminPostProductsProductVariantsReq](../classes/internal-18.AdminPostProductsProductVariantsReq.md)
- [AdminPostProductsProductVariantsVariantReq](../classes/internal-18.AdminPostProductsProductVariantsVariantReq.md)
- [AdminPostProductsReq](../classes/internal-18.AdminPostProductsReq.md)
- [FilterableProductProps](../classes/internal-18.FilterableProductProps.md)
- [ProductOptionReq](../classes/internal-18.ProductOptionReq.md)
- [ProductSalesChannelReq](../classes/internal-18.ProductSalesChannelReq.md)
- [ProductTagReq](../classes/internal-18.ProductTagReq.md)
- [ProductTypeReq](../classes/internal-18.ProductTypeReq.md)
- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq.md)
- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-1.md)
- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-2.md)
- [ProductVariantOptionReq](../classes/internal-18.ProductVariantOptionReq-3.md)
- [ProductVariantPricesCreateReq](../classes/internal-18.ProductVariantPricesCreateReq.md)
- [ProductVariantPricesUpdateReq](../classes/internal-18.ProductVariantPricesUpdateReq.md)
- [ProductVariantReq](../classes/internal-18.ProductVariantReq.md)
- [ProductVariantReq](../classes/internal-18.ProductVariantReq-1.md)
## Type Aliases
### AdminReturnReasonsListRes
### AdminProductsDeleteOptionRes
Ƭ **AdminReturnReasonsListRes**: `Object`
Ƭ **AdminProductsDeleteOptionRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
| `deleted` | `boolean` |
| `object` | ``"option"`` |
| `option_id` | `string` |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/admin/return-reasons/index.d.ts:10
medusa/dist/api/routes/admin/products/index.d.ts:13
___
### AdminReturnReasonsRes
### AdminProductsDeleteRes
Ƭ **AdminReturnReasonsRes**: `Object`
Ƭ **AdminProductsDeleteRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
| `deleted` | `boolean` |
| `id` | `string` |
| `object` | ``"product"`` |
#### Defined in
medusa/dist/api/routes/admin/return-reasons/index.d.ts:7
medusa/dist/api/routes/admin/products/index.d.ts:25
___
### AdminProductsDeleteVariantRes
Ƭ **AdminProductsDeleteVariantRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `deleted` | `boolean` |
| `object` | ``"product-variant"`` |
| `product` | [`Product`](../classes/internal.Product.md) |
| `variant_id` | `string` |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:19
___
### AdminProductsListRes
Ƭ **AdminProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: ([`PricedProduct`](internal-18.md#pricedproduct) \| [`Product`](../classes/internal.Product.md))[] }
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:30
___
### AdminProductsListTagsRes
Ƭ **AdminProductsListTagsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tags` | [`ProductTag`](../classes/internal.ProductTag.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:36
___
### AdminProductsListTypesRes
Ƭ **AdminProductsListTypesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `types` | [`ProductType`](../classes/internal.ProductType.md)[] |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:33
___
### AdminProductsRes
Ƭ **AdminProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/admin/products/index.d.ts:39
___
### PricedProduct
Ƭ **PricedProduct**: `Omit`<`Partial`<[`Product`](../classes/internal.Product.md)\>, ``"variants"``\> & { `variants`: [`PricedVariant`](internal-18.md#pricedvariant)[] }
#### Defined in
medusa/dist/types/pricing.d.ts:31
___
### PricedVariant
Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-18.md#productvariantpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:30
___
### ProductVariantPricing
Ƭ **ProductVariantPricing**: { `calculated_price`: `number` \| ``null`` ; `calculated_price_includes_tax?`: `boolean` \| ``null`` ; `calculated_price_type?`: `string` \| ``null`` ; `original_price`: `number` \| ``null`` ; `original_price_includes_tax?`: `boolean` \| ``null`` ; `prices`: [`MoneyAmount`](../classes/internal.MoneyAmount.md)[] } & [`TaxedPricing`](internal-18.md#taxedpricing)
#### Defined in
medusa/dist/types/pricing.d.ts:4
___
### TaxServiceRate
Ƭ **TaxServiceRate**: `Object`
The tax rate object as configured in Medusa. These may have an unspecified
numerical rate as they may be used for lookup purposes in the tax provider
plugin.
#### Type declaration
| Name | Type |
| :------ | :------ |
| `code` | `string` \| ``null`` |
| `name` | `string` |
| `rate?` | `number` \| ``null`` |
#### Defined in
medusa/dist/types/tax-service.d.ts:6
___
### TaxedPricing
Ƭ **TaxedPricing**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `calculated_price_incl_tax` | `number` \| ``null`` |
| `calculated_tax` | `number` \| ``null`` |
| `original_price_incl_tax` | `number` \| ``null`` |
| `original_tax` | `number` \| ``null`` |
| `tax_rates` | [`TaxServiceRate`](internal-18.md#taxservicerate)[] \| ``null`` |
#### Defined in
medusa/dist/types/pricing.d.ts:12
docs/content/references/js-client/modules/internal-19.md
+13 -38
View File
@@ -2,48 +2,23 @@
## Classes
- [AdminGetReturnsParams](../classes/internal-19.AdminGetReturnsParams.md)
- [AdminPostReturnsReturnReceiveReq](../classes/internal-19.AdminPostReturnsReturnReceiveReq.md)
- [Item](../classes/internal-19.Item.md)
- [AdminGetRegionsPaginationParams](../classes/internal-19.AdminGetRegionsPaginationParams.md)
- [AdminGetRegionsParams](../classes/internal-19.AdminGetRegionsParams.md)
- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-19.AdminGetRegionsRegionFulfillmentOptionsRes.md)
- [AdminPostRegionsRegionCountriesReq](../classes/internal-19.AdminPostRegionsRegionCountriesReq.md)
- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-19.AdminPostRegionsRegionFulfillmentProvidersReq.md)
- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-19.AdminPostRegionsRegionPaymentProvidersReq.md)
- [AdminPostRegionsRegionReq](../classes/internal-19.AdminPostRegionsRegionReq.md)
- [AdminPostRegionsReq](../classes/internal-19.AdminPostRegionsReq.md)
- [AdminRegionsRes](../classes/internal-19.AdminRegionsRes.md)
- [FulfillmentOption](../classes/internal-19.FulfillmentOption.md)
## Type Aliases
### AdminReturnsCancelRes
### AdminRegionsListRes
Ƭ **AdminReturnsCancelRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] }
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:6
___
### AdminReturnsListRes
Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] }
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:9
___
### AdminReturnsRes
Ƭ **AdminReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:12
medusa/dist/api/routes/admin/regions/index.d.ts:12
docs/content/references/js-client/modules/internal-2.md
+1 -1
View File
@@ -93,4 +93,4 @@ ___
#### Defined in
medusa/dist/types/common.d.ts:59
medusa/dist/types/common.d.ts:60
docs/content/references/js-client/modules/internal-20.md
+16 -24
View File
@@ -2,45 +2,37 @@
## Classes
- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-20.AdminDeleteSalesChannelsChannelProductsBatchReq.md)
- [AdminGetSalesChannelsParams](../classes/internal-20.AdminGetSalesChannelsParams.md)
- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-20.AdminPostSalesChannelsChannelProductsBatchReq.md)
- [AdminPostSalesChannelsReq](../classes/internal-20.AdminPostSalesChannelsReq.md)
- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-20.AdminPostSalesChannelsSalesChannelReq.md)
- [ProductBatchSalesChannel](../classes/internal-20.ProductBatchSalesChannel.md)
- [AdminPostReturnReasonsReasonReq](../classes/internal-20.AdminPostReturnReasonsReasonReq.md)
- [AdminPostReturnReasonsReq](../classes/internal-20.AdminPostReturnReasonsReq.md)
## Type Aliases
### AdminSalesChannelsListRes
### AdminReturnReasonsListRes
Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] }
#### Defined in
medusa/dist/api/routes/admin/sales-channels/index.d.ts:10
___
### AdminSalesChannelsRes
Ƭ **AdminSalesChannelsRes**: `Object`
Ƭ **AdminReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
#### Defined in
medusa/dist/api/routes/admin/sales-channels/index.d.ts:6
medusa/dist/api/routes/admin/return-reasons/index.d.ts:10
## Variables
___
### AdminGetSalesChannelsParams\_base
### AdminReturnReasonsRes
• `Const` **AdminGetSalesChannelsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-13.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md)
Ƭ **AdminReturnReasonsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
#### Defined in
medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:110
medusa/dist/api/routes/admin/return-reasons/index.d.ts:7
docs/content/references/js-client/modules/internal-21.md
+33 -19
View File
@@ -2,34 +2,48 @@
## Classes
- [AdminGetShippingOptionsParams](../classes/internal-21.AdminGetShippingOptionsParams.md)
- [AdminPostShippingOptionsOptionReq](../classes/internal-21.AdminPostShippingOptionsOptionReq.md)
- [AdminPostShippingOptionsReq](../classes/internal-21.AdminPostShippingOptionsReq.md)
- [OptionRequirement](../classes/internal-21.OptionRequirement.md)
- [OptionRequirement](../classes/internal-21.OptionRequirement-1.md)
- [AdminGetReturnsParams](../classes/internal-21.AdminGetReturnsParams.md)
- [AdminPostReturnsReturnReceiveReq](../classes/internal-21.AdminPostReturnsReturnReceiveReq.md)
- [Item](../classes/internal-21.Item.md)
## Type Aliases
### AdminShippingOptionsListRes
### AdminReturnsCancelRes
Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] }
#### Defined in
medusa/dist/api/routes/admin/shipping-options/index.d.ts:7
___
### AdminShippingOptionsRes
Ƭ **AdminShippingOptionsRes**: `Object`
Ƭ **AdminReturnsCancelRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/admin/shipping-options/index.d.ts:10
medusa/dist/api/routes/admin/returns/index.d.ts:6
___
### AdminReturnsListRes
Ƭ **AdminReturnsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `returns`: [`Return`](../classes/internal.Return.md)[] }
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:9
___
### AdminReturnsRes
Ƭ **AdminReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/admin/returns/index.d.ts:12
docs/content/references/js-client/modules/internal-22.md
+23 -15
View File
@@ -2,37 +2,45 @@
## Classes
- [AdminPostShippingProfilesProfileReq](../classes/internal-22.AdminPostShippingProfilesProfileReq.md)
- [AdminPostShippingProfilesReq](../classes/internal-22.AdminPostShippingProfilesReq.md)
- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-22.AdminDeleteSalesChannelsChannelProductsBatchReq.md)
- [AdminGetSalesChannelsParams](../classes/internal-22.AdminGetSalesChannelsParams.md)
- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-22.AdminPostSalesChannelsChannelProductsBatchReq.md)
- [AdminPostSalesChannelsReq](../classes/internal-22.AdminPostSalesChannelsReq.md)
- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-22.AdminPostSalesChannelsSalesChannelReq.md)
- [ProductBatchSalesChannel](../classes/internal-22.ProductBatchSalesChannel.md)
## Type Aliases
### AdminShippingProfilesListRes
### AdminSalesChannelsListRes
Ƭ **AdminShippingProfilesListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] |
Ƭ **AdminSalesChannelsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `sales_channels`: [`SalesChannel`](../classes/internal.SalesChannel.md)[] }
#### Defined in
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12
medusa/dist/api/routes/admin/sales-channels/index.d.ts:10
___
### AdminShippingProfilesRes
### AdminSalesChannelsRes
Ƭ **AdminShippingProfilesRes**: `Object`
Ƭ **AdminSalesChannelsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) |
| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) |
#### Defined in
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9
medusa/dist/api/routes/admin/sales-channels/index.d.ts:6
## Variables
### AdminGetSalesChannelsParams\_base
• `Const` **AdminGetSalesChannelsParams\_base**: [`"/Users/shahednasser/medusa/packages/medusa/dist/types/global"`](internal-15.__Users_shahednasser_medusa_packages_medusa_dist_types_global_.md)
#### Defined in
medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:141
docs/content/references/js-client/modules/internal-23.md
+12 -31
View File
@@ -2,53 +2,34 @@
## Classes
- [AdminPostStoreReq](../classes/internal-23.AdminPostStoreReq.md)
- [Store](../classes/internal-23.Store.md)
- [AdminGetShippingOptionsParams](../classes/internal-23.AdminGetShippingOptionsParams.md)
- [AdminPostShippingOptionsOptionReq](../classes/internal-23.AdminPostShippingOptionsOptionReq.md)
- [AdminPostShippingOptionsReq](../classes/internal-23.AdminPostShippingOptionsReq.md)
- [OptionRequirement](../classes/internal-23.OptionRequirement.md)
- [OptionRequirement](../classes/internal-23.OptionRequirement-1.md)
## Type Aliases
### AdminPaymentProvidersList
### AdminShippingOptionsListRes
Ƭ **AdminPaymentProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] |
Ƭ **AdminShippingOptionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `shipping_options`: [`ShippingOption`](../classes/internal.ShippingOption.md)[] }
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:10
medusa/dist/api/routes/admin/shipping-options/index.d.ts:8
___
### AdminStoresRes
### AdminShippingOptionsRes
Ƭ **AdminStoresRes**: `Object`
Ƭ **AdminShippingOptionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `store` | [`Store`](../classes/internal-23.Store.md) |
| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:4
___
### AdminTaxProvidersList
Ƭ **AdminTaxProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:7
medusa/dist/api/routes/admin/shipping-options/index.d.ts:11
docs/content/references/js-client/modules/internal-24.md
+22 -15
View File
@@ -2,30 +2,37 @@
## Classes
- [AdminGetSwapsParams](../classes/internal-24.AdminGetSwapsParams.md)
- [AdminPostShippingProfilesProfileReq](../classes/internal-24.AdminPostShippingProfilesProfileReq.md)
- [AdminPostShippingProfilesReq](../classes/internal-24.AdminPostShippingProfilesReq.md)
## Type Aliases
### AdminSwapsListRes
### AdminShippingProfilesListRes
Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] }
#### Defined in
medusa/dist/api/routes/admin/swaps/index.d.ts:7
___
### AdminSwapsRes
Ƭ **AdminSwapsRes**: `Object`
Ƭ **AdminShippingProfilesListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] |
#### Defined in
medusa/dist/api/routes/admin/swaps/index.d.ts:10
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:12
___
### AdminShippingProfilesRes
Ƭ **AdminShippingProfilesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_profile` | [`ShippingProfile`](../classes/internal.ShippingProfile.md) |
#### Defined in
medusa/dist/api/routes/admin/shipping-profiles/index.d.ts:9
docs/content/references/js-client/modules/internal-25.md
+38 -28
View File
@@ -2,43 +2,53 @@
## Classes
- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesParams.md)
- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductTypesReq.md)
- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductsParams.md)
- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateProductsReq.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-25.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md)
- [AdminGetTaxRatesParams](../classes/internal-25.AdminGetTaxRatesParams.md)
- [AdminGetTaxRatesTaxRateParams](../classes/internal-25.AdminGetTaxRatesTaxRateParams.md)
- [AdminPostTaxRatesReq](../classes/internal-25.AdminPostTaxRatesReq.md)
- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-25.AdminPostTaxRatesTaxRateProductTypesReq.md)
- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-25.AdminPostTaxRatesTaxRateProductsReq.md)
- [AdminPostTaxRatesTaxRateReq](../classes/internal-25.AdminPostTaxRatesTaxRateReq.md)
- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-25.AdminPostTaxRatesTaxRateShippingOptionsReq.md)
- [NumericalComparisonOperator](../classes/internal-25.NumericalComparisonOperator.md)
- [AdminPostStoreReq](../classes/internal-25.AdminPostStoreReq.md)
- [Store](../classes/internal-25.Store.md)
## Type Aliases
### AdminTaxRatesListRes
### AdminPaymentProvidersList
Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] }
#### Defined in
medusa/dist/api/routes/admin/tax-rates/index.d.ts:8
___
### AdminTaxRatesRes
Ƭ **AdminTaxRatesRes**: `Object`
Ƭ **AdminPaymentProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) |
| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] |
#### Defined in
medusa/dist/api/routes/admin/tax-rates/index.d.ts:11
medusa/dist/api/routes/admin/store/index.d.ts:10
___
### AdminStoresRes
Ƭ **AdminStoresRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `store` | [`Store`](../classes/internal-25.Store.md) |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:4
___
### AdminTaxProvidersList
Ƭ **AdminTaxProvidersList**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `tax_providers` | [`TaxProvider`](../classes/internal.TaxProvider.md)[] |
#### Defined in
medusa/dist/api/routes/admin/store/index.d.ts:7
docs/content/references/js-client/modules/internal-26.md
+8 -16
View File
@@ -2,38 +2,30 @@
## Classes
- [AdminDeleteUploadsReq](../classes/internal-26.AdminDeleteUploadsReq.md)
- [AdminPostUploadsDownloadUrlReq](../classes/internal-26.AdminPostUploadsDownloadUrlReq.md)
- [IAdminPostUploadsFileReq](../classes/internal-26.IAdminPostUploadsFileReq.md)
- [AdminGetSwapsParams](../classes/internal-26.AdminGetSwapsParams.md)
## Type Aliases
### AdminUploadsDownloadUrlRes
### AdminSwapsListRes
Ƭ **AdminUploadsDownloadUrlRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `download_url` | `string` |
Ƭ **AdminSwapsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `swaps`: [`Swap`](../classes/internal.Swap.md)[] }
#### Defined in
medusa/dist/api/routes/admin/uploads/index.d.ts:10
medusa/dist/api/routes/admin/swaps/index.d.ts:7
___
### AdminUploadsRes
### AdminSwapsRes
Ƭ **AdminUploadsRes**: `Object`
Ƭ **AdminSwapsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `uploads` | { `url`: `string` }[] |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
#### Defined in
medusa/dist/api/routes/admin/uploads/index.d.ts:4
medusa/dist/api/routes/admin/swaps/index.d.ts:10
docs/content/references/js-client/modules/internal-27.md
+21 -93
View File
@@ -2,115 +2,43 @@
## Classes
- [AdminCreateUserRequest](../classes/internal-27.AdminCreateUserRequest.md)
- [AdminResetPasswordRequest](../classes/internal-27.AdminResetPasswordRequest.md)
- [AdminResetPasswordTokenRequest](../classes/internal-27.AdminResetPasswordTokenRequest.md)
- [AdminUpdateUserRequest](../classes/internal-27.AdminUpdateUserRequest.md)
- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesParams.md)
- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductTypesReq.md)
- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductsParams.md)
- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateProductsReq.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md)
- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-27.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md)
- [AdminGetTaxRatesParams](../classes/internal-27.AdminGetTaxRatesParams.md)
- [AdminGetTaxRatesTaxRateParams](../classes/internal-27.AdminGetTaxRatesTaxRateParams.md)
- [AdminPostTaxRatesReq](../classes/internal-27.AdminPostTaxRatesReq.md)
- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-27.AdminPostTaxRatesTaxRateProductTypesReq.md)
- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-27.AdminPostTaxRatesTaxRateProductsReq.md)
- [AdminPostTaxRatesTaxRateReq](../classes/internal-27.AdminPostTaxRatesTaxRateReq.md)
- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-27.AdminPostTaxRatesTaxRateShippingOptionsReq.md)
- [NumericalComparisonOperator](../classes/internal-27.NumericalComparisonOperator.md)
## Type Aliases
### AdminCreateUserPayload
### AdminTaxRatesListRes
Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-27.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-27.md#createuserroles) }
Ƭ **AdminTaxRatesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `tax_rates`: [`TaxRate`](../classes/internal.TaxRate.md)[] }
#### Defined in
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L31)
medusa/dist/api/routes/admin/tax-rates/index.d.ts:8
___
### AdminUpdateUserPayload
### AdminTaxRatesRes
Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-27.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-27.md#updateuserroles) }
#### Defined in
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L41)
___
### AdminUserRes
Ƭ **AdminUserRes**: `Object`
Ƭ **AdminTaxRatesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:6
___
### AdminUsersListRes
Ƭ **AdminUsersListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:9
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L28)
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-27.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-27.AdminCreateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L25)
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L23)
___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L39)
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-27.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-27.AdminUpdateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L37)
medusa/dist/api/routes/admin/tax-rates/index.d.ts:11
docs/content/references/js-client/modules/internal-28.md
+28 -4
View File
@@ -2,14 +2,38 @@
## Classes
- [AdminGetVariantsParams](../classes/internal-28.AdminGetVariantsParams.md)
- [AdminDeleteUploadsReq](../classes/internal-28.AdminDeleteUploadsReq.md)
- [AdminPostUploadsDownloadUrlReq](../classes/internal-28.AdminPostUploadsDownloadUrlReq.md)
- [IAdminPostUploadsFileReq](../classes/internal-28.IAdminPostUploadsFileReq.md)
## Type Aliases
### AdminVariantsListRes
### AdminUploadsDownloadUrlRes
Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
Ƭ **AdminUploadsDownloadUrlRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `download_url` | `string` |
#### Defined in
medusa/dist/api/routes/admin/variants/index.d.ts:9
medusa/dist/api/routes/admin/uploads/index.d.ts:10
___
### AdminUploadsRes
Ƭ **AdminUploadsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `uploads` | { `url`: `string` }[] |
#### Defined in
medusa/dist/api/routes/admin/uploads/index.d.ts:4
docs/content/references/js-client/modules/internal-29.md
+93 -14
View File
@@ -2,36 +2,115 @@
## Classes
- [StorePostAuthReq](../classes/internal-29.StorePostAuthReq.md)
- [AdminCreateUserRequest](../classes/internal-29.AdminCreateUserRequest.md)
- [AdminResetPasswordRequest](../classes/internal-29.AdminResetPasswordRequest.md)
- [AdminResetPasswordTokenRequest](../classes/internal-29.AdminResetPasswordTokenRequest.md)
- [AdminUpdateUserRequest](../classes/internal-29.AdminUpdateUserRequest.md)
## Type Aliases
### StoreAuthRes
### AdminCreateUserPayload
Ƭ **StoreAuthRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-29.md#createuserroles) }
#### Defined in
medusa/dist/api/routes/store/auth/index.d.ts:4
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L31)
___
### StoreGetAuthEmailRes
### AdminUpdateUserPayload
Ƭ **StoreGetAuthEmailRes**: `Object`
Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-29.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-29.md#updateuserroles) }
#### Defined in
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L41)
___
### AdminUserRes
Ƭ **AdminUserRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `exists` | `boolean` |
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
#### Defined in
medusa/dist/api/routes/store/auth/index.d.ts:7
medusa/dist/api/routes/admin/users/index.d.ts:6
___
### AdminUsersListRes
Ƭ **AdminUsersListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] |
#### Defined in
medusa/dist/api/routes/admin/users/index.d.ts:9
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L28)
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-29.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L25)
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L23)
___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
#### Defined in
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L39)
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-29.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-29.AdminUpdateUserRequest.md)[``"role"``]\>
#### Defined in
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L37)
docs/content/references/js-client/modules/internal-3.md
+1 -1
View File
@@ -51,4 +51,4 @@ ___
#### Defined in
medusa/dist/types/common.d.ts:64
medusa/dist/types/common.d.ts:65
docs/content/references/js-client/modules/internal-30.md
+4 -27
View File
@@ -2,37 +2,14 @@
## Classes
- [Discount](../classes/internal-30.Discount.md)
- [GiftCard](../classes/internal-30.GiftCard.md)
- [Item](../classes/internal-30.Item.md)
- [StorePostCartReq](../classes/internal-30.StorePostCartReq.md)
- [StorePostCartsCartPaymentSessionReq](../classes/internal-30.StorePostCartsCartPaymentSessionReq.md)
- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-30.StorePostCartsCartPaymentSessionUpdateReq.md)
- [StorePostCartsCartReq](../classes/internal-30.StorePostCartsCartReq.md)
- [StorePostCartsCartShippingMethodReq](../classes/internal-30.StorePostCartsCartShippingMethodReq.md)
- [AdminGetVariantsParams](../classes/internal-30.AdminGetVariantsParams.md)
## Type Aliases
### StoreCartsRes
### AdminVariantsListRes
Ƭ **StoreCartsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> |
Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
#### Defined in
medusa/dist/api/routes/store/carts/index.d.ts:8
___
### StoreCompleteCartRes
Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` }
#### Defined in
medusa/dist/api/routes/store/carts/index.d.ts:11
medusa/dist/api/routes/admin/variants/index.d.ts:9
docs/content/references/js-client/modules/internal-31.md
+21 -15
View File
@@ -2,30 +2,36 @@
## Classes
- [StoreGetCollectionsParams](../classes/internal-31.StoreGetCollectionsParams.md)
- [StorePostAuthReq](../classes/internal-31.StorePostAuthReq.md)
## Type Aliases
### StoreCollectionsListRes
### StoreAuthRes
Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] }
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:7
___
### StoreCollectionsRes
Ƭ **StoreCollectionsRes**: `Object`
Ƭ **StoreAuthRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:10
medusa/dist/api/routes/store/auth/index.d.ts:4
___
### StoreGetAuthEmailRes
Ƭ **StoreGetAuthEmailRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `exists` | `boolean` |
#### Defined in
medusa/dist/api/routes/store/auth/index.d.ts:7
docs/content/references/js-client/modules/internal-32.md
+27 -8
View File
@@ -2,18 +2,37 @@
## Classes
- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-32.StoreGetCustomersCustomerOrdersPaginationParams.md)
- [StoreGetCustomersCustomerOrdersParams](../classes/internal-32.StoreGetCustomersCustomerOrdersParams.md)
- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-32.StorePostCustomersCustomerPasswordTokenReq.md)
- [StorePostCustomersCustomerReq](../classes/internal-32.StorePostCustomersCustomerReq.md)
- [StorePostCustomersReq](../classes/internal-32.StorePostCustomersReq.md)
- [Discount](../classes/internal-32.Discount.md)
- [GiftCard](../classes/internal-32.GiftCard.md)
- [Item](../classes/internal-32.Item.md)
- [StorePostCartReq](../classes/internal-32.StorePostCartReq.md)
- [StorePostCartsCartPaymentSessionReq](../classes/internal-32.StorePostCartsCartPaymentSessionReq.md)
- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-32.StorePostCartsCartPaymentSessionUpdateReq.md)
- [StorePostCartsCartReq](../classes/internal-32.StorePostCartsCartReq.md)
- [StorePostCartsCartShippingMethodReq](../classes/internal-32.StorePostCartsCartShippingMethodReq.md)
## Type Aliases
### StoreCustomersListOrdersRes
### StoreCartsRes
Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] }
Ƭ **StoreCartsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> |
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:12
medusa/dist/api/routes/store/carts/index.d.ts:8
___
### StoreCompleteCartRes
Ƭ **StoreCompleteCartRes**: { `data`: [`Cart`](../classes/internal.Cart.md) ; `type`: ``"cart"`` } \| { `data`: [`Order`](../classes/internal.Order.md) ; `type`: ``"order"`` } \| { `data`: [`Swap`](../classes/internal.Swap.md) ; `type`: ``"swap"`` }
#### Defined in
medusa/dist/api/routes/store/carts/index.d.ts:11
docs/content/references/js-client/modules/internal-33.md
+18 -4
View File
@@ -1,17 +1,31 @@
# Namespace: internal
## Classes
- [StoreGetCollectionsParams](../classes/internal-33.StoreGetCollectionsParams.md)
## Type Aliases
### StoreGiftCardsRes
### StoreCollectionsListRes
Ƭ **StoreGiftCardsRes**: `Object`
Ƭ **StoreCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] }
#### Defined in
medusa/dist/api/routes/store/collections/index.d.ts:7
___
### StoreCollectionsRes
Ƭ **StoreCollectionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) |
#### Defined in
medusa/dist/api/routes/store/gift-cards/index.d.ts:8
medusa/dist/api/routes/store/collections/index.d.ts:10
docs/content/references/js-client/modules/internal-34.md
+16 -2
View File
@@ -2,5 +2,19 @@
## Classes
- [StorePostCartsCartLineItemsItemReq](../classes/internal-34.StorePostCartsCartLineItemsItemReq.md)
- [StorePostCartsCartLineItemsReq](../classes/internal-34.StorePostCartsCartLineItemsReq.md)
- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-34.StoreGetCustomersCustomerOrdersPaginationParams.md)
- [StoreGetCustomersCustomerOrdersParams](../classes/internal-34.StoreGetCustomersCustomerOrdersParams.md)
- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-34.StorePostCustomersCustomerPasswordTokenReq.md)
- [StorePostCustomersCustomerReq](../classes/internal-34.StorePostCustomersCustomerReq.md)
- [StorePostCustomersReq](../classes/internal-34.StorePostCustomersReq.md)
- [StorePostCustomersResetPasswordReq](../classes/internal-34.StorePostCustomersResetPasswordReq.md)
## Type Aliases
### StoreCustomersListOrdersRes
Ƭ **StoreCustomersListOrdersRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `orders`: [`Order`](../classes/internal.Order.md)[] }
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:12
docs/content/references/js-client/modules/internal-35.md
+4 -9
View File
@@ -1,22 +1,17 @@
# Namespace: internal
## Classes
- [ShippingAddressPayload](../classes/internal-35.ShippingAddressPayload.md)
- [StoreGetOrdersParams](../classes/internal-35.StoreGetOrdersParams.md)
## Type Aliases
### StoreOrdersRes
### StoreGiftCardsRes
Ƭ **StoreOrdersRes**: `Object`
Ƭ **StoreGiftCardsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
#### Defined in
medusa/dist/api/routes/store/orders/index.d.ts:9
medusa/dist/api/routes/store/gift-cards/index.d.ts:8
docs/content/references/js-client/modules/internal-36.md
+3 -14
View File
@@ -1,17 +1,6 @@
# Namespace: internal
## Type Aliases
## Classes
### StoreCustomersListPaymentMethodsRes
Ƭ **StoreCustomersListPaymentMethodsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] |
#### Defined in
medusa/dist/api/routes/store/customers/index.d.ts:15
- [StorePostCartsCartLineItemsItemReq](../classes/internal-36.StorePostCartsCartLineItemsItemReq.md)
- [StorePostCartsCartLineItemsReq](../classes/internal-36.StorePostCartsCartLineItemsReq.md)
docs/content/references/js-client/modules/internal-37.md
+5 -16
View File
@@ -2,31 +2,20 @@
## Classes
- [PriceSelectionParams](../classes/internal-37.PriceSelectionParams.md)
- [StoreGetVariantsParams](../classes/internal-37.StoreGetVariantsParams.md)
- [StorePostOrderEditsOrderEditDecline](../classes/internal-37.StorePostOrderEditsOrderEditDecline.md)
## Type Aliases
### StoreVariantsListRes
### StoreOrderEditsRes
Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:9
___
### StoreVariantsRes
Ƭ **StoreVariantsRes**: `Object`
Ƭ **StoreOrderEditsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) |
| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> |
#### Defined in
medusa/dist/api/routes/store/variants/index.d.ts:6
medusa/dist/api/routes/store/order-edits/index.d.ts:4
docs/content/references/js-client/modules/internal-38.md
+6 -37
View File
@@ -2,52 +2,21 @@
## Classes
- [StoreGetProductsPaginationParams](../classes/internal-38.StoreGetProductsPaginationParams.md)
- [StoreGetProductsParams](../classes/internal-38.StoreGetProductsParams.md)
- [StorePostSearchReq](../classes/internal-38.StorePostSearchReq.md)
- [ShippingAddressPayload](../classes/internal-38.ShippingAddressPayload.md)
- [StoreGetOrdersParams](../classes/internal-38.StoreGetOrdersParams.md)
## Type Aliases
### StorePostSearchRes
### StoreOrdersRes
Ƭ **StorePostSearchRes**: `Object`
#### Index signature
▪ [k: `string`]: `unknown`
Ƭ **StoreOrdersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `hits` | `unknown`[] |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:12
___
### StoreProductsListRes
Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] }
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:16
___
### StoreProductsRes
Ƭ **StoreProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:9
medusa/dist/api/routes/store/orders/index.d.ts:9
docs/content/references/js-client/modules/internal-39.md
+4 -20
View File
@@ -2,32 +2,16 @@
## Type Aliases
### StoreRegionsListRes
### StoreCustomersListPaymentMethodsRes
Ƭ **StoreRegionsListRes**: `Object`
Ƭ **StoreCustomersListPaymentMethodsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `regions` | [`Region`](../classes/internal.Region.md)[] |
| `payment_methods` | { `data`: `object` ; `provider_id`: `string` }[] |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:4
___
### StoreRegionsRes
Ƭ **StoreRegionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `region` | [`Region`](../classes/internal.Region.md) |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:7
medusa/dist/api/routes/store/customers/index.d.ts:15
docs/content/references/js-client/modules/internal-4.md
+10 -29
View File
@@ -2,51 +2,32 @@
## Classes
- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-4.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md)
- [AdminGetCustomerGroupsGroupParams](../classes/internal-4.AdminGetCustomerGroupsGroupParams.md)
- [AdminGetCustomerGroupsParams](../classes/internal-4.AdminGetCustomerGroupsParams.md)
- [AdminGetCustomersParams](../classes/internal-4.AdminGetCustomersParams.md)
- [AdminListCustomerSelector](../classes/internal-4.AdminListCustomerSelector.md)
- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-4.AdminPostCustomerGroupsGroupCustomersBatchReq.md)
- [AdminPostCustomerGroupsGroupReq](../classes/internal-4.AdminPostCustomerGroupsGroupReq.md)
- [AdminPostCustomerGroupsReq](../classes/internal-4.AdminPostCustomerGroupsReq.md)
- [CustomerGroupsBatchCustomer](../classes/internal-4.CustomerGroupsBatchCustomer.md)
- [FilterableCustomerGroupProps](../classes/internal-4.FilterableCustomerGroupProps.md)
- [FindParams](../classes/internal-4.FindParams.md)
- [StringComparisonOperator](../classes/internal-4.StringComparisonOperator.md)
- [AdminGetCurrenciesParams](../classes/internal-4.AdminGetCurrenciesParams.md)
- [AdminPostCurrenciesCurrencyReq](../classes/internal-4.AdminPostCurrenciesCurrencyReq.md)
- [FindPaginationParams](../classes/internal-4.FindPaginationParams.md)
## Type Aliases
### AdminCustomerGroupsListRes
### AdminCurrenciesListRes
Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal.CustomerGroup.md)[] }
Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `currencies`: [`Currency`](../classes/internal.Currency.md)[] }
#### Defined in
medusa/dist/api/routes/admin/customer-groups/index.d.ts:9
medusa/dist/api/routes/admin/currencies/index.d.ts:5
___
### AdminCustomerGroupsRes
### AdminCurrenciesRes
Ƭ **AdminCustomerGroupsRes**: `Object`
Ƭ **AdminCurrenciesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer_group` | [`CustomerGroup`](../classes/internal.CustomerGroup.md) |
| `currency` | [`Currency`](../classes/internal.Currency.md) |
#### Defined in
medusa/dist/api/routes/admin/customer-groups/index.d.ts:5
___
### AdminCustomersListRes
Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal.Customer.md)[] }
#### Defined in
medusa/dist/api/routes/admin/customers/index.d.ts:9
medusa/dist/api/routes/admin/currencies/index.d.ts:8
docs/content/references/js-client/modules/internal-40.md
+12 -13
View File
@@ -1,33 +1,32 @@
# Namespace: internal
## Classes
- [PriceSelectionParams](../classes/internal-40.PriceSelectionParams.md)
- [StoreGetVariantsParams](../classes/internal-40.StoreGetVariantsParams.md)
## Type Aliases
### StoreReturnReasonsListRes
### StoreVariantsListRes
Ƭ **StoreReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
Ƭ **StoreVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`ProductVariant`](../classes/internal.ProductVariant.md)[] }
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:6
medusa/dist/api/routes/store/variants/index.d.ts:9
___
### StoreReturnReasonsRes
### StoreVariantsRes
Ƭ **StoreReturnReasonsRes**: `Object`
Ƭ **StoreVariantsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:9
medusa/dist/api/routes/store/variants/index.d.ts:6
docs/content/references/js-client/modules/internal-41.md
+37 -7
View File
@@ -2,22 +2,52 @@
## Classes
- [Item](../classes/internal-41.Item.md)
- [ReturnShipping](../classes/internal-41.ReturnShipping.md)
- [StorePostReturnsReq](../classes/internal-41.StorePostReturnsReq.md)
- [StoreGetProductsPaginationParams](../classes/internal-41.StoreGetProductsPaginationParams.md)
- [StoreGetProductsParams](../classes/internal-41.StoreGetProductsParams.md)
- [StorePostSearchReq](../classes/internal-41.StorePostSearchReq.md)
## Type Aliases
### StoreReturnsRes
### StorePostSearchRes
Ƭ **StoreReturnsRes**: `Object`
Ƭ **StorePostSearchRes**: `Object`
#### Index signature
▪ [k: `string`]: `unknown`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
| `hits` | `unknown`[] |
#### Defined in
medusa/dist/api/routes/store/returns/index.d.ts:4
medusa/dist/api/routes/store/products/index.d.ts:12
___
### StoreProductsListRes
Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] }
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:16
___
### StoreProductsRes
Ƭ **StoreProductsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `product` | [`Product`](../classes/internal.Product.md) |
#### Defined in
medusa/dist/api/routes/store/products/index.d.ts:9
docs/content/references/js-client/modules/internal-42.md
+20 -8
View File
@@ -1,21 +1,33 @@
# Namespace: internal
## Classes
- [StoreGetShippingOptionsParams](../classes/internal-42.StoreGetShippingOptionsParams.md)
## Type Aliases
### StoreShippingOptionsListRes
### StoreRegionsListRes
Ƭ **StoreShippingOptionsListRes**: `Object`
Ƭ **StoreRegionsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] |
| `regions` | [`Region`](../classes/internal.Region.md)[] |
#### Defined in
medusa/dist/api/routes/store/shipping-options/index.d.ts:4
medusa/dist/api/routes/store/regions/index.d.ts:4
___
### StoreRegionsRes
Ƭ **StoreRegionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `region` | [`Region`](../classes/internal.Region.md) |
#### Defined in
medusa/dist/api/routes/store/regions/index.d.ts:7
docs/content/references/js-client/modules/internal-43.md
+20 -10
View File
@@ -1,23 +1,33 @@
# Namespace: internal
## Classes
- [AdditionalItem](../classes/internal-43.AdditionalItem.md)
- [Item](../classes/internal-43.Item.md)
- [StorePostSwapsReq](../classes/internal-43.StorePostSwapsReq.md)
## Type Aliases
### StoreSwapsRes
### StoreReturnReasonsListRes
Ƭ **StoreSwapsRes**: `Object`
Ƭ **StoreReturnReasonsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
#### Defined in
medusa/dist/api/routes/store/swaps/index.d.ts:6
medusa/dist/api/routes/store/return-reasons/index.d.ts:6
___
### StoreReturnReasonsRes
Ƭ **StoreReturnReasonsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
#### Defined in
medusa/dist/api/routes/store/return-reasons/index.d.ts:9
docs/content/references/js-client/modules/internal-44.md
+23
View File
@@ -0,0 +1,23 @@
# Namespace: internal
## Classes
- [Item](../classes/internal-44.Item.md)
- [ReturnShipping](../classes/internal-44.ReturnShipping.md)
- [StorePostReturnsReq](../classes/internal-44.StorePostReturnsReq.md)
## Type Aliases
### StoreReturnsRes
Ƭ **StoreReturnsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `return` | [`Return`](../classes/internal.Return.md) |
#### Defined in
medusa/dist/api/routes/store/returns/index.d.ts:4
docs/content/references/js-client/modules/internal-45.md
+21
View File
@@ -0,0 +1,21 @@
# Namespace: internal
## Classes
- [StoreGetShippingOptionsParams](../classes/internal-45.StoreGetShippingOptionsParams.md)
## Type Aliases
### StoreShippingOptionsListRes
Ƭ **StoreShippingOptionsListRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `shipping_options` | [`ShippingOption`](../classes/internal.ShippingOption.md)[] |
#### Defined in
medusa/dist/api/routes/store/shipping-options/index.d.ts:4
docs/content/references/js-client/modules/internal-46.md
+23
View File
@@ -0,0 +1,23 @@
# Namespace: internal
## Classes
- [AdditionalItem](../classes/internal-46.AdditionalItem.md)
- [Item](../classes/internal-46.Item.md)
- [StorePostSwapsReq](../classes/internal-46.StorePostSwapsReq.md)
## Type Aliases
### StoreSwapsRes
Ƭ **StoreSwapsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `swap` | [`Swap`](../classes/internal.Swap.md) |
#### Defined in
medusa/dist/api/routes/store/swaps/index.d.ts:7
docs/content/references/js-client/modules/internal-5.md
+36 -7
View File
@@ -2,22 +2,51 @@
## Classes
- [AdminPostCustomersCustomerReq](../classes/internal-5.AdminPostCustomersCustomerReq.md)
- [AdminPostCustomersReq](../classes/internal-5.AdminPostCustomersReq.md)
- [Group](../classes/internal-5.Group.md)
- [AdminDeleteCustomerGroupsGroupCustomerBatchReq](../classes/internal-5.AdminDeleteCustomerGroupsGroupCustomerBatchReq.md)
- [AdminGetCustomerGroupsGroupParams](../classes/internal-5.AdminGetCustomerGroupsGroupParams.md)
- [AdminGetCustomerGroupsParams](../classes/internal-5.AdminGetCustomerGroupsParams.md)
- [AdminGetCustomersParams](../classes/internal-5.AdminGetCustomersParams.md)
- [AdminListCustomerSelector](../classes/internal-5.AdminListCustomerSelector.md)
- [AdminPostCustomerGroupsGroupCustomersBatchReq](../classes/internal-5.AdminPostCustomerGroupsGroupCustomersBatchReq.md)
- [AdminPostCustomerGroupsGroupReq](../classes/internal-5.AdminPostCustomerGroupsGroupReq.md)
- [AdminPostCustomerGroupsReq](../classes/internal-5.AdminPostCustomerGroupsReq.md)
- [CustomerGroupsBatchCustomer](../classes/internal-5.CustomerGroupsBatchCustomer.md)
- [FilterableCustomerGroupProps](../classes/internal-5.FilterableCustomerGroupProps.md)
- [FindParams](../classes/internal-5.FindParams.md)
- [StringComparisonOperator](../classes/internal-5.StringComparisonOperator.md)
## Type Aliases
### AdminCustomersRes
### AdminCustomerGroupsListRes
Ƭ **AdminCustomersRes**: `Object`
Ƭ **AdminCustomerGroupsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customer_groups`: [`CustomerGroup`](../classes/internal.CustomerGroup.md)[] }
#### Defined in
medusa/dist/api/routes/admin/customer-groups/index.d.ts:9
___
### AdminCustomerGroupsRes
Ƭ **AdminCustomerGroupsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
| `customer_group` | [`CustomerGroup`](../classes/internal.CustomerGroup.md) |
#### Defined in
medusa/dist/api/routes/admin/customers/index.d.ts:5
medusa/dist/api/routes/admin/customer-groups/index.d.ts:5
___
### AdminCustomersListRes
Ƭ **AdminCustomersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `customers`: [`Customer`](../classes/internal.Customer.md)[] }
#### Defined in
medusa/dist/api/routes/admin/customers/index.d.ts:9
docs/content/references/js-client/modules/internal-6.md
+7 -45
View File
@@ -2,60 +2,22 @@
## Classes
- [AdminCreateCondition](../classes/internal-6.AdminCreateCondition.md)
- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-6.AdminGetDiscountsDiscountConditionsConditionParams.md)
- [AdminGetDiscountsDiscountRuleParams](../classes/internal-6.AdminGetDiscountsDiscountRuleParams.md)
- [AdminGetDiscountsParams](../classes/internal-6.AdminGetDiscountsParams.md)
- [AdminPostDiscountsDiscountConditions](../classes/internal-6.AdminPostDiscountsDiscountConditions.md)
- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-6.AdminPostDiscountsDiscountConditionsCondition.md)
- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-6.AdminPostDiscountsDiscountConditionsConditionParams.md)
- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-6.AdminPostDiscountsDiscountConditionsParams.md)
- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-6.AdminPostDiscountsDiscountDynamicCodesReq.md)
- [AdminPostDiscountsDiscountReq](../classes/internal-6.AdminPostDiscountsDiscountReq.md)
- [AdminPostDiscountsDiscountRule](../classes/internal-6.AdminPostDiscountsDiscountRule.md)
- [AdminPostDiscountsReq](../classes/internal-6.AdminPostDiscountsReq.md)
- [AdminUpdateDiscountRule](../classes/internal-6.AdminUpdateDiscountRule.md)
- [AdminUpsertCondition](../classes/internal-6.AdminUpsertCondition.md)
- [AdminUpsertConditionsReq](../classes/internal-6.AdminUpsertConditionsReq.md)
- [AdminPostCustomersCustomerReq](../classes/internal-6.AdminPostCustomersCustomerReq.md)
- [AdminPostCustomersReq](../classes/internal-6.AdminPostCustomersReq.md)
- [Group](../classes/internal-6.Group.md)
## Type Aliases
### AdminDiscountConditionsRes
### AdminCustomersRes
Ƭ **AdminDiscountConditionsRes**: `Object`
Ƭ **AdminCustomersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `discount_condition` | [`DiscountCondition`](../classes/internal.DiscountCondition.md) |
| `customer` | [`Customer`](../classes/internal.Customer.md) |
#### Defined in
medusa/dist/api/routes/admin/discounts/index.d.ts:14
___
### AdminDiscountsListRes
Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal.Discount.md)[] }
#### Defined in
medusa/dist/api/routes/admin/discounts/index.d.ts:18
___
### AdminDiscountsRes
Ƭ **AdminDiscountsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `discount` | [`Discount`](../classes/internal.Discount.md) |
#### Defined in
medusa/dist/api/routes/admin/discounts/index.d.ts:11
medusa/dist/api/routes/admin/customers/index.d.ts:5
docs/content/references/js-client/modules/internal-7.md
+33 -23
View File
@@ -2,50 +2,60 @@
## Classes
- [AdminGetDraftOrdersParams](../classes/internal-7.AdminGetDraftOrdersParams.md)
- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md)
- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderLineItemsReq.md)
- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-7.AdminPostDraftOrdersDraftOrderReq.md)
- [Discount](../classes/internal-7.Discount.md)
- [AdminCreateCondition](../classes/internal-7.AdminCreateCondition.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)
- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md)
- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md)
- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md)
- [AdminPostDiscountsDiscountReq](../classes/internal-7.AdminPostDiscountsDiscountReq.md)
- [AdminPostDiscountsDiscountRule](../classes/internal-7.AdminPostDiscountsDiscountRule.md)
- [AdminPostDiscountsReq](../classes/internal-7.AdminPostDiscountsReq.md)
- [AdminUpdateDiscountRule](../classes/internal-7.AdminUpdateDiscountRule.md)
- [AdminUpsertCondition](../classes/internal-7.AdminUpsertCondition.md)
- [AdminUpsertConditionsReq](../classes/internal-7.AdminUpsertConditionsReq.md)
## Type Aliases
### AdminDraftOrdersListRes
### AdminDiscountConditionsRes
Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/internal.DraftOrder.md)[] }
#### Defined in
medusa/dist/api/routes/admin/draft-orders/index.d.ts:18
___
### AdminDraftOrdersRes
Ƭ **AdminDraftOrdersRes**: `Object`
Ƭ **AdminDiscountConditionsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `draft_order` | [`DraftOrder`](../classes/internal.DraftOrder.md) |
| `discount_condition` | [`DiscountCondition`](../classes/internal.DiscountCondition.md) |
#### Defined in
medusa/dist/api/routes/admin/draft-orders/index.d.ts:14
medusa/dist/api/routes/admin/discounts/index.d.ts:14
___
### AdminPostDraftOrdersDraftOrderRegisterPaymentRes
### AdminDiscountsListRes
Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object`
Ƭ **AdminDiscountsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `discounts`: [`Discount`](../classes/internal.Discount.md)[] }
#### Defined in
medusa/dist/api/routes/admin/discounts/index.d.ts:18
___
### AdminDiscountsRes
Ƭ **AdminDiscountsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
| `discount` | [`Discount`](../classes/internal.Discount.md) |
#### Defined in
medusa/dist/api/routes/admin/draft-orders/index.d.ts:11
medusa/dist/api/routes/admin/discounts/index.d.ts:11
docs/content/references/js-client/modules/internal-8.md
+28 -10
View File
@@ -2,32 +2,50 @@
## Classes
- [AdminGetGiftCardsParams](../classes/internal-8.AdminGetGiftCardsParams.md)
- [AdminPostGiftCardsGiftCardReq](../classes/internal-8.AdminPostGiftCardsGiftCardReq.md)
- [AdminPostGiftCardsReq](../classes/internal-8.AdminPostGiftCardsReq.md)
- [AdminGetDraftOrdersParams](../classes/internal-8.AdminGetDraftOrdersParams.md)
- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md)
- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md)
- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md)
- [Discount](../classes/internal-8.Discount.md)
## Type Aliases
### AdminGiftCardsListRes
### AdminDraftOrdersListRes
Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal.GiftCard.md)[] }
Ƭ **AdminDraftOrdersListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `draft_orders`: [`DraftOrder`](../classes/internal.DraftOrder.md)[] }
#### Defined in
medusa/dist/api/routes/admin/gift-cards/index.d.ts:14
medusa/dist/api/routes/admin/draft-orders/index.d.ts:18
___
### AdminGiftCardsRes
### AdminDraftOrdersRes
Ƭ **AdminGiftCardsRes**: `Object`
Ƭ **AdminDraftOrdersRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
| `draft_order` | [`DraftOrder`](../classes/internal.DraftOrder.md) |
#### Defined in
medusa/dist/api/routes/admin/gift-cards/index.d.ts:10
medusa/dist/api/routes/admin/draft-orders/index.d.ts:14
___
### AdminPostDraftOrdersDraftOrderRegisterPaymentRes
Ƭ **AdminPostDraftOrdersDraftOrderRegisterPaymentRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `order` | [`Order`](../classes/internal.Order.md) |
#### Defined in
medusa/dist/api/routes/admin/draft-orders/index.d.ts:11
docs/content/references/js-client/modules/internal-9.md
+17 -28
View File
@@ -2,43 +2,32 @@
## Classes
- [AdminPostInvitesInviteAcceptReq](../classes/internal-9.AdminPostInvitesInviteAcceptReq.md)
- [AdminPostInvitesInviteAcceptUserReq](../classes/internal-9.AdminPostInvitesInviteAcceptUserReq.md)
- [AdminPostInvitesReq](../classes/internal-9.AdminPostInvitesReq.md)
- [Invite](../classes/internal-9.Invite.md)
- [AdminGetGiftCardsParams](../classes/internal-9.AdminGetGiftCardsParams.md)
- [AdminPostGiftCardsGiftCardReq](../classes/internal-9.AdminPostGiftCardsGiftCardReq.md)
- [AdminPostGiftCardsReq](../classes/internal-9.AdminPostGiftCardsReq.md)
## Type Aliases
### AdminListInvitesRes
### AdminGiftCardsListRes
Ƭ **AdminListInvitesRes**: `Object`
Ƭ **AdminGiftCardsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `gift_cards`: [`GiftCard`](../classes/internal.GiftCard.md)[] }
#### Defined in
medusa/dist/api/routes/admin/gift-cards/index.d.ts:14
___
### AdminGiftCardsRes
Ƭ **AdminGiftCardsRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `invites` | [`Invite`](../classes/internal-9.Invite.md)[] |
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
#### Defined in
medusa/dist/api/routes/admin/invites/index.d.ts:8
___
### AdminPostInvitesPayload
Ƭ **AdminPostInvitesPayload**: `Omit`<[`AdminPostInvitesReq`](../classes/internal-9.AdminPostInvitesReq.md), ``"role"``\> & { `role`: [`InviteUserRolesEnum`](internal-9.md#inviteuserrolesenum) }
#### Defined in
[medusa-js/src/typings.ts:47](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L47)
___
### InviteUserRolesEnum
Ƭ **InviteUserRolesEnum**: \`${AdminPostInvitesReq["role"]}\`
#### Defined in
[medusa-js/src/typings.ts:45](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L45)
medusa/dist/api/routes/admin/gift-cards/index.d.ts:10
docs/content/references/js-client/modules/internal.md
+7 -3
View File
@@ -17,6 +17,8 @@ displayed_sidebar: jsClientSidebar
- [DiscountRuleType](../enums/internal.DiscountRuleType.md)
- [DraftOrderStatus](../enums/internal.DraftOrderStatus.md)
- [FulfillmentStatus](../enums/internal.FulfillmentStatus.md)
- [OrderEditItemChangeType](../enums/internal.OrderEditItemChangeType.md)
- [OrderEditStatus](../enums/internal.OrderEditStatus.md)
- [OrderStatus](../enums/internal.OrderStatus.md)
- [PaymentStatus](../enums/internal.PaymentStatus.md)
- [PriceListStatus](../enums/internal.PriceListStatus.md)
@@ -61,6 +63,8 @@ displayed_sidebar: jsClientSidebar
- [LineItemTaxLine](../classes/internal.LineItemTaxLine.md)
- [MoneyAmount](../classes/internal.MoneyAmount.md)
- [Order](../classes/internal.Order.md)
- [OrderEdit](../classes/internal.OrderEdit.md)
- [OrderItemChange](../classes/internal.OrderItemChange.md)
- [Payment](../classes/internal.Payment.md)
- [PaymentProvider](../classes/internal.PaymentProvider.md)
- [PaymentSession](../classes/internal.PaymentSession.md)
@@ -153,7 +157,7 @@ ___
#### Defined in
[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/request.ts#L21)
[medusa-js/src/request.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/request.ts#L21)
___
@@ -169,7 +173,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L17)
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L17)
___
@@ -185,7 +189,7 @@ ___
#### Defined in
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/f7a63f178/packages/medusa-js/src/typings.ts#L21)
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L21)
___