increase 1.357.0 → 1.358.0

data/lib/increase/models/physical_card.rb

@@ -35,6 +35,20 @@ module Increase
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute expiration_month
+      #   The month printed on the Physical Card as its expiration, in M format (e.g.,
+      #   August is 8). This stays the same when the Card is renewed.
+      #
+      #   @return [Integer]
+      required :expiration_month, Integer
+
+      # @!attribute expiration_year
+      #   The year printed on the Physical Card as its expiration, in YYYY format (e.g.,
+      #   2025). This stays the same when the Card is renewed.
+      #
+      #   @return [Integer]
+      required :expiration_year, Integer
+
       # @!attribute idempotency_key
       #   The idempotency key you chose for this object. This value is unique across
       #   Increase and is used to ensure that a request is only processed once. Learn more
@@ -68,7 +82,7 @@ module Increase
       #   @return [Symbol, Increase::Models::PhysicalCard::Type]
       required :type, enum: -> { Increase::PhysicalCard::Type }
 
-      # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
+      # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, expiration_month:, expiration_year:, idempotency_key:, physical_card_profile_id:, shipment:, status:, type:)
       #   Custom physical Visa cards that are shipped to your customers. The artwork is
       #   configurable by a connected [Card Profile](/documentation/api#card-profiles).
       #   The same Card can be used for multiple Physical Cards. Printing cards incurs a
@@ -88,6 +102,14 @@ module Increase
       #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
       #     the Physical Card was created.
       #
+      #   @param expiration_month [Integer]
+      #     The month printed on the Physical Card as its expiration, in M format (e.g.,
+      #     August is 8). This stays the same when the Card is renewed.
+      #
+      #   @param expiration_year [Integer]
+      #     The year printed on the Physical Card as its expiration, in YYYY format (e.g.,
+      #     2025). This stays the same when the Card is renewed.
+      #
       #   @param idempotency_key [String, nil]
       #     The idempotency key you chose for this object. This value is unique across
       #     Increase and is used to ensure that a request is only processed once. Learn more

data/lib/increase/models/transaction.rb

@@ -1666,6 +1666,9 @@ module Increase
               # The user's chargeback was submitted.
               CHARGEBACK_SUBMITTED = :chargeback_submitted
 
+              # The merchant's pre-arbitration submission was accepted by the user or not responded to in time.
+              MERCHANT_PREARBITRATION_ACCEPTED = :merchant_prearbitration_accepted
+
               # The user declined the merchant's pre-arbitration submission.
               MERCHANT_PREARBITRATION_DECLINE_SUBMITTED = :merchant_prearbitration_decline_submitted
 
@@ -1675,6 +1678,9 @@ module Increase
               # The transaction was re-presented by the merchant.
               REPRESENTED = :represented
 
+              # The user's pre-arbitration was accepted by the merchant or not responded to in time.
+              USER_PREARBITRATION_ACCEPTED = :user_prearbitration_accepted
+
               # The user's pre-arbitration was declined by the merchant.
               USER_PREARBITRATION_DECLINE_RECEIVED = :user_prearbitration_decline_received
 

data/lib/increase/models.rb

@@ -167,6 +167,8 @@ module Increase
 
   CardPushTransferRetrieveParams = Increase::Models::CardPushTransferRetrieveParams
 
+  CardRenewParams = Increase::Models::CardRenewParams
+
   CardRetrieveParams = Increase::Models::CardRetrieveParams
 
   CardToken = Increase::Models::CardToken

data/lib/increase/resources/cards.rb

@@ -5,7 +5,7 @@ module Increase
     class Cards
       # Create a Card
       #
-      # @overload create(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, request_options: {})
+      # @overload create(account_id:, authorization_controls: nil, billing_address: nil, cardholder_name: nil, description: nil, digital_wallet: nil, entity_id: nil, replacement_for: nil, request_options: {})
       #
       # @param account_id [String] The Account the card should belong to.
       #
@@ -31,6 +31,10 @@ 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.
       #
+      # @param replacement_for [Increase::Models::CardCreateParams::ReplacementFor]
+      #   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.
+      #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Increase::Models::Card]
@@ -216,6 +220,30 @@ module Increase
         )
       end
 
+      # Renew a Card in place. The Card keeps its identifier, card number, PIN, and
+      # Physical Cards, and receives a new expiration date in the current month four
+      # years from now along with a new verification code, which the Card's details will
+      # return afterwards. Physical Cards that have already shipped keep working until
+      # they are canceled.
+      #
+      # @overload renew(card_id, request_options: {})
+      #
+      # @param card_id [String] The identifier of the Card to renew.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::Card]
+      #
+      # @see Increase::Models::CardRenewParams
+      def renew(card_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["cards/%1$s/renew", card_id],
+          model: Increase::Card,
+          options: params[:request_options]
+        )
+      end
+
       # Update a Card's PIN
       #
       # @overload update_pin(card_id, pin:, request_options: {})

