metronome-sdk 0.2.0 → 1.0.0

data/lib/metronome_sdk/models/payment_gate_config.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute payment_gate_type
+      #   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.
+      #
+      #   @return [Symbol, MetronomeSDK::Models::PaymentGateConfig::PaymentGateType]
+      required :payment_gate_type, enum: -> { MetronomeSDK::PaymentGateConfig::PaymentGateType }
+
+      # @!attribute precalculated_tax_config
+      #   Only applicable if using PRECALCULATED as your tax type.
+      #
+      #   @return [MetronomeSDK::Models::PaymentGateConfig::PrecalculatedTaxConfig, nil]
+      optional :precalculated_tax_config, -> { MetronomeSDK::PaymentGateConfig::PrecalculatedTaxConfig }
+
+      # @!attribute stripe_config
+      #   Only applicable if using STRIPE as your payment gate type.
+      #
+      #   @return [MetronomeSDK::Models::PaymentGateConfig::StripeConfig, nil]
+      optional :stripe_config, -> { MetronomeSDK::PaymentGateConfig::StripeConfig }
+
+      # @!attribute tax_type
+      #   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.
+      #
+      #   @return [Symbol, MetronomeSDK::Models::PaymentGateConfig::TaxType, nil]
+      optional :tax_type, enum: -> { MetronomeSDK::PaymentGateConfig::TaxType }
+
+      # @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::PaymentGateConfig} for more details.
+      #
+      #   @param payment_gate_type [Symbol, MetronomeSDK::Models::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
+      #
+      #   @param precalculated_tax_config [MetronomeSDK::Models::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
+      #
+      #   @param stripe_config [MetronomeSDK::Models::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gate type.
+      #
+      #   @param tax_type [Symbol, MetronomeSDK::Models::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
+
+      # 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.
+      #
+      # @see MetronomeSDK::Models::PaymentGateConfig#payment_gate_type
+      module PaymentGateType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        NONE = :NONE
+        STRIPE = :STRIPE
+        EXTERNAL = :EXTERNAL
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see MetronomeSDK::Models::PaymentGateConfig#precalculated_tax_config
+      class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute tax_amount
+        #   Amount of tax to be applied. This should be in the same currency and
+        #   denomination as the commit's invoice schedule
+        #
+        #   @return [Float]
+        required :tax_amount, Float
+
+        # @!attribute tax_name
+        #   Name of the tax to be applied. This may be used in an invoice line item
+        #   description.
+        #
+        #   @return [String, nil]
+        optional :tax_name, String
+
+        # @!method initialize(tax_amount:, tax_name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::PaymentGateConfig::PrecalculatedTaxConfig} for more
+        #   details.
+        #
+        #   Only applicable if using PRECALCULATED as your tax type.
+        #
+        #   @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
+        #
+        #   @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
+      end
+
+      # @see MetronomeSDK::Models::PaymentGateConfig#stripe_config
+      class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute payment_type
+        #   If left blank, will default to INVOICE
+        #
+        #   @return [Symbol, MetronomeSDK::Models::PaymentGateConfig::StripeConfig::PaymentType]
+        required :payment_type, enum: -> { MetronomeSDK::PaymentGateConfig::StripeConfig::PaymentType }
+
+        # @!attribute invoice_metadata
+        #   Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+        #   your payment type.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!method initialize(payment_type:, invoice_metadata: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::PaymentGateConfig::StripeConfig} for more details.
+        #
+        #   Only applicable if using STRIPE as your payment gate type.
+        #
+        #   @param payment_type [Symbol, MetronomeSDK::Models::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
+        #
+        #   @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+
+        # If left blank, will default to INVOICE
+        #
+        # @see MetronomeSDK::Models::PaymentGateConfig::StripeConfig#payment_type
+        module PaymentType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          INVOICE = :INVOICE
+          PAYMENT_INTENT = :PAYMENT_INTENT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        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.
+      #
+      # @see MetronomeSDK::Models::PaymentGateConfig#tax_type
+      module TaxType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        NONE = :NONE
+        STRIPE = :STRIPE
+        ANROK = :ANROK
+        PRECALCULATED = :PRECALCULATED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/payment_gate_config_v2.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class PaymentGateConfigV2 < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute payment_gate_type
+      #   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.
+      #
+      #   @return [Symbol, MetronomeSDK::Models::PaymentGateConfigV2::PaymentGateType]
+      required :payment_gate_type, enum: -> { MetronomeSDK::PaymentGateConfigV2::PaymentGateType }
+
+      # @!attribute precalculated_tax_config
+      #   Only applicable if using PRECALCULATED as your tax type.
+      #
+      #   @return [MetronomeSDK::Models::PaymentGateConfigV2::PrecalculatedTaxConfig, nil]
+      optional :precalculated_tax_config, -> { MetronomeSDK::PaymentGateConfigV2::PrecalculatedTaxConfig }
+
+      # @!attribute stripe_config
+      #   Only applicable if using STRIPE as your payment gateway type.
+      #
+      #   @return [MetronomeSDK::Models::PaymentGateConfigV2::StripeConfig, nil]
+      optional :stripe_config, -> { MetronomeSDK::PaymentGateConfigV2::StripeConfig }
+
+      # @!attribute tax_type
+      #   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.
+      #
+      #   @return [Symbol, MetronomeSDK::Models::PaymentGateConfigV2::TaxType, nil]
+      optional :tax_type, enum: -> { MetronomeSDK::PaymentGateConfigV2::TaxType }
+
+      # @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::PaymentGateConfigV2} for more details.
+      #
+      #   @param payment_gate_type [Symbol, MetronomeSDK::Models::PaymentGateConfigV2::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
+      #
+      #   @param precalculated_tax_config [MetronomeSDK::Models::PaymentGateConfigV2::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
+      #
+      #   @param stripe_config [MetronomeSDK::Models::PaymentGateConfigV2::StripeConfig] Only applicable if using STRIPE as your payment gateway type.
+      #
+      #   @param tax_type [Symbol, MetronomeSDK::Models::PaymentGateConfigV2::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
+
+      # 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.
+      #
+      # @see MetronomeSDK::Models::PaymentGateConfigV2#payment_gate_type
+      module PaymentGateType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        NONE = :NONE
+        STRIPE = :STRIPE
+        EXTERNAL = :EXTERNAL
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see MetronomeSDK::Models::PaymentGateConfigV2#precalculated_tax_config
+      class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute tax_amount
+        #   Amount of tax to be applied. This should be in the same currency and
+        #   denomination as the commit's invoice schedule
+        #
+        #   @return [Float]
+        required :tax_amount, Float
+
+        # @!attribute tax_name
+        #   Name of the tax to be applied. This may be used in an invoice line item
+        #   description.
+        #
+        #   @return [String, nil]
+        optional :tax_name, String
+
+        # @!method initialize(tax_amount:, tax_name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::PaymentGateConfigV2::PrecalculatedTaxConfig} for more
+        #   details.
+        #
+        #   Only applicable if using PRECALCULATED as your tax type.
+        #
+        #   @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
+        #
+        #   @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
+      end
+
+      # @see MetronomeSDK::Models::PaymentGateConfigV2#stripe_config
+      class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute payment_type
+        #   If left blank, will default to INVOICE
+        #
+        #   @return [Symbol, MetronomeSDK::Models::PaymentGateConfigV2::StripeConfig::PaymentType]
+        required :payment_type, enum: -> { MetronomeSDK::PaymentGateConfigV2::StripeConfig::PaymentType }
+
+        # @!attribute invoice_metadata
+        #   Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+        #   your payment type.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!method initialize(payment_type:, invoice_metadata: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::PaymentGateConfigV2::StripeConfig} for more details.
+        #
+        #   Only applicable if using STRIPE as your payment gateway type.
+        #
+        #   @param payment_type [Symbol, MetronomeSDK::Models::PaymentGateConfigV2::StripeConfig::PaymentType] If left blank, will default to INVOICE
+        #
+        #   @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+
+        # If left blank, will default to INVOICE
+        #
+        # @see MetronomeSDK::Models::PaymentGateConfigV2::StripeConfig#payment_type
+        module PaymentType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          INVOICE = :INVOICE
+          PAYMENT_INTENT = :PAYMENT_INTENT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        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.
+      #
+      # @see MetronomeSDK::Models::PaymentGateConfigV2#tax_type
+      module TaxType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        NONE = :NONE
+        STRIPE = :STRIPE
+        ANROK = :ANROK
+        PRECALCULATED = :PRECALCULATED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class PrepaidBalanceThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute commit
+      #
+      #   @return [MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit]
+      required :commit, -> { MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit }
+
+      # @!attribute is_enabled
+      #   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.
+      #
+      #   @return [Boolean]
+      required :is_enabled, MetronomeSDK::Internal::Type::Boolean
+
+      # @!attribute payment_gate_config
+      #
+      #   @return [MetronomeSDK::Models::PaymentGateConfig]
+      required :payment_gate_config, -> { MetronomeSDK::PaymentGateConfig }
+
+      # @!attribute recharge_to_amount
+      #   Specify the amount the balance should be recharged to.
+      #
+      #   @return [Float]
+      required :recharge_to_amount, Float
+
+      # @!attribute threshold_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.
+      #
+      #   @return [Float]
+      required :threshold_amount, Float
+
+      # @!attribute custom_credit_type_id
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :custom_credit_type_id, String
+
+      # @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:, custom_credit_type_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration} for more details.
+      #
+      #   @param commit [MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit]
+      #
+      #   @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
+      #
+      #   @param payment_gate_config [MetronomeSDK::Models::PaymentGateConfig]
+      #
+      #   @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
+      #
+      #   @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's prepaid
+      #
+      #   @param custom_credit_type_id [String] If provided, the threshold, recharge-to amount, and the resulting threshold comm
+
+      # @see MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration#commit
+      class Commit < MetronomeSDK::Models::BaseThresholdCommit
+        # @!attribute applicable_product_ids
+        #   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.
+        #
+        #   @return [Array<String>, nil]
+        optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute applicable_product_tags
+        #   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.
+        #
+        #   @return [Array<String>, nil]
+        optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute specifiers
+        #   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`.
+        #
+        #   @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
+        optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
+
+        # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, specifiers: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit} for more
+        #   details.
+        #
+        #   @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If applicable_product_ids, appli
+        #
+        #   @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If applicable_product_ids, applicabl
+        #
+        #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class PrepaidBalanceThresholdConfigurationV2 < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute commit
+      #
+      #   @return [MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit]
+      required :commit, -> { MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit }
+
+      # @!attribute is_enabled
+      #   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.
+      #
+      #   @return [Boolean]
+      required :is_enabled, MetronomeSDK::Internal::Type::Boolean
+
+      # @!attribute payment_gate_config
+      #
+      #   @return [MetronomeSDK::Models::PaymentGateConfigV2]
+      required :payment_gate_config, -> { MetronomeSDK::PaymentGateConfigV2 }
+
+      # @!attribute recharge_to_amount
+      #   Specify the amount the balance should be recharged to.
+      #
+      #   @return [Float]
+      required :recharge_to_amount, Float
+
+      # @!attribute threshold_amount
+      #   Specify the threshold amount for the contract. Each time the contract's balance
+      #   lowers to this amount, a threshold charge will be initiated.
+      #
+      #   @return [Float]
+      required :threshold_amount, Float
+
+      # @!attribute custom_credit_type_id
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :custom_credit_type_id, String
+
+      # @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:, custom_credit_type_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2} for more details.
+      #
+      #   @param commit [MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit]
+      #
+      #   @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
+      #
+      #   @param payment_gate_config [MetronomeSDK::Models::PaymentGateConfigV2]
+      #
+      #   @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
+      #
+      #   @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's balance
+      #
+      #   @param custom_credit_type_id [String] If provided, the threshold, recharge-to amount, and the resulting threshold comm
+
+      # @see MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2#commit
+      class Commit < MetronomeSDK::Models::UpdateBaseThresholdCommit
+        # @!attribute applicable_product_ids
+        #   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.
+        #
+        #   @return [Array<String>, nil]
+        optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute applicable_product_tags
+        #   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.
+        #
+        #   @return [Array<String>, nil]
+        optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute specifiers
+        #   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`.
+        #
+        #   @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
+        optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
+
+        # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, specifiers: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit} for more
+        #   details.
+        #
+        #   @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If applicable_product_ids, appli
+        #
+        #   @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If applicable_product_ids, applicabl
+        #
+        #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/pro_service.rb

