increase 1.81.0 → 1.83.0

data/rbi/increase/models/card_detail_update_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardDetailUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CardDetailUpdateParams, Increase::Internal::AnyHash)
+        end
+
+      # The 4-digit PIN for the card, for use with ATMs.
+      sig { returns(String) }
+      attr_accessor :pin
+
+      sig do
+        params(
+          pin: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The 4-digit PIN for the card, for use with ATMs.
+        pin:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { pin: String, request_options: Increase::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/card_details.rbi

@@ -2,10 +2,10 @@
 
 module Increase
   module Models
-    class CardDetails < Increase::Internal::Type::BaseModel
+    class CardDetailsAPI < Increase::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
-          T.any(Increase::CardDetails, Increase::Internal::AnyHash)
+          T.any(Increase::CardDetailsAPI, Increase::Internal::AnyHash)
         end
 
       # The identifier for the Card for which sensitive details have been returned.
@@ -30,7 +30,7 @@ module Increase
 
       # A constant representing the object's type. For this resource it will always be
       # `card_details`.
-      sig { returns(Increase::CardDetails::Type::TaggedSymbol) }
+      sig { returns(Increase::CardDetailsAPI::Type::TaggedSymbol) }
       attr_accessor :type
 
       # The three-digit verification code for the card. It's also known as the Card
@@ -39,7 +39,7 @@ module Increase
       sig { returns(String) }
       attr_accessor :verification_code
 
-      # An object containing the sensitive details (card number, cvc, etc) for a Card.
+      # An object containing the sensitive details (card number, CVC, etc) for a Card.
       sig do
         params(
           card_id: String,
@@ -47,7 +47,7 @@ module Increase
           expiration_year: Integer,
           pin: String,
           primary_account_number: String,
-          type: Increase::CardDetails::Type::OrSymbol,
+          type: Increase::CardDetailsAPI::Type::OrSymbol,
           verification_code: String
         ).returns(T.attached_class)
       end
@@ -80,7 +80,7 @@ module Increase
             expiration_year: Integer,
             pin: String,
             primary_account_number: String,
-            type: Increase::CardDetails::Type::TaggedSymbol,
+            type: Increase::CardDetailsAPI::Type::TaggedSymbol,
             verification_code: String
           }
         )
@@ -94,14 +94,16 @@ module Increase
         extend Increase::Internal::Type::Enum
 
         TaggedSymbol =
-          T.type_alias { T.all(Symbol, Increase::CardDetails::Type) }
+          T.type_alias { T.all(Symbol, Increase::CardDetailsAPI::Type) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         CARD_DETAILS =
-          T.let(:card_details, Increase::CardDetails::Type::TaggedSymbol)
+          T.let(:card_details, Increase::CardDetailsAPI::Type::TaggedSymbol)
 
         sig do
-          override.returns(T::Array[Increase::CardDetails::Type::TaggedSymbol])
+          override.returns(
+            T::Array[Increase::CardDetailsAPI::Type::TaggedSymbol]
+          )
         end
         def self.values
         end

data/rbi/increase/models/card_update_params.rbi

@@ -50,6 +50,13 @@ module Increase
       sig { params(entity_id: String).void }
       attr_writer :entity_id
 
+      # The 4-digit PIN for the card, for use with ATMs.
+      sig { returns(T.nilable(String)) }
+      attr_reader :pin
+
+      sig { params(pin: String).void }
+      attr_writer :pin
+
       # The status to update the Card with.
       sig { returns(T.nilable(Increase::CardUpdateParams::Status::OrSymbol)) }
       attr_reader :status
@@ -63,6 +70,7 @@ module Increase
           description: String,
           digital_wallet: Increase::CardUpdateParams::DigitalWallet::OrHash,
           entity_id: String,
+          pin: String,
           status: Increase::CardUpdateParams::Status::OrSymbol,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -79,6 +87,8 @@ module Increase
         # The Entity the card belongs to. You only need to supply this in rare situations
         # when the card is not for the Account holder.
         entity_id: nil,
+        # The 4-digit PIN for the card, for use with ATMs.
+        pin: nil,
         # The status to update the Card with.
         status: nil,
         request_options: {}
@@ -92,6 +102,7 @@ module Increase
             description: String,
             digital_wallet: Increase::CardUpdateParams::DigitalWallet,
             entity_id: String,
+            pin: String,
             status: Increase::CardUpdateParams::Status::OrSymbol,
             request_options: Increase::RequestOptions
           }

