growsurf-ruby 0.0.2

data/sig/growsurf_ruby/models/campaign/participant.rbs

@@ -0,0 +1,455 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type campaign_participant =
+        {
+          id: String,
+          email: String,
+          monthly_rank: Integer,
+          monthly_referral_count: Integer,
+          rank: Integer,
+          referral_count: Integer,
+          rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward],
+          share_url: String,
+          all_matching_fraudsters: ::Array[::Hash[Symbol, top]],
+          created_at: Integer,
+          fingerprint: String?,
+          first_name: String?,
+          fraud_reason_code: String,
+          fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
+          impression_count: Integer,
+          invite_count: Integer,
+          ip_address: String?,
+          is_new: bool,
+          is_winner: bool,
+          last_name: String?,
+          metadata: ::Hash[Symbol, top],
+          monthly_referrals: ::Array[String],
+          notes: String?,
+          paypal_email_address: String,
+          prev_monthly_rank: Integer,
+          prev_monthly_referral_count: Integer,
+          referrals: ::Array[String],
+          referral_source: GrowsurfRuby::Models::Campaign::referral_source,
+          referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+          referred_by: String,
+          referrer: GrowsurfRuby::Campaign::CampaignParticipant::Referrer?,
+          share_count: ::Hash[Symbol, Integer],
+          unique_impression_count: Integer,
+          unread_commissions_count: Integer,
+          unread_payouts_count: Integer,
+          unsubscribed: bool,
+          vanity_keys: ::Array[String]
+        }
+
+      class CampaignParticipant < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor email: String
+
+        attr_accessor monthly_rank: Integer
+
+        attr_accessor monthly_referral_count: Integer
+
+        attr_accessor rank: Integer
+
+        attr_accessor referral_count: Integer
+
+        attr_accessor rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward]
+
+        attr_accessor share_url: String
+
+        attr_reader all_matching_fraudsters: ::Array[::Hash[Symbol, top]]?
+
+        def all_matching_fraudsters=: (
+          ::Array[::Hash[Symbol, top]]
+        ) -> ::Array[::Hash[Symbol, top]]
+
+        attr_reader created_at: Integer?
+
+        def created_at=: (Integer) -> Integer
+
+        attr_accessor fingerprint: String?
+
+        attr_accessor first_name: String?
+
+        attr_reader fraud_reason_code: String?
+
+        def fraud_reason_code=: (String) -> String
+
+        attr_reader fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level?
+
+        def fraud_risk_level=: (
+          GrowsurfRuby::Models::Campaign::fraud_risk_level
+        ) -> GrowsurfRuby::Models::Campaign::fraud_risk_level
+
+        attr_reader impression_count: Integer?
+
+        def impression_count=: (Integer) -> Integer
+
+        attr_reader invite_count: Integer?
+
+        def invite_count=: (Integer) -> Integer
+
+        attr_accessor ip_address: String?
+
+        attr_reader is_new: bool?
+
+        def is_new=: (bool) -> bool
+
+        attr_reader is_winner: bool?
+
+        def is_winner=: (bool) -> bool
+
+        attr_accessor last_name: String?
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader monthly_referrals: ::Array[String]?
+
+        def monthly_referrals=: (::Array[String]) -> ::Array[String]
+
+        attr_accessor notes: String?
+
+        attr_reader paypal_email_address: String?
+
+        def paypal_email_address=: (String) -> String
+
+        attr_reader prev_monthly_rank: Integer?
+
+        def prev_monthly_rank=: (Integer) -> Integer
+
+        attr_reader prev_monthly_referral_count: Integer?
+
+        def prev_monthly_referral_count=: (Integer) -> Integer
+
+        attr_reader referrals: ::Array[String]?
+
+        def referrals=: (::Array[String]) -> ::Array[String]
+
+        attr_reader referral_source: GrowsurfRuby::Models::Campaign::referral_source?
+
+        def referral_source=: (
+          GrowsurfRuby::Models::Campaign::referral_source
+        ) -> GrowsurfRuby::Models::Campaign::referral_source
+
+        attr_reader referral_status: GrowsurfRuby::Models::Campaign::referral_status?
+
+        def referral_status=: (
+          GrowsurfRuby::Models::Campaign::referral_status
+        ) -> GrowsurfRuby::Models::Campaign::referral_status
+
+        attr_reader referred_by: String?
+
+        def referred_by=: (String) -> String
+
+        attr_accessor referrer: GrowsurfRuby::Campaign::CampaignParticipant::Referrer?
+
+        attr_reader share_count: ::Hash[Symbol, Integer]?
+
+        def share_count=: (::Hash[Symbol, Integer]) -> ::Hash[Symbol, Integer]
+
+        attr_reader unique_impression_count: Integer?
+
+        def unique_impression_count=: (Integer) -> Integer
+
+        attr_reader unread_commissions_count: Integer?
+
+        def unread_commissions_count=: (Integer) -> Integer
+
+        attr_reader unread_payouts_count: Integer?
+
+        def unread_payouts_count=: (Integer) -> Integer
+
+        attr_reader unsubscribed: bool?
+
+        def unsubscribed=: (bool) -> bool
+
+        attr_reader vanity_keys: ::Array[String]?
+
+        def vanity_keys=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          id: String,
+          email: String,
+          monthly_rank: Integer,
+          monthly_referral_count: Integer,
+          rank: Integer,
+          referral_count: Integer,
+          rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward],
+          share_url: String,
+          ?all_matching_fraudsters: ::Array[::Hash[Symbol, top]],
+          ?created_at: Integer,
+          ?fingerprint: String?,
+          ?first_name: String?,
+          ?fraud_reason_code: String,
+          ?fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
+          ?impression_count: Integer,
+          ?invite_count: Integer,
+          ?ip_address: String?,
+          ?is_new: bool,
+          ?is_winner: bool,
+          ?last_name: String?,
+          ?metadata: ::Hash[Symbol, top],
+          ?monthly_referrals: ::Array[String],
+          ?notes: String?,
+          ?paypal_email_address: String,
+          ?prev_monthly_rank: Integer,
+          ?prev_monthly_referral_count: Integer,
+          ?referrals: ::Array[String],
+          ?referral_source: GrowsurfRuby::Models::Campaign::referral_source,
+          ?referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+          ?referred_by: String,
+          ?referrer: GrowsurfRuby::Campaign::CampaignParticipant::Referrer?,
+          ?share_count: ::Hash[Symbol, Integer],
+          ?unique_impression_count: Integer,
+          ?unread_commissions_count: Integer,
+          ?unread_payouts_count: Integer,
+          ?unsubscribed: bool,
+          ?vanity_keys: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          email: String,
+          monthly_rank: Integer,
+          monthly_referral_count: Integer,
+          rank: Integer,
+          referral_count: Integer,
+          rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward],
+          share_url: String,
+          all_matching_fraudsters: ::Array[::Hash[Symbol, top]],
+          created_at: Integer,
+          fingerprint: String?,
+          first_name: String?,
+          fraud_reason_code: String,
+          fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
+          impression_count: Integer,
+          invite_count: Integer,
+          ip_address: String?,
+          is_new: bool,
+          is_winner: bool,
+          last_name: String?,
+          metadata: ::Hash[Symbol, top],
+          monthly_referrals: ::Array[String],
+          notes: String?,
+          paypal_email_address: String,
+          prev_monthly_rank: Integer,
+          prev_monthly_referral_count: Integer,
+          referrals: ::Array[String],
+          referral_source: GrowsurfRuby::Models::Campaign::referral_source,
+          referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+          referred_by: String,
+          referrer: GrowsurfRuby::Campaign::CampaignParticipant::Referrer?,
+          share_count: ::Hash[Symbol, Integer],
+          unique_impression_count: Integer,
+          unread_commissions_count: Integer,
+          unread_payouts_count: Integer,
+          unsubscribed: bool,
+          vanity_keys: ::Array[String]
+        }
+
+        type referrer =
+          {
+            id: String,
+            created_at: Integer,
+            email: String,
+            fingerprint: String?,
+            first_name: String?,
+            fraud_reason_code: String,
+            fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
+            impression_count: Integer,
+            invite_count: Integer,
+            ip_address: String?,
+            is_winner: bool,
+            last_name: String?,
+            metadata: ::Hash[Symbol, top],
+            monthly_rank: Integer,
+            monthly_referral_count: Integer,
+            monthly_referrals: ::Array[String],
+            prev_monthly_rank: Integer,
+            prev_monthly_referral_count: Integer,
+            rank: Integer,
+            referral_count: Integer,
+            referrals: ::Array[String],
+            referral_source: GrowsurfRuby::Models::Campaign::referral_source,
+            referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+            share_count: ::Hash[Symbol, Integer],
+            share_url: String,
+            unique_impression_count: Integer,
+            unsubscribed: bool
+          }
+
+        class Referrer < GrowsurfRuby::Internal::Type::BaseModel
+          attr_reader id: String?
+
+          def id=: (String) -> String
+
+          attr_reader created_at: Integer?
+
+          def created_at=: (Integer) -> Integer
+
+          attr_reader email: String?
+
+          def email=: (String) -> String
+
+          attr_accessor fingerprint: String?
+
+          attr_accessor first_name: String?
+
+          attr_reader fraud_reason_code: String?
+
+          def fraud_reason_code=: (String) -> String
+
+          attr_reader fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level?
+
+          def fraud_risk_level=: (
+            GrowsurfRuby::Models::Campaign::fraud_risk_level
+          ) -> GrowsurfRuby::Models::Campaign::fraud_risk_level
+
+          attr_reader impression_count: Integer?
+
+          def impression_count=: (Integer) -> Integer
+
+          attr_reader invite_count: Integer?
+
+          def invite_count=: (Integer) -> Integer
+
+          attr_accessor ip_address: String?
+
+          attr_reader is_winner: bool?
+
+          def is_winner=: (bool) -> bool
+
+          attr_accessor last_name: String?
+
+          attr_reader metadata: ::Hash[Symbol, top]?
+
+          def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+          attr_reader monthly_rank: Integer?
+
+          def monthly_rank=: (Integer) -> Integer
+
+          attr_reader monthly_referral_count: Integer?
+
+          def monthly_referral_count=: (Integer) -> Integer
+
+          attr_reader monthly_referrals: ::Array[String]?
+
+          def monthly_referrals=: (::Array[String]) -> ::Array[String]
+
+          attr_reader prev_monthly_rank: Integer?
+
+          def prev_monthly_rank=: (Integer) -> Integer
+
+          attr_reader prev_monthly_referral_count: Integer?
+
+          def prev_monthly_referral_count=: (Integer) -> Integer
+
+          attr_reader rank: Integer?
+
+          def rank=: (Integer) -> Integer
+
+          attr_reader referral_count: Integer?
+
+          def referral_count=: (Integer) -> Integer
+
+          attr_reader referrals: ::Array[String]?
+
+          def referrals=: (::Array[String]) -> ::Array[String]
+
+          attr_reader referral_source: GrowsurfRuby::Models::Campaign::referral_source?
+
+          def referral_source=: (
+            GrowsurfRuby::Models::Campaign::referral_source
+          ) -> GrowsurfRuby::Models::Campaign::referral_source
+
+          attr_reader referral_status: GrowsurfRuby::Models::Campaign::referral_status?
+
+          def referral_status=: (
+            GrowsurfRuby::Models::Campaign::referral_status
+          ) -> GrowsurfRuby::Models::Campaign::referral_status
+
+          attr_reader share_count: ::Hash[Symbol, Integer]?
+
+          def share_count=: (::Hash[Symbol, Integer]) -> ::Hash[Symbol, Integer]
+
+          attr_reader share_url: String?
+
+          def share_url=: (String) -> String
+
+          attr_reader unique_impression_count: Integer?
+
+          def unique_impression_count=: (Integer) -> Integer
+
+          attr_reader unsubscribed: bool?
+
+          def unsubscribed=: (bool) -> bool
+
+          def initialize: (
+            ?id: String,
+            ?created_at: Integer,
+            ?email: String,
+            ?fingerprint: String?,
+            ?first_name: String?,
+            ?fraud_reason_code: String,
+            ?fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
+            ?impression_count: Integer,
+            ?invite_count: Integer,
+            ?ip_address: String?,
+            ?is_winner: bool,
+            ?last_name: String?,
+            ?metadata: ::Hash[Symbol, top],
+            ?monthly_rank: Integer,
+            ?monthly_referral_count: Integer,
+            ?monthly_referrals: ::Array[String],
+            ?prev_monthly_rank: Integer,
+            ?prev_monthly_referral_count: Integer,
+            ?rank: Integer,
+            ?referral_count: Integer,
+            ?referrals: ::Array[String],
+            ?referral_source: GrowsurfRuby::Models::Campaign::referral_source,
+            ?referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+            ?share_count: ::Hash[Symbol, Integer],
+            ?share_url: String,
+            ?unique_impression_count: Integer,
+            ?unsubscribed: bool
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            created_at: Integer,
+            email: String,
+            fingerprint: String?,
+            first_name: String?,
+            fraud_reason_code: String,
+            fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
+            impression_count: Integer,
+            invite_count: Integer,
+            ip_address: String?,
+            is_winner: bool,
+            last_name: String?,
+            metadata: ::Hash[Symbol, top],
+            monthly_rank: Integer,
+            monthly_referral_count: Integer,
+            monthly_referrals: ::Array[String],
+            prev_monthly_rank: Integer,
+            prev_monthly_referral_count: Integer,
+            rank: Integer,
+            referral_count: Integer,
+            referrals: ::Array[String],
+            referral_source: GrowsurfRuby::Models::Campaign::referral_source,
+            referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+            share_count: ::Hash[Symbol, Integer],
+            share_url: String,
+            unique_impression_count: Integer,
+            unsubscribed: bool
+          }
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_add_params.rbs

