metronome-sdk 0.3.0 → 2.0.0

data/rbi/metronome_sdk/models/payment_gate_config_v2.rbi

@@ -0,0 +1,326 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    class PaymentGateConfigV2 < MetronomeSDK::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            MetronomeSDK::PaymentGateConfigV2,
+            MetronomeSDK::Internal::AnyHash
+          )
+        end
+
+      # Gate access to the commit balance based on successful collection of payment.
+      # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+      # facilitate payment using your own payment integration. Select NONE if you do not
+      # wish to payment gate the commit balance.
+      sig do
+        returns(MetronomeSDK::PaymentGateConfigV2::PaymentGateType::OrSymbol)
+      end
+      attr_accessor :payment_gate_type
+
+      # Only applicable if using PRECALCULATED as your tax type.
+      sig do
+        returns(
+          T.nilable(MetronomeSDK::PaymentGateConfigV2::PrecalculatedTaxConfig)
+        )
+      end
+      attr_reader :precalculated_tax_config
+
+      sig do
+        params(
+          precalculated_tax_config:
+            MetronomeSDK::PaymentGateConfigV2::PrecalculatedTaxConfig::OrHash
+        ).void
+      end
+      attr_writer :precalculated_tax_config
+
+      # Only applicable if using STRIPE as your payment gateway type.
+      sig do
+        returns(T.nilable(MetronomeSDK::PaymentGateConfigV2::StripeConfig))
+      end
+      attr_reader :stripe_config
+
+      sig do
+        params(
+          stripe_config: MetronomeSDK::PaymentGateConfigV2::StripeConfig::OrHash
+        ).void
+      end
+      attr_writer :stripe_config
+
+      # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+      # not wish Metronome to calculate tax on your behalf. Leaving this field blank
+      # will default to NONE.
+      sig do
+        returns(T.nilable(MetronomeSDK::PaymentGateConfigV2::TaxType::OrSymbol))
+      end
+      attr_reader :tax_type
+
+      sig do
+        params(
+          tax_type: MetronomeSDK::PaymentGateConfigV2::TaxType::OrSymbol
+        ).void
+      end
+      attr_writer :tax_type
+
+      sig do
+        params(
+          payment_gate_type:
+            MetronomeSDK::PaymentGateConfigV2::PaymentGateType::OrSymbol,
+          precalculated_tax_config:
+            MetronomeSDK::PaymentGateConfigV2::PrecalculatedTaxConfig::OrHash,
+          stripe_config:
+            MetronomeSDK::PaymentGateConfigV2::StripeConfig::OrHash,
+          tax_type: MetronomeSDK::PaymentGateConfigV2::TaxType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Gate access to the commit balance based on successful collection of payment.
+        # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+        # facilitate payment using your own payment integration. Select NONE if you do not
+        # wish to payment gate the commit balance.
+        payment_gate_type:,
+        # Only applicable if using PRECALCULATED as your tax type.
+        precalculated_tax_config: nil,
+        # Only applicable if using STRIPE as your payment gateway type.
+        stripe_config: nil,
+        # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+        # not wish Metronome to calculate tax on your behalf. Leaving this field blank
+        # will default to NONE.
+        tax_type: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            payment_gate_type:
+              MetronomeSDK::PaymentGateConfigV2::PaymentGateType::OrSymbol,
+            precalculated_tax_config:
+              MetronomeSDK::PaymentGateConfigV2::PrecalculatedTaxConfig,
+            stripe_config: MetronomeSDK::PaymentGateConfigV2::StripeConfig,
+            tax_type: MetronomeSDK::PaymentGateConfigV2::TaxType::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Gate access to the commit balance based on successful collection of payment.
+      # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+      # facilitate payment using your own payment integration. Select NONE if you do not
+      # wish to payment gate the commit balance.
+      module PaymentGateType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, MetronomeSDK::PaymentGateConfigV2::PaymentGateType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NONE =
+          T.let(
+            :NONE,
+            MetronomeSDK::PaymentGateConfigV2::PaymentGateType::TaggedSymbol
+          )
+        STRIPE =
+          T.let(
+            :STRIPE,
+            MetronomeSDK::PaymentGateConfigV2::PaymentGateType::TaggedSymbol
+          )
+        EXTERNAL =
+          T.let(
+            :EXTERNAL,
+            MetronomeSDK::PaymentGateConfigV2::PaymentGateType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              MetronomeSDK::PaymentGateConfigV2::PaymentGateType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::PaymentGateConfigV2::PrecalculatedTaxConfig,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # Amount of tax to be applied. This should be in the same currency and
+        # denomination as the commit's invoice schedule
+        sig { returns(Float) }
+        attr_accessor :tax_amount
+
+        # Name of the tax to be applied. This may be used in an invoice line item
+        # description.
+        sig { returns(T.nilable(String)) }
+        attr_reader :tax_name
+
+        sig { params(tax_name: String).void }
+        attr_writer :tax_name
+
+        # Only applicable if using PRECALCULATED as your tax type.
+        sig do
+          params(tax_amount: Float, tax_name: String).returns(T.attached_class)
+        end
+        def self.new(
+          # Amount of tax to be applied. This should be in the same currency and
+          # denomination as the commit's invoice schedule
+          tax_amount:,
+          # Name of the tax to be applied. This may be used in an invoice line item
+          # description.
+          tax_name: nil
+        )
+        end
+
+        sig { override.returns({ tax_amount: Float, tax_name: String }) }
+        def to_hash
+        end
+      end
+
+      class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::PaymentGateConfigV2::StripeConfig,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # If left blank, will default to INVOICE
+        sig do
+          returns(
+            MetronomeSDK::PaymentGateConfigV2::StripeConfig::PaymentType::OrSymbol
+          )
+        end
+        attr_accessor :payment_type
+
+        # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+        # your payment type.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :invoice_metadata
+
+        sig { params(invoice_metadata: T::Hash[Symbol, String]).void }
+        attr_writer :invoice_metadata
+
+        # Only applicable if using STRIPE as your payment gateway type.
+        sig do
+          params(
+            payment_type:
+              MetronomeSDK::PaymentGateConfigV2::StripeConfig::PaymentType::OrSymbol,
+            invoice_metadata: T::Hash[Symbol, String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # If left blank, will default to INVOICE
+          payment_type:,
+          # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+          # your payment type.
+          invoice_metadata: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              payment_type:
+                MetronomeSDK::PaymentGateConfigV2::StripeConfig::PaymentType::OrSymbol,
+              invoice_metadata: T::Hash[Symbol, String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # If left blank, will default to INVOICE
+        module PaymentType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::PaymentGateConfigV2::StripeConfig::PaymentType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INVOICE =
+            T.let(
+              :INVOICE,
+              MetronomeSDK::PaymentGateConfigV2::StripeConfig::PaymentType::TaggedSymbol
+            )
+          PAYMENT_INTENT =
+            T.let(
+              :PAYMENT_INTENT,
+              MetronomeSDK::PaymentGateConfigV2::StripeConfig::PaymentType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::PaymentGateConfigV2::StripeConfig::PaymentType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+      # not wish Metronome to calculate tax on your behalf. Leaving this field blank
+      # will default to NONE.
+      module TaxType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, MetronomeSDK::PaymentGateConfigV2::TaxType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        NONE =
+          T.let(:NONE, MetronomeSDK::PaymentGateConfigV2::TaxType::TaggedSymbol)
+        STRIPE =
+          T.let(
+            :STRIPE,
+            MetronomeSDK::PaymentGateConfigV2::TaxType::TaggedSymbol
+          )
+        ANROK =
+          T.let(
+            :ANROK,
+            MetronomeSDK::PaymentGateConfigV2::TaxType::TaggedSymbol
+          )
+        AVALARA =
+          T.let(
+            :AVALARA,
+            MetronomeSDK::PaymentGateConfigV2::TaxType::TaggedSymbol
+          )
+        PRECALCULATED =
+          T.let(
+            :PRECALCULATED,
+            MetronomeSDK::PaymentGateConfigV2::TaxType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[MetronomeSDK::PaymentGateConfigV2::TaxType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

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