Ruby interface for the Lokalise APIv2 that represents returned data as Ruby objects.
View the Project on GitHub lokalise/ruby-lokalise-api
@client.segments(project_id, key_id, lang_iso, params = {}) # Input:
## project_id (string, required)
## key_id (integer or string, required)
## lang_iso (string, required)
## params (hash)
### :disable_references (string, default "0") — whether to disable key references. Possible values are 1 and 0.
### :filter_is_reviewed (string, default "0") — Filter translations which are reviewed. Possible values are 1 and 0.
### :filter_unverified (string, default "0") — Filter translations which are unverified (fuzzy). Possible values are 1 and 0.
### :filter_untranslated (string, default "0") — Filter by untranslated keys. Possible values are 1 and 0.
### :filter_qa_issues (string) — One or more QA issues to filter by (comma separated).
### :page and :limit
# Output:
## Collection of segments
For example:
@client.segments '123.abc', 1234, 'en', disable_references: '1'
@client.segment(project_id, key_id, lang_iso, segment_number, params = {}) # Input:
## project_id (string, required)
## key_id (integer or string, required)
## lang_iso (string, required)
## segment_number (integer or string, required)
## params (hash)
### :disable_references (string, default "0") — whether to disable key references. Possible values are 1 and 0.
For example:
@client.segment '123.abc', 1234, 'en', 4, disable_references: '1'
@client.update_segment(project_id, key_id, lang_iso, segment_number, params = {}) # Input:
## project_id (string, required)
## key_id (integer or string, required)
## lang_iso (string, required)
## segment_number (integer or string, required)
## params (hash)
### :value (string, required) — The actual translation content. Use an JSON object for plural keys.
### :is_fuzzy (boolean) — Whether the Fuzzy flag is enabled. (Note: Fuzzy is called Unverified in the editor now).
### :is_reviewed (boolean) — Whether the Reviewed flag is enabled.
### :custom_translation_status_ids (array of strings or integers) — Custom translation status IDs to assign to translation (existing statuses will be replaced).
For example:
@client.update_segment '123.abc', 1234, 'en', 4,
value: 'Updated via API',
is_reviewed: true
Alternatively:
segment = @client.segment '123.abc', 1234, 'en', 4, disable_references: '1'
segment.update(value: 'Updated segment')