Module: Conversations

Included in:
Content
Defined in:
lib/user/content/conversations.rb

Instance Method Summary collapse

Instance Method Details

#attach_contact_in_conversation(id, data) ⇒ Object

Attach contact in conversation.

Attach a contact in a conversation.

Parameters

id

(Integer) – Conversation id.

data

(Hash) – Data to be submitted.

Example

data = {
  contact_id: 2
}
@data = @mints_user.attach_contact_in_conversation(1, data)


157
158
159
 
# File 'lib/user/content/conversations.rb', line 157

def attach_contact_in_conversation(id, data)
  @client.raw('post', "/content/conversations/#{id}/attach-contact", nil, data_transform(data))
end

#attach_user_in_conversation(id, data) ⇒ Object

Attach user in conversation.

Attach an user in a conversation.

Parameters

id

(Integer) – Conversation id.

data

(Hash) – Data to be submitted.

Example

data = {
  user_id: 2
}
@data = @mints_user.attach_user_in_conversation(13, data)


125
126
127
 
# File 'lib/user/content/conversations.rb', line 125

def attach_user_in_conversation(id, data)
  @client.raw('post', "/content/conversations/#{id}/attach-user", nil, data_transform(data))
end

#create_conversation(data, options = nil) ⇒ Object

Create conversation.

Create a conversation with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Conversation'
}
@data = @mints_user.create_conversation(data)


53
54
55
 
# File 'lib/user/content/conversations.rb', line 53

def create_conversation(data, options = nil)
  @client.raw('post', '/content/conversations', options, data_transform(data))
end

#delete_conversation(id) ⇒ Object

Delete conversation.

Delete a conversation.

Parameters

id

(Integer) – Conversation id.

Example

@data = @mints_user.delete_conversation(11)


81
82
83
 
# File 'lib/user/content/conversations.rb', line 81

def delete_conversation(id)
  @client.raw('delete', "/content/conversations/#{id}")
end

#detach_contact_in_conversation(id, data) ⇒ Object

Detach contact in conversation.

Detach a contact in a conversation.

Parameters

id

(Integer) – Contact id.

data

(Hash) – Data to be submitted.

Example

data = {
  contact_id: 2
}
@data = @mints_user.detach_contact_in_conversation(1, data)


173
174
175
 
# File 'lib/user/content/conversations.rb', line 173

def detach_contact_in_conversation(id, data)
  @client.raw('post', "/content/conversations/#{id}/detach-contact", nil, data_transform(data))
end

#detach_user_in_conversation(id, data) ⇒ Object

Detach user in conversation.

Detach an user in a conversation.

Parameters

id

(Integer) – Conversation id.

data

(Hash) – Data to be submitted.

Example

data = {
  user_id: 2
}
@data = @mints_user.detach_user_in_conversation(13, data)


141
142
143
 
# File 'lib/user/content/conversations.rb', line 141

def detach_user_in_conversation(id, data)
  @client.raw('post', "/content/conversations/#{id}/detach-user", nil, data_transform(data))
end

#get_conversation(id, options = nil) ⇒ Object

Get conversation.

Get a conversation info.

Parameters

id

(Integer) – Conversation id.

options

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

First Example

@data = @mints_user.get_conversation(1)

Second Example

options = { fields: 'title' }
@data = @mints_user.get_conversation(1, options)


38
39
40
 
# File 'lib/user/content/conversations.rb', line 38

def get_conversation(id, options = nil)
  @client.raw('get', "/content/conversations/#{id}", options)
end

#get_conversation_participants(id) ⇒ Object

Get conversation participants.

Get participants in a conversation.

Parameters

id

(Integer) – Conversation id.

Example

@data = @mints_user.get_conversation_participants(1)


109
110
111
 
# File 'lib/user/content/conversations.rb', line 109

def get_conversation_participants(id)
  @client.raw('get', "/content/conversations/#{id}/participants")
end

#get_conversations(options = nil) ⇒ Object

Get conversations.

Get a collection of conversations.

Parameters

options

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

First Example

@data = @mints_user.get_conversations

Second Example

options = { fields: 'title' }
@data = @mints_user.get_conversations(options)


21
22
23
 
# File 'lib/user/content/conversations.rb', line 21

def get_conversations(options = nil)
  @client.raw('get', '/content/conversations', options)
end

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

Update conversation.

Update a conversation info.

Parameters

id

(Integer) – Conversation id.

data

(Hash) – Data to be submitted.

Example

data = {
  title: 'New Conversation Modified'
}
@data = @mints_user.update_conversation(13, data)


69
70
71
 
# File 'lib/user/content/conversations.rb', line 69

def update_conversation(id, data, options = nil)
  @client.raw('put', "/content/conversations/#{id}", options, data_transform(data))
end

#update_conversation_status(id, data) ⇒ Object

Update conversation status.

Update a conversation status.

Parameters

id

(Integer) – Conversation id.

data

(Hash) – Data to be submitted.

Example

data = {
  status: 'read'
}
@data = @mints_user.update_conversation_status(13, data)


97
98
99
 
# File 'lib/user/content/conversations.rb', line 97

def update_conversation_status(id, data)
  @client.raw('put', "/content/conversations/#{id}/status", nil, data_transform(data))
end