Module: Voog::API::Pages

Included in:
Client
Defined in:
lib/voog_api/api/pages.rb

Instance Method Summary collapse

Instance Method Details

#create_page(data) ⇒ Object

Create a page



16
17
18
 
# File 'lib/voog_api/api/pages.rb', line 16

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

#create_page_content(page_id, data) ⇒ Object

Create a page content for page



62
63
64
 
# File 'lib/voog_api/api/pages.rb', line 62

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



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

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

#delete_page_content(page_id, id) ⇒ Object

Delete a content from page



67
68
69
 
# File 'lib/voog_api/api/pages.rb', line 67

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



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

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



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

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



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

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

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

Get a single content for page



57
58
59
 
# File 'lib/voog_api/api/pages.rb', line 57

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



52
53
54
 
# File 'lib/voog_api/api/pages.rb', line 52

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

#pages(params = {}) ⇒ Object

List pages



6
7
8
 
# File 'lib/voog_api/api/pages.rb', line 6

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

#patch_page(id, data) ⇒ Object

Patch a page



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

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

#update_page(id, data) ⇒ Object

Update a page



21
22
23
 
# File 'lib/voog_api/api/pages.rb', line 21

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



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

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