increase 1.353.0 → 1.355.0

data/lib/increase/models/digital_wallet_token_request_list_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalWalletTokenRequests#list
+    class DigitalWalletTokenRequestListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute card_id
+      #   Filter Digital Wallet Token Requests to ones for the specified Card.
+      #
+      #   @return [String, nil]
+      optional :card_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::DigitalWalletTokenRequestListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::DigitalWalletTokenRequestListParams::CreatedAt }
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   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
+
+      # @!method initialize(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
+      #   @param card_id [String] Filter Digital Wallet Token Requests to ones for the specified Card.
+      #
+      #   @param created_at [Increase::Models::DigitalWalletTokenRequestListParams::CreatedAt]
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param limit [Integer]
+      #     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
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   @param after [Time]
+        #     Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
+        #
+        #   @param before [Time]
+        #     Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #     timestamp.
+        #
+        #   @param on_or_after [Time]
+        #     Return results on or after this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @param on_or_before [Time]
+        #     Return results on or before this
+        #     [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+      end
+    end
+  end
+end

data/lib/increase/models/digital_wallet_token_request_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalWalletTokenRequests#retrieve
+    class DigitalWalletTokenRequestRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute digital_wallet_token_request_id
+      #   The identifier of the Digital Wallet Token Request.
+      #
+      #   @return [String]
+      required :digital_wallet_token_request_id, String
+
+      # @!method initialize(digital_wallet_token_request_id:, request_options: {})
+      #   @param digital_wallet_token_request_id [String] The identifier of the Digital Wallet Token Request.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/digital_wallet_token_transition_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalWalletTokens#transition
+    class DigitalWalletTokenTransitionParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute digital_wallet_token_id
+      #   The identifier of the Digital Wallet Token.
+      #
+      #   @return [String]
+      required :digital_wallet_token_id, String
+
+      # @!attribute status
+      #   The status to transition the Digital Wallet Token to.
+      #
+      #   @return [Symbol, Increase::Models::DigitalWalletTokenTransitionParams::Status]
+      required :status, enum: -> { Increase::DigitalWalletTokenTransitionParams::Status }
+
+      # @!method initialize(digital_wallet_token_id:, status:, request_options: {})
+      #   @param digital_wallet_token_id [String] The identifier of the Digital Wallet Token.
+      #
+      #   @param status [Symbol, Increase::Models::DigitalWalletTokenTransitionParams::Status]
+      #     The status to transition the Digital Wallet Token to.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The status to transition the Digital Wallet Token to.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # Reactivate a suspended Digital Wallet Token.
+        ACTIVE = :active
+
+        # Temporarily pause an active Digital Wallet Token.
+        SUSPENDED = :suspended
+
+        # Permanently cancel an active, inactive, or suspended Digital Wallet Token.
+        DEACTIVATED = :deactivated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/entity.rb

@@ -546,7 +546,7 @@ module Increase
                 # A social security number.
                 SOCIAL_SECURITY_NUMBER = :social_security_number
 
-                # The last four digits of a social security number.
+                # The last four digits of a social security number. Not all programs can use this method.
                 SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
 
                 # An individual taxpayer identification number (ITIN).
@@ -952,7 +952,7 @@ module Increase
               # A social security number.
               SOCIAL_SECURITY_NUMBER = :social_security_number
 
-              # The last four digits of a social security number.
+              # The last four digits of a social security number. Not all programs can use this method.
               SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
 
               # An individual taxpayer identification number (ITIN).
@@ -1108,7 +1108,7 @@ module Increase
             # A social security number.
             SOCIAL_SECURITY_NUMBER = :social_security_number
 
-            # The last four digits of a social security number.
+            # The last four digits of a social security number. Not all programs can use this method.
             SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
 
             # An individual taxpayer identification number (ITIN).
@@ -1433,7 +1433,7 @@ module Increase
               # A social security number.
               SOCIAL_SECURITY_NUMBER = :social_security_number
 
-              # The last four digits of a social security number.
+              # The last four digits of a social security number. Not all programs can use this method.
               SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
 
               # An individual taxpayer identification number (ITIN).
