@whop/sdk 0.0.26 → 0.0.28

package/src/resources/companies.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
+import * as ProductsAPI from './products';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
@@ -9,11 +10,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 connected account 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> {
@@ -21,7 +23,7 @@ export class Companies extends APIResource {
   }
 
   /**
-   * Retrieves an company by ID or its url route
+   * Retrieves the details of an existing company.
    *
    * Required permissions:
    *
@@ -32,8 +34,7 @@ export class Companies extends APIResource {
   }
 
   /**
-   * Update an existing company. Either a regular company, platform company, or one
-   * of a platform's connected accounts
+   * Update a company's title, description, logo, and other settings.
    *
    * Required permissions:
    *
@@ -49,14 +50,16 @@ export class Companies extends APIResource {
   }
 
   /**
-   * Lists companies the current user has access to
+   * Returns a paginated list of companies. When parent_company_id is provided, lists
+   * connected accounts under that platform. 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,12 +84,13 @@ export interface CompanyListResponse {
   business_type: Shared.BusinessTypes | null;
 
   /**
-   * When the company was created (signed up)
+   * The datetime the company was created.
    */
   created_at: string;
 
   /**
-   * The creator pitch for the company.
+   * A promotional pitch written by the company creator, displayed to potential
+   * customers on the store page.
    */
   description: string | null;
 
@@ -100,48 +105,51 @@ export interface CompanyListResponse {
   logo: CompanyListResponse.Logo | null;
 
   /**
-   * The number of members in the company.
+   * The total number of users who currently hold active memberships across all of
+   * this company's products.
    */
   member_count: number;
 
   /**
-   * A key-value store of data for the account, created/updated by the platform that
-   * made the account.
+   * A key-value JSON object of custom metadata for this company, managed by the
+   * platform that created the account.
    */
   metadata: { [key: string]: unknown } | null;
 
   /**
-   * The user who owns this company
+   * The user who owns and has full administrative control over this company.
    */
   owner_user: CompanyListResponse.OwnerUser;
 
   /**
-   * The number of reviews that have been published for the company.
+   * The total number of published customer reviews across all products for this
+   * company.
    */
   published_reviews_count: number;
 
   /**
-   * The slug/route of the company on the Whop site.
+   * The URL slug for the company's store page (e.g., 'pickaxe' in whop.com/pickaxe).
    */
   route: string;
 
   /**
-   * Whether Whop sends transactional emails to customers on behalf of this company.
+   * Whether Whop sends transactional emails (receipts, updates) to customers on
+   * behalf of this company.
    */
   send_customer_emails: boolean;
 
   /**
-   * The title of the company.
+   * The display name of the company shown to customers.
    */
   title: string;
 
   /**
-   * The time the company was last updated.
+   * The datetime the company was last updated.
    */
   updated_at: string;
 
   /**
-   * If the company is Whop Verified
+   * Whether this company has been verified by Whop's trust and safety team.
    */
   verified: boolean;
 }
@@ -152,28 +160,28 @@ export namespace CompanyListResponse {
    */
   export interface Logo {
     /**
-     * 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 user who owns this company
+   * The user who owns and has full administrative control over this company.
    */
   export interface OwnerUser {
     /**
-     * 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;
   }
@@ -181,24 +189,31 @@ export namespace CompanyListResponse {
 
 export interface CompanyCreateParams {
   /**
-   * The email of the user who the company will belong to.
+   * The display name of the company shown to customers.
    */
-  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 promotional pitch displayed to potential customers on the company's store
+   * page.
    */
-  title: string;
+  description?: string | null;
 
   /**
-   * The different business types a company can be.
+   * The email address of the user who will own the connected account. Required when
+   * parent_company_id is provided.
    */
-  business_type?: Shared.BusinessTypes | null;
+  email?: string | null;
+
+  /**
+   * The different industry groups a company can be in.
+   */
+  industry_group?: ProductsAPI.IndustryGroups | null;
 
   /**
    * The different industry types a company can be in.
@@ -206,27 +221,32 @@ export interface CompanyCreateParams {
   industry_type?: Shared.IndustryTypes | null;
 
   /**
-   * The logo for the company in png, jpeg, or gif format
+   * The company's logo image. Accepts PNG, JPEG, or GIF format.
    */
   logo?: CompanyCreateParams.Logo | null;
 
   /**
-   * Additional metadata for the account
+   * A key-value JSON object of custom metadata to store on the company.
    */
   metadata?: { [key: string]: unknown } | null;
 
+  /**
+   * The unique identifier of the parent platform company. When provided, creates a
+   * connected account under that platform. Omit to create a company 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 applies when creating a connected account.
    */
   send_customer_emails?: boolean | null;
 }
 
 export namespace CompanyCreateParams {
   /**
-   * The logo for the company in png, jpeg, or gif format
+   * The company's logo image. Accepts PNG, JPEG, or GIF format.
    */
   export interface Logo {
     /**
@@ -238,7 +258,7 @@ export namespace CompanyCreateParams {
 
 export interface CompanyUpdateParams {
   /**
-   * The banner image for the company in png or jpeg format
+   * The company's banner image. Accepts PNG or JPEG format.
    */
   banner_image?: CompanyUpdateParams.BannerImage | null;
 
@@ -247,33 +267,48 @@ export interface CompanyUpdateParams {
    */
   business_type?: Shared.BusinessTypes | null;
 
+  /**
+   * A promotional pitch displayed to potential customers on the company's store
+   * page.
+   */
+  description?: string | null;
+
+  /**
+   * The different industry groups a company can be in.
+   */
+  industry_group?: ProductsAPI.IndustryGroups | null;
+
   /**
    * The different industry types a company can be in.
    */
   industry_type?: Shared.IndustryTypes | null;
 
   /**
-   * The logo for the company in png, jpeg, or gif format
+   * The company's logo image. Accepts PNG, JPEG, or GIF format.
    */
   logo?: CompanyUpdateParams.Logo | 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.
+   * Whether Whop sends transactional emails (receipts, renewals, cancelations) to
+   * customers on behalf of this company.
    */
   send_customer_emails?: boolean | null;
 
   /**
-   * The title of the company
+   * The target audience for this company (e.g., 'beginner day traders aged 18-25
+   * looking to learn options').
+   */
+  target_audience?: string | null;
+
+  /**
+   * The display name of the company shown to customers.
    */
   title?: string | null;
 }
 
 export namespace CompanyUpdateParams {
   /**
-   * The banner image for the company in png or jpeg format
+   * The company's banner image. Accepts PNG or JPEG format.
    */
   export interface BannerImage {
     /**
@@ -283,7 +318,7 @@ export namespace CompanyUpdateParams {
   }
 
   /**
-   * The logo for the company in png, jpeg, or gif format
+   * The company's logo image. Accepts PNG, JPEG, or GIF format.
    */
   export interface Logo {
     /**
@@ -294,23 +329,18 @@ 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.
    */
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return companies created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return companies created before this timestamp.
    */
   created_before?: string | null;
 
@@ -328,6 +358,13 @@ export interface CompanyListParams extends CursorPageParams {
    * Returns the last _n_ elements from the list.
    */
   last?: number | null;
+
+  /**
+   * The unique identifier of the parent platform company. When provided, lists
+   * connected accounts under that platform. Omit to list the current user's own
+   * companies.
+   */
+  parent_company_id?: string | null;
 }
 
 export declare namespace Companies {