growsurf-ruby 1.2.0 → 1.3.0

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
@@ -88,12 +95,12 @@ module GrowsurfRuby
         end
 
         # Deletes a list of participants from a program in one request. Each entry in
-        # `participants` is a GrowSurf participant ID or an email address (mixed lists
-        # are allowed). Up to `200` entries per request — chunk larger lists across
-        # multiple calls. The response reports a per-row `status` for every submitted
-        # entry, so a `200` can include rows that were `NOT_FOUND` or failed. Deletion
-        # is permanent and removes the participants' referrals, rewards, commissions,
-        # and payout records.
+        # `participants` is a GrowSurf participant ID or an email address (mixed lists are
+        # allowed). Up to `200` entries per request — chunk larger lists across multiple
+        # calls. The response reports a per-row `status` for every submitted entry, so a
+        # `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent
+        # and removes the participants' referrals, rewards, commissions, and payout
+        # records.
         sig do
           params(
             id: String,
@@ -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,
@@ -156,7 +175,8 @@ module GrowsurfRuby
         )
         end
 
-        # Retrieves a paged list of commissions earned by a participant.
+        # **Affiliate programs only.** Retrieves a paged list of commissions earned by a
+        # participant.
         sig do
           params(
             participant_id_or_email: String,
@@ -183,7 +203,8 @@ module GrowsurfRuby
         )
         end
 
-        # Retrieves a paged list of payouts that belong to a participant.
+        # **Affiliate programs only.** Retrieves a paged list of payouts that belong to a
+        # participant.
         sig do
           params(
             participant_id_or_email: String,
@@ -280,15 +301,12 @@ module GrowsurfRuby
         )
         end
 
-        # Records a sale made by a referred customer and generates affiliate commissions
-        # for their referrer when applicable.
-        #
-        # At least one transaction identifier is required: one of +external_id+,
-        # +transaction_id+, +order_id+, +payment_id+, +invoice_id+, +payment_intent_id+,
-        # or +charge_id+. +customer_id+ and +subscription_id+ do not count, since they
-        # identify the customer or subscription rather than the specific transaction.
-        # Without an identifier, resending the same sale creates a duplicate commission
-        # and double-pays the referrer; the server rejects such requests with HTTP 400.
+        # **Affiliate programs only.** Records a sale made by a referred customer and
+        # generates affiliate commissions for their referrer when applicable. Requires at
+        # least one transaction identifier (externalId, transactionId, orderId, paymentId,
+        # invoiceId, paymentIntentId, or chargeId) so repeated requests can be
+        # de-duplicated — without one, a resent sale would create a second commission.
+        # Reuse the same identifier(s) when refunding.
         sig do
           params(
             participant_id_or_email: String,
@@ -376,9 +394,12 @@ module GrowsurfRuby
         )
         end
 
