growsurf-ruby 1.0.0 → 1.1.0

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

@@ -0,0 +1,421 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#retrieve_analytics
+      class ParticipantAnalyticsResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute analytics
+        #
+        #   @return [GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Analytics]
+        required :analytics, -> { GrowsurfRuby::Campaign::ParticipantAnalyticsResponse::Analytics }
+
+        # @!attribute ranks
+        #
+        #   @return [GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Ranks]
+        required :ranks, -> { GrowsurfRuby::Campaign::ParticipantAnalyticsResponse::Ranks }
+
+        # @!attribute share_count
+        #   Per-channel share counts (e.g. `email`, `facebook`, `twitter`, ...).
+        #
+        #   @return [Hash{Symbol=>Integer}]
+        required :share_count,
+                 GrowsurfRuby::Internal::Type::HashOf[Integer],
+                 api_name: :shareCount
+
+        # @!attribute end_date
+        #   Present only with `include=series`. Window end (Unix ms).
+        #
+        #   @return [Integer, nil]
+        optional :end_date, Integer, api_name: :endDate
+
+        # @!attribute series
+        #   Present only when `include=series`. This participant's own referral-link activity
+        #   per period (ascending), windowed by `days`/`startDate`/`endDate` and bucketed by
+        #   `interval`.
+        #
+        #   @return [Array<GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Series>, nil]
+        optional :series,
+                 -> {
+                   GrowsurfRuby::Internal::Type::ArrayOf[
+                     GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Series
+                   ]
+                 }
+
+        # @!attribute start_date
+        #   Present only with `include=series`. Window start (Unix ms).
+        #
+        #   @return [Integer, nil]
+        optional :start_date, Integer, api_name: :startDate
+
+        # @!method initialize(analytics:, ranks:, share_count:, end_date: nil, series: nil, start_date: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse} for more details.
+        #
+        #   @param analytics [GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Analytics]
+        #
+        #   @param ranks [GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Ranks]
+        #
+        #   @param share_count [Hash{Symbol=>Integer}] Per-channel share counts (e.g. `email`, `facebook`, `twitter`, ...).
+        #
+        #   @param end_date [Integer] Present only with `include=series`. Window end (Unix ms).
+        #
+        #   @param series [Array<GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Series>] Present only when `include=series`. This participant's own referral-link activity
+        #
+        #   @param start_date [Integer] Present only with `include=series`. Window start (Unix ms).
+
+        # @see GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse#analytics
+        class Analytics < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute currency_iso
+          #
+          #   @return [String, nil]
+          optional :currency_iso, String, api_name: :currencyISO
+
+          # @!attribute expired_referrals
+          #
+          #   @return [Integer, nil]
+          optional :expired_referrals, Integer, api_name: :expiredReferrals
+
+          # @!attribute impressions
+          #
+          #   @return [Integer, nil]
+          optional :impressions, Integer
+
+          # @!attribute invites_sent
+          #
+          #   @return [Integer, nil]
+          optional :invites_sent, Integer, api_name: :invitesSent
+
+          # @!attribute leads
+          #
+          #   @return [Integer, nil]
+          optional :leads, Integer
+
+          # @!attribute monthly_referrals
+          #
+          #   @return [Integer, nil]
+          optional :monthly_referrals, Integer, api_name: :monthlyReferrals
+
+          # @!attribute pending_rewards
+          #
+          #   @return [Integer, nil]
+          optional :pending_rewards, Integer, api_name: :pendingRewards
+
+          # @!attribute referral_revenue
+          #   Affiliate only. Revenue attributed to this participant's referrals, in minor
+          #   currency units.
+          #
+          #   @return [Integer, nil]
+          optional :referral_revenue, Integer, api_name: :referralRevenue
+
+          # @!attribute referrals
+          #
+          #   @return [Integer, nil]
+          optional :referrals, Integer
+
+          # @!attribute rewards_earned
+          #
+          #   @return [Integer, nil]
+          optional :rewards_earned, Integer, api_name: :rewardsEarned
+
+          # @!attribute total_commissions
+          #   Affiliate only. Total commissions earned, in minor currency units.
+          #
+          #   @return [Integer, nil]
+          optional :total_commissions, Integer, api_name: :totalCommissions
+
+          # @!attribute total_paid_out
+          #   Affiliate only. Total paid out, in minor currency units.
+          #
+          #   @return [Integer, nil]
+          optional :total_paid_out, Integer, api_name: :totalPaidOut
+
+          # @!attribute unique_impressions
+          #
+          #   @return [Integer, nil]
+          optional :unique_impressions, Integer, api_name: :uniqueImpressions
+
+          # @!attribute upcoming_payout
+          #   Affiliate only. Approved commissions ready to pay, in minor currency units.
+          #
+          #   @return [Integer, nil]
+          optional :upcoming_payout, Integer, api_name: :upcomingPayout
+
+          # @!method initialize(currency_iso: nil, expired_referrals: nil, impressions: nil, invites_sent: nil, leads: nil, monthly_referrals: nil, pending_rewards: nil, referral_revenue: nil, referrals: nil, rewards_earned: nil, total_commissions: nil, total_paid_out: nil, unique_impressions: nil, upcoming_payout: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Analytics} for
+          #   more details.
+          #
+          #   @param currency_iso [String]
+          #
+          #   @param expired_referrals [Integer]
+          #
+          #   @param impressions [Integer]
+          #
+          #   @param invites_sent [Integer]
+          #
+          #   @param leads [Integer]
+          #
+          #   @param monthly_referrals [Integer]
+          #
+          #   @param pending_rewards [Integer]
+          #
+          #   @param referral_revenue [Integer] Affiliate only. Revenue attributed to this participant's referrals, in minor curr
+          #
+          #   @param referrals [Integer]
+          #
+          #   @param rewards_earned [Integer]
+          #
+          #   @param total_commissions [Integer] Affiliate only. Total commissions earned, in minor currency units.
+          #
+          #   @param total_paid_out [Integer] Affiliate only. Total paid out, in minor currency units.
+          #
+          #   @param unique_impressions [Integer]
+          #
+          #   @param upcoming_payout [Integer] Affiliate only. Approved commissions ready to pay, in minor currency units.
+        end
+
+        # @see GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse#ranks
+        class Ranks < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute monthly_rank
+          #
+          #   @return [Integer, nil]
+          optional :monthly_rank, Integer, api_name: :monthlyRank, nil?: true
+
+          # @!attribute prev_monthly_rank
+          #
+          #   @return [Integer, nil]
+          optional :prev_monthly_rank, Integer, api_name: :prevMonthlyRank, nil?: true
+
+          # @!attribute rank
+          #   All-time rank (1-indexed), or null when unranked.
+          #
+          #   @return [Integer, nil]
+          optional :rank, Integer, nil?: true
+
+          # @!method initialize(monthly_rank: nil, prev_monthly_rank: nil, rank: nil)
+          #   @param monthly_rank [Integer, nil]
+          #
+          #   @param prev_monthly_rank [Integer, nil]
+          #
+          #   @param rank [Integer, nil] All-time rank (1-indexed), or null when unranked.
+        end
+
+        class Series < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute android_native_shares
+          #
+          #   @return [Integer, nil]
+          optional :android_native_shares, Integer, api_name: :androidNativeShares
+
+          # @!attribute bluesky_shares
+          #
+          #   @return [Integer, nil]
+          optional :bluesky_shares, Integer, api_name: :blueskyShares
+
+          # @!attribute copy_ref_link_shares
+          #
+          #   @return [Integer, nil]
+          optional :copy_ref_link_shares, Integer, api_name: :copyRefLinkShares
+
+          # @!attribute email_shares
+          #
+          #   @return [Integer, nil]
+          optional :email_shares, Integer, api_name: :emailShares
+
+          # @!attribute facebook_shares
+          #
+          #   @return [Integer, nil]
+          optional :facebook_shares, Integer, api_name: :facebookShares
+
+          # @!attribute impressions
+          #
+          #   @return [Integer, nil]
+          optional :impressions, Integer
+
+          # @!attribute invites
+          #
+          #   @return [Integer, nil]
+          optional :invites, Integer
+
+          # @!attribute ios_native_shares
+          #
+          #   @return [Integer, nil]
+          optional :ios_native_shares, Integer, api_name: :iosNativeShares
+
+          # @!attribute linked_in_shares
+          #
+          #   @return [Integer, nil]
+          optional :linked_in_shares, Integer, api_name: :linkedInShares
+
+          # @!attribute messenger_shares
+          #
+          #   @return [Integer, nil]
+          optional :messenger_shares, Integer, api_name: :messengerShares
+
+          # @!attribute participants
+          #
+          #   @return [Integer, nil]
+          optional :participants, Integer
+
+          # @!attribute period_start
+          #   Start of the period, as a Unix timestamp in milliseconds (UTC).
+          #
+          #   @return [Integer, nil]
+          optional :period_start, Integer, api_name: :periodStart
+
+          # @!attribute pinterest_shares
+          #
+          #   @return [Integer, nil]
+          optional :pinterest_shares, Integer, api_name: :pinterestShares
+
+          # @!attribute qrcode_shares
+          #
+          #   @return [Integer, nil]
+          optional :qrcode_shares, Integer, api_name: :qrcodeShares
+
+          # @!attribute reddit_shares
+          #
+          #   @return [Integer, nil]
+          optional :reddit_shares, Integer, api_name: :redditShares
+
+          # @!attribute referral_credit_expireds
+          #
+          #   @return [Integer, nil]
+          optional :referral_credit_expireds, Integer, api_name: :referralCreditExpireds
+
+          # @!attribute referral_credit_pendings
+          #
+          #   @return [Integer, nil]
+          optional :referral_credit_pendings, Integer, api_name: :referralCreditPendings
+
+          # @!attribute referrals
+          #
+          #   @return [Integer, nil]
+          optional :referrals, Integer
+
+          # @!attribute sms_shares
+          #
+          #   @return [Integer, nil]
+          optional :sms_shares, Integer, api_name: :smsShares
+
+          # @!attribute telegram_shares
+          #
+          #   @return [Integer, nil]
+          optional :telegram_shares, Integer, api_name: :telegramShares
+
+          # @!attribute threads_shares
+          #
+          #   @return [Integer, nil]
+          optional :threads_shares, Integer, api_name: :threadsShares
+
+          # @!attribute total_commission_count
+          #   Affiliate programs only. Number of commission records.
+          #
+          #   @return [Integer, nil]
+          optional :total_commission_count, Integer, api_name: :totalCommissionCount
+
+          # @!attribute total_commissions
+          #   Affiliate programs only. Commissions in the smallest unit of the program
+          #   currency.
+          #
+          #   @return [Integer, nil]
+          optional :total_commissions, Integer, api_name: :totalCommissions
+
+          # @!attribute total_revenue
+          #   Affiliate programs only. Revenue in the smallest unit of the program currency.
+          #
+          #   @return [Integer, nil]
+          optional :total_revenue, Integer, api_name: :totalRevenue
+
+          # @!attribute tumblr_shares
+          #
+          #   @return [Integer, nil]
+          optional :tumblr_shares, Integer, api_name: :tumblrShares
+
+          # @!attribute twitter_shares
+          #
+          #   @return [Integer, nil]
+          optional :twitter_shares, Integer, api_name: :twitterShares
+
+          # @!attribute unique_impressions
+          #
+          #   @return [Integer, nil]
+          optional :unique_impressions, Integer, api_name: :uniqueImpressions
+
+          # @!attribute wechat_shares
+          #
+          #   @return [Integer, nil]
+          optional :wechat_shares, Integer, api_name: :wechatShares
+
+          # @!attribute whats_app_shares
+          #
+          #   @return [Integer, nil]
+          optional :whats_app_shares, Integer, api_name: :whatsAppShares
+
+          # @!method initialize(android_native_shares: nil, bluesky_shares: nil, copy_ref_link_shares: nil, email_shares: nil, facebook_shares: nil, impressions: nil, invites: nil, ios_native_shares: nil, linked_in_shares: nil, messenger_shares: nil, participants: nil, period_start: nil, pinterest_shares: nil, qrcode_shares: nil, reddit_shares: nil, referral_credit_expireds: nil, referral_credit_pendings: nil, referrals: nil, sms_shares: nil, telegram_shares: nil, threads_shares: nil, total_commission_count: nil, total_commissions: nil, total_revenue: nil, tumblr_shares: nil, twitter_shares: nil, unique_impressions: nil, wechat_shares: nil, whats_app_shares: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse::Series} for more
+          #   details.
+          #
+          #   @param android_native_shares [Integer]
+          #
+          #   @param bluesky_shares [Integer]
+          #
+          #   @param copy_ref_link_shares [Integer]
+          #
+          #   @param email_shares [Integer]
+          #
+          #   @param facebook_shares [Integer]
+          #
+          #   @param impressions [Integer]
+          #
+          #   @param invites [Integer]
+          #
+          #   @param ios_native_shares [Integer]
+          #
+          #   @param linked_in_shares [Integer]
+          #
+          #   @param messenger_shares [Integer]
+          #
+          #   @param participants [Integer]
+          #
+          #   @param period_start [Integer] Start of the period, as a Unix timestamp in milliseconds (UTC).
+          #
+          #   @param pinterest_shares [Integer]
+          #
+          #   @param qrcode_shares [Integer]
+          #
+          #   @param reddit_shares [Integer]
+          #
+          #   @param referral_credit_expireds [Integer]
+          #
+          #   @param referral_credit_pendings [Integer]
+          #
+          #   @param referrals [Integer]
+          #
+          #   @param sms_shares [Integer]
+          #
+          #   @param telegram_shares [Integer]
+          #
+          #   @param threads_shares [Integer]
+          #
+          #   @param total_commission_count [Integer] Affiliate programs only. Number of commission records.
+          #
+          #   @param total_commissions [Integer] Affiliate programs only. Commissions in the smallest unit of the program currenc
+          #
+          #   @param total_revenue [Integer] Affiliate programs only. Revenue in the smallest unit of the program currency.
+          #
+          #   @param tumblr_shares [Integer]
+          #
+          #   @param twitter_shares [Integer]
+          #
+          #   @param unique_impressions [Integer]
+          #
+          #   @param wechat_shares [Integer]
+          #
+          #   @param whats_app_shares [Integer]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#bulk_delete
+      class ParticipantBulkDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participants
+        #   GrowSurf participant IDs and/or email addresses to delete. Mixed entries are
+        #   allowed.
+        #
+        #   @return [Array<String>]
+        required :participants, GrowsurfRuby::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, participants:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param participants [Array<String>] GrowSurf participant IDs and/or email addresses to delete. Mixed entries are al
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#bulk_delete
+      class ParticipantBulkDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute results
+        #   One entry per submitted identifier, in the same order as the request.
+        #
+        #   @return [Array<GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result>]
+        required :results,
+                 -> {
+                   GrowsurfRuby::Internal::Type::ArrayOf[
+                     GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Result
+                   ]
+                 }
+
+        # @!attribute summary
+        #
+        #   @return [GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary]
+        required :summary, -> { GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Summary }
+
+        # @!method initialize(results:, summary:)
+        #   @param results [Array<GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result>] One entry per submitted identifier, in the same order as the request.
+        #
+        #   @param summary [GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary]
+
+        class Result < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute identifier
+          #   The submitted participant ID or email address, echoed back as received.
+          #
+          #   @return [String]
+          required :identifier, String
+
+          # @!attribute index
+          #   Zero-based position of this entry in the submitted `participants` array.
+          #
+          #   @return [Integer]
+          required :index, Integer
+
+          # @!attribute status
+          #   Per-row outcome. `DELETED` — the participant was resolved and removed.
+          #   `NOT_FOUND` — no participant matches the ID or email. `DUPLICATE` — the entry
+          #   resolves to the same participant as an earlier entry in the same request.
+          #   `ERROR` — the lookup or deletion failed for this row.
+          #
+          #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result::Status]
+          required :status, enum: -> { GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Result::Status }
+
+          # @!attribute email
+          #   The resolved participant's email address. Present on `DELETED` rows.
+          #
+          #   @return [String, nil]
+          optional :email, String
+
+          # @!attribute message
+          #   Human-readable detail for `NOT_FOUND`, `DUPLICATE`, and `ERROR` rows.
+          #
+          #   @return [String, nil]
+          optional :message, String
+
+          # @!attribute participant_id
+          #   The resolved GrowSurf participant ID. Present when the entry resolved to a
+          #   participant.
+          #
+          #   @return [String, nil]
+          optional :participant_id, String, api_name: :participantId
+
+          # @!method initialize(identifier:, index:, status:, email: nil, message: nil, participant_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result} for
+          #   more details.
+          #
+          #   @param identifier [String] The submitted participant ID or email address, echoed back as received.
+          #
+          #   @param index [Integer] Zero-based position of this entry in the submitted `participants` array.
+          #
+          #   @param status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result::Status] Per-row outcome. `DELETED` — the participant was resolved and removed. `NOT_FOU
+          #
+          #   @param email [String] The resolved participant's email address. Present on `DELETED` rows.
+          #
+          #   @param message [String] Human-readable detail for `NOT_FOUND`, `DUPLICATE`, and `ERROR` rows.
+          #
+          #   @param participant_id [String] The resolved GrowSurf participant ID. Present when the entry resolved to a part
+
+          # Per-row outcome. `DELETED` — the participant was resolved and removed.
+          # `NOT_FOUND` — no participant matches the ID or email. `DUPLICATE` — the entry
+          # resolves to the same participant as an earlier entry in the same request.
+          # `ERROR` — the lookup or deletion failed for this row.
+          #
+          # @see GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result#status
+          module Status
+            extend GrowsurfRuby::Internal::Type::Enum
+
+            DELETED = :DELETED
+            NOT_FOUND = :NOT_FOUND
+            DUPLICATE = :DUPLICATE
+            ERROR = :ERROR
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Summary < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute deleted_count
+          #   Entries that resolved to a participant and were deleted.
+          #
+          #   @return [Integer]
+          required :deleted_count, Integer, api_name: :deletedCount
+
+          # @!attribute duplicate_count
+          #   Entries that resolved to the same participant as an earlier entry.
+          #
+          #   @return [Integer]
+          required :duplicate_count, Integer, api_name: :duplicateCount
+
+          # @!attribute error_count
+          #   Entries that failed to look up or delete.
+          #
+          #   @return [Integer]
+          required :error_count, Integer, api_name: :errorCount
+
+          # @!attribute not_found_count
+          #   Entries that did not match any participant.
+          #
+          #   @return [Integer]
+          required :not_found_count, Integer, api_name: :notFoundCount
+
+          # @!attribute total
+          #   Number of entries submitted in this request.
+          #
+          #   @return [Integer]
+          required :total, Integer
+
+          # @!method initialize(deleted_count:, duplicate_count:, error_count:, not_found_count:, total:)
+          #   @param deleted_count [Integer] Entries that resolved to a participant and were deleted.
+          #
+          #   @param duplicate_count [Integer] Entries that resolved to the same participant as an earlier entry.
+          #
+          #   @param error_count [Integer] Entries that failed to look up or delete.
+          #
+          #   @param not_found_count [Integer] Entries that did not match any participant.
+          #
+          #   @param total [Integer] Number of entries submitted in this request.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#email
+      class ParticipantEmailParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, String
+
+        # @!attribute body
+        #   HTML body for a free-form email. You can personalize it with dynamic text,
+        #   inserting `{{...}}` tokens like `{{firstName}}` or `{{shareUrl}}`. See
+        #   [Guide to using dynamic text in GrowSurf emails](https://support.growsurf.com/article/213-guide-to-using-dynamic-text-in-growsurf-emails).
+        #
+        #   @return [String, nil]
+        optional :body, String
+
+        # @!attribute email_type
+        #   The program email template to send (template mode). Send the camelCase key.
+        #   The valid types depend on the program type; `isEnabled` only controls automatic sends.
+        #   Referral programs: `welcomeNonReferred`, `referralLinkViewedFirstTime`,
+        #   `referralLinkUsed`, `referredSignup`, `welcomeReferred`, `goalAchieved`,
+        #   `campaignEndedWinners`, `campaignEndedNonWinners`, `progressUpdateMonthly`.
+        #   Affiliate programs: `welcomeNonReferred`, `referralLinkViewedFirstTime`,
+        #   `referredSignup`, `commissionGenerated`, `commissionAdjusted`, `payoutPending`,
+        #   `payoutSentSuccess`, `progressUpdateMonthly`. System/transactional types (login
+        #   link, PayPal confirmation, tax) and the invite email cannot be sent.
+        #
+        #   @return [String, nil]
+        optional :email_type, String, api_name: :emailType
+
+        # @!attribute preheader
+        #   Optional preheader text for a free-form email.
+        #
+        #   @return [String, nil]
+        optional :preheader, String
+
+        # @!attribute subject
+        #   Subject line for a free-form email. Supports dynamic text (`{{...}}` tokens),
+        #   the same as the body.
+        #
+        #   @return [String, nil]
+        optional :subject, String
+
+        # @!method initialize(id:, participant_id_or_email:, body: nil, email_type: nil, preheader: nil, subject: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::Campaign::ParticipantEmailParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param participant_id_or_email [String]
+        #
+        #   @param body [String] HTML body for a free-form email. You can personalize it with dynamic text, inserting `{{...}}` tokens like `{{firstName}}` or `{{shareUrl}}`. See [Guide to using dynamic text in GrowSurf emails](https://support.growsurf.com/article/213-guide-to-using-dynamic-text-in-growsurf-emails).
+        #
+        #   @param email_type [String] The program email template to send (template mode). Send the camelCase key; it m
+        #
+        #   @param preheader [String] Optional preheader text for a free-form email.
+        #
+        #   @param subject [String] Subject line for a free-form email. Supports dynamic text (`{{...}}` tokens), the same as the body.
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end