orb-billing 1.46.0 → 1.48.0

data/lib/orb/resources/metrics.rb

@@ -44,16 +44,21 @@ module Orb
       # Some parameter documentations has been truncated, see
       # {Orb::Models::MetricUpdateParams} for more details.
       #
-      # This endpoint allows you to update the `metadata` property on a metric. If you
-      # pass `null` for the metadata value, it will clear any existing metadata for that
-      # invoice.
+      # This endpoint allows you to update the `name`, `description`, and `metadata`
+      # properties on a metric. Fields left out of the request are not changed, and
+      # `name` cannot be empty. If you pass `null` for the metadata value, it will clear
+      # any existing metadata for that metric.
       #
-      # @overload update(metric_id, metadata: nil, request_options: {})
+      # @overload update(metric_id, description: nil, metadata: nil, name: nil, request_options: {})
       #
       # @param metric_id [String]
       #
+      # @param description [String, nil] A description of the metric.
+      #
       # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
       #
+      # @param name [String, nil] The name of the metric.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::BillableMetric]
@@ -76,7 +81,10 @@ module Orb
       # This endpoint is used to list [metrics](/core-concepts#metric). It returns
       # information about the metrics including its name, description, and item.
       #
-      # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
+      # Pass `status` to only return metrics with that status, e.g. `status=active` to
+      # leave out archived metrics.
+      #
+      # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {})
       #
       # @param created_at_gt [Time, nil]
       #
@@ -90,6 +98,8 @@ module Orb
       #
       # @param limit [Integer] The number of items to fetch. Defaults to 20.
       #
+      # @param status [Symbol, Orb::Models::MetricListParams::Status, nil] The metric status to filter to ('active', 'archived', or 'draft').
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::BillableMetric>]
@@ -113,6 +123,31 @@ module Orb
         )
       end
 
+      # This endpoint archives a [metric](/core-concepts#metric). Archived metrics are
+      # left out of `GET /v1/metrics` when filtering with `status=active`, and can't be
+      # chosen when creating new plans in the Orb dashboard.
+      #
+      # Archiving does not change existing prices, plans, or subscriptions that use the
+      # metric, and usage on those prices continues to be billed. A metric that is
+      # already archived cannot be archived again.
+      #
+      # @overload archive(metric_id, request_options: {})
+      #
+      # @param metric_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::BillableMetric]
+      #
+      # @see Orb::Models::MetricArchiveParams
+      def archive(metric_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["metrics/%1$s/archive", metric_id],
+          model: Orb::BillableMetric,
+          options: params[:request_options]
+        )
+      end
+
       # This endpoint is used to fetch [metric](/core-concepts#metric) details given a
       # metric identifier. It returns information about the metrics including its name,
       # description, and item.
@@ -134,6 +169,27 @@ module Orb
         )
       end
 
+      # This endpoint restores an archived [metric](/core-concepts#metric) to `active`,
+      # so it can be chosen for new plans again. Only archived metrics can be
+      # unarchived.
+      #
+      # @overload unarchive(metric_id, request_options: {})
+      #
+      # @param metric_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::BillableMetric]
+      #
+      # @see Orb::Models::MetricUnarchiveParams
+      def unarchive(metric_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["metrics/%1$s/unarchive", metric_id],
+          model: Orb::BillableMetric,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Orb::Client]

data/lib/orb/resources/plans/external_plan_id.rb

@@ -11,12 +11,13 @@ module Orb
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details.
         #
-        # This endpoint can be used to update the `external_plan_id`, `description`, and
-        # `metadata` of an existing plan.
+        # This endpoint can be used to update the `name`, `external_plan_id`,
+        # `description`, and `metadata` of an existing plan. A plan's `name` cannot be
+        # empty.
         #
         # Other fields on a plan are currently immutable.
         #
-        # @overload update(other_external_plan_id, description: nil, external_plan_id: nil, metadata: nil, request_options: {})
+        # @overload update(other_external_plan_id, description: nil, external_plan_id: nil, metadata: nil, name: nil, request_options: {})
         #
         # @param other_external_plan_id [String]
         #
@@ -26,6 +27,8 @@ module Orb
         #
         # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
         #
+        # @param name [String, nil] The name of the plan.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Plan]

data/lib/orb/resources/plans.rb

@@ -63,12 +63,13 @@ module Orb
       # Some parameter documentations has been truncated, see
       # {Orb::Models::PlanUpdateParams} for more details.
       #
