metronome-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

data/lib/metronome_sdk/internal/util.rb

@@ -9,6 +9,23 @@ module MetronomeSDK
       # @return [Float]
       def self.monotonic_secs = Process.clock_gettime(Process::CLOCK_MONOTONIC)
 
+      # @api private
+      #
+      # @param ns [Module, Class]
+      #
+      # @return [Enumerable<Module, Class>]
+      def self.walk_namespaces(ns)
+        ns.constants(false).lazy.flat_map do
+          case (c = ns.const_get(_1, false))
+          in Module | Class
+            walk_namespaces(c)
+          else
+            []
+          end
+        end
+          .chain([ns])
+      end
+
       class << self
         # @api private
         #
@@ -128,6 +145,22 @@ module MetronomeSDK
             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 #{MetronomeSDK::Internal::Type::BaseModel}, got #{data.inspect}"
+            raise ArgumentError.new(message)
+          end
+        end
       end
 
       class << self
@@ -454,7 +487,7 @@ module MetronomeSDK
       # @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
@@ -493,7 +526,7 @@ module MetronomeSDK
             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
@@ -519,7 +552,7 @@ module MetronomeSDK
             filename = ERB::Util.url_encode(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(File.basename(val.to_path))
+            filename = ERB::Util.url_encode(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end
@@ -567,12 +600,14 @@ module MetronomeSDK
         #
         # @return [Object]
         def encode_content(headers, body)
+          # rubocop:disable Style/CaseEquality
+          # rubocop:disable Layout/LineLength
           content_type = headers["content-type"]
           case [content_type, body]
           in [MetronomeSDK::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
-            [headers, JSON.fast_generate(body)]
-          in [MetronomeSDK::Internal::Util::JSONL_CONTENT, Enumerable] unless body.is_a?(MetronomeSDK::Internal::Type::FileInput)
-            [headers, body.lazy.map { JSON.fast_generate(_1) }]
+            [headers, JSON.generate(body)]
+          in [MetronomeSDK::Internal::Util::JSONL_CONTENT, Enumerable] unless MetronomeSDK::Internal::Type::FileInput === body
+            [headers, body.lazy.map { JSON.generate(_1) }]
           in [%r{^multipart/form-data}, Hash | MetronomeSDK::Internal::Type::FileInput]
             boundary, strio = encode_multipart_streaming(body)
             headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
@@ -586,6 +621,8 @@ module MetronomeSDK
           else
             [headers, body]
           end
+          # rubocop:enable Layout/LineLength
+          # rubocop:enable Style/CaseEquality
         end
 
         # @api private
@@ -785,6 +822,94 @@ module MetronomeSDK
           end
         end
       end
+
+      # @api private
+      module SorbetRuntimeSupport
+        class MissingSorbetRuntimeError < ::RuntimeError
+        end
+
+        # @api private
+        #
+        # @return [Hash{Symbol=>Object}]
+        private def sorbet_runtime_constants = @sorbet_runtime_constants ||= {}
+
+        # @api private
+        #
+        # @param name [Symbol]
+        def const_missing(name)
+          super unless sorbet_runtime_constants.key?(name)
+
+          unless Object.const_defined?(:T)
+            message = "Trying to access a Sorbet constant #{name.inspect} without `sorbet-runtime`."
+            raise MissingSorbetRuntimeError.new(message)
+          end
+
+          sorbet_runtime_constants.fetch(name).call
+        end
+
+        # @api private
+        #
+        # @param name [Symbol]
+        #
+        # @return [Boolean]
+        def sorbet_constant_defined?(name) = sorbet_runtime_constants.key?(name)
+
+        # @api private
+        #
+        # @param name [Symbol]
+        # @param blk [Proc]
+        def define_sorbet_constant!(name, &blk) = sorbet_runtime_constants.store(name, blk)
+
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type = raise NotImplementedError
+
+        class << self
+          # @api private
+          #
+          # @param type [MetronomeSDK::Internal::Util::SorbetRuntimeSupport, Object]
+          #
+          # @return [Object]
+          def to_sorbet_type(type)
+            case type
+            in MetronomeSDK::Internal::Util::SorbetRuntimeSupport
+              type.to_sorbet_type
+            in Class | Module
+              type
+            in true | false
+              T::Boolean
+            else
+              type.class
+            end
+          end
+        end
+      end
+
+      extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
+
+      define_sorbet_constant!(:ParsedUri) do
+        T.type_alias do
+          {
+            scheme: T.nilable(String),
+            host: T.nilable(String),
+            port: T.nilable(Integer),
+            path: T.nilable(String),
+            query: T::Hash[String, T::Array[String]]
+          }
+        end
+      end
+
+      define_sorbet_constant!(:ServerSentEvent) do
+        T.type_alias do
+          {
+            event: T.nilable(String),
+            data: T.nilable(String),
+            id: T.nilable(String),
+            retry: T.nilable(Integer)
+          }
+        end
+      end
     end
   end
 end

data/lib/metronome_sdk/internal.rb

@@ -2,10 +2,19 @@
 
 module MetronomeSDK
   module Internal
+    extend MetronomeSDK::Internal::Util::SorbetRuntimeSupport
+
     OMIT =
       Object.new.tap do
         _1.define_singleton_method(:inspect) { "#<#{MetronomeSDK::Internal}::OMIT>" }
       end
         .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, MetronomeSDK::FilePart) }
+    end
   end
 end

data/lib/metronome_sdk/models/v1/alert_archive_response.rb

@@ -7,11 +7,22 @@ module MetronomeSDK
       class AlertArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::ID]
