increase 0.3.2 → 1.0.0

data/lib/increase/models/inbound_wire_drawdown_request.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundWireDrawdownRequests#retrieve
+    class InboundWireDrawdownRequest < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Wire drawdown request identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   The amount being requested in cents.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute beneficiary_account_number
+      #   The drawdown request's beneficiary's account number.
+      #
+      #   @return [String]
+      required :beneficiary_account_number, String
+
+      # @!attribute beneficiary_address_line1
+      #   Line 1 of the drawdown request's beneficiary's address.
+      #
+      #   @return [String, nil]
+      required :beneficiary_address_line1, String, nil?: true
+
+      # @!attribute beneficiary_address_line2
+      #   Line 2 of the drawdown request's beneficiary's address.
+      #
+      #   @return [String, nil]
+      required :beneficiary_address_line2, String, nil?: true
+
+      # @!attribute beneficiary_address_line3
+      #   Line 3 of the drawdown request's beneficiary's address.
+      #
+      #   @return [String, nil]
+      required :beneficiary_address_line3, String, nil?: true
+
+      # @!attribute beneficiary_name
+      #   The drawdown request's beneficiary's name.
+      #
+      #   @return [String, nil]
+      required :beneficiary_name, String, nil?: true
+
+      # @!attribute beneficiary_routing_number
+      #   The drawdown request's beneficiary's routing number.
+      #
+      #   @return [String]
+      required :beneficiary_routing_number, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the inbound wire drawdown requested was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+      #   requested. Will always be "USD".
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute message_to_recipient
+      #   A message from the drawdown request's originator.
+      #
+      #   @return [String, nil]
+      required :message_to_recipient, String, nil?: true
+
+      # @!attribute originator_account_number
+      #   The drawdown request's originator's account number.
+      #
+      #   @return [String, nil]
+      required :originator_account_number, String, nil?: true
+
+      # @!attribute originator_address_line1
+      #   Line 1 of the drawdown request's originator's address.
+      #
+      #   @return [String, nil]
+      required :originator_address_line1, String, nil?: true
+
+      # @!attribute originator_address_line2
+      #   Line 2 of the drawdown request's originator's address.
+      #
+      #   @return [String, nil]
+      required :originator_address_line2, String, nil?: true
+
+      # @!attribute originator_address_line3
+      #   Line 3 of the drawdown request's originator's address.
+      #
+      #   @return [String, nil]
+      required :originator_address_line3, String, nil?: true
+
+      # @!attribute originator_name
+      #   The drawdown request's originator's name.
+      #
+      #   @return [String, nil]
+      required :originator_name, String, nil?: true
+
+      # @!attribute originator_routing_number
+      #   The drawdown request's originator's routing number.
+      #
+      #   @return [String]
+      required :originator_routing_number, String
+
+      # @!attribute originator_to_beneficiary_information_line1
+      #   Line 1 of the information conveyed from the originator of the message to the
+      #   beneficiary.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information_line1, String, nil?: true
+
+      # @!attribute originator_to_beneficiary_information_line2
+      #   Line 2 of the information conveyed from the originator of the message to the
+      #   beneficiary.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information_line2, String, nil?: true
+
+      # @!attribute originator_to_beneficiary_information_line3
+      #   Line 3 of the information conveyed from the originator of the message to the
+      #   beneficiary.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information_line3, String, nil?: true
+
+      # @!attribute originator_to_beneficiary_information_line4
+      #   Line 4 of the information conveyed from the originator of the message to the
+      #   beneficiary.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information_line4, String, nil?: true
+
+      # @!attribute recipient_account_number_id
+      #   The Account Number from which the recipient of this request is being requested
+      #   to send funds.
+      #
+      #   @return [String]
+      required :recipient_account_number_id, String
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `inbound_wire_drawdown_request`.
+      #
+      #   @return [Symbol, Increase::Models::InboundWireDrawdownRequest::Type]
+      required :type, enum: -> { Increase::InboundWireDrawdownRequest::Type }
+
+      # @!method initialize(id:, amount:, beneficiary_account_number:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, beneficiary_routing_number:, created_at:, currency:, message_to_recipient:, originator_account_number:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, originator_routing_number:, originator_to_beneficiary_information_line1:, originator_to_beneficiary_information_line2:, originator_to_beneficiary_information_line3:, originator_to_beneficiary_information_line4:, recipient_account_number_id:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::InboundWireDrawdownRequest} for more details.
+      #
+      #   Inbound wire drawdown requests are requests from someone else to send them a
+      #   wire. For more information, see our
+      #   [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests).
+      #
+      #   @param id [String] The Wire drawdown request identifier.
+      #
+      #   @param amount [Integer] The amount being requested in cents.
+      #
+      #   @param beneficiary_account_number [String] The drawdown request's beneficiary's account number.
+      #
+      #   @param beneficiary_address_line1 [String, nil] Line 1 of the drawdown request's beneficiary's address.
+      #
+      #   @param beneficiary_address_line2 [String, nil] Line 2 of the drawdown request's beneficiary's address.
+      #
+      #   @param beneficiary_address_line3 [String, nil] Line 3 of the drawdown request's beneficiary's address.
+      #
+      #   @param beneficiary_name [String, nil] The drawdown request's beneficiary's name.
+      #
+      #   @param beneficiary_routing_number [String] The drawdown request's beneficiary's routing number.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param currency [String] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being
+      #
+      #   @param message_to_recipient [String, nil] A message from the drawdown request's originator.
+      #
+      #   @param originator_account_number [String, nil] The drawdown request's originator's account number.
+      #
+      #   @param originator_address_line1 [String, nil] Line 1 of the drawdown request's originator's address.
+      #
+      #   @param originator_address_line2 [String, nil] Line 2 of the drawdown request's originator's address.
+      #
+      #   @param originator_address_line3 [String, nil] Line 3 of the drawdown request's originator's address.
+      #
+      #   @param originator_name [String, nil] The drawdown request's originator's name.
+      #
+      #   @param originator_routing_number [String] The drawdown request's originator's routing number.
+      #
+      #   @param originator_to_beneficiary_information_line1 [String, nil] Line 1 of the information conveyed from the originator of the message to the ben
+      #
+      #   @param originator_to_beneficiary_information_line2 [String, nil] Line 2 of the information conveyed from the originator of the message to the ben
+      #
+      #   @param originator_to_beneficiary_information_line3 [String, nil] Line 3 of the information conveyed from the originator of the message to the ben
+      #
+      #   @param originator_to_beneficiary_information_line4 [String, nil] Line 4 of the information conveyed from the originator of the message to the ben
+      #
+      #   @param recipient_account_number_id [String] The Account Number from which the recipient of this request is being requested t
+      #
+      #   @param type [Symbol, Increase::Models::InboundWireDrawdownRequest::Type] A constant representing the object's type. For this resource it will always be `
+
+      # A constant representing the object's type. For this resource it will always be
+      # `inbound_wire_drawdown_request`.
+      #
+      # @see Increase::Models::InboundWireDrawdownRequest#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        INBOUND_WIRE_DRAWDOWN_REQUEST = :inbound_wire_drawdown_request
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/inbound_wire_drawdown_request_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundWireDrawdownRequests#list
+    class InboundWireDrawdownRequestListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::InboundWireDrawdownRequestListParams} for more details.
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/inbound_wire_drawdown_request_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundWireDrawdownRequests#retrieve
+    class InboundWireDrawdownRequestRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/inbound_wire_transfer.rb

