Module: Segments

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

Instance Method Summary collapse

Instance Method Details

#create_segment(data) ⇒ Object

Create segment.

Create a segment with data.

Parameters

data

(Hash) – Data to be submited.

Example

data = { 
  "title": "New Segment",
  "object_type": "deals"
}
@data = @mints_user.create_segment(data)


101
102
103
 
# File 'lib/user/crm/segments.rb', line 101

def create_segment(data)
    return @client.raw("post", "/crm/segments", nil, data_transform(data))
end

#delete_segment(id) ⇒ Object

Delete segment.

Delete a segment.

Parameters

id

(Integer) – Segment id.

Example

@mints_user.delete_segment(113)


129
130
131
 
# File 'lib/user/crm/segments.rb', line 129

def delete_segment(id)
    return @client.raw("delete", "/crm/segments/#{id}")
end

#duplicate_segment(id, data) ⇒ Object

Duplicate segment.

Duplicate a segment.

Parameters

id

(Integer) – Segment id.

data

(Hash) – Data to be submited.

Example

data = { 
  "options": [] 
}
@data = @mints_user.duplicate_segment(107, data)


52
53
54
 
# File 'lib/user/crm/segments.rb', line 52

def duplicate_segment(id, data)
    return @client.raw("post", "/crm/segments/#{id}/duplicate", nil, data)
end

#get_segment(id, options = nil) ⇒ Object

Get segment.

Get a segment info.

Parameters

id

(Integer) – Segment id.

options

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

First Example

@data = @mints_user.get_segment(1)

Second Example

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


85
86
87
 
# File 'lib/user/crm/segments.rb', line 85

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

#get_segment_group(groupId) ⇒ Object

Get segment group.

Get segment group.

Parameters

groupId

(String) – Group’s name.

Example

@data = @mints_user.get_segment_group("users")


36
37
38
 
# File 'lib/user/crm/segments.rb', line 36

def get_segment_group(groupId)
    return @client.raw("get", "/crm/segments/groups/#{groupId}")
end

#get_segments(options = nil) ⇒ Object

Get segments.

Get a collection of segments.

Parameters

options

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

First Example

@data = @mints_user.get_segments

Second Example

options = { "fields": "id", "sort": "-id" }
@data = @mints_user.get_segments(options)


68
69
70
 
# File 'lib/user/crm/segments.rb', line 68

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

#get_segments_attributes(options = nil) ⇒ Object

Get segments attributes.

Get segments attributes.

Parameters

options

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

Example

options = { "object_type": "contacts" }
@data = @mints_user.get_segments_attributes(options)


24
25
26
 
# File 'lib/user/crm/segments.rb', line 24

def get_segments_attributes(options = nil)
    return @client.raw("get", "/crm/segments/attributes", options)
end

#get_segments_support_data ⇒ Object

Get segments support data.

Get segments support data.

Example

@data = @mints_user.get_segments_support_data


11
12
13
 
# File 'lib/user/crm/segments.rb', line 11

def get_segments_support_data
    return @client.raw("get", "/crm/segments/support-data")
end

#update_segment(id, data) ⇒ Object

Update segment.

Update a segment info.

Parameters

id

(Integer) – Segment id.

data

(Hash) – Data to be submited.

Example

data = { 
  "title": "New Segment Modified"
}
@data = @mints_user.update_segment(118, data)


117
118
119
 
# File 'lib/user/crm/segments.rb', line 117

def update_segment(id, data)
    return @client.raw("put", "/crm/segments/#{id}", nil, data_transform(data))
end