metronome-sdk 0.2.0 → 1.0.0

data/lib/metronome_sdk/models/credit.rb

@@ -58,6 +58,7 @@ module MetronomeSDK
       optional :contract, -> { MetronomeSDK::Credit::Contract }
 
       # @!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]
@@ -70,8 +71,8 @@ module MetronomeSDK
       # @!attribute hierarchy_configuration
       #   Optional configuration for credit hierarchy access control
       #
-      #   @return [MetronomeSDK::Models::Credit::HierarchyConfiguration, nil]
-      optional :hierarchy_configuration, -> { MetronomeSDK::Credit::HierarchyConfiguration }
+      #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
+      optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
 
       # @!attribute ledger
       #   A list of ordered events that impact the balance of a credit. For example, an
@@ -114,8 +115,8 @@ module MetronomeSDK
       #   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.
       #
-      #   @return [Array<MetronomeSDK::Models::Credit::Specifier>, nil]
-      optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Credit::Specifier] }
+      #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
+      optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
       # @!attribute uniqueness_key
       #   Prevents the creation of duplicates. If a request to create a commit or credit
@@ -148,11 +149,11 @@ module MetronomeSDK
       #
       #   @param contract [MetronomeSDK::Models::Credit::Contract]
       #
-      #   @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]
       #
-      #   @param hierarchy_configuration [MetronomeSDK::Models::Credit::HierarchyConfiguration] Optional configuration for credit hierarchy access control
+      #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
       #
       #   @param ledger [Array<MetronomeSDK::Models::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry>] A list of ordered events that impact the balance of a credit. For example, an in
       #
@@ -166,7 +167,7 @@ module MetronomeSDK
       #
       #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
       #
-      #   @param specifiers [Array<MetronomeSDK::Models::Credit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
+      #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
       #
       #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
 
@@ -208,114 +209,6 @@ module MetronomeSDK
         #   @param id [String]
       end
 
-      # @see MetronomeSDK::Models::Credit#hierarchy_configuration
-      class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute child_access
-        #
-        #   @return [MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
-        required :child_access, union: -> { MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess }
-
-        # @!method initialize(child_access:)
-        #   Optional configuration for credit hierarchy access control
-        #
-        #   @param child_access [MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
-
-        # @see MetronomeSDK::Models::Credit::HierarchyConfiguration#child_access
-        module ChildAccess
-          extend MetronomeSDK::Internal::Type::Union
-
-          variant -> {
-            MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
-          }
-
-          variant -> {
-            MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
-          }
-
-          variant -> {
-            MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
-          }
-
-          class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute type
-            #
-            #   @return [Symbol, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
-            required :type,
-                     enum: -> {
-                       MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
-                     }
-
-            # @!method initialize(type:)
-            #   @param type [Symbol, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
-
-            # @see MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
-            module Type
-              extend MetronomeSDK::Internal::Type::Enum
-
-              ALL = :ALL
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-
-          class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute type
-            #
-            #   @return [Symbol, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
-            required :type,
-                     enum: -> {
-                       MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
-                     }
-
-            # @!method initialize(type:)
-            #   @param type [Symbol, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
-
-            # @see MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
-            module Type
-              extend MetronomeSDK::Internal::Type::Enum
-
-              NONE = :NONE
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-
-          class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute contract_ids
-            #
-            #   @return [Array<String>]
-            required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-            # @!attribute type
-            #
-            #   @return [Symbol, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
-            required :type,
-                     enum: -> {
-                       MetronomeSDK::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
-                     }
-
-            # @!method initialize(contract_ids:, type:)
-            #   @param contract_ids [Array<String>]
-            #   @param type [Symbol, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
-
-            # @see MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
-            module Type
-              extend MetronomeSDK::Internal::Type::Enum
-
-              CONTRACT_IDS = :CONTRACT_IDS
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-
-          # @!method self.variants
-          #   @return [Array(MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
-        end
-      end
-
       module Ledger
         extend MetronomeSDK::Internal::Type::Union
 
@@ -617,10 +510,7 @@ module MetronomeSDK
           # @!attribute type
           #
           #   @return [Symbol, MetronomeSDK::Models::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type]
-          required :type,
-                   enum: -> {
-                     MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type
-                   }
+          required :type, enum: -> { MetronomeSDK::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry::Type }
 
           # @!method initialize(amount:, segment_id:, timestamp:, type:)
           #   @param amount [Float]
