increase 1.113.0 → 1.114.0

data/sig/increase/models/fednow_transfer_list_params.rbs

@@ -0,0 +1,174 @@
+module Increase
+  module Models
+    type fednow_transfer_list_params =
+      {
+        account_id: String,
+        created_at: Increase::FednowTransferListParams::CreatedAt,
+        cursor: String,
+        external_account_id: String,
+        idempotency_key: String,
+        limit: Integer,
+        status: Increase::FednowTransferListParams::Status
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class FednowTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_reader account_id: String?
+
+      def account_id=: (String) -> String
+
+      attr_reader created_at: Increase::FednowTransferListParams::CreatedAt?
+
+      def created_at=: (
+        Increase::FednowTransferListParams::CreatedAt
+      ) -> Increase::FednowTransferListParams::CreatedAt
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader external_account_id: String?
+
+      def external_account_id=: (String) -> String
+
+      attr_reader idempotency_key: String?
+
+      def idempotency_key=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_reader status: Increase::FednowTransferListParams::Status?
+
+      def status=: (
+        Increase::FednowTransferListParams::Status
+      ) -> Increase::FednowTransferListParams::Status
+
+      def initialize: (
+        ?account_id: String,
+        ?created_at: Increase::FednowTransferListParams::CreatedAt,
+        ?cursor: String,
+        ?external_account_id: String,
+        ?idempotency_key: String,
+        ?limit: Integer,
+        ?status: Increase::FednowTransferListParams::Status,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        created_at: Increase::FednowTransferListParams::CreatedAt,
+        cursor: String,
+        external_account_id: String,
+        idempotency_key: String,
+        limit: Integer,
+        status: Increase::FednowTransferListParams::Status,
+        request_options: Increase::RequestOptions
+      }
+
+      type created_at =
+        { after: Time, before: Time, on_or_after: Time, on_or_before: Time }
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        attr_reader after: Time?
+
+        def after=: (Time) -> Time
+
+        attr_reader before: Time?
+
+        def before=: (Time) -> Time
+
+        attr_reader on_or_after: Time?
+
+        def on_or_after=: (Time) -> Time
+
+        attr_reader on_or_before: Time?
+
+        def on_or_before=: (Time) -> Time
+
+        def initialize: (
+          ?after: Time,
+          ?before: Time,
+          ?on_or_after: Time,
+          ?on_or_before: Time
+        ) -> void
+
+        def to_hash: -> {
+          after: Time,
+          before: Time,
+          on_or_after: Time,
+          on_or_before: Time
+        }
+      end
+
+      type status =
+        {
+          in_: ::Array[Increase::Models::FednowTransferListParams::Status::in_]
+        }
+
+      class Status < Increase::Internal::Type::BaseModel
+        attr_reader in_: ::Array[Increase::Models::FednowTransferListParams::Status::in_]?
+
+        def in_=: (
+          ::Array[Increase::Models::FednowTransferListParams::Status::in_]
+        ) -> ::Array[Increase::Models::FednowTransferListParams::Status::in_]
+
+        def initialize: (
+          ?in_: ::Array[Increase::Models::FednowTransferListParams::Status::in_]
+        ) -> void
+
+        def to_hash: -> {
+          in_: ::Array[Increase::Models::FednowTransferListParams::Status::in_]
+        }
+
+        type in_ =
+          :pending_reviewing
+          | :canceled
+          | :reviewing_rejected
+          | :requires_attention
+          | :pending_approval
+          | :pending_submitting
+          | :pending_response
+          | :complete
+          | :rejected
+
+        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
+
+          def self?.values: -> ::Array[Increase::Models::FednowTransferListParams::Status::in_]
+        end
+      end
+    end
+  end
+end

data/sig/increase/models/fednow_transfer_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module Increase
+  module Models
+    type fednow_transfer_retrieve_params =
+      {  } & Increase::Internal::Type::request_parameters
+
+    class FednowTransferRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Increase::request_opts) -> void
+
+      def to_hash: -> { request_options: Increase::RequestOptions }
+    end
+  end
+end

data/sig/increase/models/inbound_fednow_transfer.rbs

