increase 1.347.0 → 1.349.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9721f0cea6c29a79e0bc991becf4491dd8aae9516c957e2548f5f047147a9c4a
-  data.tar.gz: 289a88d3f39ebaa334c5bbd0e7c00a6a407aeb558e3b463ee1e85c4d1e5ba163
+  metadata.gz: 23cf98582ddaa22a0c6fcea1ae351f11324ff09dd6fc637883436dda459fe05c
+  data.tar.gz: 92fadfd622e3083e74f486cdbb8910d7021146294aa824c671edfbd7c35fdd7f
 SHA512:
-  metadata.gz: dc6f8c4480df3a69f005c76b68732b2f264ba7c431c50b836589f4bb420eb5c9ba927d7e2be71c0c146f473441ff86169b43fbb90852102d16228a08da283a9e
-  data.tar.gz: d7894b272e43d8e09b438c65f11e3bd6b40f0f227a2b6ab2de04517dadc017efe59c5c45a66424786eb7fb0775a656dc8e1ac94213e99346ccedafc2800aa139
+  metadata.gz: 18170e8cff606f8ef8248eb56d106e6ecac5a7c123b351505a02cef6836dbf2f1ab459122872c136f8c50c08e62c092529cbafc73018ae3157469939d0c1b86d
+  data.tar.gz: 34c18ed49cc6b7ad16bdac6a4dae2bb364e22387fd50554635bc71ab2a926eb7db67c8200cea3f691f64eff52a1dcaa342686a8a4e581bc10c411dfa7eaca69a

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

data/lib/increase/models/account_create_params.rb

@@ -92,28 +92,28 @@ module Increase
         #   The number of days after the statement date that the Account can be past due
         #   before being considered delinquent.
         #
-        #   @return [Integer]
-        required :grace_period_days, Integer
+        #   @return [Integer, nil]
+        optional :grace_period_days, Integer
+
+        # @!attribute maturity_date
+        #   The date on which the loan matures.
+        #
+        #   @return [Date, nil]
+        optional :maturity_date, Date
 
         # @!attribute statement_day_of_month
         #   The day of the month on which the loan statement is generated.
         #
-        #   @return [Integer]
-        required :statement_day_of_month, Integer
+        #   @return [Integer, nil]
+        optional :statement_day_of_month, Integer
 
         # @!attribute statement_payment_type
         #   The type of statement payment for the account.
         #
-        #   @return [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType]
-        required :statement_payment_type, enum: -> { Increase::AccountCreateParams::Loan::StatementPaymentType }
-
-        # @!attribute maturity_date
-        #   The date on which the loan matures.
-        #
-        #   @return [Date, nil]
-        optional :maturity_date, Date
+        #   @return [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType, nil]
+        optional :statement_payment_type, enum: -> { Increase::AccountCreateParams::Loan::StatementPaymentType }
 
-        # @!method initialize(credit_limit:, grace_period_days:, statement_day_of_month:, statement_payment_type:, maturity_date: nil)
+        # @!method initialize(credit_limit:, grace_period_days: nil, maturity_date: nil, statement_day_of_month: nil, statement_payment_type: nil)
         #   The loan details for the account.
         #
         #   @param credit_limit [Integer] The maximum amount of money that can be drawn from the Account.
@@ -122,12 +122,12 @@ module Increase
         #     The number of days after the statement date that the Account can be past due
         #     before being considered delinquent.
         #
+        #   @param maturity_date [Date] The date on which the loan matures.
+        #
         #   @param statement_day_of_month [Integer] The day of the month on which the loan statement is generated.
         #
         #   @param statement_payment_type [Symbol, Increase::Models::AccountCreateParams::Loan::StatementPaymentType]
         #     The type of statement payment for the account.
-        #
-        #   @param maturity_date [Date] The date on which the loan matures.
 
         # The type of statement payment for the account.
         #

data/lib/increase/models/ach_prenotification_create_params.rb

@@ -79,7 +79,7 @@ module Increase
       optional :individual_id, String
 
       # @!attribute individual_name
-      #   The name of therecipient. This value is informational and not verified by the
+      #   The name of the recipient. This value is informational and not verified by the
       #   recipient's bank.
       #
       #   @return [String, nil]
@@ -127,7 +127,7 @@ module Increase
       #   @param individual_id [String] Your identifier for the recipient.
       #
       #   @param individual_name [String]
-      #     The name of therecipient. This value is informational and not verified by the
+      #     The name of the recipient. This value is informational and not verified by the
       #     recipient's bank.
       #
       #   @param standard_entry_class_code [Symbol, Increase::Models::ACHPrenotificationCreateParams::StandardEntryClassCode]

data/lib/increase/models/ach_transfer.rb

@@ -1497,7 +1497,7 @@ module Increase
       class Submission < Increase::Internal::Type::BaseModel
         # @!attribute administrative_returns_expected_by
         #   The timestamp by which any administrative returns are expected to be received
-        #   by. This follows the NACHA guidelines for return windows, which are: "In
+        #   by. This follows the Nacha guidelines for return windows, which are: "In
         #   general, return entries must be received by the RDFI’s ACH Operator by its
         #   deposit deadline for the return entry to be made available to the ODFI no later
         #   than the opening of business on the second banking day following the Settlement
@@ -1558,7 +1558,7 @@ module Increase
         #
         #   @param administrative_returns_expected_by [Time]
         #     The timestamp by which any administrative returns are expected to be received
-        #     by. This follows the NACHA guidelines for return windows, which are: "In
+        #     by. This follows the Nacha guidelines for return windows, which are: "In
         #     general, return entries must be received by the RDFI’s ACH Operator by its
         #     deposit deadline for the return entry to be made available to the ODFI no later
         #     than the opening of business on the second banking day following the Settlement

data/lib/increase/models/ach_transfer_create_params.rb

@@ -151,13 +151,7 @@ module Increase
       optional :standard_entry_class_code,
                enum: -> { Increase::ACHTransferCreateParams::StandardEntryClassCode }
 
-      # @!attribute transaction_timing
-      #   The timing of the transaction.
-      #
-      #   @return [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming, nil]
-      optional :transaction_timing, enum: -> { Increase::ACHTransferCreateParams::TransactionTiming }
-
-      # @!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, transaction_timing: nil, request_options: {})
+      # @!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 amount [Integer]
@@ -245,9 +239,6 @@ module Increase
       #     to use for the transfer. If not provided, the default is
       #     `corporate_credit_or_debit`.
       #
-      #   @param transaction_timing [Symbol, Increase::Models::ACHTransferCreateParams::TransactionTiming]
-      #     The timing of the transaction.
-      #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
       class Addenda < Increase::Internal::Type::BaseModel
@@ -487,20 +478,6 @@ module Increase
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      # The timing of the transaction.
-      module TransactionTiming
-        extend Increase::Internal::Type::Enum
-
-        # A Transaction will be created immediately.
-        SYNCHRONOUS = :synchronous
-
-        # A Transaction will be created when the funds settle at the Federal Reserve.
-        ASYNCHRONOUS = :asynchronous
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/increase/models/balance_lookup.rb

@@ -72,6 +72,42 @@ module Increase
         #   @return [Integer]
         required :due_balance, Integer
 
+        # @!attribute due_fees
+        #   The fees on the loan that are due and unpaid.
+        #
+        #   @return [Integer, nil]
+        required :due_fees, Integer, nil?: true
+
+        # @!attribute due_interest
+        #   The interest on the loan that is due and unpaid.
+        #
+        #   @return [Integer, nil]
+        required :due_interest, Integer, nil?: true
+
+        # @!attribute due_principal
+        #   The principal on the loan that is due and unpaid.
+        #
+        #   @return [Integer, nil]
+        required :due_principal, Integer, nil?: true
+
+        # @!attribute not_due_fees
+        #   The fees on the loan that are not yet due.
+        #
+        #   @return [Integer, nil]
+        required :not_due_fees, Integer, nil?: true
+
+        # @!attribute not_due_interest
+        #   The interest on the loan that is not yet due.
+        #
+        #   @return [Integer, nil]
+        required :not_due_interest, Integer, nil?: true
+
+        # @!attribute not_due_principal
+        #   The principal on the loan that is not yet due.
+        #
+        #   @return [Integer, nil]
+        required :not_due_principal, Integer, nil?: true
+
         # @!attribute past_due_balance
         #   The amount past due on the loan.
         #
@@ -84,7 +120,7 @@ module Increase
         #   @return [Increase::Models::BalanceLookup::Loan::Receivables, nil]
         required :receivables, -> { Increase::BalanceLookup::Loan::Receivables }, nil?: true
 
-        # @!method initialize(due_at:, due_balance:, past_due_balance:, receivables:)
+        # @!method initialize(due_at:, due_balance:, due_fees:, due_interest:, due_principal:, not_due_fees:, not_due_interest:, not_due_principal:, past_due_balance:, receivables:)
         #   The loan balances for the Account.
         #
         #   @param due_at [Time, nil]
@@ -93,6 +129,18 @@ module Increase
         #
         #   @param due_balance [Integer] The total amount due on the loan.
         #
+        #   @param due_fees [Integer, nil] The fees on the loan that are due and unpaid.
+        #
+        #   @param due_interest [Integer, nil] The interest on the loan that is due and unpaid.
+        #
+        #   @param due_principal [Integer, nil] The principal on the loan that is due and unpaid.
+        #
+        #   @param not_due_fees [Integer, nil] The fees on the loan that are not yet due.
+        #
+        #   @param not_due_interest [Integer, nil] The interest on the loan that is not yet due.
+        #
+        #   @param not_due_principal [Integer, nil] The principal on the loan that is not yet due.
+        #
         #   @param past_due_balance [Integer] The amount past due on the loan.
         #
         #   @param receivables [Increase::Models::BalanceLookup::Loan::Receivables, nil]

data/lib/increase/models/beneficial_owner_update_params.rb

@@ -29,6 +29,12 @@ module Increase
       #   @return [Boolean, nil]
       optional :confirmed_no_us_tax_id, Increase::Internal::Type::Boolean
 
+      # @!attribute date_of_birth
+      #   The person's date of birth in YYYY-MM-DD format.
+      #
+      #   @return [Date, nil]
+      optional :date_of_birth, Date
+
       # @!attribute identification
       #   A means of verifying the person's identity.
       #
@@ -51,7 +57,7 @@ module Increase
       optional :prongs,
                -> { Increase::Internal::Type::ArrayOf[enum: Increase::BeneficialOwnerUpdateParams::Prong] }
 
-      # @!method initialize(entity_beneficial_owner_id:, address: nil, confirmed_no_us_tax_id: nil, identification: nil, name: nil, prongs: nil, request_options: {})
+      # @!method initialize(entity_beneficial_owner_id:, address: nil, confirmed_no_us_tax_id: nil, date_of_birth: nil, identification: nil, name: nil, prongs: nil, request_options: {})
       #   @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
       #
       #   @param address [Increase::Models::BeneficialOwnerUpdateParams::Address]
@@ -64,6 +70,8 @@ module Increase
       #     tax id (either a Social Security Number or Individual Taxpayer Identification
       #     Number).
       #
+      #   @param date_of_birth [Date] The person's date of birth in YYYY-MM-DD format.
+      #
       #   @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
       #     A means of verifying the person's identity.
       #

data/lib/increase/models/card.rb

@@ -34,6 +34,13 @@ module Increase
       #   @return [String]
       required :bin, String
 
+      # @!attribute cardholder_name
+      #   The name of the cardholder. Used to respond to Account Name Inquiry requests
+      #   from acquirers in Card Validations.
+      #
+      #   @return [Increase::Models::Card::CardholderName, nil]
+      required :cardholder_name, -> { Increase::Card::CardholderName }, nil?: true
+
       # @!attribute created_at
       #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
       #   the Card was created.
@@ -100,7 +107,7 @@ module Increase
       #   @return [Symbol, Increase::Models::Card::Type]
       required :type, enum: -> { Increase::Card::Type }
 
-      # @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
+      # @!method initialize(id:, account_id:, authorization_controls:, billing_address:, bin:, cardholder_name:, created_at:, description:, digital_wallet:, entity_id:, expiration_month:, expiration_year:, idempotency_key:, last4:, status:, type:)
       #   Cards may operate on credit, debit, or prepaid BINs. They’ll immediately work
       #   for online purchases after you create them. All cards work on a good funds
       #   model, and maintain a maximum limit of 100% of the Account’s available balance
@@ -118,6 +125,10 @@ module Increase
       #
       #   @param bin [String] The Bank Identification Number (BIN) of the Card.
       #
+      #   @param cardholder_name [Increase::Models::Card::CardholderName, nil]
+      #     The name of the cardholder. Used to respond to Account Name Inquiry requests
+      #     from acquirers in Card Validations.
+      #
       #   @param created_at [Time]
       #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
       #     the Card was created.
