increase 1.32.0 → 1.34.0

data/rbi/increase/models/card_validation_create_params.rbi

@@ -0,0 +1,155 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardValidationCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::CardValidationCreateParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Account from which to send the validation.
+      sig { returns(String) }
+      attr_accessor :account_id
+
+      # The Increase identifier for the Card Token that represents the card number
+      # you're validating.
+      sig { returns(String) }
+      attr_accessor :card_token_id
+
+      # A four-digit code (MCC) identifying the type of business or service provided by
+      # the merchant.
+      sig { returns(String) }
+      attr_accessor :merchant_category_code
+
+      # The city where the merchant (typically your business) is located.
+      sig { returns(String) }
+      attr_accessor :merchant_city_name
+
+      # The merchant name that will appear in the cardholder’s statement descriptor.
+      # Typically your business name.
+      sig { returns(String) }
+      attr_accessor :merchant_name
+
+      # The postal code for the merchant’s (typically your business’s) location.
+      sig { returns(String) }
+      attr_accessor :merchant_postal_code
+
+      # The U.S. state where the merchant (typically your business) is located.
+      sig { returns(String) }
+      attr_accessor :merchant_state
+
+      # The cardholder's first name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cardholder_first_name
+
+      sig { params(cardholder_first_name: String).void }
+      attr_writer :cardholder_first_name
+
+      # The cardholder's last name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cardholder_last_name
+
+      sig { params(cardholder_last_name: String).void }
+      attr_writer :cardholder_last_name
+
+      # The cardholder's middle name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cardholder_middle_name
+
+      sig { params(cardholder_middle_name: String).void }
+      attr_writer :cardholder_middle_name
+
+      # The postal code of the cardholder's address.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cardholder_postal_code
+
+      sig { params(cardholder_postal_code: String).void }
+      attr_writer :cardholder_postal_code
+
+      # The cardholder's street address.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cardholder_street_address
+
+      sig { params(cardholder_street_address: String).void }
+      attr_writer :cardholder_street_address
+
+      sig do
+        params(
+          account_id: String,
+          card_token_id: String,
+          merchant_category_code: String,
+          merchant_city_name: String,
+          merchant_name: String,
+          merchant_postal_code: String,
+          merchant_state: String,
+          cardholder_first_name: String,
+          cardholder_last_name: String,
+          cardholder_middle_name: String,
+          cardholder_postal_code: String,
+          cardholder_street_address: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Account from which to send the validation.
+        account_id:,
+        # The Increase identifier for the Card Token that represents the card number
+        # you're validating.
+        card_token_id:,
+        # A four-digit code (MCC) identifying the type of business or service provided by
+        # the merchant.
+        merchant_category_code:,
+        # The city where the merchant (typically your business) is located.
+        merchant_city_name:,
+        # The merchant name that will appear in the cardholder’s statement descriptor.
+        # Typically your business name.
+        merchant_name:,
+        # The postal code for the merchant’s (typically your business’s) location.
+        merchant_postal_code:,
+        # The U.S. state where the merchant (typically your business) is located.
+        merchant_state:,
+        # The cardholder's first name.
+        cardholder_first_name: nil,
+        # The cardholder's last name.
+        cardholder_last_name: nil,
+        # The cardholder's middle name.
+        cardholder_middle_name: nil,
+        # The postal code of the cardholder's address.
+        cardholder_postal_code: nil,
+        # The cardholder's street address.
+        cardholder_street_address: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            card_token_id: String,
+            merchant_category_code: String,
+            merchant_city_name: String,
+            merchant_name: String,
+            merchant_postal_code: String,
+            merchant_state: String,
+            cardholder_first_name: String,
+            cardholder_last_name: String,
+            cardholder_middle_name: String,
+            cardholder_postal_code: String,
+            cardholder_street_address: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/card_validation_list_params.rbi

@@ -0,0 +1,295 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardValidationListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CardValidationListParams, Increase::Internal::AnyHash)
+        end
+
+      # Filter Card Validations to ones belonging to the specified Account.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      sig { returns(T.nilable(Increase::CardValidationListParams::CreatedAt)) }
+      attr_reader :created_at
+
+      sig do
+        params(
+          created_at: Increase::CardValidationListParams::CreatedAt::OrHash
+        ).void
+      end
+      attr_writer :created_at
+
+      # Return the page of entries after this one.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # 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).
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # Limit the size of the list that is returned. The default (and maximum) is 100
+      # objects.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig { returns(T.nilable(Increase::CardValidationListParams::Status)) }
+      attr_reader :status
+
+      sig do
+        params(status: Increase::CardValidationListParams::Status::OrHash).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          account_id: String,
+          created_at: Increase::CardValidationListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::CardValidationListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter Card Validations to ones belonging to the specified Account.
+        account_id: nil,
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # 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).
+        idempotency_key: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            created_at: Increase::CardValidationListParams::CreatedAt,
+            cursor: String,
+            idempotency_key: String,
+            limit: Integer,
+            status: Increase::CardValidationListParams::Status,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CardValidationListParams::CreatedAt,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        # timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :after
+
+        sig { params(after: Time).void }
+        attr_writer :after
+
+        # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        # timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :before
+
+        sig { params(before: Time).void }
+        attr_writer :before
+
+        # Return results on or after this
+        # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :on_or_after
+
+        sig { params(on_or_after: Time).void }
+        attr_writer :on_or_after
+
+        # Return results on or before this
+        # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :on_or_before
+
+        sig { params(on_or_before: Time).void }
+        attr_writer :on_or_before
+
+        sig do
+          params(
+            after: Time,
+            before: Time,
+            on_or_after: Time,
+            on_or_before: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+          # timestamp.
+          after: nil,
+          # Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+          # timestamp.
+          before: nil,
+          # Return results on or after this
+          # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+          on_or_after: nil,
+          # Return results on or before this
+          # [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+          on_or_before: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { after: Time, before: Time, on_or_after: Time, on_or_before: Time }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CardValidationListParams::Status,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # Filter Card Validations by status. For GET requests, this should be encoded as a
+        # comma-delimited string, such as `?in=one,two,three`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Increase::CardValidationListParams::Status::In::OrSymbol]
+            )
+          )
+        end
+        attr_reader :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[Increase::CardValidationListParams::Status::In::OrSymbol]
+          ).void
+        end
+        attr_writer :in_
+
+        sig do
+          params(
+            in_:
+              T::Array[Increase::CardValidationListParams::Status::In::OrSymbol]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter Card Validations by status. For GET requests, this should be encoded as a
+          # comma-delimited string, such as `?in=one,two,three`.
+          in_: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              in_:
+                T::Array[
+                  Increase::CardValidationListParams::Status::In::OrSymbol
+                ]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::CardValidationListParams::Status::In)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The validation requires attention from an Increase operator.
+          REQUIRES_ATTENTION =
+            T.let(
+              :requires_attention,
+              Increase::CardValidationListParams::Status::In::TaggedSymbol
+            )
+
+          # The validation is queued to be submitted to the card network.
+          PENDING_SUBMISSION =
+            T.let(
+              :pending_submission,
+              Increase::CardValidationListParams::Status::In::TaggedSymbol
+            )
+
+          # The validation has been submitted and is pending a response from the card network.
+          SUBMITTED =
+            T.let(
+              :submitted,
+              Increase::CardValidationListParams::Status::In::TaggedSymbol
+            )
+
+          # The validation has been sent successfully and is complete.
+          COMPLETE =
+            T.let(
+              :complete,
+              Increase::CardValidationListParams::Status::In::TaggedSymbol
+            )
+
+          # The validation was declined by the network or the recipient's bank.
+          DECLINED =
+            T.let(
+              :declined,
+              Increase::CardValidationListParams::Status::In::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::CardValidationListParams::Status::In::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/card_validation_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardValidationRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::CardValidationRetrieveParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Increase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Increase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/entity_create_beneficial_owner_params.rbi

@@ -256,6 +256,10 @@ module Increase
                 )
               end
 
