metronome-sdk 3.6.0 → 3.7.0

data/lib/metronome_sdk/models/v1/package_create_params.rb

@@ -127,6 +127,12 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::SpendThresholdConfiguration, nil]
         optional :spend_threshold_configuration, -> { MetronomeSDK::SpendThresholdConfiguration }
 
+        # @!attribute spend_trackers
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker>, nil]
+        optional :spend_trackers,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::SpendTracker] }
+
         # @!attribute subscriptions
         #
         #   @return [Array<MetronomeSDK::Models::V1::PackageCreateParams::Subscription>, nil]
@@ -146,7 +152,7 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::V1::PackageCreateParams::UsageStatementSchedule, nil]
         optional :usage_statement_schedule, -> { MetronomeSDK::V1::PackageCreateParams::UsageStatementSchedule }
 
-        # @!method initialize(name:, aliases: nil, billing_provider: nil, commits: nil, contract_name: nil, credits: nil, delivery_method: nil, duration: nil, multiplier_override_prioritization: nil, net_payment_terms_days: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, uniqueness_key: nil, usage_statement_schedule: nil, request_options: {})
+        # @!method initialize(name:, aliases: nil, billing_provider: nil, commits: nil, contract_name: nil, credits: nil, delivery_method: nil, duration: nil, multiplier_override_prioritization: nil, net_payment_terms_days: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, spend_trackers: nil, subscriptions: nil, uniqueness_key: nil, usage_statement_schedule: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::PackageCreateParams} for more details.
         #
@@ -188,6 +194,8 @@ module MetronomeSDK
         #
         #   @param spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfiguration]
         #
+        #   @param spend_trackers [Array<MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker>]
+        #
         #   @param subscriptions [Array<MetronomeSDK::Models::V1::PackageCreateParams::Subscription>]
         #
         #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
@@ -2241,6 +2249,112 @@ module MetronomeSDK
           #   @return [Array<Symbol>]
         end
 
+        class SpendTracker < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute alias_
+          #   Human-readable identifier, unique per contract.
+          #
+          #   @return [String]
+          required :alias_, String, api_name: :alias
+
+          # @!attribute applicable_spend_specifiers
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier>]
+          required :applicable_spend_specifiers,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier] }
+
+          # @!attribute credit_type_id
+          #
+          #   @return [String]
+          required :credit_type_id, String
+
+          # @!attribute reset_frequency
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ResetFrequency]
+          required :reset_frequency,
+                   enum: -> { MetronomeSDK::V1::PackageCreateParams::SpendTracker::ResetFrequency }
+
+          # @!method initialize(alias_:, applicable_spend_specifiers:, credit_type_id:, reset_frequency:)
+          #   @param alias_ [String] Human-readable identifier, unique per contract.
+          #
+          #   @param applicable_spend_specifiers [Array<MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier>]
+          #
+          #   @param credit_type_id [String]
+          #
+          #   @param reset_frequency [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ResetFrequency]
+
+          class ApplicableSpendSpecifier < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute sources
+            #
+            #   @return [Array<Symbol, MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::Source>]
+            required :sources,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::Source] }
+
+            # @!attribute spend_type
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::SpendType]
+            required :spend_type,
+                     enum: -> { MetronomeSDK::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::SpendType }
+
+            # @!attribute discounted
+            #   Filter by whether the spend was discounted. Defaults to ANY if omitted.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::Discounted, nil]
+            optional :discounted,
+                     enum: -> { MetronomeSDK::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::Discounted }
+
+            # @!method initialize(sources:, spend_type:, discounted: nil)
+            #   @param sources [Array<Symbol, MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::Source>]
+            #
+            #   @param spend_type [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::SpendType]
+            #
+            #   @param discounted [Symbol, MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier::Discounted] Filter by whether the spend was discounted. Defaults to ANY if omitted.
+
+            module Source
+              extend MetronomeSDK::Internal::Type::Enum
+
+              THRESHOLD_RECHARGE = :THRESHOLD_RECHARGE
+              MANUAL = :MANUAL
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier#spend_type
+            module SpendType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              COMMIT_PURCHASE = :COMMIT_PURCHASE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Filter by whether the spend was discounted. Defaults to ANY if omitted.
+            #
+            # @see MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker::ApplicableSpendSpecifier#discounted
+            module Discounted
+              extend MetronomeSDK::Internal::Type::Enum
+
+              ANY = :ANY
+              DISCOUNTED_ONLY = :DISCOUNTED_ONLY
+              UNDISCOUNTED_ONLY = :UNDISCOUNTED_ONLY
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::PackageCreateParams::SpendTracker#reset_frequency
+          module ResetFrequency
+            extend MetronomeSDK::Internal::Type::Enum
+
+            BILLING_PERIOD = :BILLING_PERIOD
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         class Subscription < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute collection_schedule
           #

