growsurf-ruby 1.4.0 → 1.5.1

data/rbi/growsurf_ruby/models/campaign/integration.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class Integration < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::Integration,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # Stable integration key, the same value the GrowSurf dashboard uses for this
+        # integration.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Whether GrowSurf switched the integration off after repeated delivery failures.
+        # Its credentials are still stored, but it delivers nothing until it is
+        # reconnected in the GrowSurf dashboard.
+        sig { returns(T::Boolean) }
+        attr_accessor :auto_disabled
+
+        # Dashboard link that opens this integration's connect panel in the GrowSurf Program
+        # Editor. Give it to the person running the program: connecting an account is a step
+        # they complete in the dashboard, and the API cannot do it for them.
+        sig { returns(String) }
+        attr_accessor :connect_url
+
+        # Whether the program has stored credentials for this integration.
+        sig { returns(T::Boolean) }
+        attr_accessor :connected
+
+        # Whether the integration is switched on and currently working.
+        sig { returns(T::Boolean) }
+        attr_accessor :enabled
+
+        # Display name, matching what the GrowSurf dashboard calls this integration.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # One integration a program can connect, with its current state.
+        sig do
+          params(
+            id: String,
+            auto_disabled: T::Boolean,
+            connect_url: String,
+            connected: T::Boolean,
+            enabled: T::Boolean,
+            name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Stable integration key, the same value the GrowSurf dashboard uses for this
+          # integration.
+          id:,
+          # Whether GrowSurf switched the integration off after repeated delivery failures.
+          # Its credentials are still stored, but it delivers nothing until it is
+          # reconnected in the GrowSurf dashboard.
+          auto_disabled:,
+          # Dashboard link that opens this integration's connect panel in the GrowSurf Program
+          # Editor. Give it to the person running the program: connecting an account is a step
+          # they complete in the dashboard, and the API cannot do it for them.
+          connect_url:,
+          # Whether the program has stored credentials for this integration.
+          connected:,
+          # Whether the integration is switched on and currently working.
+          enabled:,
+          # Display name, matching what the GrowSurf dashboard calls this integration.
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              auto_disabled: T::Boolean,
+              connect_url: String,
+              connected: T::Boolean,
+              enabled: T::Boolean,
+              name: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/integration_list_response.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class IntegrationListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::IntegrationListResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        # Every integration this program can connect, in the order the GrowSurf dashboard
+        # lists them.
+        sig { returns(T::Array[GrowsurfRuby::Models::Campaign::Integration]) }
+        attr_accessor :integrations
+
+        sig do
+          params(
+            integrations:
+              T::Array[GrowsurfRuby::Models::Campaign::Integration::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Every integration this program can connect, in the order the GrowSurf dashboard
+          # lists them.
+          integrations:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              integrations:
+                T::Array[GrowsurfRuby::Models::Campaign::Integration]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_activation_analytics.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantActivationAnalytics < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::ParticipantActivationAnalytics,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :coverage_start_at, :enrolled_as_advocate_at
+
+        sig { returns(Integer) }
+        attr_accessor :metric_contract_version
+
+        sig { returns(ProgramType::OrSymbol) }
+        attr_accessor :program_type
+
+        sig { returns(GrowsurfRuby::Models::AnalyticsAvailability::OrSymbol) }
+        attr_accessor :state
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::AnalyticsUnavailableReason::OrSymbol
+            )
+          )
+        end
+        attr_accessor :reason
+
+        sig { returns(Cohort) }
+        attr_accessor :cohort
+
+        sig { returns(Milestones) }
+        attr_accessor :milestones
+
+        sig { params(kwargs: T.untyped).returns(T.attached_class) }
+        def self.new(**kwargs)
+        end
+
+        module ProgramType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          REFERRAL = T.let(:REFERRAL, Symbol)
+          AFFILIATE = T.let(:AFFILIATE, Symbol)
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+
+        module AnchorField
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          ENROLLED_AS_ADVOCATE_AT = T.let(:enrolledAsAdvocateAt, Symbol)
+          APPROVED_AS_AFFILIATE_AT = T.let(:approvedAsAffiliateAt, Symbol)
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+
+        module ShareChannel
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          EMAIL = T.let(:email, Symbol)
+          FACEBOOK = T.let(:facebook, Symbol)
+          TWITTER = T.let(:twitter, Symbol)
+          LINKEDIN = T.let(:linkedin, Symbol)
+          PINTEREST = T.let(:pinterest, Symbol)
+          THREADS = T.let(:threads, Symbol)
+          BLUESKY = T.let(:bluesky, Symbol)
+          SMS = T.let(:sms, Symbol)
+          MESSENGER = T.let(:messenger, Symbol)
+          WHATSAPP = T.let(:whatsapp, Symbol)
+          WECHAT = T.let(:wechat, Symbol)
+          TELEGRAM = T.let(:telegram, Symbol)
+          REDDIT = T.let(:reddit, Symbol)
+          TUMBLR = T.let(:tumblr, Symbol)
+          QRCODE = T.let(:qrcode, Symbol)
+          COPY_REF_LINK = T.let(:copyRefLink, Symbol)
+          IOS_NATIVE_SHARE = T.let(:iosNativeShare, Symbol)
+          ANDROID_NATIVE_SHARE = T.let(:androidNativeShare, Symbol)
+          sig { override.returns(T::Array[Symbol]) }
+          def self.values
+          end
+        end
+
+        class Cohort < GrowsurfRuby::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Cohort, GrowsurfRuby::Internal::AnyHash) }
+          sig { returns(AnchorField::OrSymbol) }
+          attr_accessor :anchor_field
+
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :anchor_at
+
+          sig { params(kwargs: T.untyped).returns(T.attached_class) }
+          def self.new(**kwargs)
+          end
+        end
+
+        class Milestones < GrowsurfRuby::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Milestones, GrowsurfRuby::Internal::AnyHash) }
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :first_portal_viewed_at,
+                        :first_referral_link_copied_at,
+                        :first_share_at,
+                        :first_unique_click_at,
+                        :first_lead_at,
+                        :first_referral_at,
+                        :first_reward_at,
+                        :first_commission_at,
+                        :payout_setup_completed_at
+
+          sig { returns(T.nilable(ShareChannel::OrSymbol)) }
+          attr_accessor :first_share_channel
+
+          sig { params(kwargs: T.untyped).returns(T.attached_class) }
+          def self.new(**kwargs)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -28,6 +28,23 @@ module GrowsurfRuby
         sig { returns(T::Hash[Symbol, Integer]) }
         attr_accessor :share_count
 
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::ParticipantActivationAnalytics
+            )
+          )
+        end
+        attr_reader :activation
+
+        sig do
+          params(
+            activation:
+              GrowsurfRuby::Models::Campaign::ParticipantActivationAnalytics::OrHash
+          ).void
+        end
+        attr_writer :activation
+
         # Present only when `include` contains `series` or `email`. Window end (Unix ms).
         sig { returns(T.nilable(Integer)) }
         attr_reader :end_date
