Module: Voog::API::Elements

Included in:

Client

Defined in:

lib/voog_api/api/elements.rb

Overview

Voog Element Definitions API methods.

See Also:

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

Instance Method Summary

• #create_element(data) ⇒ Object

  Create a element.

• #create_element_content(element_id, data) ⇒ Object

  Create a element content for element.

• #delete_element(id) ⇒ Object

  Delete a element.

• #delete_element_content(element_id, id) ⇒ Object

  Delete a content from element.

• #element(id, params = {}) ⇒ Object

  Get a single element.

• #element_content(element_id, id, params = {}) ⇒ Object

  Get a single content for element.

• #element_contents(id, params = {}) ⇒ Object

  List contents for element.

• #elements(params = {}) ⇒ Object

  List elements.

• #move_element(element_id, params) ⇒ Object

  Reorder a elements.

• #move_element_content(element_id, id, params = {}) ⇒ Object

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

• #update_element(id, data) ⇒ Object

  Update a element.

Instance Method Details

#create_element(data) ⇒ Object

Create a element

See Also:

• http://www.voog.com/developers/api/resources/elements#create_element

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

def create_element(data)
  post 'elements', data
end

#create_element_content(element_id, data) ⇒ Object

Create a element content for element

See Also:

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

# File 'lib/voog_api/api/elements.rb', line 70

def create_element_content(element_id, data)
  create_content(Voog::API::Contents::ParentKind::Element, element_id, data)
end

#delete_element(id) ⇒ Object

Delete a element

See Also:

• http://www.voog.com/developers/api/resources/elements#remove_element

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

def delete_element(id)
  delete "elements/#{id}"
end

#delete_element_content(element_id, id) ⇒ Object

Delete a content from element

See Also:

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

# File 'lib/voog_api/api/elements.rb', line 77

def delete_element_content(element_id, id)
  delete_content(Voog::API::Contents::ParentKind::Element, element_id, id)
end

#element(id, params = {}) ⇒ Object

Get a single element

See Also:

• http://www.voog.com/developers/api/resources/elements#get_element

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

def element(id, params = {})
  get "elements/#{id}", {query: params}
end

#element_content(element_id, id, params = {}) ⇒ Object

Get a single content for element

See Also:

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

# File 'lib/voog_api/api/elements.rb', line 63

def element_content(element_id, id, params = {})
  content(Voog::API::Contents::ParentKind::Element, element_id, id, params)
end

#element_contents(id, params = {}) ⇒ Object

List contents for element

See Also:

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

# File 'lib/voog_api/api/elements.rb', line 56

def element_contents(id, params = {})
  contents(Voog::API::Contents::ParentKind::Element, id, params)
end

#elements(params = {}) ⇒ Object

List elements

See Also:

• http://www.voog.com/developers/api/resources/elements#get_elements

# File 'lib/voog_api/api/elements.rb', line 12

def elements(params = {})
  paginate 'elements', {query: params}
end

#move_element(element_id, params) ⇒ Object

Reorder a elements

See Also:

• http://www.voog.com/developers/api/resources/elements#move_element

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

def move_element(element_id, params)
  put "elements/#{element_id}/move", nil, {query: params}
end

#move_element_content(element_id, id, params = {}) ⇒ Object

Reorder/move element 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/elements.rb', line 84

def move_element_content(element_id, id, params = {})
  move_content(Voog::API::Contents::ParentKind::Element, element_id, id, params)
end

#update_element(id, data) ⇒ Object

Update a element

See Also:

• http://www.voog.com/developers/api/resources/elements#update_element

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

def update_element(id, data)
  put "elements/#{id}", data
end