-        # Records an amendment (refund, partial refund, refund cancellation, or
-        # chargeback) against a previously recorded transaction and reverses or adjusts
-        # the referrer's commission.
+        # **Affiliate programs only.** Records an amendment (refund, partial refund,
+        # refund cancellation, or chargeback) against a previously recorded transaction
+        # and reverses or adjusts the referrer's commission. The inverse of Record
+        # Affiliate Transaction. Identify the original transaction with the same
+        # identifier(s) you sent when recording it. Commissions already paid out to the
+        # affiliate are not clawed back; the amendment is recorded for tax reporting only.
         sig do
           params(
             participant_id_or_email: String,
@@ -444,7 +465,7 @@ module GrowsurfRuby
         end
 
         # Sends email invites on behalf of a participant to a list of email addresses.
-        # Sending invites via the API requires a verified custom email domain on the
+        # Sending invites via the API requires a **verified custom email domain** on the
         # program; the request fails until one is verified.
         sig do
           params(
@@ -474,7 +495,10 @@ module GrowsurfRuby
         end
 
         # Triggers referral credit for an existing referred participant by GrowSurf
-        # participant ID or email address.
+        # participant ID or email address. Optionally pass `delayInDays` to hold the
+        # credit for a number of days before it is awarded (for example, to cover your own
+        # refund window). A delayed trigger can be cancelled before it is awarded with the
+        # Cancel delayed referral trigger request (DELETE on this same path).
         sig do
           params(
             participant_id_or_email: String,
@@ -500,8 +524,11 @@ module GrowsurfRuby
         )
         end
 
-        # Cancels a pending delayed referral trigger for an existing referred participant
-        # by GrowSurf participant ID or email address.
+        # Cancels a pending delayed referral trigger for a participant (the companion to a
+        # delayed Trigger referral request). Use this to undo a scheduled referral credit
+        # before it is awarded, for example when a refund occurs inside your refund
+        # window. If the participant has no pending delayed trigger, `success` is returned
+        # as `false`.
         sig do
           params(
             participant_id_or_email: String,
@@ -520,15 +547,14 @@ module GrowsurfRuby
         )
         end
 
-        # Sends an email to a participant. Provide EITHER `email_type` to trigger one of the
-        # program's configured email templates, OR `subject` + `body` for a free-form email.
-        # Free-form emails are sent with the same compliance handling (company name,
-        # postal address, and an unsubscribe link are added automatically, and unsubscribed
-        # participants are suppressed). Sending requires the team to be verified by
-        # GrowSurf. Requires a verified custom email domain on the program (set up
-        # in Campaign Editor > 3. Emails > Email Settings). Returns `400` until one is
-        # verified.
-        # The email is accepted for delivery.
+        # Sends an email to a participant. Provide EITHER `emailType` to trigger one of
+        # the program's configured email templates, OR `subject` + `body` for a free-form
+        # email. Free-form emails are sent with the same compliance handling (company
+        # name, postal address, and an unsubscribe link are added automatically, and
+        # unsubscribed participants are suppressed). Sending requires the team to be
+        # verified by GrowSurf. Requires a **verified custom email domain** on the program
+        # (which can be completed in *Campaign Editor > 3. Emails > Email Settings*).
+        # Returns `400` until one is verified. The email is accepted for delivery.
         sig do
           params(
             participant_id_or_email: String,
@@ -569,7 +595,8 @@ module GrowsurfRuby
         )
         end
 
-        # Returns a participant's activity logs, most recent first (offset/limit paginated).
+        # Returns a participant's activity logs, most recent first (offset/limit
+        # paginated).
         sig do
           params(
             participant_id_or_email: String,
@@ -594,17 +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.
+        # 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,
@@ -623,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.
@@ -634,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/reward.rbi

@@ -23,8 +23,9 @@ module GrowsurfRuby
         )
         end
 
-        # Approves a manually approved reward earned by a participant. Requires
-        # `reward:write`. Passing `fulfill: true` also requires `reward:fulfill`.
+        # Approves a manually approved reward earned by a participant. This requires
+        # `reward:write`. When the request also sets `fulfill` to `true`, it additionally
+        # requires `reward:fulfill`.
         sig do
           params(
             reward_id: String,
@@ -44,7 +45,7 @@ module GrowsurfRuby
         )
         end
 
-        # Marks an approved participant reward as fulfilled. Requires `reward:fulfill`.
+        # Marks an approved participant reward as fulfilled.
         sig do
           params(
             reward_id: String,

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

@@ -4,7 +4,9 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Rewards
-        # Retrieves the rewards configured for a program.
+        # Retrieves the list of a program's configured rewards (`CampaignReward`s) — the
+        # same set embedded in the `rewards` array of the campaign response. Delete a
+        # reward with `DELETE /campaign/{id}/reward-configs/{campaignRewardId}`.
         sig do
           params(
             id: String,
@@ -18,8 +20,11 @@ module GrowsurfRuby
         )
         end
 
-        # Creates a reward for a program. The reward `type` must be compatible with the
-        # program type.
+        # Creates a new campaign reward (`CampaignReward`) with a GrowSurf-assigned ID.
+        # The reward type must be compatible with the program type (affiliate programs
+        # support only `AFFILIATE` rewards; referral programs support all other types).
+        # Enabling an active reward of a type automatically enables that reward type on
+        # the program.
         sig do
           params(
             id: String,
@@ -100,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,
@@ -112,8 +117,11 @@ module GrowsurfRuby
         )
         end
 
-        # Updates an existing campaign reward. Only the fields you send are changed; `type`
-        # is immutable and must not be supplied.
+        # Updates an existing campaign reward (`CampaignReward`). The reward `type` is
+        # immutable and cannot be changed. When the update replaces `metadata`, renamed
+        # keys automatically rewrite any `{{campaignReward[…]}}` references in campaign
+        # copy; removing a key that campaign copy still references returns a `409` listing
+        # the referencing fields.
         sig do
           params(
             campaign_reward_id: String,
@@ -193,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,
@@ -205,7 +213,11 @@ module GrowsurfRuby
         )
         end
 
-        # Deletes a campaign reward.
+        # Deletes a campaign reward (`CampaignReward`). The reward is deactivated, removed
+        # from the program's reward set, and any connected upfront-discount coupons are
+        # cleaned up. If campaign copy still references any of the reward's metadata keys
+        # via `{{campaignReward[…]}}` tokens, the delete returns a `409` listing the
+        # referencing fields — update those fields first.
         sig do
           params(
             campaign_reward_id: String,