increase 1.346.1 → 1.348.0

data/lib/increase/models/card_dispute_list_params.rb

@@ -31,6 +31,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -54,6 +56,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param status [Increase::Models::CardDisputeListParams::Status]
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
@@ -146,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_list_params.rb

@@ -37,6 +37,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -62,6 +64,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param status [Increase::Models::CardListParams::Status]
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

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/card_payment_list_params.rb

@@ -34,6 +34,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -50,6 +52,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
       class CreatedAt < Increase::Internal::Type::BaseModel

data/lib/increase/models/card_purchase_supplement_list_params.rb

@@ -29,6 +29,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -45,6 +47,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
       class CreatedAt < Increase::Internal::Type::BaseModel

data/lib/increase/models/card_push_transfer_list_params.rb

@@ -37,6 +37,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -62,6 +64,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param status [Increase::Models::CardPushTransferListParams::Status]
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

data/lib/increase/models/card_token_list_params.rb

@@ -22,6 +22,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -34,6 +36,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
       class CreatedAt < Increase::Internal::Type::BaseModel

data/lib/increase/models/card_validation_list_params.rb

@@ -37,6 +37,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -62,6 +64,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param status [Increase::Models::CardValidationListParams::Status]
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

data/lib/increase/models/check_deposit_list_params.rb

@@ -37,6 +37,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -57,6 +59,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
       class CreatedAt < Increase::Internal::Type::BaseModel

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]
@@ -753,10 +762,10 @@ module Increase
         module ShippingMethod
           extend Increase::Internal::Type::Enum
 
-          # Ship the checks via USPS First Class, which supports a maximum of 1000 pages (checks and attachments combined).
+          # USPS First Class
           USPS_FIRST_CLASS = :usps_first_class
 
-          # Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks and attachments combined).
+          # FedEx Overnight
           FEDEX_OVERNIGHT = :fedex_overnight
 
           # @!method self.values
@@ -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.
           #
@@ -433,10 +445,10 @@ module Increase
         module ShippingMethod
           extend Increase::Internal::Type::Enum
 
-          # Ship the checks via USPS First Class, which supports a maximum of 1000 pages (checks and attachments combined).
+          # USPS First Class
           USPS_FIRST_CLASS = :usps_first_class
 
-          # Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks and attachments combined).
+          # FedEx Overnight
           FEDEX_OVERNIGHT = :fedex_overnight
 
           # @!method self.values

data/lib/increase/models/check_transfer_list_params.rb

@@ -37,6 +37,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -62,6 +64,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param status [Increase::Models::CheckTransferListParams::Status]
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

data/lib/increase/models/declined_transaction_list_params.rb

@@ -33,6 +33,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -55,6 +57,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param route_id [String] Filter Declined Transactions to those belonging to the specified route.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

data/lib/increase/models/digital_card_profile_list_params.rb

@@ -26,6 +26,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -47,6 +49,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param status [Increase::Models::DigitalCardProfileListParams::Status]
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

data/lib/increase/models/digital_wallet_token_list_params.rb

@@ -28,6 +28,8 @@ module Increase
       #   Limit the size of the list that is returned. The default (and maximum) is 100
       #   objects.
       #
+      #   Defaults to `100`.
+      #
       #   @return [Integer, nil]
       optional :limit, Integer
 
@@ -42,6 +44,8 @@ module Increase
       #     Limit the size of the list that is returned. The default (and maximum) is 100
       #     objects.
       #
+      #     Defaults to `100`.
+      #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
       class CreatedAt < Increase::Internal::Type::BaseModel

data/lib/increase/models/entity.rb

@@ -1208,8 +1208,8 @@ module Increase
         # @!attribute ip_address
         #   The IP address the Entity accessed reviewed the terms from.
         #
-        #   @return [String]
-        required :ip_address, String
+        #   @return [String, nil]
+        required :ip_address, String, nil?: true
 
         # @!attribute terms_url
         #   The URL of the terms agreement. This link will be provided by your bank partner.
@@ -1220,7 +1220,7 @@ module Increase
         # @!method initialize(agreed_at:, ip_address:, terms_url:)
         #   @param agreed_at [Time] The timestamp of when the Entity agreed to the terms.
         #
-        #   @param ip_address [String] The IP address the Entity accessed reviewed the terms from.
+        #   @param ip_address [String, nil] The IP address the Entity accessed reviewed the terms from.
         #
         #   @param terms_url [String] The URL of the terms agreement. This link will be provided by your bank partner.
       end
@@ -1832,6 +1832,12 @@ module Increase
           #   @return [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
           required :entity_address, -> { Increase::Entity::Validation::Issue::EntityAddress }, nil?: true
 
+          # @!attribute entity_identity
+          #   Details when the issue is with the entity's identity verification.
+          #
+          #   @return [Increase::Models::Entity::Validation::Issue::EntityIdentity, nil]
+          required :entity_identity, -> { Increase::Entity::Validation::Issue::EntityIdentity }, nil?: true
+
           # @!attribute entity_tax_identifier
           #   Details when the issue is with the entity's tax ID.
           #
@@ -1840,7 +1846,7 @@ module Increase
                    -> { Increase::Entity::Validation::Issue::EntityTaxIdentifier },
                    nil?: true
 
-          # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_tax_identifier:)
+          # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_identity:, entity_tax_identifier:)
           #   @param beneficial_owner_address [Increase::Models::Entity::Validation::Issue::BeneficialOwnerAddress, nil]
           #     Details when the issue is with a beneficial owner's address.
           #
@@ -1854,6 +1860,9 @@ module Increase
           #   @param entity_address [Increase::Models::Entity::Validation::Issue::EntityAddress, nil]
           #     Details when the issue is with the entity's address.
           #
+          #   @param entity_identity [Increase::Models::Entity::Validation::Issue::EntityIdentity, nil]
+          #     Details when the issue is with the entity's identity verification.
+          #
           #   @param entity_tax_identifier [Increase::Models::Entity::Validation::Issue::EntityTaxIdentifier, nil]
           #     Details when the issue is with the entity's tax ID.
 
@@ -1920,6 +1929,9 @@ module Increase
             # The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address).
             ENTITY_ADDRESS = :entity_address
 
+            # The entity's identity could not be verified. Update the identification with the [update an entity API](/documentation/api/entities#update-an-entity.natural_person.identification).
+            ENTITY_IDENTITY = :entity_identity
+
             # A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
             BENEFICIAL_OWNER_IDENTITY = :beneficial_owner_identity
 
@@ -1958,6 +1970,12 @@ module Increase
             end
           end
 
+          # @see Increase::Models::Entity::Validation::Issue#entity_identity
+          class EntityIdentity < Increase::Internal::Type::BaseModel
+            # @!method initialize
+            #   Details when the issue is with the entity's identity verification.
+          end
+
           # @see Increase::Models::Entity::Validation::Issue#entity_tax_identifier
           class EntityTaxIdentifier < Increase::Internal::Type::BaseModel
             # @!method initialize