@@ -613,6 +624,37 @@ module Increase
         #   @param state [String, nil] The US state of the billing address.
       end
 
+      # @see Increase::Models::Card#cardholder_name
+      class CardholderName < Increase::Internal::Type::BaseModel
+        # @!attribute first
+        #   The cardholder's first name.
+        #
+        #   @return [String]
+        required :first, String
+
+        # @!attribute last
+        #   The cardholder's last name.
+        #
+        #   @return [String]
+        required :last, String
+
+        # @!attribute middle
+        #   The cardholder's middle name.
+        #
+        #   @return [String, nil]
+        required :middle, String, nil?: true
+
+        # @!method initialize(first:, last:, middle:)
+        #   The name of the cardholder. Used to respond to Account Name Inquiry requests
+        #   from acquirers in Card Validations.
+        #
+        #   @param first [String] The cardholder's first name.
+        #
+        #   @param last [String] The cardholder's last name.
+        #
+        #   @param middle [String, nil] The cardholder's middle name.
+      end
+
       # @see Increase::Models::Card#digital_wallet
       class DigitalWallet < Increase::Internal::Type::BaseModel
         # @!attribute digital_card_profile_id

data/lib/increase/models/card_create_params.rb

@@ -25,6 +25,13 @@ module Increase
       #   @return [Increase::Models::CardCreateParams::BillingAddress, nil]
       optional :billing_address, -> { Increase::CardCreateParams::BillingAddress }
 
+      # @!attribute cardholder_name
+      #   The name of the cardholder. Used to respond to Account Name Inquiry requests
+      #   from acquirers in Card Validations.
+      #
+      #   @return [Increase::Models::CardCreateParams::CardholderName, nil]
+      optional :cardholder_name, -> { Increase::CardCreateParams::CardholderName }
+
       # @!attribute description
       #   The description you choose to give the card.
       #
@@ -48,7 +55,7 @@ module Increase
       #   @return [String, nil]
       optional :entity_id, String
 
-      # @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
+      # @!method initialize(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
       #   @param account_id [String] The Account the card should belong to.
       #
       #   @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
@@ -56,6 +63,10 @@ module Increase
       #
       #   @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
       #
+      #   @param cardholder_name [Increase::Models::CardCreateParams::CardholderName]
+      #     The name of the cardholder. Used to respond to Account Name Inquiry requests
+      #     from acquirers in Card Validations.
+      #
       #   @param description [String] The description you choose to give the card.
       #
       #   @param digital_wallet [Increase::Models::CardCreateParams::DigitalWallet]
@@ -519,6 +530,36 @@ module Increase
         #   @param line2 [String] The second line of the billing address.
       end
 
+      class CardholderName < Increase::Internal::Type::BaseModel
+        # @!attribute first
+        #   The cardholder's first name.
+        #
+        #   @return [String]
+        required :first, String
+
+        # @!attribute last
+        #   The cardholder's last name.
+        #
+        #   @return [String]
+        required :last, String
+
+        # @!attribute middle
+        #   The cardholder's middle name.
+        #
+        #   @return [String, nil]
+        optional :middle, String
+
+        # @!method initialize(first:, last:, middle: nil)
+        #   The name of the cardholder. Used to respond to Account Name Inquiry requests
+        #   from acquirers in Card Validations.
+        #
+        #   @param first [String] The cardholder's first name.
+        #
+        #   @param last [String] The cardholder's last name.
+        #
+        #   @param middle [String] The cardholder's middle name.
+      end
+
       class DigitalWallet < Increase::Internal::Type::BaseModel
         # @!attribute digital_card_profile_id
         #   The digital card profile assigned to this digital card.

data/lib/increase/models/card_dispute.rb

@@ -275,7 +275,7 @@ module Increase
         # The Card Dispute has been won and no further action can be taken.
         WON = :won
 
-        # The Card Dispute has been reviewed and rejected, please review the explanation for more details.
+        # The Card Dispute was rejected before it was submitted to the network, either by Increase or because the user withdrew it. Please review the explanation for more details.
         REJECTED = :rejected
 
         # @!method self.values

data/lib/increase/models/card_dispute_list_params.rb

@@ -150,7 +150,7 @@ module Increase
           # The Card Dispute has been won and no further action can be taken.
           WON = :won
 
