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

data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi

@@ -62,11 +62,20 @@ module MetronomeSDK
         attr_writer :custom_fields
 
         # An optional filtering rule to match the 'event_type' property of an event.
-        sig { returns(T.nilable(MetronomeSDK::EventTypeFilter)) }
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::Models::V1::BillableMetricListResponse::EventTypeFilter
+            )
+          )
+        end
         attr_reader :event_type_filter
 
         sig do
-          params(event_type_filter: MetronomeSDK::EventTypeFilter::OrHash).void
+          params(
+            event_type_filter:
+              MetronomeSDK::Models::V1::BillableMetricListResponse::EventTypeFilter::OrHash
+          ).void
         end
         attr_writer :event_type_filter
 
@@ -81,12 +90,23 @@ module MetronomeSDK
         # A list of filters to match events to this billable metric. Each filter defines a
         # rule on an event property. All rules must pass for the event to match the
         # billable metric.
-        sig { returns(T.nilable(T::Array[MetronomeSDK::PropertyFilter])) }
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                MetronomeSDK::Models::V1::BillableMetricListResponse::PropertyFilter
+              ]
+            )
+          )
+        end
         attr_reader :property_filters
 
         sig do
           params(
-            property_filters: T::Array[MetronomeSDK::PropertyFilter::OrHash]
+            property_filters:
+              T::Array[
+                MetronomeSDK::Models::V1::BillableMetricListResponse::PropertyFilter::OrHash
+              ]
           ).void
         end
         attr_writer :property_filters
@@ -107,9 +127,13 @@ module MetronomeSDK
               MetronomeSDK::Models::V1::BillableMetricListResponse::AggregationType::OrSymbol,
             archived_at: Time,
             custom_fields: T::Hash[Symbol, String],
-            event_type_filter: MetronomeSDK::EventTypeFilter::OrHash,
+            event_type_filter:
+              MetronomeSDK::Models::V1::BillableMetricListResponse::EventTypeFilter::OrHash,
             group_keys: T::Array[T::Array[String]],
-            property_filters: T::Array[MetronomeSDK::PropertyFilter::OrHash],
+            property_filters:
+              T::Array[
+                MetronomeSDK::Models::V1::BillableMetricListResponse::PropertyFilter::OrHash
+              ],
             sql: String
           ).returns(T.attached_class)
         end
@@ -152,9 +176,13 @@ module MetronomeSDK
                 MetronomeSDK::Models::V1::BillableMetricListResponse::AggregationType::TaggedSymbol,
               archived_at: Time,
               custom_fields: T::Hash[Symbol, String],
-              event_type_filter: MetronomeSDK::EventTypeFilter,
+              event_type_filter:
+                MetronomeSDK::Models::V1::BillableMetricListResponse::EventTypeFilter,
               group_keys: T::Array[T::Array[String]],
-              property_filters: T::Array[MetronomeSDK::PropertyFilter],
+              property_filters:
+                T::Array[
+                  MetronomeSDK::Models::V1::BillableMetricListResponse::PropertyFilter
+                ],
               sql: String
             }
           )
@@ -211,6 +239,147 @@ module MetronomeSDK
           def self.values
           end
         end
+
+        class EventTypeFilter < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::BillableMetricListResponse::EventTypeFilter,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # 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.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :in_values
+
+          sig { params(in_values: T::Array[String]).void }
+          attr_writer :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.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :not_in_values
+
+          sig { params(not_in_values: T::Array[String]).void }
+          attr_writer :not_in_values
+
+          # An optional filtering rule to match the 'event_type' property of an event.
+          sig do
+            params(
+              in_values: T::Array[String],
+              not_in_values: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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.
+            in_values: nil,
+            # 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.
+            not_in_values: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { in_values: T::Array[String], not_in_values: T::Array[String] }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class PropertyFilter < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::BillableMetricListResponse::PropertyFilter,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The name of the event property.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # 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.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :exists
+
+          sig { params(exists: T::Boolean).void }
+          attr_writer :exists
+
+          # 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.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :in_values
+
+          sig { params(in_values: T::Array[String]).void }
+          attr_writer :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.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :not_in_values
+
+          sig { params(not_in_values: T::Array[String]).void }
+          attr_writer :not_in_values
+
+          sig do
+            params(
+              name: String,
+              exists: T::Boolean,
+              in_values: T::Array[String],
+              not_in_values: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the event property.
+            name:,
+            # 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.
+            exists: nil,
+            # 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.
+            in_values: nil,
+            # 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.
+            not_in_values: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name: String,
+                exists: T::Boolean,
+                in_values: T::Array[String],
+                not_in_values: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi

@@ -106,12 +106,19 @@ module MetronomeSDK
           attr_writer :custom_fields
 
           # An optional filtering rule to match the 'event_type' property of an event.
-          sig { returns(T.nilable(MetronomeSDK::EventTypeFilter)) }
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::EventTypeFilter
+              )
+            )
+          end
           attr_reader :event_type_filter
 
           sig do
             params(
-              event_type_filter: MetronomeSDK::EventTypeFilter::OrHash
+              event_type_filter:
+                MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::EventTypeFilter::OrHash
             ).void
           end
           attr_writer :event_type_filter