-        required :data, -> { MetronomeSDK::Models::ID }
+        #   @return [MetronomeSDK::Models::V1::AlertArchiveResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::AlertArchiveResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::ID]
+        #   @param data [MetronomeSDK::Models::V1::AlertArchiveResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::AlertArchiveResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   @param id [String]
+        end
       end
     end
   end

data/lib/metronome_sdk/models/v1/alert_create_params.rb

@@ -12,7 +12,7 @@ module MetronomeSDK
         #   Type of the alert
         #
         #   @return [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType]
-        required :alert_type, enum: -> { MetronomeSDK::Models::V1::AlertCreateParams::AlertType }
+        required :alert_type, enum: -> { MetronomeSDK::V1::AlertCreateParams::AlertType }
 
         # @!attribute name
         #   Name of the alert
@@ -53,11 +53,13 @@ module MetronomeSDK
         #
         #   @return [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>, nil]
         optional :custom_field_filters,
-                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter] }
+                 -> {
+                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter]
+                 }
 
         # @!attribute customer_id
         #   If provided, will create this alert for this specific customer. To create an
-        #   alert for all customers, do not specify `customer_id` or `plan_id`.
+        #   alert for all customers, do not specify a `customer_id`.
         #
         #   @return [String, nil]
         optional :customer_id, String
@@ -75,7 +77,7 @@ module MetronomeSDK
         #   items. Only present for spend alerts.
         #
         #   @return [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter, nil]
-        optional :group_key_filter, -> { MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter }
+        optional :group_key_filter, -> { MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter }
 
         # @!attribute invoice_types_filter
         #   Only supported for invoice_total_reached alerts. A list of invoice types to
@@ -86,7 +88,7 @@ module MetronomeSDK
 
         # @!attribute plan_id
         #   If provided, will create this alert for this specific plan. To create an alert
-        #   for all customers, do not specify `customer_id` or `plan_id`.
+        #   for all customers, do not specify a `plan_id`.
         #
         #   @return [String, nil]
         optional :plan_id, String
@@ -108,36 +110,26 @@ module MetronomeSDK
         #   @param name [String] Name of the alert
         #
         #   @param threshold [Float] Threshold value of the alert policy. Depending upon the alert type, this number
-        #   ...
         #
         #   @param billable_metric_id [String] For alerts of type `usage_threshold_reached`, specifies which billable metric to
-        #   ...
         #
         #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
-        #   ...
         #
         #   @param credit_type_id [String]
         #
         #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
-        #   ...
         #
         #   @param customer_id [String] If provided, will create this alert for this specific customer. To create an ale
-        #   ...
         #
         #   @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
-        #   ...
         #
         #   @param group_key_filter [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
-        #   ...
         #
         #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
-        #   ...
         #
         #   @param plan_id [String] If provided, will create this alert for this specific plan. To create an alert f
