growsurf-ruby 1.0.0 → 1.1.0

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi

@@ -32,6 +32,36 @@ module GrowsurfRuby
       sig { params(end_date: Integer).void }
       attr_writer :end_date
 
+      # Comma-separated list of optional enrichments (opt-in to keep the default response
+      # lean): `previousPeriod` adds totals for the equal-length window immediately before
+      # the requested one; `statusCounts` adds reward (and, for affiliate programs,
+      # affiliate/commission/payout) status breakdowns; `rates` adds derived referral
+      # rates.
+      sig { returns(T.nilable(String)) }
+      attr_reader :include
+
+      sig { params(include: String).void }
+      attr_writer :include
+
+      # When set to `day`, `week`, or `month`, the response also includes a `series` array
+      # with per-period totals. Defaults to `total` (no series).
+      sig do
+        returns(
+          T.nilable(
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol
+          )
+        )
+      end
+      attr_reader :interval
+
+      sig do
+        params(
+          interval:
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol
+        ).void
+      end
+      attr_writer :interval
+
       # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
       # Required if `days` is not set.
       sig { returns(T.nilable(Integer)) }
@@ -45,6 +75,9 @@ module GrowsurfRuby
           id: String,
           days: Integer,
           end_date: Integer,
+          include: String,
+          interval:
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
           start_date: Integer,
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -56,6 +89,15 @@ module GrowsurfRuby
         # End date of the analytics timeframe as a Unix timestamp in milliseconds.
         # Required if `days` is not set.
         end_date: nil,
+        # Comma-separated list of optional enrichments (opt-in to keep the default response
+        # lean): `previousPeriod` adds totals for the equal-length window immediately before
+        # the requested one; `statusCounts` adds reward (and, for affiliate programs,
+        # affiliate/commission/payout) status breakdowns; `rates` adds derived referral
+        # rates.
+        include: nil,
+        # When set to `day`, `week`, or `month`, the response also includes a `series` array
+        # with per-period totals. Defaults to `total` (no series).
+        interval: nil,
         # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
         # Required if `days` is not set.
         start_date: nil,
@@ -69,6 +111,9 @@ module GrowsurfRuby
             id: String,
             days: Integer,
             end_date: Integer,
+            include: String,
+            interval:
+              GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
             start_date: Integer,
             request_options: GrowsurfRuby::RequestOptions
           }
@@ -76,6 +121,52 @@ module GrowsurfRuby
       end
       def to_hash
       end
+
+      # When set to `day`, `week`, or `month`, the response also includes a `series` array
+      # with per-period totals. Defaults to `total` (no series).
+      module Interval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DAY =
+          T.let(
+            :day,
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+          )
+        WEEK =
+          T.let(
+            :week,
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :month,
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+          )
+        TOTAL =
+          T.let(
+            :total,
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end