@whop/sdk 0.0.26 → 0.0.27

package/src/resources/companies.ts

@@ -9,11 +9,12 @@ import { path } from '../internal/utils/path';
 
 export class Companies extends APIResource {
   /**
-   * Create a new connected account for your platform
+   * Create a new company. Pass parent_company_id to create a sub-company under a
+   * platform, or omit it to create a company for the current user.
    *
    * Required permissions:
    *
-   * - `company:create_child`
+   * - `company:create`
    * - `company:basic:read`
    */
   create(body: CompanyCreateParams, options?: RequestOptions): APIPromise<Shared.Company> {
@@ -49,14 +50,16 @@ export class Companies extends APIResource {
   }
 
   /**
-   * Lists companies the current user has access to
+   * Lists companies. When parent_company_id is provided, lists connected accounts
+   * under that company. When omitted, lists companies the current user has access
+   * to.
    *
    * Required permissions:
    *
    * - `company:basic:read`
    */
   list(
-    query: CompanyListParams,
+    query: CompanyListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse> {
     return this._client.getAPIList('/companies', CursorPage<CompanyListResponse>, { query, ...options });
@@ -66,11 +69,12 @@ export class Companies extends APIResource {
 export type CompanyListResponsesCursorPage = CursorPage<CompanyListResponse>;
 
 /**
- * An object representing a (sanitized) company.
+ * A company is a seller on Whop. Companies own products, manage members, and
+ * receive payouts.
  */
 export interface CompanyListResponse {
   /**
-   * The ID (tag) of the company.
+   * The unique identifier for the company.
    */
   id: string;
 
@@ -80,7 +84,7 @@ export interface CompanyListResponse {
   business_type: Shared.BusinessTypes | null;
 
   /**
-   * When the company was created (signed up)
+   * The datetime the company was created.
    */
   created_at: string;
 
@@ -136,7 +140,7 @@ export interface CompanyListResponse {
   title: string;
 
   /**
-   * The time the company was last updated.
+   * The datetime the company was last updated.
    */
   updated_at: string;
 
@@ -163,7 +167,7 @@ export namespace CompanyListResponse {
    */
   export interface OwnerUser {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -181,24 +185,25 @@ export namespace CompanyListResponse {
 
 export interface CompanyCreateParams {
   /**
-   * The email of the user who the company will belong to.
+   * The name of the company being created.
    */
-  email: string;
+  title: string;
 
   /**
-   * The company ID of the platform creating this company.
+   * The different business types a company can be.
    */
-  parent_company_id: string;
+  business_type?: Shared.BusinessTypes | null;
 
   /**
-   * The name of the company being created.
+   * A description of what the company offers or does.
    */
-  title: string;
+  description?: string | null;
 
   /**
-   * The different business types a company can be.
+   * The email of the user who the sub-company will belong to. Required when
+   * parent_company_id is provided.
    */
-  business_type?: Shared.BusinessTypes | null;
+  email?: string | null;
 
   /**
    * The different industry types a company can be in.
@@ -211,15 +216,19 @@ export interface CompanyCreateParams {
   logo?: CompanyCreateParams.Logo | null;
 
   /**
-   * Additional metadata for the account
+   * Additional metadata for the company
    */
   metadata?: { [key: string]: unknown } | null;
 
+  /**
+   * The company ID of the platform creating this sub-company. If omitted, the
+   * company is created for the current user.
+   */
+  parent_company_id?: string | null;
+
   /**
    * Whether Whop sends transactional emails to customers on behalf of this company.
-   * Includes: order confirmations, payment failures, refund notifications, upcoming
-   * renewals, and membership cancelations/expirations. When disabled, the platform
-   * is responsible for handling these communications. This is defaulted to true.
+   * Only used when parent_company_id is provided.
    */
   send_customer_emails?: boolean | null;
 }
@@ -247,6 +256,11 @@ export interface CompanyUpdateParams {
    */
   business_type?: Shared.BusinessTypes | null;
 
+  /**
+   * A description of what the company offers or does.
+   */
+  description?: string | null;
+
   /**
    * The different industry types a company can be in.
    */
@@ -294,11 +308,6 @@ export namespace CompanyUpdateParams {
 }
 
 export interface CompanyListParams extends CursorPageParams {
-  /**
-   * The ID of the parent company to list connected accounts for
-   */
-  parent_company_id: string;
-
   /**
    * Returns the elements in the list that come before the specified cursor.
    */
@@ -328,6 +337,12 @@ export interface CompanyListParams extends CursorPageParams {
    * Returns the last _n_ elements from the list.
    */
   last?: number | null;
+
+  /**
+   * The ID of the parent company to list connected accounts for. Omit to list the
+   * current user's own companies.
+   */
+  parent_company_id?: string | null;
 }
 
 export declare namespace Companies {

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

@@ -81,7 +81,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;
 
@@ -96,7 +96,7 @@ export interface CompanyTokenTransaction {
   company: CompanyTokenTransaction.Company;
 
   /**
-   * When the transaction was created
+   * The datetime the company token transaction was created.
    */
   created_at: string;
 
@@ -137,7 +137,7 @@ export namespace CompanyTokenTransaction {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -157,7 +157,7 @@ export namespace CompanyTokenTransaction {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
@@ -167,7 +167,7 @@ export namespace CompanyTokenTransaction {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -188,7 +188,7 @@ export namespace CompanyTokenTransaction {
  */
 export interface CompanyTokenTransactionListResponse {
   /**
-   * The ID of the transaction
+   * The unique identifier for the company token transaction.
    */
   id: string;
 
@@ -203,7 +203,7 @@ export interface CompanyTokenTransactionListResponse {
   company: CompanyTokenTransactionListResponse.Company;
 
   /**
-   * When the transaction was created
+   * The datetime the company token transaction was created.
    */
   created_at: string;
 
@@ -244,7 +244,7 @@ export namespace CompanyTokenTransactionListResponse {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -264,7 +264,7 @@ export namespace CompanyTokenTransactionListResponse {
    */
   export interface Member {
     /**
-     * The ID of the member
+     * The unique identifier for the company member.
      */
     id: string;
   }
@@ -274,7 +274,7 @@ export namespace CompanyTokenTransactionListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/course-chapters.ts

@@ -115,7 +115,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;
 
@@ -141,7 +141,7 @@ export namespace CourseChapter {
    */
   export interface Lesson {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
 
@@ -162,7 +162,7 @@ export namespace CourseChapter {
  */
 export interface CourseChapterListResponse {
   /**
-   * The ID of the chapter. Looks like chap_XXX
+   * The unique identifier for the chapter.
    */
   id: string;
 

package/src/resources/course-lessons.ts

@@ -178,7 +178,7 @@ export type EmbedType = 'youtube' | 'loom';
  */
 export interface Lesson {
   /**
-   * The ID of the lesson
+   * The unique identifier for the lesson.
    */
   id: string;
 
@@ -198,7 +198,7 @@ export interface Lesson {
   content: string | null;
 
   /**
-   * The timestamp of when the lesson was created
+   * The datetime the lesson was created.
    */
   created_at: string;
 
@@ -260,7 +260,7 @@ export namespace Lesson {
    */
   export interface AssessmentQuestion {
     /**
-     * The ID of the assessment question
+     * The unique identifier for the assessment question.
      */
     id: string;
 
@@ -271,7 +271,7 @@ export namespace Lesson {
     correct_answer: string | null;
 
     /**
-     * When the question was created
+     * The datetime the assessment question was created.
      */
     created_at: string;
 
@@ -333,7 +333,7 @@ export namespace Lesson {
      */
     export interface Option {
       /**
-       * The ID of the assessment question option
+       * The unique identifier for the assessment question option.
        */
       id: string;
 
@@ -423,7 +423,7 @@ export namespace Lesson {
    */
   export interface VideoAsset {
     /**
-     * The ID of the Mux asset
+     * The unique identifier for the mux asset.
      */
     id: string;
 
@@ -438,7 +438,7 @@ export namespace Lesson {
     audio_only: boolean;
 
     /**
-     * The time at which the Mux asset was created
+     * The datetime the mux asset was created.
      */
     created_at: string;
 
@@ -483,7 +483,7 @@ export 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;
   }
@@ -505,7 +505,7 @@ export type LessonVisibilities = 'visible' | 'hidden';
  */
 export interface CourseLessonListResponse {
   /**
-   * The ID of the lesson
+   * The unique identifier for the lesson.
    */
   id: string;
 
@@ -515,7 +515,7 @@ export interface CourseLessonListResponse {
   content: string | null;
 
   /**
-   * The timestamp of when the lesson was created
+   * The datetime the lesson was created.
    */
   created_at: string;
 
@@ -594,12 +594,12 @@ 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;
 
@@ -639,7 +639,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;
 
@@ -655,7 +655,7 @@ export namespace CourseLessonSubmitAssessmentResponse {
    */
   export interface Lesson {
     /**
-     * The ID of the lesson
+     * The unique identifier for the lesson.
      */
     id: string;
 
@@ -670,7 +670,7 @@ export namespace CourseLessonSubmitAssessmentResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/course-students.ts

@@ -45,7 +45,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;
 
@@ -91,7 +91,7 @@ export namespace CourseStudentRetrieveResponse {
    */
   export interface Course {
     /**
-     * The ID of the course. Looks like cors_XXX
+     * The unique identifier for the course.
      */
     id: string;
 
@@ -112,7 +112,7 @@ export namespace CourseStudentRetrieveResponse {
      */
     export interface Experience {
       /**
-       * The unique ID representing this experience
+       * The unique identifier for the experience.
        */
       id: string;
     }
@@ -123,7 +123,7 @@ export namespace CourseStudentRetrieveResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -144,7 +144,7 @@ export 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;
 
@@ -185,7 +185,7 @@ export namespace CourseStudentListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/courses.ts

@@ -115,7 +115,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;
 
@@ -136,7 +136,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;
 
@@ -178,7 +178,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;
 
@@ -195,7 +195,7 @@ export namespace Course {
    */
   export interface Chapter {
     /**
-     * The ID of the chapter. Looks like chap_XXX
+     * The unique identifier for the chapter.
      */
     id: string;
 
@@ -221,7 +221,7 @@ export namespace Course {
      */
     export interface Lesson {
       /**
-       * The ID of the lesson
+       * The unique identifier for the lesson.
        */
       id: string;
 
@@ -356,7 +356,7 @@ export type Languages =
  */
 export interface CourseListResponse {
   /**
-   * The ID of the course. Looks like cors_XXX
+   * The unique identifier for the course.
    */
   id: string;
 
@@ -372,7 +372,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;
 
@@ -414,7 +414,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;
 

package/src/resources/disputes.ts

@@ -90,11 +90,12 @@ export class Disputes extends APIResource {
 export type DisputeListResponsesCursorPage = CursorPage<DisputeListResponse>;
 
 /**
- * An object representing a dispute against a company.
+ * A dispute is a chargeback or payment challenge filed against a company,
+ * including evidence and response status.
  */
 export interface Dispute {
   /**
-   * The internal ID of the dispute.
+   * The unique identifier for the dispute.
    */
   id: string;
 
@@ -129,7 +130,7 @@ export interface Dispute {
   company: Dispute.Company | null;
 
   /**
-   * When it was made.
+   * The datetime the dispute was created.
    */
   created_at: string | null;
 
@@ -265,7 +266,7 @@ export namespace Dispute {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -306,7 +307,7 @@ export namespace Dispute {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
 
@@ -326,7 +327,7 @@ export namespace Dispute {
     card_last4: string | null;
 
     /**
-     * The datetime the payment was created
+     * The datetime the payment was created.
      */
     created_at: string;
 
@@ -387,7 +388,7 @@ export namespace Dispute {
      */
     export interface Member {
       /**
-       * The ID of the member
+       * The unique identifier for the company member.
        */
       id: string;
 
@@ -402,7 +403,7 @@ export namespace Dispute {
      */
     export interface Membership {
       /**
-       * The internal ID of the membership.
+       * The unique identifier for the membership.
        */
       id: string;
 
@@ -417,7 +418,7 @@ export namespace Dispute {
      */
     export interface User {
       /**
-       * The internal ID of the user.
+       * The unique identifier for the user.
        */
       id: string;
 
@@ -443,7 +444,7 @@ export namespace Dispute {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -453,7 +454,7 @@ export namespace Dispute {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;
 
@@ -531,11 +532,12 @@ export type DisputeStatuses =
   | 'other';
 
 /**
- * An object representing a dispute against a company.
+ * A dispute is a chargeback or payment challenge filed against a company,
+ * including evidence and response status.
  */
 export interface DisputeListResponse {
   /**
-   * The internal ID of the dispute.
+   * The unique identifier for the dispute.
    */
   id: string;
 
@@ -550,7 +552,7 @@ export interface DisputeListResponse {
   company: DisputeListResponse.Company | null;
 
   /**
-   * When it was made.
+   * The datetime the dispute was created.
    */
   created_at: string | null;
 
@@ -606,7 +608,7 @@ export namespace DisputeListResponse {
    */
   export interface Company {
     /**
-     * The ID of the company
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -621,7 +623,7 @@ export namespace DisputeListResponse {
    */
   export interface Payment {
     /**
-     * The payment ID
+     * The unique identifier for the payment.
      */
     id: string;
   }
@@ -631,7 +633,7 @@ export namespace DisputeListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
   }
@@ -641,7 +643,7 @@ export namespace DisputeListResponse {
    */
   export interface Product {
     /**
-     * The internal ID of the public product.
+     * The unique identifier for the product.
      */
     id: string;