growsurf-ruby 1.2.1 → 1.3.0

data/lib/growsurf_ruby/models/affiliate_invite.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#create_affiliate_invite
+    class AffiliateInvite < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute accepted_at
+      #   When the invite was accepted, in Unix milliseconds. `null` until accepted.
+      #
+      #   @return [Integer, nil]
+      optional :accepted_at, Integer, api_name: :acceptedAt, nil?: true
+
+      # @!attribute created_at
+      #   When the invite was created, in Unix milliseconds.
+      #
+      #   @return [Integer, nil]
+      optional :created_at, Integer, api_name: :createdAt
+
+      # @!attribute email
+      #   Invitee email address.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute expires_at
+      #   When the emailed accept link stops working, in Unix milliseconds.
+      #
+      #   @return [Integer, nil]
+      optional :expires_at, Integer, api_name: :expiresAt
+
+      # @!attribute first_name
+      #   Invitee first name, when provided.
+      #
+      #   @return [String, nil]
+      optional :first_name, String, api_name: :firstName, nil?: true
+
+      # @!attribute id
+      #   Invite ID.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute last_name
+      #   Invitee last name, when provided.
+      #
+      #   @return [String, nil]
+      optional :last_name, String, api_name: :lastName, nil?: true
+
+      # @!attribute last_sent_at
+      #   When the invite email was last sent, in Unix milliseconds.
+      #
+      #   @return [Integer, nil]
+      optional :last_sent_at, Integer, api_name: :lastSentAt
+
+      # @!attribute revoked_at
+      #   When the invite was revoked, in Unix milliseconds. `null` unless revoked.
+      #
+      #   @return [Integer, nil]
+      optional :revoked_at, Integer, api_name: :revokedAt, nil?: true
+
+      # @!attribute status
+      #   The invite's lifecycle state. Accepting a pending invite enrolls the invitee as
+      #   an approved affiliate.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::AffiliateInvite::Status, nil]
+      optional :status, enum: -> { GrowsurfRuby::AffiliateInvite::Status }
+
+      # @!method initialize(accepted_at: nil, created_at: nil, email: nil, expires_at: nil, first_name: nil, id: nil, last_name: nil, last_sent_at: nil, revoked_at: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::AffiliateInvite} for more details.
+      #
+      #   @param accepted_at [Integer, nil] When the invite was accepted, in Unix milliseconds. `null` until accepted.
+      #
+      #   @param created_at [Integer] When the invite was created, in Unix milliseconds.
+      #
+      #   @param email [String] Invitee email address.
+      #
+      #   @param expires_at [Integer] When the emailed accept link stops working, in Unix milliseconds.
+      #
+      #   @param first_name [String, nil] Invitee first name, when provided.
+      #
+      #   @param id [String] Invite ID.
+      #
+      #   @param last_name [String, nil] Invitee last name, when provided.
+      #
+      #   @param last_sent_at [Integer] When the invite email was last sent, in Unix milliseconds.
+      #
+      #   @param revoked_at [Integer, nil] When the invite was revoked, in Unix milliseconds. `null` unless revoked.
+      #
+      #   @param status [Symbol, GrowsurfRuby::Models::AffiliateInvite::Status] The invite's lifecycle state. Accepting a pending invite enrolls the invitee as
+
+      # The invite's lifecycle state. Accepting a pending invite enrolls the invitee as
+      # an approved affiliate.
+      #
+      # @see GrowsurfRuby::Models::AffiliateInvite#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/affiliate_invite_list_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_affiliate_invites
+    class AffiliateInviteListResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute invites
+      #   One page of the program's invites, newest first.
+      #
+      #   @return [Array<GrowsurfRuby::Models::AffiliateInvite>]
+      required :invites, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::AffiliateInvite] }
+
+      # @!attribute total
+      #   Total number of invites matching the filter.
+      #
+      #   @return [Integer]
+      required :total, Integer
+
+      # @!attribute limit
+      #   The page size used.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute offset
+      #   The offset this page started at.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!method initialize(invites:, total:, limit: nil, offset: nil)
+      #   @param invites [Array<GrowsurfRuby::Models::AffiliateInvite>] One page of the program's invites, newest first.
+      #
+      #   @param total [Integer] Total number of invites matching the filter.
+      #
+      #   @param limit [Integer] The page size used.
+      #
+      #   @param offset [Integer] The offset this page started at.
+    end
+  end
+end

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

