dodopayments 1.20.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c7b22e5857506ae73a79e9a4f5c8cbd92f03696fcf72f9934b7f70d73b9be99
-  data.tar.gz: 3aba6366092a43c500db25321615514724aa4e0015ca108ec27eb478346acd06
+  metadata.gz: f0db8ac6abab224124982361204de2655bd917a370eba199ce6c6ee668296f06
+  data.tar.gz: 268aa11f3fb3430ac18eb2c483ca6fc1d49d1df9801aa6f706b9233f330840f0
 SHA512:
-  metadata.gz: 0bb40b6240681cf2f68f968c3da1b960e782aa9daebe21cc1738730290ebb6aea7100f4aa8ac9b642dd685059dc5c155955984bc2bc1d7fb5c6604cf5e425171
-  data.tar.gz: be7ead7c6dcef10ddcacb9c6c6b46b423ccab46231a8f4ac9794054a0214b5220c69e0829837504be20a20f4214d846a5b0ba2f5c0fbb9ba7ead43e661669e0c
+  metadata.gz: 38271ef5ae9db50f038f12341d8ab2153eb7683a96f8e0b1ace1a229287099acdaf9a2e0aa0cc9cf4d3cb5a9ceb76c792b6683ccdb9ea02e09a54bcef431831d
+  data.tar.gz: fa6f3f577a1a045311e8525fc720148981c4f0db35f7b1899c1e40467c47fff43c36d2531c1a3b5f6a949148d50cc9606586b9da656a6a98a5deee13968a49ef

