@whop/sdk 0.0.26 → 0.0.28

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

@@ -8,7 +8,8 @@ import { path } from '../internal/utils/path';
 
 export class CompanyTokenTransactions extends APIResource {
   /**
-   * Create a token transaction (add/subtract/transfer) for a member
+   * Create a token transaction to add, subtract, or transfer tokens for a member
+   * within a company.
    *
    * Required permissions:
    *
@@ -36,7 +37,7 @@ export class CompanyTokenTransactions extends APIResource {
   }
 
   /**
-   * Retrieves a token transaction by ID
+   * Retrieves the details of an existing company token transaction.
    *
    * Required permissions:
    *
@@ -49,7 +50,9 @@ export class CompanyTokenTransactions extends APIResource {
   }
 
   /**
-   * Lists token transactions for a company
+   * Returns a paginated list of token transactions for a user or company, depending
+   * on the authenticated actor, with optional filtering by user and transaction
+   * type.
    *
    * Required permissions:
    *
@@ -72,72 +75,72 @@ export class CompanyTokenTransactions extends APIResource {
 export type CompanyTokenTransactionListResponsesCursorPage = CursorPage<CompanyTokenTransactionListResponse>;
 
 /**
- * The type of token transaction
- */
-export type BotTokenTransactionTypes = 'add' | 'subtract' | 'transfer';
-
-/**
- * A token transaction within a company
+ * A token transaction records a credit or debit to a member's token balance within
+ * a company, including transfers between members.
  */
 export interface CompanyTokenTransaction {
   /**
-   * The ID of the transaction
+   * The unique identifier for the company token transaction.
    */
   id: string;
 
   /**
-   * The transaction amount (always positive)
+   * The token amount for this transaction. Always a positive value regardless of
+   * transaction type.
    */
   amount: number;
 
   /**
-   * The company
+   * The company whose token balance this transaction affects.
    */
   company: CompanyTokenTransaction.Company;
 
   /**
-   * When the transaction was created
+   * The datetime the company token transaction was created.
    */
   created_at: string;
 
   /**
-   * Optional description
+   * Free-text description explaining the reason for this token transaction. Null if
+   * no description was provided.
    */
   description: string | null;
 
   /**
-   * Optional idempotency key to prevent duplicate transactions
+   * A unique key used to prevent duplicate transactions when retrying API requests.
+   * Null if no idempotency key was provided.
    */
   idempotency_key: string | null;
 
   /**
-   * For transfers, the ID of the linked transaction
+   * The ID of the corresponding transaction on the other side of a transfer. Null if
+   * this is not a transfer transaction.
    */
   linked_transaction_id: string | null;
 
   /**
-   * The member
+   * The member whose token balance was affected by this transaction.
    */
   member: CompanyTokenTransaction.Member;
 
   /**
-   * The type of transaction
+   * The direction of this token transaction (add, subtract, or transfer).
    */
-  transaction_type: BotTokenTransactionTypes;
+  transaction_type: CompanyTokenTransactionType;
 
   /**
-   * The user whose balance changed
+   * The user whose token balance was affected by this transaction.
    */
   user: CompanyTokenTransaction.User;
 }
 
 export namespace CompanyTokenTransaction {
   /**
-   * The company
+   * The company whose token balance this transaction affects.
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -153,98 +156,108 @@ export namespace CompanyTokenTransaction {
   }
 
   /**
-   * The member
+   * The member whose token balance was affected by this transaction.
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
 
   /**
-   * The user whose balance changed
+   * The user whose token balance was affected by this transaction.
    */
   export 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;
   }
 }
 
 /**
- * A token transaction within a company
+ * The type of token transaction
+ */
+export type CompanyTokenTransactionType = 'add' | 'subtract' | 'transfer';
+
+/**
+ * A token transaction records a credit or debit to a member's token balance within
+ * a company, including transfers between members.
  */
 export interface CompanyTokenTransactionListResponse {
   /**
-   * The ID of the transaction
+   * The unique identifier for the company token transaction.
    */
   id: string;
 
   /**
-   * The transaction amount (always positive)
+   * The token amount for this transaction. Always a positive value regardless of
+   * transaction type.
    */
   amount: number;
 
   /**
-   * The company
+   * The company whose token balance this transaction affects.
    */
   company: CompanyTokenTransactionListResponse.Company;
 
   /**
-   * When the transaction was created
+   * The datetime the company token transaction was created.
    */
   created_at: string;
 
   /**
-   * Optional description
+   * Free-text description explaining the reason for this token transaction. Null if
+   * no description was provided.
    */
   description: string | null;
 
   /**
-   * Optional idempotency key to prevent duplicate transactions
+   * A unique key used to prevent duplicate transactions when retrying API requests.
+   * Null if no idempotency key was provided.
    */
   idempotency_key: string | null;
 
   /**
-   * For transfers, the ID of the linked transaction
+   * The ID of the corresponding transaction on the other side of a transfer. Null if
+   * this is not a transfer transaction.
    */
   linked_transaction_id: string | null;
 
   /**
-   * The member
+   * The member whose token balance was affected by this transaction.
    */
   member: CompanyTokenTransactionListResponse.Member;
 
   /**
-   * The type of transaction
+   * The direction of this token transaction (add, subtract, or transfer).
    */
-  transaction_type: BotTokenTransactionTypes;
+  transaction_type: CompanyTokenTransactionType;
 
   /**
-   * The user whose balance changed
+   * The user whose token balance was affected by this transaction.
    */
   user: CompanyTokenTransactionListResponse.User;
 }
 
 export namespace CompanyTokenTransactionListResponse {
   /**
-   * The company
+   * The company whose token balance this transaction affects.
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -260,31 +273,31 @@ export namespace CompanyTokenTransactionListResponse {
   }
 
   /**
-   * The member
+   * The member whose token balance was affected by this transaction.
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
 
   /**
-   * The user whose balance changed
+   * The user whose token balance was affected by this transaction.
    */
   export 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;
   }
