metronome-sdk 2.2.0 → 3.0.0

data/rbi/metronome_sdk/models/v1/customers/invoice.rbi

@@ -238,6 +238,17 @@ module MetronomeSDK
           end
           attr_writer :reseller_royalty
 
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice
+                ]
+              )
+            )
+          end
+          attr_accessor :revenue_system_invoices
+
           # This field's availability is dependent on your client's configuration.
           sig { returns(T.nilable(String)) }
           attr_reader :salesforce_opportunity_id
@@ -301,6 +312,12 @@ module MetronomeSDK
               plan_name: String,
               reseller_royalty:
                 MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty::OrHash,
+              revenue_system_invoices:
+                T.nilable(
+                  T::Array[
+                    MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice::OrHash
+                  ]
+                ),
               salesforce_opportunity_id: String,
               start_timestamp: Time,
               subtotal: Float
@@ -348,6 +365,7 @@ module MetronomeSDK
             plan_name: nil,
             # Only present for contract invoices with reseller royalties.
             reseller_royalty: nil,
+            revenue_system_invoices: nil,
             # This field's availability is dependent on your client's configuration.
             salesforce_opportunity_id: nil,
             # Beginning of the usage period this invoice covers (UTC)
@@ -398,6 +416,12 @@ module MetronomeSDK
                 plan_name: String,
                 reseller_royalty:
                   MetronomeSDK::V1::Customers::Invoice::ResellerRoyalty,
+                revenue_system_invoices:
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice
+                    ]
+                  ),
                 salesforce_opportunity_id: String,
                 start_timestamp: Time,
                 subtotal: Float
@@ -2705,6 +2729,71 @@ module MetronomeSDK
               end
             end
           end
+
+          class RevenueSystemInvoice < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Customers::Invoice::RevenueSystemInvoice,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :revenue_system_external_entity_type
+
+            sig { returns(String) }
+            attr_accessor :revenue_system_provider
+
+            sig { returns(String) }
+            attr_accessor :sync_status
+
+            # The error message from the revenue system, if available.
+            sig { returns(T.nilable(String)) }
+            attr_reader :error_message
+
+            sig { params(error_message: String).void }
+            attr_writer :error_message
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :revenue_system_external_entity_id
+
+            sig { params(revenue_system_external_entity_id: String).void }
+            attr_writer :revenue_system_external_entity_id
+
+            sig do
+              params(
+                revenue_system_external_entity_type: String,
+                revenue_system_provider: String,
+                sync_status: String,
+                error_message: String,
+                revenue_system_external_entity_id: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              revenue_system_external_entity_type:,
+              revenue_system_provider:,
+              sync_status:,
+              # The error message from the revenue system, if available.
+              error_message: nil,
+              revenue_system_external_entity_id: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  revenue_system_external_entity_type: String,
+                  revenue_system_provider: String,
+                  sync_status: String,
+                  error_message: String,
+                  revenue_system_external_entity_id: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

data/rbi/metronome_sdk/models/v1/payment.rbi

@@ -72,6 +72,21 @@ module MetronomeSDK
         end
         attr_writer :payment_gateway
 
+        sig do
+          returns(
+            T.nilable(T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment])
+          )
+        end
+        attr_reader :revenue_system_payments
+
+        sig do
+          params(
+            revenue_system_payments:
+              T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment::OrHash]
+          ).void
+        end
+        attr_writer :revenue_system_payments
+
         sig do
           returns(T.nilable(MetronomeSDK::V1::PaymentStatus::TaggedSymbol))
         end
@@ -98,6 +113,8 @@ module MetronomeSDK
             fiat_credit_type: MetronomeSDK::CreditTypeData::OrHash,
             invoice_id: String,
             payment_gateway: MetronomeSDK::V1::Payment::PaymentGateway::OrHash,
+            revenue_system_payments:
+              T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment::OrHash],
             status: MetronomeSDK::V1::PaymentStatus::OrSymbol,
             updated_at: Time
           ).returns(T.attached_class)
@@ -113,6 +130,7 @@ module MetronomeSDK
           fiat_credit_type: nil,
           invoice_id: nil,
           payment_gateway: nil,
+          revenue_system_payments: nil,
           status: nil,
           updated_at: nil
         )
@@ -131,6 +149,8 @@ module MetronomeSDK
               fiat_credit_type: MetronomeSDK::CreditTypeData,
               invoice_id: String,
               payment_gateway: MetronomeSDK::V1::Payment::PaymentGateway,
