@whop/sdk 0.0.26 → 0.0.28

package/src/resources/chat-channels.ts

@@ -9,7 +9,7 @@ import { path } from '../internal/utils/path';
 
 export class ChatChannels extends APIResource {
   /**
-   * Retrieves a chat channel
+   * Retrieves the details of an existing chat channel.
    *
    * Required permissions:
    *
@@ -27,7 +27,8 @@ export class ChatChannels extends APIResource {
   }
 
   /**
-   * Updates a chat channel
+   * Update moderation settings for a chat channel, such as who can post, banned
+   * words, and media restrictions.
    *
    * Required permissions:
    *
@@ -47,7 +48,8 @@ export class ChatChannels extends APIResource {
   }
 
   /**
-   * Lists chat channels inside a company
+   * Returns a paginated list of chat channels within a specific company, with
+   * optional filtering by product.
    *
    * Required permissions:
    *
@@ -77,7 +79,8 @@ export class ChatChannels extends APIResource {
 export type ChatChannelListResponsesCursorPage = CursorPage<ChatChannelListResponse>;
 
 /**
- * Represents a Chat feed
+ * A real-time chat feed attached to an experience, with configurable moderation
+ * and posting permissions.
  */
 export interface ChatChannelListResponse {
   /**
@@ -86,53 +89,55 @@ export interface ChatChannelListResponse {
   id: string;
 
   /**
-   * Whether or not media is banned in this chat
+   * Whether media uploads such as images and videos are blocked in this chat.
    */
   ban_media: boolean;
 
   /**
-   * Whether or not URLs are banned in this chat
+   * Whether URL links are blocked from being posted in this chat.
    */
   ban_urls: boolean;
 
   /**
-   * List of banned words in this chat
+   * A list of words that are automatically filtered from messages in this chat.
    */
   banned_words: Array<string>;
 
   /**
-   * The experience for this chat
+   * The experience this chat feed is attached to.
    */
   experience: ChatChannelListResponse.Experience;
 
   /**
-   * The number of seconds a user needs to wait before posting again, if any
+   * The minimum number of seconds a user must wait between consecutive messages.
+   * Null if no cooldown is enforced.
    */
   user_posts_cooldown_seconds: number | null;
 
   /**
-   * Who can post on this chat
+   * The permission level controlling which users can send messages in this chat.
    */
   who_can_post: Shared.WhoCanPost;
 
   /**
-   * Who can react on this chat
+   * The permission level controlling which users can add reactions in this chat.
    */
   who_can_react: Shared.WhoCanReact;
 }
 
 export namespace ChatChannelListResponse {
   /**
-   * The experience for this chat
+   * The experience this chat feed is attached to.
    */
   export interface Experience {
     /**
-     * The unique ID representing this experience
+     * The unique identifier for the experience.
      */
     id: string;
 
     /**
-     * The written name of the description.
+     * The display name of this experience shown to users in the product navigation.
+     * Maximum 255 characters.
      */
     name: string;
   }
@@ -140,22 +145,24 @@ export namespace ChatChannelListResponse {
 
 export interface ChatChannelUpdateParams {
   /**
-   * Whether media uploads are banned in this chat
+   * Whether media uploads such as images and videos are banned in this chat channel.
    */
   ban_media?: boolean | null;
 
   /**
-   * Whether URLs are banned in this chat
+   * Whether URLs and links are banned from being posted in this chat channel.
    */
   ban_urls?: boolean | null;
 
   /**
-   * List of banned words for this chat
+   * A list of words that are automatically blocked from messages in this chat
+   * channel. For example, ['spam', 'scam'].
    */
   banned_words?: Array<string> | null;
 
   /**
-   * The cooldown period in seconds between user posts
+   * The minimum number of seconds a user must wait between sending messages in this
+   * chat channel.
    */
   user_posts_cooldown_seconds?: number | null;
 
@@ -172,7 +179,7 @@ export interface ChatChannelUpdateParams {
 
 export interface ChatChannelListParams extends CursorPageParams {
   /**
-   * The ID of the company to list chat channels for
+   * The unique identifier of the company to list chat channels for.
    */
   company_id: string;
 
@@ -192,7 +199,8 @@ export interface ChatChannelListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * If provided, only chat channels connected to this product are returned
+   * The unique identifier of a product to filter by. When set, only chat channels
+   * connected to this product are returned.
    */
   product_id?: string | null;
 }

package/src/resources/checkout-configurations.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 import * as PaymentsAPI from './payments';
+import * as ProductsAPI from './products';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
@@ -36,7 +37,7 @@ export class CheckoutConfigurations extends APIResource {
   }
 
   /**
-   * Retrieves a checkout configuration by ID
+   * Retrieves the details of an existing checkout configuration.
    *
    * Required permissions:
    *
@@ -47,7 +48,8 @@ export class CheckoutConfigurations extends APIResource {
   }
 
   /**
-   * Lists checkout configurations
+   * Returns a paginated list of checkout configurations for a company, with optional
+   * filtering by plan and creation date.
    *
    * Required permissions:
    *
@@ -73,14 +75,13 @@ export type CheckoutConfigurationListResponsesCursorPage = CursorPage<CheckoutCo
 export type CheckoutModes = 'payment' | 'setup';
 
 /**
- * A checkout configuration object.
- *         Can be used to create a reusable custom configuration for a checkout, including attaching plans, affiliates and custom metadata to the checkout.
- *         This configuration can be re-used by multiple users.
- *         All successful payments and memberships resulting from a checkout will contain the passed metadata.
+ * A checkout configuration is a reusable configuration for a checkout, including
+ * the plan, affiliate, and custom metadata. Payments and memberships created from
+ * a checkout session inherit its metadata.
  */
 export interface CheckoutConfigurationListResponse {
   /**
-   * The ID of the checkout configuration
+   * The unique identifier for the checkout session.
    */
   id: string;
 
@@ -167,52 +168,63 @@ export namespace CheckoutConfigurationListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
 
     /**
-     * The interval at which the plan charges (renewal plans).
+     * The number of days between each recurring charge. Null for one-time plans. For
+     * example, 30 for monthly or 365 for annual billing.
      */
     billing_period: number | null;
 
     /**
-     * The respective currency identifier for the plan.
+     * The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary
+     * amounts on the plan are denominated in this currency.
      */
     currency: Shared.Currency;
 
     /**
-     * The interval at which the plan charges (expiration plans).
+     * The number of days until the membership expires (for expiration-based plans).
+     * For example, 365 for a one-year access pass.
      */
     expiration_days: number | null;
 
     /**
-     * The price a person has to pay for a plan on the initial purchase.
+     * The initial purchase price in the plan's base_currency (e.g., 49.99 for $49.99).
+     * For one-time plans, this is the full price. For renewal plans, this is charged
+     * on top of the first renewal_price.
      */
     initial_price: number;
 
     /**
-     * Indicates if the plan is a one time payment or recurring.
+     * The billing model for this plan: 'renewal' for recurring subscriptions or
+     * 'one_time' for single payments.
      */
     plan_type: Shared.PlanType;
 
     /**
-     * This is the release method the business uses to sell this plan.
+     * The method used to sell this plan: 'buy_now' for immediate purchase or
+     * 'waitlist' for waitlist-based access.
      */
     release_method: Shared.ReleaseMethod;
 
     /**
-     * The price a person has to pay for a plan on the renewal purchase.
+     * The recurring price charged every billing_period in the plan's base_currency
+     * (e.g., 9.99 for $9.99/period). Zero for one-time plans.
      */
     renewal_price: number;
 
     /**
-     * The number of free trial days added before a renewal plan.
+     * The number of free trial days before the first charge on a renewal plan. Null if
+     * no trial is configured or the current user has already used a trial for this
+     * plan.
      */
     trial_period_days: number | null;
 
     /**
-     * Shows or hides the plan from public/business view.
+     * Controls whether the plan is visible to customers. When set to 'hidden', the
+     * plan is only accessible via direct link.
      */
     visibility: Shared.Visibility;
   }
@@ -226,12 +238,12 @@ export type CheckoutConfigurationCreateParams =
 export declare namespace CheckoutConfigurationCreateParams {
   export interface CreateCheckoutSessionInputModePaymentWithPlan {
     /**
-     * Pass this object to create a new plan for this checkout configuration
+     * The plan attributes to create a new plan inline for this checkout configuration.
      */
     plan: CreateCheckoutSessionInputModePaymentWithPlan.Plan;
 
     /**
-     * The affiliate code to use for the checkout configuration
+     * An affiliate tracking code to attribute the checkout to a specific affiliate.
      */
     affiliate_code?: string | null;
 
@@ -241,21 +253,20 @@ export declare namespace CheckoutConfigurationCreateParams {
     currency?: Shared.Currency | null;
 
     /**
-     * The metadata to use for the checkout configuration
+     * Custom key-value metadata to attach to the checkout configuration.
      */
     metadata?: { [key: string]: unknown } | null;
 
     mode?: 'payment';
 
     /**
-     * This currently only works for configurations made in 'setup' mode. The explicit
-     * payment method configuration for the checkout session. If not provided, the
-     * platform or company's defaults will apply.
+     * The explicit payment method configuration for the checkout session. Only applies
+     * to setup mode. If not provided, the platform or company defaults will apply.
      */
     payment_method_configuration?: CreateCheckoutSessionInputModePaymentWithPlan.PaymentMethodConfiguration | null;
 
     /**
-     * The URL to redirect the user to after the checkout configuration is created
+     * The URL to redirect the user to after checkout is completed.
      */
     redirect_url?: string | null;
 
@@ -267,7 +278,7 @@ export declare namespace CheckoutConfigurationCreateParams {
 
   export namespace CreateCheckoutSessionInputModePaymentWithPlan {
     /**
-     * Pass this object to create a new plan for this checkout configuration
+     * The plan attributes to create a new plan inline for this checkout configuration.
      */
     export interface Plan {
       /**
@@ -282,13 +293,15 @@ export declare namespace CheckoutConfigurationCreateParams {
 
       /**
        * The application fee amount collected by the platform from this connected
-       * account. Must be less than the total payment amount. Only valid for connected
-       * accounts with a parent company.
+       * account. Provided as a number in dollars (e.g., 5.00 for $5.00). Must be less
+       * than the total payment amount. Only valid for connected accounts with a parent
+       * company.
        */
       application_fee_amount?: number | null;
 
       /**
-       * The interval at which the plan charges (renewal plans).
+       * The interval in days at which the plan charges (renewal plans). For example, 30
+       * for monthly billing.
        */
       billing_period?: number | null;
 
@@ -303,7 +316,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       description?: string | null;
 
       /**
-       * The interval at which the plan charges (expiration plans).
+       * The number of days until the membership expires (for expiration-based plans).
+       * For example, 365 for a one-year access pass.
        */
       expiration_days?: number | null;
 
@@ -319,7 +333,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       image?: Plan.Image | null;
 
       /**
-       * An additional amount charged upon first purchase.
+       * An additional amount charged upon first purchase. Provided as a number in
+       * dollars (e.g., 10.00 for $10.00).
        */
       initial_price?: number | null;
 
@@ -362,7 +377,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       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
+       * dollars (e.g., 9.99 for $9.99/period).
        */
       renewal_price?: number | null;
 
@@ -516,6 +532,11 @@ export declare namespace CheckoutConfigurationCreateParams {
          */
         headline?: string | null;
 
+        /**
+         * The different industry groups a company can be in.
+         */
+        industry_group?: ProductsAPI.IndustryGroups | null;
+
         /**
          * The different industry types a company can be in.
          */
@@ -544,9 +565,8 @@ export declare namespace CheckoutConfigurationCreateParams {
     }
 
     /**
-     * This currently only works for configurations made in 'setup' mode. The explicit
-     * payment method configuration for the checkout session. If not provided, the
-     * platform or company's defaults will apply.
+     * The explicit payment method configuration for the checkout session. Only applies
+     * to setup mode. If not provided, the platform or company defaults will apply.
      */
     export interface PaymentMethodConfiguration {
       /**
@@ -574,12 +594,13 @@ export declare namespace CheckoutConfigurationCreateParams {
 
   export interface CreateCheckoutSessionInputModePaymentWithPlanID {
     /**
-     * The ID of the plan to use for the checkout configuration
+     * The unique identifier of an existing plan to use for this checkout
+     * configuration.
      */
     plan_id: string;
 
     /**
-     * The affiliate code to use for the checkout configuration
+     * An affiliate tracking code to attribute the checkout to a specific affiliate.
      */
     affiliate_code?: string | null;
 
@@ -589,21 +610,20 @@ export declare namespace CheckoutConfigurationCreateParams {
     currency?: Shared.Currency | null;
 
     /**
-     * The metadata to use for the checkout configuration
+     * Custom key-value metadata to attach to the checkout configuration.
      */
     metadata?: { [key: string]: unknown } | null;
 
     mode?: 'payment';
 
     /**
-     * This currently only works for configurations made in 'setup' mode. The explicit
-     * payment method configuration for the checkout session. If not provided, the
-     * platform or company's defaults will apply.
+     * The explicit payment method configuration for the checkout session. Only applies
+     * to setup mode. If not provided, the platform or company defaults will apply.
      */
     payment_method_configuration?: CreateCheckoutSessionInputModePaymentWithPlanID.PaymentMethodConfiguration | null;
 
     /**
-     * The URL to redirect the user to after the checkout configuration is created
+     * The URL to redirect the user to after checkout is completed.
      */
     redirect_url?: string | null;
 
@@ -615,9 +635,8 @@ export declare namespace CheckoutConfigurationCreateParams {
 
   export namespace CreateCheckoutSessionInputModePaymentWithPlanID {
     /**
-     * This currently only works for configurations made in 'setup' mode. The explicit
-     * payment method configuration for the checkout session. If not provided, the
-     * platform or company's defaults will apply.
+     * The explicit payment method configuration for the checkout session. Only applies
+     * to setup mode. If not provided, the platform or company defaults will apply.
      */
     export interface PaymentMethodConfiguration {
       /**
@@ -645,8 +664,8 @@ export declare namespace CheckoutConfigurationCreateParams {
 
   export interface CreateCheckoutSessionInputModeSetup {
     /**
-     * The ID of the company for which to generate the checkout configuration. Only
-     * required in setup mode.
+     * The unique identifier of the company to create the checkout configuration for.
+     * Only required in setup mode.
      */
     company_id: string;
 
@@ -658,19 +677,18 @@ export declare namespace CheckoutConfigurationCreateParams {
     currency?: Shared.Currency | null;
 
     /**
-     * The metadata to use for the checkout configuration
+     * Custom key-value metadata to attach to the checkout configuration.
      */
     metadata?: { [key: string]: unknown } | null;
 
     /**
-     * This currently only works for configurations made in 'setup' mode. The explicit
-     * payment method configuration for the checkout session. If not provided, the
-     * platform or company's defaults will apply.
+     * The explicit payment method configuration for the checkout session. Only applies
+     * to setup mode. If not provided, the platform or company defaults will apply.
      */
     payment_method_configuration?: CreateCheckoutSessionInputModeSetup.PaymentMethodConfiguration | null;
 
     /**
-     * The URL to redirect the user to after the checkout configuration is created
+     * The URL to redirect the user to after checkout is completed.
      */
     redirect_url?: string | null;
 
@@ -682,9 +700,8 @@ export declare namespace CheckoutConfigurationCreateParams {
 
   export namespace CreateCheckoutSessionInputModeSetup {
     /**
-     * This currently only works for configurations made in 'setup' mode. The explicit
-     * payment method configuration for the checkout session. If not provided, the
-     * platform or company's defaults will apply.
+     * The explicit payment method configuration for the checkout session. Only applies
+     * to setup mode. If not provided, the platform or company defaults will apply.
      */
     export interface PaymentMethodConfiguration {
       /**
@@ -713,7 +730,7 @@ export declare namespace CheckoutConfigurationCreateParams {
 
 export interface CheckoutConfigurationListParams extends CursorPageParams {
   /**
-   * The ID of the company to list checkout configurations for
+   * The unique identifier of the company to list checkout configurations for.
    */
   company_id: string;
 
@@ -723,12 +740,12 @@ export interface CheckoutConfigurationListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return checkout configurations created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return checkout configurations created before this timestamp.
    */
   created_before?: string | null;
 
@@ -748,7 +765,8 @@ export interface CheckoutConfigurationListParams extends CursorPageParams {
   last?: number | null;
 
   /**
-   * The ID of the plan to filter checkout configurations by
+   * Filter checkout configurations to only those associated with this plan
+   * identifier.
    */
   plan_id?: string | null;
 }