@@ -0,0 +1,95 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_add_params =
+        {
+          id: String,
+          email: String,
+          fingerprint: String,
+          first_name: String,
+          ip_address: String,
+          last_name: String,
+          metadata: ::Hash[Symbol, top],
+          referral_status: GrowsurfRuby::Models::Campaign::ParticipantAddParams::referral_status,
+          referred_by: String
+        }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantAddParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor email: String
+
+        attr_reader fingerprint: String?
+
+        def fingerprint=: (String) -> String
+
+        attr_reader first_name: String?
+
+        def first_name=: (String) -> String
+
+        attr_reader ip_address: String?
+
+        def ip_address=: (String) -> String
+
+        attr_reader last_name: String?
+
+        def last_name=: (String) -> String
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader referral_status: GrowsurfRuby::Models::Campaign::ParticipantAddParams::referral_status?
+
+        def referral_status=: (
+          GrowsurfRuby::Models::Campaign::ParticipantAddParams::referral_status
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantAddParams::referral_status
+
+        attr_reader referred_by: String?
+
+        def referred_by=: (String) -> String
+
+        def initialize: (
+          id: String,
+          email: String,
+          ?fingerprint: String,
+          ?first_name: String,
+          ?ip_address: String,
+          ?last_name: String,
+          ?metadata: ::Hash[Symbol, top],
+          ?referral_status: GrowsurfRuby::Models::Campaign::ParticipantAddParams::referral_status,
+          ?referred_by: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          email: String,
+          fingerprint: String,
+          first_name: String,
+          ip_address: String,
+          last_name: String,
+          metadata: ::Hash[Symbol, top],
+          referral_status: GrowsurfRuby::Models::Campaign::ParticipantAddParams::referral_status,
+          referred_by: String,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+
+        type referral_status = :CREDIT_PENDING | :CREDIT_AWARDED
+
+        module ReferralStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          CREDIT_PENDING: :CREDIT_PENDING
+          CREDIT_AWARDED: :CREDIT_AWARDED
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantAddParams::referral_status]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_delete_params.rbs

@@ -0,0 +1,30 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_delete_params =
+        { id: String, participant_id_or_email: String }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor participant_id_or_email: String
+
+        def initialize: (
+          id: String,
+          participant_id_or_email: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          participant_id_or_email: String,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_delete_response.rbs

@@ -0,0 +1,15 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_delete_response = { success: bool }
+
+      class ParticipantDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor success: bool
+
+        def initialize: (success: bool) -> void
+
+        def to_hash: -> { success: bool }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_list_commissions_params.rbs

@@ -0,0 +1,70 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_list_commissions_params =
+        {
+          id: String,
+          participant_id_or_email: String,
+          limit: Integer,
+          next_id: String,
+          status: GrowsurfRuby::Models::Campaign::ParticipantListCommissionsParams::status
+        }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantListCommissionsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor participant_id_or_email: String
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        attr_reader next_id: String?
+
+        def next_id=: (String) -> String
+
+        attr_reader status: GrowsurfRuby::Models::Campaign::ParticipantListCommissionsParams::status?
+
+        def status=: (
+          GrowsurfRuby::Models::Campaign::ParticipantListCommissionsParams::status
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantListCommissionsParams::status
+
+        def initialize: (
+          id: String,
+          participant_id_or_email: String,
+          ?limit: Integer,
+          ?next_id: String,
+          ?status: GrowsurfRuby::Models::Campaign::ParticipantListCommissionsParams::status,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          participant_id_or_email: String,
+          limit: Integer,
+          next_id: String,
+          status: GrowsurfRuby::Models::Campaign::ParticipantListCommissionsParams::status,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+
+        type status = :PENDING | :APPROVED | :PAID | :REVERSED | :DELETED
+
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          PENDING: :PENDING
+          APPROVED: :APPROVED
+          PAID: :PAID
+          REVERSED: :REVERSED
+          DELETED: :DELETED
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantListCommissionsParams::status]
+        end
+      end
+    end
+  end
+end