growsurf-ruby 1.2.1 → 1.3.0

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb

@@ -19,6 +19,9 @@ module GrowsurfRuby
       #   @return [Integer]
       required :start_date, Integer, api_name: :startDate
 
+      # Present only when `include` contains `email`.
+      optional :email, -> { GrowsurfRuby::Models::EmailAnalytics }
+
       # @!attribute previous_period
       #   Present only when `include` contains `previousPeriod`.
       #
@@ -199,6 +202,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]
@@ -214,7 +224,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, 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, 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::CampaignRetrieveAnalyticsResponse::Analytics} for more
         #   details.
@@ -269,6 +279,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]
@@ -283,6 +295,9 @@ module GrowsurfRuby
         #   @return [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics]
         required :analytics, -> { GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics }
 
+        # Present when the parent request includes both `previousPeriod` and `email`.
+        optional :email, -> { GrowsurfRuby::Models::EmailAnalytics }
+
         # @!attribute end_date
         #
         #   @return [Integer]
@@ -355,6 +370,9 @@ module GrowsurfRuby
         #   @return [Integer, nil]
         optional :email_shares, Integer, api_name: :emailShares
 
+        # Per-period email counts. Present only when `include` contains `email`.
+        optional :email, -> { GrowsurfRuby::Models::EmailAnalytics::Counts }
+
         # @!attribute facebook_shares
         #
         #   @return [Integer, nil]
@@ -470,6 +488,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]
@@ -485,7 +510,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::CampaignRetrieveAnalyticsResponse::Series} for more
         #   details.
@@ -542,6 +567,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]
@@ -711,6 +738,14 @@ module GrowsurfRuby
                      GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
                    }
 
+          # @!attribute reversed
+          #
+          #   @return [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric, nil]
+          optional :reversed,
+                   -> {
+                     GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
+                   }
+
           # @!attribute upcoming
           #
           #   @return [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric, nil]
@@ -719,7 +754,7 @@ module GrowsurfRuby
                      GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
                    }
 
-          # @!method initialize(failed: nil, issued: nil, queued: nil, upcoming: nil)
+          # @!method initialize(failed: nil, issued: nil, queued: nil, reversed: nil, upcoming: nil)
           #   Affiliate only. Payout counts and amounts by status.
           #
           #   @param failed [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric]
@@ -728,6 +763,8 @@ module GrowsurfRuby
           #
           #   @param queued [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric]
           #
+          #   @param reversed [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric]
+          #
           #   @param upcoming [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric]
 
           class PayoutStatusMetric < GrowsurfRuby::Internal::Type::BaseModel
@@ -751,21 +788,32 @@ module GrowsurfRuby
 
         # @see GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts#reward_status
         class RewardStatus < GrowsurfRuby::Internal::Type::BaseModel
-          # @!attribute approved
+          # @!attribute completed
+          #   Approved rewards that are fulfilled.
           #
           #   @return [Integer, nil]
-          optional :approved, Integer
+          optional :completed, Integer
 
-          # @!attribute pending
-          #   Unapproved rewards awaiting fulfillment.
+          # @!attribute unapproved
+          #   Unapproved rewards awaiting review.
+          #
+          #   @return [Integer, nil]
+          optional :unapproved, Integer
+
+          # @!attribute unfulfilled
+          #   Rewards that are approved but not fulfilled.
           #
           #   @return [Integer, nil]
-          optional :pending, Integer
+          optional :unfulfilled, Integer
 
-          # @!method initialize(approved: nil, pending: nil)
-          #   @param approved [Integer]
+          # @!method initialize(completed: nil, unapproved: nil, unfulfilled: nil)
+          #   Reward counts grouped by review and fulfillment status.
+          #
+          #   @param completed [Integer] Approved rewards that are fulfilled.
+          #
+          #   @param unapproved [Integer] Unapproved rewards awaiting review.
           #
-          #   @param pending [Integer] Unapproved rewards awaiting fulfillment.
+          #   @param unfulfilled [Integer] Rewards that are approved but not fulfilled.
         end
       end
     end

