dodopayments 1.18.0 → 1.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5893887fb8cc4a7d0167f490b1c1a6d70480c05540d8cece0ce556b38688082a
-  data.tar.gz: f96bf3c63b0a72a140e9e5e5cf46168300a4ce4ba03f46b30cdc2c7932ecb5de
+  metadata.gz: faa49e494933cd4c99fe0aabf206b9265ef8f78ad00bb290d8bfbfb17479c055
+  data.tar.gz: 655d18ea3f74079e16381502bad83a559e9febab0b309b513b1d5d21b463cdce
 SHA512:
-  metadata.gz: 28a0005ba7b8f0e1a0aca68a9fd63e3cb58f1866de67d622fb99c2cf8fe639981a4a311ceb2e7c43bd2c50cb0809474ee76024c0de649ff310a6795b02dca514
-  data.tar.gz: 4856a6d0cb1e1634089fe7e845a6c1a7a356e5b3fc757744343501db4cd9e5857502daa8b17728c1d3f198c0e2c908809185a3f27583ddd0e830c6accac6c1fa
+  metadata.gz: e6ae05ae801c276d4ddf672bde0c31e0101cbf0dcca5378b2147cf3b8bba6635e1eb46073e672d957ecaa4f5ea576a6d10deb1c78b70da6ee1c20811c8a9e03e
+  data.tar.gz: f30f1c50f072dc1af5ad05cb3248c4958139f514e9abc83d8fbd9e1746a66b26e3943c0311d54edf7e2ce9550a40a3302445d16094aa33f92a69f1095db66090

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 1.18.1 (2025-04-25)
+
+Full Changelog: [v1.18.0...v1.18.1](https://github.com/dodopayments/dodopayments-ruby/compare/v1.18.0...v1.18.1)
+
+### Features
+
+* support specifying content-type with FilePart class ([05ee21c](https://github.com/dodopayments/dodopayments-ruby/commit/05ee21c08e27593808a49a31d8a06b2aa9fdf1a9))
+* support webmock for testing ([aff42ca](https://github.com/dodopayments/dodopayments-ruby/commit/aff42ca9a2c889dadb9eb375948d36302d3504b0))
+
+
+### Chores
+
+* broadly detect json family of content-type headers ([826d222](https://github.com/dodopayments/dodopayments-ruby/commit/826d222ddeb13f2778a39d55534248e13be8f409))
+* **ci:** only use depot for staging repos ([bb8e176](https://github.com/dodopayments/dodopayments-ruby/commit/bb8e17605af188705dccc623554128e933180811))
+* **internal:** codegen related update ([e449407](https://github.com/dodopayments/dodopayments-ruby/commit/e4494070a75a27e9cc85bacc312c816fff999541))
+* **internal:** improve response envelope unwrap functionality ([6e7675c](https://github.com/dodopayments/dodopayments-ruby/commit/6e7675c0fb1ad1618fd2d1a2e44e0e7e67c56456))
+* show truncated parameter docs in yard ([904002a](https://github.com/dodopayments/dodopayments-ruby/commit/904002ac59c8008068ad27dd17c43e433f8d1a32))
+
 ## 1.18.0 (2025-04-23)
 
 Full Changelog: [v1.17.0...v1.18.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.17.0...v1.18.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.18.0"
+gem "dodopayments", "~> 1.18.1"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case contents
+      in Pathname
+        contents.read(binmode: true)
+      in StringIO
+        contents.string
+      in IO
+        contents.read
+      in String
+        contents
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : File.basename(filename)
+        else
+          filename.nil? ? nil : File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end

data/lib/dodopayments/internal/transport/base_client.rb

@@ -153,7 +153,7 @@ module Dodopayments
 
         # @api private
         # @return [Dodopayments::Internal::Transport::PooledNetRequester]
-        attr_accessor :requester
+        attr_reader :requester
 
         # @api private
         #
@@ -214,7 +214,7 @@ module Dodopayments
         #
         #   @option req [Object, nil] :body
         #
-        #   @option req [Symbol, nil] :unwrap
+        #   @option req [Symbol, Integer, Array<Symbol, Integer>, Proc, nil] :unwrap
         #
         #   @option req [Class<Dodopayments::Internal::Type::BasePage>, nil] :page
         #
@@ -418,7 +418,7 @@ module Dodopayments
         #
         # @param body [Object, nil]
         #
-        # @param unwrap [Symbol, nil]
+        # @param unwrap [Symbol, Integer, Array<Symbol, Integer>, Proc, nil]
         #
         # @param page [Class<Dodopayments::Internal::Type::BasePage>, nil]
         #

data/lib/dodopayments/internal/transport/pooled_net_requester.rb

@@ -176,7 +176,7 @@ module Dodopayments
             conn.finish if !eof && conn&.started?
             closing&.call
           end
-          [Integer(response.code), response, (response.body = body)]
+          [Integer(response.code), response, body]
         end
 
         # @api private

data/lib/dodopayments/internal/type/converter.rb

@@ -43,7 +43,7 @@ module Dodopayments
             value.string
           in Pathname | IO
             state[:can_retry] = false if value.is_a?(IO)
-            Dodopayments::Internal::Util::SerializationAdapter.new(value)
+            Dodopayments::FilePart.new(value)
           else
             value
           end

data/lib/dodopayments/internal/type/{io_like.rb → file_input.rb}

@@ -7,8 +7,12 @@ module Dodopayments
       #
       # @abstract
       #
-      # Either `Pathname` or `StringIO`.
-      class IOLike
+      # Either `Pathname` or `StringIO`, or `IO`, or
+      # `Dodopayments::Internal::Type::FileInput`.
+      #
+      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
+      # not rewindable.
+      class FileInput
         extend Dodopayments::Internal::Type::Converter
 
         private_class_method :new
@@ -20,7 +24,7 @@ module Dodopayments
         # @return [Boolean]
         def self.===(other)
           case other
-          in StringIO | Pathname | IO
+          in Pathname | StringIO | IO | String | Dodopayments::FilePart
             true
           else
             false
@@ -32,7 +36,7 @@ module Dodopayments
         # @param other [Object]
         #
         # @return [Boolean]
-        def self.==(other) = other.is_a?(Class) && other <= Dodopayments::Internal::Type::IOLike
+        def self.==(other) = other.is_a?(Class) && other <= Dodopayments::Internal::Type::FileInput
 
         class << self
           # @api private

data/lib/dodopayments/internal/util.rb

@@ -175,18 +175,17 @@ module Dodopayments
         # @api private
         #
         # @param data [Hash{Symbol=>Object}, Array<Object>, Object]
-        # @param pick [Symbol, Integer, Array<Symbol, Integer>, nil]
-        # @param sentinel [Object, nil]
+        # @param pick [Symbol, Integer, Array<Symbol, Integer>, Proc, nil]
         # @param blk [Proc, nil]
         #
         # @return [Object, nil]
-        def dig(data, pick, sentinel = nil, &blk)
-          case [data, pick, blk]
-          in [_, nil, nil]
+        def dig(data, pick, &blk)
+          case [data, pick]
+          in [_, nil]
             data
-          in [Hash, Symbol, _] | [Array, Integer, _]
-            blk.nil? ? data.fetch(pick, sentinel) : data.fetch(pick, &blk)
-          in [Hash | Array, Array, _]
+          in [Hash, Symbol] | [Array, Integer]
+            data.fetch(pick) { blk&.call }
+          in [Hash | Array, Array]
             pick.reduce(data) do |acc, key|
               case acc
               in Hash if acc.key?(key)
@@ -194,11 +193,13 @@ module Dodopayments
               in Array if key.is_a?(Integer) && key < acc.length
                 acc[key]
               else
-                return blk.nil? ? sentinel : blk.call
+                return blk&.call
               end
             end
-          in _
-            blk.nil? ? sentinel : blk.call
+          in [_, Proc]
+            pick.call(data)
+          else
+            blk&.call
           end
         end
       end
@@ -348,27 +349,6 @@ module Dodopayments
         end
       end
 
-      # @api private
-      class SerializationAdapter
-        # @return [Pathname, IO]
-        attr_reader :inner
-
-        # @param a [Object]
-        #
-        # @return [String]
-        def to_json(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_json(*a)
-
-        # @param a [Object]
-        #
-        # @return [String]
-        def to_yaml(*a) = (inner.is_a?(IO) ? inner.read : inner.read(binmode: true)).to_yaml(*a)
-
-        # @api private
-        #
-        # @param inner [Pathname, IO]
-        def initialize(inner) = @inner = inner
-      end
-
       # @api private
       #
       # An adapter that satisfies the IO interface required by `::IO.copy_stream`
@@ -471,46 +451,44 @@ module Dodopayments
         end
       end
 
+      # @type [Regexp]
+      JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
+      # @type [Regexp]
+      JSONL_CONTENT = %r{^application/(?:x-)?jsonl}
+
       class << self
         # @api private
         #
         # @param y [Enumerator::Yielder]
-        # @param boundary [String]
-        # @param key [Symbol, String]
         # @param val [Object]
         # @param closing [Array<Proc>]
-        private def write_multipart_chunk(y, boundary:, key:, val:, closing:)
-          val = val.inner if val.is_a?(Dodopayments::Internal::Util::SerializationAdapter)
+        # @param content_type [String, nil]
+        private def write_multipart_content(y, val:, closing:, content_type: nil)
+          content_type ||= "application/octet-stream"
 
-          y << "--#{boundary}\r\n"
-          y << "Content-Disposition: form-data"
-          unless key.nil?
-            name = ERB::Util.url_encode(key.to_s)
-            y << "; name=\"#{name}\""
-          end
-          case val
-          in Pathname | IO
-            filename = ERB::Util.url_encode(File.basename(val.to_path))
-            y << "; filename=\"#{filename}\""
-          else
-          end
-          y << "\r\n"
           case val
+          in Dodopayments::FilePart
+            return write_multipart_content(
+              y,
+              val: val.content,
+              closing: closing,
+              content_type: val.content_type
+            )
           in Pathname
-            y << "Content-Type: application/octet-stream\r\n\r\n"
+            y << "Content-Type: #{content_type}\r\n\r\n"
             io = val.open(binmode: true)
             closing << io.method(:close)
             IO.copy_stream(io, y)
           in IO
-            y << "Content-Type: application/octet-stream\r\n\r\n"
+            y << "Content-Type: #{content_type}\r\n\r\n"
             IO.copy_stream(val, y)
           in StringIO
-            y << "Content-Type: application/octet-stream\r\n\r\n"
+            y << "Content-Type: #{content_type}\r\n\r\n"
             y << val.string
           in String
-            y << "Content-Type: application/octet-stream\r\n\r\n"
+            y << "Content-Type: #{content_type}\r\n\r\n"
             y << val.to_s
-          in _ if primitive?(val)
+          in -> { primitive?(_1) }
             y << "Content-Type: text/plain\r\n\r\n"
             y << val.to_s
           else
@@ -520,6 +498,36 @@ module Dodopayments
           y << "\r\n"
         end
 
+        # @api private
+        #
+        # @param y [Enumerator::Yielder]
+        # @param boundary [String]
+        # @param key [Symbol, String]
+        # @param val [Object]
+        # @param closing [Array<Proc>]
+        private def write_multipart_chunk(y, boundary:, key:, val:, closing:)
+          y << "--#{boundary}\r\n"
+          y << "Content-Disposition: form-data"
+
+          unless key.nil?
+            name = ERB::Util.url_encode(key.to_s)
+            y << "; name=\"#{name}\""
+          end
+
+          case val
+          in Dodopayments::FilePart unless val.filename.nil?
+            filename = ERB::Util.url_encode(val.filename)
+            y << "; filename=\"#{filename}\""
+          in Pathname | IO
+            filename = ERB::Util.url_encode(File.basename(val.to_path))
+            y << "; filename=\"#{filename}\""
+          else
+          end
+          y << "\r\n"
+
+          write_multipart_content(y, val: val, closing: closing)
+        end
+
         # @api private
         #
         # @param body [Object]
@@ -560,14 +568,12 @@ module Dodopayments
         # @return [Object]
         def encode_content(headers, body)
           content_type = headers["content-type"]
-          body = body.inner if body.is_a?(Dodopayments::Internal::Util::SerializationAdapter)
-
           case [content_type, body]
-          in [%r{^application/(?:vnd\.api\+)?json}, Hash | Array | -> { primitive?(_1) }]
+          in [Dodopayments::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
             [headers, JSON.fast_generate(body)]
-          in [%r{^application/(?:x-)?jsonl}, Enumerable] unless body.is_a?(StringIO) || body.is_a?(IO)
+          in [Dodopayments::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Dodopayments::Internal::Type::FileInput)
             [headers, body.lazy.map { JSON.fast_generate(_1) }]
-          in [%r{^multipart/form-data}, Hash | Pathname | StringIO | IO]
+          in [%r{^multipart/form-data}, Hash | Dodopayments::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
             [headers, strio]
@@ -575,6 +581,8 @@ module Dodopayments
             [headers, body.to_s]
           in [_, StringIO]
             [headers, body.string]
+          in [_, Dodopayments::FilePart]
+            [headers, body.content]
           else
             [headers, body]
           end
@@ -611,7 +619,7 @@ module Dodopayments
         # @return [Object]
         def decode_content(headers, stream:, suppress_error: false)
           case (content_type = headers["content-type"])
-          in %r{^application/(?:vnd\.api\+)?json}
+          in Dodopayments::Internal::Util::JSON_CONTENT
             json = stream.to_a.join
             begin
               JSON.parse(json, symbolize_names: true)
@@ -619,7 +627,7 @@ module Dodopayments
               raise e unless suppress_error
               json
             end
-          in %r{^application/(?:x-)?jsonl}
+          in Dodopayments::Internal::Util::JSONL_CONTENT
             lines = decode_lines(stream)
             chain_fused(lines) do |y|
               lines.each { y << JSON.parse(_1, symbolize_names: true) }

data/lib/dodopayments/models/billing_address.rb

@@ -34,11 +34,15 @@ module Dodopayments
       required :zipcode, String
 
       # @!method initialize(city:, country:, state:, street:, zipcode:)
-      #   @param city [String]
-      #   @param country [Symbol, Dodopayments::Models::CountryCode]
-      #   @param state [String]
-      #   @param street [String]
-      #   @param zipcode [String]
+      #   @param city [String] City name
+      #
+      #   @param country [Symbol, Dodopayments::Models::CountryCode] ISO country code alpha2 variant
+      #
+      #   @param state [String] State or province name
+      #
+      #   @param street [String] Street address including house number and unit/apartment if applicable
+      #
+      #   @param zipcode [String] Postal code or ZIP code
     end
   end
 end

data/lib/dodopayments/models/create_new_customer.rb

@@ -27,9 +27,16 @@ module Dodopayments
       optional :phone_number, String, nil?: true
 
       # @!method initialize(email:, name:, create_new_customer: nil, phone_number: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::CreateNewCustomer} for more details.
+      #
       #   @param email [String]
+      #
       #   @param name [String]
-      #   @param create_new_customer [Boolean]
+      #
+      #   @param create_new_customer [Boolean] When false, the most recently created customer object with the given email is us
+      #   ...
+      #
       #   @param phone_number [String, nil]
     end
   end

data/lib/dodopayments/models/customer_limited_details.rb

@@ -22,9 +22,11 @@ module Dodopayments
       required :name, String
 
       # @!method initialize(customer_id:, email:, name:)
-      #   @param customer_id [String]
-      #   @param email [String]
-      #   @param name [String]
+      #   @param customer_id [String] Unique identifier for the customer
+      #
+      #   @param email [String] Email address of the customer
+      #
+      #   @param name [String] Full name of the customer
     end
   end
 end

data/lib/dodopayments/models/customer_list_params.rb

@@ -20,8 +20,10 @@ module Dodopayments
       optional :page_size, Integer, nil?: true
 
       # @!method initialize(page_number: nil, page_size: nil, request_options: {})
-      #   @param page_number [Integer, nil]
-      #   @param page_size [Integer, nil]
+      #   @param page_number [Integer, nil] Page number default is 0
+      #
+      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/customers/customer_portal_create_params.rb

@@ -15,7 +15,8 @@ module Dodopayments
         optional :send_email, Dodopayments::Internal::Type::Boolean, nil?: true
 
         # @!method initialize(send_email: nil, request_options: {})
-        #   @param send_email [Boolean, nil]
+        #   @param send_email [Boolean, nil] If true, will send link to user.
+        #
         #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/dodopayments/models/discount.rb

@@ -74,17 +74,30 @@ module Dodopayments
       optional :usage_limit, Integer, nil?: true
 
       # @!method initialize(amount:, business_id:, code:, created_at:, discount_id:, restricted_to:, times_used:, type:, expires_at: nil, name: nil, usage_limit: nil)
-      #   @param amount [Integer]
-      #   @param business_id [String]
-      #   @param code [String]
-      #   @param created_at [Time]
-      #   @param discount_id [String]
-      #   @param restricted_to [Array<String>]
-      #   @param times_used [Integer]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::Discount} for more details.
+      #
+      #   @param amount [Integer] The discount amount. ...
+      #
+      #   @param business_id [String] The business this discount belongs to.
+      #
+      #   @param code [String] The discount code (up to 16 chars).
+      #
+      #   @param created_at [Time] Timestamp when the discount is created
+      #
+      #   @param discount_id [String] The unique discount ID
+      #
+      #   @param restricted_to [Array<String>] List of product IDs to which this discount is restricted.
+      #
+      #   @param times_used [Integer] How many times this discount has been used.
+      #
       #   @param type [Symbol, Dodopayments::Models::DiscountType]
-      #   @param expires_at [Time, nil]
-      #   @param name [String, nil]
-      #   @param usage_limit [Integer, nil]
+      #
+      #   @param expires_at [Time, nil] Optional date/time after which discount is expired.
+      #
+      #   @param name [String, nil] Name for the Discount
+      #
+      #   @param usage_limit [Integer, nil] Usage limit for this discount, if any.
     end
   end
 end

data/lib/dodopayments/models/discount_create_params.rb

@@ -58,13 +58,23 @@ module Dodopayments
       optional :usage_limit, Integer, nil?: true
 
       # @!method initialize(amount:, type:, code: nil, expires_at: nil, name: nil, restricted_to: nil, usage_limit: nil, request_options: {})
-      #   @param amount [Integer]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::DiscountCreateParams} for more details.
+      #
+      #   @param amount [Integer] The discount amount. ...
+      #
       #   @param type [Symbol, Dodopayments::Models::DiscountType]
-      #   @param code [String, nil]
-      #   @param expires_at [Time, nil]
+      #
+      #   @param code [String, nil] Optionally supply a code (will be uppercased). ...
+      #
+      #   @param expires_at [Time, nil] When the discount expires, if ever.
+      #
       #   @param name [String, nil]
-      #   @param restricted_to [Array<String>, nil]
-      #   @param usage_limit [Integer, nil]
+      #
+      #   @param restricted_to [Array<String>, nil] List of product IDs to restrict usage (if any).
+      #
+      #   @param usage_limit [Integer, nil] How many times this discount can be used (if any). ...
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/discount_list_params.rb

@@ -20,8 +20,10 @@ module Dodopayments
       optional :page_size, Integer, nil?: true
 
       # @!method initialize(page_number: nil, page_size: nil, request_options: {})
-      #   @param page_number [Integer, nil]
-      #   @param page_size [Integer, nil]
+      #   @param page_number [Integer, nil] Page number (default = 0).
+      #
+      #   @param page_size [Integer, nil] Page size (default = 10, max = 100).
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/discount_update_params.rb

@@ -53,13 +53,23 @@ module Dodopayments
       optional :usage_limit, Integer, nil?: true
 
       # @!method initialize(amount: nil, code: nil, expires_at: nil, name: nil, restricted_to: nil, type: nil, usage_limit: nil, request_options: {})
-      #   @param amount [Integer, nil]
-      #   @param code [String, nil]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::DiscountUpdateParams} for more details.
+      #
+      #   @param amount [Integer, nil] If present, update the discount amount: ...
+      #
+      #   @param code [String, nil] If present, update the discount code (uppercase).
+      #
       #   @param expires_at [Time, nil]
+      #
       #   @param name [String, nil]
-      #   @param restricted_to [Array<String>, nil]
+      #
+      #   @param restricted_to [Array<String>, nil] If present, replaces all restricted product IDs with this new set. ...
+      #
       #   @param type [Symbol, Dodopayments::Models::DiscountType, nil]
+      #
       #   @param usage_limit [Integer, nil]
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/dodopayments/models/dispute.rb

@@ -52,14 +52,25 @@ module Dodopayments
       required :payment_id, String
 
       # @!method initialize(amount:, business_id:, created_at:, currency:, dispute_id:, dispute_stage:, dispute_status:, payment_id:)
-      #   @param amount [String]
-      #   @param business_id [String]
-      #   @param created_at [Time]
-      #   @param currency [String]
-      #   @param dispute_id [String]
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::Dispute} for more details.
+      #
+      #   @param amount [String] The amount involved in the dispute, represented as a string to accommodate preci
+      #   ...
+      #
+      #   @param business_id [String] The unique identifier of the business involved in the dispute.
+      #
+      #   @param created_at [Time] The timestamp of when the dispute was created, in UTC.
+      #
+      #   @param currency [String] The currency of the disputed amount, represented as an ISO 4217 currency code.
+      #
+      #   @param dispute_id [String] The unique identifier of the dispute.
+      #
       #   @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage]
+      #
       #   @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus]
-      #   @param payment_id [String]
+      #
+      #   @param payment_id [String] The unique identifier of the payment associated with the dispute.
     end
   end
 end

data/lib/dodopayments/models/dispute_list_params.rb

@@ -50,13 +50,20 @@ module Dodopayments
       optional :page_size, Integer, nil?: true
 
       # @!method initialize(created_at_gte: nil, created_at_lte: nil, customer_id: nil, dispute_stage: nil, dispute_status: nil, page_number: nil, page_size: nil, request_options: {})
-      #   @param created_at_gte [Time, nil]
-      #   @param created_at_lte [Time, nil]
-      #   @param customer_id [String, nil]
-      #   @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage, nil]
-      #   @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus, nil]
-      #   @param page_number [Integer, nil]
-      #   @param page_size [Integer, nil]
+      #   @param created_at_gte [Time, nil] Get events after this created time
+      #
+      #   @param created_at_lte [Time, nil] Get events created before this time
+      #
+      #   @param customer_id [String, nil] Filter by customer_id
+      #
+      #   @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage, nil] Filter by dispute stage
+      #
+      #   @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus, nil] Filter by dispute status
+      #
+      #   @param page_number [Integer, nil] Page number default is 0
+      #
+      #   @param page_size [Integer, nil] Page size default is 10 max is 100
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
     end
   end