increase 1.340.0 → 1.342.0

data/lib/increase/models/beneficial_owner_update_params.rb

@@ -52,20 +52,28 @@ module Increase
                -> { 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: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::BeneficialOwnerUpdateParams} for more details.
-      #
       #   @param entity_beneficial_owner_id [String] The identifier of the Beneficial Owner to update.
       #
-      #   @param address [Increase::Models::BeneficialOwnerUpdateParams::Address] The individual's physical address. Mail receiving locations like PO Boxes and PM
+      #   @param address [Increase::Models::BeneficialOwnerUpdateParams::Address]
+      #     The individual's physical address. Mail receiving locations like PO Boxes and
+      #     PMB's are disallowed.
       #
-      #   @param confirmed_no_us_tax_id [Boolean] The identification method for an individual can only be a passport, driver's lic
+      #   @param confirmed_no_us_tax_id [Boolean]
+      #     The identification method for an individual can only be a passport, driver's
+      #     license, or other document if you've confirmed the individual does not have a US
+      #     tax id (either a Social Security Number or Individual Taxpayer Identification
+      #     Number).
       #
-      #   @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification] A means of verifying the person's identity.
+      #   @param identification [Increase::Models::BeneficialOwnerUpdateParams::Identification]
+      #     A means of verifying the person's identity.
       #
       #   @param name [String] The individual's legal name.
       #
-      #   @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>] Why this person is considered a beneficial owner of the entity. At least one opt
+      #   @param prongs [Array<Symbol, Increase::Models::BeneficialOwnerUpdateParams::Prong>]
+      #     Why this person is considered a beneficial owner of the entity. At least one
+      #     option is required, if a person is both a control person and owner, submit an
+      #     array containing both. Providing this replaces the beneficial owner's current
+      #     prongs.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
@@ -76,18 +84,19 @@ module Increase
         #   @return [String]
         required :city, String
 
-        # @!attribute country
-        #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-        #
-        #   @return [String]
-        required :country, String
-
         # @!attribute line1
         #   The first line of the address. This is usually the street number and street.
         #
         #   @return [String]
         required :line1, String
 
+        # @!attribute country
+        #   The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+        #   to `US`.
+        #
+        #   @return [String, nil]
+        optional :country, String
+
         # @!attribute line2
         #   The second line of the address. This might be the floor or room number.
         #
@@ -107,22 +116,23 @@ module Increase
         #   @return [String, nil]
         optional :zip, String
 
-        # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::BeneficialOwnerUpdateParams::Address} for more details.
-        #
+        # @!method initialize(city:, line1:, country: nil, line2: nil, state: nil, zip: nil)
         #   The individual's physical address. Mail receiving locations like PO Boxes and
         #   PMB's are disallowed.
         #
         #   @param city [String] The city, district, town, or village of the address.
         #
-        #   @param country [String] The two-letter ISO 3166-1 alpha-2 code for the country of the address.
-        #
         #   @param line1 [String] The first line of the address. This is usually the street number and street.
         #
+        #   @param country [String]
+        #     The two-letter ISO 3166-1 alpha-2 code for the country of the address. Defaults
+        #     to `US`.
+        #
         #   @param line2 [String] The second line of the address. This might be the floor or room number.
         #
-        #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the US state
+        #   @param state [String]
+        #     The two-letter United States Postal Service (USPS) abbreviation for the US
+        #     state, province, or region of the address. Required in certain countries.
         #
         #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
       end
@@ -168,21 +178,29 @@ module Increase
         optional :passport, -> { Increase::BeneficialOwnerUpdateParams::Identification::Passport }
 
         # @!method initialize(method_:, number:, drivers_license: nil, other: nil, passport: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::BeneficialOwnerUpdateParams::Identification} for more
-        #   details.
-        #
         #   A means of verifying the person's identity.
         #
-        #   @param method_ [Symbol, Increase::Models::BeneficialOwnerUpdateParams::Identification::Method] A method that can be used to verify the individual's identity.
+        #   @param method_ [Symbol, Increase::Models::BeneficialOwnerUpdateParams::Identification::Method]
+        #     A method that can be used to verify the individual's identity.
         #
