growsurf-ruby 1.3.0 → 1.5.0

data/lib/growsurf_ruby/models/campaign.rb

@@ -57,7 +57,7 @@ module GrowsurfRuby
       # @!attribute currency_iso
       #
       #   @return [String, nil]
-      optional :currency_iso, String, api_name: :currencyISO
+      optional :currency_iso, String, api_name: :currencyISO, nil?: true
 
       # @!method initialize(id:, impression_count:, invite_count:, name:, participant_count:, referral_count:, rewards:, status:, type:, winner_count:, currency_iso: nil)
       #   @param id [String]
@@ -120,6 +120,14 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :description, String, nil?: true
 
+        # @!attribute event
+        #   The referral event that earns this Campaign Reward. Present only for
+        #   `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+        #   Rewards return `CONVERSION`.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::Event, nil]
+        optional :event, enum: -> { GrowsurfRuby::CampaignAPI::Reward::Event }, nil?: true
+
         # @!attribute image_url
         #
         #   @return [String, nil]
@@ -200,7 +208,7 @@ module GrowsurfRuby
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
         optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
 
-        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, value: nil)
+        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, value: nil)
         #   @param id [String]
         #
         #   @param is_unlimited [Boolean]
@@ -217,6 +225,8 @@ module GrowsurfRuby
         #
         #   @param description [String, nil]
         #
+        #   @param event [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::Event, nil] The referral event that earns this Campaign Reward.
+        #
         #   @param image_url [String, nil]
         #
         #   @param limit [Integer, nil] `-1` represents an unlimited reward in REST responses.
@@ -255,6 +265,17 @@ module GrowsurfRuby
           #   @return [Array<Symbol>]
         end
 
+        # @see GrowsurfRuby::Models::CampaignAPI::Reward#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          CONVERSION = :CONVERSION
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::CampaignAPI::Reward#limit_duration
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum
@@ -272,8 +293,10 @@ module GrowsurfRuby
         extend GrowsurfRuby::Internal::Type::Enum
 
         DRAFT = :DRAFT
+        PENDING = :PENDING
         IN_PROGRESS = :IN_PROGRESS
         COMPLETE = :COMPLETE
+        CANCELLED = :CANCELLED
         DELETED = :DELETED
 
         # @!method self.values

