Module: Voog::API::Contents

Included in:

Client

Defined in:

lib/voog_api/api/contents.rb

Overview

Voog Contents API methods.

See Also:

• http://www.voog.com/developers/api/resources/contents

Defined Under Namespace

Modules: ParentKind

Instance Method Summary

• #content(parent_name, parent_id, id, params = {}) ⇒ Object

  Get a single content.

• #contents(parent_name, parent_id, params = {}) ⇒ Object

  List contents.

• #create_content(parent_name, parent_id, data) ⇒ Object

  Create a content.

• #delete_content(parent_name, parent_id, id) ⇒ Object

  Delete a content.

• #move_content(parent_name, parent_id, id, params = {}) ⇒ Object

  Reorder/move content inside/between content areas and parent objects.

Instance Method Details

#content(parent_name, parent_id, id, params = {}) ⇒ Object

Get a single content

See Also:

• http://www.voog.com/developers/api/resources/contents#get_content

# File 'lib/voog_api/api/contents.rb', line 26

def content(parent_name, parent_id, id, params = {})
  get "#{parent_name}/#{parent_id}/contents/#{id}", {query: params}
end

#contents(parent_name, parent_id, params = {}) ⇒ Object

List contents

See Also:

• http://www.voog.com/developers/api/resources/contents#get_contents

# File 'lib/voog_api/api/contents.rb', line 19

def contents(parent_name, parent_id, params = {})
  paginate "#{parent_name}/#{parent_id}/contents", {query: params}
end

#create_content(parent_name, parent_id, data) ⇒ Object

Create a content

See Also:

• http://www.voog.com/developers/api/resources/contents#create_content

# File 'lib/voog_api/api/contents.rb', line 33

def create_content(parent_name, parent_id, data)
  post "#{parent_name}/#{parent_id}/contents", data
end

#delete_content(parent_name, parent_id, id) ⇒ Object

Delete a content

See Also:

• http://www.voog.com/developers/api/resources/contents#delete_content

# File 'lib/voog_api/api/contents.rb', line 40

def delete_content(parent_name, parent_id, id)
  delete "#{parent_name}/#{parent_id}/contents/#{id}"
end

#move_content(parent_name, parent_id, id, params = {}) ⇒ Object

Reorder/move content inside/between content areas and parent objects

See Also:

• http://www.voog.com/developers/api/resources/contents#relocate_content

# File 'lib/voog_api/api/contents.rb', line 47

def move_content(parent_name, parent_id, id, params = {})
  put "#{parent_name}/#{parent_id}/contents/#{id}/move", nil, {query: params}
end