@@ -1858,7 +1858,7 @@ module Increase
               # A social security number.
               SOCIAL_SECURITY_NUMBER = :social_security_number
 
-              # The last four digits of a social security number.
+              # The last four digits of a social security number. Not all programs can use this method.
               SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
 
               # An individual taxpayer identification number (ITIN).
@@ -2037,7 +2037,7 @@ module Increase
                 # A social security number.
                 SOCIAL_SECURITY_NUMBER = :social_security_number
 
-                # The last four digits of a social security number.
+                # The last four digits of a social security number. Not all programs can use this method.
                 SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
 
                 # An individual taxpayer identification number (ITIN).
@@ -2129,6 +2129,14 @@ module Increase
                    -> { Increase::Entity::Validation::Issue::BeneficialOwnerIdentity },
                    nil?: true
 
+          # @!attribute beneficial_owner_tax_identifier
+          #   Details when the issue is with a beneficial owner's tax identifier.
+          #
+          #   @return [Increase::Models::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier, nil]
+          required :beneficial_owner_tax_identifier,
+                   -> { Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier },
+                   nil?: true
+
           # @!attribute category
           #   The type of issue. We may add additional possible values for this enum over
           #   time; your application should be able to handle such additions gracefully.
@@ -2156,13 +2164,16 @@ module Increase
                    -> { Increase::Entity::Validation::Issue::EntityTaxIdentifier },
                    nil?: true
 
-          # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, category:, entity_address:, entity_identity:, entity_tax_identifier:)
+          # @!method initialize(beneficial_owner_address:, beneficial_owner_identity:, beneficial_owner_tax_identifier:, 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.
           #
           #   @param beneficial_owner_identity [Increase::Models::Entity::Validation::Issue::BeneficialOwnerIdentity, nil]
           #     Details when the issue is with a beneficial owner's identity verification.
           #
+          #   @param beneficial_owner_tax_identifier [Increase::Models::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier, nil]
+          #     Details when the issue is with a beneficial owner's tax identifier.
+          #
           #   @param category [Symbol, Increase::Models::Entity::Validation::Issue::Category]
           #     The type of issue. We may add additional possible values for this enum over
           #     time; your application should be able to handle such additions gracefully.
@@ -2226,6 +2237,20 @@ module Increase
             #   @param beneficial_owner_id [String] The ID of the beneficial owner.
           end
 
+          # @see Increase::Models::Entity::Validation::Issue#beneficial_owner_tax_identifier
+          class BeneficialOwnerTaxIdentifier < Increase::Internal::Type::BaseModel
+            # @!attribute beneficial_owner_id
+            #   The ID of the beneficial owner.
+            #
+            #   @return [String]
+            required :beneficial_owner_id, String
+
+            # @!method initialize(beneficial_owner_id:)
+            #   Details when the issue is with a beneficial owner's tax identifier.
+            #
+            #   @param beneficial_owner_id [String] The ID of the beneficial owner.
+          end
+
           # The type of issue. We may add additional possible values for this enum over
           # time; your application should be able to handle such additions gracefully.
           #
@@ -2248,6 +2273,9 @@ module Increase
             # A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
             BENEFICIAL_OWNER_ADDRESS = :beneficial_owner_address
 
+            # A beneficial owner's full tax identifier is required. A non-US person can submit a passport or driver's license. Make changes via the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner).
+            BENEFICIAL_OWNER_TAX_IDENTIFIER = :beneficial_owner_tax_identifier
+
             # @!method self.values
             #   @return [Array<Symbol>]
           end

data/lib/increase/models/entity_beneficial_owner.rb

@@ -223,7 +223,7 @@ module Increase
             # A social security number.
             SOCIAL_SECURITY_NUMBER = :social_security_number
 
-            # The last four digits of a social security number.
+            # The last four digits of a social security number. Not all programs can use this method.
             SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
 
             # An individual taxpayer identification number (ITIN).

data/lib/increase/models/entity_create_params.rb

