growsurf-ruby 1.3.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

@@ -19,14 +19,16 @@ module GrowsurfRuby
         required :participant_id_or_email, String
 
         # @!attribute days
-        #   Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        #   Last number of days for optional `series` and `email` analytics. Defaults to
+        #   365. Maximum 1825. Does not filter the top-level all-time totals.
         #
         #   @return [Integer, nil]
         optional :days, Integer
 
         # @!attribute end_date
-        #   End date of the analytics timeframe as a Unix timestamp in milliseconds.
-        #   Required if `days` is not set.
+        #   End of a custom `series` and `email` analytics window as a Unix timestamp in
+        #   milliseconds. Set it together with `startDate`. Does not filter the top-level
+        #   all-time totals.
         #
         #   @return [Integer, nil]
         optional :end_date, Integer
@@ -35,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
@@ -50,8 +53,9 @@ module GrowsurfRuby
         optional :interval, enum: -> { GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval }
 
         # @!attribute start_date
-        #   Start date of the analytics timeframe as a Unix timestamp in milliseconds.
-        #   Required if `days` is not set.
+        #   Start of a custom `series` and `email` analytics window as a Unix timestamp in
+        #   milliseconds. Set it together with `endDate`. Does not filter the top-level
+        #   all-time totals.
         #
         #   @return [Integer, nil]
         optional :start_date, Integer
@@ -65,15 +69,15 @@ module GrowsurfRuby
         #
         #   @param participant_id_or_email [String]
         #
-        #   @param days [Integer] Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        #   @param days [Integer] Last number of days for optional `series` and `email` analytics. Defaults to 365. Maxi
         #
-        #   @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
+        #   @param end_date [Integer] End of a custom `series` and `email` analytics window as a Unix timestamp in milli
         #
         #   @param include [String] Comma-separated optional data. `series` returns this participant's own activity
         #
         #   @param interval [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval] Bucket size for the `series` (only used when `include` contains `series`).
         #
-        #   @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
+        #   @param start_date [Integer] Start of a custom `series` and `email` analytics window as a Unix timestamp in mi
         #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 

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]
@@ -93,6 +105,7 @@ module GrowsurfRuby
 
           PENDING = :PENDING
           FULFILLED = :FULFILLED
+          CANCELLED = :CANCELLED
 
           # @!method self.values
           #   @return [Array<Symbol>]

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.rb

@@ -52,6 +52,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::Campaign::Reward::Event, nil]
+        optional :event, enum: -> { GrowsurfRuby::Campaign::Reward::Event }, nil?: true
+
         # @!attribute image_url
         #
         #   @return [String, nil]
@@ -145,7 +153,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, is_visible: 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, title: 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, is_visible: 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, title: nil, value: nil)
         #   @param id [String]
         #
         #   @param is_unlimited [Boolean]
@@ -162,6 +170,8 @@ module GrowsurfRuby
         #
         #   @param description [String, nil]
         #
+        #   @param event [Symbol, GrowsurfRuby::Models::Campaign::Reward::Event, nil] The referral event that earns this Campaign Reward.
+        #
         #   @param image_url [String, nil]
         #
         #   @param is_visible [Boolean] Whether the reward is enabled. When `false` the reward is disabled: hidden from
@@ -204,6 +214,17 @@ module GrowsurfRuby
           #   @return [Array<Symbol>]
         end
 
+        # @see GrowsurfRuby::Models::Campaign::Reward#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          CONVERSION = :CONVERSION
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::Campaign::Reward#limit_duration
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum

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

@@ -31,17 +31,26 @@ 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
         #
         #   @return [String, nil]
         optional :description, String
 
+        # @!attribute event
+        #   The referral event that earns this Campaign Reward. Use `LEAD` or
+        #   `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to
+        #   be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and
+        #   `MILESTONE` rewards. When omitted, it defaults to `CONVERSION`.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Event, nil]
+        optional :event, enum: -> { GrowsurfRuby::Campaign::RewardCreateParams::Event }
+
         # @!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
@@ -80,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`
@@ -108,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
         #
@@ -129,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
         #
@@ -141,9 +151,9 @@ 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, 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: {})
+        # @!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
         #   {GrowsurfRuby::Models::Campaign::RewardCreateParams} for more details.
         #
@@ -157,6 +167,8 @@ module GrowsurfRuby
         #
         #   @param description [String]
         #
+        #   @param event [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::Event] The referral event that earns this Campaign Reward.
+        #
         #   @param image_url [String]
         #
         #   @param is_unlimited [Boolean] Whether the reward can be earned an unlimited number of times. Defaults to `true
@@ -205,6 +217,17 @@ module GrowsurfRuby
           #   @return [Array<Symbol>]
         end
 
+        # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          CONVERSION = :CONVERSION
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::Campaign::RewardCreateParams#limit_duration
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum

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

@@ -36,17 +36,26 @@ 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
         #
         #   @return [String, nil]
         optional :description, String
 
+        # @!attribute event
+        #   The referral event that earns this Campaign Reward. Use `LEAD` or
+        #   `CONVERSION`. `LEAD` requires the program installation's `referralTrigger` to
+        #   be `CUSTOM`. This field applies only to `SINGLE_SIDED`, `DOUBLE_SIDED`, and
+        #   `MILESTONE` rewards. When omitted, the stored event is preserved.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event, nil]
+        optional :event, enum: -> { GrowsurfRuby::Campaign::RewardUpdateParams::Event }
+
         # @!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
@@ -85,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`
@@ -113,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
         #
@@ -134,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
         #
@@ -146,9 +156,9 @@ 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, 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: {})
+        # @!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
         #   {GrowsurfRuby::Models::Campaign::RewardUpdateParams} for more details.
         #
@@ -164,6 +174,8 @@ module GrowsurfRuby
         #
         #   @param description [String]
         #
+        #   @param event [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event] The referral event that earns this Campaign Reward.
+        #
         #   @param image_url [String]
         #
         #   @param is_unlimited [Boolean] Whether the reward can be earned an unlimited number of times. Defaults to `true
@@ -198,6 +210,17 @@ module GrowsurfRuby
         #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 
+        # @see GrowsurfRuby::Models::Campaign::RewardUpdateParams#event
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD = :LEAD
+          CONVERSION = :CONVERSION
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         # @see GrowsurfRuby::Models::Campaign::RewardUpdateParams#limit_duration
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum