Class: PritunlApiClient::Settings

Inherits:
Object
  • Object
show all
Defined in:
lib/pritunl_api_client/settings.rb

Overview

Interact with /settings api’s

Instance Method Summary collapse

Constructor Details

#initialize(api) ⇒ Settings

Returns a new instance of Settings.

Parameters:



7
8
9
 
# File 'lib/pritunl_api_client/settings.rb', line 7

def initialize( api )
  @api = api
end

Instance Method Details

#all ⇒ Array

Get system settings

Returns:

  • (Array) 


14
15
16
 
# File 'lib/pritunl_api_client/settings.rb', line 14

def all
  @api.get( '/settings' )
end

#update(params) ⇒ Hash

Change the system settings

Parameters:

  • params (Hash)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) —

    if params is not a Hash



23
24
25
26
 
# File 'lib/pritunl_api_client/settings.rb', line 23

def update( params )
  fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
  @api.put( '/settings', params )
end