increase 1.361.0 → 1.363.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 693a4c244c1ccd7cd6ce2efec35ed0bb1c7852ffb11df31789decc7fdaaa703d
-  data.tar.gz: 71892bf2ecf9a4c8a3ad2738b00b835cccda0c7cbcd51c26b62782eb1b8cc04b
+  metadata.gz: f63ff7ab654a402cc90736db41326ac8d1c00edbda030c347801315125430860
+  data.tar.gz: 8a17ebc028b8d1eee17ad80ecdb98c3a9ba84f54b1fd86101070056909322c3a
 SHA512:
-  metadata.gz: '08f7b1d238efae08f9195514392d5c4f4c2b35e2a6c7c07b61392d61445b92bba69edc231a3a922d6fd40fdac5753814db285ee49c718c4abda9126fde19f53c'
-  data.tar.gz: 711946095b9706ebb435a07e0ac013805f6161f5848eb9e90226caebb23fb18279068f518f4b5476c766f38d43320c4f92be566cfd39a5b38f43d3df41e594bf
+  metadata.gz: 9bce475b357304a547e42aeb3e6ba9734c6dc11a8e8e7f70ccffcf075e6a921bbe598764f5ab3640c9c86da6c6d7d19576d43854b63f28fa47c473d7501b8b6f
+  data.tar.gz: c1033455aa379e2591718eae054b276977d10d300af62a9aedebf017bdb1a73ced407ce25765d12e849dcd461606ed851b253c2202608c41294db763552d7cca

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.361.0"
+gem "increase", "~> 1.363.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/client.rb

@@ -173,18 +173,6 @@ module Increase
     # @return [Increase::Resources::RealTimeDecisions]
     attr_reader :real_time_decisions
 
-    # @return [Increase::Resources::Groups]
-    attr_reader :groups
-
-    # @return [Increase::Resources::OAuthApplications]
-    attr_reader :oauth_applications
-
-    # @return [Increase::Resources::OAuthConnections]
-    attr_reader :oauth_connections
-
-    # @return [Increase::Resources::OAuthTokens]
-    attr_reader :oauth_tokens
-
     # @return [Increase::Resources::IntrafiAccountEnrollments]
     attr_reader :intrafi_account_enrollments
 
@@ -343,10 +331,6 @@ module Increase
       @events = Increase::Resources::Events.new(client: self)
       @event_subscriptions = Increase::Resources::EventSubscriptions.new(client: self)
       @real_time_decisions = Increase::Resources::RealTimeDecisions.new(client: self)
-      @groups = Increase::Resources::Groups.new(client: self)
-      @oauth_applications = Increase::Resources::OAuthApplications.new(client: self)
-      @oauth_connections = Increase::Resources::OAuthConnections.new(client: self)
-      @oauth_tokens = Increase::Resources::OAuthTokens.new(client: self)
       @intrafi_account_enrollments = Increase::Resources::IntrafiAccountEnrollments.new(client: self)
       @intrafi_balances = Increase::Resources::IntrafiBalances.new(client: self)
       @intrafi_exclusions = Increase::Resources::IntrafiExclusions.new(client: self)

data/lib/increase/internal/transport/pooled_net_requester.rb

@@ -64,6 +64,9 @@ module Increase
           # @return [Array(Net::HTTPGenericRequest, Proc)]
           def build_request(request, &blk)
             method, url, headers, body = request.fetch_values(:method, :url, :headers, :body)
