class Wavefront::Settings

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

Public Instance Methods

api_base() click to toggle source
# File lib/wavefront-sdk/settings.rb, line 11
def api_base
  '/customer'
end
default_user_groups() click to toggle source

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

# File lib/wavefront-sdk/settings.rb, line 49
def default_user_groups
  api.get('/preferences/defaultUserGroups')
end
permissions() click to toggle source

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

# File lib/wavefront-sdk/settings.rb, line 18
def permissions
  api.get(:permissions)
end
preferences() click to toggle source

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

# File lib/wavefront-sdk/settings.rb, line 25
def preferences
  api.get(:preferences)
end
update_preferences(body) click to toggle source

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

@param 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]]
# File lib/wavefront-sdk/settings.rb, line 42
def update_preferences(body)
  api.post(:preferences, body, 'application/json')
end