@whop/sdk 0.0.27 → 0.0.28

package/resources/apps.d.mts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Apps extends APIResource {
     /**
-     * Create a new App
+     * Register a new app on the Whop developer platform. Apps provide custom
+     * experiences that can be added to products.
      *
      * Required permissions:
      *
@@ -22,7 +23,7 @@ export declare class Apps extends APIResource {
      */
     create(body: AppCreateParams, options?: RequestOptions): APIPromise<Shared.App>;
     /**
-     * Retrieves an app by ID
+     * Retrieves the details of an existing app.
      *
      * Required permissions:
      *
@@ -37,7 +38,8 @@ export declare class Apps extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.App>;
     /**
-     * Update an existing App
+     * Update the settings, metadata, or status of an existing app on the Whop
+     * developer platform.
      *
      * Required permissions:
      *
@@ -51,7 +53,8 @@ export declare class Apps extends APIResource {
      */
     update(id: string, body?: AppUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.App>;
     /**
-     * Fetches a list of apps
+     * Returns a paginated list of apps on the Whop platform, with optional filtering
+     * by company, type, view support, and search query.
      *
      * @example
      * ```ts
@@ -78,72 +81,76 @@ export interface AppListResponse {
      */
     id: string;
     /**
-     * The type of end-user an app is built for
+     * The target audience classification for this app (e.g., 'b2b_app', 'b2c_app',
+     * 'company_app', 'component').
      */
     app_type: AppType;
     /**
-     * The base url of the app
+     * The production base URL where the app is hosted. Null if no base URL is
+     * configured.
      */
     base_url: string | null;
     /**
-     * The company that owns the app
+     * The company that owns and publishes this app.
      */
     company: AppListResponse.Company;
     /**
-     * The creator of the app
+     * The user who created and owns the company that published this app.
      */
     creator: AppListResponse.Creator;
     /**
-     * The path part for a specific view of the app. This is the template part of the
-     * url after the base domain. Eg: /experiences/[experienceId]
+     * The URL path template for a specific view of this app, appended to the base
+     * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
+     * not configured.
      */
     dashboard_path: string | null;
     /**
-     * The description of the app
+     * A written description of what this app does, displayed on the app store listing
+     * page. Null if no description has been set.
      */
     description: string | null;
     /**
-     * The path part for a specific view of the app. This is the template part of the
-     * url after the base domain. Eg: /experiences/[experienceId]
+     * The URL path template for a specific view of this app, appended to the base
+     * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
+     * not configured.
      */
     discover_path: string | null;
     /**
-     * The unique part of the proxied domain for this app. Used to generate the base
-     * url used to display the app inside the whop platform. Refers to the id part in
-     * the final url: https://{domain_id}.apps.whop.com
+     * The unique subdomain identifier for this app's proxied URL on the Whop platform.
+     * Forms the URL pattern https://{domain_id}.apps.whop.com.
      */
     domain_id: string;
     /**
-     * The path part for a specific view of the app. This is the template part of the
-     * url after the base domain. Eg: /experiences/[experienceId]
+     * The URL path template for a specific view of this app, appended to the base
+     * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
+     * not configured.
      */
     experience_path: string | null;
     /**
-     * The icon for the app. This icon is shown on discovery, on the product page, on
-     * checkout, and as a default icon for the experiences.
+     * The icon image for this app, displayed on the app store, product pages,
+     * checkout, and as the default icon for experiences using this app.
      */
     icon: AppListResponse.Icon | null;
     /**
-     * The name of the app
+     * The display name of this app shown on the app store and in experience
+     * navigation. Maximum 30 characters.
      */
     name: string;
     /**
-     * If the status is live, the app is visible on Whop discovery. In order to be
-     * live, you need to set the name, icon, and description. Being unlisted or hidden
-     * means it's not visible on Whop but you can still install the app via direct
-     * link. To remove the app from whop discovery, you should set the status to
-     * unlisted.
+     * The current visibility status of this app on the Whop app store. 'live' means
+     * publicly discoverable, 'unlisted' means accessible only via direct link, and
+     * 'hidden' means not visible anywhere.
      */
     status: Shared.AppStatuses;
     /**
-     * Whether this app has been verified by Whop. Verified apps are endorsed by whop
-     * and are shown in the 'featured apps' section of the app store.
+     * Whether this app has been verified by Whop. Verified apps are endorsed by Whop
+     * and displayed in the featured apps section of the app store.
      */
     verified: boolean;
 }
 export declare namespace AppListResponse {
     /**
-     * The company that owns the app
+     * The company that owns and publishes this app.
      */
     interface Company {
         /**
@@ -151,12 +158,12 @@ export declare namespace AppListResponse {
          */
         id: string;
         /**
-         * The title of the company.
+         * The display name of the company shown to customers.
          */
         title: string;
     }
     /**
-     * The creator of the app
+     * The user who created and owns the company that published this app.
      */
     interface Creator {
         /**
@@ -164,47 +171,54 @@ export declare namespace AppListResponse {
          */
         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;
     }
     /**
-     * The icon for the app. This icon is shown on discovery, on the product page, on
-     * checkout, and as a default icon for the experiences.
+     * The icon image for this app, displayed on the app store, product pages,
+     * checkout, and as the default icon for experiences using this app.
      */
     interface Icon {
         /**
-         * 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;
     }
 }
 export interface AppCreateParams {
     /**
-     * The ID of the company to create the app for
+     * The unique identifier of the company to create the app for, starting with
+     * 'biz\_'.
      */
     company_id: string;
     /**
-     * The name of the app to be created
+     * The display name for the app, shown to users on the app store and product pages.
      */
     name: string;
     /**
-     * The base URL of the app to be created
+     * The base production URL where the app is hosted, such as
+     * 'https://myapp.example.com'.
      */
     base_url?: string | null;
     /**
-     * The icon for the app in png, jpeg, or gif format
+     * The icon image for the app in PNG, JPEG, or GIF format.
      */
     icon?: AppCreateParams.Icon | null;
+    /**
+     * The whitelisted OAuth callback URLs that users are redirected to after
+     * authorizing the app.
+     */
+    redirect_uris?: Array<string> | null;
 }
 export declare namespace AppCreateParams {
     /**
-     * The icon for the app in png, jpeg, or gif format
+     * The icon image for the app in PNG, JPEG, or GIF format.
      */
     interface Icon {
         /**
@@ -215,7 +229,7 @@ export declare namespace AppCreateParams {
 }
 export interface AppUpdateParams {
     /**
-     * The description of the app for the app store in-depth app view.
+     * The detailed description shown on the app store's in-depth app view page.
      */
     app_store_description?: string | null;
     /**
@@ -223,35 +237,46 @@ export interface AppUpdateParams {
      */
     app_type?: AppType | null;
     /**
-     * The base production url of the app
+     * The base production URL where the app is hosted, such as
+     * 'https://myapp.example.com'.
      */
     base_url?: string | null;
     /**
-     * The path for the dashboard view of the app
+     * The URL path for the company dashboard view of the app, such as '/dashboard'.
      */
     dashboard_path?: string | null;
     /**
-     * The description of the app
+     * A short description of the app shown in listings and search results.
      */
     description?: string | null;
     /**
-     * The path for the discover view of the app
+     * The URL path for the discover view of the app, such as '/discover'.
      */
     discover_path?: string | null;
     /**
-     * The path for the hub view of the app
+     * The URL path for the member-facing hub view of the app, such as
+     * '/experiences/[experienceId]'.
      */
     experience_path?: string | null;
     /**
-     * The icon for the app
+     * The icon image for the app, used in listings and navigation.
      */
     icon?: AppUpdateParams.Icon | null;
     /**
-     * The name of the app
+     * The display name for the app, shown to users on the app store and product pages.
      */
     name?: string | null;
     /**
-     * The scopes that the app will request off of users when a user installs the app.
+     * How this app authenticates at the OAuth token endpoint.
+     */
+    oauth_client_type?: 'public' | 'confidential' | null;
+    /**
+     * The whitelisted OAuth callback URLs that users are redirected to after
+     * authorizing the app
+     */
+    redirect_uris?: Array<string> | null;
+    /**
+     * The permission scopes the app will request from users when they install it.
      */
     required_scopes?: Array<'read_user'> | null;
     /**
@@ -261,7 +286,7 @@ export interface AppUpdateParams {
 }
 export declare namespace AppUpdateParams {
     /**
-     * The icon for the app
+     * The icon image for the app, used in listings and navigation.
      */
     interface Icon {
         /**
@@ -280,7 +305,7 @@ export interface AppListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The ID of the company to filter apps by
+     * Filter apps to only those created by this company, starting with 'biz\_'.
      */
     company_id?: string | null;
     /**
@@ -300,12 +325,12 @@ export interface AppListParams extends CursorPageParams {
      */
     order?: 'created_at' | 'discoverable_at' | 'total_installs_last_30_days' | 'total_installs_last_7_days' | 'time_spent' | 'time_spent_last_24_hours' | 'daily_active_users' | 'ai_prompt_count' | 'total_ai_cost_usd' | 'total_ai_tokens' | 'last_ai_prompt_at' | 'ai_average_rating' | null;
     /**
-     * The query to search for apps by name.
+     * A search string to filter apps by name, such as 'chat' or 'analytics'.
      */
     query?: string | null;
     /**
-     * If true, you will only get apps that are verified by Whop. Use this to populate
-     * a 'featured apps' section on the app store.
+     * Whether to only return apps that have been verified by Whop. Useful for
+     * populating a featured apps section.
      */
     verified_apps_only?: boolean | null;
     /**

package/resources/apps.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"apps.d.mts","sourceRoot":"","sources":["../src/resources/apps.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,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAI/E;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAItE;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAIzB;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,eAAe,CAAC;CAG5D;AAED,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;IAEjC;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC;IAE3B;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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;;OAEG;IACH,KAAK,CAAC,EACF,YAAY,GACZ,iBAAiB,GACjB,6BAA6B,GAC7B,4BAA4B,GAC5B,YAAY,GACZ,0BAA0B,GAC1B,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,IAAI,CAAC;IAET;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}
+{"version":3,"file":"apps.d.mts","sourceRoot":"","sources":["../src/resources/apps.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,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAI/E;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAItE;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC;IAIzB;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,eAAe,CAAC;CAG5D;AAED,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;IAEjC;;OAEG;IACH,OAAO,EAAE,eAAe,CAAC,OAAO,CAAC;IAEjC;;;;OAIG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAElC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC;IAE3B;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACtC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,QAAQ,GAAG,cAAc,GAAG,IAAI,CAAC;IAErD;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;CACpC;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;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;;OAEG;IACH,KAAK,CAAC,EACF,YAAY,GACZ,iBAAiB,GACjB,6BAA6B,GAC7B,4BAA4B,GAC5B,YAAY,GACZ,0BAA0B,GAC1B,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,IAAI,CAAC;IAET;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,WAAW,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;CACH"}

package/resources/apps.d.ts

@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Apps extends APIResource {
     /**
-     * Create a new App
+     * Register a new app on the Whop developer platform. Apps provide custom
+     * experiences that can be added to products.
      *
      * Required permissions:
      *
@@ -22,7 +23,7 @@ export declare class Apps extends APIResource {
      */
     create(body: AppCreateParams, options?: RequestOptions): APIPromise<Shared.App>;
     /**
-     * Retrieves an app by ID
+     * Retrieves the details of an existing app.
      *
      * Required permissions:
      *
@@ -37,7 +38,8 @@ export declare class Apps extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.App>;
     /**
-     * Update an existing App
+     * Update the settings, metadata, or status of an existing app on the Whop
+     * developer platform.
      *
      * Required permissions:
      *
@@ -51,7 +53,8 @@ export declare class Apps extends APIResource {
      */
     update(id: string, body?: AppUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Shared.App>;
     /**
-     * Fetches a list of apps
+     * Returns a paginated list of apps on the Whop platform, with optional filtering
+     * by company, type, view support, and search query.
      *
      * @example
      * ```ts
@@ -78,72 +81,76 @@ export interface AppListResponse {
      */
     id: string;
     /**
-     * The type of end-user an app is built for
+     * The target audience classification for this app (e.g., 'b2b_app', 'b2c_app',
+     * 'company_app', 'component').
      */
     app_type: AppType;
     /**
-     * The base url of the app
+     * The production base URL where the app is hosted. Null if no base URL is
+     * configured.
      */
     base_url: string | null;
     /**
-     * The company that owns the app
+     * The company that owns and publishes this app.
      */
     company: AppListResponse.Company;
     /**
-     * The creator of the app
+     * The user who created and owns the company that published this app.
      */
     creator: AppListResponse.Creator;
     /**
-     * The path part for a specific view of the app. This is the template part of the
-     * url after the base domain. Eg: /experiences/[experienceId]
+     * The URL path template for a specific view of this app, appended to the base
+     * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
+     * not configured.
      */
     dashboard_path: string | null;
     /**
-     * The description of the app
+     * A written description of what this app does, displayed on the app store listing
+     * page. Null if no description has been set.
      */
     description: string | null;
     /**
-     * The path part for a specific view of the app. This is the template part of the
-     * url after the base domain. Eg: /experiences/[experienceId]
+     * The URL path template for a specific view of this app, appended to the base
+     * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
+     * not configured.
      */
     discover_path: string | null;
     /**
-     * The unique part of the proxied domain for this app. Used to generate the base
-     * url used to display the app inside the whop platform. Refers to the id part in
-     * the final url: https://{domain_id}.apps.whop.com
+     * The unique subdomain identifier for this app's proxied URL on the Whop platform.
+     * Forms the URL pattern https://{domain_id}.apps.whop.com.
      */
     domain_id: string;
     /**
-     * The path part for a specific view of the app. This is the template part of the
-     * url after the base domain. Eg: /experiences/[experienceId]
+     * The URL path template for a specific view of this app, appended to the base
+     * domain (e.g., '/experiences/[experienceId]'). Null if the specified view type is
+     * not configured.
      */
     experience_path: string | null;
     /**
-     * The icon for the app. This icon is shown on discovery, on the product page, on
-     * checkout, and as a default icon for the experiences.
+     * The icon image for this app, displayed on the app store, product pages,
+     * checkout, and as the default icon for experiences using this app.
      */
     icon: AppListResponse.Icon | null;
     /**
-     * The name of the app
+     * The display name of this app shown on the app store and in experience
+     * navigation. Maximum 30 characters.
      */
     name: string;
     /**
-     * If the status is live, the app is visible on Whop discovery. In order to be
-     * live, you need to set the name, icon, and description. Being unlisted or hidden
-     * means it's not visible on Whop but you can still install the app via direct
-     * link. To remove the app from whop discovery, you should set the status to
-     * unlisted.
+     * The current visibility status of this app on the Whop app store. 'live' means
+     * publicly discoverable, 'unlisted' means accessible only via direct link, and
+     * 'hidden' means not visible anywhere.
      */
     status: Shared.AppStatuses;
     /**
-     * Whether this app has been verified by Whop. Verified apps are endorsed by whop
-     * and are shown in the 'featured apps' section of the app store.
+     * Whether this app has been verified by Whop. Verified apps are endorsed by Whop
+     * and displayed in the featured apps section of the app store.
      */
     verified: boolean;
 }
 export declare namespace AppListResponse {
     /**
-     * The company that owns the app
+     * The company that owns and publishes this app.
      */
     interface Company {
         /**
@@ -151,12 +158,12 @@ export declare namespace AppListResponse {
          */
         id: string;
         /**
-         * The title of the company.
+         * The display name of the company shown to customers.
          */
         title: string;
     }
     /**
-     * The creator of the app
+     * The user who created and owns the company that published this app.
      */
     interface Creator {
         /**
@@ -164,47 +171,54 @@ export declare namespace AppListResponse {
          */
         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;
     }
     /**
-     * The icon for the app. This icon is shown on discovery, on the product page, on
-     * checkout, and as a default icon for the experiences.
+     * The icon image for this app, displayed on the app store, product pages,
+     * checkout, and as the default icon for experiences using this app.
      */
     interface Icon {
         /**
-         * 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;
     }
 }
 export interface AppCreateParams {
     /**
-     * The ID of the company to create the app for
+     * The unique identifier of the company to create the app for, starting with
+     * 'biz\_'.
      */
     company_id: string;
     /**
-     * The name of the app to be created
+     * The display name for the app, shown to users on the app store and product pages.
      */
     name: string;
     /**
-     * The base URL of the app to be created
+     * The base production URL where the app is hosted, such as
+     * 'https://myapp.example.com'.
      */
     base_url?: string | null;
     /**
-     * The icon for the app in png, jpeg, or gif format
+     * The icon image for the app in PNG, JPEG, or GIF format.
      */
     icon?: AppCreateParams.Icon | null;
+    /**
+     * The whitelisted OAuth callback URLs that users are redirected to after
+     * authorizing the app.
+     */
+    redirect_uris?: Array<string> | null;
 }
 export declare namespace AppCreateParams {
     /**
-     * The icon for the app in png, jpeg, or gif format
+     * The icon image for the app in PNG, JPEG, or GIF format.
      */
     interface Icon {
         /**
@@ -215,7 +229,7 @@ export declare namespace AppCreateParams {
 }
 export interface AppUpdateParams {
     /**
-     * The description of the app for the app store in-depth app view.
+     * The detailed description shown on the app store's in-depth app view page.
      */
     app_store_description?: string | null;
     /**
@@ -223,35 +237,46 @@ export interface AppUpdateParams {
      */
     app_type?: AppType | null;
     /**
-     * The base production url of the app
+     * The base production URL where the app is hosted, such as
+     * 'https://myapp.example.com'.
      */
     base_url?: string | null;
     /**
-     * The path for the dashboard view of the app
+     * The URL path for the company dashboard view of the app, such as '/dashboard'.
      */
     dashboard_path?: string | null;
     /**
-     * The description of the app
+     * A short description of the app shown in listings and search results.
      */
     description?: string | null;
     /**
-     * The path for the discover view of the app
+     * The URL path for the discover view of the app, such as '/discover'.
      */
     discover_path?: string | null;
     /**
-     * The path for the hub view of the app
+     * The URL path for the member-facing hub view of the app, such as
+     * '/experiences/[experienceId]'.
      */
     experience_path?: string | null;
     /**
-     * The icon for the app
+     * The icon image for the app, used in listings and navigation.
      */
     icon?: AppUpdateParams.Icon | null;
     /**
-     * The name of the app
+     * The display name for the app, shown to users on the app store and product pages.
      */
     name?: string | null;
     /**
-     * The scopes that the app will request off of users when a user installs the app.
+     * How this app authenticates at the OAuth token endpoint.
+     */
+    oauth_client_type?: 'public' | 'confidential' | null;
+    /**
+     * The whitelisted OAuth callback URLs that users are redirected to after
+     * authorizing the app
+     */
+    redirect_uris?: Array<string> | null;
+    /**
+     * The permission scopes the app will request from users when they install it.
      */
     required_scopes?: Array<'read_user'> | null;
     /**
@@ -261,7 +286,7 @@ export interface AppUpdateParams {
 }
 export declare namespace AppUpdateParams {
     /**
-     * The icon for the app
+     * The icon image for the app, used in listings and navigation.
      */
     interface Icon {
         /**
@@ -280,7 +305,7 @@ export interface AppListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The ID of the company to filter apps by
+     * Filter apps to only those created by this company, starting with 'biz\_'.
      */
     company_id?: string | null;
     /**
@@ -300,12 +325,12 @@ export interface AppListParams extends CursorPageParams {
      */
     order?: 'created_at' | 'discoverable_at' | 'total_installs_last_30_days' | 'total_installs_last_7_days' | 'time_spent' | 'time_spent_last_24_hours' | 'daily_active_users' | 'ai_prompt_count' | 'total_ai_cost_usd' | 'total_ai_tokens' | 'last_ai_prompt_at' | 'ai_average_rating' | null;
     /**
-     * The query to search for apps by name.
+     * A search string to filter apps by name, such as 'chat' or 'analytics'.
      */
     query?: string | null;
     /**
-     * If true, you will only get apps that are verified by Whop. Use this to populate
-     * a 'featured apps' section on the app store.
+     * Whether to only return apps that have been verified by Whop. Useful for
+     * populating a featured apps section.
      */
     verified_apps_only?: boolean | null;
     /**