@whop/sdk 0.0.26 → 0.0.28

package/resources/course-chapters.d.ts

@@ -4,7 +4,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class CourseChapters extends APIResource {
     /**
-     * Creates a new course chapter
+     * Create a new chapter within a course to organize lessons into sections.
      *
      * Required permissions:
      *
@@ -19,7 +19,7 @@ export declare class CourseChapters extends APIResource {
      */
     create(body: CourseChapterCreateParams, options?: RequestOptions): APIPromise<CourseChapter>;
     /**
-     * Retrieves a course chapter by ID
+     * Retrieves the details of an existing course chapter.
      *
      * Required permissions:
      *
@@ -34,7 +34,7 @@ export declare class CourseChapters extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<CourseChapter>;
     /**
-     * Updates a course chapter
+     * Update a chapter's title within a course.
      *
      * Required permissions:
      *
@@ -50,7 +50,7 @@ export declare class CourseChapters extends APIResource {
      */
     update(id: string, body: CourseChapterUpdateParams, options?: RequestOptions): APIPromise<CourseChapter>;
     /**
-     * Lists chapters for a course
+     * Returns a paginated list of chapters within a course, ordered by position.
      *
      * Required permissions:
      *
@@ -68,7 +68,7 @@ export declare class CourseChapters extends APIResource {
      */
     list(query: CourseChapterListParams, options?: RequestOptions): PagePromise<CourseChapterListResponsesCursorPage, CourseChapterListResponse>;
     /**
-     * Deletes a course chapter
+     * Permanently delete a chapter and all of its lessons from a course.
      *
      * Required permissions:
      *
@@ -85,59 +85,63 @@ export declare class CourseChapters extends APIResource {
 }
 export type CourseChapterListResponsesCursorPage = CursorPage<CourseChapterListResponse>;
 /**
- * A chapter from the courses app
+ * A grouping of related lessons within a course, used to organize content into
+ * sections.
  */
 export interface CourseChapter {
     /**
-     * The ID of the chapter. Looks like chap_XXX
+     * The unique identifier for the chapter.
      */
     id: string;
     /**
-     * The lessons in this chapter
+     * An ordered list of lessons in this chapter, sorted by display position. Hidden
+     * lessons are excluded for non-admin users.
      */
     lessons: Array<CourseChapter.Lesson>;
     /**
-     * The order of the chapter within its course
+     * The sort position of this chapter within its parent course, starting from zero.
      */
     order: number;
     /**
-     * The title of the chapter
+     * The display name of the chapter shown to students. Maximum 150 characters.
      */
     title: string;
 }
 export declare namespace CourseChapter {
     /**
-     * A lesson from the courses app
+     * An individual learning unit within a chapter, which can contain text, video,
+     * PDF, or assessment content.
      */
     interface Lesson {
         /**
-         * The ID of the lesson
+         * The unique identifier for the lesson.
          */
         id: string;
         /**
-         * The order of the lesson within its chapter
+         * The sort position of this lesson within its parent chapter, starting from zero.
          */
         order: number;
         /**
-         * The title of the lesson
+         * The display name of the lesson shown to students. Maximum 120 characters.
          */
         title: string;
     }
 }
 /**
- * A chapter from the courses app
+ * A grouping of related lessons within a course, used to organize content into
+ * sections.
  */
 export interface CourseChapterListResponse {
     /**
-     * The ID of the chapter. Looks like chap_XXX
+     * The unique identifier for the chapter.
      */
     id: string;
     /**
-     * The order of the chapter within its course
+     * The sort position of this chapter within its parent course, starting from zero.
      */
     order: number;
     /**
-     * The title of the chapter
+     * The display name of the chapter shown to students. Maximum 150 characters.
      */
     title: string;
 }
@@ -147,23 +151,24 @@ export interface CourseChapterListResponse {
 export type CourseChapterDeleteResponse = boolean;
 export interface CourseChapterCreateParams {
     /**
-     * The ID of the course to create the chapter in
+     * The unique identifier of the course to create the chapter in (e.g.,
+     * "course_XXXXX").
      */
     course_id: string;
     /**
-     * The title of the chapter
+     * The display title of the chapter (e.g., "Module 1: Introduction").
      */
     title?: string | null;
 }
 export interface CourseChapterUpdateParams {
     /**
-     * The title of the chapter
+     * The new display title of the chapter (e.g., "Module 1: Introduction").
      */
     title: string;
 }
 export interface CourseChapterListParams extends CursorPageParams {
     /**
-     * The ID of the course
+     * The unique identifier of the course to list chapters for.
      */
     course_id: string;
     /**

package/resources/course-chapters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"course-chapters.d.ts","sourceRoot":"","sources":["../src/resources/course-chapters.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIxG;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;IAO/E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGtF;AAED,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAElD,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
+{"version":3,"file":"course-chapters.d.ts","sourceRoot":"","sources":["../src/resources/course-chapters.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAI5F;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIzE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,aAAa,CAAC;IAIxG;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;IAO/E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGtF;AAED,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAErC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,aAAa,CAAC;IAC7B;;;OAGG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAElD,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/course-chapters.js

@@ -7,7 +7,7 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class CourseChapters extends resource_1.APIResource {
     /**
-     * Creates a new course chapter
+     * Create a new chapter within a course to organize lessons into sections.
      *
      * Required permissions:
      *
@@ -24,7 +24,7 @@ class CourseChapters extends resource_1.APIResource {
         return this._client.post('/course_chapters', { body, ...options });
     }
     /**
-     * Retrieves a course chapter by ID
+     * Retrieves the details of an existing course chapter.
      *
      * Required permissions:
      *
@@ -41,7 +41,7 @@ class CourseChapters extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/course_chapters/${id}`, options);
     }
     /**
-     * Updates a course chapter
+     * Update a chapter's title within a course.
      *
      * Required permissions:
      *
@@ -59,7 +59,7 @@ class CourseChapters extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/course_chapters/${id}`, { body, ...options });
     }
     /**
-     * Lists chapters for a course
+     * Returns a paginated list of chapters within a course, ordered by position.
      *
      * Required permissions:
      *
@@ -82,7 +82,7 @@ class CourseChapters extends resource_1.APIResource {
         });
     }
     /**
-     * Deletes a course chapter
+     * Permanently delete a chapter and all of its lessons from a course.
      *
      * Required permissions:
      *

package/resources/course-chapters.mjs

@@ -4,7 +4,7 @@ import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class CourseChapters extends APIResource {
     /**
-     * Creates a new course chapter
+     * Create a new chapter within a course to organize lessons into sections.
      *
      * Required permissions:
      *
@@ -21,7 +21,7 @@ export class CourseChapters extends APIResource {
         return this._client.post('/course_chapters', { body, ...options });
     }
     /**
-     * Retrieves a course chapter by ID
+     * Retrieves the details of an existing course chapter.
      *
      * Required permissions:
      *
@@ -38,7 +38,7 @@ export class CourseChapters extends APIResource {
         return this._client.get(path `/course_chapters/${id}`, options);
     }
     /**
-     * Updates a course chapter
+     * Update a chapter's title within a course.
      *
      * Required permissions:
      *
@@ -56,7 +56,7 @@ export class CourseChapters extends APIResource {
         return this._client.patch(path `/course_chapters/${id}`, { body, ...options });
     }
     /**
-     * Lists chapters for a course
+     * Returns a paginated list of chapters within a course, ordered by position.
      *
      * Required permissions:
      *
@@ -79,7 +79,7 @@ export class CourseChapters extends APIResource {
         });
     }
     /**
-     * Deletes a course chapter
+     * Permanently delete a chapter and all of its lessons from a course.
      *
      * Required permissions:
      *

package/resources/course-lesson-interactions.d.mts

@@ -6,7 +6,7 @@ import { type CursorPageParams, PagePromise } from "../core/pagination.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class CourseLessonInteractions extends APIResource {
     /**
-     * Retrieves a course lesson interaction by ID
+     * Retrieves the details of an existing course lesson interaction.
      *
      * Required permissions:
      *
@@ -15,7 +15,8 @@ export declare class CourseLessonInteractions extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction>;
     /**
-     * Lists course lesson interactions
+     * Returns a paginated list of lesson interactions, filtered by lesson, course,
+     * user, or completion status.
      *
      * Required permissions:
      *
@@ -30,11 +31,11 @@ export interface CourseLessonInteractionListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * Whether the lesson has been completed by the user
+     * Whether to filter for completed or in-progress lesson interactions.
      */
     completed?: boolean | null;
     /**
-     * The ID of the course to list course lesson interactions for
+     * The unique identifier of the course to filter interactions for.
      */
     course_id?: string | null;
     /**
@@ -46,11 +47,11 @@ export interface CourseLessonInteractionListParams extends CursorPageParams {
      */
     last?: number | null;
     /**
-     * The ID of the lesson to list course lesson interactions for
+     * The unique identifier of the lesson to filter interactions for.
      */
     lesson_id?: string | null;
     /**
-     * The ID of the user to list course lesson interactions for
+     * The unique identifier of the user to filter lesson interactions for.
      */
     user_id?: string | null;
 }

package/resources/course-lesson-interactions.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"course-lesson-interactions.d.mts","sourceRoot":"","sources":["../src/resources/course-lesson-interactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0CAA0C,EAAE;OAC9C,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,MAAM,CAAC,+BAA+B,CAAC;CAOnG;AAED,MAAM,WAAW,iCAAkC,SAAQ,gBAAgB;IACzE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,OAAO,EAAE,KAAK,iCAAiC,IAAI,iCAAiC,EAAE,CAAC;CACxF;AAED,OAAO,EAAE,KAAK,0CAA0C,EAAE,CAAC"}
+{"version":3,"file":"course-lesson-interactions.d.mts","sourceRoot":"","sources":["../src/resources/course-lesson-interactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0CAA0C,EAAE;OAC9C,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,MAAM,CAAC,+BAA+B,CAAC;CAOnG;AAED,MAAM,WAAW,iCAAkC,SAAQ,gBAAgB;IACzE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,OAAO,EAAE,KAAK,iCAAiC,IAAI,iCAAiC,EAAE,CAAC;CACxF;AAED,OAAO,EAAE,KAAK,0CAA0C,EAAE,CAAC"}

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

@@ -6,7 +6,7 @@ import { type CursorPageParams, PagePromise } from "../core/pagination.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare class CourseLessonInteractions extends APIResource {
     /**
-     * Retrieves a course lesson interaction by ID
+     * Retrieves the details of an existing course lesson interaction.
      *
      * Required permissions:
      *
@@ -15,7 +15,8 @@ export declare class CourseLessonInteractions extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction>;
     /**
-     * Lists course lesson interactions
+     * Returns a paginated list of lesson interactions, filtered by lesson, course,
+     * user, or completion status.
      *
      * Required permissions:
      *
@@ -30,11 +31,11 @@ export interface CourseLessonInteractionListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * Whether the lesson has been completed by the user
+     * Whether to filter for completed or in-progress lesson interactions.
      */
     completed?: boolean | null;
     /**
-     * The ID of the course to list course lesson interactions for
+     * The unique identifier of the course to filter interactions for.
      */
     course_id?: string | null;
     /**
@@ -46,11 +47,11 @@ export interface CourseLessonInteractionListParams extends CursorPageParams {
      */
     last?: number | null;
     /**
-     * The ID of the lesson to list course lesson interactions for
+     * The unique identifier of the lesson to filter interactions for.
      */
     lesson_id?: string | null;
     /**
-     * The ID of the user to list course lesson interactions for
+     * The unique identifier of the user to filter lesson interactions for.
      */
     user_id?: string | null;
 }

package/resources/course-lesson-interactions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"course-lesson-interactions.d.ts","sourceRoot":"","sources":["../src/resources/course-lesson-interactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0CAA0C,EAAE;OAC9C,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,MAAM,CAAC,+BAA+B,CAAC;CAOnG;AAED,MAAM,WAAW,iCAAkC,SAAQ,gBAAgB;IACzE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,OAAO,EAAE,KAAK,iCAAiC,IAAI,iCAAiC,EAAE,CAAC;CACxF;AAED,OAAO,EAAE,KAAK,0CAA0C,EAAE,CAAC"}
+{"version":3,"file":"course-lesson-interactions.d.ts","sourceRoot":"","sources":["../src/resources/course-lesson-interactions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,0CAA0C,EAAE;OAC9C,EAAE,UAAU,EAAE;OACd,EAAc,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,uBAAuB,CAAC;IAI1F;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,iCAAiC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0CAA0C,EAAE,MAAM,CAAC,+BAA+B,CAAC;CAOnG;AAED,MAAM,WAAW,iCAAkC,SAAQ,gBAAgB;IACzE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,wBAAwB,CAAC;IAChD,OAAO,EAAE,KAAK,iCAAiC,IAAI,iCAAiC,EAAE,CAAC;CACxF;AAED,OAAO,EAAE,KAAK,0CAA0C,EAAE,CAAC"}

package/resources/course-lesson-interactions.js

@@ -7,7 +7,7 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class CourseLessonInteractions extends resource_1.APIResource {
     /**
-     * Retrieves a course lesson interaction by ID
+     * Retrieves the details of an existing course lesson interaction.
      *
      * Required permissions:
      *
@@ -18,7 +18,8 @@ class CourseLessonInteractions extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/course_lesson_interactions/${id}`, options);
     }
     /**
-     * Lists course lesson interactions
+     * Returns a paginated list of lesson interactions, filtered by lesson, course,
+     * user, or completion status.
      *
      * Required permissions:
      *

package/resources/course-lesson-interactions.js.map

@@ -1 +1 @@
-{"version":3,"file":"course-lesson-interactions.js","sourceRoot":"","sources":["../src/resources/course-lesson-interactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,wBAAyB,SAAQ,sBAAW;IACvD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,6BAA6B,EAC7B,CAAA,uBAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AA/BD,4DA+BC"}
+{"version":3,"file":"course-lesson-interactions.js","sourceRoot":"","sources":["../src/resources/course-lesson-interactions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,wBAAyB,SAAQ,sBAAW;IACvD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,6BAA6B,EAC7B,CAAA,uBAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAhCD,4DAgCC"}

package/resources/course-lesson-interactions.mjs

@@ -4,7 +4,7 @@ import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class CourseLessonInteractions extends APIResource {
     /**
-     * Retrieves a course lesson interaction by ID
+     * Retrieves the details of an existing course lesson interaction.
      *
      * Required permissions:
      *
@@ -15,7 +15,8 @@ export class CourseLessonInteractions extends APIResource {
         return this._client.get(path `/course_lesson_interactions/${id}`, options);
     }
     /**
-     * Lists course lesson interactions
+     * Returns a paginated list of lesson interactions, filtered by lesson, course,
+     * user, or completion status.
      *
      * Required permissions:
      *

package/resources/course-lesson-interactions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"course-lesson-interactions.mjs","sourceRoot":"","sources":["../src/resources/course-lesson-interactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,6BAA6B,EAC7B,CAAA,UAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"course-lesson-interactions.mjs","sourceRoot":"","sources":["../src/resources/course-lesson-interactions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,wBAAyB,SAAQ,WAAW;IACvD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,+BAA+B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,6BAA6B,EAC7B,CAAA,UAAkD,CAAA,EAClD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}