Module: Workflows

Included in:
CustomerData
Defined in:
lib/user/customer-data/workflows.rb

Instance Method Summary collapse

Instance Method Details

#check_workflow_object_steps(id, data, options = nil) ⇒ Object

Check workflow object steps.

Check if object steps are valid.

Parameters

id

(Integer) – Workflow id.

data

(Hash) – Data to be submitted.

options

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


79
80
81
 
# File 'lib/user/customer-data/workflows.rb', line 79

def check_workflow_object_steps(id, data, options = nil)
  @client.raw('put', "/customer-data/workflows/#{id}/object-step/check-item", options, data)
end

#create_workflow(data, options = nil) ⇒ Object

Create workflow.

Create a workflow with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
    example_field: 'example_value'
}
@data = @cxf_user.create_workflow(data)


57
58
59
 
# File 'lib/user/customer-data/workflows.rb', line 57

def create_workflow(data, options = nil)
  @client.raw('post', '/customer-data/workflows/', options, data_transform(data))
end

#delete_workflows(data) ⇒ Object

Delete Workflows.

Delete a group of workflows.

Parameters

data

(Hash) – Data to be submitted.

Example

data = { ids: %w[21 22] }
@data = @cxf_user.delete_workflows(data)


112
113
114
 
# File 'lib/user/customer-data/workflows.rb', line 112

def delete_workflows(data)
  @client.raw('delete', '/customer-data/workflows/delete', nil, data_transform(data))
end

#get_workflow(id, options = nil) ⇒ Object

Get workflow.

Get a workflow info.

Parameters

id

(Integer) – Workflow id.

options

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

First Example

@data = @cxf_user.get_workflow(21)

Second Example

options = { fields: 'id, title' }
@data = @cxf_user.get_workflow(21, options)


42
43
44
 
# File 'lib/user/customer-data/workflows.rb', line 42

def get_workflow(id, options = nil)
  @client.raw('get', "/customer-data/workflows/#{id}", options)
end

#get_workflows(options = nil, use_post = true) ⇒ Object

Get workflows.

Get a collection of workflows.

Parameters

options

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

use_post

(Boolean) – Variable to determine if the request is by ‘post’ or ‘get’ functions.

First Example

@data = @cxf_user.get_workflows

Second Example

options = { fields: 'id, title', sort: '-id' }
@data = @cxf_user.get_workflows(options)

Third Example

options = { fields: 'id, title', sort: '-id' }
@data = @cxf_user.get_workflows(options, false)


25
26
27
 
# File 'lib/user/customer-data/workflows.rb', line 25

def get_workflows(options = nil, use_post = true)
  get_query_results('/customer-data/workflows', options, use_post)
end

#update_workflow(id, data, options = nil) ⇒ Object

Update workflow.

Update a workflow info.

Parameters

id

(Integer) – Workflow id.

data

(Hash) – Data to be submitted.

Example

data = {
  example_field: 'example_value_modified'
}
@data = @cxf_user.update_workflow(23, data)


95
96
97
 
# File 'lib/user/customer-data/workflows.rb', line 95

def update_workflow(id, data, options = nil)
  @client.raw('put', "/customer-data/workflows/#{id}", options, data_transform(data))
end

#update_workflow_object_steps(id, data, options = nil) ⇒ Object

Update workflow object steps.

Update a workflow’s object steps.

Parameters

id

(Integer) – Workflow id.

data

(Hash) – Data to be submitted.

options

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


68
69
70
 
# File 'lib/user/customer-data/workflows.rb', line 68

def update_workflow_object_steps(id, data, options = nil)
  @client.raw('put', "/customer-data/workflows/#{id}/object-step", options, data)
end