whop_sdk 0.0.39 → 0.0.41

data/rbi/whop_sdk/models/ad_campaign_list_params.rbi

@@ -11,77 +11,174 @@ module WhopSDK
           T.any(WhopSDK::AdCampaignListParams, WhopSDK::Internal::AnyHash)
         end
 
-      # The unique identifier of the company to list ad campaigns for.
-      sig { returns(String) }
-      attr_accessor :company_id
+      # The account the campaigns belong to. Defaults to the account-scoped key's own
+      # account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # Cursor to fetch the page after (from page_info.end_cursor).
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
 
-      # Returns the elements in the list that come after the specified cursor.
+      # Cursor to fetch the page before (from page_info.start_cursor).
       sig { returns(T.nilable(String)) }
-      attr_accessor :after
+      attr_reader :before
 
-      # Returns the elements in the list that come before the specified cursor.
+      sig { params(before: String).void }
+      attr_writer :before
+
+      # Only return campaigns created after this timestamp.
       sig { returns(T.nilable(String)) }
-      attr_accessor :before
+      attr_reader :created_after
+
+      sig { params(created_after: String).void }
+      attr_writer :created_after
+
+      # Only return campaigns created before this timestamp.
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_before
+
+      sig { params(created_before: String).void }
+      attr_writer :created_before
 
-      # Only return ad campaigns created after this timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_accessor :created_after
+      # The sort direction. Defaults to desc.
+      sig do
+        returns(T.nilable(WhopSDK::AdCampaignListParams::Direction::OrSymbol))
+      end
+      attr_reader :direction
 
-      # Only return ad campaigns created before this timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_accessor :created_before
+      sig do
+        params(
+          direction: WhopSDK::AdCampaignListParams::Direction::OrSymbol
+        ).void
+      end
+      attr_writer :direction
 
-      # Returns the first _n_ elements from the list.
+      # The number of campaigns to return.
       sig { returns(T.nilable(Integer)) }
-      attr_accessor :first
+      attr_reader :first
 
-      # Returns the last _n_ elements from the list.
+      sig { params(first: Integer).void }
+      attr_writer :first
+
+      # The number of campaigns to return from the end of the range.
       sig { returns(T.nilable(Integer)) }
-      attr_accessor :last
+      attr_reader :last
+
+      sig { params(last: Integer).void }
+      attr_writer :last
+
+      # 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.
+      sig { returns(T.nilable(WhopSDK::AdCampaignListParams::Order::OrSymbol)) }
+      attr_reader :order
 
-      # Case-insensitive substring match against the campaign title.
+      sig { params(order: WhopSDK::AdCampaignListParams::Order::OrSymbol).void }
+      attr_writer :order
+
+      # Filter campaigns by a title or ID substring.
       sig { returns(T.nilable(String)) }
-      attr_accessor :query
+      attr_reader :query
+
+      sig { params(query: String).void }
+      attr_writer :query
 
-      # The status of an ad campaign.
+      # Start of the stats window. Defaults to all-time.
+      sig { returns(T.nilable(String)) }
+      attr_reader :stats_from
+
+      sig { params(stats_from: String).void }
+      attr_writer :stats_from
+
+      # End of the stats window. Defaults to now.
+      sig { returns(T.nilable(String)) }
+      attr_reader :stats_to
+
+      sig { params(stats_to: String).void }
+      attr_writer :stats_to
+
+      # Only return campaigns with this status.
       sig do
         returns(T.nilable(WhopSDK::AdCampaignListParams::Status::OrSymbol))
       end
-      attr_accessor :status
+      attr_reader :status
+
+      sig do
+        params(status: WhopSDK::AdCampaignListParams::Status::OrSymbol).void
+      end
+      attr_writer :status
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :time_zone
+
+      sig { params(time_zone: String).void }
+      attr_writer :time_zone
 
       sig do
         params(
-          company_id: String,
-          after: T.nilable(String),
-          before: 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::AdCampaignListParams::Status::OrSymbol),
+          account_id: String,
+          after: String,
+          before: String,
+          created_after: String,
+          created_before: String,
+          direction: WhopSDK::AdCampaignListParams::Direction::OrSymbol,
+          first: Integer,
+          last: Integer,
+          order: WhopSDK::AdCampaignListParams::Order::OrSymbol,
+          query: String,
+          stats_from: String,
+          stats_to: String,
+          status: WhopSDK::AdCampaignListParams::Status::OrSymbol,
+          time_zone: String,
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The unique identifier of the company to list ad campaigns for.
-        company_id:,
-        # Returns the elements in the list that come after the specified cursor.
+        # The account the campaigns belong to. Defaults to the account-scoped key's own
+        # account.
+        account_id: nil,
+        # 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,
-        # Only return ad campaigns created after this timestamp.
+        # Only return campaigns created after this timestamp.
         created_after: nil,