data/lib/metronome_sdk/models/v1/package_list_response.rb

@@ -141,6 +141,12 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::SpendThresholdConfiguration, nil]
         optional :spend_threshold_configuration, -> { MetronomeSDK::SpendThresholdConfiguration }
 
+        # @!attribute spend_trackers
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::PackageListResponse::SpendTracker>, nil]
+        optional :spend_trackers,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageListResponse::SpendTracker] }
+
         # @!attribute subscriptions
         #
         #   @return [Array<MetronomeSDK::Models::V1::PackageListResponse::Subscription>, nil]
@@ -155,7 +161,7 @@ module MetronomeSDK
         #   @return [String, nil]
         optional :uniqueness_key, String
 
-        # @!method initialize(id:, commits:, created_at:, created_by:, overrides:, scheduled_charges:, usage_statement_schedule:, aliases: nil, archived_at: nil, billing_provider: nil, contract_name: nil, credits: nil, delivery_method: nil, duration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, prepaid_balance_threshold_configuration: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, uniqueness_key: nil)
+        # @!method initialize(id:, commits:, created_at:, created_by:, overrides:, scheduled_charges:, usage_statement_schedule:, aliases: nil, archived_at: nil, billing_provider: nil, contract_name: nil, credits: nil, delivery_method: nil, duration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, prepaid_balance_threshold_configuration: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, spend_trackers: nil, subscriptions: nil, uniqueness_key: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V1::PackageListResponse} for more details.
         #
@@ -205,6 +211,8 @@ module MetronomeSDK
         #
         #   @param spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfiguration]
         #
+        #   @param spend_trackers [Array<MetronomeSDK::Models::V1::PackageListResponse::SpendTracker>]
+        #
         #   @param subscriptions [Array<MetronomeSDK::Models::V1::PackageListResponse::Subscription>]
         #
         #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
@@ -2157,6 +2165,107 @@ module MetronomeSDK
           #   @return [Array<Symbol>]
         end
 
+        class SpendTracker < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute alias_
+          #   Human-readable identifier, unique per contract.
+          #
+          #   @return [String]
+          required :alias_, String, api_name: :alias
+
+          # @!attribute applicable_spend_specifiers
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier>]
+          required :applicable_spend_specifiers,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier] }
+
+          # @!attribute credit_type_id
+          #
+          #   @return [String]
+          required :credit_type_id, String
+
+          # @!attribute reset_frequency
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ResetFrequency]
+          required :reset_frequency,
+                   enum: -> { MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ResetFrequency }
+
+          # @!method initialize(alias_:, applicable_spend_specifiers:, credit_type_id:, reset_frequency:)
+          #   @param alias_ [String] Human-readable identifier, unique per contract.
+          #
+          #   @param applicable_spend_specifiers [Array<MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier>]
+          #
+          #   @param credit_type_id [String]
+          #
+          #   @param reset_frequency [Symbol, MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ResetFrequency]
+
+          class ApplicableSpendSpecifier < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute sources
+            #
+            #   @return [Array<Symbol, MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::Source>]
+            required :sources,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::Source] }
+
+            # @!attribute spend_type
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::SpendType]
+            required :spend_type,
+                     enum: -> { MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::SpendType }
+
+            # @!attribute discounted
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::Discounted, nil]
+            optional :discounted,
+                     enum: -> { MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::Discounted }
+
+            # @!method initialize(sources:, spend_type:, discounted: nil)
+            #   @param sources [Array<Symbol, MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::Source>]
+            #   @param spend_type [Symbol, MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::SpendType]
+            #   @param discounted [Symbol, MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier::Discounted]
+
+            module Source
+              extend MetronomeSDK::Internal::Type::Enum
+
+              THRESHOLD_RECHARGE = :THRESHOLD_RECHARGE
+              MANUAL = :MANUAL
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier#spend_type
+            module SpendType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              COMMIT_PURCHASE = :COMMIT_PURCHASE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see MetronomeSDK::Models::V1::PackageListResponse::SpendTracker::ApplicableSpendSpecifier#discounted
+            module Discounted
+              extend MetronomeSDK::Internal::Type::Enum
+
+              ANY = :ANY
+              DISCOUNTED_ONLY = :DISCOUNTED_ONLY
+              UNDISCOUNTED_ONLY = :UNDISCOUNTED_ONLY
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::PackageListResponse::SpendTracker#reset_frequency
+          module ResetFrequency
+            extend MetronomeSDK::Internal::Type::Enum
+
+            BILLING_PERIOD = :BILLING_PERIOD
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         class Subscription < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute collection_schedule
           #

