docs: generate medusa-react reference (#6004)

* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option

packages/generated/client-types/src/lib/models/AdminDeleteCustomerGroupsGroupCustomerBatchReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The customers to remove from the customer group.
+ */
 export interface AdminDeleteCustomerGroupsGroupCustomerBatchReq {
   /**
    * The ids of the customers to remove

packages/generated/client-types/src/lib/models/AdminDeletePriceListPricesPricesReq.ts

@@ -3,9 +3,12 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the prices to delete.
+ */
 export interface AdminDeletePriceListPricesPricesReq {
   /**
-   * The price IDs of the Money Amounts to delete.
+   * The IDs of the prices to delete.
    */
   price_ids?: Array<string>
 }

packages/generated/client-types/src/lib/models/AdminDeletePriceListsPriceListProductsPricesBatchReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products' prices to delete.
+ */
 export interface AdminDeletePriceListsPriceListProductsPricesBatchReq {
   /**
    * The IDs of the products to delete their associated prices.

packages/generated/client-types/src/lib/models/AdminDeleteProductCategoriesCategoryProductsBatchReq.ts

@@ -3,9 +3,12 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products to delete from the product category.
+ */
 export interface AdminDeleteProductCategoriesCategoryProductsBatchReq {
   /**
-   * The IDs of the products to delete from the Product Category.
+   * The IDs of the products to delete from the product category.
    */
   product_ids: Array<{
     /**

packages/generated/client-types/src/lib/models/AdminDeleteProductsFromCollectionReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products to remove from the collection.
+ */
 export interface AdminDeleteProductsFromCollectionReq {
   /**
    * An array of Product IDs to remove from the Product Collection.

packages/generated/client-types/src/lib/models/AdminDeletePublishableApiKeySalesChannelsBatchReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the sales channels to remove from the publishable API key.
+ */
 export interface AdminDeletePublishableApiKeySalesChannelsBatchReq {
   /**
    * The IDs of the sales channels to remove from the publishable API key

packages/generated/client-types/src/lib/models/AdminDeleteSalesChannelsChannelProductsBatchReq.ts

@@ -3,9 +3,12 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products to delete from the sales channel.
+ */
 export interface AdminDeleteSalesChannelsChannelProductsBatchReq {
   /**
-   * The IDs of the products to remove from the Sales Channel.
+   * The IDs of the products to remove from the sales channel.
    */
   product_ids: Array<{
     /**

packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateProductsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products to remove their associated with the tax rate.
+ */
 export interface AdminDeleteTaxRatesTaxRateProductsReq {
   /**
    * The IDs of the products to remove their association with this tax rate.

packages/generated/client-types/src/lib/models/AdminDeleteTaxRatesTaxRateShippingOptionsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the shipping options to remove their associate with the tax rate.
+ */
 export interface AdminDeleteTaxRatesTaxRateShippingOptionsReq {
   /**
    * The IDs of the shipping options to remove their association with this tax rate.

packages/generated/client-types/src/lib/models/AdminDeleteUploadsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the file to delete.
+ */
 export interface AdminDeleteUploadsReq {
   /**
    * key of the file to delete. This is obtained when you first uploaded the file, or by the file service if you used it directly.

packages/generated/client-types/src/lib/models/AdminPaymentCollectionsRes.ts

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { PaymentCollection } from "./PaymentCollection"
 import type { Region } from "./Region"
 
+/**
+ * The payment collection's details.
+ */
 export interface AdminPaymentCollectionsRes {
   /**
    * Payment Collection details.

packages/generated/client-types/src/lib/models/AdminPostAuthReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The admin's credentials used to log in.
+ */
 export interface AdminPostAuthReq {
   /**
    * The user's email.

packages/generated/client-types/src/lib/models/AdminPostBatchesReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the batch job to create.
+ */
 export interface AdminPostBatchesReq {
   /**
    * The type of batch job to start, which is defined by the `batchType` property of the associated batch job strategy.

packages/generated/client-types/src/lib/models/AdminPostCollectionsCollectionReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The product collection's details to update.
+ */
 export interface AdminPostCollectionsCollectionReq {
   /**
    * The title of the collection.

packages/generated/client-types/src/lib/models/AdminPostCollectionsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The product collection's details.
+ */
 export interface AdminPostCollectionsReq {
   /**
    * The title of the collection.

packages/generated/client-types/src/lib/models/AdminPostCurrenciesCurrencyReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update in the currency
+ */
 export interface AdminPostCurrenciesCurrencyReq {
   /**
    * Tax included in prices of currency.

packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupCustomersBatchReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The customers to add to the customer group.
+ */
 export interface AdminPostCustomerGroupsGroupCustomersBatchReq {
   /**
    * The ids of the customers to add

packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsGroupReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update in the customer group.
+ */
 export interface AdminPostCustomerGroupsGroupReq {
   /**
    * Name of the customer group

packages/generated/client-types/src/lib/models/AdminPostCustomerGroupsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the customer group to create.
+ */
 export interface AdminPostCustomerGroupsReq {
   /**
    * Name of the customer group

packages/generated/client-types/src/lib/models/AdminPostCustomersCustomerReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the customer to update.
+ */
 export interface AdminPostCustomersCustomerReq {
   /**
    * The Customer's email. You can't update the email of a registered customer.

packages/generated/client-types/src/lib/models/AdminPostCustomersReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the customer to create.
+ */
 export interface AdminPostCustomersReq {
   /**
    * The customer's email.

packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountConditionsConditionBatchReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the resources to add.
+ */
 export interface AdminPostDiscountsDiscountConditionsConditionBatchReq {
   /**
    * The resources to be added to the discount condition

packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountDynamicCodesReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the dynamic discount to create.
+ */
 export interface AdminPostDiscountsDiscountDynamicCodesReq {
   /**
    * A unique code that will be used to redeem the Discount

packages/generated/client-types/src/lib/models/AdminPostDiscountsDiscountReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the discount to update.
+ */
 export interface AdminPostDiscountsDiscountReq {
   /**
    * A unique code that will be used to redeem the discount

packages/generated/client-types/src/lib/models/AdminPostDiscountsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the discount to create.
+ */
 export interface AdminPostDiscountsReq {
   /**
    * A unique code that will be used to redeem the discount

packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsItemReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the line item.
+ */
 export interface AdminPostDraftOrdersDraftOrderLineItemsItemReq {
   /**
    * The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price.

packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderLineItemsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the line item to create.
+ */
 export interface AdminPostDraftOrdersDraftOrderLineItemsReq {
   /**
    * The ID of the Product Variant associated with the line item. If the line item is custom, the `variant_id` should be omitted.

packages/generated/client-types/src/lib/models/AdminPostDraftOrdersDraftOrderReq.ts

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { AddressPayload } from "./AddressPayload"
 
+/**
+ * The details of the draft order to update.
+ */
 export interface AdminPostDraftOrdersDraftOrderReq {
   /**
    * The ID of the Region to create the Draft Order in.

packages/generated/client-types/src/lib/models/AdminPostDraftOrdersReq.ts

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { AddressPayload } from "./AddressPayload"
 
+/**
+ * The details of the draft order to create.
+ */
 export interface AdminPostDraftOrdersReq {
   /**
    * The status of the draft order. The draft order's default status is `open`. It's changed to `completed` when its payment is marked as paid.

packages/generated/client-types/src/lib/models/AdminPostGiftCardsGiftCardReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the gift card.
+ */
 export interface AdminPostGiftCardsGiftCardReq {
   /**
    * The value (excluding VAT) that the Gift Card should represent.

packages/generated/client-types/src/lib/models/AdminPostGiftCardsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the gift card to create.
+ */
 export interface AdminPostGiftCardsReq {
   /**
    * The value (excluding VAT) that the Gift Card should represent.

packages/generated/client-types/src/lib/models/AdminPostInventoryItemsItemLocationLevelsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the location level to create.
+ */
 export interface AdminPostInventoryItemsItemLocationLevelsReq {
   /**
    * the ID of the stock location

packages/generated/client-types/src/lib/models/AdminPostInventoryItemsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the inventory item to create.
+ */
 export interface AdminPostInventoryItemsReq {
   /**
    * The ID of the variant to create the inventory item for.

packages/generated/client-types/src/lib/models/AdminPostNotesNoteReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the note.
+ */
 export interface AdminPostNotesNoteReq {
   /**
    * The description of the Note.

packages/generated/client-types/src/lib/models/AdminPostNotesReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the note to be created.
+ */
 export interface AdminPostNotesReq {
   /**
    * The ID of the resource which the Note relates to. For example, an order ID.

packages/generated/client-types/src/lib/models/AdminPostNotificationsNotificationResendReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The resend details.
+ */
 export interface AdminPostNotificationsNotificationResendReq {
   /**
    * A new address or user identifier that the Notification should be sent to. If not provided, the previous `to` field of the notification will be used.

packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsLineItemReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to create or update of the line item change.
+ */
 export interface AdminPostOrderEditsEditLineItemsLineItemReq {
   /**
    * The quantity to update

packages/generated/client-types/src/lib/models/AdminPostOrderEditsEditLineItemsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the line item change to create.
+ */
 export interface AdminPostOrderEditsEditLineItemsReq {
   /**
    * The ID of the product variant associated with the item.

packages/generated/client-types/src/lib/models/AdminPostOrderEditsOrderEditReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the order edit.
+ */
 export interface AdminPostOrderEditsOrderEditReq {
   /**
    * An optional note to create or update in the order edit.

packages/generated/client-types/src/lib/models/AdminPostOrderEditsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the order edit to create.
+ */
 export interface AdminPostOrderEditsReq {
   /**
    * The ID of the order to create the edit for.

packages/generated/client-types/src/lib/models/AdminPostOrdersOrderRefundsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the order refund.
+ */
 export interface AdminPostOrdersOrderRefundsReq {
   /**
    * The amount to refund. It should be less than or equal the `refundable_amount` of the order.

packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReq.ts

@@ -7,6 +7,9 @@ import type { AddressPayload } from "./AddressPayload"
 import type { Discount } from "./Discount"
 import type { LineItem } from "./LineItem"
 
+/**
+ * The details to update of the order.
+ */
 export interface AdminPostOrdersOrderReq {
   /**
    * The email associated with the order

packages/generated/client-types/src/lib/models/AdminPostOrdersOrderReturnsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the requested return.
+ */
 export interface AdminPostOrdersOrderReturnsReq {
   /**
    * The line items that will be returned.

packages/generated/client-types/src/lib/models/AdminPostOrdersOrderShipmentReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the shipment to create.
+ */
 export interface AdminPostOrdersOrderShipmentReq {
   /**
    * The ID of the Fulfillment.

packages/generated/client-types/src/lib/models/AdminPostOrdersOrderSwapsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the swap to create.
+ */
 export interface AdminPostOrdersOrderSwapsReq {
   /**
    * The Line Items to associate with the swap's return.

packages/generated/client-types/src/lib/models/AdminPostPaymentRefundsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the refund to create.
+ */
 export interface AdminPostPaymentRefundsReq {
   /**
    * The amount to refund.

packages/generated/client-types/src/lib/models/AdminPostPriceListPricesPricesReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the prices to add.
+ */
 export interface AdminPostPriceListPricesPricesReq {
   /**
    * The prices to update or add.

packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListPriceListReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the payment collection.
+ */
 export interface AdminPostPriceListsPriceListPriceListReq {
   /**
    * The name of the Price List

packages/generated/client-types/src/lib/models/AdminPostPriceListsPriceListReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the price list to create.
+ */
 export interface AdminPostPriceListsPriceListReq {
   /**
    * The name of the Price List.

packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryProductsBatchReq.ts

@@ -3,9 +3,12 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products to add to the product category.
+ */
 export interface AdminPostProductCategoriesCategoryProductsBatchReq {
   /**
-   * The IDs of the products to add to the Product Category
+   * The IDs of the products to add to the product category
    */
   product_ids: Array<{
     /**

packages/generated/client-types/src/lib/models/AdminPostProductCategoriesCategoryReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the product category.
+ */
 export interface AdminPostProductCategoriesCategoryReq {
   /**
    * The name to identify the Product Category by.

packages/generated/client-types/src/lib/models/AdminPostProductCategoriesReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the product category to create.
+ */
 export interface AdminPostProductCategoriesReq {
   /**
    * The name of the product category

packages/generated/client-types/src/lib/models/AdminPostProductsProductOptionsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the product option to create.
+ */
 export interface AdminPostProductsProductOptionsReq {
   /**
    * The title the Product Option.

packages/generated/client-types/src/lib/models/AdminPostProductsProductReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the product.
+ */
 export interface AdminPostProductsProductReq {
   /**
    * The title of the Product

packages/generated/client-types/src/lib/models/AdminPostProductsProductVariantsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the product variant to create.
+ */
 export interface AdminPostProductsProductVariantsReq {
   /**
    * The title of the product variant.

packages/generated/client-types/src/lib/models/AdminPostProductsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the product to create.
+ */
 export interface AdminPostProductsReq {
   /**
    * The title of the Product

packages/generated/client-types/src/lib/models/AdminPostProductsToCollectionReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products to add to the collection.
+ */
 export interface AdminPostProductsToCollectionReq {
   /**
    * An array of Product IDs to add to the Product Collection.

packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeySalesChannelsBatchReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the sales channels to add to the publishable API key.
+ */
 export interface AdminPostPublishableApiKeySalesChannelsBatchReq {
   /**
    * The IDs of the sales channels to add to the publishable API key

packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysPublishableApiKeyReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the publishable API key.
+ */
 export interface AdminPostPublishableApiKeysPublishableApiKeyReq {
   /**
    * The title of the Publishable API Key.

packages/generated/client-types/src/lib/models/AdminPostPublishableApiKeysReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the publishable API key to create.
+ */
 export interface AdminPostPublishableApiKeysReq {
   /**
    * The title of the publishable API key

packages/generated/client-types/src/lib/models/AdminPostRegionsRegionCountriesReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the country to add to the region.
+ */
 export interface AdminPostRegionsRegionCountriesReq {
   /**
    * The 2 character ISO code for the Country.

packages/generated/client-types/src/lib/models/AdminPostRegionsRegionFulfillmentProvidersReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the fulfillment provider to add to the region.
+ */
 export interface AdminPostRegionsRegionFulfillmentProvidersReq {
   /**
    * The ID of the Fulfillment Provider.

packages/generated/client-types/src/lib/models/AdminPostRegionsRegionPaymentProvidersReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the payment provider to add to the region.
+ */
 export interface AdminPostRegionsRegionPaymentProvidersReq {
   /**
    * The ID of the Payment Provider.

packages/generated/client-types/src/lib/models/AdminPostRegionsRegionReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the regions.
+ */
 export interface AdminPostRegionsRegionReq {
   /**
    * The name of the Region

packages/generated/client-types/src/lib/models/AdminPostRegionsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the region to create.
+ */
 export interface AdminPostRegionsReq {
   /**
    * The name of the Region

packages/generated/client-types/src/lib/models/AdminPostReservationsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the reservation to create.
+ */
 export interface AdminPostReservationsReq {
   /**
    * The ID of the line item of the reservation.

packages/generated/client-types/src/lib/models/AdminPostReservationsReservationReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the reservation.
+ */
 export interface AdminPostReservationsReservationReq {
   /**
    * The ID of the location associated with the reservation.

packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReasonReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the return reason.
+ */
 export interface AdminPostReturnReasonsReasonReq {
   /**
    * The label to display to the Customer.

packages/generated/client-types/src/lib/models/AdminPostReturnReasonsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the return reason to create.
+ */
 export interface AdminPostReturnReasonsReq {
   /**
    * The label to display to the Customer.

packages/generated/client-types/src/lib/models/AdminPostReturnsReturnReceiveReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the received return.
+ */
 export interface AdminPostReturnsReturnReceiveReq {
   /**
    * The Line Items that have been received.

packages/generated/client-types/src/lib/models/AdminPostSalesChannelsChannelProductsBatchReq.ts

@@ -3,9 +3,12 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products to add to the sales channel.
+ */
 export interface AdminPostSalesChannelsChannelProductsBatchReq {
   /**
-   * The IDs of the products to add to the Sales Channel
+   * The IDs of the products to add to the sales channel
    */
   product_ids: Array<{
     /**

packages/generated/client-types/src/lib/models/AdminPostSalesChannelsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the sales channel to create.
+ */
 export interface AdminPostSalesChannelsReq {
   /**
    * The name of the Sales Channel

packages/generated/client-types/src/lib/models/AdminPostSalesChannelsSalesChannelReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the sales channel.
+ */
 export interface AdminPostSalesChannelsSalesChannelReq {
   /**
    * The name of the sales channel

packages/generated/client-types/src/lib/models/AdminPostShippingOptionsOptionReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the shipping option.
+ */
 export interface AdminPostShippingOptionsOptionReq {
   /**
    * The name of the Shipping Option

packages/generated/client-types/src/lib/models/AdminPostShippingOptionsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the shipping option to create.
+ */
 export interface AdminPostShippingOptionsReq {
   /**
    * The name of the Shipping Option

packages/generated/client-types/src/lib/models/AdminPostShippingProfilesProfileReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The detail to update of the shipping profile.
+ */
 export interface AdminPostShippingProfilesProfileReq {
   /**
    * The name of the Shipping Profile

packages/generated/client-types/src/lib/models/AdminPostShippingProfilesReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the shipping profile to create.
+ */
 export interface AdminPostShippingProfilesReq {
   /**
    * The name of the Shipping Profile

packages/generated/client-types/src/lib/models/AdminPostStockLocationsLocationReq.ts

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { StockLocationAddressInput } from "./StockLocationAddressInput"
 
+/**
+ * The details to update of the stock location.
+ */
 export interface AdminPostStockLocationsLocationReq {
   /**
    * the name of the stock location

packages/generated/client-types/src/lib/models/AdminPostStockLocationsReq.ts

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { StockLocationAddressInput } from "./StockLocationAddressInput"
 
+/**
+ * The details of the stock location to create.
+ */
 export interface AdminPostStockLocationsReq {
   /**
    * the name of the stock location

packages/generated/client-types/src/lib/models/AdminPostStoreReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the store.
+ */
 export interface AdminPostStoreReq {
   /**
    * The name of the Store

packages/generated/client-types/src/lib/models/AdminPostTaxRatesReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the tax rate to create.
+ */
 export interface AdminPostTaxRatesReq {
   /**
    * The code of the tax rate.

packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateProductsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the products to associat with the tax rate.
+ */
 export interface AdminPostTaxRatesTaxRateProductsReq {
   /**
    * The IDs of the products to associate with this tax rate

packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the tax rate.
+ */
 export interface AdminPostTaxRatesTaxRateReq {
   /**
    * The code of the tax rate.

packages/generated/client-types/src/lib/models/AdminPostTaxRatesTaxRateShippingOptionsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the shipping options to associate with the tax rate.
+ */
 export interface AdminPostTaxRatesTaxRateShippingOptionsReq {
   /**
    * The IDs of the shipping options to associate with this tax rate

packages/generated/client-types/src/lib/models/AdminPostUploadsDownloadUrlReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the file to retrieve its download URL.
+ */
 export interface AdminPostUploadsDownloadUrlReq {
   /**
    * key of the file to obtain the download link for. This is obtained when you first uploaded the file, or by the file service if you used it directly.

packages/generated/client-types/src/lib/models/AdminResetPasswordRequest.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the password reset request.
+ */
 export interface AdminResetPasswordRequest {
   /**
    * The User's email.

packages/generated/client-types/src/lib/models/AdminResetPasswordTokenRequest.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the password reset token request.
+ */
 export interface AdminResetPasswordTokenRequest {
   /**
    * The User's email.

packages/generated/client-types/src/lib/models/AdminStockLocationsListRes.ts

@@ -9,6 +9,9 @@ import type { StockLocationExpandedDTO } from "./StockLocationExpandedDTO"
  * The list of stock locations with pagination fields.
  */
 export interface AdminStockLocationsListRes {
+  /**
+   * The list of stock locations.
+   */
   stock_locations: Array<StockLocationExpandedDTO>
   /**
    * The total number of items available

packages/generated/client-types/src/lib/models/AdminUpdatePaymentCollectionsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the payment collection.
+ */
 export interface AdminUpdatePaymentCollectionsReq {
   /**
    * A description to create or update the payment collection.

packages/generated/client-types/src/lib/models/StorePaymentCollectionSessionsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the payment session to manage.
+ */
 export interface StorePaymentCollectionSessionsReq {
   /**
    * The ID of the Payment Provider.

packages/generated/client-types/src/lib/models/StorePaymentCollectionsSessionRes.ts

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { PaymentSession } from "./PaymentSession"
 
+/**
+ * The details of the payment session.
+ */
 export interface StorePaymentCollectionsSessionRes {
   /**
    * Payment session's details.

packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsItemReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details to update of the line item.
+ */
 export interface StorePostCartsCartLineItemsItemReq {
   /**
    * The quantity of the line item in the cart.

packages/generated/client-types/src/lib/models/StorePostCartsCartLineItemsReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the line item to create.
+ */
 export interface StorePostCartsCartLineItemsReq {
   /**
    * The id of the Product Variant to generate the Line Item from.

packages/generated/client-types/src/lib/models/StorePostCartsCartPaymentSessionReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the payment session to set.
+ */
 export interface StorePostCartsCartPaymentSessionReq {
   /**
    * The ID of the Payment Provider.

packages/generated/client-types/src/lib/models/StorePostCartsCartReq.ts

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { AddressPayload } from "./AddressPayload"
 
+/**
+ * The details to update of the cart.
+ */
 export interface StorePostCartsCartReq {
   /**
    * The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency.

packages/generated/client-types/src/lib/models/StorePostCartsCartShippingMethodReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the shipping method to add to the cart.
+ */
 export interface StorePostCartsCartShippingMethodReq {
   /**
    * ID of the shipping option to create the method from.

packages/generated/client-types/src/lib/models/StorePostCustomersCustomerAcceptClaimReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details necessary to grant order access.
+ */
 export interface StorePostCustomersCustomerAcceptClaimReq {
   /**
    * The claim token generated by previous request to the Claim Order API Route.

packages/generated/client-types/src/lib/models/StorePostCustomersCustomerOrderClaimReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the orders to claim.
+ */
 export interface StorePostCustomersCustomerOrderClaimReq {
   /**
    * The ID of the orders to claim

packages/generated/client-types/src/lib/models/StorePostCustomersCustomerReq.ts

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { AddressPayload } from "./AddressPayload"
 
+/**
+ * The details to update of the customer.
+ */
 export interface StorePostCustomersCustomerReq {
   /**
    * The customer's first name.

packages/generated/client-types/src/lib/models/StorePostCustomersReq.ts

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the customer to create.
+ */
 export interface StorePostCustomersReq {
   /**
    * The customer's first name.