increase 1.0.0 → 1.1.0

data/rbi/increase/models/check_transfer_create_params.rbi

@@ -231,6 +231,30 @@ module Increase
         sig { params(note: String).void }
         attr_writer :note
 
+        # The payer of the check. This will be printed on the top-left portion of the
+        # check and defaults to the return address if unspecified. This should be an array
+        # of up to 4 elements, each of which represents a line of the payer.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Increase::CheckTransferCreateParams::PhysicalCheck::Payer
+              ]
+            )
+          )
+        end
+        attr_reader :payer
+
+        sig do
+          params(
+            payer:
+              T::Array[
+                Increase::CheckTransferCreateParams::PhysicalCheck::Payer::OrHash
+              ]
+          ).void
+        end
+        attr_writer :payer
+
         # The return address to be printed on the check. If omitted this will default to
         # an Increase-owned address that will mark checks as delivery failed and shred
         # them.
@@ -289,6 +313,10 @@ module Increase
             recipient_name: String,
             attachment_file_id: String,
             note: String,
+            payer:
+              T::Array[
+                Increase::CheckTransferCreateParams::PhysicalCheck::Payer::OrHash
+              ],
             return_address:
               Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress::OrHash,
             shipping_method:
@@ -309,6 +337,10 @@ module Increase
           attachment_file_id: nil,
           # The descriptor that will be printed on the letter included with the check.
           note: nil,
+          # The payer of the check. This will be printed on the top-left portion of the
+          # check and defaults to the return address if unspecified. This should be an array
+          # of up to 4 elements, each of which represents a line of the payer.
+          payer: nil,
           # The return address to be printed on the check. If omitted this will default to
           # an Increase-owned address that will mark checks as delivery failed and shred
           # them.
@@ -331,6 +363,10 @@ module Increase
               recipient_name: String,
               attachment_file_id: String,
               note: String,
+              payer:
+                T::Array[
+                  Increase::CheckTransferCreateParams::PhysicalCheck::Payer
+                ],
               return_address:
                 Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
               shipping_method:
@@ -413,6 +449,31 @@ module Increase
           end
         end
 
+        class Payer < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::CheckTransferCreateParams::PhysicalCheck::Payer,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The contents of the line.
+          sig { returns(String) }
+          attr_accessor :contents
+
+          sig { params(contents: String).returns(T.attached_class) }
+          def self.new(
+            # The contents of the line.
+            contents:
+          )
+          end
+
+          sig { override.returns({ contents: String }) }
+          def to_hash
+          end
+        end
+
         class ReturnAddress < Increase::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -545,7 +606,7 @@ module Increase
 
         # The pay-to name you will print on the check. If provided, this is used for
         # [Positive Pay](/documentation/positive-pay). If this is omitted, Increase will
-        # be unable to validate the payee name when the check is deposited.
+        # be unable to validate the payer name when the check is deposited.
         sig { returns(T.nilable(String)) }
         attr_reader :recipient_name
 
@@ -559,7 +620,7 @@ module Increase
         def self.new(
           # The pay-to name you will print on the check. If provided, this is used for
           # [Positive Pay](/documentation/positive-pay). If this is omitted, Increase will
-          # be unable to validate the payee name when the check is deposited.
+          # be unable to validate the payer name when the check is deposited.
           recipient_name: nil
         )
         end

data/rbi/increase/models/event.rbi

@@ -493,34 +493,62 @@ module Increase
             Increase::Event::Category::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::Event::Category::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::Event::Category::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::Event::Category::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::Event::Category::TaggedSymbol
           )
 
