module Voog::API::Elements

Voog Element Definitions API methods.

@see www.voog.com/developers/api/resources/elements

Public Instance Methods

create_element(data) click to toggle source

Create a element

@see 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) click to toggle source

Create a element content for element

@see 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) click to toggle source

Delete a element

@see 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) click to toggle source

Delete a content from element

@see 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 = {}) click to toggle source

Get a single element

@see 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 = {}) click to toggle source

Get a single content for element

@see 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 = {}) click to toggle source

List contents for element

@see 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 = {}) click to toggle source

List elements

@see 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) click to toggle source

Reorder a elements

@see 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 = {}) click to toggle source

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

@see 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) click to toggle source

Update a element

@see 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