release: 1.83.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.82.0"
+  ".": "1.83.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 213
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-8d71e78a4afd7e1ce2436bf2428777d623f468bb3b6c37c36ed8ed3155fe6c77.yml
-openapi_spec_hash: 3064d7c7468a53e4797ef16b648fd06d
-config_hash: e1e8bc2138a13f290956ae6687f099cd
+configured_endpoints: 214
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-6241d4f5ad4269845e96fe2c674d19f586894ca27456095fee5a70dede9ea19c.yml
+openapi_spec_hash: 81e8f749b8ca89085b599b2c346a773d
+config_hash: 8dadd60eab7ab858cf06c6a8633ed9f3

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.83.0 (2025-09-19)
+
+Full Changelog: [v1.82.0...v1.83.0](https://github.com/Increase/increase-ruby/compare/v1.82.0...v1.83.0)
+
+### Features
+
+* **api:** api update ([e4382bb](https://github.com/Increase/increase-ruby/commit/e4382bb2fad1d76e20ff852aa75d8d819bd13d01))
+
+
+### Chores
+
+* do not install brew dependencies in ./scripts/bootstrap by default ([0173be9](https://github.com/Increase/increase-ruby/commit/0173be95cdbd2321196c60b385970c9b2520bcd8))
+
 ## 1.82.0 (2025-09-19)
 
 Full Changelog: [v1.81.0...v1.82.0](https://github.com/Increase/increase-ruby/compare/v1.81.0...v1.82.0)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    increase (1.82.0)
+    increase (1.83.0)
       connection_pool
 
 GEM

README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.82.0"
+gem "increase", "~> 1.83.0"
 ```
 
 <!-- x-release-please-end -->

lib/increase.rb

@@ -97,10 +97,11 @@
 require_relative "increase/models/bookkeeping_entry_set_list_params"
 require_relative "increase/models/bookkeeping_entry_set_retrieve_params"
 require_relative "increase/models/card"
-require_relative "increase/models/card_create_details_iframe_params"
 require_relative "increase/models/card_create_params"
+require_relative "increase/models/card_detail_create_details_iframe_params"
+require_relative "increase/models/card_detail_details_params"
 require_relative "increase/models/card_details"
-require_relative "increase/models/card_details_params"
+require_relative "increase/models/card_detail_update_params"
 require_relative "increase/models/card_iframe_url"
 require_relative "increase/models/card_list_params"
 require_relative "increase/models/card_payment"
@@ -302,7 +303,7 @@
 require_relative "increase/models/simulations/interest_payment_create_params"
 require_relative "increase/models/simulations/pending_transaction_release_inbound_funds_hold_params"
 require_relative "increase/models/simulations/physical_card_advance_shipment_params"
-require_relative "increase/models/simulations/physical_card_tracking_updates_params"
+require_relative "increase/models/simulations/physical_card_create_params"
 require_relative "increase/models/simulations/program_create_params"
 require_relative "increase/models/simulations/real_time_payments_transfer_complete_params"
 require_relative "increase/models/simulations/wire_drawdown_request_refuse_params"
@@ -334,6 +335,7 @@
 require_relative "increase/resources/bookkeeping_accounts"
 require_relative "increase/resources/bookkeeping_entries"
 require_relative "increase/resources/bookkeeping_entry_sets"
+require_relative "increase/resources/card_details"
 require_relative "increase/resources/card_payments"
 require_relative "increase/resources/card_purchase_supplements"
 require_relative "increase/resources/card_push_transfers"

lib/increase/client.rb

@@ -35,6 +35,9 @@ class Client < Increase::Internal::Transport::BaseClient
     # @return [Increase::Resources::Cards]
     attr_reader :cards
 
+    # @return [Increase::Resources::CardDetails]
+    attr_reader :card_details
+
     # @return [Increase::Resources::CardPayments]
     attr_reader :card_payments
 
@@ -251,6 +254,7 @@ def initialize(
       @account_numbers = Increase::Resources::AccountNumbers.new(client: self)
       @account_transfers = Increase::Resources::AccountTransfers.new(client: self)
       @cards = Increase::Resources::Cards.new(client: self)
+      @card_details = Increase::Resources::CardDetails.new(client: self)
       @card_payments = Increase::Resources::CardPayments.new(client: self)
       @card_purchase_supplements = Increase::Resources::CardPurchaseSupplements.new(client: self)
       @physical_cards = Increase::Resources::PhysicalCards.new(client: self)

lib/increase/models.rb

@@ -131,13 +131,15 @@ 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
 

lib/increase/models/card_create_details_iframe_params.rb → lib/increase/models/card_detail_create_details_iframe_params.rb

@@ -2,8 +2,8 @@
 
 module Increase
   module Models
-    # @see Increase::Resources::Cards#create_details_iframe
-    class CardCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
+    # @see Increase::Resources::CardDetails#create_details_iframe
+    class CardDetailCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 

lib/increase/models/card_details_params.rb → lib/increase/models/card_detail_details_params.rb

@@ -2,8 +2,8 @@
 
 module Increase
   module Models
-    # @see Increase::Resources::Cards#details
-    class CardDetailsParams < Increase::Internal::Type::BaseModel
+    # @see Increase::Resources::CardDetails#details
+    class CardDetailDetailsParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 

lib/increase/models/card_detail_update_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardDetails#update
+    class CardDetailUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute pin
+      #   The 4-digit PIN for the card, for use with ATMs.
+      #
+      #   @return [String]
+      required :pin, String
+
+      # @!method initialize(pin:, request_options: {})
+      #   @param pin [String] The 4-digit PIN for the card, for use with ATMs.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

lib/increase/models/card_details.rb

@@ -2,8 +2,8 @@
 
 module Increase
   module Models
-    # @see Increase::Resources::Cards#details
-    class CardDetails < Increase::Internal::Type::BaseModel
+    # @see Increase::Resources::CardDetails#update
+    class CardDetailsAPI < Increase::Internal::Type::BaseModel
       # @!attribute card_id
       #   The identifier for the Card for which sensitive details have been returned.
       #
@@ -38,8 +38,8 @@ class CardDetails < Increase::Internal::Type::BaseModel
       #   A constant representing the object's type. For this resource it will always be
       #   `card_details`.
       #
-      #   @return [Symbol, Increase::Models::CardDetails::Type]
-      required :type, enum: -> { Increase::CardDetails::Type }
+      #   @return [Symbol, Increase::Models::CardDetailsAPI::Type]
+      required :type, enum: -> { Increase::CardDetailsAPI::Type }
 
       # @!attribute verification_code
       #   The three-digit verification code for the card. It's also known as the Card
@@ -51,9 +51,9 @@ class CardDetails < Increase::Internal::Type::BaseModel
 
       # @!method initialize(card_id:, expiration_month:, expiration_year:, pin:, primary_account_number:, type:, verification_code:)
       #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::CardDetails} for more details.
+      #   {Increase::Models::CardDetailsAPI} for more details.
       #
-      #   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.
       #
       #   @param card_id [String] The identifier for the Card for which sensitive details have been returned.
       #
@@ -65,14 +65,14 @@ class CardDetails < Increase::Internal::Type::BaseModel
       #
       #   @param primary_account_number [String] The card number.
       #
-      #   @param type [Symbol, Increase::Models::CardDetails::Type] A constant representing the object's type. For this resource it will always be `
+      #   @param type [Symbol, Increase::Models::CardDetailsAPI::Type] A constant representing the object's type. For this resource it will always be `
       #
       #   @param verification_code [String] The three-digit verification code for the card. It's also known as the Card Veri
 
       # A constant representing the object's type. For this resource it will always be
       # `card_details`.
       #
-      # @see Increase::Models::CardDetails#type
+      # @see Increase::Models::CardDetailsAPI#type
       module Type
         extend Increase::Internal::Type::Enum
 

lib/increase/models/card_iframe_url.rb

@@ -2,7 +2,7 @@
 
 module Increase
   module Models
-    # @see Increase::Resources::Cards#create_details_iframe
+    # @see Increase::Resources::CardDetails#create_details_iframe
     class CardIframeURL < Increase::Internal::Type::BaseModel
       # @!attribute expires_at
       #   The time the iframe URL will expire.

lib/increase/models/card_update_params.rb

@@ -34,13 +34,19 @@ class CardUpdateParams < Increase::Internal::Type::BaseModel
       #   @return [String, nil]
       optional :entity_id, String
 
+      # @!attribute pin
+      #   The 4-digit PIN for the card, for use with ATMs.
+      #
+      #   @return [String, nil]
+      optional :pin, String
+
       # @!attribute status
       #   The status to update the Card with.
       #
       #   @return [Symbol, Increase::Models::CardUpdateParams::Status, nil]
       optional :status, enum: -> { Increase::CardUpdateParams::Status }
 
-      # @!method initialize(billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, status: nil, request_options: {})
+      # @!method initialize(billing_address: nil, description: nil, digital_wallet: nil, entity_id: nil, pin: nil, status: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CardUpdateParams} for more details.
       #
@@ -52,6 +58,8 @@ class CardUpdateParams < Increase::Internal::Type::BaseModel
       #
       #   @param entity_id [String] The Entity the card belongs to. You only need to supply this in rare situations
       #
+      #   @param pin [String] The 4-digit PIN for the card, for use with ATMs.
+      #
       #   @param status [Symbol, Increase::Models::CardUpdateParams::Status] The status to update the Card with.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

lib/increase/models/simulations/physical_card_tracking_updates_params.rb → lib/increase/models/simulations/physical_card_create_params.rb

@@ -3,16 +3,16 @@
 module Increase
   module Models
     module Simulations
-      # @see Increase::Resources::Simulations::PhysicalCards#tracking_updates
-      class PhysicalCardTrackingUpdatesParams < Increase::Internal::Type::BaseModel
+      # @see Increase::Resources::Simulations::PhysicalCards#create
+      class PhysicalCardCreateParams < Increase::Internal::Type::BaseModel
         extend Increase::Internal::Type::RequestParameters::Converter
         include Increase::Internal::Type::RequestParameters
 
         # @!attribute category
         #   The type of tracking event.
         #
-        #   @return [Symbol, Increase::Models::Simulations::PhysicalCardTrackingUpdatesParams::Category]
-        required :category, enum: -> { Increase::Simulations::PhysicalCardTrackingUpdatesParams::Category }
+        #   @return [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category]
+        required :category, enum: -> { Increase::Simulations::PhysicalCardCreateParams::Category }
 
         # @!attribute carrier_estimated_delivery_at
         #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the
@@ -41,10 +41,9 @@ class PhysicalCardTrackingUpdatesParams < Increase::Internal::Type::BaseModel
 
         # @!method initialize(category:, carrier_estimated_delivery_at: nil, city: nil, postal_code: nil, state: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::Simulations::PhysicalCardTrackingUpdatesParams} for more
-        #   details.
+        #   {Increase::Models::Simulations::PhysicalCardCreateParams} for more details.
         #
-        #   @param category [Symbol, Increase::Models::Simulations::PhysicalCardTrackingUpdatesParams::Category] The type of tracking event.
+        #   @param category [Symbol, Increase::Models::Simulations::PhysicalCardCreateParams::Category] The type of tracking event.
         #
         #   @param carrier_estimated_delivery_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the ca
         #

lib/increase/resources/card_details.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class CardDetails
+      # Update a Card's Details
+      #
+      # @overload update(card_id, pin:, request_options: {})
+      #
+      # @param card_id [String] The card identifier.
+      #
+      # @param pin [String] The 4-digit PIN for the card, for use with ATMs.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardDetailsAPI]
+      #
+      # @see Increase::Models::CardDetailUpdateParams
+      def update(card_id, params)
+        parsed, options = Increase::CardDetailUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["cards/%1$s/details", card_id],
+          body: parsed,
+          model: Increase::CardDetailsAPI,
+          options: 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).
+      #
+      # @overload create_details_iframe(card_id, physical_card_id: nil, request_options: {})
+      #
+      # @param card_id [String] The identifier of the Card to retrieve details for.
+      #
+      # @param physical_card_id [String] The identifier of the Physical Card to retrieve details for.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardIframeURL]
+      #
+      # @see Increase::Models::CardDetailCreateDetailsIframeParams
+      def create_details_iframe(card_id, params = {})
+        parsed, options = Increase::CardDetailCreateDetailsIframeParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["cards/%1$s/create_details_iframe", card_id],
+          body: parsed,
+          model: Increase::CardIframeURL,
+          options: options
+        )
+      end
+
+      # Sensitive details for a Card include the primary account number, expiry, card
+      # verification code, and PIN.
+      #
+      # @overload details(card_id, request_options: {})
+      #
+      # @param card_id [String] The identifier of the Card to retrieve details for.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardDetailsAPI]
+      #
+      # @see Increase::Models::CardDetailDetailsParams
+      def details(card_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["cards/%1$s/details", card_id],
+          model: Increase::CardDetailsAPI,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end