growsurf-ruby 1.4.0 → 1.5.0

data/lib/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rb

@@ -9,28 +9,28 @@ module GrowsurfRuby
         #   When the confirmation link expires, as a Unix timestamp in milliseconds.
         #
         #   @return [Integer, nil]
-        optional :expires_at, Integer, api_name: :expiresAt, nil?: true
+        required :expires_at, Integer, api_name: :expiresAt, nil?: true
 
         # @!attribute provider
         #   The provider the participant was asked to confirm.
         #
-        #   @return [String, nil]
-        optional :provider, String
+        #   @return [String]
+        required :provider, String
 
         # @!attribute provider_display_name
         #   The customer-facing provider name (e.g. "PayPal", "Wise").
         #
-        #   @return [String, nil]
-        optional :provider_display_name, String, api_name: :providerDisplayName
+        #   @return [String]
+        required :provider_display_name, String, api_name: :providerDisplayName
 
         # @!attribute status
         #   Confirms the message was requested.
         #
-        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status, nil]
-        optional :status,
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status]
+        required :status,
                  enum: -> { GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status }
 
-        # @!method initialize(expires_at: nil, provider: nil, provider_display_name: nil, status: nil)
+        # @!method initialize(expires_at:, provider:, provider_display_name:, status:)
         #   @param expires_at [Integer, nil] When the confirmation link expires, as a Unix timestamp in milliseconds.
         #
         #   @param provider [String] The provider the participant was asked to confirm.

data/lib/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rb

@@ -37,9 +37,10 @@ module GrowsurfRuby
         #   Comma-separated optional data. `series` returns this participant's own activity
         #   per period; `email` returns `sent`, `delivered`, `opened`, `clicked`, `bounced`,
         #   `spamComplaints`, and per-email-type metrics attributed to the participant for
-        #   the requested analytics window (including invitations they sent). Request both
-        #   in either order to add email counts to every series item for emails sent during
-        #   that period. Only documented tokens are accepted; an unknown token returns `400`.
+        #   the requested analytics window (including invitations they sent); `activation`
+        #   returns the cohort anchor and covered first milestones. Request
+        #   `activation,series` to add covered portal-view and share-action counts to every
+        #   series item. Only documented tokens are accepted; an unknown token returns `400`.
         #
         #   @return [String, nil]
         optional :include, String

data/lib/growsurf_ruby/models/campaign/participant_reward.rb

@@ -27,7 +27,12 @@ module GrowsurfRuby
         # @!attribute approved_at
         #
         #   @return [Integer, nil]
-        optional :approved_at, Integer, api_name: :approvedAt
+        optional :approved_at, Integer, api_name: :approvedAt, nil?: true
+
+        # @!attribute amount
+        #
+        #   @return [Float, nil]
+        optional :amount, Float, nil?: true
 
         # @!attribute commission_structure
         #
@@ -37,10 +42,15 @@ module GrowsurfRuby
                  api_name: :commissionStructure,
                  nil?: true
 
+        # @!attribute currency_iso
+        #
+        #   @return [String, nil]
+        optional :currency_iso, String, api_name: :currencyISO, nil?: true
+
         # @!attribute fulfilled_at
         #
         #   @return [Integer, nil]
-        optional :fulfilled_at, Integer, api_name: :fulfilledAt
+        optional :fulfilled_at, Integer, api_name: :fulfilledAt, nil?: true
 
         # @!attribute is_available
         #
@@ -72,13 +82,15 @@ module GrowsurfRuby
         #   @return [Boolean, nil]
         optional :unread, GrowsurfRuby::Internal::Type::Boolean
 
-        # @!method initialize(id:, reward_id:, status:, approved: nil, approved_at: nil, commission_structure: nil, fulfilled_at: nil, is_available: nil, is_fulfilled: nil, is_referrer: nil, referred_id: nil, referrer_id: nil, unread: nil)
+        # @!method initialize(id:, reward_id:, status:, approved: nil, approved_at: nil, amount: nil, commission_structure: nil, currency_iso: nil, fulfilled_at: nil, is_available: nil, is_fulfilled: nil, is_referrer: nil, referred_id: nil, referrer_id: nil, unread: nil)
         #   @param id [String]
         #   @param reward_id [String]
         #   @param status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantReward::Status]
         #   @param approved [Boolean]
         #   @param approved_at [Integer]
+        #   @param amount [Float]
         #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure, nil]
+        #   @param currency_iso [String]
         #   @param fulfilled_at [Integer]
         #   @param is_available [Boolean]
         #   @param is_fulfilled [Boolean]

