dodopayments 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d1a48e653837160bb439d4e35d801a8de5fe88751cd32d8a9147663e7251381
-  data.tar.gz: 03f679fa0bdc29f57ae09a458b1c31ce1c175926bbe521d5042da2a8939a5cb3
+  metadata.gz: 9c7b22e5857506ae73a79e9a4f5c8cbd92f03696fcf72f9934b7f70d73b9be99
+  data.tar.gz: 3aba6366092a43c500db25321615514724aa4e0015ca108ec27eb478346acd06
 SHA512:
-  metadata.gz: 401099541db5886408eb47a0f75329cc9f740b0bbf0bb4dee999897a0c496f9b880b1d6d3231904d95e05f4b5e11c8f8252d23db34f26dd640731753c1617106
-  data.tar.gz: 0b5331df7152b042e06005799a64c3ad6d39f21d199885e671464d3f6039ede3f46fa0c5ae72e523e6405e634422bd4337d99aebf4f10a26f7e7f8b7d2526638
+  metadata.gz: 0bb40b6240681cf2f68f968c3da1b960e782aa9daebe21cc1738730290ebb6aea7100f4aa8ac9b642dd685059dc5c155955984bc2bc1d7fb5c6604cf5e425171
+  data.tar.gz: be7ead7c6dcef10ddcacb9c6c6b46b423ccab46231a8f4ac9794054a0214b5220c69e0829837504be20a20f4214d846a5b0ba2f5c0fbb9ba7ead43e661669e0c

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # 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)

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.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/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/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

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

data/lib/dodopayments/models/currency.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Currency
+      extend Dodopayments::Internal::Type::Enum
+
+      AED = :AED
+      ALL = :ALL
+      AMD = :AMD
+      ANG = :ANG
+      AOA = :AOA
+      ARS = :ARS
+      AUD = :AUD
+      AWG = :AWG
+      AZN = :AZN
+      BAM = :BAM
+      BBD = :BBD
+      BDT = :BDT
+      BGN = :BGN
+      BHD = :BHD
+      BIF = :BIF
+      BMD = :BMD
+      BND = :BND
+      BOB = :BOB
+      BRL = :BRL
+      BSD = :BSD
+      BWP = :BWP
+      BYN = :BYN
+      BZD = :BZD
+      CAD = :CAD
+      CHF = :CHF
+      CLP = :CLP
+      CNY = :CNY
+      COP = :COP
+      CRC = :CRC
+      CUP = :CUP
+      CVE = :CVE
+      CZK = :CZK
+      DJF = :DJF
+      DKK = :DKK
+      DOP = :DOP
+      DZD = :DZD
+      EGP = :EGP
+      ETB = :ETB
+      EUR = :EUR
+      FJD = :FJD
+      FKP = :FKP
+      GBP = :GBP
+      GEL = :GEL
+      GHS = :GHS
+      GIP = :GIP
+      GMD = :GMD
+      GNF = :GNF
+      GTQ = :GTQ
+      GYD = :GYD
+      HKD = :HKD
+      HNL = :HNL
+      HRK = :HRK
+      HTG = :HTG
+      HUF = :HUF
+      IDR = :IDR
+      ILS = :ILS
+      INR = :INR
+      IQD = :IQD
+      JMD = :JMD
+      JOD = :JOD
+      JPY = :JPY
+      KES = :KES
+      KGS = :KGS
+      KHR = :KHR
+      KMF = :KMF
+      KRW = :KRW
+      KWD = :KWD
+      KYD = :KYD
+      KZT = :KZT
+      LAK = :LAK
+      LBP = :LBP
+      LKR = :LKR
+      LRD = :LRD
+      LSL = :LSL
+      LYD = :LYD
+      MAD = :MAD
+      MDL = :MDL
+      MGA = :MGA
+      MKD = :MKD
+      MMK = :MMK
+      MNT = :MNT
+      MOP = :MOP
+      MRU = :MRU
+      MUR = :MUR
+      MVR = :MVR
+      MWK = :MWK
+      MXN = :MXN
+      MYR = :MYR
+      MZN = :MZN
+      NAD = :NAD
+      NGN = :NGN
+      NIO = :NIO
+      NOK = :NOK
+      NPR = :NPR
+      NZD = :NZD
+      OMR = :OMR
+      PAB = :PAB
+      PEN = :PEN
+      PGK = :PGK
+      PHP = :PHP
+      PKR = :PKR
+      PLN = :PLN
+      PYG = :PYG
+      QAR = :QAR
+      RON = :RON
+      RSD = :RSD
+      RUB = :RUB
+      RWF = :RWF
+      SAR = :SAR
+      SBD = :SBD
+      SCR = :SCR
+      SEK = :SEK
+      SGD = :SGD
+      SHP = :SHP
+      SLE = :SLE
+      SLL = :SLL
+      SOS = :SOS
+      SRD = :SRD
+      SSP = :SSP
+      STN = :STN
+      SVC = :SVC
+      SZL = :SZL
+      THB = :THB
+      TND = :TND
+      TOP = :TOP
+      TRY = :TRY
+      TTD = :TTD
+      TWD = :TWD
+      TZS = :TZS
+      UAH = :UAH
+      UGX = :UGX
+      USD = :USD
+      UYU = :UYU
+      UZS = :UZS
+      VES = :VES
+      VND = :VND
+      VUV = :VUV
+      WST = :WST
+      XAF = :XAF
+      XCD = :XCD
+      XOF = :XOF
+      XPF = :XPF
+      YER = :YER
+      ZAR = :ZAR
+      ZMW = :ZMW
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end