data/CHANGELOG.md

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

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.20.0"
+gem "dodopayments", "~> 1.22.0"
 ```
 
 <!-- x-release-please-end -->
@@ -29,7 +29,7 @@ require "bundler/setup"
 require "dodopayments"
 
 dodo_payments = Dodopayments::Client.new(
-  api_key: "My API Key", # 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"
 )
 

data/lib/dodopayments/client.rb

@@ -20,8 +20,9 @@ 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 :api_key
+    attr_reader :bearer_token
 
     # @return [Dodopayments::Resources::Payments]
     attr_reader :payments
@@ -72,14 +73,14 @@ module Dodopayments
     #
     # @return [Hash{String=>String}]
     private def auth_headers
-      return {} if @api_key.nil?
+      return {} if @bearer_token.nil?
 
-      {"authorization" => "Bearer #{@api_key}"}
+      {"authorization" => "Bearer #{@bearer_token}"}
     end
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param api_key [String, nil] Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
+    # @param bearer_token [String, nil] Bearer Token for API authentication Defaults to `ENV["DODO_PAYMENTS_API_KEY"]`
     #
     # @param environment [:live_mode, :test_mode, nil] Specifies the environment to use for the API.
     #
@@ -99,7 +100,7 @@ module Dodopayments
     #
     # @param max_retry_delay [Float]
     def initialize(
-      api_key: ENV["DODO_PAYMENTS_API_KEY"],
+      bearer_token: ENV["DODO_PAYMENTS_API_KEY"],
       environment: nil,
       base_url: ENV["DODO_PAYMENTS_BASE_URL"],
       max_retries: Dodopayments::Client::DEFAULT_MAX_RETRIES,
@@ -112,11 +113,11 @@ module Dodopayments
         raise ArgumentError.new(message)
       end
 
-      if api_key.nil?
-        raise ArgumentError.new("api_key is required, and can be set via environ: \"DODO_PAYMENTS_API_KEY\"")
+      if bearer_token.nil?
+        raise ArgumentError.new("bearer_token is required, and can be set via environ: \"DODO_PAYMENTS_API_KEY\"")
       end
 
-      @api_key = api_key.to_s
+      @bearer_token = bearer_token.to_s
 
       super(
         base_url: base_url,

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

@@ -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

data/lib/dodopayments/models/dispute.rb

@@ -2,7 +2,6 @@
 
 module Dodopayments
   module Models
-    # @see Dodopayments::Resources::Disputes#retrieve
     class Dispute < Dodopayments::Internal::Type::BaseModel
       # @!attribute amount
       #   The amount involved in the dispute, represented as a string to accommodate
@@ -51,7 +50,13 @@ module Dodopayments
       #   @return [String]
       required :payment_id, String
 
-      # @!method initialize(amount:, business_id:, created_at:, currency:, dispute_id:, dispute_stage:, dispute_status:, payment_id:)
+      # @!attribute remarks
+      #   Remarks
+      #
+      #   @return [String, nil]
+      optional :remarks, String, nil?: true
+
+      # @!method initialize(amount:, business_id:, created_at:, currency:, dispute_id:, dispute_stage:, dispute_status:, payment_id:, remarks: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Dispute} for more details.
       #
@@ -71,6 +76,8 @@ module Dodopayments
       #   @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus]
       #
       #   @param payment_id [String] The unique identifier of the payment associated with the dispute.
+      #
+      #   @param remarks [String, nil] Remarks
     end
   end
 end

data/lib/dodopayments/models/dispute_list_response.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Disputes#list
+    class DisputeListResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The amount involved in the dispute, represented as a string to accommodate
+      #   precision.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute business_id
+      #   The unique identifier of the business involved in the dispute.
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   The timestamp of when the dispute was created, in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The currency of the disputed amount, represented as an ISO 4217 currency code.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute dispute_id
+      #   The unique identifier of the dispute.
+      #
+      #   @return [String]
+      required :dispute_id, String
+
+      # @!attribute dispute_stage
+      #
+      #   @return [Symbol, Dodopayments::Models::DisputeStage]
+      required :dispute_stage, enum: -> { Dodopayments::Models::DisputeStage }
+
+      # @!attribute dispute_status
+      #
+      #   @return [Symbol, Dodopayments::Models::DisputeStatus]
+      required :dispute_status, enum: -> { Dodopayments::Models::DisputeStatus }
+
+      # @!attribute payment_id
+      #   The unique identifier of the payment associated with the dispute.
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!method initialize(amount:, business_id:, created_at:, currency:, dispute_id:, dispute_stage:, dispute_status:, payment_id:)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::DisputeListResponse} 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] The unique identifier of the payment associated with the dispute.
+    end
+  end
+end

data/lib/dodopayments/models/dispute_retrieve_response.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Disputes#retrieve
+    class DisputeRetrieveResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The amount involved in the dispute, represented as a string to accommodate
+      #   precision.
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute business_id
+      #   The unique identifier of the business involved in the dispute.
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #   The timestamp of when the dispute was created, in UTC.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The currency of the disputed amount, represented as an ISO 4217 currency code.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute customer
+      #
+      #   @return [Dodopayments::Models::CustomerLimitedDetails]
+      required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
+
+      # @!attribute dispute_id
+      #   The unique identifier of the dispute.
+      #
+      #   @return [String]
+      required :dispute_id, String
+
+      # @!attribute dispute_stage
+      #
+      #   @return [Symbol, Dodopayments::Models::DisputeStage]
+      required :dispute_stage, enum: -> { Dodopayments::Models::DisputeStage }
+
+      # @!attribute dispute_status
+      #
+      #   @return [Symbol, Dodopayments::Models::DisputeStatus]
+      required :dispute_status, enum: -> { Dodopayments::Models::DisputeStatus }
+
+      # @!attribute payment_id
+      #   The unique identifier of the payment associated with the dispute.
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute reason
+      #   Reason for the dispute
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute remarks
+      #   Remarks
+      #
+      #   @return [String, nil]
+      optional :remarks, String, nil?: true
+
+      # @!method initialize(amount:, business_id:, created_at:, currency:, customer:, dispute_id:, dispute_stage:, dispute_status:, payment_id:, reason: nil, remarks: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::DisputeRetrieveResponse} 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 customer [Dodopayments::Models::CustomerLimitedDetails]
+      #
+      #   @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] The unique identifier of the payment associated with the dispute.
+      #
+      #   @param reason [String, nil] Reason for the dispute
+      #
+      #   @param remarks [String, nil] Remarks
+    end
+  end
+end

data/lib/dodopayments/models/payment.rb

@@ -74,6 +74,30 @@ module Dodopayments
       #   @return [Integer]
       required :total_amount, Integer
 
+      # @!attribute card_issuing_country
+      #   ISO country code alpha2 variant
+      #
+      #   @return [Symbol, Dodopayments::Models::CountryCode, nil]
+      optional :card_issuing_country, enum: -> { Dodopayments::Models::CountryCode }, nil?: true
+
+      # @!attribute card_last_four
+      #   The last four digits of the card
+      #
+      #   @return [String, nil]
+      optional :card_last_four, String, nil?: true
+
+      # @!attribute card_network
+      #   Card network like VISA, MASTERCARD etc.
+      #
+      #   @return [String, nil]
+      optional :card_network, String, nil?: true
+
+      # @!attribute card_type
+      #   The type of card DEBIT or CREDIT
+      #
+      #   @return [String, nil]
+      optional :card_type, String, nil?: true
+
       # @!attribute discount_id
       #   The discount id if discount is applied
       #
@@ -143,7 +167,7 @@ module Dodopayments
       #   @return [Time, nil]
       optional :updated_at, Time, nil?: true
 
-      # @!method initialize(billing:, business_id:, created_at:, currency:, customer:, disputes:, metadata:, payment_id:, refunds:, settlement_amount:, settlement_currency:, total_amount:, discount_id: nil, error_message: nil, payment_link: nil, payment_method: nil, payment_method_type: nil, product_cart: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
+      # @!method initialize(billing:, business_id:, created_at:, currency:, customer:, disputes:, metadata:, payment_id:, refunds:, settlement_amount:, settlement_currency:, total_amount:, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, discount_id: nil, error_message: nil, payment_link: nil, payment_method: nil, payment_method_type: nil, product_cart: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Payment} for more details.
       #
@@ -173,6 +197,14 @@ module Dodopayments
       #   @param total_amount [Integer] Total amount charged to the customer including tax, in smallest currency unit (e
       #   ...
       #
+      #   @param card_issuing_country [Symbol, Dodopayments::Models::CountryCode, nil] ISO country code alpha2 variant
+      #
+      #   @param card_last_four [String, nil] The last four digits of the card
+      #
+      #   @param card_network [String, nil] Card network like VISA, MASTERCARD etc.
+      #
+      #   @param card_type [String, nil] The type of card DEBIT or CREDIT
+      #
       #   @param discount_id [String, nil] The discount id if discount is applied
       #
       #   @param error_message [String, nil] An error message if the payment failed

data/lib/dodopayments/models/subscription_change_plan_params.rb

@@ -25,13 +25,27 @@ module Dodopayments
       #   @return [Integer]
       required :quantity, Integer
 
-      # @!method initialize(product_id:, proration_billing_mode:, quantity:, request_options: {})
+      # @!attribute addons
+      #   Addons for the new plan. Note : Leaving this empty would remove any existing
+      #   addons
+      #
+      #   @return [Array<Dodopayments::Models::SubscriptionChangePlanParams::Addon>, nil]
+      optional :addons,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::SubscriptionChangePlanParams::Addon] },
+               nil?: true
+
+      # @!method initialize(product_id:, proration_billing_mode:, quantity:, addons: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::SubscriptionChangePlanParams} for more details.
+      #
       #   @param product_id [String] Unique identifier of the product to subscribe to
       #
       #   @param proration_billing_mode [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode]
       #
       #   @param quantity [Integer] Number of units to subscribe for. Must be at least 1.
       #
+      #   @param addons [Array<Dodopayments::Models::SubscriptionChangePlanParams::Addon>, nil] Addons for the new plan. ...
+      #
       #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
 
       module ProrationBillingMode
@@ -42,6 +56,22 @@ module Dodopayments
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class Addon < 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:)
+        #   @param addon_id [String]
+        #   @param quantity [Integer]
+      end
     end
   end
 end