chore: reorganize docs apps (#7228)

* reorganize docs apps * add README * fix directory * add condition for old docs
2024-05-03 17:36:38 +03:00
parent 224ebb2154
commit 4fe28f5a95
6187 changed files with 601447 additions and 598226 deletions
@@ -0,0 +1,349 @@
+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](../../medusa/classes/medusa.FindParams/page.mdx)) => (`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](../../medusa/classes/medusa.StoreGetOrdersParams/page.mdx)) => [`\"orders\"`, `\"list\"`, ``{ query: undefined \\| [StoreGetOrdersParams](../../medusa/classes/medusa.StoreGetOrdersParams/page.mdx)  }``]","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](../../medusa/types/medusa.AdminBatchJobRes/page.mdx)","optional":false,"defaultValue":"","description":"The batch job's details.","expandable":false,"children":[{"name":"batch_job","type":"`BatchJob`","description":"Batch job details.","optional":false,"defaultValue":"","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](../../medusa/classes/medusa.AdminGetProductsVariantsParams/page.mdx)","description":"Configurations to apply on the retrieved product variants.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter product variants by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.\nif a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.\nwithout prefix it will replace the entire default fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"100","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search product variants' title, sku, and products' title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_quantity","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator/page.mdx)","description":"Number filters to apply on product variants' `inventory_quantity` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Filter product variants by whether their inventory is managed or not.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"Filter product variants by whether they are allowed to be backordered or not.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator/page.mdx)","description":"Date filters to apply on the product variants' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator/page.mdx)","description":"Date filters to apply on the product variants' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}  sectionTitle="useAdminProductVariants"/>
+
+#### Query Returned Data
+
+<TypeList types={[{"name":"limit","type":"`number`","description":"The maximum number of items that can be returned in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items skipped before the returned items in the list.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"The total number of items available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../medusa_react/types/medusa_react.ProductVariant/page.mdx)[]","description":"An array of product variants details.","optional":false,"defaultValue":"","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"/>