@@ -34,6 +34,7 @@ module MetronomeSDK
       required :unit_price, Float
 
       # @!attribute custom_fields
+      #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -63,7 +64,7 @@ module MetronomeSDK
       #
       #   @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
       #
-      #   @param custom_fields [Hash{Symbol=>String}]
+      #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       #
       #   @param description [String]
       #

data/lib/metronome_sdk/models/recurring_commit_subscription_config.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class RecurringCommitSubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute allocation
+      #
+      #   @return [Symbol, MetronomeSDK::Models::RecurringCommitSubscriptionConfig::Allocation]
+      required :allocation, enum: -> { MetronomeSDK::RecurringCommitSubscriptionConfig::Allocation }
+
+      # @!attribute apply_seat_increase_config
+      #
+      #   @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig::ApplySeatIncreaseConfig]
+      required :apply_seat_increase_config,
+               -> { MetronomeSDK::RecurringCommitSubscriptionConfig::ApplySeatIncreaseConfig }
+
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!method initialize(allocation:, apply_seat_increase_config:, subscription_id:)
+      #   @param allocation [Symbol, MetronomeSDK::Models::RecurringCommitSubscriptionConfig::Allocation]
+      #   @param apply_seat_increase_config [MetronomeSDK::Models::RecurringCommitSubscriptionConfig::ApplySeatIncreaseConfig]
+      #   @param subscription_id [String]
+
+      # @see MetronomeSDK::Models::RecurringCommitSubscriptionConfig#allocation
+      module Allocation
+        extend MetronomeSDK::Internal::Type::Enum
+
+        INDIVIDUAL = :INDIVIDUAL
+        POOLED = :POOLED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see MetronomeSDK::Models::RecurringCommitSubscriptionConfig#apply_seat_increase_config
+      class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute is_prorated
+        #   Indicates whether a mid-period seat increase should be prorated.
+        #
+        #   @return [Boolean]
+        required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+        # @!method initialize(is_prorated:)
+        #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/schedule_point_in_time.rb