-          # The Card Dispute has been reviewed and rejected, please review the explanation for more details.
+          # The Card Dispute was rejected before it was submitted to the network, either by Increase or because the user withdrew it. Please review the explanation for more details.
           REJECTED = :rejected
 
           # @!method self.values

data/lib/increase/models/card_payment.rb

@@ -1512,6 +1512,16 @@ module Increase
           #   @return [Integer, nil]
           required :network_risk_score, Integer, nil?: true
 
+          # @!attribute original_card_payment_id
+          #   The ID of the Card Payment containing the original authorization or card
+          #   validation this transaction references. For a merchant-initiated transaction,
+          #   this is the Card Payment from when the card was first stored, which is typically
+          #   where the CVV2 was verified. The reference this is derived from is supplied by
+          #   the merchant or their acquirer, so it is not guaranteed to be present.
+          #
+          #   @return [String, nil]
+          required :original_card_payment_id, String, nil?: true
+
           # @!attribute pending_transaction_id
           #   The identifier of the Pending Transaction associated with this Transaction.
           #
@@ -1580,7 +1590,7 @@ module Increase
           #   @return [Increase::Models::CardPayment::Element::CardAuthorization::Verification]
           required :verification, -> { Increase::CardPayment::Element::CardAuthorization::Verification }
 
-          # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
+          # @!method initialize(id:, actioner:, additional_amounts:, amount:, card_payment_id:, currency:, digital_wallet_token_id:, direction:, expires_at:, healthcare:, merchant_acceptor_id:, merchant_category_code:, merchant_city:, merchant_country:, merchant_descriptor:, merchant_postal_code:, merchant_state:, network_details:, network_identifiers:, network_risk_score:, original_card_payment_id:, pending_transaction_id:, physical_card_id:, presentment_amount:, presentment_currency:, processing_category:, real_time_decision_id:, scheme_fees:, terminal_id:, type:, verification:)
           #   A Card Authorization object. This field will be present in the JSON response if
           #   and only if `category` is equal to `card_authorization`. Card Authorizations are
           #   temporary holds placed on a customer's funds with the intent to later clear a
@@ -1654,6 +1664,13 @@ module Increase
           #     Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
           #     score is from 0 to 999, where 999 is the riskiest.
           #
+          #   @param original_card_payment_id [String, nil]
+          #     The ID of the Card Payment containing the original authorization or card
+          #     validation this transaction references. For a merchant-initiated transaction,
+          #     this is the Card Payment from when the card was first stored, which is typically
+          #     where the CVV2 was verified. The reference this is derived from is supplied by
+          #     the merchant or their acquirer, so it is not guaranteed to be present.
+          #
           #   @param pending_transaction_id [String, nil]
           #     The identifier of the Pending Transaction associated with this Transaction.
           #

data/lib/increase/models/check_transfer.rb

@@ -532,6 +532,12 @@ module Increase
         #   @return [Array<Increase::Models::CheckTransfer::PhysicalCheck::Payer>]
         required :payer, -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::Payer] }
 
+        # @!attribute physical_check_batch_id
+        #   The identifier of the Physical Check Batch that this check is a part of.
+        #
+        #   @return [String, nil]
+        required :physical_check_batch_id, String, nil?: true
+
         # @!attribute recipient_name
         #   The name that will be printed on the check.
         #
@@ -570,7 +576,7 @@ module Increase
         required :tracking_updates,
                  -> { Increase::Internal::Type::ArrayOf[Increase::CheckTransfer::PhysicalCheck::TrackingUpdate] }
 
-        # @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, recipient_name:, return_address:, return_address_name:, shipping_method:, signature:, tracking_updates:)
+        # @!method initialize(attachment_file_id:, check_voucher_image_file_id:, mailing_address:, memo:, note:, payer:, physical_check_batch_id:, recipient_name:, return_address:, return_address_name:, shipping_method:, signature:, tracking_updates:)
         #   Details relating to the physical check that Increase will print and mail. Will
         #   be present if and only if `fulfillment_method` is equal to `physical_check`.
         #
@@ -589,6 +595,9 @@ module Increase
         #     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.
         #
+        #   @param physical_check_batch_id [String, nil]
+        #     The identifier of the Physical Check Batch that this check is a part of.
+        #
         #   @param recipient_name [String] The name that will be printed on the check.
         #
         #   @param return_address [Increase::Models::CheckTransfer::PhysicalCheck::ReturnAddress, nil]