data/rbi/increase/models/real_time_decision_action_params.rbi

@@ -477,15 +477,10 @@ module Increase
 
           # Your decisions on whether or not each provided address component is a match.
           # Your response here is evaluated against the customer's provided `postal_code`
-          # and `line1`, and an appropriate network response is generated. For example, if
-          # you would like to approve all transactions for a given card, you can submit
-          # `match` for both `postal_code` and `line1` and Increase will generate an
-          # approval with an Address Verification System (AVS) code that will match all of
-          # the available address information, or will report that no check was performed if
-          # no address information is available. If you do not provide a response, the
-          # address verification result will be calculated by Increase using the available
-          # address information available on the card. If none is available, Increase will
-          # report that no check was performed.
+          # and `line1`, and an appropriate network response is generated. For more
+          # information, see our
+          # [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
+          # guide.
           sig do
             returns(
               T.nilable(
@@ -516,15 +511,10 @@ module Increase
           def self.new(
             # Your decisions on whether or not each provided address component is a match.
             # Your response here is evaluated against the customer's provided `postal_code`
-            # and `line1`, and an appropriate network response is generated. For example, if
-            # you would like to approve all transactions for a given card, you can submit
-            # `match` for both `postal_code` and `line1` and Increase will generate an
-            # approval with an Address Verification System (AVS) code that will match all of
-            # the available address information, or will report that no check was performed if
-            # no address information is available. If you do not provide a response, the
-            # address verification result will be calculated by Increase using the available
-            # address information available on the card. If none is available, Increase will
-            # report that no check was performed.
+            # and `line1`, and an appropriate network response is generated. For more
+            # information, see our
+            # [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
+            # guide.
             cardholder_address_verification_result: nil
           )
           end
@@ -567,15 +557,10 @@ module Increase
 
             # Your decisions on whether or not each provided address component is a match.
             # Your response here is evaluated against the customer's provided `postal_code`
-            # and `line1`, and an appropriate network response is generated. For example, if
-            # you would like to approve all transactions for a given card, you can submit
-            # `match` for both `postal_code` and `line1` and Increase will generate an
-            # approval with an Address Verification System (AVS) code that will match all of
-            # the available address information, or will report that no check was performed if
-            # no address information is available. If you do not provide a response, the
-            # address verification result will be calculated by Increase using the available
-            # address information available on the card. If none is available, Increase will
-            # report that no check was performed.
+            # and `line1`, and an appropriate network response is generated. For more
+            # information, see our
+            # [Address Verification System Codes and Overrides](https://increase.com/documentation/address-verification-system-codes-and-overrides)
+            # guide.
             sig do
               params(
                 line1:

data/rbi/increase/models/simulations/{physical_card_tracking_updates_params.rbi → physical_card_create_params.rbi}

@@ -3,14 +3,14 @@
 module Increase
   module Models
     module Simulations
-      class PhysicalCardTrackingUpdatesParams < Increase::Internal::Type::BaseModel
+      class PhysicalCardCreateParams < Increase::Internal::Type::BaseModel
         extend Increase::Internal::Type::RequestParameters::Converter
         include Increase::Internal::Type::RequestParameters
 
         OrHash =
           T.type_alias do
             T.any(
-              Increase::Simulations::PhysicalCardTrackingUpdatesParams,
+              Increase::Simulations::PhysicalCardCreateParams,
               Increase::Internal::AnyHash
             )
           end
@@ -18,7 +18,7 @@ module Increase
         # The type of tracking event.
         sig do
           returns(
-            Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::OrSymbol
+            Increase::Simulations::PhysicalCardCreateParams::Category::OrSymbol
           )
         end
         attr_accessor :category
@@ -55,7 +55,7 @@ module Increase
         sig do
           params(
             category:
-              Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::OrSymbol,
+              Increase::Simulations::PhysicalCardCreateParams::Category::OrSymbol,
             carrier_estimated_delivery_at: Time,
             city: String,
             postal_code: String,
@@ -83,7 +83,7 @@ module Increase
           override.returns(
             {
               category:
-                Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::OrSymbol,
+                Increase::Simulations::PhysicalCardCreateParams::Category::OrSymbol,
               carrier_estimated_delivery_at: Time,
               city: String,
               postal_code: String,
@@ -103,7 +103,7 @@ module Increase
             T.type_alias do
               T.all(
                 Symbol,
-                Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category
+                Increase::Simulations::PhysicalCardCreateParams::Category
               )
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -112,34 +112,34 @@ module Increase
           IN_TRANSIT =
             T.let(
               :in_transit,
-              Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::TaggedSymbol
+              Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
             )
 
           # The physical card has been processed for delivery.
           PROCESSED_FOR_DELIVERY =
             T.let(
               :processed_for_delivery,
-              Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::TaggedSymbol
+              Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
             )
 
           # The physical card has been delivered.
           DELIVERED =
             T.let(
               :delivered,
-              Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::TaggedSymbol
+              Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
             )
 
           # Delivery failed and the physical card was returned to sender.
           RETURNED_TO_SENDER =
             T.let(
               :returned_to_sender,
-              Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::TaggedSymbol
+              Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
             )
 
           sig do
             override.returns(
               T::Array[
-                Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::TaggedSymbol
+                Increase::Simulations::PhysicalCardCreateParams::Category::TaggedSymbol
               ]
             )
           end

data/rbi/increase/models.rbi

@@ -104,14 +104,16 @@ module Increase
 
   Card = Increase::Models::Card
 
-  CardCreateDetailsIframeParams =
-    Increase::Models::CardCreateDetailsIframeParams
-
   CardCreateParams = Increase::Models::CardCreateParams
 
-  CardDetails = Increase::Models::CardDetails
+  CardDetailCreateDetailsIframeParams =
+    Increase::Models::CardDetailCreateDetailsIframeParams
+
+  CardDetailDetailsParams = Increase::Models::CardDetailDetailsParams
+
+  CardDetailsAPI = Increase::Models::CardDetailsAPI
 
-  CardDetailsParams = Increase::Models::CardDetailsParams
+  CardDetailUpdateParams = Increase::Models::CardDetailUpdateParams
 
   CardIframeURL = Increase::Models::CardIframeURL
 

data/rbi/increase/resources/card_details.rbi

@@ -0,0 +1,63 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class CardDetails
+      # Update a Card's Details
+      sig do
+        params(
+          card_id: String,
+          pin: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardDetailsAPI)
+      end
+      def update(
+        # The card identifier.
+        card_id,
+        # The 4-digit PIN for the card, for use with ATMs.
+        pin:,
+        request_options: {}
+      )
+      end
+
+      # Create an iframe URL for a Card to display the card details. More details about
+      # styling and usage can be found in the
+      # [documentation](/documentation/embedded-card-component).
+      sig do
+        params(
+          card_id: String,
+          physical_card_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardIframeURL)
+      end
+      def create_details_iframe(
+        # The identifier of the Card to retrieve details for.
+        card_id,
+        # The identifier of the Physical Card to retrieve details for.
+        physical_card_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Sensitive details for a Card include the primary account number, expiry, card
+      # verification code, and PIN.
+      sig do
+        params(
+          card_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardDetailsAPI)
+      end
+      def details(
+        # The identifier of the Card to retrieve details for.
+        card_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/cards.rbi

@@ -56,6 +56,7 @@ module Increase
           description: String,
           digital_wallet: Increase::CardUpdateParams::DigitalWallet::OrHash,
           entity_id: String,
+          pin: String,
           status: Increase::CardUpdateParams::Status::OrSymbol,
           request_options: Increase::RequestOptions::OrHash
         ).returns(Increase::Card)
@@ -74,6 +75,8 @@ module Increase
         # The Entity the card belongs to. You only need to supply this in rare situations
         # when the card is not for the Account holder.
         entity_id: nil,
+        # The 4-digit PIN for the card, for use with ATMs.
+        pin: nil,
         # The status to update the Card with.
         status: nil,
         request_options: {}
@@ -111,40 +114,6 @@ module Increase
       )
       end
 
-      # Create an iframe URL for a Card to display the card details. More details about
-      # styling and usage can be found in the
-      # [documentation](/documentation/embedded-card-component).
-      sig do
-        params(
-          card_id: String,
-          physical_card_id: String,
-          request_options: Increase::RequestOptions::OrHash
-        ).returns(Increase::CardIframeURL)
-      end
-      def create_details_iframe(
-        # The identifier of the Card to retrieve details for.
-        card_id,
-        # The identifier of the Physical Card to retrieve details for.
-        physical_card_id: nil,
-        request_options: {}
-      )
-      end
-
-      # Sensitive details for a Card include the primary account number, expiry, card
-      # verification code, and PIN.
-      sig do
-        params(
-          card_id: String,
-          request_options: Increase::RequestOptions::OrHash
-        ).returns(Increase::CardDetails)
-      end
-      def details(
-        # The identifier of the Card to retrieve details for.
-        card_id,
-        request_options: {}
-      )
-      end
-
       # @api private
       sig { params(client: Increase::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/increase/resources/simulations/physical_cards.rbi

@@ -4,33 +4,13 @@ module Increase
   module Resources
     class Simulations
       class PhysicalCards
-        # This endpoint allows you to simulate advancing the shipment status of a Physical
-        # Card, to simulate e.g., that a physical card was attempted shipped but then
-        # failed delivery.
-        sig do
-          params(
-            physical_card_id: String,
-            shipment_status:
-              Increase::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus::OrSymbol,
-            request_options: Increase::RequestOptions::OrHash
-          ).returns(Increase::PhysicalCard)
-        end
-        def advance_shipment(
-          # The Physical Card you would like to action.
-          physical_card_id,
-          # The shipment status to move the Physical Card to.
-          shipment_status:,
-          request_options: {}
-        )
-        end
-
         # This endpoint allows you to simulate receiving a tracking update for a Physical
         # Card, to simulate the progress of a shipment.
         sig do
           params(
             physical_card_id: String,
             category:
-              Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category::OrSymbol,
+              Increase::Simulations::PhysicalCardCreateParams::Category::OrSymbol,
             carrier_estimated_delivery_at: Time,
             city: String,
             postal_code: String,
@@ -38,7 +18,7 @@ module Increase
             request_options: Increase::RequestOptions::OrHash
           ).returns(Increase::PhysicalCard)
         end
-        def tracking_updates(
+        def create(
           # The Physical Card you would like to action.
           physical_card_id,
           # The type of tracking event.
@@ -56,6 +36,26 @@ module Increase
         )
         end
 
+        # This endpoint allows you to simulate advancing the shipment status of a Physical
+        # Card, to simulate e.g., that a physical card was attempted shipped but then
+        # failed delivery.
+        sig do
+          params(
+            physical_card_id: String,
+            shipment_status:
+              Increase::Simulations::PhysicalCardAdvanceShipmentParams::ShipmentStatus::OrSymbol,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::PhysicalCard)
+        end
+        def advance_shipment(
+          # The Physical Card you would like to action.
+          physical_card_id,
+          # The shipment status to move the Physical Card to.
+          shipment_status:,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: Increase::Client).returns(T.attached_class) }
         def self.new(client:)

data/sig/increase/client.rbs

@@ -23,6 +23,8 @@ module Increase
 
     attr_reader cards: Increase::Resources::Cards
 
+    attr_reader card_details: Increase::Resources::CardDetails
+
     attr_reader card_payments: Increase::Resources::CardPayments
 
     attr_reader card_purchase_supplements: Increase::Resources::CardPurchaseSupplements

data/sig/increase/models/{card_create_details_iframe_params.rbs → card_detail_create_details_iframe_params.rbs}

@@ -1,10 +1,10 @@
 module Increase
   module Models
-    type card_create_details_iframe_params =
+    type card_detail_create_details_iframe_params =
       { physical_card_id: String }
       & Increase::Internal::Type::request_parameters
 
-    class CardCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
+    class CardDetailCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 

data/sig/increase/models/{card_details_params.rbs → card_detail_details_params.rbs}

@@ -1,9 +1,9 @@
 module Increase
   module Models
-    type card_details_params =
+    type card_detail_details_params =
       {  } & Increase::Internal::Type::request_parameters
 
-    class CardDetailsParams < Increase::Internal::Type::BaseModel
+    class CardDetailDetailsParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 

data/sig/increase/models/card_detail_update_params.rbs

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

data/sig/increase/models/card_details.rbs

@@ -1,17 +1,17 @@
 module Increase
   module Models
-    type card_details =
+    type card_details_api =
       {
         card_id: String,
         expiration_month: Integer,
         expiration_year: Integer,
         pin: String,
         primary_account_number: String,
-        type: Increase::Models::CardDetails::type_,
+        type: Increase::Models::CardDetailsAPI::type_,
         verification_code: String
       }
 
-    class CardDetails < Increase::Internal::Type::BaseModel
+    class CardDetailsAPI < Increase::Internal::Type::BaseModel
       attr_accessor card_id: String
 
       attr_accessor expiration_month: Integer
@@ -22,7 +22,7 @@ module Increase
 
       attr_accessor primary_account_number: String
 
-      attr_accessor type: Increase::Models::CardDetails::type_
+      attr_accessor type: Increase::Models::CardDetailsAPI::type_
 
       attr_accessor verification_code: String
 
@@ -32,7 +32,7 @@ module Increase
         expiration_year: Integer,
         pin: String,
         primary_account_number: String,
-        type: Increase::Models::CardDetails::type_,
+        type: Increase::Models::CardDetailsAPI::type_,
         verification_code: String
       ) -> void
 
@@ -42,7 +42,7 @@ module Increase
         expiration_year: Integer,
         pin: String,
         primary_account_number: String,
-        type: Increase::Models::CardDetails::type_,
+        type: Increase::Models::CardDetailsAPI::type_,
         verification_code: String
       }
 
@@ -53,7 +53,7 @@ module Increase
 
         CARD_DETAILS: :card_details
 
-        def self?.values: -> ::Array[Increase::Models::CardDetails::type_]
+        def self?.values: -> ::Array[Increase::Models::CardDetailsAPI::type_]
       end
     end
   end

data/sig/increase/models/card_update_params.rbs

@@ -6,6 +6,7 @@ module Increase
         description: String,
         digital_wallet: Increase::CardUpdateParams::DigitalWallet,
         entity_id: String,
+        pin: String,
         status: Increase::Models::CardUpdateParams::status
       }
       & Increase::Internal::Type::request_parameters
@@ -34,6 +35,10 @@ module Increase
 
       def entity_id=: (String) -> String
 
+      attr_reader pin: String?
+
+      def pin=: (String) -> String
+
       attr_reader status: Increase::Models::CardUpdateParams::status?
 
       def status=: (
@@ -45,6 +50,7 @@ module Increase
         ?description: String,
         ?digital_wallet: Increase::CardUpdateParams::DigitalWallet,
         ?entity_id: String,
+        ?pin: String,
         ?status: Increase::Models::CardUpdateParams::status,
         ?request_options: Increase::request_opts
       ) -> void
@@ -54,6 +60,7 @@ module Increase
         description: String,
         digital_wallet: Increase::CardUpdateParams::DigitalWallet,
         entity_id: String,
+        pin: String,
         status: Increase::Models::CardUpdateParams::status,
         request_options: Increase::RequestOptions
       }