-        #   @param number [String] An identification number that can be used to verify the individual's identity, s
+        #   @param number [String]
+        #     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
+        #     Taxpayer Identification Numbers, submit nine digits with no dashes or other
+        #     separators. When testing in sandbox, use one of our
+        #     [sandbox test values](https://increase.com/documentation/sandbox-test-values).
         #
-        #   @param drivers_license [Increase::Models::BeneficialOwnerUpdateParams::Identification::DriversLicense] Information about the United States driver's license used for identification. Re
+        #   @param drivers_license [Increase::Models::BeneficialOwnerUpdateParams::Identification::DriversLicense]
+        #     Information about the United States driver's license used for identification.
+        #     Required if `method` is equal to `drivers_license`.
         #
-        #   @param other [Increase::Models::BeneficialOwnerUpdateParams::Identification::Other] Information about the identification document provided. Required if `method` is
+        #   @param other [Increase::Models::BeneficialOwnerUpdateParams::Identification::Other]
+        #     Information about the identification document provided. Required if `method` is
+        #     equal to `other`.
         #
-        #   @param passport [Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport] Information about the passport used for identification. Required if `method` is
+        #   @param passport [Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport]
+        #     Information about the passport used for identification. Required if `method` is
+        #     equal to `passport`.
 
         # A method that can be used to verify the individual's identity.
         #
@@ -283,20 +301,20 @@ module Increase
           optional :expiration_date, Date
 
           # @!method initialize(country:, description:, file_id:, back_file_id: nil, expiration_date: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::BeneficialOwnerUpdateParams::Identification::Other} for more
-          #   details.
-          #
           #   Information about the identification document provided. Required if `method` is
           #   equal to `other`.
           #
-          #   @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
+          #   @param country [String]
+          #     The two-character ISO 3166-1 code representing the country that issued the
+          #     document (e.g., `US`).
           #
           #   @param description [String] A description of the document submitted.
           #
           #   @param file_id [String] The identifier of the File containing the front of the document.
           #
-          #   @param back_file_id [String] The identifier of the File containing the back of the document. Not every docume
+          #   @param back_file_id [String]
+          #     The identifier of the File containing the back of the document. Not every
+          #     document has a reverse side.
           #
           #   @param expiration_date [Date] The document's expiration date in YYYY-MM-DD format.
         end
@@ -323,14 +341,12 @@ module Increase
           required :file_id, String
 
           # @!method initialize(country:, expiration_date:, file_id:)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::BeneficialOwnerUpdateParams::Identification::Passport} for
-          #   more details.
-          #
           #   Information about the passport used for identification. Required if `method` is
           #   equal to `passport`.
           #
-          #   @param country [String] The two-character ISO 3166-1 code representing the country that issued the docum
+          #   @param country [String]
+          #     The two-character ISO 3166-1 code representing the country that issued the
+          #     document (e.g., `US`).
           #
           #   @param expiration_date [Date] The passport's expiration date in YYYY-MM-DD format.
           #

data/lib/increase/models/card.rb

@@ -101,9 +101,6 @@ module Increase
       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:)
-      #   Some parameter documentations has been truncated, see {Increase::Models::Card}
-      #   for more details.
-      #
       #   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
@@ -114,17 +111,23 @@ module Increase
       #
       #   @param account_id [String] The identifier for the account this card belongs to.
       #
-      #   @param authorization_controls [Increase::Models::Card::AuthorizationControls, nil] Controls that restrict how this card can be used.
+      #   @param authorization_controls [Increase::Models::Card::AuthorizationControls, nil]
+      #     Controls that restrict how this card can be used.
       #
       #   @param billing_address [Increase::Models::Card::BillingAddress] The Card's billing address.
       #
       #   @param bin [String] The Bank Identification Number (BIN) of the Card.
       #
-      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #     the Card was created.
       #
       #   @param description [String, nil] The card's description for display purposes.
       #
