@whop/sdk 0.0.26 → 0.0.28

package/resources/companies.d.ts

@@ -1,20 +1,22 @@
 import { APIResource } from "../core/resource.js";
+import * as ProductsAPI from "./products.js";
 import * as Shared from "./shared.js";
 import { APIPromise } from "../core/api-promise.js";
 import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
 import { RequestOptions } from "../internal/request-options.js";
 export declare 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>;
     /**
-     * Retrieves an company by ID or its url route
+     * Retrieves the details of an existing company.
      *
      * Required permissions:
      *
@@ -22,8 +24,7 @@ export declare class Companies extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Company>;
     /**
-     * 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:
      *
@@ -32,21 +33,24 @@ export declare class Companies extends APIResource {
      */
     update(id: string, body?: CompanyUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.Company>;
     /**
-     * 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, options?: RequestOptions): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse>;
+    list(query?: CompanyListParams | null | undefined, options?: RequestOptions): PagePromise<CompanyListResponsesCursorPage, CompanyListResponse>;
 }
 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;
     /**
@@ -54,11 +58,12 @@ 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;
     /**
@@ -70,42 +75,45 @@ 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;
 }
@@ -115,71 +123,81 @@ export declare namespace CompanyListResponse {
      */
     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.
      */
     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;
     }
 }
 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.
      */
     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 declare namespace CompanyCreateParams {
     /**
-     * The logo for the company in png, jpeg, or gif format
+     * The company's logo image. Accepts PNG, JPEG, or GIF format.
      */
     interface Logo {
         /**
@@ -190,36 +208,48 @@ export declare 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;
     /**
      * The different business types a company can be.
      */
     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 declare namespace CompanyUpdateParams {
     /**
-     * The banner image for the company in png or jpeg format
+     * The company's banner image. Accepts PNG or JPEG format.
      */
     interface BannerImage {
         /**
@@ -228,7 +258,7 @@ export declare namespace CompanyUpdateParams {
         id: string;
     }
     /**
-     * The logo for the company in png, jpeg, or gif format
+     * The company's logo image. Accepts PNG, JPEG, or GIF format.
      */
     interface Logo {
         /**
@@ -238,20 +268,16 @@ export declare 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;
     /**
@@ -266,6 +292,12 @@ 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 {
     export { type CompanyListResponse as CompanyListResponse, type CompanyListResponsesCursorPage as CompanyListResponsesCursorPage, type CompanyCreateParams as CompanyCreateParams, type CompanyUpdateParams as CompanyUpdateParams, type CompanyListParams as CompanyListParams, };

package/resources/companies.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;OAMG;IACH,IAAI,CACF,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;CAGpE;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAE1C;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;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,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvF;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI1E;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC;IAI7B;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,8BAA8B,EAAE,mBAAmB,CAAC;CAGpE;AAED,MAAM,MAAM,8BAA8B,GAAG,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,UAAU,EAAE,mBAAmB,CAAC,SAAS,CAAC;IAE1C;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC,WAAW,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/companies.js

@@ -7,18 +7,19 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class Companies extends resource_1.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, options) {
         return this._client.post('/companies', { body, ...options });
     }
     /**
-     * Retrieves an company by ID or its url route
+     * Retrieves the details of an existing company.
      *
      * Required permissions:
      *
@@ -28,8 +29,7 @@ class Companies extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/companies/${id}`, options);
     }
     /**
-     * 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:
      *
@@ -40,13 +40,15 @@ class Companies extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/companies/${id}`, { body, ...options });
     }
     /**
-     * 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, options) {
+    list(query = {}, options) {
         return this._client.getAPIList('/companies', (pagination_1.CursorPage), { query, ...options });
     }
 }

package/resources/companies.js.map

@@ -1 +1 @@
-{"version":3,"file":"companies.js","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,uBAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAtDD,8BAsDC"}
+{"version":3,"file":"companies.js","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,uBAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAxDD,8BAwDC"}

package/resources/companies.mjs

@@ -4,18 +4,19 @@ import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
 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, options) {
         return this._client.post('/companies', { body, ...options });
     }
     /**
-     * Retrieves an company by ID or its url route
+     * Retrieves the details of an existing company.
      *
      * Required permissions:
      *
@@ -25,8 +26,7 @@ export class Companies extends APIResource {
         return this._client.get(path `/companies/${id}`, options);
     }
     /**
-     * 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:
      *
@@ -37,13 +37,15 @@ export class Companies extends APIResource {
         return this._client.patch(path `/companies/${id}`, { body, ...options });
     }
     /**
-     * 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, options) {
+    list(query = {}, options) {
         return this._client.getAPIList('/companies', (CursorPage), { query, ...options });
     }
 }

package/resources/companies.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"companies.mjs","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,KAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,UAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}
+{"version":3,"file":"companies.mjs","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,cAAc,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,UAA+B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}