growsurf-ruby 1.2.0 → 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/account.rbi

@@ -3,6 +3,20 @@
 module GrowsurfRuby
   module Resources
     class Account
+      # Creates a new GrowSurf account. This is the only endpoint that does not require
+      # an API key. The response includes an API key for the new account, shown once in
+      # the response. The key is locked until the team owner's email address is
+      # verified: authenticated program and resource endpoints return a `403` with error
+      # code `EMAIL_NOT_VERIFIED_ERROR` until then (resend the email via `POST
+      # /team/owner/verification-email`, then retry). A welcome email is sent to the
+      # address with the verification link and a set-password link for dashboard access.
+      # Accounts whose email is never verified are deleted automatically after 7 days.
+      # For security, the API key is rotated the first time the account owner signs in
+      # to the GrowSurf dashboard. Some actions (such as emailing participants)
+      # additionally require GrowSurf to verify the team first. By creating an account
+      # you agree, on behalf of the account holder, to GrowSurf's [Terms of
+      # Service](https://growsurf.com/terms) and [Privacy
+      # Policy](https://growsurf.com/privacy).
       sig do
         params(
           email: String,

data/rbi/growsurf_ruby/resources/campaign/commission.rbi

@@ -5,7 +5,7 @@ module GrowsurfRuby
     class Campaign
       # Affiliate transaction, commission, and payout operations.
       class Commission
-        # Removes a pending participant commission.
+        # **Affiliate programs only.** Removes a pending participant commission.
         sig do
           params(
             commission_id: String,
@@ -22,7 +22,8 @@ module GrowsurfRuby
         )
         end
 
-        # Approves a pending participant commission so it can become eligible for payout.
+        # **Affiliate programs only.** Approves a pending participant commission so it can
+        # become eligible for payout.
         sig do
           params(
             commission_id: String,

data/rbi/growsurf_ruby/resources/campaign/design.rbi

@@ -5,9 +5,11 @@ module GrowsurfRuby
     class Campaign
       class Design
         # Retrieves a program's design configuration — the same surface as the dashboard
-        # Program Editor's **Design** tab. This is a large, deeply nested 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 update.
+        # 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. 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,
@@ -21,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). The request body is a partial design object. To see the full object
-        # with every field and its current value, `GET` this resource, then `PATCH` back
-        # only the fields you want to change.
+        # 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/emails.rbi

@@ -5,9 +5,10 @@ module GrowsurfRuby
     class Campaign
       class Emails
         # Retrieves a program's email configuration — the same surface as the dashboard
-        # Program Editor's **Emails** tab. To see the full object with every field and its
-        # current value, `GET` this resource, then `PATCH` back only the fields you want to
-        # change.
+        # Program Editor's **Emails** tab. Returns each editable email template
+        # (`subject`, `preheader`, `body`, `isEnabled`) plus the `settings` block (sender,
+        # contact, and design). The set of email templates returned depends on the program
+        # type (referral vs affiliate).
         sig do
           params(
             id: String,
@@ -22,9 +23,11 @@ module GrowsurfRuby
         end
 
         # Updates a program's email configuration. Only the fields you send are changed;
-        # anything you leave out is untouched. The request body is a partial email
-        # configuration object. To see the full object with every field and its current
-        # value, `GET` this resource, then `PATCH` back only the fields you want to change.
+        # omitted fields are left untouched. You may only write the email templates the
+        # dashboard exposes for the program type — writing a template that is not
+        # available for the program type returns a `400`. Some fields are read-only
+        # (`settings.sender.fromEmail`, whose custom value requires dashboard domain
+        # verification).
         sig do
           params(
             id: String,

data/rbi/growsurf_ruby/resources/campaign/installation.rbi

@@ -5,10 +5,9 @@ module GrowsurfRuby
     class Campaign
       class Installation
         # Retrieves a program's installation configuration — the same surface as the
-        # dashboard Program Editor's **Installation** tab. This is a nested object whose
-        # available fields depend on the program type. To see the full object with every
-        # field and its current value, `GET` this resource, then `PATCH` back only the
-        # fields you want to change.
+        # dashboard Program Editor's **Installation** tab (plus the Mobile SDK settings).
+        # Includes the referral trigger (referral programs only), signup tracking method,
+        # share URL and whitelist, custom-form signup settings, and mobile SDK settings.
         sig do
           params(
             id: String,
@@ -23,10 +22,11 @@ module GrowsurfRuby
         end
 
         # Updates a program's installation configuration. Only the fields you send are
-        # changed; anything you leave out is untouched. The request body is a partial
-        # installation configuration object. To see the full object with every field and
-        # its current value, `GET` this resource, then `PATCH` back only the fields you
-        # want to change.
+        # changed; omitted fields are left untouched. `referralTrigger` is only available
+        # for referral programs. `mobile.publicKey` is read-only; if no key exists yet,
+        # enabling `mobile.isEnabled` creates one. Changing `shareUrl` re-resolves its
+        # redirect destinations, which may take a moment to complete. URLs must include an
+        # explicit `http://` or `https://` scheme.
         sig do
           params(
             id: String,

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

@@ -4,10 +4,11 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Options
-        # Retrieves a program's options configuration — the same surface as the dashboard
-        # Program Editor's **Options** tab. To see the full object with every field and its
-        # current value, `GET` this resource, then `PATCH` back only the fields you want to
-        # change.
+        # 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, 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,
@@ -21,10 +22,12 @@ module GrowsurfRuby
         )
         end
 
-        # Updates a program's options configuration. Only the fields you send are changed;
-        # anything you leave out is untouched. The request body is a partial options
-        # configuration object. To see the full object with every field and its current
-        # value, `GET` this resource, then `PATCH` back only the fields you want to change.
+        # Updates a program's options. Only the fields you send are changed. Some fields
+        # are program-type specific (`requireManualRewardApproval`/`autoFulfillRewards`
+        # 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,