@@ -876,6 +885,9 @@ module Increase
         # The transfer has been canceled.
         CANCELED = :canceled
 
+        # The transfer is waiting for its Physical Check Batch to be completed.
+        PENDING_BATCH_COMPLETING = :pending_batch_completing
+
         # The transfer is pending submission.
         PENDING_SUBMISSION = :pending_submission
 

data/lib/increase/models/check_transfer_create_params.rb

@@ -151,7 +151,8 @@ module Increase
 
       class PhysicalCheck < Increase::Internal::Type::BaseModel
         # @!attribute mailing_address
-        #   Details for where Increase will mail the check.
+        #   Details for where Increase will mail the check. When `physical_check_batch_id`
+        #   is set, the address must match the Physical Check Batch.
         #
         #   @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::MailingAddress]
         required :mailing_address, -> { Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress }
@@ -199,10 +200,16 @@ module Increase
         #   @return [String, nil]
         optional :note, String
 
+        # @!attribute physical_check_batch_id
+        #   The identifier of the Physical Check Batch to mail this check as a part of.
+        #
+        #   @return [String, nil]
+        optional :physical_check_batch_id, String
+
         # @!attribute return_address
-        #   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.
+        #   Details for where the courier will return the check to if it is unable to be
+        #   delivered. Defaults to an Increase-owned address that will mark checks as
+        #   delivery failed and shred them.
         #
         #   @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress, nil]
         optional :return_address, -> { Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress }
@@ -229,13 +236,14 @@ module Increase
         #   @return [Increase::Models::CheckTransferCreateParams::PhysicalCheck::Signature, nil]
         optional :signature, -> { Increase::CheckTransferCreateParams::PhysicalCheck::Signature }
 
-        # @!method initialize(mailing_address:, memo:, payer:, recipient_name:, attachment_file_id: nil, check_voucher_image_file_id: nil, note: nil, return_address: nil, return_address_name: nil, shipping_method: nil, signature: nil)
+        # @!method initialize(mailing_address:, memo:, payer:, recipient_name:, attachment_file_id: nil, check_voucher_image_file_id: nil, note: nil, physical_check_batch_id: nil, return_address: nil, return_address_name: nil, shipping_method: nil, signature: nil)
         #   Details relating to the physical check that Increase will print and mail. This
         #   is required if `fulfillment_method` is equal to `physical_check`. It must not be
         #   included if any other `fulfillment_method` is provided.
         #
         #   @param mailing_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::MailingAddress]
-        #     Details for where Increase will mail the check.
+        #     Details for where Increase will mail the check. When `physical_check_batch_id`
+        #     is set, the address must match the Physical Check Batch.
         #
         #   @param memo [String] The descriptor that will be printed on the memo field on the check.
         #
@@ -258,10 +266,13 @@ module Increase
         #
         #   @param note [String] The descriptor that will be printed on the letter included with the check.
         #
+        #   @param physical_check_batch_id [String]
+        #     The identifier of the Physical Check Batch to mail this check as a part of.
+        #
         #   @param return_address [Increase::Models::CheckTransferCreateParams::PhysicalCheck::ReturnAddress]
-        #     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.
+        #     Details for where the courier will return the check to if it is unable to be
+        #     delivered. Defaults to an Increase-owned address that will mark checks as
+        #     delivery failed and shred them.
         #
         #   @param return_address_name [String]
         #     A custom name to print above the default return address. Cannot be provided
@@ -324,7 +335,8 @@ module Increase
           optional :phone, String
 
           # @!method initialize(city:, line1:, postal_code:, state:, line2: nil, name: nil, phone: nil)
-          #   Details for where Increase will mail the check.
+          #   Details for where Increase will mail the check. When `physical_check_batch_id`
+          #   is set, the address must match the Physical Check Batch.
           #
           #   @param city [String] The city component of the check's destination address.
           #
@@ -404,9 +416,9 @@ module Increase
           optional :phone, String
 
           # @!method initialize(city:, line1:, name:, postal_code:, state:, line2: nil, phone: 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.
+          #   Details for where the courier will return the check to if it is unable to be
+          #   delivered. Defaults to an Increase-owned address that will mark checks as
+          #   delivery failed and shred them.
           #
           #   @param city [String] The city of the return address.
           #