growsurf-ruby 1.2.1 → 1.3.0

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#request_payout_destination_confirmation
+      class ParticipantRequestPayoutDestinationConfirmationResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute expires_at
+        #   When the confirmation link expires, as a Unix timestamp in milliseconds.
+        #
+        #   @return [Integer, nil]
+        optional :expires_at, Integer, api_name: :expiresAt, nil?: true
+
+        # @!attribute provider
+        #   The provider the participant was asked to confirm.
+        #
+        #   @return [String, nil]
+        optional :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
+
+        # @!attribute status
+        #   Confirms the message was requested.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status, nil]
+        optional :status,
+                 enum: -> { GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status }
+
+        # @!method initialize(expires_at: nil, provider: nil, provider_display_name: nil, status: nil)
+        #   @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.
+        #
+        #   @param provider_display_name [String] The customer-facing provider name (e.g. "PayPal", "Wise").
+        #
+        #   @param status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status] Confirms the message was requested.
+
+        # Confirms the message was requested.
+        #
+        # @see GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse#status
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          CONFIRMATION_REQUESTED = :CONFIRMATION_REQUESTED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -32,13 +32,19 @@ module GrowsurfRuby
         optional :end_date, Integer
 
         # @!attribute include
-        #   Set to `series` to also return this participant's own activity per period.
+        #   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`.
         #
-        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Include, nil]
-        optional :include, enum: -> { GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include }
+        #   @return [String, nil]
+        optional :include, String
 
         # @!attribute interval
-        #   Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        #   Bucket size for the `series` (only used when `include` contains `series`).
+        #   Defaults to `day`.
         #
         #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Interval, nil]
         optional :interval, enum: -> { GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval }
@@ -63,25 +69,16 @@ module GrowsurfRuby
         #
         #   @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
         #
-        #   @param include [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::Include] Set to `series` to also return this participant's own activity per period.
+        #   @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 with `include=series`). Defaults to `day`.
+        #   @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 request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 
-        # Set to `series` to also return this participant's own activity per period.
-        module Include
-          extend GrowsurfRuby::Internal::Type::Enum
-
-          SERIES = :series
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        # Bucket size for the `series` (only used when `include` contains `series`).
+        # Defaults to `day`.
         module Interval
           extend GrowsurfRuby::Internal::Type::Enum
 

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

@@ -18,6 +18,16 @@ module GrowsurfRuby
         #   @return [String]
         required :participant_id_or_email, String
 
+        # @!attribute affiliate_status
+        #   Affiliate programs only. Sets the affiliate status. `APPROVED` also enrolls a
+        #   participant who is not yet an affiliate. `SUSPENDED` and `BANNED` are rejected
+        #   for non-affiliates.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::AffiliateStatus, nil]
+        optional :affiliate_status,
+                 enum: -> { GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus },
+                 api_name: :affiliateStatus
+
         # @!attribute email
         #
         #   @return [String, nil]
@@ -46,12 +56,6 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :notes, String
 
-        # @!attribute paypal_email
-        #   The participant's PayPal email address, used for affiliate payouts.
-        #
-        #   @return [String, nil]
-        optional :paypal_email, String, api_name: :paypalEmail
-
         # @!attribute referral_status
         #
         #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::ReferralStatus, nil]
@@ -74,7 +78,7 @@ module GrowsurfRuby
         #   @return [Array<String>, nil]
         optional :vanity_keys, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :vanityKeys
 
-        # @!method initialize(id:, participant_id_or_email:, email: nil, first_name: nil, last_name: nil, metadata: nil, notes: nil, paypal_email: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {})
+        # @!method initialize(id:, participant_id_or_email:, affiliate_status: nil, email: nil, first_name: nil, last_name: nil, metadata: nil, notes: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {GrowsurfRuby::Models::Campaign::ParticipantUpdateParams} for more details.
         #
@@ -82,6 +86,8 @@ module GrowsurfRuby
         #
         #   @param participant_id_or_email [String]
         #
+        #   @param affiliate_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::AffiliateStatus] Affiliate programs only. Sets the affiliate status.
+        #
         #   @param email [String]
         #
         #   @param first_name [String]
@@ -92,8 +98,6 @@ module GrowsurfRuby
         #
         #   @param notes [String] Freeform internal notes about the participant (internal only, never exposed to pa
         #
-        #   @param paypal_email [String] The participant's PayPal email address, used for affiliate payouts.
-        #
         #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::ReferralStatus]
         #
         #   @param referred_by [String]
@@ -104,6 +108,18 @@ module GrowsurfRuby
         #
         #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
 
+        # @see GrowsurfRuby::Models::Campaign::ParticipantUpdateParams#affiliate_status
+        module AffiliateStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          APPROVED = :APPROVED
+          SUSPENDED = :SUSPENDED
+          BANNED = :BANNED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
         module ReferralStatus
           extend GrowsurfRuby::Internal::Type::Enum
 

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