@@ -127,12 +134,23 @@ module MetronomeSDK
           # A list of filters to match events to this billable metric. Each filter defines a
           # rule on an event property. All rules must pass for the event to match the
           # billable metric.
-          sig { returns(T.nilable(T::Array[MetronomeSDK::PropertyFilter])) }
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::PropertyFilter
+                ]
+              )
+            )
+          end
           attr_reader :property_filters
 
           sig do
             params(
-              property_filters: T::Array[MetronomeSDK::PropertyFilter::OrHash]
+              property_filters:
+                T::Array[
+                  MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::PropertyFilter::OrHash
+                ]
             ).void
           end
           attr_writer :property_filters
@@ -153,9 +171,13 @@ module MetronomeSDK
                 MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::AggregationType::OrSymbol,
               archived_at: Time,
               custom_fields: T::Hash[Symbol, String],
-              event_type_filter: MetronomeSDK::EventTypeFilter::OrHash,
+              event_type_filter:
+                MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::EventTypeFilter::OrHash,
               group_keys: T::Array[T::Array[String]],
-              property_filters: T::Array[MetronomeSDK::PropertyFilter::OrHash],
+              property_filters:
+                T::Array[
+                  MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::PropertyFilter::OrHash
+                ],
               sql: String
             ).returns(T.attached_class)
           end
@@ -198,9 +220,13 @@ module MetronomeSDK
                   MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::AggregationType::TaggedSymbol,
                 archived_at: Time,
                 custom_fields: T::Hash[Symbol, String],
-                event_type_filter: MetronomeSDK::EventTypeFilter,
+                event_type_filter:
+                  MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::EventTypeFilter,
                 group_keys: T::Array[T::Array[String]],
-                property_filters: T::Array[MetronomeSDK::PropertyFilter],
+                property_filters:
+                  T::Array[
+                    MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::PropertyFilter
+                  ],
                 sql: String
               }
             )
@@ -257,6 +283,147 @@ module MetronomeSDK
             def self.values
             end
           end
+
+          class EventTypeFilter < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::EventTypeFilter,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # 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.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :in_values
+
+            sig { params(in_values: T::Array[String]).void }
+            attr_writer :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.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :not_in_values
+
+            sig { params(not_in_values: T::Array[String]).void }
+            attr_writer :not_in_values
+
+            # An optional filtering rule to match the 'event_type' property of an event.
+            sig do
+              params(
+                in_values: T::Array[String],
+                not_in_values: T::Array[String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # 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.
+              in_values: nil,
+              # 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.
+              not_in_values: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                { in_values: T::Array[String], not_in_values: T::Array[String] }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class PropertyFilter < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::BillableMetricRetrieveResponse::Data::PropertyFilter,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            # The name of the event property.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # 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.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :exists
+
+            sig { params(exists: T::Boolean).void }
+            attr_writer :exists
+
+            # 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.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :in_values
+
+            sig { params(in_values: T::Array[String]).void }
+            attr_writer :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.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :not_in_values
+
+            sig { params(not_in_values: T::Array[String]).void }
+            attr_writer :not_in_values
+
+            sig do
+              params(
+                name: String,
+                exists: T::Boolean,
+                in_values: T::Array[String],
+                not_in_values: T::Array[String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The name of the event property.
+              name:,
+              # 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.
+              exists: nil,
+              # 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.
+              in_values: nil,
+              # 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.
+              not_in_values: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  name: String,
+                  exists: T::Boolean,
+                  in_values: T::Array[String],
+                  not_in_values: T::Array[String]
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end