@@ -587,7 +587,7 @@ module Increase
                 # A social security number.
                 SOCIAL_SECURITY_NUMBER = :social_security_number
 
-                # The last four digits of a social security number.
+                # The last four digits of a social security number. Not all programs can use this method.
                 SOCIAL_SECURITY_NUMBER_LAST4 = :social_security_number_last4
 
                 # An individual taxpayer identification number (ITIN).

data/lib/increase/models/export.rb

@@ -432,14 +432,14 @@ module Increase
       module Category
         extend Increase::Internal::Type::Enum
 
-        # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
-        ACCOUNT_STATEMENT_OFX = :account_statement_ofx
-
         # Export a BAI2 file of transactions and balances for a given date and optional Account.
         ACCOUNT_STATEMENT_BAI2 = :account_statement_bai2
 
-        # Export a CSV of all transactions for a given time range.
-        TRANSACTION_CSV = :transaction_csv
+        # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
+        ACCOUNT_STATEMENT_OFX = :account_statement_ofx
+
+        # A PDF of an account verification letter.
+        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
 
         # Export a CSV of account balances for the dates in a given range. (deprecated, use `daily_account_balance_csv` instead)
         BALANCE_CSV = :balance_csv
@@ -447,20 +447,17 @@ module Increase
         # Export a CSV of bookkeeping account balances for the dates in a given range.
         BOOKKEEPING_ACCOUNT_BALANCE_CSV = :bookkeeping_account_balance_csv
 
-        # Export a CSV of entities with a given status.
-        ENTITY_CSV = :entity_csv
-
-        # Export a CSV of vendors added to the third-party risk management dashboard.
-        VENDOR_CSV = :vendor_csv
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
 
         # Certain dashboard tables are available as CSV exports. This export cannot be created via the API.
         DASHBOARD_TABLE_CSV = :dashboard_table_csv
 
-        # A PDF of an account verification letter.
-        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
+        # Export a CSV of entities with a given status.
+        ENTITY_CSV = :entity_csv
 
-        # A PDF of funding instructions.
-        FUNDING_INSTRUCTIONS = :funding_instructions
+        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
+        FEE_CSV = :fee_csv
 
         # A PDF of an Internal Revenue Service Form 1099-INT.
         FORM_1099_INT = :form_1099_int
@@ -468,15 +465,18 @@ module Increase
         # A PDF of an Internal Revenue Service Form 1099-MISC.
         FORM_1099_MISC = :form_1099_misc
 
-        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
-        FEE_CSV = :fee_csv
+        # A PDF of funding instructions.
+        FUNDING_INSTRUCTIONS = :funding_instructions
+
+        # Export a CSV of all transactions for a given time range.
+        TRANSACTION_CSV = :transaction_csv
+
+        # Export a CSV of vendors added to the third-party risk management dashboard.
+        VENDOR_CSV = :vendor_csv
 
         # A PDF of a voided check.
         VOIDED_CHECK = :voided_check
 
-        # Export a CSV of daily account balances with starting and ending balances for a given date range.
-        DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
-
         # @!method self.values
         #   @return [Array<Symbol>]
       end

data/lib/increase/models/export_create_params.rb

@@ -138,14 +138,14 @@ module Increase
       module Category
         extend Increase::Internal::Type::Enum
 
-        # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
-        ACCOUNT_STATEMENT_OFX = :account_statement_ofx
-
         # Export a BAI2 file of transactions and balances for a given date and optional Account.
         ACCOUNT_STATEMENT_BAI2 = :account_statement_bai2
 
-        # Export a CSV of all transactions for a given time range.
-        TRANSACTION_CSV = :transaction_csv
+        # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
+        ACCOUNT_STATEMENT_OFX = :account_statement_ofx
+
+        # A PDF of an account verification letter.
+        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
 
         # Export a CSV of account balances for the dates in a given range. (deprecated, use `daily_account_balance_csv` instead)
         BALANCE_CSV = :balance_csv
