metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.3

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

@@ -7,11 +7,134 @@ module MetronomeSDK
       class CustomerRetrieveResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::V1::CustomerDetail]
-        required :data, -> { MetronomeSDK::V1::CustomerDetail }
+        #   @return [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::V1::CustomerDetail]
+        #   @param data [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::CustomerRetrieveResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   the Metronome ID of the customer
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   RFC 3339 timestamp indicating when the customer was created.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}]
+          required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+          # @!attribute customer_config
+          #
+          #   @return [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig]
+          required :customer_config, -> { MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig }
+
+          # @!attribute external_id
+          #   (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+          #   alias) that can be used in usage events
+          #
+          #   @return [String]
+          required :external_id, String
+
+          # @!attribute ingest_aliases
+          #   aliases for this customer that can be used instead of the Metronome customer ID
+          #   in usage events
+          #
+          #   @return [Array<String>]
+          required :ingest_aliases, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute archived_at
+          #   RFC 3339 timestamp indicating when the customer was archived. Null if the
+          #   customer is active.
+          #
+          #   @return [Time, nil]
+          optional :archived_at, Time, nil?: true
+
+          # @!attribute current_billable_status
+          #   This field's availability is dependent on your client's configuration.
+          #
+          #   @return [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus, nil]
+          optional :current_billable_status,
+                   -> { MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus }
+
+          # @!method initialize(id:, created_at:, custom_fields:, customer_config:, external_id:, ingest_aliases:, name:, archived_at: nil, current_billable_status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data} for more details.
+          #
+          #   @param id [String] the Metronome ID of the customer
+          #
+          #   @param created_at [Time] RFC 3339 timestamp indicating when the customer was created.
+          #
+          #   @param custom_fields [Hash{Symbol=>String}]
+          #
+          #   @param customer_config [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig]
+          #
+          #   @param external_id [String] (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias
+          #
+          #   @param ingest_aliases [Array<String>] aliases for this customer that can be used instead of the Metronome customer ID
+          #
+          #   @param name [String]
+          #
+          #   @param archived_at [Time, nil] RFC 3339 timestamp indicating when the customer was archived. Null if the custom
+          #
+          #   @param current_billable_status [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus] This field's availability is dependent on your client's configuration.
+
+          # @see MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data#customer_config
+          class CustomerConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute salesforce_account_id
+            #   The Salesforce account ID for the customer
+            #
+            #   @return [String, nil]
+            required :salesforce_account_id, String, nil?: true
+
+            # @!method initialize(salesforce_account_id:)
+            #   @param salesforce_account_id [String, nil] The Salesforce account ID for the customer
+          end
+
+          # @see MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data#current_billable_status
+          class CurrentBillableStatus < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute value
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value]
+            required :value,
+                     enum: -> { MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value }
+
+            # @!attribute effective_at
+            #
+            #   @return [Time, nil]
+            optional :effective_at, Time, nil?: true
+
+            # @!method initialize(value:, effective_at: nil)
+            #   This field's availability is dependent on your client's configuration.
+            #
+            #   @param value [Symbol, MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value]
+            #   @param effective_at [Time, nil]
+
+            # @see MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus#value
+            module Value
+              extend MetronomeSDK::Internal::Type::Enum
+
+              BILLABLE = :billable
+              UNBILLABLE = :unbillable
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
       end
     end
   end

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

@@ -7,11 +7,58 @@ module MetronomeSDK
       class CustomerSetNameResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::V1::Customer]
-        required :data, -> { MetronomeSDK::V1::Customer }
+        #   @return [MetronomeSDK::Models::V1::CustomerSetNameResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::CustomerSetNameResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::V1::Customer]
+        #   @param data [MetronomeSDK::Models::V1::CustomerSetNameResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::CustomerSetNameResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   the Metronome ID of the customer
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute external_id
+          #   (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+          #   alias) that can be used in usage events
+          #
+          #   @return [String]
+          required :external_id, String
+
+          # @!attribute ingest_aliases
+          #   aliases for this customer that can be used instead of the Metronome customer ID
+          #   in usage events
+          #
+          #   @return [Array<String>]
+          required :ingest_aliases, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+          # @!method initialize(id:, external_id:, ingest_aliases:, name:, custom_fields: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::CustomerSetNameResponse::Data} for more details.
+          #
+          #   @param id [String] the Metronome ID of the customer
+          #
+          #   @param external_id [String] (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias
+          #
+          #   @param ingest_aliases [Array<String>] aliases for this customer that can be used instead of the Metronome customer ID
+          #
+          #   @param name [String]
+          #
+          #   @param custom_fields [Hash{Symbol=>String}]
+        end
       end
     end
   end

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

@@ -25,7 +25,7 @@ module MetronomeSDK
           #   Optionally filter by alert status. If absent, only enabled alerts will be
           #   returned.
           #
