@whop/sdk 0.0.25 → 0.0.27

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,17 +14,14 @@ export class AIChats extends APIResource {
    *
    * - `ai_chat:create`
    */
-  create(
-    body: AIChatCreateParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<AIChatCreateResponse> {
+  create(body: AIChatCreateParams, options?: RequestOptions): APIPromise<AIChat> {
     return this._client.post('/ai_chats', { body, ...options });
   }
 
   /**
    * Fetches a single AI chat by ID
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<AIChatRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<AIChat> {
     return this._client.get(path`/ai_chats/${id}`, options);
   }
 
@@ -39,7 +36,7 @@ export class AIChats extends APIResource {
     id: string,
     body: AIChatUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<AIChatUpdateResponse> {
+  ): APIPromise<AIChat> {
     return this._client.patch(path`/ai_chats/${id}`, { body, ...options });
   }
 
@@ -70,9 +67,9 @@ export type AIChatListResponsesCursorPage = CursorPage<AIChatListResponse>;
 /**
  * An AI chat conversation belonging to a user
  */
-export interface AIChatCreateResponse {
+export interface AIChat {
   /**
-   * The unique identifier for the AI chat
+   * The unique identifier for the ai chat.
    */
   id: string;
 
@@ -82,7 +79,7 @@ export interface AIChatCreateResponse {
   blended_token_usage: string;
 
   /**
-   * When the AI chat was created
+   * The datetime the ai chat was created.
    */
   created_at: string;
 
@@ -102,23 +99,23 @@ export interface AIChatCreateResponse {
   title: string | null;
 
   /**
-   * When the AI chat was last updated
+   * The datetime the ai chat was last updated.
    */
   updated_at: string;
 
   /**
    * The user who owns the AI chat
    */
-  user: AIChatCreateResponse.User;
+  user: AIChat.User;
 }
 
-export namespace AIChatCreateResponse {
+export namespace AIChat {
   /**
    * The user who owns the AI chat
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
   }
@@ -127,66 +124,9 @@ export namespace AIChatCreateResponse {
 /**
  * An AI chat conversation belonging to a user
  */
-export interface AIChatRetrieveResponse {
-  /**
-   * The unique identifier for the AI chat
-   */
-  id: string;
-
-  /**
-   * The total number of tokens used in the chat
-   */
-  blended_token_usage: string;
-
-  /**
-   * When the AI chat was created
-   */
-  created_at: string;
-
-  /**
-   * When the last message was sent
-   */
-  last_message_at: string | null;
-
-  /**
-   * The number of messages in the chat
-   */
-  message_count: number;
-
-  /**
-   * The title of the AI chat
-   */
-  title: string | null;
-
-  /**
-   * When the AI chat was last updated
-   */
-  updated_at: string;
-
-  /**
-   * The user who owns the AI chat
-   */
-  user: AIChatRetrieveResponse.User;
-}
-
-export namespace AIChatRetrieveResponse {
-  /**
-   * The user who owns the AI chat
-   */
-  export interface User {
-    /**
-     * The internal ID of the user.
-     */
-    id: string;
-  }
-}
-
-/**
- * An AI chat conversation belonging to a user
- */
-export interface AIChatUpdateResponse {
+export interface AIChatListResponse {
   /**
-   * The unique identifier for the AI chat
+   * The unique identifier for the ai chat.
    */
   id: string;
 
@@ -196,7 +136,7 @@ export interface AIChatUpdateResponse {
   blended_token_usage: string;
 
   /**
-   * When the AI chat was created
+   * The datetime the ai chat was created.
    */
   created_at: string;
 
@@ -216,98 +156,74 @@ export interface AIChatUpdateResponse {
   title: string | null;
 
   /**
-   * When the AI chat was last updated
+   * The datetime the ai chat was last updated.
    */
   updated_at: string;
 
   /**
    * The user who owns the AI chat
    */
-  user: AIChatUpdateResponse.User;
+  user: AIChatListResponse.User;
 }
 
-export namespace AIChatUpdateResponse {
+export namespace AIChatListResponse {
   /**
    * The user who owns the AI chat
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
   }
 }
 
 /**
- * An AI chat conversation belonging to a user
+ * Represents `true` or `false` values.
  */
-export interface AIChatListResponse {
-  /**
-   * The unique identifier for the AI chat
-   */
-  id: string;
-
-  /**
-   * The total number of tokens used in the chat
-   */
-  blended_token_usage: string;
+export type AIChatDeleteResponse = boolean;
 
+export interface AIChatCreateParams {
   /**
-   * When the AI chat was created
+   * The text content of the first message sent in the chat
    */
-  created_at: string;
+  message_text: string;
 
   /**
-   * When the last message was sent
+   * The ID of the company to set as the current company in context for the AI chat
    */
-  last_message_at: string | null;
+  current_company_id?: string | null;
 
   /**
-   * The number of messages in the chat
+   * The IDs of existing uploaded attachments to include in the first message to the
+   * agent
    */
-  message_count: number;
+  message_attachments?: Array<AIChatCreateParams.MessageAttachment> | null;
 
   /**
    * The title of the AI chat
    */
-  title: string | null;
-
-  /**
-   * When the AI chat was last updated
-   */
-  updated_at: string;
-
-  /**
-   * The user who owns the AI chat
-   */
-  user: AIChatListResponse.User;
+  title?: string | null;
 }
 
-export namespace AIChatListResponse {
+export namespace AIChatCreateParams {
   /**
-   * The user who owns the AI chat
+   * Input for an attachment
    */
-  export interface User {
+  export interface MessageAttachment {
     /**
-     * The internal ID of the user.
+     * The ID of an existing file object.
      */
     id: string;
   }
 }
 
-/**
- * Represents `true` or `false` values.
- */
-export type AIChatDeleteResponse = boolean;
-
-export interface AIChatCreateParams {
+export interface AIChatUpdateParams {
   /**
-   * The title of the AI chat
+   * The ID of the company to set as the current company in context for the AI chat
    */
-  title?: string | null;
-}
+  current_company_id?: string | null;
 
-export interface AIChatUpdateParams {
   /**
    * The new title for the AI chat
    */
@@ -333,9 +249,7 @@ export interface AIChatListParams extends CursorPageParams {
 
 export declare namespace AIChats {
   export {
-    type AIChatCreateResponse as AIChatCreateResponse,
-    type AIChatRetrieveResponse as AIChatRetrieveResponse,
-    type AIChatUpdateResponse as AIChatUpdateResponse,
+    type AIChat as AIChat,
     type AIChatListResponse as AIChatListResponse,
     type AIChatDeleteResponse as AIChatDeleteResponse,
     type AIChatListResponsesCursorPage as AIChatListResponsesCursorPage,

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

@@ -29,7 +29,7 @@ export class AuthorizedUsers extends APIResource {
    * - `member:email:read`
    */
   list(
-    query: AuthorizedUserListParams,
+    query: AuthorizedUserListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<AuthorizedUserListResponsesCursorPage, AuthorizedUserListResponse> {
     return this._client.getAPIList('/authorized_users', CursorPage<AuthorizedUserListResponse>, {
@@ -46,10 +46,15 @@ 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;
 
+  /**
+   * The company associated with the authorized user.
+   */
+  company: AuthorizedUserRetrieveResponse.Company;
+
   /**
    * The role of the authorized user in the company.
    */
@@ -62,12 +67,27 @@ export interface AuthorizedUserRetrieveResponse {
 }
 
 export namespace AuthorizedUserRetrieveResponse {
+  /**
+   * The company associated with the authorized user.
+   */
+  export interface Company {
+    /**
+     * The unique identifier for the company.
+     */
+    id: string;
+
+    /**
+     * The title of the company.
+     */
+    title: string;
+  }
+
   /**
    * The user associated with the authorized user.
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -93,10 +113,15 @@ export namespace AuthorizedUserRetrieveResponse {
  */
 export interface AuthorizedUserListResponse {
   /**
-   * A unique ID representing the authorized user object.
+   * The unique identifier for the authorized user.
    */
   id: string;
 
+  /**
+   * The company associated with the authorized user.
+   */
+  company: AuthorizedUserListResponse.Company;
+
   /**
    * The role of the authorized user in the company.
    */
@@ -109,12 +134,27 @@ export interface AuthorizedUserListResponse {
 }
 
 export namespace AuthorizedUserListResponse {
+  /**
+   * The company associated with the authorized user.
+   */
+  export interface Company {
+    /**
+     * The unique identifier for the company.
+     */
+    id: string;
+
+    /**
+     * The title of the company.
+     */
+    title: string;
+  }
+
   /**
    * The user associated with the authorized user.
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
 
@@ -137,14 +177,14 @@ export namespace AuthorizedUserListResponse {
 
 export interface AuthorizedUserListParams extends CursorPageParams {
   /**
-   * The ID of the company to list authorized users for
+   * Returns the elements in the list that come before the specified cursor.
    */
-  company_id: string;
+  before?: string | null;
 
   /**
-   * Returns the elements in the list that come before the specified cursor.
+   * The ID of the company to list authorized users for
    */
-  before?: string | null;
+  company_id?: string | null;
 
   /**
    * The minimum creation date to filter by

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;