data/lib/growsurf_ruby/models/campaign_review_affiliate_application_params.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#review_affiliate_application
+    # Either decide a pending application with `status`, or move a denied application's
+    # reapplication window with `reapply_allowed_at`. Provide exactly one of those
+    # fields.
+    class CampaignReviewAffiliateApplicationParams < 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
+
+      # @!attribute allow_immediate_reapply
+      #   When denying, let the applicant reapply right away instead of waiting out the
+      #   program's reapplication cooldown. Only valid when `status` is `DENIED`.
+      #
+      #   @return [Boolean, nil]
+      optional :allow_immediate_reapply,
+               GrowsurfRuby::Internal::Type::Boolean,
+               api_name: :allowImmediateReapply
+
+      # @!attribute reapply_allowed_at
+      #   For an already-denied application, move the reapplication window to this earlier
+      #   time, in Unix milliseconds. Send without `status`.
+      #
+      #   @return [Integer, nil]
+      optional :reapply_allowed_at, Integer, api_name: :reapplyAllowedAt
+
+      # @!attribute rejection_reason
+      #   Short reason recorded with a denial. Only valid when `status` is `DENIED`.
+      #   Maximum 255 characters.
+      #
+      #   @return [String, nil]
+      optional :rejection_reason, String, api_name: :rejectionReason
+
+      # @!attribute review_note
+      #   Private note recorded with a denial. Only valid when `status` is `DENIED`; never
+      #   shown to the applicant. Maximum 500 characters.
+      #
+      #   @return [String, nil]
+      optional :review_note, String, api_name: :reviewNote
+
+      # @!attribute status
+      #   The decision. `APPROVED` enrolls the applicant as an affiliate; `DENIED` closes
+      #   the application.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::Status, nil]
+      optional :status, enum: -> { GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status }
+
+      # @!method initialize(id:, application_id:, allow_immediate_reapply: nil, reapply_allowed_at: nil, rejection_reason: nil, review_note: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams} for more
+      #   details.
+      #
+      #   @param id [String]
+      #
+      #   @param application_id [String]
+      #
+      #   @param allow_immediate_reapply [Boolean] When denying, let the applicant reapply right away instead of waiting out the
+      #
+      #   @param reapply_allowed_at [Integer] For an already-denied application, move the reapplication window to this earlier
+      #
+      #   @param rejection_reason [String] Short reason recorded with a denial. Only valid when `status` is `DENIED`.
+      #
+      #   @param review_note [String] Private note recorded with a denial. Only valid when `status` is `DENIED`;
+      #
+      #   @param status [Symbol, GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::Status] The decision. `APPROVED` enrolls the applicant as an affiliate; `DENIED` closes
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # The decision. `APPROVED` enrolls the applicant as an affiliate; `DENIED` closes
+      # the application.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        APPROVED = :APPROVED
+        DENIED = :DENIED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#revoke_affiliate_invite
+    class CampaignRevokeAffiliateInviteParams < 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/email_analytics.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # Accepted-send and lifecycle metrics for program emails in a requested window.
+    class EmailAnalytics < GrowsurfRuby::Internal::Type::BaseModel
+      required :sent, Integer
+      required :delivered, Integer
+      required :opened, Integer
+      required :clicked, Integer
+      required :bounced, Integer
+      required :spam_complaints, Integer, api_name: :spamComplaints
+      required :delivery_rate, Float, api_name: :deliveryRate
+      required :open_rate, Float, api_name: :openRate
+      required :click_rate, Float, api_name: :clickRate
+      required :bounce_rate, Float, api_name: :bounceRate
+      required :by_type,
+               -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Models::EmailAnalytics::ByType] },
+               api_name: :byType
+      required :coverage_start_date, Integer, api_name: :coverageStartDate, nil?: true
+      required :is_partial, GrowsurfRuby::Internal::Type::Boolean, api_name: :isPartial
+
+      class Counts < GrowsurfRuby::Internal::Type::BaseModel
+        required :sent, Integer
+        required :delivered, Integer
+        required :opened, Integer
+        required :clicked, Integer
+        required :bounced, Integer
+        required :spam_complaints, Integer, api_name: :spamComplaints
+      end
+
+      class ByType < Counts
+        required :email_type, String, api_name: :emailType
+        required :delivery_rate, Float, api_name: :deliveryRate
+        required :open_rate, Float, api_name: :openRate
+        required :click_rate, Float, api_name: :clickRate
+        required :bounce_rate, Float, api_name: :bounceRate
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/participant_payout_list.rb

@@ -106,7 +106,12 @@ module GrowsurfRuby
         #   @return [Integer, nil]
         optional :queued_at, Integer, api_name: :queuedAt
 
-        # @!method initialize(id:, amount:, commission_ids:, created_at:, currency_iso:, participant_id:, status:, amount_in_campaign_currency: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, failed_at: nil, fx_error: nil, issued_at: nil, provider: nil, queued_at: nil)
+        # @!attribute reversed_at
+        #
+        #   @return [Integer, nil]
+        optional :reversed_at, Integer, api_name: :reversedAt
+
+        # @!method initialize(id:, amount:, commission_ids:, created_at:, currency_iso:, participant_id:, status:, amount_in_campaign_currency: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, failed_at: nil, fx_error: nil, issued_at: nil, provider: nil, queued_at: nil, reversed_at: nil)
         #   @param id [String]
         #   @param amount [Integer]
         #   @param commission_ids [Array<String>]
