chore: improve JS Client TSDoc comments (#5582)

* add oas schema to tsdoc parser

* add tsdoc (part 1)

* Finished tsdoc in js client

* general fixes

* added tsdoc in core medusa package

* parse schema tags in model files

* added maxlevel option

* added more tsdoc

* added tsdoc in core

* added TSDoc in core package

* generated client types

* support featureFlag and expandable tags

* added support for resource feature flag note

* fix api ignore plugin

* added eslint plugin

* support feature flag and expandable badges

* adjusted overview page + generated reference

* revert generated files

* added changeset

* add details about new typedoc options

* fix broken link

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

@@ -19,6 +19,9 @@ export interface AddressPayload {
    * Phone Number
    */
   phone?: string
+  /**
+   * Company
+   */
   company?: string
   /**
    * Address line 1

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { User } from "./User"
 
+/**
+ * The user's details.
+ */
 export interface AdminAuthRes {
   /**
    * User details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { BatchJob } from "./BatchJob"
 
+/**
+ * The batch job's details.
+ */
 export interface AdminBatchJobRes {
   /**
    * Batch job details.

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The access token of the user, if they're authenticated successfully.
+ */
 export interface AdminBearerAuthRes {
   /**
    * Access token that can be used to send authenticated requests.

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

@@ -5,6 +5,12 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ProductCollection } from "./ProductCollection"
 
+/**
+ * The collection's details.
+ */
 export interface AdminCollectionsRes {
+  /**
+   * Product Collection details.
+   */
   collection: SetRelation<ProductCollection, "products">
 }

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Currency } from "./Currency"
 
+/**
+ * List of currencies with pagination fields.
+ */
 export interface AdminCurrenciesListRes {
   /**
    * An array of currency details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Currency } from "./Currency"
 
+/**
+ * A currency's details.
+ */
 export interface AdminCurrenciesRes {
   /**
    * Currency details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { CustomerGroup } from "./CustomerGroup"
 
+/**
+ * The customer group's details.
+ */
 export interface AdminCustomerGroupsRes {
   /**
    * Customer group details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Customer } from "./Customer"
 
+/**
+ * The list of customers with pagination fields.
+ */
 export interface AdminCustomersListRes {
   /**
    * An array of customer details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Customer } from "./Customer"
 
+/**
+ * The customer's details.
+ */
 export interface AdminCustomersRes {
   /**
    * Customer details.

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The resources to remove.
+ */
 export interface AdminDeleteDiscountsDiscountConditionsConditionBatchReq {
   /**
    * The resources to be removed from the discount condition

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * Deletion operation details
+ */
 export interface AdminDeleteProductsFromCollectionRes {
   /**
    * The ID of the collection

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * Product types to remove from the tax rates.
+ */
 export interface AdminDeleteTaxRatesTaxRateProductTypesReq {
   /**
    * The IDs of the product types to remove their association with this tax rate.

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

@@ -6,7 +6,13 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Discount } from "./Discount"
 import type { DiscountRule } from "./DiscountRule"
 
+/**
+ * The list of discounts with pagination fields.
+ */
 export interface AdminDiscountsListRes {
+  /**
+   * The list of discounts.
+   */
   discounts: Array<
     Merge<
       SetRelation<Discount, "parent_discount" | "regions" | "rule">,

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

@@ -7,6 +7,9 @@ import type { Discount } from "./Discount"
 import type { DiscountRule } from "./DiscountRule"
 import type { Region } from "./Region"
 
+/**
+ * The discount's details.
+ */
 export interface AdminDiscountsRes {
   /**
    * Discount details.

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

@@ -7,6 +7,9 @@ import type { Cart } from "./Cart"
 import type { DraftOrder } from "./DraftOrder"
 import type { LineItem } from "./LineItem"
 
+/**
+ * The list of draft orders with pagination fields.
+ */
 export interface AdminDraftOrdersListRes {
   /**
    * An array of draft order's details.

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

@@ -12,6 +12,9 @@ import type { ProductVariant } from "./ProductVariant"
 import type { Region } from "./Region"
 import type { ShippingMethod } from "./ShippingMethod"
 
+/**
+ * The list of draft orders.
+ */
 export interface AdminDraftOrdersRes {
   /**
    * Draft order's details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ExtendedStoreDTO } from "./ExtendedStoreDTO"
 
+/**
+ * The store's details with additional details like payment and tax providers.
+ */
 export interface AdminExtendedStoresRes {
   /**
    * Store details.

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The list of fulfillment options in a region.
+ */
 export interface AdminGetRegionsRegionFulfillmentOptionsRes {
   /**
    * Fulfillment providers details.

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

@@ -5,9 +5,12 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { VariantInventory } from "./VariantInventory"
 
+/**
+ * The variant's inventory details.
+ */
 export interface AdminGetVariantsVariantInventoryRes {
   /**
-   * The product variant's.
+   * The product variant's inventory details.
    */
   variant?: VariantInventory
 }

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

@@ -6,7 +6,13 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { GiftCard } from "./GiftCard"
 import type { Region } from "./Region"
 
+/**
+ * The list of gift cards with pagination fields.
+ */
 export interface AdminGiftCardsListRes {
+  /**
+   * The list of gift cards.
+   */
   gift_cards: Array<
     Merge<
       SetRelation<GiftCard, "order" | "region">,

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

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { GiftCard } from "./GiftCard"
 import type { Region } from "./Region"
 
+/**
+ * The gift card's details.
+ */
 export interface AdminGiftCardsRes {
   /**
    * A gift card's details.

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

@@ -5,12 +5,18 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { InventoryLevelDTO } from "./InventoryLevelDTO"
 
+/**
+ * Details of inventory items and their associated location levels.
+ */
 export interface AdminInventoryItemsLocationLevelsRes {
+  /**
+   * An inventory item's ID and associated location levels.
+   */
   inventory_item: {
     /**
      * The id of the location
      */
-    id: any
+    id: string
     /**
      * List of stock levels at a given location
      */

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { InventoryItemDTO } from "./InventoryItemDTO"
 
+/**
+ * The inventory item's details.
+ */
 export interface AdminInventoryItemsRes {
   /**
    * Inventory Item details

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Invite } from "./Invite"
 
+/**
+ * The list of invites.
+ */
 export interface AdminListInvitesRes {
   /**
    * An array of invites

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Note } from "./Note"
 
+/**
+ * The list of notes with pagination fields.
+ */
 export interface AdminNotesListRes {
   /**
    * An array of notes

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Note } from "./Note"
 
+/**
+ * The note's details.
+ */
 export interface AdminNotesRes {
   /**
    * Note details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Notification } from "./Notification"
 
+/**
+ * The notification's details.
+ */
 export interface AdminNotificationsRes {
   /**
    * Notification details

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of deleting order edit item changes.
+ */
 export interface AdminOrderEditItemChangeDeleteRes {
   /**
    * The ID of the deleted Order Edit Item Change.

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

@@ -7,6 +7,9 @@ import type { LineItem } from "./LineItem"
 import type { OrderEdit } from "./OrderEdit"
 import type { OrderItemChange } from "./OrderItemChange"
 
+/**
+ * The list of order edits with pagination fields.
+ */
 export interface AdminOrderEditsListRes {
   /**
    * An array of order edit details

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

@@ -7,6 +7,9 @@ import type { LineItem } from "./LineItem"
 import type { OrderEdit } from "./OrderEdit"
 import type { OrderItemChange } from "./OrderItemChange"
 
+/**
+ * The order edit details.
+ */
 export interface AdminOrderEditsRes {
   /**
    * Order edit details

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

@@ -18,6 +18,9 @@ import type { ReturnItem } from "./ReturnItem"
 import type { ShippingMethod } from "./ShippingMethod"
 import type { Swap } from "./Swap"
 
+/**
+ * The list of orders with pagination fields.
+ */
 export interface AdminOrdersListRes {
   /**
    * An array of order details.

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

@@ -18,6 +18,9 @@ import type { ReturnItem } from "./ReturnItem"
 import type { ShippingMethod } from "./ShippingMethod"
 import type { Swap } from "./Swap"
 
+/**
+ * The order's details.
+ */
 export interface AdminOrdersRes {
   /**
    * Order details.

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of deleting a payment collection.
+ */
 export interface AdminPaymentCollectionDeleteRes {
   /**
    * The ID of the deleted Payment Collection.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { PaymentProvider } from "./PaymentProvider"
 
+/**
+ * The list of payment providers in a store.
+ */
 export interface AdminPaymentProvidersList {
   /**
    * An array of payment providers details.

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

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

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

@@ -9,7 +9,7 @@ export interface AdminPostDiscountsDiscountConditionsConditionBatchReq {
    */
   resources: Array<{
     /**
-     * The id of the item
+     * The ID of the item
      */
     id: string
   }>

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Order } from "./Order"
 
+/**
+ * The order's details.
+ */
 export interface AdminPostDraftOrdersDraftOrderRegisterPaymentRes {
   /**
    * Order's details.

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The attributes to update in an inventory item.
+ */
 export interface AdminPostInventoryItemsInventoryItemReq {
   /**
    * The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
@@ -36,6 +39,18 @@ export interface AdminPostInventoryItemsInventoryItemReq {
    * The length of the Inventory Item. May be used in shipping rate calculations.
    */
   length?: number
+  /**
+   * The inventory item's title.
+   */
+  title?: string
+  /**
+   * The inventory item's description.
+   */
+  description?: string
+  /**
+   * The inventory item's thumbnail.
+   */
+  thumbnail?: string
   /**
    * Whether the item requires shipping.
    */

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

@@ -68,6 +68,18 @@ export interface AdminPostInventoryItemsReq {
    * The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.
    */
   material?: string
+  /**
+   * The inventory item's title.
+   */
+  title?: string
+  /**
+   * The inventory item's description.
+   */
+  description?: string
+  /**
+   * The inventory item's thumbnail.
+   */
+  thumbnail?: string
   /**
    * An optional set of key-value pairs with additional information.
    */

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the invite to be accepted.
+ */
 export interface AdminPostInvitesInviteAcceptReq {
   /**
    * The token of the invite to accept. This is a unique token generated when the invite was created or resent.

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

@@ -12,4 +12,8 @@ export interface AdminPostOrdersOrderClaimsClaimFulfillmentsReq {
    * If set to `true`, no notification will be sent to the customer related to this Claim.
    */
   no_notification?: boolean
+  /**
+   * The ID of the fulfillment's location.
+   */
+  location_id?: string
 }

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { AddressPayload } from "./AddressPayload"
 
+/**
+ * The details of the claim to be created.
+ */
 export interface AdminPostOrdersOrderClaimsReq {
   /**
    * The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items.
@@ -98,6 +101,10 @@ export interface AdminPostOrdersOrderClaimsReq {
    * If set to true no notification will be send related to this Claim.
    */
   no_notification?: boolean
+  /**
+   * The ID of the location used for the associated return.
+   */
+  return_location_id?: string
   /**
    * An optional set of key-value pairs to hold additional information.
    */

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of the fulfillment to be created.
+ */
 export interface AdminPostOrdersOrderFulfillmentsReq {
   /**
    * The Line Items to include in the Fulfillment.
@@ -17,6 +20,10 @@ export interface AdminPostOrdersOrderFulfillmentsReq {
      */
     quantity: number
   }>
+  /**
+   * The ID of the location where the items will be fulfilled from.
+   */
+  location_id?: string
   /**
    * If set to `true`, no notification will be sent to the customer related to this fulfillment.
    */

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

@@ -9,7 +9,7 @@ import type { LineItem } from "./LineItem"
 
 export interface AdminPostOrdersOrderReq {
   /**
-   * the email associated with the order
+   * The email associated with the order
    */
   email?: string
   /**

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

@@ -54,4 +54,8 @@ export interface AdminPostOrdersOrderReturnsReq {
    * The amount to refund.
    */
   refund?: number
+  /**
+   * The ID of the location used for the return.
+   */
+  location_id?: string
 }

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The shipping method's details.
+ */
 export interface AdminPostOrdersOrderShippingMethodsReq {
   /**
    * The price (excluding VAT) that should be charged for the Shipping Method
@@ -15,5 +18,5 @@ export interface AdminPostOrdersOrderShippingMethodsReq {
   /**
    * The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider.
    */
-  date?: Record<string, any>
+  data?: Record<string, any>
 }

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

@@ -51,6 +51,10 @@ export interface AdminPostOrdersOrderSwapsReq {
      */
     quantity: number
   }>
+  /**
+   * The ID of the sales channel associated with the swap.
+   */
+  sales_channel_id?: string
   /**
    * An array of custom shipping options to potentially create a Shipping Method from to send the additional items.
    */
@@ -68,6 +72,10 @@ export interface AdminPostOrdersOrderSwapsReq {
    * If set to `true`, no notification will be sent to the customer related to this Swap.
    */
   no_notification?: boolean
+  /**
+   * The ID of the location used for the associated return.
+   */
+  return_location_id?: string
   /**
    * If set to `true`, swaps can be completed with items out of stock
    */

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

@@ -12,4 +12,8 @@ export interface AdminPostOrdersOrderSwapsSwapFulfillmentsReq {
    * If set to `true`, no notification will be sent to the customer related to this swap.
    */
   no_notification?: boolean
+  /**
+   * The ID of the fulfillment's location.
+   */
+  location_id?: string
 }

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

@@ -214,6 +214,10 @@ export interface AdminPostProductsProductReq {
    * The width of the Product.
    */
   width?: number
+  /**
+   * The Harmonized System code of the product variant.
+   */
+  hs_code?: string
   /**
    * The country of origin of the Product.
    */

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

@@ -20,6 +20,10 @@ export interface AdminPostReservationsReq {
    * The quantity to reserve.
    */
   quantity: number
+  /**
+   * The reservation's description.
+   */
+  description?: string
   /**
    * An optional set of key-value pairs with additional information.
    */

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

@@ -12,6 +12,10 @@ export interface AdminPostReservationsReservationReq {
    * The quantity to reserve.
    */
   quantity?: number
+  /**
+   * The reservation's description.
+   */
+  description?: string
   /**
    * An optional set of key-value pairs with additional information.
    */

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

@@ -21,4 +21,8 @@ export interface AdminPostReturnsReturnReceiveReq {
    * The amount to refund.
    */
   refund?: number
+  /**
+   * The ID of the location to return items from.
+   */
+  location_id?: string
 }

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

@@ -12,4 +12,8 @@ export interface AdminPostShippingProfilesReq {
    * The type of the Shipping Profile
    */
   type: "default" | "gift_card" | "custom"
+  /**
+   * An optional set of key-value pairs with additional information.
+   */
+  metadata?: Record<string, any>
 }

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

@@ -18,5 +18,8 @@ export interface AdminPostStockLocationsLocationReq {
    * An optional key-value map with additional details
    */
   metadata?: Record<string, any>
+  /**
+   * The data of an associated address to create or update.
+   */
   address?: StockLocationAddressInput
 }

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

@@ -21,7 +21,7 @@ export interface AdminPostStockLocationsReqAddress {
    */
   city?: string
   /**
-   * The 2 character ISO code for the country.
+   * The two character ISO code for the country.
    */
   country_code: string
   /**

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

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

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

@@ -3,7 +3,13 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of deleting a price list.
+ */
 export interface AdminPriceListDeleteBatchRes {
+  /**
+   * The IDs of the deleted prices.
+   */
   ids: Array<string>
   /**
    * The type of the object that was deleted. A price is also named `money-amount`.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { PriceList } from "./PriceList"
 
+/**
+ * The price list's details.
+ */
 export interface AdminPriceListRes {
   /**
    * Price List details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { PriceList } from "./PriceList"
 
+/**
+ * The list of price lists with pagination fields.
+ */
 export interface AdminPriceListsListRes {
   /**
    * An array of price lists details.

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

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Product } from "./Product"
 import type { ProductVariant } from "./ProductVariant"
 
+/**
+ * The list of products with pagination fields.
+ */
 export interface AdminPriceListsProductsListRes {
   /**
    * An array of products details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ProductCategory } from "./ProductCategory"
 
+/**
+ * The product category's details.
+ */
 export interface AdminProductCategoriesCategoryRes {
   /**
    * Product category details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ProductCategory } from "./ProductCategory"
 
+/**
+ * The list of product categories with pagination fields.
+ */
 export interface AdminProductCategoriesListRes {
   /**
    * An array of product category details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ProductTag } from "./ProductTag"
 
+/**
+ * The list of product tags with pagination fields.
+ */
 export interface AdminProductTagsListRes {
   /**
    * An array of product tag details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ProductType } from "./ProductType"
 
+/**
+ * The list of product types with pagination fields.
+ */
 export interface AdminProductTypesListRes {
   /**
    * An array of product types details.

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

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { PricedProduct } from "./PricedProduct"
 import type { ProductVariant } from "./ProductVariant"
 
+/**
+ * The details of deleting a product's option.
+ */
 export interface AdminProductsDeleteOptionRes {
   /**
    * The ID of the deleted Product Option

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The details of deleting a product.
+ */
 export interface AdminProductsDeleteRes {
   /**
    * The ID of the deleted Product.

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

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { PricedProduct } from "./PricedProduct"
 import type { ProductVariant } from "./ProductVariant"
 
+/**
+ * The details of deleting a product's variant.
+ */
 export interface AdminProductsDeleteVariantRes {
   /**
    * The ID of the deleted Product Variant.

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

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { PricedProduct } from "./PricedProduct"
 import type { ProductVariant } from "./ProductVariant"
 
+/**
+ * The list of products with pagination fields.
+ */
 export interface AdminProductsListRes {
   /**
    * An array of products details.

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The usage details of product tags.
+ */
 export interface AdminProductsListTagsRes {
   /**
    * An array of product tags details.

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

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { PricedProduct } from "./PricedProduct"
 import type { ProductVariant } from "./ProductVariant"
 
+/**
+ * The product's details.
+ */
 export interface AdminProductsRes {
   /**
    * Product details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { PublishableApiKey } from "./PublishableApiKey"
 
+/**
+ * The list of publishable API keys with pagination fields.
+ */
 export interface AdminPublishableApiKeysListRes {
   /**
    * An array of publishable API keys details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { SalesChannel } from "./SalesChannel"
 
+/**
+ * The list of sales channel.
+ */
 export interface AdminPublishableApiKeysListSalesChannelsRes {
   /**
    * An array of sales channels details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { PublishableApiKey } from "./PublishableApiKey"
 
+/**
+ * The publishable API key's details.
+ */
 export interface AdminPublishableApiKeysRes {
   /**
    * Publishable API key details.

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

@@ -5,9 +5,12 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Refund } from "./Refund"
 
+/**
+ * The refund's details.
+ */
 export interface AdminRefundRes {
   /**
-   * Refund details
+   * Refund details.
    */
   refund: Refund
 }

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Region } from "./Region"
 
+/**
+ * The list of regions with pagination fields.
+ */
 export interface AdminRegionsListRes {
   /**
    * An array of regions details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Region } from "./Region"
 
+/**
+ * The region's details.
+ */
 export interface AdminRegionsRes {
   /**
    * Region details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ExtendedReservationItem } from "./ExtendedReservationItem"
 
+/**
+ * The list of reservations with pagination fields.
+ */
 export interface AdminReservationsListRes {
   /**
    * An array of reservations details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ReservationItemDTO } from "./ReservationItemDTO"
 
+/**
+ * The reservation's details.
+ */
 export interface AdminReservationsRes {
   /**
    * Reservation details.

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

@@ -5,7 +5,13 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ReturnReason } from "./ReturnReason"
 
+/**
+ * The list of return reasons.
+ */
 export interface AdminReturnReasonsListRes {
+  /**
+   * The list of return reasons.
+   */
   return_reasons: Array<
     SetRelation<ReturnReason, "parent_return_reason" | "return_reason_children">
   >

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

@@ -5,7 +5,13 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ReturnReason } from "./ReturnReason"
 
+/**
+ * The return reason's details.
+ */
 export interface AdminReturnReasonsRes {
+  /**
+   * The return reason's details.
+   */
   return_reason: SetRelation<
     ReturnReason,
     "parent_return_reason" | "return_reason_children"

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

@@ -14,6 +14,9 @@ import type { ReturnItem } from "./ReturnItem"
 import type { ShippingMethod } from "./ShippingMethod"
 import type { Swap } from "./Swap"
 
+/**
+ * The associated order's details.
+ */
 export interface AdminReturnsCancelRes {
   /**
    * Order details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Return } from "./Return"
 
+/**
+ * The list of returns with pagination fields.
+ */
 export interface AdminReturnsListRes {
   /**
    * An array of returns details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Return } from "./Return"
 
+/**
+ * The return's details.
+ */
 export interface AdminReturnsRes {
   /**
    * Return details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { SalesChannel } from "./SalesChannel"
 
+/**
+ * The list of sales channels with pagination fields.
+ */
 export interface AdminSalesChannelsListRes {
   /**
    * An array of sales channels details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { SalesChannel } from "./SalesChannel"
 
+/**
+ * The sales channel's details.
+ */
 export interface AdminSalesChannelsRes {
   /**
    * Sales Channel's details.

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

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Region } from "./Region"
 import type { ShippingOption } from "./ShippingOption"
 
+/**
+ * The list of shipping options with pagination fields.
+ */
 export interface AdminShippingOptionsListRes {
   /**
    * An array of shipping options details.

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

@@ -6,6 +6,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Region } from "./Region"
 import type { ShippingOption } from "./ShippingOption"
 
+/**
+ * The shipping option's details.
+ */
 export interface AdminShippingOptionsRes {
   /**
    * Shipping option details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ShippingProfile } from "./ShippingProfile"
 
+/**
+ * The list of shipping profiles.
+ */
 export interface AdminShippingProfilesListRes {
   /**
    * An array of shipping profiles details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { ShippingProfile } from "./ShippingProfile"
 
+/**
+ * The shipping profile's details.
+ */
 export interface AdminShippingProfilesRes {
   /**
    * Shipping profile details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { StockLocationExpandedDTO } from "./StockLocationExpandedDTO"
 
+/**
+ * The list of stock locations with pagination fields.
+ */
 export interface AdminStockLocationsListRes {
   stock_locations: Array<StockLocationExpandedDTO>
   /**

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { StockLocationExpandedDTO } from "./StockLocationExpandedDTO"
 
+/**
+ * The stock location's details.
+ */
 export interface AdminStockLocationsRes {
   /**
    * Stock location details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Store } from "./Store"
 
+/**
+ * The store's details.
+ */
 export interface AdminStoresRes {
   /**
    * Store details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { Swap } from "./Swap"
 
+/**
+ * The list of swaps with pagination fields.
+ */
 export interface AdminSwapsListRes {
   /**
    * An array of swaps details.

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

@@ -9,6 +9,9 @@ import type { LineItem } from "./LineItem"
 import type { ShippingMethod } from "./ShippingMethod"
 import type { Swap } from "./Swap"
 
+/**
+ * The swap's details.
+ */
 export interface AdminSwapsRes {
   /**
    * Swap details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { TaxProvider } from "./TaxProvider"
 
+/**
+ * The list of tax providers in a store.
+ */
 export interface AdminTaxProvidersList {
   /**
    * An array of tax providers details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { TaxRate } from "./TaxRate"
 
+/**
+ * The list of tax rates with pagination fields.
+ */
 export interface AdminTaxRatesListRes {
   /**
    * An array of tax rate details.

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

@@ -5,6 +5,9 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 import type { TaxRate } from "./TaxRate"
 
+/**
+ * The tax rate's details.
+ */
 export interface AdminTaxRatesRes {
   /**
    * Tax rate details.

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The download URL details.
+ */
 export interface AdminUploadsDownloadUrlRes {
   /**
    * The Download URL of the file

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

@@ -3,6 +3,9 @@
 /* eslint-disable */
 import { SetRelation, Merge } from "../core/ModelUtils"
 
+/**
+ * The list of uploaded files.
+ */
 export interface AdminUploadsRes {
   /**
    * Uploaded files details.