increase 1.346.1 → 1.347.0

data/lib/increase/resources/physical_card_profiles.rb

@@ -8,13 +8,18 @@ module Increase
       # @overload create(carrier_image_file_id:, contact_phone:, description:, front_image_file_id:, program_id:, front_text: nil, request_options: {})
       #
       # @param carrier_image_file_id [String]
-      #   The identifier of the File containing the physical card's carrier image.
+      #   The identifier of the File containing the physical card's carrier image. This
+      #   must have `purpose: physical_card_carrier` and be a 2550x3300 pixel PNG with a
+      #   density of 300 dots per inch (DPI).
       #
       # @param contact_phone [String] A phone number the user can contact to receive support for their card.
       #
       # @param description [String] A description you can use to identify the Card Profile.
       #
-      # @param front_image_file_id [String] The identifier of the File containing the physical card's front image.
+      # @param front_image_file_id [String]
+      #   The identifier of the File containing the physical card's front image. This must
+      #   have `purpose: physical_card_front` and be a 2100x1344 pixel PNG with a density
+      #   of 600 dots per inch (DPI).
       #
       # @param program_id [String] The identifier for the Program that this Physical Card Profile falls under.
       #
@@ -74,6 +79,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::PhysicalCardProfileListParams::Status]
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/increase/resources/physical_cards.rb

@@ -100,6 +100,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}, nil]
       #
       # @return [Increase::Internal::Page<Increase::Models::PhysicalCard>]

