increase 1.32.0 → 1.34.0

data/lib/increase/models/card_validation_create_params.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardValidations#create
+    class CardValidationCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The identifier of the Account from which to send the validation.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute card_token_id
+      #   The Increase identifier for the Card Token that represents the card number
+      #   you're validating.
+      #
+      #   @return [String]
+      required :card_token_id, String
+
+      # @!attribute merchant_category_code
+      #   A four-digit code (MCC) identifying the type of business or service provided by
+      #   the merchant.
+      #
+      #   @return [String]
+      required :merchant_category_code, String
+
+      # @!attribute merchant_city_name
+      #   The city where the merchant (typically your business) is located.
+      #
+      #   @return [String]
+      required :merchant_city_name, String
+
+      # @!attribute merchant_name
+      #   The merchant name that will appear in the cardholder’s statement descriptor.
+      #   Typically your business name.
+      #
+      #   @return [String]
+      required :merchant_name, String
+
+      # @!attribute merchant_postal_code
+      #   The postal code for the merchant’s (typically your business’s) location.
+      #
+      #   @return [String]
+      required :merchant_postal_code, String
+
+      # @!attribute merchant_state
+      #   The U.S. state where the merchant (typically your business) is located.
+      #
+      #   @return [String]
+      required :merchant_state, String
+
+      # @!attribute cardholder_first_name
+      #   The cardholder's first name.
+      #
+      #   @return [String, nil]
+      optional :cardholder_first_name, String
+
+      # @!attribute cardholder_last_name
+      #   The cardholder's last name.
+      #
+      #   @return [String, nil]
+      optional :cardholder_last_name, String
+
+      # @!attribute cardholder_middle_name
+      #   The cardholder's middle name.
+      #
+      #   @return [String, nil]
+      optional :cardholder_middle_name, String
+
+      # @!attribute cardholder_postal_code
+      #   The postal code of the cardholder's address.
+      #
+      #   @return [String, nil]
+      optional :cardholder_postal_code, String
+
+      # @!attribute cardholder_street_address
+      #   The cardholder's street address.
+      #
+      #   @return [String, nil]
+      optional :cardholder_street_address, String
+
+      # @!method initialize(account_id:, card_token_id:, merchant_category_code:, merchant_city_name:, merchant_name:, merchant_postal_code:, merchant_state:, cardholder_first_name: nil, cardholder_last_name: nil, cardholder_middle_name: nil, cardholder_postal_code: nil, cardholder_street_address: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CardValidationCreateParams} for more details.
+      #
+      #   @param account_id [String] The identifier of the Account from which to send the validation.
+      #
+      #   @param card_token_id [String] The Increase identifier for the Card Token that represents the card number you'r
+      #
+      #   @param merchant_category_code [String] A four-digit code (MCC) identifying the type of business or service provided by
+      #
+      #   @param merchant_city_name [String] The city where the merchant (typically your business) is located.
+      #
+      #   @param merchant_name [String] The merchant name that will appear in the cardholder’s statement descriptor. Typ
+      #
+      #   @param merchant_postal_code [String] The postal code for the merchant’s (typically your business’s) location.
+      #
+      #   @param merchant_state [String] The U.S. state where the merchant (typically your business) is located.
+      #
+      #   @param cardholder_first_name [String] The cardholder's first name.
+      #
+      #   @param cardholder_last_name [String] The cardholder's last name.
+      #
+      #   @param cardholder_middle_name [String] The cardholder's middle name.
+      #
+      #   @param cardholder_postal_code [String] The postal code of the cardholder's address.
+      #
+      #   @param cardholder_street_address [String] The cardholder's street address.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/card_validation_list_params.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardValidations#list
+    class CardValidationListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Filter Card Validations to ones belonging to the specified Account.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::CardValidationListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::CardValidationListParams::CreatedAt }
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute idempotency_key
+      #   Filter records to the one with the specified `idempotency_key` you chose for
+      #   that 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).
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #
+      #   @return [Increase::Models::CardValidationListParams::Status, nil]
+      optional :status, -> { Increase::CardValidationListParams::Status }
+
+      # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CardValidationListParams} for more details.
+      #
+      #   @param account_id [String] Filter Card Validations to ones belonging to the specified Account.
+      #
+      #   @param created_at [Increase::Models::CardValidationListParams::CreatedAt]
+      #
+      #   @param cursor [String] Return the page of entries after this one.
+      #
+      #   @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param status [Increase::Models::CardValidationListParams::Status]
+      #
+      #   @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)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::CardValidationListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter Card Validations by status. For GET requests, this should be encoded as a
+        #   comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::CardValidationListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::CardValidationListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::CardValidationListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::CardValidationListParams::Status::In>] Filter Card Validations by status. For GET requests, this should be encoded as a
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The validation requires attention from an Increase operator.
+          REQUIRES_ATTENTION = :requires_attention
+
+          # The validation is queued to be submitted to the card network.
+          PENDING_SUBMISSION = :pending_submission
+
+          # The validation has been submitted and is pending a response from the card network.
+          SUBMITTED = :submitted
+
+          # The validation has been sent successfully and is complete.
+          COMPLETE = :complete
+
+          # The validation was declined by the network or the recipient's bank.
+          DECLINED = :declined
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/card_validation_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardValidations#retrieve
+    class CardValidationRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/entity_create_beneficial_owner_params.rb