@@ -123,6 +128,7 @@ module GrowsurfRuby
         #   @param issued_at [Integer]
         #   @param provider [String, nil]
         #   @param queued_at [Integer]
+        #   @param reversed_at [Integer]
 
         # @see GrowsurfRuby::Models::ParticipantPayoutList::Payout#status
         module Status
@@ -132,6 +138,7 @@ module GrowsurfRuby
           QUEUED = :QUEUED
           ISSUED = :ISSUED
           FAILED = :FAILED
+          REVERSED = :REVERSED
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/growsurf_ruby/models/reward_tax_valuation.rb

@@ -10,17 +10,18 @@ module GrowsurfRuby
       #   @return [Float, nil]
       optional :fair_market_value_usd, Float, api_name: :fairMarketValueUSD, nil?: true
 
-      # @!attribute is_tax_reportable
-      #   Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
-      #   the smart default for the reward's source.
+      # @!attribute tax_character
+      #   The reason the recipient earns this reward. `null` inherits the program's
+      #   confirmed tax treatment for configurable non-commission rewards. Commission
+      #   rewards always use `NONEMPLOYEE_SERVICES`.
       #
-      #   @return [Boolean, nil]
-      optional :is_tax_reportable,
-               GrowsurfRuby::Internal::Type::Boolean,
-               api_name: :isTaxReportable,
+      #   @return [Symbol, GrowsurfRuby::Models::RewardTaxValuation::TaxCharacter, nil]
+      optional :tax_character,
+               enum: -> { GrowsurfRuby::RewardTaxValuation::TaxCharacter },
+               api_name: :taxCharacter,
                nil?: true
 
-      # @!method initialize(fair_market_value_usd: nil, is_tax_reportable: nil)
+      # @!method initialize(fair_market_value_usd: nil, tax_character: nil)
       #   Some parameter documentations has been truncated, see
       #   {GrowsurfRuby::Models::RewardTaxValuation} for more details.
       #
@@ -29,7 +30,21 @@ module GrowsurfRuby
       #
       #   @param fair_market_value_usd [Float, nil] Manual fair-market value in USD (major units) used as the fallback when the rewa
       #
-      #   @param is_tax_reportable [Boolean, nil] Whether the reward's value counts toward 1099 thresholds/totals. `null` = use th
+      #   @param tax_character [Symbol, GrowsurfRuby::Models::RewardTaxValuation::TaxCharacter, nil] The reason the recipient earns this reward. `null` inherits the program's
+
+      # The U.S. federal tax character of a reward.
+      module TaxCharacter
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        NONEMPLOYEE_SERVICES = :NONEMPLOYEE_SERVICES
+        PRIZE_OR_AWARD = :PRIZE_OR_AWARD
+        PURCHASE_REBATE = :PURCHASE_REBATE
+        OTHER_INCOME = :OTHER_INCOME
+        REVIEW_REQUIRED = :REVIEW_REQUIRED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/growsurf_ruby/models.rb

@@ -41,6 +41,10 @@ module GrowsurfRuby
 
   AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
 
+  AffiliateApplication = GrowsurfRuby::Models::AffiliateApplication
+
+  AffiliateInvite = GrowsurfRuby::Models::AffiliateInvite
+
   Team = GrowsurfRuby::Models::Team
 
   TeamUpdateParams = GrowsurfRuby::Models::TeamUpdateParams
@@ -49,11 +53,17 @@ module GrowsurfRuby
 
   CampaignAPI = GrowsurfRuby::Models::CampaignAPI
 
+  CampaignCreateAffiliateInviteParams = GrowsurfRuby::Models::CampaignCreateAffiliateInviteParams
+
   CampaignCreateMobileParticipantTokenParams =
     GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
 
   CampaignCreateParams = GrowsurfRuby::Models::CampaignCreateParams
 
+  CampaignListAffiliateApplicationsParams = GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams
+
+  CampaignListAffiliateInvitesParams = GrowsurfRuby::Models::CampaignListAffiliateInvitesParams
+
   CampaignListCommissionsParams = GrowsurfRuby::Models::CampaignListCommissionsParams
 
   CampaignListLeaderboardParams = GrowsurfRuby::Models::CampaignListLeaderboardParams
@@ -66,10 +76,19 @@ module GrowsurfRuby
 
   CampaignListReferralsParams = GrowsurfRuby::Models::CampaignListReferralsParams
 