data/lib/increase/resources/programs.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`.
+      #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Increase::Internal::Page<Increase::Models::Program>]

data/lib/increase/resources/real_time_payments_transfers.rb

@@ -105,6 +105,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::RealTimePaymentsTransferListParams::Status]
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/increase/resources/routing_numbers.rb

@@ -19,6 +19,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}, nil]
       #
       # @return [Increase::Internal::Page<Increase::Models::RoutingNumberListResponse>]

data/lib/increase/resources/simulations/ach_transfers.rb

@@ -78,6 +78,7 @@ module Increase
         #
         # @param reason [Symbol, Increase::Models::Simulations::ACHTransferReturnParams::Reason]
         #   The reason why the Federal Reserve or destination bank returned this transfer.
+        #
         #   Defaults to `no_account`.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/increase/resources/simulations/check_deposits.rb

@@ -20,8 +20,9 @@ module Increase
         #   Deposit amount.
         #
         # @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason]
-        #   The reason for the adjustment. Defaults to `non_conforming_item`, which is often
-        #   used for a low quality image that the recipient wasn't able to handle.
+        #   The reason for the adjustment.
+        #
+        #   Defaults to `non_conforming_item`.
         #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/increase/resources/simulations/inbound_check_deposits.rb

@@ -6,10 +6,11 @@ module Increase
       class InboundCheckDeposits
         # Simulates an Inbound Check Deposit against your account. This imitates someone
         # depositing a check at their bank that was issued from your account. It may or
-        # may not be associated with a Check Transfer. Increase will evaluate the Inbound
-        # Check Deposit as we would in production and either create a Transaction or a
-        # Declined Transaction as a result. You can inspect the resulting Inbound Check
-        # Deposit object to see the result.
+        # may not be associated with a Check Transfer. The resulting Inbound Check Deposit
+        # will have a `status` of `pending`, and after an hour Increase will evaluate it
+        # as we would in production and either create a Transaction or a Declined
+        # Transaction as a result. To resolve it sooner, use the simulation to accept an
+        # Inbound Check Deposit or the API to decline one.
         #
         # @overload create(account_number_id:, amount:, check_number:, payee_name_analysis: nil, request_options: {})
         #

data/lib/increase/resources/supplemental_documents.rb

@@ -45,6 +45,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}, nil]
       #
       # @return [Increase::Internal::Page<Increase::Models::EntitySupplementalDocument>]

data/lib/increase/resources/swift_transfers.rb

@@ -105,6 +105,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::SwiftTransferListParams::Status]
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/increase/resources/transactions.rb

@@ -39,6 +39,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 Transactions for those belonging to the specified route. This could be a
       #   Card ID or an Account Number ID.

data/lib/increase/resources/wire_drawdown_requests.rb

@@ -92,6 +92,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::WireDrawdownRequestListParams::Status]
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/increase/resources/wire_transfers.rb

@@ -100,6 +100,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::WireTransferListParams::Status]
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/increase/version.rb

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

data/rbi/increase/models/account.rbi

@@ -200,6 +200,10 @@ module Increase
         GRASSHOPPER_BANK =
           T.let(:grasshopper_bank, Increase::Account::Bank::TaggedSymbol)
 
+        # Increase Bank
+        INCREASE_BANK =
+          T.let(:increase_bank, Increase::Account::Bank::TaggedSymbol)
+
         sig do
           override.returns(T::Array[Increase::Account::Bank::TaggedSymbol])
         end

data/rbi/increase/models/account_list_params.rbi

@@ -52,6 +52,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -99,6 +101,8 @@ module Increase
         informational_entity_id: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         # Filter Accounts for those in a specific Program.
         program_id: nil,

data/rbi/increase/models/account_number_list_params.rbi

@@ -60,6 +60,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -101,6 +103,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         status: nil,
         request_options: {}

data/rbi/increase/models/account_statement_list_params.rbi

@@ -30,6 +30,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -68,6 +70,8 @@ module Increase
         cursor: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         statement_period_start: nil,
         request_options: {}

data/rbi/increase/models/account_transfer_list_params.rbi

@@ -50,6 +50,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -79,6 +81,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         request_options: {}
       )

data/rbi/increase/models/ach_prenotification_create_params.rbi

@@ -63,6 +63,8 @@ module Increase
       attr_writer :company_name
 
       # Whether the Prenotification is for a future debit or credit.
+      #
+      # Defaults to `debit`.
       sig do
         returns(
           T.nilable(
@@ -106,6 +108,8 @@ module Increase
       # The
       # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
       # to use for the ACH Prenotification.
+      #
+      # Defaults to `corporate_credit_or_debit`.
       sig do
         returns(
           T.nilable(
@@ -162,6 +166,8 @@ module Increase
         # The name by which the recipient knows you.
         company_name: nil,
         # Whether the Prenotification is for a future debit or credit.
+        #
+        # Defaults to `debit`.
         credit_debit_indicator: nil,
         # The ACH Prenotification effective date in
         # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
@@ -174,6 +180,8 @@ module Increase
         # The
         # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
         # to use for the ACH Prenotification.
+        #
+        # Defaults to `corporate_credit_or_debit`.
         standard_entry_class_code: nil,
         request_options: {}
       )
@@ -205,6 +213,8 @@ module Increase
       end
 
       # Whether the Prenotification is for a future debit or credit.
+      #
+      # Defaults to `debit`.
       module CreditDebitIndicator
         extend Increase::Internal::Type::Enum
 
@@ -245,6 +255,8 @@ module Increase
       # The
       # [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
       # to use for the ACH Prenotification.
+      #
+      # Defaults to `corporate_credit_or_debit`.
       module StandardEntryClassCode
         extend Increase::Internal::Type::Enum
 

data/rbi/increase/models/ach_prenotification_list_params.rbi

@@ -45,6 +45,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -71,6 +73,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         request_options: {}
       )

data/rbi/increase/models/ach_transfer_create_params.rbi

@@ -116,6 +116,8 @@ module Increase
       attr_writer :external_account_id
 
       # The type of the receiver's bank account.
+      #
+      # Defaults to `checking`.
       sig do
         returns(T.nilable(Increase::ACHTransferCreateParams::Funding::OrSymbol))
       end
@@ -292,6 +294,8 @@ module Increase
         # provided, `account_number`, `routing_number`, and `funding` must be absent.
         external_account_id: nil,
         # The type of the receiver's bank account.
+        #
+        # Defaults to `checking`.
         funding: nil,
         # 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.
@@ -704,6 +708,8 @@ module Increase
       end
 
       # The type of the receiver's bank account.
+      #
+      # Defaults to `checking`.
       module Funding
         extend Increase::Internal::Type::Enum
 

data/rbi/increase/models/ach_transfer_list_params.rbi

@@ -54,6 +54,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -95,6 +97,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         status: nil,
         request_options: {}

data/rbi/increase/models/beneficial_owner_create_params.rbi

@@ -206,6 +206,8 @@ module Increase
           attr_accessor :city
 
           # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          # Defaults to `US`.
           sig { returns(String) }
           attr_accessor :country
 
@@ -251,6 +253,8 @@ module Increase
             # The city, district, town, or village of the address.
             city:,
             # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+            #
+            # Defaults to `US`.
             country:,
             # The first line of the address. This is usually the street number and street.
             line1:,
@@ -290,6 +294,8 @@ module Increase
             end
 
           # A method that can be used to verify the individual's identity.
+          #
+          # Defaults to `social_security_number`.
           sig do
             returns(
               Increase::BeneficialOwnerCreateParams::Individual::Identification::Method::OrSymbol
@@ -378,6 +384,8 @@ module Increase
           end
           def self.new(
             # A method that can be used to verify the individual's identity.
+            #
+            # Defaults to `social_security_number`.
             method_:,
             # An identification number that can be used to verify the individual's identity,
             # such as a social security number. For Social Security Numbers and Individual
@@ -416,6 +424,8 @@ module Increase
           end
 
           # A method that can be used to verify the individual's identity.
+          #
+          # Defaults to `social_security_number`.
           module Method
             extend Increase::Internal::Type::Enum
 

data/rbi/increase/models/beneficial_owner_list_params.rbi

@@ -38,6 +38,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -66,6 +68,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         request_options: {}
       )

data/rbi/increase/models/beneficial_owner_update_params.rbi

@@ -153,6 +153,8 @@ module Increase
         attr_accessor :city
 
         # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+        #
+        # Defaults to `US`.
         sig { returns(String) }
         attr_accessor :country
 
@@ -198,6 +200,8 @@ module Increase
           # The city, district, town, or village of the address.
           city:,
           # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
+          #
+          # Defaults to `US`.
           country:,
           # The first line of the address. This is usually the street number and street.
           line1:,
@@ -237,6 +241,8 @@ module Increase
           end
 
         # A method that can be used to verify the individual's identity.
+        #
+        # Defaults to `social_security_number`.
         sig do
           returns(
             Increase::BeneficialOwnerUpdateParams::Identification::Method::OrSymbol
@@ -325,6 +331,8 @@ module Increase
         end
         def self.new(
           # A method that can be used to verify the individual's identity.
+          #
+          # Defaults to `social_security_number`.
           method_:,
           # An identification number that can be used to verify the individual's identity,
           # such as a social security number. For Social Security Numbers and Individual
@@ -363,6 +371,8 @@ module Increase
         end
 
         # A method that can be used to verify the individual's identity.
+        #
+        # Defaults to `social_security_number`.
         module Method
           extend Increase::Internal::Type::Enum
 

data/rbi/increase/models/card_dispute_list_params.rbi

@@ -40,6 +40,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -75,6 +77,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         status: nil,
         request_options: {}

data/rbi/increase/models/card_list_params.rbi

@@ -45,6 +45,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -81,6 +83,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         status: nil,
         request_options: {}

data/rbi/increase/models/card_payment_list_params.rbi

@@ -44,6 +44,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -70,6 +72,8 @@ module Increase
         cursor: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         request_options: {}
       )

data/rbi/increase/models/card_purchase_supplement_list_params.rbi

@@ -46,6 +46,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -71,6 +73,8 @@ module Increase
         cursor: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         request_options: {}
       )

data/rbi/increase/models/card_push_transfer_list_params.rbi

@@ -52,6 +52,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -92,6 +94,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         status: nil,
         request_options: {}

data/rbi/increase/models/card_token_list_params.rbi

@@ -30,6 +30,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -50,6 +52,8 @@ module Increase
         cursor: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         request_options: {}
       )

data/rbi/increase/models/card_validation_list_params.rbi

@@ -47,6 +47,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -85,6 +87,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         status: nil,
         request_options: {}

data/rbi/increase/models/check_deposit_list_params.rbi

@@ -47,6 +47,8 @@ module Increase
 
       # Limit the size of the list that is returned. The default (and maximum) is 100
       # objects.
+      #
+      # Defaults to `100`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -76,6 +78,8 @@ module Increase
         idempotency_key: nil,
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
+        #
+        # Defaults to `100`.
         limit: nil,
         request_options: {}
       )

data/rbi/increase/models/check_transfer.rbi

@@ -1140,14 +1140,14 @@ module Increase
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          # Ship the checks via USPS First Class, which supports a maximum of 1000 pages (checks and attachments combined).
+          # USPS First Class
           USPS_FIRST_CLASS =
             T.let(
               :usps_first_class,
               Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol
             )
 
-          # Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks and attachments combined).
+          # FedEx Overnight
           FEDEX_OVERNIGHT =
             T.let(
               :fedex_overnight,

data/rbi/increase/models/check_transfer_create_params.rbi

@@ -718,14 +718,14 @@ module Increase
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          # Ship the checks via USPS First Class, which supports a maximum of 1000 pages (checks and attachments combined).
+          # USPS First Class
           USPS_FIRST_CLASS =
             T.let(
               :usps_first_class,
               Increase::CheckTransferCreateParams::PhysicalCheck::ShippingMethod::TaggedSymbol
             )
 
-          # Ship the checks via FedEx Overnight, which supports a maximum of 50 pages (checks and attachments combined).
+          # FedEx Overnight
           FEDEX_OVERNIGHT =
             T.let(
               :fedex_overnight,