class PritunlApiClient::Organization

Interact with /organization api's

Public Class Methods

new( api ) click to toggle source

@param api [PritunlApiClient::Api]

# File lib/pritunl_api_client/organization.rb, line 7
def initialize( api )
  @api = api
end

Public Instance Methods

all() click to toggle source

Returns a list of organizations on the server

@return [Array]

# File lib/pritunl_api_client/organization.rb, line 14
def all
  @api.get( '/organization' )
end
create( params ) click to toggle source

Create a new organization

@param params [Hash] @raise [ArgumentError] if params is not a Hash @return [Hash]

# 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 ) click to toggle source

Delete an existing organization

@param id [String] Organization ID

# File lib/pritunl_api_client/organization.rb, line 50
def delete( id )
  @api.delete( "/organization/#{id}" )
end
find( id ) click to toggle source

Returns an organization

@param id [String] Organization ID @return [Hash]

# File lib/pritunl_api_client/organization.rb, line 22
def find( id )
  @api.get( "/organization/#{id}" )
end
update( id, params ) click to toggle source

Modify an existing organization

@param id [String] Organization ID @param params [Hash] @raise [ArgumentError] if params is not a Hash @return [Hash]

# 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