Module: CloudConnect::Client::Configurations

Included in:
CloudConnect::Client
Defined in:
lib/cloud_connect/client/configurations.rb

Defined Under Namespace

Modules: ConfigurationMethods

Instance Method Summary collapse

Instance Method Details

#configuration(id, options = {}) ⇒ Configuration

Get a configuration

Parameters:

  • id (String) —

    ID of the configuration

Returns:

  • (Configuration) —

    The configuration you requested, if it exists



8
9
10
 
# File 'lib/cloud_connect/client/configurations.rb', line 8

def configuration(id, options={})
  enhance( get("configs/#{id}", options), with: ConfigurationMethods )
end

#configurations(options = {}) ⇒ Array Also known as: list_configurations

Get all configurations

Returns:

  • (Array) —

    A list of all configurations



44
45
46
 
# File 'lib/cloud_connect/client/configurations.rb', line 44

def configurations(options={})
  enhance( get("configs", options), with: ConfigurationMethods )
end

#create_configuration(name, options = {}) ⇒ Field

Create a configuration

Parameters:

  • name (String) —

    Name of the configuration

Returns:

  • (Field) —

    Your newly created configuration



26
27
28
 
# File 'lib/cloud_connect/client/configurations.rb', line 26

def create_configuration(name, options={})
  enhance( post("configs", options.merge(name: name)), with: ConfigurationMethods )
end

#search_configurations(search_term, options = {}) ⇒ Array

Search configurations

Parameters:

  • search_term (String) —

    The term to search for

Returns:

  • (Array) —

    A list of configurations matching the search term



16
17
18
 
# File 'lib/cloud_connect/client/configurations.rb', line 16

def search_configurations(search_term, options={})
  enhance( get("configs?q=#{search_term}", options), with: ConfigurationMethods )
end

#update_configuration(id, options = {}) ⇒ Field

Update a configuration

Parameters:

  • id (String) —

    Id of the configuration

Returns:

  • (Field) —

    Your newly created configuration



37
38
39
 
# File 'lib/cloud_connect/client/configurations.rb', line 37

def update_configuration(id, options={})
  enhance( put("configs/#{id}", options), with: ConfigurationMethods )
end