increase 1.353.0 → 1.355.0

data/sig/increase/models/digital_wallet_token_request.rbs

@@ -0,0 +1,260 @@
+module Increase
+  module Models
+    type digital_wallet_token_request =
+      {
+        id: String,
+        card_id: String,
+        created_at: Time,
+        declined: Increase::DigitalWalletTokenRequest::Declined?,
+        device: Increase::DigitalWalletTokenRequest::Device,
+        outcome: Increase::Models::DigitalWalletTokenRequest::outcome,
+        provisioned: Increase::DigitalWalletTokenRequest::Provisioned?,
+        token_reference_identifier: String,
+        token_requestor: Increase::Models::DigitalWalletTokenRequest::token_requestor,
+        type: Increase::Models::DigitalWalletTokenRequest::type_
+      }
+
+    class DigitalWalletTokenRequest < Increase::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor card_id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor declined: Increase::DigitalWalletTokenRequest::Declined?
+
+      attr_accessor device: Increase::DigitalWalletTokenRequest::Device
+
+      attr_accessor outcome: Increase::Models::DigitalWalletTokenRequest::outcome
+
+      attr_accessor provisioned: Increase::DigitalWalletTokenRequest::Provisioned?
+
+      attr_accessor token_reference_identifier: String
+
+      attr_accessor token_requestor: Increase::Models::DigitalWalletTokenRequest::token_requestor
+
+      attr_accessor type: Increase::Models::DigitalWalletTokenRequest::type_
+
+      def initialize: (
+        id: String,
+        card_id: String,
+        created_at: Time,
+        declined: Increase::DigitalWalletTokenRequest::Declined?,
+        device: Increase::DigitalWalletTokenRequest::Device,
+        outcome: Increase::Models::DigitalWalletTokenRequest::outcome,
+        provisioned: Increase::DigitalWalletTokenRequest::Provisioned?,
+        token_reference_identifier: String,
+        token_requestor: Increase::Models::DigitalWalletTokenRequest::token_requestor,
+        type: Increase::Models::DigitalWalletTokenRequest::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        card_id: String,
+        created_at: Time,
+        declined: Increase::DigitalWalletTokenRequest::Declined?,
+        device: Increase::DigitalWalletTokenRequest::Device,
+        outcome: Increase::Models::DigitalWalletTokenRequest::outcome,
+        provisioned: Increase::DigitalWalletTokenRequest::Provisioned?,
+        token_reference_identifier: String,
+        token_requestor: Increase::Models::DigitalWalletTokenRequest::token_requestor,
+        type: Increase::Models::DigitalWalletTokenRequest::type_
+      }
+
+      type declined =
+        {
+          reason: Increase::Models::DigitalWalletTokenRequest::Declined::reason
+        }
+
+      class Declined < Increase::Internal::Type::BaseModel
+        attr_accessor reason: Increase::Models::DigitalWalletTokenRequest::Declined::reason
+
+        def initialize: (
+          reason: Increase::Models::DigitalWalletTokenRequest::Declined::reason
+        ) -> void
+
+        def to_hash: -> {
+          reason: Increase::Models::DigitalWalletTokenRequest::Declined::reason
+        }
+
+        type reason =
+          :card_not_active
+          | :no_verification_method
+          | :webhook_timed_out
+          | :webhook_declined
+          | :incorrect_card_verification_code
+          | :declined_by_token_requestor
+          | :group_locked
+          | :account_closed
+          | :entity_not_active
+
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The card is not active.
+          CARD_NOT_ACTIVE: :card_not_active
+
+          # The card does not have a two-factor authentication method.
+          NO_VERIFICATION_METHOD: :no_verification_method
+
+          # Your webhook timed out when evaluating the token provisioning attempt.
+          WEBHOOK_TIMED_OUT: :webhook_timed_out
+
+          # Your webhook declined the token provisioning attempt.
+          WEBHOOK_DECLINED: :webhook_declined
+
+          # The tokenization attempt failed because the Card Verification Code (CVC) was incorrect.
+          INCORRECT_CARD_VERIFICATION_CODE: :incorrect_card_verification_code
+
+          # The tokenization attempt was declined by the token requestor.
+          DECLINED_BY_TOKEN_REQUESTOR: :declined_by_token_requestor
+
+          # The group was locked.
+          GROUP_LOCKED: :group_locked
+
+          # The account has been closed.
+          ACCOUNT_CLOSED: :account_closed
+
+          # The account's entity was not active.
+          ENTITY_NOT_ACTIVE: :entity_not_active
+
+          def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::Declined::reason]
+        end
+      end
+
+      type device =
+        {
+          device_type: Increase::Models::DigitalWalletTokenRequest::Device::device_type?,
+          identifier: String?,
+          ip_address: String?,
+          name: String?
+        }
+
+      class Device < Increase::Internal::Type::BaseModel
+        attr_accessor device_type: Increase::Models::DigitalWalletTokenRequest::Device::device_type?
+
+        attr_accessor identifier: String?
+
+        attr_accessor ip_address: String?
+
+        attr_accessor name: String?
+
+        def initialize: (
+          device_type: Increase::Models::DigitalWalletTokenRequest::Device::device_type?,
+          identifier: String?,
+          ip_address: String?,
+          name: String?
+        ) -> void
+
+        def to_hash: -> {
+          device_type: Increase::Models::DigitalWalletTokenRequest::Device::device_type?,
+          identifier: String?,
+          ip_address: String?,
+          name: String?
+        }
+
+        type device_type =
+          :unknown
+          | :mobile_phone
+          | :tablet
+          | :watch
+          | :mobilephone_or_tablet
+          | :pc
+          | :household_device
+          | :wearable_device
+          | :automobile_device
+
+        module DeviceType
+          extend Increase::Internal::Type::Enum
+
+          # Unknown
+          UNKNOWN: :unknown
+
+          # Mobile Phone
+          MOBILE_PHONE: :mobile_phone
+
+          # Tablet
+          TABLET: :tablet
+
+          # Watch
+          WATCH: :watch
+
+          # Mobile Phone or Tablet
+          MOBILEPHONE_OR_TABLET: :mobilephone_or_tablet
+
+          # PC
+          PC: :pc
+
+          # Household Device
+          HOUSEHOLD_DEVICE: :household_device
+
+          # Wearable Device
+          WEARABLE_DEVICE: :wearable_device
+
+          # Automobile Device
+          AUTOMOBILE_DEVICE: :automobile_device
+
+          def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::Device::device_type]
+        end
+      end
+
+      type outcome = :provisioned | :declined
+
+      module Outcome
+        extend Increase::Internal::Type::Enum
+
+        # The tokenization request was approved and a Digital Wallet Token was provisioned.
+        PROVISIONED: :provisioned
+
+        # The tokenization request was declined.
+        DECLINED: :declined
+
+        def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::outcome]
+      end
+
+      type provisioned = { digital_wallet_token_id: String }
+
+      class Provisioned < Increase::Internal::Type::BaseModel
+        attr_accessor digital_wallet_token_id: String
+
+        def initialize: (digital_wallet_token_id: String) -> void
+
+        def to_hash: -> { digital_wallet_token_id: String }
+      end
+
+      type token_requestor =
+        :apple_pay | :google_pay | :samsung_pay | :garmin_pay | :unknown
+
+      module TokenRequestor
+        extend Increase::Internal::Type::Enum
+
+        # Apple Pay
+        APPLE_PAY: :apple_pay
+
+        # Google Pay
+        GOOGLE_PAY: :google_pay
+
+        # Samsung Pay
+        SAMSUNG_PAY: :samsung_pay
+
+        # Garmin Pay
+        GARMIN_PAY: :garmin_pay
+
+        # Unknown
+        UNKNOWN: :unknown
+
+        def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::token_requestor]
+      end
+
+      type type_ = :digital_wallet_token_request
+
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        DIGITAL_WALLET_TOKEN_REQUEST: :digital_wallet_token_request
+
+        def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenRequest::type_]
+      end
+    end
+  end
+end