data/lib/growsurf_ruby/models/campaign/program_resource.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceFile < GrowsurfRuby::Internal::Type::BaseModel
+        required :file_name, String, api_name: :fileName
+        required :mime_type, String, api_name: :mimeType
+        required :bytes, Integer
+        required :format, String
+        required :moderation_status,
+                 enum: -> { GrowsurfRuby::Campaign::ProgramResourceFile::ModerationStatus },
+                 api_name: :moderationStatus
+
+        module ModerationStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          PENDING = :PENDING
+          APPROVED = :APPROVED
+          REJECTED = :REJECTED
+        end
+      end
+
+      # A program-owned participant resource returned by the REST API.
+      class ProgramResource < GrowsurfRuby::Internal::Type::BaseModel
+        required :id, String
+        required :type, enum: -> { GrowsurfRuby::Campaign::ProgramResource::Type }
+        required :title, String
+        required :description, String, nil?: true
+        required :category, String, nil?: true
+        required :url, String, nil?: true
+        required :text, String, nil?: true
+        required :file, -> { GrowsurfRuby::Campaign::ProgramResourceFile }, nil?: true
+        required :is_published, GrowsurfRuby::Internal::Type::Boolean, api_name: :isPublished
+        required :position, Integer
+        # Unix time in milliseconds when the resource was created.
+        required :created_at, Integer, api_name: :createdAt
+        # Unix time in milliseconds when the resource was last updated.
+        required :updated_at, Integer, api_name: :updatedAt
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          FILE = :FILE
+          LINK = :LINK
+          TEXT = :TEXT
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/program_resource_create_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        required :type, enum: -> { GrowsurfRuby::Campaign::ProgramResourceCreateParams::Type }
+        required :title, String
+        optional :description, String, nil?: true
+        optional :category, String, nil?: true
+        optional :is_published, GrowsurfRuby::Internal::Type::Boolean, api_name: :isPublished
+        optional :url, String
+        optional :text, String
+        optional :upload_ticket, String, api_name: :uploadTicket
+        optional :upload_result,
+                 GrowsurfRuby::Models::Campaign::ProgramResourceUploadResult,
+                 api_name: :uploadResult
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          FILE = :FILE
+          LINK = :LINK
+          TEXT = :TEXT
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/program_resource_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        required :id, String
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/program_resource_list_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        required :resources,
+                 -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::ProgramResource] }
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/program_resource_update_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        required :id, String
+        optional :type, enum: -> { GrowsurfRuby::Campaign::ProgramResourceUpdateParams::Type }
+        optional :title, String
+        optional :description, String, nil?: true
+        optional :category, String, nil?: true
+        optional :is_published, GrowsurfRuby::Internal::Type::Boolean, api_name: :isPublished
+        # Zero-based destination. Must be from 0 through 99 and within the current Resource list.
+        optional :position, Integer
+        optional :url, String
+        optional :text, String
+        optional :upload_ticket, String, api_name: :uploadTicket
+        optional :upload_result,
+                 GrowsurfRuby::Models::Campaign::ProgramResourceUploadResult,
+                 api_name: :uploadResult
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          FILE = :FILE
+          LINK = :LINK
+          TEXT = :TEXT
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/program_resource_upload_result.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # The unmodified signed result returned after uploading with a GrowSurf ticket.
+      class ProgramResourceUploadResult < GrowsurfRuby::Internal::Type::BaseModel
+        optional :asset_id, String
+        required :public_id, String
+        required :version, Integer
+        required :signature, String
+        required :resource_type, enum: -> { GrowsurfRuby::Models::Campaign::ProgramResourceUploadResult::ResourceType }
+        required :type, enum: -> { GrowsurfRuby::Models::Campaign::ProgramResourceUploadResult::Type }
+        required :bytes, Integer
+        required :secure_url, String
+        optional :format, String
+
+        module ResourceType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          IMAGE = :image
+          RAW = :raw
+        end
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          AUTHENTICATED = :authenticated
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/program_resource_upload_ticket.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      module ProgramResourceUploadParameter
+        extend GrowsurfRuby::Internal::Type::Union
+
+        variant GrowsurfRuby::Internal::Type::Boolean
+        variant String
+        variant Integer
+        variant Float
+      end
+
+      class ProgramResourceUploadTicket < GrowsurfRuby::Internal::Type::BaseModel
+        required :ticket, String
+        required :expires_in, Integer, api_name: :expiresIn
+        required :upload_url, String, api_name: :uploadUrl
+        # Opaque signed scalar fields that must be sent unchanged with the file upload.
+        required :upload_parameters,
+                 GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Models::Campaign::ProgramResourceUploadParameter],
+                 api_name: :uploadParameters
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/program_resource_upload_ticket_params.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceUploadTicketParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # File name sent to GrowSurf. Must contain 1 through 120 characters.
+        required :file_name, String, api_name: :fileName
+        required :mime_type, String, api_name: :mimeType
+        required :bytes, Integer
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/reward_create_params.rb

