dodopayments 1.19.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d1a48e653837160bb439d4e35d801a8de5fe88751cd32d8a9147663e7251381
-  data.tar.gz: 03f679fa0bdc29f57ae09a458b1c31ce1c175926bbe521d5042da2a8939a5cb3
+  metadata.gz: f0db8ac6abab224124982361204de2655bd917a370eba199ce6c6ee668296f06
+  data.tar.gz: 268aa11f3fb3430ac18eb2c483ca6fc1d49d1df9801aa6f706b9233f330840f0
 SHA512:
-  metadata.gz: 401099541db5886408eb47a0f75329cc9f740b0bbf0bb4dee999897a0c496f9b880b1d6d3231904d95e05f4b5e11c8f8252d23db34f26dd640731753c1617106
-  data.tar.gz: 0b5331df7152b042e06005799a64c3ad6d39f21d199885e671464d3f6039ede3f46fa0c5ae72e523e6405e634422bd4337d99aebf4f10a26f7e7f8b7d2526638
+  metadata.gz: 38271ef5ae9db50f038f12341d8ab2153eb7683a96f8e0b1ace1a229287099acdaf9a2e0aa0cc9cf4d3cb5a9ceb76c792b6683ccdb9ea02e09a54bcef431831d
+  data.tar.gz: fa6f3f577a1a045311e8525fc720148981c4f0db35f7b1899c1e40467c47fff43c36d2531c1a3b5f6a949148d50cc9606586b9da656a6a98a5deee13968a49ef

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## 1.22.0 (2025-05-09)
+
+Full Changelog: [v1.20.0...v1.22.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.20.0...v1.22.0)
+
+### Features
+
+* **api:** fixed api key schema to bearer ([06d3549](https://github.com/dodopayments/dodopayments-ruby/commit/06d354910a3eb15c036d35f68cfb5393c5a20c62))
+* **api:** manual updates ([eae9353](https://github.com/dodopayments/dodopayments-ruby/commit/eae935376b239dc03bc8ad8ed201e9ca9c2eeaa4))
+* **api:** updated openapi spec ([c369261](https://github.com/dodopayments/dodopayments-ruby/commit/c369261442be58e8b31890f0362fba1536bb9593))
+
+
+### Bug Fixes
+
+* **internal:** fix formatting script for macos ([8abfc9c](https://github.com/dodopayments/dodopayments-ruby/commit/8abfc9c2b3921e5fb3e5903612111e02a87e92d1))
+
+
+### Chores
+
+* accept all nd-json mimetype variants ([b0dd5d6](https://github.com/dodopayments/dodopayments-ruby/commit/b0dd5d644ce5ebbcd0259dca5f9113befa548b54))
+* always check if current page is empty in `next_page?` ([45b817d](https://github.com/dodopayments/dodopayments-ruby/commit/45b817d504e3c4cbc17b328c53ab9a310d038b22))
+* **internal:** codegen related update ([e3ce1b3](https://github.com/dodopayments/dodopayments-ruby/commit/e3ce1b36a1ea8dba0fbd2915a6deadc01820d280))
+* **internal:** codegen related update ([2cd0f3e](https://github.com/dodopayments/dodopayments-ruby/commit/2cd0f3e089a67097c26e9abef90b55cecfaa014c))
+* re-export top level models under library namespace ([bbc82df](https://github.com/dodopayments/dodopayments-ruby/commit/bbc82df831d64038e9169ff0912401d2e333082b))
+* remove Gemfile.lock during bootstrap ([a484914](https://github.com/dodopayments/dodopayments-ruby/commit/a48491445f25a274883dd8068913efcd9e68c32d))
+* revert ignoring Gemfile.lock ([8ba5e6a](https://github.com/dodopayments/dodopayments-ruby/commit/8ba5e6a4f876f0823b33eb92443ebd5d97c2139f))
+* validate request option coercion correctness ([1ac286c](https://github.com/dodopayments/dodopayments-ruby/commit/1ac286ccf79b674d312bf50fa29bb8a1f7e37176))
+
+
+### Documentation
+
+* illustrate environmental defaults for auth variables ([520d6cf](https://github.com/dodopayments/dodopayments-ruby/commit/520d6cf3692d5aeaf3faee980160521d81bd3867))
+
+## 1.20.0 (2025-05-01)
+
+Full Changelog: [v1.19.0...v1.20.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.19.0...v1.20.0)
+
+### Features
+
+* **api:** added addons ([b7ab9df](https://github.com/dodopayments/dodopayments-ruby/commit/b7ab9dfcffc9113bb89668fac0870241e68ec1f8))
+* **api:** updated readme example ([7ab77ac](https://github.com/dodopayments/dodopayments-ruby/commit/7ab77ac6b2f2349a0876996b2740d4baeca97f3f))
+* **api:** updated readme example ([9646785](https://github.com/dodopayments/dodopayments-ruby/commit/964678539575be673521723ef0b41c5b5af85f97))
+
+
+### Bug Fixes
+
+* re-exported array and map models should typecheck in steep ([443c685](https://github.com/dodopayments/dodopayments-ruby/commit/443c685afdddc50872c8eddbf7acf37d1bf65402))
+
+
+### Chores
+
+* migrate away from deprecated `JSON#fast_generate` ([11a01cc](https://github.com/dodopayments/dodopayments-ruby/commit/11a01ccc3ab39f47c6b13ff359bf4ec99378c40b))
+
+
+### Documentation
+
+* **readme:** fix typo ([32dda82](https://github.com/dodopayments/dodopayments-ruby/commit/32dda82d2b0fd01b6bc1c4b19a62a39ecc3f96c1))
+
 ## 1.19.0 (2025-04-30)
 
 Full Changelog: [v1.18.3...v1.19.0](https://github.com/dodopayments/dodopayments-ruby/compare/v1.18.3...v1.19.0)

data/README.md

@@ -1,6 +1,6 @@
 # Dodo Payments Ruby API library
 
-The Dodo Payments Ruby library provides convenient access to the Dodo Payments REST API from any Ruby 3.1.0+ application.
+The Dodo Payments Ruby library provides convenient access to the Dodo Payments REST API from any Ruby 3.2.0+ application.
 
 It is generated with [Stainless](https://www.stainless.com/).
 
@@ -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.19.0"
+gem "dodopayments", "~> 1.22.0"
 ```
 
 <!-- x-release-please-end -->
@@ -29,7 +29,7 @@ require "bundler/setup"
 require "dodopayments"
 
 dodo_payments = Dodopayments::Client.new(
-  bearer_token: "My Bearer Token", # defaults to ENV["DODO_PAYMENTS_API_KEY"]
+  bearer_token: ENV["DODO_PAYMENTS_API_KEY"], # This is the default and can be omitted
   environment: "test_mode" # defaults to "live_mode"
 )
 
@@ -79,7 +79,7 @@ rescue Dodopayments::Errors::APIError => e
 end
 ```
 
-Error codes are as followed:
+Error codes are as follows:
 
 | Cause            | Error Type                 |
 | ---------------- | -------------------------- |
@@ -217,7 +217,7 @@ This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` typ
 
 ## Requirements
 
-Ruby 3.1.0 or higher.
+Ruby 3.2.0 or higher.
 
 ## Contributing
 

data/lib/dodopayments/client.rb

@@ -66,6 +66,9 @@ module Dodopayments
     # @return [Dodopayments::Resources::Discounts]
     attr_reader :discounts
 
+    # @return [Dodopayments::Resources::Addons]
+    attr_reader :addons
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -138,6 +141,7 @@ module Dodopayments
       @products = Dodopayments::Resources::Products.new(client: self)
       @misc = Dodopayments::Resources::Misc.new(client: self)
       @discounts = Dodopayments::Resources::Discounts.new(client: self)
+      @addons = Dodopayments::Resources::Addons.new(client: self)
     end
   end
 end

data/lib/dodopayments/internal/default_page_number_pagination.rb

@@ -72,8 +72,8 @@ module Dodopayments
         super
 
         case page_data
-        in {items: Array | nil => items}
-          @items = items&.map { Dodopayments::Internal::Type::Converter.coerce(@model, _1) }
+        in {items: Array => items}
+          @items = items.map { Dodopayments::Internal::Type::Converter.coerce(@model, _1) }
         else
         end
       end

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

@@ -261,7 +261,7 @@ module Dodopayments
             headers["x-stainless-retry-count"] = "0"
           end
 
-          timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..))
+          timeout = opts.fetch(:timeout, @timeout).to_f.clamp(0..)
           unless headers.key?("x-stainless-timeout") || timeout.zero?
             headers["x-stainless-timeout"] = timeout.to_s
           end
@@ -461,9 +461,9 @@ module Dodopayments
 
           decoded = Dodopayments::Internal::Util.decode_content(response, stream: stream)
           case req
-          in { stream: Class => st }
+          in {stream: Class => st}
             st.new(model: model, url: url, status: status, response: response, stream: decoded)
-          in { page: Class => page }
+          in {page: Class => page}
             page.new(client: self, req: req, headers: response, page_data: decoded)
           else
             unwrapped = Dodopayments::Internal::Util.dig(decoded, req[:unwrap])

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

@@ -395,15 +395,7 @@ module Dodopayments
         # Create a new instance of a model.
         #
         # @param data [Hash{Symbol=>Object}, self]
-        def initialize(data = {})
-          case Dodopayments::Internal::Util.coerce_hash(data)
-          in Hash => coerced
-            @data = coerced
-          else
-            message = "Expected a #{Hash} or #{Dodopayments::Internal::Type::BaseModel}, got #{data.inspect}"
-            raise ArgumentError.new(message)
-          end
-        end
+        def initialize(data = {}) = (@data = Dodopayments::Internal::Util.coerce_hash!(data).to_h)
 
         class << self
           # @api private

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

@@ -28,14 +28,8 @@ module Dodopayments
             state = {can_retry: true}
             case (dumped = dump(params, state: state))
             in Hash
-              options = Dodopayments::Internal::Util.coerce_hash(dumped[:request_options])
-              request_options =
-                case [options, state.fetch(:can_retry)]
-                in [Hash | nil, false]
-                  {**options.to_h, max_retries: 0}
-                else
-                  options
-                end
+              options = Dodopayments::Internal::Util.coerce_hash!(dumped[:request_options]).to_h
+              request_options = state.fetch(:can_retry) ? options : {**options, max_retries: 0}
               [dumped.except(:request_options), request_options]
             else
               [dumped, nil]

data/lib/dodopayments/internal/util.rb

@@ -128,6 +128,22 @@ module Dodopayments
             input.respond_to?(:to_h) ? input.to_h : input
           end
         end
+
+        # @api private
+        #
+        # @param input [Object]
+        #
+        # @raise [ArgumentError]
+        # @return [Hash{Object=>Object}, nil]
+        def coerce_hash!(input)
+          case coerce_hash(input)
+          in Hash | nil => coerced
+            coerced
+          else
+            message = "Expected a #{Hash} or #{Dodopayments::Internal::Type::BaseModel}, got #{data.inspect}"
+            raise ArgumentError.new(message)
+          end
+        end
       end
 
       class << self
@@ -454,7 +470,7 @@ module Dodopayments
       # @type [Regexp]
       JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
       # @type [Regexp]
-      JSONL_CONTENT = %r{^application/(?:x-)?jsonl}
+      JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
         # @api private
@@ -493,7 +509,7 @@ module Dodopayments
             y << val.to_s
           else
             y << "Content-Type: application/json\r\n\r\n"
-            y << JSON.fast_generate(val)
+            y << JSON.generate(val)
           end
           y << "\r\n"
         end
@@ -570,9 +586,9 @@ module Dodopayments
           content_type = headers["content-type"]
           case [content_type, body]
           in [Dodopayments::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
-            [headers, JSON.fast_generate(body)]
+            [headers, JSON.generate(body)]
           in [Dodopayments::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(Dodopayments::Internal::Type::FileInput)
-            [headers, body.lazy.map { JSON.fast_generate(_1) }]
+            [headers, body.lazy.map { JSON.generate(_1) }]
           in [%r{^multipart/form-data}, Hash | Dodopayments::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}

data/lib/dodopayments/models/addon_cart_response_item.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class AddonCartResponseItem < Dodopayments::Internal::Type::BaseModel
+      # @!attribute addon_id
+      #
+      #   @return [String]
+      required :addon_id, String
+
+      # @!attribute quantity
+      #
+      #   @return [Integer]
+      required :quantity, Integer
+
+      # @!method initialize(addon_id:, quantity:)
+      #   Response struct representing subscription details
+      #
+      #   @param addon_id [String]
+      #   @param quantity [Integer]
+    end
+  end
+end

data/lib/dodopayments/models/addon_create_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Addons#create
+    class AddonCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency]
+      required :currency, enum: -> { Dodopayments::Models::Currency }
+
+      # @!attribute name
+      #   Name of the Addon
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute price
+      #   Amount of the addon
+      #
+      #   @return [Integer]
+      required :price, Integer
+
+      # @!attribute tax_category
+      #   Represents the different categories of taxation applicable to various products
+      #   and services.
+      #
+      #   @return [Symbol, Dodopayments::Models::TaxCategory]
+      required :tax_category, enum: -> { Dodopayments::Models::TaxCategory }
+
+      # @!attribute description
+      #   Optional description of the Addon
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(currency:, name:, price:, tax_category:, description: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::AddonCreateParams} for more details.
+      #
+      #   @param currency [Symbol, Dodopayments::Models::Currency]
+      #
+      #   @param name [String] Name of the Addon
+      #
+      #   @param price [Integer] Amount of the addon
+      #
+      #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
+      #   ...
+      #
+      #   @param description [String, nil] Optional description of the Addon
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/addon_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Addons#list
+    class AddonListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute page_number
+      #   Page number default is 0
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer, nil?: true
+
+      # @!attribute page_size
+      #   Page size default is 10 max is 100
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer, nil?: true
+
+      # @!method initialize(page_number: nil, page_size: nil, request_options: {})
+      #   @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
+end

data/lib/dodopayments/models/addon_response.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Addons#create
+    class AddonResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #   id of the Addon
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute business_id
+      #   Unique identifier for the business to which the addon belongs.
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   Created time
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency]
+      required :currency, enum: -> { Dodopayments::Models::Currency }
+
+      # @!attribute name
+      #   Name of the Addon
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute price
+      #   Amount of the addon
+      #
+      #   @return [Integer]
+      required :price, Integer
+
+      # @!attribute tax_category
+      #   Represents the different categories of taxation applicable to various products
+      #   and services.
+      #
+      #   @return [Symbol, Dodopayments::Models::TaxCategory]
+      required :tax_category, enum: -> { Dodopayments::Models::TaxCategory }
+
+      # @!attribute updated_at
+      #   Updated time
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #   Optional description of the Addon
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute image
+      #   Image of the Addon
+      #
+      #   @return [String, nil]
+      optional :image, String, nil?: true
+
+      # @!method initialize(id:, business_id:, created_at:, currency:, name:, price:, tax_category:, updated_at:, description: nil, image: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::AddonResponse} for more details.
+      #
+      #   @param id [String] id of the Addon
+      #
+      #   @param business_id [String] Unique identifier for the business to which the addon belongs.
+      #
+      #   @param created_at [Time] Created time
+      #
+      #   @param currency [Symbol, Dodopayments::Models::Currency]
+      #
+      #   @param name [String] Name of the Addon
+      #
+      #   @param price [Integer] Amount of the addon
+      #
+      #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory] Represents the different categories of taxation applicable to various products a
+      #   ...
+      #
+      #   @param updated_at [Time] Updated time
+      #
+      #   @param description [String, nil] Optional description of the Addon
+      #
+      #   @param image [String, nil] Image of the Addon
+    end
+  end
+end

data/lib/dodopayments/models/addon_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Addons#retrieve
+    class AddonRetrieveParams < 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/addon_update_images_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Addons#update_images
+    class AddonUpdateImagesParams < 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/addon_update_images_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Addons#update_images
+    class AddonUpdateImagesResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute image_id
+      #
+      #   @return [String]
+      required :image_id, String
+
+      # @!attribute url
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(image_id:, url:)
+      #   @param image_id [String]
+      #   @param url [String]
+    end
+  end
+end

data/lib/dodopayments/models/addon_update_params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Addons#update
+    class AddonUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute currency
+      #
+      #   @return [Symbol, Dodopayments::Models::Currency, nil]
+      optional :currency, enum: -> { Dodopayments::Models::Currency }, nil?: true
+
+      # @!attribute description
+      #   Description of the Addon, optional and must be at most 1000 characters.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute image_id
+      #   Addon image id after its uploaded to S3
+      #
+      #   @return [String, nil]
+      optional :image_id, String, nil?: true
+
+      # @!attribute name
+      #   Name of the Addon, optional and must be at most 100 characters.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute price
+      #   Amount of the addon
+      #
+      #   @return [Integer, nil]
+      optional :price, Integer, nil?: true
+
+      # @!attribute tax_category
+      #   Represents the different categories of taxation applicable to various products
+      #   and services.
+      #
+      #   @return [Symbol, Dodopayments::Models::TaxCategory, nil]
+      optional :tax_category, enum: -> { Dodopayments::Models::TaxCategory }, nil?: true
+
+      # @!method initialize(currency: nil, description: nil, image_id: nil, name: nil, price: nil, tax_category: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::AddonUpdateParams} for more details.
+      #
+      #   @param currency [Symbol, Dodopayments::Models::Currency, nil]
+      #
+      #   @param description [String, nil] Description of the Addon, optional and must be at most 1000 characters.
+      #
+      #   @param image_id [String, nil] Addon image id after its uploaded to S3
+      #
+      #   @param name [String, nil] Name of the Addon, optional and must be at most 100 characters.
+      #
+      #   @param price [Integer, nil] Amount of the addon
+      #
+      #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
+      #   ...
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end