@@ -24,6 +24,15 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :ip_address, String, api_name: :ipAddress
 
+        # @!attribute is_affiliate
+        #   Affiliate programs only. Controls affiliate enrollment for a new participant.
+        #   `true` enrolls the participant with `affiliateStatus: APPROVED`; `false` creates
+        #   a non-affiliate without `affiliateStatus`. Existing participants are returned
+        #   unchanged.
+        #
+        #   @return [Boolean, nil]
+        optional :is_affiliate, GrowsurfRuby::Internal::Type::Boolean, api_name: :isAffiliate
+
         # @!attribute last_name
         #
         #   @return [String, nil]
@@ -60,7 +69,7 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :referred_by, String, api_name: :referredBy
 
-        # @!method initialize(email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, referral_status: nil, referred_by: nil)
+        # @!method initialize(email:, fingerprint: nil, first_name: nil, ip_address: nil, is_affiliate: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, referral_status: nil, referred_by: nil)
         #   Some parameter documentations has been truncated, see
         #   {GrowsurfRuby::Models::Campaign::Create} for more details.
         #
@@ -72,6 +81,8 @@ module GrowsurfRuby
         #
         #   @param ip_address [String]
         #
+        #   @param is_affiliate [Boolean] Affiliate programs only. Controls affiliate enrollment for a new participant.
+        #
         #   @param last_name [String]
         #
         #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.

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

@@ -41,9 +41,26 @@ module GrowsurfRuby
         required :rewards, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::ParticipantReward] }
 
         # @!attribute share_url
+        #   The unique share URL of the participant. Omitted for affiliate program
+        #   participants who are not approved affiliates.
         #
-        #   @return [String]
-        required :share_url, String, api_name: :shareUrl
+        #   @return [String, nil]
+        optional :share_url, String, api_name: :shareUrl
+
+        # @!attribute affiliate_enrollment_source
+        #   Affiliate programs only. How the affiliate enrolled (`OPEN_ENROLLMENT`,
+        #   `APPLICATION`, `PARTICIPANT_AUTH`, `INVITE`, `REST_API`, `CSV`, or `DASHBOARD`).
+        #   `null` when not recorded.
+        #
+        #   @return [String, nil]
+        optional :affiliate_enrollment_source, String, api_name: :affiliateEnrollmentSource, nil?: true
+
+        # @!attribute affiliate_status
+        #   Affiliate programs only. The enrolled affiliate's status (`APPROVED`,
+        #   `SUSPENDED`, or `BANNED`). `null` for participants who are not affiliates.
+        #
+        #   @return [String, nil]
+        optional :affiliate_status, String, api_name: :affiliateStatus, nil?: true
 
         # @!attribute all_matching_fraudsters
         #
@@ -96,6 +113,13 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :ip_address, String, api_name: :ipAddress, nil?: true
 
+        # @!attribute is_affiliate
+        #   Affiliate programs only. Whether this participant is an enrolled affiliate. A
+        #   referred customer who has not joined the program is `false`.
+        #
+        #   @return [Boolean, nil]
+        optional :is_affiliate, GrowsurfRuby::Internal::Type::Boolean, api_name: :isAffiliate
+
         # @!attribute is_new
         #
         #   @return [Boolean, nil]
@@ -137,6 +161,16 @@ module GrowsurfRuby
         #   @return [String, nil]
         optional :notes, String, nil?: true
 
+        # @!attribute payout_settings
+        #   Payout-related actions the participant must complete before a payout can be
+        #   released (e.g. configuring a payout destination or submitting a W-9/W-8 tax form).
+        #   Always present; the requiredActions array is empty when no action is required.
+        #
+        #   @return [GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings, nil]
+        optional :payout_settings,
+                 -> { GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings },
+                 api_name: :payoutSettings
+
         # @!attribute paypal_email_address
         #
         #   @return [String, nil]
@@ -215,7 +249,7 @@ module GrowsurfRuby
         #   @return [Array<String>, nil]
         optional :vanity_keys, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :vanityKeys
 