@@ -8,14 +8,27 @@ module MetronomeSDK
       #   @return [MetronomeSDK::Models::CreditTypeData, nil]
       optional :credit_type, -> { MetronomeSDK::CreditTypeData }
 
+      # @!attribute do_not_invoice
+      #   This field is only applicable to commit invoice schedules. If true, this
+      #   schedule will not generate an invoice.
+      #
+      #   @return [Boolean, nil]
+      optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean
+
       # @!attribute schedule_items
       #
       #   @return [Array<MetronomeSDK::Models::SchedulePointInTime::ScheduleItem>, nil]
       optional :schedule_items,
                -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::SchedulePointInTime::ScheduleItem] }
 
-      # @!method initialize(credit_type: nil, schedule_items: nil)
+      # @!method initialize(credit_type: nil, do_not_invoice: nil, schedule_items: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::SchedulePointInTime} for more details.
+      #
       #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+      #
+      #   @param do_not_invoice [Boolean] This field is only applicable to commit invoice schedules. If true, this schedul
+      #
       #   @param schedule_items [Array<MetronomeSDK::Models::SchedulePointInTime::ScheduleItem>]
 
       class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel

data/lib/metronome_sdk/models/scheduled_charge.rb

@@ -24,6 +24,7 @@ module MetronomeSDK
       optional :archived_at, Time
 
       # @!attribute custom_fields
