growsurf-ruby 1.2.1 → 1.3.0

data/rbi/growsurf_ruby/models/participant_payout_list.rbi

@@ -115,6 +115,12 @@ module GrowsurfRuby
         sig { params(queued_at: Integer).void }
         attr_writer :queued_at
 
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :reversed_at
+
+        sig { params(reversed_at: Integer).void }
+        attr_writer :reversed_at
+
         sig do
           params(
             id: String,
@@ -133,7 +139,8 @@ module GrowsurfRuby
             fx_error: T.nilable(String),
             issued_at: Integer,
             provider: T.nilable(String),
-            queued_at: Integer
+            queued_at: Integer,
+            reversed_at: Integer
           ).returns(T.attached_class)
         end
         def self.new(
@@ -152,7 +159,8 @@ module GrowsurfRuby
           fx_error: nil,
           issued_at: nil,
           provider: nil,
-          queued_at: nil
+          queued_at: nil,
+          reversed_at: nil
         )
         end
 
@@ -175,7 +183,8 @@ module GrowsurfRuby
               fx_error: T.nilable(String),
               issued_at: Integer,
               provider: T.nilable(String),
-              queued_at: Integer
+              queued_at: Integer,
+              reversed_at: Integer
             }
           )
         end
@@ -211,6 +220,11 @@ module GrowsurfRuby
               :FAILED,
               GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol
             )
