Module: Content

Includes:
Assets, ContentInstances, ContentTemplates, Conversations, DAM, Forms, MessageTemplates, Messages, Pages, Stories, StoryTemplates
Included in:
Mints::User
Defined in:
lib/user/content/content.rb

Instance Method Summary collapse

Methods included from StoryTemplates

#create_story_template, #get_story_template, #get_story_template_support_data, #get_story_templates, #get_story_templates_support_data, #update_story_template

Methods included from Stories

#create_story, #delete_story, #duplicate_story, #get_stories, #get_stories_support_data, #get_story, #publish_story, #revert_published_story, #schedule_story, #update_story

Methods included from Pages

#create_page, #delete_page, #get_page, #get_page_groups, #get_pages, #update_page

Methods included from Messages

#create_message, #delete_message, #get_message, #get_messages, #update_message

Methods included from MessageTemplates

#create_message_template, #delete_message_template, #duplicate_message_template, #get_driver_templates, #get_message_template, #get_message_templates, #get_recipient_variables, #get_variables_of_content_page_from_message_templates, #preview_message_template, #send_message_template, #update_message_template

Methods included from Forms

#create_form, #delete_form, #duplicate_form, #get_form, #get_form_submissions, #get_form_support_data, #get_forms, #publish_form, #revert_published_form, #schedule_form, #update_form

Methods included from DAM

#create_dam_folder, #delete_dam, #get_dam_asset_locations, #get_dam_loadtree, #paste_dam, #rename_dam, #search_dam, #send_to_trash_dam

Methods included from Conversations

#attach_contact_in_conversation, #attach_user_in_conversation, #create_conversation, #delete_conversation, #detach_contact_in_conversation, #detach_user_in_conversation, #get_conversation, #get_conversation_participants, #get_conversations, #update_conversation, #update_conversation_status

Methods included from ContentTemplates

#create_content_template, #delete_content_template, #duplicate_content_template, #get_content_template, #get_content_template_instances, #get_content_templates, #update_content_template

Methods included from ContentInstances

#create_content_instance, #delete_content_instance, #duplicate_content_instance, #get_content_instance, #get_content_instances, #publish_content_instance, #revert_published_content_instance, #schedule_content_instance, #update_content_instance

Methods included from Assets

#create_asset_size, #delete_asset_size, #delete_asset_variation, #download_asset, #edit_asset_size, #generate_asset_variation, #get_asset_doc_types, #get_asset_info, #get_asset_link_info, #get_asset_public_route, #get_asset_sizes, #get_asset_usage, #get_asset_variation, #get_original_asset, #update_asset_variation, #upload_asset, #upload_asset_variation

Instance Method Details

#create_author(data) ⇒ Object

Create author.

Create an author with data.

Parameters

data

(Hash) – Data to be submited.

Example

data = {
  "title": "Howard Phillips Lovecraft",
  "slug": "howard-phillips-lovecraft"
}
@data = @mints_user.create_author(data.to_json)
[View source]

73
74
75
 
# File 'lib/user/content/content.rb', line 73

def create_author(data)
    return @client.raw("post", "/content/authors", nil, data)
end

#create_keyword(data) ⇒ Object

Create keyword.

Create a keyword with data.

Parameters

data

(Hash) – Data to be submited.

Example

data = {
  "title": "New Keyword"
}
@data = @mints_user.create_keyword(data.to_json)
[View source]

132
133
134
 
# File 'lib/user/content/content.rb', line 132

def create_keyword(data)
    return @client.raw("post", "/content/keywords", nil, data)
end

#create_stage(data) ⇒ Object

Create stage.

Create a stage with data.

Parameters

data

(Hash) – Data to be submited.

Example

config_json = {
  "count": 1
}
event_json = {
  "rset": "DTSTART:20190214T000000Z",
  "duration": 1
}
data = {
  "title": "New Stage",
  "description": "New Stage Description",
  "config_json": config_json.to_json,
  "event_json": event_json.to_json
}
@data = @mints_user.create_stage(data.to_json)
[View source]

