growsurf-ruby 0.0.2

data/rbi/growsurf_ruby/models/campaign.rbi

@@ -0,0 +1,376 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignAPI < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(GrowsurfRuby::CampaignAPI, GrowsurfRuby::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Integer) }
+      attr_accessor :impression_count
+
+      sig { returns(Integer) }
+      attr_accessor :invite_count
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(Integer) }
+      attr_accessor :participant_count
+
+      sig { returns(Integer) }
+      attr_accessor :referral_count
+
+      sig { returns(T::Array[GrowsurfRuby::CampaignAPI::Reward]) }
+      attr_accessor :rewards
+
+      sig { returns(GrowsurfRuby::CampaignAPI::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      sig { returns(GrowsurfRuby::CampaignAPI::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      sig { returns(Integer) }
+      attr_accessor :winner_count
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :currency_iso
+
+      sig { params(currency_iso: String).void }
+      attr_writer :currency_iso
+
+      sig do
+        params(
+          id: String,
+          impression_count: Integer,
+          invite_count: Integer,
+          name: String,
+          participant_count: Integer,
+          referral_count: Integer,
+          rewards: T::Array[GrowsurfRuby::CampaignAPI::Reward::OrHash],
+          status: GrowsurfRuby::CampaignAPI::Status::OrSymbol,
+          type: GrowsurfRuby::CampaignAPI::Type::OrSymbol,
+          winner_count: Integer,
+          currency_iso: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        impression_count:,
+        invite_count:,
+        name:,
+        participant_count:,
+        referral_count:,
+        rewards:,
+        status:,
+        type:,
+        winner_count:,
+        currency_iso: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            impression_count: Integer,
+            invite_count: Integer,
+            name: String,
+            participant_count: Integer,
+            referral_count: Integer,
+            rewards: T::Array[GrowsurfRuby::CampaignAPI::Reward],
+            status: GrowsurfRuby::CampaignAPI::Status::TaggedSymbol,
+            type: GrowsurfRuby::CampaignAPI::Type::TaggedSymbol,
+            winner_count: Integer,
+            currency_iso: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Reward < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::CampaignAPI::Reward,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Boolean) }
+        attr_accessor :is_unlimited
+
+        # Shallow custom metadata object.
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :metadata
+
+        sig { returns(GrowsurfRuby::CampaignAPI::Reward::Type::TaggedSymbol) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(GrowsurfRuby::CommissionStructure)) }
+        attr_reader :commission_structure
+
+        sig do
+          params(
+            commission_structure:
+              T.nilable(GrowsurfRuby::CommissionStructure::OrHash)
+          ).void
+        end
+        attr_writer :commission_structure
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :conversions_required
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :coupon_code
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :image_url
+
+        # `-1` represents an unlimited reward in REST responses.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :limit
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::CampaignAPI::Reward::LimitDuration::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :limit_duration
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_milestone_prefix
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_milestone_suffix
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :number_of_winners
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :order
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :referral_description
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :referred_reward_upfront
+
+        sig { params(referred_reward_upfront: T::Boolean).void }
+        attr_writer :referred_reward_upfront
+
+        sig do
+          params(
+            id: String,
+            is_unlimited: T::Boolean,
+            metadata: T::Hash[Symbol, T.anything],
+            type: GrowsurfRuby::CampaignAPI::Reward::Type::OrSymbol,
+            commission_structure:
+              T.nilable(GrowsurfRuby::CommissionStructure::OrHash),
+            conversions_required: T.nilable(Integer),
+            coupon_code: T.nilable(String),
+            description: T.nilable(String),
+            image_url: T.nilable(String),
+            limit: T.nilable(Integer),
+            limit_duration:
+              T.nilable(
+                GrowsurfRuby::CampaignAPI::Reward::LimitDuration::OrSymbol
+              ),
+            next_milestone_prefix: T.nilable(String),
+            next_milestone_suffix: T.nilable(String),
+            number_of_winners: T.nilable(Integer),
+            order: T.nilable(Integer),
+            referral_description: T.nilable(String),
+            referred_reward_upfront: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          is_unlimited:,
+          # Shallow custom metadata object.
+          metadata:,
+          type:,
+          commission_structure: nil,
+          conversions_required: nil,
+          coupon_code: nil,
+          description: nil,
+          image_url: nil,
+          # `-1` represents an unlimited reward in REST responses.
+          limit: nil,
+          limit_duration: nil,
+          next_milestone_prefix: nil,
+          next_milestone_suffix: nil,
+          number_of_winners: nil,
+          order: nil,
+          referral_description: nil,
+          referred_reward_upfront: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              is_unlimited: T::Boolean,
+              metadata: T::Hash[Symbol, T.anything],
+              type: GrowsurfRuby::CampaignAPI::Reward::Type::TaggedSymbol,
+              commission_structure:
+                T.nilable(GrowsurfRuby::CommissionStructure),
+              conversions_required: T.nilable(Integer),
+              coupon_code: T.nilable(String),
+              description: T.nilable(String),
+              image_url: T.nilable(String),
+              limit: T.nilable(Integer),
+              limit_duration:
+                T.nilable(
+                  GrowsurfRuby::CampaignAPI::Reward::LimitDuration::TaggedSymbol
+                ),
+              next_milestone_prefix: T.nilable(String),
+              next_milestone_suffix: T.nilable(String),
+              number_of_winners: T.nilable(Integer),
+              order: T.nilable(Integer),
+              referral_description: T.nilable(String),
+              referred_reward_upfront: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::CampaignAPI::Reward::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SINGLE_SIDED =
+            T.let(
+              :SINGLE_SIDED,
+              GrowsurfRuby::CampaignAPI::Reward::Type::TaggedSymbol
+            )
+          DOUBLE_SIDED =
+            T.let(
+              :DOUBLE_SIDED,
+              GrowsurfRuby::CampaignAPI::Reward::Type::TaggedSymbol
+            )
+          MILESTONE =
+            T.let(
+              :MILESTONE,
+              GrowsurfRuby::CampaignAPI::Reward::Type::TaggedSymbol
+            )
+          LEADERBOARD =
+            T.let(
+              :LEADERBOARD,
+              GrowsurfRuby::CampaignAPI::Reward::Type::TaggedSymbol
+            )
+          AFFILIATE =
+            T.let(
+              :AFFILIATE,
+              GrowsurfRuby::CampaignAPI::Reward::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[GrowsurfRuby::CampaignAPI::Reward::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::CampaignAPI::Reward::LimitDuration)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_TOTAL =
+            T.let(
+              :IN_TOTAL,
+              GrowsurfRuby::CampaignAPI::Reward::LimitDuration::TaggedSymbol
+            )
+          PER_MONTH =
+            T.let(
+              :PER_MONTH,
+              GrowsurfRuby::CampaignAPI::Reward::LimitDuration::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::CampaignAPI::Reward::LimitDuration::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, GrowsurfRuby::CampaignAPI::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT = T.let(:DRAFT, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
+        IN_PROGRESS =
+          T.let(:IN_PROGRESS, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
+        COMPLETE =
+          T.let(:COMPLETE, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
+        DELETED =
+          T.let(:DELETED, GrowsurfRuby::CampaignAPI::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::CampaignAPI::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      module Type
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, GrowsurfRuby::CampaignAPI::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        REFERRAL =
+          T.let(:REFERRAL, GrowsurfRuby::CampaignAPI::Type::TaggedSymbol)
+        AFFILIATE =
+          T.let(:AFFILIATE, GrowsurfRuby::CampaignAPI::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::CampaignAPI::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_commissions_params.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListCommissionsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignListCommissionsParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # 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
+
+      # Participant commission status.
+      sig do
+        returns(
+          T.nilable(
+            GrowsurfRuby::CampaignListCommissionsParams::Status::OrSymbol
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: GrowsurfRuby::CampaignListCommissionsParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          next_id: String,
+          status: GrowsurfRuby::CampaignListCommissionsParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        # Participant commission status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            limit: Integer,
+            next_id: String,
+            status:
+              GrowsurfRuby::CampaignListCommissionsParams::Status::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Participant commission status.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::CampaignListCommissionsParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PENDING =
+          T.let(
+            :PENDING,
+            GrowsurfRuby::CampaignListCommissionsParams::Status::TaggedSymbol
+          )
+        APPROVED =
+          T.let(
+            :APPROVED,
+            GrowsurfRuby::CampaignListCommissionsParams::Status::TaggedSymbol
+          )
+        PAID =
+          T.let(
+            :PAID,
+            GrowsurfRuby::CampaignListCommissionsParams::Status::TaggedSymbol
+          )
+        REVERSED =
+          T.let(
+            :REVERSED,
+            GrowsurfRuby::CampaignListCommissionsParams::Status::TaggedSymbol
+          )
+        DELETED =
+          T.let(
+            :DELETED,
+            GrowsurfRuby::CampaignListCommissionsParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignListCommissionsParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_leaderboard_params.rbi

@@ -0,0 +1,171 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListLeaderboardParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignListLeaderboardParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Deprecated. Use `leaderboardType=CURRENT_MONTH` instead.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_monthly
+
+      sig { params(is_monthly: T::Boolean).void }
+      attr_writer :is_monthly
+
+      # Leaderboard ordering mode.
+      sig do
+        returns(
+          T.nilable(
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::OrSymbol
+          )
+        )
+      end
+      attr_reader :leaderboard_type
+
+      sig do
+        params(
+          leaderboard_type:
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::OrSymbol
+        ).void
+      end
+      attr_writer :leaderboard_type
+
+      # 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,
+          is_monthly: T::Boolean,
+          leaderboard_type:
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::OrSymbol,
+          limit: Integer,
+          next_id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Deprecated. Use `leaderboardType=CURRENT_MONTH` instead.
+        is_monthly: nil,
+        # Leaderboard ordering mode.
+        leaderboard_type: nil,
+        # 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,
+            is_monthly: T::Boolean,
+            leaderboard_type:
+              GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::OrSymbol,
+            limit: Integer,
+            next_id: String,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Leaderboard ordering mode.
+      module LeaderboardType
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ALL_TIME =
+          T.let(
+            :ALL_TIME,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+        CURRENT_MONTH =
+          T.let(
+            :CURRENT_MONTH,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+        PREV_MONTH =
+          T.let(
+            :PREV_MONTH,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+        TOTAL_IMPRESSION_COUNT =
+          T.let(
+            :TOTAL_IMPRESSION_COUNT,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+        UNIQUE_IMPRESSION_COUNT =
+          T.let(
+            :UNIQUE_IMPRESSION_COUNT,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+        BY_COMMISSIONS =
+          T.let(
+            :BY_COMMISSIONS,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+        BY_REVENUE =
+          T.let(
+            :BY_REVENUE,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+        BY_REFERRALS =
+          T.let(
+            :BY_REFERRALS,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+        BY_LEADS =
+          T.let(
+            :BY_LEADS,
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignListParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: GrowsurfRuby::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end