metronome-sdk 0.2.0 → 1.0.0

data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi

@@ -48,6 +48,13 @@ module MetronomeSDK
           sig { params(composite_tags: T::Array[String]).void }
           attr_writer :composite_tags
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :custom_fields
+
+          sig { params(custom_fields: T::Hash[Symbol, String]).void }
+          attr_writer :custom_fields
+
           # Beta feature only available for composite products. If true, products with $0
           # will not be included when computing composite usage. Defaults to false
           sig { returns(T.nilable(T::Boolean)) }
@@ -150,6 +157,7 @@ module MetronomeSDK
               billable_metric_id: String,
               composite_product_ids: T::Array[String],
               composite_tags: T::Array[String],
+              custom_fields: T::Hash[Symbol, String],
               exclude_free_usage: T::Boolean,
               is_refundable: T::Boolean,
               netsuite_internal_item_id: String,
@@ -178,6 +186,8 @@ module MetronomeSDK
             composite_product_ids: nil,
             # Required for COMPOSITE products
             composite_tags: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+            custom_fields: nil,
             # Beta feature only available for composite products. If true, products with $0
             # will not be included when computing composite usage. Defaults to false
             exclude_free_usage: nil,
@@ -224,6 +234,7 @@ module MetronomeSDK
                 billable_metric_id: String,
                 composite_product_ids: T::Array[String],
                 composite_tags: T::Array[String],
+                custom_fields: T::Hash[Symbol, String],
                 exclude_free_usage: T::Boolean,
                 is_refundable: T::Boolean,
                 netsuite_internal_item_id: String,

data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi

@@ -55,6 +55,7 @@ module MetronomeSDK
           sig { returns(T.nilable(Time)) }
           attr_accessor :archived_at
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :custom_fields
 
@@ -85,6 +86,7 @@ module MetronomeSDK
             type:,
             updates:,
             archived_at: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields: nil
           )
           end

data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi

@@ -101,6 +101,7 @@ module MetronomeSDK
             sig { returns(T.nilable(Time)) }
             attr_accessor :archived_at
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :custom_fields
 
@@ -131,6 +132,7 @@ module MetronomeSDK
               type:,
               updates:,
               archived_at: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               custom_fields: nil
             )
             end

data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_params.rbi

@@ -66,6 +66,7 @@ module MetronomeSDK
           end
           attr_writer :credit_type_conversions
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :custom_fields
 
@@ -112,6 +113,7 @@ module MetronomeSDK
             aliases: nil,
             # Required when using custom pricing units in rates.
             credit_type_conversions: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields: nil,
             description: nil,
             # The Metronome ID of the credit type to associate with the rate card, defaults to

data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi

@@ -67,6 +67,7 @@ module MetronomeSDK
           end
           attr_writer :credit_type_conversions
 
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           sig { returns(T.nilable(T::Hash[Symbol, String])) }
           attr_reader :custom_fields
 
@@ -113,6 +114,7 @@ module MetronomeSDK
             name:,
             aliases: nil,
             credit_type_conversions: nil,
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             custom_fields: nil,
             description: nil,
             fiat_credit_type: nil

data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi

@@ -63,6 +63,7 @@ module MetronomeSDK
             sig { returns(T::Boolean) }
             attr_accessor :entitled
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T::Hash[Symbol, String]) }
             attr_accessor :product_custom_fields
 
@@ -103,21 +104,10 @@ module MetronomeSDK
 
             # A distinct rate on the rate card. You can choose to use this rate rather than
             # list rate when consuming a credit or commit.
-            sig do
-              returns(
-                T.nilable(
-                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate
-                )
-              )
-            end
+            sig { returns(T.nilable(MetronomeSDK::CommitRate)) }
             attr_reader :commit_rate
 
-            sig do
-              params(
-                commit_rate:
-                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::OrHash
-              ).void
-            end
+            sig { params(commit_rate: MetronomeSDK::CommitRate::OrHash).void }
             attr_writer :commit_rate
 
             sig { returns(T.nilable(Time)) }