-        # @!method initialize(id:, email:, monthly_rank:, monthly_referral_count:, rank:, referral_count:, rewards:, share_url:, all_matching_fraudsters: nil, created_at: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_new: nil, is_winner: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, monthly_referrals: nil, notes: nil, paypal_email_address: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, referred_by: nil, referrer: nil, share_count: nil, unique_impression_count: nil, unread_commissions_count: nil, unread_payouts_count: nil, unsubscribed: nil, vanity_keys: nil)
+        # @!method initialize(id:, email:, monthly_rank:, monthly_referral_count:, rank:, referral_count:, rewards:, share_url: nil, affiliate_enrollment_source: nil, affiliate_status: nil, all_matching_fraudsters: nil, created_at: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_affiliate: nil, is_new: nil, is_winner: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, monthly_referrals: nil, notes: nil, payout_settings: nil, paypal_email_address: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, referred_by: nil, referrer: nil, share_count: nil, unique_impression_count: nil, unread_commissions_count: nil, unread_payouts_count: nil, unsubscribed: nil, vanity_keys: nil)
         #   Some parameter documentations has been truncated, see
         #   {GrowsurfRuby::Models::Campaign::CampaignParticipant} for more details.
         #
@@ -233,7 +267,12 @@ module GrowsurfRuby
         #
         #   @param rewards [Array<GrowsurfRuby::Models::Campaign::ParticipantReward>]
         #
-        #   @param share_url [String]
+        #   @param share_url [String, nil] The unique share URL of the participant. Omitted for
+        #     affiliate program participants who are not approved affiliates.
+        #
+        #   @param affiliate_enrollment_source [String, nil] Affiliate programs only. How the affiliate enrolled (`OPEN_ENROLLMENT`,
+        #
+        #   @param affiliate_status [String, nil] Affiliate programs only. The enrolled affiliate's status (`APPROVED`,
         #
         #   @param all_matching_fraudsters [Array<Hash{Symbol=>Object}>]
         #
@@ -253,6 +292,8 @@ module GrowsurfRuby
         #
         #   @param ip_address [String, nil]
         #
+        #   @param is_affiliate [Boolean] Affiliate programs only. Whether this participant is an enrolled affiliate. A
+        #
         #   @param is_new [Boolean]
         #
         #   @param is_winner [Boolean]
@@ -267,6 +308,8 @@ module GrowsurfRuby
         #
         #   @param notes [String, nil]
         #
+        #   @param payout_settings [GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings] Payout-related actions the participant must complete before a payout can be
+        #
         #   @param paypal_email_address [String]
         #
         #   @param prev_monthly_rank [Integer]
@@ -295,6 +338,38 @@ module GrowsurfRuby
         #
         #   @param vanity_keys [Array<String>]
 
+        # @see GrowsurfRuby::Models::Campaign::CampaignParticipant#payout_settings
+        class PayoutSettings < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute required_actions
+          #   Actions the participant must complete before payouts can be sent.
+          #
+          #   @return [Array<Symbol, GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::RequiredAction>, nil]
+          optional :required_actions,
+                   -> {
+                     GrowsurfRuby::Internal::Type::ArrayOf[
+                       enum: GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction
+                     ]
+                   },
+                   api_name: :requiredActions
+
+          # @!method initialize(required_actions: nil)
+          #   Payout-related actions the participant must complete before a payout can be
+          #   released (e.g. configuring a payout destination or submitting a W-9/W-8 tax form).
+          #   Always present; the requiredActions array is empty when no action is required.
+          #
+          #   @param required_actions [Array<Symbol, GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::RequiredAction>] Actions the participant must complete before payouts can be sent.
+
+          module RequiredAction
+            extend GrowsurfRuby::Internal::Type::Enum
+
+            PAYOUT_DESTINATION = :PAYOUT_DESTINATION
+            TAX_INFO = :TAX_INFO
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # @see GrowsurfRuby::Models::Campaign::CampaignParticipant#referrer
         class Referrer < GrowsurfRuby::Internal::Type::BaseModel
           # @!attribute id

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

@@ -23,8 +23,11 @@ module GrowsurfRuby
                  GrowsurfRuby::Internal::Type::HashOf[Integer],
                  api_name: :shareCount
 
+        # Present only when `include` contains `email`.
+        optional :email, -> { GrowsurfRuby::Models::EmailAnalytics }
+
         # @!attribute end_date
-        #   Present only with `include=series`. Window end (Unix ms).
+        #   Present only when `include` contains `series` or `email`. Window end (Unix ms).
         #
         #   @return [Integer, nil]
         optional :end_date, Integer, api_name: :endDate
@@ -43,7 +46,7 @@ module GrowsurfRuby
                  }
 
         # @!attribute start_date
-        #   Present only with `include=series`. Window start (Unix ms).
+        #   Present only when `include` contains `series` or `email`. Window start (Unix ms).
         #
         #   @return [Integer, nil]
         optional :start_date, Integer, api_name: :startDate
@@ -58,11 +61,11 @@ module GrowsurfRuby
         #
         #   @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 end_date [Integer] Present only when `include` contains `series` or `email`. 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).
+        #   @param start_date [Integer] Present only when `include` contains `series` or `email`. Window start (Unix ms).
 
         # @see GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse#analytics
         class Analytics < GrowsurfRuby::Internal::Type::BaseModel
@@ -96,10 +99,13 @@ module GrowsurfRuby
           #   @return [Integer, nil]
           optional :monthly_referrals, Integer, api_name: :monthlyReferrals
 
-          # @!attribute pending_rewards
+          # @!attribute reward_status
+          #   This participant's reward counts grouped by review and fulfillment status.
           #
-          #   @return [Integer, nil]
-          optional :pending_rewards, Integer, api_name: :pendingRewards
+          #   @return [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus, nil]
+          optional :reward_status,
+                   -> { GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus },
+                   api_name: :rewardStatus
 
           # @!attribute referral_revenue
           #   Affiliate only. Revenue attributed to this participant's referrals, in minor
@@ -113,11 +119,6 @@ module GrowsurfRuby
           #   @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.
           #
@@ -141,7 +142,7 @@ module GrowsurfRuby
           #   @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)
+          # @!method initialize(currency_iso: nil, expired_referrals: nil, impressions: nil, invites_sent: nil, leads: nil, monthly_referrals: nil, referral_revenue: nil, referrals: nil, reward_status: 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.
@@ -158,13 +159,11 @@ module GrowsurfRuby
           #
           #   @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 reward_status [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus] This participant's reward counts grouped by review and fulfillment status.
           #
           #   @param total_commissions [Integer] Affiliate only. Total commissions earned, in minor currency units.
           #
@@ -222,6 +221,9 @@ module GrowsurfRuby
           #   @return [Integer, nil]
           optional :email_shares, Integer, api_name: :emailShares
 
+          # Per-period email counts when both `series` and `email` are requested.
+          optional :email, -> { GrowsurfRuby::Models::EmailAnalytics::Counts }
+
           # @!attribute facebook_shares
           #
           #   @return [Integer, nil]
@@ -337,6 +339,13 @@ module GrowsurfRuby
           #   @return [Integer, nil]
           optional :twitter_shares, Integer, api_name: :twitterShares
 
+          # @!attribute unique_commission_referrals
+          #   Affiliate programs only. Number of unique referred participants represented by
+          #   commissions in the requested timeframe.
+          #
+          #   @return [Integer, nil]
+          optional :unique_commission_referrals, Integer, api_name: :uniqueCommissionReferrals
+
           # @!attribute unique_impressions
           #
           #   @return [Integer, nil]
@@ -352,7 +361,7 @@ module GrowsurfRuby
           #   @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)
+          # @!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_commission_referrals: 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.
@@ -409,6 +418,8 @@ module GrowsurfRuby
           #
           #   @param twitter_shares [Integer]
           #
