increase 0.3.3 → 1.0.0

data/rbi/increase/models/wire_drawdown_request.rbi

@@ -0,0 +1,324 @@
+# typed: strong
+
+module Increase
+  module Models
+    class WireDrawdownRequest < Increase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Increase::WireDrawdownRequest, Increase::Internal::AnyHash)
+        end
+
+      # The Wire drawdown request identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The Account Number to which the recipient of this request is being requested to
+      # send funds.
+      sig { returns(String) }
+      attr_accessor :account_number_id
+
+      # The amount being requested in cents.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      # the wire drawdown request was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+      # requested. Will always be "USD".
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # If the recipient fulfills the drawdown request by sending funds, then this will
+      # be the identifier of the corresponding Transaction.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :fulfillment_inbound_wire_transfer_id
+
+      # 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 message the recipient will see as part of the drawdown request.
+      sig { returns(String) }
+      attr_accessor :message_to_recipient
+
+      # The originator's address line 1.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :originator_address_line1
+
+      # The originator's address line 2.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :originator_address_line2
+
+      # The originator's address line 3.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :originator_address_line3
+
+      # The originator's name.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :originator_name
+
+      # The drawdown request's recipient's account number.
+      sig { returns(String) }
+      attr_accessor :recipient_account_number
+
+      # Line 1 of the drawdown request's recipient's address.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :recipient_address_line1
+
+      # Line 2 of the drawdown request's recipient's address.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :recipient_address_line2
+
+      # Line 3 of the drawdown request's recipient's address.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :recipient_address_line3
+
+      # The drawdown request's recipient's name.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :recipient_name
+
+      # The drawdown request's recipient's routing number.
+      sig { returns(String) }
+      attr_accessor :recipient_routing_number
+
+      # The lifecycle status of the drawdown request.
+      sig { returns(Increase::WireDrawdownRequest::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # After the drawdown request is submitted to Fedwire, this will contain
+      # supplemental details.
+      sig { returns(T.nilable(Increase::WireDrawdownRequest::Submission)) }
+      attr_reader :submission
+
+      sig do
+        params(
+          submission:
+            T.nilable(Increase::WireDrawdownRequest::Submission::OrHash)
+        ).void
+      end
+      attr_writer :submission
+
+      # A constant representing the object's type. For this resource it will always be
+      # `wire_drawdown_request`.
+      sig { returns(Increase::WireDrawdownRequest::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Wire drawdown requests enable you to request that someone else send you a wire.
+      # Because there is nuance to making sure your counterparty's bank processes these
+      # correctly, we ask that you reach out to
+      # [support@increase.com](mailto:support@increase.com) to enable this feature so we
+      # can help you plan your integration. For more information, see our
+      # [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).
+      sig do
+        params(
+          id: String,
+          account_number_id: String,
+          amount: Integer,
+          created_at: Time,
+          currency: String,
+          fulfillment_inbound_wire_transfer_id: T.nilable(String),
+          idempotency_key: T.nilable(String),
+          message_to_recipient: String,
+          originator_address_line1: T.nilable(String),
+          originator_address_line2: T.nilable(String),
+          originator_address_line3: T.nilable(String),
+          originator_name: T.nilable(String),
+          recipient_account_number: String,
+          recipient_address_line1: T.nilable(String),
+          recipient_address_line2: T.nilable(String),
+          recipient_address_line3: T.nilable(String),
+          recipient_name: T.nilable(String),
+          recipient_routing_number: String,
+          status: Increase::WireDrawdownRequest::Status::OrSymbol,
+          submission:
+            T.nilable(Increase::WireDrawdownRequest::Submission::OrHash),
+          type: Increase::WireDrawdownRequest::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Wire drawdown request identifier.
+        id:,
+        # The Account Number to which the recipient of this request is being requested to
+        # send funds.
+        account_number_id:,
+        # The amount being requested in cents.
+        amount:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the wire drawdown request was created.
+        created_at:,
+        # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+        # requested. Will always be "USD".
+        currency:,
+        # If the recipient fulfills the drawdown request by sending funds, then this will
+        # be the identifier of the corresponding Transaction.
+        fulfillment_inbound_wire_transfer_id:,
+        # 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 message the recipient will see as part of the drawdown request.
+        message_to_recipient:,
+        # The originator's address line 1.
+        originator_address_line1:,
+        # The originator's address line 2.
+        originator_address_line2:,
+        # The originator's address line 3.
+        originator_address_line3:,
+        # The originator's name.
+        originator_name:,
+        # The drawdown request's recipient's account number.
+        recipient_account_number:,
+        # Line 1 of the drawdown request's recipient's address.
+        recipient_address_line1:,
+        # Line 2 of the drawdown request's recipient's address.
+        recipient_address_line2:,
+        # Line 3 of the drawdown request's recipient's address.
+        recipient_address_line3:,
+        # The drawdown request's recipient's name.
+        recipient_name:,
+        # The drawdown request's recipient's routing number.
+        recipient_routing_number:,
+        # The lifecycle status of the drawdown request.
+        status:,
+        # After the drawdown request is submitted to Fedwire, this will contain
+        # supplemental details.
+        submission:,
+        # A constant representing the object's type. For this resource it will always be
+        # `wire_drawdown_request`.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            account_number_id: String,
+            amount: Integer,
+            created_at: Time,
+            currency: String,
+            fulfillment_inbound_wire_transfer_id: T.nilable(String),
+            idempotency_key: T.nilable(String),
+            message_to_recipient: String,
+            originator_address_line1: T.nilable(String),
+            originator_address_line2: T.nilable(String),
+            originator_address_line3: T.nilable(String),
+            originator_name: T.nilable(String),
+            recipient_account_number: String,
+            recipient_address_line1: T.nilable(String),
+            recipient_address_line2: T.nilable(String),
+            recipient_address_line3: T.nilable(String),
+            recipient_name: T.nilable(String),
+            recipient_routing_number: String,
+            status: Increase::WireDrawdownRequest::Status::TaggedSymbol,
+            submission: T.nilable(Increase::WireDrawdownRequest::Submission),
+            type: Increase::WireDrawdownRequest::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The lifecycle status of the drawdown request.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::WireDrawdownRequest::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # The drawdown request is queued to be submitted to Fedwire.
+        PENDING_SUBMISSION =
+          T.let(
+            :pending_submission,
+            Increase::WireDrawdownRequest::Status::TaggedSymbol
+          )
+
+        # The drawdown request has been sent and the recipient should respond in some way.
+        PENDING_RESPONSE =
+          T.let(
+            :pending_response,
+            Increase::WireDrawdownRequest::Status::TaggedSymbol
+          )
+
+        # The drawdown request has been fulfilled by the recipient.
+        FULFILLED =
+          T.let(:fulfilled, Increase::WireDrawdownRequest::Status::TaggedSymbol)
+
+        # The drawdown request has been refused by the recipient.
+        REFUSED =
+          T.let(:refused, Increase::WireDrawdownRequest::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::WireDrawdownRequest::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Submission < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::WireDrawdownRequest::Submission,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The input message accountability data (IMAD) uniquely identifying the submission
+        # with Fedwire.
+        sig { returns(String) }
+        attr_accessor :input_message_accountability_data
+
+        # After the drawdown request is submitted to Fedwire, this will contain
+        # supplemental details.
+        sig do
+          params(input_message_accountability_data: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The input message accountability data (IMAD) uniquely identifying the submission
+          # with Fedwire.
+          input_message_accountability_data:
+        )
+        end
+
+        sig { override.returns({ input_message_accountability_data: String }) }
+        def to_hash
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `wire_drawdown_request`.
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::WireDrawdownRequest::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WIRE_DRAWDOWN_REQUEST =
+          T.let(
+            :wire_drawdown_request,
+            Increase::WireDrawdownRequest::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Increase::WireDrawdownRequest::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/wire_drawdown_request_create_params.rbi

@@ -0,0 +1,179 @@
+# typed: strong
+
+module Increase
+  module Models
+    class WireDrawdownRequestCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::WireDrawdownRequestCreateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The Account Number to which the recipient should send funds.
+      sig { returns(String) }
+      attr_accessor :account_number_id
+
+      # The amount requested from the recipient, in USD cents.
+      sig { returns(Integer) }
+      attr_accessor :amount
+
+      # A message the recipient will see as part of the request.
+      sig { returns(String) }
+      attr_accessor :message_to_recipient
+
+      # The drawdown request's recipient's account number.
+      sig { returns(String) }
+      attr_accessor :recipient_account_number
+
+      # The drawdown request's recipient's name.
+      sig { returns(String) }
+      attr_accessor :recipient_name
+
+      # The drawdown request's recipient's routing number.
+      sig { returns(String) }
+      attr_accessor :recipient_routing_number
+
+      # The drawdown request originator's address line 1. This is only necessary if
+      # you're requesting a payment to a commingled account. Otherwise, we'll use the
+      # associated entity's details.
+      sig { returns(T.nilable(String)) }
+      attr_reader :originator_address_line1
+
+      sig { params(originator_address_line1: String).void }
+      attr_writer :originator_address_line1
+
+      # The drawdown request originator's address line 2. This is only necessary if
+      # you're requesting a payment to a commingled account. Otherwise, we'll use the
+      # associated entity's details.
+      sig { returns(T.nilable(String)) }
+      attr_reader :originator_address_line2
+
+      sig { params(originator_address_line2: String).void }
+      attr_writer :originator_address_line2
+
+      # The drawdown request originator's address line 3. This is only necessary if
+      # you're requesting a payment to a commingled account. Otherwise, we'll use the
+      # associated entity's details.
+      sig { returns(T.nilable(String)) }
+      attr_reader :originator_address_line3
+
+      sig { params(originator_address_line3: String).void }
+      attr_writer :originator_address_line3
+
+      # The drawdown request originator's name. This is only necessary if you're
+      # requesting a payment to a commingled account. Otherwise, we'll use the
+      # associated entity's details.
+      sig { returns(T.nilable(String)) }
+      attr_reader :originator_name
+
+      sig { params(originator_name: String).void }
+      attr_writer :originator_name
+
+      # Line 1 of the drawdown request's recipient's address.
+      sig { returns(T.nilable(String)) }
+      attr_reader :recipient_address_line1
+
+      sig { params(recipient_address_line1: String).void }
+      attr_writer :recipient_address_line1
+
+      # Line 2 of the drawdown request's recipient's address.
+      sig { returns(T.nilable(String)) }
+      attr_reader :recipient_address_line2
+
+      sig { params(recipient_address_line2: String).void }
+      attr_writer :recipient_address_line2
+
+      # Line 3 of the drawdown request's recipient's address.
+      sig { returns(T.nilable(String)) }
+      attr_reader :recipient_address_line3
+
+      sig { params(recipient_address_line3: String).void }
+      attr_writer :recipient_address_line3
+
+      sig do
+        params(
+          account_number_id: String,
+          amount: Integer,
+          message_to_recipient: String,
+          recipient_account_number: String,
+          recipient_name: String,
+          recipient_routing_number: String,
+          originator_address_line1: String,
+          originator_address_line2: String,
+          originator_address_line3: String,
+          originator_name: String,
+          recipient_address_line1: String,
+          recipient_address_line2: String,
+          recipient_address_line3: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Account Number to which the recipient should send funds.
+        account_number_id:,
+        # The amount requested from the recipient, in USD cents.
+        amount:,
+        # A message the recipient will see as part of the request.
+        message_to_recipient:,
+        # The drawdown request's recipient's account number.
+        recipient_account_number:,
+        # The drawdown request's recipient's name.
+        recipient_name:,
+        # The drawdown request's recipient's routing number.
+        recipient_routing_number:,
+        # The drawdown request originator's address line 1. This is only necessary if
+        # you're requesting a payment to a commingled account. Otherwise, we'll use the
+        # associated entity's details.
+        originator_address_line1: nil,
+        # The drawdown request originator's address line 2. This is only necessary if
+        # you're requesting a payment to a commingled account. Otherwise, we'll use the
+        # associated entity's details.
+        originator_address_line2: nil,
+        # The drawdown request originator's address line 3. This is only necessary if
+        # you're requesting a payment to a commingled account. Otherwise, we'll use the
+        # associated entity's details.
+        originator_address_line3: nil,
+        # The drawdown request originator's name. This is only necessary if you're
+        # requesting a payment to a commingled account. Otherwise, we'll use the
+        # associated entity's details.
+        originator_name: nil,
+        # Line 1 of the drawdown request's recipient's address.
+        recipient_address_line1: nil,
+        # Line 2 of the drawdown request's recipient's address.
+        recipient_address_line2: nil,
+        # Line 3 of the drawdown request's recipient's address.
+        recipient_address_line3: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_number_id: String,
+            amount: Integer,
+            message_to_recipient: String,
+            recipient_account_number: String,
+            recipient_name: String,
+            recipient_routing_number: String,
+            originator_address_line1: String,
+            originator_address_line2: String,
+            originator_address_line3: String,
+            originator_name: String,
+            recipient_address_line1: String,
+            recipient_address_line2: String,
+            recipient_address_line3: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/wire_drawdown_request_list_params.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module Increase
+  module Models
+    class WireDrawdownRequestListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::WireDrawdownRequestListParams,
+            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::WireDrawdownRequestListParams::Status))
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: Increase::WireDrawdownRequestListParams::Status::OrHash
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::WireDrawdownRequestListParams::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::WireDrawdownRequestListParams::Status,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::WireDrawdownRequestListParams::Status,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter Wire Drawdown Requests for those with the specified status. 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::WireDrawdownRequestListParams::Status::In::OrSymbol
+              ]
+            )
+          )
+        end
+        attr_reader :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::WireDrawdownRequestListParams::Status::In::OrSymbol
+              ]
+          ).void
+        end
+        attr_writer :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[
+                Increase::WireDrawdownRequestListParams::Status::In::OrSymbol
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter Wire Drawdown Requests for those with the specified status. 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::WireDrawdownRequestListParams::Status::In::OrSymbol
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::WireDrawdownRequestListParams::Status::In)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The drawdown request is queued to be submitted to Fedwire.
+          PENDING_SUBMISSION =
+            T.let(
+              :pending_submission,
+              Increase::WireDrawdownRequestListParams::Status::In::TaggedSymbol
+            )
+
+          # The drawdown request has been sent and the recipient should respond in some way.
+          PENDING_RESPONSE =
+            T.let(
+              :pending_response,
+              Increase::WireDrawdownRequestListParams::Status::In::TaggedSymbol
+            )
+
+          # The drawdown request has been fulfilled by the recipient.
+          FULFILLED =
+            T.let(
+              :fulfilled,
+              Increase::WireDrawdownRequestListParams::Status::In::TaggedSymbol
+            )
+
+          # The drawdown request has been refused by the recipient.
+          REFUSED =
+            T.let(
+              :refused,
+              Increase::WireDrawdownRequestListParams::Status::In::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::WireDrawdownRequestListParams::Status::In::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end