@@ -8,6 +8,9 @@ module GrowsurfRuby
 
         DIRECT = :DIRECT
         PARTICIPANT = :PARTICIPANT
+        DELETED_PARTICIPANT = :DELETED_PARTICIPANT
+        IMPORT = :IMPORT
+        MANUAL = :MANUAL
 
         # @!method self.values
         #   @return [Array<Symbol>]

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

@@ -57,6 +57,13 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :image_url, String, api_name: :imageUrl, nil?: true
 
+        # @!attribute is_visible
+        #   Whether the reward is enabled. When `false` the reward is disabled: hidden from
+        #   participants and no longer awarded, including those who already earned it.
+        #
+        #   @return [Boolean, nil]
+        optional :is_visible, GrowsurfRuby::Internal::Type::Boolean, api_name: :isVisible
+
         # @!attribute limit
         #   `-1` represents an unlimited reward in REST responses.
         #
@@ -118,7 +125,7 @@ module GrowsurfRuby
                  api_name: :referredRewardUpfront
 
         # @!attribute referred_value
-        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #   Tax treatment override for the referred friend's side of a double-sided reward.
         #
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
         optional :referred_value,
@@ -126,13 +133,19 @@ module GrowsurfRuby
                  api_name: :referredValue,
                  nil?: true
 
+        # @!attribute title
+        #   The reward title (internal label).
+        #
+        #   @return [String, nil]
+        optional :title, String, nil?: true
+
         # @!attribute value
         #   Tax valuation for the reward (the referrer's side of a double-sided reward).
         #
         #   @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, 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]
@@ -151,6 +164,8 @@ module GrowsurfRuby
         #
         #   @param image_url [String, nil]
         #
+        #   @param is_visible [Boolean] Whether the reward is enabled. When `false` the reward is disabled: hidden from
+        #
         #   @param limit [Integer, nil] `-1` represents an unlimited reward in REST responses.
         #
         #   @param limit_duration [Symbol, GrowsurfRuby::Models::Campaign::Reward::LimitDuration, nil]
@@ -169,7 +184,9 @@ module GrowsurfRuby
         #
         #   @param referred_reward_upfront [Boolean]
         #
-        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the referred friend's side of a double-sided reward.
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax treatment override for the referred friend's side of a double-sided reward.
+        #
+        #   @param title [String, nil] The reward title (internal label).
         #
         #   @param value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the reward (the referrer's side of a double-sided reward).
 

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

@@ -123,8 +123,8 @@ module GrowsurfRuby
                  api_name: :referredRewardUpfront
 
         # @!attribute referred_value
-        #   Tax valuation for the referred friend's side of a double-sided reward.
-        #   Defaults to not tax-reportable (a purchase rebate).
+        #   Tax treatment override for the referred friend's side of a double-sided reward.
+        #   Defaults to the program's confirmed default.
         #
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
         optional :referred_value,
@@ -183,7 +183,7 @@ module GrowsurfRuby
         #
         #   @param referred_reward_upfront [Boolean]
         #
-        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the referred friend's side of a double-sided reward. Defaults
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Tax treatment override for the referred friend's side of a double-sided reward. Defaults
         #
         #   @param title [String]
         #

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

@@ -128,8 +128,8 @@ module GrowsurfRuby
                  api_name: :referredRewardUpfront
 
         # @!attribute referred_value
-        #   Tax valuation for the referred friend's side of a double-sided reward.
-        #   Defaults to not tax-reportable (a purchase rebate).
+        #   Tax treatment override for the referred friend's side of a double-sided reward.
+        #   Defaults to the program's confirmed default.
         #
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
         optional :referred_value,
@@ -190,7 +190,7 @@ module GrowsurfRuby
         #
         #   @param referred_reward_upfront [Boolean]
         #
-        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Tax valuation for the referred friend's side of a double-sided reward. Defaults
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation] Tax treatment override for the referred friend's side of a double-sided reward. Defaults
         #
         #   @param title [String]
         #

data/lib/growsurf_ruby/models/campaign.rb

@@ -186,7 +186,7 @@ module GrowsurfRuby
                  api_name: :referredRewardUpfront
 
         # @!attribute referred_value
-        #   Tax valuation for the referred friend's side of a double-sided reward.
+        #   Tax treatment override for the referred friend's side of a double-sided reward.
         #
         #   @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
         optional :referred_value,
@@ -237,7 +237,7 @@ module GrowsurfRuby
         #
         #   @param referred_reward_upfront [Boolean]
         #
-        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the referred friend's side of a double-sided reward.
+        #   @param referred_value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax treatment override for the referred friend's side of a double-sided reward.
         #
         #   @param value [GrowsurfRuby::Models::RewardTaxValuation, nil] Tax valuation for the reward (the referrer's side of a double-sided reward).
 

