@whop/sdk 0.0.26 → 0.0.28

package/resources/products.d.ts

@@ -6,7 +6,8 @@ import { type CursorPageParams, PagePromise } from "../core/pagination.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Products extends APIResource {
     /**
-     * Creates a new Product
+     * Create a new product for a company. The product serves as the top-level
+     * container for plans and experiences.
      *
      * Required permissions:
      *
@@ -23,7 +24,7 @@ export declare class Products extends APIResource {
      */
     create(body: ProductCreateParams, options?: RequestOptions): APIPromise<Shared.Product>;
     /**
-     * Retrieves a product by ID or route
+     * Retrieves the details of an existing product.
      *
      * Required permissions:
      *
@@ -38,7 +39,7 @@ export declare class Products extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Product>;
     /**
-     * Updates an existing Product
+     * Update a product's title, description, visibility, and other settings.
      *
      * Required permissions:
      *
@@ -54,7 +55,8 @@ export declare class Products extends APIResource {
      */
     update(id: string, body?: ProductUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Product>;
     /**
-     * Lists products for a company
+     * Returns a paginated list of products belonging to a company, with optional
+     * filtering by type, visibility, and creation date.
      *
      * Required permissions:
      *
@@ -72,7 +74,7 @@ export declare class Products extends APIResource {
      */
     list(query: ProductListParams, options?: RequestOptions): PagePromise<ProductListItemsCursorPage, Shared.ProductListItem>;
     /**
-     * Deletes an existing Product
+     * Permanently delete a product and remove it from the company's catalog.
      *
      * Required permissions:
      *
@@ -87,17 +89,21 @@ export declare class Products extends APIResource {
      */
     delete(id: string, options?: RequestOptions): APIPromise<ProductDeleteResponse>;
 }
