docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [UserRoles](../enums/internal-1.UserRoles.md)
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminPostAuthReq](../classes/internal-1.AdminPostAuthReq.md)
|
||||
- [User](../classes/internal-1.User.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminAuthRes
|
||||
|
||||
Ƭ **AdminAuthRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/auth/index.d.ts:4
|
||||
@@ -0,0 +1,44 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [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
|
||||
|
||||
### AdminListInvitesRes
|
||||
|
||||
Ƭ **AdminListInvitesRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `invites` | [`Invite`](../classes/internal-10.Invite.md)[] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
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/29135c051/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/29135c051/packages/medusa-js/src/typings.ts#L45)
|
||||
@@ -0,0 +1,34 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [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
|
||||
|
||||
### AdminNotesListRes
|
||||
|
||||
Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-11.Note.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/index.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### AdminNotesRes
|
||||
|
||||
Ƭ **AdminNotesRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `note` | [`Note`](../classes/internal-11.Note.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/notes/index.d.ts:6
|
||||
@@ -0,0 +1,40 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [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
|
||||
|
||||
### AdminNotificationsListRes
|
||||
|
||||
Ƭ **AdminNotificationsListRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `notifications` | [`Notification`](../classes/internal-12.Notification.md)[] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
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
|
||||
@@ -0,0 +1,64 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminPostOrderEditsEditLineItemsLineItemReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsLineItemReq.md)
|
||||
- [AdminPostOrderEditsEditLineItemsReq](../classes/internal-13.AdminPostOrderEditsEditLineItemsReq.md)
|
||||
- [AdminPostOrderEditsOrderEditReq](../classes/internal-13.AdminPostOrderEditsOrderEditReq.md)
|
||||
- [AdminPostOrderEditsReq](../classes/internal-13.AdminPostOrderEditsReq.md)
|
||||
- [GetOrderEditsOrderEditParams](../classes/internal-13.GetOrderEditsOrderEditParams.md)
|
||||
- [GetOrderEditsParams](../classes/internal-13.GetOrderEditsParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminOrderEditItemChangeDeleteRes
|
||||
|
||||
Ƭ **AdminOrderEditItemChangeDeleteRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `deleted` | `boolean` |
|
||||
| `id` | `string` |
|
||||
| `object` | ``"item_change"`` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/order-edits/index.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### AdminOrderEditsListRes
|
||||
|
||||
Ƭ **AdminOrderEditsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `order_edits`: [`OrderEdit`](../classes/internal.OrderEdit.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/order-edits/index.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### AdminOrderEditsRes
|
||||
|
||||
Ƭ **AdminOrderEditsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `order_edit` | [`OrderEdit`](../classes/internal.OrderEdit.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/order-edits/index.d.ts:5
|
||||
|
||||
## Variables
|
||||
|
||||
### GetOrderEditsParams\_base
|
||||
|
||||
• `Const` **GetOrderEditsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/order-edits/list-order-edit.d.ts:71
|
||||
@@ -0,0 +1,62 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [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
|
||||
|
||||
### AdminOrdersListRes
|
||||
|
||||
Ƭ **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`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `order` | [`Order`](../classes/internal.Order.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/orders/index.d.ts:7
|
||||
@@ -0,0 +1,40 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminUpdatePaymentCollectionsReq](../classes/internal-15.AdminUpdatePaymentCollectionsReq.md)
|
||||
- [GetPaymentCollectionsParams](../classes/internal-15.GetPaymentCollectionsParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminPaymentCollectionDeleteRes
|
||||
|
||||
Ƭ **AdminPaymentCollectionDeleteRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `deleted` | `boolean` |
|
||||
| `id` | `string` |
|
||||
| `object` | ``"payment_collection"`` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/payment-collections/index.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### AdminPaymentCollectionsRes
|
||||
|
||||
Ƭ **AdminPaymentCollectionsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/payment-collections/index.d.ts:7
|
||||
@@ -0,0 +1,42 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [RefundReason](../enums/internal-16.RefundReason.md)
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminPostPaymentRefundsReq](../classes/internal-16.AdminPostPaymentRefundsReq.md)
|
||||
- [GetPaymentsParams](../classes/internal-16.GetPaymentsParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminPaymentRes
|
||||
|
||||
Ƭ **AdminPaymentRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payment` | [`Payment`](../classes/internal.Payment.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/payments/index.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### AdminRefundRes
|
||||
|
||||
Ƭ **AdminRefundRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `refund` | [`Refund`](../classes/internal.Refund.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/payments/index.d.ts:9
|
||||
@@ -0,0 +1,69 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminDeletePriceListPricesPricesReq](../classes/internal-17.AdminDeletePriceListPricesPricesReq.md)
|
||||
- [AdminGetPriceListPaginationParams](../classes/internal-17.AdminGetPriceListPaginationParams.md)
|
||||
- [AdminGetPriceListsPriceListProductsParams](../classes/internal-17.AdminGetPriceListsPriceListProductsParams.md)
|
||||
- [AdminPostPriceListPricesPricesReq](../classes/internal-17.AdminPostPriceListPricesPricesReq.md)
|
||||
- [AdminPostPriceListsPriceListPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListPriceListReq.md)
|
||||
- [AdminPostPriceListsPriceListReq](../classes/internal-17.AdminPostPriceListsPriceListReq.md)
|
||||
- [AdminPriceListPricesCreateReq](../classes/internal-17.AdminPriceListPricesCreateReq.md)
|
||||
- [AdminPriceListPricesUpdateReq](../classes/internal-17.AdminPriceListPricesUpdateReq.md)
|
||||
- [CustomerGroup](../classes/internal-17.CustomerGroup.md)
|
||||
- [CustomerGroup](../classes/internal-17.CustomerGroup-1.md)
|
||||
- [FilterablePriceListProps](../classes/internal-17.FilterablePriceListProps.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminPriceListDeleteBatchRes
|
||||
|
||||
Ƭ **AdminPriceListDeleteBatchRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `deleted` | `boolean` |
|
||||
| `ids` | `string`[] |
|
||||
| `object` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
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**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/price-lists/list-price-list-products.d.ts:175
|
||||
@@ -0,0 +1,16 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetProductTagsPaginationParams](../classes/internal-18.AdminGetProductTagsPaginationParams.md)
|
||||
- [AdminGetProductTagsParams](../classes/internal-18.AdminGetProductTagsParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminProductTagsListRes
|
||||
|
||||
Ƭ **AdminProductTagsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_tags`: [`ProductTag`](../classes/internal.ProductTag.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/product-tags/index.d.ts:9
|
||||
@@ -0,0 +1,15 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetProductTypesParams](../classes/internal-19.AdminGetProductTypesParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminProductTypesListRes
|
||||
|
||||
Ƭ **AdminProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/product-types/index.d.ts:9
|
||||
@@ -0,0 +1,96 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [BatchJobStatus](../enums/internal-2.BatchJobStatus.md)
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetBatchPaginationParams](../classes/internal-2.AdminGetBatchPaginationParams.md)
|
||||
- [AdminGetBatchParams](../classes/internal-2.AdminGetBatchParams.md)
|
||||
- [AdminPostBatchesReq](../classes/internal-2.AdminPostBatchesReq.md)
|
||||
- [BatchJob](../classes/internal-2.BatchJob.md)
|
||||
- [DateComparisonOperator](../classes/internal-2.DateComparisonOperator.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminBatchJobListRes
|
||||
|
||||
Ƭ **AdminBatchJobListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `batch_jobs`: [`BatchJob`](../classes/internal-2.BatchJob.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/batch/index.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### AdminBatchJobRes
|
||||
|
||||
Ƭ **AdminBatchJobRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `batch_job` | [`BatchJob`](../classes/internal-2.BatchJob.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/batch/index.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### BatchJobResultError
|
||||
|
||||
Ƭ **BatchJobResultError**: `Object`
|
||||
|
||||
#### Index signature
|
||||
|
||||
▪ [key: `string`]: `unknown`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `code` | `string` \| `number` |
|
||||
| `message` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/batch-job.d.ts:18
|
||||
|
||||
___
|
||||
|
||||
### BatchJobResultStatDescriptor
|
||||
|
||||
Ƭ **BatchJobResultStatDescriptor**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `key` | `string` |
|
||||
| `message` | `string` |
|
||||
| `name` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/batch-job.d.ts:23
|
||||
|
||||
___
|
||||
|
||||
### PaginatedResponse
|
||||
|
||||
Ƭ **PaginatedResponse**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `count` | `number` |
|
||||
| `limit` | `number` |
|
||||
| `offset` | `number` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:60
|
||||
@@ -0,0 +1,211 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetProductsParams](../classes/internal-20.AdminGetProductsParams.md)
|
||||
- [AdminPostProductsProductMetadataReq](../classes/internal-20.AdminPostProductsProductMetadataReq.md)
|
||||
- [AdminPostProductsProductOptionsOption](../classes/internal-20.AdminPostProductsProductOptionsOption.md)
|
||||
- [AdminPostProductsProductOptionsReq](../classes/internal-20.AdminPostProductsProductOptionsReq.md)
|
||||
- [AdminPostProductsProductReq](../classes/internal-20.AdminPostProductsProductReq.md)
|
||||
- [AdminPostProductsProductVariantsReq](../classes/internal-20.AdminPostProductsProductVariantsReq.md)
|
||||
- [AdminPostProductsProductVariantsVariantReq](../classes/internal-20.AdminPostProductsProductVariantsVariantReq.md)
|
||||
- [AdminPostProductsReq](../classes/internal-20.AdminPostProductsReq.md)
|
||||
- [FilterableProductProps](../classes/internal-20.FilterableProductProps.md)
|
||||
- [ProductOptionReq](../classes/internal-20.ProductOptionReq.md)
|
||||
- [ProductSalesChannelReq](../classes/internal-20.ProductSalesChannelReq.md)
|
||||
- [ProductTagReq](../classes/internal-20.ProductTagReq.md)
|
||||
- [ProductTypeReq](../classes/internal-20.ProductTypeReq.md)
|
||||
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq.md)
|
||||
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-1.md)
|
||||
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-2.md)
|
||||
- [ProductVariantOptionReq](../classes/internal-20.ProductVariantOptionReq-3.md)
|
||||
- [ProductVariantPricesCreateReq](../classes/internal-20.ProductVariantPricesCreateReq.md)
|
||||
- [ProductVariantPricesUpdateReq](../classes/internal-20.ProductVariantPricesUpdateReq.md)
|
||||
- [ProductVariantReq](../classes/internal-20.ProductVariantReq.md)
|
||||
- [ProductVariantReq](../classes/internal-20.ProductVariantReq-1.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminProductsDeleteOptionRes
|
||||
|
||||
Ƭ **AdminProductsDeleteOptionRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `deleted` | `boolean` |
|
||||
| `object` | ``"option"`` |
|
||||
| `option_id` | `string` |
|
||||
| `product` | [`Product`](../classes/internal.Product.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-20.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-20.md#pricedvariant)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/pricing.d.ts:31
|
||||
|
||||
___
|
||||
|
||||
### PricedVariant
|
||||
|
||||
Ƭ **PricedVariant**: `Partial`<[`ProductVariant`](../classes/internal.ProductVariant.md)\> & [`ProductVariantPricing`](internal-20.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-20.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:15
|
||||
|
||||
___
|
||||
|
||||
### 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-20.md#taxservicerate)[] \| ``null`` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/pricing.d.ts:12
|
||||
@@ -0,0 +1,58 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminDeletePublishableApiKeySalesChannelsBatchReq](../classes/internal-21.AdminDeletePublishableApiKeySalesChannelsBatchReq.md)
|
||||
- [AdminPostPublishableApiKeySalesChannelsBatchReq](../classes/internal-21.AdminPostPublishableApiKeySalesChannelsBatchReq.md)
|
||||
- [AdminPostPublishableApiKeysPublishableApiKeyReq](../classes/internal-21.AdminPostPublishableApiKeysPublishableApiKeyReq.md)
|
||||
- [AdminPostPublishableApiKeysReq](../classes/internal-21.AdminPostPublishableApiKeysReq.md)
|
||||
- [GetPublishableApiKeySalesChannelsParams](../classes/internal-21.GetPublishableApiKeySalesChannelsParams.md)
|
||||
- [GetPublishableApiKeysParams](../classes/internal-21.GetPublishableApiKeysParams.md)
|
||||
- [ProductBatchSalesChannel](../classes/internal-21.ProductBatchSalesChannel.md)
|
||||
- [PublishableApiKey](../classes/internal-21.PublishableApiKey.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminPublishableApiKeysListRes
|
||||
|
||||
Ƭ **AdminPublishableApiKeysListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `publishable_api_keys`: [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### AdminPublishableApiKeysRes
|
||||
|
||||
Ƭ **AdminPublishableApiKeysRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `publishable_api_key` | [`PublishableApiKey`](../classes/internal-21.PublishableApiKey.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/publishable-api-keys/index.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### AdminSalesChannelsListRes
|
||||
|
||||
Ƭ **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
|
||||
|
||||
## Variables
|
||||
|
||||
### GetPublishableApiKeysParams\_base
|
||||
|
||||
• `Const` **GetPublishableApiKeysParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/publishable-api-keys/list-publishable-api-keys.d.ts:61
|
||||
@@ -0,0 +1,24 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetRegionsPaginationParams](../classes/internal-22.AdminGetRegionsPaginationParams.md)
|
||||
- [AdminGetRegionsParams](../classes/internal-22.AdminGetRegionsParams.md)
|
||||
- [AdminGetRegionsRegionFulfillmentOptionsRes](../classes/internal-22.AdminGetRegionsRegionFulfillmentOptionsRes.md)
|
||||
- [AdminPostRegionsRegionCountriesReq](../classes/internal-22.AdminPostRegionsRegionCountriesReq.md)
|
||||
- [AdminPostRegionsRegionFulfillmentProvidersReq](../classes/internal-22.AdminPostRegionsRegionFulfillmentProvidersReq.md)
|
||||
- [AdminPostRegionsRegionPaymentProvidersReq](../classes/internal-22.AdminPostRegionsRegionPaymentProvidersReq.md)
|
||||
- [AdminPostRegionsRegionReq](../classes/internal-22.AdminPostRegionsRegionReq.md)
|
||||
- [AdminPostRegionsReq](../classes/internal-22.AdminPostRegionsReq.md)
|
||||
- [AdminRegionsRes](../classes/internal-22.AdminRegionsRes.md)
|
||||
- [FulfillmentOption](../classes/internal-22.FulfillmentOption.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminRegionsListRes
|
||||
|
||||
Ƭ **AdminRegionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `regions`: [`Region`](../classes/internal.Region.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/regions/index.d.ts:12
|
||||
@@ -0,0 +1,38 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminPostReturnReasonsReasonReq](../classes/internal-23.AdminPostReturnReasonsReasonReq.md)
|
||||
- [AdminPostReturnReasonsReq](../classes/internal-23.AdminPostReturnReasonsReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminReturnReasonsListRes
|
||||
|
||||
Ƭ **AdminReturnReasonsListRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/return-reasons/index.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### AdminReturnReasonsRes
|
||||
|
||||
Ƭ **AdminReturnReasonsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `return_reason` | [`ReturnReason`](../classes/internal.ReturnReason.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/return-reasons/index.d.ts:7
|
||||
@@ -0,0 +1,49 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetReturnsParams](../classes/internal-24.AdminGetReturnsParams.md)
|
||||
- [AdminPostReturnsReturnReceiveReq](../classes/internal-24.AdminPostReturnsReturnReceiveReq.md)
|
||||
- [Item](../classes/internal-24.Item.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminReturnsCancelRes
|
||||
|
||||
Ƭ **AdminReturnsCancelRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `order` | [`Order`](../classes/internal.Order.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
|
||||
@@ -0,0 +1,35 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminDeleteSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminDeleteSalesChannelsChannelProductsBatchReq.md)
|
||||
- [AdminGetSalesChannelsParams](../classes/internal-25.AdminGetSalesChannelsParams.md)
|
||||
- [AdminPostSalesChannelsChannelProductsBatchReq](../classes/internal-25.AdminPostSalesChannelsChannelProductsBatchReq.md)
|
||||
- [AdminPostSalesChannelsReq](../classes/internal-25.AdminPostSalesChannelsReq.md)
|
||||
- [AdminPostSalesChannelsSalesChannelReq](../classes/internal-25.AdminPostSalesChannelsSalesChannelReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminSalesChannelsRes
|
||||
|
||||
Ƭ **AdminSalesChannelsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `sales_channel` | [`SalesChannel`](../classes/internal.SalesChannel.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/sales-channels/index.d.ts:6
|
||||
|
||||
## Variables
|
||||
|
||||
### AdminGetSalesChannelsParams\_base
|
||||
|
||||
• `Const` **AdminGetSalesChannelsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/sales-channels/list-sales-channels.d.ts:142
|
||||
@@ -0,0 +1,35 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetShippingOptionsParams](../classes/internal-26.AdminGetShippingOptionsParams.md)
|
||||
- [AdminPostShippingOptionsOptionReq](../classes/internal-26.AdminPostShippingOptionsOptionReq.md)
|
||||
- [AdminPostShippingOptionsReq](../classes/internal-26.AdminPostShippingOptionsReq.md)
|
||||
- [OptionRequirement](../classes/internal-26.OptionRequirement.md)
|
||||
- [OptionRequirement](../classes/internal-26.OptionRequirement-1.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminShippingOptionsListRes
|
||||
|
||||
Ƭ **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:8
|
||||
|
||||
___
|
||||
|
||||
### AdminShippingOptionsRes
|
||||
|
||||
Ƭ **AdminShippingOptionsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `shipping_option` | [`ShippingOption`](../classes/internal.ShippingOption.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/shipping-options/index.d.ts:11
|
||||
@@ -0,0 +1,38 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminPostShippingProfilesProfileReq](../classes/internal-27.AdminPostShippingProfilesProfileReq.md)
|
||||
- [AdminPostShippingProfilesReq](../classes/internal-27.AdminPostShippingProfilesReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminShippingProfilesListRes
|
||||
|
||||
Ƭ **AdminShippingProfilesListRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `shipping_profiles` | [`ShippingProfile`](../classes/internal.ShippingProfile.md)[] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
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
|
||||
@@ -0,0 +1,54 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminPostStoreReq](../classes/internal-28.AdminPostStoreReq.md)
|
||||
- [Store](../classes/internal-28.Store.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminPaymentProvidersList
|
||||
|
||||
Ƭ **AdminPaymentProvidersList**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payment_providers` | [`PaymentProvider`](../classes/internal.PaymentProvider.md)[] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/store/index.d.ts:10
|
||||
|
||||
___
|
||||
|
||||
### AdminStoresRes
|
||||
|
||||
Ƭ **AdminStoresRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `store` | [`Store`](../classes/internal-28.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
|
||||
@@ -0,0 +1,31 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetSwapsParams](../classes/internal-29.AdminGetSwapsParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminSwapsListRes
|
||||
|
||||
Ƭ **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`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `swap` | [`Swap`](../classes/internal.Swap.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/swaps/index.d.ts:10
|
||||
@@ -0,0 +1,54 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminDeleteProductsFromCollectionReq](../classes/internal-3.AdminDeleteProductsFromCollectionReq.md)
|
||||
- [AdminGetCollectionsPaginationParams](../classes/internal-3.AdminGetCollectionsPaginationParams.md)
|
||||
- [AdminGetCollectionsParams](../classes/internal-3.AdminGetCollectionsParams.md)
|
||||
- [AdminPostCollectionsCollectionReq](../classes/internal-3.AdminPostCollectionsCollectionReq.md)
|
||||
- [AdminPostCollectionsReq](../classes/internal-3.AdminPostCollectionsReq.md)
|
||||
- [AdminPostProductsToCollectionReq](../classes/internal-3.AdminPostProductsToCollectionReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminCollectionsListRes
|
||||
|
||||
Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal.ProductCollection.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/collections/index.d.ts:8
|
||||
|
||||
___
|
||||
|
||||
### AdminCollectionsRes
|
||||
|
||||
Ƭ **AdminCollectionsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/collections/index.d.ts:12
|
||||
|
||||
___
|
||||
|
||||
### DeleteResponse
|
||||
|
||||
Ƭ **DeleteResponse**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `deleted` | `boolean` |
|
||||
| `id` | `string` |
|
||||
| `object` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:65
|
||||
@@ -0,0 +1,44 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminDeleteTaxRatesTaxRateProductTypesParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesParams.md)
|
||||
- [AdminDeleteTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductTypesReq.md)
|
||||
- [AdminDeleteTaxRatesTaxRateProductsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsParams.md)
|
||||
- [AdminDeleteTaxRatesTaxRateProductsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateProductsReq.md)
|
||||
- [AdminDeleteTaxRatesTaxRateShippingOptionsParams](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsParams.md)
|
||||
- [AdminDeleteTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminDeleteTaxRatesTaxRateShippingOptionsReq.md)
|
||||
- [AdminGetTaxRatesParams](../classes/internal-30.AdminGetTaxRatesParams.md)
|
||||
- [AdminGetTaxRatesTaxRateParams](../classes/internal-30.AdminGetTaxRatesTaxRateParams.md)
|
||||
- [AdminPostTaxRatesReq](../classes/internal-30.AdminPostTaxRatesReq.md)
|
||||
- [AdminPostTaxRatesTaxRateProductTypesReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductTypesReq.md)
|
||||
- [AdminPostTaxRatesTaxRateProductsReq](../classes/internal-30.AdminPostTaxRatesTaxRateProductsReq.md)
|
||||
- [AdminPostTaxRatesTaxRateReq](../classes/internal-30.AdminPostTaxRatesTaxRateReq.md)
|
||||
- [AdminPostTaxRatesTaxRateShippingOptionsReq](../classes/internal-30.AdminPostTaxRatesTaxRateShippingOptionsReq.md)
|
||||
- [NumericalComparisonOperator](../classes/internal-30.NumericalComparisonOperator.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminTaxRatesListRes
|
||||
|
||||
Ƭ **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`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `tax_rate` | [`TaxRate`](../classes/internal.TaxRate.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/tax-rates/index.d.ts:11
|
||||
@@ -0,0 +1,39 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminDeleteUploadsReq](../classes/internal-31.AdminDeleteUploadsReq.md)
|
||||
- [AdminPostUploadsDownloadUrlReq](../classes/internal-31.AdminPostUploadsDownloadUrlReq.md)
|
||||
- [IAdminPostUploadsFileReq](../classes/internal-31.IAdminPostUploadsFileReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminUploadsDownloadUrlRes
|
||||
|
||||
Ƭ **AdminUploadsDownloadUrlRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `download_url` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
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
|
||||
@@ -0,0 +1,116 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminCreateUserRequest](../classes/internal-32.AdminCreateUserRequest.md)
|
||||
- [AdminResetPasswordRequest](../classes/internal-32.AdminResetPasswordRequest.md)
|
||||
- [AdminResetPasswordTokenRequest](../classes/internal-32.AdminResetPasswordTokenRequest.md)
|
||||
- [AdminUpdateUserRequest](../classes/internal-32.AdminUpdateUserRequest.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminCreateUserPayload
|
||||
|
||||
Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-32.md#createuserroles) }
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### AdminUpdateUserPayload
|
||||
|
||||
Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-32.md#updateuserroles) }
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### AdminUserRes
|
||||
|
||||
Ƭ **AdminUserRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
|
||||
|
||||
#### 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/29135c051/packages/medusa-js/src/typings.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### CreateUserRolesEnum
|
||||
|
||||
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-32.AdminCreateUserRequest.md)[``"role"``]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/29135c051/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/29135c051/packages/medusa-js/src/typings.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### UpdateUserRoles
|
||||
|
||||
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### UpdateUserRolesEnum
|
||||
|
||||
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-32.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-32.AdminUpdateUserRequest.md)[``"role"``]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L37)
|
||||
@@ -0,0 +1,17 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetVariantsParams](../classes/internal-33.AdminGetVariantsParams.md)
|
||||
- [AdminPriceSelectionParams](../classes/internal-33.AdminPriceSelectionParams.md)
|
||||
- [PriceSelectionParams](../classes/internal-33.PriceSelectionParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminVariantsListRes
|
||||
|
||||
Ƭ **AdminVariantsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `variants`: [`PricedVariant`](internal-20.md#pricedvariant)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/variants/index.d.ts:10
|
||||
@@ -0,0 +1,37 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StorePostAuthReq](../classes/internal-34.StorePostAuthReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreAuthRes
|
||||
|
||||
Ƭ **StoreAuthRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customer` | [`Customer`](../classes/internal.Customer.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
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
|
||||
@@ -0,0 +1,38 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [Discount](../classes/internal-35.Discount.md)
|
||||
- [GiftCard](../classes/internal-35.GiftCard.md)
|
||||
- [Item](../classes/internal-35.Item.md)
|
||||
- [StorePostCartReq](../classes/internal-35.StorePostCartReq.md)
|
||||
- [StorePostCartsCartPaymentSessionReq](../classes/internal-35.StorePostCartsCartPaymentSessionReq.md)
|
||||
- [StorePostCartsCartPaymentSessionUpdateReq](../classes/internal-35.StorePostCartsCartPaymentSessionUpdateReq.md)
|
||||
- [StorePostCartsCartReq](../classes/internal-35.StorePostCartsCartReq.md)
|
||||
- [StorePostCartsCartShippingMethodReq](../classes/internal-35.StorePostCartsCartShippingMethodReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreCartsRes
|
||||
|
||||
Ƭ **StoreCartsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `cart` | `Omit`<[`Cart`](../classes/internal.Cart.md), ``"refundable_amount"`` \| ``"refunded_total"``\> |
|
||||
|
||||
#### 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
|
||||
@@ -0,0 +1,31 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StoreGetCollectionsParams](../classes/internal-36.StoreGetCollectionsParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreCollectionsListRes
|
||||
|
||||
Ƭ **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 |
|
||||
| :------ | :------ |
|
||||
| `collection` | [`ProductCollection`](../classes/internal.ProductCollection.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/collections/index.d.ts:10
|
||||
@@ -0,0 +1,20 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StoreGetCustomersCustomerOrdersPaginationParams](../classes/internal-37.StoreGetCustomersCustomerOrdersPaginationParams.md)
|
||||
- [StoreGetCustomersCustomerOrdersParams](../classes/internal-37.StoreGetCustomersCustomerOrdersParams.md)
|
||||
- [StorePostCustomersCustomerPasswordTokenReq](../classes/internal-37.StorePostCustomersCustomerPasswordTokenReq.md)
|
||||
- [StorePostCustomersCustomerReq](../classes/internal-37.StorePostCustomersCustomerReq.md)
|
||||
- [StorePostCustomersReq](../classes/internal-37.StorePostCustomersReq.md)
|
||||
- [StorePostCustomersResetPasswordReq](../classes/internal-37.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
|
||||
@@ -0,0 +1,17 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreGiftCardsRes
|
||||
|
||||
Ƭ **StoreGiftCardsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/gift-cards/index.d.ts:8
|
||||
@@ -0,0 +1,6 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StorePostCartsCartLineItemsItemReq](../classes/internal-39.StorePostCartsCartLineItemsItemReq.md)
|
||||
- [StorePostCartsCartLineItemsReq](../classes/internal-39.StorePostCartsCartLineItemsReq.md)
|
||||
@@ -0,0 +1,33 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetCurrenciesParams](../classes/internal-4.AdminGetCurrenciesParams.md)
|
||||
- [AdminPostCurrenciesCurrencyReq](../classes/internal-4.AdminPostCurrenciesCurrencyReq.md)
|
||||
- [FindPaginationParams](../classes/internal-4.FindPaginationParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminCurrenciesListRes
|
||||
|
||||
Ƭ **AdminCurrenciesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `currencies`: [`Currency`](../classes/internal.Currency.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/currencies/index.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### AdminCurrenciesRes
|
||||
|
||||
Ƭ **AdminCurrenciesRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `currency` | [`Currency`](../classes/internal.Currency.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/currencies/index.d.ts:8
|
||||
@@ -0,0 +1,21 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StorePostOrderEditsOrderEditDecline](../classes/internal-40.StorePostOrderEditsOrderEditDecline.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreOrderEditsRes
|
||||
|
||||
Ƭ **StoreOrderEditsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `order_edit` | `Omit`<[`OrderEdit`](../classes/internal.OrderEdit.md), ``"internal_note"`` \| ``"created_by"`` \| ``"confirmed_by"`` \| ``"canceled_by"``\> |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/order-edits/index.d.ts:4
|
||||
@@ -0,0 +1,24 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [ShippingAddressPayload](../classes/internal-41.ShippingAddressPayload.md)
|
||||
- [StoreGetOrdersParams](../classes/internal-41.StoreGetOrdersParams.md)
|
||||
- [StorePostCustomersCustomerAcceptClaimReq](../classes/internal-41.StorePostCustomersCustomerAcceptClaimReq.md)
|
||||
- [StorePostCustomersCustomerOrderClaimReq](../classes/internal-41.StorePostCustomersCustomerOrderClaimReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreOrdersRes
|
||||
|
||||
Ƭ **StoreOrdersRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `order` | [`Order`](../classes/internal.Order.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/orders/index.d.ts:9
|
||||
@@ -0,0 +1,40 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StorePaymentCollectionSessionsReq](../classes/internal-42.StorePaymentCollectionSessionsReq.md)
|
||||
- [StorePostPaymentCollectionsBatchSessionsAuthorizeReq](../classes/internal-42.StorePostPaymentCollectionsBatchSessionsAuthorizeReq.md)
|
||||
- [StorePostPaymentCollectionsBatchSessionsReq](../classes/internal-42.StorePostPaymentCollectionsBatchSessionsReq.md)
|
||||
- [StorePostPaymentCollectionsSessionsReq](../classes/internal-42.StorePostPaymentCollectionsSessionsReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StorePaymentCollectionsRes
|
||||
|
||||
Ƭ **StorePaymentCollectionsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payment_collection` | [`PaymentCollection`](../classes/internal.PaymentCollection.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/payment-collections/index.d.ts:7
|
||||
|
||||
___
|
||||
|
||||
### StorePaymentCollectionsSessionRes
|
||||
|
||||
Ƭ **StorePaymentCollectionsSessionRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `payment_session` | [`PaymentSession`](../classes/internal.PaymentSession.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/payment-collections/index.d.ts:10
|
||||
@@ -0,0 +1,17 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### 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
|
||||
@@ -0,0 +1,15 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StoreGetProductTypesParams](../classes/internal-44.StoreGetProductTypesParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreProductTypesListRes
|
||||
|
||||
Ƭ **StoreProductTypesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `product_types`: [`ProductType`](../classes/internal.ProductType.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/product-types/index.d.ts:9
|
||||
@@ -0,0 +1,31 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StoreGetVariantsParams](../classes/internal-45.StoreGetVariantsParams.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreVariantsListRes
|
||||
|
||||
Ƭ **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`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `variant` | [`ProductVariant`](../classes/internal.ProductVariant.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/variants/index.d.ts:6
|
||||
@@ -0,0 +1,53 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StoreGetProductsPaginationParams](../classes/internal-46.StoreGetProductsPaginationParams.md)
|
||||
- [StoreGetProductsParams](../classes/internal-46.StoreGetProductsParams.md)
|
||||
- [StorePostSearchReq](../classes/internal-46.StorePostSearchReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StorePostSearchRes
|
||||
|
||||
Ƭ **StorePostSearchRes**: `Object`
|
||||
|
||||
#### Index signature
|
||||
|
||||
▪ [k: `string`]: `unknown`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `hits` | `unknown`[] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/products/index.d.ts:13
|
||||
|
||||
___
|
||||
|
||||
### StoreProductsListRes
|
||||
|
||||
Ƭ **StoreProductsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `products`: [`Product`](../classes/internal.Product.md)[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/products/index.d.ts:17
|
||||
|
||||
___
|
||||
|
||||
### StoreProductsRes
|
||||
|
||||
Ƭ **StoreProductsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `product` | [`Product`](../classes/internal.Product.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/products/index.d.ts:10
|
||||
@@ -0,0 +1,33 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreRegionsListRes
|
||||
|
||||
Ƭ **StoreRegionsListRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `regions` | [`Region`](../classes/internal.Region.md)[] |
|
||||
|
||||
#### 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
|
||||
@@ -0,0 +1,33 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### StoreReturnReasonsListRes
|
||||
|
||||
Ƭ **StoreReturnReasonsListRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `return_reasons` | [`ReturnReason`](../classes/internal.ReturnReason.md)[] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
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
|
||||
@@ -0,0 +1,23 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [Item](../classes/internal-49.Item.md)
|
||||
- [ReturnShipping](../classes/internal-49.ReturnShipping.md)
|
||||
- [StorePostReturnsReq](../classes/internal-49.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
|
||||
@@ -0,0 +1,52 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [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
|
||||
|
||||
### AdminCustomerGroupsListRes
|
||||
|
||||
Ƭ **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_group` | [`CustomerGroup`](../classes/internal.CustomerGroup.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
|
||||
@@ -0,0 +1,21 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [StoreGetShippingOptionsParams](../classes/internal-50.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
|
||||
@@ -0,0 +1,23 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdditionalItem](../classes/internal-51.AdditionalItem.md)
|
||||
- [Item](../classes/internal-51.Item.md)
|
||||
- [StorePostSwapsReq](../classes/internal-51.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
|
||||
@@ -0,0 +1,23 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminPostCustomersCustomerReq](../classes/internal-6.AdminPostCustomersCustomerReq.md)
|
||||
- [AdminPostCustomersReq](../classes/internal-6.AdminPostCustomersReq.md)
|
||||
- [Group](../classes/internal-6.Group.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminCustomersRes
|
||||
|
||||
Ƭ **AdminCustomersRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customer` | [`Customer`](../classes/internal.Customer.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/customers/index.d.ts:5
|
||||
@@ -0,0 +1,123 @@
|
||||
# Namespace: "/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"
|
||||
|
||||
[internal](internal-7.md)."/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### ClassConstructor
|
||||
|
||||
Ƭ **ClassConstructor**<`T`\>: `Object`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/global.d.ts:27
|
||||
|
||||
___
|
||||
|
||||
### ConfigModule
|
||||
|
||||
Ƭ **ConfigModule**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `featureFlags` | `Record`<`string`, `boolean` \| `string`\> |
|
||||
| `moduleResolutions?` | `Record`<`string`, [`ModuleResolution`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduleresolution)\> |
|
||||
| `modules?` | `Record`<`string`, `string`\> |
|
||||
| `plugins` | ({ `options`: `Record`<`string`, `unknown`\> ; `resolve`: `string` } \| `string`)[] |
|
||||
| `projectConfig` | { `admin_cors?`: `string` ; `cookie_secret?`: `string` ; `database_database?`: `string` ; `database_extra?`: `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } ; `database_logging`: `LoggerOptions` ; `database_type`: `string` ; `database_url?`: `string` ; `jwt_secret?`: `string` ; `redis_url?`: `string` ; `store_cors?`: `string` } |
|
||||
| `projectConfig.admin_cors?` | `string` |
|
||||
| `projectConfig.cookie_secret?` | `string` |
|
||||
| `projectConfig.database_database?` | `string` |
|
||||
| `projectConfig.database_extra?` | `Record`<`string`, `unknown`\> & { `ssl`: { `rejectUnauthorized`: ``false`` } } |
|
||||
| `projectConfig.database_logging` | `LoggerOptions` |
|
||||
| `projectConfig.database_type` | `string` |
|
||||
| `projectConfig.database_url?` | `string` |
|
||||
| `projectConfig.jwt_secret?` | `string` |
|
||||
| `projectConfig.redis_url?` | `string` |
|
||||
| `projectConfig.store_cors?` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/global.d.ts:50
|
||||
|
||||
___
|
||||
|
||||
### ExtendedRequest
|
||||
|
||||
Ƭ **ExtendedRequest**<`TEntity`\>: `Request` & { `resource`: `TEntity` }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `TEntity` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/global.d.ts:24
|
||||
|
||||
___
|
||||
|
||||
### Logger
|
||||
|
||||
Ƭ **Logger**: `_Logger` & { `info`: (`msg`: `string`) => `void` ; `progress`: (`activityId`: `string`, `msg`: `string`) => `void` ; `warn`: (`msg`: `string`) => `void` }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/global.d.ts:33
|
||||
|
||||
___
|
||||
|
||||
### MedusaContainer
|
||||
|
||||
Ƭ **MedusaContainer**: `AwilixContainer` & { `registerAdd`: <T\>(`name`: `string`, `registration`: `T`) => [`MedusaContainer`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#medusacontainer) }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/global.d.ts:30
|
||||
|
||||
___
|
||||
|
||||
### ModuleDefinition
|
||||
|
||||
Ƭ **ModuleDefinition**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `canOverride?` | `boolean` |
|
||||
| `defaultPackage` | `string` |
|
||||
| `isRequired?` | `boolean` |
|
||||
| `key` | `string` |
|
||||
| `label` | `string` |
|
||||
| `registrationName` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/global.d.ts:42
|
||||
|
||||
___
|
||||
|
||||
### ModuleResolution
|
||||
|
||||
Ƭ **ModuleResolution**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `definition` | [`ModuleDefinition`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md#moduledefinition) |
|
||||
| `resolutionPath` | `string` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/global.d.ts:38
|
||||
@@ -0,0 +1,78 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Namespaces
|
||||
|
||||
- ["/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminCreateCondition](../classes/internal-7.AdminCreateCondition.md)
|
||||
- [AdminDeleteDiscountsDiscountConditionsConditionBatchReq](../classes/internal-7.AdminDeleteDiscountsDiscountConditionsConditionBatchReq.md)
|
||||
- [AdminGetDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminGetDiscountsDiscountConditionsConditionParams.md)
|
||||
- [AdminGetDiscountsDiscountRuleParams](../classes/internal-7.AdminGetDiscountsDiscountRuleParams.md)
|
||||
- [AdminGetDiscountsParams](../classes/internal-7.AdminGetDiscountsParams.md)
|
||||
- [AdminPostDiscountsDiscountConditions](../classes/internal-7.AdminPostDiscountsDiscountConditions.md)
|
||||
- [AdminPostDiscountsDiscountConditionsCondition](../classes/internal-7.AdminPostDiscountsDiscountConditionsCondition.md)
|
||||
- [AdminPostDiscountsDiscountConditionsConditionBatchParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchParams.md)
|
||||
- [AdminPostDiscountsDiscountConditionsConditionBatchReq](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionBatchReq.md)
|
||||
- [AdminPostDiscountsDiscountConditionsConditionParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsConditionParams.md)
|
||||
- [AdminPostDiscountsDiscountConditionsParams](../classes/internal-7.AdminPostDiscountsDiscountConditionsParams.md)
|
||||
- [AdminPostDiscountsDiscountDynamicCodesReq](../classes/internal-7.AdminPostDiscountsDiscountDynamicCodesReq.md)
|
||||
- [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
|
||||
|
||||
### AdminDiscountConditionsRes
|
||||
|
||||
Ƭ **AdminDiscountConditionsRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `discount_condition` | [`DiscountCondition`](../classes/internal.DiscountCondition.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
|
||||
|
||||
## Variables
|
||||
|
||||
### AdminGetDiscountsParams\_base
|
||||
|
||||
• `Const` **AdminGetDiscountsParams\_base**: [`"/home/runner/work/medusa/medusa/packages/medusa/dist/types/global"`](internal-7.__home_runner_work_medusa_medusa_packages_medusa_dist_types_global_.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/discounts/list-discounts.d.ts:87
|
||||
@@ -0,0 +1,55 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetDraftOrdersParams](../classes/internal-8.AdminGetDraftOrdersParams.md)
|
||||
- [AdminPostDraftOrdersDraftOrderLineItemsItemReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsItemReq.md)
|
||||
- [AdminPostDraftOrdersDraftOrderLineItemsReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderLineItemsReq.md)
|
||||
- [AdminPostDraftOrdersDraftOrderReq](../classes/internal-8.AdminPostDraftOrdersDraftOrderReq.md)
|
||||
- [AdminPostDraftOrdersReq](../classes/internal-8.AdminPostDraftOrdersReq.md)
|
||||
- [Discount](../classes/internal-8.Discount.md)
|
||||
- [Discount](../classes/internal-8.Discount-1.md)
|
||||
- [Item](../classes/internal-8.Item.md)
|
||||
- [ShippingMethod](../classes/internal-8.ShippingMethod.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminDraftOrdersListRes
|
||||
|
||||
Ƭ **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`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `draft_order` | [`DraftOrder`](../classes/internal.DraftOrder.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
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
|
||||
@@ -0,0 +1,33 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminGetGiftCardsParams](../classes/internal-9.AdminGetGiftCardsParams.md)
|
||||
- [AdminPostGiftCardsGiftCardReq](../classes/internal-9.AdminPostGiftCardsGiftCardReq.md)
|
||||
- [AdminPostGiftCardsReq](../classes/internal-9.AdminPostGiftCardsReq.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminGiftCardsListRes
|
||||
|
||||
Ƭ **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 |
|
||||
| :------ | :------ |
|
||||
| `gift_card` | [`GiftCard`](../classes/internal.GiftCard.md) |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/gift-cards/index.d.ts:10
|
||||
230
www/apps/docs/content/references/js-client/modules/internal.md
Normal file
230
www/apps/docs/content/references/js-client/modules/internal.md
Normal file
@@ -0,0 +1,230 @@
|
||||
---
|
||||
displayed_sidebar: jsClientSidebar
|
||||
---
|
||||
|
||||
# Namespace: internal
|
||||
|
||||
## Enumerations
|
||||
|
||||
- [AllocationType](../enums/internal.AllocationType.md)
|
||||
- [CartType](../enums/internal.CartType.md)
|
||||
- [ClaimFulfillmentStatus](../enums/internal.ClaimFulfillmentStatus.md)
|
||||
- [ClaimPaymentStatus](../enums/internal.ClaimPaymentStatus.md)
|
||||
- [ClaimReason](../enums/internal.ClaimReason.md)
|
||||
- [ClaimType](../enums/internal.ClaimType.md)
|
||||
- [DiscountConditionOperator](../enums/internal.DiscountConditionOperator.md)
|
||||
- [DiscountConditionType](../enums/internal.DiscountConditionType.md)
|
||||
- [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)
|
||||
- [PaymentCollectionStatus](../enums/internal.PaymentCollectionStatus.md)
|
||||
- [PaymentStatus](../enums/internal.PaymentStatus.md)
|
||||
- [PriceListStatus](../enums/internal.PriceListStatus.md)
|
||||
- [PriceListType](../enums/internal.PriceListType.md)
|
||||
- [ProductStatus](../enums/internal.ProductStatus.md)
|
||||
- [RequirementType](../enums/internal.RequirementType.md)
|
||||
- [ReturnStatus](../enums/internal.ReturnStatus.md)
|
||||
- [ShippingOptionPriceType](../enums/internal.ShippingOptionPriceType.md)
|
||||
- [ShippingProfileType](../enums/internal.ShippingProfileType.md)
|
||||
- [SwapFulfillmentStatus](../enums/internal.SwapFulfillmentStatus.md)
|
||||
- [SwapPaymentStatus](../enums/internal.SwapPaymentStatus.md)
|
||||
|
||||
## Classes
|
||||
|
||||
- [Address](../classes/internal.Address.md)
|
||||
- [AddressCreatePayload](../classes/internal.AddressCreatePayload.md)
|
||||
- [AddressPayload](../classes/internal.AddressPayload.md)
|
||||
- [Axios](../classes/internal.Axios.md)
|
||||
- [BaseEntity](../classes/internal.BaseEntity.md)
|
||||
- [Cart](../classes/internal.Cart.md)
|
||||
- [ClaimImage](../classes/internal.ClaimImage.md)
|
||||
- [ClaimItem](../classes/internal.ClaimItem.md)
|
||||
- [ClaimOrder](../classes/internal.ClaimOrder.md)
|
||||
- [ClaimTag](../classes/internal.ClaimTag.md)
|
||||
- [Client](../classes/internal.Client.md)
|
||||
- [Country](../classes/internal.Country.md)
|
||||
- [Currency](../classes/internal.Currency.md)
|
||||
- [Customer](../classes/internal.Customer.md)
|
||||
- [CustomerGroup](../classes/internal.CustomerGroup.md)
|
||||
- [Discount](../classes/internal.Discount.md)
|
||||
- [DiscountCondition](../classes/internal.DiscountCondition.md)
|
||||
- [DiscountRule](../classes/internal.DiscountRule.md)
|
||||
- [DraftOrder](../classes/internal.DraftOrder.md)
|
||||
- [Fulfillment](../classes/internal.Fulfillment.md)
|
||||
- [FulfillmentItem](../classes/internal.FulfillmentItem.md)
|
||||
- [FulfillmentProvider](../classes/internal.FulfillmentProvider.md)
|
||||
- [GiftCard](../classes/internal.GiftCard.md)
|
||||
- [GiftCardTransaction](../classes/internal.GiftCardTransaction.md)
|
||||
- [Image](../classes/internal.Image.md)
|
||||
- [LineItem](../classes/internal.LineItem.md)
|
||||
- [LineItemAdjustment](../classes/internal.LineItemAdjustment.md)
|
||||
- [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)
|
||||
- [PaymentCollection](../classes/internal.PaymentCollection.md)
|
||||
- [PaymentProvider](../classes/internal.PaymentProvider.md)
|
||||
- [PaymentSession](../classes/internal.PaymentSession.md)
|
||||
- [PriceList](../classes/internal.PriceList.md)
|
||||
- [Product](../classes/internal.Product.md)
|
||||
- [ProductCollection](../classes/internal.ProductCollection.md)
|
||||
- [ProductOption](../classes/internal.ProductOption.md)
|
||||
- [ProductOptionValue](../classes/internal.ProductOptionValue.md)
|
||||
- [ProductTag](../classes/internal.ProductTag.md)
|
||||
- [ProductType](../classes/internal.ProductType.md)
|
||||
- [ProductVariant](../classes/internal.ProductVariant.md)
|
||||
- [Refund](../classes/internal.Refund.md)
|
||||
- [Region](../classes/internal.Region.md)
|
||||
- [Return](../classes/internal.Return.md)
|
||||
- [ReturnItem](../classes/internal.ReturnItem.md)
|
||||
- [ReturnReason](../classes/internal.ReturnReason.md)
|
||||
- [SalesChannel](../classes/internal.SalesChannel.md)
|
||||
- [ShippingMethod](../classes/internal.ShippingMethod.md)
|
||||
- [ShippingMethodTaxLine](../classes/internal.ShippingMethodTaxLine.md)
|
||||
- [ShippingOption](../classes/internal.ShippingOption.md)
|
||||
- [ShippingOptionRequirement](../classes/internal.ShippingOptionRequirement.md)
|
||||
- [ShippingProfile](../classes/internal.ShippingProfile.md)
|
||||
- [SoftDeletableEntity](../classes/internal.SoftDeletableEntity.md)
|
||||
- [StorePostCustomersCustomerAddressesAddressReq](../classes/internal.StorePostCustomersCustomerAddressesAddressReq.md)
|
||||
- [StorePostCustomersCustomerAddressesReq](../classes/internal.StorePostCustomersCustomerAddressesReq.md)
|
||||
- [Swap](../classes/internal.Swap.md)
|
||||
- [TaxLine](../classes/internal.TaxLine.md)
|
||||
- [TaxProvider](../classes/internal.TaxProvider.md)
|
||||
- [TaxRate](../classes/internal.TaxRate.md)
|
||||
- [TrackingLink](../classes/internal.TrackingLink.md)
|
||||
|
||||
## Interfaces
|
||||
|
||||
- [AxiosAdapter](../interfaces/internal.AxiosAdapter.md)
|
||||
- [AxiosBasicCredentials](../interfaces/internal.AxiosBasicCredentials.md)
|
||||
- [AxiosDefaults](../interfaces/internal.AxiosDefaults.md)
|
||||
- [AxiosError](../interfaces/internal.AxiosError.md)
|
||||
- [AxiosInstance](../interfaces/internal.AxiosInstance.md)
|
||||
- [AxiosInterceptorManager](../interfaces/internal.AxiosInterceptorManager.md)
|
||||
- [AxiosPromise](../interfaces/internal.AxiosPromise.md)
|
||||
- [AxiosProxyConfig](../interfaces/internal.AxiosProxyConfig.md)
|
||||
- [AxiosRequestConfig](../interfaces/internal.AxiosRequestConfig.md)
|
||||
- [AxiosRequestTransformer](../interfaces/internal.AxiosRequestTransformer.md)
|
||||
- [AxiosResponse](../interfaces/internal.AxiosResponse.md)
|
||||
- [AxiosResponseTransformer](../interfaces/internal.AxiosResponseTransformer.md)
|
||||
- [Cancel](../interfaces/internal.Cancel.md)
|
||||
- [CancelToken](../interfaces/internal.CancelToken.md)
|
||||
- [Config](../interfaces/internal.Config.md)
|
||||
- [HTTPResponse](../interfaces/internal.HTTPResponse.md)
|
||||
- [HeadersDefaults](../interfaces/internal.HeadersDefaults.md)
|
||||
- [RequestOptions](../interfaces/internal.RequestOptions.md)
|
||||
- [RetryConfig](../interfaces/internal.RetryConfig.md)
|
||||
- [TransitionalOptions](../interfaces/internal.TransitionalOptions.md)
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
### ORDER\_EDIT
|
||||
|
||||
• **ORDER\_EDIT**: ``"order_edit"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/models/payment-collection.d.ts:11
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AxiosRequestHeaders
|
||||
|
||||
Ƭ **AxiosRequestHeaders**: `Record`<`string`, `string`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:3
|
||||
|
||||
___
|
||||
|
||||
### AxiosResponseHeaders
|
||||
|
||||
Ƭ **AxiosResponseHeaders**: `Record`<`string`, `string`\> & { `set-cookie?`: `string`[] }
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:5
|
||||
|
||||
___
|
||||
|
||||
### Method
|
||||
|
||||
Ƭ **Method**: ``"get"`` \| ``"GET"`` \| ``"delete"`` \| ``"DELETE"`` \| ``"head"`` \| ``"HEAD"`` \| ``"options"`` \| ``"OPTIONS"`` \| ``"post"`` \| ``"POST"`` \| ``"put"`` \| ``"PUT"`` \| ``"patch"`` \| ``"PATCH"`` \| ``"purge"`` \| ``"PURGE"`` \| ``"link"`` \| ``"LINK"`` \| ``"unlink"`` \| ``"UNLINK"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:36
|
||||
|
||||
___
|
||||
|
||||
### RequestMethod
|
||||
|
||||
Ƭ **RequestMethod**: ``"DELETE"`` \| ``"POST"`` \| ``"GET"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/request.ts:26](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/request.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
### Response
|
||||
|
||||
Ƭ **Response**<`T`\>: `T` & { `response`: [`HTTPResponse`](../interfaces/internal.HTTPResponse.md) }
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:17](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L17)
|
||||
|
||||
___
|
||||
|
||||
### ResponsePromise
|
||||
|
||||
Ƭ **ResponsePromise**<`T`\>: `Promise`<[`Response`](internal.md#response)<`T`\>\>
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `T` | `any` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:21](https://github.com/medusajs/medusa/blob/29135c051/packages/medusa-js/src/typings.ts#L21)
|
||||
|
||||
___
|
||||
|
||||
### ResponseType
|
||||
|
||||
Ƭ **ResponseType**: ``"arraybuffer"`` \| ``"blob"`` \| ``"document"`` \| ``"json"`` \| ``"text"`` \| ``"stream"``
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa-js/node_modules/axios/index.d.ts:48
|
||||
|
||||
___
|
||||
|
||||
### StoreCustomersRes
|
||||
|
||||
Ƭ **StoreCustomersRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `customer` | `Omit`<[`Customer`](../classes/internal.Customer.md), ``"password_hash"``\> |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/store/customers/index.d.ts:9
|
||||
Reference in New Issue
Block a user