metronome-sdk 0.2.0 → 0.3.0

data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi

@@ -1505,6 +1505,14 @@ module MetronomeSDK
             sig { params(credit_type_id: String).void }
             attr_writer :credit_type_id
 
+            # This field is only applicable to commit invoice schedules. If true, this
+            # schedule will not generate an invoice.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :do_not_invoice
+
+            sig { params(do_not_invoice: T::Boolean).void }
+            attr_writer :do_not_invoice
+
             # Enter the unit price and quantity for the charge or instead only send the
             # amount. If amount is sent, the unit price is assumed to be the amount and
             # quantity is inferred to be 1.
@@ -1554,6 +1562,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -1565,6 +1574,9 @@ module MetronomeSDK
             def self.new(
               # Defaults to USD (cents) if not passed.
               credit_type_id: nil,
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              do_not_invoice: nil,
               # Enter the unit price and quantity for the charge or instead only send the
               # amount. If amount is sent, the unit price is assumed to be the amount and
               # quantity is inferred to be 1.
@@ -1578,6 +1590,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule,
                   schedule_items:
@@ -2108,12 +2121,27 @@ module MetronomeSDK
               sig { params(invoice_metadata: T::Hash[Symbol, String]).void }
               attr_writer :invoice_metadata
 
+              # If true, the payment will be made assuming the customer is present (i.e. on
+              # session).
+              #
+              # If false, the payment will be made assuming the customer is not present (i.e.
+              # off session). For cardholders from a country with an e-mandate requirement (e.g.
+              # India), the payment may be declined.
+              #
+              # If left blank, will default to false.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :on_session_payment
+
+              sig { params(on_session_payment: T::Boolean).void }
+              attr_writer :on_session_payment
+
               # Only applicable if using STRIPE as your payment gateway type.
               sig do
                 params(
                   payment_type:
                     MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol,
-                  invoice_metadata: T::Hash[Symbol, String]
+                  invoice_metadata: T::Hash[Symbol, String],
+                  on_session_payment: T::Boolean
                 ).returns(T.attached_class)
               end
               def self.new(
@@ -2121,7 +2149,16 @@ module MetronomeSDK
                 payment_type:,
                 # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
                 # your payment type.
-                invoice_metadata: nil
+                invoice_metadata: nil,
+                # If true, the payment will be made assuming the customer is present (i.e. on
+                # session).
+                #
+                # If false, the payment will be made assuming the customer is not present (i.e.
+                # off session). For cardholders from a country with an e-mandate requirement (e.g.
+                # India), the payment may be declined.
+                #
+                # If left blank, will default to false.
+                on_session_payment: nil
               )
               end
 
@@ -2130,7 +2167,8 @@ module MetronomeSDK
                   {
                     payment_type:
                       MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol,
-                    invoice_metadata: T::Hash[Symbol, String]
+                    invoice_metadata: T::Hash[Symbol, String],
+                    on_session_payment: T::Boolean
                   }
                 )
               end
@@ -3128,6 +3166,14 @@ module MetronomeSDK
             sig { params(credit_type_id: String).void }
             attr_writer :credit_type_id
 
+            # This field is only applicable to commit invoice schedules. If true, this
+            # schedule will not generate an invoice.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :do_not_invoice
+
+            sig { params(do_not_invoice: T::Boolean).void }
+            attr_writer :do_not_invoice
+
             # Enter the unit price and quantity for the charge or instead only send the
             # amount. If amount is sent, the unit price is assumed to be the amount and
             # quantity is inferred to be 1.
@@ -3174,6 +3220,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -3185,6 +3232,9 @@ module MetronomeSDK
             def self.new(
               # Defaults to USD (cents) if not passed.
               credit_type_id: nil,
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              do_not_invoice: nil,
               # Enter the unit price and quantity for the charge or instead only send the
               # amount. If amount is sent, the unit price is assumed to be the amount and
               # quantity is inferred to be 1.
@@ -3198,6 +3248,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule,
                   schedule_items:
@@ -5367,8 +5418,8 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :unit_price
 
-            # This field is currently required. Upcoming recurring commit/credit configuration
-            # options will allow it to be optional.
+            # This field is required unless a subscription is attached via
+            # `subscription_config`.
             sig { returns(T.nilable(Float)) }
             attr_reader :quantity
 
@@ -5386,8 +5437,8 @@ module MetronomeSDK
             def self.new(
               credit_type_id:,
               unit_price:,
-              # This field is currently required. Upcoming recurring commit/credit configuration
-              # options will allow it to be optional.
+              # This field is required unless a subscription is attached via
+              # `subscription_config`.
               quantity: nil
             )
             end
@@ -6513,8 +6564,8 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :unit_price
 
-            # This field is currently required. Upcoming recurring commit/credit configuration
-            # options will allow it to be optional.
+            # This field is required unless a subscription is attached via
+            # `subscription_config`.
             sig { returns(T.nilable(Float)) }
             attr_reader :quantity
 
@@ -6532,8 +6583,8 @@ module MetronomeSDK
             def self.new(
               credit_type_id:,
               unit_price:,
-              # This field is currently required. Upcoming recurring commit/credit configuration
-              # options will allow it to be optional.
+              # This field is required unless a subscription is attached via
+              # `subscription_config`.
               quantity: nil
             )
             end
@@ -7555,6 +7606,12 @@ module MetronomeSDK
           end
           attr_writer :schedule
 
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :custom_fields
+
+          sig { params(custom_fields: T::Hash[Symbol, String]).void }
+          attr_writer :custom_fields
+
           # displayed on invoices
           sig { returns(T.nilable(String)) }
           attr_reader :name
@@ -7574,6 +7631,7 @@ module MetronomeSDK
               product_id: String,
               schedule:
                 MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::OrHash,
+              custom_fields: T::Hash[Symbol, String],
               name: String,
               netsuite_sales_order_id: String
             ).returns(T.attached_class)