@@ -143,14 +133,14 @@ module MetronomeSDK
                 starting_at: Time,
                 billing_frequency:
                   MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::OrSymbol,
-                commit_rate:
-                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::OrHash,
+                commit_rate: MetronomeSDK::CommitRate::OrHash,
                 ending_before: Time,
                 pricing_group_values: T::Hash[Symbol, String]
               ).returns(T.attached_class)
             end
             def self.new(
               entitled:,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               product_custom_fields:,
               product_id:,
               product_name:,
@@ -178,8 +168,7 @@ module MetronomeSDK
                   starting_at: Time,
                   billing_frequency:
                     MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::TaggedSymbol,
-                  commit_rate:
-                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate,
+                  commit_rate: MetronomeSDK::CommitRate,
                   ending_before: Time,
                   pricing_group_values: T::Hash[Symbol, String]
                 }
@@ -231,118 +220,6 @@ module MetronomeSDK
               def self.values
               end
             end
-
-            class CommitRate < MetronomeSDK::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate,
-                    MetronomeSDK::Internal::AnyHash
-                  )
-                end
-
-              sig do
-                returns(
-                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
-                )
-              end
-              attr_accessor :rate_type
-
-              # Commit rate price. For FLAT rate_type, this must be >=0.
-              sig { returns(T.nilable(Float)) }
-              attr_reader :price
-
-              sig { params(price: Float).void }
-              attr_writer :price
-
-              # Only set for TIERED rate_type.
-              sig { returns(T.nilable(T::Array[MetronomeSDK::Tier])) }
-              attr_reader :tiers
-
-              sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
-              attr_writer :tiers
-
-              # A distinct rate on the rate card. You can choose to use this rate rather than
-              # list rate when consuming a credit or commit.
-              sig do
-                params(
-                  rate_type:
-                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::OrSymbol,
-                  price: Float,
-                  tiers: T::Array[MetronomeSDK::Tier::OrHash]
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                rate_type:,
-                # Commit rate price. For FLAT rate_type, this must be >=0.
-                price: nil,
-                # Only set for TIERED rate_type.
-                tiers: nil
-              )
-              end
-
-              sig do
-                override.returns(
-                  {
-                    rate_type:
-                      MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol,
-                    price: Float,
-                    tiers: T::Array[MetronomeSDK::Tier]
-                  }
-                )
-              end
-              def to_hash
-              end
-
-              module RateType
-                extend MetronomeSDK::Internal::Type::Enum
-
-                TaggedSymbol =
-                  T.type_alias do
-                    T.all(
-                      Symbol,
-                      MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType
-                    )
-                  end
-                OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-                FLAT =
-                  T.let(
-                    :FLAT,
-                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
-                  )
-                PERCENTAGE =
-                  T.let(
-                    :PERCENTAGE,
-                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
-                  )
-                SUBSCRIPTION =
-                  T.let(
-                    :SUBSCRIPTION,
-                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
-                  )
-                TIERED =
-                  T.let(
-                    :TIERED,
-                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
-                  )
-                CUSTOM =
-                  T.let(
-                    :CUSTOM,
-                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
-                  )
-
-                sig do
-                  override.returns(
-                    T::Array[
-                      MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::RateType::TaggedSymbol
-                    ]
-                  )
-                end
-                def self.values
-                end
-              end
-            end
           end
         end
       end

data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi

@@ -111,6 +111,7 @@ module MetronomeSDK
             end
             attr_writer :credit_type_conversions
 
+            # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
             sig { returns(T.nilable(T::Hash[Symbol, String])) }
             attr_reader :custom_fields
 
@@ -159,6 +160,7 @@ module MetronomeSDK
               name:,
               aliases: nil,
               credit_type_conversions: nil,
+              # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
               custom_fields: nil,
               description: nil,
               fiat_credit_type: nil

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi

@@ -105,21 +105,10 @@ module MetronomeSDK
 
               # A distinct rate on the rate card. You can choose to use this rate rather than
               # list rate when consuming a credit or commit.
