@whop/sdk 0.0.38 → 0.0.40

package/src/resources/checkout-configurations.ts

@@ -13,6 +13,25 @@ import { path } from '../internal/utils/path';
  * Checkout configurations
  */
 export class CheckoutConfigurations extends APIResource {
+  /**
+   * Returns a paginated list of checkout configurations for a company, with optional
+   * filtering by plan and creation date.
+   *
+   * Required permissions:
+   *
+   * - `checkout_configuration:basic:read`
+   */
+  list(
+    query: CheckoutConfigurationListParams,
+    options?: RequestOptions,
+  ): PagePromise<CheckoutConfigurationListResponsesCursorPage, CheckoutConfigurationListResponse> {
+    return this._client.getAPIList(
+      '/checkout_configurations',
+      CursorPage<CheckoutConfigurationListResponse>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Creates a new checkout configuration
    *
@@ -49,25 +68,6 @@ export class CheckoutConfigurations extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CheckoutConfiguration> {
     return this._client.get(path`/checkout_configurations/${id}`, options);
   }
-
-  /**
-   * Returns a paginated list of checkout configurations for a company, with optional
-   * filtering by plan and creation date.
-   *
-   * Required permissions:
-   *
-   * - `checkout_configuration:basic:read`
-   */
-  list(
-    query: CheckoutConfigurationListParams,
-    options?: RequestOptions,
-  ): PagePromise<CheckoutConfigurationListResponsesCursorPage, CheckoutConfigurationListResponse> {
-    return this._client.getAPIList(
-      '/checkout_configurations',
-      CursorPage<CheckoutConfigurationListResponse>,
-      { query, ...options },
-    );
-  }
 }
 
 export type CheckoutConfigurationListResponsesCursorPage = CursorPage<CheckoutConfigurationListResponse>;
@@ -181,6 +181,12 @@ export namespace CheckoutConfigurationListResponse {
      */
     id: string;
 
+    /**
+     * Whether the creator has turned on adaptive pricing for this plan. Raw setting —
+     * does not check processor compatibility or feature flags.
+     */
+    adaptive_pricing_enabled: boolean;
+
     /**
      * The number of days between each recurring charge. Null for one-time plans. For
      * example, 30 for monthly or 365 for annual billing.
@@ -224,6 +230,11 @@ export namespace CheckoutConfigurationListResponse {
      */
     renewal_price: number;
 
+    /**
+     * The 3D Secure behavior for a plan.
+     */
+    three_ds_level: 'mandate_challenge' | 'frictionless' | null;
+
     /**
      * 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
@@ -239,6 +250,49 @@ export namespace CheckoutConfigurationListResponse {
   }
 }
 
+export interface CheckoutConfigurationListParams extends CursorPageParams {
+  /**
+   * The unique identifier of the company to list checkout configurations for.
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Only return checkout configurations created after this timestamp.
+   */
+  created_after?: string | null;
+
+  /**
+   * Only return checkout configurations created before this timestamp.
+   */
+  created_before?: string | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * Filter checkout configurations to only those associated with this plan
+   * identifier.
+   */
+  plan_id?: string | null;
+}
+
 export type CheckoutConfigurationCreateParams =
   | CheckoutConfigurationCreateParams.CreateCheckoutSessionInputModePaymentWithPlan
   | CheckoutConfigurationCreateParams.CreateCheckoutSessionInputModePaymentWithPlanID
@@ -312,6 +366,11 @@ export declare namespace CheckoutConfigurationCreateParams {
        */
       currency: Shared.Currency;
 
+      /**
+       * Whether this plan accepts local currency payments via adaptive pricing.
+       */
+      adaptive_pricing_enabled?: boolean | null;
+
       /**
        * The application fee amount collected by the platform from this connected
        * account. Provided as a number in dollars (e.g., 5.00 for $5.00). Must be less
@@ -496,7 +555,7 @@ export declare namespace CheckoutConfigurationCreateParams {
          * in this configuration. The full list of default payment methods can be found in
          * the documentation at docs.whop.com/payments.
          */
-        include_platform_defaults: boolean;
+        include_platform_defaults?: boolean | null;
       }
 
       /**
@@ -575,6 +634,12 @@ export declare namespace CheckoutConfigurationCreateParams {
      * defaults.
      */
     export interface CheckoutStyling {
+      /**
+       * A hex color code for the checkout page background, applied to the order summary
+       * panel (e.g. #F4F4F5).
+       */
+      background_color?: string | null;
+
       /**
        * The different border-radius styles available for checkout pages.
        */
@@ -615,7 +680,7 @@ export declare namespace CheckoutConfigurationCreateParams {
        * in this configuration. The full list of default payment methods can be found in
        * the documentation at docs.whop.com/payments.
        */
-      include_platform_defaults: boolean;
+      include_platform_defaults?: boolean | null;
     }
   }
 
@@ -678,6 +743,12 @@ export declare namespace CheckoutConfigurationCreateParams {
      * defaults.
      */
     export interface CheckoutStyling {
+      /**
+       * A hex color code for the checkout page background, applied to the order summary
+       * panel (e.g. #F4F4F5).
+       */
+      background_color?: string | null;
+
       /**
        * The different border-radius styles available for checkout pages.
        */
@@ -718,7 +789,7 @@ export declare namespace CheckoutConfigurationCreateParams {
        * in this configuration. The full list of default payment methods can be found in
        * the documentation at docs.whop.com/payments.
        */
-      include_platform_defaults: boolean;
+      include_platform_defaults?: boolean | null;
     }
   }
 
@@ -776,6 +847,12 @@ export declare namespace CheckoutConfigurationCreateParams {
      * defaults.
      */
     export interface CheckoutStyling {
+      /**
+       * A hex color code for the checkout page background, applied to the order summary
+       * panel (e.g. #F4F4F5).
+       */
+      background_color?: string | null;
+
       /**
        * The different border-radius styles available for checkout pages.
        */
@@ -816,60 +893,17 @@ export declare namespace CheckoutConfigurationCreateParams {
        * in this configuration. The full list of default payment methods can be found in
        * the documentation at docs.whop.com/payments.
        */
-      include_platform_defaults: boolean;
+      include_platform_defaults?: boolean | null;
     }
   }
 }
 
-export interface CheckoutConfigurationListParams extends CursorPageParams {
-  /**
-   * The unique identifier of the company to list checkout configurations for.
-   */
-  company_id: string;
-
-  /**
-   * Returns the elements in the list that come before the specified cursor.
-   */
-  before?: string | null;
-
-  /**
-   * Only return checkout configurations created after this timestamp.
-   */
-  created_after?: string | null;
-
-  /**
-   * Only return checkout configurations created before this timestamp.
-   */
-  created_before?: string | null;
-
-  /**
-   * The direction of the sort.
-   */
-  direction?: Shared.Direction | null;
-
-  /**
-   * Returns the first _n_ elements from the list.
-   */
-  first?: number | null;
-
-  /**
-   * Returns the last _n_ elements from the list.
-   */
-  last?: number | null;
-
-  /**
-   * Filter checkout configurations to only those associated with this plan
-   * identifier.
-   */
-  plan_id?: string | null;
-}
-
 export declare namespace CheckoutConfigurations {
   export {
     type CheckoutModes as CheckoutModes,
     type CheckoutConfigurationListResponse as CheckoutConfigurationListResponse,
     type CheckoutConfigurationListResponsesCursorPage as CheckoutConfigurationListResponsesCursorPage,
-    type CheckoutConfigurationCreateParams as CheckoutConfigurationCreateParams,
     type CheckoutConfigurationListParams as CheckoutConfigurationListParams,
+    type CheckoutConfigurationCreateParams as CheckoutConfigurationCreateParams,
   };
 }

package/src/resources/companies.ts

@@ -13,27 +13,43 @@ import { path } from '../internal/utils/path';
  */
 export class Companies extends APIResource {
   /**
-   * Create a new company. Pass parent_company_id to create a connected account under
-   * a platform, or omit it to create a company for the current user.
+   * Retrieves the details of an existing company.
    *
    * Required permissions:
    *
-   * - `company:create`
    * - `company:basic:read`
    */
-  create(body: CompanyCreateParams, options?: RequestOptions): APIPromise<Shared.Company> {
-    return this._client.post('/companies', { body, ...options });
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Company> {
+    return this._client.get(path`/companies/${id}`, options);
   }
 
   /**
-   * Retrieves the details of an existing company.
+   * Returns a paginated list of companies. When parent_company_id is provided, lists
+   * connected accounts under that platform. When omitted, lists companies the
+   * current user has access to.
    *
    * Required permissions:
    *
    * - `company:basic:read`
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Company> {
-    return this._client.get(path`/companies/${id}`, options);
+  list(
+    query: CompanyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse> {
+    return this._client.getAPIList('/companies', CursorPage<CompanyListResponse>, { query, ...options });
+  }
+
+  /**
+   * Create a new company. Pass parent_company_id to create a connected account under
+   * a platform, or omit it to create a company for the current user.
+   *
+   * Required permissions:
+   *
+   * - `company:create`
+   * - `company:basic:read`
+   */
+  create(body: CompanyCreateParams, options?: RequestOptions): APIPromise<Shared.Company> {
+    return this._client.post('/companies', { body, ...options });
   }
 
   /**
@@ -53,19 +69,15 @@ export class Companies extends APIResource {
   }
 
   /**
-   * Returns a paginated list of companies. When parent_company_id is provided, lists
-   * connected accounts under that platform. When omitted, lists companies the
-   * current user has access to.
-   *
-   * Required permissions:
-   *
-   * - `company:basic:read`
+   * Create an API key for a connected account (child company) owned by a parent
+   * company.
    */
-  list(
-    query: CompanyListParams | null | undefined = {},
+  createAPIKey(
+    parentCompanyID: string,
+    body: CompanyCreateAPIKeyParams,
     options?: RequestOptions,
-  ): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse> {
-    return this._client.getAPIList('/companies', CursorPage<CompanyListResponse>, { query, ...options });
+  ): APIPromise<CompanyCreateAPIKeyResponse> {
+    return this._client.post(path`/companies/${parentCompanyID}/api_keys`, { body, ...options });
   }
 }
 
@@ -199,6 +211,65 @@ export namespace CompanyListResponse {
   }
 }
 
+/**
+ * An API key created for a child company, including the one-time secret key.
+ */
+export interface CompanyCreateAPIKeyResponse {
+  /**
+   * The unique identifier for the authorized api key.
+   */
+  id: string;
+
+  /**
+   * A user set name to identify an API key
+   */
+  name: string | null;
+
+  /**
+   * The secret key used to authenticate requests. Only returned at creation time.
+   */
+  secret_key: string;
+}
+
+export interface CompanyListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Only return companies created after this timestamp.
+   */
+  created_after?: string | null;
+
+  /**
+   * Only return companies created before this timestamp.
+   */
+  created_before?: string | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * The unique identifier of the parent platform company. When provided, lists
+   * connected accounts under that platform. Omit to list the current user's own
+   * companies.
+   */
+  parent_company_id?: string | null;
+}
+
 export interface CompanyCreateParams {
   /**
    * The display name of the company shown to customers.
@@ -388,52 +459,63 @@ export namespace CompanyUpdateParams {
   }
 }
 
-export interface CompanyListParams extends CursorPageParams {
+export interface CompanyCreateAPIKeyParams {
   /**
-   * Returns the elements in the list that come before the specified cursor.
+   * The unique identifier of the connected account to create the API key for (e.g.
+   * 'biz_xxx').
    */
-  before?: string | null;
+  child_company_id: string;
 
   /**
-   * Only return companies created after this timestamp.
+   * A human-readable name for the API key, such as 'Production API Key'.
    */
-  created_after?: string | null;
+  name?: string | null;
 
   /**
-   * Only return companies created before this timestamp.
+   * Granular permission statements defining which actions this API key can perform.
+   * Either permissions or role must be provided.
    */
-  created_before?: string | null;
+  permissions?: Array<CompanyCreateAPIKeyParams.Permission> | null;
 
   /**
-   * The direction of the sort.
+   * The different system roles that can be assigned.
    */
-  direction?: Shared.Direction | null;
+  role?: 'owner' | 'admin' | 'moderator' | 'sales_manager' | 'advertiser' | null;
+}
 
+export namespace CompanyCreateAPIKeyParams {
   /**
-   * Returns the first _n_ elements from the list.
+   * Input for a single permissions statement
    */
-  first?: number | null;
+  export interface Permission {
+    /**
+     * Actions covered by this statement
+     */
+    actions: Array<string>;
 
-  /**
-   * Returns the last _n_ elements from the list.
-   */
-  last?: number | null;
+    /**
+     * Whether the actions are granted or denied
+     */
+    grant: boolean;
 
-  /**
-   * The unique identifier of the parent platform company. When provided, lists
-   * connected accounts under that platform. Omit to list the current user's own
-   * companies.
-   */
-  parent_company_id?: string | null;
+    /**
+     * Resource identifiers. Can look like 'biz*xxxx' or 'biz_xxx|pass*_|exp*xxx' or
+     * 'biz_xxx|app_xxx' or 'biz_xxx|pass_xxx|exp_xxx' or 'biz_xxx|pass_xxx' or
+     * 'biz_xxx|pass*_'
+     */
+    resources: Array<string>;
+  }
 }
 
 export declare namespace Companies {
   export {
     type SocialLinkWebsites as SocialLinkWebsites,
     type CompanyListResponse as CompanyListResponse,
+    type CompanyCreateAPIKeyResponse as CompanyCreateAPIKeyResponse,
     type CompanyListResponsesCursorPage as CompanyListResponsesCursorPage,
+    type CompanyListParams as CompanyListParams,
     type CompanyCreateParams as CompanyCreateParams,
     type CompanyUpdateParams as CompanyUpdateParams,
-    type CompanyListParams as CompanyListParams,
+    type CompanyCreateAPIKeyParams as CompanyCreateAPIKeyParams,
   };
 }

package/src/resources/company-token-transactions.ts

@@ -10,6 +10,28 @@ import { path } from '../internal/utils/path';
  * Company token transactions
  */
 export class CompanyTokenTransactions extends APIResource {
+  /**
+   * Returns a paginated list of token transactions for a user or company, depending
+   * on the authenticated actor, with optional filtering by user and transaction
+   * type.
+   *
+   * Required permissions:
+   *
+   * - `company_token_transaction:read`
+   * - `member:basic:read`
+   * - `company:basic:read`
+   */
+  list(
+    query: CompanyTokenTransactionListParams,
+    options?: RequestOptions,
+  ): PagePromise<CompanyTokenTransactionListResponsesCursorPage, CompanyTokenTransactionListResponse> {
+    return this._client.getAPIList(
+      '/company_token_transactions',
+      CursorPage<CompanyTokenTransactionListResponse>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Create a token transaction to add, subtract, or transfer tokens for a member
    * within a company.
@@ -51,28 +73,6 @@ export class CompanyTokenTransactions extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<CompanyTokenTransaction> {
     return this._client.get(path`/company_token_transactions/${id}`, options);
   }
-
-  /**
-   * Returns a paginated list of token transactions for a user or company, depending
-   * on the authenticated actor, with optional filtering by user and transaction
-   * type.
-   *
-   * Required permissions:
-   *
-   * - `company_token_transaction:read`
-   * - `member:basic:read`
-   * - `company:basic:read`
-   */
-  list(
-    query: CompanyTokenTransactionListParams,
-    options?: RequestOptions,
-  ): PagePromise<CompanyTokenTransactionListResponsesCursorPage, CompanyTokenTransactionListResponse> {
-    return this._client.getAPIList(
-      '/company_token_transactions',
-      CursorPage<CompanyTokenTransactionListResponse>,
-      { query, ...options },
-    );
-  }
 }
 
 export type CompanyTokenTransactionListResponsesCursorPage = CursorPage<CompanyTokenTransactionListResponse>;
@@ -306,6 +306,38 @@ export namespace CompanyTokenTransactionListResponse {
   }
 }
 
+export interface CompanyTokenTransactionListParams extends CursorPageParams {
+  /**
+   * The unique identifier of the company to list token transactions for.
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * The type of token transaction
+   */
+  transaction_type?: CompanyTokenTransactionType | null;
+
+  /**
+   * Filter transactions to only those involving this specific user.
+   */
+  user_id?: string | null;
+}
+
 export type CompanyTokenTransactionCreateParams =
   | CompanyTokenTransactionCreateParams.CreateCompanyTokenTransactionInputTransactionTypeTransfer
   | CompanyTokenTransactionCreateParams.CreateCompanyTokenTransactionInputTransactionTypeAdd
@@ -415,45 +447,13 @@ export declare namespace CompanyTokenTransactionCreateParams {
   }
 }
 
-export interface CompanyTokenTransactionListParams extends CursorPageParams {
-  /**
-   * The unique identifier of the company to list token transactions for.
-   */
-  company_id: string;
-
-  /**
-   * Returns the elements in the list that come before the specified cursor.
-   */
-  before?: string | null;
-
-  /**
-   * Returns the first _n_ elements from the list.
-   */
-  first?: number | null;
-
-  /**
-   * Returns the last _n_ elements from the list.
-   */
-  last?: number | null;
-
-  /**
-   * The type of token transaction
-   */
-  transaction_type?: CompanyTokenTransactionType | null;
-
-  /**
-   * Filter transactions to only those involving this specific user.
-   */
-  user_id?: string | null;
-}
-
 export declare namespace CompanyTokenTransactions {
   export {
     type CompanyTokenTransaction as CompanyTokenTransaction,
     type CompanyTokenTransactionType as CompanyTokenTransactionType,
     type CompanyTokenTransactionListResponse as CompanyTokenTransactionListResponse,
     type CompanyTokenTransactionListResponsesCursorPage as CompanyTokenTransactionListResponsesCursorPage,
-    type CompanyTokenTransactionCreateParams as CompanyTokenTransactionCreateParams,
     type CompanyTokenTransactionListParams as CompanyTokenTransactionListParams,
+    type CompanyTokenTransactionCreateParams as CompanyTokenTransactionCreateParams,
   };
 }