metronome-sdk 0.1.0 → 0.3.0

data/rbi/metronome_sdk/models/credit.rbi

@@ -740,6 +740,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -747,10 +753,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -761,7 +775,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end
@@ -907,6 +922,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -914,10 +935,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -928,7 +957,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Credit::Ledger::CreditCanceledLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end
@@ -993,6 +1023,12 @@ module MetronomeSDK
           end
           attr_accessor :type
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :contract_id
+
+          sig { params(contract_id: String).void }
+          attr_writer :contract_id
+
           sig do
             params(
               amount: Float,
@@ -1000,10 +1036,18 @@ module MetronomeSDK
               segment_id: String,
               timestamp: Time,
               type:
-                MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type::OrSymbol
+                MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type::OrSymbol,
+              contract_id: String
             ).returns(T.attached_class)
           end
-          def self.new(amount:, invoice_id:, segment_id:, timestamp:, type:)
+          def self.new(
+            amount:,
+            invoice_id:,
+            segment_id:,
+            timestamp:,
+            type:,
+            contract_id: nil
+          )
           end
 
           sig do
@@ -1014,7 +1058,8 @@ module MetronomeSDK
                 segment_id: String,
                 timestamp: Time,
                 type:
-                  MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type::TaggedSymbol
+                  MetronomeSDK::Credit::Ledger::CreditCreditedLedgerEntry::Type::TaggedSymbol,
+                contract_id: String
               }
             )
           end

data/rbi/metronome_sdk/models/schedule_point_in_time.rbi

@@ -17,6 +17,14 @@ module MetronomeSDK
       sig { params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void }
       attr_writer :credit_type
 
+      # 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
+
       sig do
         returns(
           T.nilable(T::Array[MetronomeSDK::SchedulePointInTime::ScheduleItem])
@@ -35,17 +43,25 @@ module MetronomeSDK
       sig do
         params(
           credit_type: MetronomeSDK::CreditTypeData::OrHash,
+          do_not_invoice: T::Boolean,
           schedule_items:
             T::Array[MetronomeSDK::SchedulePointInTime::ScheduleItem::OrHash]
         ).returns(T.attached_class)
       end
-      def self.new(credit_type: nil, schedule_items: nil)
+      def self.new(
+        credit_type: nil,
+        # This field is only applicable to commit invoice schedules. If true, this
+        # schedule will not generate an invoice.
+        do_not_invoice: nil,
+        schedule_items: nil
+      )
       end
 
       sig do
         override.returns(
           {
             credit_type: MetronomeSDK::CreditTypeData,
+            do_not_invoice: T::Boolean,
             schedule_items:
               T::Array[MetronomeSDK::SchedulePointInTime::ScheduleItem]
           }

data/rbi/metronome_sdk/models/v1/alert_create_params.rbi

@@ -94,22 +94,22 @@ module MetronomeSDK
         sig { params(evaluate_on_create: T::Boolean).void }
         attr_writer :evaluate_on_create
 
-        # Scopes alert evaluation to a specific presentation group key on individual line
-        # items. Only present for spend alerts.
+        # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+        # group key on individual line items.
         sig do
           returns(
-            T.nilable(MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter)
+            T.nilable(T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue])
           )
         end
-        attr_reader :group_key_filter
+        attr_reader :group_values
 
         sig do
           params(
-            group_key_filter:
-              MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter::OrHash
+            group_values:
+              T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue::OrHash]
           ).void
         end
-        attr_writer :group_key_filter
+        attr_writer :group_values
 
         # Only supported for invoice_total_reached alerts. A list of invoice types to
         # evaluate.
@@ -151,8 +151,8 @@ module MetronomeSDK
               ],
             customer_id: String,
             evaluate_on_create: T::Boolean,
-            group_key_filter:
-              MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter::OrHash,
+            group_values:
+              T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue::OrHash],
             invoice_types_filter: T::Array[String],
             plan_id: String,
             uniqueness_key: String,
@@ -188,9 +188,9 @@ module MetronomeSDK
           # alert threshold. If false, it will only evaluate on future customers that
           # trigger the alert threshold. Defaults to true.
           evaluate_on_create: nil,
-          # Scopes alert evaluation to a specific presentation group key on individual line
-          # items. Only present for spend alerts.
-          group_key_filter: nil,
+          # Only present for `spend_threshold_reached` alerts. Scope alert to a specific
+          # group key on individual line items.
+          group_values: nil,
           # Only supported for invoice_total_reached alerts. A list of invoice types to
           # evaluate.
           invoice_types_filter: nil,
@@ -221,8 +221,8 @@ module MetronomeSDK
                 ],
               customer_id: String,
               evaluate_on_create: T::Boolean,
-              group_key_filter:
-                MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter,
+              group_values:
+                T::Array[MetronomeSDK::V1::AlertCreateParams::GroupValue],
               invoice_types_filter: T::Array[String],
               plan_id: String,
               uniqueness_key: String,
@@ -411,11 +411,11 @@ module MetronomeSDK
           end
         end
 
-        class GroupKeyFilter < MetronomeSDK::Internal::Type::BaseModel
+        class GroupValue < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter,
+                MetronomeSDK::V1::AlertCreateParams::GroupValue,
                 MetronomeSDK::Internal::AnyHash
               )
             end
@@ -426,8 +426,6 @@ module MetronomeSDK
           sig { returns(String) }
           attr_accessor :value
 
-          # Scopes alert evaluation to a specific presentation group key on individual line
-          # items. Only present for spend alerts.
           sig { params(key: String, value: String).returns(T.attached_class) }
           def self.new(key:, value:)
           end

data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi

@@ -1031,6 +1031,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.
@@ -1080,6 +1088,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -1091,6 +1100,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.
@@ -1104,6 +1116,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule,
                   schedule_items:
@@ -1629,12 +1642,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 gate type.
               sig do
                 params(
                   payment_type:
                     MetronomeSDK::V1::ContractAmendParams::Commit::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(
@@ -1642,7 +1670,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
 
@@ -1651,7 +1688,8 @@ module MetronomeSDK
                   {
                     payment_type:
                       MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol,
-                    invoice_metadata: T::Hash[Symbol, String]
+                    invoice_metadata: T::Hash[Symbol, String],
+                    on_session_payment: T::Boolean
                   }
                 )
               end
@@ -2650,6 +2688,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.
@@ -2696,6 +2742,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -2707,6 +2754,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.
@@ -2720,6 +2770,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule,
                   schedule_items:
@@ -4140,6 +4191,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
@@ -4159,6 +4216,7 @@ module MetronomeSDK
               product_id: String,
               schedule:
                 MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::OrHash,
+              custom_fields: T::Hash[Symbol, String],
               name: String,
               netsuite_sales_order_id: String
             ).returns(T.attached_class)
@@ -4167,6 +4225,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.
@@ -4180,6 +4239,7 @@ module MetronomeSDK
                 product_id: String,
                 schedule:
                   MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule,
+                custom_fields: T::Hash[Symbol, String],
                 name: String,
                 netsuite_sales_order_id: String
               }
@@ -4204,6 +4264,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.
@@ -4250,6 +4318,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -4261,6 +4330,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.
@@ -4274,6 +4346,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule,
                   schedule_items: