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

data/rbi/metronome_sdk/resources/v1/customers/plans.rbi

@@ -11,9 +11,12 @@ module MetronomeSDK
               customer_id: String,
               limit: Integer,
               next_page: String,
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Internal::CursorPage[
+                MetronomeSDK::Models::V1::Customers::PlanListResponse
+              ]
             )
-              .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Customers::PlanListResponse])
           end
           def list(
             # Path param:
@@ -23,7 +26,9 @@ module MetronomeSDK
             # Query param: Cursor that indicates where the next page of results should start.
             next_page: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Associate an existing customer with a plan for a specified date range. See the
           # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
           # for details on the price adjustments.
@@ -34,22 +39,18 @@ module MetronomeSDK
               starting_on: Time,
               ending_before: Time,
               net_payment_terms_days: Float,
-              overage_rate_adjustments: T::Array[
-                T.any(
-                  MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              ],
-              price_adjustments: T::Array[
-                T.any(
-                  MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              ],
-              trial_spec: T.any(MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec, MetronomeSDK::Internal::AnyHash),
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .returns(MetronomeSDK::Models::V1::Customers::PlanAddResponse)
+              overage_rate_adjustments:
+                T::Array[
+                  MetronomeSDK::V1::Customers::PlanAddParams::OverageRateAdjustment::OrHash
+                ],
+              price_adjustments:
+                T::Array[
+                  MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment::OrHash
+                ],
+              trial_spec:
+                MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec::OrHash,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(MetronomeSDK::Models::V1::Customers::PlanAddResponse)
           end
           def add(
             # Path param:
@@ -78,7 +79,9 @@ module MetronomeSDK
             # for details.
             trial_spec: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Change the end date of a customer's plan.
           sig do
             params(
@@ -87,9 +90,8 @@ module MetronomeSDK
               ending_before: Time,
               void_invoices: T::Boolean,
               void_stripe_invoices: T::Boolean,
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .returns(MetronomeSDK::Models::V1::Customers::PlanEndResponse)
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(MetronomeSDK::Models::V1::Customers::PlanEndResponse)
           end
           def end_(
             # Path param:
@@ -109,7 +111,9 @@ module MetronomeSDK
             # still in draft state.
             void_stripe_invoices: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Lists a customer plans adjustments. See the
           # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
           # for details.
@@ -119,11 +123,12 @@ module MetronomeSDK
               customer_plan_id: String,
               limit: Integer,
               next_page: String,
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Internal::CursorPage[
+                MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse
+              ]
             )
-              .returns(
-                MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse]
-              )
           end
           def list_price_adjustments(
             # Path param:
@@ -135,10 +140,13 @@ module MetronomeSDK
             # Query param: Cursor that indicates where the next page of results should start.
             next_page: 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/customers.rbi

@@ -29,19 +29,17 @@ module MetronomeSDK
         sig do
           params(
             name: String,
-            billing_config: T.any(MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig, MetronomeSDK::Internal::AnyHash),
+            billing_config:
+              MetronomeSDK::V1::CustomerCreateParams::BillingConfig::OrHash,
             custom_fields: T::Hash[Symbol, String],
-            customer_billing_provider_configurations: T::Array[
-              T.any(
-                MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration,
-                MetronomeSDK::Internal::AnyHash
-              )
-            ],
+            customer_billing_provider_configurations:
+              T::Array[
+                MetronomeSDK::V1::CustomerCreateParams::CustomerBillingProviderConfiguration::OrHash
+              ],
             external_id: String,
             ingest_aliases: T::Array[String],
-            request_options: MetronomeSDK::RequestOpts
-          )
-            .returns(MetronomeSDK::Models::V1::CustomerCreateResponse)
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::CustomerCreateResponse)
         end
         def create(
           # This will be truncated to 160 characters if the provided name is longer.
@@ -55,13 +53,18 @@ module MetronomeSDK
           # Aliases that can be used to refer to this customer in usage events
           ingest_aliases: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Get a customer by Metronome ID.
         sig do
-          params(customer_id: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::CustomerRetrieveResponse)
+          params(
+            customer_id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::CustomerRetrieveResponse)
+        end
+        def retrieve(customer_id:, request_options: {})
         end
-        def retrieve(customer_id:, request_options: {}); end
 
         # List all customers.
         sig do
@@ -72,9 +75,12 @@ module MetronomeSDK
             next_page: String,
             only_archived: T::Boolean,
             salesforce_account_ids: T::Array[String],
-            request_options: MetronomeSDK::RequestOpts
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::CustomerListResponse
+            ]
           )
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::CustomerDetail])
         end
         def list(
           # Filter the customer list by customer_id. Up to 100 ids can be provided.
@@ -92,13 +98,19 @@ module MetronomeSDK
           # provided.
           salesforce_account_ids: nil,
           request_options: {}
-        ); end
-        # Archive a customer
+        )
+        end
+
+        # Archive a customer Note: any alerts associated with the customer will not be
+        # triggered.
         sig do