+        # Occurs whenever a Card Push Transfer is created.
+        CARD_PUSH_TRANSFER_CREATED =
+          T.let(
+            :"card_push_transfer.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Push Transfer is updated.
+        CARD_PUSH_TRANSFER_UPDATED =
+          T.let(
+            :"card_push_transfer.updated",
+            Increase::Event::Category::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Validation is created.
+        CARD_VALIDATION_CREATED =
+          T.let(
+            :"card_validation.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Validation is updated.
+        CARD_VALIDATION_UPDATED =
+          T.let(
+            :"card_validation.updated",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever a Pending Transaction is created.
         PENDING_TRANSACTION_CREATED =
           T.let(
@@ -640,6 +668,20 @@ module Increase
             Increase::Event::Category::TaggedSymbol
           )
 
+        # Occurs whenever a Swift Transfer is created.
+        SWIFT_TRANSFER_CREATED =
+          T.let(
+            :"swift_transfer.created",
+            Increase::Event::Category::TaggedSymbol
+          )
+
+        # Occurs whenever a Swift Transfer is updated.
+        SWIFT_TRANSFER_UPDATED =
+          T.let(
+            :"swift_transfer.updated",
+            Increase::Event::Category::TaggedSymbol
+          )
+
         # Occurs whenever a Transaction is created.
         TRANSACTION_CREATED =
           T.let(:"transaction.created", Increase::Event::Category::TaggedSymbol)

data/rbi/increase/models/event_list_params.rbi

@@ -592,34 +592,62 @@ module Increase
               Increase::EventListParams::Category::In::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::EventListParams::Category::In::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::EventListParams::Category::In::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::EventListParams::Category::In::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::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a Card Push Transfer is created.
+          CARD_PUSH_TRANSFER_CREATED =
+            T.let(
+              :"card_push_transfer.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
+          # Occurs whenever a Card Push Transfer is updated.
+          CARD_PUSH_TRANSFER_UPDATED =
+            T.let(
+              :"card_push_transfer.updated",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
+          # Occurs whenever a Card Validation is created.
+          CARD_VALIDATION_CREATED =
+            T.let(
+              :"card_validation.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
+          # Occurs whenever a Card Validation is updated.
+          CARD_VALIDATION_UPDATED =
+            T.let(
+              :"card_validation.updated",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever a Pending Transaction is created.
           PENDING_TRANSACTION_CREATED =
             T.let(
@@ -739,6 +767,20 @@ module Increase
               Increase::EventListParams::Category::In::TaggedSymbol
             )
 
+          # Occurs whenever a Swift Transfer is created.
+          SWIFT_TRANSFER_CREATED =
+            T.let(
+              :"swift_transfer.created",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
+          # Occurs whenever a Swift Transfer is updated.
+          SWIFT_TRANSFER_UPDATED =
+            T.let(
+              :"swift_transfer.updated",
+              Increase::EventListParams::Category::In::TaggedSymbol
+            )
+
           # Occurs whenever a Transaction is created.
           TRANSACTION_CREATED =
             T.let(

data/rbi/increase/models/event_subscription.rbi

@@ -576,34 +576,62 @@ module Increase
             Increase::EventSubscription::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::EventSubscription::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::EventSubscription::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::EventSubscription::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::EventSubscription::SelectedEventCategory::TaggedSymbol
           )
 
+        # Occurs whenever a Card Push Transfer is created.
+        CARD_PUSH_TRANSFER_CREATED =
+          T.let(
+            :"card_push_transfer.created",
+            Increase::EventSubscription::SelectedEventCategory::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Push Transfer is updated.
+        CARD_PUSH_TRANSFER_UPDATED =
+          T.let(
+            :"card_push_transfer.updated",
+            Increase::EventSubscription::SelectedEventCategory::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Validation is created.
+        CARD_VALIDATION_CREATED =
+          T.let(
+            :"card_validation.created",
+            Increase::EventSubscription::SelectedEventCategory::TaggedSymbol
+          )
+
+        # Occurs whenever a Card Validation is updated.
+        CARD_VALIDATION_UPDATED =
+          T.let(
+            :"card_validation.updated",
+            Increase::EventSubscription::SelectedEventCategory::TaggedSymbol
+          )
+
         # Occurs whenever a Pending Transaction is created.
         PENDING_TRANSACTION_CREATED =
           T.let(
@@ -723,6 +751,20 @@ module Increase
             Increase::EventSubscription::SelectedEventCategory::TaggedSymbol
           )
 
+        # Occurs whenever a Swift Transfer is created.
+        SWIFT_TRANSFER_CREATED =
+          T.let(
+            :"swift_transfer.created",
+            Increase::EventSubscription::SelectedEventCategory::TaggedSymbol
+          )
+
+        # Occurs whenever a Swift Transfer is updated.
+        SWIFT_TRANSFER_UPDATED =
+          T.let(
+            :"swift_transfer.updated",
+            Increase::EventSubscription::SelectedEventCategory::TaggedSymbol
+          )
+
         # Occurs whenever a Transaction is created.
         TRANSACTION_CREATED =
           T.let(

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/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