metronome-sdk 0.3.0 → 2.0.0

data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb

@@ -64,6 +64,7 @@ module MetronomeSDK
           optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[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]
@@ -120,11 +121,8 @@ module MetronomeSDK
           #   specifiers to contribute to a commit's or credit's drawdown. This field cannot
           #   be used together with `applicable_product_ids` or `applicable_product_tags`.
           #
-          #   @return [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::Specifier>, nil]
-          optional :specifiers,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::Specifier]
-                   }
+          #   @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
+          optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
 
           # @!attribute uniqueness_key
           #   Prevents the creation of duplicates. If a request to create a commit or credit
@@ -155,7 +153,7 @@ module MetronomeSDK
           #
           #   @param applicable_product_tags [Array<String>] Which tags the commit applies to. If applicable*product_ids, applicable_product*
           #
-          #   @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] Used only in UI/API. It is not exposed to end customers.
           #
@@ -171,7 +169,7 @@ module MetronomeSDK
           #
           #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
           #
-          #   @param specifiers [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
+          #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] 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
           #
@@ -182,9 +180,7 @@ module MetronomeSDK
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem>]
             required :schedule_items,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem] }
 
             # @!attribute credit_type_id
             #   Defaults to USD (cents) if not passed
@@ -258,18 +254,14 @@ module MetronomeSDK
             #
             #   @return [MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule, nil]
             optional :recurring_schedule,
-                     -> {
-                       MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule
-                     }
+                     -> { MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule }
 
             # @!attribute schedule_items
             #   Either provide amount or provide both unit_price and quantity.
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem>, nil]
             optional :schedule_items,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem] }
 
             # @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
             #   Some parameter documentations has been truncated, see
@@ -295,9 +287,7 @@ module MetronomeSDK
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::AmountDistribution]
               required :amount_distribution,
-                       enum: -> {
-                         MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::AmountDistribution
-                       }
+                       enum: -> { MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::AmountDistribution }
 
               # @!attribute ending_before
               #   RFC 3339 timestamp (exclusive).
@@ -309,9 +299,7 @@ module MetronomeSDK
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::Frequency]
               required :frequency,
-                       enum: -> {
-                         MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::Frequency
-                       }
+                       enum: -> { MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::Frequency }
 
               # @!attribute starting_at
               #   RFC 3339 timestamp (inclusive).
@@ -447,44 +435,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::V1::Customers::CommitCreateParams::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/v1/customers/credit_create_params.rb

@@ -54,6 +54,7 @@ module MetronomeSDK
           optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[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]
@@ -93,11 +94,8 @@ module MetronomeSDK
           #   specifiers to contribute to a commit's or credit's drawdown. This field cannot
           #   be used together with `applicable_product_ids` or `applicable_product_tags`.
           #
-          #   @return [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::Specifier>, nil]
-          optional :specifiers,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CreditCreateParams::Specifier]
-                   }
+          #   @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
+          optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
 
           # @!attribute uniqueness_key
           #   Prevents the creation of duplicates. If a request to create a commit or credit
@@ -126,7 +124,7 @@ module MetronomeSDK
           #
           #   @param applicable_product_tags [Array<String>] Which tags the credit applies to. If both applicable*product_ids and applicable*
           #
-          #   @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] Used only in UI/API. It is not exposed to end customers.
           #
@@ -138,7 +136,7 @@ module MetronomeSDK
           #
           #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
           #
-          #   @param specifiers [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
+          #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] 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
           #
@@ -149,9 +147,7 @@ module MetronomeSDK
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem>]
             required :schedule_items,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem] }
 
             # @!attribute credit_type_id
             #   Defaults to USD (cents) if not passed
@@ -202,44 +198,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::V1::Customers::CreditCreateParams::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/v1/customers/customer_alert.rb

@@ -4,6 +4,7 @@ module MetronomeSDK
   module Models
     module V1
       module Customers
+        # @see MetronomeSDK::Resources::V1::Customers::Alerts#list
         class CustomerAlert < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute alert
           #
@@ -11,8 +12,8 @@ module MetronomeSDK
           required :alert, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert }
 
           # @!attribute customer_status
-          #   The status of the customer alert. If the alert is archived, null will be
-          #   returned.
+          #   The status of the threshold notification. If the notification is archived, null
+          #   will be returned.
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil]
           required :customer_status,
@@ -20,7 +21,7 @@ module MetronomeSDK
                    nil?: true
 
           # @!attribute triggered_by
-          #   If present, indicates the reason the alert was triggered.
+          #   If present, indicates the reason the threshold notification was triggered.
           #
           #   @return [String, nil]
           optional :triggered_by, String, nil?: true
@@ -31,52 +32,53 @@ module MetronomeSDK
           #
           #   @param alert [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert]
           #
-          #   @param customer_status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil] The status of the customer alert. If the alert is archived, null will be returne
+          #   @param customer_status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::CustomerStatus, nil] The status of the threshold notification. If the notification is archived, null
           #
-          #   @param triggered_by [String, nil] If present, indicates the reason the alert was triggered.
+          #   @param triggered_by [String, nil] If present, indicates the reason the threshold notification was triggered.
 
           # @see MetronomeSDK::Models::V1::Customers::CustomerAlert#alert
           class Alert < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute id
-            #   the Metronome ID of the alert
+            #   the Metronome ID of the threshold notification
             #
             #   @return [String]
             required :id, String
 
             # @!attribute name
-            #   Name of the alert
+            #   Name of the threshold notification
             #
             #   @return [String]
             required :name, String
 
             # @!attribute status
-            #   Status of the alert
+            #   Status of the threshold notification
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status]
             required :status, enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::Status }
 
             # @!attribute threshold
-            #   Threshold value of the alert policy
+            #   Threshold value of the notification policy
             #
             #   @return [Float]
             required :threshold, Float
 
             # @!attribute type