@@ -73,6 +90,8 @@ module GrowsurfRuby
             ranks:
               GrowsurfRuby::Campaign::ParticipantAnalyticsResponse::Ranks::OrHash,
             share_count: T::Hash[Symbol, Integer],
+            activation:
+              GrowsurfRuby::Models::Campaign::ParticipantActivationAnalytics::OrHash,
             end_date: Integer,
             series:
               T::Array[
@@ -86,6 +105,8 @@ module GrowsurfRuby
           ranks:,
           # Per-channel share counts (e.g. `email`, `facebook`, `twitter`, ...).
           share_count:,
+          # Present only when `include` contains `activation`.
+          activation: nil,
           # 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
@@ -105,6 +126,8 @@ module GrowsurfRuby
               ranks:
                 GrowsurfRuby::Campaign::ParticipantAnalyticsResponse::Ranks,
               share_count: T::Hash[Symbol, Integer],
+              activation:
+                GrowsurfRuby::Models::Campaign::ParticipantActivationAnalytics,
               end_date: Integer,
               series:
                 T::Array[
@@ -421,6 +444,9 @@ module GrowsurfRuby
           sig { params(pinterest_shares: Integer).void }
           attr_writer :pinterest_shares
 
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :portal_views
+
           sig { returns(T.nilable(Integer)) }
           attr_reader :qrcode_shares
 
@@ -457,6 +483,9 @@ module GrowsurfRuby
           sig { params(sms_shares: Integer).void }
           attr_writer :sms_shares
 
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :share_actions
+
           sig { returns(T.nilable(Integer)) }
           attr_reader :telegram_shares
 
@@ -542,12 +571,14 @@ module GrowsurfRuby
               participants: Integer,
               period_start: Integer,
               pinterest_shares: Integer,
+              portal_views: T.nilable(Integer),
               qrcode_shares: Integer,
               reddit_shares: Integer,
               referral_credit_expireds: Integer,
               referral_credit_pendings: Integer,
               referrals: Integer,
               sms_shares: Integer,
+              share_actions: T.nilable(Integer),
               telegram_shares: Integer,
               threads_shares: Integer,
               total_commission_count: Integer,
@@ -576,12 +607,14 @@ module GrowsurfRuby
             # Start of the period, as a Unix timestamp in milliseconds (UTC).
             period_start: nil,
             pinterest_shares: nil,
+            portal_views: nil,
             qrcode_shares: nil,
             reddit_shares: nil,
             referral_credit_expireds: nil,
             referral_credit_pendings: nil,
             referrals: nil,
             sms_shares: nil,
+            share_actions: nil,
             telegram_shares: nil,
             threads_shares: nil,
             # Affiliate programs only. Number of commission records.
@@ -616,12 +649,14 @@ module GrowsurfRuby
                 participants: Integer,
                 period_start: Integer,
                 pinterest_shares: Integer,
+                portal_views: T.nilable(Integer),
                 qrcode_shares: Integer,
                 reddit_shares: Integer,
                 referral_credit_expireds: Integer,
                 referral_credit_pendings: Integer,
                 referrals: Integer,
                 sms_shares: Integer,
+                share_actions: T.nilable(Integer),
                 telegram_shares: Integer,
                 threads_shares: Integer,
                 total_commission_count: Integer,

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

@@ -21,11 +21,9 @@ module GrowsurfRuby
         # for it.
         sig do
           returns(
-            T.nilable(
-              T::Array[
-                GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination
-              ]
-            )
+            T::Array[
+              GrowsurfRuby::Campaign::ParticipantGetPayoutDestinationResponse::Destination
+            ]
           )
         end
         attr_reader :destinations
@@ -42,11 +40,7 @@ module GrowsurfRuby
 
         # The payout providers enabled for this program.
         sig do
-          returns(
-            T.nilable(
-              T::Array[String]
-            )
-          )
+          returns(T::Array[String])
         end
         attr_reader :enabled_providers
 
@@ -71,12 +65,12 @@ module GrowsurfRuby
         def self.new(
           # The provider that currently gets paid, or null until the participant confirms
           # one.
-          active_provider: nil,
+          active_provider:,
           # One entry per enabled payout provider describing the participant's destination
           # for it.
-          destinations: nil,
+          destinations:,
           # The payout providers enabled for this program.
-          enabled_providers: nil
+          enabled_providers:
         )
         end
 
@@ -127,14 +121,14 @@ module GrowsurfRuby
           attr_accessor :needs_repair_reason
 
           # The payout provider this entry describes.
-          sig { returns(T.nilable(String)) }
+          sig { returns(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)) }
+          sig { returns(String) }
           attr_reader :provider_display_name
 
           sig { params(provider_display_name: String).void }
@@ -143,7 +137,7 @@ module GrowsurfRuby
           # 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)) }
+          sig { returns(String) }
           attr_reader :status
 
           sig { params(status: String).void }
@@ -165,21 +159,21 @@ module GrowsurfRuby
           end
           def self.new(
             # The confirmed payout email for this provider.
-            claim_email: nil,
+            claim_email:,
             # When the destination was confirmed, as a Unix timestamp in milliseconds.
-            confirmed_at: nil,
+            confirmed_at:,
             # The legal recipient type the participant confirmed, if any.
-            legal_entity_type: nil,
+            legal_entity_type:,
             # When status is `NEEDS_REPAIR`, why (e.g. a bounced delivery).
-            needs_repair_reason: nil,
+            needs_repair_reason:,
             # The payout provider this entry describes.
-            provider: nil,
+            provider:,
             # The customer-facing provider name (e.g. "PayPal", "Wise").
-            provider_display_name: nil,
+            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`.
-            status: nil
+            status:
           )
           end
 

data/rbi/growsurf_ruby/models/campaign/participant_record_transaction_params.rbi

@@ -155,6 +155,18 @@ module GrowsurfRuby
         sig { params(transaction_id: String).void }
         attr_writer :transaction_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :payment_provider
+
+        sig { params(payment_provider: String).void }
+        attr_writer :payment_provider
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :test_mode
+
+        sig { params(test_mode: T::Boolean).void }
+        attr_writer :test_mode
+
         sig do
           params(
             id: String,
@@ -182,6 +194,8 @@ module GrowsurfRuby
             total_tax_amounts: T::Array[T::Hash[Symbol, T.anything]],
             total_taxes: T::Array[T::Hash[Symbol, T.anything]],
             transaction_id: String,
+            payment_provider: String,
+            test_mode: T::Boolean,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -211,6 +225,8 @@ module GrowsurfRuby
           total_tax_amounts: nil,
           total_taxes: nil,
           transaction_id: nil,
+          payment_provider: nil,
+          test_mode: nil,
           request_options: {}
         )
         end
@@ -243,6 +259,8 @@ module GrowsurfRuby
               total_tax_amounts: T::Array[T::Hash[Symbol, T.anything]],
               total_taxes: T::Array[T::Hash[Symbol, T.anything]],
               transaction_id: String,
+              payment_provider: String,
+              test_mode: T::Boolean,
               request_options: GrowsurfRuby::RequestOptions
             }
           )

data/rbi/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbi

@@ -122,6 +122,18 @@ module GrowsurfRuby
         sig { params(transaction_id: String).void }
         attr_writer :transaction_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :payment_provider
+
+        sig { params(payment_provider: String).void }
+        attr_writer :payment_provider
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :test_mode
+
+        sig { params(test_mode: T::Boolean).void }
+        attr_writer :test_mode
+
         sig do
           params(
             id: String,
@@ -142,6 +154,8 @@ module GrowsurfRuby
             refund_id: String,
             refund_status: String,
             transaction_id: String,
+            payment_provider: String,
+            test_mode: T::Boolean,
             request_options: GrowsurfRuby::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -163,6 +177,8 @@ module GrowsurfRuby
           refund_id: nil,
           refund_status: nil,
           transaction_id: nil,
+          payment_provider: nil,
+          test_mode: nil,
           request_options: {}
         )
         end
@@ -188,6 +204,8 @@ module GrowsurfRuby
               refund_id: String,
               refund_status: String,
               transaction_id: String,
+              payment_provider: String,
+              test_mode: T::Boolean,
               request_options: GrowsurfRuby::RequestOptions
             }
           )

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

@@ -17,14 +17,14 @@ module GrowsurfRuby
         attr_accessor :expires_at
 
         # The provider the participant was asked to confirm.
-        sig { returns(T.nilable(String)) }
+        sig { returns(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)) }
+        sig { returns(String) }
         attr_reader :provider_display_name
 
         sig { params(provider_display_name: String).void }
@@ -33,9 +33,7 @@ module GrowsurfRuby
         # Confirms the message was requested.
         sig do
           returns(
-            T.nilable(
-              GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status::OrSymbol
-            )
+            GrowsurfRuby::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::Status::OrSymbol
           )
         end
         attr_reader :status
@@ -59,13 +57,13 @@ module GrowsurfRuby
         end
         def self.new(
           # When the confirmation link expires, as a Unix timestamp in milliseconds.
-          expires_at: nil,
+          expires_at:,
           # The provider the participant was asked to confirm.
-          provider: nil,
+          provider:,
           # The customer-facing provider name (e.g. "PayPal", "Wise").
-          provider_display_name: nil,
+          provider_display_name:,
           # Confirms the message was requested.
-          status: nil
+          status:
         )
         end
 

data/rbi/growsurf_ruby/models/campaign/participant_reward.rbi

@@ -34,9 +34,15 @@ module GrowsurfRuby
         sig { returns(T.nilable(Integer)) }
         attr_reader :approved_at
 
-        sig { params(approved_at: Integer).void }
+        sig { params(approved_at: T.nilable(Integer)).void }
         attr_writer :approved_at
 
+        sig { returns(T.nilable(Float)) }
+        attr_reader :amount
+
+        sig { params(amount: T.nilable(Float)).void }
+        attr_writer :amount
+
         sig { returns(T.nilable(GrowsurfRuby::CommissionStructure)) }
         attr_reader :commission_structure
 
@@ -48,10 +54,16 @@ module GrowsurfRuby
         end
         attr_writer :commission_structure
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :currency_iso
+
+        sig { params(currency_iso: T.nilable(String)).void }
+        attr_writer :currency_iso
+
         sig { returns(T.nilable(Integer)) }
         attr_reader :fulfilled_at
 
-        sig { params(fulfilled_at: Integer).void }
+        sig { params(fulfilled_at: T.nilable(Integer)).void }
         attr_writer :fulfilled_at
 
         sig { returns(T.nilable(T::Boolean)) }
@@ -96,10 +108,12 @@ module GrowsurfRuby
             reward_id: String,
             status: GrowsurfRuby::Campaign::ParticipantReward::Status::OrSymbol,
             approved: T::Boolean,
-            approved_at: Integer,
+            approved_at: T.nilable(Integer),
+            amount: T.nilable(Float),
             commission_structure:
               T.nilable(GrowsurfRuby::CommissionStructure::OrHash),
-            fulfilled_at: Integer,
+            currency_iso: T.nilable(String),
+            fulfilled_at: T.nilable(Integer),
             is_available: T::Boolean,
             is_fulfilled: T::Boolean,
             is_referrer: T::Boolean,
@@ -114,7 +128,9 @@ module GrowsurfRuby
           status:,
           approved: nil,
           approved_at: nil,
+          amount: nil,
           commission_structure: nil,
+          currency_iso: nil,
           fulfilled_at: nil,
           is_available: nil,
           is_fulfilled: nil,
@@ -133,10 +149,12 @@ module GrowsurfRuby
               status:
                 GrowsurfRuby::Campaign::ParticipantReward::Status::TaggedSymbol,
               approved: T::Boolean,
-              approved_at: Integer,
+              approved_at: T.nilable(Integer),
+              amount: T.nilable(Float),
               commission_structure:
                 T.nilable(GrowsurfRuby::CommissionStructure),
-              fulfilled_at: Integer,
+              currency_iso: T.nilable(String),
+              fulfilled_at: T.nilable(Integer),
               is_available: T::Boolean,
               is_fulfilled: T::Boolean,
               is_referrer: T::Boolean,