growsurf-ruby 1.3.0 → 1.5.0

data/rbi/growsurf_ruby/models/campaign_engagement_analytics.rbi

@@ -0,0 +1,369 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignEngagementAnalytics < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::Models::CampaignEngagementAnalytics,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :coverage_start_at
+
+      sig { returns(Integer) }
+      attr_accessor :metric_contract_version
+
+      sig { returns(ProgramType::OrSymbol) }
+      attr_accessor :program_type
+
+      sig { returns(String) }
+      attr_accessor :timezone
+
+      sig { returns(Interval::OrSymbol) }
+      attr_accessor :interval
+
+      sig { returns(PlatformFilter) }
+      attr_accessor :platform
+
+      sig { returns(Period) }
+      attr_accessor :period
+
+      sig { returns(GrowsurfRuby::Models::AnalyticsAvailability::OrSymbol) }
+      attr_accessor :state
+
+      sig do
+        returns(
+          T.nilable(GrowsurfRuby::Models::AnalyticsUnavailableReason::OrSymbol)
+        )
+      end
+      attr_accessor :reason
+
+      sig { returns(Totals) }
+      attr_accessor :totals
+
+      sig { returns(PreviousPeriod) }
+      attr_accessor :previous_period
+
+      sig { returns(Comparison) }
+      attr_accessor :comparison
+
+      sig { returns(T::Array[SeriesPoint]) }
+      attr_accessor :series
+
+      sig { returns(Breakdowns) }
+      attr_accessor :breakdowns
+
+      sig { params(kwargs: T.untyped).returns(T.attached_class) }
+      def self.new(**kwargs)
+      end
+
+      module ProgramType
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        REFERRAL = T.let(:REFERRAL, Symbol)
+        AFFILIATE = T.let(:AFFILIATE, Symbol)
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+
+      module Interval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        DAY = T.let(:day, Symbol)
+        WEEK = T.let(:week, Symbol)
+        MONTH = T.let(:month, Symbol)
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+
+      module Platform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        ALL = T.let(:ALL, Symbol)
+        WEB = T.let(:WEB, Symbol)
+        IOS = T.let(:IOS, Symbol)
+        ANDROID = T.let(:ANDROID, Symbol)
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+
+      module BreakdownPlatform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        WEB = T.let(:WEB, Symbol)
+        IOS = T.let(:IOS, Symbol)
+        ANDROID = T.let(:ANDROID, Symbol)
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+
+      module PortalSource
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        DEFAULT_LAUNCHER = T.let(:DEFAULT_LAUNCHER, Symbol)
+        SDK_OPEN = T.let(:SDK_OPEN, Symbol)
+        CSS_CLASS = T.let(:CSS_CLASS, Symbol)
+        EMBEDDABLE_ELEMENT = T.let(:EMBEDDABLE_ELEMENT, Symbol)
+        HOSTED_PORTAL = T.let(:HOSTED_PORTAL, Symbol)
+        NATIVE_WINDOW = T.let(:NATIVE_WINDOW, Symbol)
+        UNKNOWN = T.let(:UNKNOWN, Symbol)
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+
+      class Metric < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Metric, GrowsurfRuby::Internal::AnyHash) }
+        sig { returns(GrowsurfRuby::Models::AnalyticsAvailability::OrSymbol) }
+        attr_accessor :state
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :value
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::AnalyticsUnavailableReason::OrSymbol
+            )
+          )
+        end
+        attr_accessor :reason
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :delta
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class Totals < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Totals, GrowsurfRuby::Internal::AnyHash) }
+        sig { returns(Metric) }
+        attr_accessor :active_participants,
+                      :sharing_participants,
+                      :sharing_rate,
+                      :repeat_active_participants,
+                      :repeat_sharing_participants,
+                      :retained_active_participants,
+                      :portal_views,
+                      :share_actions
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class Period < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Period, GrowsurfRuby::Internal::AnyHash) }
+        sig { returns(Integer) }
+        attr_accessor :from, :to, :previous_from, :previous_to
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :effective_from
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class PlatformFilter < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(PlatformFilter, GrowsurfRuby::Internal::AnyHash)
+          end
+        sig { returns(Platform::OrSymbol) }
+        attr_accessor :requested, :applied
+
+        sig { returns(GrowsurfRuby::Models::AnalyticsAvailability::OrSymbol) }
+        attr_accessor :state
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class PreviousPeriod < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(PreviousPeriod, GrowsurfRuby::Internal::AnyHash)
+          end
+        sig { returns(GrowsurfRuby::Models::AnalyticsAvailability::OrSymbol) }
+        attr_accessor :state
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::AnalyticsUnavailableReason::OrSymbol
+            )
+          )
+        end
+        attr_accessor :reason
+
+        sig { returns(T.nilable(Totals)) }
+        attr_accessor :totals
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class ComparisonMetrics < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ComparisonMetrics, GrowsurfRuby::Internal::AnyHash)
+          end
+        sig { returns(T.nilable(Metric)) }
+        attr_accessor :active_participants,
+                      :sharing_participants,
+                      :repeat_active_participants,
+                      :repeat_sharing_participants,
+                      :portal_views,
+                      :share_actions
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class Comparison < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias { T.any(Comparison, GrowsurfRuby::Internal::AnyHash) }
+        sig { returns(GrowsurfRuby::Models::AnalyticsAvailability::OrSymbol) }
+        attr_accessor :state
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::AnalyticsUnavailableReason::OrSymbol
+            )
+          )
+        end
+        attr_accessor :reason
+
+        sig { returns(T.nilable(ComparisonMetrics)) }
+        attr_accessor :metrics
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class SeriesPoint < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias { T.any(SeriesPoint, GrowsurfRuby::Internal::AnyHash) }
+        sig { returns(Integer) }
+        attr_accessor :from,
+                      :to,
+                      :active_participants,
+                      :sharing_participants,
+                      :portal_views,
+                      :share_actions
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class PlatformBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(PlatformBreakdown, GrowsurfRuby::Internal::AnyHash)
+          end
+        sig { returns(BreakdownPlatform::OrSymbol) }
+        attr_accessor :key
+
+        sig { returns(Integer) }
+        attr_accessor :active_participants,
+                      :sharing_participants,
+                      :portal_views,
+                      :share_actions
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class PortalSourceBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(PortalSourceBreakdown, GrowsurfRuby::Internal::AnyHash)
+          end
+        sig { returns(PortalSource::OrSymbol) }
+        attr_accessor :key
+
+        sig { returns(Integer) }
+        attr_accessor :active_participants, :portal_views
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class ShareChannelBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ShareChannelBreakdown, GrowsurfRuby::Internal::AnyHash)
+          end
+        sig { returns(String) }
+        attr_accessor :key
+
+        sig { returns(Integer) }
+        attr_accessor :sharing_participants, :share_actions
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class FirstShareChannelBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(FirstShareChannelBreakdown, GrowsurfRuby::Internal::AnyHash)
+          end
+        sig { returns(String) }
+        attr_accessor :key
+
+        sig { returns(Integer) }
+        attr_accessor :sharing_participants
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+
+      class Breakdowns < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias { T.any(Breakdowns, GrowsurfRuby::Internal::AnyHash) }
+        sig { returns(T::Array[PlatformBreakdown]) }
+        attr_accessor :platforms
+
+        sig { returns(T::Array[PortalSourceBreakdown]) }
+        attr_accessor :portal_view_sources
+
+        sig { returns(T::Array[ShareChannelBreakdown]) }
+        attr_accessor :share_channels
+
+        sig { returns(T::Array[FirstShareChannelBreakdown]) }
+        attr_accessor :first_share_channels
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_retrieve_activation_analytics_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignRetrieveActivationAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignRetrieveActivationAnalyticsParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :cohort_from, :cohort_to
+
+      sig { returns(T.nilable(CohortInterval::OrSymbol)) }
+      attr_accessor :cohort_interval
+
+      sig { returns(T.nilable(ObservationWindowDays::OrInteger)) }
+      attr_accessor :observation_window_days
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :timezone
+
+      sig { params(kwargs: T.untyped).returns(T.attached_class) }
+      def self.new(**kwargs)
+      end
+
+      module CohortInterval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        DAY = T.let(:day, Symbol)
+        WEEK = T.let(:week, Symbol)
+        MONTH = T.let(:month, Symbol)
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
+
+      module ObservationWindowDays
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        OrInteger = T.type_alias { Integer }
+        SEVEN = T.let(7, Integer)
+        THIRTY = T.let(30, Integer)
+        sig { override.returns(T::Array[Integer]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi

@@ -46,7 +46,9 @@ module GrowsurfRuby
       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).
+      # with per-period totals and uses the same bucket size for `engagement.series`.
+      # Defaults to `total` (no legacy series); `engagement.series` uses daily buckets when
+      # `interval` is `total` or omitted.
       sig do
         returns(
           T.nilable(
@@ -64,6 +66,23 @@ module GrowsurfRuby
       end
       attr_writer :interval
 
+      sig do
+        returns(
+          T.nilable(
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Platform::OrSymbol
+          )
+        )
+      end
+      attr_reader :platform
+
+      sig do
+        params(
+          platform:
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Platform::OrSymbol
+        ).void
+      end
+      attr_writer :platform
+
       # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
       # Required if `days` is not set.
       sig { returns(T.nilable(Integer)) }
@@ -72,6 +91,12 @@ module GrowsurfRuby
       sig { params(start_date: Integer).void }
       attr_writer :start_date
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :timezone
+
+      sig { params(timezone: String).void }
+      attr_writer :timezone
+
       sig do
         params(
           id: String,
@@ -80,7 +105,10 @@ module GrowsurfRuby
           include: String,
           interval:
             GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
+          platform:
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams::Platform::OrSymbol,
           start_date: Integer,
+          timezone: String,
           request_options: GrowsurfRuby::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -101,11 +129,17 @@ module GrowsurfRuby
         # windows.
         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).
+        # with per-period totals and uses the same bucket size for `engagement.series`.
+        # Defaults to `total` (no legacy series); `engagement.series` uses daily buckets when
+        # `interval` is `total` or omitted.
         interval: nil,
+        # Participant platform used for `engagement`. Defaults to `ALL`.
+        platform: nil,
         # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
         # Required if `days` is not set.
         start_date: nil,
+        # IANA timezone used for engagement periods and buckets. Defaults to `UTC`.
+        timezone: nil,
         request_options: {}
       )
       end
@@ -119,7 +153,10 @@ module GrowsurfRuby
             include: String,
             interval:
               GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
+            platform:
+              GrowsurfRuby::CampaignRetrieveAnalyticsParams::Platform::OrSymbol,
             start_date: Integer,
+            timezone: String,
             request_options: GrowsurfRuby::RequestOptions
           }
         )