-      #   @param digital_wallet [Increase::Models::Card::DigitalWallet, nil] The contact information used in the two-factor steps for digital wallet card cre
+      #   @param digital_wallet [Increase::Models::Card::DigitalWallet, nil]
+      #     The contact information used in the two-factor steps for digital wallet card
+      #     creation. At least one field must be present to complete the digital wallet
+      #     steps.
       #
       #   @param entity_id [String, nil] The identifier for the entity associated with this card.
       #
@@ -132,13 +135,19 @@ module Increase
       #
       #   @param expiration_year [Integer] The year the card expires in YYYY format (e.g., 2025).
       #
-      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #   @param idempotency_key [String, nil]
+      #     The idempotency key you chose for this object. This value is unique across
+      #     Increase and is used to ensure that a request is only processed once. Learn more
+      #     about [idempotency](https://increase.com/documentation/idempotency-keys).
       #
       #   @param last4 [String] The last 4 digits of the Card's Primary Account Number.
       #
-      #   @param status [Symbol, Increase::Models::Card::Status] This indicates if payments can be made with the card.
+      #   @param status [Symbol, Increase::Models::Card::Status]
+      #     This indicates if payments can be made with the card.
       #
-      #   @param type [Symbol, Increase::Models::Card::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::Card::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `card`.
 
       # @see Increase::Models::Card#authorization_controls
       class AuthorizationControls < Increase::Internal::Type::BaseModel
@@ -174,18 +183,22 @@ module Increase
         required :usage, -> { Increase::Card::AuthorizationControls::Usage }, nil?: true
 
         # @!method initialize(merchant_acceptor_identifier:, merchant_category_code:, merchant_country:, usage:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::Card::AuthorizationControls} for more details.
-        #
         #   Controls that restrict how this card can be used.
         #
-        #   @param merchant_acceptor_identifier [Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier, nil] Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
+        #   @param merchant_acceptor_identifier [Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier, nil]
+        #     Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
+        #     on this card.
         #
-        #   @param merchant_category_code [Increase::Models::Card::AuthorizationControls::MerchantCategoryCode, nil] Restricts which Merchant Category Codes are allowed or blocked for authorization
+        #   @param merchant_category_code [Increase::Models::Card::AuthorizationControls::MerchantCategoryCode, nil]
+        #     Restricts which Merchant Category Codes are allowed or blocked for
+        #     authorizations on this card.
         #
-        #   @param merchant_country [Increase::Models::Card::AuthorizationControls::MerchantCountry, nil] Restricts which merchant countries are allowed or blocked for authorizations on
+        #   @param merchant_country [Increase::Models::Card::AuthorizationControls::MerchantCountry, nil]
+        #     Restricts which merchant countries are allowed or blocked for authorizations on
+        #     this card.
         #
-        #   @param usage [Increase::Models::Card::AuthorizationControls::Usage, nil] Controls how many times this card can be used.
+        #   @param usage [Increase::Models::Card::AuthorizationControls::Usage, nil]
+        #     Controls how many times this card can be used.
 
         # @see Increase::Models::Card::AuthorizationControls#merchant_acceptor_identifier
         class MerchantAcceptorIdentifier < Increase::Internal::Type::BaseModel
@@ -213,9 +226,11 @@ module Increase
           #   Restricts which Merchant Acceptor IDs are allowed or blocked for authorizations
           #   on this card.
           #
-          #   @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier::Allowed>, nil] The Merchant Acceptor IDs that are allowed for authorizations on this card.
+          #   @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier::Allowed>, nil]
+          #     The Merchant Acceptor IDs that are allowed for authorizations on this card.
           #
-          #   @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier::Blocked>, nil] The Merchant Acceptor IDs that are blocked for authorizations on this card.
+          #   @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantAcceptorIdentifier::Blocked>, nil]
+          #     The Merchant Acceptor IDs that are blocked for authorizations on this card.
 
           class Allowed < Increase::Internal::Type::BaseModel
             # @!attribute identifier