@@ -653,43 +543,6 @@ module MetronomeSDK
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      class Specifier < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute presentation_group_values
-        #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
-
-        # @!attribute pricing_group_values
-        #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
-
-        # @!attribute product_id
-        #   If provided, the specifier will only apply to the product with the specified ID.
-        #
-        #   @return [String, nil]
-        optional :product_id, String
-
-        # @!attribute product_tags
-        #   If provided, the specifier will only apply to products with all the specified
-        #   tags.
-        #
-        #   @return [Array<String>, nil]
-        optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-        # @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {MetronomeSDK::Models::Credit::Specifier} for more details.
-        #
-        #   @param presentation_group_values [Hash{Symbol=>String}]
-        #
-        #   @param pricing_group_values [Hash{Symbol=>String}]
-        #
-        #   @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
-        #
-        #   @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
-      end
     end
   end
 end

data/lib/metronome_sdk/models/discount.rb

@@ -19,6 +19,7 @@ module MetronomeSDK
       required :schedule, -> { MetronomeSDK::SchedulePointInTime }
 
       # @!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]
@@ -41,7 +42,7 @@ module MetronomeSDK
       #
       #   @param schedule [MetronomeSDK::Models::SchedulePointInTime]
       #
-      #   @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]
       #

data/lib/metronome_sdk/models/hierarchy_configuration.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    # Either a **parent** configuration with a list of children or a **child**
+    # configuration with a single parent.
+    module HierarchyConfiguration
+      extend MetronomeSDK::Internal::Type::Union
+
+      variant -> { MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration }
+
+      variant -> { MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration }
+
+      class ParentHierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute children
+        #   List of contracts that belong to this parent.
+        #
+        #   @return [Array<MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::Child>]
+        required :children,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::Child] }
+
+        # @!method initialize(children:)
+        #   @param children [Array<MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::Child>] List of contracts that belong to this parent.
+
+        class Child < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute contract_id
+          #
+          #   @return [String]
+          required :contract_id, String
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!method initialize(contract_id:, customer_id:)
+          #   @param contract_id [String]
+          #   @param customer_id [String]
+        end
+      end
+
+      class ChildHierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute parent
+        #   The single parent contract/customer for this child.
+        #
+        #   @return [MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Parent]
+        required :parent, -> { MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent }
+
+        # @!method initialize(parent:)
+        #   @param parent [MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Parent] The single parent contract/customer for this child.
+
+        # @see MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration#parent
+        class Parent < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute contract_id
+          #
+          #   @return [String]
+          required :contract_id, String
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!method initialize(contract_id:, customer_id:)
+          #   The single parent contract/customer for this child.
+          #
+          #   @param contract_id [String]
+          #   @param customer_id [String]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration)]
+    end
+  end
+end

data/lib/metronome_sdk/models/override.rb

@@ -58,14 +58,13 @@ module MetronomeSDK
 
       # @!attribute override_tiers
       #
-      #   @return [Array<MetronomeSDK::Models::Override::OverrideTier>, nil]
-      optional :override_tiers,
-               -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override::OverrideTier] }
+      #   @return [Array<MetronomeSDK::Models::OverrideTier>, nil]
+      optional :override_tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::OverrideTier] }
 
       # @!attribute overwrite_rate
       #
-      #   @return [MetronomeSDK::Models::Override::OverwriteRate, nil]
-      optional :overwrite_rate, -> { MetronomeSDK::Override::OverwriteRate }
+      #   @return [MetronomeSDK::Models::OverwriteRate, nil]
+      optional :overwrite_rate, -> { MetronomeSDK::OverwriteRate }
 
       # @!attribute price
       #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
@@ -142,9 +141,9 @@ module MetronomeSDK
       #
       #   @param override_specifiers [Array<MetronomeSDK::Models::Override::OverrideSpecifier>]
       #
-      #   @param override_tiers [Array<MetronomeSDK::Models::Override::OverrideTier>]
+      #   @param override_tiers [Array<MetronomeSDK::Models::OverrideTier>]
       #
-      #   @param overwrite_rate [MetronomeSDK::Models::Override::OverwriteRate]
+      #   @param overwrite_rate [MetronomeSDK::Models::OverwriteRate]
       #
       #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
       #
@@ -229,100 +228,6 @@ module MetronomeSDK
         end
       end
 