-        # Only return ad campaigns created before this timestamp.
+        # Only return campaigns 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 campaigns to return.
         first: nil,
-        # Returns the last _n_ elements from the list.
+        # The number of campaigns to return from the end of the range.
         last: nil,
-        # Case-insensitive substring match against the campaign title.
+        # 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 campaigns by a title or ID substring.
         query: nil,
-        # The status of an ad campaign.
+        # 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 campaigns 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
@@ -89,15 +186,20 @@ module WhopSDK
       sig do
         override.returns(
           {
-            company_id: String,
-            after: T.nilable(String),
-            before: 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::AdCampaignListParams::Status::OrSymbol),
+            account_id: String,
+            after: String,
+            before: String,
+            created_after: String,
+            created_before: String,
+            direction: WhopSDK::AdCampaignListParams::Direction::OrSymbol,
+            first: Integer,
+            last: Integer,
+            order: WhopSDK::AdCampaignListParams::Order::OrSymbol,
+            query: String,
+            stats_from: String,
+            stats_to: String,
+            status: WhopSDK::AdCampaignListParams::Status::OrSymbol,
+            time_zone: String,
             request_options: WhopSDK::RequestOptions
           }
         )
@@ -105,7 +207,101 @@ module WhopSDK
       def to_hash
       end
 
