increase 1.113.0 → 1.114.0

data/lib/increase/models/fednow_transfer_create_params.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::FednowTransfers#create
+    class FednowTransferCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The identifier for the account that will send the transfer.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute amount
+      #   The amount, in minor units, to send to the creditor.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute creditor_name
+      #   The creditor's name.
+      #
+      #   @return [String]
+      required :creditor_name, String
+
+      # @!attribute debtor_name
+      #   The debtor's name.
+      #
+      #   @return [String]
+      required :debtor_name, String
+
+      # @!attribute source_account_number_id
+      #   The Account Number to include in the transfer as the debtor's account number.
+      #
+      #   @return [String]
+      required :source_account_number_id, String
+
+      # @!attribute unstructured_remittance_information
+      #   Unstructured remittance information to include in the transfer.
+      #
+      #   @return [String]
+      required :unstructured_remittance_information, String
+
+      # @!attribute account_number
+      #   The creditor's account number.
+      #
+      #   @return [String, nil]
+      optional :account_number, String
+
+      # @!attribute creditor_address
+      #   The creditor's address.
+      #
+      #   @return [Increase::Models::FednowTransferCreateParams::CreditorAddress, nil]
+      optional :creditor_address, -> { Increase::FednowTransferCreateParams::CreditorAddress }
+
+      # @!attribute debtor_address
+      #   The debtor's address.
+      #
+      #   @return [Increase::Models::FednowTransferCreateParams::DebtorAddress, nil]
+      optional :debtor_address, -> { Increase::FednowTransferCreateParams::DebtorAddress }
+
+      # @!attribute external_account_id
+      #   The ID of an External Account to initiate a transfer to. If this parameter is
+      #   provided, `account_number` and `routing_number` must be absent.
+      #
+      #   @return [String, nil]
+      optional :external_account_id, String
+
+      # @!attribute require_approval
+      #   Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      #   @return [Boolean, nil]
+      optional :require_approval, Increase::Internal::Type::Boolean
+
+      # @!attribute routing_number
+      #   The creditor's bank account routing number.
+      #
+      #   @return [String, nil]
+      optional :routing_number, String
+
+      # @!method initialize(account_id:, amount:, creditor_name:, debtor_name:, source_account_number_id:, unstructured_remittance_information:, account_number: nil, creditor_address: nil, debtor_address: nil, external_account_id: nil, require_approval: nil, routing_number: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::FednowTransferCreateParams} for more details.
+      #
+      #   @param account_id [String] The identifier for the account that will send the transfer.
+      #
+      #   @param amount [Integer] The amount, in minor units, to send to the creditor.
+      #
+      #   @param creditor_name [String] The creditor's name.
+      #
+      #   @param debtor_name [String] The debtor's name.
+      #
+      #   @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
+      #
+      #   @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
+      #
+      #   @param account_number [String] The creditor's account number.
+      #
+      #   @param creditor_address [Increase::Models::FednowTransferCreateParams::CreditorAddress] The creditor's address.
+      #
+      #   @param debtor_address [Increase::Models::FednowTransferCreateParams::DebtorAddress] The debtor's address.
+      #
+      #   @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
+      #
+      #   @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      #   @param routing_number [String] The creditor's bank account routing number.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreditorAddress < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city, district, town, or village of the address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute postal_code
+        #   The postal code component of the address.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute state
+        #   The US state component of the address.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!attribute line1
+        #   The first line of the address. This is usually the street number and street.
+        #
+        #   @return [String, nil]
+        optional :line1, String
+
+        # @!method initialize(city:, postal_code:, state:, line1: nil)
+        #   The creditor's address.
+        #
+        #   @param city [String] The city, district, town, or village of the address.
+        #
+        #   @param postal_code [String] The postal code component of the address.
+        #
+        #   @param state [String] The US state component of the address.
+        #
+        #   @param line1 [String] The first line of the address. This is usually the street number and street.
+      end
+
+      class DebtorAddress < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city, district, town, or village of the address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute postal_code
+        #   The postal code component of the address.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute state
+        #   The US state component of the address.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!attribute line1
+        #   The first line of the address. This is usually the street number and street.
+        #
+        #   @return [String, nil]
+        optional :line1, String
+
+        # @!method initialize(city:, postal_code:, state:, line1: nil)
+        #   The debtor's address.
+        #
+        #   @param city [String] The city, district, town, or village of the address.
+        #
+        #   @param postal_code [String] The postal code component of the address.
+        #
+        #   @param state [String] The US state component of the address.
+        #
+        #   @param line1 [String] The first line of the address. This is usually the street number and street.
+      end
+    end
+  end
+end