+          #   @param unique_commission_referrals [Integer] Affiliate programs only. Number of unique referred participants represented by commissions in the requested timeframe.
+          #
           #   @param unique_impressions [Integer]
           #
           #   @param wechat_shares [Integer]

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#get_payout_destination
+      class ParticipantGetPayoutDestinationParams < 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
+
+        # @!method initialize(id:, participant_id_or_email:, request_options: {})
+        #   @param id [String]
+        #   @param participant_id_or_email [String]
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#get_payout_destination
+      class ParticipantGetPayoutDestinationResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute active_provider
+        #   The provider that currently gets paid, or null until the participant confirms
+        #   one.
+        #
+        #   @return [String, nil]
+        optional :active_provider, String, api_name: :activeProvider, nil?: true
+
+        # @!attribute destinations
+        #   One entry per enabled payout provider describing the participant's destination
+        #   for it.
+        #
+        #   @return [Array<GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination>, nil]
+        optional :destinations,
+                 -> {
+                   GrowsurfRuby::Internal::Type::ArrayOf[
+                     GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination
+                   ]
+                 }
+
+        # @!attribute enabled_providers
+        #   The payout providers enabled for this program.
+        #
+        #   @return [Array<String>, nil]
+        optional :enabled_providers,
+                 -> {
+                   GrowsurfRuby::Internal::Type::ArrayOf[String]
+                 },
+                 api_name: :enabledProviders
+
+        # @!method initialize(active_provider: nil, destinations: nil, enabled_providers: nil)
+        #   @param active_provider [String, nil] The provider that currently gets paid, or null until the participant confirms one.
+        #
+        #   @param destinations [Array<GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination>] One entry per enabled payout provider describing the participant's destination for it.
+        #
+        #   @param enabled_providers [Array<String>] The payout providers enabled for this program.
+
+        # @see GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse#destinations
+        class Destination < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute claim_email
+          #   The confirmed payout email for this provider.
+          #
+          #   @return [String, nil]
+          optional :claim_email, String, api_name: :claimEmail, nil?: true
+
+          # @!attribute confirmed_at
+          #   When the destination was confirmed, as a Unix timestamp in milliseconds.
+          #
+          #   @return [Integer, nil]
+          optional :confirmed_at, Integer, api_name: :confirmedAt, nil?: true
+
+          # @!attribute legal_entity_type
+          #   The legal recipient type the participant confirmed, if any.
+          #
+          #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType, nil]
+          optional :legal_entity_type,
+                   enum: -> {
+                     GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType
+                   },
+                   api_name: :legalEntityType,
+                   nil?: true
+
+          # @!attribute needs_repair_reason
+          #   When status is `NEEDS_REPAIR`, why (e.g. a bounced delivery).
+          #
+          #   @return [String, nil]
+          optional :needs_repair_reason, String, api_name: :needsRepairReason, nil?: true
+
+          # @!attribute provider
+          #   The payout provider this entry describes.
+          #
+          #   @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
+          #   The destination's current status: `NONE` (not set up), `PENDING_CONFIRMATION`,
+          #   `CONFIRMED`, `ACTIVE`, `NEEDS_REPAIR`, or `EXPIRED`. Historical superseded
+          #   or revoked destinations are projected as `NONE`.
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!method initialize(claim_email: nil, confirmed_at: nil, legal_entity_type: nil, needs_repair_reason: nil, provider: nil, provider_display_name: nil, status: nil)
+          #   @param claim_email [String, nil] The confirmed payout email for this provider.
+          #
+          #   @param confirmed_at [Integer, nil] When the destination was confirmed, as a Unix timestamp in milliseconds.
+          #
+          #   @param legal_entity_type [Symbol, GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType, nil] The legal recipient type the participant confirmed, if any.
+          #
+          #   @param needs_repair_reason [String, nil] When status is `NEEDS_REPAIR`, why (e.g. a bounced delivery).
+          #
+          #   @param provider [String] The payout provider this entry describes.
+          #
+          #   @param provider_display_name [String] The customer-facing provider name (e.g. "PayPal", "Wise").
+          #
+          #   @param status [String] The destination's current status: `NONE` (not set up), `PENDING_CONFIRMATION`, `CONFIRMED`, `ACTIVE`, `NEEDS_REPAIR`, or `EXPIRED`.
+
+          # The legal recipient type the participant confirmed, if any.
+          #
+          # @see GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination#legal_entity_type
+          module LegalEntityType
+            extend GrowsurfRuby::Internal::Type::Enum
+
+            INDIVIDUAL = :INDIVIDUAL
+            BUSINESS = :BUSINESS
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#request_payout_destination_confirmation
+      class ParticipantRequestPayoutDestinationConfirmationParams < 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 provider
+        #   The payout provider the participant should confirm a destination for.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider]
+        required :provider,
+                 enum: -> { GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider }
+
+        # @!method initialize(id:, participant_id_or_email:, provider:, request_options: {})
+        #   @param id [String]
+        #
+        #   @param participant_id_or_email [String]
+        #
+        #   @param provider [Symbol, GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider] The payout provider the participant should confirm a destination for.
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        # The payout provider the participant should confirm a destination for.
+        module Provider
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          PAYPAL = :PAYPAL
+          WISECOM = :WISECOM
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end