increase 1.357.0 → 1.359.0

data/rbi/increase/models/card.rbi

@@ -95,6 +95,22 @@ module Increase
       sig { returns(String) }
       attr_accessor :last4
 
+      # Completed renewals of this Card, sorted by `renewed_at` in ascending order. Each
+      # renewal records the expiration date the Card had before it was renewed.
+      sig { returns(T::Array[Increase::Card::Renewal]) }
+      attr_accessor :renewals
+
+      # Details about the Card this Card replaces, if it was created as a replacement.
+      sig { returns(T.nilable(Increase::Card::ReplacementFor)) }
+      attr_reader :replacement_for
+
+      sig do
+        params(
+          replacement_for: T.nilable(Increase::Card::ReplacementFor::OrHash)
+        ).void
+      end
+      attr_writer :replacement_for
+
       # This indicates if payments can be made with the card.
       sig { returns(Increase::Card::Status::TaggedSymbol) }
       attr_accessor :status
@@ -108,7 +124,8 @@ module Increase
       # for online purchases after you create them. All cards work on a good funds
       # model, and maintain a maximum limit of 100% of the Account’s available balance
       # at the time of transaction. Funds are deducted from the Account upon transaction
-      # settlement.
+      # settlement. For more information, see our guide on
+      # [managing cards](https://increase.com/documentation/managing-cards).
       sig do
         params(
           id: String,
@@ -126,6 +143,8 @@ module Increase
           expiration_year: Integer,
           idempotency_key: T.nilable(String),
           last4: String,
+          renewals: T::Array[Increase::Card::Renewal::OrHash],
+          replacement_for: T.nilable(Increase::Card::ReplacementFor::OrHash),
           status: Increase::Card::Status::OrSymbol,
           type: Increase::Card::Type::OrSymbol
         ).returns(T.attached_class)
@@ -165,6 +184,11 @@ module Increase
         idempotency_key:,
         # The last 4 digits of the Card's Primary Account Number.
         last4:,
+        # Completed renewals of this Card, sorted by `renewed_at` in ascending order. Each
+        # renewal records the expiration date the Card had before it was renewed.
+        renewals:,
+        # Details about the Card this Card replaces, if it was created as a replacement.
+        replacement_for:,
         # This indicates if payments can be made with the card.
         status:,
         # A constant representing the object's type. For this resource it will always be
@@ -191,6 +215,8 @@ module Increase
             expiration_year: Integer,
             idempotency_key: T.nilable(String),
             last4: String,
+            renewals: T::Array[Increase::Card::Renewal],
+            replacement_for: T.nilable(Increase::Card::ReplacementFor),
             status: Increase::Card::Status::TaggedSymbol,
             type: Increase::Card::Type::TaggedSymbol
           }
@@ -1353,7 +1379,8 @@ module Increase
         attr_accessor :email
 
         # A phone number that can be used to verify the cardholder via one-time passcode
-        # over SMS.
+        # over SMS. Returned in [E.164](https://en.wikipedia.org/wiki/E.164) format, for
+        # example `+14155550123`.
         sig { returns(T.nilable(String)) }
         attr_accessor :phone
 
@@ -1375,7 +1402,8 @@ module Increase
           # over email.
           email:,
           # A phone number that can be used to verify the cardholder via one-time passcode
-          # over SMS.
+          # over SMS. Returned in [E.164](https://en.wikipedia.org/wiki/E.164) format, for
+          # example `+14155550123`.
           phone:
         )
         end
@@ -1393,6 +1421,143 @@ module Increase
         end
       end
 