@@ -31,7 +31,7 @@ module GrowsurfRuby
         #   issued coupon when one exists.
         #
         #   @return [String, nil]
-        optional :coupon_code, String, api_name: :couponCode
+        optional :coupon_code, String, api_name: :couponCode, nil?: true
 
         # @!attribute description
         #
@@ -50,7 +50,7 @@ module GrowsurfRuby
         # @!attribute image_url
         #
         #   @return [String, nil]
-        optional :image_url, String, api_name: :imageUrl
+        optional :image_url, String, api_name: :imageUrl, nil?: true
 
         # @!attribute is_unlimited
         #   Whether the reward can be earned an unlimited number of times. Defaults to
@@ -89,14 +89,14 @@ module GrowsurfRuby
         #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
-        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix
+        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix, nil?: true
 
         # @!attribute next_milestone_suffix
         #   Text shown after a participant's referral count in milestone-progress copy.
         #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
-        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix
+        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix, nil?: true
 
         # @!attribute number_of_winners
         #   The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
@@ -117,12 +117,12 @@ module GrowsurfRuby
         #   connected billing integration's issued coupon when one exists.
         #
         #   @return [String, nil]
-        optional :referral_coupon_code, String, api_name: :referralCouponCode
+        optional :referral_coupon_code, String, api_name: :referralCouponCode, nil?: true
 
         # @!attribute referral_description
         #
         #   @return [String, nil]
-        optional :referral_description, String, api_name: :referralDescription
+        optional :referral_description, String, api_name: :referralDescription, nil?: true
 
         # @!attribute referred_reward_upfront
         #
@@ -138,7 +138,8 @@ module GrowsurfRuby
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
         optional :referred_value,
                  -> { GrowsurfRuby::RewardTaxValuation },
-                 api_name: :referredValue
+                 api_name: :referredValue,
+                 nil?: true
 
         # @!attribute title
         #
@@ -150,7 +151,7 @@ module GrowsurfRuby
         #   Used by tax documentation / 1099 reporting.
         #
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
-        optional :value, -> { GrowsurfRuby::RewardTaxValuation }
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
 
         # @!method initialize(type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: 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, title: nil, value: nil, request_options: {})
         #   Some parameter documentations has been truncated, see

data/lib/growsurf_ruby/models/campaign/reward_update_params.rb

@@ -36,7 +36,7 @@ module GrowsurfRuby
         #   issued coupon when one exists.
         #
         #   @return [String, nil]
-        optional :coupon_code, String, api_name: :couponCode
+        optional :coupon_code, String, api_name: :couponCode, nil?: true
 
         # @!attribute description
         #
@@ -55,7 +55,7 @@ module GrowsurfRuby
         # @!attribute image_url
         #
         #   @return [String, nil]
-        optional :image_url, String, api_name: :imageUrl
+        optional :image_url, String, api_name: :imageUrl, nil?: true
 
         # @!attribute is_unlimited
         #   Whether the reward can be earned an unlimited number of times. Defaults to
@@ -94,14 +94,14 @@ module GrowsurfRuby
         #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
-        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix
+        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix, nil?: true
 
         # @!attribute next_milestone_suffix
         #   Text shown after a participant's referral count in milestone-progress copy.
         #   Applies to `MILESTONE` rewards.
         #
         #   @return [String, nil]
-        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix
+        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix, nil?: true
 
         # @!attribute number_of_winners
         #   The number of winners (`LEADERBOARD` rewards only). With `limitDuration`
@@ -122,12 +122,12 @@ module GrowsurfRuby
         #   connected billing integration's issued coupon when one exists.
         #
         #   @return [String, nil]
-        optional :referral_coupon_code, String, api_name: :referralCouponCode
+        optional :referral_coupon_code, String, api_name: :referralCouponCode, nil?: true
 
         # @!attribute referral_description
         #
         #   @return [String, nil]
-        optional :referral_description, String, api_name: :referralDescription
+        optional :referral_description, String, api_name: :referralDescription, nil?: true
 
         # @!attribute referred_reward_upfront
         #
@@ -143,7 +143,8 @@ module GrowsurfRuby
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
         optional :referred_value,
                  -> { GrowsurfRuby::RewardTaxValuation },
-                 api_name: :referredValue
+                 api_name: :referredValue,
+                 nil?: true
 
         # @!attribute title
         #
@@ -155,7 +156,7 @@ module GrowsurfRuby
         #   Used by tax documentation / 1099 reporting.
         #
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
-        optional :value, -> { GrowsurfRuby::RewardTaxValuation }
+        optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
 
         # @!method initialize(id:, campaign_reward_id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: 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, title: nil, value: nil, request_options: {})
         #   Some parameter documentations has been truncated, see

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]
@@ -293,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