+      #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -49,7 +50,7 @@ module MetronomeSDK
       #
       #   @param archived_at [Time]
       #
-      #   @param custom_fields [Hash{Symbol=>String}]
+      #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       #
       #   @param name [String] displayed on invoices
       #

data/lib/metronome_sdk/models/spend_threshold_configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class SpendThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute commit
+      #
+      #   @return [MetronomeSDK::Models::BaseThresholdCommit]
+      required :commit, -> { MetronomeSDK::BaseThresholdCommit }
+
+      # @!attribute is_enabled
+      #   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.
+      #
+      #   @return [Boolean]
+      required :is_enabled, MetronomeSDK::Internal::Type::Boolean
+
+      # @!attribute payment_gate_config
+      #
+      #   @return [MetronomeSDK::Models::PaymentGateConfig]
+      required :payment_gate_config, -> { MetronomeSDK::PaymentGateConfig }
+
+      # @!attribute threshold_amount
+      #   Specify the threshold amount for the contract. Each time the contract's usage
+      #   hits this amount, a threshold charge will be initiated.
+      #
+      #   @return [Float]
+      required :threshold_amount, Float
+
+      # @!method initialize(commit:, is_enabled:, payment_gate_config:, threshold_amount:)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::SpendThresholdConfiguration} for more details.
+      #
+      #   @param commit [MetronomeSDK::Models::BaseThresholdCommit]
+      #
+      #   @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
+      #
+      #   @param payment_gate_config [MetronomeSDK::Models::PaymentGateConfig]
+      #
+      #   @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's usage hi
+    end
+  end
+end