+      class Renewal < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Increase::Card::Renewal, Increase::Internal::AnyHash)
+          end
+
+        # The month the Card expired in before this renewal, in M format (e.g., August is
+        # 8).
+        sig { returns(Integer) }
+        attr_accessor :previous_expiration_month
+
+        # The year the Card expired in before this renewal, in YYYY format (e.g., 2025).
+        sig { returns(Integer) }
+        attr_accessor :previous_expiration_year
+
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        # the Card was renewed.
+        sig { returns(Time) }
+        attr_accessor :renewed_at
+
+        sig do
+          params(
+            previous_expiration_month: Integer,
+            previous_expiration_year: Integer,
+            renewed_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The month the Card expired in before this renewal, in M format (e.g., August is
+          # 8).
+          previous_expiration_month:,
+          # The year the Card expired in before this renewal, in YYYY format (e.g., 2025).
+          previous_expiration_year:,
+          # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+          # the Card was renewed.
+          renewed_at:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              previous_expiration_month: Integer,
+              previous_expiration_year: Integer,
+              renewed_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class ReplacementFor < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Increase::Card::ReplacementFor, Increase::Internal::AnyHash)
+          end
+
+        # The identifier of the replaced Card.
+        sig { returns(String) }
+        attr_accessor :card_id
+
+        # Why the Card was replaced. Only `expiring` notifies merchants that have the
+        # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
+        # replaced Card that have not been deactivated to the new Card.
+        sig { returns(Increase::Card::ReplacementFor::Reason::TaggedSymbol) }
+        attr_accessor :reason
+
+        # Details about the Card this Card replaces, if it was created as a replacement.
+        sig do
+          params(
+            card_id: String,
+            reason: Increase::Card::ReplacementFor::Reason::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the replaced Card.
+          card_id:,
+          # Why the Card was replaced. Only `expiring` notifies merchants that have the
+          # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
+          # replaced Card that have not been deactivated to the new Card.
+          reason:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              card_id: String,
+              reason: Increase::Card::ReplacementFor::Reason::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Why the Card was replaced. Only `expiring` notifies merchants that have the
+        # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
+        # replaced Card that have not been deactivated to the new Card.
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::Card::ReplacementFor::Reason)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The replaced card is expiring. Merchants with the replaced card on file will be notified of the new card, and its digital wallet tokens that have not been deactivated will move to the new card.
+          EXPIRING =
+            T.let(
+              :expiring,
+              Increase::Card::ReplacementFor::Reason::TaggedSymbol
+            )
+
+          # The replaced card was lost. Merchants will not be notified of the new card.
+          LOST =
+            T.let(:lost, Increase::Card::ReplacementFor::Reason::TaggedSymbol)
+
+          # The replaced card was stolen. Merchants will not be notified of the new card.
+          STOLEN =
+            T.let(:stolen, Increase::Card::ReplacementFor::Reason::TaggedSymbol)
+
+          # The replaced card was used fraudulently. Merchants will not be notified of the new card.
+          FRAUD =
+            T.let(:fraud, Increase::Card::ReplacementFor::Reason::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Increase::Card::ReplacementFor::Reason::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       # This indicates if payments can be made with the card.
       module Status
         extend Increase::Internal::Type::Enum

data/rbi/increase/models/card_create_params.rbi

@@ -82,6 +82,18 @@ module Increase
       sig { params(entity_id: String).void }
       attr_writer :entity_id
 
+      # Details about the Card this Card replaces. Supply this when issuing a new Card
+      # to take over from an existing one. The replaced Card is not canceled.
+      sig { returns(T.nilable(Increase::CardCreateParams::ReplacementFor)) }
+      attr_reader :replacement_for
+
+      sig do
+        params(
+          replacement_for: Increase::CardCreateParams::ReplacementFor::OrHash
+        ).void
+      end
+      attr_writer :replacement_for
+
       sig do
         params(
           account_id: String,
@@ -92,6 +104,7 @@ module Increase
           description: String,
           digital_wallet: Increase::CardCreateParams::DigitalWallet::OrHash,
           entity_id: String,
+          replacement_for: Increase::CardCreateParams::ReplacementFor::OrHash,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -116,6 +129,9 @@ 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,
+        # Details about the Card this Card replaces. Supply this when issuing a new Card
+        # to take over from an existing one. The replaced Card is not canceled.
+        replacement_for: nil,
         request_options: {}
       )
       end
@@ -131,6 +147,7 @@ module Increase
             description: String,
             digital_wallet: Increase::CardCreateParams::DigitalWallet,
             entity_id: String,
+            replacement_for: Increase::CardCreateParams::ReplacementFor,
             request_options: Increase::RequestOptions
           }
         )
