increase 1.0.0 → 1.2.0

data/rbi/increase/models/event_subscription_create_params.rbi

@@ -556,34 +556,62 @@ module Increase
             Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
           )
 
-        # Occurs whenever an Outbound Card Push Transfer is created.
+        # Occurs whenever a Card Push Transfer is created.
         OUTBOUND_CARD_PUSH_TRANSFER_CREATED =
           T.let(
             :"outbound_card_push_transfer.created",
             Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
           )
 
-        # Occurs whenever an Outbound Card Push Transfer is updated.
+        # Occurs whenever a Card Push Transfer is updated.
         OUTBOUND_CARD_PUSH_TRANSFER_UPDATED =
           T.let(
             :"outbound_card_push_transfer.updated",
             Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
           )
 
-        # Occurs whenever an Outbound Card Validation is created.
+        # Occurs whenever a Card Validation is created.
         OUTBOUND_CARD_VALIDATION_CREATED =
           T.let(
             :"outbound_card_validation.created",
             Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
           )
 
-        # Occurs whenever an Outbound Card Validation is updated.
+        # Occurs whenever a Card Validation is updated.
         OUTBOUND_CARD_VALIDATION_UPDATED =
           T.let(
             :"outbound_card_validation.updated",
             Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
           )
 
+        # Occurs whenever a Card Push Transfer is created.
+        CARD_PUSH_TRANSFER_CREATED =
+          T.let(
+            :"card_push_transfer.created",
+            Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Push Transfer is updated.
+        CARD_PUSH_TRANSFER_UPDATED =
+          T.let(
+            :"card_push_transfer.updated",
+            Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Validation is created.
+        CARD_VALIDATION_CREATED =
+          T.let(
+            :"card_validation.created",
+            Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Validation is updated.
+        CARD_VALIDATION_UPDATED =
+          T.let(
+            :"card_validation.updated",
+            Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
+          )
+
         # Occurs whenever a Pending Transaction is created.
         PENDING_TRANSACTION_CREATED =
           T.let(
@@ -703,6 +731,20 @@ module Increase
             Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
           )
 
+        # Occurs whenever a Swift Transfer is created.
+        SWIFT_TRANSFER_CREATED =
+          T.let(
+            :"swift_transfer.created",
+            Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
+          )
+
+        # Occurs whenever a Swift Transfer is updated.
+        SWIFT_TRANSFER_UPDATED =
+          T.let(
+            :"swift_transfer.updated",
+            Increase::EventSubscriptionCreateParams::SelectedEventCategory::TaggedSymbol
+          )
+
         # Occurs whenever a Transaction is created.
         TRANSACTION_CREATED =
           T.let(

data/rbi/increase/models/file.rbi

@@ -265,6 +265,10 @@ module Increase
             Increase::File::Purpose::TaggedSymbol
           )
 
+        # Funding instructions.
+        FUNDING_INSTRUCTIONS =
+          T.let(:funding_instructions, Increase::File::Purpose::TaggedSymbol)
+
         sig do
           override.returns(T::Array[Increase::File::Purpose::TaggedSymbol])
         end

data/rbi/increase/models/file_list_params.rbi

@@ -396,6 +396,13 @@ module Increase
               Increase::FileListParams::Purpose::In::TaggedSymbol
             )
 
+          # Funding instructions.
+          FUNDING_INSTRUCTIONS =
+            T.let(
+              :funding_instructions,
+              Increase::FileListParams::Purpose::In::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[Increase::FileListParams::Purpose::In::TaggedSymbol]

data/rbi/increase/models/inbound_ach_transfer.rbi

@@ -76,14 +76,6 @@ module Increase
       sig { returns(Date) }
       attr_accessor :effective_date
 
-      # The settlement schedule the transfer is expected to follow.
-      sig do
-        returns(
-          Increase::InboundACHTransfer::ExpectedSettlementSchedule::TaggedSymbol
-        )
-      end
-      attr_accessor :expected_settlement_schedule
-
       # If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will
       # contain fields pertaining to the International ACH Transaction.
       sig do
@@ -151,6 +143,18 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :receiver_name
 
+      # A subhash containing information about when and how the transfer settled at the
+      # Federal Reserve.
+      sig { returns(Increase::InboundACHTransfer::Settlement) }
+      attr_reader :settlement
+
+      sig do
+        params(
+          settlement: Increase::InboundACHTransfer::Settlement::OrHash
+        ).void
+      end
+      attr_writer :settlement
+
       # The Standard Entry Class (SEC) code of the transfer.
       sig do
         returns(
@@ -203,8 +207,6 @@ module Increase
           decline: T.nilable(Increase::InboundACHTransfer::Decline::OrHash),
           direction: Increase::InboundACHTransfer::Direction::OrSymbol,
           effective_date: Date,
-          expected_settlement_schedule:
-            Increase::InboundACHTransfer::ExpectedSettlementSchedule::OrSymbol,
           international_addenda:
             T.nilable(
               Increase::InboundACHTransfer::InternationalAddenda::OrHash
@@ -221,6 +223,7 @@ module Increase
           originator_routing_number: String,
           receiver_id_number: T.nilable(String),
           receiver_name: T.nilable(String),
+          settlement: Increase::InboundACHTransfer::Settlement::OrHash,
           standard_entry_class_code:
             Increase::InboundACHTransfer::StandardEntryClassCode::OrSymbol,
           status: Increase::InboundACHTransfer::Status::OrSymbol,
@@ -255,8 +258,6 @@ module Increase
         # The effective date of the transfer. This is sent by the sending bank and is a
         # factor in determining funds availability.
         effective_date:,
-        # The settlement schedule the transfer is expected to follow.
-        expected_settlement_schedule:,
         # If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will
         # contain fields pertaining to the International ACH Transaction.
         international_addenda:,
@@ -280,6 +281,9 @@ module Increase
         receiver_id_number:,
         # The name of the receiver of the transfer.
         receiver_name:,
+        # A subhash containing information about when and how the transfer settled at the
+        # Federal Reserve.
+        settlement:,
         # The Standard Entry Class (SEC) code of the transfer.
         standard_entry_class_code:,
         # The status of the transfer.
@@ -311,8 +315,6 @@ module Increase
             decline: T.nilable(Increase::InboundACHTransfer::Decline),
             direction: Increase::InboundACHTransfer::Direction::TaggedSymbol,
             effective_date: Date,
-            expected_settlement_schedule:
-              Increase::InboundACHTransfer::ExpectedSettlementSchedule::TaggedSymbol,
             international_addenda:
               T.nilable(Increase::InboundACHTransfer::InternationalAddenda),
             notification_of_change:
@@ -325,6 +327,7 @@ module Increase
             originator_routing_number: String,
             receiver_id_number: T.nilable(String),
             receiver_name: T.nilable(String),
+            settlement: Increase::InboundACHTransfer::Settlement,
             standard_entry_class_code:
               Increase::InboundACHTransfer::StandardEntryClassCode::TaggedSymbol,
             status: Increase::InboundACHTransfer::Status::TaggedSymbol,
@@ -758,44 +761,6 @@ module Increase
         end
       end
 
-      # The settlement schedule the transfer is expected to follow.
-      module ExpectedSettlementSchedule
-        extend Increase::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(
-              Symbol,
-              Increase::InboundACHTransfer::ExpectedSettlementSchedule
-            )
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        # The transfer is expected to settle same-day.
-        SAME_DAY =
-          T.let(
-            :same_day,
-            Increase::InboundACHTransfer::ExpectedSettlementSchedule::TaggedSymbol
-          )
-
-        # The transfer is expected to settle on a future date.
-        FUTURE_DATED =
-          T.let(
-            :future_dated,
-            Increase::InboundACHTransfer::ExpectedSettlementSchedule::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Increase::InboundACHTransfer::ExpectedSettlementSchedule::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
       class InternationalAddenda < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -1552,6 +1517,97 @@ module Increase
         end
       end
 
+      class Settlement < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::InboundACHTransfer::Settlement,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # When the funds for this transfer settle at the recipient bank at the Federal
+        # Reserve.
+        sig { returns(Time) }
+        attr_accessor :settled_at
+
+        # The settlement schedule this transfer follows.
+        sig do
+          returns(
+            Increase::InboundACHTransfer::Settlement::SettlementSchedule::TaggedSymbol
+          )
+        end
+        attr_accessor :settlement_schedule
+
+        # A subhash containing information about when and how the transfer settled at the
+        # Federal Reserve.
+        sig do
+          params(
+            settled_at: Time,
+            settlement_schedule:
+              Increase::InboundACHTransfer::Settlement::SettlementSchedule::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # When the funds for this transfer settle at the recipient bank at the Federal
+          # Reserve.
+          settled_at:,
+          # The settlement schedule this transfer follows.
+          settlement_schedule:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              settled_at: Time,
+              settlement_schedule:
+                Increase::InboundACHTransfer::Settlement::SettlementSchedule::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The settlement schedule this transfer follows.
+        module SettlementSchedule
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::InboundACHTransfer::Settlement::SettlementSchedule
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The transfer is expected to settle same-day.
+          SAME_DAY =
+            T.let(
+              :same_day,
+              Increase::InboundACHTransfer::Settlement::SettlementSchedule::TaggedSymbol
+            )
+
+          # The transfer is expected to settle on a future date.
+          FUTURE_DATED =
+            T.let(
+              :future_dated,
+              Increase::InboundACHTransfer::Settlement::SettlementSchedule::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::InboundACHTransfer::Settlement::SettlementSchedule::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       # The Standard Entry Class (SEC) code of the transfer.
       module StandardEntryClassCode
         extend Increase::Internal::Type::Enum

data/rbi/increase/models/inbound_mail_item.rbi

@@ -12,6 +12,10 @@ module Increase
       sig { returns(String) }
       attr_accessor :id
 
+      # The checks in the mail item.
+      sig { returns(T::Array[Increase::InboundMailItem::Check]) }
+      attr_accessor :checks
+
       # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
       # Mail Item was created.
       sig { returns(Time) }
@@ -51,6 +55,7 @@ module Increase
       sig do
         params(
           id: String,
+          checks: T::Array[Increase::InboundMailItem::Check::OrHash],
           created_at: Time,
           file_id: String,
           lockbox_id: T.nilable(String),
@@ -64,6 +69,8 @@ module Increase
       def self.new(
         # The Inbound Mail Item identifier.
         id:,
+        # The checks in the mail item.
+        checks:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound
         # Mail Item was created.
         created_at:,
@@ -88,6 +95,7 @@ module Increase
         override.returns(
           {
             id: String,
+            checks: T::Array[Increase::InboundMailItem::Check],
             created_at: Time,
             file_id: String,
             lockbox_id: T.nilable(String),
@@ -104,6 +112,55 @@ module Increase
       def to_hash
       end
 
+      class Check < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Increase::InboundMailItem::Check, Increase::Internal::AnyHash)
+          end
+
+        # The amount of the check.
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # The identifier for the File containing the back of the check.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :back_file_id
+
+        # The identifier for the File containing the front of the check.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :front_file_id
+
+        # Inbound Mail Item Checks represent the checks in an Inbound Mail Item.
+        sig do
+          params(
+            amount: Integer,
+            back_file_id: T.nilable(String),
+            front_file_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The amount of the check.
+          amount:,
+          # The identifier for the File containing the back of the check.
+          back_file_id:,
+          # The identifier for the File containing the front of the check.
+          front_file_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              amount: Integer,
+              back_file_id: T.nilable(String),
+              front_file_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       # If the mail item has been rejected, why it was rejected.
       module RejectionReason
         extend Increase::Internal::Type::Enum

data/rbi/increase/models/pending_transaction.rbi

@@ -344,6 +344,27 @@ module Increase
         end
         attr_writer :card_authorization
 
+        # A Card Push Transfer Instruction object. This field will be present in the JSON
+        # response if and only if `category` is equal to `card_push_transfer_instruction`.
+        sig do
+          returns(
+            T.nilable(
+              Increase::PendingTransaction::Source::CardPushTransferInstruction
+            )
+          )
+        end
+        attr_reader :card_push_transfer_instruction
+
+        sig do
+          params(
+            card_push_transfer_instruction:
+              T.nilable(
+                Increase::PendingTransaction::Source::CardPushTransferInstruction::OrHash
+              )
+          ).void
+        end
+        attr_writer :card_push_transfer_instruction
+
         # The type of the resource. We may add additional possible values for this enum
         # over time; your application should be able to handle such additions gracefully.
         sig do
@@ -442,28 +463,6 @@ module Increase
         sig { returns(T.nilable(T.anything)) }
         attr_accessor :other
 
-        # An Outbound Card Push Transfer Instruction object. This field will be present in
-        # the JSON response if and only if `category` is equal to
-        # `outbound_card_push_transfer_instruction`.
-        sig do
-          returns(
-            T.nilable(
-              Increase::PendingTransaction::Source::OutboundCardPushTransferInstruction
-            )
-          )
-        end
-        attr_reader :outbound_card_push_transfer_instruction
-
-        sig do
-          params(
-            outbound_card_push_transfer_instruction:
-              T.nilable(
-                Increase::PendingTransaction::Source::OutboundCardPushTransferInstruction::OrHash
-              )
-          ).void
-        end
-        attr_writer :outbound_card_push_transfer_instruction
-
         # A Real-Time Payments Transfer Instruction object. This field will be present in
         # the JSON response if and only if `category` is equal to
         # `real_time_payments_transfer_instruction`.
@@ -551,6 +550,10 @@ module Increase
               T.nilable(
                 Increase::PendingTransaction::Source::CardAuthorization::OrHash
               ),
+            card_push_transfer_instruction:
+              T.nilable(
+                Increase::PendingTransaction::Source::CardPushTransferInstruction::OrHash
+              ),
             category: Increase::PendingTransaction::Source::Category::OrSymbol,
             check_deposit_instruction:
               T.nilable(
@@ -569,10 +572,6 @@ module Increase
                 Increase::PendingTransaction::Source::InboundWireTransferReversal::OrHash
               ),
             other: T.nilable(T.anything),
-            outbound_card_push_transfer_instruction:
-              T.nilable(
-                Increase::PendingTransaction::Source::OutboundCardPushTransferInstruction::OrHash
-              ),
             real_time_payments_transfer_instruction:
               T.nilable(
                 Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction::OrHash
@@ -600,6 +599,9 @@ module Increase
           # temporary holds placed on a customers funds with the intent to later clear a
           # transaction.
           card_authorization:,
+          # A Card Push Transfer Instruction object. This field will be present in the JSON
+          # response if and only if `category` is equal to `card_push_transfer_instruction`.
+          card_push_transfer_instruction:,
           # The type of the resource. We may add additional possible values for this enum
           # over time; your application should be able to handle such additions gracefully.
           category:,
@@ -622,10 +624,6 @@ module Increase
           # If the category of this Transaction source is equal to `other`, this field will
           # contain an empty object, otherwise it will contain null.
           other:,
-          # An Outbound Card Push Transfer Instruction object. This field will be present in
-          # the JSON response if and only if `category` is equal to
-          # `outbound_card_push_transfer_instruction`.
-          outbound_card_push_transfer_instruction:,
           # A Real-Time Payments Transfer Instruction object. This field will be present in
           # the JSON response if and only if `category` is equal to
           # `real_time_payments_transfer_instruction`.
@@ -658,6 +656,10 @@ module Increase
                 T.nilable(
                   Increase::PendingTransaction::Source::CardAuthorization
                 ),
+              card_push_transfer_instruction:
+                T.nilable(
+                  Increase::PendingTransaction::Source::CardPushTransferInstruction
+                ),
               category:
                 Increase::PendingTransaction::Source::Category::TaggedSymbol,
               check_deposit_instruction:
@@ -677,10 +679,6 @@ module Increase
                   Increase::PendingTransaction::Source::InboundWireTransferReversal
                 ),
               other: T.nilable(T.anything),
-              outbound_card_push_transfer_instruction:
-                T.nilable(
-                  Increase::PendingTransaction::Source::OutboundCardPushTransferInstruction
-                ),
               real_time_payments_transfer_instruction:
                 T.nilable(
                   Increase::PendingTransaction::Source::RealTimePaymentsTransferInstruction
@@ -2292,6 +2290,43 @@ module Increase
           end
         end
 
+        class CardPushTransferInstruction < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::PendingTransaction::Source::CardPushTransferInstruction,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The transfer amount in USD cents.
+          sig { returns(Integer) }
+          attr_accessor :amount
+
+          # The identifier of the Card Push Transfer that led to this Pending Transaction.
+          sig { returns(String) }
+          attr_accessor :transfer_id
+
+          # A Card Push Transfer Instruction object. This field will be present in the JSON
+          # response if and only if `category` is equal to `card_push_transfer_instruction`.
+          sig do
+            params(amount: Integer, transfer_id: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The transfer amount in USD cents.
+            amount:,
+            # The identifier of the Card Push Transfer that led to this Pending Transaction.
+            transfer_id:
+          )
+          end
+
+          sig { override.returns({ amount: Integer, transfer_id: String }) }
+          def to_hash
+          end
+        end
+
         # The type of the resource. We may add additional possible values for this enum
         # over time; your application should be able to handle such additions gracefully.
         module Category
@@ -2380,10 +2415,10 @@ module Increase
               Increase::PendingTransaction::Source::Category::TaggedSymbol
             )
 
-          # Outbound Card Push Transfer Instruction: details will be under the `outbound_card_push_transfer_instruction` object.
-          OUTBOUND_CARD_PUSH_TRANSFER_INSTRUCTION =
+          # Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.
+          CARD_PUSH_TRANSFER_INSTRUCTION =
             T.let(
-              :outbound_card_push_transfer_instruction,
+              :card_push_transfer_instruction,
               Increase::PendingTransaction::Source::Category::TaggedSymbol
             )
 
@@ -2987,46 +3022,6 @@ module Increase
           end
         end
 
-        class OutboundCardPushTransferInstruction < Increase::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Increase::PendingTransaction::Source::OutboundCardPushTransferInstruction,
-                Increase::Internal::AnyHash
-              )
-            end
-
-          # The transfer amount in USD cents.
-          sig { returns(Integer) }
-          attr_accessor :amount
-
-          # The identifier of the Outbound Card Push Transfer that led to this Pending
-          # Transaction.
-          sig { returns(String) }
-          attr_accessor :transfer_id
-
-          # An Outbound Card Push Transfer Instruction object. This field will be present in
-          # the JSON response if and only if `category` is equal to
-          # `outbound_card_push_transfer_instruction`.
-          sig do
-            params(amount: Integer, transfer_id: String).returns(
-              T.attached_class
-            )
-          end
-          def self.new(
-            # The transfer amount in USD cents.
-            amount:,
-            # The identifier of the Outbound Card Push Transfer that led to this Pending
-            # Transaction.
-            transfer_id:
-          )
-          end
-
-          sig { override.returns({ amount: Integer, transfer_id: String }) }
-          def to_hash
-          end
-        end
-
         class RealTimePaymentsTransferInstruction < Increase::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/increase/models/pending_transaction_list_params.rbi

@@ -272,10 +272,10 @@ module Increase
               Increase::PendingTransactionListParams::Category::In::TaggedSymbol
             )
 
-          # Outbound Card Push Transfer Instruction: details will be under the `outbound_card_push_transfer_instruction` object.
-          OUTBOUND_CARD_PUSH_TRANSFER_INSTRUCTION =
+          # Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.
+          CARD_PUSH_TRANSFER_INSTRUCTION =
             T.let(
-              :outbound_card_push_transfer_instruction,
+              :card_push_transfer_instruction,
               Increase::PendingTransactionListParams::Category::In::TaggedSymbol
             )