+            # Streamed bodies (e.g. multipart) arrive as a factory so each attempt gets a fresh stream.
+            body = body.call if body.is_a?(Proc)
+
             req = Net::HTTPGenericRequest.new(
               method.to_s.upcase,
               !body.nil?,

data/lib/increase/internal/util.rb

@@ -608,34 +608,39 @@ module Increase
         #
         # @param body [Object]
         #
-        # @return [Array(String, Enumerable<String>)]
+        # @return [Array(String, Proc)]
         private def encode_multipart_streaming(body)
           # rubocop:disable Style/CaseEquality
           # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
           boundary = SecureRandom.urlsafe_base64(46)
 
-          closing = []
-          strio = writable_enum do |y|
-            case body
-            in Hash
-              body.each do |key, val|
-                case val
-                in Array if val.all? { primitive?(_1) || Increase::Internal::Type::FileInput === _1 }
-                  val.each do |v|
-                    write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
+          # Retries and redirects resend the request, and a streamed body can only be read
+          # once, so hand back a factory that builds a fresh stream for each attempt.
+          stream = lambda do
+            closing = []
+            strio = writable_enum do |y|
+              case body
+              in Hash
+                body.each do |key, val|
+                  case val
+                  in Array if val.all? { primitive?(_1) || Increase::Internal::Type::FileInput === _1 }
+                    val.each do |v|
+                      write_multipart_chunk(y, boundary: boundary, key: key, val: v, closing: closing)
+                    end
+                  else
+                    write_multipart_chunk(y, boundary: boundary, key: key, val: val, closing: closing)
                   end
-                else
-                  write_multipart_chunk(y, boundary: boundary, key: key, val: val, closing: closing)
                 end
+              else
+                write_multipart_chunk(y, boundary: boundary, key: nil, val: body, closing: closing)
               end
-            else
-              write_multipart_chunk(y, boundary: boundary, key: nil, val: body, closing: closing)
+              y << "--#{boundary}--\r\n"
             end
-            y << "--#{boundary}--\r\n"
+
+            fused_enum(strio) { closing.each(&:call) }
           end
 
-          fused_io = fused_enum(strio) { closing.each(&:call) }
-          [boundary, fused_io]
+          [boundary, stream]
           # rubocop:enable Style/CaseEquality
         end
 

data/lib/increase/models/ach_transfer.rb

@@ -59,25 +59,34 @@ module Increase
       required :cancellation, -> { Increase::ACHTransfer::Cancellation }, nil?: true
 
       # @!attribute company_descriptive_date
-      #   The description of the date of the transfer.
+      #   A description of the transfer date (typically `YYMMDD`), sent in the company
+      #   batch header. This value is informational and does not affect funds movement,
+      #   settlement timing, or returns.
       #
       #   @return [String, nil]
       required :company_descriptive_date, String, nil?: true
 
       # @!attribute company_discretionary_data
-      #   The data you chose to associate with the transfer.
+      #   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.
       #
       #   @return [String, nil]
       required :company_discretionary_data, String, nil?: true
 
       # @!attribute company_entry_description
-      #   The description of the transfer you set to be shown to the recipient.
+      #   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.
       #
       #   @return [String, nil]
       required :company_entry_description, String, nil?: true
 
       # @!attribute company_id
-      #   The company ID associated with the transfer.
+      #   The Company ID sent in the batch header, which identifies the originator to the
+      #   receiving bank. Businesses use this value to allowlist the companies permitted
+      #   to debit their accounts. This value is configured by Increase and will be the
+      #   same for all your transfers.
       #
       #   @return [String]
       required :company_id, String
@@ -179,10 +188,8 @@ module Increase
       required :pending_transaction_id, String, nil?: true
 
       # @!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
-      #   `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
-      #   must be set.
+      #   Configuration for how the effective date of the transfer was set. This
+      #   determines same-day vs future-dated settlement timing.
       #
       #   @return [Increase::Models::ACHTransfer::PreferredEffectiveDate]
       required :preferred_effective_date, -> { Increase::ACHTransfer::PreferredEffectiveDate }
@@ -218,8 +225,8 @@ module Increase
       # @!attribute statement_descriptor
       #   The descriptor that will show on the recipient's bank statement.
       #
-      #   @return [String]
-      required :statement_descriptor, String
+      #   @return [String, nil]
+      required :statement_descriptor, String, nil?: true
 
       # @!attribute status
       #   The lifecycle status of the transfer.
@@ -281,14 +288,26 @@ module Increase
       #     If your account requires approvals for transfers and the transfer was not
       #     approved, this will contain details of the cancellation.
       #
-      #   @param company_descriptive_date [String, nil] The description of the date of the transfer.
+      #   @param company_descriptive_date [String, nil]
+      #     A description of the transfer date (typically `YYMMDD`), sent in the company
+      #     batch header. This value is informational and does not affect funds movement,
+      #     settlement timing, or returns.
       #
-      #   @param company_discretionary_data [String, nil] The data you chose to associate with the transfer.
+      #   @param company_discretionary_data [String, nil]
+      #     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.
       #
       #   @param company_entry_description [String, nil]
-      #     The description of the transfer you set to be shown to the recipient.
+      #     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.
       #
-      #   @param company_id [String] The company ID associated with the transfer.
+      #   @param company_id [String]
+      #     The Company ID sent in the batch header, which identifies the originator to the
+      #     receiving bank. Businesses use this value to allowlist the companies permitted
+      #     to debit their accounts. This value is configured by Increase and will be the
+      #     same for all your transfers.
       #
       #   @param company_name [String, nil] The name by which the recipient knows you.
       #
@@ -341,10 +360,8 @@ module Increase
       #     by someone else in your organization.
       #
       #   @param preferred_effective_date [Increase::Models::ACHTransfer::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
-      #     `settlement_schedule` of `same_day`. If set, exactly one of the child attributes
-      #     must be set.
+      #     Configuration for how the effective date of the transfer was set. This
+      #     determines same-day vs future-dated settlement timing.
       #
       #   @param return_ [Increase::Models::ACHTransfer::Return, nil]
       #     If your transfer is returned, this will contain details of the return.
@@ -362,7 +379,7 @@ module Increase
       #     [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
       #     to use for the transfer.
       #
-      #   @param statement_descriptor [String] The descriptor that will show on the recipient's bank statement.
+      #   @param statement_descriptor [String, nil] The descriptor that will show on the recipient's bank statement.
       #
       #   @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer.
       #
@@ -1069,10 +1086,8 @@ module Increase
                  nil?: true
 
         # @!method initialize(date:, settlement_schedule:)
-        #   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
-        #   must be set.
+        #   Configuration for how the effective date of the transfer was set. This
+        #   determines same-day vs future-dated settlement timing.
         #
         #   @param date [Date, nil]
         #     A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to

data/lib/increase/models/ach_transfer_create_params.rb

@@ -8,15 +8,20 @@ module Increase
       include Increase::Internal::Type::RequestParameters
 
       # @!attribute account_id
-      #   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.
       #
       #   @return [String]
       required :account_id, String
 
       # @!attribute amount
       #   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).
       #
       #   @return [Integer]
       required :amount, Integer
@@ -33,9 +38,10 @@ module Increase
       required :statement_descriptor, String
 
       # @!attribute account_number
-      #   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.
       #
       #   @return [String, nil]
       optional :account_number, String
@@ -58,27 +64,32 @@ module Increase
       optional :company_descriptive_date, String
 
       # @!attribute company_discretionary_data
-      #   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.
       #
       #   @return [String, nil]
       optional :company_discretionary_data, String
 
       # @!attribute company_entry_description
-      #   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`.
       #
       #   @return [String, nil]
       optional :company_entry_description, String
 
       # @!attribute company_name
-      #   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
-      #   `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. 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
@@ -106,15 +117,19 @@ module Increase
       optional :funding, enum: -> { Increase::ACHTransferCreateParams::Funding }
 
       # @!attribute individual_id
-      #   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.
       #
       #   @return [String, nil]
       optional :individual_id, String
 
       # @!attribute individual_name
-      #   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`.
       #
       #   @return [String, nil]
       optional :individual_name, String
@@ -152,12 +167,18 @@ module Increase
                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: {})
