whop_sdk 0.0.39 → 0.0.40

data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi

@@ -19,29 +19,41 @@ module WhopSDK
       sig { returns(Time) }
       attr_accessor :to
 
-      # The unique identifier of an ad campaign. Mutually exclusive with `adGroupId` and
-      # `adId`.
+      # The unique identifier of an ad campaign. Mutually exclusive with `companyId`,
+      # `adGroupId`, and `adId`.
       sig { returns(T.nilable(String)) }
       attr_accessor :ad_campaign_id
 
-      # The unique identifier of an ad group. Mutually exclusive with `adCampaignId` and
-      # `adId`.
+      # The unique identifier of an ad group. Mutually exclusive with `companyId`,
+      # `adCampaignId`, and `adId`.
       sig { returns(T.nilable(String)) }
       attr_accessor :ad_group_id
 
-      # The unique identifier of an ad. Mutually exclusive with `adCampaignId` and
-      # `adGroupId`.
+      # The unique identifier of an ad. Mutually exclusive with `companyId`,
+      # `adCampaignId`, and `adGroupId`.
       sig { returns(T.nilable(String)) }
       attr_accessor :ad_id
 
+      # Entity level to group an ad report by.
+      sig do
+        returns(T.nilable(WhopSDK::AdReportRetrieveParams::Breakdown::OrSymbol))
+      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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :company_id
+
       # ISO 4217 currency code to report `spend` in. Defaults to the company's ads
       # reporting currency.
       sig { returns(T.nilable(String)) }
       attr_accessor :currency
 
-      # When true, includes a per-day breakdown alongside the summary.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_accessor :include_daily
+      # Bucket size for external ad stat rows.
+      sig { returns(T.nilable(WhopSDK::Granularities::OrSymbol)) }
+      attr_accessor :granularity
 
       sig do
         params(
@@ -50,8 +62,11 @@ module WhopSDK
           ad_campaign_id: T.nilable(String),
           ad_group_id: T.nilable(String),
           ad_id: T.nilable(String),
+          breakdown:
+            T.nilable(WhopSDK::AdReportRetrieveParams::Breakdown::OrSymbol),
+          company_id: T.nilable(String),
           currency: T.nilable(String),
-          include_daily: T.nilable(T::Boolean),
+          granularity: T.nilable(WhopSDK::Granularities::OrSymbol),
           request_options: WhopSDK::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -60,20 +75,26 @@ module WhopSDK
         from:,
         # Inclusive end of the reporting window.
         to:,
-        # The unique identifier of an ad campaign. Mutually exclusive with `adGroupId` and
-        # `adId`.
+        # 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 `adCampaignId` and
-        # `adId`.
+        # 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 `adCampaignId` and
-        # `adGroupId`.
+        # The unique identifier of an ad. Mutually exclusive with `companyId`,
+        # `adCampaignId`, and `adGroupId`.
         ad_id: 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.
+        company_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,
+        # Bucket size for external ad stat rows.
+        granularity: nil,
         request_options: {}
       )
       end
@@ -86,14 +107,49 @@ module WhopSDK
             ad_campaign_id: T.nilable(String),
             ad_group_id: T.nilable(String),
             ad_id: T.nilable(String),
+            breakdown:
+              T.nilable(WhopSDK::AdReportRetrieveParams::Breakdown::OrSymbol),
+            company_id: T.nilable(String),
             currency: T.nilable(String),
-            include_daily: T.nilable(T::Boolean),
+            granularity: T.nilable(WhopSDK::Granularities::OrSymbol),
             request_options: WhopSDK::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # Entity level to group an ad report by.
+      module Breakdown
+        extend WhopSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, WhopSDK::AdReportRetrieveParams::Breakdown)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CAMPAIGN =
+          T.let(
+            :campaign,
+            WhopSDK::AdReportRetrieveParams::Breakdown::TaggedSymbol
+          )
+        AD_GROUP =
+          T.let(
+            :ad_group,
+            WhopSDK::AdReportRetrieveParams::Breakdown::TaggedSymbol
+          )
+        AD =
+          T.let(:ad, WhopSDK::AdReportRetrieveParams::Breakdown::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[WhopSDK::AdReportRetrieveParams::Breakdown::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end