dodopayments 1.56.0 → 1.56.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce3e5943f7a051da09468b89769723b9a1ec3c8e985572676ac5ccbf1b9d6ad4
-  data.tar.gz: 244eb00a4c80ec77cf6aaffe5dea51207b4ebecf2afc310a26791f9471dcf997
+  metadata.gz: 12aa5f73bbc394a9c94235aa84d6cd067df7d038adcf3de991bace729b58afd7
+  data.tar.gz: 99d11f78c2f2cac8457f9d656c190a31bf9e2eaa7369d47351906742d2012a35
 SHA512:
-  metadata.gz: a5ce6a84b5bf1224822d61c145e43ff3061bfbb5c8b7e8193e7ee929e94bf968e0129db2320c08862b49d21f2a2e53be13b0ace6f484d27b0b287d111a60f667
-  data.tar.gz: 78ff2e68c238a62dc345a945ac0f0c36123043cc36a83dccbc78143d6d5ac71667334b5af3d981203d8425e79162daede453b00f0d40c8e8ab58a830e8e99b3e
+  metadata.gz: fda9e6a8f1b679fd1d3695c130dceefabc5e354467d70d8319c912a3a55908a182b7ecd0123cb5a4c14123899411a16ff98767a00f867e8d2018562e4b63d2df
+  data.tar.gz: 29ac046586bd1d5175a1b63bd2f6ed6d8a285b6e5edb49a78531949378d0356e1ffd0ba67d5794728ca2ecfb9abb84fc497d118ee565a825eed380911a60009e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.56.2 (2025-10-27)
+
+Full Changelog: [v1.56.0...v1.56.2](https://github.com/dodopayments/dodopayments-ruby/compare/v1.56.0...v1.56.2)
+
+### Features
+
+* **api:** updated to openapi spec v1.56.0 ([e734ebf](https://github.com/dodopayments/dodopayments-ruby/commit/e734ebfd1718a0cfda521a01c71dc0b7faf4a1cd))
+
 ## 1.56.0 (2025-10-25)
 
 Full Changelog: [v1.55.8...v1.56.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.55.8...v1.56.0)

data/README.md

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

data/lib/dodopayments/models/checkout_session_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::CheckoutSessions#retrieve
+    class CheckoutSessionRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/checkout_session_status.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::CheckoutSessions#retrieve
+    class CheckoutSessionStatus < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #   Id of the checkout session
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Created at timestamp
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute customer_email
+      #   Customer email: prefers payment's customer, falls back to session
+      #
+      #   @return [String, nil]
+      optional :customer_email, String, nil?: true
+
+      # @!attribute customer_name
+      #   Customer name: prefers payment's customer, falls back to session
+      #
+      #   @return [String, nil]
+      optional :customer_name, String, nil?: true
+
+      # @!attribute payment_id
+      #   Id of the payment created by the checkout sessions.
+      #
+      #   Null if checkout sessions is still at the details collection stage.
+      #
+      #   @return [String, nil]
+      optional :payment_id, String, nil?: true
+
+      # @!attribute payment_status
+      #   status of the payment.
+      #
+      #   Null if checkout sessions is still at the details collection stage.
+      #
+      #   @return [Symbol, Dodopayments::Models::IntentStatus, nil]
+      optional :payment_status, enum: -> { Dodopayments::IntentStatus }, nil?: true
+
+      # @!method initialize(id:, created_at:, customer_email: nil, customer_name: nil, payment_id: nil, payment_status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::CheckoutSessionStatus} for more details.
+      #
+      #   @param id [String] Id of the checkout session
+      #
+      #   @param created_at [Time] Created at timestamp
+      #
+      #   @param customer_email [String, nil] Customer email: prefers payment's customer, falls back to session
+      #
+      #   @param customer_name [String, nil] Customer name: prefers payment's customer, falls back to session
+      #
+      #   @param payment_id [String, nil] Id of the payment created by the checkout sessions.
+      #
+      #   @param payment_status [Symbol, Dodopayments::Models::IntentStatus, nil] status of the payment.
+    end
+  end
+end

data/lib/dodopayments/models/subscription_update_params.rb

@@ -18,6 +18,11 @@ module Dodopayments
       #   @return [Boolean, nil]
       optional :cancel_at_next_billing_date, Dodopayments::Internal::Type::Boolean, nil?: true
 
+      # @!attribute customer_name
+      #
+      #   @return [String, nil]
+      optional :customer_name, String, nil?: true
+
       # @!attribute disable_on_demand
       #
       #   @return [Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil]
@@ -43,11 +48,13 @@ module Dodopayments
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!method initialize(billing: nil, cancel_at_next_billing_date: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
+      # @!method initialize(billing: nil, cancel_at_next_billing_date: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
       #   @param billing [Dodopayments::Models::BillingAddress, nil]
       #
       #   @param cancel_at_next_billing_date [Boolean, nil] When set, the subscription will remain active until the end of billing period
       #
+      #   @param customer_name [String, nil]
+      #
       #   @param disable_on_demand [Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil]
       #
       #   @param metadata [Hash{Symbol=>String}, nil]

data/lib/dodopayments/models.rb

@@ -79,6 +79,10 @@ module Dodopayments
 
   CheckoutSessionResponse = Dodopayments::Models::CheckoutSessionResponse
 
+  CheckoutSessionRetrieveParams = Dodopayments::Models::CheckoutSessionRetrieveParams
+
+  CheckoutSessionStatus = Dodopayments::Models::CheckoutSessionStatus
+
   CountryCode = Dodopayments::Models::CountryCode
 
   CreateNewCustomer = Dodopayments::Models::CreateNewCustomer

data/lib/dodopayments/resources/checkout_sessions.rb

@@ -52,6 +52,23 @@ module Dodopayments
         )
       end
 
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::CheckoutSessionStatus]
+      #
+      # @see Dodopayments::Models::CheckoutSessionRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["checkouts/%1$s", id],
+          model: Dodopayments::CheckoutSessionStatus,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Dodopayments::Client]

data/lib/dodopayments/resources/subscriptions.rb

@@ -74,7 +74,7 @@ module Dodopayments
         )
       end
 
-      # @overload update(subscription_id, billing: nil, cancel_at_next_billing_date: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
+      # @overload update(subscription_id, billing: nil, cancel_at_next_billing_date: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
       #
       # @param subscription_id [String] Subscription Id
       #
@@ -82,6 +82,8 @@ module Dodopayments
       #
       # @param cancel_at_next_billing_date [Boolean, nil] When set, the subscription will remain active until the end of billing period
       #
+      # @param customer_name [String, nil]
+      #
       # @param disable_on_demand [Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil]
       #
       # @param metadata [Hash{Symbol=>String}, nil]

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "1.56.0"
+  VERSION = "1.56.2"
 end

data/lib/dodopayments.rb

@@ -81,6 +81,8 @@ require_relative "dodopayments/models/brand_update_images_response"
 require_relative "dodopayments/models/brand_update_params"
 require_relative "dodopayments/models/checkout_session_create_params"
 require_relative "dodopayments/models/checkout_session_response"
+require_relative "dodopayments/models/checkout_session_retrieve_params"
+require_relative "dodopayments/models/checkout_session_status"
 require_relative "dodopayments/models/country_code"
 require_relative "dodopayments/models/create_new_customer"
 require_relative "dodopayments/models/currency"

data/rbi/dodopayments/models/checkout_session_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class CheckoutSessionRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::CheckoutSessionRetrieveParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Dodopayments::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: Dodopayments::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/checkout_session_status.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class CheckoutSessionStatus < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::CheckoutSessionStatus,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Id of the checkout session
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Created at timestamp
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Customer email: prefers payment's customer, falls back to session
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_email
+
+      # Customer name: prefers payment's customer, falls back to session
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_name
+
+      # Id of the payment created by the checkout sessions.
+      #
+      # Null if checkout sessions is still at the details collection stage.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payment_id
+
+      # status of the payment.
+      #
+      # Null if checkout sessions is still at the details collection stage.
+      sig { returns(T.nilable(Dodopayments::IntentStatus::TaggedSymbol)) }
+      attr_accessor :payment_status
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          customer_email: T.nilable(String),
+          customer_name: T.nilable(String),
+          payment_id: T.nilable(String),
+          payment_status: T.nilable(Dodopayments::IntentStatus::OrSymbol)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Id of the checkout session
+        id:,
+        # Created at timestamp
+        created_at:,
+        # Customer email: prefers payment's customer, falls back to session
+        customer_email: nil,
+        # Customer name: prefers payment's customer, falls back to session
+        customer_name: nil,
+        # Id of the payment created by the checkout sessions.
+        #
+        # Null if checkout sessions is still at the details collection stage.
+        payment_id: nil,
+        # status of the payment.
+        #
+        # Null if checkout sessions is still at the details collection stage.
+        payment_status: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            customer_email: T.nilable(String),
+            customer_name: T.nilable(String),
+            payment_id: T.nilable(String),
+            payment_status: T.nilable(Dodopayments::IntentStatus::TaggedSymbol)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -26,6 +26,9 @@ module Dodopayments
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :cancel_at_next_billing_date
 
