dodopayments 1.51.1 → 1.52.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cbce1c0ca3b761c9e450ba66825a02cf7fbb35b79bd4c323cbac96d5da985a9
-  data.tar.gz: 94604e87949996377def5887c12113b2c056e220bac1cb13300d6221f1fda892
+  metadata.gz: 90035c1d14b5aa55b3c8e33db01257b8f45bb2636259d2aca65d08f77a8303b2
+  data.tar.gz: 17bb0b417c9f606ee48df9a06bec7ecf9b8d7b1985146d6c03190509aeddc775
 SHA512:
-  metadata.gz: f3b0b10375a6eafce47adc1de263f24a25108c6d0e849c5d24b43aaee0f50c51f165387bbf4b12c725c45ff881808fcdc2dba6f426afa8ea137c1237e637b63a
-  data.tar.gz: 4c6b437f5d8f133e5deaf2a3c7dc7384119a01f6ddadb7f17ca8f61d904b9982753547e1938b581e4e4a736c65a65aed36144d8ea8f1e3d807e71bc3a81b46bf
+  metadata.gz: 193a65895d8e20cf1f818a6ea8f725a00a0bffefeaaf46def43ec2f1c64fb4662e1c845cda63e72fa4f4df6e4ecbd485fe4153ddc4c7ea6d4333380002300b6a
+  data.tar.gz: 6a50f094b283c7d173271bba624b2cd95346f9519dc9f051d404e90852def09a57011afdb47f7765057cb915cf3197f8651e5109ea9cac8f09a85ab45791b4c6

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 1.52.5 (2025-09-04)
+
+Full Changelog: [v1.52.4...v1.52.5](https://github.com/dodopayments/dodopayments-ruby/compare/v1.52.4...v1.52.5)
+
+### Features
+
+* **api:** updated openapi spec to v1.52.4 ([49331b8](https://github.com/dodopayments/dodopayments-ruby/commit/49331b8c97f7995f20e6428fb6d0e2f8f567273e))
+
+## 1.52.4 (2025-09-03)
+
+Full Changelog: [v1.51.1...v1.52.4](https://github.com/dodopayments/dodopayments-ruby/compare/v1.51.1...v1.52.4)
+
+### Features
+
+* **api:** manual updates ([0dd3323](https://github.com/dodopayments/dodopayments-ruby/commit/0dd3323b773634410a377238bf3d3d7fadac0d12))
+* **api:** updated openapi spec ([c338d93](https://github.com/dodopayments/dodopayments-ruby/commit/c338d93bcded89768cc1b92410496b7acf6db609))
+* updated openapi spec and added model and API functions for Usage Based Billing ([54d898a](https://github.com/dodopayments/dodopayments-ruby/commit/54d898a1cd82cb37a2877dfb2838f6f9e5209943))
+
 ## 1.51.1 (2025-08-25)
 
 Full Changelog: [v1.51.0...v1.51.1](https://github.com/dodopayments/dodopayments-ruby/compare/v1.51.0...v1.51.1)

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.51.1"
+gem "dodopayments", "~> 1.52.5"
 ```
 
 <!-- x-release-please-end -->

data/lib/dodopayments/client.rb

@@ -78,6 +78,12 @@ module Dodopayments
     # @return [Dodopayments::Resources::Webhooks]
     attr_reader :webhooks
 
+    # @return [Dodopayments::Resources::UsageEvents]
+    attr_reader :usage_events
+
+    # @return [Dodopayments::Resources::Meters]
+    attr_reader :meters
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -154,6 +160,8 @@ module Dodopayments
       @addons = Dodopayments::Resources::Addons.new(client: self)
       @brands = Dodopayments::Resources::Brands.new(client: self)
       @webhooks = Dodopayments::Resources::Webhooks.new(client: self)
+      @usage_events = Dodopayments::Resources::UsageEvents.new(client: self)
+      @meters = Dodopayments::Resources::Meters.new(client: self)
     end
   end
 end

data/lib/dodopayments/models/add_meter_to_price.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class AddMeterToPrice < Dodopayments::Internal::Type::BaseModel
+      # @!attribute meter_id
+      #
+      #   @return [String]
+      required :meter_id, String
+
+      # @!attribute price_per_unit
+      #   The price per unit in lowest denomination. Must be greater than zero. Supports
+      #   up to 5 digits before decimal point and 12 decimal places.
+      #
+      #   @return [String]
+      required :price_per_unit, String
+
+      # @!attribute description
+      #   Meter description. Will ignored on Request, but will be shown in response
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute free_threshold
+      #
+      #   @return [Integer, nil]
+      optional :free_threshold, Integer, nil?: true
+
+      # @!attribute measurement_unit
+      #   Meter measurement unit. Will ignored on Request, but will be shown in response
+      #
+      #   @return [String, nil]
+      optional :measurement_unit, String, nil?: true
+
+      # @!attribute name
+      #   Meter name. Will ignored on Request, but will be shown in response
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(meter_id:, price_per_unit:, description: nil, free_threshold: nil, measurement_unit: nil, name: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::AddMeterToPrice} for more details.
+      #
+      #   @param meter_id [String]
+      #
+      #   @param price_per_unit [String] The price per unit in lowest denomination. Must be greater than zero. Supports u
+      #
+      #   @param description [String, nil] Meter description. Will ignored on Request, but will be shown in response
+      #
+      #   @param free_threshold [Integer, nil]
+      #
+      #   @param measurement_unit [String, nil] Meter measurement unit. Will ignored on Request, but will be shown in response
+      #
+      #   @param name [String, nil] Meter name. Will ignored on Request, but will be shown in response
+    end
+  end
+end

data/lib/dodopayments/models/event.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::UsageEvents#retrieve
+    class Event < Dodopayments::Internal::Type::BaseModel
+      # @!attribute business_id
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute customer_id
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!attribute event_id
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_name
+      #
+      #   @return [String]
+      required :event_name, String
+
+      # @!attribute timestamp
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute metadata
+      #   Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
+      #
+      #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+      optional :metadata,
+               -> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::Event::Metadata] },
+               nil?: true
+
+      # @!method initialize(business_id:, customer_id:, event_id:, event_name:, timestamp:, metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::Event} for more details.
+      #
+      #   @param business_id [String]
+      #
+      #   @param customer_id [String]
+      #
+      #   @param event_id [String]
+      #
+      #   @param event_name [String]
+      #
+      #   @param timestamp [Time]
+      #
+      #   @param metadata [Hash{Symbol=>String, Float, Boolean}, nil] Arbitrary key-value metadata. Values can be string, integer, number, or boolean.
+
+      # Metadata value can be a string, integer, number, or boolean
+      module Metadata
+        extend Dodopayments::Internal::Type::Union
+
+        variant String
+
+        variant Float
+
+        variant Dodopayments::Internal::Type::Boolean
+
+        # @!method self.variants
+        #   @return [Array(String, Float, Boolean)]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/event_input.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class EventInput < Dodopayments::Internal::Type::BaseModel
+      # @!attribute customer_id
+      #   customer_id of the customer whose usage needs to be tracked
+      #
+      #   @return [String]
+      required :customer_id, String
+
+      # @!attribute event_id
+      #   Event Id acts as an idempotency key. Any subsequent requests with the same
+      #   event_id will be ignored
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_name
+      #   Name of the event
+      #
+      #   @return [String]
+      required :event_name, String
+
+      # @!attribute metadata
+      #   Custom metadata. Only key value pairs are accepted, objects or arrays submitted
+      #   will be rejected.
+      #
+      #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+      optional :metadata,
+               -> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::EventInput::Metadata] },
+               nil?: true
+
+      # @!attribute timestamp
+      #   Custom Timestamp. Defaults to current timestamp in UTC. Timestamps that are
+      #   older that 1 hour or after 5 mins, from current timestamp, will be rejected.
+      #
+      #   @return [Time, nil]
+      optional :timestamp, Time, nil?: true
+
+      # @!method initialize(customer_id:, event_id:, event_name:, metadata: nil, timestamp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::EventInput} for more details.
+      #
+      #   @param customer_id [String] customer_id of the customer whose usage needs to be tracked
+      #
+      #   @param event_id [String] Event Id acts as an idempotency key. Any subsequent requests with the same event
+      #
+      #   @param event_name [String] Name of the event
+      #
+      #   @param metadata [Hash{Symbol=>String, Float, Boolean}, nil] Custom metadata. Only key value pairs are accepted, objects or arrays submitted
+      #
+      #   @param timestamp [Time, nil] Custom Timestamp. Defaults to current timestamp in UTC.
+
+      # Metadata value can be a string, integer, number, or boolean
+      module Metadata
+        extend Dodopayments::Internal::Type::Union
+
+        variant String
+
+        variant Float
+
+        variant Dodopayments::Internal::Type::Boolean
+
+        # @!method self.variants
+        #   @return [Array(String, Float, Boolean)]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/invoices/payment_retrieve_refund_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module Invoices
+      # @see Dodopayments::Resources::Invoices::Payments#retrieve_refund
+      class PaymentRetrieveRefundParams < 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
+end

data/lib/dodopayments/models/meter.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Meters#create
+    class Meter < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute aggregation
+      #
+      #   @return [Dodopayments::Models::MeterAggregation]
+      required :aggregation, -> { Dodopayments::MeterAggregation }
+
+      # @!attribute business_id
+      #
+      #   @return [String]
+      required :business_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute event_name
+      #
+      #   @return [String]
+      required :event_name, String
+
+      # @!attribute measurement_unit
+      #
+      #   @return [String]
+      required :measurement_unit, String
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute filter
+      #   A filter structure that combines multiple conditions with logical conjunctions
+      #   (AND/OR).
+      #
+      #   Supports up to 3 levels of nesting to create complex filter expressions. Each
+      #   filter has a conjunction (and/or) and clauses that can be either direct
+      #   conditions or nested filters.
+      #
+      #   @return [Dodopayments::Models::MeterFilter, nil]
+      optional :filter, -> { Dodopayments::MeterFilter }, nil?: true
+
+      # @!method initialize(id:, aggregation:, business_id:, created_at:, event_name:, measurement_unit:, name:, updated_at:, description: nil, filter: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::Meter} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param aggregation [Dodopayments::Models::MeterAggregation]
+      #
+      #   @param business_id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param event_name [String]
+      #
+      #   @param measurement_unit [String]
+      #
+      #   @param name [String]
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param description [String, nil]
+      #
+      #   @param filter [Dodopayments::Models::MeterFilter, nil] A filter structure that combines multiple conditions with logical conjunctions (
+    end
+  end
+end

data/lib/dodopayments/models/meter_aggregation.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class MeterAggregation < Dodopayments::Internal::Type::BaseModel
+      # @!attribute type
+      #   Aggregation type for the meter
+      #
+      #   @return [Symbol, Dodopayments::Models::MeterAggregation::Type]
+      required :type, enum: -> { Dodopayments::MeterAggregation::Type }
+
+      # @!attribute key
+      #   Required when type is not COUNT
+      #
+      #   @return [String, nil]
+      optional :key, String, nil?: true
+
+      # @!method initialize(type:, key: nil)
+      #   @param type [Symbol, Dodopayments::Models::MeterAggregation::Type] Aggregation type for the meter
+      #
+      #   @param key [String, nil] Required when type is not COUNT
+
+      # Aggregation type for the meter
+      #
+      # @see Dodopayments::Models::MeterAggregation#type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        COUNT = :count
+        SUM = :sum
+        MAX = :max
+        LAST = :last
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/meter_archive_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Meters#archive
+    class MeterArchiveParams < 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/meter_create_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::Meters#create
+    class MeterCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute aggregation
+      #   Aggregation configuration for the meter
+      #
+      #   @return [Dodopayments::Models::MeterAggregation]
+      required :aggregation, -> { Dodopayments::MeterAggregation }
+
+      # @!attribute event_name
+      #   Event name to track
+      #
+      #   @return [String]
+      required :event_name, String
+
+      # @!attribute measurement_unit
+      #   measurement unit
+      #
+      #   @return [String]
+      required :measurement_unit, String
+
+      # @!attribute name
+      #   Name of the meter
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute description
+      #   Optional description of the meter
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute filter
+      #   Optional filter to apply to the meter
+      #
+      #   @return [Dodopayments::Models::MeterFilter, nil]
+      optional :filter, -> { Dodopayments::MeterFilter }, nil?: true
+
+      # @!method initialize(aggregation:, event_name:, measurement_unit:, name:, description: nil, filter: nil, request_options: {})
+      #   @param aggregation [Dodopayments::Models::MeterAggregation] Aggregation configuration for the meter
+      #
+      #   @param event_name [String] Event name to track
+      #
+      #   @param measurement_unit [String] measurement unit
+      #
+      #   @param name [String] Name of the meter
+      #
+      #   @param description [String, nil] Optional description of the meter
+      #
+      #   @param filter [Dodopayments::Models::MeterFilter, nil] Optional filter to apply to the meter
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end