data/lib/growsurf_ruby/models/campaign_activation_analytics_response.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # Activation cohorts for eligible participants in a referral or affiliate program.
+    class CampaignActivationAnalyticsResponse < GrowsurfRuby::Internal::Type::BaseModel
+      required :coverage_start_at, Integer, api_name: :coverageStartAt, nil?: true
+      required :metric_contract_version, Integer, api_name: :metricContractVersion
+      required :program_type,
+               enum: -> { GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::ProgramType },
+               api_name: :programType
+      required :timezone, String
+      required :cohort_interval,
+               enum: -> { GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::CohortInterval },
+               api_name: :cohortInterval
+      required :observation_window_days, Integer, api_name: :observationWindowDays
+      required :portal_viewed_label,
+               enum: -> { GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::PortalViewedLabel },
+               api_name: :portalViewedLabel
+      required :portal_viewed_helper_text, String, api_name: :portalViewedHelperText
+      required :aggregate, -> { GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::CohortResult }
+      required :cohorts,
+               -> {
+                 GrowsurfRuby::Internal::Type::ArrayOf[
+                   GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::CohortResult
+                 ]
+               }
+
+      module ProgramType
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        REFERRAL = :REFERRAL
+        AFFILIATE = :AFFILIATE
+      end
+
+      module CohortInterval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DAY = :day
+        WEEK = :week
+        MONTH = :month
+      end
+
+      module PortalViewedLabel
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        REFERRAL = :"Referral portal viewed"
+        AFFILIATE = :"Affiliate portal viewed"
+      end
+
+      module StageKey
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ELIGIBLE = :ELIGIBLE
+        PORTAL_VIEWED = :PORTAL_VIEWED
+        SHARE_ACTION = :SHARE_ACTION
+        UNIQUE_REFERRAL_VISIT = :UNIQUE_REFERRAL_VISIT
+        LEAD = :LEAD
+        CREDITED_REFERRAL = :CREDITED_REFERRAL
+      end
+
+      module StalledSegmentKey
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ELIGIBLE_NO_PORTAL_VIEW = :ELIGIBLE_NO_PORTAL_VIEW
+        PORTAL_VIEWED_NO_SHARE_ACTION = :PORTAL_VIEWED_NO_SHARE_ACTION
+        SHARED_NO_UNIQUE_REFERRAL_VISIT = :SHARED_NO_UNIQUE_REFERRAL_VISIT
+        UNIQUE_VISIT_NO_LEAD = :UNIQUE_VISIT_NO_LEAD
+        LEAD_NO_CREDITED_REFERRAL = :LEAD_NO_CREDITED_REFERRAL
+      end
+
+      module StalledSegmentFromStage
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ELIGIBLE = :ELIGIBLE
+        PORTAL_VIEWED = :PORTAL_VIEWED
+        SHARE_ACTION = :SHARE_ACTION
+        UNIQUE_REFERRAL_VISIT = :UNIQUE_REFERRAL_VISIT
+        LEAD = :LEAD
+      end
+
+      module StalledSegmentToStage
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PORTAL_VIEWED = :PORTAL_VIEWED
+        SHARE_ACTION = :SHARE_ACTION
+        UNIQUE_REFERRAL_VISIT = :UNIQUE_REFERRAL_VISIT
+        LEAD = :LEAD
+        CREDITED_REFERRAL = :CREDITED_REFERRAL
+      end
+
+      class Stage < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, enum: -> { StageKey }
+        required :count, Integer
+        required :conversion_rate_from_prior, Float, api_name: :conversionRateFromPrior, nil?: true
+        required :conversion_rate_from_eligible, Float, api_name: :conversionRateFromEligible, nil?: true
+        required :drop_off_count, Integer, api_name: :dropOffCount, nil?: true
+        required :drop_off_rate, Float, api_name: :dropOffRate, nil?: true
+        required :median_time_to_stage_ms, Float, api_name: :medianTimeToStageMs, nil?: true
+        required :stalled_segment_key,
+                 enum: -> { StalledSegmentKey },
+                 api_name: :stalledSegmentKey,
+                 nil?: true
+      end
+
+      class StageCounts < GrowsurfRuby::Internal::Type::BaseModel
+        required :eligible, Integer, api_name: :ELIGIBLE
+        required :portal_viewed, Integer, api_name: :PORTAL_VIEWED
+        required :share_action, Integer, api_name: :SHARE_ACTION
+        required :unique_referral_visit, Integer, api_name: :UNIQUE_REFERRAL_VISIT
+        required :lead, Integer, api_name: :LEAD
+        required :credited_referral, Integer, api_name: :CREDITED_REFERRAL
+      end
+
+      class StalledSegment < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, enum: -> { StalledSegmentKey }
+        required :from_stage, enum: -> { StalledSegmentFromStage }, api_name: :fromStage
+        required :to_stage, enum: -> { StalledSegmentToStage }, api_name: :toStage
+        required :count, Integer
+      end
+
+      class OutcomeCount < GrowsurfRuby::Internal::Type::BaseModel
+        required :count, Integer
+      end
+
+      class Outcomes < GrowsurfRuby::Internal::Type::BaseModel
+        optional :first_reward, -> { OutcomeCount }, api_name: :FIRST_REWARD
+        optional :first_commission, -> { OutcomeCount }, api_name: :FIRST_COMMISSION
+        optional :payout_setup_completed, -> { OutcomeCount }, api_name: :PAYOUT_SETUP_COMPLETED
+      end
+
+      module ImprovementAreaKey
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PORTAL_ACCESS = :PORTAL_ACCESS
+        SHARING_EXPERIENCE = :SHARING_EXPERIENCE
+        SHARE_EFFECTIVENESS = :SHARE_EFFECTIVENESS
+        VISITOR_SIGNUP = :VISITOR_SIGNUP
+        ATTRIBUTION_AND_QUALIFICATION = :ATTRIBUTION_AND_QUALIFICATION
+      end
+
+      class LargestDrop < GrowsurfRuby::Internal::Type::BaseModel
+        required :from_stage, String, api_name: :fromStage
+        required :to_stage, String, api_name: :toStage
+        required :count, Integer
+        required :rate, Float
+        required :stalled_segment_key, String, api_name: :stalledSegmentKey
+        required :improvement_area_key, enum: -> { ImprovementAreaKey }, api_name: :improvementAreaKey
+        required :improvement_area, String, api_name: :improvementArea
+      end
+
+      module AnchorField
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ENROLLED_AS_ADVOCATE_AT = :enrolledAsAdvocateAt
+        APPROVED_AS_AFFILIATE_AT = :approvedAsAffiliateAt
+      end
+
+      class CohortBounds < GrowsurfRuby::Internal::Type::BaseModel
+        required :from, Integer
+        required :to, Integer
+        required :effective_from, Integer, api_name: :effectiveFrom, nil?: true
+        required :matured_at, Integer, api_name: :maturedAt
+        required :as_of, Integer, api_name: :asOf
+        required :anchor_field, enum: -> { AnchorField }, api_name: :anchorField
+      end
+
+      class CohortResult < GrowsurfRuby::Internal::Type::BaseModel
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+        required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+        required :cohort, -> { CohortBounds }
+        required :strict_stages,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[Stage] },
+                 api_name: :strictStages,
+                 nil?: true
+        required :raw_stage_counts, -> { StageCounts }, api_name: :rawStageCounts, nil?: true
+        required :stalled_segments,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[StalledSegment] },
+                 api_name: :stalledSegments,
+                 nil?: true
+        required :outcomes, -> { Outcomes }, nil?: true
+        required :largest_drop, -> { LargestDrop }, api_name: :largestDrop, nil?: true
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_create_params.rb

