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

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

@@ -8,25 +8,39 @@ module MetronomeSDK
           # Get the customer alert status and alert information for the specified customer
           # and alert
           sig do
-            params(alert_id: String, customer_id: String, request_options: MetronomeSDK::RequestOpts)
-              .returns(MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse)
+            params(
+              alert_id: String,
+              customer_id: String,
+              plans_or_contracts:
+                MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse
+            )
           end
           def retrieve(
             # The Metronome ID of the alert
             alert_id:,
             # The Metronome ID of the customer
             customer_id:,
+            # When parallel alerts are enabled during migration, this flag denotes whether to
+            # fetch alerts for plans or contracts.
+            plans_or_contracts: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Fetch all customer alert statuses and alert information for a customer
           sig do
             params(
               customer_id: String,
               next_page: String,
-              alert_statuses: T::Array[MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus::OrSymbol],
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .returns(MetronomeSDK::Models::V1::Customers::AlertListResponse)
+              alert_statuses:
+                T::Array[
+                  MetronomeSDK::V1::Customers::AlertListParams::AlertStatus::OrSymbol
+                ],
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(MetronomeSDK::Models::V1::Customers::AlertListResponse)
           end
           def list(
             # Body param: The Metronome ID of the customer
@@ -37,10 +51,16 @@ module MetronomeSDK
             # will be returned.
             alert_statuses: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Reset state for an alert by customer id and force re-evaluation
           sig do
-            params(alert_id: String, customer_id: String, request_options: MetronomeSDK::RequestOpts).void
+            params(
+              alert_id: String,
+              customer_id: String,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).void
           end
           def reset(
             # The Metronome ID of the alert
@@ -48,10 +68,13 @@ module MetronomeSDK
             # The Metronome ID of the customer
             customer_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/customers/billing_config.rbi

@@ -9,14 +9,16 @@ module MetronomeSDK
           sig do
             params(
               customer_id: String,
-              billing_provider_type: MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::BillingProviderType::OrSymbol,
+              billing_provider_type:
+                MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType::OrSymbol,
               billing_provider_customer_id: String,
               aws_product_code: String,
-              aws_region: MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::AwsRegion::OrSymbol,
-              stripe_collection_method: MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::OrSymbol,
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .void
+              aws_region:
+                MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion::OrSymbol,
+              stripe_collection_method:
+                MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).void
           end
           def create(
             # Path param:
@@ -33,41 +35,50 @@ module MetronomeSDK
             # Body param:
             stripe_collection_method: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Fetch the billing configuration for the given customer.
           sig do
             params(
               customer_id: String,
-              billing_provider_type: MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveParams::BillingProviderType::OrSymbol,
-              request_options: MetronomeSDK::RequestOpts
+              billing_provider_type:
+                MetronomeSDK::V1::Customers::BillingConfigRetrieveParams::BillingProviderType::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse
             )
-              .returns(MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse)
           end
           def retrieve(
             customer_id:,
             # The billing provider (e.g. stripe)
             billing_provider_type:,
             request_options: {}
-          ); end
+          )
+          end
+
           # Delete the billing configuration for a given customer. Note: this is unsupported
           # for Azure and AWS Marketplace customers.
           sig do
             params(
               customer_id: String,
-              billing_provider_type: MetronomeSDK::Models::V1::Customers::BillingConfigDeleteParams::BillingProviderType::OrSymbol,
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .void
+              billing_provider_type:
+                MetronomeSDK::V1::Customers::BillingConfigDeleteParams::BillingProviderType::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).void
           end
           def delete(
             customer_id:,
             # The billing provider (e.g. stripe)
             billing_provider_type:,
             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/commits.rbi

@@ -8,32 +8,29 @@ module MetronomeSDK
           # Create a new commit at the customer level.
           sig do
             params(
-              access_schedule: T.any(
-                MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule,
-                MetronomeSDK::Internal::AnyHash
-              ),
+              access_schedule:
+                MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::OrHash,
               customer_id: String,
               priority: Float,
               product_id: String,
-              type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type::OrSymbol,
+              type:
+                MetronomeSDK::V1::Customers::CommitCreateParams::Type::OrSymbol,
               applicable_contract_ids: T::Array[String],
               applicable_product_ids: T::Array[String],
               applicable_product_tags: T::Array[String],
               custom_fields: T::Hash[Symbol, String],
               description: String,
               invoice_contract_id: String,
-              invoice_schedule: T.any(
-                MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule,
-                MetronomeSDK::Internal::AnyHash
-              ),
+              invoice_schedule:
+                MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::OrHash,
               name: String,
               netsuite_sales_order_id: String,
-              rate_type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::RateType::OrSymbol,
+              rate_type:
+                MetronomeSDK::V1::Customers::CommitCreateParams::RateType::OrSymbol,
               salesforce_opportunity_id: String,
               uniqueness_key: String,
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .returns(MetronomeSDK::Models::V1::Customers::CommitCreateResponse)
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(MetronomeSDK::Models::V1::Customers::CommitCreateResponse)
           end
           def create(
             # Schedule for distributing the commit to the customer. For "POSTPAID" commits
@@ -81,7 +78,9 @@ module MetronomeSDK
             # error.
             uniqueness_key: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # List commits.
           sig do
             params(
@@ -95,9 +94,8 @@ module MetronomeSDK
               include_ledgers: T::Boolean,
               next_page: String,
               starting_at: Time,
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .returns(MetronomeSDK::Models::V1::Customers::CommitListResponse)
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(MetronomeSDK::Models::V1::Customers::CommitListResponse)
           end
           def list(
             customer_id:,
@@ -121,7 +119,9 @@ module MetronomeSDK
             # Include only commits that have any access on or after the provided date
             starting_at: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Pull forward the end date of a prepaid commit. Use the "edit a commit" endpoint
           # to extend the end date of a prepaid commit, or to make other edits to the
           # commit.
@@ -131,9 +131,10 @@ module MetronomeSDK
               customer_id: String,
               access_ending_before: Time,
               invoices_ending_before: Time,
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateResponse
             )
-              .returns(MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateResponse)
           end
           def update_end_date(
             # ID of the commit to update. Only supports "PREPAID" commits.
@@ -148,10 +149,13 @@ module MetronomeSDK
             # (exclusive). If not provided, the invoice schedule will not be updated.
             invoices_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/customers/credits.rbi

@@ -8,10 +8,8 @@ module MetronomeSDK
           # Create a new credit at the customer level.
           sig do
             params(
-              access_schedule: T.any(
-                MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule,
-                MetronomeSDK::Internal::AnyHash
-              ),
+              access_schedule:
+                MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::OrHash,
               customer_id: String,
               priority: Float,
               product_id: String,
@@ -22,12 +20,12 @@ module MetronomeSDK
               description: String,
               name: String,
               netsuite_sales_order_id: String,
-              rate_type: MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType::OrSymbol,
+              rate_type:
+                MetronomeSDK::V1::Customers::CreditCreateParams::RateType::OrSymbol,
               salesforce_opportunity_id: String,
               uniqueness_key: String,
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .returns(MetronomeSDK::Models::V1::Customers::CreditCreateResponse)
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(MetronomeSDK::Models::V1::Customers::CreditCreateResponse)
           end
           def create(
             # Schedule for distributing the credit to the customer.
@@ -62,7 +60,9 @@ module MetronomeSDK
             # error.
             uniqueness_key: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # List credits.
           sig do
             params(
@@ -76,9 +76,8 @@ module MetronomeSDK
               include_ledgers: T::Boolean,
               next_page: String,
               starting_at: Time,
-              request_options: MetronomeSDK::RequestOpts
-            )
-              .returns(MetronomeSDK::Models::V1::Customers::CreditListResponse)
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(MetronomeSDK::Models::V1::Customers::CreditListResponse)
           end
           def list(
             customer_id:,
@@ -102,7 +101,9 @@ module MetronomeSDK
             # Include only credits that have any access on or after the provided date
             starting_at: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Pull forward the end date of a credit. Use the "edit a credit" endpoint to
           # extend the end date of a credit, or to make other edits to the credit.
           sig do
@@ -110,9 +111,10 @@ module MetronomeSDK
               access_ending_before: Time,
               credit_id: String,
               customer_id: String,
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse
             )
-              .returns(MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse)
           end
           def update_end_date(
             # RFC 3339 timestamp indicating when access to the credit will end and it will no
@@ -123,10 +125,13 @@ module MetronomeSDK
             # ID of the customer whose credit is to be updated
             customer_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/customers/invoices.rbi

@@ -11,9 +11,10 @@ module MetronomeSDK
               customer_id: String,
               invoice_id: String,
               skip_zero_qty_line_items: T::Boolean,
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Customers::InvoiceRetrieveResponse
             )
-              .returns(MetronomeSDK::Models::V1::Customers::InvoiceRetrieveResponse)
           end
           def retrieve(
             # Path param:
@@ -24,7 +25,9 @@ module MetronomeSDK
             # response
             skip_zero_qty_line_items: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # List all invoices for a given customer, optionally filtered by status, date
           # range, and/or credit type.
           sig do
@@ -35,12 +38,16 @@ module MetronomeSDK
               limit: Integer,
               next_page: String,
               skip_zero_qty_line_items: T::Boolean,
-              sort: MetronomeSDK::Models::V1::Customers::InvoiceListParams::Sort::OrSymbol,
+              sort:
+                MetronomeSDK::V1::Customers::InvoiceListParams::Sort::OrSymbol,
               starting_on: Time,
               status: String,
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Internal::CursorPage[
+                MetronomeSDK::V1::Customers::Invoice
+              ]
             )
-              .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Customers::Invoice])
           end
           def list(
             # Path param:
@@ -66,7 +73,9 @@ module MetronomeSDK
             # Query param: Invoice status, e.g. DRAFT, FINALIZED, or VOID
             status: nil,
             request_options: {}
-          ); end
+          )
+          end
+
           # Add a one time charge to the specified invoice
           sig do
             params(
@@ -77,9 +86,10 @@ module MetronomeSDK
               invoice_start_timestamp: Time,
               price: Float,
               quantity: Float,
-              request_options: MetronomeSDK::RequestOpts
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Models::V1::Customers::InvoiceAddChargeResponse
             )
-              .returns(MetronomeSDK::Models::V1::Customers::InvoiceAddChargeResponse)
           end
           def add_charge(
             # Path param:
@@ -100,7 +110,9 @@ module MetronomeSDK
             # Body param:
             quantity:,
             request_options: {}
-          ); end
+          )
+          end
+
           # List daily or hourly invoice breakdowns for a given customer, optionally
           # filtered by status, date range, and/or credit type. Important considerations:
           #
@@ -115,14 +127,17 @@ module MetronomeSDK
               limit: Integer,
               next_page: String,
               skip_zero_qty_line_items: T::Boolean,
-              sort: MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::Sort::OrSymbol,
+              sort:
+                MetronomeSDK::V1::Customers::InvoiceListBreakdownsParams::Sort::OrSymbol,
               status: String,
-              window_size: MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize::OrSymbol,
-              request_options: MetronomeSDK::RequestOpts
+              window_size:
+                MetronomeSDK::V1::Customers::InvoiceListBreakdownsParams::WindowSize::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions::OrHash
+            ).returns(
+              MetronomeSDK::Internal::CursorPage[
+                MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse
+              ]
             )
-              .returns(
-                MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse]
-              )
           end
           def list_breakdowns(
             # Path param:
@@ -153,10 +168,13 @@ module MetronomeSDK
             # Query param: The granularity of the breakdowns to return. Defaults to day.
             window_size: 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/named_schedules.rbi

@@ -12,9 +12,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::Customers::NamedScheduleRetrieveResponse
             )
-              .returns(MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveResponse)
           end
           def retrieve(
             # ID of the customer 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 customer. 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 customer 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/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