-      # This endpoint can be used to update the `external_plan_id`, `description`, and
-      # `metadata` of an existing plan.
+      # This endpoint can be used to update the `name`, `external_plan_id`,
+      # `description`, and `metadata` of an existing plan. A plan's `name` cannot be
+      # empty.
       #
       # Other fields on a plan are currently immutable.
       #
-      # @overload update(plan_id, description: nil, external_plan_id: nil, metadata: nil, request_options: {})
+      # @overload update(plan_id, description: nil, external_plan_id: nil, metadata: nil, name: nil, request_options: {})
       #
       # @param plan_id [String]
       #
@@ -78,6 +79,8 @@ module Orb
       #
       # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
       #
+      # @param name [String, nil] The name of the plan.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Plan]

data/lib/orb/resources/webhook_endpoints.rb

@@ -12,12 +12,14 @@ module Orb
       # webhook events. The secret isn't returned by any other endpoint. An account can
       # have at most 20 webhook endpoints by default.
       #
-      # @overload create(url:, enabled_event_types: nil, request_options: {})
+      # @overload create(url:, enabled_event_types: nil, payload_style: nil, request_options: {})
       #
       # @param url [String] The HTTPS URL that Orb sends webhook events to.
       #
       # @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. If omitted or null, all event
       #
+      # @param payload_style [Symbol, Orb::Models::WebhookEndpointCreateParams::PayloadStyle, nil] The payload style of the webhook events sent to this endpoint. If omitted or nul
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::WebhookEndpointWithSecret]
@@ -58,12 +60,14 @@ module Orb
       #
       # This endpoint updates a webhook endpoint's URL or the event types sent to it.
       #
-      # @overload update(webhook_endpoint_id, enabled_event_types: nil, url: nil, request_options: {})
+      # @overload update(webhook_endpoint_id, enabled_event_types: nil, payload_style: nil, url: nil, request_options: {})
       #
       # @param webhook_endpoint_id [String]
       #
       # @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. Null sends all event types; om
       #
+      # @param payload_style [Symbol, Orb::Models::WebhookEndpointUpdateParams::PayloadStyle, nil] The payload style of the webhook events sent to this endpoint. Applies to events
+      #
       # @param url [String, nil] The HTTPS URL that Orb sends webhook events to.
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.46.0"
+  VERSION = "1.48.0"
 end

data/lib/orb.rb

@@ -107,6 +107,8 @@ require_relative "orb/models/credit_block_list_invoices_params"
 require_relative "orb/models/credit_block_list_invoices_response"
 require_relative "orb/models/credit_block_retrieve_params"
 require_relative "orb/models/credit_block_retrieve_response"
+require_relative "orb/models/credit_block_update_params"
+require_relative "orb/models/credit_block_update_response"
 require_relative "orb/models/credit_note"
 require_relative "orb/models/credit_note_accounting_sync_failed_webhook_event"
 require_relative "orb/models/credit_note_accounting_sync_succeeded_webhook_event"
@@ -304,10 +306,12 @@ require_relative "orb/models/matrix_value"
 require_relative "orb/models/matrix_with_allocation_config"
 require_relative "orb/models/maximum"
 require_relative "orb/models/maximum_interval"
+require_relative "orb/models/metric_archive_params"
 require_relative "orb/models/metric_create_params"
 require_relative "orb/models/metric_events_dropped_by_watermark_webhook_event"
 require_relative "orb/models/metric_fetch_params"
 require_relative "orb/models/metric_list_params"
+require_relative "orb/models/metric_unarchive_params"
 require_relative "orb/models/metric_update_params"
 require_relative "orb/models/minimum"
 require_relative "orb/models/minimum_interval"

data/rbi/orb/models/credit_block_update_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Orb
+  module Models
+    class CreditBlockUpdateParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Orb::CreditBlockUpdateParams, Orb::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :block_id
+
+      # User-specified key/value pairs for the resource. Individual keys can be removed
+      # by setting the value to `null`, and the entire metadata mapping can be cleared
+      # by setting `metadata` to `null`.
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_accessor :metadata
+
+      sig do
+        params(
+          block_id: String,
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        block_id:,
+        # User-specified key/value pairs for the resource. Individual keys can be removed
+        # by setting the value to `null`, and the entire metadata mapping can be cleared
+        # by setting `metadata` to `null`.
+        metadata: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            block_id: String,
+            metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+            request_options: Orb::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end