chore(oas): improvements to examples and descriptions (#4545)

* improve curl examples in OAS

* update tags

* fix oas errors

* update tags and their descriptions

* updated oas of endpoints

* improved oas of all admin endpoints

* improved store OAS comments

* improved models OAS comments

* small change

docs/content/modules/orders/storefront/implement-claim-order.mdx

@@ -83,7 +83,7 @@ To allow the customer to claim an order, send a request to the Claim an Order en
 <TabItem value="client" label="Medusa JS Client" default>
 
 ```ts
-medusa.orders.claimOrders({
+medusa.orders.requestCustomerOrders({
   order_ids: [
     order_id,
   ],

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

@@ -7,7 +7,7 @@ import type { Country } from "./Country"
 import type { Customer } from "./Customer"
 
 /**
- * An address.
+ * An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
  */
 export interface Address {
   /**
@@ -51,7 +51,7 @@ export interface Address {
    */
   country_code: string | null
   /**
-   * A country object. Available if the relation `country` is expanded.
+   * A country object.
    */
   country?: Country | null
   /**

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { OAuth } from "./OAuth"
 
 export interface AdminAppsListRes {
+  /**
+   * An array of app details.
+   */
   apps: Array<OAuth>
 }

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { OAuth } from "./OAuth"
 
 export interface AdminAppsRes {
+  /**
+   * App details.
+   */
   apps: OAuth
 }

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

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

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { BatchJob } from "./BatchJob"
 
 export interface AdminBatchJobListRes {
+  /**
+   * An array of batch job details.
+   */
   batch_jobs: Array<BatchJob>
   /**
    * The total number of items available
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of batch jobs skipped when retrieving the batch jobs.
    */
   offset: number
   /**

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { BatchJob } from "./BatchJob"
 
 export interface AdminBatchJobRes {
+  /**
+   * Batch job details.
+   */
   batch_job: BatchJob
 }

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { ProductCollection } from "./ProductCollection"
 
 export interface AdminCollectionsListRes {
+  /**
+   * an array of collection details
+   */
   collections: Array<ProductCollection>
   /**
    * The total number of items available
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of product collections skipped when retrieving the product collections.
    */
   offset: number
   /**

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

@@ -5,23 +5,23 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminCreateUserRequest {
   /**
-   * The Users email.
+   * The User's email.
    */
   email: string
   /**
-   * The name of the User.
+   * The first name of the User.
    */
   first_name?: string
   /**
-   * The name of the User.
+   * The last name of the User.
    */
   last_name?: string
   /**
-   * Userrole assigned to the user.
+   * The role assigned to the user. These roles don't provide any different privileges.
    */
   role?: "admin" | "member" | "developer"
   /**
-   * The Users password.
+   * The User's password.
    */
   password: string
 }

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Currency } from "./Currency"
 
 export interface AdminCurrenciesListRes {
+  /**
+   * An array of currency details.
+   */
   currencies: Array<Currency>
   /**
    * The total number of items available
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of currencies skipped when retrieving the currencies.
    */
   offset: number
   /**

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

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

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { CustomerGroup } from "./CustomerGroup"
 
 export interface AdminCustomerGroupsListRes {
+  /**
+   * An array of customer group details.
+   */
   customer_groups: Array<CustomerGroup>
   /**
    * The total number of items available
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of customer groups skipped when retrieving the customer groups.
    */
   offset: number
   /**

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { CustomerGroup } from "./CustomerGroup"
 
 export interface AdminCustomerGroupsRes {
+  /**
+   * Customer group details.
+   */
   customer_group: CustomerGroup
 }

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Customer } from "./Customer"
 
 export interface AdminCustomersListRes {
+  /**
+   * An array of customer details.
+   */
   customers: Array<Customer>
   /**
    * The total number of items available
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of customers skipped when retrieving the customers.
    */
   offset: number
   /**

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Customer } from "./Customer"
 
 export interface AdminCustomersRes {
+  /**
+   * Customer details.
+   */
   customer: SetRelation<Customer, "orders" | "shipping_addresses">
 }

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteDiscountsDiscountConditionsConditionBatchReq {
   /**
-   * The resources to be deleted from the discount condition
+   * The resources to be removed from the discount condition
    */
   resources: Array<{
     /**

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteDiscountsDiscountConditionsConditionParams {
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned discount.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned discount.
    */
   fields?: string
 }

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeletePriceListPricesPricesReq {
   /**
-   * The price id's of the Money Amounts to delete.
+   * The price IDs of the Money Amounts to delete.
    */
   price_ids?: Array<string>
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteProductCategoriesCategoryProductsBatchParams {
   /**
-   * (Comma separated) Category fields to be expanded in the response.
+   * Comma-separated relations that should be expanded in the returned product category.
    */
   expand?: string
   /**
-   * (Comma separated) Category fields to be retrieved in the response.
+   * Comma-separated fields that should be included in the returned product category.
    */
   fields?: string
 }

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeletePublishableApiKeySalesChannelsBatchReq {
   /**
-   * The IDs of the sales channels to delete from the publishable api key
+   * The IDs of the sales channels to remove from the publishable API key
    */
   sales_channel_ids: Array<{
     /**

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteSalesChannelsChannelProductsBatchReq {
   /**
-   * The IDs of the products to delete 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/AdminDeleteTaxRatesTaxRateProductTypesParams.ts

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteTaxRatesTaxRateProductTypesParams {
   /**
-   * Which fields should be included in the result.
+   * Comma-separated fields that should be included in the returned tax rate.
    */
   fields?: Array<string>
   /**
-   * Which fields should be expanded and retrieved in the result.
+   * Comma-separated relations that should be expanded in the returned tax rate.
    */
   expand?: Array<string>
 }

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteTaxRatesTaxRateProductTypesReq {
   /**
-   * The IDs of the types of products to remove association with this tax rate
+   * The IDs of the product types to remove their association with this tax rate.
    */
   product_types: Array<string>
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteTaxRatesTaxRateProductsParams {
   /**
-   * Which fields should be included in the result.
+   * Comma-separated fields that should be included in the returned tax rate.
    */
   fields?: Array<string>
   /**
-   * Which fields should be expanded and retrieved in the result.
+   * Comma-separated relations that should be expanded in the returned tax rate.
    */
   expand?: Array<string>
 }

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteTaxRatesTaxRateProductsReq {
   /**
-   * The IDs of the products to remove association with this tax rate
+   * The IDs of the products to remove their association with this tax rate.
    */
   products: Array<string>
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteTaxRatesTaxRateShippingOptionsParams {
   /**
-   * Which fields should be included in the result.
+   * Comma-separated fields that should be included in the returned tax rate.
    */
   fields?: Array<string>
   /**
-   * Which fields should be expanded and retrieved in the result.
+   * Comma-separated relations that should be expanded in the returned tax rate.
    */
   expand?: Array<string>
 }

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminDeleteTaxRatesTaxRateShippingOptionsReq {
   /**
-   * The IDs of the shipping options to remove association with this tax rate
+   * The IDs of the shipping options to remove their association with this tax rate.
    */
   shipping_options: Array<string>
 }

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

@@ -7,7 +7,7 @@ import type { Discount } from "./Discount"
 
 export interface AdminDiscountConditionsDeleteRes {
   /**
-   * The ID of the deleted DiscountCondition
+   * The ID of the deleted Discount Condition
    */
   id: string
   /**
@@ -15,11 +15,11 @@ export interface AdminDiscountConditionsDeleteRes {
    */
   object: string
   /**
-   * Whether the discount condition was deleted successfully or not.
+   * Whether the discount condition was deleted successfully.
    */
   deleted: boolean
   /**
-   * The Discount to which the condition used to belong
+   * The Discount to which the condition used to belong to.
    */
   discount: Discount
 }

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { DiscountCondition } from "./DiscountCondition"
 
 export interface AdminDiscountConditionsRes {
+  /**
+   * Discount condition details.
+   */
   discount_condition: SetRelation<DiscountCondition, "discount_rule">
 }

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

@@ -13,7 +13,7 @@ export interface AdminDiscountsDeleteRes {
    */
   object: string
   /**
-   * Whether the discount was deleted successfully or not.
+   * Whether the discount was deleted successfully.
    */
   deleted: boolean
 }

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

@@ -20,7 +20,7 @@ export interface AdminDiscountsListRes {
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of discounts skipped when retrieving the discounts.
    */
   offset: number
   /**

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

@@ -8,6 +8,9 @@ import type { DiscountRule } from "./DiscountRule"
 import type { Region } from "./Region"
 
 export interface AdminDiscountsRes {
+  /**
+   * Discount details.
+   */
   discount: Merge<
     SetRelation<Discount, "parent_discount" | "regions" | "rule">,
     {

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

@@ -13,7 +13,7 @@ export interface AdminDraftOrdersDeleteRes {
    */
   object: string
   /**
-   * Whether the draft order was deleted successfully or not.
+   * Whether the draft order was deleted successfully.
    */
   deleted: boolean
 }

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

@@ -8,6 +8,9 @@ import type { DraftOrder } from "./DraftOrder"
 import type { LineItem } from "./LineItem"
 
 export interface AdminDraftOrdersListRes {
+  /**
+   * An array of draft order's details.
+   */
   draft_orders: Array<
     Merge<
       SetRelation<DraftOrder, "order" | "cart">,
@@ -26,7 +29,7 @@ export interface AdminDraftOrdersListRes {
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of draft orders skipped when retrieving the draft orders.
    */
   offset: number
   /**

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

@@ -13,6 +13,9 @@ import type { Region } from "./Region"
 import type { ShippingMethod } from "./ShippingMethod"
 
 export interface AdminDraftOrdersRes {
+  /**
+   * Draft order's details.
+   */
   draft_order: Merge<
     SetRelation<DraftOrder, "order" | "cart">,
     {

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { ExtendedStoreDTO } from "./ExtendedStoreDTO"
 
 export interface AdminExtendedStoresRes {
+  /**
+   * Store details.
+   */
   store: SetRelation<ExtendedStoreDTO, "currencies" | "default_currency">
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetBatchParams {
   /**
-   * The number of batch jobs to return.
+   * Limit the number of batch jobs returned.
    */
   limit?: number
   /**
-   * The number of batch jobs to skip before results.
+   * The number of batch jobs to skip when retrieving the batch jobs.
    */
   offset?: number
   /**
@@ -21,7 +21,7 @@ export interface AdminGetBatchParams {
    */
   type?: Array<string>
   /**
-   * Date comparison for when resulting collections was confirmed, i.e. less than, greater than etc.
+   * Filter by a confirmation date range.
    */
   confirmed_at?: {
     /**
@@ -42,7 +42,7 @@ export interface AdminGetBatchParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections was pre processed, i.e. less than, greater than etc.
+   * Filter by a pre-processing date range.
    */
   pre_processed_at?: {
     /**
@@ -63,7 +63,7 @@ export interface AdminGetBatchParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections was completed, i.e. less than, greater than etc.
+   * Filter by a completion date range.
    */
   completed_at?: {
     /**
@@ -84,7 +84,7 @@ export interface AdminGetBatchParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections was failed, i.e. less than, greater than etc.
+   * Filter by a failure date range.
    */
   failed_at?: {
     /**
@@ -105,7 +105,7 @@ export interface AdminGetBatchParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections was canceled, i.e. less than, greater than etc.
+   * Filter by a cancelation date range.
    */
   canceled_at?: {
     /**
@@ -126,19 +126,19 @@ export interface AdminGetBatchParams {
     gte?: string
   }
   /**
-   * Field used to order retrieved batch jobs
+   * A batch-job field to sort-order the retrieved batch jobs by.
    */
   order?: string
   /**
-   * (Comma separated) Which fields should be expanded in each order of the result.
+   * Comma-separated relations that should be expanded in the returned batch jobs.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in each order of the result.
+   * Comma-separated fields that should be included in the returned batch jobs.
    */
   fields?: string
   /**
-   * Date comparison for when resulting collections was created, i.e. less than, greater than etc.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -159,7 +159,7 @@ export interface AdminGetBatchParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections was updated, i.e. less than, greater than etc.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**

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

@@ -9,27 +9,27 @@ export interface AdminGetCollectionsParams {
    */
   limit?: number
   /**
-   * The number of collections to skip before the results.
+   * The number of collections to skip when retrieving the collections.
    */
   offset?: number
   /**
-   * The title of collections to return.
+   * Filter collections by their title.
    */
   title?: string
   /**
-   * The handle of collections to return.
+   * Filter collections by their handle.
    */
   handle?: string
   /**
-   * a search term to search titles and handles.
+   * a term to search collections by their title or handle.
    */
   q?: string
   /**
-   * The discount condition id on which to filter the product collections.
+   * Filter collections by a discount condition ID associated with them.
    */
   discount_condition_id?: string
   /**
-   * Date comparison for when resulting collections were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -50,7 +50,7 @@ export interface AdminGetCollectionsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**
@@ -71,7 +71,7 @@ export interface AdminGetCollectionsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections were deleted.
+   * Filter by a deletion date range.
    */
   deleted_at?: {
     /**

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

@@ -5,23 +5,23 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetCurrenciesParams {
   /**
-   * Code of the currency to search for.
+   * filter by currency code.
    */
   code?: string
   /**
-   * Search for tax inclusive currencies.
+   * filter currencies by whether they include taxes or not.
    */
   includes_tax?: boolean
   /**
-   * order to retrieve products in.
+   * A field to sort order the retrieved currencies by.
    */
   order?: string
   /**
-   * How many products to skip in the result.
+   * The number of currencies to skip when retrieving the currencies.
    */
   offset?: number
   /**
-   * Limit the number of products returned.
+   * The number of currencies to return.
    */
   limit?: number
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetCustomerGroupsGroupParams {
   /**
-   * (Comma separated) Which fields should be expanded in the customer group.
+   * Comma-separated relations that should be expanded in the returned customer group.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in the customer group.
+   * Comma-separated fields that should be included in the returned customer group.
    */
   fields?: string
 }

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

@@ -5,19 +5,19 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetCustomerGroupsParams {
   /**
-   * Query used for searching customer group names.
+   * term to search customer groups by name.
    */
   q?: string
   /**
-   * How many groups to skip in the result.
+   * The number of customer groups to skip when retrieving the customer groups.
    */
   offset?: number
   /**
-   * the field used to order the customer groups.
+   * A field to sort order the retrieved customer groups by.
    */
   order?: string
   /**
-   * The discount condition id on which to filter the customer groups.
+   * Filter by discount condition ID.
    */
   discount_condition_id?: string
   /**
@@ -49,7 +49,7 @@ export interface AdminGetCustomerGroupsParams {
    */
   name?: Array<string>
   /**
-   * Date comparison for when resulting customer groups were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -70,7 +70,7 @@ export interface AdminGetCustomerGroupsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting customer groups were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**
@@ -91,11 +91,11 @@ export interface AdminGetCustomerGroupsParams {
     gte?: string
   }
   /**
-   * Limit the number of customer groups returned.
+   * The number of customer groups to return.
    */
   limit?: number
   /**
-   * (Comma separated) Which fields should be expanded in each customer groups of the result.
+   * Comma-separated relations that should be expanded in the returned customer groups.
    */
   expand?: string
 }

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

@@ -5,19 +5,23 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetCustomersParams {
   /**
-   * The number of items to return.
+   * The number of customers to return.
    */
   limit?: number
   /**
-   * The items to skip before result.
+   * The number of customers to skip when retrieving the customers.
    */
   offset?: number
   /**
-   * (Comma separated) Which fields should be expanded in each customer.
+   * Comma-separated relations that should be expanded in the returned customer.
    */
   expand?: string
   /**
-   * a search term to search email, first_name, and last_name.
+   * term to search customers' email, first_name, and last_name fields.
    */
   q?: string
+  /**
+   * Filter by customer group IDs.
+   */
+  groups?: Array<string>
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetDiscountParams {
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned discount.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned discount.
    */
   fields?: string
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetDiscountsDiscountCodeParams {
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned discount.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned discount.
    */
   fields?: string
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetDiscountsDiscountConditionsConditionParams {
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned discount condition.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned discount condition.
    */
   fields?: string
 }

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

@@ -5,40 +5,40 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetDiscountsParams {
   /**
-   * Search query applied on the code field.
+   * term to search discounts' code field.
    */
   q?: string
   /**
-   * Discount Rules filters to apply on the search
+   * Filter discounts by rule fields.
    */
   rule?: {
     /**
-     * The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.
+     * Filter discounts by type.
      */
     type?: "fixed" | "percentage" | "free_shipping"
     /**
-     * The value that the discount represents; this will depend on the type of the discount
+     * Filter discounts by allocation type.
      */
     allocation?: "total" | "item"
   }
   /**
-   * Return only dynamic discounts.
+   * Filter discounts by whether they're dynamic or not.
    */
   is_dynamic?: boolean
   /**
-   * Return only disabled discounts.
+   * Filter discounts by whether they're disabled or not.
    */
   is_disabled?: boolean
   /**
-   * The number of items in the response
+   * The number of discounts to return
    */
   limit?: number
   /**
-   * The offset of items in response
+   * The number of discounts to skip when retrieving the discounts.
    */
   offset?: number
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in each returned discount.
    */
   expand?: string
 }

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

@@ -5,15 +5,15 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetDraftOrdersParams {
   /**
-   * The number of items to skip before the results.
+   * The number of draft orders to skip when retrieving the draft orders.
    */
   offset?: number
   /**
-   * Limit the number of items returned.
+   * Limit the number of draft orders returned.
    */
   limit?: number
   /**
-   * a search term to search emails in carts associated with draft orders and display IDs of draft orders
+   * a term to search draft orders' display IDs and emails in the draft order's cart
    */
   q?: string
 }

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

@@ -5,15 +5,15 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetGiftCardsParams {
   /**
-   * The number of items to skip before the results.
+   * The number of gift cards to skip when retrieving the gift cards.
    */
   offset?: number
   /**
-   * Limit the number of items returned.
+   * Limit the number of gift cards returned.
    */
   limit?: number
   /**
-   * a search term to search by code or display ID
+   * a term to search gift cards' code or display ID
    */
   q?: string
 }

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

@@ -5,19 +5,19 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetGroupsGroupCustomersParams {
   /**
-   * The number of items to return.
+   * The number of customers to return.
    */
   limit?: number
   /**
-   * The items to skip before result.
+   * The number of customers to skip when retrieving the customers.
    */
   offset?: number
   /**
-   * (Comma separated) Which fields should be expanded in each customer.
+   * Comma-separated relations that should be expanded in the returned customers.
    */
   expand?: string
   /**
-   * a search term to search email, first_name, and last_name.
+   * a term to search customers by email, first_name, and last_name.
    */
   q?: string
 }

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

@@ -5,15 +5,15 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetInventoryItemsItemLocationLevelsParams {
   /**
-   * Locations ids to search for.
+   * Filter by location IDs.
    */
   location_id?: Array<string>
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned inventory levels.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned inventory levels.
    */
   fields?: string
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetInventoryItemsItemParams {
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned inventory item.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned inventory item.
    */
   fields?: string
 }

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetInventoryItemsParams {
   /**
-   * How many inventory items to skip in the result.
+   * The number of inventory items to skip when retrieving the inventory items.
    */
   offset?: number
   /**
@@ -13,63 +13,63 @@ export interface AdminGetInventoryItemsParams {
    */
   limit?: number
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in each returned inventory item.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned inventory item.
    */
   fields?: string
   /**
-   * Query used for searching product inventory items and their properties.
+   * term to search inventory item's sku, title, and description.
    */
   q?: string
   /**
-   * Locations ids to search for.
+   * Filter by location IDs.
    */
   location_id?: Array<string>
   /**
-   * id to search for.
+   * Filter by the inventory ID
    */
-  id?: string
+  id?: string | Array<string>
   /**
-   * sku to search for.
+   * Filter by SKU
    */
   sku?: string
   /**
-   * origin_country to search for.
+   * Filter by origin country
    */
   origin_country?: string
   /**
-   * mid_code to search for.
+   * Filter by MID code
    */
   mid_code?: string
   /**
-   * material to search for.
+   * Filter by material
    */
   material?: string
   /**
-   * hs_code to search for.
+   * Filter by HS Code
    */
   hs_code?: string
   /**
-   * weight to search for.
+   * Filter by weight
    */
   weight?: string
   /**
-   * length to search for.
+   * Filter by length
    */
   length?: string
   /**
-   * height to search for.
+   * Filter by height
    */
   height?: string
   /**
-   * width to search for.
+   * Filter by width
    */
   width?: string
   /**
-   * requires_shipping to search for.
+   * Filter by whether the item requires shipping
    */
   requires_shipping?: string
 }

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

@@ -5,15 +5,15 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetNotesParams {
   /**
-   * The number of notes to get
+   * Limit the number of notes returned.
    */
   limit?: number
   /**
-   * The offset at which to get notes
+   * The number of notes to skip when retrieving the notes.
    */
   offset?: number
   /**
-   * The ID which the notes belongs to
+   * Filter by resource ID
    */
   resource_id?: string
 }

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

@@ -5,35 +5,35 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetNotificationsParams {
   /**
-   * The number of notifications to skip before starting to collect the notifications set
+   * The number of inventory items to skip when retrieving the inventory items.
    */
   offset?: number
   /**
-   * The number of notifications to return
+   * Limit the number of notifications returned.
    */
   limit?: number
   /**
-   * Comma separated fields to include in the result set
+   * Comma-separated fields that should be included in each returned notification.
    */
   fields?: string
   /**
-   * Comma separated fields to populate
+   * Comma-separated relations that should be expanded in each returned notification.
    */
   expand?: string
   /**
-   * The name of the event that the notification was sent for.
+   * Filter by the name of the event that triggered sending this notification.
    */
   event_name?: string
   /**
-   * The type of resource that the Notification refers to.
+   * Filter by the resource type.
    */
   resource_type?: string
   /**
-   * The ID of the resource that the Notification refers to.
+   * Filter by the resource ID.
    */
   resource_id?: string
   /**
-   * The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id
+   * Filter by the address that the Notification was sent to. This will usually be an email address, but it can also represent other addresses such as a chat bot user id.
    */
   to?: string
   /**

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetOrdersOrderParams {
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned order.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned order.
    */
   fields?: string
 }

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

@@ -5,21 +5,21 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetOrdersParams {
   /**
-   * Query used for searching orders by shipping address first name, orders' email, and orders' display ID
+   * term to search orders' shipping address, first name, email, and display ID
    */
   q?: string
   /**
-   * ID of the order to search for.
+   * Filter by ID.
    */
   id?: string
   /**
-   * Status to search for
+   * Filter by status
    */
   status?: Array<
     "pending" | "completed" | "archived" | "canceled" | "requires_action"
   >
   /**
-   * Fulfillment status to search for.
+   * Filter by fulfillment status
    */
   fulfillment_status?: Array<
     | "not_fulfilled"
@@ -33,7 +33,7 @@ export interface AdminGetOrdersParams {
     | "requires_action"
   >
   /**
-   * Payment status to search for.
+   * Filter by payment status
    */
   payment_status?: Array<
     | "captured"
@@ -45,35 +45,35 @@ export interface AdminGetOrdersParams {
     | "requires_action"
   >
   /**
-   * Display ID to search for.
+   * Filter by display ID
    */
   display_id?: string
   /**
-   * to search for.
+   * Filter by cart ID
    */
   cart_id?: string
   /**
-   * to search for.
+   * Filter by customer ID
    */
   customer_id?: string
   /**
-   * to search for.
+   * Filter by email
    */
   email?: string
   /**
-   * Regions to search orders by
+   * Filter by region IDs.
    */
   region_id?: string | Array<string>
   /**
-   * Currency code to search for
+   * Filter by currency codes.
    */
   currency_code?: string
   /**
-   * to search for.
+   * Filter by tax rate.
    */
   tax_rate?: string
   /**
-   * Date comparison for when resulting orders were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -94,7 +94,7 @@ export interface AdminGetOrdersParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting orders were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**
@@ -115,7 +115,7 @@ export interface AdminGetOrdersParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting orders were canceled.
+   * Filter by a cancelation date range.
    */
   canceled_at?: {
     /**
@@ -136,11 +136,11 @@ export interface AdminGetOrdersParams {
     gte?: string
   }
   /**
-   * Filter by Sales Channels
+   * Filter by Sales Channel IDs
    */
   sales_channel_id?: Array<string>
   /**
-   * How many orders to skip before the results.
+   * The number of orders to skip when retrieving the orders.
    */
   offset?: number
   /**
@@ -148,11 +148,11 @@ export interface AdminGetOrdersParams {
    */
   limit?: number
   /**
-   * (Comma separated) Which fields should be expanded in each order of the result.
+   * Comma-separated relations that should be expanded in the returned order.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in each order of the result.
+   * Comma-separated fields that should be included in the returned order.
    */
   fields?: string
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetPaymentCollectionsParams {
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned payment collection.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned payment collection.
    */
   fields?: string
 }

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

@@ -5,47 +5,51 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetPriceListPaginationParams {
   /**
-   * The number of items to get
+   * Limit the number of price lists returned.
    */
   limit?: number
   /**
-   * The offset at which to get items
+   * The number of price lists to skip when retrieving the price lists.
    */
   offset?: number
   /**
-   * (Comma separated) Which fields should be expanded in each item of the result.
+   * Comma-separated relations that should be expanded in the returned price lists.
    */
   expand?: string
   /**
-   * field to order results by.
+   * Comma-separated fields that should be included in the returned price lists.
+   */
+  fields?: string
+  /**
+   * A price-list field to sort-order the retrieved price lists by.
    */
   order?: string
   /**
-   * ID to search for.
+   * Filter by ID
    */
   id?: string
   /**
-   * query to search in price list description, price list name, and customer group name fields.
+   * term to search price lists' description, name, and customer group's name.
    */
   q?: string
   /**
-   * Status to search for.
+   * Filter by status.
    */
   status?: Array<"active" | "draft">
   /**
-   * price list name to search for.
+   * Filter by name
    */
   name?: string
   /**
-   * Customer Group IDs to search for.
+   * Filter by customer-group IDs.
    */
   customer_groups?: Array<string>
   /**
-   * Type to search for.
+   * Filter by type.
    */
   type?: Array<"sale" | "override">
   /**
-   * Date comparison for when resulting price lists were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -66,7 +70,7 @@ export interface AdminGetPriceListPaginationParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting price lists were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**
@@ -87,7 +91,7 @@ export interface AdminGetPriceListPaginationParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting price lists were deleted.
+   * Filter by a deletion date range.
    */
   deleted_at?: {
     /**

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

@@ -5,51 +5,51 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetPriceListsPriceListProductsParams {
   /**
-   * Query used for searching product title and description, variant title and sku, and collection title.
+   * term used to search products' title, description, product variant's title and sku, and product collection's title.
    */
   q?: string
   /**
-   * ID of the product to search for.
+   * Filter by product ID
    */
   id?: string
   /**
-   * Product status to search for
+   * Filter by product status
    */
   status?: Array<"draft" | "proposed" | "published" | "rejected">
   /**
-   * Collection IDs to search for
+   * Filter by product collection ID. Only products in the specified collections are retrieved.
    */
   collection_id?: Array<string>
   /**
-   * Tag IDs to search for
+   * Filter by tag IDs. Only products having the specified tags are retrieved.
    */
   tags?: Array<string>
   /**
-   * product title to search for.
+   * Filter by title
    */
   title?: string
   /**
-   * product description to search for.
+   * Filter by description
    */
   description?: string
   /**
-   * product handle to search for.
+   * Filter by handle
    */
   handle?: string
   /**
-   * Search for giftcards using is_giftcard=true.
+   * A boolean value to filter by whether the product is a gift card or not.
    */
   is_giftcard?: string
   /**
-   * to search for.
+   * Filter product type.
    */
   type?: string
   /**
-   * field to sort results by.
+   * A product field to sort-order the retrieved products by.
    */
   order?: string
   /**
-   * Date comparison for when resulting products were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -70,7 +70,7 @@ export interface AdminGetPriceListsPriceListProductsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting products were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**
@@ -91,7 +91,7 @@ export interface AdminGetPriceListsPriceListProductsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting products were deleted.
+   * Filter by a deletion date range.
    */
   deleted_at?: {
     /**
@@ -112,7 +112,7 @@ export interface AdminGetPriceListsPriceListProductsParams {
     gte?: string
   }
   /**
-   * How many products to skip in the result.
+   * The number of products to skip when retrieving the products.
    */
   offset?: number
   /**
@@ -120,11 +120,11 @@ export interface AdminGetPriceListsPriceListProductsParams {
    */
   limit?: number
   /**
-   * (Comma separated) Which fields should be expanded in each product of the result.
+   * Comma-separated relations that should be expanded in the returned products.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in each product of the result.
+   * Comma-separated fields that should be included in the returned products.
    */
   fields?: string
 }

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

@@ -5,31 +5,31 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetProductCategoriesParams {
   /**
-   * Query used for searching product category names or handles.
+   * term to search product categories' names and handles.
    */
   q?: string
   /**
-   * Query used for searching product category by handle.
+   * Filter by handle.
    */
   handle?: string
   /**
-   * Search for only internal categories.
+   * Filter by whether the category is internal or not.
    */
   is_internal?: boolean
   /**
-   * Search for only active categories
+   * Filter by whether the category is active or not.
    */
   is_active?: boolean
   /**
-   * Include all nested descendants of category
+   * If set to `true`, all nested descendants of a category are included in the response.
    */
   include_descendants_tree?: boolean
   /**
-   * Returns categories scoped by parent
+   * Filter by the ID of a parent category.
    */
   parent_category_id?: string
   /**
-   * How many product categories to skip in the result.
+   * The number of product categories to skip when retrieving the product categories.
    */
   offset?: number
   /**
@@ -37,11 +37,11 @@ export interface AdminGetProductCategoriesParams {
    */
   limit?: number
   /**
-   * (Comma separated) Which fields should be expanded in the product category.
+   * Comma-separated relations that should be expanded in the returned product categories.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in the product category.
+   * Comma-separated fields that should be included in the returned product categories.
    */
   fields?: string
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetProductCategoryParams {
   /**
-   * (Comma separated) Which fields should be expanded in the results.
+   * Comma-separated relations that should be expanded in the returned product category.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in the results.
+   * Comma-separated fields that should be included in the returned product category.
    */
   fields?: string
 }

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

@@ -5,35 +5,35 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetProductTagsParams {
   /**
-   * The number of tags to return.
+   * Limit the number of product tags returned.
    */
   limit?: number
   /**
-   * The number of items to skip before the results.
+   * The number of product tags to skip when retrieving the product tags.
    */
   offset?: number
   /**
-   * The field to sort items by.
+   * A product tag field to sort-order the retrieved product tags by.
    */
   order?: string
   /**
-   * The discount condition id on which to filter the tags.
+   * Filter by the ID of a discount condition. Only product tags that this discount condition is applied to will be retrieved.
    */
   discount_condition_id?: string
   /**
-   * The tag values to search for
+   * Filter by tag value.
    */
   value?: Array<string>
   /**
-   * A query string to search values for
+   * term to search product tags' values.
    */
   q?: string
   /**
-   * The tag IDs to search for
+   * Filter by tag IDs.
    */
   id?: Array<string>
   /**
-   * Date comparison for when resulting product tags were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -54,7 +54,7 @@ export interface AdminGetProductTagsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting product tags were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**

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

@@ -5,35 +5,35 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetProductTypesParams {
   /**
-   * The number of types to return.
+   * Limit the number of product types returned.
    */
   limit?: number
   /**
-   * The number of items to skip before the results.
+   * The number of product types to skip when retrieving the product types.
    */
   offset?: number
   /**
-   * The field to sort items by.
+   * A product type field to sort-order the retrieved product types by.
    */
   order?: string
   /**
-   * The discount condition id on which to filter the product types.
+   * Filter by the ID of a discount condition. Only product types that this discount condition is applied to will be retrieved.
    */
   discount_condition_id?: string
   /**
-   * The type values to search for
+   * Filter by value.
    */
   value?: Array<string>
   /**
-   * The type IDs to search for
+   * Filter by product type IDs.
    */
   id?: Array<string>
   /**
-   * A query string to search values for
+   * term to search product types' values.
    */
   q?: string
   /**
-   * Date comparison for when resulting product types were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -54,7 +54,7 @@ export interface AdminGetProductTypesParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting product types were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetProductsParams {
   /**
-   * Query used for searching product title and description, variant title and sku, and collection title.
+   * term to search products' title, description, variants' title and sku, and collections' title.
    */
   q?: string
   /**
-   * The discount condition id on which to filter the product.
+   * Filter by the ID of a discount condition. Only products that this discount condition is applied to will be retrieved.
    */
   discount_condition_id?: string
   /**
@@ -17,55 +17,55 @@ export interface AdminGetProductsParams {
    */
   id?: string | Array<string>
   /**
-   * Status to search for
+   * Filter by status.
    */
   status?: Array<"draft" | "proposed" | "published" | "rejected">
   /**
-   * Collection ids to search for.
+   * Filter by product collection IDs. Only products that are associated with the specified collections will be retrieved.
    */
   collection_id?: Array<string>
   /**
-   * Tag IDs to search for
+   * Filter by product tag IDs. Only products that are associated with the specified tags will be retrieved.
    */
   tags?: Array<string>
   /**
-   * Price List IDs to search for
+   * Filter by IDs of price lists. Only products that these price lists are applied to will be retrieved.
    */
   price_list_id?: Array<string>
   /**
-   * Sales Channel IDs to filter products by
+   * Filter by sales channel IDs. Only products that are available in the specified sales channels will be retrieved.
    */
   sales_channel_id?: Array<string>
   /**
-   * Type IDs to filter products by
+   * Filter by product type IDs. Only products that are associated with the specified types will be retrieved.
    */
   type_id?: Array<string>
   /**
-   * Category IDs to filter products by
+   * Filter by product category IDs. Only products that are associated with the specified categories will be retrieved.
    */
   category_id?: Array<string>
   /**
-   * Include category children when filtering by category_id
+   * whether to include product category children when filtering by `category_id`
    */
   include_category_children?: boolean
   /**
-   * title to search for.
+   * Filter by title.
    */
   title?: string
   /**
-   * description to search for.
+   * Filter by description.
    */
   description?: string
   /**
-   * handle to search for.
+   * Filter by handle.
    */
   handle?: string
   /**
-   * Search for giftcards using is_giftcard=true.
+   * Whether to retrieve gift cards or regular products.
    */
   is_giftcard?: boolean
   /**
-   * Date comparison for when resulting products were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -86,7 +86,7 @@ export interface AdminGetProductsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting products were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**
@@ -107,7 +107,7 @@ export interface AdminGetProductsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting products were deleted.
+   * Filter by a deletion date range.
    */
   deleted_at?: {
     /**
@@ -128,7 +128,7 @@ export interface AdminGetProductsParams {
     gte?: string
   }
   /**
-   * How many products to skip in the result.
+   * The number of products to skip when retrieving the products.
    */
   offset?: number
   /**
@@ -136,15 +136,15 @@ export interface AdminGetProductsParams {
    */
   limit?: number
   /**
-   * (Comma separated) Which fields should be expanded in each product of the result.
+   * Comma-separated relations that should be expanded in the returned products.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in each product of the result.
+   * Comma-separated fields that should be included in the returned products.
    */
   fields?: string
   /**
-   * the field used to order the products.
+   * A product field to sort-order the retrieved products by.
    */
   order?: string
 }

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

@@ -5,19 +5,19 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetProductsVariantsParams {
   /**
-   * Comma separated string of the column to select.
+   * Comma-separated fields that should be included in the returned product variants.
    */
   fields?: string
   /**
-   * Comma separated string of the relations to include.
+   * Comma-separated relations that should be expanded in the returned product variants.
    */
   expand?: string
   /**
-   * How many items to skip before the results.
+   * The number of product variants to skip when retrieving the product variants.
    */
   offset?: number
   /**
-   * Limit the number of items returned.
+   * Limit the number of product variants returned.
    */
   limit?: number
 }

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

@@ -5,23 +5,74 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetRegionsParams {
   /**
-   * limit the number of regions in response
+   * Limit the number of regions returned.
    */
   limit?: number
   /**
-   * Offset of regions in response (used for pagination)
+   * The number of regions to skip when retrieving the regions.
    */
   offset?: number
   /**
-   * Date comparison for when resulting region was created, i.e. less than, greater than etc.
+   * Filter by a creation date range.
    */
-  created_at?: Record<string, any>
+  created_at?: {
     /**
-   * Date comparison for when resulting region was updated, i.e. less than, greater than etc.
+     * filter by dates less than this date
      */
-  updated_at?: Record<string, any>
+    lt?: string
     /**
-   * Date comparison for when resulting region was deleted, i.e. less than, greater than etc.
+     * filter by dates greater than this date
      */
-  deleted_at?: Record<string, any>
+    gt?: string
+    /**
+     * filter by dates less than or equal to this date
+     */
+    lte?: string
+    /**
+     * filter by dates greater than or equal to this date
+     */
+    gte?: string
+  }
+  /**
+   * Filter by an update date range.
+   */
+  updated_at?: {
+    /**
+     * filter by dates less than this date
+     */
+    lt?: string
+    /**
+     * filter by dates greater than this date
+     */
+    gt?: string
+    /**
+     * filter by dates less than or equal to this date
+     */
+    lte?: string
+    /**
+     * filter by dates greater than or equal to this date
+     */
+    gte?: string
+  }
+  /**
+   * Filter by a deletion date range.
+   */
+  deleted_at?: {
+    /**
+     * filter by dates less than this date
+     */
+    lt?: string
+    /**
+     * filter by dates greater than this date
+     */
+    gt?: string
+    /**
+     * filter by dates less than or equal to this date
+     */
+    lte?: string
+    /**
+     * filter by dates greater than or equal to this date
+     */
+    gte?: string
+  }
 }

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

@@ -4,6 +4,9 @@
 import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetRegionsRegionFulfillmentOptionsRes {
+  /**
+   * Fulfillment providers details.
+   */
   fulfillment_options: Array<{
     /**
      * ID of the fulfillment provider

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

@@ -5,15 +5,15 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetReservationsParams {
   /**
-   * Location ids to search for.
+   * Filter by location ID
    */
   location_id?: Array<string>
   /**
-   * Inventory Item ids to search for.
+   * Filter by inventory item ID.
    */
   inventory_item_id?: Array<string>
   /**
-   * Line Item ids to search for.
+   * Filter by line item ID.
    */
   line_item_id?: Array<string>
   /**
@@ -38,7 +38,7 @@ export interface AdminGetReservationsParams {
     gte?: number
   }
   /**
-   * A param for search reservation descriptions
+   * Filter by description.
    */
   description?:
     | string
@@ -57,7 +57,7 @@ export interface AdminGetReservationsParams {
         ends_with?: string
       }
   /**
-   * Date comparison for when resulting reservations were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -78,19 +78,19 @@ export interface AdminGetReservationsParams {
     gte?: string
   }
   /**
-   * How many Reservations to skip in the result.
+   * The number of reservations to skip when retrieving the reservations.
    */
   offset?: number
   /**
-   * Limit the number of Reservations returned.
+   * Limit the number of reservations returned.
    */
   limit?: number
   /**
-   * (Comma separated) Which fields should be expanded in the product category.
+   * Comma-separated relations that should be expanded in the returned reservations.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in the product category.
+   * Comma-separated fields that should be included in the returned reservations.
    */
   fields?: string
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetReturnsParams {
   /**
-   * The upper limit for the amount of responses returned.
+   * Limit the number of Returns returned.
    */
   limit?: number
   /**
-   * The offset of the list returned.
+   * The number of Returns to skip when retrieving the Returns.
    */
   offset?: number
 }

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

@@ -5,27 +5,27 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetSalesChannelsParams {
   /**
-   * ID of the sales channel
+   * Filter by a sales channel ID.
    */
   id?: string
   /**
-   * Name of the sales channel
+   * Filter by name.
    */
   name?: string
   /**
-   * Description of the sales channel
+   * Filter by description.
    */
   description?: string
   /**
-   * Query used for searching sales channels' names and descriptions.
+   * term used to search sales channels' names and descriptions.
    */
   q?: string
   /**
-   * The field to order the results by.
+   * A sales-channel field to sort-order the retrieved sales channels by.
    */
   order?: string
   /**
-   * Date comparison for when resulting collections were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -46,7 +46,7 @@ export interface AdminGetSalesChannelsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**
@@ -67,7 +67,7 @@ export interface AdminGetSalesChannelsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections were deleted.
+   * Filter by a deletion date range.
    */
   deleted_at?: {
     /**
@@ -88,7 +88,7 @@ export interface AdminGetSalesChannelsParams {
     gte?: string
   }
   /**
-   * How many sales channels to skip in the result.
+   * The number of sales channels to skip when retrieving the sales channels.
    */
   offset?: number
   /**
@@ -96,11 +96,11 @@ export interface AdminGetSalesChannelsParams {
    */
   limit?: number
   /**
-   * (Comma separated) Which fields should be expanded in each sales channel of the result.
+   * Comma-separated relations that should be expanded in the returned sales channels.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in each sales channel of the result.
+   * Comma-separated fields that should be included in the returned sales channels.
    */
   fields?: string
 }

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

@@ -5,15 +5,15 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetShippingOptionsParams {
   /**
-   * Region ID to fetch options from
+   * Filter by a region ID.
    */
   region_id?: string
   /**
-   * Flag for fetching return options only
+   * Filter by whether the shipping option is used for returns or orders.
    */
   is_return?: boolean
   /**
-   * Flag for fetching admin specific options
+   * Filter by whether the shipping option is used only by admins or not.
    */
   admin_only?: boolean
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetStockLocationsLocationParams {
   /**
-   * Comma separated list of relations to include in the results.
+   * Comma-separated relations that should be expanded in the returned stock location.
    */
   expand?: string
   /**
-   * Comma separated list of fields to include in the results.
+   * Comma-separated fields that should be included in the returned stock location.
    */
   fields?: string
 }

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

@@ -5,19 +5,19 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetStockLocationsParams {
   /**
-   * ID of the stock location
+   * Filter by ID.
    */
   id?: string
   /**
-   * Name of the stock location
+   * Filter by name.
    */
   name?: string
   /**
-   * The field to order the results by.
+   * A stock-location field to sort-order the retrieved stock locations by.
    */
   order?: string
   /**
-   * Date comparison for when resulting collections were created.
+   * Filter by a creation date range.
    */
   created_at?: {
     /**
@@ -38,7 +38,7 @@ export interface AdminGetStockLocationsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections were updated.
+   * Filter by an update date range.
    */
   updated_at?: {
     /**
@@ -59,7 +59,7 @@ export interface AdminGetStockLocationsParams {
     gte?: string
   }
   /**
-   * Date comparison for when resulting collections were deleted.
+   * Filter by a deletion date range.
    */
   deleted_at?: {
     /**
@@ -80,7 +80,7 @@ export interface AdminGetStockLocationsParams {
     gte?: string
   }
   /**
-   * How many stock locations to skip in the result.
+   * The number of stock locations to skip when retrieving the stock locations.
    */
   offset?: number
   /**
@@ -88,11 +88,11 @@ export interface AdminGetStockLocationsParams {
    */
   limit?: number
   /**
-   * (Comma separated) Which fields should be expanded in each stock location of the result.
+   * Comma-separated relations that should be expanded in the returned stock locations.
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included in each stock location of the result.
+   * Comma-separated fields that should be included in the returned stock locations.
    */
   fields?: string
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetSwapsParams {
   /**
-   * The upper limit for the amount of responses returned.
+   * Limit the number of swaps returned.
    */
   limit?: number
   /**
-   * The offset of the list returned.
+   * The number of swaps to skip when retrieving the swaps.
    */
   offset?: number
 }

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

@@ -5,15 +5,15 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetTaxRatesParams {
   /**
-   * Name of tax rate to retrieve
+   * Filter by name.
    */
   name?: string
   /**
-   * Filter by Region ID
+   * Filter by Region IDs
    */
   region_id?: string | Array<string>
   /**
-   * code to search for.
+   * Filter by code.
    */
   code?: string
   /**
@@ -40,7 +40,7 @@ export interface AdminGetTaxRatesParams {
         gte?: number
       }
   /**
-   * How many tax rates to skip before retrieving the result.
+   * The number of tax rates to skip when retrieving the tax rates.
    */
   offset?: number
   /**
@@ -48,11 +48,11 @@ export interface AdminGetTaxRatesParams {
    */
   limit?: number
   /**
-   * Which fields should be included in each item.
+   * Comma-separated fields that should be included in the returned tax rate.
    */
   fields?: Array<string>
   /**
-   * Which fields should be expanded and retrieved for each item.
+   * Comma-separated relations that should be expanded in the returned tax rate.
    */
   expand?: Array<string>
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetTaxRatesTaxRateParams {
   /**
-   * Which fields should be included in the result.
+   * Comma-separated fields that should be included in the returned tax rate.
    */
   fields?: Array<string>
   /**
-   * Which fields should be expanded and retrieved in the result.
+   * Comma-separated relations that should be expanded in the returned tax rate.
    */
   expand?: Array<string>
 }

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

@@ -5,11 +5,11 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetVariantParams {
   /**
-   * (Comma separated) Which fields should be expanded the order of the result.
+   * "Comma-separated relations that should be expanded in the returned product variant."
    */
   expand?: string
   /**
-   * (Comma separated) Which fields should be included the order of the result.
+   * "Comma-separated fields that should be included in the returned product variant."
    */
   fields?: string
 }

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

@@ -5,47 +5,43 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminGetVariantsParams {
   /**
-   * A Product Variant id to filter by.
+   * Filter by product variant IDs.
    */
-  id?: string
+  id?: string | Array<string>
   /**
-   * A comma separated list of Product Variant ids to filter by.
+   * "Comma-separated relations that should be expanded in the returned product variants."
-   */
-  ids?: string
-  /**
-   * A comma separated list of Product Variant relations to load.
    */
   expand?: string
   /**
-   * A comma separated list of Product Variant fields to include.
+   * "Comma-separated fields that should be included in the returned product variants."
    */
   fields?: string
   /**
-   * How many product variants to skip in the result.
+   * The number of product variants to skip when retrieving the product variants.
    */
   offset?: number
   /**
-   * Maximum number of Product Variants to return.
+   * Limit the number of product variants returned.
    */
   limit?: number
   /**
-   * The id of the cart to use for price selection.
+   * The ID of the cart to use for the price selection context.
    */
   cart_id?: string
   /**
-   * The id of the region to use for price selection.
+   * The ID of the region to use for the price selection context.
    */
   region_id?: string
   /**
-   * The currency code to use for price selection.
+   * The 3 character ISO currency code to use for the price selection context.
    */
   currency_code?: string
   /**
-   * The id of the customer to use for price selection.
+   * The ID of the customer to use for the price selection context.
    */
   customer_id?: string
   /**
-   * product variant title to search for.
+   * Filter by title.
    */
   title?: string | Array<string>
   /**

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

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

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

@@ -13,7 +13,7 @@ export interface AdminGiftCardsDeleteRes {
    */
   object: string
   /**
-   * Whether the gift card was deleted successfully or not.
+   * Whether the gift card was deleted successfully.
    */
   deleted: boolean
 }

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

@@ -23,7 +23,7 @@ export interface AdminGiftCardsListRes {
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of gift cards skipped when retrieving the gift cards.
    */
   offset: number
   /**

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

@@ -7,6 +7,9 @@ import type { GiftCard } from "./GiftCard"
 import type { Region } from "./Region"
 
 export interface AdminGiftCardsRes {
+  /**
+   * A gift card's details.
+   */
   gift_card: Merge<
     SetRelation<GiftCard, "order" | "region">,
     {

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { InventoryItemDTO } from "./InventoryItemDTO"
 
 export interface AdminInventoryItemsListRes {
+  /**
+   * an array of Inventory Item details
+   */
   inventory_items: Array<InventoryItemDTO>
   /**
    * The total number of items available
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of inventory items skipped when retrieving the inventory items.
    */
   offset: number
   /**

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { DecoratedInventoryItemDTO } from "./DecoratedInventoryItemDTO"
 
 export interface AdminInventoryItemsListWithVariantsAndLocationLevelsRes {
+  /**
+   * an array of Inventory Item details
+   */
   inventory_items: Array<DecoratedInventoryItemDTO>
   /**
    * The total number of items available
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of inventory items skipped when retrieving the inventory items.
    */
   offset: number
   /**

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { InventoryItemDTO } from "./InventoryItemDTO"
 
 export interface AdminInventoryItemsRes {
+  /**
+   * Inventory Item details
+   */
   inventory_item: InventoryItemDTO
 }

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

@@ -13,7 +13,7 @@ export interface AdminInviteDeleteRes {
    */
   object: string
   /**
-   * Whether or not the Invite was deleted.
+   * Whether or not the invite was deleted.
    */
   deleted: boolean
 }

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Invite } from "./Invite"
 
 export interface AdminListInvitesRes {
+  /**
+   * An array of invites
+   */
   invites: Array<Invite>
 }

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Note } from "./Note"
 
 export interface AdminNotesListRes {
+  /**
+   * An array of notes
+   */
   notes: Array<Note>
   /**
    * The total number of items available
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of notes skipped when retrieving the notes.
    */
   offset: number
   /**

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

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

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

@@ -6,13 +6,16 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Notification } from "./Notification"
 
 export interface AdminNotificationsListRes {
+  /**
+   * an array of notifications
+   */
   notifications: Array<SetRelation<Notification, "resends">>
   /**
    * The total number of notifications
    */
   count?: number
   /**
-   * The number of notifications skipped before these notifications
+   * The number of notifications skipped when retrieving the notifications.
    */
   offset?: number
   /**

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { Notification } from "./Notification"
 
 export interface AdminNotificationsRes {
+  /**
+   * Notification details
+   */
   notification: SetRelation<Notification, "resends">
 }

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

@@ -8,6 +8,9 @@ import type { OrderEdit } from "./OrderEdit"
 import type { OrderItemChange } from "./OrderItemChange"
 
 export interface AdminOrderEditsListRes {
+  /**
+   * An array of order edit details
+   */
   order_edits: Array<
     Merge<
       SetRelation<
@@ -58,7 +61,7 @@ export interface AdminOrderEditsListRes {
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of order edits skipped when retrieving the order edits.
    */
   offset: number
   /**

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

@@ -8,6 +8,9 @@ import type { OrderEdit } from "./OrderEdit"
 import type { OrderItemChange } from "./OrderItemChange"
 
 export interface AdminOrderEditsRes {
+  /**
+   * Order edit details
+   */
   order_edit: Merge<
     SetRelation<
       OrderEdit,

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

@@ -19,6 +19,9 @@ import type { ShippingMethod } from "./ShippingMethod"
 import type { Swap } from "./Swap"
 
 export interface AdminOrdersListRes {
+  /**
+   * An array of order details.
+   */
   orders: Array<
     Merge<
       SetRelation<
@@ -168,7 +171,7 @@ export interface AdminOrdersListRes {
    */
   count: number
   /**
-   * The number of items skipped before these items
+   * The number of orders skipped when retrieving the orders.
    */
   offset: number
   /**

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminOrdersOrderLineItemReservationReq {
   /**
-   * The id of the location of the reservation
+   * The ID of the location of the reservation
    */
   location_id: string
   /**

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

@@ -19,6 +19,9 @@ import type { ShippingMethod } from "./ShippingMethod"
 import type { Swap } from "./Swap"
 
 export interface AdminOrdersRes {
+  /**
+   * Order details.
+   */
   order: Merge<
     SetRelation<
       Order,

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

@@ -7,6 +7,9 @@ import type { PaymentCollection } from "./PaymentCollection"
 import type { Region } from "./Region"
 
 export interface AdminPaymentCollectionsRes {
+  /**
+   * Payment Collection details.
+   */
   payment_collection: Merge<
     SetRelation<PaymentCollection, "payment_sessions" | "payments" | "region">,
     {

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

@@ -6,5 +6,8 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 import type { PaymentProvider } from "./PaymentProvider"
 
 export interface AdminPaymentProvidersList {
+  /**
+   * An array of payment providers details.
+   */
   payment_providers: Array<PaymentProvider>
 }

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

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

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

@@ -5,7 +5,7 @@ import { SetRelation, Merge } from "../core/ModelUtils"
 
 export interface AdminPostAppsReq {
   /**
-   * Name of the application for the token to be generated for.
+   * Name of the application for to generate the token for.
    */
   application_name: string
   /**