@@ -7582,6 +7640,7 @@ module MetronomeSDK
             product_id:,
             # Must provide either schedule_items or recurring_schedule.
             schedule:,
+            custom_fields: nil,
             # displayed on invoices
             name: nil,
             # This field's availability is dependent on your client's configuration.
@@ -7595,6 +7654,7 @@ module MetronomeSDK
                 product_id: String,
                 schedule:
                   MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule,
+                custom_fields: T::Hash[Symbol, String],
                 name: String,
                 netsuite_sales_order_id: String
               }
@@ -7619,6 +7679,14 @@ module MetronomeSDK
             sig { params(credit_type_id: String).void }
             attr_writer :credit_type_id
 
+            # This field is only applicable to commit invoice schedules. If true, this
+            # schedule will not generate an invoice.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :do_not_invoice
+
+            sig { params(do_not_invoice: T::Boolean).void }
+            attr_writer :do_not_invoice
+
             # Enter the unit price and quantity for the charge or instead only send the
             # amount. If amount is sent, the unit price is assumed to be the amount and
             # quantity is inferred to be 1.
@@ -7665,6 +7733,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -7676,6 +7745,9 @@ module MetronomeSDK
             def self.new(
               # Defaults to USD (cents) if not passed.
               credit_type_id: nil,
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              do_not_invoice: nil,
               # Enter the unit price and quantity for the charge or instead only send the
               # amount. If amount is sent, the unit price is assumed to be the amount and
               # quantity is inferred to be 1.
@@ -7689,6 +7761,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule,
                   schedule_items:
@@ -9030,6 +9103,9 @@ module MetronomeSDK
           sig { returns(T.nilable(String)) }
           attr_accessor :netsuite_sales_order_id
 
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :priority
+
           sig { returns(T.nilable(String)) }
           attr_reader :product_id
 
@@ -9051,6 +9127,7 @@ module MetronomeSDK
               invoice_schedule:
                 MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule::OrHash,
               netsuite_sales_order_id: T.nilable(String),
+              priority: T.nilable(Float),
               product_id: String,
               rollover_fraction: T.nilable(Float)
             ).returns(T.attached_class)
@@ -9070,6 +9147,7 @@ module MetronomeSDK
             hierarchy_configuration: nil,
             invoice_schedule: nil,
             netsuite_sales_order_id: nil,
+            priority: nil,
             product_id: nil,
             rollover_fraction: nil
           )
@@ -9088,6 +9166,7 @@ module MetronomeSDK
                 invoice_schedule:
                   MetronomeSDK::V2::ContractEditParams::UpdateCommit::InvoiceSchedule,
                 netsuite_sales_order_id: T.nilable(String),
+                priority: T.nilable(Float),
                 product_id: String,
                 rollover_fraction: T.nilable(Float)
               }
@@ -9937,6 +10016,9 @@ module MetronomeSDK
           sig { returns(T.nilable(String)) }
           attr_accessor :netsuite_sales_order_id
 
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :priority
+
           sig { returns(T.nilable(String)) }
           attr_reader :product_id
 
@@ -9953,6 +10035,7 @@ module MetronomeSDK
               hierarchy_configuration:
                 MetronomeSDK::V2::ContractEditParams::UpdateCredit::HierarchyConfiguration::OrHash,
               netsuite_sales_order_id: T.nilable(String),
+              priority: T.nilable(Float),
               product_id: String
             ).returns(T.attached_class)
           end
@@ -9970,6 +10053,7 @@ module MetronomeSDK
             # Optional configuration for commit hierarchy access control
             hierarchy_configuration: nil,
             netsuite_sales_order_id: nil,
+            priority: nil,
             product_id: nil
           )
           end