-            #   Type of the alert
+            #   Type of the threshold notification
             #
             #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type]
             required :type, enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type }
 
             # @!attribute updated_at
-            #   Timestamp for when the alert was last updated
+            #   Timestamp for when the threshold notification was last updated
             #
             #   @return [Time]
             required :updated_at, Time
 
             # @!attribute credit_grant_type_filters
-            #   An array of strings, representing a way to filter the credit grant this alert
-            #   applies to, by looking at the credit_grant_type field on the credit grant. This
-            #   field is only defined for CreditPercentage and CreditBalance alerts
+            #   An array of strings, representing a way to filter the credit grant this
+            #   threshold notification applies to, by looking at the credit_grant_type field on
+            #   the credit grant. This field is only defined for CreditPercentage and
+            #   CreditBalance notifications
             #
             #   @return [Array<String>, nil]
             optional :credit_grant_type_filters, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -87,37 +89,31 @@ module MetronomeSDK
             optional :credit_type, -> { MetronomeSDK::CreditTypeData }, nil?: true
 
             # @!attribute custom_field_filters
-            #   A list of custom field filters for alert types that support advanced filtering
+            #   A list of custom field filters for notification types that support advanced
+            #   filtering
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>, nil]
             optional :custom_field_filters,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter] }
 
             # @!attribute group_key_filter
-            #   Scopes alert evaluation to a specific presentation group key on individual line
-            #   items. Only present for spend alerts.
+            #   Scopes threshold notification evaluation to a specific presentation group key on
+            #   individual line items. Only present for spend notifications.
             #
             #   @return [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter, nil]
-            optional :group_key_filter,
-                     -> {
-                       MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter
-                     }
+            optional :group_key_filter, -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupKeyFilter }
 
             # @!attribute group_values
-            #   Only present for `spend_threshold_reached` alerts. Scope alert to a specific
-            #   group key on individual line items.
+            #   Only present for `spend_threshold_reached` notifications. Scope notification to
+            #   a specific group key on individual line items.
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>, nil]
             optional :group_values,
-                     -> {
-                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue]
-                     }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert::Alert::GroupValue] }
 
             # @!attribute invoice_types_filter
-            #   Only supported for invoice_total_reached alerts. A list of invoice types to
-            #   evaluate.
+            #   Only supported for invoice_total_reached threshold notifications. A list of
+            #   invoice types to evaluate.
             #
             #   @return [Array<String>, nil]
             optional :invoice_types_filter, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -134,33 +130,33 @@ module MetronomeSDK
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert} for more details.
             #
-            #   @param id [String] the Metronome ID of the alert
+            #   @param id [String] the Metronome ID of the threshold notification
             #
-            #   @param name [String] Name of the alert
+            #   @param name [String] Name of the threshold notification
             #
-            #   @param status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status] Status of the alert
+            #   @param status [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Status] Status of the threshold notification
             #
-            #   @param threshold [Float] Threshold value of the alert policy
+            #   @param threshold [Float] Threshold value of the notification policy
             #
-            #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type] Type of the alert
+            #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::Type] Type of the threshold notification
             #
-            #   @param updated_at [Time] Timestamp for when the alert was last updated
+            #   @param updated_at [Time] Timestamp for when the threshold notification was last updated
             #
-            #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
+            #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this threshol
             #
             #   @param credit_type [MetronomeSDK::Models::CreditTypeData, nil]
             #
-            #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering
+            #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter>] A list of custom field filters for notification types that support advanced filt
             #
-            #   @param group_key_filter [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
+            #   @param group_key_filter [MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupKeyFilter] Scopes threshold notification evaluation to a specific presentation group key on
             #
-            #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>] Only present for `spend_threshold_reached` alerts. Scope alert to a specific gro
+            #   @param group_values [Array<MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::GroupValue>] Only present for `spend_threshold_reached` notifications. Scope notification to
             #
-            #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
+            #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached threshold notifications. A list of invo
             #
             #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
 
-            # Status of the alert
+            # Status of the threshold notification
             #
             # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert#status
             module Status
@@ -174,7 +170,7 @@ module MetronomeSDK
               #   @return [Array<Symbol>]
             end
 
-            # Type of the alert
+            # Type of the threshold notification
             #
             # @see MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert#type
             module Type
@@ -206,9 +202,7 @@ module MetronomeSDK
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CustomerAlert::Alert::CustomFieldFilter::Entity]
               required :entity,
-                       enum: -> {
-                         MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter::Entity
-                       }
+                       enum: -> { MetronomeSDK::V1::Customers::CustomerAlert::Alert::CustomFieldFilter::Entity }
 
               # @!attribute key
               #
@@ -251,8 +245,8 @@ module MetronomeSDK
               required :value, String
 
               # @!method initialize(key:, value:)
-              #   Scopes alert evaluation to a specific presentation group key on individual line
-              #   items. Only present for spend alerts.
+              #   Scopes threshold notification evaluation to a specific presentation group key on
+              #   individual line items. Only present for spend notifications.
               #
               #   @param key [String]
               #   @param value [String]
@@ -266,17 +260,17 @@ module MetronomeSDK
 
               # @!attribute value
               #
-              #   @return [String]
-              required :value, String
+              #   @return [String, nil]
+              optional :value, String
 
-              # @!method initialize(key:, value:)
+              # @!method initialize(key:, value: nil)
               #   @param key [String]
               #   @param value [String]
             end
           end
 
-          # The status of the customer alert. If the alert is archived, null will be
-          # returned.
+          # The status of the threshold notification. If the notification is archived, null
+          # will be returned.
           #
           # @see MetronomeSDK::Models::V1::Customers::CustomerAlert#customer_status
           module CustomerStatus