+              revenue_system_payments:
+                T::Array[MetronomeSDK::V1::Payment::RevenueSystemPayment],
               status: MetronomeSDK::V1::PaymentStatus::TaggedSymbol,
               updated_at: Time
             }
@@ -318,6 +338,65 @@ module MetronomeSDK
             end
           end
         end
+
+        class RevenueSystemPayment < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::Payment::RevenueSystemPayment,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :revenue_system_provider
+
+          sig { returns(String) }
+          attr_accessor :sync_status
+
+          # The error message from the revenue system, if available.
+          sig { returns(T.nilable(String)) }
+          attr_reader :error_message
+
+          sig { params(error_message: String).void }
+          attr_writer :error_message
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :revenue_system_external_payment_id
+
+          sig { params(revenue_system_external_payment_id: String).void }
+          attr_writer :revenue_system_external_payment_id
+
+          sig do
+            params(
+              revenue_system_provider: String,
+              sync_status: String,
+              error_message: String,
+              revenue_system_external_payment_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            revenue_system_provider:,
+            sync_status:,
+            # The error message from the revenue system, if available.
+            error_message: nil,
+            revenue_system_external_payment_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                revenue_system_provider: String,
+                sync_status: String,
+                error_message: String,
+                revenue_system_external_payment_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

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

@@ -69,7 +69,6 @@ module MetronomeSDK
                 pricing_group_values: T::Hash[Symbol, String],
                 quantity: Float,
                 tiers: T::Array[MetronomeSDK::Tier::OrHash],
-                use_list_prices: T::Boolean,
                 request_options: MetronomeSDK::RequestOptions::OrHash
               ).returns(
                 MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse
@@ -113,10 +112,6 @@ module MetronomeSDK
               quantity: nil,
               # Only set for TIERED rate_type.
               tiers: nil,
-              # Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-              # using list prices rather than the standard rates for this product on the
-              # contract.
-              use_list_prices: nil,
               request_options: {}
             )
             end

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

@@ -209,7 +209,7 @@ module MetronomeSDK
             limit: nil,
             # Query param: Cursor that indicates where the next page of results should start.
             next_page: nil,
-            # Body param:
+            # Body param
             body: nil,
             request_options: {}
           )

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

@@ -24,20 +24,20 @@ module MetronomeSDK
             ).void
           end
           def create(
-            # Path param:
+            # Path param
             customer_id:,
             # Path param: The billing provider (e.g. stripe)
             billing_provider_type:,
             # Body param: The customer ID in the billing provider's system. For Azure, this is
             # the subscription ID.
             billing_provider_customer_id:,
-            # Body param:
+            # Body param
             aws_customer_account_id: nil,
-            # Body param:
+            # Body param
             aws_customer_id: nil,
-            # Body param:
+            # Body param
             aws_product_code: nil,
-            # Body param:
+            # Body param
             aws_region: nil,
             # Body param: The collection method for the customer's invoices. NOTE:
             # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.

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

@@ -56,9 +56,9 @@ module MetronomeSDK
             )
           end
           def retrieve(
-            # Path param:
+            # Path param
             customer_id:,
-            # Path param:
+            # Path param
             invoice_id:,
             # Query param: If set, all zero quantity line items will be filtered out of the
             # response
@@ -133,7 +133,7 @@ module MetronomeSDK
             )
           end
           def list(
-            # Path param:
+            # Path param
             customer_id:,
             # Query param: Only return invoices for the specified credit type
             credit_type_id: nil,
@@ -176,7 +176,7 @@ module MetronomeSDK
             )
           end
           def add_charge(
-            # Path param:
+            # Path param
             customer_id:,
             # Body param: The Metronome ID of the charge to add to the invoice. Note that the
             # charge must be on a product that is not on the current plan, and the product
@@ -184,14 +184,14 @@ module MetronomeSDK
             charge_id:,
             # Body param: The Metronome ID of the customer plan to add the charge to.
             customer_plan_id:,
-            # Body param:
+            # Body param
             description:,
             # Body param: The start_timestamp of the invoice to add the charge to.
             invoice_start_timestamp:,
             # Body param: The price of the charge. This price will match the currency on the
             # invoice, e.g. USD cents.
             price:,
-            # Body param:
+            # Body param
             quantity:,
             request_options: {}
           )
