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

data/rbi/metronome_sdk/models.rbi

@@ -0,0 +1,7 @@
+# typed: strong
+
+module MetronomeSDK
+  V1 = MetronomeSDK::Models::V1
+
+  V2 = MetronomeSDK::Models::V2
+end

data/rbi/metronome_sdk/request_options.rbi

@@ -1,17 +1,21 @@
 # typed: strong
 
 module MetronomeSDK
-  RequestOpts = T.type_alias { T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash) }
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
   # or override those provided at the client level.
   #
   # When making a request, you can pass an actual {RequestOptions} instance, or
   # simply pass a Hash with symbol keys matching the attributes on this class.
   class RequestOptions < MetronomeSDK::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+      end
+
     # @api private
-    sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void }
-    def self.validate!(opts); end
+    sig { params(opts: MetronomeSDK::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
 
     # Idempotency key to send with request and all associated retries. Will only be
     # sent for write requests.
@@ -20,7 +24,11 @@ module MetronomeSDK
 
     # Extra query params to send with the request. These are `.merge`’d into any
     # `query` given at the client level.
-    sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) }
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
     attr_accessor :extra_query
 
     # Extra headers to send with the request. These are `.merged`’d into any
@@ -42,7 +50,10 @@ module MetronomeSDK
     attr_accessor :timeout
 
     # Returns a new instance of RequestOptions.