@@ -298,92 +311,102 @@ export type CompanyTokenTransactionCreateParams =
 export declare namespace CompanyTokenTransactionCreateParams {
   export interface CreateCompanyTokenTransactionInputTransactionTypeTransfer {
     /**
-     * The positive amount of tokens
+     * The positive number of tokens to transact. For example, 100.0 for 100 tokens.
      */
     amount: number;
 
     /**
-     * The company ID
+     * The unique identifier of the company to create the transaction in, starting with
+     * 'biz\_'.
      */
     company_id: string;
 
     /**
-     * Required for transfers - the user to receive tokens
+     * The unique identifier of the user receiving the tokens. Required when the
+     * transaction type is 'transfer'.
      */
     destination_user_id: string;
 
     transaction_type: 'transfer';
 
     /**
-     * The user ID whose balance will change
+     * The unique identifier of the user whose token balance will be affected, starting
+     * with 'user\_'.
      */
     user_id: string;
 
     /**
-     * Optional description for the transaction
+     * A human-readable description of why the transaction was created.
      */
     description?: string | null;
 
     /**
-     * Optional key to prevent duplicate transactions
+     * A unique key to prevent duplicate transactions. Use a UUID or similar unique
+     * string.
      */
     idempotency_key?: string | null;
   }
 
   export interface CreateCompanyTokenTransactionInputTransactionTypeAdd {
     /**
-     * The positive amount of tokens
+     * The positive number of tokens to transact. For example, 100.0 for 100 tokens.
      */
     amount: number;
 
     /**
-     * The company ID
+     * The unique identifier of the company to create the transaction in, starting with
+     * 'biz\_'.
      */
     company_id: string;
 
     transaction_type: 'add';
 
     /**
-     * The user ID whose balance will change
+     * The unique identifier of the user whose token balance will be affected, starting
+     * with 'user\_'.
      */
     user_id: string;
 
     /**
-     * Optional description for the transaction
+     * A human-readable description of why the transaction was created.
      */
     description?: string | null;
 
     /**
-     * Optional key to prevent duplicate transactions
+     * A unique key to prevent duplicate transactions. Use a UUID or similar unique
+     * string.
      */
     idempotency_key?: string | null;
   }
 
   export interface CreateCompanyTokenTransactionInputTransactionTypeSubtract {
     /**
-     * The positive amount of tokens
+     * The positive number of tokens to transact. For example, 100.0 for 100 tokens.
      */
     amount: number;
 
     /**
-     * The company ID
+     * The unique identifier of the company to create the transaction in, starting with
+     * 'biz\_'.
      */
     company_id: string;
 
     transaction_type: 'subtract';
 
     /**
-     * The user ID whose balance will change
+     * The unique identifier of the user whose token balance will be affected, starting
+     * with 'user\_'.
      */
     user_id: string;
 
     /**
-     * Optional description for the transaction
+     * A human-readable description of why the transaction was created.
      */
     description?: string | null;
 
     /**
-     * Optional key to prevent duplicate transactions
+     * A unique key to prevent duplicate transactions. Use a UUID or similar unique
+     * string.
      */
     idempotency_key?: string | null;
   }
@@ -391,7 +414,7 @@ export declare namespace CompanyTokenTransactionCreateParams {
 
 export interface CompanyTokenTransactionListParams extends CursorPageParams {
   /**
-   * The ID of the company
+   * The unique identifier of the company to list token transactions for.
    */
   company_id: string;
 
@@ -413,18 +436,18 @@ export interface CompanyTokenTransactionListParams extends CursorPageParams {
   /**
    * The type of token transaction
    */
-  transaction_type?: BotTokenTransactionTypes | null;
+  transaction_type?: CompanyTokenTransactionType | null;
 
   /**
-   * Filter by user ID
+   * Filter transactions to only those involving this specific user.
    */
   user_id?: string | null;
 }
 
 export declare namespace CompanyTokenTransactions {
   export {
-    type BotTokenTransactionTypes as BotTokenTransactionTypes,
     type CompanyTokenTransaction as CompanyTokenTransaction,
+    type CompanyTokenTransactionType as CompanyTokenTransactionType,
     type CompanyTokenTransactionListResponse as CompanyTokenTransactionListResponse,
     type CompanyTokenTransactionListResponsesCursorPage as CompanyTokenTransactionListResponsesCursorPage,
     type CompanyTokenTransactionCreateParams as CompanyTokenTransactionCreateParams,

package/src/resources/course-chapters.ts

@@ -8,7 +8,7 @@ import { path } from '../internal/utils/path';
 
 export class CourseChapters extends APIResource {
   /**
-   * Creates a new course chapter
+   * Create a new chapter within a course to organize lessons into sections.
    *
    * Required permissions:
    *
@@ -26,7 +26,7 @@ export class CourseChapters extends APIResource {
   }
 
   /**
-   * Retrieves a course chapter by ID
+   * Retrieves the details of an existing course chapter.
    *
    * Required permissions:
    *
@@ -44,7 +44,7 @@ export class CourseChapters extends APIResource {
   }
 
   /**
-   * Updates a course chapter
+   * Update a chapter's title within a course.
    *
    * Required permissions:
    *
@@ -63,7 +63,7 @@ export class CourseChapters extends APIResource {
   }
 
   /**
-   * Lists chapters for a course
+   * Returns a paginated list of chapters within a course, ordered by position.
    *
    * Required permissions:
    *
@@ -90,7 +90,7 @@ export class CourseChapters extends APIResource {
   }
 
   /**
-   * Deletes a course chapter
+   * Permanently delete a chapter and all of its lessons from a course.
    *
    * Required permissions:
    *
@@ -111,68 +111,72 @@ export 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 namespace CourseChapter {
   /**
-   * 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;
 
     /**
-     * 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;
 }
@@ -184,26 +188,27 @@ 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/src/resources/course-lesson-interactions.ts

@@ -10,7 +10,7 @@ import { path } from '../internal/utils/path';
 
 export class CourseLessonInteractions extends APIResource {
   /**
-   * Retrieves a course lesson interaction by ID
+   * Retrieves the details of an existing course lesson interaction.
    *
    * Required permissions:
    *
@@ -22,7 +22,8 @@ export class CourseLessonInteractions extends APIResource {
   }
 
   /**
-   * Lists course lesson interactions
+   * Returns a paginated list of lesson interactions, filtered by lesson, course,
+   * user, or completion status.
    *
    * Required permissions:
    *
@@ -48,12 +49,12 @@ 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;
 
@@ -68,12 +69,12 @@ 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;
 }