@@ -119,6 +119,12 @@ module Increase
 
           # @see Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual#address
           class Address < Increase::Internal::Type::BaseModel
+            # @!attribute city
+            #   The city, district, town, or village of the address.
+            #
+            #   @return [String]
+            required :city, String
+
             # @!attribute country
             #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
             #
@@ -131,13 +137,6 @@ module Increase
             #   @return [String]
             required :line1, String
 
-            # @!attribute city
-            #   The city, district, town, or village of the address. Required in certain
-            #   countries.
-            #
-            #   @return [String, nil]
-            optional :city, String
-
             # @!attribute line2
             #   The second line of the address. This might be the floor or room number.
             #
@@ -157,7 +156,7 @@ module Increase
             #   @return [String, nil]
             optional :zip, String
 
-            # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil)
+            # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
             #   Some parameter documentations has been truncated, see
             #   {Increase::Models::EntityCreateBeneficialOwnerParams::BeneficialOwner::Individual::Address}
             #   for more details.
@@ -165,12 +164,12 @@ module Increase
             #   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 city [String] The city, district, town, or village of the address. Required in certain countri
-            #
             #   @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

data/lib/increase/models/entity_create_params.rb

@@ -349,6 +349,12 @@ module Increase
 
             # @see Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual#address
             class Address < Increase::Internal::Type::BaseModel
+              # @!attribute city
+              #   The city, district, town, or village of the address.
+              #
+              #   @return [String]
+              required :city, String
+
               # @!attribute country
               #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
               #
@@ -361,13 +367,6 @@ module Increase
               #   @return [String]
               required :line1, String
 
-              # @!attribute city
-              #   The city, district, town, or village of the address. Required in certain
-              #   countries.
-              #
-              #   @return [String, nil]
-              optional :city, String
-
               # @!attribute line2
               #   The second line of the address. This might be the floor or room number.
               #
@@ -387,7 +386,7 @@ module Increase
               #   @return [String, nil]
               optional :zip, String
 
-              # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil)
+              # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
               #   Some parameter documentations has been truncated, see
               #   {Increase::Models::EntityCreateParams::Corporation::BeneficialOwner::Individual::Address}
               #   for more details.
@@ -395,12 +394,12 @@ module Increase
               #   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 city [String] The city, district, town, or village of the address. Required in certain countri
-              #
               #   @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

data/lib/increase/models/entity_update_beneficial_owner_address_params.rb

@@ -32,6 +32,12 @@ module Increase
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 
       class Address < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city, district, town, or village of the address.
+        #
+        #   @return [String]
+        required :city, String
+
         # @!attribute country
         #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
         #
@@ -44,13 +50,6 @@ module Increase
         #   @return [String]
         required :line1, String
 
-        # @!attribute city
-        #   The city, district, town, or village of the address. Required in certain
-        #   countries.
-        #
-        #   @return [String, nil]
-        optional :city, String
-
         # @!attribute line2
         #   The second line of the address. This might be the floor or room number.
         #
@@ -70,7 +69,7 @@ module Increase
         #   @return [String, nil]
         optional :zip, String
 
-        # @!method initialize(country:, line1:, city: nil, line2: nil, state: nil, zip: nil)
+        # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::EntityUpdateBeneficialOwnerAddressParams::Address} for more
         #   details.
@@ -78,12 +77,12 @@ module Increase
         #   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 city [String] The city, district, town, or village of the address. Required in certain countri
-        #
         #   @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