@@ -266,9 +281,11 @@ module Increase
           #   Restricts which Merchant Category Codes are allowed or blocked for
           #   authorizations on this card.
           #
-          #   @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantCategoryCode::Allowed>, nil] The Merchant Category Codes that are allowed for authorizations on this card.
+          #   @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantCategoryCode::Allowed>, nil]
+          #     The Merchant Category Codes that are allowed for authorizations on this card.
           #
-          #   @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantCategoryCode::Blocked>, nil] The Merchant Category Codes that are blocked for authorizations on this card.
+          #   @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantCategoryCode::Blocked>, nil]
+          #     The Merchant Category Codes that are blocked for authorizations on this card.
 
           class Allowed < Increase::Internal::Type::BaseModel
             # @!attribute code
@@ -319,9 +336,11 @@ module Increase
           #   Restricts which merchant countries are allowed or blocked for authorizations on
           #   this card.
           #
-          #   @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantCountry::Allowed>, nil] The merchant countries that are allowed for authorizations on this card.
+          #   @param allowed [Array<Increase::Models::Card::AuthorizationControls::MerchantCountry::Allowed>, nil]
+          #     The merchant countries that are allowed for authorizations on this card.
           #
-          #   @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantCountry::Blocked>, nil] The merchant countries that are blocked for authorizations on this card.
+          #   @param blocked [Array<Increase::Models::Card::AuthorizationControls::MerchantCountry::Blocked>, nil]
+          #     The merchant countries that are blocked for authorizations on this card.
 
           class Allowed < Increase::Internal::Type::BaseModel
             # @!attribute country
@@ -368,16 +387,17 @@ module Increase
           required :single_use, -> { Increase::Card::AuthorizationControls::Usage::SingleUse }, nil?: true
 
           # @!method initialize(category:, multi_use:, single_use:)
-          #   Some parameter documentations has been truncated, see
-          #   {Increase::Models::Card::AuthorizationControls::Usage} for more details.
-          #
           #   Controls how many times this card can be used.
           #
-          #   @param category [Symbol, Increase::Models::Card::AuthorizationControls::Usage::Category] Whether the card is for a single use or multiple uses.
+          #   @param category [Symbol, Increase::Models::Card::AuthorizationControls::Usage::Category]
+          #     Whether the card is for a single use or multiple uses.
           #
-          #   @param multi_use [Increase::Models::Card::AuthorizationControls::Usage::MultiUse, nil] Controls for multi-use cards. Required if and only if `category` is `multi_use`.
+          #   @param multi_use [Increase::Models::Card::AuthorizationControls::Usage::MultiUse, nil]
+          #     Controls for multi-use cards. Required if and only if `category` is `multi_use`.
           #
-          #   @param single_use [Increase::Models::Card::AuthorizationControls::Usage::SingleUse, nil] Controls for single-use cards. Required if and only if `category` is `single_use
+          #   @param single_use [Increase::Models::Card::AuthorizationControls::Usage::SingleUse, nil]
+          #     Controls for single-use cards. Required if and only if `category` is
+          #     `single_use`.
 
           # Whether the card is for a single use or multiple uses.
           #
@@ -409,13 +429,11 @@ module Increase
                      nil?: true
 
             # @!method initialize(spending_limits:)
-            #   Some parameter documentations has been truncated, see
-            #   {Increase::Models::Card::AuthorizationControls::Usage::MultiUse} for more
-            #   details.
-            #
             #   Controls for multi-use cards. Required if and only if `category` is `multi_use`.
             #
-            #   @param spending_limits [Array<Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit>, nil] Spending limits for this card. The most restrictive limit applies if multiple li
+            #   @param spending_limits [Array<Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit>, nil]
+            #     Spending limits for this card. The most restrictive limit applies if multiple
+            #     limits match.
 
             class SpendingLimit < Increase::Internal::Type::BaseModel
               # @!attribute interval
