Module: MgmtConsole::Client::SpigitConfigs

Included in:
MgmtConsole::Client
Defined in:
lib/mgmt_console/client/spigit_configs.rb

Overview

Methods for the SpigitConfigs API

Instance Method Summary collapse

Instance Method Details

#create_spigit_config(options = {}) ⇒ Sawyer::Resource

Create Spigit Config

Examples:

Create spigit config

@client.create_spigit_config(engage_instance_id: 'b4c2719c-10ac-487c-9af4-59c297e17766', siteid: '3-6-0-stable', config: {"SERVERNAME" => "r225.spigit.com"})

Returns:

  • (Sawyer::Resource) —

    Spigit Config

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/mgmt_console/client/spigit_configs.rb', line 21

def create_spigit_config(options = {})
  # Required
  engage_instance_id = options.delete(:engage_instance_id)
  siteid = options.delete(:siteid)

  raise MgmtConsole::BadRequest.new('You must provide the Engage Instance ID as :engage_instance_id') unless engage_instance_id
  raise MgmtConsole::BadRequest.new('You must provide the Site ID as :siteid')                        unless siteid

  # Optional
  config = options.delete(:config)

  params = {
    engage_instance_id: engage_instance_id,
    siteid: siteid,
    config: config,
  }.reject { |k,v| v.nil? }

  data = post("#{api_endpoint}/spigit_configs", options.merge(params))
end

#spigit_configs(options = {}) ⇒ Array<Sawyer::Resource>

Get Spigit Configs list

Examples:

Get spigit configs

@client.spigit_configs

Returns:

  • (Array<Sawyer::Resource>) —

    Array of spigit configs



12
13
14
 
# File 'lib/mgmt_console/client/spigit_configs.rb', line 12

def spigit_configs(options = {})
  paginate("#{api_endpoint}/spigit_configs", options)
end

#update_spigit_config(id = nil, options = {}) ⇒ Sawyer::Resource

Update Spigit Config

Examples:

Update spigit config

@client.update_spigit_config(235, config: {"SERVERNAME" => "r226.spigit.com"})

Returns:

  • (Sawyer::Resource) —

    Spigit Config

Raises:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/mgmt_console/client/spigit_configs.rb', line 46

def update_spigit_config(id=nil, options = {})
  # Required
  raise MgmtConsole::BadRequest.new('You must provide the Spigit Config ID as :id') unless id

  # Optional
  engage_instance_id = options.delete(:engage_instance_id)
  siteid = options.delete(:siteid)
  config = options.delete(:config)

  params = {
    engage_instance_id: engage_instance_id,
    siteid: siteid,
    config: config,
  }.reject { |k,v| v.nil? }

  data = patch("#{api_endpoint}/spigit_configs/#{id}", options.merge(params))
end