@@ -1348,7 +1365,8 @@ module Increase
         attr_writer :email
 
         # A phone number that can be used to contact and verify the cardholder via
-        # one-time passcode over SMS.
+        # one-time passcode over SMS. Accepts formats like `+14155550123`, `4155550123`,
+        # `415-555-0123`, or `(415) 555-0123`.
         sig { returns(T.nilable(String)) }
         attr_reader :phone
 
@@ -1374,7 +1392,8 @@ module Increase
           # one-time passcode over email.
           email: nil,
           # A phone number that can be used to contact and verify the cardholder via
-          # one-time passcode over SMS.
+          # one-time passcode over SMS. Accepts formats like `+14155550123`, `4155550123`,
+          # `415-555-0123`, or `(415) 555-0123`.
           phone: nil
         )
         end
@@ -1387,6 +1406,109 @@ module Increase
         def to_hash
         end
       end
+
+      class ReplacementFor < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CardCreateParams::ReplacementFor,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The identifier of the Card being replaced.
+        sig { returns(String) }
+        attr_accessor :card_id
+
+        # Why the Card is being replaced. Only `expiring` notifies merchants that have the
+        # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
+        # replaced Card that have not been deactivated to the new Card.
+        sig do
+          returns(Increase::CardCreateParams::ReplacementFor::Reason::OrSymbol)
+        end
+        attr_accessor :reason
+
+        # Details about the Card this Card replaces. Supply this when issuing a new Card
+        # to take over from an existing one. The replaced Card is not canceled.
+        sig do
+          params(
+            card_id: String,
+            reason: Increase::CardCreateParams::ReplacementFor::Reason::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the Card being replaced.
+          card_id:,
+          # Why the Card is being replaced. Only `expiring` notifies merchants that have the
+          # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
+          # replaced Card that have not been deactivated to the new Card.
+          reason:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              card_id: String,
+              reason:
+                Increase::CardCreateParams::ReplacementFor::Reason::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Why the Card is being replaced. Only `expiring` notifies merchants that have the
+        # replaced Card on file of the new Card and moves Digital Wallet Tokens on the
+        # replaced Card that have not been deactivated to the new Card.
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::CardCreateParams::ReplacementFor::Reason)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The replaced card is expiring. Merchants with the replaced card on file will be notified of the new card, and its digital wallet tokens that have not been deactivated will move to the new card.
+          EXPIRING =
+            T.let(
+              :expiring,
+              Increase::CardCreateParams::ReplacementFor::Reason::TaggedSymbol
+            )
+
+          # The replaced card was lost. Merchants will not be notified of the new card.
+          LOST =
+            T.let(
+              :lost,
+              Increase::CardCreateParams::ReplacementFor::Reason::TaggedSymbol
+            )
+
+          # The replaced card was stolen. Merchants will not be notified of the new card.
+          STOLEN =
+            T.let(
+              :stolen,
+              Increase::CardCreateParams::ReplacementFor::Reason::TaggedSymbol
+            )
+
+          # The replaced card was used fraudulently. Merchants will not be notified of the new card.
+          FRAUD =
+            T.let(
+              :fraud,
+              Increase::CardCreateParams::ReplacementFor::Reason::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::CardCreateParams::ReplacementFor::Reason::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/increase/models/card_dispute.rbi

@@ -109,7 +109,9 @@ module Increase
       attr_writer :withdrawal
 
       # If unauthorized activity occurs on a card, you can create a Card Dispute and
-      # we'll work with the card networks to return the funds if appropriate.
+      # we'll work with the card networks to return the funds if appropriate. For more
+      # information, see our guide on
+      # [card disputes](https://increase.com/documentation/card-disputes).
       sig do
         params(
           id: String,

data/rbi/increase/models/card_payment.rbi

@@ -50,7 +50,9 @@ module Increase
       attr_accessor :type
 
       # Card Payments group together interactions related to a single card payment, such
-      # as an authorization and its corresponding settlement.
+      # as an authorization and its corresponding settlement. For more information, see
+      # our guide on the
+      # [Card Payment lifecycle](https://increase.com/documentation/card-payment-lifecycle).
       sig do
         params(
           id: String,

data/rbi/increase/models/card_push_transfer.rbi

@@ -1589,6 +1589,13 @@ module Increase
               Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XCD
+          XCD =
+            T.let(
+              :XCD,
+              Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # ARS
           ARS =
             T.let(
@@ -1666,6 +1673,13 @@ module Increase
               Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XOF
+          XOF =
+            T.let(
+              :XOF,
+              Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # BMD
           BMD =
             T.let(
@@ -1736,13 +1750,6 @@ module Increase
               Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
             )
 
-          # BGN
-          BGN =
-            T.let(
-              :BGN,
-              Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
-            )
-
           # BIF
           BIF =
             T.let(
@@ -1764,6 +1771,13 @@ module Increase
               Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XAF
+          XAF =
+            T.let(
+              :XAF,
+              Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # CAD
           CAD =
             T.let(
@@ -1848,6 +1862,13 @@ module Increase
               Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XCG
+          XCG =
+            T.let(
+              :XCG,
+              Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # CZK
           CZK =
             T.let(
@@ -1925,6 +1946,13 @@ module Increase
               Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XPF
+          XPF =
+            T.let(
+              :XPF,
+              Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # GMD
           GMD =
             T.let(
@@ -2667,6 +2695,13 @@ module Increase
               Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # BGN
+          BGN =
+            T.let(
+              :BGN,
+              Increase::CardPushTransfer::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/card_push_transfer_create_params.rbi

@@ -523,6 +523,13 @@ module Increase
               Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XCD
+          XCD =
+            T.let(
+              :XCD,
+              Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # ARS
           ARS =
             T.let(
@@ -600,6 +607,13 @@ module Increase
               Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XOF
+          XOF =
+            T.let(
+              :XOF,
+              Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # BMD
           BMD =
             T.let(
@@ -670,13 +684,6 @@ module Increase
               Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
             )
 
-          # BGN
-          BGN =
-            T.let(
-              :BGN,
-              Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
-            )
-
           # BIF
           BIF =
             T.let(
@@ -698,6 +705,13 @@ module Increase
               Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XAF
+          XAF =
+            T.let(
+              :XAF,
+              Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # CAD
           CAD =
             T.let(
@@ -782,6 +796,13 @@ module Increase
               Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XCG
+          XCG =
+            T.let(
+              :XCG,
+              Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # CZK
           CZK =
             T.let(
@@ -859,6 +880,13 @@ module Increase
               Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # XPF
+          XPF =
+            T.let(
+              :XPF,
+              Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           # GMD
           GMD =
             T.let(
@@ -1601,6 +1629,13 @@ module Increase
               Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
             )
 
+          # BGN
+          BGN =
+            T.let(
+              :BGN,
+              Increase::CardPushTransferCreateParams::PresentmentAmount::Currency::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/card_renew_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardRenewParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CardRenewParams, Increase::Internal::AnyHash)
+        end
+
+      # The identifier of the Card to renew.
+      sig { returns(String) }
+      attr_accessor :card_id
+
+      sig do
+        params(
+          card_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Card to renew.
+        card_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { card_id: String, request_options: Increase::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/card_update_params.rbi

@@ -1290,7 +1290,8 @@ module Increase
         attr_writer :email
 
         # A phone number that can be used to verify the cardholder via one-time passcode
-        # over SMS.
+        # over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
+        # `(415) 555-0123`.
         sig { returns(T.nilable(String)) }
         attr_reader :phone
 
@@ -1314,7 +1315,8 @@ module Increase
           # over email.
           email: nil,
           # A phone number that can be used to verify the cardholder via one-time passcode
-          # over SMS.
+          # over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
+          # `(415) 555-0123`.
           phone: nil
         )
         end