whop_sdk 0.0.40 → 0.0.41

data/rbi/whop_sdk/models/ad_list_params.rbi

@@ -11,132 +11,182 @@ module WhopSDK
           T.any(WhopSDK::AdListParams, WhopSDK::Internal::AnyHash)
         end
 
-      # 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.
       sig { returns(T.nilable(String)) }
-      attr_accessor :ad_group_id
+      attr_reader :account_id
 
-      # Returns the elements in the list that come after the specified cursor.
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # Only return ads in this ad campaign.
       sig { returns(T.nilable(String)) }
-      attr_accessor :after
+      attr_reader :ad_campaign_id
+
+      sig { params(ad_campaign_id: String).void }
+      attr_writer :ad_campaign_id
 
-      # Returns the elements in the list that come before the specified cursor.
+      # Only return ads in this ad group.
       sig { returns(T.nilable(String)) }
-      attr_accessor :before
+      attr_reader :ad_group_id
+
+      sig { params(ad_group_id: String).void }
+      attr_writer :ad_group_id
 
-      # Filter by campaign. Provide exactly one of ad_group_id, campaign_id, or
-      # company_id.
+      # Cursor to fetch the page after (from page_info.end_cursor).
       sig { returns(T.nilable(String)) }
-      attr_accessor :campaign_id
+      attr_reader :after
 
-      # Filter by company. Provide exactly one of ad_group_id, campaign_id, or
-      # company_id.
+      sig { params(after: String).void }
+      attr_writer :after
+
+      # Cursor to fetch the page before (from page_info.start_cursor).
       sig { returns(T.nilable(String)) }
-      attr_accessor :company_id
+      attr_reader :before
+
+      sig { params(before: String).void }
+      attr_writer :before
 
       # Only return ads created after this timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_accessor :created_after
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_after
+
+      sig { params(created_after: String).void }
+      attr_writer :created_after
 
       # Only return ads created before this timestamp.
-      sig { returns(T.nilable(Time)) }
-      attr_accessor :created_before
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_before
+
+      sig { params(created_before: String).void }
+      attr_writer :created_before
 
-      # Returns the first _n_ elements from the list.
+      # The sort direction. Defaults to desc.
+      sig { returns(T.nilable(WhopSDK::AdListParams::Direction::OrSymbol)) }
+      attr_reader :direction
+
+      sig { params(direction: WhopSDK::AdListParams::Direction::OrSymbol).void }
+      attr_writer :direction
+
+      # The number of ads to return.
       sig { returns(T.nilable(Integer)) }
-      attr_accessor :first
+      attr_reader :first
 
-      # When false, excludes paused ads so pagination matches the dashboard's
-      # hide-paused toggle.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_accessor :include_paused
+      sig { params(first: Integer).void }
+      attr_writer :first
 
-      # Returns the last _n_ elements from the list.
+      # The number of ads 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
 
-      # Columns that the listAds query can sort by.
-      sig { returns(T.nilable(WhopSDK::AdListParams::OrderBy::OrSymbol)) }
-      attr_accessor :order_by
+      # 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::AdListParams::Order::OrSymbol)) }
+      attr_reader :order
 
-      # The direction of the sort.
-      sig { returns(T.nilable(WhopSDK::Direction::OrSymbol)) }
-      attr_accessor :order_direction
+      sig { params(order: WhopSDK::AdListParams::Order::OrSymbol).void }
+      attr_writer :order
 
-      # Case-insensitive substring match against the ad title or tag.
+      # Filter ads by a title or ID substring.
       sig { returns(T.nilable(String)) }
-      attr_accessor :query
+      attr_reader :query
 
-      # Start of the stats date range used when order_by is a stats column.
-      sig { returns(T.nilable(Time)) }
-      attr_accessor :stats_from
+      sig { params(query: String).void }
+      attr_writer :query
 
-      # End of the stats date range used when order_by is a stats column.
-      sig { returns(T.nilable(Time)) }
-      attr_accessor :stats_to
+      # 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 ads with this status.
+      sig { returns(T.nilable(WhopSDK::AdListParams::Status::OrSymbol)) }
+      attr_reader :status
 
