growsurf-ruby 0.0.2

data/rbi/growsurf_ruby/models/campaign/participant_list_referrals_params.rbi

@@ -0,0 +1,228 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantListReferralsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        # Return results in descending order when true.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :desc
+
+        sig { params(desc: T::Boolean).void }
+        attr_writer :desc
+
+        # URL-encoded email value to filter referral results.
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        # First name value to filter results.
+        sig { returns(T.nilable(String)) }
+        attr_reader :first_name
+
+        sig { params(first_name: String).void }
+        attr_writer :first_name
+
+        # Last name value to filter results.
+        sig { returns(T.nilable(String)) }
+        attr_reader :last_name
+
+        sig { params(last_name: String).void }
+        attr_writer :last_name
+
+        # Number of results to return. Maximum 100.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # ID to start the next paged result set with.
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_id
+
+        sig { params(next_id: String).void }
+        attr_writer :next_id
+
+        # Offset number used to skip through a result set.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :offset
+
+        sig { params(offset: Integer).void }
+        attr_writer :offset
+
+        sig do
+          returns(T.nilable(GrowsurfRuby::Campaign::ReferralStatus::OrSymbol))
+        end
+        attr_reader :referral_status
+
+        sig do
+          params(
+            referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol
+          ).void
+        end
+        attr_writer :referral_status
+
+        # Field used to sort referral results.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::OrSymbol
+            )
+          )
+        end
+        attr_reader :sort_by
+
+        sig do
+          params(
+            sort_by:
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::OrSymbol
+          ).void
+        end
+        attr_writer :sort_by
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            desc: T::Boolean,
+            email: String,
+            first_name: String,
+            last_name: String,
+            limit: Integer,
+            next_id: String,
+            offset: Integer,
+            referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol,
+            sort_by:
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          participant_id_or_email:,
+          # Return results in descending order when true.
+          desc: nil,
+          # URL-encoded email value to filter referral results.
+          email: nil,
+          # First name value to filter results.
+          first_name: nil,
+          # Last name value to filter results.
+          last_name: nil,
+          # Number of results to return. Maximum 100.
+          limit: nil,
+          # ID to start the next paged result set with.
+          next_id: nil,
+          # Offset number used to skip through a result set.
+          offset: nil,
+          referral_status: nil,
+          # Field used to sort referral results.
+          sort_by: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              desc: T::Boolean,
+              email: String,
+              first_name: String,
+              last_name: String,
+              limit: Integer,
+              next_id: String,
+              offset: Integer,
+              referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol,
+              sort_by:
+                GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::OrSymbol,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Field used to sort referral results.
+        module SortBy
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          UPDATED_AT =
+            T.let(
+              :updatedAt,
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::TaggedSymbol
+            )
+          CREATED_AT =
+            T.let(
+              :createdAt,
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::TaggedSymbol
+            )
+          EMAIL =
+            T.let(
+              :email,
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::TaggedSymbol
+            )
+          FIRST_NAME =
+            T.let(
+              :firstName,
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::TaggedSymbol
+            )
+          LAST_NAME =
+            T.let(
+              :lastName,
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::TaggedSymbol
+            )
+          REFERRAL_STATUS =
+            T.let(
+              :referralStatus,
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::TaggedSymbol
+            )
+          REFERRAL_TRIGGERED_AT =
+            T.let(
+              :referralTriggeredAt,
+              GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_list_rewards_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantListRewardsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantListRewardsParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        # Number of results to return. Maximum 100.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # ID to start the next paged result set with.
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_id
+
+        sig { params(next_id: String).void }
+        attr_writer :next_id
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            limit: Integer,
+            next_id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          participant_id_or_email:,
+          # Number of results to return. Maximum 100.
+          limit: nil,
+          # ID to start the next paged result set with.
+          next_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              limit: Integer,
+              next_id: String,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/participant_list_rewards_response.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantListRewardsResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::ParticipantListRewardsResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :limit
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_id
+
+        sig { returns(T::Array[GrowsurfRuby::Campaign::ParticipantReward]) }
+        attr_accessor :rewards
+
+        sig do
+          params(
+            limit: Integer,
+            next_id: T.nilable(String),
+            rewards: T::Array[GrowsurfRuby::Campaign::ParticipantReward::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(limit:, next_id:, rewards:)
+        end
+
+        sig do
+          override.returns(
+            {
+              limit: Integer,
+              next_id: T.nilable(String),
+              rewards: T::Array[GrowsurfRuby::Campaign::ParticipantReward]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,255 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantRecordTransactionParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantRecordTransactionParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        sig { returns(String) }
+        attr_accessor :currency
+
+        sig { returns(Integer) }
+        attr_accessor :gross_amount
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :amount_cash_net
+
+        sig { params(amount_cash_net: Integer).void }
+        attr_writer :amount_cash_net
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :amount_paid
+
+        sig { params(amount_paid: Integer).void }
+        attr_writer :amount_paid
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :charge_id
+
+        sig { params(charge_id: String).void }
+        attr_writer :charge_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :external_id
+
+        sig { params(external_id: String).void }
+        attr_writer :external_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :invoice_id
+
+        sig { params(invoice_id: String).void }
+        attr_writer :invoice_id
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :invoice_subtotal_excluding_tax
+
+        sig { params(invoice_subtotal_excluding_tax: Integer).void }
+        attr_writer :invoice_subtotal_excluding_tax
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :invoice_total
+
+        sig { params(invoice_total: Integer).void }
+        attr_writer :invoice_total
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :invoice_total_excluding_tax
+
+        sig { params(invoice_total_excluding_tax: Integer).void }
+        attr_writer :invoice_total_excluding_tax
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :net_amount
+
+        sig { params(net_amount: Integer).void }
+        attr_writer :net_amount
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :order_id
+
+        sig { params(order_id: String).void }
+        attr_writer :order_id
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :paid_at
+
+        sig { params(paid_at: Integer).void }
+        attr_writer :paid_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :payment_id
+
+        sig { params(payment_id: String).void }
+        attr_writer :payment_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :payment_intent_id
+
+        sig { params(payment_intent_id: String).void }
+        attr_writer :payment_intent_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :subscription_id
+
+        sig { params(subscription_id: String).void }
+        attr_writer :subscription_id
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :tax_amount
+
+        sig { params(tax_amount: Integer).void }
+        attr_writer :tax_amount
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :total_tax_amount
+
+        sig { params(total_tax_amount: Integer).void }
+        attr_writer :total_tax_amount
+
+        sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+        attr_reader :total_tax_amounts
+
+        sig do
+          params(total_tax_amounts: T::Array[T::Hash[Symbol, T.anything]]).void
+        end
+        attr_writer :total_tax_amounts
+
+        sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+        attr_reader :total_taxes
+
+        sig { params(total_taxes: T::Array[T::Hash[Symbol, T.anything]]).void }
+        attr_writer :total_taxes
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :transaction_id
+
+        sig { params(transaction_id: String).void }
+        attr_writer :transaction_id
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            currency: String,
+            gross_amount: Integer,
+            amount_cash_net: Integer,
+            amount_paid: Integer,
+            charge_id: String,
+            customer_id: String,
+            description: String,
+            external_id: String,
+            invoice_id: String,
+            invoice_subtotal_excluding_tax: Integer,
+            invoice_total: Integer,
+            invoice_total_excluding_tax: Integer,
+            net_amount: Integer,
+            order_id: String,
+            paid_at: Integer,
+            payment_id: String,
+            payment_intent_id: String,
+            subscription_id: String,
+            tax_amount: Integer,
+            total_tax_amount: Integer,
+            total_tax_amounts: T::Array[T::Hash[Symbol, T.anything]],
+            total_taxes: T::Array[T::Hash[Symbol, T.anything]],
+            transaction_id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          participant_id_or_email:,
+          currency:,
+          gross_amount:,
+          amount_cash_net: nil,
+          amount_paid: nil,
+          charge_id: nil,
+          customer_id: nil,
+          description: nil,
+          external_id: nil,
+          invoice_id: nil,
+          invoice_subtotal_excluding_tax: nil,
+          invoice_total: nil,
+          invoice_total_excluding_tax: nil,
+          net_amount: nil,
+          order_id: nil,
+          paid_at: nil,
+          payment_id: nil,
+          payment_intent_id: nil,
+          subscription_id: nil,
+          tax_amount: nil,
+          total_tax_amount: nil,
+          total_tax_amounts: nil,
+          total_taxes: nil,
+          transaction_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              currency: String,
+              gross_amount: Integer,
+              amount_cash_net: Integer,
+              amount_paid: Integer,
+              charge_id: String,
+              customer_id: String,
+              description: String,
+              external_id: String,
+              invoice_id: String,
+              invoice_subtotal_excluding_tax: Integer,
+              invoice_total: Integer,
+              invoice_total_excluding_tax: Integer,
+              net_amount: Integer,
+              order_id: String,
+              paid_at: Integer,
+              payment_id: String,
+              payment_intent_id: String,
+              subscription_id: String,
+              tax_amount: Integer,
+              total_tax_amount: Integer,
+              total_tax_amounts: T::Array[T::Hash[Symbol, T.anything]],
+              total_taxes: T::Array[T::Hash[Symbol, T.anything]],
+              transaction_id: String,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end