increase 1.364.0 → 1.366.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 222a3a474a6fabf7445abcecbbe300845db445bc0d08b3bc399596cc760f24af
-  data.tar.gz: 10425bbfc0580d4df9cacbe14d13fe6122cbca7f84786c4eaad54ece99260d5f
+  metadata.gz: 211fbbf6b1a0858edc8134c95ebc037a7c2bc1405a8ba477a5be65448d26b31d
+  data.tar.gz: 1321070823bdb7946cd8b217f2f28d3e28d64680068da7d6d4aafb7d1ec06baf
 SHA512:
-  metadata.gz: 1a92736d94243d471c75cd7d4e0fb50294474808b2d69f09f746920916f9d05b0655404f50b1c0a0c311c61aa315c2586e81ea552e958063191c5524e25047dd
-  data.tar.gz: d5cf59099d458e204f9942bfd3c4b05cd69ea5e494cb1e624dd7c0c376cdca60df686f89893fd525906b830e2c82f16ef1328099ddf736d098b35832aa08072c
+  metadata.gz: adf93ef36b26aebaacb0da3eab1170c8b811ee7f4828c997e676a4d363cab599d0e253fe3ca1ba80d8c661e9d244791826a206559ba71cb82ff9540ce03ef913
+  data.tar.gz: 8723b388931f436101d86574b44cdcce5546812ad8e66a02d12db48331dee3eb4465435d7a3af5ed601b43592f45935cfcecaef175de606e21a1737b0ff833e9

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.364.0"
+gem "increase", "~> 1.366.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/ach_transfer.rb

@@ -223,7 +223,10 @@ module Increase
       required :standard_entry_class_code, enum: -> { Increase::ACHTransfer::StandardEntryClassCode }
 
       # @!attribute statement_descriptor
-      #   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.
       #
       #   @return [String, nil]
       required :statement_descriptor, String, nil?: true
@@ -379,7 +382,11 @@ module Increase
       #     [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
       #     to use for the transfer.
       #
-      #   @param statement_descriptor [String, nil] The descriptor that will show on the recipient's bank statement.
+      #   @param statement_descriptor [String, nil]
+      #     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.
       #
       #   @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer.
       #

data/lib/increase/models/ach_transfer_create_params.rb

@@ -26,16 +26,26 @@ module Increase
       #   @return [Integer]
       required :amount, Integer
 
-      # @!attribute statement_descriptor
-      #   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.
+      # @!attribute company_name
+      #   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.
+      #
+      #   @return [String]
+      required :company_name, String
+
+      # @!attribute individual_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.
       #
       #   @return [String]
-      required :statement_descriptor, String
+      required :individual_name, String
 
       # @!attribute account_number
       #   The receiver's account number. For credit transfers (transfers with a positive
@@ -83,17 +93,6 @@ module Increase
       #   @return [String, nil]
       optional :company_entry_description, String
 
-      # @!attribute company_name
-      #   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`.
-      #
-      #   @return [String, nil]
-      optional :company_name, String
-
       # @!attribute destination_account_holder
       #   The type of entity that owns the receiver's account.
       #
@@ -125,15 +124,6 @@ module Increase
       #   @return [String, nil]
       optional :individual_id, String
 
-      # @!attribute individual_name
-      #   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`.
-      #
-      #   @return [String, nil]
-      optional :individual_name, String
-
       # @!attribute preferred_effective_date
       #   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
@@ -166,7 +156,7 @@ module Increase
       optional :standard_entry_class_code,
                enum: -> { Increase::ACHTransferCreateParams::StandardEntryClassCode }
 
-      # @!method initialize(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: {})
+      # @!method initialize(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
       #     credit transfers (transfers with a positive `amount`), this is the account that
@@ -180,13 +170,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
@@ -219,14 +216,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.
       #
@@ -245,12 +234,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/models/card_create_params.rb

@@ -20,7 +20,9 @@ module Increase
       optional :authorization_controls, -> { Increase::CardCreateParams::AuthorizationControls }
 
       # @!attribute billing_address
-      #   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.
       #
       #   @return [Increase::Models::CardCreateParams::BillingAddress, nil]
       optional :billing_address, -> { Increase::CardCreateParams::BillingAddress }
@@ -68,7 +70,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
@@ -528,7 +533,9 @@ module Increase
         optional :line2, String
 
         # @!method initialize(city:, line1:, postal_code:, state:, line2: 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.
         #
         #   @param city [String] The city of the billing address.
         #