203
204
205
 
# File 'lib/user/content/content.rb', line 203

def create_stage(data)
    return @client.raw("post", "/content/stages", nil, data)
end

#get_author(id) ⇒ Object

Get author.

Get an author.

Parameters

id

(Integer) – Author id.

Example

@data = @mints_user.get_author(1)
[View source]

57
58
59
 
# File 'lib/user/content/content.rb', line 57

def get_author(id)
    return @client.raw("get", "/content/authors/#{id}")
end

#get_authors ⇒ Object

Get authors.

Get authors.

Example

@data = @mints_user.get_authors
[View source]

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

def get_authors
    return @client.raw("get", "/content/authors")
end

#get_keyword(id) ⇒ Object

Get keyword.

Get a keyword.

Parameters

id

(Integer) – Keyword id.

[View source]

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

def get_keyword(id)
    return @client.raw("get", "/content/keywords/#{id}")
end

#get_keywords(options = nil) ⇒ Object

Get keywords.

Get a collection of keywords.

Parameters

options

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

First Example

@data = @mints_user.get_keywords

Second Example

options = { "fields": "title" }
@data = @mints_user.get_keywords(options)
[View source]

107
108
109
 
# File 'lib/user/content/content.rb', line 107

def get_keywords(options = nil)
    return @client.raw("get", "/content/keywords", options)
end

#get_public_images_url ⇒ Object

Get public images url.

Get public images url.

Example

@data = @mints_user.get_public_images_url
[View source]

31
32
33
 
# File 'lib/user/content/content.rb', line 31

def get_public_images_url
    return @client.raw("get", "/content/public-images-url")
end

#get_stage(id) ⇒ Object

Get stage.

Get a stage.

Parameters

id

(Integer) – Stage id.

Example

@data = @mints_user.get_stage(1)
[View source]

178
179
180
 
# File 'lib/user/content/content.rb', line 178

def get_stage(id)
    return @client.raw("get", "/content/stages/#{id}")
end

#get_stages(options = nil) ⇒ Object

Get stages.

Get a collection of stages.

Parameters

options

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

First Example

@data = @mints_user.get_stages

Second Example

options = { "fields": "title" }
@data = @mints_user.get_stages(options)
[View source]

166
167
168
 
# File 'lib/user/content/content.rb', line 166

def get_stages(options = nil)
    return @client.raw("get", "/content/stages", options)
end

#update_author(id, data) ⇒ Object

Update author.

Update an author info.

Parameters

id

(Integer) – Author id.

data

(Hash) – Data to be submited.

Example

[View source]

86
87
88
89
 
# File 'lib/user/content/content.rb', line 86

def update_author(id, data)
    #FIXME: Author controller doesnt receive data
    return @client.raw("put", "/content/authors/#{id}", nil, data)
end

#update_keyword(id, data) ⇒ Object

Update keyword.

Update a keyword info.

Parameters

id

(Integer) – Keyword id.

data

(Hash) – Data to be submited.

Example

[View source]

145
146
147
148
 
# File 'lib/user/content/content.rb', line 145

def update_keyword(id, data)
    #FIXME: Keyword controller doesnt receive data
    return @client.raw("put", "/content/keywords/#{id}", nil, data)
end

#update_stage(id, data) ⇒ Object

Update stage.

Update a stage info.

Parameters

id

(Integer) – Stage id.

data

(Hash) – Data to be submited.

Example

config_json = {
  "count": 2
}
event_json = {
  "rset": "DTSTART:20190214T000000Z",
  "duration": 2
}
data = {
  "stageProps": { 
    "title": "New Stage Modified",
    "description": "New Stage Description Modified"
  },
  "config_json": config_json.to_json,
  "event_json": event_json.to_json
}
@data = @mints_user.update_stage(3, data.to_json)
[View source]

231
232
233
234
 
# File 'lib/user/content/content.rb', line 231

def update_stage(id, data)
    #TODO: Inform StageController.update method has been modified
    return @client.raw("put", "/content/stages/#{id}", nil, data)
end