data/sig/increase/models/digital_wallet_token_request_list_params.rbs

@@ -0,0 +1,86 @@
+module Increase
+  module Models
+    type digital_wallet_token_request_list_params =
+      {
+        card_id: String,
+        created_at: Increase::DigitalWalletTokenRequestListParams::CreatedAt,
+        cursor: String,
+        limit: Integer
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class DigitalWalletTokenRequestListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_reader card_id: String?
+
+      def card_id=: (String) -> String
+
+      attr_reader created_at: Increase::DigitalWalletTokenRequestListParams::CreatedAt?
+
+      def created_at=: (
+        Increase::DigitalWalletTokenRequestListParams::CreatedAt
+      ) -> Increase::DigitalWalletTokenRequestListParams::CreatedAt
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      def initialize: (
+        ?card_id: String,
+        ?created_at: Increase::DigitalWalletTokenRequestListParams::CreatedAt,
+        ?cursor: String,
+        ?limit: Integer,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        card_id: String,
+        created_at: Increase::DigitalWalletTokenRequestListParams::CreatedAt,
+        cursor: String,
+        limit: Integer,
+        request_options: Increase::RequestOptions
+      }
+
+      type created_at =
+        { after: Time, before: Time, on_or_after: Time, on_or_before: Time }
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        attr_reader after: Time?
+
+        def after=: (Time) -> Time
+
+        attr_reader before: Time?
+
+        def before=: (Time) -> Time
+
+        attr_reader on_or_after: Time?
+
+        def on_or_after=: (Time) -> Time
+
+        attr_reader on_or_before: Time?
+
+        def on_or_before=: (Time) -> Time
+
+        def initialize: (
+          ?after: Time,
+          ?before: Time,
+          ?on_or_after: Time,
+          ?on_or_before: Time
+        ) -> void
+
+        def to_hash: -> {
+          after: Time,
+          before: Time,
+          on_or_after: Time,
+          on_or_before: Time
+        }
+      end
+    end
+  end
+end

data/sig/increase/models/digital_wallet_token_request_retrieve_params.rbs

@@ -0,0 +1,24 @@
+module Increase
+  module Models
+    type digital_wallet_token_request_retrieve_params =
+      { digital_wallet_token_request_id: String }
+      & Increase::Internal::Type::request_parameters
+
+    class DigitalWalletTokenRequestRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor digital_wallet_token_request_id: String
+
+      def initialize: (
+        digital_wallet_token_request_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        digital_wallet_token_request_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/digital_wallet_token_transition_params.rbs

@@ -0,0 +1,48 @@
+module Increase
+  module Models
+    type digital_wallet_token_transition_params =
+      {
+        digital_wallet_token_id: String,
+        status: Increase::Models::DigitalWalletTokenTransitionParams::status
+      }
+      & Increase::Internal::Type::request_parameters
+
+    class DigitalWalletTokenTransitionParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor digital_wallet_token_id: String
+
+      attr_accessor status: Increase::Models::DigitalWalletTokenTransitionParams::status
+
+      def initialize: (
+        digital_wallet_token_id: String,
+        status: Increase::Models::DigitalWalletTokenTransitionParams::status,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        digital_wallet_token_id: String,
+        status: Increase::Models::DigitalWalletTokenTransitionParams::status,
+        request_options: Increase::RequestOptions
+      }
+
+      type status = :active | :suspended | :deactivated
+
+      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
+
+        def self?.values: -> ::Array[Increase::Models::DigitalWalletTokenTransitionParams::status]
+      end
+    end
+  end
+end

data/sig/increase/models/entity.rbs

@@ -348,7 +348,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).
@@ -690,7 +690,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).
@@ -819,7 +819,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).
@@ -1071,7 +1071,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).
@@ -1424,7 +1424,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).
@@ -1573,7 +1573,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).
@@ -1641,6 +1641,7 @@ module Increase
           {
             beneficial_owner_address: Increase::Entity::Validation::Issue::BeneficialOwnerAddress?,
             beneficial_owner_identity: Increase::Entity::Validation::Issue::BeneficialOwnerIdentity?,
+            beneficial_owner_tax_identifier: Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier?,
             category: Increase::Models::Entity::Validation::Issue::category,
             entity_address: Increase::Entity::Validation::Issue::EntityAddress?,
             entity_identity: Increase::Entity::Validation::Issue::EntityIdentity?,
@@ -1652,6 +1653,8 @@ module Increase
 
           attr_accessor beneficial_owner_identity: Increase::Entity::Validation::Issue::BeneficialOwnerIdentity?
 
+          attr_accessor beneficial_owner_tax_identifier: Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier?
+
           attr_accessor category: Increase::Models::Entity::Validation::Issue::category
 
           attr_accessor entity_address: Increase::Entity::Validation::Issue::EntityAddress?
@@ -1663,6 +1666,7 @@ module Increase
           def initialize: (
             beneficial_owner_address: Increase::Entity::Validation::Issue::BeneficialOwnerAddress?,
             beneficial_owner_identity: Increase::Entity::Validation::Issue::BeneficialOwnerIdentity?,
+            beneficial_owner_tax_identifier: Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier?,
             category: Increase::Models::Entity::Validation::Issue::category,
             entity_address: Increase::Entity::Validation::Issue::EntityAddress?,
             entity_identity: Increase::Entity::Validation::Issue::EntityIdentity?,
@@ -1672,6 +1676,7 @@ module Increase
           def to_hash: -> {
             beneficial_owner_address: Increase::Entity::Validation::Issue::BeneficialOwnerAddress?,
             beneficial_owner_identity: Increase::Entity::Validation::Issue::BeneficialOwnerIdentity?,
+            beneficial_owner_tax_identifier: Increase::Entity::Validation::Issue::BeneficialOwnerTaxIdentifier?,
             category: Increase::Models::Entity::Validation::Issue::category,
             entity_address: Increase::Entity::Validation::Issue::EntityAddress?,
             entity_identity: Increase::Entity::Validation::Issue::EntityIdentity?,
@@ -1721,12 +1726,23 @@ module Increase
             def to_hash: -> { beneficial_owner_id: String }
           end
 
+          type beneficial_owner_tax_identifier = { beneficial_owner_id: String }
+
+          class BeneficialOwnerTaxIdentifier < Increase::Internal::Type::BaseModel
+            attr_accessor beneficial_owner_id: String
+
+            def initialize: (beneficial_owner_id: String) -> void
+
+            def to_hash: -> { beneficial_owner_id: String }
+          end
+
           type category =
             :entity_tax_identifier
             | :entity_address
             | :entity_identity
             | :beneficial_owner_identity
             | :beneficial_owner_address
+            | :beneficial_owner_tax_identifier
 
           module Category
             extend Increase::Internal::Type::Enum
@@ -1746,6 +1762,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
+
             def self?.values: -> ::Array[Increase::Models::Entity::Validation::Issue::category]
           end
 

data/sig/increase/models/entity_beneficial_owner.rbs

@@ -159,7 +159,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/sig/increase/models/entity_create_params.rbs

@@ -443,7 +443,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/sig/increase/models/export.rbs

@@ -253,33 +253,33 @@ module Increase
       end
 
       type category =
-        :account_statement_ofx
-        | :account_statement_bai2
-        | :transaction_csv
+        :account_statement_bai2
+        | :account_statement_ofx
+        | :account_verification_letter
         | :balance_csv
         | :bookkeeping_account_balance_csv
-        | :entity_csv
-        | :vendor_csv
+        | :daily_account_balance_csv
         | :dashboard_table_csv
-        | :account_verification_letter
-        | :funding_instructions
+        | :entity_csv
+        | :fee_csv
         | :form_1099_int
         | :form_1099_misc
-        | :fee_csv
+        | :funding_instructions
+        | :transaction_csv
+        | :vendor_csv
         | :voided_check
-        | :daily_account_balance_csv
 
       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
@@ -287,20 +287,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
@@ -308,15 +305,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
-
         def self?.values: -> ::Array[Increase::Models::Export::category]
       end