Ruby interface for the Lokalise APIv2 that represents returned data as Ruby objects.
View the Project on GitHub lokalise/ruby-lokalise-api
@client.project_comments(project_id, params = {}) # Input:
## project_id (string, required)
## params (hash)
### :page and :limit
# Output:
## Collection of comments available in the given project
@client.comments(project_id, key_id, params = {}) # Input:
## project_id (string, required)
## key_id (string, required)
## params (hash)
### :page and :limit
# Output:
## Collection of comments available for the specified key in the given project
For example:
@client.comments project_id, key_id, limit: 1, page: 2
@client.create_comments(project_id, key_id, params) # Input:
## project_id (string, required)
## key_id (string, required)
## params (array or hash, required) - contains parameter of newly created comments. Pass array of hashes to create multiple comments, or a hash to create a single comment
### :comment (string, required)
# Output:
## Newly created comment
For example:
@client.create_comments project_id, key_id, [
{comment: 'demo comment'},
{comment: 'another comment'}
]
@client.comment(project_id, key_id, comment_id) # Input:
## project_id (string, required)
## key_id (string, required)
## comment_id (string, required)
# Output:
## Comment for the key in the given project
@client.destroy_comment(project_id, key_id, comment_id) # Input:
## project_id (string, required)
## key_id (string, required)
## comment_id (string, required)
# Output:
## Hash with the project's id and "comment_deleted"=>true
Alternatively:
comment = @client.comment('project_id', 'comment_id')
comment.destroy