dodopayments 1.18.3 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abe1b45633addd932eb1274291d91d2b7acf5b589bb4bf5a668019caa6679830
-  data.tar.gz: 45b91de05dcc52f26c61054f735f150df9093d891beb961a2b59cca1b65fc9f7
+  metadata.gz: 9c7b22e5857506ae73a79e9a4f5c8cbd92f03696fcf72f9934b7f70d73b9be99
+  data.tar.gz: 3aba6366092a43c500db25321615514724aa4e0015ca108ec27eb478346acd06
 SHA512:
-  metadata.gz: bf852de0565c8053f6b76e6edf34adb739d8cbdf288d7a96843fe3bfa2b5ab4526607e9981f614272051250e8243697bd2427b6769a3e9fa472e112997677b6e
-  data.tar.gz: 8b3b1f0dec7a7b334944d84c74f838b3e2ba9ac12744c7bcae57737fe7660ca441e5f43222b9931d0b15077c6d992accbde06650fbe87a855da90b2460e26c13
+  metadata.gz: 0bb40b6240681cf2f68f968c3da1b960e782aa9daebe21cc1738730290ebb6aea7100f4aa8ac9b642dd685059dc5c155955984bc2bc1d7fb5c6604cf5e425171
+  data.tar.gz: be7ead7c6dcef10ddcacb9c6c6b46b423ccab46231a8f4ac9794054a0214b5220c69e0829837504be20a20f4214d846a5b0ba2f5c0fbb9ba7ead43e661669e0c

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## 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)
+
+### Bug Fixes
+
+* ensure gem release is unaffected by renaming ([d134bf2](https://github.com/dodopayments/dodopayments-ruby/commit/d134bf2816ddc6c6de271b01dfe00251ec0ad429))
+* make a typo for `FilePart.content` ([e1b34c1](https://github.com/dodopayments/dodopayments-ruby/commit/e1b34c1896c629aad7f696511b4fa31e23c240ad))
+
+
+### Chores
+
+* add generator safe directory ([176120f](https://github.com/dodopayments/dodopayments-ruby/commit/176120f332f361f8c7b111925de0a6b9d95b472d))
+* **internal:** annotate request options with type aliases in sorbet ([4e29dc1](https://github.com/dodopayments/dodopayments-ruby/commit/4e29dc1213b30f2fe1b8aae34e9e86206b7d087a))
+* **internal:** mostly README touch ups ([d4fd618](https://github.com/dodopayments/dodopayments-ruby/commit/d4fd618c958e24432f76778b74c6c47e32c48d28))
+* **internal:** remove unnecessary `rbi/lib` folder ([0745897](https://github.com/dodopayments/dodopayments-ruby/commit/07458978bf5b06c8c1bafdce5ee3287091cad34b))
+* loosen rubocop rules that don't always make sense ([129618a](https://github.com/dodopayments/dodopayments-ruby/commit/129618aafdd550efaa6b8788b431b1739aa509e1))
+* more accurate type annotations and aliases ([433979e](https://github.com/dodopayments/dodopayments-ruby/commit/433979e298c9967438df5e92674b314f075ad4ea))
+
 ## 1.18.3 (2025-04-25)
 
 Full Changelog: [v1.18.1...v1.18.3](https://github.com/dodopayments/dodopayments-ruby/compare/v1.18.1...v1.18.3)

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.18.3"
+gem "dodopayments", "~> 1.20.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"]
+  api_key: "My API Key", # defaults to ENV["DODO_PAYMENTS_API_KEY"]
   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

@@ -20,9 +20,8 @@ module Dodopayments
     ENVIRONMENTS = {live_mode: "https://live.dodopayments.com", test_mode: "https://test.dodopayments.com"}
     # rubocop:enable Style/MutableConstant
 
-    # Bearer Token for API authentication
     # @return [String]
-    attr_reader :bearer_token
+    attr_reader :api_key
 
     # @return [Dodopayments::Resources::Payments]
     attr_reader :payments
@@ -66,18 +65,21 @@ module Dodopayments
     # @return [Dodopayments::Resources::Discounts]
     attr_reader :discounts
 
+    # @return [Dodopayments::Resources::Addons]
+    attr_reader :addons
+
     # @api private
     #
     # @return [Hash{String=>String}]
     private def auth_headers
-      return {} if @bearer_token.nil?
+      return {} if @api_key.nil?
 
-      {"authorization" => "Bearer #{@bearer_token}"}
+      {"authorization" => "Bearer #{@api_key}"}
     end
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param bearer_token [String, nil] Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
+    # @param api_key [String, nil] Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
     #
     # @param environment [:live_mode, :test_mode, nil] Specifies the environment to use for the API.
     #
@@ -97,7 +99,7 @@ module Dodopayments
     #
     # @param max_retry_delay [Float]
     def initialize(
-      bearer_token: ENV["DODO_PAYMENTS_API_KEY"],
+      api_key: ENV["DODO_PAYMENTS_API_KEY"],
       environment: nil,
       base_url: ENV["DODO_PAYMENTS_BASE_URL"],
       max_retries: Dodopayments::Client::DEFAULT_MAX_RETRIES,
@@ -110,11 +112,11 @@ module Dodopayments
         raise ArgumentError.new(message)
       end
 
-      if bearer_token.nil?
-        raise ArgumentError.new("bearer_token is required, and can be set via environ: \"DODO_PAYMENTS_API_KEY\"")
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"DODO_PAYMENTS_API_KEY\"")
       end
 
-      @bearer_token = bearer_token.to_s
+      @api_key = api_key.to_s
 
       super(
         base_url: base_url,
@@ -138,6 +140,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/errors.rb

@@ -3,9 +3,9 @@
 module Dodopayments
   module Errors
     class Error < StandardError
-      # @!parse
-      #   # @return [StandardError, nil]
-      #   attr_accessor :cause
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
     end
 
     class ConversionError < Dodopayments::Errors::Error
@@ -40,13 +40,13 @@ module Dodopayments
     end
 
     class APIConnectionError < Dodopayments::Errors::APIError
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :status
+      # @!attribute status
+      #
+      #   @return [nil]
 
-      # @!parse
-      #   # @return [nil]
-      #   attr_accessor :body
+      # @!attribute body
+      #
+      #   @return [nil]
 
       # @api private
       #

data/lib/dodopayments/file_part.rb

@@ -15,15 +15,15 @@ module Dodopayments
     #
     # @return [String]
     private def read
-      case contents
+      case content
       in Pathname
-        contents.read(binmode: true)
+        content.read(binmode: true)
       in StringIO
-        contents.string
+        content.string
       in IO
-        contents.read
+        content.read
       in String
-        contents
+        content
       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

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

@@ -46,17 +46,16 @@ module Dodopayments
             value
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Boolean, Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Boolean, Object]
-          #   def dump(value, state:) = super
+          # @!method dump(value, state:)
+          #   @api private
+          #
+          #   @param value [Boolean, Object]
+          #
+          #   @param state [Hash{Symbol=>Object}] .
+          #
+          #     @option state [Boolean] :can_retry
+          #
+          #   @return [Boolean, Object]
         end
       end
     end

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

@@ -44,6 +44,9 @@ module Dodopayments
           in Pathname | IO
             state[:can_retry] = false if value.is_a?(IO)
             Dodopayments::FilePart.new(value)
+          in Dodopayments::FilePart
+            state[:can_retry] = false if value.content.is_a?(IO)
+            value
           else
             value
           end

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

@@ -100,17 +100,16 @@ module Dodopayments
           end
         end
 
-        # @!parse
-        #   # @api private
-        #   #
-        #   # @param value [Symbol, Object]
-        #   #
-        #   # @param state [Hash{Symbol=>Object}] .
-        #   #
-        #   #   @option state [Boolean] :can_retry
-        #   #
-        #   # @return [Symbol, Object]
-        #   def dump(value, state:) = super
+        # @!method dump(value, state:)
+        #   @api private
+        #
+        #   @param value [Symbol, Object]
+        #
+        #   @param state [Hash{Symbol=>Object}] .
+        #
+        #     @option state [Boolean] :can_retry
+        #
+        #   @return [Symbol, Object]
 
         # @api private
         #

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

@@ -67,17 +67,28 @@ module Dodopayments
             end
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Pathname, StringIO, IO, String, Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Pathname, StringIO, IO, String, Object]
-          #   def dump(value, state:) = super
+          # @api private
+          #
+          # @param value [Pathname, StringIO, IO, String, Object]
+          #
+          # @param state [Hash{Symbol=>Object}] .
+          #
+          #   @option state [Boolean] :can_retry
+          #
+          # @return [Pathname, StringIO, IO, String, Object]
+          def dump(value, state:)
+            # rubocop:disable Lint/DuplicateBranch
+            case value
+            in IO
+              state[:can_retry] = false
+            in Dodopayments::FilePart if value.content.is_a?(IO)
+              state[:can_retry] = false
+            else
+            end
+            # rubocop:enable Lint/DuplicateBranch
+
+            value
+          end
         end
       end
     end

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

@@ -48,17 +48,16 @@ module Dodopayments
             value
           end
 
-          # @!parse
-          #   # @api private
-          #   #
-          #   # @param value [Object]
-          #   #
-          #   # @param state [Hash{Symbol=>Object}] .
-          #   #
-          #   #   @option state [Boolean] :can_retry
-          #   #
-          #   # @return [Object]
-          #   def dump(value, state:) = super
+          # @!method dump(value, state:)
+          #   @api private
+          #
+          #   @param value [Object]
+          #
+          #   @param state [Hash{Symbol=>Object}] .
+          #
+          #     @option state [Boolean] :can_retry
+          #
+          #   @return [Object]
         end
 
         # rubocop:enable Lint/UnusedMethodArgument

data/lib/dodopayments/internal/util.rb

@@ -493,7 +493,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 +570,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