@whop/sdk 0.0.3 → 0.0.5

package/src/resources/companies.ts

@@ -3,10 +3,23 @@
 import { APIResource } from '../core/resource';
 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';
 
 export class Companies extends APIResource {
+  /**
+   * Create a new sub company for your platform
+   *
+   * Required permissions:
+   *
+   * - `company:create_child`
+   * - `company:basic:read`
+   */
+  create(body: CompanyCreateParams, options?: RequestOptions): APIPromise<Shared.Company> {
+    return this._client.post('/companies', { body, ...options });
+  }
+
   /**
    * Retrieves an company by ID or its url route
    *
@@ -17,4 +30,187 @@ export class Companies extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Company> {
     return this._client.get(path`/companies/${id}`, options);
   }
+
+  /**
+   * Lists companies the current user has access to
+   *
+   * Required permissions:
+   *
+   * - `company:basic:read`
+   */
+  list(
+    query: CompanyListParams,
+    options?: RequestOptions,
+  ): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse> {
+    return this._client.getAPIList('/companies', CursorPage<CompanyListResponse>, { query, ...options });
+  }
+}
+
+export type CompanyListResponsesCursorPage = CursorPage<CompanyListResponse>;
+
+/**
+ * An object representing a (sanitized) company.
+ */
+export interface CompanyListResponse {
+  /**
+   * The ID (tag) of the company.
+   */
+  id: string;
+
+  /**
+   * The different business types a company can be.
+   */
+  business_type: Shared.BusinessTypes | null;
+
+  /**
+   * When the company was created (signed up)
+   */
+  created_at: string;
+
+  /**
+   * The creator pitch for the company.
+   */
+  description: string | null;
+
+  /**
+   * The different industry types a company can be in.
+   */
+  industry_type: Shared.IndustryTypes | null;
+
+  /**
+   * The company's logo.
+   */
+  logo: CompanyListResponse.Logo | null;
+
+  /**
+   * The number of members in the company.
+   */
+  member_count: number;
+
+  /**
+   * A key-value store of data for the account, created/updated by the platform that
+   * made the account.
+   */
+  metadata: { [key: string]: unknown } | null;
+
+  /**
+   * The user who owns this company
+   */
+  owner_user: CompanyListResponse.OwnerUser;
+
+  /**
+   * The number of reviews that have been published for the company.
+   */
+  published_reviews_count: number;
+
+  /**
+   * The slug/route of the company on the Whop site.
+   */
+  route: string;
+
+  /**
+   * The title of the company.
+   */
+  title: string;
+
+  /**
+   * The time the company was last updated.
+   */
+  updated_at: string;
+
+  /**
+   * If the company is Whop Verified
+   */
+  verified: boolean;
+}
+
+export namespace CompanyListResponse {
+  /**
+   * The company's logo.
+   */
+  export interface Logo {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+
+  /**
+   * The user who owns this company
+   */
+  export interface OwnerUser {
+    /**
+     * The internal ID of the user.
+     */
+    id: string;
+
+    /**
+     * The name of the user from their Whop account.
+     */
+    name: string | null;
+
+    /**
+     * The username of the user from their Whop account.
+     */
+    username: string;
+  }
+}
+
+export interface CompanyCreateParams {
+  /**
+   * The email of the user who the company will belong to.
+   */
+  email: string;
+
+  /**
+   * The company ID of the platform creating this company.
+   */
+  parent_company_id: string;
+
+  /**
+   * The name of the company being created.
+   */
+  title: string;
+
+  /**
+   * Additional metadata for the account
+   */
+  metadata?: { [key: string]: unknown } | null;
+}
+
+export interface CompanyListParams extends CursorPageParams {
+  /**
+   * The ID of the parent company to list sub companies for
+   */
+  parent_company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  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;
+}
+
+export declare namespace Companies {
+  export {
+    type CompanyListResponse as CompanyListResponse,
+    type CompanyListResponsesCursorPage as CompanyListResponsesCursorPage,
+    type CompanyCreateParams as CompanyCreateParams,
+    type CompanyListParams as CompanyListParams,
+  };
 }

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

@@ -14,8 +14,8 @@ export class CourseLessonInteractions extends APIResource {
    *
    * Required permissions:
    *
-   * - `course_lesson_interaction:read`
    * - `courses:read`
+   * - `course_analytics:read`
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction> {
     return this._client.get(path`/course_lesson_interactions/${id}`, options);
@@ -26,8 +26,8 @@ export class CourseLessonInteractions extends APIResource {
    *
    * Required permissions:
    *
-   * - `course_lesson_interaction:read`
    * - `courses:read`
+   * - `course_analytics:read`
    */
   list(
     query: CourseLessonInteractionListParams | null | undefined = {},

package/src/resources/course-lessons.ts

@@ -118,6 +118,11 @@ export type CourseLessonListResponsesCursorPage = CursorPage<CourseLessonListRes
  */
 export type AssessmentQuestionTypes = 'short_answer' | 'true_false' | 'multiple_choice' | 'multiple_select';
 
+/**
+ * The type of embed for a lesson
+ */
+export type EmbedType = 'youtube' | 'loom';
+
 /**
  * A lesson from the courses app
  */
@@ -147,6 +152,16 @@ export interface Lesson {
    */
   days_from_course_start_until_unlock: number | null;
 
+  /**
+   * ID for the embed (YouTube video ID or Loom share ID)
+   */
+  embed_id: string | null;
+
+  /**
+   * The type of embed for a lesson
+   */
+  embed_type: EmbedType | null;
+
   /**
    * The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
    */
@@ -162,6 +177,11 @@ export interface Lesson {
    */
   order: number;
 
+  /**
+   * The thumbnail for the lesson
+   */
+  thumbnail: Lesson.Thumbnail | null;
+
   /**
    * The title of the lesson
    */
@@ -190,9 +210,10 @@ export namespace Lesson {
     id: string;
 
     /**
-     * The correct answer for the question. Used for short answer questions
+     * The correct answer for the question. Used for short answer questions. Only
+     * visible to admins (users with courses:update permission)
      */
-    correct_answer: string;
+    correct_answer: string | null;
 
     /**
      * When the question was created
@@ -262,9 +283,10 @@ export namespace Lesson {
       id: string;
 
       /**
-       * Whether this option is a correct answer
+       * Whether this option is a correct answer. Only visible to admins (users with
+       * courses:update permission)
        */
-      is_correct: boolean;
+      is_correct: boolean | null;
 
       /**
        * The text of the answer option
@@ -330,6 +352,17 @@ export namespace Lesson {
     url: string | null;
   }
 
+  /**
+   * The thumbnail for the lesson
+   */
+  export interface Thumbnail {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+
   /**
    * The associated Mux asset for video lessons
    */
@@ -381,6 +414,16 @@ export interface CourseLessonListResponse {
    */
   days_from_course_start_until_unlock: number | null;
 
+  /**
+   * ID for the embed (YouTube video ID or Loom share ID)
+   */
+  embed_id: string | null;
+
+  /**
+   * The type of embed for a lesson
+   */
+  embed_type: EmbedType | null;
+
   /**
    * The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
    */
@@ -391,6 +434,11 @@ export interface CourseLessonListResponse {
    */
   order: number;
 
+  /**
+   * The thumbnail for the lesson
+   */
+  thumbnail: CourseLessonListResponse.Thumbnail | null;
+
   /**
    * The title of the lesson
    */
@@ -403,6 +451,19 @@ export interface CourseLessonListResponse {
   visibility: LessonVisibilities;
 }
 
+export namespace CourseLessonListResponse {
+  /**
+   * The thumbnail for the lesson
+   */
+  export interface Thumbnail {
+    /**
+     * This is the URL you use to render optimized attachments on the client. This
+     * should be used for apps.
+     */
+    url: string | null;
+  }
+}
+
 /**
  * Represents `true` or `false` values.
  */
@@ -429,13 +490,62 @@ export interface CourseLessonCreateParams {
    */
   days_from_course_start_until_unlock?: number | null;
 
+  /**
+   * ID for the embed (YouTube video ID or Loom share ID)
+   */
+  embed_id?: string | null;
+
+  /**
+   * The type of embed for a lesson
+   */
+  embed_type?: EmbedType | null;
+
+  /**
+   * The thumbnail for the lesson in png, jpeg, or gif format
+   */
+  thumbnail?:
+    | CourseLessonCreateParams.AttachmentInputWithDirectUploadID
+    | CourseLessonCreateParams.AttachmentInputWithID
+    | null;
+
   /**
    * The title of the lesson
    */
   title?: string | null;
 }
 
+export namespace CourseLessonCreateParams {
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithDirectUploadID {
+    /**
+     * This ID should be used the first time you upload an attachment. It is the ID of
+     * the direct upload that was created when uploading the file to S3 via the
+     * mediaDirectUpload mutation.
+     */
+    direct_upload_id: string;
+  }
+
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithID {
+    /**
+     * The ID of an existing attachment object. Use this when updating a resource and
+     * keeping a subset of the attachments. Don't use this unless you know what you're
+     * doing.
+     */
+    id: string;
+  }
+}
+
 export interface CourseLessonUpdateParams {
+  /**
+   * Completion requirements for quiz/knowledge check lessons
+   */
+  assessment_completion_requirement?: CourseLessonUpdateParams.AssessmentCompletionRequirement | null;
+
   /**
    * Assessment questions for quiz/knowledge check lessons. Replaces all existing
    * questions.
@@ -446,7 +556,10 @@ export interface CourseLessonUpdateParams {
    * General attachments for the lesson (PDFs, files, etc). Replaces all existing
    * attachments.
    */
-  attachments?: Array<CourseLessonUpdateParams.Attachment> | null;
+  attachments?: Array<
+    | CourseLessonUpdateParams.AttachmentInputWithDirectUploadID
+    | CourseLessonUpdateParams.AttachmentInputWithID
+  > | null;
 
   /**
    * The content of the lesson
@@ -458,6 +571,16 @@ export interface CourseLessonUpdateParams {
    */
   days_from_course_start_until_unlock?: number | null;
 
+  /**
+   * ID for the embed (YouTube video ID or Loom share ID)
+   */
+  embed_id?: string | null;
+
+  /**
+   * The type of embed for a lesson
+   */
+  embed_type?: EmbedType | null;
+
   /**
    * The available types for a lesson
    */
@@ -466,13 +589,29 @@ export interface CourseLessonUpdateParams {
   /**
    * The main PDF file for this lesson
    */
-  main_pdf?: CourseLessonUpdateParams.MainPdf | null;
+  main_pdf?:
+    | CourseLessonUpdateParams.AttachmentInputWithDirectUploadID
+    | CourseLessonUpdateParams.AttachmentInputWithID
+    | null;
+
+  /**
+   * Maximum number of attempts allowed for assessments
+   */
+  max_attempts?: number | null;
 
   /**
    * The ID of the Mux asset to attach to this lesson for video lessons
    */
   mux_asset_id?: string | null;
 
+  /**
+   * The thumbnail for the lesson in png, jpeg, or gif format
+   */
+  thumbnail?:
+    | CourseLessonUpdateParams.AttachmentInputWithDirectUploadID
+    | CourseLessonUpdateParams.AttachmentInputWithID
+    | null;
+
   /**
    * The title of the lesson
    */
@@ -486,6 +625,23 @@ export interface CourseLessonUpdateParams {
 }
 
 export namespace CourseLessonUpdateParams {
+  /**
+   * Completion requirements for quiz/knowledge check lessons
+   */
+  export interface AssessmentCompletionRequirement {
+    /**
+     * The minimum grade percentage required to pass (0-100). Cannot be set together
+     * with minimum_questions_correct.
+     */
+    minimum_grade_percent?: number | null;
+
+    /**
+     * The minimum number of questions that must be answered correctly. Cannot be set
+     * together with minimum_grade_percent.
+     */
+    minimum_questions_correct?: number | null;
+  }
+
   /**
    * Input for creating or updating an assessment question
    */
@@ -514,7 +670,10 @@ export namespace CourseLessonUpdateParams {
     /**
      * Optional image attachment for the question
      */
-    image?: AssessmentQuestion.Image | null;
+    image?:
+      | AssessmentQuestion.AttachmentInputWithDirectUploadID
+      | AssessmentQuestion.AttachmentInputWithID
+      | null;
 
     /**
      * The answer options for multiple choice/select questions
@@ -524,22 +683,27 @@ export namespace CourseLessonUpdateParams {
 
   export namespace AssessmentQuestion {
     /**
-     * Optional image attachment for the question
+     * Input for an attachment
      */
-    export interface Image {
-      /**
-       * The ID of an existing attachment object. Use this when updating a resource and
-       * keeping a subset of the attachments. Don't use this unless you know what you're
-       * doing.
-       */
-      id?: string | null;
-
+    export interface AttachmentInputWithDirectUploadID {
       /**
        * This ID should be used the first time you upload an attachment. It is the ID of
        * the direct upload that was created when uploading the file to S3 via the
        * mediaDirectUpload mutation.
        */
-      direct_upload_id?: string | null;
+      direct_upload_id: string;
+    }
+
+    /**
+     * Input for an attachment
+     */
+    export interface AttachmentInputWithID {
+      /**
+       * The ID of an existing attachment object. Use this when updating a resource and
+       * keeping a subset of the attachments. Don't use this unless you know what you're
+       * doing.
+       */
+      id: string;
     }
 
     /**
@@ -567,39 +731,73 @@ export namespace CourseLessonUpdateParams {
   /**
    * Input for an attachment
    */
-  export interface Attachment {
+  export interface AttachmentInputWithDirectUploadID {
+    /**
+     * This ID should be used the first time you upload an attachment. It is the ID of
+     * the direct upload that was created when uploading the file to S3 via the
+     * mediaDirectUpload mutation.
+     */
+    direct_upload_id: string;
+  }
+
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithID {
     /**
      * The ID of an existing attachment object. Use this when updating a resource and
      * keeping a subset of the attachments. Don't use this unless you know what you're
      * doing.
      */
-    id?: string | null;
+    id: string;
+  }
 
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithDirectUploadID {
     /**
      * This ID should be used the first time you upload an attachment. It is the ID of
      * the direct upload that was created when uploading the file to S3 via the
      * mediaDirectUpload mutation.
      */
-    direct_upload_id?: string | null;
+    direct_upload_id: string;
   }
 
   /**
-   * The main PDF file for this lesson
+   * Input for an attachment
    */
-  export interface MainPdf {
+  export interface AttachmentInputWithID {
     /**
      * The ID of an existing attachment object. Use this when updating a resource and
      * keeping a subset of the attachments. Don't use this unless you know what you're
      * doing.
      */
-    id?: string | null;
+    id: string;
+  }
 
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithDirectUploadID {
     /**
      * This ID should be used the first time you upload an attachment. It is the ID of
      * the direct upload that was created when uploading the file to S3 via the
      * mediaDirectUpload mutation.
      */
-    direct_upload_id?: string | null;
+    direct_upload_id: string;
+  }
+
+  /**
+   * Input for an attachment
+   */
+  export interface AttachmentInputWithID {
+    /**
+     * The ID of an existing attachment object. Use this when updating a resource and
+     * keeping a subset of the attachments. Don't use this unless you know what you're
+     * doing.
+     */
+    id: string;
   }
 }
 
@@ -633,6 +831,7 @@ export interface CourseLessonListParams extends CursorPageParams {
 export declare namespace CourseLessons {
   export {
     type AssessmentQuestionTypes as AssessmentQuestionTypes,
+    type EmbedType as EmbedType,
     type Lesson as Lesson,
     type LessonTypes as LessonTypes,
     type LessonVisibilities as LessonVisibilities,