+          REVERSED =
+            T.let(
+              :REVERSED,
+              GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/growsurf_ruby/models/reward_tax_valuation.rbi

@@ -18,26 +18,33 @@ module GrowsurfRuby
       sig { returns(T.nilable(Float)) }
       attr_accessor :fair_market_value_usd
 
-      # Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
-      # the smart default for the reward's source.
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_accessor :is_tax_reportable
+      # 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`.
+      sig do
+        returns(
+          T.nilable(GrowsurfRuby::RewardTaxValuation::TaxCharacter::OrSymbol)
+        )
+      end
+      attr_accessor :tax_character
 
       # Tax valuation settings for a reward. Only relevant when the program collects
       # tax documentation.
       sig do
         params(
           fair_market_value_usd: T.nilable(Float),
-          is_tax_reportable: T.nilable(T::Boolean)
+          tax_character:
+            T.nilable(GrowsurfRuby::RewardTaxValuation::TaxCharacter::OrSymbol)
         ).returns(T.attached_class)
       end
       def self.new(
         # Manual fair-market value in USD (major units) used as the fallback when the
         # reward value cannot be resolved automatically. `null` = no manual value.
         fair_market_value_usd: nil,
-        # Whether the reward's value counts toward 1099 thresholds/totals. `null` = use
-        # the smart default for the reward's source.
-        is_tax_reportable: nil
+        # 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`.
+        tax_character: nil
       )
       end
 
@@ -45,12 +52,62 @@ module GrowsurfRuby
         override.returns(
           {
             fair_market_value_usd: T.nilable(Float),
-            is_tax_reportable: T.nilable(T::Boolean)
+            tax_character:
+              T.nilable(
+                GrowsurfRuby::RewardTaxValuation::TaxCharacter::OrSymbol
+              )
           }
         )
       end
       def to_hash
       end
+
+      # The U.S. federal tax character of a reward.
+      module TaxCharacter
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::RewardTaxValuation::TaxCharacter)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NONEMPLOYEE_SERVICES =
+          T.let(
+            :NONEMPLOYEE_SERVICES,
+            GrowsurfRuby::RewardTaxValuation::TaxCharacter::TaggedSymbol
+          )
+        PRIZE_OR_AWARD =
+          T.let(
+            :PRIZE_OR_AWARD,
+            GrowsurfRuby::RewardTaxValuation::TaxCharacter::TaggedSymbol
+          )
+        PURCHASE_REBATE =
+          T.let(
+            :PURCHASE_REBATE,
+            GrowsurfRuby::RewardTaxValuation::TaxCharacter::TaggedSymbol
+          )
+        OTHER_INCOME =
+          T.let(
+            :OTHER_INCOME,
+            GrowsurfRuby::RewardTaxValuation::TaxCharacter::TaggedSymbol
+          )
+        REVIEW_REQUIRED =
+          T.let(
+            :REVIEW_REQUIRED,
+            GrowsurfRuby::RewardTaxValuation::TaxCharacter::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::RewardTaxValuation::TaxCharacter::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/growsurf_ruby/models.rbi

@@ -3,6 +3,10 @@
 module GrowsurfRuby
   AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
 
+  AffiliateApplication = GrowsurfRuby::Models::AffiliateApplication
+
+  AffiliateInvite = GrowsurfRuby::Models::AffiliateInvite
+
   Team = GrowsurfRuby::Models::Team
 
   TeamUpdateParams = GrowsurfRuby::Models::TeamUpdateParams
@@ -11,11 +15,20 @@ 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
 
@@ -32,11 +45,23 @@ 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/rbi/growsurf_ruby/resources/campaign/design.rbi

@@ -7,9 +7,9 @@ module GrowsurfRuby
         # 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`.
+        # referral/affiliate summary + status sections. 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.
         sig do
           params(
             id: String,
@@ -23,11 +23,12 @@ 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.
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign/options.rbi

@@ -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.
         sig do
           params(
             id: String,
@@ -24,10 +24,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".
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign/participant.rbi

@@ -21,17 +21,22 @@ module GrowsurfRuby
         )
         end
 
-        # Updates a participant by GrowSurf participant ID or email address.
+        # Updates a participant by GrowSurf participant ID or email address. For affiliate
+        # programs, set `affiliateStatus` to `APPROVED`, `SUSPENDED`, or `BANNED`.
+        # `APPROVED` enrolls the participant as an affiliate. `SUSPENDED` and `BANNED`
+        # require an existing affiliate. This endpoint does not accept `isAffiliate`, and
+        # affiliate enrollment cannot be removed through REST.
         sig do
           params(
             participant_id_or_email: String,
             id: String,
+            affiliate_status:
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol,
             email: String,
             first_name: String,
             last_name: String,
             metadata: T::Hash[Symbol, T.anything],
             notes: String,
-            paypal_email: String,
             referral_status:
               GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol,
             referred_by: String,
@@ -45,6 +50,10 @@ module GrowsurfRuby
           participant_id_or_email,
           # Path param: GrowSurf program ID.
           id:,
+          # Body param: 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.
+          affiliate_status: nil,
           # Body param
           email: nil,
           # Body param
@@ -56,8 +65,6 @@ module GrowsurfRuby
           # Body param: Freeform internal notes about the participant (internal only, never
           # exposed to participants).
           notes: nil,
-          # Body param: The participant's PayPal email address, used for affiliate payouts.
-          paypal_email: nil,
           # Body param
           referral_status: nil,
           # Body param
@@ -114,7 +121,13 @@ module GrowsurfRuby
         end
 
         # Adds a new participant to the program. If the email already exists, the existing
-        # participant is returned.
+        # participant is returned unchanged. For affiliate programs, set `isAffiliate` to
+        # `true` to enroll a new participant as an approved affiliate or `false` to create
+        # a non-affiliate. If you omit `isAffiliate`, a valid `referredBy` creates a
+        # referred non-affiliate; without a valid referrer, the new participant is enrolled
+        # as an approved affiliate. You can send a valid `referredBy` with
+        # `isAffiliate: true` to keep the referral attribution and enroll the participant
+        # as an affiliate.
         sig do
           params(
             id: String,
@@ -122,6 +135,7 @@ module GrowsurfRuby
             fingerprint: String,
             first_name: String,
             ip_address: String,
+            is_affiliate: T::Boolean,
             last_name: String,
             metadata: T::Hash[Symbol, T.anything],
             mobile_instance_id: String,
@@ -138,6 +152,11 @@ module GrowsurfRuby
           fingerprint: nil,
           first_name: nil,
           ip_address: nil,
+          # 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.
+          is_affiliate: nil,
           last_name: nil,
           # Shallow custom metadata object.
           metadata: nil,
@@ -602,18 +621,19 @@ module GrowsurfRuby
         )
         end
 
-        # Retrieves analytics for a single participant — all-time engagement counters,
-        # leaderboard ranks, and per-channel share counts (plus affiliate money metrics
-        # for affiliate programs). Useful for segmenting and re-engaging participants.
-        # Pass `include=series` to also get this participant's own activity over time.
+        # Retrieves analytics for a single participant — all-time engagement counters, leaderboard
+        # ranks, and per-channel share counts (plus affiliate revenue, commission, and payout
+        # metrics for affiliate programs). Pass `include=email` for `sent` (accepted for
+        # delivery), `delivered`, `opened`, `clicked`, `bounced`, and `spamComplaints` metrics
+        # attributed to this participant, including invitations they sent. Use
+        # `include=email,series` to include the same counts in each UTC series bucket.
         sig do
           params(
             participant_id_or_email: String,
             id: String,
             days: Integer,
             end_date: Integer,
-            include:
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol,
+            include: String,
             interval:
               GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol,
             start_date: Integer,
@@ -632,9 +652,15 @@ module GrowsurfRuby
           # End date of the analytics timeframe as a Unix timestamp in milliseconds.
           # Required if `days` is not set.
           end_date: nil,
-          # 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`.
           include: nil,
-          # 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`.
           interval: nil,
           # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
           # Required if `days` is not set.
@@ -643,6 +669,56 @@ module GrowsurfRuby
         )
         end
 
+        # Returns a participant's payout-destination status across every payout provider
+        # enabled for the program (PayPal and/or Wise). For each provider it reports the
+        # current status, the confirmed claim email, the legal recipient type, and — when a
+        # delivery bounced or a recipient was invalidated — the repair reason.
+        # `activeProvider` is the provider that currently gets paid, or `null` until the
+        # participant confirms one.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse
+          )
+        end
+        def get_payout_destination(
+          # GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # Sends the participant a one-time link to confirm their payout destination for
+        # the chosen provider. Only the participant can open the link and confirm — this
+        # endpoint just triggers the message. The provider must be enabled for the
+        # program.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            provider:
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse
+          )
+        end
+        def request_payout_destination_confirmation(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param: The payout provider the participant should confirm a destination for.
+          provider:,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/growsurf_ruby/resources/campaign/rewards.rbi

@@ -105,8 +105,8 @@ module GrowsurfRuby
           referral_description: nil,
           # Body param
           referred_reward_upfront: nil,
-          # Body param: Tax valuation for the referred friend's side of a double-sided
-          # reward. Defaults to not tax-reportable (a purchase rebate).
+          # Body param: Tax treatment override for the referred friend's side of a double-sided
+          # reward. Defaults to the program's confirmed default.
           referred_value: nil,
           # Body param
           title: nil,
@@ -201,8 +201,8 @@ module GrowsurfRuby
           referral_description: nil,
           # Body param
           referred_reward_upfront: nil,
-          # Body param: Tax valuation for the referred friend's side of a double-sided
-          # reward. Defaults to not tax-reportable (a purchase rebate).
+          # Body param: Tax treatment override for the referred friend's side of a double-sided
+          # reward. Defaults to the program's confirmed default.
           referred_value: nil,
           # Body param
           title: nil,