data/lib/increase/resources/digital_card_profiles.rb

@@ -64,7 +64,7 @@ module Increase
         )
       end
 
-      # List Card Profiles
+      # List Digital Card Profiles
       #
       # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
       #
@@ -122,7 +122,7 @@ module Increase
         )
       end
 
-      # Clones a Digital Card Profile
+      # Clone a Digital Card Profile
       #
       # @overload clone_(digital_card_profile_id, app_icon_file_id: nil, background_image_file_id: nil, card_description: nil, contact_email: nil, contact_name: nil, contact_phone: nil, contact_website: nil, description: nil, text_color: nil, request_options: {})
       #

data/lib/increase/resources/files.rb

@@ -38,7 +38,9 @@ module Increase
         )
       end
 
-      # Retrieve a File
+      # Fetch metadata about a File, like its `purpose` and MIME type. To access the
+      # content, use the [Get File contents](/documentation/api/files#get-file-contents)
+      # API.
       #
       # @overload retrieve(file_id, request_options: {})
       #

data/lib/increase/resources/intrafi_account_enrollments.rb

@@ -3,7 +3,7 @@
 module Increase
   module Resources
     class IntrafiAccountEnrollments
-      # Enroll an account in the IntraFi deposit sweep network
+      # Enroll an Account in the IntraFi deposit sweep network
       #
       # @overload create(account_id:, email_address:, request_options: {})
       #
@@ -88,7 +88,7 @@ module Increase
         )
       end
 
-      # Unenroll an account from IntraFi
+      # Unenroll an Account from IntraFi
       #
       # @overload unenroll(intrafi_account_enrollment_id, request_options: {})
       #

data/lib/increase/resources/physical_card_profiles.rb

@@ -43,7 +43,7 @@ module Increase
         )
       end
 
-      # Retrieve a Card Profile
+      # Retrieve a Physical Card Profile
       #
       # @overload retrieve(physical_card_profile_id, request_options: {})
       #

data/lib/increase/resources/supplemental_documents.rb

@@ -3,7 +3,7 @@
 module Increase
   module Resources
     class SupplementalDocuments
-      # Create a supplemental document for an Entity
+      # Create a Supplemental Document
       #
       # @overload create(entity_id:, file_id:, request_options: {})
       #
@@ -27,7 +27,7 @@ module Increase
         )
       end
 
-      # List Entity Supplemental Document Submissions
+      # List Supplemental Documents
       #
       # @overload list(entity_id:, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
       #

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.357.0"
+  VERSION = "1.358.0"
 end

data/lib/increase.rb

@@ -118,6 +118,7 @@ require_relative "increase/models/card_push_transfer_cancel_params"
 require_relative "increase/models/card_push_transfer_create_params"
 require_relative "increase/models/card_push_transfer_list_params"
 require_relative "increase/models/card_push_transfer_retrieve_params"
+require_relative "increase/models/card_renew_params"
 require_relative "increase/models/card_retrieve_params"
 require_relative "increase/models/card_token"
 require_relative "increase/models/card_token_capabilities"

data/rbi/increase/models/account_statement.rbi

@@ -44,15 +44,17 @@ module Increase
 
       # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
       # of the period the Account Statement covers. The statement covers all
-      # transactions up to, but not including this timestamp. Usually, this is the
-      # beginning of the following month.
+      # transactions up to, but not including this timestamp. Statement periods are
+      # measured in UTC days, so this is usually midnight UTC on the first day of the
+      # following month.
       sig { returns(Time) }
       attr_accessor :statement_period_end
 
       # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
       # start of the period the Account Statement covers. This is the first moment of
-      # the statement period and is inclusive. Usually, this is the beginning of the
-      # month this statement covers.
+      # the statement period and is inclusive. Statement periods are measured in UTC
+      # days, so this is usually midnight UTC on the first day of the month this
+      # statement covers.
       sig { returns(Time) }
       attr_accessor :statement_period_start
 
@@ -96,13 +98,15 @@ module Increase
         starting_balance:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
         # of the period the Account Statement covers. The statement covers all
-        # transactions up to, but not including this timestamp. Usually, this is the
-        # beginning of the following month.
+        # transactions up to, but not including this timestamp. Statement periods are
+        # measured in UTC days, so this is usually midnight UTC on the first day of the
+        # following month.
         statement_period_end:,
         # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
         # start of the period the Account Statement covers. This is the first moment of
-        # the statement period and is inclusive. Usually, this is the beginning of the
-        # month this statement covers.
+        # the statement period and is inclusive. Statement periods are measured in UTC
+        # days, so this is usually midnight UTC on the first day of the month this
+        # statement covers.
         statement_period_start:,
         # A constant representing the object's type. For this resource it will always be
         # `account_statement`.

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
@@ -126,6 +142,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 +183,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 +214,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
           }
@@ -1393,6 +1418,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
           }
         )
@@ -1387,6 +1404,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_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