Ruby interface for the Lokalise APIv2 that represents returned data as Ruby objects.
View the Project on GitHub lokalise/ruby-lokalise-api
@client.system_languages(params = {}) # Input:
## params (hash)
### :page and :limit
# Output:
## Collection of system languages supported by Lokalise
For example:
@client.system_languages limit: 10, page: 3
@client.project_languages(project_id, params = {}) # Input:
## project_id (string, required)
## params (hash)
### :page and :limit
# Output:
## Collection of languages available in the given project
For example:
@client.project_languages project_id, limit: 1, page: 2
@client.language(project_id, language_id) # Input:
## project_id (string, required)
## language_id (string, required)
# Output:
## A single language in the given project
@client.create_languages(project_id, params) # Input:
## project_id (string, required)
## params (array of hashes or hash, required) - contains parameter of newly created languages. Pass array of hashes to create multiple languages, or a hash to create a single language
### :lang_iso (string, required)
### :custom_iso (string)
### :custom_name (string)
### :custom_plural_forms (array) - can contain only plural forms initially supported by Lokalise
# Output:
## Collection of newly created languages
For example:
@client.create_languages project_id, lang_iso: 'ab', custom_name: 'Demo lang'
@client.update_language(project_id, language_id, params) # Input:
## project_id (string, required)
## language_id (string, required)
## params (hash, required)
### :lang_iso (string, required)
### :custom_name (string)
### :plural_forms (array) - can contain only plural forms initially supported by Lokalise
# Output:
## Updated language
Alternatively:
language = @client.language('project_id', 'lang_id')
language.update(params)
For example:
@client.update_language project_id, new_language_id,
lang_name: 'Updated custom language',
plural_forms: %w[one]
@client.destroy_language(project_id, language_id) # Input:
## project_id (string, required)
## language_id (string, required)
# Output:
## Hash with the project's id and "language_deleted"=>true
Alternatively:
language = @client.language('project_id', 'lang_id')
language.destroy