@whop/sdk 0.0.26 → 0.0.27

package/resources/withdrawals.d.ts

@@ -59,19 +59,21 @@ export declare class Withdrawals extends APIResource {
 }
 export type WithdrawalListResponsesCursorPage = CursorPage<WithdrawalListResponse>;
 /**
- * A withdrawal request.
+ * A withdrawal represents a request to transfer funds from a company's ledger
+ * account to an external payout method.
  */
 export interface Withdrawal {
     /**
-     * Internal ID of the withdrawal request.
+     * The unique identifier for the withdrawal.
      */
     id: string;
     /**
-     * How much money was attempted to be withdrawn, in a float type.
+     * The withdrawal amount. Provided as a number in the specified currency. Eg:
+     * 100.00 for $100.00 USD.
      */
     amount: number;
     /**
-     * When the withdrawal request was created.
+     * The datetime the withdrawal was created.
      */
     created_at: string;
     /**
@@ -133,7 +135,7 @@ export declare namespace Withdrawal {
      */
     interface LedgerAccount {
         /**
-         * The ID of the LedgerAccount.
+         * The unique identifier for the ledger account.
          */
         id: string;
         /**
@@ -146,11 +148,11 @@ export declare namespace Withdrawal {
      */
     interface PayoutToken {
         /**
-         * The ID of the payout token
+         * The unique identifier for the payout token.
          */
         id: string;
         /**
-         * The date and time the payout token was created
+         * The datetime the payout token was created.
          */
         created_at: string;
         /**
@@ -182,19 +184,21 @@ export type WithdrawalSpeeds = 'standard' | 'instant';
  */
 export type WithdrawalStatus = 'requested' | 'awaiting_payment' | 'in_transit' | 'completed' | 'failed' | 'canceled' | 'denied';
 /**
- * A withdrawal request.
+ * A withdrawal represents a request to transfer funds from a company's ledger
+ * account to an external payout method.
  */
 export interface WithdrawalListResponse {
     /**
-     * Internal ID of the withdrawal request.
+     * The unique identifier for the withdrawal.
      */
     id: string;
     /**
-     * How much money was attempted to be withdrawn, in a float type.
+     * The withdrawal amount. Provided as a number in the specified currency. Eg:
+     * 100.00 for $100.00 USD.
      */
     amount: number;
     /**
-     * When the withdrawal request was created.
+     * The datetime the withdrawal was created.
      */
     created_at: string;
     /**

package/resources/withdrawals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withdrawals.d.ts","sourceRoot":"","sources":["../src/resources/withdrawals.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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;CAG1E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,UAAU,EACN,gBAAgB,GAChB,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,GAC/B,gBAAgB,GAChB,uBAAuB,GACvB,mBAAmB,GACnB,sBAAsB,GACtB,0BAA0B,GAC1B,yBAAyB,GACzB,yBAAyB,GACzB,mBAAmB,GACnB,wBAAwB,GACxB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,yBAAyB,GACzB,wBAAwB,GACxB,eAAe,GACf,sBAAsB,GACtB,mBAAmB,GACnB,+BAA+B,GAC/B,wBAAwB,GACxB,mBAAmB,GACnB,qBAAqB,GACrB,yBAAyB,GACzB,uBAAuB,GACvB,qBAAqB,GACrB,sBAAsB,GACtB,wBAAwB,GACxB,oBAAoB,GACpB,yBAAyB,GACzB,oBAAoB,GACpB,YAAY,GACZ,0BAA0B,GAC1B,sBAAsB,GACtB,yBAAyB,GACzB,oBAAoB,GACpB,0BAA0B,GAC1B,wBAAwB,GACxB,mBAAmB,GACnB,yBAAyB,GACzB,iCAAiC,GACjC,aAAa,GACb,4BAA4B,GAC5B,oBAAoB,GACpB,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,UAAU,CAAC,aAAa,CAAC;IAEzC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,yBAAyB,EAAE,MAAM,CAAC;QAElC;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,WAAW,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,SAAS,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"withdrawals.d.ts","sourceRoot":"","sources":["../src/resources/withdrawals.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,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItF;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC;IAItE;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,oBAAoB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,sBAAsB,CAAC;CAG1E;AAED,MAAM,MAAM,iCAAiC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,UAAU,EACN,gBAAgB,GAChB,wBAAwB,GACxB,6BAA6B,GAC7B,+BAA+B,GAC/B,gBAAgB,GAChB,uBAAuB,GACvB,mBAAmB,GACnB,sBAAsB,GACtB,0BAA0B,GAC1B,yBAAyB,GACzB,yBAAyB,GACzB,mBAAmB,GACnB,wBAAwB,GACxB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,yBAAyB,GACzB,wBAAwB,GACxB,eAAe,GACf,sBAAsB,GACtB,mBAAmB,GACnB,+BAA+B,GAC/B,wBAAwB,GACxB,mBAAmB,GACnB,qBAAqB,GACrB,yBAAyB,GACzB,uBAAuB,GACvB,qBAAqB,GACrB,sBAAsB,GACtB,wBAAwB,GACxB,oBAAoB,GACpB,yBAAyB,GACzB,oBAAoB,GACpB,YAAY,GACZ,0BAA0B,GAC1B,sBAAsB,GACtB,yBAAyB,GACzB,oBAAoB,GACpB,0BAA0B,GAC1B,wBAAwB,GACxB,mBAAmB,GACnB,yBAAyB,GACzB,iCAAiC,GACjC,aAAa,GACb,4BAA4B,GAC5B,oBAAoB,GACpB,IAAI,CAAC;IAET;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,cAAc,EAAE,UAAU,CAAC,aAAa,CAAC;IAEzC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;IAEzB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,WAAW;QAC1B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,yBAAyB,EAAE,MAAM,CAAC;QAElC;;;WAGG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,WAAW,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,UAAU,GAAG,SAAS,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,kBAAkB,GAClB,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,UAAU,GACV,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;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,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/src/client.ts

@@ -378,9 +378,10 @@ import {
   Transfers,
 } from './resources/transfers';
 import {
+  User,
   UserCheckAccessParams,
   UserCheckAccessResponse,
-  UserRetrieveResponse,
+  UserUpdateProfileParams,
   Users,
 } from './resources/users';
 import {
@@ -457,7 +458,7 @@ import { makeUserTokenVerifierFromSdk } from './lib/verify-user-token';
 
 export interface ClientOptions {
   /**
-   * The app API key from an app from the /dashboard/developer page
+   * A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like `Bearer ***************************`
    */
   apiKey?: string | undefined;
 
@@ -547,7 +548,6 @@ export class Whop {
   apiKey: string;
   webhookKey: string | null;
   appID: string | null;
-
   baseURL: string;
   maxRetries: number;
   timeout: number;
@@ -916,9 +916,14 @@ export class Whop {
   getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
     path: string,
     Page: new (...args: any[]) => PageClass,
-    opts?: RequestOptions,
+    opts?: PromiseOrValue<RequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
-    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
   }
 
   requestAPIList<
@@ -926,7 +931,7 @@ export class Whop {
     PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
   >(
     Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
-    options: FinalRequestOptions,
+    options: PromiseOrValue<FinalRequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
     const request = this.makeRequest(options, null, undefined);
     return new Pagination.PagePromise<PageClass, Item>(this as any as Whop, request, Page);
@@ -939,7 +944,7 @@ export class Whop {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    const abort = controller.abort.bind(controller);
+    const abort = this._makeAbort(controller);
     if (signal) signal.addEventListener('abort', abort, { once: true });
 
     const timeout = setTimeout(abort, ms);
@@ -1110,6 +1115,12 @@ export class Whop {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -1461,9 +1472,10 @@ export declare namespace Whop {
 
   export {
     Users as Users,
-    type UserRetrieveResponse as UserRetrieveResponse,
+    type User as User,
     type UserCheckAccessResponse as UserCheckAccessResponse,
     type UserCheckAccessParams as UserCheckAccessParams,
+    type UserUpdateProfileParams as UserUpdateProfileParams,
   };
 
   export {

package/src/resources/access-tokens.ts

@@ -6,19 +6,20 @@ import { RequestOptions } from '../internal/request-options';
 
 export class AccessTokens extends APIResource {
   /**
-   * Create a short-lived access token to authenticate API requests on behalf of a
-   * Company or User. This token should be used with Whop's web and mobile embedded
-   * components. You must provide either a company_id or a user_id argument, but not
-   * both.
+   * Create a short-lived access token to authenticate API requests. When using API
+   * key authentication, provide company_id or user_id. When using OAuth
+   * authentication, the user is derived from the token. This token should be used
+   * with Whop's web and mobile embedded components.
    *
    * @example
    * ```ts
-   * const accessToken = await client.accessTokens.create({
-   *   company_id: 'biz_xxxxxxxxxxxxxx',
-   * });
+   * const accessToken = await client.accessTokens.create();
    * ```
    */
-  create(body: AccessTokenCreateParams, options?: RequestOptions): APIPromise<AccessTokenCreateResponse> {
+  create(
+    body: AccessTokenCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AccessTokenCreateResponse> {
     return this._client.post('/access_tokens', { body, ...options });
   }
 }
@@ -38,57 +39,35 @@ export interface AccessTokenCreateResponse {
   expires_at: string;
 }
 
-export type AccessTokenCreateParams =
-  | AccessTokenCreateParams.CreateAccessTokenInputWithCompanyID
-  | AccessTokenCreateParams.CreateAccessTokenInputWithUserID;
-
-export declare namespace AccessTokenCreateParams {
-  export interface CreateAccessTokenInputWithCompanyID {
-    /**
-     * The ID of the Company to generate the token for. The API key must have
-     * permission to access this Company, such as the being the company the API key
-     * belongs to or a sub-merchant of it
-     */
-    company_id: string;
-
-    /**
-     * The expiration timestamp for the access token. If not provided, a default
-     * expiration time of 1 hour will be used. The expiration can be set to a maximum
-     * of 3 hours from the current time.
-     */
-    expires_at?: string | null;
-
-    /**
-     * Array of desired scoped actions for the access token. If sent as an empty array
-     * or not provided, all permissions from the API key making the request will be
-     * available on the token. If sending an explicit list, they must be a subset of
-     * the API keys's existing permissions. Otherwise, an error will be raised.
-     */
-    scoped_actions?: Array<string> | null;
-  }
+export interface AccessTokenCreateParams {
+  /**
+   * The ID of the Company to generate the token for. The API key must have
+   * permission to access this Company, such as the being the company the API key
+   * belongs to or a sub-merchant of it
+   */
+  company_id?: string | null;
 
-  export interface CreateAccessTokenInputWithUserID {
-    /**
-     * The ID of the User to generate the token for. The API key must have permission
-     * to access this User.
-     */
-    user_id: string;
+  /**
+   * The expiration timestamp for the access token. If not provided, a default
+   * expiration time of 1 hour will be used. The expiration can be set to a maximum
+   * of 3 hours from the current time.
+   */
+  expires_at?: string | null;
 
-    /**
-     * The expiration timestamp for the access token. If not provided, a default
-     * expiration time of 1 hour will be used. The expiration can be set to a maximum
-     * of 3 hours from the current time.
-     */
-    expires_at?: string | null;
+  /**
+   * Array of desired scoped actions for the access token. If sent as an empty array
+   * or not provided, all permissions from the authenticating credential (API key or
+   * OAuth token) will be available on the token. If sending an explicit list, they
+   * must be a subset of the credential's existing permissions. Otherwise, an error
+   * will be raised.
+   */
+  scoped_actions?: Array<string> | null;
 
-    /**
-     * Array of desired scoped actions for the access token. If sent as an empty array
-     * or not provided, all permissions from the API key making the request will be
-     * available on the token. If sending an explicit list, they must be a subset of
-     * the API keys's existing permissions. Otherwise, an error will be raised.
-     */
-    scoped_actions?: Array<string> | null;
-  }
+  /**
+   * The ID of the User to generate the token for. The API key must have permission
+   * to access this User.
+   */
+  user_id?: string | null;
 }
 
 export declare namespace AccessTokens {

package/src/resources/ai-chats.ts

@@ -14,7 +14,7 @@ export class AIChats extends APIResource {
    *
    * - `ai_chat:create`
    */
-  create(body: AIChatCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<AIChat> {
+  create(body: AIChatCreateParams, options?: RequestOptions): APIPromise<AIChat> {
     return this._client.post('/ai_chats', { body, ...options });
   }
 
@@ -69,7 +69,7 @@ export type AIChatListResponsesCursorPage = CursorPage<AIChatListResponse>;
  */
 export interface AIChat {
   /**
-   * The unique identifier for the AI chat
+   * The unique identifier for the ai chat.
    */
   id: string;
 
@@ -79,7 +79,7 @@ export interface AIChat {
   blended_token_usage: string;
 
   /**
-   * When the AI chat was created
+   * The datetime the ai chat was created.
    */
   created_at: string;
 
@@ -99,7 +99,7 @@ export interface AIChat {
   title: string | null;
 
   /**
-   * When the AI chat was last updated
+   * The datetime the ai chat was last updated.
    */
   updated_at: string;
 
@@ -115,7 +115,7 @@ export namespace AIChat {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
   }
@@ -126,7 +126,7 @@ export namespace AIChat {
  */
 export interface AIChatListResponse {
   /**
-   * The unique identifier for the AI chat
+   * The unique identifier for the ai chat.
    */
   id: string;
 
@@ -136,7 +136,7 @@ export interface AIChatListResponse {
   blended_token_usage: string;
 
   /**
-   * When the AI chat was created
+   * The datetime the ai chat was created.
    */
   created_at: string;
 
@@ -156,7 +156,7 @@ export interface AIChatListResponse {
   title: string | null;
 
   /**
-   * When the AI chat was last updated
+   * The datetime the ai chat was last updated.
    */
   updated_at: string;
 
@@ -172,7 +172,7 @@ export namespace AIChatListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
   }
@@ -184,13 +184,46 @@ export namespace AIChatListResponse {
 export type AIChatDeleteResponse = boolean;
 
 export interface AIChatCreateParams {
+  /**
+   * The text content of the first message sent in the chat
+   */
+  message_text: string;
+
+  /**
+   * The ID of the company to set as the current company in context for the AI chat
+   */
+  current_company_id?: string | null;
+
+  /**
+   * The IDs of existing uploaded attachments to include in the first message to the
+   * agent
+   */
+  message_attachments?: Array<AIChatCreateParams.MessageAttachment> | null;
+
   /**
    * The title of the AI chat
    */
   title?: string | null;
 }
 
+export namespace AIChatCreateParams {
+  /**
+   * Input for an attachment
+   */
+  export interface MessageAttachment {
+    /**
+     * The ID of an existing file object.
+     */
+    id: string;
+  }
+}
+
 export interface AIChatUpdateParams {
+  /**
+   * The ID of the company to set as the current company in context for the AI chat
+   */
+  current_company_id?: string | null;
+
   /**
    * The new title for the AI chat
    */

package/src/resources/app-builds.ts

@@ -96,7 +96,7 @@ export type AppBuildListResponsesCursorPage = CursorPage<AppBuildListResponse>;
  */
 export interface AppBuildListResponse {
   /**
-   * The ID of the app build. It will look like apbu_xxxxx.
+   * The unique identifier for the app build.
    */
   id: string;
 
@@ -107,7 +107,7 @@ export interface AppBuildListResponse {
   checksum: string;
 
   /**
-   * When this app build was created.
+   * The datetime the app build was created.
    */
   created_at: string;
 

package/src/resources/apps.ts

@@ -94,11 +94,12 @@ export type AppListResponsesCursorPage = CursorPage<AppListResponse>;
 export type AppType = 'b2b_app' | 'b2c_app' | 'company_app' | 'component';
 
 /**
- * An object representing an app
+ * An app is an integration built on Whop. Apps can serve consumers as experiences
+ * within products, or serve companies as business tools.
  */
 export interface AppListResponse {
   /**
-   * The ID of the app
+   * The unique identifier for the app.
    */
   id: string;
 
@@ -185,7 +186,7 @@ export namespace AppListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -200,7 +201,7 @@ export namespace AppListResponse {
    */
   export interface Creator {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/authorized-users.ts

@@ -46,7 +46,7 @@ export type AuthorizedUserListResponsesCursorPage = CursorPage<AuthorizedUserLis
  */
 export interface AuthorizedUserRetrieveResponse {
   /**
-   * A unique ID representing the authorized user object.
+   * The unique identifier for the authorized user.
    */
   id: string;
 
@@ -72,7 +72,7 @@ export namespace AuthorizedUserRetrieveResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -87,7 +87,7 @@ export namespace AuthorizedUserRetrieveResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -113,7 +113,7 @@ export namespace AuthorizedUserRetrieveResponse {
  */
 export interface AuthorizedUserListResponse {
   /**
-   * A unique ID representing the authorized user object.
+   * The unique identifier for the authorized user.
    */
   id: string;
 
@@ -139,7 +139,7 @@ export namespace AuthorizedUserListResponse {
    */
   export interface Company {
     /**
-     * The ID (tag) of the company.
+     * The unique identifier for the company.
      */
     id: string;
 
@@ -154,7 +154,7 @@ export namespace AuthorizedUserListResponse {
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 

package/src/resources/chat-channels.ts

@@ -127,7 +127,7 @@ export namespace ChatChannelListResponse {
    */
   export interface Experience {
     /**
-     * The unique ID representing this experience
+     * The unique identifier for the experience.
      */
     id: string;
 

package/src/resources/checkout-configurations.ts

@@ -73,14 +73,13 @@ export type CheckoutConfigurationListResponsesCursorPage = CursorPage<CheckoutCo
 export type CheckoutModes = 'payment' | 'setup';
 
 /**
- * A checkout configuration object.
- *         Can be used to create a reusable custom configuration for a checkout, including attaching plans, affiliates and custom metadata to the checkout.
- *         This configuration can be re-used by multiple users.
- *         All successful payments and memberships resulting from a checkout will contain the passed metadata.
+ * A checkout session is a reusable configuration for a checkout, including the
+ * plan, affiliate, and custom metadata. Payments and memberships created from a
+ * checkout session inherit its metadata.
  */
 export interface CheckoutConfigurationListResponse {
   /**
-   * The ID of the checkout configuration
+   * The unique identifier for the checkout session.
    */
   id: string;
 
@@ -167,12 +166,12 @@ export namespace CheckoutConfigurationListResponse {
    */
   export interface Plan {
     /**
-     * The internal ID of the plan.
+     * The unique identifier for the plan.
      */
     id: string;
 
     /**
-     * The interval at which the plan charges (renewal plans).
+     * The interval in days at which the plan charges (renewal plans).
      */
     billing_period: number | null;
 
@@ -182,12 +181,15 @@ export namespace CheckoutConfigurationListResponse {
     currency: Shared.Currency;
 
     /**
-     * The interval at which the plan charges (expiration plans).
+     * The number of days until the membership expires (for expiration-based plans).
+     * For example, 365 for a one-year access pass.
      */
     expiration_days: number | null;
 
     /**
-     * The price a person has to pay for a plan on the initial purchase.
+     * The initial purchase price in the plan's base_currency (e.g., 49.99 for $49.99).
+     * For one-time plans, this is the full price. For renewal plans, this is charged
+     * on top of the first renewal_price.
      */
     initial_price: number;
 
@@ -202,7 +204,8 @@ export namespace CheckoutConfigurationListResponse {
     release_method: Shared.ReleaseMethod;
 
     /**
-     * The price a person has to pay for a plan on the renewal purchase.
+     * The recurring price charged every billing_period in the plan's base_currency
+     * (e.g., 9.99 for $9.99/period). Zero for one-time plans.
      */
     renewal_price: number;
 
@@ -282,13 +285,15 @@ export declare namespace CheckoutConfigurationCreateParams {
 
       /**
        * The application fee amount collected by the platform from this connected
-       * account. Must be less than the total payment amount. Only valid for connected
-       * accounts with a parent company.
+       * account. Provided as a number in dollars (e.g., 5.00 for $5.00). Must be less
+       * than the total payment amount. Only valid for connected accounts with a parent
+       * company.
        */
       application_fee_amount?: number | null;
 
       /**
-       * The interval at which the plan charges (renewal plans).
+       * The interval in days at which the plan charges (renewal plans). For example, 30
+       * for monthly billing.
        */
       billing_period?: number | null;
 
@@ -303,7 +308,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       description?: string | null;
 
       /**
-       * The interval at which the plan charges (expiration plans).
+       * The number of days until the membership expires (for expiration-based plans).
+       * For example, 365 for a one-year access pass.
        */
       expiration_days?: number | null;
 
@@ -319,7 +325,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       image?: Plan.Image | null;
 
       /**
-       * An additional amount charged upon first purchase.
+       * An additional amount charged upon first purchase. Provided as a number in
+       * dollars (e.g., 10.00 for $10.00).
        */
       initial_price?: number | null;
 
@@ -362,7 +369,8 @@ export declare namespace CheckoutConfigurationCreateParams {
       release_method?: Shared.ReleaseMethod | null;
 
       /**
-       * The amount the customer is charged every billing period.
+       * The amount the customer is charged every billing period. Provided as a number in
+       * dollars (e.g., 9.99 for $9.99/period).
        */
       renewal_price?: number | null;