growsurf-ruby 0.0.2

data/rbi/growsurf_ruby/models/participant_commission_list.rbi

@@ -0,0 +1,269 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class ParticipantCommissionList < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::ParticipantCommissionList,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(T::Array[GrowsurfRuby::ParticipantCommissionList::Commission])
+      end
+      attr_accessor :commissions
+
+      sig { returns(Integer) }
+      attr_accessor :limit
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :next_id
+
+      sig do
+        params(
+          commissions:
+            T::Array[
+              GrowsurfRuby::ParticipantCommissionList::Commission::OrHash
+            ],
+          limit: Integer,
+          next_id: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(commissions:, limit:, next_id:)
+      end
+
+      sig do
+        override.returns(
+          {
+            commissions:
+              T::Array[GrowsurfRuby::ParticipantCommissionList::Commission],
+            limit: Integer,
+            next_id: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Commission < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::ParticipantCommissionList::Commission,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :currency_iso
+
+        sig { returns(String) }
+        attr_accessor :referred_id
+
+        sig { returns(String) }
+        attr_accessor :referrer_id
+
+        sig { returns(Integer) }
+        attr_accessor :sale_amount
+
+        sig do
+          returns(
+            GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :amount_in_campaign_currency
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :approved_at
+
+        sig { params(approved_at: Integer).void }
+        attr_writer :approved_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :campaign_currency_iso
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :exchange_rate
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :exchange_rate_at
+
+        sig { params(exchange_rate_at: Integer).void }
+        attr_writer :exchange_rate_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :fx_error
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :hold_duration
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :paid_at
+
+        sig { params(paid_at: Integer).void }
+        attr_writer :paid_at
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :payout_queued_at
+
+        sig { params(payout_queued_at: Integer).void }
+        attr_writer :payout_queued_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :provider
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :reversed_at
+
+        sig { params(reversed_at: Integer).void }
+        attr_writer :reversed_at
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :sale_amount_amount_in_campaign_currency
+
+        sig do
+          params(
+            id: String,
+            amount: Integer,
+            created_at: Integer,
+            currency_iso: String,
+            referred_id: String,
+            referrer_id: String,
+            sale_amount: Integer,
+            status:
+              GrowsurfRuby::ParticipantCommissionList::Commission::Status::OrSymbol,
+            amount_in_campaign_currency: T.nilable(Integer),
+            approved_at: Integer,
+            campaign_currency_iso: T.nilable(String),
+            exchange_rate: T.nilable(Float),
+            exchange_rate_at: Integer,
+            fx_error: T.nilable(String),
+            hold_duration: T.nilable(Integer),
+            paid_at: Integer,
+            payout_queued_at: Integer,
+            provider: T.nilable(String),
+            reversed_at: Integer,
+            sale_amount_amount_in_campaign_currency: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          amount:,
+          created_at:,
+          currency_iso:,
+          referred_id:,
+          referrer_id:,
+          sale_amount:,
+          status:,
+          amount_in_campaign_currency: nil,
+          approved_at: nil,
+          campaign_currency_iso: nil,
+          exchange_rate: nil,
+          exchange_rate_at: nil,
+          fx_error: nil,
+          hold_duration: nil,
+          paid_at: nil,
+          payout_queued_at: nil,
+          provider: nil,
+          reversed_at: nil,
+          sale_amount_amount_in_campaign_currency: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              amount: Integer,
+              created_at: Integer,
+              currency_iso: String,
+              referred_id: String,
+              referrer_id: String,
+              sale_amount: Integer,
+              status:
+                GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol,
+              amount_in_campaign_currency: T.nilable(Integer),
+              approved_at: Integer,
+              campaign_currency_iso: T.nilable(String),
+              exchange_rate: T.nilable(Float),
+              exchange_rate_at: Integer,
+              fx_error: T.nilable(String),
+              hold_duration: T.nilable(Integer),
+              paid_at: Integer,
+              payout_queued_at: Integer,
+              provider: T.nilable(String),
+              reversed_at: Integer,
+              sale_amount_amount_in_campaign_currency: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::ParticipantCommissionList::Commission::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :PENDING,
+              GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol
+            )
+          APPROVED =
+            T.let(
+              :APPROVED,
+              GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol
+            )
+          PAID =
+            T.let(
+              :PAID,
+              GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol
+            )
+          REVERSED =
+            T.let(
+              :REVERSED,
+              GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol
+            )
+          DELETED =
+            T.let(
+              :DELETED,
+              GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::ParticipantCommissionList::Commission::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/participant_list.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class ParticipantList < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(GrowsurfRuby::ParticipantList, 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::CampaignParticipant]) }
+      attr_accessor :participants
+
+      sig do
+        params(
+          limit: Integer,
+          next_id: T.nilable(String),
+          participants:
+            T::Array[GrowsurfRuby::Campaign::CampaignParticipant::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(limit:, next_id:, participants:)
+      end
+
+      sig do
+        override.returns(
+          {
+            limit: Integer,
+            next_id: T.nilable(String),
+            participants: T::Array[GrowsurfRuby::Campaign::CampaignParticipant]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/participant_payout_list.rbi

@@ -0,0 +1,219 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class ParticipantPayoutList < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::ParticipantPayoutList,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Integer) }
+      attr_accessor :limit
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :next_id
+
+      sig { returns(T::Array[GrowsurfRuby::ParticipantPayoutList::Payout]) }
+      attr_accessor :payouts
+
+      sig do
+        params(
+          limit: Integer,
+          next_id: T.nilable(String),
+          payouts: T::Array[GrowsurfRuby::ParticipantPayoutList::Payout::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(limit:, next_id:, payouts:)
+      end
+
+      sig do
+        override.returns(
+          {
+            limit: Integer,
+            next_id: T.nilable(String),
+            payouts: T::Array[GrowsurfRuby::ParticipantPayoutList::Payout]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Payout < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::ParticipantPayoutList::Payout,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        sig { returns(T::Array[String]) }
+        attr_accessor :commission_ids
+
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :currency_iso
+
+        sig { returns(String) }
+        attr_accessor :participant_id
+
+        sig do
+          returns(
+            GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :amount_in_campaign_currency
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :campaign_currency_iso
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :exchange_rate
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :exchange_rate_at
+
+        sig { params(exchange_rate_at: Integer).void }
+        attr_writer :exchange_rate_at
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :failed_at
+
+        sig { params(failed_at: Integer).void }
+        attr_writer :failed_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :fx_error
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :issued_at
+
+        sig { params(issued_at: Integer).void }
+        attr_writer :issued_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :provider
+
+        sig do
+          params(
+            id: String,
+            amount: Integer,
+            commission_ids: T::Array[String],
+            created_at: Integer,
+            currency_iso: String,
+            participant_id: String,
+            status:
+              GrowsurfRuby::ParticipantPayoutList::Payout::Status::OrSymbol,
+            amount_in_campaign_currency: T.nilable(Integer),
+            campaign_currency_iso: T.nilable(String),
+            exchange_rate: T.nilable(Float),
+            exchange_rate_at: Integer,
+            failed_at: Integer,
+            fx_error: T.nilable(String),
+            issued_at: Integer,
+            provider: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          amount:,
+          commission_ids:,
+          created_at:,
+          currency_iso:,
+          participant_id:,
+          status:,
+          amount_in_campaign_currency: nil,
+          campaign_currency_iso: nil,
+          exchange_rate: nil,
+          exchange_rate_at: nil,
+          failed_at: nil,
+          fx_error: nil,
+          issued_at: nil,
+          provider: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              amount: Integer,
+              commission_ids: T::Array[String],
+              created_at: Integer,
+              currency_iso: String,
+              participant_id: String,
+              status:
+                GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol,
+              amount_in_campaign_currency: T.nilable(Integer),
+              campaign_currency_iso: T.nilable(String),
+              exchange_rate: T.nilable(Float),
+              exchange_rate_at: Integer,
+              failed_at: Integer,
+              fx_error: T.nilable(String),
+              issued_at: Integer,
+              provider: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::ParticipantPayoutList::Payout::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          UPCOMING =
+            T.let(
+              :UPCOMING,
+              GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol
+            )
+          QUEUED =
+            T.let(
+              :QUEUED,
+              GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol
+            )
+          ISSUED =
+            T.let(
+              :ISSUED,
+              GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :FAILED,
+              GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::ParticipantPayoutList::Payout::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/referral_list.rbi

@@ -0,0 +1,129 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class ReferralList < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(GrowsurfRuby::ReferralList, GrowsurfRuby::Internal::AnyHash)
+        end
+
+      sig { returns(Integer) }
+      attr_accessor :limit
+
+      sig { returns(T::Boolean) }
+      attr_accessor :more
+
+      sig { returns(T::Array[GrowsurfRuby::ReferralList::Referral]) }
+      attr_accessor :referrals
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :next_id
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :next_offset
+
+      sig do
+        params(
+          limit: Integer,
+          more: T::Boolean,
+          referrals: T::Array[GrowsurfRuby::ReferralList::Referral::OrHash],
+          next_id: T.nilable(String),
+          next_offset: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(limit:, more:, referrals:, next_id: nil, next_offset: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            limit: Integer,
+            more: T::Boolean,
+            referrals: T::Array[GrowsurfRuby::ReferralList::Referral],
+            next_id: T.nilable(String),
+            next_offset: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Referral < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::ReferralList::Referral,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :email
+
+        sig { returns(GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol) }
+        attr_accessor :referral_status
+
+        sig { returns(String) }
+        attr_accessor :referred_by
+
+        sig { returns(Integer) }
+        attr_accessor :updated_at
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :first_name
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :last_name
+
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            email: String,
+            referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol,
+            referred_by: String,
+            updated_at: Integer,
+            first_name: T.nilable(String),
+            last_name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          email:,
+          referral_status:,
+          referred_by:,
+          updated_at:,
+          first_name: nil,
+          last_name: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              email: String,
+              referral_status:
+                GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol,
+              referred_by: String,
+              updated_at: Integer,
+              first_name: T.nilable(String),
+              last_name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module GrowsurfRuby
+  Campaign = GrowsurfRuby::Models::Campaign
+
+  CampaignAPI = GrowsurfRuby::Models::CampaignAPI
+
+  CampaignListCommissionsParams =
+    GrowsurfRuby::Models::CampaignListCommissionsParams
+
+  CampaignListLeaderboardParams =
+    GrowsurfRuby::Models::CampaignListLeaderboardParams
+
+  CampaignListParams = GrowsurfRuby::Models::CampaignListParams
+
+  CampaignListParticipantsParams =
+    GrowsurfRuby::Models::CampaignListParticipantsParams
+
+  CampaignListPayoutsParams = GrowsurfRuby::Models::CampaignListPayoutsParams
+
+  CampaignListReferralsParams =
+    GrowsurfRuby::Models::CampaignListReferralsParams
+
+  CampaignRetrieveAnalyticsParams =
+    GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
+
+  CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
+
+  CommissionStructure = GrowsurfRuby::Models::CommissionStructure
+
+  ParticipantCommissionList = GrowsurfRuby::Models::ParticipantCommissionList
+
+  ParticipantList = GrowsurfRuby::Models::ParticipantList
+
+  ParticipantPayoutList = GrowsurfRuby::Models::ParticipantPayoutList
+
+  ReferralList = GrowsurfRuby::Models::ReferralList
+end