@@ -0,0 +1,223 @@
+module Increase
+  module Models
+    type inbound_fednow_transfer =
+      {
+        id: String,
+        account_id: String,
+        account_number_id: String,
+        amount: Integer,
+        confirmation: Increase::InboundFednowTransfer::Confirmation?,
+        created_at: Time,
+        creditor_name: String,
+        currency: Increase::Models::InboundFednowTransfer::currency,
+        debtor_account_number: String,
+        debtor_name: String,
+        debtor_routing_number: String,
+        decline: Increase::InboundFednowTransfer::Decline?,
+        status: Increase::Models::InboundFednowTransfer::status,
+        transaction_id: String?,
+        type: Increase::Models::InboundFednowTransfer::type_,
+        unstructured_remittance_information: String?
+      }
+
+    class InboundFednowTransfer < Increase::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor account_id: String
+
+      attr_accessor account_number_id: String
+
+      attr_accessor amount: Integer
+
+      attr_accessor confirmation: Increase::InboundFednowTransfer::Confirmation?
+
+      attr_accessor created_at: Time
+
+      attr_accessor creditor_name: String
+
+      attr_accessor currency: Increase::Models::InboundFednowTransfer::currency
+
+      attr_accessor debtor_account_number: String
+
+      attr_accessor debtor_name: String
+
+      attr_accessor debtor_routing_number: String
+
+      attr_accessor decline: Increase::InboundFednowTransfer::Decline?
+
+      attr_accessor status: Increase::Models::InboundFednowTransfer::status
+
+      attr_accessor transaction_id: String?
+
+      attr_accessor type: Increase::Models::InboundFednowTransfer::type_
+
+      attr_accessor unstructured_remittance_information: String?
+
+      def initialize: (
+        id: String,
+        account_id: String,
+        account_number_id: String,
+        amount: Integer,
+        confirmation: Increase::InboundFednowTransfer::Confirmation?,
+        created_at: Time,
+        creditor_name: String,
+        currency: Increase::Models::InboundFednowTransfer::currency,
+        debtor_account_number: String,
+        debtor_name: String,
+        debtor_routing_number: String,
+        decline: Increase::InboundFednowTransfer::Decline?,
+        status: Increase::Models::InboundFednowTransfer::status,
+        transaction_id: String?,
+        type: Increase::Models::InboundFednowTransfer::type_,
+        unstructured_remittance_information: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        account_id: String,
+        account_number_id: String,
+        amount: Integer,
+        confirmation: Increase::InboundFednowTransfer::Confirmation?,
+        created_at: Time,
+        creditor_name: String,
+        currency: Increase::Models::InboundFednowTransfer::currency,
+        debtor_account_number: String,
+        debtor_name: String,
+        debtor_routing_number: String,
+        decline: Increase::InboundFednowTransfer::Decline?,
+        status: Increase::Models::InboundFednowTransfer::status,
+        transaction_id: String?,
+        type: Increase::Models::InboundFednowTransfer::type_,
+        unstructured_remittance_information: String?
+      }
+
+      type confirmation = { transfer_id: String }
+
+      class Confirmation < Increase::Internal::Type::BaseModel
+        attr_accessor transfer_id: String
+
+        def initialize: (transfer_id: String) -> void
+
+        def to_hash: -> { transfer_id: String }
+      end
+
+      type currency = :CAD | :CHF | :EUR | :GBP | :JPY | :USD
+
+      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
+
+        def self?.values: -> ::Array[Increase::Models::InboundFednowTransfer::currency]
+      end
+
+      type decline =
+        {
+          reason: Increase::Models::InboundFednowTransfer::Decline::reason,
+          transfer_id: String
+        }
+
+      class Decline < Increase::Internal::Type::BaseModel
+        attr_accessor reason: Increase::Models::InboundFednowTransfer::Decline::reason
+
+        attr_accessor transfer_id: String
+
+        def initialize: (
+          reason: Increase::Models::InboundFednowTransfer::Decline::reason,
+          transfer_id: String
+        ) -> void
+
+        def to_hash: -> {
+          reason: Increase::Models::InboundFednowTransfer::Decline::reason,
+          transfer_id: String
+        }
+
+        type reason =
+          :account_number_canceled
+          | :account_number_disabled
+          | :account_restricted
+          | :group_locked
+          | :entity_not_active
+          | :fednow_not_enabled
+
+        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
+
+          def self?.values: -> ::Array[Increase::Models::InboundFednowTransfer::Decline::reason]
+        end
+      end
+
+      type status =
+        :pending_confirming
+        | :timed_out
+        | :confirmed
+        | :declined
+        | :requires_attention
+
+      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
+
+        def self?.values: -> ::Array[Increase::Models::InboundFednowTransfer::status]
+      end
+
+      type type_ = :inbound_fednow_transfer
+
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        INBOUND_FEDNOW_TRANSFER: :inbound_fednow_transfer
+
+        def self?.values: -> ::Array[Increase::Models::InboundFednowTransfer::type_]
+      end
+    end
+  end
+end