@@ -128,7 +165,9 @@ module GrowsurfRuby
       end
 
       # When set to `day`, `week`, or `month`, the response also includes a `series` array
-      # with per-period totals. Defaults to `total` (no series).
+      # with per-period totals and uses the same bucket size for `engagement.series`.
+      # Defaults to `total` (no legacy series); `engagement.series` uses daily buckets when
+      # `interval` is `total` or omitted.
       module Interval
         extend GrowsurfRuby::Internal::Type::Enum
 
@@ -172,6 +211,20 @@ module GrowsurfRuby
         def self.values
         end
       end
+
+      module Platform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        ALL = T.let(:ALL, Symbol)
+        WEB = T.let(:WEB, Symbol)
+        IOS = T.let(:IOS, Symbol)
+        ANDROID = T.let(:ANDROID, Symbol)
+
+        sig { override.returns(T::Array[Symbol]) }
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi

@@ -32,6 +32,18 @@ module GrowsurfRuby
       sig { returns(Integer) }
       attr_accessor :start_date
 
+      sig do
+        returns(T.nilable(GrowsurfRuby::Models::CampaignEngagementAnalytics))
+      end
+      attr_reader :engagement
+
+      sig do
+        params(
+          engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics::OrHash
+        ).void
+      end
+      attr_writer :engagement
+
       # Present only when `include` contains `previousPeriod`.
       sig do
         returns(
@@ -115,6 +127,7 @@ module GrowsurfRuby
             GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics::OrHash,
           end_date: Integer,
           start_date: Integer,
+          engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics::OrHash,
           previous_period:
             GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod::OrHash,
           rates:
@@ -131,6 +144,8 @@ module GrowsurfRuby
         analytics:,
         end_date:,
         start_date:,
+        # Present only when `include` contains `engagement`.
+        engagement: nil,
         # Present only when `include` contains `previousPeriod`.
         previous_period: nil,
         # Present only when `include` contains `rates`.
@@ -150,6 +165,7 @@ module GrowsurfRuby
               GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
             end_date: Integer,
             start_date: Integer,
+            engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics,
             previous_period:
               GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod,
             rates:
@@ -1386,16 +1402,20 @@ module GrowsurfRuby
 
           # Reward counts grouped by review and fulfillment status.
           sig do
-            params(completed: Integer, unapproved: Integer, unfulfilled: Integer).returns(T.attached_class)
+            params(
+              completed: Integer,
+              unapproved: Integer,
+              unfulfilled: Integer
+            ).returns(T.attached_class)
           end
-          def self.new(
-            completed: nil,
-            unapproved: nil,
-            unfulfilled: nil
-          )
+          def self.new(completed: nil, unapproved: nil, unfulfilled: nil)
           end
 
-          sig { override.returns({ completed: Integer, unapproved: Integer, unfulfilled: Integer }) }
+          sig do
+            override.returns(
+              { completed: Integer, unapproved: Integer, unfulfilled: Integer }
+            )
+          end
           def to_hash
           end
         end

data/rbi/growsurf_ruby/models/commission_structure.rbi

@@ -26,7 +26,14 @@ module GrowsurfRuby
       sig { returns(T.nilable(Integer)) }
       attr_accessor :duration_in_months
 
-      sig { returns(T.nilable(String)) }
+      # The event that generates a commission. `CLICK` and `LEAD` require `FIXED` with
+      # a positive `amount`; `amountISO` defaults to the program currency when omitted.
+      # `SALE` supports `FIXED` or `PERCENT`. Missing legacy values read as `SALE`.
+      sig do
+        returns(
+          T.nilable(GrowsurfRuby::CommissionStructure::Event::TaggedSymbol)
+        )
+      end
       attr_accessor :event
 
       sig { returns(T.nilable(T::Boolean)) }
@@ -82,7 +89,7 @@ module GrowsurfRuby
           approval_required: T.nilable(T::Boolean),
           duration: T.nilable(String),
           duration_in_months: T.nilable(Integer),
-          event: T.nilable(String),
+          event: T.nilable(GrowsurfRuby::CommissionStructure::Event::OrSymbol),
           has_intro: T.nilable(T::Boolean),
           has_max_amount: T.nilable(T::Boolean),
           hold_duration: T.nilable(Integer),
@@ -131,7 +138,8 @@ module GrowsurfRuby
             approval_required: T.nilable(T::Boolean),
             duration: T.nilable(String),
             duration_in_months: T.nilable(Integer),
-            event: T.nilable(String),
+            event:
+              T.nilable(GrowsurfRuby::CommissionStructure::Event::TaggedSymbol),
             has_intro: T.nilable(T::Boolean),
             has_max_amount: T.nilable(T::Boolean),
             hold_duration: T.nilable(Integer),
@@ -153,6 +161,31 @@ module GrowsurfRuby
       def to_hash
       end
 
+      module Event
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::CommissionStructure::Event)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CLICK =
+          T.let(:CLICK, GrowsurfRuby::CommissionStructure::Event::TaggedSymbol)
+        LEAD =
+          T.let(:LEAD, GrowsurfRuby::CommissionStructure::Event::TaggedSymbol)
+        SALE =
+          T.let(:SALE, GrowsurfRuby::CommissionStructure::Event::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::CommissionStructure::Event::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       module Type
         extend GrowsurfRuby::Internal::Type::Enum