@whop/sdk 0.0.26 → 0.0.28

package/resources/course-lessons.d.ts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class CourseLessons extends APIResource {
     /**
-     * Creates a new course lesson
+     * Create a new lesson within a course chapter. Lessons can contain video, text, or
+     * assessment content.
      *
      * Required permissions:
      *
@@ -21,7 +22,7 @@ export declare class CourseLessons extends APIResource {
      */
     create(body: CourseLessonCreateParams, options?: RequestOptions): APIPromise<Lesson>;
     /**
-     * Retrieves a course lesson by ID
+     * Retrieves the details of an existing course lesson.
      *
      * Required permissions:
      *
@@ -36,7 +37,8 @@ export declare class CourseLessons extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Lesson>;
     /**
-     * Updates a course lesson
+     * Update a lesson's content, type, visibility, assessment questions, or media
+     * attachments.
      *
      * Required permissions:
      *
@@ -51,7 +53,8 @@ export declare class CourseLessons extends APIResource {
      */
     update(id: string, body?: CourseLessonUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Lesson>;
     /**
-     * Lists lessons for a course or chapter
+     * Returns a paginated list of lessons within a course or chapter, ordered by
+     * position.
      *
      * Required permissions:
      *
@@ -67,7 +70,7 @@ export declare class CourseLessons extends APIResource {
      */
     list(query?: CourseLessonListParams | null | undefined, options?: RequestOptions): PagePromise<CourseLessonListResponsesCursorPage, CourseLessonListResponse>;
     /**
-     * Deletes a course lesson
+     * Permanently delete a lesson and remove it from its chapter.
      *
      * Required permissions:
      *
@@ -82,7 +85,7 @@ export declare class CourseLessons extends APIResource {
      */
     delete(id: string, options?: RequestOptions): APIPromise<CourseLessonDeleteResponse>;
     /**
-     * Marks a course lesson as completed
+     * Mark a lesson as completed for the current user after they finish the content.
      *
      * @example
      * ```ts
@@ -93,7 +96,8 @@ export declare class CourseLessons extends APIResource {
      */
     markAsCompleted(lessonID: string, options?: RequestOptions): APIPromise<CourseLessonMarkAsCompletedResponse>;
     /**
-     * Starts a course lesson
+     * Record that the current user has started viewing a lesson, creating progress
+     * tracking records.
      *
      * @example
      * ```ts
@@ -104,7 +108,7 @@ export declare class CourseLessons extends APIResource {
      */
     start(lessonID: string, options?: RequestOptions): APIPromise<CourseLessonStartResponse>;
     /**
-     * Submits answers for a course assessment
+     * Submit answers for a quiz or knowledge check lesson and receive a graded result.
      *
      * @example
      * ```ts
@@ -126,35 +130,40 @@ export type AssessmentQuestionTypes = 'short_answer' | 'true_false' | 'multiple_
  */
 export type EmbedType = 'youtube' | 'loom';
 /**
- * A lesson from the courses app
+ * An individual learning unit within a chapter, which can contain text, video,
+ * PDF, or assessment content.
  */
 export interface Lesson {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
     /**
-     * Assessment questions for quiz/knowledge check lessons
+     * The list of questions for quiz or knowledge check lessons. Empty for
+     * non-assessment lesson types.
      */
     assessment_questions: Array<Lesson.AssessmentQuestion>;
     /**
-     * The attached files in this lesson as a flat array
+     * All supplementary files attached to this lesson returned as a flat array rather
+     * than a paginated connection.
      */
     attachments: Array<Lesson.Attachment>;
     /**
-     * The content of the lesson
+     * The Markdown content body of the lesson. Null if the lesson has no text content.
      */
     content: string | null;
     /**
-     * The timestamp of when the lesson was created
+     * The datetime the lesson was created.
      */
     created_at: string;
     /**
-     * Number of days from course start until the lesson is unlocked
+     * The number of days after a student starts the course before this lesson becomes
+     * accessible. Null if the lesson is available immediately.
      */
     days_from_course_start_until_unlock: number | null;
     /**
-     * ID for the embed (YouTube video ID or Loom share ID)
+     * The external video identifier for embedded video lessons, such as a YouTube
+     * video ID or Loom share ID. Null if the lesson has no embed.
      */
     embed_id: string | null;
     /**
@@ -162,32 +171,36 @@ export interface Lesson {
      */
     embed_type: EmbedType | null;
     /**
-     * The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+     * The content format of this lesson. One of: text, video, pdf, multi, quiz,
+     * knowledge_check.
      */
     lesson_type: LessonTypes;
     /**
-     * The main PDF file for this lesson
+     * The primary PDF document for PDF-type lessons. Null if this lesson is not a PDF
+     * lesson or no PDF has been uploaded.
      */
     main_pdf: Lesson.MainPdf | null;
     /**
-     * The order of the lesson within its chapter
+     * The sort position of this lesson within its parent chapter, starting from zero.
      */
     order: number;
     /**
-     * The thumbnail for the lesson
+     * The thumbnail image displayed on lesson cards and previews. Null if no thumbnail
+     * has been uploaded.
      */
     thumbnail: Lesson.Thumbnail | null;
     /**
-     * The title of the lesson
+     * The display name of the lesson shown to students. Maximum 120 characters.
      */
     title: string;
     /**
-     * The associated Mux asset for video lessons
+     * The Mux video asset for video-type lessons, used for streaming playback. Null if
+     * this lesson has no hosted video.
      */
     video_asset: Lesson.VideoAsset | null;
     /**
-     * The visibility of the lesson. Determines how / whether this lesson is visible to
-     * users.
+     * The visibility setting that controls whether this lesson appears to students.
+     * One of: visible, hidden.
      */
     visibility: LessonVisibilities;
 }
@@ -197,7 +210,7 @@ export declare namespace Lesson {
      */
     interface AssessmentQuestion {
         /**
-         * The ID of the assessment question
+         * The unique identifier for the assessment question.
          */
         id: string;
         /**
@@ -206,7 +219,7 @@ export declare namespace Lesson {
          */
         correct_answer: string | null;
         /**
-         * When the question was created
+         * The datetime the assessment question was created.
          */
         created_at: string;
         /**
@@ -236,20 +249,24 @@ export declare namespace Lesson {
          */
         interface Image {
             /**
-             * The ID of the attachment
+             * Represents a unique identifier that is Base64 obfuscated. It is often used to
+             * refetch an object or as key for a cache. The ID type appears in a JSON response
+             * as a String; however, it is not intended to be human-readable. When expected as
+             * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+             * input value will be accepted as an ID.
              */
             id: string;
             /**
-             * The attachment's content type (e.g., image/jpg, video/mp4)
+             * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
              */
             content_type: string | null;
             /**
-             * The name of the file
+             * The original filename of the uploaded attachment, including its file extension.
              */
             filename: string | null;
             /**
-             * This is the URL you use to render optimized attachments on the client. This
-             * should be used for apps.
+             * A pre-optimized URL for rendering this attachment on the client. This should be
+             * used for displaying attachments in apps.
              */
             url: string | null;
         }
@@ -258,7 +275,7 @@ export declare namespace Lesson {
          */
         interface Option {
             /**
-             * The ID of the assessment question option
+             * The unique identifier for the assessment question option.
              */
             id: string;
             /**
@@ -281,61 +298,72 @@ export declare namespace Lesson {
      */
     interface Attachment {
         /**
-         * The ID of the attachment
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         id: string;
         /**
-         * The attachment's content type (e.g., image/jpg, video/mp4)
+         * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
          */
         content_type: string | null;
         /**
-         * The name of the file
+         * The original filename of the uploaded attachment, including its file extension.
          */
         filename: string | null;
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
     /**
-     * The main PDF file for this lesson
+     * The primary PDF document for PDF-type lessons. Null if this lesson is not a PDF
+     * lesson or no PDF has been uploaded.
      */
     interface MainPdf {
         /**
-         * The ID of the attachment
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         id: string;
         /**
-         * The attachment's content type (e.g., image/jpg, video/mp4)
+         * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
          */
         content_type: string | null;
         /**
-         * The name of the file
+         * The original filename of the uploaded attachment, including its file extension.
          */
         filename: string | null;
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
     /**
-     * The thumbnail for the lesson
+     * The thumbnail image displayed on lesson cards and previews. Null if no thumbnail
+     * has been uploaded.
      */
     interface Thumbnail {
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
     /**
-     * The associated Mux asset for video lessons
+     * The Mux video asset for video-type lessons, used for streaming playback. Null if
+     * this lesson has no hosted video.
      */
     interface VideoAsset {
         /**
-         * The ID of the Mux asset
+         * The unique identifier for the mux asset.
          */
         id: string;
         /**
@@ -347,7 +375,7 @@ export declare namespace Lesson {
          */
         audio_only: boolean;
         /**
-         * The time at which the Mux asset was created
+         * The datetime the mux asset was created.
          */
         created_at: string;
         /**
@@ -383,7 +411,7 @@ export declare namespace Lesson {
          */
         status: 'uploading' | 'created' | 'ready';
         /**
-         * The time at which the Mux asset was last updated
+         * The datetime the mux asset was last updated.
          */
         updated_at: string;
     }
@@ -398,27 +426,30 @@ export type LessonTypes = 'text' | 'video' | 'pdf' | 'multi' | 'quiz' | 'knowled
  */
 export type LessonVisibilities = 'visible' | 'hidden';
 /**
- * A lesson from the courses app
+ * An individual learning unit within a chapter, which can contain text, video,
+ * PDF, or assessment content.
  */
 export interface CourseLessonListResponse {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
     /**
-     * The content of the lesson
+     * The Markdown content body of the lesson. Null if the lesson has no text content.
      */
     content: string | null;
     /**
-     * The timestamp of when the lesson was created
+     * The datetime the lesson was created.
      */
     created_at: string;
     /**
-     * Number of days from course start until the lesson is unlocked
+     * The number of days after a student starts the course before this lesson becomes
+     * accessible. Null if the lesson is available immediately.
      */
     days_from_course_start_until_unlock: number | null;
     /**
-     * ID for the embed (YouTube video ID or Loom share ID)
+     * The external video identifier for embedded video lessons, such as a YouTube
+     * video ID or Loom share ID. Null if the lesson has no embed.
      */
     embed_id: string | null;
     /**
@@ -426,35 +457,38 @@ export interface CourseLessonListResponse {
      */
     embed_type: EmbedType | null;
     /**
-     * The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
+     * The content format of this lesson. One of: text, video, pdf, multi, quiz,
+     * knowledge_check.
      */
     lesson_type: LessonTypes;
     /**
-     * The order of the lesson within its chapter
+     * The sort position of this lesson within its parent chapter, starting from zero.
      */
     order: number;
     /**
-     * The thumbnail for the lesson
+     * The thumbnail image displayed on lesson cards and previews. Null if no thumbnail
+     * has been uploaded.
      */
     thumbnail: CourseLessonListResponse.Thumbnail | null;
     /**
-     * The title of the lesson
+     * The display name of the lesson shown to students. Maximum 120 characters.
      */
     title: string;
     /**
-     * The visibility of the lesson. Determines how / whether this lesson is visible to
-     * users.
+     * The visibility setting that controls whether this lesson appears to students.
+     * One of: visible, hidden.
      */
     visibility: LessonVisibilities;
 }
 export declare namespace CourseLessonListResponse {
     /**
-     * The thumbnail for the lesson
+     * The thumbnail image displayed on lesson cards and previews. Null if no thumbnail
+     * has been uploaded.
      */
     interface Thumbnail {
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
@@ -476,11 +510,11 @@ export type CourseLessonStartResponse = boolean;
  */
 export interface CourseLessonSubmitAssessmentResponse {
     /**
-     * The ID of the assessment result
+     * The unique identifier for the assessment result.
      */
     id: string;
     /**
-     * When the assessment was taken
+     * The datetime the assessment result was created.
      */
     created_at: string;
     /**
@@ -514,7 +548,7 @@ export interface CourseLessonSubmitAssessmentResponse {
      */
     score_percent: number;
     /**
-     * When the assessment result was last updated
+     * The datetime the assessment result was last updated.
      */
     updated_at: string;
     /**
@@ -528,11 +562,11 @@ export declare namespace CourseLessonSubmitAssessmentResponse {
      */
     interface Lesson {
         /**
-         * The ID of the lesson
+         * The unique identifier for the lesson.
          */
         id: string;
         /**
-         * The title of the lesson
+         * The display name of the lesson shown to students. Maximum 120 characters.
          */
         title: string;
     }
@@ -541,38 +575,41 @@ export declare namespace CourseLessonSubmitAssessmentResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
-         * The name of the user from their Whop account.
+         * The user's display name shown on their public profile.
          */
         name: string | null;
         /**
-         * The username of the user from their Whop account.
+         * The user's unique username shown on their public profile.
          */
         username: string;
     }
 }
 export interface CourseLessonCreateParams {
     /**
-     * The ID of the chapter to create the lesson in
+     * The unique identifier of the chapter to create the lesson in (e.g.,
+     * "chap_XXXXX").
      */
     chapter_id: string;
     /**
-     * The type of the lesson
+     * The content type of the lesson, such as video, text, quiz, or knowledge check.
      */
     lesson_type: LessonTypes;
     /**
-     * The content of the lesson
+     * The Markdown content body of the lesson.
      */
     content?: string | null;
     /**
-     * Days from course start until unlock
+     * The number of days after a student starts the course before this lesson becomes
+     * accessible.
      */
     days_from_course_start_until_unlock?: number | null;
     /**
-     * ID for the embed (YouTube video ID or Loom share ID)
+     * The external video identifier for embedded content (e.g., a YouTube video ID or
+     * Loom share ID).
      */
     embed_id?: string | null;
     /**
@@ -580,17 +617,17 @@ export interface CourseLessonCreateParams {
      */
     embed_type?: EmbedType | null;
     /**
-     * The thumbnail for the lesson in png, jpeg, or gif format
+     * The thumbnail image for the lesson in PNG, JPEG, or GIF format.
      */
     thumbnail?: CourseLessonCreateParams.Thumbnail | null;
     /**
-     * The title of the lesson
+     * The display title of the lesson (e.g., "Getting Started with APIs").
      */
     title?: string | null;
 }
 export declare namespace CourseLessonCreateParams {
     /**
-     * The thumbnail for the lesson in png, jpeg, or gif format
+     * The thumbnail image for the lesson in PNG, JPEG, or GIF format.
      */
     interface Thumbnail {
         /**
@@ -601,29 +638,32 @@ export declare namespace CourseLessonCreateParams {
 }
 export interface CourseLessonUpdateParams {
     /**
-     * Completion requirements for quiz/knowledge check lessons
+     * The passing criteria for quiz or knowledge check lessons, such as minimum grade
+     * or correct answers.
      */
     assessment_completion_requirement?: CourseLessonUpdateParams.AssessmentCompletionRequirement | null;
     /**
-     * Assessment questions for quiz/knowledge check lessons. Replaces all existing
-     * questions.
+     * The full list of assessment questions for quiz or knowledge check lessons.
+     * Replaces all existing questions.
      */
     assessment_questions?: Array<CourseLessonUpdateParams.AssessmentQuestion> | null;
     /**
-     * General attachments for the lesson (PDFs, files, etc). Replaces all existing
+     * File attachments for the lesson such as PDFs or documents. Replaces all existing
      * attachments.
      */
     attachments?: Array<CourseLessonUpdateParams.Attachment> | null;
     /**
-     * The content of the lesson
+     * The Markdown content body of the lesson.
      */
     content?: string | null;
     /**
-     * Days from course start until unlock
+     * The number of days after a student starts the course before this lesson becomes
+     * accessible.
      */
     days_from_course_start_until_unlock?: number | null;
     /**
-     * ID for the embed (YouTube video ID or Loom share ID)
+     * The external video identifier for embedded content (e.g., a YouTube video ID or
+     * Loom share ID).
      */
     embed_id?: string | null;
     /**
@@ -635,23 +675,24 @@ export interface CourseLessonUpdateParams {
      */
     lesson_type?: LessonTypes | null;
     /**
-     * The main PDF file for this lesson
+     * The primary PDF document attached to this lesson for student reference.
      */
     main_pdf?: CourseLessonUpdateParams.MainPdf | null;
     /**
-     * Maximum number of attempts allowed for assessments
+     * The maximum number of attempts a student is allowed for assessment lessons.
      */
     max_attempts?: number | null;
     /**
-     * The ID of the Mux asset to attach to this lesson for video lessons
+     * The identifier of a Mux video asset to attach to this lesson (e.g.,
+     * "mux_XXXXX").
      */
     mux_asset_id?: string | null;
     /**
-     * The thumbnail for the lesson in png, jpeg, or gif format
+     * The thumbnail image for the lesson in PNG, JPEG, or GIF format.
      */
     thumbnail?: CourseLessonUpdateParams.Thumbnail | null;
     /**
-     * The title of the lesson
+     * The display title of the lesson (e.g., "Getting Started with APIs").
      */
     title?: string | null;
     /**
@@ -662,7 +703,8 @@ export interface CourseLessonUpdateParams {
 }
 export declare namespace CourseLessonUpdateParams {
     /**
-     * Completion requirements for quiz/knowledge check lessons
+     * The passing criteria for quiz or knowledge check lessons, such as minimum grade
+     * or correct answers.
      */
     interface AssessmentCompletionRequirement {
         /**
@@ -745,7 +787,7 @@ export declare namespace CourseLessonUpdateParams {
         id: string;
     }
     /**
-     * The main PDF file for this lesson
+     * The primary PDF document attached to this lesson for student reference.
      */
     interface MainPdf {
         /**
@@ -754,7 +796,7 @@ export declare namespace CourseLessonUpdateParams {
         id: string;
     }
     /**
-     * The thumbnail for the lesson in png, jpeg, or gif format
+     * The thumbnail image for the lesson in PNG, JPEG, or GIF format.
      */
     interface Thumbnail {
         /**
@@ -769,11 +811,11 @@ export interface CourseLessonListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The ID of the chapter (returns lessons only for this chapter)
+     * The unique identifier of a chapter to return only its lessons.
      */
     chapter_id?: string | null;
     /**
-     * The ID of the course (returns all lessons across all chapters)
+     * The unique identifier of the course to return all lessons across all chapters.
      */
     course_id?: string | null;
     /**
@@ -787,7 +829,7 @@ export interface CourseLessonListParams extends CursorPageParams {
 }
 export interface CourseLessonSubmitAssessmentParams {
     /**
-     * The answers to the assessment questions
+     * The list of answers to submit for each assessment question.
      */
     answers: Array<CourseLessonSubmitAssessmentParams.Answer>;
 }