increase 1.360.0 → 1.362.0

data/rbi/increase/models/ach_transfer_create_params.rbi

@@ -11,13 +11,18 @@ module Increase
           T.any(Increase::ACHTransferCreateParams, Increase::Internal::AnyHash)
         end
 
-      # The Increase identifier for the account that will send the transfer.
+      # The Increase identifier for the account that will originate the transfer. For
+      # credit transfers (transfers with a positive `amount`), this is the account that
+      # funds will be sent from. For debit transfers (transfers with a negative
+      # `amount`), this is the account that funds will be pulled into.
       sig { returns(String) }
       attr_accessor :account_id
 
       # The transfer amount in USD cents. A positive amount originates a credit transfer
-      # pushing funds to the receiving account. A negative amount originates a debit
-      # transfer pulling funds from the receiving account.
+      # pushing funds from Increase to the account at the other bank. A negative amount
+      # originates a debit transfer pulling funds from the account at the other bank
+      # into Increase. Debit transfers
+      # [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
       sig { returns(Integer) }
       attr_accessor :amount
 
@@ -30,9 +35,10 @@ module Increase
       sig { returns(String) }
       attr_accessor :statement_descriptor
 
-      # The receiver's account number. For credit transfers (positive `amount`) this is
-      # the account that funds will be sent to. For debit transfers (negative `amount`)
-      # this is the account that funds will be pulled from.
+      # The receiver's account number. For credit transfers (transfers with a positive
+      # `amount`), this is the account that funds will be sent to. For debit transfers
+      # (transfers with a negative `amount`), this is the account that funds will be
+      # pulled from.
       sig { returns(T.nilable(String)) }
       attr_reader :account_number
 
@@ -60,29 +66,34 @@ module Increase
       sig { params(company_descriptive_date: String).void }
       attr_writer :company_descriptive_date
 
-      # Custom data sent in the company batch header. This value is informational and
-      # does not affect funds movement, settlement timing, or returns. Most ACH
-      # transfers do not need this. Only set this if your recipient has asked for it.
+      # Custom data sent in the company batch header, meant as metadata for the
+      # originator. This value is informational and does not affect funds movement,
+      # settlement timing, or returns. Most ACH transfers do not need this; we recommend
+      # storing metadata in your own application instead.
       sig { returns(T.nilable(String)) }
       attr_reader :company_discretionary_data
 
       sig { params(company_discretionary_data: String).void }
       attr_writer :company_discretionary_data
 
-      # A short description sent in the company batch header. Most receivers do not
-      # surface this. Only set this if your recipient has asked for a specific value or
-      # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
-      # example, Prearranged Payment and Deposit (PPD) payroll credits must use
-      # `PAYROLL`, and reversals must use `REVERSAL`.
+      # A short description sent in the company batch header, meant to provide the
+      # receiver with a reason for the transfer. Many receivers do not surface this data
+      # on the receiver's bank statement. Only set this if your recipient has asked for
+      # a specific value or if Nacha mandates one for your Standard Entry Class (SEC)
+      # code and use case. For example, some use cases require constants like
+      # `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
       sig { returns(T.nilable(String)) }
       attr_reader :company_entry_description
 
       sig { params(company_entry_description: String).void }
       attr_writer :company_entry_description
 
-      # The name by which the recipient knows you, sent in the company batch header. We
-      # recommend setting this on every transfer; if you do not, we fall back to the ACH
-      # company name configured on your account.
+      # The name by which the recipient knows the counterparty of this transaction. If
+      # you're processing payments on behalf of another party, use their name, not your
+      # own, so that it's more likely the recipient understands the context of the
+      # payment. This value is usually displayed to the recipient on their bank
+      # statement. We recommend setting this on every transfer; if you do not, we fall
+      # back to the `statement_descriptor`.
       sig { returns(T.nilable(String)) }
       attr_reader :company_name
 
@@ -130,16 +141,20 @@ module Increase
       end
       attr_writer :funding
 
-      # Your internal identifier for the transfer recipient. This value is informational
-      # and not verified by the recipient's bank. Most callers can leave this unset.
+      # Your internal identifier for the recipient. This value is informational and
+      # generally not verified by the recipient's bank. Most callers can leave this
+      # unset. For the specific case of person-to-person credits with the WEB standard
+      # entry class code, this must include the name of the payer.
       sig { returns(T.nilable(String)) }
       attr_reader :individual_id
 
       sig { params(individual_id: String).void }
       attr_writer :individual_id
 
-      # The name of the transfer recipient. This value is informational and not verified
-      # by the recipient's bank.
+      # The name of the transfer recipient. This value is informational and generally
+      # not verified by the recipient's bank. This value is usually displayed to the
+      # recipient on their bank statement. We recommend setting this on every transfer;
+      # if you do not, we fall back to the `statement_descriptor`.
       sig { returns(T.nilable(String)) }
       attr_reader :individual_name
 