@@ -9985,6 +10069,7 @@ module MetronomeSDK
                 hierarchy_configuration:
                   MetronomeSDK::V2::ContractEditParams::UpdateCredit::HierarchyConfiguration,
                 netsuite_sales_order_id: T.nilable(String),
+                priority: T.nilable(Float),
                 product_id: String
               }
             )

data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi

@@ -7300,6 +7300,11 @@ module MetronomeSDK
             sig { returns(T.nilable(String)) }
             attr_accessor :netsuite_sales_order_id
 
+            # If multiple commits are applicable, the one with the lower priority will apply
+            # first.
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :priority
+
             sig { returns(T.nilable(String)) }
             attr_reader :product_id
 
@@ -7339,6 +7344,7 @@ module MetronomeSDK
                   MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::InvoiceSchedule::OrHash,
                 name: String,
                 netsuite_sales_order_id: T.nilable(String),
+                priority: T.nilable(Float),
                 product_id: String,
                 rollover_fraction: T.nilable(Float),
                 specifiers:
@@ -7365,6 +7371,9 @@ module MetronomeSDK
               invoice_schedule: nil,
               name: nil,
               netsuite_sales_order_id: nil,
+              # If multiple commits are applicable, the one with the lower priority will apply
+              # first.
+              priority: nil,
               product_id: nil,
               rollover_fraction: nil,
               # List of filters that determine what kind of customer usage draws down a commit
@@ -7391,6 +7400,7 @@ module MetronomeSDK
                     MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCommit::InvoiceSchedule,
                   name: String,
                   netsuite_sales_order_id: T.nilable(String),
+                  priority: T.nilable(Float),
                   product_id: String,
                   rollover_fraction: T.nilable(Float),
                   specifiers:
@@ -8315,6 +8325,11 @@ module MetronomeSDK
             sig { returns(T.nilable(String)) }
             attr_accessor :netsuite_sales_order_id
 
+            # If multiple credits are applicable, the one with the lower priority will apply
+            # first.
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :priority
+
             sig { returns(T.nilable(Float)) }
             attr_accessor :rollover_fraction
 
@@ -8327,6 +8342,7 @@ module MetronomeSDK
                   MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit::HierarchyConfiguration::OrHash,
                 name: String,
                 netsuite_sales_order_id: T.nilable(String),
+                priority: T.nilable(Float),
                 rollover_fraction: T.nilable(Float)
               ).returns(T.attached_class)
             end
@@ -8337,6 +8353,9 @@ module MetronomeSDK
               hierarchy_configuration: nil,
               name: nil,
               netsuite_sales_order_id: nil,
+              # If multiple credits are applicable, the one with the lower priority will apply
+              # first.
+              priority: nil,
               rollover_fraction: nil
             )
             end
@@ -8351,6 +8370,7 @@ module MetronomeSDK
                     MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateCredit::HierarchyConfiguration,
                   name: String,
                   netsuite_sales_order_id: T.nilable(String),
+                  priority: T.nilable(Float),
                   rollover_fraction: T.nilable(Float)
                 }
               )
@@ -8973,6 +8993,14 @@ module MetronomeSDK
               sig { params(credit_type_id: String).void }
               attr_writer :credit_type_id
 
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :do_not_invoice
+
+              sig { params(do_not_invoice: T::Boolean).void }
+              attr_writer :do_not_invoice
+
               # Enter the unit price and quantity for the charge or instead only send the
               # amount. If amount is sent, the unit price is assumed to be the amount and
               # quantity is inferred to be 1.