-      # The status of an external ad.
-      sig { returns(T.nilable(WhopSDK::ExternalAdStatus::OrSymbol)) }
-      attr_accessor :status
+      sig { params(status: WhopSDK::AdListParams::Status::OrSymbol).void }
+      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(
-          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),
-          include_paused: T.nilable(T::Boolean),
-          last: T.nilable(Integer),
-          order_by: T.nilable(WhopSDK::AdListParams::OrderBy::OrSymbol),
-          order_direction: T.nilable(WhopSDK::Direction::OrSymbol),
-          query: T.nilable(String),
-          stats_from: T.nilable(Time),
-          stats_to: T.nilable(Time),
-          status: T.nilable(WhopSDK::ExternalAdStatus::OrSymbol),
+          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(T.attached_class)
       end
       def self.new(
-        # 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,
-        # When false, excludes paused ads so pagination matches the dashboard's
-        # hide-paused toggle.
-        include_paused: nil,
-        # Returns the last _n_ elements from the list.
+        # The number of ads to return from the end of the range.
         last: nil,
-        # Columns that the listAds query can sort by.
-        order_by: nil,
-        # The direction of the sort.
-        order_direction: nil,
-        # Case-insensitive substring match against the ad title or tag.
+        # 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 date range used when order_by is a stats column.
+        # Start of the stats window. Defaults to all-time.
         stats_from: nil,
-        # End of the stats date range used when order_by is a stats column.
+        # End of the stats window. Defaults to now.
         stats_to: nil,
-        # The status of an external ad.
+        # 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
@@ -144,22 +194,22 @@ module WhopSDK
       sig do
         override.returns(
           {
-            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),
-            include_paused: T.nilable(T::Boolean),
-            last: T.nilable(Integer),
-            order_by: T.nilable(WhopSDK::AdListParams::OrderBy::OrSymbol),
-            order_direction: T.nilable(WhopSDK::Direction::OrSymbol),
-            query: T.nilable(String),
-            stats_from: T.nilable(Time),
-            stats_to: T.nilable(Time),
-            status: T.nilable(WhopSDK::ExternalAdStatus::OrSymbol),
+            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
           }
         )
@@ -167,20 +217,86 @@ module WhopSDK
       def to_hash
       end
 
