@whop/sdk 0.0.26 → 0.0.27

package/resources/company-token-transactions.d.mts

@@ -56,7 +56,7 @@ export type BotTokenTransactionTypes = 'add' | 'subtract' | 'transfer';
  */
 export interface CompanyTokenTransaction {
     /**
-     * The ID of the transaction
+     * The unique identifier for the company token transaction.
      */
     id: string;
     /**
@@ -68,7 +68,7 @@ export interface CompanyTokenTransaction {
      */
     company: CompanyTokenTransaction.Company;
     /**
-     * When the transaction was created
+     * The datetime the company token transaction was created.
      */
     created_at: string;
     /**
@@ -102,7 +102,7 @@ export declare namespace CompanyTokenTransaction {
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -119,7 +119,7 @@ export declare namespace CompanyTokenTransaction {
      */
     interface Member {
         /**
-         * The ID of the member
+         * The unique identifier for the company member.
          */
         id: string;
     }
@@ -128,7 +128,7 @@ export declare namespace CompanyTokenTransaction {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -146,7 +146,7 @@ export declare namespace CompanyTokenTransaction {
  */
 export interface CompanyTokenTransactionListResponse {
     /**
-     * The ID of the transaction
+     * The unique identifier for the company token transaction.
      */
     id: string;
     /**
@@ -158,7 +158,7 @@ export interface CompanyTokenTransactionListResponse {
      */
     company: CompanyTokenTransactionListResponse.Company;
     /**
-     * When the transaction was created
+     * The datetime the company token transaction was created.
      */
     created_at: string;
     /**
@@ -192,7 +192,7 @@ export declare namespace CompanyTokenTransactionListResponse {
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -209,7 +209,7 @@ export declare namespace CompanyTokenTransactionListResponse {
      */
     interface Member {
         /**
-         * The ID of the member
+         * The unique identifier for the company member.
          */
         id: string;
     }
@@ -218,7 +218,7 @@ export declare namespace CompanyTokenTransactionListResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**

package/resources/company-token-transactions.d.ts

@@ -56,7 +56,7 @@ export type BotTokenTransactionTypes = 'add' | 'subtract' | 'transfer';
  */
 export interface CompanyTokenTransaction {
     /**
-     * The ID of the transaction
+     * The unique identifier for the company token transaction.
      */
     id: string;
     /**
@@ -68,7 +68,7 @@ export interface CompanyTokenTransaction {
      */
     company: CompanyTokenTransaction.Company;
     /**
-     * When the transaction was created
+     * The datetime the company token transaction was created.
      */
     created_at: string;
     /**
@@ -102,7 +102,7 @@ export declare namespace CompanyTokenTransaction {
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -119,7 +119,7 @@ export declare namespace CompanyTokenTransaction {
      */
     interface Member {
         /**
-         * The ID of the member
+         * The unique identifier for the company member.
          */
         id: string;
     }
@@ -128,7 +128,7 @@ export declare namespace CompanyTokenTransaction {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -146,7 +146,7 @@ export declare namespace CompanyTokenTransaction {
  */
 export interface CompanyTokenTransactionListResponse {
     /**
-     * The ID of the transaction
+     * The unique identifier for the company token transaction.
      */
     id: string;
     /**
@@ -158,7 +158,7 @@ export interface CompanyTokenTransactionListResponse {
      */
     company: CompanyTokenTransactionListResponse.Company;
     /**
-     * When the transaction was created
+     * The datetime the company token transaction was created.
      */
     created_at: string;
     /**
@@ -192,7 +192,7 @@ export declare namespace CompanyTokenTransactionListResponse {
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -209,7 +209,7 @@ export declare namespace CompanyTokenTransactionListResponse {
      */
     interface Member {
         /**
-         * The ID of the member
+         * The unique identifier for the company member.
          */
         id: string;
     }
@@ -218,7 +218,7 @@ export declare namespace CompanyTokenTransactionListResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**

package/resources/course-chapters.d.mts

@@ -89,7 +89,7 @@ export type CourseChapterListResponsesCursorPage = CursorPage<CourseChapterListR
  */
 export interface CourseChapter {
     /**
-     * The ID of the chapter. Looks like chap_XXX
+     * The unique identifier for the chapter.
      */
     id: string;
     /**
@@ -111,7 +111,7 @@ export declare namespace CourseChapter {
      */
     interface Lesson {
         /**
-         * The ID of the lesson
+         * The unique identifier for the lesson.
          */
         id: string;
         /**
@@ -129,7 +129,7 @@ export declare namespace CourseChapter {
  */
 export interface CourseChapterListResponse {
     /**
-     * The ID of the chapter. Looks like chap_XXX
+     * The unique identifier for the chapter.
      */
     id: string;
     /**

package/resources/course-chapters.d.ts

@@ -89,7 +89,7 @@ export type CourseChapterListResponsesCursorPage = CursorPage<CourseChapterListR
  */
 export interface CourseChapter {
     /**
-     * The ID of the chapter. Looks like chap_XXX
+     * The unique identifier for the chapter.
      */
     id: string;
     /**
@@ -111,7 +111,7 @@ export declare namespace CourseChapter {
      */
     interface Lesson {
         /**
-         * The ID of the lesson
+         * The unique identifier for the lesson.
          */
         id: string;
         /**
@@ -129,7 +129,7 @@ export declare namespace CourseChapter {
  */
 export interface CourseChapterListResponse {
     /**
-     * The ID of the chapter. Looks like chap_XXX
+     * The unique identifier for the chapter.
      */
     id: string;
     /**

package/resources/course-lessons.d.mts

@@ -130,7 +130,7 @@ export type EmbedType = 'youtube' | 'loom';
  */
 export interface Lesson {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
     /**
@@ -146,7 +146,7 @@ export interface Lesson {
      */
     content: string | null;
     /**
-     * The timestamp of when the lesson was created
+     * The datetime the lesson was created.
      */
     created_at: string;
     /**
@@ -197,7 +197,7 @@ export declare namespace Lesson {
      */
     interface AssessmentQuestion {
         /**
-         * The ID of the assessment question
+         * The unique identifier for the assessment question.
          */
         id: string;
         /**
@@ -206,7 +206,7 @@ export declare namespace Lesson {
          */
         correct_answer: string | null;
         /**
-         * When the question was created
+         * The datetime the assessment question was created.
          */
         created_at: string;
         /**
@@ -258,7 +258,7 @@ export declare namespace Lesson {
          */
         interface Option {
             /**
-             * The ID of the assessment question option
+             * The unique identifier for the assessment question option.
              */
             id: string;
             /**
@@ -335,7 +335,7 @@ export declare namespace Lesson {
      */
     interface VideoAsset {
         /**
-         * The ID of the Mux asset
+         * The unique identifier for the mux asset.
          */
         id: string;
         /**
@@ -347,7 +347,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 +383,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;
     }
@@ -402,7 +402,7 @@ export type LessonVisibilities = 'visible' | 'hidden';
  */
 export interface CourseLessonListResponse {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
     /**
@@ -410,7 +410,7 @@ export interface CourseLessonListResponse {
      */
     content: string | null;
     /**
-     * The timestamp of when the lesson was created
+     * The datetime the lesson was created.
      */
     created_at: string;
     /**
@@ -476,11 +476,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 +514,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,7 +528,7 @@ export declare namespace CourseLessonSubmitAssessmentResponse {
      */
     interface Lesson {
         /**
-         * The ID of the lesson
+         * The unique identifier for the lesson.
          */
         id: string;
         /**
@@ -541,7 +541,7 @@ export declare namespace CourseLessonSubmitAssessmentResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**

package/resources/course-lessons.d.ts

@@ -130,7 +130,7 @@ export type EmbedType = 'youtube' | 'loom';
  */
 export interface Lesson {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
     /**
@@ -146,7 +146,7 @@ export interface Lesson {
      */
     content: string | null;
     /**
-     * The timestamp of when the lesson was created
+     * The datetime the lesson was created.
      */
     created_at: string;
     /**
@@ -197,7 +197,7 @@ export declare namespace Lesson {
      */
     interface AssessmentQuestion {
         /**
-         * The ID of the assessment question
+         * The unique identifier for the assessment question.
          */
         id: string;
         /**
@@ -206,7 +206,7 @@ export declare namespace Lesson {
          */
         correct_answer: string | null;
         /**
-         * When the question was created
+         * The datetime the assessment question was created.
          */
         created_at: string;
         /**
@@ -258,7 +258,7 @@ export declare namespace Lesson {
          */
         interface Option {
             /**
-             * The ID of the assessment question option
+             * The unique identifier for the assessment question option.
              */
             id: string;
             /**
@@ -335,7 +335,7 @@ export declare namespace Lesson {
      */
     interface VideoAsset {
         /**
-         * The ID of the Mux asset
+         * The unique identifier for the mux asset.
          */
         id: string;
         /**
@@ -347,7 +347,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 +383,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;
     }
@@ -402,7 +402,7 @@ export type LessonVisibilities = 'visible' | 'hidden';
  */
 export interface CourseLessonListResponse {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
     /**
@@ -410,7 +410,7 @@ export interface CourseLessonListResponse {
      */
     content: string | null;
     /**
-     * The timestamp of when the lesson was created
+     * The datetime the lesson was created.
      */
     created_at: string;
     /**
@@ -476,11 +476,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 +514,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,7 +528,7 @@ export declare namespace CourseLessonSubmitAssessmentResponse {
      */
     interface Lesson {
         /**
-         * The ID of the lesson
+         * The unique identifier for the lesson.
          */
         id: string;
         /**
@@ -541,7 +541,7 @@ export declare namespace CourseLessonSubmitAssessmentResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**

package/resources/course-students.d.mts

@@ -28,7 +28,7 @@ export type CourseStudentListResponsesCursorPage = CursorPage<CourseStudentListR
  */
 export interface CourseStudentRetrieveResponse {
     /**
-     * The ID of the course student. Looks like crsi_XXX
+     * The unique identifier for the course student type.
      */
     id: string;
     /**
@@ -66,7 +66,7 @@ export declare namespace CourseStudentRetrieveResponse {
      */
     interface Course {
         /**
-         * The ID of the course. Looks like cors_XXX
+         * The unique identifier for the course.
          */
         id: string;
         /**
@@ -84,7 +84,7 @@ export declare namespace CourseStudentRetrieveResponse {
          */
         interface Experience {
             /**
-             * The unique ID representing this experience
+             * The unique identifier for the experience.
              */
             id: string;
         }
@@ -94,7 +94,7 @@ export declare namespace CourseStudentRetrieveResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -112,7 +112,7 @@ export declare namespace CourseStudentRetrieveResponse {
  */
 export interface CourseStudentListResponse {
     /**
-     * The ID of the course student. Looks like crsi_XXX
+     * The unique identifier for the course student type.
      */
     id: string;
     /**
@@ -146,7 +146,7 @@ export declare namespace CourseStudentListResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**

package/resources/course-students.d.ts

@@ -28,7 +28,7 @@ export type CourseStudentListResponsesCursorPage = CursorPage<CourseStudentListR
  */
 export interface CourseStudentRetrieveResponse {
     /**
-     * The ID of the course student. Looks like crsi_XXX
+     * The unique identifier for the course student type.
      */
     id: string;
     /**
@@ -66,7 +66,7 @@ export declare namespace CourseStudentRetrieveResponse {
      */
     interface Course {
         /**
-         * The ID of the course. Looks like cors_XXX
+         * The unique identifier for the course.
          */
         id: string;
         /**
@@ -84,7 +84,7 @@ export declare namespace CourseStudentRetrieveResponse {
          */
         interface Experience {
             /**
-             * The unique ID representing this experience
+             * The unique identifier for the experience.
              */
             id: string;
         }
@@ -94,7 +94,7 @@ export declare namespace CourseStudentRetrieveResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**
@@ -112,7 +112,7 @@ export declare namespace CourseStudentRetrieveResponse {
  */
 export interface CourseStudentListResponse {
     /**
-     * The ID of the course student. Looks like crsi_XXX
+     * The unique identifier for the course student type.
      */
     id: string;
     /**
@@ -146,7 +146,7 @@ export declare namespace CourseStudentListResponse {
      */
     interface User {
         /**
-         * The internal ID of the user.
+         * The unique identifier for the user.
          */
         id: string;
         /**

package/resources/courses.d.mts

@@ -88,7 +88,7 @@ export type CourseListResponsesCursorPage = CursorPage<CourseListResponse>;
  */
 export interface Course {
     /**
-     * The ID of the course. Looks like cors_XXX
+     * The unique identifier for the course.
      */
     id: string;
     /**
@@ -105,7 +105,7 @@ export interface Course {
      */
     cover_image: string | null;
     /**
-     * The timestamp of when the course was created
+     * The datetime the course was created.
      */
     created_at: string;
     /**
@@ -139,7 +139,7 @@ export interface Course {
      */
     title: string | null;
     /**
-     * The timestamp of when the course was last updated
+     * The datetime the course was last updated.
      */
     updated_at: string;
     /**
@@ -154,7 +154,7 @@ export declare namespace Course {
      */
     interface Chapter {
         /**
-         * The ID of the chapter. Looks like chap_XXX
+         * The unique identifier for the chapter.
          */
         id: string;
         /**
@@ -176,7 +176,7 @@ export declare namespace Course {
          */
         interface Lesson {
             /**
-             * The ID of the lesson
+             * The unique identifier for the lesson.
              */
             id: string;
             /**
@@ -272,7 +272,7 @@ export type Languages = 'en' | 'es' | 'it' | 'pt' | 'de' | 'fr' | 'pl' | 'ru' |
  */
 export interface CourseListResponse {
     /**
-     * The ID of the course. Looks like cors_XXX
+     * The unique identifier for the course.
      */
     id: string;
     /**
@@ -285,7 +285,7 @@ export interface CourseListResponse {
      */
     cover_image: string | null;
     /**
-     * The timestamp of when the course was created
+     * The datetime the course was created.
      */
     created_at: string;
     /**
@@ -319,7 +319,7 @@ export interface CourseListResponse {
      */
     title: string | null;
     /**
-     * The timestamp of when the course was last updated
+     * The datetime the course was last updated.
      */
     updated_at: string;
     /**