Module: Voog::API::Pages

Included in:

Client

Defined in:

lib/voog_api/api/pages.rb

Overview

Voog Pages API methods.

See Also:

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

Instance Method Summary

• #create_page(data) ⇒ Object

  Create a page.

• #create_page_content(page_id, data) ⇒ Object

  Create a page content for page.

• #delete_page(id) ⇒ Object

  Delete a page.

• #delete_page_content(page_id, id) ⇒ Object

  Delete a content from page.

• #delete_page_data(page_id, id) ⇒ Object

  Delete a key from page data field.

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

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

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

  Get a single page.

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

  Get a single content for page.

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

  List contents for page.

• #pages(params = {}) ⇒ Object

  List pages.

• #patch_page(id, data) ⇒ Object

  Patch a page.

• #update_page(id, data) ⇒ Object

  Update a page.

• #update_page_data(page_id, id, data) ⇒ Object

  Update/create a key in page data field.

Instance Method Details

#create_page(data) ⇒ Object

Create a page

See Also:

• http://www.voog.com/developers/api/resources/pages#create_pages

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

def create_page(data)
  post 'pages', data
end

#create_page_content(page_id, data) ⇒ Object

Create a page content for page

See Also:

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

# File 'lib/voog_api/api/pages.rb', line 88

def create_page_content(page_id, data)
  create_content(Voog::API::Contents::ParentKind::Page, page_id, data)
end

#delete_page(id) ⇒ Object

Delete a page

See Also:

• http://www.voog.com/developers/api/resources/pages#delete_page

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

def delete_page(id)
  delete "pages/#{id}"
end

#delete_page_content(page_id, id) ⇒ Object

Delete a content from page

See Also:

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

# File 'lib/voog_api/api/pages.rb', line 95

def delete_page_content(page_id, id)
  delete_content(Voog::API::Contents::ParentKind::Page, page_id, id)
end

#delete_page_data(page_id, id) ⇒ Object

Delete a key from page data field

Parameters:

• id (String) —

  key in data field

See Also:

• http://www.voog.com/developers/api/resources/pages#delete_page_data_field

# File 'lib/voog_api/api/pages.rb', line 65

def delete_page_data(page_id, id)
  delete "pages/#{page_id}/data/#{id}"
end

#move_page_content(page_id, id, params = {}) ⇒ Object

Reorder/move page 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/pages.rb', line 102

def move_page_content(page_id, id, params = {})
  move_content(Voog::API::Contents::ParentKind::Page, page_id, id, params)
end

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

Get a single page

See Also:

• http://www.voog.com/developers/api/resources/pages#get_page

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

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

#page_content(page_id, id, params = {}) ⇒ Object

Get a single content for page

See Also:

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

# File 'lib/voog_api/api/pages.rb', line 81

def page_content(page_id, id, params = {})
  content(Voog::API::Contents::ParentKind::Page, page_id, id, params)
end

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

List contents for page

See Also:

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

# File 'lib/voog_api/api/pages.rb', line 74

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

#pages(params = {}) ⇒ Object

List pages

See Also:

• http://www.voog.com/developers/api/resources/pages#get_pages

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

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

#patch_page(id, data) ⇒ Object

Patch a page

See Also:

• http://www.voog.com/developers/api/resources/pages#patch_page

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

def patch_page(id, data)
  patch "pages/#{id}", data
end

#update_page(id, data) ⇒ Object

Update a page

See Also:

• http://www.voog.com/developers/api/resources/pages#update_page

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

def update_page(id, data)
  put "pages/#{id}", data
end

#update_page_data(page_id, id, data) ⇒ Object

Update/create a key in page data field

Parameters:

• id (String) —

  key in data field

See Also:

• http://www.voog.com/developers/api/resources/pages#update_page_data_field

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

def update_page_data(page_id, id, data)
  put "pages/#{page_id}/data/#{id}", {value: data}
end