increase 1.39.0 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8b2f6858bc742cd3da02aadf5e4cc469b2fec47544bd062cf78f41fce2d843c
-  data.tar.gz: f951ec2b7095c3447d17bf8d34319445d045b84ba158b649a0249c5bfa349fd1
+  metadata.gz: 431ebe1a12c0cc64bb236d37954675f6a2fc0997be59c5e313116c97773bcc61
+  data.tar.gz: 6ce174eaa92699f6797ebfa89695233201f3c0ff0c5bf9bc0c7f7d371b23cc62
 SHA512:
-  metadata.gz: 0b253c55c3c9242d3fcca0c447afb8f9bb911a2b76502502d1027c888551a97cd842467c542d6d4a70cbef57f17e72199511866d151862785e0a8af64dcda12e
-  data.tar.gz: c55c75c84ac60f9c7d8307164e99c17b0f02b428b139662e8cf58fb34f14728ef2d8018f337d278c087fbc1c4dd164e06029bb99831ecff088b118d18d90d7db
+  metadata.gz: 93fa2087cc2641aba6aa9789afcfc7eb8722bc03536974b451419a4693f180e32817e62c1e950cd7a4c4e8296a1696be1378cda27c3dd570a4322ba2474b4c20
+  data.tar.gz: c4cd2f429007ef063627b2016cdc76ad7fcf09cf763fe2ad40e7c151d41a6170ce62a209f3a49a4e3467b7e199b1d11e94ae076f66f370b2d926a61d31b38251

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.40.0 (2025-08-20)
+
+Full Changelog: [v1.39.0...v1.40.0](https://github.com/Increase/increase-ruby/compare/v1.39.0...v1.40.0)
+
+### Features
+
+* **api:** api update ([6f2b4ab](https://github.com/Increase/increase-ruby/commit/6f2b4ab35ffbb974911ac85740af55836f9609e1))
+
 ## 1.39.0 (2025-08-20)
 
 Full Changelog: [v1.38.0...v1.39.0](https://github.com/Increase/increase-ruby/compare/v1.38.0...v1.39.0)

data/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.39.0"
+gem "increase", "~> 1.40.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/card_create_details_iframe_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Cards#create_details_iframe
+    class CardCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute physical_card_id
+      #   The identifier of the Physical Card to retrieve details for.
+      #
+      #   @return [String, nil]
+      optional :physical_card_id, String
+
+      # @!method initialize(physical_card_id: nil, request_options: {})
+      #   @param physical_card_id [String] The identifier of the Physical Card to retrieve details for.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/card_iframe_url.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Cards#create_details_iframe
+    class CardIframeURL < Increase::Internal::Type::BaseModel
+      # @!attribute expires_at
+      #   The time the iframe URL will expire.
+      #
+      #   @return [Time]
+      required :expires_at, Time
+
+      # @!attribute iframe_url
+      #   The iframe URL for the Card. Treat this as an opaque URL.
+      #
+      #   @return [String]
+      required :iframe_url, String
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `card_iframe_url`.
+      #
+      #   @return [Symbol, Increase::Models::CardIframeURL::Type]
+      required :type, enum: -> { Increase::CardIframeURL::Type }
+
+      # @!method initialize(expires_at:, iframe_url:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::CardIframeURL} for more details.
+      #
+      #   An object containing the iframe URL for a Card.
+      #
+      #   @param expires_at [Time] The time the iframe URL will expire.
+      #
+      #   @param iframe_url [String] The iframe URL for the Card. Treat this as an opaque URL.
+      #
+      #   @param type [Symbol, Increase::Models::CardIframeURL::Type] A constant representing the object's type. For this resource it will always be `
+
+      # A constant representing the object's type. For this resource it will always be
+      # `card_iframe_url`.
+      #
+      # @see Increase::Models::CardIframeURL#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CARD_IFRAME_URL = :card_iframe_url
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models.rb

@@ -131,6 +131,8 @@ module Increase
 
   Card = Increase::Models::Card
 
+  CardCreateDetailsIframeParams = Increase::Models::CardCreateDetailsIframeParams
+
   CardCreateParams = Increase::Models::CardCreateParams
 
   CardDetails = Increase::Models::CardDetails
@@ -145,6 +147,8 @@ module Increase
 
   CardDisputeRetrieveParams = Increase::Models::CardDisputeRetrieveParams
 
+  CardIframeURL = Increase::Models::CardIframeURL
+
   CardListParams = Increase::Models::CardListParams
 
   CardPayment = Increase::Models::CardPayment

data/lib/increase/resources/cards.rb

@@ -121,7 +121,34 @@ module Increase
         )
       end
 
-      # Retrieve sensitive details for a Card
+      # 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::CardCreateDetailsIframeParams
+      def create_details_iframe(card_id, params = {})
+        parsed, options = Increase::CardCreateDetailsIframeParams.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: {})
       #

data/lib/increase/version.rb

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

data/lib/increase.rb

@@ -97,6 +97,7 @@ require_relative "increase/models/bookkeeping_entry_set_create_params"
 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_details"
 require_relative "increase/models/card_details_params"
@@ -104,6 +105,7 @@ require_relative "increase/models/card_dispute"
 require_relative "increase/models/card_dispute_create_params"
 require_relative "increase/models/card_dispute_list_params"
 require_relative "increase/models/card_dispute_retrieve_params"
+require_relative "increase/models/card_iframe_url"
 require_relative "increase/models/card_list_params"
 require_relative "increase/models/card_payment"
 require_relative "increase/models/card_payment_list_params"

data/rbi/increase/models/card_create_details_iframe_params.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::CardCreateDetailsIframeParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The identifier of the Physical Card to retrieve details for.
+      sig { returns(T.nilable(String)) }
+      attr_reader :physical_card_id
+
+      sig { params(physical_card_id: String).void }
+      attr_writer :physical_card_id
+
+      sig do
+        params(
+          physical_card_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The identifier of the Physical Card to retrieve details for.
+        physical_card_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            physical_card_id: String,
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/card_iframe_url.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardIframeURL < Increase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Increase::CardIframeURL, Increase::Internal::AnyHash)
+        end
+
+      # The time the iframe URL will expire.
+      sig { returns(Time) }
+      attr_accessor :expires_at
+
+      # The iframe URL for the Card. Treat this as an opaque URL.
+      sig { returns(String) }
+      attr_accessor :iframe_url
+
+      # A constant representing the object's type. For this resource it will always be
+      # `card_iframe_url`.
+      sig { returns(Increase::CardIframeURL::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # An object containing the iframe URL for a Card.
+      sig do
+        params(
+          expires_at: Time,
+          iframe_url: String,
+          type: Increase::CardIframeURL::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The time the iframe URL will expire.
+        expires_at:,
+        # The iframe URL for the Card. Treat this as an opaque URL.
+        iframe_url:,
+        # A constant representing the object's type. For this resource it will always be
+        # `card_iframe_url`.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            expires_at: Time,
+            iframe_url: String,
+            type: Increase::CardIframeURL::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `card_iframe_url`.
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::CardIframeURL::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CARD_IFRAME_URL =
+          T.let(:card_iframe_url, Increase::CardIframeURL::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::CardIframeURL::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models.rbi

@@ -104,6 +104,9 @@ module Increase
 
   Card = Increase::Models::Card
 
+  CardCreateDetailsIframeParams =
+    Increase::Models::CardCreateDetailsIframeParams
+
   CardCreateParams = Increase::Models::CardCreateParams
 
   CardDetails = Increase::Models::CardDetails
@@ -118,6 +121,8 @@ module Increase
 
   CardDisputeRetrieveParams = Increase::Models::CardDisputeRetrieveParams
 
+  CardIframeURL = Increase::Models::CardIframeURL
+
   CardListParams = Increase::Models::CardListParams
 
   CardPayment = Increase::Models::CardPayment

data/rbi/increase/resources/cards.rbi

@@ -111,7 +111,27 @@ module Increase
       )
       end
 
-      # Retrieve sensitive details for a Card
+      # 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,

data/sig/increase/models/card_create_details_iframe_params.rbs

@@ -0,0 +1,26 @@
+module Increase
+  module Models
+    type card_create_details_iframe_params =
+      { physical_card_id: String }
+      & Increase::Internal::Type::request_parameters
+
+    class CardCreateDetailsIframeParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_reader physical_card_id: String?
+
+      def physical_card_id=: (String) -> String
+
+      def initialize: (
+        ?physical_card_id: String,
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        physical_card_id: String,
+        request_options: Increase::RequestOptions
+      }
+    end
+  end
+end

data/sig/increase/models/card_iframe_url.rbs

@@ -0,0 +1,40 @@
+module Increase
+  module Models
+    type card_iframe_url =
+      {
+        expires_at: Time,
+        iframe_url: String,
+        type: Increase::Models::CardIframeURL::type_
+      }
+
+    class CardIframeURL < Increase::Internal::Type::BaseModel
+      attr_accessor expires_at: Time
+
+      attr_accessor iframe_url: String
+
+      attr_accessor type: Increase::Models::CardIframeURL::type_
+
+      def initialize: (
+        expires_at: Time,
+        iframe_url: String,
+        type: Increase::Models::CardIframeURL::type_
+      ) -> void
+
+      def to_hash: -> {
+        expires_at: Time,
+        iframe_url: String,
+        type: Increase::Models::CardIframeURL::type_
+      }
+
+      type type_ = :card_iframe_url
+
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CARD_IFRAME_URL: :card_iframe_url
+
+        def self?.values: -> ::Array[Increase::Models::CardIframeURL::type_]
+      end
+    end
+  end
+end

data/sig/increase/models.rbs

@@ -91,6 +91,8 @@ module Increase
 
   class Card = Increase::Models::Card
 
+  class CardCreateDetailsIframeParams = Increase::Models::CardCreateDetailsIframeParams
+
   class CardCreateParams = Increase::Models::CardCreateParams
 
   class CardDetails = Increase::Models::CardDetails
@@ -105,6 +107,8 @@ module Increase
 
   class CardDisputeRetrieveParams = Increase::Models::CardDisputeRetrieveParams
 
+  class CardIframeURL = Increase::Models::CardIframeURL
+
   class CardListParams = Increase::Models::CardListParams
 
   class CardPayment = Increase::Models::CardPayment

data/sig/increase/resources/cards.rbs

@@ -35,6 +35,12 @@ module Increase
         ?request_options: Increase::request_opts
       ) -> Increase::Internal::Page[Increase::Card]
 
+      def create_details_iframe: (
+        String card_id,
+        ?physical_card_id: String,
+        ?request_options: Increase::request_opts
+      ) -> Increase::CardIframeURL
+
       def details: (
         String card_id,
         ?request_options: Increase::request_opts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.39.0
+  version: 1.40.0
 platform: ruby
 authors:
 - Increase
@@ -102,6 +102,7 @@ files:
 - lib/increase/models/bookkeeping_entry_set_list_params.rb
 - lib/increase/models/bookkeeping_entry_set_retrieve_params.rb
 - lib/increase/models/card.rb
+- lib/increase/models/card_create_details_iframe_params.rb
 - lib/increase/models/card_create_params.rb
 - lib/increase/models/card_details.rb
 - lib/increase/models/card_details_params.rb
@@ -109,6 +110,7 @@ files:
 - lib/increase/models/card_dispute_create_params.rb
 - lib/increase/models/card_dispute_list_params.rb
 - lib/increase/models/card_dispute_retrieve_params.rb
+- lib/increase/models/card_iframe_url.rb
 - lib/increase/models/card_list_params.rb
 - lib/increase/models/card_payment.rb
 - lib/increase/models/card_payment_list_params.rb
@@ -484,6 +486,7 @@ files:
 - rbi/increase/models/bookkeeping_entry_set_list_params.rbi
 - rbi/increase/models/bookkeeping_entry_set_retrieve_params.rbi
 - rbi/increase/models/card.rbi
+- rbi/increase/models/card_create_details_iframe_params.rbi
 - rbi/increase/models/card_create_params.rbi
 - rbi/increase/models/card_details.rbi
 - rbi/increase/models/card_details_params.rbi
@@ -491,6 +494,7 @@ files:
 - rbi/increase/models/card_dispute_create_params.rbi
 - rbi/increase/models/card_dispute_list_params.rbi
 - rbi/increase/models/card_dispute_retrieve_params.rbi
+- rbi/increase/models/card_iframe_url.rbi
 - rbi/increase/models/card_list_params.rbi
 - rbi/increase/models/card_payment.rbi
 - rbi/increase/models/card_payment_list_params.rbi
@@ -865,6 +869,7 @@ files:
 - sig/increase/models/bookkeeping_entry_set_list_params.rbs
 - sig/increase/models/bookkeeping_entry_set_retrieve_params.rbs
 - sig/increase/models/card.rbs
+- sig/increase/models/card_create_details_iframe_params.rbs
 - sig/increase/models/card_create_params.rbs
 - sig/increase/models/card_details.rbs
 - sig/increase/models/card_details_params.rbs
@@ -872,6 +877,7 @@ files:
 - sig/increase/models/card_dispute_create_params.rbs
 - sig/increase/models/card_dispute_list_params.rbs
 - sig/increase/models/card_dispute_retrieve_params.rbs
+- sig/increase/models/card_iframe_url.rbs
 - sig/increase/models/card_list_params.rbs
 - sig/increase/models/card_payment.rbs
 - sig/increase/models/card_payment_list_params.rbs