-    sig { params(values: MetronomeSDK::Internal::AnyHash).returns(T.attached_class) }
-    def self.new(values = {}); end
+    sig do
+      params(values: MetronomeSDK::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
   end
 end

data/rbi/metronome_sdk/resources/v1/alerts.rbi

@@ -7,22 +7,26 @@ module MetronomeSDK
         # Create a new alert
         sig do
           params(
-            alert_type: MetronomeSDK::Models::V1::AlertCreateParams::AlertType::OrSymbol,
+            alert_type:
+              MetronomeSDK::V1::AlertCreateParams::AlertType::OrSymbol,
             name: String,
             threshold: Float,
             billable_metric_id: String,
             credit_grant_type_filters: T::Array[String],
             credit_type_id: String,
-            custom_field_filters: T::Array[T.any(MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter, MetronomeSDK::Internal::AnyHash)],
+            custom_field_filters:
+              T::Array[
+                MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter::OrHash
+              ],
             customer_id: String,
             evaluate_on_create: T::Boolean,
-            group_key_filter: T.any(MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter, MetronomeSDK::Internal::AnyHash),
+            group_key_filter:
+              MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter::OrHash,
             invoice_types_filter: T::Array[String],
             plan_id: String,
             uniqueness_key: String,
-            request_options: MetronomeSDK::RequestOpts
-          )
-            .returns(MetronomeSDK::Models::V1::AlertCreateResponse)
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::AlertCreateResponse)
         end
         def create(
           # Type of the alert
@@ -44,7 +48,7 @@ module MetronomeSDK
           # Only present for contract invoices.
           custom_field_filters: nil,
           # 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`.
           customer_id: nil,
           # If true, the alert will evaluate immediately on customers that already meet the
           # alert threshold. If false, it will only evaluate on future customers that
@@ -57,18 +61,23 @@ module MetronomeSDK
           # evaluate.
           invoice_types_filter: nil,
           # 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`.
           plan_id: nil,
           # Prevents the creation of duplicates. If a request to create a record is made
           # with a previously used uniqueness key, a new record will not be created and the
           # request will fail with a 409 error.
           uniqueness_key: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Archive an existing alert
         sig do
-          params(id: String, release_uniqueness_key: T::Boolean, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::AlertArchiveResponse)
+          params(
+            id: String,
+            release_uniqueness_key: T::Boolean,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::AlertArchiveResponse)
         end
         def archive(
           # The Metronome ID of the alert
@@ -76,10 +85,13 @@ module MetronomeSDK
           # If true, resets the uniqueness key on this alert so it can be re-used
           release_uniqueness_key: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/metronome_sdk/resources/v1/audit_logs.rbi

@@ -15,11 +15,14 @@ module MetronomeSDK
             next_page: String,
             resource_id: String,
             resource_type: String,
-            sort: MetronomeSDK::Models::V1::AuditLogListParams::Sort::OrSymbol,
+            sort: MetronomeSDK::V1::AuditLogListParams::Sort::OrSymbol,
             starting_on: Time,
-            request_options: MetronomeSDK::RequestOpts
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::AuditLogListResponse
+            ]
           )
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::AuditLogListResponse])
         end
         def list(
           # RFC 3339 timestamp (exclusive). Cannot be used with 'next_page'.
@@ -40,10 +43,13 @@ module MetronomeSDK
           # 'next_page'.
           starting_on: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi

@@ -9,15 +9,19 @@ module MetronomeSDK
           params(
             name: String,
             aggregation_key: String,
-            aggregation_type: MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType::OrSymbol,
+            aggregation_type:
+              MetronomeSDK::V1::BillableMetricCreateParams::AggregationType::OrSymbol,
             custom_fields: T::Hash[Symbol, String],
-            event_type_filter: T.any(MetronomeSDK::Models::EventTypeFilter, MetronomeSDK::Internal::AnyHash),
+            event_type_filter:
+              MetronomeSDK::V1::BillableMetricCreateParams::EventTypeFilter::OrHash,
             group_keys: T::Array[T::Array[String]],
-            property_filters: T::Array[T.any(MetronomeSDK::Models::PropertyFilter, MetronomeSDK::Internal::AnyHash)],
+            property_filters:
+              T::Array[
+                MetronomeSDK::V1::BillableMetricCreateParams::PropertyFilter::OrHash
+              ],
             sql: String,
-            request_options: MetronomeSDK::RequestOpts
-          )
-            .returns(MetronomeSDK::Models::V1::BillableMetricCreateResponse)
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::BillableMetricCreateResponse)
         end
         def create(
           # The display name of the billable metric.
@@ -44,13 +48,18 @@ module MetronomeSDK
           # omitted.
           sql: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Get a billable metric.
         sig do
-          params(billable_metric_id: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::BillableMetricRetrieveResponse)
+          params(
+            billable_metric_id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::BillableMetricRetrieveResponse)
+        end
+        def retrieve(billable_metric_id:, request_options: {})
         end
-        def retrieve(billable_metric_id:, request_options: {}); end
 
         # List all billable metrics.
         sig do
@@ -58,9 +67,12 @@ module MetronomeSDK
             include_archived: T::Boolean,
             limit: Integer,
             next_page: String,
-            request_options: MetronomeSDK::RequestOpts
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::BillableMetricListResponse
+            ]
           )
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::BillableMetricListResponse])
         end
         def list(
           # If true, the list of returned metrics will include archived metrics
@@ -70,17 +82,23 @@ module MetronomeSDK
           # Cursor that indicates where the next page of results should start.
           next_page: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Archive an existing billable metric.
         sig do
-          params(id: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::BillableMetricArchiveResponse)
+          params(
+            id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::BillableMetricArchiveResponse)
+        end
+        def archive(id:, request_options: {})
         end
-        def archive(id:, request_options: {}); end
 
         # @api private
         sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/metronome_sdk/resources/v1/contracts/named_schedules.rbi

@@ -12,9 +12,10 @@ module MetronomeSDK
               rate_card_id: String,
               schedule_name: String,
               covering_date: Time,
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Contracts::NamedScheduleRetrieveResponse
             )
