Module: Logs

Included in:
Config
Defined in:
lib/user/config/logs.rb

Instance Method Summary collapse

Instance Method Details

#create_log(data) ⇒ Object

Create log.

Create a log with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  alias_1: 'eventsCopy',
  alias_2: 'ticketsCopy',
  object_model_1: 'Story',
  object_model_2: 'Product'
}
@data = @cxf_user.create_log(data)



51
52
53
 
# File 'lib/user/config/logs.rb', line 51

def create_log(data)
  @client.raw('post', '/config/logs', nil, data_transform(data))
end

#delete_log(id) ⇒ Object

Delete log.

Delete a log.

Parameters

id

(Integer) – Relationship id.

Example

@data = @cxf_user.delete_log(5)



82
83
84
 
# File 'lib/user/config/logs.rb', line 82

def delete_log(id)
  @client.raw('delete', "/config/logs/#{id}")
end

#get_log(id, options = nil) ⇒ Object

Get log.

Get a log info.

Parameters

id

(Integer) – Relationship id.

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @cxf_user.get_log(1)

Second Example

options = { fields: 'id' }
@data = @cxf_user.get_log(1, options)



33
34
35
 
# File 'lib/user/config/logs.rb', line 33

def get_log(id, options = nil)
  @client.raw('get', "/config/logs/#{id}", options)
end

#get_logs(options = nil) ⇒ Object

Get logs.

Get a collection of logs.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @cxf_user.get_logs

Second Example

options = { fields: 'id' }
@data = @cxf_user.get_logs(options)



16
17
18
 
# File 'lib/user/config/logs.rb', line 16

def get_logs(options = nil)
  @client.raw('get', '/config/logs', options)
end

#update_log(id, data) ⇒ Object

Update log.

Update a log info.

Parameters

id

(Integer) – Relationship id.

data

(Hash) – Data to be submitted.

Example

data = {
  alias_1: 'eventsCopyModified',
  alias_2: 'ticketsCopyModified',
  object_model_1: 'Story',
  object_model_2: 'Product'
}
@data = @cxf_user.update_log(5, data)



70
71
72
 
# File 'lib/user/config/logs.rb', line 70

def update_log(id, data)
  @client.raw('put', "/config/logs/#{id}", nil, data_transform(data))
end