-      class OverrideTier < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute multiplier
-        #
-        #   @return [Float]
-        required :multiplier, Float
-
-        # @!attribute size
-        #
-        #   @return [Float, nil]
-        optional :size, Float
-
-        # @!method initialize(multiplier:, size: nil)
-        #   @param multiplier [Float]
-        #   @param size [Float]
-      end
-
-      # @see MetronomeSDK::Models::Override#overwrite_rate
-      class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute rate_type
-        #
-        #   @return [Symbol, MetronomeSDK::Models::Override::OverwriteRate::RateType]
-        required :rate_type, enum: -> { MetronomeSDK::Override::OverwriteRate::RateType }
-
-        # @!attribute credit_type
-        #
-        #   @return [MetronomeSDK::Models::CreditTypeData, nil]
-        optional :credit_type, -> { MetronomeSDK::CreditTypeData }
-
-        # @!attribute custom_rate
-        #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
-        #   processors.
-        #
-        #   @return [Hash{Symbol=>Object}, nil]
-        optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
-
-        # @!attribute is_prorated
-        #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
-        #   set to true.
-        #
-        #   @return [Boolean, nil]
-        optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
-
-        # @!attribute price
-        #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
-        #   this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
-        #
-        #   @return [Float, nil]
-        optional :price, Float
-
-        # @!attribute quantity
-        #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
-        #
-        #   @return [Float, nil]
-        optional :quantity, Float
-
-        # @!attribute tiers
-        #   Only set for TIERED rate_type.
-        #
-        #   @return [Array<MetronomeSDK::Models::Tier>, nil]
-        optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
-
-        # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {MetronomeSDK::Models::Override::OverwriteRate} for more details.
-        #
-        #   @param rate_type [Symbol, MetronomeSDK::Models::Override::OverwriteRate::RateType]
-        #
-        #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
-        #
-        #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
-        #
-        #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
-        #
-        #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
-        #
-        #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
-        #
-        #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
-
-        # @see MetronomeSDK::Models::Override::OverwriteRate#rate_type
-        module RateType
-          extend MetronomeSDK::Internal::Type::Enum
-
-          FLAT = :FLAT
-          PERCENTAGE = :PERCENTAGE
-          SUBSCRIPTION = :SUBSCRIPTION
-          TIERED = :TIERED
-          CUSTOM = :CUSTOM
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       # @see MetronomeSDK::Models::Override#product
       class Product < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute id

data/lib/metronome_sdk/models/override_tier.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class OverrideTier < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute multiplier
+      #
+      #   @return [Float]
+      required :multiplier, Float
+
+      # @!attribute size
+      #
+      #   @return [Float, nil]
+      optional :size, Float
+
+      # @!method initialize(multiplier:, size: nil)
+      #   @param multiplier [Float]
+      #   @param size [Float]
+    end
+  end
+end

data/lib/metronome_sdk/models/overwrite_rate.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute rate_type
+      #
+      #   @return [Symbol, MetronomeSDK::Models::OverwriteRate::RateType]
+      required :rate_type, enum: -> { MetronomeSDK::OverwriteRate::RateType }
+
+      # @!attribute credit_type
+      #
+      #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+      optional :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+      # @!attribute custom_rate
+      #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
+      #   processors.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+      # @!attribute is_prorated
+      #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+      #   set to true.
+      #
+      #   @return [Boolean, nil]
+      optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+      # @!attribute price
+      #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+      #   this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+      #
+      #   @return [Float, nil]
+      optional :price, Float
+
+      # @!attribute quantity
+      #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+      #
+      #   @return [Float, nil]
+      optional :quantity, Float
+
+      # @!attribute tiers
+      #   Only set for TIERED rate_type.
+      #
+      #   @return [Array<MetronomeSDK::Models::Tier>, nil]
+      optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
+
+      # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::OverwriteRate} for more details.
+      #
+      #   @param rate_type [Symbol, MetronomeSDK::Models::OverwriteRate::RateType]
+      #
+      #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+      #
+      #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
+      #
+      #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+      #
+      #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
+      #
+      #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+      #
+      #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+
+      # @see MetronomeSDK::Models::OverwriteRate#rate_type
+      module RateType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        FLAT = :FLAT
+        PERCENTAGE = :PERCENTAGE
+        SUBSCRIPTION = :SUBSCRIPTION
+        TIERED = :TIERED
+        CUSTOM = :CUSTOM
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end