growsurf-ruby 0.0.2

data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi

@@ -0,0 +1,178 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::ParticipantUpdateParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :participant_id_or_email
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :email
+
+        sig { params(email: String).void }
+        attr_writer :email
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :first_name
+
+        sig { params(first_name: String).void }
+        attr_writer :first_name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :last_name
+
+        sig { params(last_name: String).void }
+        attr_writer :last_name
+
+        # Shallow custom metadata object.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :metadata
+
+        sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+        attr_writer :metadata
+
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol
+            )
+          )
+        end
+        attr_reader :referral_status
+
+        sig do
+          params(
+            referral_status:
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol
+          ).void
+        end
+        attr_writer :referral_status
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :referred_by
+
+        sig { params(referred_by: String).void }
+        attr_writer :referred_by
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :unsubscribed
+
+        sig { params(unsubscribed: T::Boolean).void }
+        attr_writer :unsubscribed
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :vanity_keys
+
+        sig { params(vanity_keys: T::Array[String]).void }
+        attr_writer :vanity_keys
+
+        sig do
+          params(
+            id: String,
+            participant_id_or_email: String,
+            email: String,
+            first_name: String,
+            last_name: String,
+            metadata: T::Hash[Symbol, T.anything],
+            referral_status:
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol,
+            referred_by: String,
+            unsubscribed: T::Boolean,
+            vanity_keys: T::Array[String],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          participant_id_or_email:,
+          email: nil,
+          first_name: nil,
+          last_name: nil,
+          # Shallow custom metadata object.
+          metadata: nil,
+          referral_status: nil,
+          referred_by: nil,
+          unsubscribed: nil,
+          vanity_keys: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              participant_id_or_email: String,
+              email: String,
+              first_name: String,
+              last_name: String,
+              metadata: T::Hash[Symbol, T.anything],
+              referral_status:
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol,
+              referred_by: String,
+              unsubscribed: T::Boolean,
+              vanity_keys: T::Array[String],
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module ReferralStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREDIT_PENDING =
+            T.let(
+              :CREDIT_PENDING,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::TaggedSymbol
+            )
+          CREDIT_AWARDED =
+            T.let(
+              :CREDIT_AWARDED,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::TaggedSymbol
+            )
+          CREDIT_EXPIRED =
+            T.let(
+              :CREDIT_EXPIRED,
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/referral_source.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      module ReferralSource
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, GrowsurfRuby::Campaign::ReferralSource) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DIRECT =
+          T.let(:DIRECT, GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol)
+        PARTICIPANT =
+          T.let(
+            :PARTICIPANT,
+            GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::Campaign::ReferralSource::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/referral_status.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      module ReferralStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, GrowsurfRuby::Campaign::ReferralStatus) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREDIT_PENDING =
+          T.let(
+            :CREDIT_PENDING,
+            GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol
+          )
+        CREDIT_AWARDED =
+          T.let(
+            :CREDIT_AWARDED,
+            GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol
+          )
+        CREDIT_EXPIRED =
+          T.let(
+            :CREDIT_EXPIRED,
+            GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol
+          )
+        INVITE_SENT =
+          T.let(
+            :INVITE_SENT,
+            GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[GrowsurfRuby::Campaign::ReferralStatus::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/reward_approve_params.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class RewardApproveParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Campaign::RewardApproveParams,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(String) }
+        attr_accessor :reward_id
+
+        # Set true to mark the reward as fulfilled after approval.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :fulfill
+
+        sig { params(fulfill: T::Boolean).void }
+        attr_writer :fulfill
+
+        sig do
+          params(
+            id: String,
+            reward_id: String,
+            fulfill: T::Boolean,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          reward_id:,
+          # Set true to mark the reward as fulfilled after approval.
+          fulfill: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              reward_id: String,
+              fulfill: T::Boolean,
+              request_options: GrowsurfRuby::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/reward_approve_response.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class RewardApproveResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::RewardApproveResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig { params(success: T::Boolean).returns(T.attached_class) }
+        def self.new(success:)
+        end
+
+        sig { override.returns({ success: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/reward_delete_params.rbi

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

data/rbi/growsurf_ruby/models/campaign/reward_delete_response.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class RewardDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::RewardDeleteResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig { params(success: T::Boolean).returns(T.attached_class) }
+        def self.new(success:)
+        end
+
+        sig { override.returns({ success: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/reward_fulfill_params.rbi

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

data/rbi/growsurf_ruby/models/campaign/reward_fulfill_response.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class RewardFulfillResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::Campaign::RewardFulfillResponse,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Boolean) }
+        attr_accessor :success
+
+        sig { params(success: T::Boolean).returns(T.attached_class) }
+        def self.new(success:)
+        end
+
+        sig { override.returns({ success: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end