metronome-sdk 0.3.0 → 1.0.0

data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi

@@ -0,0 +1,183 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    class PrepaidBalanceThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            MetronomeSDK::PrepaidBalanceThresholdConfiguration,
+            MetronomeSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit)
+      end
+      attr_reader :commit
+
+      sig do
+        params(
+          commit:
+            MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::OrHash
+        ).void
+      end
+      attr_writer :commit
+
+      # When set to false, the contract will not be evaluated against the
+      # threshold_amount. Toggling to true will result an immediate evaluation,
+      # regardless of prior state.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_enabled
+
+      sig { returns(MetronomeSDK::PaymentGateConfig) }
+      attr_reader :payment_gate_config
+
+      sig do
+        params(
+          payment_gate_config: MetronomeSDK::PaymentGateConfig::OrHash
+        ).void
+      end
+      attr_writer :payment_gate_config
+
+      # Specify the amount the balance should be recharged to.
+      sig { returns(Float) }
+      attr_accessor :recharge_to_amount
+
+      # Specify the threshold amount for the contract. Each time the contract's prepaid
+      # balance lowers to this amount, a threshold charge will be initiated.
+      sig { returns(Float) }
+      attr_accessor :threshold_amount
+
+      # If provided, the threshold, recharge-to amount, and the resulting threshold
+      # commit amount will be in terms of this credit type instead of the fiat currency.
+      sig { returns(T.nilable(String)) }
+      attr_reader :custom_credit_type_id
+
+      sig { params(custom_credit_type_id: String).void }
+      attr_writer :custom_credit_type_id
+
+      sig do
+        params(
+          commit:
+            MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::OrHash,
+          is_enabled: T::Boolean,
+          payment_gate_config: MetronomeSDK::PaymentGateConfig::OrHash,
+          recharge_to_amount: Float,
+          threshold_amount: Float,
+          custom_credit_type_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        commit:,
+        # When set to false, the contract will not be evaluated against the
+        # threshold_amount. Toggling to true will result an immediate evaluation,
+        # regardless of prior state.
+        is_enabled:,
+        payment_gate_config:,
+        # Specify the amount the balance should be recharged to.
+        recharge_to_amount:,
+        # Specify the threshold amount for the contract. Each time the contract's prepaid
+        # balance lowers to this amount, a threshold charge will be initiated.
+        threshold_amount:,
+        # If provided, the threshold, recharge-to amount, and the resulting threshold
+        # commit amount will be in terms of this credit type instead of the fiat currency.
+        custom_credit_type_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            commit: MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit,
+            is_enabled: T::Boolean,
+            payment_gate_config: MetronomeSDK::PaymentGateConfig,
+            recharge_to_amount: Float,
+            threshold_amount: Float,
+            custom_credit_type_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Commit < MetronomeSDK::Models::BaseThresholdCommit
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # Which products the threshold commit applies to. If applicable_product_ids,
+        # applicable_product_tags or specifiers are not provided, the commit applies to
+        # all products.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :applicable_product_ids
+
+        sig { params(applicable_product_ids: T::Array[String]).void }
+        attr_writer :applicable_product_ids
+
+        # Which tags the threshold commit applies to. If applicable_product_ids,
+        # applicable_product_tags or specifiers are not provided, the commit applies to
+        # all products.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :applicable_product_tags
+
+        sig { params(applicable_product_tags: T::Array[String]).void }
+        attr_writer :applicable_product_tags
+
+        # 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
+        # specifiers to contribute to a commit's or credit's drawdown. This field cannot
+        # be used together with `applicable_product_ids` or `applicable_product_tags`.
+        sig { returns(T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput])) }
+        attr_reader :specifiers
+
+        sig do
+          params(
+            specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
+          ).void
+        end
+        attr_writer :specifiers
+
+        sig do
+          params(
+            applicable_product_ids: T::Array[String],
+            applicable_product_tags: T::Array[String],
+            specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Which products the threshold commit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # all products.
+          applicable_product_ids: nil,
+          # Which tags the threshold commit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # all products.
+          applicable_product_tags: 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
+          # specifiers to contribute to a commit's or credit's drawdown. This field cannot
+          # be used together with `applicable_product_ids` or `applicable_product_tags`.
+          specifiers: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              applicable_product_ids: T::Array[String],
+              applicable_product_tags: T::Array[String],
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi

@@ -0,0 +1,188 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    class PrepaidBalanceThresholdConfigurationV2 < MetronomeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            MetronomeSDK::PrepaidBalanceThresholdConfigurationV2,
+            MetronomeSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit)
+      end
+      attr_reader :commit
+
+      sig do
+        params(
+          commit:
+            MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit::OrHash
+        ).void
+      end
+      attr_writer :commit
+
+      # When set to false, the contract will not be evaluated against the
+      # threshold_amount. Toggling to true will result an immediate evaluation,
+      # regardless of prior state.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_enabled
+
+      sig { returns(MetronomeSDK::PaymentGateConfigV2) }
+      attr_reader :payment_gate_config
+
+      sig do
+        params(
+          payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash
+        ).void
+      end
+      attr_writer :payment_gate_config
+
+      # Specify the amount the balance should be recharged to.
+      sig { returns(Float) }
+      attr_accessor :recharge_to_amount
+
+      # Specify the threshold amount for the contract. Each time the contract's balance
+      # lowers to this amount, a threshold charge will be initiated.
+      sig { returns(Float) }
+      attr_accessor :threshold_amount
+
+      # If provided, the threshold, recharge-to amount, and the resulting threshold
+      # commit amount will be in terms of this credit type instead of the fiat currency.
+      sig { returns(T.nilable(String)) }
+      attr_reader :custom_credit_type_id
+
+      sig { params(custom_credit_type_id: String).void }
+      attr_writer :custom_credit_type_id
+
+      sig do
+        params(
+          commit:
+            MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit::OrHash,
+          is_enabled: T::Boolean,
+          payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash,
+          recharge_to_amount: Float,
+          threshold_amount: Float,
+          custom_credit_type_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        commit:,
+        # When set to false, the contract will not be evaluated against the
+        # threshold_amount. Toggling to true will result an immediate evaluation,
+        # regardless of prior state.
+        is_enabled:,
+        payment_gate_config:,
+        # Specify the amount the balance should be recharged to.
+        recharge_to_amount:,
+        # Specify the threshold amount for the contract. Each time the contract's balance
+        # lowers to this amount, a threshold charge will be initiated.
+        threshold_amount:,
+        # If provided, the threshold, recharge-to amount, and the resulting threshold
+        # commit amount will be in terms of this credit type instead of the fiat currency.
+        custom_credit_type_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            commit:
+              MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit,
+            is_enabled: T::Boolean,
+            payment_gate_config: MetronomeSDK::PaymentGateConfigV2,
+            recharge_to_amount: Float,
+            threshold_amount: Float,
+            custom_credit_type_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Commit < MetronomeSDK::Models::UpdateBaseThresholdCommit
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # Which products the threshold commit applies to. If applicable_product_ids,
+        # applicable_product_tags or specifiers are not provided, the commit applies to
+        # all products.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :applicable_product_ids
+
+        sig { params(applicable_product_ids: T::Array[String]).void }
+        attr_writer :applicable_product_ids
+
+        # Which tags the threshold commit applies to. If applicable_product_ids,
+        # applicable_product_tags or specifiers are not provided, the commit applies to
+        # all products.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :applicable_product_tags
+
+        sig { params(applicable_product_tags: T::Array[String]).void }
+        attr_writer :applicable_product_tags
+
+        # 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
+        # specifiers to contribute to a commit's or credit's drawdown. This field cannot
+        # be used together with `applicable_product_ids` or `applicable_product_tags`.
+        # Instead, to target usage by product or product tag, pass those values in the
+        # body of `specifiers`.
+        sig { returns(T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput])) }
+        attr_reader :specifiers
+
+        sig do
+          params(
+            specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
+          ).void
+        end
+        attr_writer :specifiers
+
+        sig do
+          params(
+            applicable_product_ids: T::Array[String],
+            applicable_product_tags: T::Array[String],
+            specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Which products the threshold commit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # all products.
+          applicable_product_ids: nil,
+          # Which tags the threshold commit applies to. If applicable_product_ids,
+          # applicable_product_tags or specifiers are not provided, the commit applies to
+          # all products.
+          applicable_product_tags: 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
+          # specifiers to contribute to a commit's or credit's drawdown. This field cannot
+          # be used together with `applicable_product_ids` or `applicable_product_tags`.
+          # Instead, to target usage by product or product tag, pass those values in the
+          # body of `specifiers`.
+          specifiers: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              applicable_product_ids: T::Array[String],
+              applicable_product_tags: T::Array[String],
+              specifiers: T::Array[MetronomeSDK::CommitSpecifierInput]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/pro_service.rbi

@@ -28,6 +28,7 @@ module MetronomeSDK
       sig { returns(Float) }
       attr_accessor :unit_price
 
+      # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :custom_fields
 
@@ -70,6 +71,7 @@ module MetronomeSDK
         # Unit price for the charge. Will be multiplied by quantity to determine the
         # amount and must be specified.
         unit_price:,
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         custom_fields: nil,
         description: nil,
         # This field's availability is dependent on your client's configuration.

data/rbi/metronome_sdk/models/recurring_commit_subscription_config.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    class RecurringCommitSubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            MetronomeSDK::RecurringCommitSubscriptionConfig,
+            MetronomeSDK::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          MetronomeSDK::RecurringCommitSubscriptionConfig::Allocation::TaggedSymbol
+        )
+      end
+      attr_accessor :allocation
+
+      sig do
+        returns(
+          MetronomeSDK::RecurringCommitSubscriptionConfig::ApplySeatIncreaseConfig
+        )
+      end
+      attr_reader :apply_seat_increase_config
+
+      sig do
+        params(
+          apply_seat_increase_config:
+            MetronomeSDK::RecurringCommitSubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+        ).void
+      end
+      attr_writer :apply_seat_increase_config
+
+      sig { returns(String) }
+      attr_accessor :subscription_id
+
+      sig do
+        params(
+          allocation:
+            MetronomeSDK::RecurringCommitSubscriptionConfig::Allocation::OrSymbol,
+          apply_seat_increase_config:
+            MetronomeSDK::RecurringCommitSubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+          subscription_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(allocation:, apply_seat_increase_config:, subscription_id:)
+      end
+
+      sig do
+        override.returns(
+          {
+            allocation:
+              MetronomeSDK::RecurringCommitSubscriptionConfig::Allocation::TaggedSymbol,
+            apply_seat_increase_config:
+              MetronomeSDK::RecurringCommitSubscriptionConfig::ApplySeatIncreaseConfig,
+            subscription_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Allocation
+        extend MetronomeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              MetronomeSDK::RecurringCommitSubscriptionConfig::Allocation
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INDIVIDUAL =
+          T.let(
+            :INDIVIDUAL,
+            MetronomeSDK::RecurringCommitSubscriptionConfig::Allocation::TaggedSymbol
+          )
+        POOLED =
+          T.let(
+            :POOLED,
+            MetronomeSDK::RecurringCommitSubscriptionConfig::Allocation::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              MetronomeSDK::RecurringCommitSubscriptionConfig::Allocation::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::RecurringCommitSubscriptionConfig::ApplySeatIncreaseConfig,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # Indicates whether a mid-period seat increase should be prorated.
+        sig { returns(T::Boolean) }
+        attr_accessor :is_prorated
+
+        sig { params(is_prorated: T::Boolean).returns(T.attached_class) }
+        def self.new(
+          # Indicates whether a mid-period seat increase should be prorated.
+          is_prorated:
+        )
+        end
+
+        sig { override.returns({ is_prorated: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/scheduled_charge.rbi

@@ -31,6 +31,7 @@ module MetronomeSDK
       sig { params(archived_at: Time).void }
       attr_writer :archived_at
 
+      # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
       attr_reader :custom_fields
 
@@ -67,6 +68,7 @@ module MetronomeSDK
         product:,
         schedule:,
         archived_at: nil,
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         custom_fields: nil,
         # displayed on invoices
         name: nil,

data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    class SpendThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            MetronomeSDK::SpendThresholdConfiguration,
+            MetronomeSDK::Internal::AnyHash
+          )
+        end
+
+      sig { returns(MetronomeSDK::BaseThresholdCommit) }
+      attr_reader :commit
+
+      sig { params(commit: MetronomeSDK::BaseThresholdCommit::OrHash).void }
+      attr_writer :commit
+
+      # When set to false, the contract will not be evaluated against the
+      # threshold_amount. Toggling to true will result an immediate evaluation,
+      # regardless of prior state.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_enabled
+
+      sig { returns(MetronomeSDK::PaymentGateConfig) }
+      attr_reader :payment_gate_config
+
+      sig do
+        params(
+          payment_gate_config: MetronomeSDK::PaymentGateConfig::OrHash
+        ).void
+      end
+      attr_writer :payment_gate_config
+
+      # Specify the threshold amount for the contract. Each time the contract's usage
+      # hits this amount, a threshold charge will be initiated.
+      sig { returns(Float) }
+      attr_accessor :threshold_amount
+
+      sig do
+        params(
+          commit: MetronomeSDK::BaseThresholdCommit::OrHash,
+          is_enabled: T::Boolean,
+          payment_gate_config: MetronomeSDK::PaymentGateConfig::OrHash,
+          threshold_amount: Float
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        commit:,
+        # When set to false, the contract will not be evaluated against the
+        # threshold_amount. Toggling to true will result an immediate evaluation,
+        # regardless of prior state.
+        is_enabled:,
+        payment_gate_config:,
+        # Specify the threshold amount for the contract. Each time the contract's usage
+        # hits this amount, a threshold charge will be initiated.
+        threshold_amount:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            commit: MetronomeSDK::BaseThresholdCommit,
+            is_enabled: T::Boolean,
+            payment_gate_config: MetronomeSDK::PaymentGateConfig,
+            threshold_amount: Float
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    class SpendThresholdConfigurationV2 < MetronomeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            MetronomeSDK::SpendThresholdConfigurationV2,
+            MetronomeSDK::Internal::AnyHash
+          )
+        end
+
+      sig { returns(MetronomeSDK::UpdateBaseThresholdCommit) }
+      attr_reader :commit
+
+      sig do
+        params(commit: MetronomeSDK::UpdateBaseThresholdCommit::OrHash).void
+      end
+      attr_writer :commit
+
+      # When set to false, the contract will not be evaluated against the
+      # threshold_amount. Toggling to true will result an immediate evaluation,
+      # regardless of prior state.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_enabled
+
+      sig { returns(MetronomeSDK::PaymentGateConfigV2) }
+      attr_reader :payment_gate_config
+
+      sig do
+        params(
+          payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash
+        ).void
+      end
+      attr_writer :payment_gate_config
+
+      # Specify the threshold amount for the contract. Each time the contract's usage
+      # hits this amount, a threshold charge will be initiated.
+      sig { returns(Float) }
+      attr_accessor :threshold_amount
+
+      sig do
+        params(
+          commit: MetronomeSDK::UpdateBaseThresholdCommit::OrHash,
+          is_enabled: T::Boolean,
+          payment_gate_config: MetronomeSDK::PaymentGateConfigV2::OrHash,
+          threshold_amount: Float
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        commit:,
+        # When set to false, the contract will not be evaluated against the
+        # threshold_amount. Toggling to true will result an immediate evaluation,
+        # regardless of prior state.
+        is_enabled:,
+        payment_gate_config:,
+        # Specify the threshold amount for the contract. Each time the contract's usage
+        # hits this amount, a threshold charge will be initiated.
+        threshold_amount:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            commit: MetronomeSDK::UpdateBaseThresholdCommit,
+            is_enabled: T::Boolean,
+            payment_gate_config: MetronomeSDK::PaymentGateConfigV2,
+            threshold_amount: Float
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end