increase 1.364.0 → 1.366.0

data/lib/increase/resources/ach_transfers.rb

@@ -10,7 +10,7 @@ module Increase
       # You should set both of these, in addition to the required amount and account
       # fields.
       #
-      # @overload create(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
+      # @overload create(account_id:, amount:, company_name:, individual_name:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
       #
       # @param account_id [String]
       #   The Increase identifier for the account that will originate the transfer. For
@@ -25,13 +25,20 @@ module Increase
       #   into Increase. Debit transfers
       #   [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
       #
-      # @param statement_descriptor [String]
-      #   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
-      #   `individual_name` and `company_name` are not explicitly set by this API, the
-      #   `statement_descriptor` will be sent in those fields to the receiving bank to
-      #   help the customer recognize the transfer. You are highly encouraged to pass
-      #   `individual_name` and `company_name` instead of relying on this fallback.
+      # @param company_name [String]
+      #   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.
+      #
+      # @param individual_name [String]
+      #   The name of the transfer recipient. This value is informational and generally
+      #   not verified by the recipient's bank. The business-to-business
+      #   [Standard Entry Class (SEC) codes](/documentation/ach-standard-entry-class-codes)
+      #   call this "individual name or receiving company name;" it's reasonable to
+      #   include a business name in this field. This value is usually displayed to the
+      #   recipient on their bank statement.
       #
       # @param account_number [String]
       #   The receiver's account number. For credit transfers (transfers with a positive
@@ -64,14 +71,6 @@ module Increase
       #   code and use case. For example, some use cases require constants like
       #   `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
       #
-      # @param company_name [String]
-      #   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`.
-      #
       # @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder]
       #   The type of entity that owns the receiver's account.
       #
@@ -90,12 +89,6 @@ module Increase
       #   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.
       #
-      # @param individual_name [String]
-      #   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`.
-      #
       # @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
       #   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/lib/increase/resources/cards.rb

@@ -12,7 +12,10 @@ module Increase
       # @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
       #   Controls that restrict how this card can be used.
       #
-      # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
+      # @param billing_address [Increase::Models::CardCreateParams::BillingAddress]
+      #   The card's billing address. This is used in card authorizations to
+      #   [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+      #   If not provided, the address associated with the account's entity will be used.
       #
       # @param cardholder_name [Increase::Models::CardCreateParams::CardholderName]
       #   The name of the cardholder. Used to respond to Account Name Inquiry requests
@@ -75,7 +78,9 @@ module Increase
       #   Controls that restrict how this card can be used.
       #
       # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress]
-      #   The card's updated billing address.
+      #   The card's billing address. This is used in card authorizations to
+      #   [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+      #   If not provided, the address associated with the account's entity will be used.
       #
       # @param description [String] The description you choose to give the card.
       #

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.364.0"
+  VERSION = "1.366.0"
 end

data/rbi/increase/models/ach_transfer.rbi

@@ -229,7 +229,10 @@ module Increase
       end
       attr_accessor :standard_entry_class_code
 
-      # The descriptor that will show on the recipient's bank statement.
+      # A description you chose to give the transfer. If `individual_name` and
+      # `company_name` were not explicitly set, the `statement_descriptor` will be sent
+      # in those fields to the receiving bank to help the customer recognize the
+      # transfer.
       sig { returns(T.nilable(String)) }
       attr_accessor :statement_descriptor
 
@@ -403,7 +406,10 @@ module Increase
         # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
         # to use for the transfer.
         standard_entry_class_code:,
-        # The descriptor that will show on the recipient's bank statement.
+        # A description you chose to give the transfer. If `individual_name` and
+        # `company_name` were not explicitly set, the `statement_descriptor` will be sent
+        # in those fields to the receiving bank to help the customer recognize the
+        # transfer.
         statement_descriptor:,
         # The lifecycle status of the transfer.
         status:,

data/rbi/increase/models/ach_transfer_create_params.rbi

@@ -26,14 +26,22 @@ module Increase
       sig { returns(Integer) }
       attr_accessor :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
-      # `individual_name` and `company_name` are not explicitly set by this API, the
-      # `statement_descriptor` will be sent in those fields to the receiving bank to
-      # help the customer recognize the transfer. You are highly encouraged to pass
-      # `individual_name` and `company_name` instead of relying on this fallback.
+      # 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.
       sig { returns(String) }