@@ -443,13 +461,12 @@ module Increase
               required :settlement_amount, Integer
 
               # @!method initialize(interval:, merchant_category_codes:, settlement_amount:)
-              #   Some parameter documentations has been truncated, see
-              #   {Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit}
-              #   for more details.
-              #
-              #   @param interval [Symbol, Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit::Interval] The interval at which the spending limit is enforced.
+              #   @param interval [Symbol, Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit::Interval]
+              #     The interval at which the spending limit is enforced.
               #
-              #   @param merchant_category_codes [Array<Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode>, nil] The Merchant Category Codes (MCCs) this spending limit applies to. If not set, t
+              #   @param merchant_category_codes [Array<Increase::Models::Card::AuthorizationControls::Usage::MultiUse::SpendingLimit::MerchantCategoryCode>, nil]
+              #     The Merchant Category Codes (MCCs) this spending limit applies to. If not set,
+              #     the limit applies to all transactions.
               #
               #   @param settlement_amount [Integer] The maximum settlement amount permitted in the given interval.
 
@@ -504,7 +521,8 @@ module Increase
             #   Controls for single-use cards. Required if and only if `category` is
             #   `single_use`.
             #
-            #   @param settlement_amount [Increase::Models::Card::AuthorizationControls::Usage::SingleUse::SettlementAmount] The settlement amount constraint for this single-use card.
+            #   @param settlement_amount [Increase::Models::Card::AuthorizationControls::Usage::SingleUse::SettlementAmount]
+            #     The settlement amount constraint for this single-use card.
 
             # @see Increase::Models::Card::AuthorizationControls::Usage::SingleUse#settlement_amount
             class SettlementAmount < Increase::Internal::Type::BaseModel
@@ -524,7 +542,8 @@ module Increase
               # @!method initialize(comparison:, value:)
               #   The settlement amount constraint for this single-use card.
               #
-              #   @param comparison [Symbol, Increase::Models::Card::AuthorizationControls::Usage::SingleUse::SettlementAmount::Comparison] The operator used to compare the settlement amount.
+              #   @param comparison [Symbol, Increase::Models::Card::AuthorizationControls::Usage::SingleUse::SettlementAmount::Comparison]
+              #     The operator used to compare the settlement amount.
               #
               #   @param value [Integer] The settlement amount value.
 
@@ -618,18 +637,21 @@ module Increase
         required :phone, String, nil?: true
 
         # @!method initialize(digital_card_profile_id:, email:, phone:)
-        #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::Card::DigitalWallet} for more details.
-        #
         #   The contact information used in the two-factor steps for digital wallet card
         #   creation. At least one field must be present to complete the digital wallet
         #   steps.
         #
-        #   @param digital_card_profile_id [String, nil] The digital card profile assigned to this digital card. Card profiles may also b
+        #   @param digital_card_profile_id [String, nil]
+        #     The digital card profile assigned to this digital card. Card profiles may also
+        #     be assigned at the program level.
         #
-        #   @param email [String, nil] An email address that can be used to verify the cardholder via one-time passcode
+        #   @param email [String, nil]
+        #     An email address that can be used to verify the cardholder via one-time passcode
+        #     over email.
         #
-        #   @param phone [String, nil] A phone number that can be used to verify the cardholder via one-time passcode o
+        #   @param phone [String, nil]
+        #     A phone number that can be used to verify the cardholder via one-time passcode
+        #     over SMS.
       end
 
       # This indicates if payments can be made with the card.

data/lib/increase/models/card_create_details_iframe_params.rb

@@ -21,12 +21,11 @@ module Increase
       optional :physical_card_id, String
 
       # @!method initialize(card_id:, physical_card_id: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::CardCreateDetailsIframeParams} for more details.
-      #
       #   @param card_id [String] The identifier of the Card to create an iframe for.
       #
-      #   @param physical_card_id [String] The identifier of the Physical Card to create an iframe for. This will inform th
+      #   @param physical_card_id [String]
+      #     The identifier of the Physical Card to create an iframe for. This will inform
+      #     the appearance of the card rendered in the iframe.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
     end