data/lib/increase/models/simulations/card_token_create_params.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::CardTokens#create
+      class CardTokenCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute capabilities
+        #   The capabilities of the outbound card token.
+        #
+        #   @return [Array<Increase::Models::Simulations::CardTokenCreateParams::Capability>, nil]
+        optional :capabilities,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[Increase::Simulations::CardTokenCreateParams::Capability]
+                 }
+
+        # @!attribute expiration
+        #   The expiration date of the card.
+        #
+        #   @return [Date, nil]
+        optional :expiration, Date
+
+        # @!attribute last4
+        #   The last 4 digits of the card number.
+        #
+        #   @return [String, nil]
+        optional :last4, String
+
+        # @!attribute prefix
+        #   The prefix of the card number, usually the first 8 digits.
+        #
+        #   @return [String, nil]
+        optional :prefix, String
+
+        # @!attribute primary_account_number_length
+        #   The total length of the card number, including prefix and last4.
+        #
+        #   @return [Integer, nil]
+        optional :primary_account_number_length, Integer
+
+        # @!method initialize(capabilities: nil, expiration: nil, last4: nil, prefix: nil, primary_account_number_length: nil, request_options: {})
+        #   @param capabilities [Array<Increase::Models::Simulations::CardTokenCreateParams::Capability>] The capabilities of the outbound card token.
+        #
+        #   @param expiration [Date] The expiration date of the card.
+        #
+        #   @param last4 [String] The last 4 digits of the card number.
+        #
+        #   @param prefix [String] The prefix of the card number, usually the first 8 digits.
+        #
+        #   @param primary_account_number_length [Integer] The total length of the card number, including prefix and last4.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        class Capability < Increase::Internal::Type::BaseModel
+          # @!attribute cross_border_push_transfers
+          #   The cross-border push transfers capability.
+          #
+          #   @return [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers]
+          required :cross_border_push_transfers,
+                   enum: -> {
+                     Increase::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers
+                   }
+
+          # @!attribute domestic_push_transfers
+          #   The domestic push transfers capability.
+          #
+          #   @return [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers]
+          required :domestic_push_transfers,
+                   enum: -> {
+                     Increase::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers
+                   }
+
+          # @!attribute route
+          #   The route of the capability.
+          #
+          #   @return [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::Route]
+          required :route, enum: -> { Increase::Simulations::CardTokenCreateParams::Capability::Route }
+
+          # @!method initialize(cross_border_push_transfers:, domestic_push_transfers:, route:)
+          #   @param cross_border_push_transfers [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::CrossBorderPushTransfers] The cross-border push transfers capability.
+          #
+          #   @param domestic_push_transfers [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::DomesticPushTransfers] The domestic push transfers capability.
+          #
+          #   @param route [Symbol, Increase::Models::Simulations::CardTokenCreateParams::Capability::Route] The route of the capability.
+
+          # The cross-border push transfers capability.
+          #
+          # @see Increase::Models::Simulations::CardTokenCreateParams::Capability#cross_border_push_transfers
+          module CrossBorderPushTransfers
+            extend Increase::Internal::Type::Enum
+
+            # The capability is supported.
+            SUPPORTED = :supported
+
+            # The capability is not supported.
+            NOT_SUPPORTED = :not_supported
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The domestic push transfers capability.
+          #
+          # @see Increase::Models::Simulations::CardTokenCreateParams::Capability#domestic_push_transfers
+          module DomesticPushTransfers
+            extend Increase::Internal::Type::Enum
+
+            # The capability is supported.
+            SUPPORTED = :supported
+
+            # The capability is not supported.
+            NOT_SUPPORTED = :not_supported
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The route of the capability.
+          #
+          # @see Increase::Models::Simulations::CardTokenCreateParams::Capability#route
+          module Route
+            extend Increase::Internal::Type::Enum
+
+            # Visa and Interlink
+            VISA = :visa
+
+            # Mastercard and Maestro
+            MASTERCARD = :mastercard
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/increase/models.rb

@@ -159,10 +159,40 @@ module Increase
 
   CardPurchaseSupplementRetrieveParams = Increase::Models::CardPurchaseSupplementRetrieveParams
 
+  CardPushTransfer = Increase::Models::CardPushTransfer
+
+  CardPushTransferApproveParams = Increase::Models::CardPushTransferApproveParams
+
+  CardPushTransferCancelParams = Increase::Models::CardPushTransferCancelParams
+
+  CardPushTransferCreateParams = Increase::Models::CardPushTransferCreateParams
+
+  CardPushTransferListParams = Increase::Models::CardPushTransferListParams
+
+  CardPushTransferRetrieveParams = Increase::Models::CardPushTransferRetrieveParams
+
   CardRetrieveParams = Increase::Models::CardRetrieveParams
 
+  CardToken = Increase::Models::CardToken
+
+  CardTokenCapabilities = Increase::Models::CardTokenCapabilities
+
+  CardTokenCapabilitiesParams = Increase::Models::CardTokenCapabilitiesParams
+
+  CardTokenListParams = Increase::Models::CardTokenListParams
+
+  CardTokenRetrieveParams = Increase::Models::CardTokenRetrieveParams
+
   CardUpdateParams = Increase::Models::CardUpdateParams
 
+  CardValidation = Increase::Models::CardValidation
+
+  CardValidationCreateParams = Increase::Models::CardValidationCreateParams
+
+  CardValidationListParams = Increase::Models::CardValidationListParams
+
+  CardValidationRetrieveParams = Increase::Models::CardValidationRetrieveParams
+
   CheckDeposit = Increase::Models::CheckDeposit
 
   CheckDepositCreateParams = Increase::Models::CheckDepositCreateParams