data/sig/increase/models/inbound_fednow_transfer_list_params.rbs

@@ -0,0 +1,93 @@
+module Increase
+  module Models
+    type inbound_fednow_transfer_list_params =
+      {
+        account_id: String,
+        account_number_id: String,
+        created_at: Increase::InboundFednowTransferListParams::CreatedAt,
+        cursor: String,
+        limit: Integer
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class InboundFednowTransferListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_reader account_id: String?
+
+      def account_id=: (String) -> String
+
+      attr_reader account_number_id: String?
+
+      def account_number_id=: (String) -> String
+
+      attr_reader created_at: Increase::InboundFednowTransferListParams::CreatedAt?
+
+      def created_at=: (
+        Increase::InboundFednowTransferListParams::CreatedAt
+      ) -> Increase::InboundFednowTransferListParams::CreatedAt
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      def initialize: (
+        ?account_id: String,
+        ?account_number_id: String,
+        ?created_at: Increase::InboundFednowTransferListParams::CreatedAt,
+        ?cursor: String,
+        ?limit: Integer,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        account_number_id: String,
+        created_at: Increase::InboundFednowTransferListParams::CreatedAt,
+        cursor: String,
+        limit: Integer,
+        request_options: Increase::RequestOptions
+      }
+
+      type created_at =
+        { after: Time, before: Time, on_or_after: Time, on_or_before: Time }
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        attr_reader after: Time?
+
+        def after=: (Time) -> Time
+
+        attr_reader before: Time?
+
+        def before=: (Time) -> Time
+
+        attr_reader on_or_after: Time?
+
+        def on_or_after=: (Time) -> Time
+
+        attr_reader on_or_before: Time?
+
+        def on_or_before=: (Time) -> Time
+
+        def initialize: (
+          ?after: Time,
+          ?before: Time,
+          ?on_or_after: Time,
+          ?on_or_before: Time
+        ) -> void
+
+        def to_hash: -> {
+          after: Time,
+          before: Time,
+          on_or_after: Time,
+          on_or_before: Time
+        }
+      end
+    end
+  end
+end

data/sig/increase/models/inbound_fednow_transfer_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module Increase
+  module Models
+    type inbound_fednow_transfer_retrieve_params =
+      {  } & Increase::Internal::Type::request_parameters
+
+    class InboundFednowTransferRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Increase::request_opts) -> void
+
+      def to_hash: -> { request_options: Increase::RequestOptions }
+    end
+  end
+end

data/sig/increase/models/simulations/inbound_fednow_transfer_create_params.rbs

