orb-billing 1.34.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d22f2113a4acbd1c6f8d94504b3c2e5b751636c2e24cd2c7bdc25897e3d6dd8b
-  data.tar.gz: 4b5092fb788b3bd1b064c20fe160a92bccf05e2394b1af40b715df5db403a27f
+  metadata.gz: 7dccfefe6ce7cde0754bbb1d6b14152cec555db907947996e0d151769b713b72
+  data.tar.gz: b0b230acf4c18d6a950d5b85d2bd3354704fedb09a5e47b4f10b2570b2066411
 SHA512:
-  metadata.gz: 322da3b2af920d12a3967a9599f3c2b1a104e25497a66d42175e2387f6879edbe7e8338a5cecd098a009c5347046f6de5863a161f049e67ab31b78cb965d1573
-  data.tar.gz: 8a7db721c8affc90f7c0b32113ab96118dc139005bba72b2a8ee03b6944aff99413f8b9e296b96f911c21097e4597143a43ae1da4dafb048dea667d0a896df20
+  metadata.gz: 6887197332231d65647e176359fa795ecf7a701bc32d56ed0e3629c5424f0394e1f2ef3fbcf6206f46a72b69ebee54ae30e382c57cea6a0539b51764e6dde67a
+  data.tar.gz: 6bba73f8827220e60b107b95affce1f13eb5c2943776aaaa2e922e8a3c4a369f49c94844ef63eb338227e7d1019c9c2141285e7cbfa5278d76d1d3e0931e3cdb

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [1.36.0](https://github.com/orbcorp/orb-ruby/compare/v1.35.0...v1.36.0) (2026-09-23)
+
+
+### Features
+
+* **api:** api update ([62c9140](https://github.com/orbcorp/orb-ruby/commit/62c914083d1b3b3f514e86a4960b42ff0ef18fa4))
+* **api:** api update ([62c9140](https://github.com/orbcorp/orb-ruby/commit/62c914083d1b3b3f514e86a4960b42ff0ef18fa4))
+* **api:** api update ([62c9140](https://github.com/orbcorp/orb-ruby/commit/62c914083d1b3b3f514e86a4960b42ff0ef18fa4))
+* **api:** api update ([14a6517](https://github.com/orbcorp/orb-ruby/commit/14a65171cecf6a8ffde8b816ab3f1b83bba2a6fa))
+* **api:** api update ([14a6517](https://github.com/orbcorp/orb-ruby/commit/14a65171cecf6a8ffde8b816ab3f1b83bba2a6fa))
+* **api:** api update ([14a6517](https://github.com/orbcorp/orb-ruby/commit/14a65171cecf6a8ffde8b816ab3f1b83bba2a6fa))
+* **api:** api update ([14a6517](https://github.com/orbcorp/orb-ruby/commit/14a65171cecf6a8ffde8b816ab3f1b83bba2a6fa))
+
+
+### Bug Fixes
+
+* **api:** correctly apply plan name when updating a draft plan ([62c9140](https://github.com/orbcorp/orb-ruby/commit/62c914083d1b3b3f514e86a4960b42ff0ef18fa4))
+
+## [1.35.0](https://github.com/orbcorp/orb-ruby/compare/v1.34.0...v1.35.0) (2026-09-21)
+
+
+### Features
+
+* **api:** api update ([f86f225](https://github.com/orbcorp/orb-ruby/commit/f86f22550792b81d0aa2153d0794c242e0504f30))
+
 ## [1.34.0](https://github.com/orbcorp/orb-ruby/compare/v1.33.0...v1.34.0) (2026-09-13)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.34.0"
+gem "orb-billing", "~> 1.36.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/client.rb

@@ -21,6 +21,9 @@ module Orb
     # @return [String, nil]
     attr_reader :webhook_secret
 
+    # @return [Orb::Resources::Webhooks]
+    attr_reader :webhooks
+
     # @return [Orb::Resources::TopLevel]
     attr_reader :top_level
 
@@ -219,6 +222,7 @@ module Orb
         idempotency_header: idempotency_header
       )
 
+      @webhooks = Orb::Resources::Webhooks.new(client: self)
       @top_level = Orb::Resources::TopLevel.new(client: self)
       @beta = Orb::Resources::Beta.new(client: self)
       @coupons = Orb::Resources::Coupons.new(client: self)

data/lib/orb/models/backfill_reflected_webhook_event.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BackfillReflectedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute backfill
+      #   A backfill represents an update to historical usage data, adding or replacing
+      #   events in a timeframe.
+      #
+      #   @return [Orb::Models::BackfillReflectedWebhookEvent::Backfill]
+      required :backfill, -> { Orb::BackfillReflectedWebhookEvent::Backfill }
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::BackfillReflectedWebhookEvent::Type]
+      required :type, enum: -> { Orb::BackfillReflectedWebhookEvent::Type }
+
+      # @!method initialize(id:, backfill:, created_at:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::BackfillReflectedWebhookEvent} for more details.
+      #
+      #   Issued when a backfill is closed and its events are reflected into usage.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param backfill [Orb::Models::BackfillReflectedWebhookEvent::Backfill] A backfill represents an update to historical usage data, adding or replacing ev
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::BackfillReflectedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::BackfillReflectedWebhookEvent#backfill
+      class Backfill < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute close_time
+        #   If in the future, the time at which the backfill will automatically close. If in
+        #   the past, the time at which the backfill was closed.
+        #
+        #   @return [Time, nil]
+        required :close_time, Time, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute customer_id
+        #   The Orb-generated ID of the customer to which this backfill is scoped. If
+        #   `null`, this backfill is scoped to all customers.
+        #
+        #   @return [String, nil]
+        required :customer_id, String, nil?: true
+
+        # @!attribute events_ingested
+        #   The number of events ingested in this backfill.
+        #
+        #   @return [Integer]
+        required :events_ingested, Integer
+
+        # @!attribute replace_existing_events
+        #   If `true`, existing events in the backfill's timeframe will be replaced with the
+        #   newly ingested events associated with the backfill. If `false`, newly ingested
+        #   events will be added to the existing events.
+        #
+        #   @return [Boolean]
+        required :replace_existing_events, Orb::Internal::Type::Boolean
+
+        # @!attribute reverted_at
+        #   The time at which this backfill was reverted.
+        #
+        #   @return [Time, nil]
+        required :reverted_at, Time, nil?: true
+
+        # @!attribute status
+        #   The status of the backfill.
+        #
+        #   @return [Symbol, Orb::Models::BackfillReflectedWebhookEvent::Backfill::Status]
+        required :status, enum: -> { Orb::BackfillReflectedWebhookEvent::Backfill::Status }
+
+        # @!attribute timeframe_end
+        #
+        #   @return [Time]
+        required :timeframe_end, Time
+
+        # @!attribute timeframe_start
+        #
+        #   @return [Time]
+        required :timeframe_start, Time
+
+        # @!attribute deprecation_filter
+        #   A boolean
+        #   [computed property](/extensibility/advanced-metrics#computed-properties) used to
+        #   filter the set of events to deprecate
+        #
+        #   @return [String, nil]
+        optional :deprecation_filter, String, nil?: true
+
+        # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::BackfillReflectedWebhookEvent::Backfill} for more details.
+        #
+        #   A backfill represents an update to historical usage data, adding or replacing
+        #   events in a timeframe.
+        #
+        #   @param id [String]
+        #
+        #   @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
+        #
+        #   @param events_ingested [Integer] The number of events ingested in this backfill.
+        #
+        #   @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
+        #
+        #   @param reverted_at [Time, nil] The time at which this backfill was reverted.
+        #
+        #   @param status [Symbol, Orb::Models::BackfillReflectedWebhookEvent::Backfill::Status] The status of the backfill.
+        #
+        #   @param timeframe_end [Time]
+        #
+        #   @param timeframe_start [Time]
+        #
+        #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+
+        # The status of the backfill.
+        #
+        # @see Orb::Models::BackfillReflectedWebhookEvent::Backfill#status
+        module Status
+          extend Orb::Internal::Type::Enum
+
+          PENDING = :pending
+          REFLECTED = :reflected
+          PENDING_REVERT = :pending_revert
+          REVERTED = :reverted
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::BackfillReflectedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        BACKFILL_REFLECTED = :"backfill.reflected"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/backfill_reverted_webhook_event.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BackfillRevertedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute backfill
+      #   A backfill represents an update to historical usage data, adding or replacing
+      #   events in a timeframe.
+      #
+      #   @return [Orb::Models::BackfillRevertedWebhookEvent::Backfill]
+      required :backfill, -> { Orb::BackfillRevertedWebhookEvent::Backfill }
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::BackfillRevertedWebhookEvent::Type]
+      required :type, enum: -> { Orb::BackfillRevertedWebhookEvent::Type }
+
+      # @!method initialize(id:, backfill:, created_at:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::BackfillRevertedWebhookEvent} for more details.
+      #
+      #   Issued when a backfill is reverted, removing its events from usage.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param backfill [Orb::Models::BackfillRevertedWebhookEvent::Backfill] A backfill represents an update to historical usage data, adding or replacing ev
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::BackfillRevertedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::BackfillRevertedWebhookEvent#backfill
+      class Backfill < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute close_time
+        #   If in the future, the time at which the backfill will automatically close. If in
+        #   the past, the time at which the backfill was closed.
+        #
+        #   @return [Time, nil]
+        required :close_time, Time, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute customer_id
+        #   The Orb-generated ID of the customer to which this backfill is scoped. If
+        #   `null`, this backfill is scoped to all customers.
+        #
+        #   @return [String, nil]
+        required :customer_id, String, nil?: true
+
+        # @!attribute events_ingested
+        #   The number of events ingested in this backfill.
+        #
+        #   @return [Integer]
+        required :events_ingested, Integer
+
+        # @!attribute replace_existing_events
+        #   If `true`, existing events in the backfill's timeframe will be replaced with the
+        #   newly ingested events associated with the backfill. If `false`, newly ingested
+        #   events will be added to the existing events.
+        #
+        #   @return [Boolean]
+        required :replace_existing_events, Orb::Internal::Type::Boolean
+
+        # @!attribute reverted_at
+        #   The time at which this backfill was reverted.
+        #
+        #   @return [Time, nil]
+        required :reverted_at, Time, nil?: true
+
+        # @!attribute status
+        #   The status of the backfill.
+        #
+        #   @return [Symbol, Orb::Models::BackfillRevertedWebhookEvent::Backfill::Status]
+        required :status, enum: -> { Orb::BackfillRevertedWebhookEvent::Backfill::Status }
+
+        # @!attribute timeframe_end
+        #
+        #   @return [Time]
+        required :timeframe_end, Time
+
+        # @!attribute timeframe_start
+        #
+        #   @return [Time]
+        required :timeframe_start, Time
+
+        # @!attribute deprecation_filter
+        #   A boolean
+        #   [computed property](/extensibility/advanced-metrics#computed-properties) used to
+        #   filter the set of events to deprecate
+        #
+        #   @return [String, nil]
+        optional :deprecation_filter, String, nil?: true
+
+        # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::BackfillRevertedWebhookEvent::Backfill} for more details.
+        #
+        #   A backfill represents an update to historical usage data, adding or replacing
+        #   events in a timeframe.
+        #
+        #   @param id [String]
+        #
+        #   @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
+        #
+        #   @param events_ingested [Integer] The number of events ingested in this backfill.
+        #
+        #   @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
+        #
+        #   @param reverted_at [Time, nil] The time at which this backfill was reverted.
+        #
+        #   @param status [Symbol, Orb::Models::BackfillRevertedWebhookEvent::Backfill::Status] The status of the backfill.
+        #
+        #   @param timeframe_end [Time]
+        #
+        #   @param timeframe_start [Time]
+        #
+        #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
+
+        # The status of the backfill.
+        #
+        # @see Orb::Models::BackfillRevertedWebhookEvent::Backfill#status
+        module Status
+          extend Orb::Internal::Type::Enum
+
+          PENDING = :pending
+          REFLECTED = :reflected
+          PENDING_REVERT = :pending_revert
+          REVERTED = :reverted
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::BackfillRevertedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        BACKFILL_REVERTED = :"backfill.reverted"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/billable_metric_edited_webhook_event.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class BillableMetricEditedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute billable_metric
+      #   The Metric resource represents a calculation of a quantity based on events.
+      #   Metrics are defined by the query that transforms raw usage events into
+      #   meaningful values for your customers.
+      #
+      #   @return [Orb::Models::BillableMetric]
+      required :billable_metric, -> { Orb::BillableMetric }
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::BillableMetricEditedWebhookEvent::Properties]
+      required :properties, -> { Orb::BillableMetricEditedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::BillableMetricEditedWebhookEvent::Type]
+      required :type, enum: -> { Orb::BillableMetricEditedWebhookEvent::Type }
+
+      # @!method initialize(id:, billable_metric:, created_at:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::BillableMetricEditedWebhookEvent} for more details.
+      #
+      #   Issued when a billable metric is edited.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param billable_metric [Orb::Models::BillableMetric] The Metric resource represents a calculation of a quantity based on events.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param properties [Orb::Models::BillableMetricEditedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::BillableMetricEditedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::BillableMetricEditedWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute previous_attributes
+        #   metadata values are non-null on the wire, as on the price event.
+        #
+        #   @return [Orb::Models::BillableMetricEditedWebhookEvent::Properties::PreviousAttributes]
+        required :previous_attributes,
+                 -> { Orb::BillableMetricEditedWebhookEvent::Properties::PreviousAttributes }
+
+        # @!method initialize(previous_attributes:)
+        #   @param previous_attributes [Orb::Models::BillableMetricEditedWebhookEvent::Properties::PreviousAttributes] metadata values are non-null on the wire, as on the price event.
+
+        # @see Orb::Models::BillableMetricEditedWebhookEvent::Properties#previous_attributes
+        class PreviousAttributes < Orb::Internal::Type::BaseModel
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute metadata
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :metadata, Orb::Internal::Type::HashOf[String], nil?: true
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!method initialize(description: nil, metadata: nil, name: nil)
+          #   metadata values are non-null on the wire, as on the price event.
+          #
+          #   @param description [String, nil]
+          #   @param metadata [Hash{Symbol=>String}, nil]
+          #   @param name [String, nil]
+        end
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::BillableMetricEditedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        BILLABLE_METRIC_EDITED = :"billable_metric.edited"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end