@@ -27,6 +27,19 @@ module GrowsurfRuby
       #   @return [String, nil]
       optional :currency_iso, String, api_name: :currencyISO
 
+      # @!attribute goal
+      #   What the program is for, which seeds share settings that suit that audience.
+      #   Programs selling to businesses (`CUSTOMERS`, `USERS`, `B2B_SAAS_SELF_SERVICE`,
+      #   `B2B_SAAS_ENTERPRISE`) start with the LinkedIn share button visible; consumer,
+      #   financial, education, insurance, newsletter, and waitlist programs
+      #   (`B2C_SUBSCRIPTIONS`, `FINANCIAL_SERVICES`, `ONLINE_EDUCATION`,
+      #   `ONLINE_INSURANCE`, `SUBSCRIBERS`, `WAITLIST`) start with it hidden. Omit it and
+      #   every share button keeps its standard default. Set only when the program is
+      #   created; it is not accepted on update.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal, nil]
+      optional :goal, enum: -> { GrowsurfRuby::CampaignCreateParams::Goal }
+
       # @!attribute name
       #
       #   @return [String, nil]
@@ -38,7 +51,7 @@ module GrowsurfRuby
       optional :rewards,
                -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::RewardCreateParams] }
 
-      # @!method initialize(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, name: nil, rewards: nil, request_options: {})
+      # @!method initialize(type:, company_logo_image_url: nil, company_name: nil, currency_iso: nil, goal: nil, name: nil, rewards: nil, request_options: {})
       #   @param type [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Type]
       #
       #   @param company_logo_image_url [String]
@@ -47,6 +60,8 @@ module GrowsurfRuby
       #
       #   @param currency_iso [String]
       #
+      #   @param goal [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal] What the program is for, which seeds share settings that suit that audience.
+      #
       #   @param name [String]
       #
       #   @param rewards [Array<GrowsurfRuby::Models::Campaign::RewardCreateParams>]