+/**
+ * The different industry groups a company can be in.
+ */
+export type IndustryGroups = 'academic_and_test_prep' | 'accessories' | 'agriculture_and_farming' | 'ai_and_automation_agencies' | 'ai_and_automation_software' | 'arts_and_crafts' | 'automotive' | 'b2b_and_professional_marketplaces' | 'baby_and_kids' | 'beauty_and_personal_care' | 'beauty_and_wellness' | 'business_and_entrepreneurship' | 'business_and_money_groups' | 'career_and_professional' | 'charity_and_cause_events' | 'class_action_settlement' | 'clothing_and_apparel' | 'communication_and_messaging_software' | 'community_and_education_software' | 'consulting' | 'content_and_clipping_agencies' | 'creative_and_content_creation' | 'creative_and_content_groups' | 'creative_and_education' | 'creative_gigs' | 'creative_services' | 'customer_support_agencies' | 'dating_and_relationships' | 'delivery_and_logistics' | 'dental_and_vision' | 'dermatology_and_skin' | 'design_and_creative_agencies' | 'developer_and_technical_tools' | 'development_agencies' | 'digital_and_education_marketplaces' | 'digital_goods_and_accounts' | 'e_commerce_software' | 'education_and_business_events' | 'education_and_childcare' | 'electronics_and_gadgets' | 'entertainment_and_leisure' | 'entertainment_events' | 'family_and_community_events' | 'finance_and_investing' | 'fitness_and_athletics' | 'fitness_and_health_groups' | 'fitness_and_recreation' | 'fitness_equipment_and_gear' | 'food_and_beverage' | 'food_and_beverages' | 'food_and_hospitality_marketplaces' | 'funeral_and_death_care' | 'gaming_and_entertainment_software' | 'gaming_groups' | 'genetic_and_specialized' | 'government_and_public' | 'health_and_wellness' | 'health_and_wellness_services' | 'healthcare' | 'healthcare_and_wellness_software' | 'hobbies_and_lifestyle' | 'hobby_and_interest_groups' | 'home_and_living' | 'home_and_trade_services' | 'home_and_trade_storefronts' | 'home_improvement_and_tools' | 'home_services_gigs' | 'hospitality_and_lodging' | 'industrial_and_manufacturing' | 'industry_specific_software' | 'language_and_communication' | 'legal_and_compliance' | 'lifestyle_and_culture' | 'lifestyle_and_personal_growth_groups' | 'lifestyle_and_wellness_events' | 'logistics_and_transportation_services' | 'marketing_agencies' | 'marketing_and_advertising' | 'marketing_and_sales_software' | 'media_and_publishing_companies' | 'mental_health_and_behavioral' | 'miscellaneous' | 'music_and_performing_arts' | 'news_and_politics' | 'nonprofit_and_charity' | 'office_and_business_supplies' | 'outdoor_and_sports' | 'personal_development' | 'personal_finance' | 'personal_services' | 'pet_services' | 'pets_and_animals' | 'primary_and_general_care' | 'product_marketplaces' | 'productivity_and_business_ops' | 'professional_gigs' | 'professional_services' | 'professional_services_storefront' | 'publishing_and_info_products' | 'real_estate' | 'real_estate_software' | 'recruiting_and_staffing' | 'rehabilitation_and_therapy' | 'rental_marketplaces' | 'retail' | 'sales_agencies' | 'sales_and_revenue' | 'security_and_investigations' | 'security_and_privacy_software' | 'service_marketplaces' | 'sleep_and_chronic_conditions' | 'social_and_networking_events' | 'specialized_gigs' | 'specialty_medical_care' | 'spirituality_and_mindfulness' | 'spirituality_and_personal_growth' | 'sports_and_fitness_events' | 'sports_betting_and_gambling' | 'sports_betting_groups' | 'supplements_and_nutrition' | 'sustainability_and_eco_products' | 'task_and_errands' | 'tech_and_ai' | 'tech_and_dev_groups' | 'tech_and_development' | 'trading_and_finance_software' | 'trading_and_investing' | 'trading_and_investing_groups' | 'transportation' | 'veterinary' | 'video_games_and_esports' | 'weight_and_metabolic_health' | 'wellness_and_alternative' | 'womens_and_mens_health';
 /**
  * Represents `true` or `false` values.
  */
 export type ProductDeleteResponse = boolean;
 export interface ProductCreateParams {
     /**
-     * The ID of the company to create the product for.
+     * The unique identifier of the company to create this product for.
      */
     company_id: string;
     /**
-     * The title of the product. It must be max 40 characters.
+     * The display name of the product. Maximum 40 characters.
      */
     title: string;
     /**
@@ -105,7 +111,7 @@ export interface ProductCreateParams {
      */
     business_type?: Shared.BusinessTypes | null;
     /**
-     * Whether or not to collect shipping information at checkout from the customer.
+     * Whether the checkout flow collects a shipping address from the customer.
      */
     collect_shipping_address?: boolean | null;
     /**
@@ -113,25 +119,27 @@ export interface ProductCreateParams {
      */
     custom_cta?: Shared.CustomCta | null;
     /**
-     * The custom call to action URL for the product.
+     * A URL that the call-to-action button links to instead of the default checkout
+     * flow.
      */
     custom_cta_url?: string | null;
     /**
-     * The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
-     * between 5 and 22 characters, contain at least one letter, and not contain any of
-     * the following characters: <, >, \, ', "
+     * A custom text label that appears on the customer's bank statement. Must be 5-22
+     * characters, contain at least one letter, and not contain <, >, \, ', or "
+     * characters.
      */
     custom_statement_descriptor?: string | null;
     /**
-     * A written description of the product.
+     * A written description of the product displayed on its product page.
      */
     description?: string | null;
     /**
-     * An array of experience IDs that this pass has
+     * The unique identifiers of experiences to connect to this product.
      */
     experience_ids?: Array<string> | null;
     /**
-     * The percentage of the revenue that goes to the global affiliate program.
+     * The commission rate as a percentage that affiliates earn through the global
+     * affiliate program.
      */
     global_affiliate_percentage?: number | null;
     /**
@@ -139,15 +147,20 @@ export interface ProductCreateParams {
      */
     global_affiliate_status?: Shared.GlobalAffiliateStatus | null;
     /**
-     * The headline of the product.
+     * A short marketing headline displayed prominently on the product page.
      */
     headline?: string | null;
+    /**
+     * The different industry groups a company can be in.
+     */
+    industry_group?: IndustryGroups | null;
     /**
      * The different industry types a company can be in.
      */
     industry_type?: Shared.IndustryTypes | null;
     /**
-     * The percentage of the revenue that goes to the member affiliate program.
+     * The commission rate as a percentage that members earn through the member
+     * affiliate program.
      */
     member_affiliate_percentage?: number | null;
     /**
@@ -155,23 +168,19 @@ export interface ProductCreateParams {
      */
     member_affiliate_status?: Shared.GlobalAffiliateStatus | null;
     /**
-     * The details to assign an autogenerated plan.
+     * Configuration for an automatically generated plan to attach to this product.
      */
     plan_options?: ProductCreateParams.PlanOptions | null;
     /**
-     * The product highlights for the product.
-     */
-    product_highlights?: Array<ProductCreateParams.ProductHighlight> | null;
-    /**
-     * The ID of the product tax code to apply to this product.
+     * The unique identifier of the tax classification code to apply to this product.
      */
     product_tax_code_id?: string | null;
     /**
-     * The URL to redirect the customer to after a purchase.
+     * A URL to redirect the customer to after completing a purchase.
      */
     redirect_purchase_url?: string | null;
     /**
-     * The route of the product.
+     * The URL slug for the product's public link.
      */
     route?: string | null;
     /**
@@ -181,7 +190,7 @@ export interface ProductCreateParams {
 }
 export declare namespace ProductCreateParams {
     /**
-     * The details to assign an autogenerated plan.
+     * Configuration for an automatically generated plan to attach to this product.
      */
     interface PlanOptions {
         /**
@@ -197,7 +206,8 @@ export declare namespace ProductCreateParams {
          */
         custom_fields?: Array<PlanOptions.CustomField> | null;
         /**
-         * An additional amount charged upon first purchase.
+         * An additional amount charged upon first purchase. Provided as a number in the
+         * specified currency. Eg: 10.43 for $10.43 USD.
          */
         initial_price?: number | null;
         /**
@@ -209,7 +219,8 @@ export declare namespace ProductCreateParams {
          */
         release_method?: Shared.ReleaseMethod | null;
         /**
-         * The amount the customer is charged every billing period.
+         * The amount the customer is charged every billing period. Provided as a number in
+         * the specified currency. Eg: 10.43 for $10.43 USD.
          */
         renewal_price?: number | null;
         /**
@@ -245,24 +256,6 @@ export declare namespace ProductCreateParams {
             required?: boolean | null;
         }
     }
-    /**
-     * Input for creating a product highlight
-     */
-    interface ProductHighlight {
-        /**
-         * Text to display to describe the product highlight (max length 250 for
-         * qualification or benefits, 170 for who this is for, 140 for pricing features).
-         */
-        content: string;
-        /**
-         * The type of this highlight.
-         */
-        highlight_type: 'qualification' | 'benefit' | 'who_this_is_for' | 'pricing_feature';
-        /**
-         * The title of the product highlight, if applicable.
-         */
-        title?: string | null;
-    }
 }
 export interface ProductUpdateParams {
     /**
@@ -270,7 +263,7 @@ export interface ProductUpdateParams {
      */
     business_type?: Shared.BusinessTypes | null;
     /**
-     * Whether or not to collect shipping information at checkout from the customer.
+     * Whether the checkout flow collects a shipping address from the customer.
      */
     collect_shipping_address?: boolean | null;
     /**
@@ -278,21 +271,27 @@ export interface ProductUpdateParams {
      */
     custom_cta?: Shared.CustomCta | null;
     /**
-     * The custom call to action URL for the product.
+     * A URL that the call-to-action button links to instead of the default checkout
+     * flow.
      */
     custom_cta_url?: string | null;
     /**
-     * The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
-     * between 5 and 22 characters, contain at least one letter, and not contain any of
-     * the following characters: <, >, \, ', "
+     * A custom text label that appears on the customer's bank statement. Must be 5-22
+     * characters, contain at least one letter, and not contain <, >, \, ', or "
+     * characters.
      */
     custom_statement_descriptor?: string | null;
     /**
-     * A written description of the product.
+     * A written description of the product displayed on its product page.
      */
     description?: string | null;
     /**
-     * The percentage of the revenue that goes to the global affiliate program.
+     * The gallery images for the product.
+     */
+    gallery_images?: Array<ProductUpdateParams.GalleryImage> | null;
+    /**
+     * The commission rate as a percentage that affiliates earn through the global
+     * affiliate program.
      */
     global_affiliate_percentage?: number | null;
     /**
@@ -300,15 +299,20 @@ export interface ProductUpdateParams {
      */
     global_affiliate_status?: Shared.GlobalAffiliateStatus | null;
     /**
-     * The headline of the product.
+     * A short marketing headline displayed prominently on the product page.
      */
     headline?: string | null;
+    /**
+     * The different industry groups a company can be in.
+     */
+    industry_group?: IndustryGroups | null;
     /**
      * The different industry types a company can be in.
      */
     industry_type?: Shared.IndustryTypes | null;
     /**
-     * The percentage of the revenue that goes to the member affiliate program.
+     * The commission rate as a percentage that members earn through the member
+     * affiliate program.
      */
     member_affiliate_percentage?: number | null;
     /**
@@ -316,23 +320,23 @@ export interface ProductUpdateParams {
      */
     member_affiliate_status?: Shared.GlobalAffiliateStatus | null;
     /**
-     * The ID of the product tax code to apply to this product.
+     * The unique identifier of the tax classification code to apply to this product.
      */
     product_tax_code_id?: string | null;
     /**
-     * The URL to redirect the customer to after a purchase.
+     * A URL to redirect the customer to after completing a purchase.
      */
     redirect_purchase_url?: string | null;
     /**
-     * The route of the product.
+     * The URL slug for the product's public link.
      */
     route?: string | null;
     /**
-     * Configuration for a product on the company's store page.
+     * Layout and display configuration for this product on the company's store page.
      */
     store_page_config?: ProductUpdateParams.StorePageConfig | null;
     /**
-     * The title of the product.
+     * The display name of the product. Maximum 40 characters.
      */
     title?: string | null;
     /**
@@ -342,7 +346,16 @@ export interface ProductUpdateParams {
 }
 export declare namespace ProductUpdateParams {
     /**
-     * Configuration for a product on the company's store page.
+     * Input for an attachment
+     */
+    interface GalleryImage {
+        /**
+         * The ID of an existing file object.
+         */
+        id: string;
+    }
+    /**
+     * Layout and display configuration for this product on the company's store page.
      */
     interface StorePageConfig {
         /**
@@ -357,7 +370,7 @@ export declare namespace ProductUpdateParams {
 }
 export interface ProductListParams extends CursorPageParams {
     /**
-     * The ID of the company to filter products by
+     * The unique identifier of the company to list products for.
      */
     company_id: string;
     /**
@@ -365,11 +378,11 @@ export interface ProductListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return products created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return products created before this timestamp.
      */
     created_before?: string | null;
     /**
@@ -389,16 +402,16 @@ export interface ProductListParams extends CursorPageParams {
      */
     order?: 'active_memberships_count' | 'created_at' | 'usd_gmv' | 'usd_gmv_30_days' | null;
     /**
-     * The type of products to filter by
+     * Filter to only products matching these type classifications.
      */
     product_types?: Array<Shared.AccessPassType> | null;
     /**
-     * The visibility of the products to filter by
+     * Filter to only products matching these visibility states.
      */
     visibilities?: Array<Shared.VisibilityFilter> | null;
 }
 export declare namespace Products {
-    export { type ProductDeleteResponse as ProductDeleteResponse, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, };
+    export { type IndustryGroups as IndustryGroups, type ProductDeleteResponse as ProductDeleteResponse, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, };
 }
 export { type ProductListItemsCursorPage };
 //# sourceMappingURL=products.d.ts.map

package/resources/products.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../src/resources/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0BAA0B,EAAE;OAC9B,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,eAAe,CAAC;IAIlE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAExE;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;QAEtD;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;QAE7C;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,WAAW,CAAC;QAC3B,UAAiB,WAAW;YAC1B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;SAC3B;KACF;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,cAAc,EAAE,eAAe,GAAG,SAAS,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;QAEpF;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,eAAe,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,0BAA0B,GAAG,YAAY,GAAG,SAAS,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAEzF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH;AAED,OAAO,EAAE,KAAK,0BAA0B,EAAE,CAAC"}
+{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../src/resources/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0BAA0B,EAAE;OAC9B,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,MAAM,CAAC,eAAe,CAAC;IAIlE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,wBAAwB,GACxB,aAAa,GACb,yBAAyB,GACzB,4BAA4B,GAC5B,4BAA4B,GAC5B,iBAAiB,GACjB,YAAY,GACZ,mCAAmC,GACnC,eAAe,GACf,0BAA0B,GAC1B,qBAAqB,GACrB,+BAA+B,GAC/B,2BAA2B,GAC3B,yBAAyB,GACzB,0BAA0B,GAC1B,yBAAyB,GACzB,sBAAsB,GACtB,sCAAsC,GACtC,kCAAkC,GAClC,YAAY,GACZ,+BAA+B,GAC/B,+BAA+B,GAC/B,6BAA6B,GAC7B,wBAAwB,GACxB,eAAe,GACf,mBAAmB,GACnB,2BAA2B,GAC3B,0BAA0B,GAC1B,wBAAwB,GACxB,mBAAmB,GACnB,sBAAsB,GACtB,8BAA8B,GAC9B,+BAA+B,GAC/B,sBAAsB,GACtB,oCAAoC,GACpC,4BAA4B,GAC5B,qBAAqB,GACrB,+BAA+B,GAC/B,yBAAyB,GACzB,yBAAyB,GACzB,2BAA2B,GAC3B,sBAAsB,GACtB,6BAA6B,GAC7B,uBAAuB,GACvB,uBAAuB,GACvB,2BAA2B,GAC3B,wBAAwB,GACxB,4BAA4B,GAC5B,mBAAmB,GACnB,oBAAoB,GACpB,mCAAmC,GACnC,wBAAwB,GACxB,mCAAmC,GACnC,eAAe,GACf,yBAAyB,GACzB,uBAAuB,GACvB,qBAAqB,GACrB,8BAA8B,GAC9B,YAAY,GACZ,kCAAkC,GAClC,uBAAuB,GACvB,2BAA2B,GAC3B,iBAAiB,GACjB,yBAAyB,GACzB,4BAA4B,GAC5B,4BAA4B,GAC5B,oBAAoB,GACpB,yBAAyB,GACzB,8BAA8B,GAC9B,4BAA4B,GAC5B,4BAA4B,GAC5B,sBAAsB,GACtB,uBAAuB,GACvB,sCAAsC,GACtC,+BAA+B,GAC/B,uCAAuC,GACvC,oBAAoB,GACpB,2BAA2B,GAC3B,8BAA8B,GAC9B,gCAAgC,GAChC,8BAA8B,GAC9B,eAAe,GACf,2BAA2B,GAC3B,mBAAmB,GACnB,uBAAuB,GACvB,8BAA8B,GAC9B,oBAAoB,GACpB,sBAAsB,GACtB,kBAAkB,GAClB,mBAAmB,GACnB,cAAc,GACd,kBAAkB,GAClB,0BAA0B,GAC1B,sBAAsB,GACtB,+BAA+B,GAC/B,mBAAmB,GACnB,uBAAuB,GACvB,kCAAkC,GAClC,8BAA8B,GAC9B,aAAa,GACb,sBAAsB,GACtB,yBAAyB,GACzB,4BAA4B,GAC5B,qBAAqB,GACrB,QAAQ,GACR,gBAAgB,GAChB,mBAAmB,GACnB,6BAA6B,GAC7B,+BAA+B,GAC/B,sBAAsB,GACtB,8BAA8B,GAC9B,8BAA8B,GAC9B,kBAAkB,GAClB,wBAAwB,GACxB,8BAA8B,GAC9B,kCAAkC,GAClC,2BAA2B,GAC3B,6BAA6B,GAC7B,uBAAuB,GACvB,2BAA2B,GAC3B,iCAAiC,GACjC,kBAAkB,GAClB,aAAa,GACb,qBAAqB,GACrB,sBAAsB,GACtB,8BAA8B,GAC9B,uBAAuB,GACvB,8BAA8B,GAC9B,gBAAgB,GAChB,YAAY,GACZ,yBAAyB,GACzB,6BAA6B,GAC7B,0BAA0B,GAC1B,wBAAwB,CAAC;AAE7B;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,aAAa,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;QAEtD;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;QAE7C;;;WAGG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;KACvC;IAED,UAAiB,WAAW,CAAC;QAC3B,UAAiB,WAAW;YAC1B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEnB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAErC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAEhE;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,eAAe,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,eAAe;QAC9B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,0BAA0B,GAAG,YAAY,GAAG,SAAS,GAAG,iBAAiB,GAAG,IAAI,CAAC;IAEzF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;CACtD;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH;AAED,OAAO,EAAE,KAAK,0BAA0B,EAAE,CAAC"}

package/resources/products.js

@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class Products extends resource_1.APIResource {
     /**
-     * Creates a new Product
+     * Create a new product for a company. The product serves as the top-level
+     * container for plans and experiences.
      *
      * Required permissions:
      *
@@ -26,7 +27,7 @@ class Products extends resource_1.APIResource {
         return this._client.post('/products', { body, ...options });
     }
     /**
-     * Retrieves a product by ID or route
+     * Retrieves the details of an existing product.
      *
      * Required permissions:
      *
@@ -43,7 +44,7 @@ class Products extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/products/${id}`, options);
     }
     /**
-     * Updates an existing Product
+     * Update a product's title, description, visibility, and other settings.
      *
      * Required permissions:
      *
@@ -61,7 +62,8 @@ class Products extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/products/${id}`, { body, ...options });
     }
     /**
-     * Lists products for a company
+     * Returns a paginated list of products belonging to a company, with optional
+     * filtering by type, visibility, and creation date.
      *
      * Required permissions:
      *
@@ -81,7 +83,7 @@ class Products extends resource_1.APIResource {
         return this._client.getAPIList('/products', (pagination_1.CursorPage), { query, ...options });
     }
     /**
-     * Deletes an existing Product
+     * Permanently delete a product and remove it from the company's catalog.
      *
      * Required permissions:
      *

package/resources/products.js.map

@@ -1 +1 @@
-{"version":3,"file":"products.js","sourceRoot":"","sources":["../src/resources/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,uBAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAvGD,4BAuGC"}
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../src/resources/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,uBAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAzGD,4BAyGC"}

package/resources/products.mjs

@@ -4,7 +4,8 @@ import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class Products extends APIResource {
     /**
-     * Creates a new Product
+     * Create a new product for a company. The product serves as the top-level
+     * container for plans and experiences.
      *
      * Required permissions:
      *
@@ -23,7 +24,7 @@ export class Products extends APIResource {
         return this._client.post('/products', { body, ...options });
     }
     /**
-     * Retrieves a product by ID or route
+     * Retrieves the details of an existing product.
      *
      * Required permissions:
      *
@@ -40,7 +41,7 @@ export class Products extends APIResource {
         return this._client.get(path `/products/${id}`, options);
     }
     /**
-     * Updates an existing Product
+     * Update a product's title, description, visibility, and other settings.
      *
      * Required permissions:
      *
@@ -58,7 +59,8 @@ export class Products extends APIResource {
         return this._client.patch(path `/products/${id}`, { body, ...options });
     }
     /**
-     * Lists products for a company
+     * Returns a paginated list of products belonging to a company, with optional
+     * filtering by type, visibility, and creation date.
      *
      * Required permissions:
      *
@@ -78,7 +80,7 @@ export class Products extends APIResource {
         return this._client.getAPIList('/products', (CursorPage), { query, ...options });
     }
     /**
-     * Deletes an existing Product
+     * Permanently delete a product and remove it from the company's catalog.
      *
      * Required permissions:
      *

package/resources/products.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../src/resources/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}
+{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../src/resources/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,CAAA,UAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}