-        #   ...
         #
         #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -170,7 +162,7 @@ module MetronomeSDK
           # @!attribute entity
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter::Entity]
-          required :entity, enum: -> { MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter::Entity }
+          required :entity, enum: -> { MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter::Entity }
 
           # @!attribute key
           #

data/lib/metronome_sdk/models/v1/alert_create_response.rb

@@ -7,11 +7,22 @@ module MetronomeSDK
       class AlertCreateResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::ID]
-        required :data, -> { MetronomeSDK::Models::ID }
+        #   @return [MetronomeSDK::Models::V1::AlertCreateResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::AlertCreateResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::ID]
+        #   @param data [MetronomeSDK::Models::V1::AlertCreateResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::AlertCreateResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   @param id [String]
+        end
       end
     end
   end

data/lib/metronome_sdk/models/v1/audit_log_list_params.rb

@@ -44,7 +44,7 @@ module MetronomeSDK
         #   Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
         #
         #   @return [Symbol, MetronomeSDK::Models::V1::AuditLogListParams::Sort, nil]
-        optional :sort, enum: -> { MetronomeSDK::Models::V1::AuditLogListParams::Sort }
+        optional :sort, enum: -> { MetronomeSDK::V1::AuditLogListParams::Sort }
 
         # @!attribute starting_on
         #   RFC 3339 timestamp of the earliest audit log to return. Cannot be used with
@@ -64,15 +64,12 @@ module MetronomeSDK
         #   @param next_page [String] Cursor that indicates where the next page of results should start.
         #
         #   @param resource_id [String] Optional parameter that can be used to filter which audit logs are returned. If
-        #   ...
         #
         #   @param resource_type [String] Optional parameter that can be used to filter which audit logs are returned. If
-        #   ...
         #
         #   @param sort [Symbol, MetronomeSDK::Models::V1::AuditLogListParams::Sort] Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
         #
         #   @param starting_on [Time] RFC 3339 timestamp of the earliest audit log to return. Cannot be used with 'nex
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/metronome_sdk/models/v1/billable_metric_archive_params.rb

@@ -4,11 +4,17 @@ module MetronomeSDK
   module Models
     module V1
       # @see MetronomeSDK::Resources::V1::BillableMetrics#archive
-      class BillableMetricArchiveParams < MetronomeSDK::Models::ID
+      class BillableMetricArchiveParams < MetronomeSDK::Internal::Type::BaseModel
         extend MetronomeSDK::Internal::Type::RequestParameters::Converter
         include MetronomeSDK::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb

@@ -7,11 +7,22 @@ module MetronomeSDK
       class BillableMetricArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::ID]
-        required :data, -> { MetronomeSDK::Models::ID }
+        #   @return [MetronomeSDK::Models::V1::BillableMetricArchiveResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::BillableMetricArchiveResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::ID]
+        #   @param data [MetronomeSDK::Models::V1::BillableMetricArchiveResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::BillableMetricArchiveResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   @param id [String]
+        end
       end
     end
   end

data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb

@@ -25,8 +25,7 @@ module MetronomeSDK
         #   Specifies the type of aggregation performed on matching events.
         #
         #   @return [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType, nil]
-        optional :aggregation_type,
-                 enum: -> { MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType }
+        optional :aggregation_type, enum: -> { MetronomeSDK::V1::BillableMetricCreateParams::AggregationType }
 
         # @!attribute custom_fields
         #   Custom fields to attach to the billable metric.
@@ -37,8 +36,8 @@ module MetronomeSDK
         # @!attribute event_type_filter
         #   An optional filtering rule to match the 'event_type' property of an event.
         #
-        #   @return [MetronomeSDK::Models::EventTypeFilter, nil]
-        optional :event_type_filter, -> { MetronomeSDK::Models::EventTypeFilter }
+        #   @return [MetronomeSDK::Models::V1::BillableMetricCreateParams::EventTypeFilter, nil]
+        optional :event_type_filter, -> { MetronomeSDK::V1::BillableMetricCreateParams::EventTypeFilter }
 
         # @!attribute group_keys
         #   Property names that are used to group usage costs on an invoice. Each entry
@@ -53,9 +52,11 @@ module MetronomeSDK
         #   rule on an event property. All rules must pass for the event to match the
         #   billable metric.
         #