@@ -63,6 +78,27 @@ module GrowsurfRuby
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # What the program is for, which seeds share settings that suit that audience.
+      #
+      # @see GrowsurfRuby::Models::CampaignCreateParams#goal
+      module Goal
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        CUSTOMERS = :CUSTOMERS
+        USERS = :USERS
+        SUBSCRIBERS = :SUBSCRIBERS
+        WAITLIST = :WAITLIST
+        B2B_SAAS_SELF_SERVICE = :B2B_SAAS_SELF_SERVICE
+        B2B_SAAS_ENTERPRISE = :B2B_SAAS_ENTERPRISE
+        B2C_SUBSCRIPTIONS = :B2C_SUBSCRIPTIONS
+        FINANCIAL_SERVICES = :FINANCIAL_SERVICES
+        ONLINE_EDUCATION = :ONLINE_EDUCATION
+        ONLINE_INSURANCE = :ONLINE_INSURANCE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/growsurf_ruby/models/campaign_engagement_analytics.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # Current participant engagement for the selected program, period, and platform.
+    class CampaignEngagementAnalytics < GrowsurfRuby::Internal::Type::BaseModel
+      required :coverage_start_at, Integer, api_name: :coverageStartAt, nil?: true
+      required :metric_contract_version, Integer, api_name: :metricContractVersion
+      required :program_type, enum: -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::ProgramType }, api_name: :programType
+      required :timezone, String
+      required :interval, enum: -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Interval }
+      required :platform, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::PlatformFilter }
+      required :period, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Period }
+      required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+      required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+      required :totals, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Totals }
+      required :previous_period,
+               -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::PreviousPeriod },
+               api_name: :previousPeriod
+      required :comparison, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Comparison }
+      required :series,
+               -> {
+                 GrowsurfRuby::Internal::Type::ArrayOf[
+                   GrowsurfRuby::Models::CampaignEngagementAnalytics::SeriesPoint
+                 ]
+               }
+      required :breakdowns, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics::Breakdowns }
+
+      module ProgramType
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        REFERRAL = :REFERRAL
+        AFFILIATE = :AFFILIATE
+      end
+
+      module Interval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DAY = :day
+        WEEK = :week
+        MONTH = :month
+      end
+
+      module Platform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ALL = :ALL
+        WEB = :WEB
+        IOS = :IOS
+        ANDROID = :ANDROID
+      end
+
+      module BreakdownPlatform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        WEB = :WEB
+        IOS = :IOS
+        ANDROID = :ANDROID
+      end
+
+      class Metric < GrowsurfRuby::Internal::Type::BaseModel
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+        required :value, Float, nil?: true
+        required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+        optional :delta, Float
+      end
+
+      class Totals < GrowsurfRuby::Internal::Type::BaseModel
+        required :active_participants, -> { Metric }, api_name: :activeParticipants
+        required :sharing_participants, -> { Metric }, api_name: :sharingParticipants
+        required :sharing_rate, -> { Metric }, api_name: :sharingRate
+        required :repeat_active_participants, -> { Metric }, api_name: :repeatActiveParticipants
+        required :repeat_sharing_participants, -> { Metric }, api_name: :repeatSharingParticipants
+        required :retained_active_participants, -> { Metric }, api_name: :retainedActiveParticipants
+        required :portal_views, -> { Metric }, api_name: :portalViews
+        required :share_actions, -> { Metric }, api_name: :shareActions
+      end
+
+      class Period < GrowsurfRuby::Internal::Type::BaseModel
+        required :from, Integer
+        required :to, Integer
+        required :effective_from, Integer, api_name: :effectiveFrom, nil?: true
+        required :previous_from, Integer, api_name: :previousFrom
+        required :previous_to, Integer, api_name: :previousTo
+      end
+
+      class PlatformFilter < GrowsurfRuby::Internal::Type::BaseModel
+        required :requested, enum: -> { Platform }
+        required :applied, enum: -> { Platform }
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+      end
+
+      class PreviousPeriod < GrowsurfRuby::Internal::Type::BaseModel
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+        required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+        required :totals, -> { Totals }, nil?: true
+      end
+
+      class ComparisonMetrics < GrowsurfRuby::Internal::Type::BaseModel
+        optional :active_participants, -> { Metric }, api_name: :activeParticipants
+        optional :sharing_participants, -> { Metric }, api_name: :sharingParticipants
+        optional :repeat_active_participants, -> { Metric }, api_name: :repeatActiveParticipants
+        optional :repeat_sharing_participants, -> { Metric }, api_name: :repeatSharingParticipants
+        optional :portal_views, -> { Metric }, api_name: :portalViews
+        optional :share_actions, -> { Metric }, api_name: :shareActions
+      end
+
+      class Comparison < GrowsurfRuby::Internal::Type::BaseModel
+        required :state, enum: -> { GrowsurfRuby::Models::AnalyticsAvailability }
+        required :reason, enum: -> { GrowsurfRuby::Models::AnalyticsUnavailableReason }, nil?: true
+        required :metrics, -> { ComparisonMetrics }, nil?: true
+      end
+
+      class SeriesPoint < GrowsurfRuby::Internal::Type::BaseModel
+        required :from, Integer
+        required :to, Integer
+        required :active_participants, Integer, api_name: :activeParticipants
+        required :sharing_participants, Integer, api_name: :sharingParticipants
+        required :portal_views, Integer, api_name: :portalViews
+        required :share_actions, Integer, api_name: :shareActions
+      end
+
+      class PlatformBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, enum: -> { BreakdownPlatform }
+        required :active_participants, Integer, api_name: :activeParticipants
+        required :sharing_participants, Integer, api_name: :sharingParticipants
+        required :portal_views, Integer, api_name: :portalViews
+        required :share_actions, Integer, api_name: :shareActions
+      end
+
+      module PortalSource
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DEFAULT_LAUNCHER = :DEFAULT_LAUNCHER
+        SDK_OPEN = :SDK_OPEN
+        CSS_CLASS = :CSS_CLASS
+        EMBEDDABLE_ELEMENT = :EMBEDDABLE_ELEMENT
+        HOSTED_PORTAL = :HOSTED_PORTAL
+        NATIVE_WINDOW = :NATIVE_WINDOW
+        UNKNOWN = :UNKNOWN
+      end
+
+      class PortalSourceBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, enum: -> { PortalSource }
+        required :active_participants, Integer, api_name: :activeParticipants
+        required :portal_views, Integer, api_name: :portalViews
+      end
+
+      class ShareChannelBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, String
+        required :sharing_participants, Integer, api_name: :sharingParticipants
+        required :share_actions, Integer, api_name: :shareActions
+      end
+
+      class FirstShareChannelBreakdown < GrowsurfRuby::Internal::Type::BaseModel
+        required :key, String
+        required :sharing_participants, Integer, api_name: :sharingParticipants
+      end
+
+      class Breakdowns < GrowsurfRuby::Internal::Type::BaseModel
+        required :platforms, -> { GrowsurfRuby::Internal::Type::ArrayOf[PlatformBreakdown] }
+        required :portal_view_sources,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[PortalSourceBreakdown] },
+                 api_name: :portalViewSources
+        required :share_channels,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[ShareChannelBreakdown] },
+                 api_name: :shareChannels
+        required :first_share_channels,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[FirstShareChannelBreakdown] },
+                 api_name: :firstShareChannels
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_retrieve_activation_analytics_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#retrieve_activation_analytics
+    class CampaignRetrieveActivationAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      required :id, String
+      optional :cohort_from, Integer
+      optional :cohort_to, Integer
+      optional :cohort_interval,
+               enum: -> { GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::CohortInterval }
+      optional :observation_window_days,
+               enum: -> { GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::ObservationWindowDays }
+      optional :timezone, String
+
+      module CohortInterval
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DAY = :day
+        WEEK = :week
+        MONTH = :month
+      end
+
+      module ObservationWindowDays
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        SEVEN = 7
+        THIRTY = 30
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb

@@ -33,18 +33,27 @@ module GrowsurfRuby
       #   `clicked`, `bounced`, `spamComplaints`, and per-email-type metrics. When `email` and
       #   an interval are both requested, each `series` item also contains counts for emails
       #   sent during that period. Combine `email` with `previousPeriod` to include the same
-      #   email metrics in both windows.
+      #   email metrics in both windows. `engagement` adds covered participant activity
+      #   totals, comparisons, series, and breakdowns.
       #
       #   @return [String, nil]
       optional :include, String
 
       # @!attribute interval
       #   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.
       #
       #   @return [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval, nil]
       optional :interval, enum: -> { GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval }
 
+      # @!attribute platform
+      #   Participant platform used for `engagement`. Defaults to `ALL`.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Platform, nil]
+      optional :platform, enum: -> { GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Platform }
+
       # @!attribute start_date
       #   Start date of the analytics timeframe as a Unix timestamp in milliseconds.
       #   Required if `days` is not set.
@@ -52,7 +61,13 @@ module GrowsurfRuby
       #   @return [Integer, nil]
       optional :start_date, Integer
 
-      # @!method initialize(id:, days: nil, end_date: nil, include: nil, interval: nil, start_date: nil, request_options: {})
+      # @!attribute timezone
+      #   IANA timezone used for engagement periods and buckets. Defaults to `UTC`.
+      #
+      #   @return [String, nil]
+      optional :timezone, String
+
+      # @!method initialize(id:, days: nil, end_date: nil, include: nil, interval: nil, platform: nil, start_date: nil, timezone: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams} for more details.
       #