-      # Columns that the listAds query can sort by.
-      module OrderBy
+      # The sort direction. Defaults to desc.
+      module Direction
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, WhopSDK::AdListParams::Direction) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC = T.let(:asc, WhopSDK::AdListParams::Direction::TaggedSymbol)
+        DESC = T.let(:desc, WhopSDK::AdListParams::Direction::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AdListParams::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::AdListParams::Order) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(:created_at, WhopSDK::AdListParams::Order::TaggedSymbol)
+        UPDATED_AT =
+          T.let(:updated_at, WhopSDK::AdListParams::Order::TaggedSymbol)
+        SPEND = T.let(:spend, WhopSDK::AdListParams::Order::TaggedSymbol)
+        IMPRESSIONS =
+          T.let(:impressions, WhopSDK::AdListParams::Order::TaggedSymbol)
+        REACH = T.let(:reach, WhopSDK::AdListParams::Order::TaggedSymbol)
+        CLICKS = T.let(:clicks, WhopSDK::AdListParams::Order::TaggedSymbol)
+        UNIQUE_CLICKS =
+          T.let(:unique_clicks, WhopSDK::AdListParams::Order::TaggedSymbol)
+        FREQUENCY =
+          T.let(:frequency, WhopSDK::AdListParams::Order::TaggedSymbol)
+        CLICK_THROUGH_RATE =
+          T.let(:click_through_rate, WhopSDK::AdListParams::Order::TaggedSymbol)
+        RESULTS = T.let(:results, WhopSDK::AdListParams::Order::TaggedSymbol)
+        COST_PER_MILLE =
+          T.let(:cost_per_mille, WhopSDK::AdListParams::Order::TaggedSymbol)
+        COST_PER_CLICK =
+          T.let(:cost_per_click, WhopSDK::AdListParams::Order::TaggedSymbol)
+        COST_PER_RESULT =
+          T.let(:cost_per_result, WhopSDK::AdListParams::Order::TaggedSymbol)
+        RETURN_ON_AD_SPEND =
+          T.let(:return_on_ad_spend, WhopSDK::AdListParams::Order::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[WhopSDK::AdListParams::Order::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      # Only return ads with this status.
+      module Status
         extend WhopSDK::Internal::Type::Enum
 
         TaggedSymbol =
-          T.type_alias { T.all(Symbol, WhopSDK::AdListParams::OrderBy) }
+          T.type_alias { T.all(Symbol, WhopSDK::AdListParams::Status) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        SPEND = T.let(:spend, WhopSDK::AdListParams::OrderBy::TaggedSymbol)
-        ROAS = T.let(:roas, WhopSDK::AdListParams::OrderBy::TaggedSymbol)
+        ACTIVE = T.let(:active, WhopSDK::AdListParams::Status::TaggedSymbol)
+        PAUSED = T.let(:paused, WhopSDK::AdListParams::Status::TaggedSymbol)
+        IN_REVIEW =
+          T.let(:in_review, WhopSDK::AdListParams::Status::TaggedSymbol)
+        REJECTED = T.let(:rejected, WhopSDK::AdListParams::Status::TaggedSymbol)
 
         sig do
           override.returns(
-            T::Array[WhopSDK::AdListParams::OrderBy::TaggedSymbol]
+            T::Array[WhopSDK::AdListParams::Status::TaggedSymbol]
           )
         end
         def self.values

data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi

@@ -19,20 +19,20 @@ module WhopSDK
       sig { returns(Time) }
       attr_accessor :to
 
-      # The unique identifier of an ad campaign. Mutually exclusive with `companyId`,
-      # `adGroupId`, and `adId`.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :ad_campaign_id
+      # Scope the report to these ad campaigns (max 100); stats are summed across them.
+      # Mutually exclusive with `companyId`, `adGroupIds`, and `adIds`.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :ad_campaign_ids
 
-      # The unique identifier of an ad group. Mutually exclusive with `companyId`,
-      # `adCampaignId`, and `adId`.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :ad_group_id
+      # Scope the report to these ad groups (max 100); stats are summed across them.
+      # Mutually exclusive with `companyId`, `adCampaignIds`, and `adIds`.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :ad_group_ids
 
-      # The unique identifier of an ad. Mutually exclusive with `companyId`,
-      # `adCampaignId`, and `adGroupId`.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :ad_id
+      # Scope the report to these ads (max 100); stats are summed across them. Mutually
+      # exclusive with `companyId`, `adCampaignIds`, and `adGroupIds`.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :ad_ids
 
       # Entity level to group an ad report by.
       sig do
@@ -40,9 +40,9 @@ module WhopSDK
       end
       attr_accessor :breakdown
 
-      # The unique identifier of a company. Mutually exclusive with `adCampaignId`,
-      # `adGroupId`, and `adId`. Use with `breakdown` to fan out across every campaign,
-      # ad group, or ad in the company without paging.
+      # The unique identifier of a company. Mutually exclusive with `adCampaignIds`,
+      # `adGroupIds`, and `adIds`. Use with `breakdown` to fan out across every
+      # campaign, ad group, or ad in the company without paging.
       sig { returns(T.nilable(String)) }
       attr_accessor :company_id
 
@@ -59,9 +59,9 @@ module WhopSDK
         params(
           from: Time,
           to: Time,
-          ad_campaign_id: T.nilable(String),
-          ad_group_id: T.nilable(String),
-          ad_id: T.nilable(String),
+          ad_campaign_ids: T.nilable(T::Array[String]),
+          ad_group_ids: T.nilable(T::Array[String]),
+          ad_ids: T.nilable(T::Array[String]),
           breakdown:
             T.nilable(WhopSDK::AdReportRetrieveParams::Breakdown::OrSymbol),
           company_id: T.nilable(String),
@@ -75,20 +75,20 @@ module WhopSDK
         from:,
         # Inclusive end of the reporting window.
         to:,
-        # The unique identifier of an ad campaign. Mutually exclusive with `companyId`,
-        # `adGroupId`, and `adId`.
-        ad_campaign_id: nil,
-        # The unique identifier of an ad group. Mutually exclusive with `companyId`,
-        # `adCampaignId`, and `adId`.
-        ad_group_id: nil,
-        # The unique identifier of an ad. Mutually exclusive with `companyId`,
-        # `adCampaignId`, and `adGroupId`.
-        ad_id: nil,
+        # Scope the report to these ad campaigns (max 100); stats are summed across them.
+        # Mutually exclusive with `companyId`, `adGroupIds`, and `adIds`.
+        ad_campaign_ids: nil,
+        # Scope the report to these ad groups (max 100); stats are summed across them.
+        # Mutually exclusive with `companyId`, `adCampaignIds`, and `adIds`.
+        ad_group_ids: nil,
+        # Scope the report to these ads (max 100); stats are summed across them. Mutually
+        # exclusive with `companyId`, `adCampaignIds`, and `adGroupIds`.
+        ad_ids: nil,
         # Entity level to group an ad report by.
         breakdown: nil,
-        # The unique identifier of a company. Mutually exclusive with `adCampaignId`,
-        # `adGroupId`, and `adId`. Use with `breakdown` to fan out across every campaign,
-        # ad group, or ad in the company without paging.
+        # The unique identifier of a company. Mutually exclusive with `adCampaignIds`,
+        # `adGroupIds`, and `adIds`. Use with `breakdown` to fan out across every
+        # campaign, ad group, or ad in the company without paging.
         company_id: nil,
         # ISO 4217 currency code to report `spend` in. Defaults to the company's ads
         # reporting currency.
@@ -104,9 +104,9 @@ module WhopSDK
           {
             from: Time,
             to: Time,
-            ad_campaign_id: T.nilable(String),
-            ad_group_id: T.nilable(String),
-            ad_id: T.nilable(String),
+            ad_campaign_ids: T.nilable(T::Array[String]),
+            ad_group_ids: T.nilable(T::Array[String]),
+            ad_ids: T.nilable(T::Array[String]),
             breakdown:
               T.nilable(WhopSDK::AdReportRetrieveParams::Breakdown::OrSymbol),
             company_id: T.nilable(String),