-        #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
+        #   @return [Array<MetronomeSDK::Models::V1::BillableMetricCreateParams::PropertyFilter>, nil]
         optional :property_filters,
-                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::PropertyFilter] }
+                 -> {
+                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::BillableMetricCreateParams::PropertyFilter]
+                 }
 
         # @!attribute sql
         #   The SQL query associated with the billable metric. This field is mutually
@@ -73,22 +74,18 @@ module MetronomeSDK
         #   @param name [String] The display name of the billable metric.
         #
         #   @param aggregation_key [String] Specifies the type of aggregation performed on matching events. Required if `sql
-        #   ...
         #
         #   @param aggregation_type [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
         #
         #   @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the billable metric.
         #
-        #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+        #   @param event_type_filter [MetronomeSDK::Models::V1::BillableMetricCreateParams::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
         #
         #   @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
-        #   ...
         #
-        #   @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
-        #   ...
+        #   @param property_filters [Array<MetronomeSDK::Models::V1::BillableMetricCreateParams::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
         #
         #   @param sql [String] The SQL query associated with the billable metric. This field is mutually exclus
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -105,6 +102,83 @@ module MetronomeSDK
           # @!method self.values
           #   @return [Array<Symbol>]
         end
+
+        class EventTypeFilter < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute in_values
+          #   A list of event types that are explicitly included in the billable metric. If
+          #   specified, only events of these types will match the billable metric. Must be
+          #   non-empty if present.
+          #
+          #   @return [Array<String>, nil]
+          optional :in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!attribute not_in_values
+          #   A list of event types that are explicitly excluded from the billable metric. If
+          #   specified, events of these types will not match the billable metric. Must be
+          #   non-empty if present.
+          #
+          #   @return [Array<String>, nil]
+          optional :not_in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(in_values: nil, not_in_values: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::BillableMetricCreateParams::EventTypeFilter} for more
+          #   details.
+          #
+          #   An optional filtering rule to match the 'event_type' property of an event.
+          #
+          #   @param in_values [Array<String>] A list of event types that are explicitly included in the billable metric. If sp
+          #
+          #   @param not_in_values [Array<String>] A list of event types that are explicitly excluded from the billable metric. If
+        end
+
+        class PropertyFilter < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute name
+          #   The name of the event property.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute exists
+          #   Determines whether the property must exist in the event. If true, only events
+          #   with this property will pass the filter. If false, only events without this
+          #   property will pass the filter. If null or omitted, the existence of the property
+          #   is optional.
+          #
+          #   @return [Boolean, nil]
+          optional :exists, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute in_values
+          #   Specifies the allowed values for the property to match an event. An event will
+          #   pass the filter only if its property value is included in this list. If
+          #   undefined, all property values will pass the filter. Must be non-empty if
+          #   present.
+          #
+          #   @return [Array<String>, nil]
+          optional :in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!attribute not_in_values
+          #   Specifies the values that prevent an event from matching the filter. An event
+          #   will not pass the filter if its property value is included in this list. If null
+          #   or empty, all property values will pass the filter. Must be non-empty if
+          #   present.
+          #
+          #   @return [Array<String>, nil]
+          optional :not_in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(name:, exists: nil, in_values: nil, not_in_values: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::BillableMetricCreateParams::PropertyFilter} for more
+          #   details.
+          #
+          #   @param name [String] The name of the event property.
+          #
+          #   @param exists [Boolean] Determines whether the property must exist in the event. If true, only events wi
+          #
+          #   @param in_values [Array<String>] Specifies the allowed values for the property to match an event. An event will p
+          #
+          #   @param not_in_values [Array<String>] Specifies the values that prevent an event from matching the filter. An event wi
+        end
       end
     end
   end

data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb

@@ -7,11 +7,22 @@ module MetronomeSDK
       class BillableMetricCreateResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::ID]
-        required :data, -> { MetronomeSDK::Models::ID }
+        #   @return [MetronomeSDK::Models::V1::BillableMetricCreateResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::BillableMetricCreateResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::ID]
+        #   @param data [MetronomeSDK::Models::V1::BillableMetricCreateResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::BillableMetricCreateResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   @param id [String]
+        end
       end
     end
   end