@whop/sdk 0.0.38 → 0.0.40

package/src/resources/conversions.ts

@@ -0,0 +1,316 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Conversions
+ */
+export class Conversions extends APIResource {
+  /**
+   * Track a conversion or engagement event for a company.
+   *
+   * Required permissions:
+   *
+   * - `event:create`
+   *
+   * @example
+   * ```ts
+   * const conversion = await client.conversions.create({
+   *   company_id: 'biz_xxxxxxxxxxxxxx',
+   *   event_name: 'lead',
+   * });
+   * ```
+   */
+  create(body: ConversionCreateParams, options?: RequestOptions): APIPromise<ConversionCreateResponse> {
+    return this._client.post('/conversions', { body, ...options });
+  }
+}
+
+/**
+ * A tracked conversion event
+ */
+export interface ConversionCreateResponse {
+  /**
+   * The unique identifier for the conversion
+   */
+  id: string;
+}
+
+export interface ConversionCreateParams {
+  /**
+   * The company to associate with this event.
+   */
+  company_id: string;
+
+  /**
+   * The type of event.
+   */
+  event_name: 'lead' | 'submit_application' | 'contact' | 'complete_registration' | 'schedule' | 'custom';
+
+  /**
+   * The channel where an event originated
+   */
+  action_source?:
+    | 'email'
+    | 'website'
+    | 'app'
+    | 'phone_call'
+    | 'chat'
+    | 'physical_store'
+    | 'system_generated'
+    | 'business_messaging'
+    | 'other'
+    | null;
+
+  /**
+   * Tracking and attribution context.
+   */
+  context?: ConversionCreateParams.Context | null;
+
+  /**
+   * The available currencies on the platform
+   */
+  currency?: Shared.Currency | null;
+
+  /**
+   * Custom event name when event_name is 'custom'.
+   */
+  custom_name?: string | null;
+
+  /**
+   * Client-provided identifier for deduplication. Generated if omitted.
+   */
+  event_id?: string | null;
+
+  /**
+   * When the event occurred. Defaults to now.
+   */
+  event_time?: string | null;
+
+  /**
+   * The plan associated with the event.
+   */
+  plan_id?: string | null;
+
+  /**
+   * The product associated with the event.
+   */
+  product_id?: string | null;
+
+  /**
+   * The referring URL.
+   */
+  referrer_url?: string | null;
+
+  /**
+   * The URL where the event occurred.
+   */
+  url?: string | null;
+
+  /**
+   * User identity and profile data.
+   */
+  user?: ConversionCreateParams.User | null;
+
+  /**
+   * Monetary value associated with the event.
+   */
+  value?: number | null;
+}
+
+export namespace ConversionCreateParams {
+  /**
+   * Tracking and attribution context.
+   */
+  export interface Context {
+    /**
+     * Ad campaign ID.
+     */
+    ad_campaign_id?: string | null;
+
+    /**
+     * Ad ID.
+     */
+    ad_id?: string | null;
+
+    /**
+     * Ad set ID.
+     */
+    ad_set_id?: string | null;
+
+    /**
+     * Facebook click ID.
+     */
+    fbclid?: string | null;
+
+    /**
+     * Facebook browser pixel ID.
+     */
+    fbp?: string | null;
+
+    /**
+     * Google Analytics client ID.
+     */
+    ga?: string | null;
+
+    /**
+     * Google click ID.
+     */
+    gclid?: string | null;
+
+    /**
+     * Instagram session ID.
+     */
+    ig_sid?: string | null;
+
+    /**
+     * IP address.
+     */
+    ip_address?: string | null;
+
+    /**
+     * TikTok click ID.
+     */
+    ttclid?: string | null;
+
+    /**
+     * TikTok pixel ID.
+     */
+    ttp?: string | null;
+
+    /**
+     * Browser user agent string.
+     */
+    user_agent?: string | null;
+
+    /**
+     * UTM campaign parameter.
+     */
+    utm_campaign?: string | null;
+
+    /**
+     * UTM content parameter.
+     */
+    utm_content?: string | null;
+
+    /**
+     * UTM ID parameter.
+     */
+    utm_id?: string | null;
+
+    /**
+     * UTM medium parameter.
+     */
+    utm_medium?: string | null;
+
+    /**
+     * UTM source parameter.
+     */
+    utm_source?: string | null;
+
+    /**
+     * UTM term parameter.
+     */
+    utm_term?: string | null;
+  }
+
+  /**
+   * User identity and profile data.
+   */
+  export interface User {
+    /**
+     * An anonymous identifier for the user.
+     */
+    anonymous_id?: string | null;
+
+    /**
+     * Date of birth (YYYY-MM-DD).
+     */
+    birthdate?: string | null;
+
+    /**
+     * City.
+     */
+    city?: string | null;
+
+    /**
+     * Country.
+     */
+    country?: string | null;
+
+    /**
+     * Email address.
+     */
+    email?: string | null;
+
+    /**
+     * An external identifier for the user.
+     */
+    external_id?: string | null;
+
+    /**
+     * First name.
+     */
+    first_name?: string | null;
+
+    /**
+     * Gender
+     */
+    gender?: 'male' | 'female' | null;
+
+    /**
+     * Last name.
+     */
+    last_name?: string | null;
+
+    /**
+     * The Whop member ID.
+     */
+    member_id?: string | null;
+
+    /**
+     * The Whop membership ID.
+     */
+    membership_id?: string | null;
+
+    /**
+     * Full display name.
+     */
+    name?: string | null;
+
+    /**
+     * Phone number.
+     */
+    phone?: string | null;
+
+    /**
+     * Postal code.
+     */
+    postal_code?: string | null;
+
+    /**
+     * State or region.
+     */
+    state?: string | null;
+
+    /**
+     * The Whop user ID.
+     */
+    user_id?: string | null;
+
+    /**
+     * Username.
+     */
+    username?: string | null;
+  }
+}
+
+export declare namespace Conversions {
+  export {
+    type ConversionCreateResponse as ConversionCreateResponse,
+    type ConversionCreateParams as ConversionCreateParams,
+  };
+}

