metronome-sdk 3.6.0 → 3.7.0

data/rbi/metronome_sdk/models/contract.rbi

@@ -119,6 +119,17 @@ module MetronomeSDK
       end
       attr_writer :spend_threshold_configuration
 
+      # Spend trackers attached to this contract.
+      sig { returns(T.nilable(T::Array[MetronomeSDK::Contract::SpendTracker])) }
+      attr_reader :spend_trackers
+
+      sig do
+        params(
+          spend_trackers: T::Array[MetronomeSDK::Contract::SpendTracker::OrHash]
+        ).void
+      end
+      attr_writer :spend_trackers
+
       # List of subscriptions on the contract.
       sig { returns(T.nilable(T::Array[MetronomeSDK::Subscription])) }
       attr_reader :subscriptions
@@ -155,6 +166,8 @@ module MetronomeSDK
             MetronomeSDK::Contract::ScheduledChargesOnUsageInvoices::OrSymbol,
           spend_threshold_configuration:
             MetronomeSDK::SpendThresholdConfiguration::OrHash,
+          spend_trackers:
+            T::Array[MetronomeSDK::Contract::SpendTracker::OrHash],
           subscriptions: T::Array[MetronomeSDK::Subscription::OrHash],
           uniqueness_key: String
         ).returns(T.attached_class)
@@ -182,6 +195,8 @@ module MetronomeSDK
         # on a separate invoice from usage charges.
         scheduled_charges_on_usage_invoices: nil,
         spend_threshold_configuration: nil,
+        # Spend trackers attached to this contract.
+        spend_trackers: nil,
         # List of subscriptions on the contract.
         subscriptions: nil,
         # Prevents the creation of duplicates. If a request to create a record is made
@@ -210,6 +225,7 @@ module MetronomeSDK
               MetronomeSDK::Contract::ScheduledChargesOnUsageInvoices::TaggedSymbol,
             spend_threshold_configuration:
               MetronomeSDK::SpendThresholdConfiguration,
+            spend_trackers: T::Array[MetronomeSDK::Contract::SpendTracker],
             subscriptions: T::Array[MetronomeSDK::Subscription],
             uniqueness_key: String
           }
@@ -768,6 +784,344 @@ module MetronomeSDK
         def self.values
         end
       end
+
+      class SpendTracker < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Contract::SpendTracker,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # Human-readable identifier, unique per contract.
+        sig { returns(String) }
+        attr_accessor :alias_
+
+        sig do
+          returns(
+            T::Array[
+              MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier
+            ]
+          )
+        end
+        attr_accessor :applicable_spend_specifiers
+
+        sig { returns(String) }
+        attr_accessor :credit_type_id
+
+        sig do
+          returns(
+            MetronomeSDK::Contract::SpendTracker::ResetFrequency::TaggedSymbol
+          )
+        end
+        attr_accessor :reset_frequency
+
+        sig do
+          returns(
+            T.nilable(MetronomeSDK::Contract::SpendTracker::AccumulatedSpend)
+          )
+        end
+        attr_reader :accumulated_spend
+
+        sig do
+          params(
+            accumulated_spend:
+              MetronomeSDK::Contract::SpendTracker::AccumulatedSpend::OrHash
+          ).void
+        end
+        attr_writer :accumulated_spend
+
+        sig do
+          params(
+            alias_: String,
+            applicable_spend_specifiers:
+              T::Array[
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::OrHash
+              ],
+            credit_type_id: String,
+            reset_frequency:
+              MetronomeSDK::Contract::SpendTracker::ResetFrequency::OrSymbol,
+            accumulated_spend:
+              MetronomeSDK::Contract::SpendTracker::AccumulatedSpend::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Human-readable identifier, unique per contract.
+          alias_:,
+          applicable_spend_specifiers:,
+          credit_type_id:,
+          reset_frequency:,
+          accumulated_spend: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              alias_: String,
+              applicable_spend_specifiers:
+                T::Array[
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier
+                ],
+              credit_type_id: String,
+              reset_frequency:
+                MetronomeSDK::Contract::SpendTracker::ResetFrequency::TaggedSymbol,
+              accumulated_spend:
+                MetronomeSDK::Contract::SpendTracker::AccumulatedSpend
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class ApplicableSpendSpecifier < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T::Array[
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+              ]
+            )
+          end
+          attr_accessor :sources
+
+          sig do
+            returns(
+              MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType::TaggedSymbol
+            )
+          end
+          attr_accessor :spend_type
+
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :discounted
+
+          sig do
+            params(
+              discounted:
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted::OrSymbol
+            ).void
+          end
+          attr_writer :discounted
+
+          sig do
+            params(
+              sources:
+                T::Array[
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Source::OrSymbol
+                ],
+              spend_type:
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType::OrSymbol,
+              discounted:
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(sources:, spend_type:, discounted: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                sources:
+                  T::Array[
+                    MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+                  ],
+                spend_type:
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType::TaggedSymbol,
+                discounted:
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Source
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Source
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            THRESHOLD_RECHARGE =
+              T.let(
+                :THRESHOLD_RECHARGE,
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+              )
+            MANUAL =
+              T.let(
+                :MANUAL,
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module SpendType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            COMMIT_PURCHASE =
+              T.let(
+                :COMMIT_PURCHASE,
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::SpendType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Discounted
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ANY =
+              T.let(
+                :ANY,
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              )
+            DISCOUNTED_ONLY =
+              T.let(
+                :DISCOUNTED_ONLY,
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              )
+            UNDISCOUNTED_ONLY =
+              T.let(
+                :UNDISCOUNTED_ONLY,
+                MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::Contract::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        module ResetFrequency
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::Contract::SpendTracker::ResetFrequency
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BILLING_PERIOD =
+            T.let(
+              :BILLING_PERIOD,
+              MetronomeSDK::Contract::SpendTracker::ResetFrequency::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::Contract::SpendTracker::ResetFrequency::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class AccumulatedSpend < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Contract::SpendTracker::AccumulatedSpend,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Float) }
+          attr_accessor :amount
+
+          sig { returns(Time) }
+          attr_accessor :period_ending_before
+
+          sig { returns(Time) }
+          attr_accessor :period_starting_at
+
+          sig do
+            params(
+              amount: Float,
+              period_ending_before: Time,
+              period_starting_at: Time
+            ).returns(T.attached_class)
+          end
+          def self.new(amount:, period_ending_before:, period_starting_at:)
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: Float,
+                period_ending_before: Time,
+                period_starting_at: Time
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
     end
   end
 end