-              .returns(MetronomeSDK::Models::V1::Contracts::NamedScheduleRetrieveResponse)
           end
           def retrieve(
             # ID of the rate card whose named schedule is to be retrieved
@@ -25,7 +26,9 @@ module MetronomeSDK
             # this date). If not provided, all segments will be returned.
             covering_date: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Update a named schedule for the given rate card. This endpoint's availability is
           # dependent on your client's configuration.
           sig do
@@ -35,9 +38,8 @@ module MetronomeSDK
               starting_at: Time,
               value: T.anything,
               ending_before: Time,
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .void
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).void
           end
           def update(
             # ID of the rate card whose named schedule is to be updated
@@ -50,10 +52,13 @@ module MetronomeSDK
             value:,
             ending_before: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # @api private
           sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
-          def self.new(client:); end
+          def self.new(client:)
+          end
         end
       end
     end

data/rbi/metronome_sdk/resources/v1/contracts/products.rbi

@@ -9,7 +9,8 @@ module MetronomeSDK
           sig do
             params(
               name: String,
-              type: MetronomeSDK::Models::V1::Contracts::ProductCreateParams::Type::OrSymbol,
+              type:
+                MetronomeSDK::V1::Contracts::ProductCreateParams::Type::OrSymbol,
               billable_metric_id: String,
               composite_product_ids: T::Array[String],
               composite_tags: T::Array[String],
@@ -19,12 +20,19 @@ module MetronomeSDK
               netsuite_overage_item_id: String,
               presentation_group_key: T::Array[String],
               pricing_group_key: T::Array[String],
-              quantity_conversion: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityConversion, MetronomeSDK::Internal::AnyHash)),
-              quantity_rounding: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityRounding, MetronomeSDK::Internal::AnyHash)),
+              quantity_conversion:
+                T.nilable(
+                  MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityConversion::OrHash
+                ),
+              quantity_rounding:
+                T.nilable(
+                  MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityRounding::OrHash
+                ),
               tags: T::Array[String],
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Contracts::ProductCreateResponse
             )
-              .returns(MetronomeSDK::Models::V1::Contracts::ProductCreateResponse)
           end
           def create(
             # displayed on invoices
@@ -70,13 +78,20 @@ module MetronomeSDK
             quantity_rounding: nil,
             tags: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Get a specific product
           sig do
-            params(id: String, request_options: MetronomeSDK::RequestOpts)
-              .returns(MetronomeSDK::Models::V1::Contracts::ProductRetrieveResponse)
+            params(
+              id: String,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Contracts::ProductRetrieveResponse
+            )
+          end
+          def retrieve(id:, request_options: {})
           end
-          def retrieve(id:, request_options: {}); end
 
           # Update a product
           sig do
@@ -93,12 +108,19 @@ module MetronomeSDK
               netsuite_overage_item_id: String,
               presentation_group_key: T::Array[String],
               pricing_group_key: T::Array[String],
-              quantity_conversion: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityConversion, MetronomeSDK::Internal::AnyHash)),
-              quantity_rounding: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityRounding, MetronomeSDK::Internal::AnyHash)),
+              quantity_conversion:
+                T.nilable(
+                  MetronomeSDK::V1::Contracts::ProductUpdateParams::QuantityConversion::OrHash
+                ),
+              quantity_rounding:
+                T.nilable(
+                  MetronomeSDK::V1::Contracts::ProductUpdateParams::QuantityRounding::OrHash
+                ),
               tags: T::Array[String],
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse
             )