-          #   @return [Array<Symbol, MetronomeSDK::V1::Customers::AlertListParams::AlertStatus>, nil]
+          #   @return [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>, nil]
           optional :alert_statuses,
                    -> {
                      MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::Customers::AlertListParams::AlertStatus]
@@ -39,7 +39,7 @@ module MetronomeSDK
           #
           #   @param next_page [String] Cursor that indicates where the next page of results should start.
           #
-          #   @param alert_statuses [Array<Symbol, MetronomeSDK::V1::Customers::AlertListParams::AlertStatus>] Optionally filter by alert status. If absent, only enabled alerts will be return
+          #   @param alert_statuses [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>] Optionally filter by alert status. If absent, only enabled alerts will be return
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 

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

@@ -8,11 +8,9 @@ module MetronomeSDK
         class AlertListResponse < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [Array<MetronomeSDK::V1::Customers::CustomerAlert>]
+          #   @return [Array<MetronomeSDK::Models::V1::Customers::AlertListResponse::Data>]
           required :data,
-                   -> {
-                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CustomerAlert]
-                   }
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::AlertListResponse::Data] }
 
           # @!attribute next_page
           #
@@ -20,8 +18,281 @@ module MetronomeSDK
           required :next_page, String, nil?: true
 
           # @!method initialize(data:, next_page:)
-          #   @param data [Array<MetronomeSDK::V1::Customers::CustomerAlert>]
+          #   @param data [Array<MetronomeSDK::Models::V1::Customers::AlertListResponse::Data>]
           #   @param next_page [String, nil]
