@whop/sdk 0.0.38 → 0.0.40

package/src/resources/ads.ts

@@ -0,0 +1,295 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as AdCampaignsAPI from './ad-campaigns';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Ads
+ */
+export class Ads extends APIResource {
+  /**
+   * List ads scoped by ad group, campaign, or company.
+   *
+   * Required permissions:
+   *
+   * - `ad_campaign:basic:read`
+   */
+  list(
+    query: AdListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AdListResponsesCursorPage, AdListResponse> {
+    return this._client.getAPIList('/ads', CursorPage<AdListResponse>, { query, ...options });
+  }
+
+  /**
+   * Retrieve an ad by its unique identifier.
+   *
+   * Required permissions:
+   *
+   * - `ad_campaign:basic:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Ad> {
+    return this._client.get(path`/ads/${id}`, options);
+  }
+
+  /**
+   * Pauses an ad.
+   *
+   * Required permissions:
+   *
+   * - `ad_campaign:update`
+   * - `ad_campaign:basic:read`
+   */
+  pause(id: string, options?: RequestOptions): APIPromise<Ad> {
+    return this._client.post(path`/ads/${id}/pause`, options);
+  }
+
+  /**
+   * Resumes a paused ad.
+   *
+   * Required permissions:
+   *
+   * - `ad_campaign:update`
+   * - `ad_campaign:basic:read`
+   */
+  unpause(id: string, options?: RequestOptions): APIPromise<Ad> {
+    return this._client.post(path`/ads/${id}/unpause`, options);
+  }
+}
+
+export type AdListResponsesCursorPage = CursorPage<AdListResponse>;
+
+/**
+ * An ad belonging to an ad group.
+ */
+export interface Ad {
+  /**
+   * The unique identifier for this ad.
+   */
+  id: string;
+
+  /**
+   * The ad campaign this ad belongs to.
+   */
+  ad_campaign: Ad.AdCampaign;
+
+  /**
+   * The parent ad group this ad belongs to.
+   */
+  ad_group: Ad.AdGroup;
+
+  /**
+   * When the ad was created.
+   */
+  created_at: string;
+
+  /**
+   * The external ad platform this ad is running on (e.g., meta, tiktok).
+   */
+  platform: AdCampaignsAPI.AdCampaignPlatform;
+
+  /**
+   * Current delivery status of the ad.
+   */
+  status: ExternalAdStatus;
+
+  /**
+   * The display title of the ad. Falls back to the creative set caption when unset.
+   */
+  title: string | null;
+
+  /**
+   * When the ad was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace Ad {
+  /**
+   * The ad campaign this ad belongs to.
+   */
+  export interface AdCampaign {
+    /**
+     * The unique identifier for this ad campaign.
+     */
+    id: string;
+  }
+
+  /**
+   * The parent ad group this ad belongs to.
+   */
+  export interface AdGroup {
+    /**
+     * The unique identifier for this ad group.
+     */
+    id: string;
+  }
+}
+
+/**
+ * The status of an external ad.
+ */
+export type ExternalAdStatus = 'active' | 'paused' | 'inactive' | 'in_review' | 'rejected' | 'flagged';
+
+/**
+ * An ad belonging to an ad group.
+ */
+export interface AdListResponse {
+  /**
+   * The unique identifier for this ad.
+   */
+  id: string;
+
+  /**
+   * The ad campaign this ad belongs to.
+   */
+  ad_campaign: AdListResponse.AdCampaign;
+
+  /**
+   * The parent ad group this ad belongs to.
+   */
+  ad_group: AdListResponse.AdGroup;
+
+  /**
+   * When the ad was created.
+   */
+  created_at: string;
+
+  /**
+   * The external ad platform this ad is running on (e.g., meta, tiktok).
+   */
+  platform: AdCampaignsAPI.AdCampaignPlatform;
+
+  /**
+   * Current delivery status of the ad.
+   */
+  status: ExternalAdStatus;
+
+  /**
+   * The display title of the ad. Falls back to the creative set caption when unset.
+   */
+  title: string | null;
+
+  /**
+   * When the ad was last updated.
+   */
+  updated_at: string;
+}
+
+export namespace AdListResponse {
+  /**
+   * The ad campaign this ad belongs to.
+   */
+  export interface AdCampaign {
+    /**
+     * The unique identifier for this ad campaign.
+     */
+    id: string;
+  }
+
+  /**
+   * The parent ad group this ad belongs to.
+   */
+  export interface AdGroup {
+    /**
+     * The unique identifier for this ad group.
+     */
+    id: string;
+  }
+}
+
+export interface AdListParams extends CursorPageParams {
+  /**
+   * Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or
+   * company_id.
+   */
+  ad_group_id?: string | null;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or
+   * company_id.
+   */
+  campaign_id?: string | null;
+
+  /**
+   * Filter by company. Provide exactly one of ad_group_id, campaign_id, or
+   * company_id.
+   */
+  company_id?: string | null;
+
+  /**
+   * Only return ads created after this timestamp.
+   */
+  created_after?: string | null;
+
+  /**
+   * Only return ads created before this timestamp.
+   */
+  created_before?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * When false, excludes paused ads so pagination matches the dashboard's
+   * hide-paused toggle.
+   */
+  include_paused?: boolean | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * Columns that the listAds query can sort by.
+   */
+  order_by?: 'spend' | 'roas' | null;
+
+  /**
+   * The direction of the sort.
+   */
+  order_direction?: Shared.Direction | null;
+
+  /**
+   * Case-insensitive substring match against the ad title or tag.
+   */
+  query?: string | null;
+
+  /**
+   * Start of the stats date range used when order_by is a stats column.
+   */
+  stats_from?: string | null;
+
+  /**
+   * End of the stats date range used when order_by is a stats column.
+   */
+  stats_to?: string | null;
+
+  /**
+   * The status of an external ad.
+   */
+  status?: ExternalAdStatus | null;
+}
+
+export declare namespace Ads {
+  export {
+    type Ad as Ad,
+    type ExternalAdStatus as ExternalAdStatus,
+    type AdListResponse as AdListResponse,
+    type AdListResponsesCursorPage as AdListResponsesCursorPage,
+    type AdListParams as AdListParams,
+  };
+}

package/src/resources/affiliates/affiliates.ts

@@ -33,6 +33,31 @@ import { path } from '../../internal/utils/path';
 export class Affiliates extends APIResource {
   overrides: OverridesAPI.Overrides = new OverridesAPI.Overrides(this._client);
 
+  /**
+   * Returns a paginated list of affiliates for the actor in context, with optional
+   * filtering by status, search, and sorting.
+   *
+   * Required permissions:
+   *
+   * - `affiliate:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const affiliateListResponse of client.affiliates.list(
+   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: AffiliateListParams,
+    options?: RequestOptions,
+  ): PagePromise<AffiliateListResponsesCursorPage, AffiliateListResponse> {
+    return this._client.getAPIList('/affiliates', CursorPage<AffiliateListResponse>, { query, ...options });
+  }
+
   /**
    * Creates or finds an affiliate for a company and user.
    *
@@ -70,31 +95,6 @@ export class Affiliates extends APIResource {
     return this._client.get(path`/affiliates/${id}`, options);
   }
 
-  /**
-   * Returns a paginated list of affiliates for the actor in context, with optional
-   * filtering by status, search, and sorting.
-   *
-   * Required permissions:
-   *
-   * - `affiliate:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const affiliateListResponse of client.affiliates.list(
-   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: AffiliateListParams,
-    options?: RequestOptions,
-  ): PagePromise<AffiliateListResponsesCursorPage, AffiliateListResponse> {
-    return this._client.getAPIList('/affiliates', CursorPage<AffiliateListResponse>, { query, ...options });
-  }
-
   /**
    * Archives an existing Affiliate
    *
@@ -385,18 +385,6 @@ export type AffiliateArchiveResponse = boolean;
  */
 export type AffiliateUnarchiveResponse = boolean;
 
-export interface AffiliateCreateParams {
-  /**
-   * The ID of the company to create the affiliate for.
-   */
-  company_id: string;
-
-  /**
-   * The user identifier (username, email, user ID, or Discord ID).
-   */
-  user_identifier: string;
-}
-
 export interface AffiliateListParams extends CursorPageParams {
   /**
    * The unique identifier of the company to list affiliates for.
@@ -439,6 +427,18 @@ export interface AffiliateListParams extends CursorPageParams {
   status?: Status | null;
 }
 
+export interface AffiliateCreateParams {
+  /**
+   * The ID of the company to create the affiliate for.
+   */
+  company_id: string;
+
+  /**
+   * The user identifier (username, email, user ID, or Discord ID).
+   */
+  user_identifier: string;
+}
+
 Affiliates.Overrides = Overrides;
 
 export declare namespace Affiliates {
@@ -449,8 +449,8 @@ export declare namespace Affiliates {
     type AffiliateArchiveResponse as AffiliateArchiveResponse,
     type AffiliateUnarchiveResponse as AffiliateUnarchiveResponse,
     type AffiliateListResponsesCursorPage as AffiliateListResponsesCursorPage,
-    type AffiliateCreateParams as AffiliateCreateParams,
     type AffiliateListParams as AffiliateListParams,
+    type AffiliateCreateParams as AffiliateCreateParams,
   };
 
   export {
@@ -466,10 +466,10 @@ export declare namespace Affiliates {
     type OverrideListResponse as OverrideListResponse,
     type OverrideDeleteResponse as OverrideDeleteResponse,
     type OverrideListResponsesCursorPage as OverrideListResponsesCursorPage,
+    type OverrideListParams as OverrideListParams,
     type OverrideCreateParams as OverrideCreateParams,
     type OverrideRetrieveParams as OverrideRetrieveParams,
     type OverrideUpdateParams as OverrideUpdateParams,
-    type OverrideListParams as OverrideListParams,
     type OverrideDeleteParams as OverrideDeleteParams,
   };
 }

package/src/resources/affiliates/index.ts

@@ -7,8 +7,8 @@ export {
   type AffiliateListResponse,
   type AffiliateArchiveResponse,
   type AffiliateUnarchiveResponse,
-  type AffiliateCreateParams,
   type AffiliateListParams,
+  type AffiliateCreateParams,
   type AffiliateListResponsesCursorPage,
 } from './affiliates';
 export {
@@ -23,10 +23,10 @@ export {
   type OverrideUpdateResponse,
   type OverrideListResponse,
   type OverrideDeleteResponse,
+  type OverrideListParams,
   type OverrideCreateParams,
   type OverrideRetrieveParams,
   type OverrideUpdateParams,
-  type OverrideListParams,
   type OverrideDeleteParams,
   type OverrideListResponsesCursorPage,
 } from './overrides';

package/src/resources/affiliates/overrides.ts

@@ -10,6 +10,34 @@ import { path } from '../../internal/utils/path';
  * Affiliates
  */
 export class Overrides extends APIResource {
+  /**
+   * Returns a paginated list of overrides for an affiliate.
+   *
+   * Required permissions:
+   *
+   * - `affiliate:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const overrideListResponse of client.affiliates.overrides.list(
+   *   'aff_xxxxxxxxxxxxxx',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    id: string,
+    query: OverrideListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<OverrideListResponsesCursorPage, OverrideListResponse> {
+    return this._client.getAPIList(path`/affiliates/${id}/overrides`, CursorPage<OverrideListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Creates a commission override for an affiliate.
    *
@@ -86,34 +114,6 @@ export class Overrides extends APIResource {
     return this._client.patch(path`/affiliates/${id}/overrides/${overrideID}`, { body, ...options });
   }
 
-  /**
-   * Returns a paginated list of overrides for an affiliate.
-   *
-   * Required permissions:
-   *
-   * - `affiliate:basic:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const overrideListResponse of client.affiliates.overrides.list(
-   *   'aff_xxxxxxxxxxxxxx',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    id: string,
-    query: OverrideListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<OverrideListResponsesCursorPage, OverrideListResponse> {
-    return this._client.getAPIList(path`/affiliates/${id}/overrides`, CursorPage<OverrideListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
   /**
    * Deletes an affiliate override.
    *
@@ -443,6 +443,28 @@ export interface OverrideListResponse {
  */
 export type OverrideDeleteResponse = boolean;
 
+export interface OverrideListParams extends CursorPageParams {
+  /**
+   * 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 role of an affiliate override (standard or rev_share)
+   */
+  override_type?: AffiliateOverrideRoles | null;
+}
+
 export type OverrideCreateParams =
   | OverrideCreateParams.CreateAffiliateOverrideInputOverrideTypeStandard
   | OverrideCreateParams.CreateAffiliateOverrideInputOverrideTypeRevShare;
@@ -542,28 +564,6 @@ export interface OverrideUpdateParams {
   revenue_basis?: AffiliateRevenueBases | null;
 }
 
-export interface OverrideListParams extends CursorPageParams {
-  /**
-   * 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 role of an affiliate override (standard or rev_share)
-   */
-  override_type?: AffiliateOverrideRoles | null;
-}
-
 export interface OverrideDeleteParams {
   /**
    * The affiliate ID.
@@ -584,10 +584,10 @@ export declare namespace Overrides {
     type OverrideListResponse as OverrideListResponse,
     type OverrideDeleteResponse as OverrideDeleteResponse,
     type OverrideListResponsesCursorPage as OverrideListResponsesCursorPage,
+    type OverrideListParams as OverrideListParams,
     type OverrideCreateParams as OverrideCreateParams,
     type OverrideRetrieveParams as OverrideRetrieveParams,
     type OverrideUpdateParams as OverrideUpdateParams,
-    type OverrideListParams as OverrideListParams,
     type OverrideDeleteParams as OverrideDeleteParams,
   };
 }

package/src/resources/ai-chats.ts

@@ -10,6 +10,16 @@ import { path } from '../internal/utils/path';
  * Ai chats
  */
 export class AIChats extends APIResource {
+  /**
+   * Returns a paginated list of AI chat threads for the current authenticated user.
+   */
+  list(
+    query: AIChatListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AIChatListResponsesCursorPage, AIChatListResponse> {
+    return this._client.getAPIList('/ai_chats', CursorPage<AIChatListResponse>, { query, ...options });
+  }
+
   /**
    * Create a new AI chat thread and send the first message to the AI agent.
    *
@@ -44,16 +54,6 @@ export class AIChats extends APIResource {
     return this._client.patch(path`/ai_chats/${id}`, { body, ...options });
   }
 
-  /**
-   * Returns a paginated list of AI chat threads for the current authenticated user.
-   */
-  list(
-    query: AIChatListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<AIChatListResponsesCursorPage, AIChatListResponse> {
-    return this._client.getAPIList('/ai_chats', CursorPage<AIChatListResponse>, { query, ...options });
-  }
-
   /**
    * Delete an AI chat thread so it no longer appears in the user's chat list.
    *
@@ -210,6 +210,28 @@ export namespace AIChatListResponse {
  */
 export type AIChatDeleteResponse = boolean;
 
+export interface AIChatListParams extends CursorPageParams {
+  /**
+   * 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;
+
+  /**
+   * When true, returns only chats with an active cron schedule
+   */
+  only_active_crons?: boolean | null;
+}
+
 export interface AIChatCreateParams {
   /**
    * The text content of the first message to send to the AI agent.
@@ -275,28 +297,6 @@ export interface AIChatUpdateParams {
   title?: string | null;
 }
 
-export interface AIChatListParams extends CursorPageParams {
-  /**
-   * 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;
-
-  /**
-   * When true, returns only chats with an active cron schedule
-   */
-  only_active_crons?: boolean | null;
-}
-
 export declare namespace AIChats {
   export {
     type AIChat as AIChat,
@@ -304,8 +304,8 @@ export declare namespace AIChats {
     type AIChatListResponse as AIChatListResponse,
     type AIChatDeleteResponse as AIChatDeleteResponse,
     type AIChatListResponsesCursorPage as AIChatListResponsesCursorPage,
+    type AIChatListParams as AIChatListParams,
     type AIChatCreateParams as AIChatCreateParams,
     type AIChatUpdateParams as AIChatUpdateParams,
-    type AIChatListParams as AIChatListParams,
   };
 }