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

chore(docs): Generated References (automated) (#8317)

Browse Source 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-07-29 09:41:15 +02:00
committed by GitHub
parent e40b4c6183
commit cb33ec5cf1
230 changed files with 54378 additions and 83917 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
www/apps/resources/references/modules/js_client/page.mdx
View File

@@ -1,66 +0,0 @@
import { TypeList } from "docs-ui"
# js-client
## Classes
- [AddressesResource](../../js_client/classes/js_client.AddressesResource/page.mdx)
- [AdminAuthResource](../../js_client/classes/js_client.AdminAuthResource/page.mdx)
- [AdminBatchJobsResource](../../js_client/classes/js_client.AdminBatchJobsResource/page.mdx)
- [AdminCollectionsResource](../../js_client/classes/js_client.AdminCollectionsResource/page.mdx)
- [AdminCurrenciesResource](../../js_client/classes/js_client.AdminCurrenciesResource/page.mdx)
- [AdminCustomResource](../../js_client/classes/js_client.AdminCustomResource/page.mdx)
- [AdminCustomerGroupsResource](../../js_client/classes/js_client.AdminCustomerGroupsResource/page.mdx)
- [AdminCustomersResource](../../js_client/classes/js_client.AdminCustomersResource/page.mdx)
- [AdminDiscountsResource](../../js_client/classes/js_client.AdminDiscountsResource/page.mdx)
- [AdminDraftOrdersResource](../../js_client/classes/js_client.AdminDraftOrdersResource/page.mdx)
- [AdminGiftCardsResource](../../js_client/classes/js_client.AdminGiftCardsResource/page.mdx)
- [Admin](../../js_client/classes/js_client.Admin/page.mdx)
- [AdminInventoryItemsResource](../../js_client/classes/js_client.AdminInventoryItemsResource/page.mdx)
- [AdminInvitesResource](../../js_client/classes/js_client.AdminInvitesResource/page.mdx)
- [AdminNotesResource](../../js_client/classes/js_client.AdminNotesResource/page.mdx)
- [AdminNotificationsResource](../../js_client/classes/js_client.AdminNotificationsResource/page.mdx)
- [AdminOrderEditsResource](../../js_client/classes/js_client.AdminOrderEditsResource/page.mdx)
- [AdminOrdersResource](../../js_client/classes/js_client.AdminOrdersResource/page.mdx)
- [AdminPaymentCollectionsResource](../../js_client/classes/js_client.AdminPaymentCollectionsResource/page.mdx)
- [AdminPaymentsResource](../../js_client/classes/js_client.AdminPaymentsResource/page.mdx)
- [AdminPriceListResource](../../js_client/classes/js_client.AdminPriceListResource/page.mdx)
- [AdminProductCategoriesResource](../../js_client/classes/js_client.AdminProductCategoriesResource/page.mdx)
- [AdminProductTagsResource](../../js_client/classes/js_client.AdminProductTagsResource/page.mdx)
- [AdminProductTypesResource](../../js_client/classes/js_client.AdminProductTypesResource/page.mdx)
- [AdminProductsResource](../../js_client/classes/js_client.AdminProductsResource/page.mdx)
- [AdminPublishableApiKeyResource](../../js_client/classes/js_client.AdminPublishableApiKeyResource/page.mdx)
- [AdminRegionsResource](../../js_client/classes/js_client.AdminRegionsResource/page.mdx)
- [AdminReservationsResource](../../js_client/classes/js_client.AdminReservationsResource/page.mdx)
- [AdminReturnReasonsResource](../../js_client/classes/js_client.AdminReturnReasonsResource/page.mdx)
- [AdminReturnsResource](../../js_client/classes/js_client.AdminReturnsResource/page.mdx)
- [AdminSalesChannelsResource](../../js_client/classes/js_client.AdminSalesChannelsResource/page.mdx)
- [AdminShippingOptionsResource](../../js_client/classes/js_client.AdminShippingOptionsResource/page.mdx)
- [AdminShippingProfilesResource](../../js_client/classes/js_client.AdminShippingProfilesResource/page.mdx)
- [AdminStockLocationsResource](../../js_client/classes/js_client.AdminStockLocationsResource/page.mdx)
- [AdminStoresResource](../../js_client/classes/js_client.AdminStoresResource/page.mdx)
- [AdminSwapsResource](../../js_client/classes/js_client.AdminSwapsResource/page.mdx)
- [AdminTaxRatesResource](../../js_client/classes/js_client.AdminTaxRatesResource/page.mdx)
- [AdminUploadsResource](../../js_client/classes/js_client.AdminUploadsResource/page.mdx)
- [AdminUsersResource](../../js_client/classes/js_client.AdminUsersResource/page.mdx)
- [AdminVariantsResource](../../js_client/classes/js_client.AdminVariantsResource/page.mdx)
- [AuthResource](../../js_client/classes/js_client.AuthResource/page.mdx)
- [CartsResource](../../js_client/classes/js_client.CartsResource/page.mdx)
- [CollectionsResource](../../js_client/classes/js_client.CollectionsResource/page.mdx)
- [CustomersResource](../../js_client/classes/js_client.CustomersResource/page.mdx)
- [GiftCardsResource](../../js_client/classes/js_client.GiftCardsResource/page.mdx)
- [LineItemsResource](../../js_client/classes/js_client.LineItemsResource/page.mdx)
- [OrderEditsResource](../../js_client/classes/js_client.OrderEditsResource/page.mdx)
- [OrdersResource](../../js_client/classes/js_client.OrdersResource/page.mdx)
- [PaymentCollectionsResource](../../js_client/classes/js_client.PaymentCollectionsResource/page.mdx)
- [PaymentMethodsResource](../../js_client/classes/js_client.PaymentMethodsResource/page.mdx)
- [ProductCategoriesResource](../../js_client/classes/js_client.ProductCategoriesResource/page.mdx)
- [ProductTagsResource](../../js_client/classes/js_client.ProductTagsResource/page.mdx)
- [ProductTypesResource](../../js_client/classes/js_client.ProductTypesResource/page.mdx)
- [ProductVariantsResource](../../js_client/classes/js_client.ProductVariantsResource/page.mdx)
- [ProductsResource](../../js_client/classes/js_client.ProductsResource/page.mdx)
- [RegionsResource](../../js_client/classes/js_client.RegionsResource/page.mdx)
- [ReturnReasonsResource](../../js_client/classes/js_client.ReturnReasonsResource/page.mdx)
- [ReturnsResource](../../js_client/classes/js_client.ReturnsResource/page.mdx)
- [ShippingOptionsResource](../../js_client/classes/js_client.ShippingOptionsResource/page.mdx)
- [SwapsResource](../../js_client/classes/js_client.SwapsResource/page.mdx)

349
www/apps/resources/references/modules/medusa_react/page.mdx
View File

@@ -1,349 +0,0 @@
import { TypeList } from "docs-ui"
# medusa-react
## Namespaces
- [Providers](../../medusa_react/medusa_react.Providers/page.mdx)
- [Utilities](../../medusa_react/medusa_react.Utilities/page.mdx)
- [Hooks](../../medusa_react/medusa_react.Hooks/page.mdx)
## Interfaces
- [CartContext](../../medusa_react/interfaces/medusa_react.CartContext/page.mdx)
- [CartProps](../../medusa_react/interfaces/medusa_react.CartProps/page.mdx)
- [MedusaContextState](../../medusa_react/interfaces/medusa_react.MedusaContextState/page.mdx)
- [MedusaProviderProps](../../medusa_react/interfaces/medusa_react.MedusaProviderProps/page.mdx)
- [Item](../../medusa_react/interfaces/medusa_react.Item/page.mdx)
- [SessionCartState](../../medusa_react/interfaces/medusa_react.SessionCartState/page.mdx)
- [SessionCartContextState](../../medusa_react/interfaces/medusa_react.SessionCartContextState/page.mdx)
- [SessionCartProviderProps](../../medusa_react/interfaces/medusa_react.SessionCartProviderProps/page.mdx)
- [FormatVariantPriceParams](../../medusa_react/interfaces/medusa_react.FormatVariantPriceParams/page.mdx)
- [ComputeVariantPriceParams](../../medusa_react/interfaces/medusa_react.ComputeVariantPriceParams/page.mdx)
## Type Aliases
- [ComputeAmountParams](../../medusa_react/types/medusa_react.ComputeAmountParams/page.mdx)
- [FormatAmountParams](../../medusa_react/types/medusa_react.FormatAmountParams/page.mdx)
- [AdminUpdateClaimReq](../../medusa_react/types/medusa_react.AdminUpdateClaimReq/page.mdx)
- [AdminFulfillClaimReq](../../medusa_react/types/medusa_react.AdminFulfillClaimReq/page.mdx)
- [AdminCancelClaimFulfillmentReq](../../medusa_react/types/medusa_react.AdminCancelClaimFulfillmentReq/page.mdx)
- [AdminDraftOrderUpdateLineItemReq](../../medusa_react/types/medusa_react.AdminDraftOrderUpdateLineItemReq/page.mdx)
- [AdminUpdateLocationLevelReq](../../medusa_react/types/medusa_react.AdminUpdateLocationLevelReq/page.mdx)
- [AdminUpdateVariantReq](../../medusa_react/types/medusa_react.AdminUpdateVariantReq/page.mdx)
- [AdminUpdateProductOptionReq](../../medusa_react/types/medusa_react.AdminUpdateProductOptionReq/page.mdx)
- [AdminFulfillSwapReq](../../medusa_react/types/medusa_react.AdminFulfillSwapReq/page.mdx)
- [AdminCreateSwapShipmentReq](../../medusa_react/types/medusa_react.AdminCreateSwapShipmentReq/page.mdx)
- [AdminCancelSwapFulfillmentReq](../../medusa_react/types/medusa_react.AdminCancelSwapFulfillmentReq/page.mdx)
- [CreateCartReq](../../medusa_react/types/medusa_react.CreateCartReq/page.mdx)
- [UpdatePaymentSessionReq](../../medusa_react/types/medusa_react.UpdatePaymentSessionReq/page.mdx)
- [RefreshPaymentSessionMutationData](../../medusa_react/types/medusa_react.RefreshPaymentSessionMutationData/page.mdx)
- [DeletePaymentSessionMutationData](../../medusa_react/types/medusa_react.DeletePaymentSessionMutationData/page.mdx)
- [UpdateMeReq](../../medusa_react/types/medusa_react.UpdateMeReq/page.mdx)
- [UpdateLineItemReq](../../medusa_react/types/medusa_react.UpdateLineItemReq/page.mdx)
- [UseQueryOptionsWrapper](../../medusa_react/types/medusa_react.UseQueryOptionsWrapper/page.mdx)
- [RegionInfo](../../medusa_react/types/medusa_react.RegionInfo/page.mdx)
- [ProductVariant](../../medusa_react/types/medusa_react.ProductVariant/page.mdx)
- [ProductVariantInfo](../../medusa_react/types/medusa_react.ProductVariantInfo/page.mdx)
- [Cart](../../medusa_react/types/medusa_react.Cart/page.mdx)
- [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)
___
## Variables
### adminAuthKeys
`Const` **adminAuthKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_auth", any, string&#62;
### adminBatchJobsKeys
`Const` **adminBatchJobsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_batches", any, string&#62;
### adminCollectionKeys
`Const` **adminCollectionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_collections", any, string&#62;
### adminCurrenciesKeys
`Const` **adminCurrenciesKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_currencies", any, string&#62;
### adminCustomerKeys
`Const` **adminCustomerKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_customers", any, string&#62;
### adminDiscountKeys
`Const` **adminDiscountKeys**: `Object`
#### Properties
<TypeList types={[{"name":"detailCondition","type":"(`id`: `string`, `query?`: `any`) => readonly [`\"admin_discounts\"`, `\"detail\"`, `string`, `\"condition\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_discounts\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_discounts\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_discounts\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_discounts\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_discounts\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminDiscountKeys"/>
### adminDraftOrderKeys
`Const` **adminDraftOrderKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_draft_orders", any, string&#62;
### adminGiftCardKeys
`Const` **adminGiftCardKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_gift_cards", any, string&#62;
### adminInventoryItemsKeys
`Const` **adminInventoryItemsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_inventory_items", any, string&#62;
### adminInviteKeys
`Const` **adminInviteKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_invites", any, string&#62;
### adminNoteKeys
`Const` **adminNoteKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_notes", any, string&#62;
### adminNotificationKeys
`Const` **adminNotificationKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_notifications", any, string&#62;
### adminOrderEditsKeys
`Const` **adminOrderEditsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_order_edits", any, string&#62;
### adminOrderKeys
`Const` **adminOrderKeys**: `Object`
#### Properties
<TypeList types={[{"name":"detailOrder","type":"(`id`: `string`, `query?`: `FindParams`) => (`string` \\| ``{ expand?: string ; fields?: string }``)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_orders\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_orders\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_orders\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_orders\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminOrderKeys"/>
### adminPaymentCollectionQueryKeys
`Const` **adminPaymentCollectionQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"paymentCollection", any, string&#62;
### adminPaymentQueryKeys
`Const` **adminPaymentQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"payment", any, string&#62;
### adminPriceListKeys
`Const` **adminPriceListKeys**: `Object`
#### Properties
<TypeList types={[{"name":"detailProducts","type":"(`id`: `string`, `query?`: `any`) => readonly [`\"admin_price_lists\"`, `\"detail\"`, `string`, `\"products\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_price_lists\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_price_lists\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_price_lists\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_price_lists\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_price_lists\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminPriceListKeys"/>
### adminProductCategoryKeys
`Const` **adminProductCategoryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"product_categories", any, string&#62;
### adminProductTagKeys
`Const` **adminProductTagKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_product_tags", any, string&#62;
### adminProductTypeKeys
`Const` **adminProductTypeKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_product_types", any, string&#62;
### adminProductKeys
`Const` **adminProductKeys**: `Object`
#### Properties
<TypeList types={[{"name":"detailVariants","type":"(`id`: `string`, `query?`: `any`) => readonly [`\"admin_products\"`, `\"detail\"`, `string`, `\"variants\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_products\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_products\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_products\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_products\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_products\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminProductKeys"/>
### adminPublishableApiKeysKeys
`Const` **adminPublishableApiKeysKeys**: `Object`
#### Properties
<TypeList types={[{"name":"detailSalesChannels","type":"(`id`: `string`, `query?`: `any`) => readonly [`\"admin_publishable_api_keys\"`, `\"detail\"`, `string`, `\"sales_channels\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_publishable_api_keys\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_publishable_api_keys\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_publishable_api_keys\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_publishable_api_keys\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_publishable_api_keys\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminPublishableApiKeysKeys"/>
### adminRegionKeys
`Const` **adminRegionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_regions", any, string&#62;
### adminReservationsKeys
`Const` **adminReservationsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_reservations", any, string&#62;
### adminReturnReasonKeys
`Const` **adminReturnReasonKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_return_reasons", any, string&#62;
### adminReturnKeys
`Const` **adminReturnKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_returns", any, string&#62;
### adminSalesChannelsKeys
`Const` **adminSalesChannelsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_sales_channels", any, string&#62;
### adminShippingOptionKeys
`Const` **adminShippingOptionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_shipping_options", any, string&#62;
### adminShippingProfileKeys
`Const` **adminShippingProfileKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_shippingProfiles", any, string&#62;
### adminStockLocationsKeys
`Const` **adminStockLocationsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_stock_locations", any, string&#62;
### adminStoreKeys
`Const` **adminStoreKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_store", any, string&#62;
### adminSwapKeys
`Const` **adminSwapKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_swaps", any, string&#62;
### adminTaxRateKeys
`Const` **adminTaxRateKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_tax_rates", any, string&#62;
### adminUserKeys
`Const` **adminUserKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_users", any, string&#62;
### adminVariantKeys
`Const` **adminVariantKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"admin_variants", any, string&#62;
### cartKeys
`Const` **cartKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"carts", any, string&#62;
### collectionKeys
`Const` **collectionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"collections", any, string&#62;
### customerKeys
`Const` **customerKeys**: `Object`
#### Properties
<TypeList types={[{"name":"orders","type":"(`id`: `string`) => readonly [`\"customers\"`, `\"detail\"`, `string`, `\"orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"customers\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"customers\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"customers\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"customers\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"customers\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="customerKeys"/>
### giftCardKeys
`Const` **giftCardKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"gift_cards", any, string&#62;
### orderEditQueryKeys
`Const` **orderEditQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"orderEdit", any, string&#62;
### orderKeys
`Const` **orderKeys**: `Object`
#### Properties
<TypeList types={[{"name":"cart","type":"(`cartId`: `string`) => readonly [`\"orders\"`, `\"detail\"`, `\"cart\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"orders\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `StoreGetOrdersParams`) => [`\"orders\"`, `\"list\"`, ``{ query: undefined \\| StoreGetOrdersParams }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"orders\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"orders\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="orderKeys"/>
### paymentCollectionQueryKeys
`Const` **paymentCollectionQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"paymentCollection", any, string&#62;
### storeProductCategoryKeys
`Const` **storeProductCategoryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"product_categories", any, string&#62;
### productTagKeys
`Const` **productTagKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"product_tags", any, string&#62;
### productTypeKeys
`Const` **productTypeKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"product_types", any, string&#62;
### productKeys
`Const` **productKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;"products", StoreGetProductsParams, string&#62;
___
## Functions
### useAdminConfirmBatchJob
When a batch job is created, it's not executed automatically if `dry_run` is set to `true`. This hook confirms that the batch job should be executed.
#### Example
```ts
import React from "react"
import { useAdminConfirmBatchJob } from "medusa-react"
type Props = {
batchJobId: string
}
const BatchJob = ({ batchJobId }: Props) => {
const confirmBatchJob = useAdminConfirmBatchJob(batchJobId)
// ...
const handleConfirm = () => {
confirmBatchJob.mutate(undefined, {
onSuccess: ({ batch_job }) => {
console.log(batch_job)
}
})
}
// ...
}
export default BatchJob
```
#### Hook Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="useAdminConfirmBatchJob"/>
#### Mutation Function Returned Data
<TypeList types={[{"name":"AdminBatchJobRes","type":"`AdminBatchJobRes`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="useAdminConfirmBatchJob"/>
### useAdminCreateInvite
#### Mutation Function Parameters
<TypeList types={[{"name":"AdminPostInvitesPayload","type":"`AdminPostInvitesPayload`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="useAdminCreateInvite"/>
### useAdminProductVariants
#### Hook Parameters
<TypeList types={[{"name":"id","type":"`string`","description":"The product's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`AdminGetProductsVariantsParams`","description":"Configurations to apply on the retrieved product variants.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="useAdminProductVariants"/>
#### Query Returned Data
<TypeList types={[{"name":"AdminProductsListVariantsRes","type":"`AdminProductsListVariantsRes`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="useAdminProductVariants"/>
### queryKeysFactory
#### Type Parameters
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TListQueryType","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TDetailQueryType","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="queryKeysFactory"/>
#### Parameters
<TypeList types={[{"name":"globalKey","type":"T","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="queryKeysFactory"/>
#### Returns
<TypeList types={[{"name":"TQueryKey","type":"[TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)&#60;T, TListQueryType, TDetailQueryType&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"T","type":"T","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TListQueryType","type":"TListQueryType","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"TDetailQueryType","type":"TDetailQueryType","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} sectionTitle="queryKeysFactory"/>
### useLocalStorage
#### Parameters
<TypeList types={[{"name":"key","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"initialState","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="useLocalStorage"/>
#### Returns
<TypeList types={[{"name":"readonly [string, (data: string) => void, () => void]","type":"readonly [`string`, (`data`: `string`) => `void`, () => `void`]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="useLocalStorage"/>