Module: Stories
- Included in:
- Content
- Defined in:
- lib/user/content/stories.rb
Instance Method Summary collapse
-
#create_story(data, options = nil) ⇒ Object
Create story.
-
#delete_story(id) ⇒ Object
Delete story.
-
#duplicate_story(id, data) ⇒ Object
Duplicate story.
-
#get_stories(options = nil, use_post = true) ⇒ Object
Get stories.
-
#get_story(id, options = nil) ⇒ Object
Get story.
-
#update_story(id, data, options = nil) ⇒ Object
Update story.
Instance Method Details
#create_story(data, options = nil) ⇒ Object
Create story.
Create a story with data.
Parameters
- data
-
(Hash) – Data to be submitted.
Example
data = {
user_id: 1,
slug: "new-story",
story_template_id: 1
}
= { fields: 'id,slug' }
@data = @mints_user.create_story(data, )
78 79 80 |
# File 'lib/user/content/stories.rb', line 78 def create_story(data, = nil) @client.raw('post', '/content/stories', , data_transform(data)) end |
#delete_story(id) ⇒ Object
Delete story.
Delete a story.
Parameters
- id
-
(Integer) – Story id.
Example
@data = @mints_user.delete_story(6)
107 108 109 |
# File 'lib/user/content/stories.rb', line 107 def delete_story(id) @client.raw('delete', "/content/stories/#{id}") end |
#duplicate_story(id, data) ⇒ Object
Duplicate story.
Duplicate a story.
Parameters
- id
-
(Integer) – Story id.
- data
-
(Hash) – Data to be submitted.
Example
data = { options: [] }
@data = @mints_user.duplicate_story(1, data.to_json)
14 15 16 |
# File 'lib/user/content/stories.rb', line 14 def duplicate_story(id, data) @client.raw('post', "/content/stories/#{id}/duplicate", nil, data) end |
#get_stories(options = nil, use_post = true) ⇒ Object
Get stories.
Get a collection of stories.
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 = @mints_user.get_stories
Second Example
= {
fields: 'id, slug'
}
@data = @mints_user.get_stories()
Third Example
= {
fields: 'id, slug'
}
@data = @mints_user.get_stories(, true)
39 40 41 |
# File 'lib/user/content/stories.rb', line 39 def get_stories( = nil, use_post = true) get_query_results('/content/stories', , use_post) end |
#get_story(id, options = nil) ⇒ Object
Get story.
Get a story info.
Parameters
- id
-
(Integer) – Story id.
- options
-
(Hash) – List of Resource Collection Options shown above can be used as parameter.
First Example
@data = @mints_user.get_story(1)
Second Example
= {
fields: 'id, slug'
}
@data = @mints_user.get_story(1, )
58 59 60 |
# File 'lib/user/content/stories.rb', line 58 def get_story(id, = nil) @client.raw('get', "/content/stories/#{id}", ) end |
#update_story(id, data, options = nil) ⇒ Object
Update story.
Update a story info.
Parameters
- id
-
(Integer) – Story id.
- data
-
(Hash) – Data to be submitted.
Example
data = {
user_id: 1,
slug: 'new-story'
}
@data = @mints_user.update_story(5, data)
95 96 97 |
# File 'lib/user/content/stories.rb', line 95 def update_story(id, data, = nil) @client.raw('put', "/content/stories/#{id}", , data_transform(data)) end |