-      attr_accessor :statement_descriptor
+      attr_accessor :company_name
+
+      # The name of the transfer recipient. This value is informational and generally
+      # not verified by the recipient's bank. The business-to-business
+      # [Standard Entry Class (SEC) codes](/documentation/ach-standard-entry-class-codes)
+      # call this "individual name or receiving company name;" it's reasonable to
+      # include a business name in this field. This value is usually displayed to the
+      # recipient on their bank statement.
+      sig { returns(String) }
+      attr_accessor :individual_name
 
       # 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
@@ -88,18 +96,6 @@ module Increase
       sig { params(company_entry_description: String).void }
       attr_writer :company_entry_description
 
-      # 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
-
-      sig { params(company_name: String).void }
-      attr_writer :company_name
-
       # The type of entity that owns the receiver's account.
       sig do
         returns(
@@ -151,16 +147,6 @@ module Increase
       sig { params(individual_id: String).void }
       attr_writer :individual_id
 
-      # 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
-
-      sig { params(individual_name: String).void }
-      attr_writer :individual_name
-
       # 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
       # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
@@ -220,19 +206,18 @@ module Increase
         params(
           account_id: String,
           amount: Integer,
-          statement_descriptor: String,
+          company_name: String,
+          individual_name: String,
           account_number: String,
           addenda: Increase::ACHTransferCreateParams::Addenda::OrHash,
           company_descriptive_date: String,
           company_discretionary_data: String,
           company_entry_description: String,
-          company_name: String,
           destination_account_holder:
             Increase::ACHTransferCreateParams::DestinationAccountHolder::OrSymbol,
           external_account_id: String,
           funding: Increase::ACHTransferCreateParams::Funding::OrSymbol,
           individual_id: String,
-          individual_name: String,
           preferred_effective_date:
             Increase::ACHTransferCreateParams::PreferredEffectiveDate::OrHash,
           require_approval: T::Boolean,
@@ -254,13 +239,19 @@ module Increase
         # 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
-        # `individual_name` and `company_name` are not explicitly set by this API, the
-        # `statement_descriptor` will be sent in those fields to the receiving bank to
-        # 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 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.
+        company_name:,
+        # The name of the transfer recipient. This value is informational and generally
+        # not verified by the recipient's bank. The business-to-business
+        # [Standard Entry Class (SEC) codes](/documentation/ach-standard-entry-class-codes)
+        # call this "individual name or receiving company name;" it's reasonable to
+        # include a business name in this field. This value is usually displayed to the
+        # recipient on their bank statement.
+        individual_name:,
         # 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
@@ -287,13 +278,6 @@ module Increase
         # 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 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,
         # The ID of an External Account to initiate a transfer to. If this parameter is
@@ -308,11 +292,6 @@ module Increase
         # 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 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
         # `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
@@ -337,19 +316,18 @@ module Increase
           {
             account_id: String,
             amount: Integer,
-            statement_descriptor: String,
+            company_name: String,
+            individual_name: String,
             account_number: String,
             addenda: Increase::ACHTransferCreateParams::Addenda,
             company_descriptive_date: String,
             company_discretionary_data: String,
             company_entry_description: String,
-            company_name: String,
             destination_account_holder:
               Increase::ACHTransferCreateParams::DestinationAccountHolder::OrSymbol,
             external_account_id: String,
             funding: Increase::ACHTransferCreateParams::Funding::OrSymbol,
             individual_id: String,
-            individual_name: String,
             preferred_effective_date:
               Increase::ACHTransferCreateParams::PreferredEffectiveDate,
             require_approval: T::Boolean,

data/rbi/increase/models/card_create_params.rbi

@@ -29,7 +29,9 @@ module Increase
       end
       attr_writer :authorization_controls
 
-      # The card's billing address.
+      # The card's billing address. This is used in card authorizations to
+      # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+      # If not provided, the address associated with the account's entity will be used.
       sig { returns(T.nilable(Increase::CardCreateParams::BillingAddress)) }
       attr_reader :billing_address
 
@@ -113,7 +115,9 @@ module Increase
         account_id:,
         # Controls that restrict how this card can be used.
         authorization_controls: nil,
-        # The card's billing address.
+        # The card's billing address. This is used in card authorizations to
+        # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+        # If not provided, the address associated with the account's entity will be used.
         billing_address: nil,
         # The name of the cardholder. Used to respond to Account Name Inquiry requests
         # from acquirers in Card Validations.
@@ -1253,7 +1257,9 @@ module Increase
         sig { params(line2: String).void }
         attr_writer :line2
 
-        # The card's billing address.
+        # The card's billing address. This is used in card authorizations to
+        # [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+        # If not provided, the address associated with the account's entity will be used.
         sig do
           params(
             city: String,