+
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute alert
+            #
+            #   @return [MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert]
+            required :alert, -> { MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert }
+
+            # @!attribute customer_status
+            #   The status of the customer alert. If the alert is archived, null will be
+            #   returned.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::CustomerStatus, nil]
+            required :customer_status,
+                     enum: -> { MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::CustomerStatus },
+                     nil?: true
+
+            # @!attribute triggered_by
+            #   If present, indicates the reason the alert was triggered.
+            #
+            #   @return [String, nil]
+            optional :triggered_by, String, nil?: true
+
+            # @!method initialize(alert:, customer_status:, triggered_by: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::Customers::AlertListResponse::Data} for more details.
+            #
+            #   @param alert [MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert]
+            #
+            #   @param customer_status [Symbol, MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::CustomerStatus, nil] The status of the customer alert. If the alert is archived, null will be returne
+            #
+            #   @param triggered_by [String, nil] If present, indicates the reason the alert was triggered.
+
+            # @see MetronomeSDK::Models::V1::Customers::AlertListResponse::Data#alert
+            class Alert < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute id
+              #   the Metronome ID of the alert
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute name
+              #   Name of the alert
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute status
+              #   Status of the alert
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::Status]
+              required :status, enum: -> { MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::Status }
+
+              # @!attribute threshold
+              #   Threshold value of the alert policy
+              #
+              #   @return [Float]
+              required :threshold, Float
+
+              # @!attribute type
+              #   Type of the alert
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::Type]
+              required :type, enum: -> { MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::Type }
+
+              # @!attribute updated_at
+              #   Timestamp for when the alert 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
+              #
+              #   @return [Array<String>, nil]
+              optional :credit_grant_type_filters, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+              # @!attribute credit_type
+              #
+              #   @return [MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CreditType, nil]
+              optional :credit_type,
+                       -> { MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CreditType },
+                       nil?: true
+
+              # @!attribute custom_field_filters
+              #   A list of custom field filters for alert types that support advanced filtering
+              #
+              #   @return [Array<MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CustomFieldFilter>, nil]
+              optional :custom_field_filters,
+                       -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CustomFieldFilter] }
+
+              # @!attribute group_key_filter
+              #   Scopes alert evaluation to a specific presentation group key on individual line
+              #   items. Only present for spend alerts.
+              #
+              #   @return [MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::GroupKeyFilter, nil]
+              optional :group_key_filter,
+                       -> { MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::GroupKeyFilter }
+
+              # @!attribute invoice_types_filter
+              #   Only supported for invoice_total_reached alerts. A list of invoice types to
+              #   evaluate.
+              #
+              #   @return [Array<String>, nil]
+              optional :invoice_types_filter, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+              # @!attribute uniqueness_key
+              #   Prevents the creation of duplicates. If a request to create a record is made
+              #   with a previously used uniqueness key, a new record will not be created and the
+              #   request will fail with a 409 error.
+              #
+              #   @return [String, nil]
+              optional :uniqueness_key, String
+
+              # @!method initialize(id:, name:, status:, threshold:, type:, updated_at:, credit_grant_type_filters: nil, credit_type: nil, custom_field_filters: nil, group_key_filter: nil, invoice_types_filter: nil, uniqueness_key: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert} for more
+              #   details.
+              #
+              #   @param id [String] the Metronome ID of the alert
+              #
+              #   @param name [String] Name of the alert
+              #
+              #   @param status [Symbol, MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::Status] Status of the alert
+              #
+              #   @param threshold [Float] Threshold value of the alert policy
+              #
+              #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::Type] Type of the alert
+              #
+              #   @param updated_at [Time] Timestamp for when the alert 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_type [MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CreditType, nil]
+              #
+              #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering
+              #
+              #   @param group_key_filter [MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
+              #
+              #   @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
+              #
+              #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
+
+              # Status of the alert
+              #
+              # @see MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert#status
+              module Status
+                extend MetronomeSDK::Internal::Type::Enum
+
+                ENABLED = :enabled
+                ARCHIVED = :archived
+                DISABLED = :disabled
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # Type of the alert
+              #
+              # @see MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                LOW_CREDIT_BALANCE_REACHED = :low_credit_balance_reached
+                SPEND_THRESHOLD_REACHED = :spend_threshold_reached
+                MONTHLY_INVOICE_TOTAL_SPEND_THRESHOLD_REACHED = :monthly_invoice_total_spend_threshold_reached
+                LOW_REMAINING_DAYS_IN_PLAN_REACHED = :low_remaining_days_in_plan_reached
+                LOW_REMAINING_CREDIT_PERCENTAGE_REACHED = :low_remaining_credit_percentage_reached
+                USAGE_THRESHOLD_REACHED = :usage_threshold_reached
+                LOW_REMAINING_DAYS_FOR_COMMIT_SEGMENT_REACHED = :low_remaining_days_for_commit_segment_reached
+                LOW_REMAINING_COMMIT_BALANCE_REACHED = :low_remaining_commit_balance_reached
+                LOW_REMAINING_COMMIT_PERCENTAGE_REACHED = :low_remaining_commit_percentage_reached
+                LOW_REMAINING_DAYS_FOR_CONTRACT_CREDIT_SEGMENT_REACHED =
+                  :low_remaining_days_for_contract_credit_segment_reached
+                LOW_REMAINING_CONTRACT_CREDIT_BALANCE_REACHED = :low_remaining_contract_credit_balance_reached
+                LOW_REMAINING_CONTRACT_CREDIT_PERCENTAGE_REACHED = :low_remaining_contract_credit_percentage_reached
+                LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_BALANCE_REACHED =
+                  :low_remaining_contract_credit_and_commit_balance_reached
+                INVOICE_TOTAL_REACHED = :invoice_total_reached
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # @see MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert#credit_type
+              class CreditType < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute name
+                #
+                #   @return [String]
+                required :name, String
+
+                # @!method initialize(id:, name:)
+                #   @param id [String]
+                #   @param name [String]
+              end
+
+              class CustomFieldFilter < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute entity
+                #
+                #   @return [Symbol, MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CustomFieldFilter::Entity]
+                required :entity,
+                         enum: -> { MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CustomFieldFilter::Entity }
+
+                # @!attribute key
+                #
+                #   @return [String]
+                required :key, String
+
+                # @!attribute value
+                #
+                #   @return [String]
+                required :value, String
+
+                # @!method initialize(entity:, key:, value:)
+                #   @param entity [Symbol, MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CustomFieldFilter::Entity]
+                #   @param key [String]
+                #   @param value [String]
+
+                # @see MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert::CustomFieldFilter#entity
+                module Entity
+                  extend MetronomeSDK::Internal::Type::Enum
+
+                  CONTRACT = :Contract
+                  COMMIT = :Commit
+                  CONTRACT_CREDIT = :ContractCredit
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              # @see MetronomeSDK::Models::V1::Customers::AlertListResponse::Data::Alert#group_key_filter
+              class GroupKeyFilter < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute key
+                #
+                #   @return [String]
+                required :key, String
+
+                # @!attribute value
+                #
+                #   @return [String]
+                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.
+                #
+                #   @param key [String]
+                #   @param value [String]
+              end
+            end
+
+            # The status of the customer alert. If the alert is archived, null will be
+            # returned.
+            #
+            # @see MetronomeSDK::Models::V1::Customers::AlertListResponse::Data#customer_status
+            module CustomerStatus
+              extend MetronomeSDK::Internal::Type::Enum
+
+              OK = :ok
+              IN_ALARM = :in_alarm
+              EVALUATING = :evaluating
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
       end
     end

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

@@ -25,7 +25,7 @@ module MetronomeSDK
           #   When parallel alerts are enabled during migration, this flag denotes whether to
           #   fetch alerts for plans or contracts.
           #
-          #   @return [Symbol, MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts, nil]
+          #   @return [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts, nil]
           optional :plans_or_contracts,
                    enum: -> { MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts }
 
@@ -37,7 +37,7 @@ module MetronomeSDK
           #
           #   @param customer_id [String] The Metronome ID of the customer
           #
-          #   @param plans_or_contracts [Symbol, MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel alerts are enabled during migration, this flag denotes whether to
+          #   @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel alerts are enabled during migration, this flag denotes whether to
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]