Class: Wavefront::Settings

Inherits:
CoreApi
  • Object
show all
Defined in:
lib/wavefront-sdk/settings.rb

Overview

Manage and query Wavefront customer settings. Corresponds to the “system preferences” page in the UI.

Instance Attribute Summary

Attributes inherited from CoreApi

#api, #creds, #logger, #opts, #update_keys

Instance Method Summary collapse

Methods inherited from CoreApi

#api_path, #hash_for_update, #initialize, #setup_api, #time_to_ms

Methods included from Mixins

#log, #parse_relative_time, #parse_time, #relative_time, #time_multiplier, #valid_relative_time?

Methods included from Validators

#uuid?, #wf_account_id?, #wf_alert_id?, #wf_alert_severity?, #wf_apitoken_id?, #wf_aws_external_id?, #wf_cloudintegration_id?, #wf_dashboard_id?, #wf_derivedmetric_id?, #wf_distribution?, #wf_distribution_count?, #wf_distribution_interval?, #wf_distribution_values?, #wf_epoch?, #wf_event_id?, #wf_granularity?, #wf_ingestionpolicy_id?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_metricspolicy_id?, #wf_monitoredcluster_id?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_permission?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_role_id?, #wf_sampling_value?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_serviceaccount_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_trace?, #wf_ts?, #wf_user_id?, #wf_usergroup_id?, #wf_value?, #wf_version?, #wf_webhook_id?

Constructor Details

This class inherits a constructor from Wavefront::CoreApi

Instance Method Details

#api_base ⇒ Object 



11
12
13
 
# File 'lib/wavefront-sdk/settings.rb', line 11

def api_base
  '/customer'
end

#default_user_groups ⇒ Object

GET /api/v2/customer/preferences/defaultUserGroups Get default user groups customer preferences



49
50
51
 
# File 'lib/wavefront-sdk/settings.rb', line 49

def default_user_groups
  api.get('/preferences/defaultUserGroups')
end

#permissions ⇒ Object

GET /api/v2/customer/permissions Get all permissions



18
19
20
 
# File 'lib/wavefront-sdk/settings.rb', line 18

def permissions
  api.get(:permissions)
end

#preferences ⇒ Object

GET /api/v2/customer/preferences Get customer preferences



25
26
27
 
# File 'lib/wavefront-sdk/settings.rb', line 25

def preferences
  api.get(:preferences)
end

#update_preferences(body) ⇒ Object

POST /api/v2/customer/preferences Update selected fields of customer preferences

Parameters:

  • body (Hash) —

    See the API documentation for the model schema. At the time of writing, permissible fields are

    showQuerybuilderByDefault [Bool]
hideTSWhenQuerybuilderShown [Bool]
landingDashboardSlug [String]
showOnboarding [Bool]
grantModifyAccessToEveryone [Bool]
defaultUserGroups: [Array[String]]
invitePermissions: [Array[String]]



42
43
44
 
# File 'lib/wavefront-sdk/settings.rb', line 42

def update_preferences(body)
  api.post(:preferences, body, 'application/json')
end