whop_sdk 0.0.37 → 0.0.39

data/rbi/whop_sdk/resources/ad_groups.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Ad groups
+    class AdGroups
+      # Retrieves a single ad group by its unique identifier.
+      #
+      # Required permissions:
+      #
+      # - `ad_campaign:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::AdGroupRetrieveResponse)
+      end
+      def retrieve(
+        # The unique identifier of the ad group.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Updates an existing ad group.
+      #
+      # Required permissions:
+      #
+      # - `ad_campaign:update`
+      # - `ad_campaign:basic:read`
+      sig do
+        params(
+          id: String,
+          budget: T.nilable(Float),
+          budget_type:
+            T.nilable(WhopSDK::AdGroupUpdateParams::BudgetType::OrSymbol),
+          config: T.nilable(WhopSDK::AdGroupUpdateParams::Config::OrHash),
+          daily_budget: T.nilable(Float),
+          name: T.nilable(String),
+          platform_config:
+            T.nilable(WhopSDK::AdGroupUpdateParams::PlatformConfig::OrHash),
+          status: T.nilable(WhopSDK::AdGroupUpdateParams::Status::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::AdGroupUpdateResponse)
+      end
+      def update(
+        # The unique identifier of the ad group to update.
+        id,
+        # Budget amount in dollars.
+        budget: nil,
+        # The budget type for an ad campaign or ad group.
+        budget_type: nil,
+        # Unified ad group configuration (bidding, optimization, targeting).
+        config: nil,
+        # Daily budget in dollars.
+        daily_budget: nil,
+        # Human-readable ad group name.
+        name: nil,
+        # Platform-specific ad group configuration.
+        platform_config: nil,
+        # The status of an external ad group.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of ad groups scoped by campaign or company, with
+      # optional filtering by status and creation date.
+      #
+      # Required permissions:
+      #
+      # - `ad_campaign:basic:read`
+      sig do
+        params(
+          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),
+          query: T.nilable(String),
+          status: T.nilable(WhopSDK::AdGroupListParams::Status::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::AdGroupListResponse]
+        )
+      end
+      def list(
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # Filter by campaign. Provide exactly one of campaign_id or company_id.
+        campaign_id: nil,
+        # Filter by company. Provide exactly one of campaign_id or company_id.
+        company_id: nil,
+        # Only return ad groups created after this timestamp.
+        created_after: nil,
+        # Only return ad groups created before this timestamp.
+        created_before: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # Case-insensitive substring match against the ad group name.
+        query: nil,
+        # The status of an external ad group.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Soft-deletes an ad group.
+      #
+      # Required permissions:
+      #
+      # - `ad_campaign:update`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(
+        # The unique identifier of the ad group to delete.
+        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/ad_reports.rbi

@@ -0,0 +1,55 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Ad reports
+    class AdReports
+      # Performance report for an ad campaign, ad group, or ad. Returns aggregate totals
+      # and an optional per-day breakdown. Exactly one of `adCampaignId`, `adGroupId`,
+      # or `adId` must be provided.
+      #
+      # Required permissions:
+      #
+      # - `ad_campaign:stats:read`
+      sig do
+        params(
+          from: Time,
+          to: Time,
+          ad_campaign_id: T.nilable(String),
+          ad_group_id: T.nilable(String),
+          ad_id: T.nilable(String),
+          currency: T.nilable(String),
+          include_daily: T.nilable(T::Boolean),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::AdReportRetrieveResponse)
+      end
+      def retrieve(
+        # Inclusive start of the reporting window.
+        from:,
+        # Inclusive end of the reporting window.
+        to:,
+        # The unique identifier of an ad campaign. Mutually exclusive with `adGroupId` and
+        # `adId`.
+        ad_campaign_id: nil,
+        # The unique identifier of an ad group. Mutually exclusive with `adCampaignId` and
+        # `adId`.
+        ad_group_id: nil,
+        # The unique identifier of an ad. Mutually exclusive with `adCampaignId` and
+        # `adGroupId`.
+        ad_id: nil,
+        # ISO 4217 currency code to report `spend` in. Defaults to the company's ads
+        # reporting currency.
+        currency: nil,
+        # When true, includes a per-day breakdown alongside the summary.
+        include_daily: nil,
+        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/ads.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Ads
+    class Ads
+      # Retrieve an ad by its unique identifier.
+      #
+      # Required permissions:
+      #
+      # - `ad_campaign:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::AdRetrieveResponse)
+      end
+      def retrieve(
+        # The unique identifier of the ad.
+        id,
+        request_options: {}
+      )
+      end
+
+      # List ads scoped by ad group, campaign, or company.
+      #
+      # Required permissions:
+      #
+      # - `ad_campaign:basic:read`
+      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),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::AdListResponse]
+        )
+      end
+      def list(
+        # Filter by ad group. Provide exactly one of ad_group_id, campaign_id, or
+        # company_id.
+        ad_group_id: nil,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified 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.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The status of an external ad.
+        status: nil,
+        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/bounties.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Bounties
+    class Bounties
+      # Create a new workforce bounty by funding a dedicated bounty pool.
+      #
+      # Required permissions:
+      #
+      # - `bounty:create`
+      sig do
+        params(
+          base_unit_amount: Float,
+          currency: WhopSDK::Currency::OrSymbol,
+          description: String,
+          title: String,
+          accepted_submissions_limit: T.nilable(Integer),
+          allowed_country_codes: T.nilable(T::Array[String]),
+          experience_id: T.nilable(String),
+          origin_account_id: T.nilable(String),
+          post_markdown_content: T.nilable(String),
+          post_title: 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.
+        base_unit_amount:,
+        # The currency for the bounty pool funding amount.
+        currency:,
+        # The description of the bounty.
+        description:,
+        # The title of the bounty.
+        title:,
+        # The number of submissions that can be approved before the bounty closes.
+        # Defaults to 1.
+        accepted_submissions_limit: nil,
+        # The ISO3166 country codes where this bounty should be visible. Empty means
+        # globally visible.
+        allowed_country_codes: 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.
+        # Defaults to the requester's personal balance when omitted. The requester must be
+        # the user themself or an owner/admin of the company.
+        origin_account_id: nil,
+        # Optional markdown body for the anchor forum post. Falls back to the bounty
+        # description when omitted.
+        post_markdown_content: nil,
+        # Optional title for the anchor forum post. Falls back to the bounty title when
+        # omitted.
+        post_title: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a workforce bounty for the current authenticated user.
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::BountyRetrieveResponse)
+      end
+      def retrieve(
+        # The unique identifier of the workforce bounty to retrieve.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of workforce bounties. When experienceId is provided,
+      # returns bounties scoped to that experience. When omitted, returns bounties with
+      # no experience.
+      sig do
+        params(
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          experience_id: T.nilable(String),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          status: T.nilable(WhopSDK::BountyListParams::Status::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::BountyListResponse]
+        )
+      end
+      def list(
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # The direction of the sort.
+        direction: nil,
+        # The experience to list bounties for. When omitted, returns bounties with no
+        # experience.
+        experience_id: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The available bounty statuses to choose from.
+        status: nil,
+        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/companies.rbi

@@ -175,6 +175,38 @@ module WhopSDK
       )
       end
 
+      # Create an API key for a connected account (child company) owned by a parent
+      # company.
+      sig do
+        params(
+          parent_company_id: String,
+          child_company_id: String,
+          name: T.nilable(String),
+          permissions:
+            T.nilable(
+              T::Array[WhopSDK::CompanyCreateAPIKeyParams::Permission::OrHash]
+            ),
+          role: T.nilable(WhopSDK::CompanyCreateAPIKeyParams::Role::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::CompanyCreateAPIKeyResponse)
+      end
+      def create_api_key(
+        # The unique identifier of the parent platform company (e.g. 'biz_xxx').
+        parent_company_id,
+        # The unique identifier of the connected account to create the API key for (e.g.
+        # 'biz_xxx').
+        child_company_id:,
+        # A human-readable name for the API key, such as 'Production API Key'.
+        name: nil,
+        # Granular permission statements defining which actions this API key can perform.
+        # Either permissions or role must be provided.
+        permissions: nil,
+        # The different system roles that can be assigned.
+        role: nil,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: WhopSDK::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/whop_sdk/resources/conversions.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    # Conversions
+    class Conversions
+      # Track a conversion or engagement event for a company.
+      #
+      # Required permissions:
+      #
+      # - `event:create`
+      sig do
+        params(
+          company_id: String,
+          event_name: WhopSDK::ConversionCreateParams::EventName::OrSymbol,
+          action_source:
+            T.nilable(WhopSDK::ConversionCreateParams::ActionSource::OrSymbol),
+          context: T.nilable(WhopSDK::ConversionCreateParams::Context::OrHash),
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
+          custom_name: T.nilable(String),
+          event_id: T.nilable(String),
+          event_time: T.nilable(Time),
+          plan_id: T.nilable(String),
+          product_id: T.nilable(String),
+          referrer_url: T.nilable(String),
+          url: T.nilable(String),
+          user: T.nilable(WhopSDK::ConversionCreateParams::User::OrHash),
+          value: T.nilable(Float),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Models::ConversionCreateResponse)
+      end
+      def create(
+        # The company to associate with this event.
+        company_id:,
+        # The type of event.
+        event_name:,
+        # The channel where an event originated
+        action_source: nil,
+        # Tracking and attribution context.
+        context: nil,
+        # The available currencies on the platform
+        currency: nil,
+        # Custom event name when event_name is 'custom'.
+        custom_name: nil,
+        # Client-provided identifier for deduplication. Generated if omitted.
+        event_id: nil,
+        # When the event occurred. Defaults to now.
+        event_time: nil,
+        # The plan associated with the event.
+        plan_id: nil,
+        # The product associated with the event.
+        product_id: nil,
+        # The referring URL.
+        referrer_url: nil,
+        # The URL where the event occurred.
+        url: nil,
+        # User identity and profile data.
+        user: nil,
+        # Monetary value associated with the event.
+        value: nil,
+        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/files.rbi

@@ -9,6 +9,8 @@ module WhopSDK
       sig do
         params(
           filename: String,
+          visibility:
+            T.nilable(WhopSDK::FileCreateParams::Visibility::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Models::FileCreateResponse)
       end
@@ -16,6 +18,9 @@ module WhopSDK
         # The name of the file including its extension (e.g., "photo.png" or
         # "document.pdf").
         filename:,
+        # Controls whether an uploaded file is publicly accessible or requires
+        # authentication to access.
+        visibility: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/forum_posts.rbi

@@ -140,6 +140,7 @@ module WhopSDK
           after: T.nilable(String),
           before: T.nilable(String),
           first: T.nilable(Integer),
+          include_bounty_anchors: T.nilable(T::Boolean),
           last: T.nilable(Integer),
           parent_id: T.nilable(String),
           pinned: T.nilable(T::Boolean),
@@ -157,6 +158,8 @@ module WhopSDK
         before: nil,
         # Returns the first _n_ elements from the list.
         first: nil,
+        # Whether to include top-level bounty discussion anchors as rich forum items.
+        include_bounty_anchors: nil,
         # Returns the last _n_ elements from the list.
         last: nil,
         # The unique identifier of a parent post to list comments for. When set, returns

data/rbi/whop_sdk/resources/forums.rbi

@@ -31,6 +31,7 @@ module WhopSDK
       sig do
         params(
           id: String,
+          banned_words: T.nilable(T::Array[String]),
           banner_image:
             T.nilable(WhopSDK::ForumUpdateParams::BannerImage::OrHash),
           email_notification_preference:
@@ -44,6 +45,9 @@ module WhopSDK
         # The unique identifier of the forum to update. Accepts either an experience ID
         # (e.g. 'exp_xxxxx') or a forum ID.
         id,
+        # A list of words that are automatically blocked from posts in this forum. For
+        # example, ['spam', 'scam'].
+        banned_words: nil,
         # The banner image displayed at the top of the forum page. Pass null to remove the
         # existing banner.
         banner_image: nil,

data/rbi/whop_sdk/resources/invoices.rbi

@@ -67,13 +67,17 @@ module WhopSDK
           member_id: T.nilable(String),
           payment_method_id: T.nilable(String),
           plan: T.nilable(WhopSDK::InvoiceUpdateParams::Plan::OrHash),
+          product_id: T.nilable(String),
+          subscription_billing_anchor_at: T.nilable(Time),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(WhopSDK::Invoice)
       end
       def update(
         # The unique identifier of the invoice to update.
         id,
-        # The date and time when the invoice will be automatically finalized and charged.
+        # The date and time when the invoice will be automatically finalized. For
+        # charge_automatically, triggers an automatic charge. For send_invoice, sends the
+        # invoice email at the specified time.
         automatically_finalizes_at: nil,
         # Inline billing address to create or update a mailing address for this invoice.
         billing_address: nil,
@@ -97,6 +101,11 @@ module WhopSDK
         payment_method_id: nil,
         # Updated plan attributes.
         plan: nil,
+        # The unique identifier of an existing product to attach to this invoice. Only
+        # allowed while the invoice is still a draft.
+        product_id: nil,
+        # The date that defines when the subscription billing cycle should start.
+        subscription_billing_anchor_at: nil,
         request_options: {}
       )
       end

data/rbi/whop_sdk/resources/payments.rbi

@@ -211,8 +211,9 @@ module WhopSDK
       def refund(
         # The unique identifier of the payment to refund.
         id,
-        # The amount to refund in the payment currency. If omitted, the full payment
-        # amount is refunded.
+        # The amount to refund. For multi-currency payments, this is in the charge
+        # currency (what the buyer paid). For single-currency, this is in the payment
+        # currency. If omitted, the full payment amount is refunded.
         partial_amount: nil,
         request_options: {}
       )

data/rbi/whop_sdk/resources/plans.rbi

@@ -16,6 +16,7 @@ module WhopSDK
         params(
           company_id: String,
           product_id: String,
+          adaptive_pricing_enabled: T.nilable(T::Boolean),
           billing_period: T.nilable(Integer),
           checkout_styling:
             T.nilable(WhopSDK::PlanCreateParams::CheckoutStyling::OrHash),
@@ -50,6 +51,8 @@ module WhopSDK
         company_id:,
         # The unique identifier of the product to attach this plan to.
         product_id:,
+        # Whether this plan accepts local currency payments via adaptive pricing.
+        adaptive_pricing_enabled: nil,
         # The number of days between recurring charges. For example, 30 for monthly or 365
         # for yearly.
         billing_period: nil,
@@ -135,6 +138,7 @@ module WhopSDK
       sig do
         params(
           id: String,
+          adaptive_pricing_enabled: T.nilable(T::Boolean),
           billing_period: T.nilable(Integer),
           checkout_styling:
             T.nilable(WhopSDK::PlanUpdateParams::CheckoutStyling::OrHash),
@@ -167,6 +171,8 @@ module WhopSDK
       def update(
         # The unique identifier of the plan to update.
         id,
+        # Whether this plan accepts local currency payments via adaptive pricing.
+        adaptive_pricing_enabled: nil,
         # The number of days between recurring charges. For example, 30 for monthly or 365
         # for yearly.
         billing_period: nil,

data/rbi/whop_sdk/resources/support_channels.rbi

@@ -56,14 +56,15 @@ module WhopSDK
       # - `support_chat:read`
       sig do
         params(
-          company_id: String,
           after: T.nilable(String),
           before: T.nilable(String),
+          company_id: T.nilable(String),
           direction: T.nilable(WhopSDK::Direction::OrSymbol),
           first: T.nilable(Integer),
           last: T.nilable(Integer),
           open_: T.nilable(T::Boolean),
           order: T.nilable(WhopSDK::SupportChannelListParams::Order::OrSymbol),
+          view: T.nilable(WhopSDK::SupportChannelListParams::View::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(
           WhopSDK::Internal::CursorPage[
@@ -72,12 +73,14 @@ module WhopSDK
         )
       end
       def list(
-        # The unique identifier of the company to list support channels for.
-        company_id:,
         # Returns the elements in the list that come after the specified cursor.
         after: nil,
         # Returns the elements in the list that come before the specified cursor.
         before: nil,
+        # The unique identifier of the company to list support channels for. Includes
+        # channels of child companies. When omitted, returns support channels across all
+        # companies the user has access to.
+        company_id: nil,
         # The direction of the sort.
         direction: nil,
         # Returns the first _n_ elements from the list.
@@ -89,6 +92,8 @@ module WhopSDK
         open_: nil,
         # Sort options for message channels
         order: nil,
+        # The perspective to filter support channels by.
+        view: nil,
         request_options: {}
       )
       end