growsurf-ruby 1.2.1 → 1.3.0

data/rbi/growsurf_ruby/models/affiliate_invite_list_response.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class AffiliateInviteListResponse < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::Models::AffiliateInviteListResponse,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      # One page of the program's invites, newest first.
+      sig { returns(T::Array[GrowsurfRuby::AffiliateInvite]) }
+      attr_accessor :invites
+
+      # Total number of invites matching the filter.
+      sig { returns(Integer) }
+      attr_accessor :total
+
+      # The page size used.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # The offset this page started at.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :offset
+
+      sig { params(offset: Integer).void }
+      attr_writer :offset
+
+      sig do
+        params(
+          invites: T::Array[GrowsurfRuby::AffiliateInvite::OrHash],
+          total: Integer,
+          limit: Integer,
+          offset: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # One page of the program's invites, newest first.
+        invites:,
+        # Total number of invites matching the filter.
+        total:,
+        # The page size used.
+        limit: nil,
+        # The offset this page started at.
+        offset: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            invites: T::Array[GrowsurfRuby::AffiliateInvite],
+            total: Integer,
+            limit: Integer,
+            offset: Integer
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/create.rbi

@@ -33,6 +33,16 @@ module GrowsurfRuby
         sig { params(ip_address: String).void }
         attr_writer :ip_address
 
+        # 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.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_affiliate
+
+        sig { params(is_affiliate: T::Boolean).void }
+        attr_writer :is_affiliate
+
         sig { returns(T.nilable(String)) }
         attr_reader :last_name
 
@@ -87,6 +97,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,
@@ -100,6 +111,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,
@@ -124,6 +140,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,

data/rbi/growsurf_ruby/models/campaign/participant.rbi

@@ -33,8 +33,24 @@ module GrowsurfRuby
         sig { returns(T::Array[GrowsurfRuby::Campaign::ParticipantReward]) }
         attr_accessor :rewards
 
-        sig { returns(String) }
-        attr_accessor :share_url
+        # The unique share URL of the participant. Omitted for affiliate program
+        # participants who are not approved affiliates.
+        sig { returns(T.nilable(String)) }
+        attr_reader :share_url
+
+        sig { params(share_url: String).void }
+        attr_writer :share_url
+
+        # Affiliate programs only. How the affiliate enrolled (`OPEN_ENROLLMENT`,
+        # `APPLICATION`, `PARTICIPANT_AUTH`, `INVITE`, `REST_API`, `CSV`, or `DASHBOARD`).
+        # `null` when not recorded.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :affiliate_enrollment_source
+
+        # Affiliate programs only. The enrolled affiliate's status (`APPROVED`,
+        # `SUSPENDED`, or `BANNED`). `null` for participants who are not affiliates.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :affiliate_status
 
         sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
         attr_reader :all_matching_fraudsters
@@ -93,6 +109,14 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :ip_address
 
+        # Affiliate programs only. Whether this participant is an enrolled affiliate. A
+        # referred customer who has not joined the program is `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_affiliate
+
+        sig { params(is_affiliate: T::Boolean).void }
+        attr_writer :is_affiliate
+
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_new
 
@@ -130,6 +154,26 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :notes
 
+        # 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.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings
+            )
+          )
+        end
+        attr_reader :payout_settings
+
+        sig do
+          params(
+            payout_settings:
+              GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::OrHash
+          ).void
+        end
+        attr_writer :payout_settings
+
         sig { returns(T.nilable(String)) }
         attr_reader :paypal_email_address
 
@@ -252,6 +296,8 @@ module GrowsurfRuby
             rewards:
               T::Array[GrowsurfRuby::Campaign::ParticipantReward::OrHash],
             share_url: String,
+            affiliate_enrollment_source: T.nilable(String),
+            affiliate_status: T.nilable(String),
             all_matching_fraudsters: T::Array[T::Hash[Symbol, T.anything]],
             created_at: Integer,
             fingerprint: T.nilable(String),
@@ -261,6 +307,7 @@ module GrowsurfRuby
             impression_count: Integer,
             invite_count: Integer,
             ip_address: T.nilable(String),
+            is_affiliate: T::Boolean,
             is_new: T::Boolean,
             is_winner: T::Boolean,
             last_name: T.nilable(String),
@@ -268,6 +315,8 @@ module GrowsurfRuby
             mobile_instance_id: T.nilable(String),
             monthly_referrals: T::Array[String],
             notes: T.nilable(String),
+            payout_settings:
+              GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::OrHash,
             paypal_email_address: String,
             prev_monthly_rank: Integer,
             prev_monthly_referral_count: Integer,
@@ -295,7 +344,16 @@ module GrowsurfRuby
           rank:,
           referral_count:,
           rewards:,
