Module: Voog::API::Site

Included in:

Client

Defined in:

lib/voog_api/api/site.rb

Overview

Voog Site API methods.

See Also:

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

Instance Method Summary

• #delete_site_data(id) ⇒ Object

  Delete a key from site data field.

• #patch_site(data) ⇒ Object

  Patch a site.

• #site(params = {}) ⇒ Object

  Get site attributes.

• #update_site(data) ⇒ Object

  Update a site.

• #update_site_data(id, data) ⇒ Object

  Update/create a key in site data field.

Instance Method Details

#delete_site_data(id) ⇒ Object

Delete a key from site data field

Parameters:

• id (String) —

  key in data field

See Also:

• http://www.voog.com/developers/api/resources/site#delete_site_data_field

# File 'lib/voog_api/api/site.rb', line 44

def delete_site_data(id)
  delete "site/data/#{id}"
end

#patch_site(data) ⇒ Object

Patch a site

See Also:

• http://www.voog.com/developers/api/resources/site#patch_sites

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

def patch_site(data)
  patch "site", data
end

#site(params = {}) ⇒ Object

Get site attributes

See Also:

• http://www.voog.com/developers/api/resources/site#get_site

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

def site(params = {})
  get 'site', {query: params}
end

#update_site(data) ⇒ Object

Update a site

See Also:

• http://www.voog.com/developers/api/resources/site#update_sites

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

def update_site(data)
  put "site", data
end

#update_site_data(id, data) ⇒ Object

Update/create a key in site data field

Parameters:

• id (String) —

  key in data field

See Also:

• http://www.voog.com/developers/api/resources/site#update_site_data

# File 'lib/voog_api/api/site.rb', line 35

def update_site_data(id, data)
  put "site/data/#{id}", {value: data}
end