package/src/resources/course-chapters.ts

@@ -10,6 +10,33 @@ import { path } from '../internal/utils/path';
  * Course chapters
  */
 export class CourseChapters extends APIResource {
+  /**
+   * Returns a paginated list of chapters within a course, ordered by position.
+   *
+   * Required permissions:
+   *
+   * - `courses:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const courseChapterListResponse of client.courseChapters.list(
+   *   { course_id: 'cors_xxxxxxxxxxxxx' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: CourseChapterListParams,
+    options?: RequestOptions,
+  ): PagePromise<CourseChapterListResponsesCursorPage, CourseChapterListResponse> {
+    return this._client.getAPIList('/course_chapters', CursorPage<CourseChapterListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Create a new chapter within a course to organize lessons into sections.
    *
@@ -65,33 +92,6 @@ export class CourseChapters extends APIResource {
     return this._client.patch(path`/course_chapters/${id}`, { body, ...options });
   }
 
-  /**
-   * Returns a paginated list of chapters within a course, ordered by position.
-   *
-   * Required permissions:
-   *
-   * - `courses:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const courseChapterListResponse of client.courseChapters.list(
-   *   { course_id: 'cors_xxxxxxxxxxxxx' },
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: CourseChapterListParams,
-    options?: RequestOptions,
-  ): PagePromise<CourseChapterListResponsesCursorPage, CourseChapterListResponse> {
-    return this._client.getAPIList('/course_chapters', CursorPage<CourseChapterListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
   /**
    * Permanently delete a chapter and all of its lessons from a course.
    *
@@ -189,46 +189,46 @@ export interface CourseChapterListResponse {
  */
 export type CourseChapterDeleteResponse = boolean;
 
-export interface CourseChapterCreateParams {
+export interface CourseChapterListParams extends CursorPageParams {
   /**
-   * The unique identifier of the course to create the chapter in (e.g.,
-   * "course_XXXXX").
+   * The unique identifier of the course to list chapters for.
    */
   course_id: string;
 
   /**
-   * The display title of the chapter (e.g., "Module 1: Introduction").
+   * Returns the elements in the list that come before the specified cursor.
    */
-  title?: string | null;
-}
+  before?: string | null;
 
-export interface CourseChapterUpdateParams {
   /**
-   * The new display title of the chapter (e.g., "Module 1: Introduction").
+   * Returns the first _n_ elements from the list.
    */
-  title: string;
-}
+  first?: number | null;
 
-export interface CourseChapterListParams extends CursorPageParams {
   /**
-   * The unique identifier of the course to list chapters for.
+   * Returns the last _n_ elements from the list.
    */
-  course_id: string;
+  last?: number | null;
+}
 
+export interface CourseChapterCreateParams {
   /**
-   * Returns the elements in the list that come before the specified cursor.
+   * The unique identifier of the course to create the chapter in (e.g.,
+   * "course_XXXXX").
    */
-  before?: string | null;
+  course_id: string;
 
   /**
-   * Returns the first _n_ elements from the list.
+   * The display title of the chapter (e.g., "Module 1: Introduction").
    */
-  first?: number | null;
+  title?: string | null;
+}
 
+export interface CourseChapterUpdateParams {
   /**
-   * Returns the last _n_ elements from the list.
+   * The new display title of the chapter (e.g., "Module 1: Introduction").
    */
-  last?: number | null;
+  title: string;
 }
 
 export declare namespace CourseChapters {
@@ -237,8 +237,8 @@ export declare namespace CourseChapters {
     type CourseChapterListResponse as CourseChapterListResponse,
     type CourseChapterDeleteResponse as CourseChapterDeleteResponse,
     type CourseChapterListResponsesCursorPage as CourseChapterListResponsesCursorPage,
+    type CourseChapterListParams as CourseChapterListParams,
     type CourseChapterCreateParams as CourseChapterCreateParams,
     type CourseChapterUpdateParams as CourseChapterUpdateParams,
-    type CourseChapterListParams as CourseChapterListParams,
   };
 }

package/src/resources/course-lesson-interactions.ts

@@ -12,18 +12,6 @@ import { path } from '../internal/utils/path';
  * Course lesson interactions
  */
 export class CourseLessonInteractions extends APIResource {
-  /**
-   * Retrieves the details of an existing course lesson interaction.
-   *
-   * Required permissions:
-   *
-   * - `courses:read`
-   * - `course_analytics:read`
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction> {
-    return this._client.get(path`/course_lesson_interactions/${id}`, options);
-  }
-
   /**
    * Returns a paginated list of lesson interactions, filtered by lesson, course,
    * user, or completion status.
@@ -43,6 +31,18 @@ export class CourseLessonInteractions extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * Retrieves the details of an existing course lesson interaction.
+   *
+   * Required permissions:
+   *
+   * - `courses:read`
+   * - `course_analytics:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction> {
+    return this._client.get(path`/course_lesson_interactions/${id}`, options);
+  }
 }
 
 export interface CourseLessonInteractionListParams extends CursorPageParams {

package/src/resources/course-lessons.ts

@@ -11,6 +11,32 @@ import { path } from '../internal/utils/path';
  * Course lessons
  */
 export class CourseLessons extends APIResource {
+  /**
+   * Returns a paginated list of lessons within a course or chapter, ordered by
+   * position.
+   *
+   * Required permissions:
+   *
+   * - `courses:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const courseLessonListResponse of client.courseLessons.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: CourseLessonListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CourseLessonListResponsesCursorPage, CourseLessonListResponse> {
+    return this._client.getAPIList('/course_lessons', CursorPage<CourseLessonListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Create a new lesson within a course chapter. Lessons can contain video, text, or
    * assessment content.
@@ -72,32 +98,6 @@ export class CourseLessons extends APIResource {
     return this._client.patch(path`/course_lessons/${id}`, { body, ...options });
   }
 
-  /**
-   * Returns a paginated list of lessons within a course or chapter, ordered by
-   * position.
-   *
-   * Required permissions:
-   *
-   * - `courses:read`
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const courseLessonListResponse of client.courseLessons.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: CourseLessonListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<CourseLessonListResponsesCursorPage, CourseLessonListResponse> {
-    return this._client.getAPIList('/course_lessons', CursorPage<CourseLessonListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
   /**
    * Permanently delete a lesson and remove it from its chapter.
    *
@@ -723,6 +723,33 @@ export namespace CourseLessonSubmitAssessmentResponse {
   }
 }
 
+export interface CourseLessonListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * The unique identifier of a chapter to return only its lessons.
+   */
+  chapter_id?: string | null;
+
+  /**
+   * The unique identifier of the course to return all lessons across all chapters.
+   */
+  course_id?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+}
+
 export interface CourseLessonCreateParams {
   /**
    * The unique identifier of the chapter to create the lesson in (e.g.,
@@ -978,33 +1005,6 @@ export namespace CourseLessonUpdateParams {
   }
 }
 
-export interface CourseLessonListParams extends CursorPageParams {
-  /**
-   * Returns the elements in the list that come before the specified cursor.
-   */
-  before?: string | null;
-
-  /**
-   * The unique identifier of a chapter to return only its lessons.
-   */
-  chapter_id?: string | null;
-
-  /**
-   * The unique identifier of the course to return all lessons across all chapters.
-   */
-  course_id?: string | null;
-
-  /**
-   * Returns the first _n_ elements from the list.
-   */
-  first?: number | null;
-
-  /**
-   * Returns the last _n_ elements from the list.
-   */
-  last?: number | null;
-}
-
 export interface CourseLessonSubmitAssessmentParams {
   /**
    * The list of answers to submit for each assessment question.
@@ -1047,9 +1047,9 @@ export declare namespace CourseLessons {
     type CourseLessonStartResponse as CourseLessonStartResponse,
     type CourseLessonSubmitAssessmentResponse as CourseLessonSubmitAssessmentResponse,
     type CourseLessonListResponsesCursorPage as CourseLessonListResponsesCursorPage,
+    type CourseLessonListParams as CourseLessonListParams,
     type CourseLessonCreateParams as CourseLessonCreateParams,
     type CourseLessonUpdateParams as CourseLessonUpdateParams,
-    type CourseLessonListParams as CourseLessonListParams,
     type CourseLessonSubmitAssessmentParams as CourseLessonSubmitAssessmentParams,
   };
 }

package/src/resources/course-students.ts

@@ -10,18 +10,6 @@ import { path } from '../internal/utils/path';
  * Course students
  */
 export class CourseStudents extends APIResource {
-  /**
-   * Retrieves the details of an existing course student.
-   *
-   * Required permissions:
-   *
-   * - `courses:read`
-   * - `course_analytics:read`
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<CourseStudentRetrieveResponse> {
-    return this._client.get(path`/course_students/${id}`, options);
-  }
-
   /**
    * Returns a paginated list of students enrolled in a course, with optional name
    * filtering.
@@ -40,6 +28,18 @@ export class CourseStudents extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieves the details of an existing course student.
+   *
+   * Required permissions:
+   *
+   * - `courses:read`
+   * - `course_analytics:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<CourseStudentRetrieveResponse> {
+    return this._client.get(path`/course_students/${id}`, options);
+  }
 }
 
 export type CourseStudentListResponsesCursorPage = CursorPage<CourseStudentListResponse>;