metronome-sdk 0.3.0 → 1.0.0

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

@@ -21,15 +21,19 @@ module MetronomeSDK
         required :name, String
 
         # @!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]
 
         # @!method initialize(id:, description:, name:, custom_fields: nil)
         #   @param id [String]
+        #
         #   @param description [String]
+        #
         #   @param name [String]
-        #   @param custom_fields [Hash{Symbol=>String}]
+        #
+        #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
       end
     end
   end

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

@@ -11,10 +11,7 @@ module MetronomeSDK
         # @!attribute usage
         #
         #   @return [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>, nil]
-        optional :usage,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageIngestParams::Usage]
-                 }
+        optional :usage, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageIngestParams::Usage] }
 
         # @!method initialize(usage: nil, request_options: {})
         #   @param usage [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>]

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

@@ -38,9 +38,7 @@ module MetronomeSDK
         #
         #   @return [Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>, nil]
         optional :billable_metrics,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageListParams::BillableMetric]
-                 }
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::UsageListParams::BillableMetric] }
 
         # @!attribute customer_ids
         #   A list of Metronome customer IDs to fetch usage for. If absent, usage for all

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

@@ -5,77 +5,60 @@ module MetronomeSDK
     module V1
       # @see MetronomeSDK::Resources::V1::Usage#list
       class UsageListResponse < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute data
+        # @!attribute billable_metric_id
         #
-        #   @return [Array<MetronomeSDK::Models::V1::UsageListResponse::Data>]
-        required :data,
-                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::UsageListResponse::Data] }
+        #   @return [String]
+        required :billable_metric_id, String
 
-        # @!attribute next_page
+        # @!attribute billable_metric_name
         #
-        #   @return [String, nil]
-        required :next_page, String, nil?: true
+        #   @return [String]
+        required :billable_metric_name, String
 
-        # @!method initialize(data:, next_page:)
-        #   @param data [Array<MetronomeSDK::Models::V1::UsageListResponse::Data>]
-        #   @param next_page [String, nil]
-
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute billable_metric_id
-          #
-          #   @return [String]
-          required :billable_metric_id, String
-
-          # @!attribute billable_metric_name
-          #
-          #   @return [String]
-          required :billable_metric_name, String
-
-          # @!attribute customer_id
-          #
-          #   @return [String]
-          required :customer_id, String
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
 
-          # @!attribute end_timestamp
-          #
-          #   @return [Time]
-          required :end_timestamp, Time
+        # @!attribute end_timestamp
+        #
+        #   @return [Time]
+        required :end_timestamp, Time
 
-          # @!attribute start_timestamp
-          #
-          #   @return [Time]
-          required :start_timestamp, Time
+        # @!attribute start_timestamp
+        #
+        #   @return [Time]
+        required :start_timestamp, Time
 
-          # @!attribute value
-          #
-          #   @return [Float, nil]
-          required :value, Float, nil?: true
+        # @!attribute value
+        #
+        #   @return [Float, nil]
+        required :value, Float, nil?: true
 
-          # @!attribute groups
-          #   Values will be either a number or null. Null indicates that there were no
-          #   matches for the group_by value.
-          #
-          #   @return [Hash{Symbol=>Float, nil}, nil]
-          optional :groups, MetronomeSDK::Internal::Type::HashOf[Float, nil?: true]
+        # @!attribute groups
+        #   Values will be either a number or null. Null indicates that there were no
+        #   matches for the group_by value.
+        #
+        #   @return [Hash{Symbol=>Float, nil}, nil]
+        optional :groups, MetronomeSDK::Internal::Type::HashOf[Float, nil?: true]
 
-          # @!method initialize(billable_metric_id:, billable_metric_name:, customer_id:, end_timestamp:, start_timestamp:, value:, groups: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {MetronomeSDK::Models::V1::UsageListResponse::Data} for more details.
-          #
-          #   @param billable_metric_id [String]
-          #
-          #   @param billable_metric_name [String]
-          #
-          #   @param customer_id [String]
-          #
-          #   @param end_timestamp [Time]
-          #
-          #   @param start_timestamp [Time]
-          #
-          #   @param value [Float, nil]
-          #
-          #   @param groups [Hash{Symbol=>Float, nil}] Values will be either a number or null. Null indicates that there were no matche
-        end
+        # @!method initialize(billable_metric_id:, billable_metric_name:, customer_id:, end_timestamp:, start_timestamp:, value:, groups: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::UsageListResponse} for more details.
+        #
+        #   @param billable_metric_id [String]
+        #
+        #   @param billable_metric_name [String]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param end_timestamp [Time]
+        #
+        #   @param start_timestamp [Time]
+        #
+        #   @param value [Float, nil]
+        #
+        #   @param groups [Hash{Symbol=>Float, nil}] Values will be either a number or null. Null indicates that there were no matche
       end
     end
   end

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

@@ -124,6 +124,7 @@ module MetronomeSDK
           optional :archived_at, Time
 
           # @!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]
@@ -151,8 +152,7 @@ module MetronomeSDK
           #   represents a set of properties used to slice events into distinct buckets.
           #
           #   @return [Array<Array<String>>, nil]
-          optional :group_keys,
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Internal::Type::ArrayOf[String]]
+          optional :group_keys, MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Internal::Type::ArrayOf[String]]
 
           # @!attribute property_filters
           #   A list of filters to match events to this billable metric. Each filter defines a
@@ -160,10 +160,7 @@ module MetronomeSDK
           #   billable metric.
           #
           #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
-          optional :property_filters,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::PropertyFilter]
-                   }
+          optional :property_filters, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::PropertyFilter] }
 
           # @!attribute sql
           #   The SQL query associated with the billable metric
@@ -190,7 +187,7 @@ module MetronomeSDK
           #
           #   @param archived_at [Time] RFC 3339 timestamp indicating when the billable metric was archived. If not prov
           #
-          #   @param custom_fields [Hash{Symbol=>String}]
+          #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           #
           #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
           #

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

@@ -64,6 +64,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 +80,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, 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.
         #
@@ -101,7 +107,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 +118,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 +203,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 +295,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]
+        # 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 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
+          LIST_RATE = :LIST_RATE
+          COMMIT_RATE = :COMMIT_RATE
 
-          # @!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::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

@@ -51,6 +51,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 +67,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, 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.
         #
@@ -84,7 +90,9 @@ module MetronomeSDK
         #
         #   @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 +101,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 +181,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]
+        # 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 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
+          LIST_RATE = :LIST_RATE
+          COMMIT_RATE = :COMMIT_RATE
 
-          # @!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::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