+            # The city, district, town, or village of the address.
+            sig { returns(String) }
+            attr_accessor :city
+
             # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
             sig { returns(String) }
             attr_accessor :country
@@ -264,14 +268,6 @@ module Increase
             sig { returns(String) }
             attr_accessor :line1
 
-            # The city, district, town, or village of the address. Required in certain
-            # countries.
-            sig { returns(T.nilable(String)) }
-            attr_reader :city
-
-            sig { params(city: String).void }
-            attr_writer :city
-
             # The second line of the address. This might be the floor or room number.
             sig { returns(T.nilable(String)) }
             attr_reader :line2
@@ -298,22 +294,21 @@ module Increase
             # PMB's are disallowed.
             sig do
               params(
+                city: String,
                 country: String,
                 line1: String,
-                city: String,
                 line2: String,
                 state: String,
                 zip: String
               ).returns(T.attached_class)
             end
             def self.new(
+              # The city, district, town, or village of the address.
+              city:,
               # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
               country:,
               # The first line of the address. This is usually the street number and street.
               line1:,
-              # The city, district, town, or village of the address. Required in certain
-              # countries.
-              city: nil,
               # The second line of the address. This might be the floor or room number.
               line2: nil,
               # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -327,9 +322,9 @@ module Increase
             sig do
               override.returns(
                 {
+                  city: String,
                   country: String,
                   line1: String,
-                  city: String,
                   line2: String,
                   state: String,
                   zip: String

data/rbi/increase/models/entity_create_params.rbi

@@ -656,6 +656,10 @@ module Increase
                   )
                 end
 
+              # The city, district, town, or village of the address.
+              sig { returns(String) }
+              attr_accessor :city
+
               # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
               sig { returns(String) }
               attr_accessor :country
@@ -664,14 +668,6 @@ module Increase
               sig { returns(String) }
               attr_accessor :line1
 
-              # The city, district, town, or village of the address. Required in certain
-              # countries.
-              sig { returns(T.nilable(String)) }
-              attr_reader :city
-
-              sig { params(city: String).void }
-              attr_writer :city
-
               # The second line of the address. This might be the floor or room number.
               sig { returns(T.nilable(String)) }
               attr_reader :line2
@@ -698,22 +694,21 @@ module Increase
               # PMB's are disallowed.
               sig do
                 params(
+                  city: String,
                   country: String,
                   line1: String,
-                  city: String,
                   line2: String,
                   state: String,
                   zip: String
                 ).returns(T.attached_class)
               end
               def self.new(
+                # The city, district, town, or village of the address.
+                city:,
                 # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
                 country:,
                 # The first line of the address. This is usually the street number and street.
                 line1:,
-                # The city, district, town, or village of the address. Required in certain
-                # countries.
-                city: nil,
                 # The second line of the address. This might be the floor or room number.
                 line2: nil,
                 # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -727,9 +722,9 @@ module Increase
               sig do
                 override.returns(
                   {
+                    city: String,
                     country: String,
                     line1: String,
-                    city: String,
                     line2: String,
                     state: String,
                     zip: String

data/rbi/increase/models/entity_update_beneficial_owner_address_params.rbi

@@ -75,6 +75,10 @@ module Increase
             )
           end
 
+        # The city, district, town, or village of the address.
+        sig { returns(String) }
+        attr_accessor :city
+
         # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
         sig { returns(String) }
         attr_accessor :country
@@ -83,14 +87,6 @@ module Increase
         sig { returns(String) }
         attr_accessor :line1
 
-        # The city, district, town, or village of the address. Required in certain
-        # countries.
-        sig { returns(T.nilable(String)) }
-        attr_reader :city
-
-        sig { params(city: String).void }
-        attr_writer :city
-
         # The second line of the address. This might be the floor or room number.
         sig { returns(T.nilable(String)) }
         attr_reader :line2
@@ -117,22 +113,21 @@ module Increase
         # PMB's are disallowed.
         sig do
           params(
+            city: String,
             country: String,
             line1: String,
-            city: String,
             line2: String,
             state: String,
             zip: String
           ).returns(T.attached_class)
         end
         def self.new(
+          # The city, district, town, or village of the address.
+          city:,
           # The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           country:,
           # The first line of the address. This is usually the street number and street.
           line1:,
-          # The city, district, town, or village of the address. Required in certain
-          # countries.
-          city: nil,
           # The second line of the address. This might be the floor or room number.
           line2: nil,
           # The two-letter United States Postal Service (USPS) abbreviation for the US
@@ -146,9 +141,9 @@ module Increase
         sig do
           override.returns(
             {
+              city: String,
               country: String,
               line1: String,
-              city: String,
               line2: String,
               state: String,
               zip: String