module Voog::API::Pages

Voog Pages API methods.

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

Public Instance Methods

create_page(data) click to toggle source

Create a page

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

Create a page content for page

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

Delete a page

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

Delete a content from page

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

Delete a key from page data field

@param id [String] key in data field

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

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

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

Get a single page

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

Get a single content for page

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

List contents for page

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

List pages

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

Patch a page

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

Update a page

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

Update/create a key in page data field

@param id [String] key in data field

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