Ruby interface for the Lokalise APIv2 that represents returned data as Ruby objects.
View the Project on GitHub lokalise/ruby-lokalise-api
Custom translation statuses must be enabled for the project before using this endpoint! It can be done in the project settings.
@client.translation_statuses(project_id, params = {}) # Input:
## project_id (string, required)
## params (hash)
### :page and :limit
# Output:
## Collection of translation statuses for the project
For example:
@client.translation_statuses project_id, limit: 1, page: 2
@client.translation_status(project_id, status_id) # Input:
## project_id (string, required)
## status_id (string or integer, required)
# Output:
## Translation status inside the given project
@client.create_translation_status(project_id, params) # Input:
## project_id (string, required)
## params (hash, required)
### :title (string, required) - title of the new status
### :color (string, required) - HEX color code of the new status. Lokalise allows a very limited number of color codes to set. Check the official docs or use `#translation_status_colors` method listed below to find the list of supported colors
# Output:
## Created translation status
For example:
@client.create_translation_status project_id,
title: "Demo status",
color: '#f2d600'
@client.update_translation_status(project_id, status_id, params) # Input:
## project_id (string, required)
## status_id (string or integer, required)
## params (hash, required)
### :title (string, required) - title of the new status
### :color (string, required) - HEX color code of the new status
# Output:
## Updated translation status
Alternatively:
status = @client.translation_status(project_id, status_id)
status.update(params)
For example:
@client.update_translation_status project_id, status_id,
title: 'Updated status',
color: '#c377e0'
@client.destroy_translation_status(project_id, status_id) # Input:
## project_id (string, required)
## status_id (string or integer, required)
# Output:
## Result of the delete operation
Alternatively:
status = @client.translation_status(project_id, status_id)
status.destroy
As long as Lokalise supports only very limited array of color hexadecimal codes for custom translation statuses, this method can be used to fetch all permitted values.
@client.translation_status_colors(project_id) # Input:
## project_id (string, required)
# Output:
## Array of color codes in HEX format