whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/resources/ads.rbi

@@ -2,72 +2,287 @@
 
 module WhopSDK
   module Resources
-    # Ads
+    # An Ad is the individual creative unit delivered by an
+    # [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative
+    # assets, and destination URL for one ad.
+    #
+    # Use the Ads API to list ads for an account, create ads inside ad groups,
+    # retrieve or update creative details, delete ads that should stop running, and
+    # pause or resume delivery.
     class Ads
-      # Retrieve an ad by its unique identifier.
-      #
-      # Required permissions:
-      #
-      # - `ad_campaign:basic:read`
+      # Creates an ad in an ad group.
+      sig do
+        params(
+          ad_group: T.anything,
+          ad_group_id: String,
+          call_to_action: WhopSDK::AdCreateParams::CallToAction::OrSymbol,
+          creatives: T::Array[WhopSDK::AdCreateParams::Creative::OrHash],
+          descriptions: T::Array[String],
+          headlines: T::Array[String],
+          lead_form: WhopSDK::AdCreateParams::LeadForm::OrHash,
+          lead_form_id: String,
+          messaging_config: WhopSDK::AdCreateParams::MessagingConfig::OrHash,
+          multi_advertiser_ads: T::Boolean,
+          post_id: String,
+          post_source: WhopSDK::AdCreateParams::PostSource::OrSymbol,
+          primary_texts: T::Array[String],
+          social_accounts:
+            T::Array[WhopSDK::AdCreateParams::SocialAccount::OrHash],
+          title: String,
+          url: String,
+          url_parameters: T.anything,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Ad)
+      end
+      def create(
+        # An inline ad group to create (same shape as POST /ad_groups, including
+        # ad_campaign_id). Creates the ad group and the ad together. Provide this OR
+        # ad_group_id.
+        ad_group: nil,
+        # The existing ad group to create the ad in. Provide this OR ad_group, not both.
+        ad_group_id: nil,
+        # The call-to-action button shown on the ad.
+        call_to_action: nil,
+        # The ad's creative assets. Each entry is an uploaded file id with an optional
+        # format; omit format for the original asset.
+        creatives: nil,
+        # The description variants shown on the ad.
+        descriptions: nil,
+        # The headline variants shown on the ad.
+        headlines: nil,
+        # Instant lead form for the ad. Only allowed when the ad group's
+        # conversion_location is an instant-form destination (instant_forms,
+        # instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with
+        # lead_form_id.
+        lead_form: nil,
+        # Use an existing Meta instant form instead of creating one — the form's Meta id,
+        # from a form already on the ad's Facebook page. Only allowed when the ad group's
+        # conversion_location is an instant-form destination. Mutually exclusive with
+        # lead_form.
+        lead_form_id: nil,
+        # Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt
+        # (keyword).
+        messaging_config: nil,
+        # Whether the ad can appear alongside other advertisers' ads in the same unit.
+        # Defaults to true.
+        multi_advertiser_ads: nil,
+        # Promote an existing post instead of uploading creatives — a Facebook post or
+        # Instagram media id. Mutually exclusive with creatives. Pair with post_source.
+        post_id: nil,
+        # Which network post_id refers to — facebook (a page post) or instagram (a media
+        # id). Authoritative; when omitted the source is inferred from the id shape.
+        post_source: nil,
+        # The primary text variants shown in the ad body.
+        primary_texts: nil,
+        # The social accounts (Facebook page, Instagram profile) the ad runs under.
+        social_accounts: nil,
+        # The display name of the ad.
+        title: nil,
+        # The URL the ad links to.
+        url: nil,
+        # Query parameters appended to the destination URL, as a string-to-string map.
+        url_parameters: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a single ad with stats over the requested window.
       sig do
         params(
           id: String,
+          stats_from: String,
+          stats_to: String,
+          time_zone: String,
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(WhopSDK::Models::AdRetrieveResponse)
+        ).returns(WhopSDK::Ad)
       end
       def retrieve(
-        # The unique identifier of the ad.
+        # The ad ID.
         id,
+        # Start of the stats window.
+        stats_from: nil,
+        # End of the stats window.
+        stats_to: nil,
+        # IANA timezone the stats window is interpreted in. Defaults to UTC.
+        time_zone: nil,
         request_options: {}
       )
       end
 
-      # List ads scoped by ad group, campaign, or company.
-      #
-      # Required permissions:
-      #
-      # - `ad_campaign:basic:read`
+      # Updates an ad's editable fields.
       sig do
         params(
-          ad_group_id: T.nilable(String),
-          after: T.nilable(String),
-          before: T.nilable(String),
-          campaign_id: T.nilable(String),
-          company_id: T.nilable(String),
-          created_after: T.nilable(Time),
-          created_before: T.nilable(Time),
-          first: T.nilable(Integer),
-          last: T.nilable(Integer),
-          status: T.nilable(WhopSDK::AdListParams::Status::OrSymbol),
+          id: String,
+          call_to_action: WhopSDK::AdUpdateParams::CallToAction::OrSymbol,
+          creatives: T::Array[WhopSDK::AdUpdateParams::Creative::OrHash],
+          descriptions: T::Array[String],
+          headlines: T::Array[String],
+          lead_form: WhopSDK::AdUpdateParams::LeadForm::OrHash,
+          lead_form_id: String,
+          messaging_config: WhopSDK::AdUpdateParams::MessagingConfig::OrHash,
+          multi_advertiser_ads: T::Boolean,
+          post_id: String,
+          post_source: WhopSDK::AdUpdateParams::PostSource::OrSymbol,
+          primary_texts: T::Array[String],
+          social_accounts:
+            T::Array[WhopSDK::AdUpdateParams::SocialAccount::OrHash],
+          title: String,
+          url: String,
+          url_parameters: T.anything,
           request_options: WhopSDK::RequestOptions::OrHash
-        ).returns(
-          WhopSDK::Internal::CursorPage[WhopSDK::Models::AdListResponse]
-        )
+        ).returns(WhopSDK::Ad)
+      end
+      def update(
+        # The ad ID.
+        id,
+        # The call-to-action button shown on the ad.
+        call_to_action: nil,
+        # The ad's creative assets. Each entry is an uploaded file id with an optional
+        # format; omit format for the original asset. Replaces a live ad's creative on the
+        # platform.
+        creatives: nil,
+        # The description variants shown on the ad.
+        descriptions: nil,
+        # The headline variants shown on the ad.
+        headlines: nil,
+        # Instant lead form for the ad. Only allowed when the ad group's
+        # conversion_location is an instant-form destination (instant_forms,
+        # instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with
+        # lead_form_id.
+        lead_form: nil,
+        # Use an existing Meta instant form instead of creating one — the form's Meta id,
+        # from a form already on the ad's Facebook page. Only allowed when the ad group's
+        # conversion_location is an instant-form destination. Mutually exclusive with
+        # lead_form. Replaces a stored lead_form.
+        lead_form_id: nil,
+        # Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt
+        # (keyword).
+        messaging_config: nil,
+        # Whether the ad can appear alongside other advertisers' ads in the same unit.
+        # Defaults to true.
+        multi_advertiser_ads: nil,
+        # Promote an existing post instead of uploading creatives — a Facebook post or
+        # Instagram media id. Mutually exclusive with creatives. Pair with post_source.
+        post_id: nil,
+        # Which network post_id refers to — facebook (a page post) or instagram (a media
+        # id). Authoritative; when omitted the source is inferred from the id shape.
+        post_source: nil,
+        # The primary text variants shown in the ad body.
+        primary_texts: nil,
+        # The social accounts the ad runs under.
+        social_accounts: nil,
+        # The display name of the ad.
+        title: nil,
+        # The URL the ad links to.
+        url: nil,
+        # Query parameters appended to the destination URL, as a string-to-string map.
+        url_parameters: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists the ads for an account, with stats over the requested window.
+      sig do
+        params(
+          account_id: String,
+          ad_campaign_id: String,
+          ad_group_id: String,
+          after: String,
+          before: String,
+          created_after: String,
+          created_before: String,
+          direction: WhopSDK::AdListParams::Direction::OrSymbol,
+          first: Integer,
+          last: Integer,
+          order: WhopSDK::AdListParams::Order::OrSymbol,
+          query: String,
+          stats_from: String,
+          stats_to: String,
+          status: WhopSDK::AdListParams::Status::OrSymbol,
+          time_zone: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Internal::CursorPage[WhopSDK::Ad])
       end
       def list(
-        # Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or
-        # company_id.
+        # The account the ads belong to. Defaults to the account-scoped key's own account.
+        account_id: nil,
+        # Only return ads in this ad campaign.
+        ad_campaign_id: nil,
+        # Only return ads in this ad group.
         ad_group_id: nil,
-        # Returns the elements in the list that come after the specified cursor.
+        # Cursor to fetch the page after (from page_info.end_cursor).
         after: nil,
-        # Returns the elements in the list that come before the specified cursor.
+        # Cursor to fetch the page before (from page_info.start_cursor).
         before: nil,
-        # Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or
-        # company_id.
-        campaign_id: nil,
-        # Filter by company. Provide exactly one of ad_group_id, campaign_id, or
-        # company_id.
-        company_id: nil,
         # Only return ads created after this timestamp.
         created_after: nil,
         # Only return ads created before this timestamp.
         created_before: nil,
-        # Returns the first _n_ elements from the list.
+        # The sort direction. Defaults to desc.
+        direction: nil,
+        # The number of ads to return.
         first: nil,
-        # Returns the last _n_ elements from the list.
+        # The number of ads to return from the end of the range.
         last: nil,
-        # The status of an external ad.
+        # The field to sort by. Defaults to created_at. Stat columns (spend, impressions,
+        # …) rank over the stats_from/stats_to window across the whole list, not just the
+        # current page. results, cost_per_result and return_on_ad_spend rank by the same
+        # Whop pixel-attributed values the response reports.
+        order: nil,
+        # Filter ads by a title or ID substring.
+        query: nil,
+        # Start of the stats window. Defaults to all-time.
+        stats_from: nil,
+        # End of the stats window. Defaults to now.
+        stats_to: nil,
+        # Only return ads with this status.
         status: nil,
+        # IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare
+        # stats_from/stats_to dates resolve to day boundaries on this clock. Defaults to
+        # UTC.
+        time_zone: nil,
+        request_options: {}
+      )
+      end
+
+      # Deletes an ad. Returns true on success.
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(
+        # The ad ID.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Pauses an active ad.
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Ad)
+      end
+      def pause(
+        # The ad ID.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Resumes a paused ad.
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Ad)
+      end
+      def unpause(
+        # The ad ID.
+        id,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/affiliates/overrides.rbi

@@ -3,7 +3,6 @@
 module WhopSDK
   module Resources
     class Affiliates
-      # Affiliates
       class Overrides
         # Creates a commission override for an affiliate.
         #

data/rbi/whop_sdk/resources/affiliates.rbi

@@ -2,9 +2,7 @@
 
 module WhopSDK
   module Resources
-    # Affiliates
     class Affiliates
-      # Affiliates
       sig { returns(WhopSDK::Resources::Affiliates::Overrides) }
       attr_reader :overrides
 

data/rbi/whop_sdk/resources/ai_chats.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Ai chats
     class AIChats
       # Create a new AI chat thread and send the first message to the AI agent.
       #

data/rbi/whop_sdk/resources/app_builds.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # App builds
     class AppBuilds
       # Upload a new build artifact for an app. The build must include a compiled code
       # bundle for the specified platform.
@@ -25,7 +24,7 @@ module WhopSDK
       def create(
         # 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.
+        # this should be a JavaScript file or a .zip archive of the hosted site.
         attachment:,
         # A client-generated checksum of the build file, used to verify file integrity
         # when unpacked on a device.

data/rbi/whop_sdk/resources/apps.rbi

@@ -2,7 +2,15 @@
 
 module WhopSDK
   module Resources
-    # Apps
+    # An App is software you build on Whop. It can be a hosted web app served at
+    # `<route>.whop.app` or an API integration installed as an experience, and it
+    # belongs to the account that owns its credentials, settings, builds, and runtime
+    # logs.
+    #
+    # Use the Apps API to manage app configuration and, for hosted apps, read server
+    # runtime logs for console output, uncaught exceptions, and failed requests. Logs
+    # are retained for 7 days and can be filtered by build, level, time window, and
+    # message text.
     class Apps
       # Register a new app on the Whop developer platform. Apps provide custom
       # experiences that can be added to products.
@@ -11,6 +19,7 @@ module WhopSDK
       #
       # - `developer:create_app`
       # - `developer:manage_api_key`
+      # - `developer:update_app`
       sig do
         params(
           company_id: String,
@@ -18,6 +27,7 @@ module WhopSDK
           base_url: T.nilable(String),
           icon: T.nilable(WhopSDK::AppCreateParams::Icon::OrHash),
           redirect_uris: T.nilable(T::Array[String]),
+          route: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::App)
       end
@@ -35,6 +45,9 @@ module WhopSDK
         # The whitelisted OAuth callback URLs that users are redirected to after
         # authorizing the app.
         redirect_uris: nil,
+        # The unique subdomain route where the app's hosted web builds are served, such as
+        # 'myapp' for myapp.whop.app.
+        route: nil,
         request_options: {}
       )
       end
@@ -44,6 +57,7 @@ module WhopSDK
       # Required permissions:
       #
       # - `developer:manage_api_key`
+      # - `developer:update_app`
       sig do
         params(
           id: String,
@@ -84,6 +98,8 @@ module WhopSDK
             T.nilable(
               T::Array[WhopSDK::AppUpdateParams::RequiredScope::OrSymbol]
             ),
+          route: T.nilable(String),
+          secrets: T.nilable(T::Hash[Symbol, T.anything]),
           skills_path: T.nilable(String),
           status: T.nilable(WhopSDK::AppStatuses::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
@@ -122,6 +138,14 @@ module WhopSDK
         redirect_uris: nil,
         # The permission scopes the app will request from users when they install it.
         required_scopes: nil,
+        # The unique subdomain route where the app's hosted web builds are served, such as
+        # 'myapp' for myapp.whop.app.
+        route: nil,
+        # Secrets to add or overwrite on the app, as an object of string values (e.g.
+        # {"MAIL_API_KEY": "..."}). Keys not included are left untouched. Pass null or an
+        # empty string as the value to delete a secret. Secrets are encrypted at rest and
+        # injected into the app's hosted server runtime as environment bindings.
+        secrets: nil,
         # The URL path to the skills directory of the app, such as '/assets/skills/'.
         skills_path: nil,
         # The status of an experience interface
@@ -178,6 +202,47 @@ module WhopSDK
       )
       end
 
+      # Lists a hosted app's server runtime logs, most recent first: console output,
+      # uncaught exceptions, and failed-request summaries captured on whop.app hosting.
+      # Logs are retained for 7 days.
+      sig do
+        params(
+          id: String,
+          after: String,
+          app_build_id: String,
+          before: String,
+          created_after: Time,
+          created_before: Time,
+          first: Integer,
+          level: WhopSDK::AppLogsParams::Level::OrSymbol,
+          query: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::AppLogsResponse)
+      end
+      def logs(
+        # The ID of the app, which will look like app\_******\*******.
+        id,
+        # A cursor for fetching logs after a previous page.
+        after: nil,
+        # Only return logs from this build.
+        app_build_id: nil,
+        # A cursor for fetching logs before a later page.
+        before: nil,
+        # Start of the time window as an ISO 8601 timestamp. Defaults to 7 days before
+        # created_before.
+        created_after: nil,
+        # End of the time window as an ISO 8601 timestamp. Defaults to now.
+        created_before: nil,
+        # The number of log lines to return (max 500).
+        first: nil,
+        # Only return console lines of this level.
+        level: nil,
+        # Only return logs whose message contains this text (case-insensitive).
+        query: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: WhopSDK::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/whop_sdk/resources/audiences.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # An Audience represents a customer list uploaded to Whop for ad targeting.
+    # Audiences belong to an account and sync to supported ad platforms as custom
+    # audiences.
+    #
+    # Use the Audiences API to create audiences from CSV uploads, monitor processing
+    # status, and list or delete audiences for an account. Created audiences are
+    # usable for targeting after processing reaches `ready` or `partial`.
+    class Audiences
+      # Creates an audience from an uploaded customer identity CSV file and starts
+      # processing it.
+      sig do
+        params(
+          account_id: String,
+          column_mapping: WhopSDK::AudienceCreateParams::ColumnMapping::OrHash,
+          file_id: String,
+          name: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Audience)
+      end
+      def create(
+        # Account ID, prefixed `biz_`.
+        account_id:,
+        # Maps supported identity fields to CSV column headers. Map at least one of
+        # `email` or `phone`.
+        column_mapping:,
+        # Direct upload ID from the standard media upload endpoint.
+        file_id:,
+        # Audience display name.
+        name:,
+        request_options: {}
+      )
+      end
+
+      # Lists uploaded customer-list audiences for an account. Pass `audience_id` to
+      # return a specific audience.
+      sig do
+        params(
+          account_id: String,
+          after: String,
+          audience_id: String,
+          first: Integer,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Internal::CursorPage[WhopSDK::Audience])
+      end
+      def list(
+        # Account ID, prefixed `biz_`.
+        account_id:,
+        # Cursor for the next page of audiences.
+        after: nil,
+        # Audience ID, prefixed `adaud_`, used to filter the response to one audience.
+        audience_id: nil,
+        # Number of audiences to return. Defaults to 20; maximum 100.
+        first: nil,
+        request_options: {}
+      )
+      end
+
+      # Deletes an audience so it is no longer available for targeting.
+      sig do
+        params(
+          audience_id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::AudienceDeleteResponse)
+      end
+      def delete(
+        # Audience ID, prefixed `adaud_`.
+        audience_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/authorized_users.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Authorized users
     class AuthorizedUsers
       # Add a new authorized user to a company.
       #
@@ -15,6 +14,8 @@ module WhopSDK
           company_id: String,
           role: WhopSDK::AuthorizedUserRoles::OrSymbol,
           user_id: String,
+          elevation:
+            T.nilable(WhopSDK::AuthorizedUserCreateParams::Elevation::OrHash),
           send_emails: T.nilable(T::Boolean),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::AuthorizedUser)
@@ -27,6 +28,8 @@ module WhopSDK
         role:,
         # The ID of the user to add as an authorized user.
         user_id:,
+        # Re-authentication proof required to perform this sensitive action.
+        elevation: nil,
         # Whether to send notification emails to the user on creation.
         send_emails: nil,
         request_options: {}

data/rbi/whop_sdk/resources/bounties.rbi

@@ -2,7 +2,6 @@
 
 module WhopSDK
   module Resources
-    # Bounties
     class Bounties
       # Create a new workforce bounty by funding a dedicated bounty pool.
       #
@@ -17,16 +16,25 @@ module WhopSDK
           title: String,
           accepted_submissions_limit: T.nilable(Integer),
           allowed_country_codes: T.nilable(T::Array[String]),
+          business_goal_type:
+            T.nilable(WhopSDK::BountyCreateParams::BusinessGoalType::OrSymbol),
           experience_id: T.nilable(String),
           origin_account_id: T.nilable(String),
           post_markdown_content: T.nilable(String),
           post_title: T.nilable(String),
+          scheduled_frequency:
+            T.nilable(
+              WhopSDK::BountyCreateParams::ScheduledFrequency::OrSymbol
+            ),
+          scheduled_publish_at: T.nilable(Time),
+          scheduled_timezone: T.nilable(String),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::BountyCreateResponse)
       end
       def create(
         # The amount paid to each approved submission. The total bounty pool funded is
-        # this amount times accepted_submissions_limit.
+        # this amount times accepted_submissions_limit, and must be at least 5 in the
+        # bounty's currency.
         base_unit_amount:,
         # The currency for the bounty pool funding amount.
         currency:,
@@ -35,11 +43,15 @@ module WhopSDK
         # The title of the bounty.
         title:,
         # The number of submissions that can be approved before the bounty closes.
-        # Defaults to 1.
+        # Defaults to 1. The total pool (base_unit_amount times this limit) must be at
+        # least 5 in the bounty's currency.
         accepted_submissions_limit: nil,
         # The ISO3166 country codes where this bounty should be visible. Empty means
         # globally visible.
         allowed_country_codes: nil,
+        # What the poster is trying to accomplish with a workforce bounty. Used for
+        # product taxonomy and analytics, separate from the bounty's implementation type.
+        business_goal_type: nil,
         # An optional experience to scope the bounty to.
         experience_id: nil,
         # The user (user*\*) or company (biz*\*) tag whose balance funds this bounty pool.
@@ -52,6 +64,14 @@ module WhopSDK
         # Optional title for the anchor forum post. Falls back to the bounty title when
         # omitted.
         post_title: nil,
+        # How often a scheduled bounty republishes a new bounty.
+        scheduled_frequency: nil,
+        # When to publish the bounty. When provided, the bounty is created as a hidden
+        # draft and published at this time instead of immediately. Must be in the future.
+        scheduled_publish_at: nil,
+        # The IANA timezone used for recurring occurrences. Required when
+        # scheduled_publish_at is provided.
+        scheduled_timezone: nil,
         request_options: {}
       )
       end