Module: MessageTemplates

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

Instance Method Summary collapse

Instance Method Details

#create_message_template(data, options = nil) ⇒ Object

Create message_template.

Create a message_template with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  user_id: 1,
  slug: "new-message_template",
  message_template_template_id: 1
}

options = { fields: 'id,slug' }

@data = @cxf_user.create_message_template(data, options)



64
65
66
 
# File 'lib/user/content/message_templates.rb', line 64

def create_message_template(data, options = nil)
  @client.raw('post', '/content/message-templates', options, data_transform(data))
end

#delete_message_template(id) ⇒ Object

Delete message_template.

Delete a message_template.

Parameters

id

(Integer) – message_template id.

Example

@data = @cxf_user.delete_message_template(6)



111
112
113
 
# File 'lib/user/content/message_templates.rb', line 111

def delete_message_template(id)
  @client.raw('delete', "/content/message-templates/#{id}")
end

#get_message_template(id, options = nil) ⇒ Object

Get message_template.

Get a message_template info.

Parameters

id

(Integer) – message_template id.

options

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

First Example

@data = @cxf_user.get_message_template(1)

Second Example

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



44
45
46
 
# File 'lib/user/content/message_templates.rb', line 44

def get_message_template(id, options = nil)
  @client.raw('get', "/content/message-templates/#{id}", options)
end

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

Get message_templates.

Get a collection of message_templates.

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_message_templates

Second Example

options = {
  fields: 'id, slug'
}
@data = @cxf_user.get_message_templates(options)

Third Example

options = {
  fields: 'id, slug'
}
@data = @cxf_user.get_message_templates(options, true)



25
26
27
 
# File 'lib/user/content/message_templates.rb', line 25

def get_message_templates(options = nil, use_post = true)
  get_query_results('/content/message-templates', options, use_post)
end

#send_message_template(data, options = nil) ⇒ Object

Send message_template.

Send a message using a message template with data.

Parameters

data

(Hash) – Data to be submitted.

options

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

Example

data = {
  user_id: 1,
  message_template_id: 2,
  content: "Hello, World!"
}
@data = @cxf_user.send_message_template(data)



82
83
84
 
# File 'lib/user/content/message_templates.rb', line 82

def send_message_template(data, options = nil)
  @client.raw('post', '/content/messages/send', options, data_transform(data))
end

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

Update message_template.

Update a message_template info.

Parameters

id

(Integer) – message_template id.

data

(Hash) – Data to be submitted.

Example

data = {
  user_id: 1,
  slug: 'new-message_template'
}
@data = @cxf_user.update_message_template(5, data)



99
100
101
 
# File 'lib/user/content/message_templates.rb', line 99

def update_message_template(id, data, options = nil)
  @client.raw('put', "/content/message-templates/#{id}", options, data_transform(data))
end