increase 1.284.1 → 1.287.0

data/rbi/increase/models/entity_onboarding_session.rbi

@@ -0,0 +1,190 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSession < Increase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Increase::EntityOnboardingSession, Increase::Internal::AnyHash)
+        end
+
+      # The Entity Onboarding Session's identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      # the Entity Onboarding Session was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The identifier of the Entity associated with this session, if one has been
+      # created or was provided when creating the session.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :entity_id
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      # the Entity Onboarding Session will expire.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # The idempotency key you chose for this object. This value is unique across
+      # Increase and is used to ensure that a request is only processed once. Learn more
+      # about [idempotency](https://increase.com/documentation/idempotency-keys).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :idempotency_key
+
+      # The identifier of the Program the Entity will be onboarded to.
+      sig { returns(String) }
+      attr_accessor :program_id
+
+      # The URL to redirect to after the onboarding session is complete. Increase will
+      # include the query parameters `entity_onboarding_session_id` and `entity_id` when
+      # redirecting.
+      sig { returns(String) }
+      attr_accessor :redirect_url
+
+      # The URL containing the onboarding form. You should share this link with your
+      # customer. Only present when the session is active.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :session_url
+
+      # The status of the onboarding session.
+      sig { returns(Increase::EntityOnboardingSession::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # A constant representing the object's type. For this resource it will always be
+      # `entity_onboarding_session`.
+      sig { returns(Increase::EntityOnboardingSession::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Entity Onboarding Sessions let your customers onboard themselves by completing
+      # Increase-hosted forms. Create a session and redirect your customer to the
+      # returned URL. When they're done, they'll be redirected back to your site. This
+      # API is used for [hosted onboarding](/documentation/hosted-onboarding).
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          entity_id: T.nilable(String),
+          expires_at: Time,
+          idempotency_key: T.nilable(String),
+          program_id: String,
+          redirect_url: String,
+          session_url: T.nilable(String),
+          status: Increase::EntityOnboardingSession::Status::OrSymbol,
+          type: Increase::EntityOnboardingSession::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Entity Onboarding Session's identifier.
+        id:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the Entity Onboarding Session was created.
+        created_at:,
+        # The identifier of the Entity associated with this session, if one has been
+        # created or was provided when creating the session.
+        entity_id:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the Entity Onboarding Session will expire.
+        expires_at:,
+        # The idempotency key you chose for this object. This value is unique across
+        # Increase and is used to ensure that a request is only processed once. Learn more
+        # about [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key:,
+        # The identifier of the Program the Entity will be onboarded to.
+        program_id:,
+        # The URL to redirect to after the onboarding session is complete. Increase will
+        # include the query parameters `entity_onboarding_session_id` and `entity_id` when
+        # redirecting.
+        redirect_url:,
+        # The URL containing the onboarding form. You should share this link with your
+        # customer. Only present when the session is active.
+        session_url:,
+        # The status of the onboarding session.
+        status:,
+        # A constant representing the object's type. For this resource it will always be
+        # `entity_onboarding_session`.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            entity_id: T.nilable(String),
+            expires_at: Time,
+            idempotency_key: T.nilable(String),
+            program_id: String,
+            redirect_url: String,
+            session_url: T.nilable(String),
+            status: Increase::EntityOnboardingSession::Status::TaggedSymbol,
+            type: Increase::EntityOnboardingSession::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the onboarding session.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Increase::EntityOnboardingSession::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # The Entity Onboarding Session is active.
+        ACTIVE =
+          T.let(
+            :active,
+            Increase::EntityOnboardingSession::Status::TaggedSymbol
+          )
+
+        # The Entity Onboarding Session has expired.
+        EXPIRED =
+          T.let(
+            :expired,
+            Increase::EntityOnboardingSession::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Increase::EntityOnboardingSession::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `entity_onboarding_session`.
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Increase::EntityOnboardingSession::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ENTITY_ONBOARDING_SESSION =
+          T.let(
+            :entity_onboarding_session,
+            Increase::EntityOnboardingSession::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Increase::EntityOnboardingSession::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/entity_onboarding_session_create_params.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSessionCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::EntityOnboardingSessionCreateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Program the Entity will be onboarded to.
+      sig { returns(String) }
+      attr_accessor :program_id
+
+      # The URL to redirect the customer to after they complete the onboarding form. The
+      # redirect will include `entity_onboarding_session_id` and `entity_id` query
+      # parameters.
+      sig { returns(String) }
+      attr_accessor :redirect_url
+
+      # The identifier of an existing Entity to associate with the onboarding session.
+      # If provided, the onboarding form will display any outstanding tasks required to
+      # complete the Entity's onboarding.
+      sig { returns(T.nilable(String)) }
+      attr_reader :entity_id
+
+      sig { params(entity_id: String).void }
+      attr_writer :entity_id
+
+      sig do
+        params(
+          program_id: String,
+          redirect_url: String,
+          entity_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Program the Entity will be onboarded to.
+        program_id:,
+        # The URL to redirect the customer to after they complete the onboarding form. The
+        # redirect will include `entity_onboarding_session_id` and `entity_id` query
+        # parameters.
+        redirect_url:,
+        # The identifier of an existing Entity to associate with the onboarding session.
+        # If provided, the onboarding form will display any outstanding tasks required to
+        # complete the Entity's onboarding.
+        entity_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            program_id: String,
+            redirect_url: String,
+            entity_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/entity_onboarding_session_expire_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSessionExpireParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::EntityOnboardingSessionExpireParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Entity Onboarding Session to expire.
+      sig { returns(String) }
+      attr_accessor :entity_onboarding_session_id
+
+      sig do
+        params(
+          entity_onboarding_session_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Entity Onboarding Session to expire.
+        entity_onboarding_session_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            entity_onboarding_session_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/entity_onboarding_session_list_params.rbi

@@ -0,0 +1,194 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSessionListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::EntityOnboardingSessionListParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # Return the page of entries after this one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # Filter records to the one with the specified `idempotency_key` you chose for
+      # that object. This value is unique across Increase and is used to ensure that a
+      # request is only processed once. Learn more about
+      # [idempotency](https://increase.com/documentation/idempotency-keys).
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        returns(T.nilable(Increase::EntityOnboardingSessionListParams::Status))
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: Increase::EntityOnboardingSessionListParams::Status::OrHash
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::EntityOnboardingSessionListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter records to the one with the specified `idempotency_key` you chose for
+        # that object. This value is unique across Increase and is used to ensure that a
+        # request is only processed once. Learn more about
+        # [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            idempotency_key: String,
+            limit: Integer,
+            status: Increase::EntityOnboardingSessionListParams::Status,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::EntityOnboardingSessionListParams::Status,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter Entity Onboarding Session for those with the specified status or
+        # statuses. For GET requests, this should be encoded as a comma-delimited string,
+        # such as `?in=one,two,three`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Increase::EntityOnboardingSessionListParams::Status::In::OrSymbol
+              ]
+            )
+          )
+        end
+        attr_reader :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::EntityOnboardingSessionListParams::Status::In::OrSymbol
+              ]
+          ).void
+        end
+        attr_writer :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::EntityOnboardingSessionListParams::Status::In::OrSymbol
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter Entity Onboarding Session for those with the specified status or
+          # statuses. For GET requests, this should be encoded as a comma-delimited string,
+          # such as `?in=one,two,three`.
+          in_: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              in_:
+                T::Array[
+                  Increase::EntityOnboardingSessionListParams::Status::In::OrSymbol
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::EntityOnboardingSessionListParams::Status::In
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The Entity Onboarding Session is active.
+          ACTIVE =
+            T.let(
+              :active,
+              Increase::EntityOnboardingSessionListParams::Status::In::TaggedSymbol
+            )
+
+          # The Entity Onboarding Session has expired.
+          EXPIRED =
+            T.let(
+              :expired,
+              Increase::EntityOnboardingSessionListParams::Status::In::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::EntityOnboardingSessionListParams::Status::In::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/entity_onboarding_session_retrieve_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Increase
+  module Models
+    class EntityOnboardingSessionRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::EntityOnboardingSessionRetrieveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Entity Onboarding Session.
+      sig { returns(String) }
+      attr_accessor :entity_onboarding_session_id
+
+      sig do
+        params(
+          entity_onboarding_session_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Entity Onboarding Session.
+        entity_onboarding_session_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            entity_onboarding_session_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end