Module: Workflows

Included in:
CRM
Defined in:
lib/user/crm/workflows.rb

Instance Method Summary collapse

Instance Method Details

#create_workflow(data) ⇒ Object

Create workflow.

Create a workflow with data.

Parameters

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Workflow",
  "object_type": "deals"
}
@data = @mints_user.create_workflow(data.to_json)


51
52
53
 
# File 'lib/user/crm/workflows.rb', line 51

def create_workflow(data)
    return @client.raw("post", "/crm/workflows/", nil, data)
end

#get_workflow(id, options = nil) ⇒ Object

Get workflow.

Get a workflow.

Parameters

id

(Integer) – Workflow id.

options

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

First Example

@data = @mints_user.get_workflow(1)

Second Example

options = { "fields": "id, title" }
@data = @mints_user.get_workflow(1, options)


35
36
37
 
# File 'lib/user/crm/workflows.rb', line 35

def get_workflow(id, options = nil)
    return @client.raw("get", "/crm/workflows/#{id}", options)
end

#get_workflows(options = nil) ⇒ Object

Get workflows.

Get a collection of workflows.

Parameters

options

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

First Example

@data = @mints_user.get_workflows

Second Example

options = { "sort": "title", "fields": "title" }
@data = @mints_user.get_workflows(options)


18
19
20
 
# File 'lib/user/crm/workflows.rb', line 18

def get_workflows(options = nil)
    return @client.raw("get", "/crm/workflows", options)
end

#update_workflow(id, data) ⇒ Object

Update workflow.

Update a workflow info.

Parameters

id

(Integer) – Workflow id.

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Workflow Modified"
}
@data = @mints_user.update_workflow(7, data)


67
68
69
 
# File 'lib/user/crm/workflows.rb', line 67

def update_workflow(id, data)
    return @client.raw("put", "/crm/workflows/#{id}", nil, correct_json(data))
end