-              sig do
-                returns(
-                  T.nilable(
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate
-                  )
-                )
-              end
+              sig { returns(T.nilable(MetronomeSDK::CommitRate)) }
               attr_reader :commit_rate
 
-              sig do
-                params(
-                  commit_rate:
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::OrHash
-                ).void
-              end
+              sig { params(commit_rate: MetronomeSDK::CommitRate::OrHash).void }
               attr_writer :commit_rate
 
               # "The Metronome ID of the credit type to associate with price, defaults to USD
@@ -203,8 +192,7 @@ module MetronomeSDK
                   starting_at: Time,
                   billing_frequency:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::OrSymbol,
-                  commit_rate:
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::OrHash,
+                  commit_rate: MetronomeSDK::CommitRate::OrHash,
                   credit_type_id: String,
                   custom_rate: T::Hash[Symbol, T.anything],
                   ending_before: Time,
@@ -269,8 +257,7 @@ module MetronomeSDK
                     starting_at: Time,
                     billing_frequency:
                       MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::OrSymbol,
-                    commit_rate:
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate,
+                    commit_rate: MetronomeSDK::CommitRate,
                     credit_type_id: String,
                     custom_rate: T::Hash[Symbol, T.anything],
                     ending_before: Time,
@@ -380,118 +367,6 @@ module MetronomeSDK
                 def self.values
                 end
               end
-
-              class CommitRate < MetronomeSDK::Internal::Type::BaseModel
-                OrHash =
-                  T.type_alias do
-                    T.any(
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate,
-                      MetronomeSDK::Internal::AnyHash
-                    )
-                  end
-
-                sig do
-                  returns(
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::OrSymbol
-                  )
-                end
-                attr_accessor :rate_type
-
-                # Commit rate price. For FLAT rate_type, this must be >=0.
-                sig { returns(T.nilable(Float)) }
-                attr_reader :price
-
-                sig { params(price: Float).void }
-                attr_writer :price
-
-                # Only set for TIERED rate_type.
-                sig { returns(T.nilable(T::Array[MetronomeSDK::Tier])) }
-                attr_reader :tiers
-
-                sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
-                attr_writer :tiers
-
-                # A distinct rate on the rate card. You can choose to use this rate rather than
-                # list rate when consuming a credit or commit.
-                sig do
-                  params(
-                    rate_type:
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::OrSymbol,
-                    price: Float,
-                    tiers: T::Array[MetronomeSDK::Tier::OrHash]
-                  ).returns(T.attached_class)
-                end
-                def self.new(
-                  rate_type:,
-                  # Commit rate price. For FLAT rate_type, this must be >=0.
-                  price: nil,
-                  # Only set for TIERED rate_type.
-                  tiers: nil
-                )
-                end
-
-                sig do
-                  override.returns(
-                    {
-                      rate_type:
-                        MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::OrSymbol,
-                      price: Float,
-                      tiers: T::Array[MetronomeSDK::Tier]
-                    }
-                  )
-                end
-                def to_hash
-                end
-
-                module RateType
-                  extend MetronomeSDK::Internal::Type::Enum
-
-                  TaggedSymbol =
-                    T.type_alias do
-                      T.all(
-                        Symbol,
-                        MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType
-                      )
-                    end
-                  OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-                  FLAT =
-                    T.let(
-                      :FLAT,
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::TaggedSymbol
-                    )
-                  PERCENTAGE =
-                    T.let(
-                      :PERCENTAGE,
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::TaggedSymbol
-                    )
-                  SUBSCRIPTION =
-                    T.let(
-                      :SUBSCRIPTION,
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::TaggedSymbol
-                    )
-                  TIERED =
-                    T.let(
-                      :TIERED,
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::TaggedSymbol
-                    )
-                  CUSTOM =
-                    T.let(
-                      :CUSTOM,
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::TaggedSymbol
-                    )
-
-                  sig do
-                    override.returns(
-                      T::Array[
-                        MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType::TaggedSymbol
-                      ]
-                    )
-                  end
-                  def self.values
-                  end
-                end
-              end
             end
           end
         end

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi

@@ -60,21 +60,10 @@ module MetronomeSDK
 
             # A distinct rate on the rate card. You can choose to use this rate rather than
             # list rate when consuming a credit or commit.
-            sig do
-              returns(
-                T.nilable(
-                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate
-                )
-              )
-            end
+            sig { returns(T.nilable(MetronomeSDK::CommitRate)) }
             attr_reader :commit_rate
 
-            sig do
-              params(
-                commit_rate:
-                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::OrHash
-              ).void
-            end
+            sig { params(commit_rate: MetronomeSDK::CommitRate::OrHash).void }
             attr_writer :commit_rate
 
             # The Metronome ID of the credit type to associate with price, defaults to USD
@@ -159,8 +148,7 @@ module MetronomeSDK
                 starting_at: Time,
                 billing_frequency:
                   MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol,
-                commit_rate:
-                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::OrHash,
+                commit_rate: MetronomeSDK::CommitRate::OrHash,
                 credit_type_id: String,
                 custom_rate: T::Hash[Symbol, T.anything],
                 ending_before: Time,
@@ -230,8 +218,7 @@ module MetronomeSDK
                   starting_at: Time,
                   billing_frequency:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol,
-                  commit_rate:
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate,
+                  commit_rate: MetronomeSDK::CommitRate,
                   credit_type_id: String,
                   custom_rate: T::Hash[Symbol, T.anything],
                   ending_before: Time,
@@ -342,118 +329,6 @@ module MetronomeSDK
               def self.values
               end
             end
-
-            class CommitRate < MetronomeSDK::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate,
-                    MetronomeSDK::Internal::AnyHash
-                  )
-                end
-
-              sig do
-                returns(
-                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol
-                )
-              end
-              attr_accessor :rate_type
-
-              # Commit rate price. For FLAT rate_type, this must be >=0.
-              sig { returns(T.nilable(Float)) }
-              attr_reader :price
-
-              sig { params(price: Float).void }
-              attr_writer :price
-
-              # Only set for TIERED rate_type.
-              sig { returns(T.nilable(T::Array[MetronomeSDK::Tier])) }
-              attr_reader :tiers
-
-              sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
-              attr_writer :tiers
-
-              # A distinct rate on the rate card. You can choose to use this rate rather than
-              # list rate when consuming a credit or commit.
-              sig do
-                params(
-                  rate_type:
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol,
-                  price: Float,
-                  tiers: T::Array[MetronomeSDK::Tier::OrHash]
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                rate_type:,
-                # Commit rate price. For FLAT rate_type, this must be >=0.
-                price: nil,
-                # Only set for TIERED rate_type.
-                tiers: nil
-              )
-              end
-
-              sig do
-                override.returns(
-                  {
-                    rate_type:
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol,
-                    price: Float,
-                    tiers: T::Array[MetronomeSDK::Tier]
-                  }
-                )
-              end
-              def to_hash
-              end
-
-              module RateType
-                extend MetronomeSDK::Internal::Type::Enum
-
-                TaggedSymbol =
-                  T.type_alias do
-                    T.all(
-                      Symbol,
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType
-                    )
-                  end
-                OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-                FLAT =
-                  T.let(
-                    :FLAT,
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
-                  )
-                PERCENTAGE =
-                  T.let(
-                    :PERCENTAGE,
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
-                  )
-                SUBSCRIPTION =
-                  T.let(
-                    :SUBSCRIPTION,
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
-                  )
-                TIERED =
-                  T.let(
-                    :TIERED,
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
-                  )
-                CUSTOM =
-                  T.let(
-                    :CUSTOM,
-                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
-                  )
-
-                sig do
-                  override.returns(
-                    T::Array[
-                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
-                    ]
-                  )
-                end
-                def self.values
-                end
-              end
-            end
           end
         end
       end