Module: MgmtConsole::Client::EngageInstances

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

Overview

Methods for the EngageInstances API

Instance Method Summary collapse

Instance Method Details

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

Create Engage Instance

Examples:

Create engage instance

@client.create_engage_instance(dbname: 'abc123', engage_server_id: 'b4c2719c-10ac-487c-9af4-59c297e17766', branch: '3-6-0-stable')

Returns:

  • (Sawyer::Resource) —

    Engage Instance

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/mgmt_console/client/engage_instances.rb', line 21

def create_engage_instance(options = {})
  # Required
  dbname = options.delete(:dbname)
  engage_server_id = options.delete(:engage_server_id)

  raise MgmtConsole::BadRequest.new('You must provide the Engage Instance Database name as :dbname') unless dbname
  raise MgmtConsole::BadRequest.new('You must provide the Engage Server ID as :engage_server_id')     unless engage_server_id

  # Optional
  salesforce_uid = options.delete(:salesforce_uid)
  branch = options.delete(:branch)
  commit = options.delete(:commit)
  engage_environment_id = options.delete(:engage_environment_id)

  params = {
    dbname: dbname,
    engage_server_id: engage_server_id,
    salesforce_uid: salesforce_uid,
    branch: branch,
    commit: commit,
    engage_environment_id: engage_environment_id,
  }.reject { |k,v| v.nil? }

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

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

Get Engage Instances list

Examples:

Get engage instances

@client.engage_instances

Returns:

  • (Array<Sawyer::Resource>) —

    Array of engage instances



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

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

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

Update Engage Instance

Examples:

Update engage instance

@client.update_engage_instance('bae956a6-17c9-4d65-b786-1c3aae311fb2', branch: '3-5-8-stable', commit: '7a0c870')

Returns:

  • (Sawyer::Resource) —

    Engage Instance

Raises:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/mgmt_console/client/engage_instances.rb', line 52

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

  # Optional
  dbname = options.delete(:dbname)
  engage_server_id = options.delete(:engage_server_id)
  salesforce_uid = options.delete(:salesforce_uid)
  branch = options.delete(:branch)
  commit = options.delete(:commit)
  engage_environment_id = options.delete(:engage_environment_id)

  params = {
    dbname: dbname,
    engage_server_id: engage_server_id,
    salesforce_uid: salesforce_uid,
    branch: branch,
    commit: commit,
    engage_environment_id: engage_environment_id,
  }.reject { |k,v| v.nil? }

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