metronome-sdk 0.3.0 → 2.0.0

data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb

@@ -41,6 +41,12 @@ module MetronomeSDK
         #   @return [Array<String>, nil]
         optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
 
+        # @!attribute hierarchy_configuration
+        #   Optional configuration for commit hierarchy access control
+        #
+        #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
+        optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
+
         # @!attribute invoice_contract_id
         #   ID of contract to use for invoicing
         #
@@ -64,6 +70,14 @@ module MetronomeSDK
         #   @return [String, nil]
         optional :product_id, String
 
+        # @!attribute rate_type
+        #   If provided, updates the commit to use the specified rate type for current and
+        #   future invoices. Previously finalized invoices will need to be voided and
+        #   regenerated to reflect the rate type change.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditCommitParams::RateType, nil]
+        optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditCommitParams::RateType }
+
         # @!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
@@ -72,14 +86,12 @@ module MetronomeSDK
         #   Instead, to target usage by product or product tag, pass those values in the
         #   body of `specifiers`.
         #
-        #   @return [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::Specifier>, nil]
+        #   @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
         optional :specifiers,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::Specifier]
-                 },
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
                  nil?: true
 
-        # @!method initialize(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, specifiers: nil, request_options: {})
+        # @!method initialize(commit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_contract_id: nil, invoice_schedule: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V2::ContractEditCommitParams} for more details.
         #
@@ -93,6 +105,8 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If applicable*product_ids, applicable_product*
         #
+        #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
+        #
         #   @param invoice_contract_id [String] ID of contract to use for invoicing
         #
         #   @param invoice_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule]
@@ -101,7 +115,9 @@ module MetronomeSDK
         #
         #   @param product_id [String]
         #
-        #   @param specifiers [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::Specifier>, nil] List of filters that determine what kind of customer usage draws down a commit o
+        #   @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractEditCommitParams::RateType] If provided, updates the commit to use the specified rate type for current and f
+        #
+        #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil] List of filters that determine what kind of customer usage draws down a commit o
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -110,25 +126,19 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule::AddScheduleItem>, nil]
           optional :add_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::AddScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::AddScheduleItem] }
 
           # @!attribute remove_schedule_items
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule::RemoveScheduleItem>, nil]
           optional :remove_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::RemoveScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::RemoveScheduleItem] }
 
           # @!attribute update_schedule_items
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule::UpdateScheduleItem>, nil]
           optional :update_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::UpdateScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::UpdateScheduleItem] }
 
           # @!method initialize(add_schedule_items: nil, remove_schedule_items: nil, update_schedule_items: nil)
           #   @param add_schedule_items [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule::AddScheduleItem>]
@@ -201,25 +211,19 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule::AddScheduleItem>, nil]
           optional :add_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::AddScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::AddScheduleItem] }
 
           # @!attribute remove_schedule_items
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule::RemoveScheduleItem>, nil]
           optional :remove_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::RemoveScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::RemoveScheduleItem] }
 
           # @!attribute update_schedule_items
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule::UpdateScheduleItem>, nil]
           optional :update_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::UpdateScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::UpdateScheduleItem] }
 
           # @!method initialize(add_schedule_items: nil, remove_schedule_items: nil, update_schedule_items: nil)
           #   @param add_schedule_items [Array<MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule::AddScheduleItem>]
@@ -299,42 +303,17 @@ module MetronomeSDK
           end
         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
+        # If provided, updates the commit to use the specified rate type for current and
+        # future invoices. Previously finalized invoices will need to be voided and
+        # regenerated to reflect the rate type change.
+        module RateType
+          extend MetronomeSDK::Internal::Type::Enum
 
-          # @!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]
+          LIST_RATE = :LIST_RATE
+          COMMIT_RATE = :COMMIT_RATE
 
-          # @!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::V2::ContractEditCommitParams::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
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb

@@ -39,6 +39,12 @@ module MetronomeSDK
         #   @return [Array<String>, nil]
         optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
 
+        # @!attribute hierarchy_configuration
+        #   Optional configuration for credit hierarchy access control
+        #
+        #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
+        optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
+
         # @!attribute priority
         #   If multiple commits are applicable, the one with the lower priority will apply
         #   first.
@@ -51,6 +57,14 @@ module MetronomeSDK
         #   @return [String, nil]
         optional :product_id, String
 
+        # @!attribute rate_type
+        #   If provided, updates the credit to use the specified rate type for current and
+        #   future invoices. Previously finalized invoices will need to be voided and
+        #   regenerated to reflect the rate type change.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditCreditParams::RateType, nil]
+        optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditCreditParams::RateType }
+
         # @!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
@@ -59,14 +73,12 @@ module MetronomeSDK
         #   Instead, to target usage by product or product tag, pass those values in the
         #   body of `specifiers`.
         #
-        #   @return [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::Specifier>, nil]
+        #   @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
         optional :specifiers,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCreditParams::Specifier]
-                 },
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
                  nil?: true
 
-        # @!method initialize(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, priority: nil, product_id: nil, specifiers: nil, request_options: {})
+        # @!method initialize(credit_id:, customer_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, priority: nil, product_id: nil, rate_type: nil, specifiers: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::V2::ContractEditCreditParams} for more details.
         #
@@ -80,11 +92,15 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>, nil] Which tags the credit applies to. If both applicable*product_ids and applicable*
         #
+        #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
+        #
         #   @param priority [Float, nil] If multiple commits are applicable, the one with the lower priority will apply f
         #
         #   @param product_id [String]
         #
-        #   @param specifiers [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::Specifier>, nil] List of filters that determine what kind of customer usage draws down a commit o
+        #   @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractEditCreditParams::RateType] If provided, updates the credit to use the specified rate type for current and f
+        #
+        #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil] List of filters that determine what kind of customer usage draws down a commit o
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -93,25 +109,19 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::AccessSchedule::AddScheduleItem>, nil]
           optional :add_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::AddScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::AddScheduleItem] }
 
           # @!attribute remove_schedule_items
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::AccessSchedule::RemoveScheduleItem>, nil]
           optional :remove_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::RemoveScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::RemoveScheduleItem] }
 
           # @!attribute update_schedule_items
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::AccessSchedule::UpdateScheduleItem>, nil]
           optional :update_schedule_items,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::UpdateScheduleItem]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::UpdateScheduleItem] }
 
           # @!method initialize(add_schedule_items: nil, remove_schedule_items: nil, update_schedule_items: nil)
           #   @param add_schedule_items [Array<MetronomeSDK::Models::V2::ContractEditCreditParams::AccessSchedule::AddScheduleItem>]
@@ -179,42 +189,17 @@ module MetronomeSDK
           end
         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
+        # If provided, updates the credit to use the specified rate type for current and
+        # future invoices. Previously finalized invoices will need to be voided and
+        # regenerated to reflect the rate type change.
+        module RateType
+          extend MetronomeSDK::Internal::Type::Enum
 
-          # @!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]
+          LIST_RATE = :LIST_RATE
+          COMMIT_RATE = :COMMIT_RATE
 
-          # @!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::V2::ContractEditCreditParams::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
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end