data/lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#create_affiliate_invite
+    class CampaignCreateAffiliateInviteParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute email
+      #   Valid email address to invite. Maximum 255 characters.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute first_name
+      #   Invitee first name, used in the invite email. Maximum 255 characters.
+      #
+      #   @return [String, nil]
+      optional :first_name, String, api_name: :firstName
+
+      # @!attribute last_name
+      #   Invitee last name. Maximum 255 characters.
+      #
+      #   @return [String, nil]
+      optional :last_name, String, api_name: :lastName
+
+      # @!method initialize(id:, email:, first_name: nil, last_name: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param email [String] Valid email address to invite. Maximum 255 characters.
+      #
+      #   @param first_name [String] Invitee first name, used in the invite email. Maximum 255 characters.
+      #
+      #   @param last_name [String] Invitee last name. Maximum 255 characters.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_affiliate_applications_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_affiliate_applications
+    class CampaignListAffiliateApplicationsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute limit
+      #   How many applications to return per page (1-100).
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute offset
+      #   Offset number used to skip through a result set.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!attribute status
+      #   Only return applications with this status.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::Status, nil]
+      optional :status, enum: -> { GrowsurfRuby::CampaignListAffiliateApplicationsParams::Status }
+
+      # @!method initialize(id:, limit: nil, offset: nil, status: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param limit [Integer] How many applications to return per page (1-100).
+      #
+      #   @param offset [Integer] Offset number used to skip through a result set.
+      #
+      #   @param status [Symbol, GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::Status] Only return applications with this status.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # Only return applications with this status.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PENDING = :PENDING
+        APPROVED = :APPROVED
+        DENIED = :DENIED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_affiliate_invites_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_affiliate_invites
+    class CampaignListAffiliateInvitesParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute limit
+      #   How many invites to return per page (1-100).
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute offset
+      #   Offset number used to skip through a result set.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!attribute status
+      #   Only return invites with this status.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::Status, nil]
+      optional :status, enum: -> { GrowsurfRuby::CampaignListAffiliateInvitesParams::Status }
+
+      # @!method initialize(id:, limit: nil, offset: nil, status: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param limit [Integer] How many invites to return per page (1-100).
+      #
+      #   @param offset [Integer] Offset number used to skip through a result set.
+      #
+      #   @param status [Symbol, GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::Status] Only return invites with this status.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # Only return invites with this status.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PENDING = :PENDING
+        ACCEPTED = :ACCEPTED
+        EXPIRED = :EXPIRED
+        REVOKED = :REVOKED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_payouts_params.rb

@@ -49,6 +49,7 @@ module GrowsurfRuby
         QUEUED = :QUEUED
         ISSUED = :ISSUED
         FAILED = :FAILED
+        REVERSED = :REVERSED
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/growsurf_ruby/models/campaign_resend_affiliate_invite_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#resend_affiliate_invite
+    class CampaignResendAffiliateInviteParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute invite_id
+      #
+      #   @return [String]
+      required :invite_id, String
+
+      # @!method initialize(id:, invite_id:, request_options: {})
+      #   @param id [String]
+      #   @param invite_id [String]
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#retrieve_affiliate_application
+    class CampaignRetrieveAffiliateApplicationParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute application_id
+      #
+      #   @return [String]
+      required :application_id, String
+
+      # @!method initialize(id:, application_id:, request_options: {})
+      #   @param id [String]
+      #   @param application_id [String]
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb

@@ -26,11 +26,14 @@ module GrowsurfRuby
       optional :end_date, Integer
 
       # @!attribute include
-      #   Comma-separated list of optional enrichments (opt-in to keep the default response
-      #   lean): `previousPeriod` adds totals for the equal-length window immediately before
-      #   the requested one; `statusCounts` adds reward (and, for affiliate programs,
-      #   affiliate/commission/payout) status breakdowns; `rates` adds derived referral
-      #   rates.
+      #   Comma-separated list of optional data to include: `previousPeriod` adds totals for
+      #   the equal-length window immediately before the requested one; `statusCounts` adds
+      #   reward (and, for affiliate programs, affiliate/commission/payout) status breakdowns;
+      #   `rates` adds derived referral rates; `email` adds `sent`, `delivered`, `opened`,
+      #   `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.
       #
       #   @return [String, nil]
       optional :include, String
@@ -59,7 +62,7 @@ module GrowsurfRuby
       #
       #   @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
       #
-      #   @param include [String] Comma-separated list of optional enrichments (opt-in to keep the default response
+      #   @param include [String] Comma-separated list of optional data to include: `previousPeriod` adds totals for
       #
       #   @param interval [Symbol, GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::Interval] When set to `day`, `week`, or `month`, the response also includes a `series` array
       #