@@ -0,0 +1,307 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundWireTransfers#retrieve
+    class InboundWireTransfer < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The inbound wire transfer's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The Account to which the transfer belongs.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute account_number_id
+      #   The identifier of the Account Number to which this transfer was sent.
+      #
+      #   @return [String]
+      required :account_number_id, String
+
+      # @!attribute amount
+      #   The amount in USD cents.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute beneficiary_address_line1
+      #   A free-form address field set by the sender.
+      #
+      #   @return [String, nil]
+      required :beneficiary_address_line1, String, nil?: true
+
+      # @!attribute beneficiary_address_line2
+      #   A free-form address field set by the sender.
+      #
+      #   @return [String, nil]
+      required :beneficiary_address_line2, String, nil?: true
+
+      # @!attribute beneficiary_address_line3
+      #   A free-form address field set by the sender.
+      #
+      #   @return [String, nil]
+      required :beneficiary_address_line3, String, nil?: true
+
+      # @!attribute beneficiary_name
+      #   A name set by the sender.
+      #
+      #   @return [String, nil]
+      required :beneficiary_name, String, nil?: true
+
+      # @!attribute beneficiary_reference
+      #   A free-form reference string set by the sender, to help identify the transfer.
+      #
+      #   @return [String, nil]
+      required :beneficiary_reference, String, nil?: true
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the inbound wire transfer was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   An Increase-constructed description of the transfer.
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute input_message_accountability_data
+      #   A unique identifier available to the originating and receiving banks, commonly
+      #   abbreviated as IMAD. It is created when the wire is submitted to the Fedwire
+      #   service and is helpful when debugging wires with the originating bank.
+      #
+      #   @return [String, nil]
+      required :input_message_accountability_data, String, nil?: true
+
+      # @!attribute originator_address_line1
+      #   The address of the wire originator, set by the sending bank.
+      #
+      #   @return [String, nil]
+      required :originator_address_line1, String, nil?: true
+
+      # @!attribute originator_address_line2
+      #   The address of the wire originator, set by the sending bank.
+      #
+      #   @return [String, nil]
+      required :originator_address_line2, String, nil?: true
+
+      # @!attribute originator_address_line3
+      #   The address of the wire originator, set by the sending bank.
+      #
+      #   @return [String, nil]
+      required :originator_address_line3, String, nil?: true
+
+      # @!attribute originator_name
+      #   The originator of the wire, set by the sending bank.
+      #
+      #   @return [String, nil]
+      required :originator_name, String, nil?: true
+
+      # @!attribute originator_routing_number
+      #   The American Banking Association (ABA) routing number of the bank originating
+      #   the transfer.
+      #
+      #   @return [String, nil]
+      required :originator_routing_number, String, nil?: true
+
+      # @!attribute originator_to_beneficiary_information
+      #   An Increase-created concatenation of the Originator-to-Beneficiary lines.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information, String, nil?: true
+
+      # @!attribute originator_to_beneficiary_information_line1
+      #   A free-form message set by the wire originator.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information_line1, String, nil?: true
+
+      # @!attribute originator_to_beneficiary_information_line2
+      #   A free-form message set by the wire originator.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information_line2, String, nil?: true
+
+      # @!attribute originator_to_beneficiary_information_line3
+      #   A free-form message set by the wire originator.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information_line3, String, nil?: true
+
+      # @!attribute originator_to_beneficiary_information_line4
+      #   A free-form message set by the wire originator.
+      #
+      #   @return [String, nil]
+      required :originator_to_beneficiary_information_line4, String, nil?: true
+
+      # @!attribute reversal
+      #   Information about the reversal of the inbound wire transfer if it has been
+      #   reversed.
+      #
+      #   @return [Increase::Models::InboundWireTransfer::Reversal, nil]
+      required :reversal, -> { Increase::InboundWireTransfer::Reversal }, nil?: true
+
+      # @!attribute sender_reference
+      #   The sending bank's reference number for the wire transfer.
+      #
+      #   @return [String, nil]
+      required :sender_reference, String, nil?: true
+
+      # @!attribute status
+      #   The status of the transfer.
+      #
+      #   @return [Symbol, Increase::Models::InboundWireTransfer::Status]
+      required :status, enum: -> { Increase::InboundWireTransfer::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `inbound_wire_transfer`.
+      #
+      #   @return [Symbol, Increase::Models::InboundWireTransfer::Type]
+      required :type, enum: -> { Increase::InboundWireTransfer::Type }
+
+      # @!method initialize(id:, account_id:, account_number_id:, amount:, beneficiary_address_line1:, beneficiary_address_line2:, beneficiary_address_line3:, beneficiary_name:, beneficiary_reference:, created_at:, description:, input_message_accountability_data:, originator_address_line1:, originator_address_line2:, originator_address_line3:, originator_name:, originator_routing_number:, originator_to_beneficiary_information:, originator_to_beneficiary_information_line1:, originator_to_beneficiary_information_line2:, originator_to_beneficiary_information_line3:, originator_to_beneficiary_information_line4:, reversal:, sender_reference:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::InboundWireTransfer} for more details.
+      #
+      #   An Inbound Wire Transfer is a wire transfer initiated outside of Increase to
+      #   your account.
+      #
+      #   @param id [String] The inbound wire transfer's identifier.
+      #
+      #   @param account_id [String] The Account to which the transfer belongs.
+      #
+      #   @param account_number_id [String] The identifier of the Account Number to which this transfer was sent.
+      #
+      #   @param amount [Integer] The amount in USD cents.
+      #
+      #   @param beneficiary_address_line1 [String, nil] A free-form address field set by the sender.
+      #
+      #   @param beneficiary_address_line2 [String, nil] A free-form address field set by the sender.
+      #
+      #   @param beneficiary_address_line3 [String, nil] A free-form address field set by the sender.
+      #
+      #   @param beneficiary_name [String, nil] A name set by the sender.
+      #
+      #   @param beneficiary_reference [String, nil] A free-form reference string set by the sender, to help identify the transfer.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param description [String] An Increase-constructed description of the transfer.
+      #
+      #   @param input_message_accountability_data [String, nil] A unique identifier available to the originating and receiving banks, commonly a
+      #
+      #   @param originator_address_line1 [String, nil] The address of the wire originator, set by the sending bank.
+      #
+      #   @param originator_address_line2 [String, nil] The address of the wire originator, set by the sending bank.
+      #
+      #   @param originator_address_line3 [String, nil] The address of the wire originator, set by the sending bank.
+      #
+      #   @param originator_name [String, nil] The originator of the wire, set by the sending bank.
+      #
+      #   @param originator_routing_number [String, nil] The American Banking Association (ABA) routing number of the bank originating th
+      #
+      #   @param originator_to_beneficiary_information [String, nil] An Increase-created concatenation of the Originator-to-Beneficiary lines.
+      #
+      #   @param originator_to_beneficiary_information_line1 [String, nil] A free-form message set by the wire originator.
+      #
+      #   @param originator_to_beneficiary_information_line2 [String, nil] A free-form message set by the wire originator.
+      #
+      #   @param originator_to_beneficiary_information_line3 [String, nil] A free-form message set by the wire originator.
+      #
+      #   @param originator_to_beneficiary_information_line4 [String, nil] A free-form message set by the wire originator.
+      #
+      #   @param reversal [Increase::Models::InboundWireTransfer::Reversal, nil] Information about the reversal of the inbound wire transfer if it has been rever
+      #
+      #   @param sender_reference [String, nil] The sending bank's reference number for the wire transfer.
+      #
+      #   @param status [Symbol, Increase::Models::InboundWireTransfer::Status] The status of the transfer.
+      #
+      #   @param type [Symbol, Increase::Models::InboundWireTransfer::Type] A constant representing the object's type. For this resource it will always be `
+
+      # @see Increase::Models::InboundWireTransfer#reversal
+      class Reversal < Increase::Internal::Type::BaseModel
+        # @!attribute reason
+        #   The reason for the reversal.
+        #
+        #   @return [Symbol, Increase::Models::InboundWireTransfer::Reversal::Reason]
+        required :reason, enum: -> { Increase::InboundWireTransfer::Reversal::Reason }
+
+        # @!attribute reversed_at
+        #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #   the transfer was reversed.
+        #
+        #   @return [Time]
+        required :reversed_at, Time
+
+        # @!method initialize(reason:, reversed_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::InboundWireTransfer::Reversal} for more details.
+        #
+        #   Information about the reversal of the inbound wire transfer if it has been
+        #   reversed.
+        #
+        #   @param reason [Symbol, Increase::Models::InboundWireTransfer::Reversal::Reason] The reason for the reversal.
+        #
+        #   @param reversed_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+
+        # The reason for the reversal.
+        #
+        # @see Increase::Models::InboundWireTransfer::Reversal#reason
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The inbound wire transfer was a duplicate.
+          DUPLICATE = :duplicate
+
+          # The recipient of the wire transfer requested the funds be returned to the sender.
+          CREDITOR_REQUEST = :creditor_request
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The status of the transfer.
+      #
+      # @see Increase::Models::InboundWireTransfer#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The Inbound Wire Transfer is awaiting action, will transition automatically if no action is taken.
+        PENDING = :pending
+
+        # The Inbound Wire Transfer is accepted.
+        ACCEPTED = :accepted
+
+        # The Inbound Wire Transfer was declined.
+        DECLINED = :declined
+
+        # The Inbound Wire Transfer was reversed.
+        REVERSED = :reversed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `inbound_wire_transfer`.
+      #
+      # @see Increase::Models::InboundWireTransfer#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        INBOUND_WIRE_TRANSFER = :inbound_wire_transfer
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end