@@ -9019,6 +9047,7 @@ module MetronomeSDK
               sig do
                 params(
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateDiscount::Schedule::RecurringSchedule::OrHash,
                   schedule_items:
@@ -9030,6 +9059,9 @@ module MetronomeSDK
               def self.new(
                 # Defaults to USD (cents) if not passed.
                 credit_type_id: nil,
+                # This field is only applicable to commit invoice schedules. If true, this
+                # schedule will not generate an invoice.
+                do_not_invoice: nil,
                 # Enter the unit price and quantity for the charge or instead only send the
                 # amount. If amount is sent, the unit price is assumed to be the amount and
                 # quantity is inferred to be 1.
@@ -9043,6 +9075,7 @@ module MetronomeSDK
                 override.returns(
                   {
                     credit_type_id: String,
+                    do_not_invoice: T::Boolean,
                     recurring_schedule:
                       MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateDiscount::Schedule::RecurringSchedule,
                     schedule_items:

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

@@ -14,6 +14,7 @@ module MetronomeSDK
               billable_metric_id: String,
               composite_product_ids: T::Array[String],
               composite_tags: T::Array[String],
+              custom_fields: T::Hash[Symbol, String],
               exclude_free_usage: T::Boolean,
               is_refundable: T::Boolean,
               netsuite_internal_item_id: String,
@@ -44,6 +45,7 @@ module MetronomeSDK
             composite_product_ids: nil,
             # Required for COMPOSITE products
             composite_tags: nil,
+            custom_fields: nil,
             # Beta feature only available for composite products. If true, products with $0
             # will not be included when computing composite usage. Defaults to false
             exclude_free_usage: nil,

data/rbi/metronome_sdk/resources/v2/contracts.rbi

@@ -231,6 +231,7 @@ module MetronomeSDK
             invoice_contract_id: String,
             invoice_schedule:
               MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::OrHash,
+            priority: T.nilable(Float),
             product_id: String,
             specifiers:
               T.nilable(
@@ -258,6 +259,9 @@ module MetronomeSDK
           # ID of contract to use for invoicing
           invoice_contract_id: nil,
           invoice_schedule: nil,
+          # If multiple commits are applicable, the one with the lower priority will apply
+          # first.
+          priority: nil,
           product_id: nil,
           # List of filters that determine what kind of customer usage draws down a commit
           # or credit. A customer's usage needs to meet the condition of at least one of the
@@ -280,6 +284,7 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            priority: T.nilable(Float),
             product_id: String,
             specifiers:
               T.nilable(
@@ -302,6 +307,9 @@ module MetronomeSDK
           # Which tags the credit applies to. If both applicable_product_ids and
           # applicable_product_tags are not provided, the credit applies to all products.
           applicable_product_tags: nil,
+          # If multiple commits are applicable, the one with the lower priority will apply
+          # first.
+          priority: nil,
           product_id: nil,
           # List of filters that determine what kind of customer usage draws down a commit
           # or credit. A customer's usage needs to meet the condition of at least one of the

data/sig/metronome_sdk/internal/type/converter.rbs

@@ -39,6 +39,23 @@ module MetronomeSDK
           | MetronomeSDK::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.meta_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> MetronomeSDK::Internal::Type::Converter::input?,
+            union: ^-> MetronomeSDK::Internal::Type::Converter::input?
+          }
+          | ^-> MetronomeSDK::Internal::Type::Converter::input
+          | MetronomeSDK::Internal::Type::Converter::input type_info,
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> MetronomeSDK::Internal::Type::Converter::input?,
+            union: ^-> MetronomeSDK::Internal::Type::Converter::input?
+          }
+          | ^-> MetronomeSDK::Internal::Type::Converter::input
+          | MetronomeSDK::Internal::Type::Converter::input spec
+        ) -> ::Hash[Symbol, top]
+
         def self.new_coerce_state: (
           ?translate_names: bool
         ) -> MetronomeSDK::Internal::Type::Converter::coerce_state

data/sig/metronome_sdk/internal/type/union.rbs

@@ -5,9 +5,9 @@ module MetronomeSDK
         include MetronomeSDK::Internal::Type::Converter
         include MetronomeSDK::Internal::Util::SorbetRuntimeSupport
 
-        private def self.known_variants: -> ::Array[[Symbol?, (^-> MetronomeSDK::Internal::Type::Converter::input)]]
+        private def self.known_variants: -> ::Array[[Symbol?, (^-> MetronomeSDK::Internal::Type::Converter::input), ::Hash[Symbol, top]]]
 
-        def self.derefed_variants: -> ::Array[[Symbol?, top]]
+        def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]]
 
         def self.variants: -> ::Array[top]
 

data/sig/metronome_sdk/models/schedule_point_in_time.rbs

@@ -3,6 +3,7 @@ module MetronomeSDK
     type schedule_point_in_time =
       {
         credit_type: MetronomeSDK::CreditTypeData,
+        do_not_invoice: bool,
         schedule_items: ::Array[MetronomeSDK::SchedulePointInTime::ScheduleItem]
       }
 
@@ -13,6 +14,10 @@ module MetronomeSDK
         MetronomeSDK::CreditTypeData
       ) -> MetronomeSDK::CreditTypeData
 
+      attr_reader do_not_invoice: bool?
+
+      def do_not_invoice=: (bool) -> bool
+
       attr_reader schedule_items: ::Array[MetronomeSDK::SchedulePointInTime::ScheduleItem]?
 
       def schedule_items=: (
@@ -21,11 +26,13 @@ module MetronomeSDK
 
       def initialize: (
         ?credit_type: MetronomeSDK::CreditTypeData,
+        ?do_not_invoice: bool,
         ?schedule_items: ::Array[MetronomeSDK::SchedulePointInTime::ScheduleItem]
       ) -> void
 
       def to_hash: -> {
         credit_type: MetronomeSDK::CreditTypeData,
+        do_not_invoice: bool,
         schedule_items: ::Array[MetronomeSDK::SchedulePointInTime::ScheduleItem]
       }