growsurf-ruby 1.2.1 → 1.3.0

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

data/rbi/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbi

@@ -36,25 +36,20 @@ module GrowsurfRuby
         sig { params(end_date: Integer).void }
         attr_writer :end_date
 
-        # Set to `series` to also return this participant's own activity per period.
-        sig do
-          returns(
-            T.nilable(
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol
-            )
-          )
-        end
+        # Comma-separated optional data. `series` returns this participant's own activity per
+        # period; `email` returns `sent`, `delivered`, `opened`, `clicked`, `bounced`,
+        # `spamComplaints`, and per-email-type metrics attributed to the participant for the
+        # requested analytics window (including invitations they sent). Request both in either
+        # order to add email counts to every series item for emails sent during that period. Only
+        # documented tokens are accepted; an unknown token returns `400`.
+        sig { returns(T.nilable(String)) }
         attr_reader :include
 
-        sig do
-          params(
-            include:
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol
-          ).void
-        end
+        sig { params(include: String).void }
         attr_writer :include
 
-        # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        # Bucket size for the `series` (only used when `include` contains `series`). Defaults to
+        # `day`.
         sig do
           returns(
             T.nilable(
@@ -86,8 +81,7 @@ module GrowsurfRuby
             participant_id_or_email: String,
             days: Integer,
             end_date: Integer,
-            include:
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol,
+            include: String,
             interval:
               GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol,
             start_date: Integer,
@@ -102,9 +96,15 @@ module GrowsurfRuby
           # End date of the analytics timeframe as a Unix timestamp in milliseconds.
           # Required if `days` is not set.
           end_date: nil,
-          # Set to `series` to also return this participant's own activity per period.
+          # Comma-separated optional data. `series` returns this participant's own activity per
+          # period; `email` returns `sent`, `delivered`, `opened`, `clicked`, `bounced`,
+          # `spamComplaints`, and per-email-type metrics attributed to the participant for the
+          # requested analytics window (including invitations they sent). Request both in either
+          # order to add email counts to every series item for emails sent during that period.
+          # Only documented tokens are accepted; an unknown token returns `400`.
           include: nil,
-          # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+          # 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.
@@ -120,8 +120,7 @@ module GrowsurfRuby
               participant_id_or_email: String,
               days: Integer,
               end_date: Integer,
-              include:
-                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::OrSymbol,
+              include: String,
               interval:
                 GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Interval::OrSymbol,
               start_date: Integer,
@@ -132,37 +131,8 @@ module GrowsurfRuby
         def to_hash
         end
 
-        # Set to `series` to also return this participant's own activity per period.
-        module Include
-          extend GrowsurfRuby::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          SERIES =
-            T.let(
-              :series,
-              GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                GrowsurfRuby::Campaign::ParticipantRetrieveAnalyticsParams::Include::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # Bucket size for the `series` (only used with `include=series`). Defaults to `day`.
+        # Bucket size for the `series` (only used when `include` contains `series`). Defaults to
+        # `day`.
         module Interval
           extend GrowsurfRuby::Internal::Type::Enum