Module: Voog::API::Languages

Included in:

Client

Defined in:

lib/voog_api/api/languages.rb

Overview

Voog Languages API methods.

See Also:

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

Instance Method Summary

• #create_language(data) ⇒ Object

  Create a language.

• #create_language_content(language_id, data) ⇒ Object

  Create a language content for language.

• #delete_language(id) ⇒ Object

  Delete a language.

• #delete_language_content(language_id, id) ⇒ Object

  Delete a content from language.

• #enable_language_autodetect ⇒ Object

  Enable language automatic detection for site visitors.

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

  Get a single language.

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

  Get a single content for language.

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

  List contents for language.

• #languages(params = {}) ⇒ Object

  List languages.

• #move_language(language_id, params) ⇒ Object

  Reorder a language.

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

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

• #update_language(id, data) ⇒ Object

  Update a language.

Instance Method Details

#create_language(data) ⇒ Object

Create a language

See Also:

• http://www.voog.com/developers/api/resources/languages#create_language

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

def create_language(data)
  post 'languages', data
end

#create_language_content(language_id, data) ⇒ Object

Create a language content for language

See Also:

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

# File 'lib/voog_api/api/languages.rb', line 77

def create_language_content(language_id, data)
  create_content(Voog::API::Contents::ParentKind::Language, language_id, data)
end

#delete_language(id) ⇒ Object

Delete a language

See Also:

• http://www.voog.com/developers/api/resources/languages#remove_language

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

def delete_language(id)
  delete "languages/#{id}"
end

#delete_language_content(language_id, id) ⇒ Object

Delete a content from language

See Also:

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

# File 'lib/voog_api/api/languages.rb', line 84

def delete_language_content(language_id, id)
  delete_content(Voog::API::Contents::ParentKind::Language, language_id, id)
end

#enable_language_autodetect ⇒ Object

Enable language automatic detection for site visitors

See Also:

• http://www.voog.com/developers/api/resources/languages#enable_autodetect

# File 'lib/voog_api/api/languages.rb', line 54

def enable_language_autodetect
  put "languages/enable_autodetect", nil
end

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

Get a single language

See Also:

• http://www.voog.com/developers/api/resources/languages#get_language

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

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

#language_content(language_id, id, params = {}) ⇒ Object

Get a single content for language

See Also:

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

# File 'lib/voog_api/api/languages.rb', line 70

def language_content(language_id, id, params = {})
  content(Voog::API::Contents::ParentKind::Language, language_id, id, params)
end

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

List contents for language

See Also:

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

# File 'lib/voog_api/api/languages.rb', line 63

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

#languages(params = {}) ⇒ Object

List languages

See Also:

• http://www.voog.com/developers/api/resources/languages#get_languages

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

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

#move_language(language_id, params) ⇒ Object

Reorder a language

See Also:

• http://www.voog.com/developers/api/resources/languages#move_language

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

def move_language(language_id, params)
  put "languages/#{language_id}/move", nil, {query: params}
end

#move_language_content(language_id, id, params = {}) ⇒ Object

Reorder/move language 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/languages.rb', line 91

def move_language_content(language_id, id, params = {})
  move_content(Voog::API::Contents::ParentKind::Language, language_id, id, params)
end

#update_language(id, data) ⇒ Object

Update a language

See Also:

• http://www.voog.com/developers/api/resources/languages#update_language

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

def update_language(id, data)
  put "languages/#{id}", data
end