Class: Morpheus::UserSettingsInterface

Inherits:
APIClient
  • Object
show all
Defined in:
lib/morpheus/api/user_settings_interface.rb

Constant Summary

Constants inherited from APIClient

APIClient::CLIENT_ID

Instance Method Summary collapse

Methods inherited from APIClient

#account_groups, #account_users, #accounts, #activity, #appliance_settings, #approvals, #apps, #archive_buckets, #archive_files, #audit, #auth, #authorization_required?, #backup_jobs, #backup_restores, #backup_results, #backup_service_types, #backup_services, #backup_settings, #backup_types, #backups, #billing, #blueprints, #budgets, #catalog, #catalog_item_types, #certificate_types, #certificates, #client_id, #client_id=, #clients, #cloud_datastores, #cloud_folders, #cloud_policies, #cloud_resource_pools, #clouds, #clusters, #common_interface_options, #containers, #credential_types, #credentials, #cypher, #dashboard, #datastores, #default_content_type, #default_timeout, #deploy, #deployments, #dry, #dry_run, #email_templates, #environments, #execute, #execute_schedules, #execution_request, #file_copy_request, #forgot, #group_policies, #groups, #guidance, #guidance_settings, #health, #hub, #image_builder, #initialize, #inspect, #instance_types, #instances, #integration_types, #integrations, #interface, #invoice_line_items, #invoices, #jobs, #key_pairs, #library_cluster_layouts, #library_cluster_packages, #library_container_scripts, #library_container_templates, #library_container_types, #library_container_upgrades, #library_instance_types, #library_layouts, #library_operating_systems, #library_spec_template_types, #library_spec_templates, #license, #load_balancer_monitors, #load_balancer_pool_nodes, #load_balancer_pools, #load_balancer_pools_secondary, #load_balancer_profiles, #load_balancer_types, #load_balancer_virtual_servers, #load_balancers, #log_settings, #logged_in?, #login, #logout, #logs, #monitoring, #monitoring_settings, #network_dhcp_relays, #network_dhcp_servers, #network_domain_records, #network_domains, #network_edge_clusters, #network_floating_ips, #network_groups, #network_pool_ips, #network_pool_server_types, #network_pool_servers, #network_pools, #network_proxies, #network_resource_types, #network_routers, #network_security_server_types, #network_security_servers, #network_server_groups, #network_server_services, #network_server_types, #network_servers, #network_services, #network_static_routes, #network_types, #networks, #old_cypher, #option_type_forms, #option_type_lists, #option_types, #options, #packages, #ping, #plugins, #policies, #power_schedules, #price_sets, #prices, #processes, #projects, #provision_types, #provisioning_license_types, #provisioning_licenses, #provisioning_settings, #reports, #resource_pool_groups, #rest, #roles, #scale_thresholds, #search, #security_group_rules, #security_groups, #security_package_types, #security_packages, #security_scans, #server_types, #servers, #service_plans, #set_ssl_verification_enabled, #setopts, #setup, #snapshots, #ssl_verification_enabled?, #storage_providers, #storage_server_types, #storage_servers, #storage_volume_types, #storage_volumes, #subnet_types, #subnets, #task_sets, #tasks, #to_s, #url, #usage, #use_refresh_token, #user_groups, #user_settings, #user_sources, #users, #vdi, #vdi_allocations, #vdi_apps, #vdi_gateways, #vdi_pools, #virtual_images, #whitelabel_settings, #whoami, #wiki, #withopts

Constructor Details

This class inherits a constructor from Morpheus::APIClient

Instance Method Details

#available_clients(params = {}) ⇒ Object 



83
84
85
86
87
88
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 83

def available_clients(params={})
  url = "#{base_path}/api-clients"
  headers = { :params => params, authorization: "Bearer #{@access_token}"}
  opts = {method: :get, url: url, headers: headers}
  execute(opts)
end

#base_path ⇒ Object 



5
6
7
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 5

def base_path
  "/api/user-settings"
end

#clear_access_token(params, payload = {}) ⇒ Object 



76
77
78
79
80
81
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 76

def clear_access_token(params, payload={})
  url = "#{base_path}/clear-access-token"
  headers = { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json'}
  opts = {method: :put, url: url, headers: headers, payload: payload.to_json}
  execute(opts)
end

#download_avatar(params, outfile) ⇒ Object

download file as attachment



18
19
20
21
22
23
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 18

def download_avatar(params, outfile)
  url = "#{base_path}/avatar"
  headers = { :params => params, :authorization => "Bearer #{@access_token}"}
  opts = {method: :get, url: url, headers: headers, payload: payload}
  execute(opts)
end

#get(params = {}, headers = {}) ⇒ Object 



9
10
11
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 9

def get(params={}, headers={})
  execute(method: :get, url: "#{base_path}", params: params, headers: headers)
end

#regenerate_access_token(params, payload = {}) ⇒ Object 



69
70
71
72
73
74
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 69

def regenerate_access_token(params, payload={})
  url = "#{base_path}/regenerate-access-token"
  headers = { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json'}
  opts = {method: :put, url: url, headers: headers, payload: payload.to_json}
  execute(opts)
end

#remove_avatar(params = {}) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 38

def remove_avatar(params={})
  url = "#{base_path}/avatar"
  headers = { :params => params, :authorization => "Bearer #{@access_token}"}
  # POST empty payload will do
  payload = {}
  opts = {method: :delete, url: url, headers: headers, payload: payload}
  execute(opts)
end

#remove_desktop_background(params = {}) ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 60

def remove_desktop_background(params={})
  url = "#{base_path}/desktop-background"
  headers = { :params => params, :authorization => "Bearer #{@access_token}"}
  # POST empty payload will do
  payload = {}
  opts = {method: :delete, url: url, headers: headers, payload: payload}
  execute(opts)
end

#update(payload, params = {}, headers = {}) ⇒ Object 



13
14
15
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 13

def update(payload, params={}, headers={})
  execute(method: :put, url: "#{base_path}", params: params, payload: payload, headers: headers)
end

#update_avatar(avatar_file, params = {}) ⇒ Object

multipart file upload



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 26

def update_avatar(avatar_file, params={})
  url = "#{base_path}/avatar"
  headers = { :params => params, :authorization => "Bearer #{@access_token}"}
  payload = {}
  #payload['user'] ||= {}
  #payload['user']['avatar'] = avatar_file
  payload['user.avatar'] = avatar_file
  payload[:multipart] = true
  opts = {method: :post, url: url, headers: headers, payload: payload}
  execute(opts)
end

#update_desktop_background(desktop_background_file, params = {}) ⇒ Object

multipart file upload



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/morpheus/api/user_settings_interface.rb', line 48

def update_desktop_background(desktop_background_file, params={})
  url = "#{base_path}/desktop-background"
  headers = { :params => params, :authorization => "Bearer #{@access_token}"}
  payload = {}
  #payload['user'] ||= {}
  #payload['user']['desktopBackground'] = desktop_background_file
  payload['user.desktopBackground'] = desktop_background_file
  payload[:multipart] = true
  opts = {method: :post, url: url, headers: headers, payload: payload}
  execute(opts)
end