-      # The status of an ad campaign.
+      # The sort direction. Defaults to desc.
+      module Direction
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::AdCampaignListParams::Direction)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(:asc, WhopSDK::AdCampaignListParams::Direction::TaggedSymbol)
+        DESC =
+          T.let(:desc, WhopSDK::AdCampaignListParams::Direction::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AdCampaignListParams::Direction::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # 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.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::AdCampaignListParams::Order) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(:created_at, WhopSDK::AdCampaignListParams::Order::TaggedSymbol)
+        UPDATED_AT =
+          T.let(:updated_at, WhopSDK::AdCampaignListParams::Order::TaggedSymbol)
+        SPEND =
+          T.let(:spend, WhopSDK::AdCampaignListParams::Order::TaggedSymbol)
+        IMPRESSIONS =
+          T.let(
+            :impressions,
+            WhopSDK::AdCampaignListParams::Order::TaggedSymbol
+          )
+        REACH =
+          T.let(:reach, WhopSDK::AdCampaignListParams::Order::TaggedSymbol)
+        CLICKS =
+          T.let(:clicks, WhopSDK::AdCampaignListParams::Order::TaggedSymbol)
+        UNIQUE_CLICKS =
+          T.let(
+            :unique_clicks,
+            WhopSDK::AdCampaignListParams::Order::TaggedSymbol
+          )
+        FREQUENCY =
+          T.let(:frequency, WhopSDK::AdCampaignListParams::Order::TaggedSymbol)
+        CLICK_THROUGH_RATE =
+          T.let(
+            :click_through_rate,
+            WhopSDK::AdCampaignListParams::Order::TaggedSymbol
+          )
+        RESULTS =
+          T.let(:results, WhopSDK::AdCampaignListParams::Order::TaggedSymbol)
+        COST_PER_MILLE =
+          T.let(
+            :cost_per_mille,
+            WhopSDK::AdCampaignListParams::Order::TaggedSymbol
+          )
+        COST_PER_CLICK =
+          T.let(
+            :cost_per_click,
+            WhopSDK::AdCampaignListParams::Order::TaggedSymbol
+          )
+        COST_PER_RESULT =
+          T.let(
+            :cost_per_result,
+            WhopSDK::AdCampaignListParams::Order::TaggedSymbol
+          )
+        RETURN_ON_AD_SPEND =
+          T.let(
+            :return_on_ad_spend,
+            WhopSDK::AdCampaignListParams::Order::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AdCampaignListParams::Order::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Only return campaigns with this status.
       module Status
         extend WhopSDK::Internal::Type::Enum
 
@@ -113,6 +309,8 @@ module WhopSDK
           T.type_alias { T.all(Symbol, WhopSDK::AdCampaignListParams::Status) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+        DRAFT =
+          T.let(:draft, WhopSDK::AdCampaignListParams::Status::TaggedSymbol)
         ACTIVE =
           T.let(:active, WhopSDK::AdCampaignListParams::Status::TaggedSymbol)
         PAUSED =
@@ -122,12 +320,6 @@ module WhopSDK
             :payment_failed,
             WhopSDK::AdCampaignListParams::Status::TaggedSymbol
           )
-        DRAFT =
-          T.let(:draft, WhopSDK::AdCampaignListParams::Status::TaggedSymbol)
-        IN_REVIEW =
-          T.let(:in_review, WhopSDK::AdCampaignListParams::Status::TaggedSymbol)
-        FLAGGED =
-          T.let(:flagged, WhopSDK::AdCampaignListParams::Status::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/whop_sdk/models/ad_campaign_retrieve_params.rbi

@@ -14,18 +14,57 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :id
 
+      # Start of the stats window.
+      sig { returns(T.nilable(String)) }
+      attr_reader :stats_from
+
+      sig { params(stats_from: String).void }
+      attr_writer :stats_from
+
+      # End of the stats window.
+      sig { returns(T.nilable(String)) }
+      attr_reader :stats_to
+
+      sig { params(stats_to: String).void }
+      attr_writer :stats_to
+
+      # IANA timezone the stats window is interpreted in. Defaults to UTC.
+      sig { returns(T.nilable(String)) }
+      attr_reader :time_zone
+
+      sig { params(time_zone: String).void }
+      attr_writer :time_zone
+
       sig do
         params(
           id: String,
+          stats_from: String,
+          stats_to: String,
+          time_zone: String,
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(
+        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
 
       sig do
         override.returns(
-          { id: String, request_options: WhopSDK::RequestOptions }
+          {
+            id: String,
+            stats_from: String,
+            stats_to: String,
+            time_zone: String,
+            request_options: WhopSDK::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/whop_sdk/models/ad_campaign_update_params.rbi

@@ -14,23 +14,120 @@ module WhopSDK
       sig { returns(String) }
       attr_accessor :id
 
-      # The campaign budget in dollars. The interpretation (daily or lifetime) follows
-      # the campaign's existing budget type.
+      # CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or
+      # maximum_target (bid cap). Switching to minimum_cost clears the cap amounts
+      # stored on the campaign's ad groups. CBO only.
+      sig do
+        returns(T.nilable(WhopSDK::AdCampaignUpdateParams::BidType::OrSymbol))
+      end
+      attr_reader :bid_type
+
+      sig do
+        params(
+          bid_type: WhopSDK::AdCampaignUpdateParams::BidType::OrSymbol
+        ).void
+      end
+      attr_writer :bid_type
+
+      # The campaign budget, in the account's currency. Interpreted as daily or lifetime
+      # per the campaign's existing budget type.
       sig { returns(T.nilable(Float)) }
-      attr_accessor :budget
+      attr_reader :budget_amount
+
+      sig { params(budget_amount: Float).void }
+      attr_writer :budget_amount
+
+      # Which level owns the budget — the campaign (CBO) or each ad group (ABO). Only
+      # changeable before the campaign is live on Meta; switching to ad_campaign
+      # requires budget_amount in the same request, and switching to ad_group clears the
+      # campaign budget.
+      sig do
+        returns(
+          T.nilable(
+            WhopSDK::AdCampaignUpdateParams::BudgetOptimization::OrSymbol
+          )
+        )
+      end
+      attr_reader :budget_optimization
+
+      sig do
+        params(
+          budget_optimization:
+            WhopSDK::AdCampaignUpdateParams::BudgetOptimization::OrSymbol
+        ).void
+      end
+      attr_writer :budget_optimization
+
+      # Campaign schedule end (ISO 8601). CBO only.
+      sig { returns(T.nilable(String)) }
+      attr_reader :ends_at
+
+      sig { params(ends_at: String).void }
+      attr_writer :ends_at
+
+      # Campaign schedule start (ISO 8601). CBO only.
+      sig { returns(T.nilable(String)) }
+      attr_reader :starts_at
+
+      sig { params(starts_at: String).void }
+      attr_writer :starts_at
+
+      # Set to active to launch a draft campaign (moderates and pushes it live).
+      # Live-campaign pause and resume use the pause and unpause actions.
+      sig do
+        returns(T.nilable(WhopSDK::AdCampaignUpdateParams::Status::OrSymbol))
+      end
+      attr_reader :status
+
+      sig do
+        params(status: WhopSDK::AdCampaignUpdateParams::Status::OrSymbol).void
+      end
+      attr_writer :status
+
+      # The name of the campaign.
+      sig { returns(T.nilable(String)) }
+      attr_reader :title
+
+      sig { params(title: String).void }
+      attr_writer :title
 
       sig do
         params(
           id: String,
-          budget: T.nilable(Float),
+          bid_type: WhopSDK::AdCampaignUpdateParams::BidType::OrSymbol,
+          budget_amount: Float,
+          budget_optimization:
+            WhopSDK::AdCampaignUpdateParams::BudgetOptimization::OrSymbol,
+          ends_at: String,
+          starts_at: String,
+          status: WhopSDK::AdCampaignUpdateParams::Status::OrSymbol,
+          title: String,
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
-        # The campaign budget in dollars. The interpretation (daily or lifetime) follows
-        # the campaign's existing budget type.
-        budget: nil,
+        # CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or
+        # maximum_target (bid cap). Switching to minimum_cost clears the cap amounts
+        # stored on the campaign's ad groups. CBO only.
+        bid_type: nil,
+        # The campaign budget, in the account's currency. Interpreted as daily or lifetime
+        # per the campaign's existing budget type.
+        budget_amount: nil,
+        # Which level owns the budget — the campaign (CBO) or each ad group (ABO). Only
+        # changeable before the campaign is live on Meta; switching to ad_campaign
+        # requires budget_amount in the same request, and switching to ad_group clears the
+        # campaign budget.
+        budget_optimization: nil,
+        # Campaign schedule end (ISO 8601). CBO only.
+        ends_at: nil,
+        # Campaign schedule start (ISO 8601). CBO only.
+        starts_at: nil,
+        # Set to active to launch a draft campaign (moderates and pushes it live).
+        # Live-campaign pause and resume use the pause and unpause actions.
+        status: nil,
+        # The name of the campaign.
+        title: nil,
         request_options: {}
       )
       end
@@ -39,13 +136,115 @@ module WhopSDK
         override.returns(
           {
             id: String,
-            budget: T.nilable(Float),
+            bid_type: WhopSDK::AdCampaignUpdateParams::BidType::OrSymbol,
+            budget_amount: Float,
+            budget_optimization:
+              WhopSDK::AdCampaignUpdateParams::BudgetOptimization::OrSymbol,
+            ends_at: String,
+            starts_at: String,
+            status: WhopSDK::AdCampaignUpdateParams::Status::OrSymbol,
+            title: String,
             request_options: WhopSDK::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or
+      # maximum_target (bid cap). Switching to minimum_cost clears the cap amounts
+      # stored on the campaign's ad groups. CBO only.
+      module BidType
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::AdCampaignUpdateParams::BidType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        MINIMUM_COST =
+          T.let(
+            :minimum_cost,
+            WhopSDK::AdCampaignUpdateParams::BidType::TaggedSymbol
+          )
+        AVERAGE_TARGET =
+          T.let(
+            :average_target,
+            WhopSDK::AdCampaignUpdateParams::BidType::TaggedSymbol
+          )
+        MAXIMUM_TARGET =
+          T.let(
+            :maximum_target,
+            WhopSDK::AdCampaignUpdateParams::BidType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AdCampaignUpdateParams::BidType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Which level owns the budget — the campaign (CBO) or each ad group (ABO). Only
+      # changeable before the campaign is live on Meta; switching to ad_campaign
+      # requires budget_amount in the same request, and switching to ad_group clears the
+      # campaign budget.
+      module BudgetOptimization
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::AdCampaignUpdateParams::BudgetOptimization)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        AD_CAMPAIGN =
+          T.let(
+            :ad_campaign,
+            WhopSDK::AdCampaignUpdateParams::BudgetOptimization::TaggedSymbol
+          )
+        AD_GROUP =
+          T.let(
+            :ad_group,
+            WhopSDK::AdCampaignUpdateParams::BudgetOptimization::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              WhopSDK::AdCampaignUpdateParams::BudgetOptimization::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Set to active to launch a draft campaign (moderates and pushes it live).
+      # Live-campaign pause and resume use the pause and unpause actions.
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::AdCampaignUpdateParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, WhopSDK::AdCampaignUpdateParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AdCampaignUpdateParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end