+      sig { returns(T.nilable(String)) }
+      attr_accessor :customer_name
+
       sig do
         returns(
           T.nilable(Dodopayments::SubscriptionUpdateParams::DisableOnDemand)
@@ -59,6 +62,7 @@ module Dodopayments
         params(
           billing: T.nilable(Dodopayments::BillingAddress::OrHash),
           cancel_at_next_billing_date: T.nilable(T::Boolean),
+          customer_name: T.nilable(String),
           disable_on_demand:
             T.nilable(
               Dodopayments::SubscriptionUpdateParams::DisableOnDemand::OrHash
@@ -74,6 +78,7 @@ module Dodopayments
         billing: nil,
         # When set, the subscription will remain active until the end of billing period
         cancel_at_next_billing_date: nil,
+        customer_name: nil,
         disable_on_demand: nil,
         metadata: nil,
         next_billing_date: nil,
@@ -88,6 +93,7 @@ module Dodopayments
           {
             billing: T.nilable(Dodopayments::BillingAddress),
             cancel_at_next_billing_date: T.nilable(T::Boolean),
+            customer_name: T.nilable(String),
             disable_on_demand:
               T.nilable(
                 Dodopayments::SubscriptionUpdateParams::DisableOnDemand

data/rbi/dodopayments/models.rbi

@@ -42,6 +42,11 @@ module Dodopayments
 
   CheckoutSessionResponse = Dodopayments::Models::CheckoutSessionResponse
 
+  CheckoutSessionRetrieveParams =
+    Dodopayments::Models::CheckoutSessionRetrieveParams
+
+  CheckoutSessionStatus = Dodopayments::Models::CheckoutSessionStatus
+
   CountryCode = Dodopayments::Models::CountryCode
 
   CreateNewCustomer = Dodopayments::Models::CreateNewCustomer

data/rbi/dodopayments/resources/checkout_sessions.rbi

@@ -74,6 +74,15 @@ module Dodopayments
       )
       end
 
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::CheckoutSessionStatus)
+      end
+      def retrieve(id, request_options: {})
+      end
+
       # @api private
       sig { params(client: Dodopayments::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -91,6 +91,7 @@ module Dodopayments
           subscription_id: String,
           billing: T.nilable(Dodopayments::BillingAddress::OrHash),
           cancel_at_next_billing_date: T.nilable(T::Boolean),
+          customer_name: T.nilable(String),
           disable_on_demand:
             T.nilable(
               Dodopayments::SubscriptionUpdateParams::DisableOnDemand::OrHash
@@ -108,6 +109,7 @@ module Dodopayments
         billing: nil,
         # When set, the subscription will remain active until the end of billing period
         cancel_at_next_billing_date: nil,
+        customer_name: nil,
         disable_on_demand: nil,
         metadata: nil,
         next_billing_date: nil,

data/sig/dodopayments/models/checkout_session_retrieve_params.rbs

@@ -0,0 +1,15 @@
+module Dodopayments
+  module Models
+    type checkout_session_retrieve_params =
+      {  } & Dodopayments::Internal::Type::request_parameters
+
+    class CheckoutSessionRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Dodopayments::request_opts) -> void
+
+      def to_hash: -> { request_options: Dodopayments::RequestOptions }
+    end
+  end
+end

data/sig/dodopayments/models/checkout_session_status.rbs

@@ -0,0 +1,45 @@
+module Dodopayments
+  module Models
+    type checkout_session_status =
+      {
+        id: String,
+        created_at: Time,
+        customer_email: String?,
+        customer_name: String?,
+        payment_id: String?,
+        payment_status: Dodopayments::Models::intent_status?
+      }
+
+    class CheckoutSessionStatus < Dodopayments::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor customer_email: String?
+
+      attr_accessor customer_name: String?
+
+      attr_accessor payment_id: String?
+
+      attr_accessor payment_status: Dodopayments::Models::intent_status?
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        ?customer_email: String?,
+        ?customer_name: String?,
+        ?payment_id: String?,
+        ?payment_status: Dodopayments::Models::intent_status?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: Time,
+        customer_email: String?,
+        customer_name: String?,
+        payment_id: String?,
+        payment_status: Dodopayments::Models::intent_status?
+      }
+    end
+  end
+end

data/sig/dodopayments/models/subscription_update_params.rbs

@@ -4,6 +4,7 @@ module Dodopayments
       {
         billing: Dodopayments::BillingAddress?,
         cancel_at_next_billing_date: bool?,
+        customer_name: String?,
         disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?,
         metadata: ::Hash[Symbol, String]?,
         next_billing_date: Time?,
@@ -20,6 +21,8 @@ module Dodopayments
 
       attr_accessor cancel_at_next_billing_date: bool?
 
+      attr_accessor customer_name: String?
+
       attr_accessor disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?
 
       attr_accessor metadata: ::Hash[Symbol, String]?
@@ -33,6 +36,7 @@ module Dodopayments
       def initialize: (
         ?billing: Dodopayments::BillingAddress?,
         ?cancel_at_next_billing_date: bool?,
+        ?customer_name: String?,
         ?disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?,
         ?metadata: ::Hash[Symbol, String]?,
         ?next_billing_date: Time?,
@@ -44,6 +48,7 @@ module Dodopayments
       def to_hash: -> {
         billing: Dodopayments::BillingAddress?,
         cancel_at_next_billing_date: bool?,
+        customer_name: String?,
         disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?,
         metadata: ::Hash[Symbol, String]?,
         next_billing_date: Time?,

data/sig/dodopayments/models.rbs

@@ -39,6 +39,10 @@ module Dodopayments
 
   class CheckoutSessionResponse = Dodopayments::Models::CheckoutSessionResponse
 
+  class CheckoutSessionRetrieveParams = Dodopayments::Models::CheckoutSessionRetrieveParams
+
+  class CheckoutSessionStatus = Dodopayments::Models::CheckoutSessionStatus
+
   module CountryCode = Dodopayments::Models::CountryCode
 
   class CreateNewCustomer = Dodopayments::Models::CreateNewCustomer

data/sig/dodopayments/resources/checkout_sessions.rbs

@@ -19,6 +19,11 @@ module Dodopayments
         ?request_options: Dodopayments::request_opts
       ) -> Dodopayments::CheckoutSessionResponse
 
+      def retrieve: (
+        String id,
+        ?request_options: Dodopayments::request_opts
+      ) -> Dodopayments::CheckoutSessionStatus
+
       def initialize: (client: Dodopayments::Client) -> void
     end
   end

data/sig/dodopayments/resources/subscriptions.rbs

@@ -30,6 +30,7 @@ module Dodopayments
         String subscription_id,
         ?billing: Dodopayments::BillingAddress?,
         ?cancel_at_next_billing_date: bool?,
+        ?customer_name: String?,
         ?disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?,
         ?metadata: ::Hash[Symbol, String]?,
         ?next_billing_date: Time?,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dodopayments
 version: !ruby/object:Gem::Version
-  version: 1.56.0
+  version: 1.56.2
 platform: ruby
 authors:
 - Dodo Payments
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-25 00:00:00.000000000 Z
+date: 2025-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -80,6 +80,8 @@ files:
 - lib/dodopayments/models/checkout_session_create_params.rb
 - lib/dodopayments/models/checkout_session_request.rb
 - lib/dodopayments/models/checkout_session_response.rb
+- lib/dodopayments/models/checkout_session_retrieve_params.rb
+- lib/dodopayments/models/checkout_session_status.rb
 - lib/dodopayments/models/country_code.rb
 - lib/dodopayments/models/create_new_customer.rb
 - lib/dodopayments/models/currency.rb
@@ -305,6 +307,8 @@ files:
 - rbi/dodopayments/models/checkout_session_create_params.rbi
 - rbi/dodopayments/models/checkout_session_request.rbi
 - rbi/dodopayments/models/checkout_session_response.rbi
+- rbi/dodopayments/models/checkout_session_retrieve_params.rbi
+- rbi/dodopayments/models/checkout_session_status.rbi
 - rbi/dodopayments/models/country_code.rbi
 - rbi/dodopayments/models/create_new_customer.rbi
 - rbi/dodopayments/models/currency.rbi
@@ -529,6 +533,8 @@ files:
 - sig/dodopayments/models/checkout_session_create_params.rbs
 - sig/dodopayments/models/checkout_session_request.rbs
 - sig/dodopayments/models/checkout_session_response.rbs
+- sig/dodopayments/models/checkout_session_retrieve_params.rbs
+- sig/dodopayments/models/checkout_session_status.rbs
 - sig/dodopayments/models/country_code.rbs
 - sig/dodopayments/models/create_new_customer.rbs
 - sig/dodopayments/models/currency.rbs