Module: ContentInstances

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

Instance Method Summary collapse

Instance Method Details

#create_content_instance(data) ⇒ Object

Create content instance.

Create a content instance with data.

Parameters

data

(Hash) – Data to be submitted.

Example

data = {
  "title": "New Content Instance",
  "content_template_id": 1,
  "slug": "new-content-instance-slug"
}
@data = @mints_user.create_content_instance(data)
[View source]

114
115
116
 
# File 'lib/user/content/content_instances.rb', line 114

def create_content_instance(data)
    return @client.raw("post", "/content/instances",  nil, data_transform(data))
end

#delete_content_instance(id) ⇒ Object

Delete content instance.

Delete a content instance.

Parameters

id

(Integer) – Content instance id.

Example

@data = @mints_user.delete_content_instance(20)
[View source]

144
145
146
 
# File 'lib/user/content/content_instances.rb', line 144

def delete_content_instance(id)
    return @client.raw("delete", "/content/instances/#{id}")
end

#duplicate_content_instance(id, data) ⇒ Object

Duplicate content instance.

Duplicate a content instance.

Parameters

id

(Integer) – Content instance id.

data

(Hash) – Data to be submitted.

Example

data = { 
  "options": [] 
}
@data = @mints_user.duplicate_content_instance(1, data.to_json)
[View source]

34
35
36
 
# File 'lib/user/content/content_instances.rb', line 34

def duplicate_content_instance(id, data)
    return @client.raw("post", "/content/instances/#{id}/duplicate", nil, data)
end

#get_content_instance(id, options = nil) ⇒ Object

Get content instance.

Get a content instance info.

Parameters

id

(Integer) – Content instance id.

options

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

First Example

@data = @mints_user.get_content_instance(1)

Second Example

options = { "fields": "id, title" }
@data = @mints_user.get_content_instance(1, options)
[View source]

51
52
53
 
# File 'lib/user/content/content_instances.rb', line 51

def get_content_instance(id, options = nil)
    return @client.raw("get", "/content/instances/#{id}", options)
end

#get_content_instances(options = nil) ⇒ Object

Get content instances.

Get a collection of content instances.

Parameters

options

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

First Example

@data = @mints_user.get_content_instances

Second Example

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

18
19
20
 
# File 'lib/user/content/content_instances.rb', line 18

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

#publish_content_instance(id, data) ⇒ Object

Publish content instance.

Publish a content instance.

Parameters

id

(Integer) – Content instance id.

data

(Hash) – Data to be submitted.

Example

data = {
  "title": "New publish",
  "slug": "new-publish",
  "content_template_id": 1
}
@data = @mints_user.publish_content_instance(2, data)
[View source]

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

def publish_content_instance(id, data)
    return @client.raw("put", "/content/instances/#{id}/publish", nil, data_transform(data))
end

#revert_published_content_instance(id) ⇒ Object

Revert published content instance.

Revert a published content instance.

Parameters

id

(Integer) – Content instance id.

Example

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

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

def revert_published_content_instance(id)
    return @client.raw("get", "/content/instances/#{id}/revert-published-data")
end

#schedule_content_instance(id, data) ⇒ Object

Schedule content instance.

Schedule a content instance in a specified date.

Parameters

id

(Integer) – Content instance id.

data

(Hash) – Data to be submitted.

Example

data = { 
  "scheduled_at": "2021-09-06T20:29:16+00:00"
}
@data = @mints_user.schedule_content_instance(1, data)
[View source]

85
86
87
 
# File 'lib/user/content/content_instances.rb', line 85

def schedule_content_instance(id, data)
    return @client.raw("put", "/content/instances/#{id}/schedule", nil, data_transform(data))
end

#update_content_instance(id, data) ⇒ Object

Update content instance.

Update a content instance info.

Parameters

id

(Integer) – Content instance id.

data

(Hash) – Data to be submitted.

Example

data = {
  "title": "New Content Instance Modified",
  "content_template_id": 1,
  "slug": "new-content-instance-slug"
}
@data = @mints_user.update_content_instance(18, data)
[View source]

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

def update_content_instance(id, data)
    return @client.raw("put", "/content/instances/#{id}", nil, data_transform(data))
end