@@ -228,11 +243,16 @@ module Increase
         ).returns(T.attached_class)
       end
       def self.new(
-        # The Increase identifier for the account that will send the transfer.
+        # The Increase identifier for the account that will originate the transfer. For
+        # credit transfers (transfers with a positive `amount`), this is the account that
+        # funds will be sent from. For debit transfers (transfers with a negative
+        # `amount`), this is the account that funds will be pulled into.
         account_id:,
         # The transfer amount in USD cents. A positive amount originates a credit transfer
-        # pushing funds to the receiving account. A negative amount originates a debit
-        # transfer pulling funds from the receiving account.
+        # pushing funds from Increase to the account at the other bank. A negative amount
+        # originates a debit transfer pulling funds from the account at the other bank
+        # into Increase. Debit transfers
+        # [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
         amount:,
         # A description you choose to give the transfer. This will be saved with the
         # transfer details, displayed in the dashboard, and returned by the API. If
@@ -241,9 +261,10 @@ module Increase
         # help the customer recognize the transfer. You are highly encouraged to pass
         # `individual_name` and `company_name` instead of relying on this fallback.
         statement_descriptor:,
-        # The receiver's account number. For credit transfers (positive `amount`) this is
-        # the account that funds will be sent to. For debit transfers (negative `amount`)
-        # this is the account that funds will be pulled from.
+        # The receiver's account number. For credit transfers (transfers with a positive
+        # `amount`), this is the account that funds will be sent to. For debit transfers
+        # (transfers with a negative `amount`), this is the account that funds will be
+        # pulled from.
         account_number: nil,
         # Additional information passed through to the receiving bank with the transfer.
         # Most ACH transfers do not need this. Only set this if your recipient has asked
@@ -254,19 +275,24 @@ module Increase
         # batch header. This value is informational and does not affect funds movement,
         # settlement timing, or returns. Only set this if your recipient has asked for it.
         company_descriptive_date: nil,
-        # Custom data sent in the company batch header. This value is informational and
-        # does not affect funds movement, settlement timing, or returns. Most ACH
-        # transfers do not need this. Only set this if your recipient has asked for it.
+        # Custom data sent in the company batch header, meant as metadata for the
+        # originator. This value is informational and does not affect funds movement,
+        # settlement timing, or returns. Most ACH transfers do not need this; we recommend
+        # storing metadata in your own application instead.
         company_discretionary_data: nil,
-        # A short description sent in the company batch header. Most receivers do not
-        # surface this. Only set this if your recipient has asked for a specific value or
-        # if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For
-        # example, Prearranged Payment and Deposit (PPD) payroll credits must use
-        # `PAYROLL`, and reversals must use `REVERSAL`.
+        # A short description sent in the company batch header, meant to provide the
+        # receiver with a reason for the transfer. Many receivers do not surface this data
+        # on the receiver's bank statement. Only set this if your recipient has asked for
+        # a specific value or if Nacha mandates one for your Standard Entry Class (SEC)
+        # code and use case. For example, some use cases require constants like
+        # `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
         company_entry_description: nil,
-        # The name by which the recipient knows you, sent in the company batch header. We
-        # recommend setting this on every transfer; if you do not, we fall back to the ACH
-        # company name configured on your account.
+        # The name by which the recipient knows the counterparty of this transaction. If
+        # you're processing payments on behalf of another party, use their name, not your
+        # own, so that it's more likely the recipient understands the context of the
+        # payment. This value is usually displayed to the recipient on their bank
+        # statement. We recommend setting this on every transfer; if you do not, we fall
+        # back to the `statement_descriptor`.
         company_name: nil,
         # The type of entity that owns the receiver's account.
         destination_account_holder: nil,
@@ -277,11 +303,15 @@ module Increase
         #
         # Defaults to `checking`.
         funding: nil,
-        # Your internal identifier for the transfer recipient. This value is informational
-        # and not verified by the recipient's bank. Most callers can leave this unset.
+        # Your internal identifier for the recipient. This value is informational and
+        # generally not verified by the recipient's bank. Most callers can leave this
+        # unset. For the specific case of person-to-person credits with the WEB standard
+        # entry class code, this must include the name of the payer.
         individual_id: nil,
-        # The name of the transfer recipient. This value is informational and not verified
-        # by the recipient's bank.
+        # The name of the transfer recipient. This value is informational and generally
+        # not verified by the recipient's bank. This value is usually displayed to the
+        # recipient on their bank statement. We recommend setting this on every transfer;
+        # if you do not, we fall back to the `statement_descriptor`.
         individual_name: nil,
         # Configuration for how the effective date of the transfer will be set. This
         # determines same-day vs future-dated settlement timing. If not set, defaults to a

data/rbi/increase/models/digital_card_profile.rbi

@@ -16,6 +16,17 @@ module Increase
       sig { returns(String) }
       attr_accessor :app_icon_file_id
 
+      # Apple Pay specific settings for the Card Profile.
+      sig { returns(T.nilable(Increase::DigitalCardProfile::ApplePay)) }
+      attr_reader :apple_pay
+
+      sig do
+        params(
+          apple_pay: T.nilable(Increase::DigitalCardProfile::ApplePay::OrHash)
+        ).void
+      end
+      attr_writer :apple_pay
+
       # The identifier of the File containing the card's front image.
       sig { returns(String) }
       attr_accessor :background_image_file_id
@@ -81,6 +92,7 @@ module Increase
         params(
           id: String,
           app_icon_file_id: String,
+          apple_pay: T.nilable(Increase::DigitalCardProfile::ApplePay::OrHash),
           background_image_file_id: String,
           card_description: String,
           contact_email: T.nilable(String),
@@ -100,6 +112,8 @@ module Increase
         id:,
         # The identifier of the File containing the card's icon image.
         app_icon_file_id:,
+        # Apple Pay specific settings for the Card Profile.
+        apple_pay:,
         # The identifier of the File containing the card's front image.
         background_image_file_id:,
         # A user-facing description for the card itself.
@@ -137,6 +151,7 @@ module Increase
           {
             id: String,
             app_icon_file_id: String,
+            apple_pay: T.nilable(Increase::DigitalCardProfile::ApplePay),
             background_image_file_id: String,
             card_description: String,
             contact_email: T.nilable(String),
@@ -155,6 +170,128 @@ module Increase
       def to_hash
       end
 
+      class ApplePay < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::DigitalCardProfile::ApplePay,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The applications associated with cards using this Card Profile.
+        sig do
+          returns(
+            T::Array[
+              Increase::DigitalCardProfile::ApplePay::AssociatedApplicationIdentifier
+            ]
+          )
+        end
+        attr_accessor :associated_application_identifiers
+
+        # The App Store listings of the applications associated with cards using this Card
+        # Profile.
+        sig do
+          returns(
+            T::Array[
+              Increase::DigitalCardProfile::ApplePay::AssociatedStoreIdentifier
+            ]
+          )
+        end
+        attr_accessor :associated_store_identifiers
+
+        # Apple Pay specific settings for the Card Profile.
+        sig do
+          params(
+            associated_application_identifiers:
+              T::Array[
+                Increase::DigitalCardProfile::ApplePay::AssociatedApplicationIdentifier::OrHash
+              ],
+            associated_store_identifiers:
+              T::Array[
+                Increase::DigitalCardProfile::ApplePay::AssociatedStoreIdentifier::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The applications associated with cards using this Card Profile.
+          associated_application_identifiers:,
+          # The App Store listings of the applications associated with cards using this Card
+          # Profile.
+          associated_store_identifiers:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              associated_application_identifiers:
+                T::Array[
+                  Increase::DigitalCardProfile::ApplePay::AssociatedApplicationIdentifier
+                ],
+              associated_store_identifiers:
+                T::Array[
+                  Increase::DigitalCardProfile::ApplePay::AssociatedStoreIdentifier
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class AssociatedApplicationIdentifier < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::DigitalCardProfile::ApplePay::AssociatedApplicationIdentifier,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The application identifier, composed of your Apple Developer Team ID and the
+          # application's bundle identifier, like `ABCDE12345.com.example.app`.
+          sig { returns(String) }
+          attr_accessor :identifier
+
+          sig { params(identifier: String).returns(T.attached_class) }
+          def self.new(
+            # The application identifier, composed of your Apple Developer Team ID and the
+            # application's bundle identifier, like `ABCDE12345.com.example.app`.
+            identifier:
+          )
+          end
+
+          sig { override.returns({ identifier: String }) }
+          def to_hash
+          end
+        end
+
+        class AssociatedStoreIdentifier < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::DigitalCardProfile::ApplePay::AssociatedStoreIdentifier,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The numeric App Store identifier.
+          sig { returns(String) }
+          attr_accessor :identifier
+
+          sig { params(identifier: String).returns(T.attached_class) }
+          def self.new(
+            # The numeric App Store identifier.
+            identifier:
+          )
+          end
+
+          sig { override.returns({ identifier: String }) }
+          def to_hash
+          end
+        end
+      end
+
       # The status of the Card Profile.
       module Status
         extend Increase::Internal::Type::Enum

data/rbi/increase/models/digital_card_profile_clone_params.rbi

@@ -25,6 +25,20 @@ module Increase
       sig { params(app_icon_file_id: String).void }
       attr_writer :app_icon_file_id
 
+      # Apple Pay specific settings for the Card Profile. Each list you leave out is
+      # copied from the original Card Profile.
+      sig do
+        returns(T.nilable(Increase::DigitalCardProfileCloneParams::ApplePay))
+      end
+      attr_reader :apple_pay
+
+      sig do
+        params(
+          apple_pay: Increase::DigitalCardProfileCloneParams::ApplePay::OrHash
+        ).void
+      end
+      attr_writer :apple_pay
+
       # The identifier of the File containing the card's front image.
       sig { returns(T.nilable(String)) }
       attr_reader :background_image_file_id
@@ -92,6 +106,7 @@ module Increase
         params(
           digital_card_profile_id: String,
           app_icon_file_id: String,
+          apple_pay: Increase::DigitalCardProfileCloneParams::ApplePay::OrHash,
           background_image_file_id: String,
           card_description: String,
           contact_email: String,
@@ -109,6 +124,9 @@ module Increase
         digital_card_profile_id:,
         # The identifier of the File containing the card's icon image.
         app_icon_file_id: nil,
+        # Apple Pay specific settings for the Card Profile. Each list you leave out is
+        # copied from the original Card Profile.
+        apple_pay: nil,
         # The identifier of the File containing the card's front image.
         background_image_file_id: nil,
         # A user-facing description for the card itself.
@@ -135,6 +153,7 @@ module Increase
           {
             digital_card_profile_id: String,
             app_icon_file_id: String,
+            apple_pay: Increase::DigitalCardProfileCloneParams::ApplePay,
             background_image_file_id: String,
             card_description: String,
             contact_email: String,
@@ -150,6 +169,153 @@ module Increase
       def to_hash
       end
 
+      class ApplePay < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::DigitalCardProfileCloneParams::ApplePay,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The applications to associate with cards using this Card Profile.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedApplicationIdentifier
+              ]
+            )
+          )
+        end
+        attr_reader :associated_application_identifiers
+
+        sig do
+          params(
+            associated_application_identifiers:
+              T::Array[
+                Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedApplicationIdentifier::OrHash
+              ]
+          ).void
+        end
+        attr_writer :associated_application_identifiers
+
+        # The App Store listings of the applications to associate with cards using this
+        # Card Profile.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedStoreIdentifier
+              ]
+            )
+          )
+        end
+        attr_reader :associated_store_identifiers
+
+        sig do
+          params(
+            associated_store_identifiers:
+              T::Array[
+                Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedStoreIdentifier::OrHash
+              ]
+          ).void
+        end
+        attr_writer :associated_store_identifiers
+
+        # Apple Pay specific settings for the Card Profile. Each list you leave out is
+        # copied from the original Card Profile.
+        sig do
+          params(
+            associated_application_identifiers:
+              T::Array[
+                Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedApplicationIdentifier::OrHash
+              ],
+            associated_store_identifiers:
+              T::Array[
+                Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedStoreIdentifier::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The applications to associate with cards using this Card Profile.
+          associated_application_identifiers: nil,
+          # The App Store listings of the applications to associate with cards using this
+          # Card Profile.
+          associated_store_identifiers: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              associated_application_identifiers:
+                T::Array[
+                  Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedApplicationIdentifier
+                ],
+              associated_store_identifiers:
+                T::Array[
+                  Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedStoreIdentifier
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class AssociatedApplicationIdentifier < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedApplicationIdentifier,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The application identifier, composed of your Apple Developer Team ID and the
+          # application's bundle identifier, like `ABCDE12345.com.example.app`.
+          sig { returns(String) }
+          attr_accessor :identifier
+
+          sig { params(identifier: String).returns(T.attached_class) }
+          def self.new(
+            # The application identifier, composed of your Apple Developer Team ID and the
+            # application's bundle identifier, like `ABCDE12345.com.example.app`.
+            identifier:
+          )
+          end
+
+          sig { override.returns({ identifier: String }) }
+          def to_hash
+          end
+        end
+
+        class AssociatedStoreIdentifier < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::DigitalCardProfileCloneParams::ApplePay::AssociatedStoreIdentifier,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The numeric App Store identifier.
+          sig { returns(String) }
+          attr_accessor :identifier
+
+          sig { params(identifier: String).returns(T.attached_class) }
+          def self.new(
+            # The numeric App Store identifier.
+            identifier:
+          )
+          end
+
+          sig { override.returns({ identifier: String }) }
+          def to_hash
+          end
+        end
+      end
+
       class TextColor < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do