@@ -257,7 +257,7 @@ module MetronomeSDK
             )
           end
           def list_breakdowns(
-            # Path param:
+            # Path param
             customer_id:,
             # Query param: RFC 3339 timestamp. Breakdowns will only be returned for time
             # windows that end on or before this time.

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

@@ -20,7 +20,7 @@ module MetronomeSDK
             )
           end
           def list(
-            # Path param:
+            # Path param
             customer_id:,
             # Query param: Max number of results that should be returned
             limit: nil,
@@ -55,9 +55,9 @@ module MetronomeSDK
             ).returns(MetronomeSDK::Models::V1::Customers::PlanAddResponse)
           end
           def add(
-            # Path param:
+            # Path param
             customer_id:,
-            # Body param:
+            # Body param
             plan_id:,
             # Body param: RFC 3339 timestamp for when the plan becomes active for this
             # customer. Must be at 0:00 UTC (midnight).
@@ -97,7 +97,7 @@ module MetronomeSDK
             ).returns(MetronomeSDK::Models::V1::Customers::PlanEndResponse)
           end
           def end_(
-            # Path param:
+            # Path param
             customer_id:,
             # Path param: the ID of a customer-plan relationship
             customer_plan_id:,
@@ -135,7 +135,7 @@ module MetronomeSDK
             )
           end
           def list_price_adjustments(
-            # Path param:
+            # Path param
             customer_id:,
             # Path param: the ID of a customer-plan relationship
             customer_plan_id:,

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

@@ -190,7 +190,7 @@ module MetronomeSDK
           )
         end
         def list_billable_metrics(
-          # Path param:
+          # Path param
           customer_id:,
           # Query param: If true, the list of returned metrics will include archived metrics
           include_archived: nil,
@@ -224,7 +224,7 @@ module MetronomeSDK
           )
         end
         def list_costs(
-          # Path param:
+          # Path param
           customer_id:,
           # Query param: RFC 3339 timestamp (exclusive)
           ending_before:,
@@ -256,7 +256,7 @@ module MetronomeSDK
           ).returns(MetronomeSDK::Models::V1::CustomerPreviewEventsResponse)
         end
         def preview_events(
-          # Path param:
+          # Path param
           customer_id:,
           # Body param: Array of usage events to include in the preview calculation. Must
           # contain at least one event in `merge` mode.
@@ -368,9 +368,9 @@ module MetronomeSDK
           ).void
         end
         def set_ingest_aliases(
-          # Path param:
+          # Path param
           customer_id:,
-          # Body param:
+          # Body param
           ingest_aliases:,
           request_options: {}
         )
@@ -389,7 +389,7 @@ module MetronomeSDK
           ).returns(MetronomeSDK::Models::V1::CustomerSetNameResponse)
         end
         def set_name(
-          # Path param:
+          # Path param
           customer_id:,
           # Body param: The new name for the customer. This will be truncated to 160
           # characters if the provided name is longer.
@@ -411,7 +411,7 @@ module MetronomeSDK
           ).void
         end
         def update_config(
-          # Path param:
+          # Path param
           customer_id:,
           # Body param: Leave in draft or set to auto-advance on invoices sent to Stripe.
           # Falls back to the client-level config if unset, which defaults to true if unset.

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

@@ -52,7 +52,7 @@ module MetronomeSDK
           )
         end
         def list_charges(
-          # Path param:
+          # Path param
           plan_id:,
           # Query param: Max number of results that should be returned
           limit: nil,
@@ -79,7 +79,7 @@ module MetronomeSDK
           )
         end
         def list_customers(
-          # Path param:
+          # Path param
           plan_id:,
           # Query param: Max number of results that should be returned
           limit: nil,

data/rbi/metronome_sdk/resources/v1/usage.rbi

@@ -57,9 +57,9 @@ module MetronomeSDK
           )
         end
         def list(
-          # Body param:
+          # Body param
           ending_before:,
-          # Body param:
+          # Body param
           starting_on:,
           # Body param: A window_size of "day" or "hour" will return the usage for the
           # specified period segmented into daily or hourly aggregates. A window_size of
@@ -228,9 +228,9 @@ module MetronomeSDK
           )
         end
         def list_with_groups(
-          # Body param:
+          # Body param
           billable_metric_id:,
-          # Body param:
+          # Body param
           customer_id:,
           # Body param: A window_size of "day" or "hour" will return the usage for the
           # specified period segmented into daily or hourly aggregates. A window_size of
@@ -245,11 +245,11 @@ module MetronomeSDK
           # return an error if the customer is currently uncontracted or starting_on and
           # ending_before are specified when this is true.
           current_period: nil,
-          # Body param:
+          # Body param
           ending_before: nil,
-          # Body param:
+          # Body param
           group_by: nil,
-          # Body param:
+          # Body param
           starting_on: nil,
           request_options: {}
         )

