Class: PritunlApiClient::Organization

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

Overview

Interact with /organization api’s

Instance Method Summary collapse

Constructor Details

#initialize(api) ⇒ Organization

Returns a new instance of Organization.

Parameters:



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

def initialize( api )
  @api = api
end

Instance Method Details

#all ⇒ Array

Returns a list of organizations on the server

Returns:

  • (Array) 


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

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

#create(params) ⇒ Hash

Create a new organization

Parameters:

  • params (Hash)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) —

    if params is not a Hash



31
32
33
34
 
# File 'lib/pritunl_api_client/organization.rb', line 31

def create( params )
  fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
  @api.post( '/organization', params )
end

#delete(id) ⇒ Object

Delete an existing organization

Parameters:

  • id (String) —

    Organization ID



50
51
52
 
# File 'lib/pritunl_api_client/organization.rb', line 50

def delete( id )
  @api.delete( "/organization/#{id}" )
end

#find(id) ⇒ Hash

Returns an organization

Parameters:

  • id (String) —

    Organization ID

Returns:

  • (Hash) 


22
23
24
 
# File 'lib/pritunl_api_client/organization.rb', line 22

def find( id )
  @api.get( "/organization/#{id}" )
end

#update(id, params) ⇒ Hash

Modify an existing organization

Parameters:

  • id (String) —

    Organization ID

  • params (Hash)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) —

    if params is not a Hash



42
43
44
45
 
# File 'lib/pritunl_api_client/organization.rb', line 42

def update( id, params )
  fail ArgumentError, 'params must be a Hash' unless params.is_a? Hash
  @api.put( "/organization/#{id}", params )
end