growsurf-ruby 1.3.0 → 1.5.0

data/rbi/growsurf_ruby/models/campaign/program_resource_create_params.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceCreateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(ProgramResourceCreateParams, GrowsurfRuby::Internal::AnyHash)
+          end
+
+        sig { returns(Type::TaggedSymbol) }
+        attr_accessor :type
+
+        sig { returns(String) }
+        attr_accessor :title
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :category
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_published
+
+        sig { params(is_published: T::Boolean).void }
+        attr_writer :is_published
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :text
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :upload_ticket
+
+        sig { returns(T.nilable(GrowsurfRuby::Campaign::ProgramResourceUploadResult)) }
+        attr_reader :upload_result
+
+        sig { params(upload_result: GrowsurfRuby::Campaign::ProgramResourceUploadResult::OrHash).void }
+        attr_writer :upload_result
+
+        sig do
+          params(
+            type: Type::OrSymbol,
+            title: String,
+            description: T.nilable(String),
+            category: T.nilable(String),
+            is_published: T::Boolean,
+            url: String,
+            text: String,
+            upload_ticket: String,
+            upload_result: GrowsurfRuby::Campaign::ProgramResourceUploadResult::OrHash,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          type:,
+          title:,
+          description: nil,
+          category: nil,
+          is_published: nil,
+          url: nil,
+          text: nil,
+          upload_ticket: nil,
+          upload_result: nil,
+          request_options: {}
+        )
+        end
+
+        sig { override.returns(T::Hash[Symbol, T.anything]) }
+        def to_hash
+        end
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          FILE = T.let(:FILE, TaggedSymbol)
+          LINK = T.let(:LINK, TaggedSymbol)
+          TEXT = T.let(:TEXT, TaggedSymbol)
+          sig { override.returns(T::Array[TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/program_resource_delete_params.rbi

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

data/rbi/growsurf_ruby/models/campaign/program_resource_list_response.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceListResponse < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ProgramResourceListResponse, GrowsurfRuby::Internal::AnyHash)
+          end
+
+        sig { returns(T::Array[ProgramResource]) }
+        attr_accessor :resources
+
+        sig do
+          params(resources: T::Array[ProgramResource::OrHash]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(resources:)
+        end
+
+        sig { override.returns({ resources: T::Array[ProgramResource] }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/program_resource_update_params.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(ProgramResourceUpdateParams, GrowsurfRuby::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T.nilable(Type::TaggedSymbol)) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :title
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :category
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_published
+
+        sig { params(is_published: T::Boolean).void }
+        attr_writer :is_published
+
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :position
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :text
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :upload_ticket
+
+        sig { returns(T.nilable(GrowsurfRuby::Campaign::ProgramResourceUploadResult)) }
+        attr_reader :upload_result
+
+        sig { params(upload_result: GrowsurfRuby::Campaign::ProgramResourceUploadResult::OrHash).void }
+        attr_writer :upload_result
+
+        sig do
+          params(
+            id: String,
+            type: Type::OrSymbol,
+            title: String,
+            description: T.nilable(String),
+            category: T.nilable(String),
+            is_published: T::Boolean,
+            position: Integer,
+            url: String,
+            text: String,
+            upload_ticket: String,
+            upload_result: GrowsurfRuby::Campaign::ProgramResourceUploadResult::OrHash,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          type: nil,
+          title: nil,
+          description: nil,
+          category: nil,
+          is_published: nil,
+          position: nil,
+          url: nil,
+          text: nil,
+          upload_ticket: nil,
+          upload_result: nil,
+          request_options: {}
+        )
+        end
+
+        sig { override.returns(T::Hash[Symbol, T.anything]) }
+        def to_hash
+        end
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          FILE = T.let(:FILE, TaggedSymbol)
+          LINK = T.let(:LINK, TaggedSymbol)
+          TEXT = T.let(:TEXT, TaggedSymbol)
+          sig { override.returns(T::Array[TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/program_resource_upload_result.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ProgramResourceUploadResult < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ProgramResourceUploadResult, GrowsurfRuby::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :asset_id
+
+        sig { returns(String) }
+        attr_accessor :public_id
+
+        sig { returns(Integer) }
+        attr_accessor :version
+
+        sig { returns(String) }
+        attr_accessor :signature
+
+        sig { returns(ResourceType::TaggedSymbol) }
+        attr_accessor :resource_type
+
+        sig { returns(Type::TaggedSymbol) }
+        attr_accessor :type
+
+        sig { returns(Integer) }
+        attr_accessor :bytes
+
+        sig { returns(String) }
+        attr_accessor :secure_url
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :format
+
+        sig do
+          params(
+            public_id: String,
+            version: Integer,
+            signature: String,
+            resource_type: ResourceType::OrSymbol,
+            type: Type::OrSymbol,
+            bytes: Integer,
+            secure_url: String,
+            asset_id: String,
+            format: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          public_id:,
+          version:,
+          signature:,
+          resource_type:,
+          type:,
+          bytes:,
+          secure_url:,
+          asset_id: nil,
+          format: nil
+        )
+        end
+
+        sig { override.returns(T::Hash[Symbol, T.anything]) }
+        def to_hash
+        end
+
+        module ResourceType
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, ResourceType) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          IMAGE = T.let(:image, TaggedSymbol)
+          RAW = T.let(:raw, TaggedSymbol)
+          sig { override.returns(T::Array[TaggedSymbol]) }
+          def self.values
+          end
+        end
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+          AUTHENTICATED = T.let(:authenticated, TaggedSymbol)
+          sig { override.returns(T::Array[TaggedSymbol]) }
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/program_resource_upload_ticket.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      ProgramResourceUploadParameter = T.type_alias { T.any(String, Integer, Float, T::Boolean) }
+
+      class ProgramResourceUploadTicket < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(ProgramResourceUploadTicket, GrowsurfRuby::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :ticket
+
+        sig { returns(Integer) }
+        attr_accessor :expires_in
+
+        sig { returns(String) }
+        attr_accessor :upload_url
+
+        sig { returns(T::Hash[Symbol, ProgramResourceUploadParameter]) }
+        attr_accessor :upload_parameters
+
+        sig do
+          params(
+            ticket: String,
+            expires_in: Integer,
+            upload_url: String,
+            upload_parameters: T::Hash[Symbol, ProgramResourceUploadParameter]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          ticket:,
+          expires_in:,
+          upload_url:,
+          upload_parameters:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              ticket: String,
+              expires_in: Integer,
+              upload_url: String,
+              upload_parameters: T::Hash[Symbol, ProgramResourceUploadParameter]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign/program_resource_upload_ticket_params.rbi

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

data/rbi/growsurf_ruby/models/campaign/reward.rbi

@@ -50,6 +50,18 @@ module GrowsurfRuby
         sig { returns(T.nilable(String)) }
         attr_accessor :description
 
+        # The referral event that earns this Campaign Reward. Present only for
+        # `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+        # Rewards return `CONVERSION`.
+        sig do
+          returns(
+            T.nilable(
+              GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :event
+
         sig { returns(T.nilable(String)) }
         attr_accessor :image_url
 
@@ -144,6 +156,10 @@ module GrowsurfRuby
             conversions_required: T.nilable(Integer),
             coupon_code: T.nilable(String),
             description: T.nilable(String),
+            event:
+              T.nilable(
+                GrowsurfRuby::Models::Campaign::Reward::Event::OrSymbol
+              ),
             image_url: T.nilable(String),
             is_visible: T::Boolean,
             limit: T.nilable(Integer),
@@ -176,6 +192,10 @@ module GrowsurfRuby
           # issued coupon when one exists.
           coupon_code: nil,
           description: nil,
+          # The referral event that earns this Campaign Reward. Present only for
+          # `SINGLE_SIDED`, `DOUBLE_SIDED`, and `MILESTONE` rewards. Legacy Campaign
+          # Rewards return `CONVERSION`.
+          event: nil,
           image_url: nil,
           # Whether the reward is enabled. When `false` the reward is disabled: hidden from
           # participants and no longer awarded, including those who already earned it.
@@ -220,6 +240,10 @@ module GrowsurfRuby
               conversions_required: T.nilable(Integer),
               coupon_code: T.nilable(String),
               description: T.nilable(String),
+              event:
+                T.nilable(
+                  GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+                ),
               image_url: T.nilable(String),
               is_visible: T::Boolean,
               limit: T.nilable(Integer),
@@ -289,6 +313,37 @@ module GrowsurfRuby
           end
         end
 
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, GrowsurfRuby::Models::Campaign::Reward::Event)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LEAD =
+            T.let(
+              :LEAD,
+              GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+            )
+          CONVERSION =
+            T.let(
+              :CONVERSION,
+              GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         module LimitDuration
           extend GrowsurfRuby::Internal::Type::Enum