-          share_url:,
+          # The unique share URL of the participant. Omitted for affiliate program
+          # participants who are not approved affiliates.
+          share_url: nil,
+          # Affiliate programs only. How the affiliate enrolled (`OPEN_ENROLLMENT`,
+          # `APPLICATION`, `PARTICIPANT_AUTH`, `INVITE`, `REST_API`, `CSV`, or `DASHBOARD`).
+          # `null` when not recorded.
+          affiliate_enrollment_source: nil,
+          # Affiliate programs only. The enrolled affiliate's status (`APPROVED`,
+          # `SUSPENDED`, or `BANNED`). `null` for participants who are not affiliates.
+          affiliate_status: nil,
           all_matching_fraudsters: nil,
           created_at: nil,
           fingerprint: nil,
@@ -305,6 +363,9 @@ module GrowsurfRuby
           impression_count: nil,
           invite_count: nil,
           ip_address: nil,
+          # Affiliate programs only. Whether this participant is an enrolled affiliate. A
+          # referred customer who has not joined the program is `false`.
+          is_affiliate: nil,
           is_new: nil,
           is_winner: nil,
           last_name: nil,
@@ -316,6 +377,10 @@ module GrowsurfRuby
           mobile_instance_id: nil,
           monthly_referrals: nil,
           notes: 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.
+          payout_settings: nil,
           paypal_email_address: nil,
           prev_monthly_rank: nil,
           prev_monthly_referral_count: nil,
@@ -344,6 +409,8 @@ module GrowsurfRuby
               referral_count: Integer,
               rewards: T::Array[GrowsurfRuby::Campaign::ParticipantReward],
               share_url: String,
+              affiliate_enrollment_source: T.nilable(String),
+              affiliate_status: T.nilable(String),
               all_matching_fraudsters: T::Array[T::Hash[Symbol, T.anything]],
               created_at: Integer,
               fingerprint: T.nilable(String),
@@ -354,6 +421,7 @@ module GrowsurfRuby
               impression_count: Integer,
               invite_count: Integer,
               ip_address: T.nilable(String),
+              is_affiliate: T::Boolean,
               is_new: T::Boolean,
               is_winner: T::Boolean,
               last_name: T.nilable(String),
@@ -361,6 +429,8 @@ module GrowsurfRuby
               mobile_instance_id: T.nilable(String),
               monthly_referrals: T::Array[String],
               notes: T.nilable(String),
+              payout_settings:
+                GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings,
               paypal_email_address: String,
               prev_monthly_rank: Integer,
               prev_monthly_referral_count: Integer,
@@ -386,6 +456,102 @@ module GrowsurfRuby
         def to_hash
         end
 