@@ -0,0 +1,61 @@
+module Increase
+  module Models
+    module Simulations
+      type inbound_fednow_transfer_create_params =
+        {
+          account_number_id: String,
+          amount: Integer,
+          debtor_account_number: String,
+          debtor_name: String,
+          debtor_routing_number: String,
+          unstructured_remittance_information: String
+        }
+        & Increase::Internal::Type::request_parameters
+
+      class InboundFednowTransferCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        attr_accessor account_number_id: String
+
+        attr_accessor amount: Integer
+
+        attr_reader debtor_account_number: String?
+
+        def debtor_account_number=: (String) -> String
+
+        attr_reader debtor_name: String?
+
+        def debtor_name=: (String) -> String
+
+        attr_reader debtor_routing_number: String?
+
+        def debtor_routing_number=: (String) -> String
+
+        attr_reader unstructured_remittance_information: String?
+
+        def unstructured_remittance_information=: (String) -> String
+
+        def initialize: (
+          account_number_id: String,
+          amount: Integer,
+          ?debtor_account_number: String,
+          ?debtor_name: String,
+          ?debtor_routing_number: String,
+          ?unstructured_remittance_information: String,
+          ?request_options: Increase::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          account_number_id: String,
+          amount: Integer,
+          debtor_account_number: String,
+          debtor_name: String,
+          debtor_routing_number: String,
+          unstructured_remittance_information: String,
+          request_options: Increase::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/increase/models.rbs

@@ -277,6 +277,18 @@ module Increase
 
   class ExternalAccountUpdateParams = Increase::Models::ExternalAccountUpdateParams
 
+  class FednowTransfer = Increase::Models::FednowTransfer
+
+  class FednowTransferApproveParams = Increase::Models::FednowTransferApproveParams
+
+  class FednowTransferCancelParams = Increase::Models::FednowTransferCancelParams
+
+  class FednowTransferCreateParams = Increase::Models::FednowTransferCreateParams
+
+  class FednowTransferListParams = Increase::Models::FednowTransferListParams
+
+  class FednowTransferRetrieveParams = Increase::Models::FednowTransferRetrieveParams
+
   class File = Increase::Models::File
 
   class FileCreateParams = Increase::Models::FileCreateParams
@@ -315,6 +327,12 @@ module Increase
 
   class InboundCheckDepositReturnParams = Increase::Models::InboundCheckDepositReturnParams
 
+  class InboundFednowTransfer = Increase::Models::InboundFednowTransfer
+
+  class InboundFednowTransferListParams = Increase::Models::InboundFednowTransferListParams
+
+  class InboundFednowTransferRetrieveParams = Increase::Models::InboundFednowTransferRetrieveParams
+
   class InboundMailItem = Increase::Models::InboundMailItem
 
   class InboundMailItemListParams = Increase::Models::InboundMailItemListParams

data/sig/increase/resources/fednow_transfers.rbs

@@ -0,0 +1,49 @@
+module Increase
+  module Resources
+    class FednowTransfers
+      def create: (
+        account_id: String,
+        amount: Integer,
+        creditor_name: String,
+        debtor_name: String,
+        source_account_number_id: String,
+        unstructured_remittance_information: String,
+        ?account_number: String,
+        ?creditor_address: Increase::FednowTransferCreateParams::CreditorAddress,
+        ?debtor_address: Increase::FednowTransferCreateParams::DebtorAddress,
+        ?external_account_id: String,
+        ?require_approval: bool,
+        ?routing_number: String,
+        ?request_options: Increase::request_opts
+      ) -> Increase::FednowTransfer
+
+      def retrieve: (
+        String fednow_transfer_id,
+        ?request_options: Increase::request_opts
+      ) -> Increase::FednowTransfer
+
+      def list: (
+        ?account_id: String,
+        ?created_at: Increase::FednowTransferListParams::CreatedAt,
+        ?cursor: String,
+        ?external_account_id: String,
+        ?idempotency_key: String,
+        ?limit: Integer,
+        ?status: Increase::FednowTransferListParams::Status,
+        ?request_options: Increase::request_opts
+      ) -> Increase::Internal::Page[Increase::FednowTransfer]
+
+      def approve: (
+        String fednow_transfer_id,
+        ?request_options: Increase::request_opts
+      ) -> Increase::FednowTransfer
+
+      def cancel: (
+        String fednow_transfer_id,
+        ?request_options: Increase::request_opts
+      ) -> Increase::FednowTransfer
+
+      def initialize: (client: Increase::Client) -> void
+    end
+  end
+end

data/sig/increase/resources/inbound_fednow_transfers.rbs

@@ -0,0 +1,21 @@
+module Increase
+  module Resources
+    class InboundFednowTransfers
+      def retrieve: (
+        String inbound_fednow_transfer_id,
+        ?request_options: Increase::request_opts
+      ) -> Increase::InboundFednowTransfer
+
+      def list: (
+        ?account_id: String,
+        ?account_number_id: String,
+        ?created_at: Increase::InboundFednowTransferListParams::CreatedAt,
+        ?cursor: String,
+        ?limit: Integer,
+        ?request_options: Increase::request_opts
+      ) -> Increase::Internal::Page[Increase::InboundFednowTransfer]
+
+      def initialize: (client: Increase::Client) -> void
+    end
+  end
+end