@@ -66,12 +81,18 @@ module GrowsurfRuby
       #
       #   @param interval [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval] When set to `day`, `week`, or `month`, the response also includes a `series` array
       #
+      #   @param platform [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Platform] Participant platform used for `engagement`. Defaults to `ALL`.
+      #
       #   @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
       #
+      #   @param timezone [String] IANA timezone used for engagement periods and buckets. Defaults to `UTC`.
+      #
       #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 
       # 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
 
@@ -83,6 +104,18 @@ module GrowsurfRuby
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      module Platform
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ALL = :ALL
+        WEB = :WEB
+        IOS = :IOS
+        ANDROID = :ANDROID
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb

@@ -22,6 +22,9 @@ module GrowsurfRuby
       # Present only when `include` contains `email`.
       optional :email, -> { GrowsurfRuby::Models::EmailAnalytics }
 
+      # Present only when `include` contains `engagement`.
+      optional :engagement, -> { GrowsurfRuby::Models::CampaignEngagementAnalytics }
+
       # @!attribute previous_period
       #   Present only when `include` contains `previousPeriod`.
       #

data/lib/growsurf_ruby/models/commission_structure.rb

@@ -32,9 +32,13 @@ module GrowsurfRuby
       optional :duration_in_months, Integer, api_name: :durationInMonths, nil?: true
 
       # @!attribute event
+      #   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`.
       #
-      #   @return [String, nil]
-      optional :event, String, nil?: true
+      #   @return [Symbol, GrowsurfRuby::Models::CommissionStructure::Event, nil]
+      optional :event, enum: -> { GrowsurfRuby::CommissionStructure::Event }, nil?: true
 
       # @!attribute has_intro
       #
@@ -112,7 +116,7 @@ module GrowsurfRuby
       #   @param approval_required [Boolean, nil]
       #   @param duration [String, nil]
       #   @param duration_in_months [Integer, nil]
-      #   @param event [String, nil]
+      #   @param event [Symbol, GrowsurfRuby::Models::CommissionStructure::Event, nil]
       #   @param has_intro [Boolean, nil]
       #   @param has_max_amount [Boolean, nil]
       #   @param hold_duration [Integer, nil]
@@ -128,6 +132,18 @@ module GrowsurfRuby
       #   @param percent [Float, nil]
       #   @param type [Symbol, GrowsurfRuby::Models::CommissionStructure::Type, nil]
 
+      # @see GrowsurfRuby::Models::CommissionStructure#event
+      module Event
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        CLICK = :CLICK
+        LEAD = :LEAD
+        SALE = :SALE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see GrowsurfRuby::Models::CommissionStructure#type
       module Type
         extend GrowsurfRuby::Internal::Type::Enum