-          params(id: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::CustomerArchiveResponse)
+          params(
+            id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::CustomerArchiveResponse)
+        end
+        def archive(id:, request_options: {})
         end
-        def archive(id:, request_options: {}); end
 
         # Get all billable metrics for a given customer.
         sig do
@@ -108,9 +120,12 @@ module MetronomeSDK
             limit: Integer,
             next_page: String,
             on_current_plan: T::Boolean,
-            request_options: MetronomeSDK::RequestOpts
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse
+            ]
           )
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse])
         end
         def list_billable_metrics(
           # Path param:
@@ -125,7 +140,9 @@ module MetronomeSDK
           # on the customer's current plan
           on_current_plan: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Fetch daily pending costs for the specified customer, broken down by credit type
         # and line items. Note: this is not supported for customers whose plan includes a
         # UNIQUE-type billable metric.
@@ -136,9 +153,12 @@ module MetronomeSDK
             starting_on: Time,
             limit: Integer,
             next_page: String,
-            request_options: MetronomeSDK::RequestOpts
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::CustomerListCostsResponse
+            ]
           )
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::CustomerListCostsResponse])
         end
         def list_costs(
           # Path param:
@@ -152,7 +172,9 @@ module MetronomeSDK
           # Query param: Cursor that indicates where the next page of results should start.
           next_page: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Sets the ingest aliases for a customer. Ingest aliases can be used in the
         # `customer_id` field when sending usage events to Metronome. This call is
         # idempotent. It fully replaces the set of ingest aliases for the given customer.
@@ -160,9 +182,8 @@ module MetronomeSDK
           params(
             customer_id: String,
             ingest_aliases: T::Array[String],
-            request_options: MetronomeSDK::RequestOpts
-          )
-            .void
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).void
         end
         def set_ingest_aliases(
           # Path param:
@@ -170,11 +191,16 @@ module MetronomeSDK
           # Body param:
           ingest_aliases:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Updates the specified customer's name.
         sig do
-          params(customer_id: String, name: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::CustomerSetNameResponse)
+          params(
+            customer_id: String,
+            name: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::CustomerSetNameResponse)
         end
         def set_name(
           # Path param:
@@ -183,16 +209,17 @@ module MetronomeSDK
           # characters if the provided name is longer.
           name:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Updates the specified customer's config.
         sig do
           params(
             customer_id: String,
             leave_stripe_invoices_in_draft: T.nilable(T::Boolean),
             salesforce_account_id: T.nilable(String),
-            request_options: MetronomeSDK::RequestOpts
-          )
-            .void
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).void
         end
         def update_config(
           # Path param:
@@ -203,10 +230,13 @@ module MetronomeSDK
           # Body param: The Salesforce account ID for the customer
           salesforce_account_id: 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/dashboards.rbi

@@ -10,28 +10,22 @@ module MetronomeSDK
         sig do
           params(
             customer_id: String,
-            dashboard: MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::Dashboard::OrSymbol,
-            bm_group_key_overrides: T::Array[
-              T.any(
-                MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride,
-                MetronomeSDK::Internal::AnyHash
-              )
-            ],
-            color_overrides: T::Array[
-              T.any(
-                MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride,
-                MetronomeSDK::Internal::AnyHash
-              )
-            ],
-            dashboard_options: T::Array[
-              T.any(
-                MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption,
-                MetronomeSDK::Internal::AnyHash
-              )
-            ],
-            request_options: MetronomeSDK::RequestOpts
-          )
-            .returns(MetronomeSDK::Models::V1::DashboardGetEmbeddableURLResponse)
+            dashboard:
+              MetronomeSDK::V1::DashboardGetEmbeddableURLParams::Dashboard::OrSymbol,
+            bm_group_key_overrides:
+              T::Array[
+                MetronomeSDK::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride::OrHash
+              ],
+            color_overrides:
+              T::Array[
+                MetronomeSDK::V1::DashboardGetEmbeddableURLParams::ColorOverride::OrHash
+              ],
+            dashboard_options:
+              T::Array[
+                MetronomeSDK::V1::DashboardGetEmbeddableURLParams::DashboardOption::OrHash
+              ],
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::DashboardGetEmbeddableURLResponse)
         end
         def get_embeddable_url(
           customer_id:,
@@ -44,10 +38,13 @@ module MetronomeSDK
           # Optional dashboard specific options
           dashboard_options: 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/invoices.rbi

@@ -6,27 +6,36 @@ module MetronomeSDK
       class Invoices
         # Regenerate a voided contract invoice
         sig do
-          params(id: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::InvoiceRegenerateResponse)
+          params(
+            id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::InvoiceRegenerateResponse)
         end
         def regenerate(
           # The invoice id to regenerate
           id:,
           request_options: {}
-        ); end
+        )
+        end
+
         # Void an invoice
         sig do
-          params(id: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::InvoiceVoidResponse)
+          params(
+            id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::InvoiceVoidResponse)
         end
         def void(
           # The invoice id to void
           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/plans.rbi

@@ -6,8 +6,15 @@ module MetronomeSDK
       class Plans
         # List all available plans.
         sig do
-          params(limit: Integer, next_page: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::PlanListResponse])
+          params(
+            limit: Integer,
+            next_page: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::PlanListResponse
+            ]
+          )
         end
         def list(
           # Max number of results that should be returned
@@ -15,13 +22,18 @@ module MetronomeSDK
           # Cursor that indicates where the next page of results should start.
           next_page: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Fetch high level details of a specific plan.
         sig do
-          params(plan_id: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Models::V1::PlanGetDetailsResponse)
+          params(
+            plan_id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(MetronomeSDK::Models::V1::PlanGetDetailsResponse)
+        end
+        def get_details(plan_id:, request_options: {})
         end
-        def get_details(plan_id:, request_options: {}); end
 
         # Fetches a list of charges of a specific plan.
         sig do
@@ -29,9 +41,12 @@ module MetronomeSDK
             plan_id: String,
             limit: Integer,
             next_page: String,
-            request_options: MetronomeSDK::RequestOpts
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::PlanListChargesResponse
+            ]
           )
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::PlanListChargesResponse])
         end
         def list_charges(
           # Path param:
@@ -41,7 +56,9 @@ module MetronomeSDK
           # Query param: Cursor that indicates where the next page of results should start.
           next_page: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # Fetches a list of customers on a specific plan (by default, only currently
         # active plans are included)
         sig do
@@ -49,10 +66,13 @@ module MetronomeSDK
             plan_id: String,
             limit: Integer,
             next_page: String,
-            status: MetronomeSDK::Models::V1::PlanListCustomersParams::Status::OrSymbol,
-            request_options: MetronomeSDK::RequestOpts
+            status: MetronomeSDK::V1::PlanListCustomersParams::Status::OrSymbol,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::PlanListCustomersResponse
+            ]
           )
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::PlanListCustomersResponse])
         end
         def list_customers(
           # Path param:
@@ -72,10 +92,13 @@ module MetronomeSDK
           # **Note:** `ended,upcoming` combination is not yet supported.
           status: 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/pricing_units.rbi

@@ -6,8 +6,15 @@ module MetronomeSDK
       class PricingUnits
         # List all pricing units (known in the API by the legacy term "credit types").
         sig do
-          params(limit: Integer, next_page: String, request_options: MetronomeSDK::RequestOpts)
-            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::PricingUnitListResponse])
+          params(
+            limit: Integer,
+            next_page: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(
+            MetronomeSDK::Internal::CursorPage[
+              MetronomeSDK::Models::V1::PricingUnitListResponse
+            ]
+          )
         end
         def list(
           # Max number of results that should be returned
@@ -15,10 +22,13 @@ module MetronomeSDK
           # Cursor that indicates where the next page of results should start.
           next_page: 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/services.rbi

@@ -8,12 +8,18 @@ module MetronomeSDK
         # addresses are not necessarily unique between services. In most cases, IP
         # addresses will appear in the list at least 30 days before they are used for the
         # first time.
-        sig { params(request_options: MetronomeSDK::RequestOpts).returns(MetronomeSDK::Models::V1::ServiceListResponse) }
-        def list(request_options: {}); end
+        sig do
+          params(request_options: MetronomeSDK::RequestOptions::OrHash).returns(
+            MetronomeSDK::Models::V1::ServiceListResponse
+          )
+        end
+        def list(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