growsurf-ruby 1.3.0 → 1.5.0

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_retrieve_analytics_params.rbi

@@ -21,15 +21,17 @@ module GrowsurfRuby
         sig { returns(String) }
         attr_accessor :participant_id_or_email
 
-        # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        # Last number of days for optional `series` and `email` analytics. Defaults to 365.
+        # Maximum 1825. Does not filter the top-level all-time totals.
         sig { returns(T.nilable(Integer)) }
         attr_reader :days
 
         sig { params(days: Integer).void }
         attr_writer :days
 
-        # End date of the analytics timeframe as a Unix timestamp in milliseconds.
-        # Required if `days` is not set.
+        # End of a custom `series` and `email` analytics window as a Unix timestamp in
+        # milliseconds. Set it together with `startDate`. Does not filter the top-level
+        # all-time totals.
         sig { returns(T.nilable(Integer)) }
         attr_reader :end_date
 
@@ -67,8 +69,9 @@ module GrowsurfRuby
         end
         attr_writer :interval
 
-        # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
-        # Required if `days` is not set.
+        # Start of a custom `series` and `email` analytics window as a Unix timestamp in
+        # milliseconds. Set it together with `endDate`. Does not filter the top-level
+        # all-time totals.
         sig { returns(T.nilable(Integer)) }
         attr_reader :start_date
 
@@ -91,10 +94,12 @@ module GrowsurfRuby
         def self.new(
           id:,
           participant_id_or_email:,
-          # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+          # Last number of days for optional `series` and `email` analytics. Defaults to 365.
+          # Maximum 1825. Does not filter the top-level all-time totals.
           days: nil,
-          # End date of the analytics timeframe as a Unix timestamp in milliseconds.
-          # Required if `days` is not set.
+          # End of a custom `series` and `email` analytics window as a Unix timestamp in
+          # milliseconds. Set it together with `startDate`. Does not filter the top-level
+          # all-time totals.
           end_date: nil,
           # Comma-separated optional data. `series` returns this participant's own activity per
           # period; `email` returns `sent`, `delivered`, `opened`, `clicked`, `bounced`,
@@ -106,8 +111,9 @@ module GrowsurfRuby
           # 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.
+          # Start of a custom `series` and `email` analytics window as a Unix timestamp in
+          # milliseconds. Set it together with `endDate`. Does not filter the top-level
+          # all-time totals.
           start_date: nil,
           request_options: {}
         )

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,
@@ -168,6 +186,11 @@ module GrowsurfRuby
               :FULFILLED,
               GrowsurfRuby::Campaign::ParticipantReward::Status::TaggedSymbol
             )
+          CANCELLED =
+            T.let(
+              :CANCELLED,
+              GrowsurfRuby::Campaign::ParticipantReward::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/growsurf_ruby/models/campaign/program_resource.rbi

@@ -0,0 +1,186 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceFile < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ProgramResourceFile, GrowsurfRuby::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :file_name
+
+        sig { returns(String) }
+        attr_accessor :mime_type
+
+        sig { returns(Integer) }
+        attr_accessor :bytes
+
+        sig { returns(String) }
+        attr_accessor :format
+
+        sig { returns(ModerationStatus::TaggedSymbol) }
+        attr_accessor :moderation_status
+
+        sig do
+          params(
+            file_name: String,
+            mime_type: String,
+            bytes: Integer,
+            format: String,
+            moderation_status: ModerationStatus::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          file_name:,
+          mime_type:,
+          bytes:,
+          format:,
+          moderation_status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              file_name: String,
+              mime_type: String,
+              bytes: Integer,
+              format: String,
+              moderation_status: ModerationStatus::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module ModerationStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, ModerationStatus) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          PENDING = T.let(:PENDING, TaggedSymbol)
+          APPROVED = T.let(:APPROVED, TaggedSymbol)
+          REJECTED = T.let(:REJECTED, TaggedSymbol)
+          sig { override.returns(T::Array[TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+
+      class ProgramResource < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ProgramResource, GrowsurfRuby::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Type::TaggedSymbol) }
+        attr_accessor :type
+
+        sig { returns(String) }
+        attr_accessor :title
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :category
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :text
+
+        sig { returns(T.nilable(ProgramResourceFile)) }
+        attr_reader :file
+
+        sig { params(file: T.nilable(ProgramResourceFile::OrHash)).void }
+        attr_writer :file
+
+        sig { returns(T::Boolean) }
+        attr_accessor :is_published
+
+        sig { returns(Integer) }
+        attr_accessor :position
+
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        sig { returns(Integer) }
+        attr_accessor :updated_at
+
+        sig do
+          params(
+            id: String,
+            type: Type::OrSymbol,
+            title: String,
+            description: T.nilable(String),
+            category: T.nilable(String),
+            url: T.nilable(String),
+            text: T.nilable(String),
+            file: T.nilable(ProgramResourceFile::OrHash),
+            is_published: T::Boolean,
+            position: Integer,
+            created_at: Integer,
+            updated_at: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          type:,
+          title:,
+          description:,
+          category:,
+          url:,
+          text:,
+          file:,
+          is_published:,
+          position:,
+          created_at:,
+          updated_at:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              type: Type::TaggedSymbol,
+              title: String,
+              description: T.nilable(String),
+              category: T.nilable(String),
+              url: T.nilable(String),
+              text: T.nilable(String),
+              file: T.nilable(ProgramResourceFile),
+              is_published: T::Boolean,
+              position: Integer,
+              created_at: Integer,
+              updated_at: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          FILE = T.let(:FILE, TaggedSymbol)
+          LINK = T.let(:LINK, TaggedSymbol)
+          TEXT = T.let(:TEXT, TaggedSymbol)
+          sig { override.returns(T::Array[TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end