data/lib/metronome_sdk/models/v1/package_retrieve_response.rb

@@ -153,6 +153,12 @@ module MetronomeSDK
           #   @return [MetronomeSDK::Models::SpendThresholdConfiguration, nil]
           optional :spend_threshold_configuration, -> { MetronomeSDK::SpendThresholdConfiguration }
 
+          # @!attribute spend_trackers
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker>, nil]
+          optional :spend_trackers,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker] }
+
           # @!attribute subscriptions
           #
           #   @return [Array<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription>, nil]
@@ -167,7 +173,7 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :uniqueness_key, String
 
-          # @!method initialize(id:, commits:, created_at:, created_by:, overrides:, scheduled_charges:, usage_statement_schedule:, aliases: nil, archived_at: nil, billing_provider: nil, contract_name: nil, credits: nil, delivery_method: nil, duration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, prepaid_balance_threshold_configuration: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, uniqueness_key: nil)
+          # @!method initialize(id:, commits:, created_at:, created_by:, overrides:, scheduled_charges:, usage_statement_schedule:, aliases: nil, archived_at: nil, billing_provider: nil, contract_name: nil, credits: nil, delivery_method: nil, duration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, prepaid_balance_threshold_configuration: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, spend_trackers: nil, subscriptions: nil, uniqueness_key: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::PackageRetrieveResponse::Data} for more details.
           #
@@ -217,6 +223,8 @@ module MetronomeSDK
           #
           #   @param spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfiguration]
           #
+          #   @param spend_trackers [Array<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker>]
+          #
           #   @param subscriptions [Array<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription>]
           #
           #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
@@ -2186,6 +2194,111 @@ module MetronomeSDK
             #   @return [Array<Symbol>]
           end
 
+          class SpendTracker < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute alias_
+            #   Human-readable identifier, unique per contract.
+            #
+            #   @return [String]
+            required :alias_, String, api_name: :alias
+
+            # @!attribute applicable_spend_specifiers
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier>]
+            required :applicable_spend_specifiers,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier] }
+
+            # @!attribute credit_type_id
+            #
+            #   @return [String]
+            required :credit_type_id, String
+
+            # @!attribute reset_frequency
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ResetFrequency]
+            required :reset_frequency,
+                     enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ResetFrequency }
+
+            # @!method initialize(alias_:, applicable_spend_specifiers:, credit_type_id:, reset_frequency:)
+            #   @param alias_ [String] Human-readable identifier, unique per contract.
+            #
+            #   @param applicable_spend_specifiers [Array<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier>]
+            #
+            #   @param credit_type_id [String]
+            #
+            #   @param reset_frequency [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ResetFrequency]
+
+            class ApplicableSpendSpecifier < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute sources
+              #
+              #   @return [Array<Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::Source>]
+              required :sources,
+                       -> do
+                         MetronomeSDK::Internal::Type::ArrayOf[
+                           enum: MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::Source
+                         ]
+                       end
+
+              # @!attribute spend_type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::SpendType]
+              required :spend_type,
+                       enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::SpendType }
+
+              # @!attribute discounted
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::Discounted, nil]
+              optional :discounted,
+                       enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::Discounted }
+
+              # @!method initialize(sources:, spend_type:, discounted: nil)
+              #   @param sources [Array<Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::Source>]
+              #   @param spend_type [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::SpendType]
+              #   @param discounted [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier::Discounted]
+
+              module Source
+                extend MetronomeSDK::Internal::Type::Enum
+
+                THRESHOLD_RECHARGE = :THRESHOLD_RECHARGE
+                MANUAL = :MANUAL
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier#spend_type
+              module SpendType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                COMMIT_PURCHASE = :COMMIT_PURCHASE
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker::ApplicableSpendSpecifier#discounted
+              module Discounted
+                extend MetronomeSDK::Internal::Type::Enum
+
+                ANY = :ANY
+                DISCOUNTED_ONLY = :DISCOUNTED_ONLY
+                UNDISCOUNTED_ONLY = :UNDISCOUNTED_ONLY
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::SpendTracker#reset_frequency
+            module ResetFrequency
+              extend MetronomeSDK::Internal::Type::Enum
+
+              BILLING_PERIOD = :BILLING_PERIOD
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
           class Subscription < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute collection_schedule
             #