-      #   @param account_id [String] The Increase identifier for the account that will send the transfer.
+      #   @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
+      #     funds will be sent from. For debit transfers (transfers with a negative
+      #     `amount`), this is the account that funds will be pulled into.
       #
       #   @param amount [Integer]
       #     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).
       #
       #   @param statement_descriptor [String]
       #     A description you choose to give the transfer. This will be saved with the
@@ -168,9 +189,10 @@ module Increase
       #     `individual_name` and `company_name` instead of relying on this fallback.
       #
       #   @param account_number [String]
-      #     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.
       #
       #   @param addenda [Increase::Models::ACHTransferCreateParams::Addenda]
       #     Additional information passed through to the receiving bank with the transfer.
@@ -184,21 +206,26 @@ module Increase
       #     settlement timing, or returns. Only set this if your recipient has asked for it.
       #
       #   @param company_discretionary_data [String]
-      #     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.
       #
       #   @param company_entry_description [String]
-      #     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`.
       #
       #   @param company_name [String]
-      #     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
-      #     `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. 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.
@@ -213,12 +240,16 @@ module Increase
       #     Defaults to `checking`.
       #
       #   @param individual_id [String]
-      #     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.
       #
       #   @param individual_name [String]
-      #     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`.
       #
       #   @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
       #     Configuration for how the effective date of the transfer will be set. This