-              .returns(MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse)
           end
           def update(
             # ID of the product to update
@@ -155,39 +177,55 @@ module MetronomeSDK
             # If not provided, defaults to product's current tags
             tags: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # List products
           sig do
             params(
               limit: Integer,
               next_page: String,
-              archive_filter: MetronomeSDK::Models::V1::Contracts::ProductListParams::ArchiveFilter::OrSymbol,
-              request_options: MetronomeSDK::RequestOpts
+              archive_filter:
+                MetronomeSDK::V1::Contracts::ProductListParams::ArchiveFilter::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Internal::CursorPage[
+                MetronomeSDK::Models::V1::Contracts::ProductListResponse
+              ]
             )
-              .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Contracts::ProductListResponse])
           end
           def list(
             # Query param: Max number of results that should be returned
             limit: nil,
             # Query param: Cursor that indicates where the next page of results should start.
             next_page: nil,
-            # Body param: Filter options for the product list
+            # Body param: Filter options for the product list. If not provided, defaults to
+            # not archived.
             archive_filter: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Archive a product
           sig do
-            params(product_id: String, request_options: MetronomeSDK::RequestOpts)
-              .returns(MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse)
+            params(
+              product_id: String,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse
+            )
           end
           def archive(
             # ID of the product to be archived
             product_id:,
             request_options: {}
-          ); end
+          )
+          end
+
           # @api private
           sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
-          def self.new(client:); end
+          def self.new(client:)
+          end
         end
       end
     end

data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbi

@@ -14,9 +14,10 @@ module MetronomeSDK
                 customer_id: String,
                 schedule_name: String,
                 covering_date: Time,
-                request_options: MetronomeSDK::RequestOpts
+                request_options: MetronomeSDK::RequestOptions::OrHash
+              ).returns(
+                MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleRetrieveResponse
               )
-                .returns(MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleRetrieveResponse)
             end
             def retrieve(
               # ID of the contract whose named schedule is to be retrieved
@@ -29,7 +30,9 @@ module MetronomeSDK
               # this date). If not provided, all segments will be returned.
               covering_date: nil,
               request_options: {}
-            ); end
+            )
+            end
+
             # Update a named schedule for the given contract. This endpoint's availability is
             # dependent on your client's configuration.
             sig do
@@ -40,9 +43,8 @@ module MetronomeSDK
                 starting_at: Time,
                 value: T.anything,
                 ending_before: Time,
-                request_options: MetronomeSDK::RequestOpts
-              )
-                .void
+                request_options: MetronomeSDK::RequestOptions::OrHash
+              ).void
             end
             def update(
               # ID of the contract whose named schedule is to be updated
@@ -57,10 +59,15 @@ module MetronomeSDK
               value:,
               ending_before: nil,
               request_options: {}
-            ); end
+            )
+            end
+
             # @api private
-            sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
-            def self.new(client:); end
+            sig do
+              params(client: MetronomeSDK::Client).returns(T.attached_class)
+            end
+            def self.new(client:)
+            end
           end
         end
       end

data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi

@@ -9,41 +9,48 @@ module MetronomeSDK
             # Updates ordering of specified products
             sig do
               params(
-                product_moves: T::Array[
-                  T.any(
-                    MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove,
-                    MetronomeSDK::Internal::AnyHash
-                  )
-                ],
+                product_moves:
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove::OrHash
+                  ],
                 rate_card_id: String,
-                request_options: MetronomeSDK::RequestOpts
+                request_options: MetronomeSDK::RequestOptions::OrHash
+              ).returns(
+                MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateResponse
               )
-                .returns(MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateResponse)
             end
             def update(
               product_moves:,
               # ID of the rate card to update
               rate_card_id:,
               request_options: {}
-            ); end
+            )
+            end
+
             # Sets the ordering of products within a rate card
             sig do
               params(
                 product_order: T::Array[String],
                 rate_card_id: String,
-                request_options: MetronomeSDK::RequestOpts
+                request_options: MetronomeSDK::RequestOptions::OrHash
+              ).returns(
+                MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderSetResponse
               )
-                .returns(MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderSetResponse)
             end
             def set(
               product_order:,
               # ID of the rate card to update
               rate_card_id:,
               request_options: {}
-            ); end
+            )
+            end
+
             # @api private
-            sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
-            def self.new(client:); end
+            sig do
+              params(client: MetronomeSDK::Client).returns(T.attached_class)
+            end
+            def self.new(client:)
+            end
           end
         end
       end