growsurf-ruby 1.2.1 → 1.4.0

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

data/rbi/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rbi

@@ -0,0 +1,243 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantGetPayoutDestinationResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # The provider that currently gets paid, or null until the participant confirms
+        # one.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :active_provider
+
+        # One entry per enabled payout provider describing the participant's destination
+        # for it.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination
+              ]
+            )
+          )
+        end
+        attr_reader :destinations
+
+        sig do
+          params(
+            destinations:
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::OrHash
+              ]
+          ).void
+        end
+        attr_writer :destinations
+
+        # The payout providers enabled for this program.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[String]
+            )
+          )
+        end
+        attr_reader :enabled_providers
+
+        sig do
+          params(
+            enabled_providers:
+              T::Array[String]
+          ).void
+        end
+        attr_writer :enabled_providers
+
+        sig do
+          params(
+            active_provider: T.nilable(String),
+            destinations:
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::OrHash
+              ],
+            enabled_providers: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The provider that currently gets paid, or null until the participant confirms
+          # one.
+          active_provider: nil,
+          # One entry per enabled payout provider describing the participant's destination
+          # for it.
+          destinations: nil,
+          # The payout providers enabled for this program.
+          enabled_providers: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              active_provider: T.nilable(String),
+              destinations:
+                T::Array[
+                  GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination
+                ],
+              enabled_providers: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Destination < GrowsurfRuby::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination,
+                GrowsurfRuby::Internal::AnyHash
+              )
+            end
+
+          # The confirmed payout email for this provider.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :claim_email
+
+          # When the destination was confirmed, as a Unix timestamp in milliseconds.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :confirmed_at
+
+          # The legal recipient type the participant confirmed, if any.
+          sig do
+            returns(
+              T.nilable(
+                GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :legal_entity_type
+
+          # When status is `NEEDS_REPAIR`, why (e.g. a bounced delivery).
+          sig { returns(T.nilable(String)) }
+          attr_accessor :needs_repair_reason
+
+          # The payout provider this entry describes.
+          sig { returns(T.nilable(String)) }
+          attr_reader :provider
+
+          sig { params(provider: String).void }
+          attr_writer :provider
+
+          # The customer-facing provider name (e.g. "PayPal", "Wise").
+          sig { returns(T.nilable(String)) }
+          attr_reader :provider_display_name
+
+          sig { params(provider_display_name: String).void }
+          attr_writer :provider_display_name
+
+          # The destination's current status: `NONE` (not set up), `PENDING_CONFIRMATION`,
+          # `CONFIRMED`, `ACTIVE`, `NEEDS_REPAIR`, or `EXPIRED`. Historical superseded
+          # or revoked destinations are projected as `NONE`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :status
+
+          sig { params(status: String).void }
+          attr_writer :status
+
+          sig do
+            params(
+              claim_email: T.nilable(String),
+              confirmed_at: T.nilable(Integer),
+              legal_entity_type:
+                T.nilable(
+                  GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType::OrSymbol
+                ),
+              needs_repair_reason: T.nilable(String),
+              provider: String,
+              provider_display_name: String,
+              status: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The confirmed payout email for this provider.
+            claim_email: nil,
+            # When the destination was confirmed, as a Unix timestamp in milliseconds.
+            confirmed_at: nil,
+            # The legal recipient type the participant confirmed, if any.
+            legal_entity_type: nil,
+            # When status is `NEEDS_REPAIR`, why (e.g. a bounced delivery).
+            needs_repair_reason: nil,
+            # The payout provider this entry describes.
+            provider: nil,
+            # The customer-facing provider name (e.g. "PayPal", "Wise").
+            provider_display_name: nil,
+            # The destination's current status: `NONE` (not set up), `PENDING_CONFIRMATION`,
+            # `CONFIRMED`, `ACTIVE`, `NEEDS_REPAIR`, or `EXPIRED`. Historical superseded
+            # or revoked destinations are projected as `NONE`.
+            status: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                claim_email: T.nilable(String),
+                confirmed_at: T.nilable(Integer),
+                legal_entity_type:
+                  T.nilable(
+                    GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType::TaggedSymbol
+                  ),
+                needs_repair_reason: T.nilable(String),
+                provider: String,
+                provider_display_name: String,
+                status: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The legal recipient type the participant confirmed, if any.
+          module LegalEntityType
+            extend GrowsurfRuby::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INDIVIDUAL =
+              T.let(
+                :INDIVIDUAL,
+                GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType::TaggedSymbol
+              )
+            BUSINESS =
+              T.let(
+                :BUSINESS,
+                GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination::LegalEntityType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_list_payouts_params.rbi

@@ -126,6 +126,11 @@ module GrowsurfRuby
               :FAILED,
               GrowsurfRuby::Campaign::ParticipantListPayoutsParams::Status::TaggedSymbol
             )
+          REVERSED =
+            T.let(
+              :REVERSED,
+              GrowsurfRuby::Campaign::ParticipantListPayoutsParams::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rbi

@@ -0,0 +1,100 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantRequestPayoutDestinationConfirmationParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        # The payout provider the participant should confirm a destination for.
+        sig do
+          returns(
+            GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider::TaggedSymbol
+          )
+        end
+        attr_accessor :provider
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            provider:
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          participant_id_or_email:,
+          # The payout provider the participant should confirm a destination for.
+          provider:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              provider:
+                GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider::TaggedSymbol,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Provider
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PAYPAL =
+            T.let(
+              :PAYPAL,
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider::TaggedSymbol
+            )
+          WISECOM =
+            T.let(
+              :WISECOM,
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::Provider::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rbi

@@ -0,0 +1,118 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantRequestPayoutDestinationConfirmationResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # When the confirmation link expires, as a Unix timestamp in milliseconds.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :expires_at
+
+        # The provider the participant was asked to confirm.
+        sig { returns(T.nilable(String)) }
+        attr_reader :provider
+
+        sig { params(provider: String).void }
+        attr_writer :provider
+
+        # The customer-facing provider name (e.g. "PayPal", "Wise").
+        sig { returns(T.nilable(String)) }
+        attr_reader :provider_display_name
+
+        sig { params(provider_display_name: String).void }
+        attr_writer :provider_display_name
+
+        # Confirms the message was requested.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status::OrSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig do
+          params(
+            expires_at: T.nilable(Integer),
+            provider: String,
+            provider_display_name: String,
+            status:
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # When the confirmation link expires, as a Unix timestamp in milliseconds.
+          expires_at: nil,
+          # The provider the participant was asked to confirm.
+          provider: nil,
+          # The customer-facing provider name (e.g. "PayPal", "Wise").
+          provider_display_name: nil,
+          # Confirms the message was requested.
+          status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              expires_at: T.nilable(Integer),
+              provider: String,
+              provider_display_name: String,
+              status:
+                GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Confirms the message was requested.
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CONFIRMATION_REQUESTED =
+            T.let(
+              :CONFIRMATION_REQUESTED,
+              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end