data/sig/metronome_sdk/models/commit.rbs

@@ -24,10 +24,12 @@ module MetronomeSDK
         netsuite_sales_order_id: String,
         priority: Float,
         rate_type: MetronomeSDK::Models::Commit::rate_type,
+        recurring_commit_id: String,
         rolled_over_from: MetronomeSDK::Commit::RolledOverFrom,
         rollover_fraction: Float,
         salesforce_opportunity_id: String,
         specifiers: ::Array[MetronomeSDK::CommitSpecifier],
+        subscription_config: MetronomeSDK::Commit::SubscriptionConfig,
         uniqueness_key: String
       }
 
@@ -126,6 +128,10 @@ module MetronomeSDK
         MetronomeSDK::Models::Commit::rate_type
       ) -> MetronomeSDK::Models::Commit::rate_type
 
+      attr_reader recurring_commit_id: String?
+
+      def recurring_commit_id=: (String) -> String
+
       attr_reader rolled_over_from: MetronomeSDK::Commit::RolledOverFrom?
 
       def rolled_over_from=: (
@@ -146,6 +152,12 @@ module MetronomeSDK
         ::Array[MetronomeSDK::CommitSpecifier]
       ) -> ::Array[MetronomeSDK::CommitSpecifier]
 
+      attr_reader subscription_config: MetronomeSDK::Commit::SubscriptionConfig?
+
+      def subscription_config=: (
+        MetronomeSDK::Commit::SubscriptionConfig
+      ) -> MetronomeSDK::Commit::SubscriptionConfig
+
       attr_reader uniqueness_key: String?
 
       def uniqueness_key=: (String) -> String
@@ -173,10 +185,12 @@ module MetronomeSDK
         ?netsuite_sales_order_id: String,
         ?priority: Float,
         ?rate_type: MetronomeSDK::Models::Commit::rate_type,
+        ?recurring_commit_id: String,
         ?rolled_over_from: MetronomeSDK::Commit::RolledOverFrom,
         ?rollover_fraction: Float,
         ?salesforce_opportunity_id: String,
         ?specifiers: ::Array[MetronomeSDK::CommitSpecifier],
+        ?subscription_config: MetronomeSDK::Commit::SubscriptionConfig,
         ?uniqueness_key: String
       ) -> void
 
@@ -203,10 +217,12 @@ module MetronomeSDK
         netsuite_sales_order_id: String,
         priority: Float,
         rate_type: MetronomeSDK::Models::Commit::rate_type,
+        recurring_commit_id: String,
         rolled_over_from: MetronomeSDK::Commit::RolledOverFrom,
         rollover_fraction: Float,
         salesforce_opportunity_id: String,
         specifiers: ::Array[MetronomeSDK::CommitSpecifier],
+        subscription_config: MetronomeSDK::Commit::SubscriptionConfig,
         uniqueness_key: String
       }
 
@@ -940,6 +956,64 @@ module MetronomeSDK
 
         def to_hash: -> { commit_id: String, contract_id: String }
       end