+  CampaignResendAffiliateInviteParams = GrowsurfRuby::Models::CampaignResendAffiliateInviteParams
+
+  CampaignRetrieveAffiliateApplicationParams =
+    GrowsurfRuby::Models::CampaignRetrieveAffiliateApplicationParams
+
   CampaignRetrieveAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
 
   CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
 
+  CampaignReviewAffiliateApplicationParams = GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams
+
+  CampaignRevokeAffiliateInviteParams = GrowsurfRuby::Models::CampaignRevokeAffiliateInviteParams
+
   CampaignUpdateParams = GrowsurfRuby::Models::CampaignUpdateParams
 
   CommissionStructure = GrowsurfRuby::Models::CommissionStructure

data/lib/growsurf_ruby/resources/campaign/design.rb

@@ -4,12 +4,13 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Design
-        # Retrieves a program's design configuration — the same surface as the dashboard
-        # Program Editor's **Design** tab: the GrowSurf window layout, header, share
-        # channels + invite, signup form, portal/landing pages, theme styling, and the
-        # referral/affiliate summary + status sections. This is a large object whose
-        # available fields depend on the program type; the response includes every field
-        # and its current value, which is the same shape you send back on `PATCH`.
+        # Retrieves a program's configured design fields: the dashboard Program Editor's **Design**
+        # tab plus the payout-destination confirmation page copy configured from payout integration
+        # cards. This includes the GrowSurf window layout, header, share channels and invites,
+        # signup form, portal and landing pages, theme styling, and referral or affiliate summary
+        # and status sections. The available fields depend on the program type.
+        # `payoutDestinationConfirmation` is omitted when no confirmation fields are stored. Stored
+        # `null` fields are returned as `null`; omitted and `null` fields use localized defaults.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -27,17 +28,18 @@ module GrowsurfRuby
           )
         end
 
-        # Updates a program's design configuration. Only the fields you send are changed;
-        # anything you leave out is untouched (arrays such as `signup.fields` replace
-        # wholesale). Unknown fields, fields not available for the program type, and
-        # invalid values return a `400`. Landing-page custom code and JavaScript are not
-        # editable via the API.
+        # Updates a program's design configuration, including the payout-destination confirmation
+        # page copy configured from payout integration cards. Only the fields you send are changed;
+        # anything you leave out is untouched (arrays such as `signup.fields` replace wholesale).
+        # Unknown fields, fields not available for the program type, and invalid values return a
+        # `400`. Landing-page custom code and JavaScript are not editable via the API.
         #
         # @overload update(id, body, request_options: {})
         #
         # @param id [String] GrowSurf program ID.
         #
-        # @param body [Hash{Symbol=>Object}] Partial design configuration to merge.
+        # @param body [Hash{Symbol=>Object}] Partial design configuration to merge, such as
+        #   `{ payoutDestinationConfirmation: { headline: "Confirm your {{payoutProvider}} payout email" } }`.
         #
         # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/growsurf_ruby/resources/campaign/options.rb

@@ -6,9 +6,9 @@ module GrowsurfRuby
       class Options
         # Retrieves a program's options — the same surface as the dashboard Program
         # Editor's **Options** tab. Includes reward/fraud approval, anti-fraud lists +
-        # toggles, referral cookie/credit windows, reCAPTCHA, payout threshold + tax
-        # settings (affiliate only), and notification-email settings.
-        # `fraud.recaptcha.secretKey` is never returned.
+        # toggles, referral cookie/credit windows, reCAPTCHA, affiliate enrollment +
+        # application review, payout threshold + tax settings (affiliate only), and
+        # notification-email settings. `fraud.recaptcha.secretKey` is never returned.
         #
         # @overload retrieve(id, request_options: {})
         #
@@ -28,10 +28,10 @@ module GrowsurfRuby
 
         # Updates a program's options. Only the fields you send are changed. Some fields
         # are program-type specific (`requireManualRewardApproval`/`autoFulfillRewards`
-        # are referral-only; `payoutThreshold`/`taxDocumentation` are affiliate-only, and
-        # affiliate programs require `requireParticipantAuth: true`).
-        # `fraud.recaptcha.secretKey` is write-only. `referralCreditWindowDays: null`
-        # means "never expires".
+        # are referral-only; `affiliateApplicationMode`/`affiliateReapplicationPolicy`
+        # and `payoutThreshold`/`taxDocumentation` are affiliate-only, and affiliate
+        # programs require `requireParticipantAuth: true`). `fraud.recaptcha.secretKey`
+        # is write-only. `referralCreditWindowDays: null` means "never expires".
         #
         # @overload update(id, body, request_options: {})
         #