data/lib/increase/models/fednow_transfer_list_params.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::FednowTransfers#list
+    class FednowTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter FedNow Transfers to those that originated from the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::FednowTransferListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::FednowTransferListParams::CreatedAt }
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute external_account_id
+      #   Filter FedNow Transfers to those made to the specified External Account.
+      #
+      #   @return [String, nil]
+      optional :external_account_id, String
+
+      # @!attribute idempotency_key
+      #   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).
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, 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
+
+      # @!attribute status
+      #
+      #   @return [Increase::Models::FednowTransferListParams::Status, nil]
+      optional :status, -> { Increase::FednowTransferListParams::Status }
+
+      # @!method initialize(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::FednowTransferListParams} for more details.
+      #
+      #   @param account_id [String] Filter FedNow Transfers to those that originated from the specified Account.
+      #
+      #   @param created_at [Increase::Models::FednowTransferListParams::CreatedAt]
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param external_account_id [String] Filter FedNow Transfers to those made to the specified External Account.
+      #
+      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param status [Increase::Models::FednowTransferListParams::Status]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::FednowTransferListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Return results whose value is in the provided list. For GET requests, this
+        #   should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::FednowTransferListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::FednowTransferListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::FednowTransferListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::FednowTransferListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The transfer is pending review by Increase.
+          PENDING_REVIEWING = :pending_reviewing
+
+          # The transfer has been canceled.
+          CANCELED = :canceled
+
+          # The transfer has been rejected by Increase.
+          REVIEWING_REJECTED = :reviewing_rejected
+
+          # The transfer requires attention from an Increase operator.
+          REQUIRES_ATTENTION = :requires_attention
+
+          # The transfer is pending approval.
+          PENDING_APPROVAL = :pending_approval
+
+          # The transfer is queued to be submitted to FedNow.
+          PENDING_SUBMITTING = :pending_submitting
+
+          # The transfer has been submitted and is pending a response from FedNow.
+          PENDING_RESPONSE = :pending_response
+
+          # The transfer has been sent successfully and is complete.
+          COMPLETE = :complete
+
+          # The transfer was rejected by the network or the recipient's bank.
+          REJECTED = :rejected
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/fednow_transfer_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::FednowTransfers#retrieve
+    class FednowTransferRetrieveParams < 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_fednow_transfer.rb

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundFednowTransfers#retrieve
+    class InboundFednowTransfer < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The inbound FedNow transfer's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The Account to which the transfer was sent.
+      #
+      #   @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 confirmation
+      #   If your transfer is confirmed, this will contain details of the confirmation.
+      #
+      #   @return [Increase::Models::InboundFednowTransfer::Confirmation, nil]
+      required :confirmation, -> { Increase::InboundFednowTransfer::Confirmation }, nil?: true
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the transfer was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute creditor_name
+      #   The name the sender of the transfer specified as the recipient of the transfer.
+      #
+      #   @return [String]
+      required :creditor_name, String
+
+      # @!attribute currency
+      #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
+      #   currency. This will always be "USD" for a FedNow transfer.
+      #
+      #   @return [Symbol, Increase::Models::InboundFednowTransfer::Currency]
+      required :currency, enum: -> { Increase::InboundFednowTransfer::Currency }
+
+      # @!attribute debtor_account_number
+      #   The account number of the account that sent the transfer.
+      #
+      #   @return [String]
+      required :debtor_account_number, String
+
+      # @!attribute debtor_name
+      #   The name provided by the sender of the transfer.
+      #
+      #   @return [String]
+      required :debtor_name, String
+
+      # @!attribute debtor_routing_number
+      #   The routing number of the account that sent the transfer.
+      #
+      #   @return [String]
+      required :debtor_routing_number, String
+
+      # @!attribute decline
+      #   If your transfer is declined, this will contain details of the decline.
+      #
+      #   @return [Increase::Models::InboundFednowTransfer::Decline, nil]
+      required :decline, -> { Increase::InboundFednowTransfer::Decline }, nil?: true
+
+      # @!attribute status
+      #   The lifecycle status of the transfer.
+      #
+      #   @return [Symbol, Increase::Models::InboundFednowTransfer::Status]
+      required :status, enum: -> { Increase::InboundFednowTransfer::Status }
+
+      # @!attribute transaction_id
+      #   The identifier of the Transaction object created when the transfer was
+      #   confirmed.
+      #
+      #   @return [String, nil]
+      required :transaction_id, String, nil?: true
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `inbound_fednow_transfer`.
+      #
+      #   @return [Symbol, Increase::Models::InboundFednowTransfer::Type]
+      required :type, enum: -> { Increase::InboundFednowTransfer::Type }
+
+      # @!attribute unstructured_remittance_information
+      #   Additional information included with the transfer.
+      #
+      #   @return [String, nil]
+      required :unstructured_remittance_information, String, nil?: true
+
+      # @!method initialize(id:, account_id:, account_number_id:, amount:, confirmation:, created_at:, creditor_name:, currency:, debtor_account_number:, debtor_name:, debtor_routing_number:, decline:, status:, transaction_id:, type:, unstructured_remittance_information:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::InboundFednowTransfer} for more details.
+      #
+      #   An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to
+      #   your account.
+      #
+      #   @param id [String] The inbound FedNow transfer's identifier.
+      #
+      #   @param account_id [String] The Account to which the transfer was sent.
+      #
+      #   @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 confirmation [Increase::Models::InboundFednowTransfer::Confirmation, nil] If your transfer is confirmed, this will contain details of the confirmation.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param creditor_name [String] The name the sender of the transfer specified as the recipient of the transfer.
+      #
+      #   @param currency [Symbol, Increase::Models::InboundFednowTransfer::Currency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's cu
+      #
+      #   @param debtor_account_number [String] The account number of the account that sent the transfer.
+      #
+      #   @param debtor_name [String] The name provided by the sender of the transfer.
+      #
+      #   @param debtor_routing_number [String] The routing number of the account that sent the transfer.
+      #
+      #   @param decline [Increase::Models::InboundFednowTransfer::Decline, nil] If your transfer is declined, this will contain details of the decline.
+      #
+      #   @param status [Symbol, Increase::Models::InboundFednowTransfer::Status] The lifecycle status of the transfer.
+      #
+      #   @param transaction_id [String, nil] The identifier of the Transaction object created when the transfer was confirmed
+      #
+      #   @param type [Symbol, Increase::Models::InboundFednowTransfer::Type] A constant representing the object's type. For this resource it will always be `
+      #
+      #   @param unstructured_remittance_information [String, nil] Additional information included with the transfer.
+
+      # @see Increase::Models::InboundFednowTransfer#confirmation
+      class Confirmation < Increase::Internal::Type::BaseModel
+        # @!attribute transfer_id
+        #   The identifier of the FedNow Transfer that led to this Transaction.
+        #
+        #   @return [String]
+        required :transfer_id, String
+
+        # @!method initialize(transfer_id:)
+        #   If your transfer is confirmed, this will contain details of the confirmation.
+        #
+        #   @param transfer_id [String] The identifier of the FedNow Transfer that led to this Transaction.
+      end
+
+      # The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's
+      # currency. This will always be "USD" for a FedNow transfer.
+      #
+      # @see Increase::Models::InboundFednowTransfer#currency
+      module Currency
+        extend Increase::Internal::Type::Enum
+
+        # Canadian Dollar (CAD)
+        CAD = :CAD
+
+        # Swiss Franc (CHF)
+        CHF = :CHF
+
+        # Euro (EUR)
+        EUR = :EUR
+
+        # British Pound (GBP)
+        GBP = :GBP
+
+        # Japanese Yen (JPY)
+        JPY = :JPY
+
+        # US Dollar (USD)
+        USD = :USD
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Increase::Models::InboundFednowTransfer#decline
+      class Decline < Increase::Internal::Type::BaseModel
+        # @!attribute reason
+        #   Why the transfer was declined.
+        #
+        #   @return [Symbol, Increase::Models::InboundFednowTransfer::Decline::Reason]
+        required :reason, enum: -> { Increase::InboundFednowTransfer::Decline::Reason }
+
+        # @!attribute transfer_id
+        #   The identifier of the FedNow Transfer that led to this declined transaction.
+        #
+        #   @return [String]
+        required :transfer_id, String
+
+        # @!method initialize(reason:, transfer_id:)
+        #   If your transfer is declined, this will contain details of the decline.
+        #
+        #   @param reason [Symbol, Increase::Models::InboundFednowTransfer::Decline::Reason] Why the transfer was declined.
+        #
+        #   @param transfer_id [String] The identifier of the FedNow Transfer that led to this declined transaction.
+
+        # Why the transfer was declined.
+        #
+        # @see Increase::Models::InboundFednowTransfer::Decline#reason
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The account number is canceled.
+          ACCOUNT_NUMBER_CANCELED = :account_number_canceled
+
+          # The account number is disabled.
+          ACCOUNT_NUMBER_DISABLED = :account_number_disabled
+
+          # Your account is restricted.
+          ACCOUNT_RESTRICTED = :account_restricted
+
+          # Your account is inactive.
+          GROUP_LOCKED = :group_locked
+
+          # The account's entity is not active.
+          ENTITY_NOT_ACTIVE = :entity_not_active
+
+          # Your account is not enabled to receive FedNow transfers.
+          FEDNOW_NOT_ENABLED = :fednow_not_enabled
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The lifecycle status of the transfer.
+      #
+      # @see Increase::Models::InboundFednowTransfer#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The transfer is pending confirmation.
+        PENDING_CONFIRMING = :pending_confirming
+
+        # The transfer was not responded to in time.
+        TIMED_OUT = :timed_out
+
+        # The transfer has been received successfully and is confirmed.
+        CONFIRMED = :confirmed
+
+        # The transfer has been declined.
+        DECLINED = :declined
+
+        # The transfer requires attention from an Increase operator.
+        REQUIRES_ATTENTION = :requires_attention
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `inbound_fednow_transfer`.
+      #
+      # @see Increase::Models::InboundFednowTransfer#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        INBOUND_FEDNOW_TRANSFER = :inbound_fednow_transfer
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end