+        class PayoutSettings < GrowsurfRuby::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings,
+                GrowsurfRuby::Internal::AnyHash
+              )
+            end
+
+          # Actions the participant must complete before payouts can be sent.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction::TaggedSymbol
+                ]
+              )
+            )
+          end
+          attr_reader :required_actions
+
+          sig do
+            params(
+              required_actions:
+                T::Array[
+                  GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction::OrSymbol
+                ]
+            ).void
+          end
+          attr_writer :required_actions
+
+          # 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.
+          sig do
+            params(
+              required_actions:
+                T::Array[
+                  GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction::OrSymbol
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Actions the participant must complete before payouts can be sent.
+            required_actions: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                required_actions:
+                  T::Array[
+                    GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction::TaggedSymbol
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module RequiredAction
+            extend GrowsurfRuby::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PAYOUT_DESTINATION =
+              T.let(
+                :PAYOUT_DESTINATION,
+                GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction::TaggedSymbol
+              )
+            TAX_INFO =
+              T.let(
+                :TAX_INFO,
+                GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings::RequiredAction::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         class Referrer < GrowsurfRuby::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/growsurf_ruby/models/campaign/participant_activity_logs_response.rbi

@@ -82,11 +82,9 @@ module GrowsurfRuby
           attr_accessor :type
 
           sig do
-            params(
-              created_at: Integer,
-              text: String,
-              type: String
-            ).returns(T.attached_class)
+            params(created_at: Integer, text: String, type: String).returns(
+              T.attached_class
+            )
           end
           def self.new(
             # When the activity occurred, as a Unix timestamp in milliseconds.

data/rbi/growsurf_ruby/models/campaign/participant_analytics_response.rbi

@@ -28,7 +28,7 @@ module GrowsurfRuby
         sig { returns(T::Hash[Symbol, Integer]) }
         attr_accessor :share_count
 
-        # Present only with `include=series`. Window end (Unix ms).
+        # Present only when `include` contains `series` or `email`. Window end (Unix ms).
         sig { returns(T.nilable(Integer)) }
         attr_reader :end_date
 
@@ -59,7 +59,7 @@ module GrowsurfRuby
         end
         attr_writer :series
 
-        # Present only with `include=series`. Window start (Unix ms).
+        # Present only when `include` contains `series` or `email`. Window start (Unix ms).
         sig { returns(T.nilable(Integer)) }
         attr_reader :start_date
 
@@ -86,13 +86,13 @@ module GrowsurfRuby
           ranks:,
           # Per-channel share counts (e.g. `email`, `facebook`, `twitter`, ...).
           share_count:,
-          # Present only with `include=series`. Window end (Unix ms).
+          # Present only when `include` contains `series` or `email`. Window end (Unix ms).
           end_date: nil,
           # Present only when `include=series`. This participant's own referral-link activity
           # per period (ascending), windowed by `days`/`startDate`/`endDate` and bucketed by
           # `interval`.
           series: nil,
-          # Present only with `include=series`. Window start (Unix ms).
+          # Present only when `include` contains `series` or `email`. Window start (Unix ms).
           start_date: nil
         )
         end
@@ -162,11 +162,23 @@ module GrowsurfRuby
           sig { params(monthly_referrals: Integer).void }
           attr_writer :monthly_referrals
 
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :pending_rewards
+          # This participant's reward counts grouped by review and fulfillment status.
+          sig do
+            returns(
+              T.nilable(
+                GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
+              )
+            )
+          end
+          attr_reader :reward_status
 
-          sig { params(pending_rewards: Integer).void }
-          attr_writer :pending_rewards
+          sig do
+            params(
+              reward_status:
+                GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
+            ).void
+          end
+          attr_writer :reward_status
 
           # Affiliate only. Revenue attributed to this participant's referrals, in minor
           # currency units.
@@ -182,12 +194,6 @@ module GrowsurfRuby
           sig { params(referrals: Integer).void }
           attr_writer :referrals
 
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :rewards_earned
-
-          sig { params(rewards_earned: Integer).void }
-          attr_writer :rewards_earned
-
           # Affiliate only. Total commissions earned, in minor currency units.
           sig { returns(T.nilable(Integer)) }
           attr_reader :total_commissions
@@ -223,10 +229,10 @@ module GrowsurfRuby
               invites_sent: Integer,
               leads: Integer,
               monthly_referrals: Integer,
-              pending_rewards: Integer,
               referral_revenue: Integer,
               referrals: Integer,
-              rewards_earned: Integer,
+              reward_status:
+                GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus,
               total_commissions: Integer,
               total_paid_out: Integer,
               unique_impressions: Integer,
@@ -240,12 +246,12 @@ module GrowsurfRuby
             invites_sent: nil,
             leads: nil,
             monthly_referrals: nil,
-            pending_rewards: nil,
             # Affiliate only. Revenue attributed to this participant's referrals, in minor
             # currency units.
             referral_revenue: nil,
             referrals: nil,
-            rewards_earned: nil,
+            # This participant's reward counts grouped by review and fulfillment status.
+            reward_status: nil,
             # Affiliate only. Total commissions earned, in minor currency units.
             total_commissions: nil,
             # Affiliate only. Total paid out, in minor currency units.
@@ -265,10 +271,10 @@ module GrowsurfRuby
                 invites_sent: Integer,
                 leads: Integer,
                 monthly_referrals: Integer,
-                pending_rewards: Integer,
                 referral_revenue: Integer,
                 referrals: Integer,
-                rewards_earned: Integer,
+                reward_status:
+                  GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus,
                 total_commissions: Integer,
                 total_paid_out: Integer,
                 unique_impressions: Integer,
@@ -497,6 +503,12 @@ module GrowsurfRuby
           sig { params(twitter_shares: Integer).void }
           attr_writer :twitter_shares
 
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :unique_commission_referrals
+
+          sig { params(unique_commission_referrals: Integer).void }
+          attr_writer :unique_commission_referrals
+
           sig { returns(T.nilable(Integer)) }
           attr_reader :unique_impressions
 
@@ -543,6 +555,7 @@ module GrowsurfRuby
               total_revenue: Integer,
               tumblr_shares: Integer,
               twitter_shares: Integer,
+              unique_commission_referrals: Integer,
               unique_impressions: Integer,
               wechat_shares: Integer,
               whats_app_shares: Integer
@@ -580,6 +593,7 @@ module GrowsurfRuby
             total_revenue: nil,
             tumblr_shares: nil,
             twitter_shares: nil,
+            unique_commission_referrals: nil,
             unique_impressions: nil,
             wechat_shares: nil,
             whats_app_shares: nil
@@ -615,6 +629,7 @@ module GrowsurfRuby
                 total_revenue: Integer,
                 tumblr_shares: Integer,
                 twitter_shares: Integer,
+                unique_commission_referrals: Integer,
                 unique_impressions: Integer,
                 wechat_shares: Integer,
                 whats_app_shares: Integer

data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbi

@@ -23,7 +23,9 @@ module GrowsurfRuby
         attr_accessor :results
 
         sig do
-          returns(GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Summary)
+          returns(
+            GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Summary
+          )
         end
         attr_reader :summary
 

data/rbi/growsurf_ruby/models/campaign/participant_get_payout_destination_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantGetPayoutDestinationParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(id:, participant_id_or_email:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end