+
+      type subscription_config =
+        {
+          allocation: MetronomeSDK::Models::Commit::SubscriptionConfig::allocation,
+          apply_seat_increase_config: MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig,
+          subscription_id: String
+        }
+
+      class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+        attr_reader allocation: MetronomeSDK::Models::Commit::SubscriptionConfig::allocation?
+
+        def allocation=: (
+          MetronomeSDK::Models::Commit::SubscriptionConfig::allocation
+        ) -> MetronomeSDK::Models::Commit::SubscriptionConfig::allocation
+
+        attr_reader apply_seat_increase_config: MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig?
+
+        def apply_seat_increase_config=: (
+          MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig
+        ) -> MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig
+
+        attr_reader subscription_id: String?
+
+        def subscription_id=: (String) -> String
+
+        def initialize: (
+          ?allocation: MetronomeSDK::Models::Commit::SubscriptionConfig::allocation,
+          ?apply_seat_increase_config: MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig,
+          ?subscription_id: String
+        ) -> void
+
+        def to_hash: -> {
+          allocation: MetronomeSDK::Models::Commit::SubscriptionConfig::allocation,
+          apply_seat_increase_config: MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig,
+          subscription_id: String
+        }
+
+        type allocation = :INDIVIDUAL | :POOLED
+
+        module Allocation
+          extend MetronomeSDK::Internal::Type::Enum
+
+          INDIVIDUAL: :INDIVIDUAL
+          POOLED: :POOLED
+
+          def self?.values: -> ::Array[MetronomeSDK::Models::Commit::SubscriptionConfig::allocation]
+        end
+
+        type apply_seat_increase_config = { is_prorated: bool }
+
+        class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+          attr_accessor is_prorated: bool
+
+          def initialize: (is_prorated: bool) -> void
+
+          def to_hash: -> { is_prorated: bool }
+        end
+      end
     end
   end
 end

data/sig/metronome_sdk/models/contract_v2.rbs

@@ -292,6 +292,7 @@ module MetronomeSDK
           netsuite_sales_order_id: String,
           priority: Float,
           rate_type: MetronomeSDK::Models::ContractV2::Commit::rate_type,
+          recurring_commit_id: String,
           rolled_over_from: MetronomeSDK::ContractV2::Commit::RolledOverFrom,
           rollover_fraction: Float,
           salesforce_opportunity_id: String,
@@ -390,6 +391,10 @@ module MetronomeSDK
           MetronomeSDK::Models::ContractV2::Commit::rate_type
         ) -> MetronomeSDK::Models::ContractV2::Commit::rate_type
 
+        attr_reader recurring_commit_id: String?
+
+        def recurring_commit_id=: (String) -> String
+
         attr_reader rolled_over_from: MetronomeSDK::ContractV2::Commit::RolledOverFrom?
 
         def rolled_over_from=: (
@@ -438,6 +443,7 @@ module MetronomeSDK
           ?netsuite_sales_order_id: String,
           ?priority: Float,
           ?rate_type: MetronomeSDK::Models::ContractV2::Commit::rate_type,
+          ?recurring_commit_id: String,
           ?rolled_over_from: MetronomeSDK::ContractV2::Commit::RolledOverFrom,
           ?rollover_fraction: Float,
           ?salesforce_opportunity_id: String,
@@ -467,6 +473,7 @@ module MetronomeSDK
           netsuite_sales_order_id: String,
           priority: Float,
           rate_type: MetronomeSDK::Models::ContractV2::Commit::rate_type,
+          recurring_commit_id: String,
           rolled_over_from: MetronomeSDK::ContractV2::Commit::RolledOverFrom,
           rollover_fraction: Float,
           salesforce_opportunity_id: String,
@@ -1650,6 +1657,7 @@ module MetronomeSDK
           name: String,
           netsuite_sales_order_id: String,
           priority: Float,
+          recurring_credit_id: String,
           salesforce_opportunity_id: String,
           specifiers: ::Array[MetronomeSDK::CommitSpecifier],
           subscription_config: MetronomeSDK::RecurringCommitSubscriptionConfig
@@ -1726,6 +1734,10 @@ module MetronomeSDK
 
         def priority=: (Float) -> Float
 
+        attr_reader recurring_credit_id: String?
+
+        def recurring_credit_id=: (String) -> String
+
         attr_reader salesforce_opportunity_id: String?
 
         def salesforce_opportunity_id=: (String) -> String
@@ -1760,6 +1772,7 @@ module MetronomeSDK
           ?name: String,
           ?netsuite_sales_order_id: String,
           ?priority: Float,
+          ?recurring_credit_id: String,
           ?salesforce_opportunity_id: String,
           ?specifiers: ::Array[MetronomeSDK::CommitSpecifier],
           ?subscription_config: MetronomeSDK::RecurringCommitSubscriptionConfig
@@ -1783,6 +1796,7 @@ module MetronomeSDK
           name: String,
           netsuite_sales_order_id: String,
           priority: Float,
+          recurring_credit_id: String,
           salesforce_opportunity_id: String,
           specifiers: ::Array[MetronomeSDK::CommitSpecifier],
           subscription_config: MetronomeSDK::RecurringCommitSubscriptionConfig