@whop/sdk 0.0.26 → 0.0.28

package/src/resources/account-links.ts

@@ -6,9 +6,8 @@ import { RequestOptions } from '../internal/request-options';
 
 export class AccountLinks extends APIResource {
   /**
-   * Generates a url that a user can be directed to in order to access their
-   * sub-merchant account. For example, they can visit the hosted payouts portal or
-   * the hosted KYC onboarding flow.
+   * Generate a URL that directs a sub-merchant to their account portal, such as the
+   * hosted payouts dashboard or the KYC onboarding flow.
    *
    * @example
    * ```ts
@@ -26,41 +25,44 @@ export class AccountLinks extends APIResource {
 }
 
 /**
- * An object representing a url that a user can be directed to to access their
- * account.
+ * A temporary, time-limited URL that grants a user access to an external account
+ * management page.
  */
 export interface AccountLinkCreateResponse {
   /**
-   * The expiration timestamp of the url.
+   * The timestamp after which this account link URL is no longer valid.
    */
   expires_at: string;
 
   /**
-   * The URL to navigate the user to.
+   * The temporary URL to redirect the user to for account access. Expires at the
+   * time specified by expires_at.
    */
   url: string;
 }
 
 export interface AccountLinkCreateParams {
   /**
-   * The ID of the Company to generate the url for. The company must be a
-   * sub-merchant of the API key's company.
+   * The unique identifier of the company to generate the link for, starting with
+   * 'biz\_'. Must be a sub-merchant of the API key's company.
    */
   company_id: string;
 
   /**
-   * The URL to redirect to if the session expires and needs to be re-authenticated
-   * due to the token expiring.
+   * The URL to redirect the user to if the session expires and needs to be
+   * re-authenticated, such as 'https://example.com/refresh'.
    */
   refresh_url: string;
 
   /**
-   * The URL to redirect to when the customer wants to return to your site.
+   * The URL to redirect the user to when they want to return to your site, such as
+   * 'https://example.com/return'.
    */
   return_url: string;
 
   /**
-   * The use case for which the link will be used.
+   * The purpose of the account link, such as hosted payouts portal or hosted KYC
+   * onboarding.
    */
   use_case: 'account_onboarding' | 'payouts_portal';
 }

package/src/resources/ai-chats.ts

@@ -8,25 +8,25 @@ import { path } from '../internal/utils/path';
 
 export class AIChats extends APIResource {
   /**
-   * Creates a new AI chat
+   * Create a new AI chat thread and send the first message to the AI agent.
    *
    * Required permissions:
    *
    * - `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 });
   }
 
   /**
-   * Fetches a single AI chat by ID
+   * Retrieves the details of an existing AI chat.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<AIChat> {
     return this._client.get(path`/ai_chats/${id}`, options);
   }
 
   /**
-   * Updates an AI chat
+   * Update an AI chat's title or associated company context.
    *
    * Required permissions:
    *
@@ -41,7 +41,7 @@ export class AIChats extends APIResource {
   }
 
   /**
-   * Fetches all AI chats for the current user
+   * Returns a paginated list of AI chat threads for the current authenticated user.
    */
   list(
     query: AIChatListParams | null | undefined = {},
@@ -51,7 +51,7 @@ export class AIChats extends APIResource {
   }
 
   /**
-   * Deletes an AI chat
+   * Delete an AI chat thread so it no longer appears in the user's chat list.
    *
    * Required permissions:
    *
@@ -65,114 +65,120 @@ export class AIChats extends APIResource {
 export type AIChatListResponsesCursorPage = CursorPage<AIChatListResponse>;
 
 /**
- * An AI chat conversation belonging to a user
+ * An AI-powered chat conversation belonging to a user, with optional scheduled
+ * automation.
  */
 export interface AIChat {
   /**
-   * The unique identifier for the AI chat
+   * The unique identifier for the ai chat.
    */
   id: string;
 
   /**
-   * The total number of tokens used in the chat
+   * The total number of tokens consumed across all messages in this conversation.
    */
   blended_token_usage: string;
 
   /**
-   * When the AI chat was created
+   * The datetime the ai chat was created.
    */
   created_at: string;
 
   /**
-   * When the last message was sent
+   * The timestamp of the most recent message in this conversation. Null if no
+   * messages have been sent yet.
    */
   last_message_at: string | null;
 
   /**
-   * The number of messages in the chat
+   * The total number of messages exchanged in this conversation.
    */
   message_count: number;
 
   /**
-   * The title of the AI chat
+   * A short descriptive title for this AI chat conversation. Null if no title has
+   * been set.
    */
   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
+   * The user who owns this AI chat conversation.
    */
   user: AIChat.User;
 }
 
 export namespace AIChat {
   /**
-   * The user who owns the AI chat
+   * The user who owns this AI chat conversation.
    */
   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
+ * An AI-powered chat conversation belonging to a user, with optional scheduled
+ * automation.
  */
 export interface AIChatListResponse {
   /**
-   * The unique identifier for the AI chat
+   * The unique identifier for the ai chat.
    */
   id: string;
 
   /**
-   * The total number of tokens used in the chat
+   * The total number of tokens consumed across all messages in this conversation.
    */
   blended_token_usage: string;
 
   /**
-   * When the AI chat was created
+   * The datetime the ai chat was created.
    */
   created_at: string;
 
   /**
-   * When the last message was sent
+   * The timestamp of the most recent message in this conversation. Null if no
+   * messages have been sent yet.
    */
   last_message_at: string | null;
 
   /**
-   * The number of messages in the chat
+   * The total number of messages exchanged in this conversation.
    */
   message_count: number;
 
   /**
-   * The title of the AI chat
+   * A short descriptive title for this AI chat conversation. Null if no title has
+   * been set.
    */
   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
+   * The user who owns this AI chat conversation.
    */
   user: AIChatListResponse.User;
 }
 
 export namespace AIChatListResponse {
   /**
-   * The user who owns the AI chat
+   * The user who owns this AI chat conversation.
    */
   export interface User {
     /**
-     * The internal ID of the user.
+     * The unique identifier for the user.
      */
     id: string;
   }
@@ -185,14 +191,54 @@ export type AIChatDeleteResponse = boolean;
 
 export interface AIChatCreateParams {
   /**
-   * The title of the AI chat
+   * The text content of the first message to send to the AI agent.
+   */
+  message_text: string;
+
+  /**
+   * The unique identifier of the company to set as context for the AI chat (e.g.,
+   * "biz_XXXXX").
+   */
+  current_company_id?: string | null;
+
+  /**
+   * A list of previously uploaded file attachments to include with the first
+   * message.
+   */
+  message_attachments?: Array<AIChatCreateParams.MessageAttachment> | null;
+
+  /**
+   * The source of an AI chat message
+   */
+  message_source?: 'manual' | 'suggestion' | 'link' | null;
+
+  /**
+   * An optional display title for the AI chat thread (e.g., "Help with billing").
    */
   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 new title for the AI chat
+   * The unique identifier of the company to set as context for the AI chat (e.g.,
+   * "biz_XXXXX").
+   */
+  current_company_id?: string | null;
+
+  /**
+   * The new display title for the AI chat thread (e.g., "Help with billing").
    */
   title?: string | null;
 }

package/src/resources/app-builds.ts

@@ -9,7 +9,8 @@ import { path } from '../internal/utils/path';
 
 export class AppBuilds extends APIResource {
   /**
-   * Creates a new app build
+   * Upload a new build artifact for an app. The build must include a compiled code
+   * bundle for the specified platform.
    *
    * Required permissions:
    *
@@ -29,7 +30,7 @@ export class AppBuilds extends APIResource {
   }
 
   /**
-   * Retrieves an app build by ID
+   * Retrieves the details of an existing app build.
    *
    * Required permissions:
    *
@@ -47,7 +48,8 @@ export class AppBuilds extends APIResource {
   }
 
   /**
-   * Lists app builds for an app
+   * Returns a paginated list of build artifacts for a given app, with optional
+   * filtering by platform, status, and creation date.
    *
    * Required permissions:
    *
@@ -71,7 +73,8 @@ export class AppBuilds extends APIResource {
   }
 
   /**
-   * Promotes an app build to production
+   * Promote an approved or draft app build to production so it becomes the active
+   * version served to users.
    *
    * Required permissions:
    *
@@ -92,101 +95,100 @@ export class AppBuilds extends APIResource {
 export type AppBuildListResponsesCursorPage = CursorPage<AppBuildListResponse>;
 
 /**
- * An App Build object representing a build of an application
+ * A versioned build artifact for a Whop React Native App, submitted for review and
+ * deployment to a specific platform.
  */
 export interface AppBuildListResponse {
   /**
-   * The ID of the app build. It will look like apbu_xxxxx.
+   * The unique identifier for the app build.
    */
   id: string;
 
   /**
-   * This is generated by the client and used to verify the integrity of the file
-   * that is submitted. It is a SHA256 hash of the app build file.
+   * A SHA-256 hash of the uploaded build file, generated by the client and used to
+   * verify file integrity.
    */
   checksum: string;
 
   /**
-   * When this app build was created.
+   * The datetime the app build was created.
    */
   created_at: string;
 
   /**
-   * The URL to download the app build .zip file.
+   * A URL to download the app build as a .zip archive.
    */
   file_url: string;
 
   /**
-   * Whether this app build is currently being used in production.
+   * Whether this build is the currently active production build for its platform.
    */
   is_production: boolean;
 
   /**
-   * The platform of the app build (ios, android, web)
+   * The target platform for this build.
    */
   platform: Shared.AppBuildPlatforms;
 
   /**
-   * The review message for the app build, if any. This is populated when the build
-   * is rejected and there is a reason specified by the reviewer.
+   * Feedback from the reviewer explaining why the build was rejected. Null if the
+   * build has not been reviewed or was approved.
    */
   review_message: string | null;
 
   /**
-   * The status of the app build (draft, approved, rejected, pending, etc)
+   * The current review status of this build.
    */
   status: Shared.AppBuildStatuses;
 
   /**
-   * The supported app view types for the app build. These are the views that the
-   * developer has specified that this build supports.
+   * The list of view types this build supports, as declared by the developer.
    */
   supported_app_view_types: Array<Shared.AppViewType>;
 }
 
 export interface AppBuildCreateParams {
   /**
-   * Attachment input for the app build file. This should be an upload in .zip
-   * format. The zip should contain at least one main_js_bundle.hbc file and
-   * optionally an assets folder next to it.
+   * The build file to upload. For iOS and Android, this should be a .zip archive
+   * containing a main_js_bundle.hbc file and an optional assets folder. For web,
+   * this should be a JavaScript file.
    */
   attachment: AppBuildCreateParams.Attachment;
 
   /**
-   * Checksum of the app build file. This is generated by the client and used to
-   * verify the integrity of the file that is submitted when un-packaged later on a
-   * device.
+   * A client-generated checksum of the build file, used to verify file integrity
+   * when unpacked on a device.
    */
   checksum: string;
 
   /**
-   * The platform of the app build (ios, android, web)
+   * The target platform for the build. Accepted values: ios, android, web.
    */
   platform: Shared.AppBuildPlatforms;
 
   /**
-   * The id of the ai prompt that created this build
+   * The identifier of the AI prompt that generated this build, if applicable.
    */
   ai_prompt_id?: string | null;
 
   /**
-   * The ID of the app to create a build for. By default the current app from the api
-   * key is used.
+   * The unique identifier of the app to create the build for. Defaults to the app
+   * associated with the current API key.
    */
   app_id?: string | null;
 
   /**
-   * Supported app view types for the app build. A build can specify multiple view
-   * types, but should only specify ones that its code supports.
+   * The view types this build supports. A build can support multiple view types but
+   * should only list the ones its code implements.
    */
   supported_app_view_types?: Array<Shared.AppViewType> | null;
 }
 
 export namespace AppBuildCreateParams {
   /**
-   * Attachment input for the app build file. This should be an upload in .zip
-   * format. The zip should contain at least one main_js_bundle.hbc file and
-   * optionally an assets folder next to it.
+   * The build file to upload. For iOS and Android, this should be a .zip archive
+   * containing a main_js_bundle.hbc file and an optional assets folder. For web,
+   * this should be a JavaScript file.
    */
   export interface Attachment {
     /**
@@ -198,7 +200,7 @@ export namespace AppBuildCreateParams {
 
 export interface AppBuildListParams extends CursorPageParams {
   /**
-   * The ID of the app to filter app builds by
+   * The unique identifier of the app to list builds for.
    */
   app_id: string;
 
@@ -208,12 +210,12 @@ export interface AppBuildListParams extends CursorPageParams {
   before?: string | null;
 
   /**
-   * The minimum creation date to filter by
+   * Only return builds created after this timestamp.
    */
   created_after?: string | null;
 
   /**
-   * The maximum creation date to filter by
+   * Only return builds created before this timestamp.
    */
   created_before?: string | null;