@@ -153,27 +153,27 @@ module Increase
         # Export a CSV of bookkeeping account balances for the dates in a given range.
         BOOKKEEPING_ACCOUNT_BALANCE_CSV = :bookkeeping_account_balance_csv
 
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
+
         # Export a CSV of entities with a given status.
         ENTITY_CSV = :entity_csv
 
-        # Export a CSV of vendors added to the third-party risk management dashboard.
-        VENDOR_CSV = :vendor_csv
-
-        # A PDF of an account verification letter.
-        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
+        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
+        FEE_CSV = :fee_csv
 
         # A PDF of funding instructions.
         FUNDING_INSTRUCTIONS = :funding_instructions
 
-        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
-        FEE_CSV = :fee_csv
+        # Export a CSV of all transactions for a given time range.
+        TRANSACTION_CSV = :transaction_csv
+
+        # Export a CSV of vendors added to the third-party risk management dashboard.
+        VENDOR_CSV = :vendor_csv
 
         # A PDF of a voided check.
         VOIDED_CHECK = :voided_check
 
-        # Export a CSV of daily account balances with starting and ending balances for a given date range.
-        DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
-
         # @!method self.values
         #   @return [Array<Symbol>]
       end

data/lib/increase/models/export_list_params.rb

@@ -89,14 +89,14 @@ module Increase
       module Category
         extend Increase::Internal::Type::Enum
 
-        # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
-        ACCOUNT_STATEMENT_OFX = :account_statement_ofx
-
         # Export a BAI2 file of transactions and balances for a given date and optional Account.
         ACCOUNT_STATEMENT_BAI2 = :account_statement_bai2
 
-        # Export a CSV of all transactions for a given time range.
-        TRANSACTION_CSV = :transaction_csv
+        # Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account.
+        ACCOUNT_STATEMENT_OFX = :account_statement_ofx
+
+        # A PDF of an account verification letter.
+        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
 
         # Export a CSV of account balances for the dates in a given range. (deprecated, use `daily_account_balance_csv` instead)
         BALANCE_CSV = :balance_csv
@@ -104,20 +104,17 @@ module Increase
         # Export a CSV of bookkeeping account balances for the dates in a given range.
         BOOKKEEPING_ACCOUNT_BALANCE_CSV = :bookkeeping_account_balance_csv
 
-        # Export a CSV of entities with a given status.
-        ENTITY_CSV = :entity_csv
-
-        # Export a CSV of vendors added to the third-party risk management dashboard.
-        VENDOR_CSV = :vendor_csv
+        # Export a CSV of daily account balances with starting and ending balances for a given date range.
+        DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
 
         # Certain dashboard tables are available as CSV exports. This export cannot be created via the API.
         DASHBOARD_TABLE_CSV = :dashboard_table_csv
 
-        # A PDF of an account verification letter.
-        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
+        # Export a CSV of entities with a given status.
+        ENTITY_CSV = :entity_csv
 
-        # A PDF of funding instructions.
-        FUNDING_INSTRUCTIONS = :funding_instructions
+        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
+        FEE_CSV = :fee_csv
 
         # A PDF of an Internal Revenue Service Form 1099-INT.
         FORM_1099_INT = :form_1099_int
@@ -125,15 +122,18 @@ module Increase
         # A PDF of an Internal Revenue Service Form 1099-MISC.
         FORM_1099_MISC = :form_1099_misc
 
-        # Export a CSV of fees. The time range must not include any fees that are part of an open fee statement.
-        FEE_CSV = :fee_csv
+        # A PDF of funding instructions.
+        FUNDING_INSTRUCTIONS = :funding_instructions
+
+        # Export a CSV of all transactions for a given time range.
+        TRANSACTION_CSV = :transaction_csv
+
+        # Export a CSV of vendors added to the third-party risk management dashboard.
+        VENDOR_CSV = :vendor_csv
 
         # A PDF of a voided check.
         VOIDED_CHECK = :voided_check
 
-        # Export a CSV of daily account balances with starting and ending balances for a given date range.
-        DAILY_ACCOUNT_BALANCE_CSV = :daily_account_balance_csv
-
         # @!method self.values
         #   @return [Array<Symbol>]
       end