ruby-lokalise-api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2212a93b34d63ef5bec7884f3003088d74a2c616affdf9931ad9767ae8b1f5d
+  data.tar.gz: e56cee6b0d8bc2974591f215191a1543f2d1b9d28a774b46c7bec1fff96c5ccb
+SHA512:
+  metadata.gz: ec48688594d2492bade883ac5dda7baa533d9f27a6c7cd59dc90cfd30e7be5e8517885f85ca3a43b3d8009bd8052945334a4c38dcee60a1a4720960289e4e338
+  data.tar.gz: 2c367579e4617dc4c89474afbd09b7b62b10a768ddaca01162934527e3211391f225ea39d3cc1a8fa1310c661d9eaab758c8239a887c2d7e091c0f4152211be0

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@lokalise.co. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/.github/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Don't forget to add specs and make sure they pass by running `rspec .`.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you.
+6. If necessary, add documentation for your feature or bug fix.
+7. Commit and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+### Steps to reproduce
+
+### Expected behavior
+
+Tell us what should happen
+
+### Actual behavior
+
+Tell us what happens instead
+
+### System configuration
+
+**Ruby version**:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request. Were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. 

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 (10-Dec-18)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018 Lokalise team, Ilya Bodrov, Roman Kutanov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,917 @@
+# Lokalise API 2.0 official Ruby interface
+
+[![Gem Version](https://badge.fury.io/rb/ruby-lokalise-api.svg)](https://badge.fury.io/rb/ruby-lokalise-api)
+[![Build Status](https://travis-ci.org/lokalise/ruby-lokalise-api.svg?branch=master)](https://travis-ci.org/lokalise/ruby-lokalise-api)
+
+Official opinionated Ruby interface for the [Lokalise API](https://lokalise.co/api2docs/ruby/) that represents returned data as Ruby objects.
+
+## Index
+
+* [Getting started](#getting-started)
+  + [Installation and Requirements](#installation-and-requirements)
+  + [Initializing the Client](#initializing-the-client)
+  + [Objects and models](#objects-and-models)
+  + [Collections of resources and pagination](#collections-of-resources-and-pagination)
+* [Available Resources](#available-resources)
+  + [Comments](#comments)
+  + [Contributors](#contributors)
+  + [Files](#files)
+  + [Keys](#keys)
+  + [Languages](#languages)
+  + [Projects](#projects)
+  + [Screenshots](#screenshots)
+  + [Snapshots](#snapshots)
+  + [Tasks](#tasks)
+  + [Teams](#teams)
+  + [Team users](#team-users)
+  + [Translations](#translations)
+* [Additional Info](#additional-info)
+  + [Error handling](#error-handling)
+  + [API Rate Limits](#api-rate-limits)
+* [Running Tests](#running-tests)
+
+## Getting Started
+
+### Installation and Requirements
+
+This gem requires [Ruby 2.4+](https://www.ruby-lang.org/en/) and [RubyGems package manager](https://rubygems.org/pages/download).
+
+Install it by running:
+
+```bash
+$ gem install ruby-lokalise-api
+```
+
+### Initializing the Client
+
+In order to perform API requests, you require a special token that can be obtained in your [personal profile](https://lokalise.co/profile#apitokens) (*API tokens* section). Note that the owner of the token must have admin access rights.
+
+After you've obtained the token, initialize the client:
+
+```ruby
+require 'ruby-lokalise-api'
+
+@client = Lokalise.client 'YOUR_TOKEN_HERE'
+```
+
+Now the `@client` can be used to perform API requests!
+
+### Objects and models
+
+Individual objects are represented as instances of Ruby classes which are called *models*. Each model responds to the methods that are named after the API object's attributes. [This file](https://github.com/lokalise/ruby-lokalise-api/blob/master/lib/ruby-lokalise-api/data/attributes.json) lists all objects and their methods.
+
+Here is an example:
+
+```ruby
+project = client.project '123'
+project.name
+project.description
+project.created_by
+```
+
+To get access to raw data returned by the API, use `#raw_data`:
+
+```ruby
+project.raw_data
+```
+
+### Collections of resources and pagination
+
+Fetching (or creating/updating) multiple objects will return a *collection* of objects. To get access to the actual data, use `#collection` method:
+
+```ruby
+project = @client.projects.collection.first # => Get the first project
+project.name
+```
+
+Bulk fetches support [pagination](https://lokalise.co/api2docs/php/#resource-pagination). There are two common parameters available:
+
+* `:limit` (defaults to `100`, maximum is `5000`) - number of records to display per page
+* `:page` (defaults  to `1`) - page to fetch
+
+```ruby
+projects = @client.projects limit: 10, page: 3 #=> Paginate by 10 records and fetch the third page
+```
+
+Collections respond to the following methods:
+
+* `#total_pages`
+* `#total_results`
+* `#results_per_page`
+* `#current_page`
+
+For example:
+
+```ruby
+projects.current_page #=> 3
+```
+
+## Available Resources
+
+### Comments
+
+[Comments attributes](https://lokalise.co/api2docs/ruby/#resource-comments)
+
+#### Fetch project comments
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-project-comments-get)
+
+```ruby
+@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
+```
+
+#### Fetch key comments
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-key-comments-get)
+
+```ruby
+@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
+```
+
+#### Create key comments
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-comments-post)
+
+```ruby
+@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
+```
+
+#### Fetch key comment
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-comment-get)
+
+```ruby
+@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
+```
+
+#### Delete key comment
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-comment-delete)
+
+```ruby
+@client.delete_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
+```
+
+### Contributors
+
+#### Fetch contributors
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-contributors-get)
+
+```ruby
+@client.contributors(project_id, params = {})   # Input:
+                                                ## project_id (string, required)
+                                                ## params (hash)
+                                                ### :page and :limit
+                                                # Output:
+                                                ## Collection of contributors in the given project
+```
+
+#### Fetch a single contributor
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-contributor-get)
+
+```ruby
+@client.contributor(project_id, contributor_id)   # Input:
+                                                  ## project_id (string, required)
+                                                  ## contributor_id (string, required) - named as "user_id" in the response
+                                                  # Output:
+                                                  ## Contributor in the given project
+```
+
+#### Create contributors
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-contributors-post)
+
+```ruby
+@client.create_contributors(project_id, params)  # Input:
+                                                 ## project_id (string, required)
+                                                 ## params (array of hashes or hash, required) - parameters for the newly created contributors. Pass array of hashes to create multiple contributors, or a hash to create a single contributor
+                                                 ### :email (string, required)
+                                                 ### :fullname (string) 
+                                                 ### :is_admin (boolean)
+                                                 ### :is_reviewer (boolean)
+                                                 ### :languages (array of hashes, required if "is_admin" set to false) - possible languages attributes:
+                                                 #### :lang_iso (string, required)
+                                                 #### :is_writable (boolean) 
+                                                 ### :admin_rights (array) 
+                                                 # Output:
+                                                 ## Collection of newly created contributors
+```
+
+#### Update contributor
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-contributor-put)
+
+```ruby
+@client.update_contributor(project_id, contributor_id, params)   # Input:
+                                                                 ## project_id (string, required)
+                                                                 ## contributor_id (string, required) 
+                                                                 ## params (hash, required)
+                                                                 ### :is_admin (boolean)
+                                                                 ### :is_reviewer (boolean)
+                                                                 ### :languages (array of hashes) - possible languages attributes:
+                                                                 #### :lang_iso (string, required)
+                                                                 #### :is_writable (boolean) 
+                                                                 ### :admin_rights (array) 
+                                                                 # Output:
+                                                                 ## Updated contributor
+```
+
+#### Delete contributor
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-contributor-delete)
+
+```ruby
+@client.delete_contributor(project_id, contributor_id)     # Input:
+                                                           ## project_id (string, required)
+                                                           ## contributor_id (string, required)
+                                                           # Output:
+                                                           ## Hash with the project's id and "contributor_deleted"=>true
+```
+
+### Files
+
+[File attributes](https://lokalise.co/api2docs/ruby/#object-files)
+
+#### Fetch translation files
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-files-get)
+
+```ruby
+@client.files(project_id, params = {})  # Input:
+                                        ## project_id (string, required)
+                                        ## params (hash)
+                                        ### :page and :limit
+                                        # Output:
+                                        ## Collection of translation files available in the given project
+```
+
+#### Download translation files
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-download-files-post)
+
+Exports project files as a `.zip` bundle and makes them available to download (the link is valid for 12 months).
+
+```ruby
+@client.download_files(project_id, params)  # Input:
+                                        ## project_id (string, required)
+                                        ## params (hash, required)
+                                        ### :format (string, required) - one of the file formats supported by Lokalise (json, xml, po etc).
+                                        ### Find the list of other supported params at https://lokalise.co/api2docs/ruby/#transition-download-files-post 
+                                        # Output:
+                                        ## Hash with the project id and a "bundle_url" link
+```
+
+#### Upload translation file
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-upload-a-file-post)
+
+```ruby
+@client.upload_file(project_id, params) # Input:
+                                        ## project_id (string, required)
+                                        ## params (hash, required)
+                                        ### :data (string, required) - base64-encoded data (the format must be supported by Lokalise)
+                                        ### :filename (string, required)
+                                        ### :lang_iso (string, required) 
+                                        ### Find the list of other supported params at https://lokalise.co/api2docs/ruby/#transition-upload-a-file-post
+                                        # Output:
+                                        ## Hash with information about the upload
+```
+
+### Keys
+
+[Key attributes](https://lokalise.co/api2docs/ruby/#object-keys)
+
+#### Fetch project keys
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-keys-get)
+
+```ruby
+@client.keys(project_id, params = {})   # Input:
+                                        ## project_id (string, required)
+                                        ## params (hash)
+                                        ### :page and :limit
+                                        # Output:
+                                        ## Collection of keys available in the given project
+```
+
+#### Fetch a single project key
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-key-get)
+
+```ruby
+@client.key(project_id, key_id, params = {})    # Input:
+                                                ## project_id (string, required)
+                                                ## key_id (string, required) 
+                                                ## params (hash)
+                                                ### :disable_references (string) - possible values are "1" and "0".
+                                                # Output:
+                                                ## Project key
+```
+
+#### Create project keys
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-keys-post)
+
+```ruby
+@client.create_keys(project_id, params)   # Input:
+                                          ## project_id (string, required)
+                                          ## params (array of hashes or hash, required)
+                                          ### :key_name (string or hash, required) - for projects with enabled per-platform key names, pass hash with "ios", "android", "web" and "other" params.
+                                          ### :platforms (array) - supported values are "ios", "android", "web" and "other"
+### Find all other supported attributes at https://lokalise.co/api2docs/ruby/#transition-create-keys-post 
+                                          # Output:
+                                          ## Collection of newly created keys
+```
+
+#### Update project key
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-key-put)
+
+```ruby
+@client.update_key(project_id, key_id, params = {})   # Input:
+                                                      ## project_id (string, required)
+                                                      ## key_id (string, required)  
+                                                      ## params (hash)
+                                                      ### Find a list of supported attributes at https://lokalise.co/api2docs/ruby/#transition-update-a-key-put
+                                                      # Output:
+                                                      ## Updated key
+```
+
+#### Bulk update project keys
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-bulk-update-put)
+
+```ruby
+@client.update_keys(project_id, params)  # Input:
+                                         ## project_id (string, required)
+                                         ## params (hash or array of hashes, required)
+                                         ### :key_id (string, required)
+                                         ### Find all other supported attributes at https://lokalise.co/api2docs/ruby/#transition-bulk-update-put 
+                                         # Output:
+                                         ## Collection of updated keys
+```
+
+#### Delete project key
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-key-delete)
+
+```ruby
+@client.delete_key(project_id, key_id)  # Input:
+                                        ## project_id (string, required)
+                                        ## key_id (string, required)  
+                                        # Output:
+                                        ## Hash with project_id and "key_removed" set to "true"
+```
+
+#### Bulk delete project keys
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-multiple-keys-delete)
+
+```ruby
+@client.delete_keys(project_id, key_ids)  # Input:
+                                          ## project_id (string, required)
+                                          ## key_ids (array, required)  
+                                          # Output:
+                                          ## Hash with project_id and "keys_removed" set to "true"
+```
+
+### Languages
+
+[Language attributes](https://lokalise.co/api2docs/ruby/#object-languages)
+
+#### Fetch system languages
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-system-languages-get)
+
+```ruby
+@client.system_languages(params = {})   # Input:
+                                        ## params (hash)
+                                        ### :page and :limit
+                                        # Output:
+                                        ## Collection of system languages supported by Lokalise
+```
+
+#### Fetch project languages
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-project-languages-get)
+
+```ruby
+@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
+```
+
+#### Fetch a single project language
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-language-get)
+
+```ruby
+@client.language(project_id, language_id)     # Input:
+                                              ## project_id (string, required)
+                                              ## language_id (string, required)
+                                              # Output:
+                                              ## A single language in the given project
+```
+
+#### Create project languages
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-languages-post)
+
+```ruby
+@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
+```
+
+#### Update project language
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-language-put)
+
+```ruby
+@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
+```
+
+#### Delete project language
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-language-delete)
+
+```ruby
+@client.delete_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
+```
+
+### Projects
+
+[Project attributes](https://lokalise.co/api2docs/php/#object-projects)
+
+#### Fetch projects collection
+
+[Doc](https://lokalise.co/api2docs/php/#transition-list-all-projects-get)
+
+```ruby
+@client.projects(params = {})   # Input:
+                                ## params (hash)
+                                ### :filter_team_id (string) - load projects only for the given team
+                                ### :page and :limit
+                                # Output:
+                                ## Collection of projects under the `projects` attribute 
+```
+
+#### Fetch a single project
+
+[Doc](https://lokalise.co/api2docs/php/#transition-retrieve-a-project-get)
+
+```ruby
+@client.project(project_id)     # Input:
+                                ## project_id (string, required)
+                                # Output:
+                                ## A single project 
+```
+
+#### Create a project
+
+[Doc](https://lokalise.co/api2docs/php/#transition-create-a-project-post)
+
+```ruby
+@client.create_project(params)  # Input:
+                                ## params (hash, required)
+                                ### name (string, required)
+                                ### description (string)
+                                ### team_id (integer) - you must be an admin of the chosen team. When omitted, defaults to the current team of the token's owner 
+                                # Output:
+                                ## A newly created project 
+
+```
+
+#### Update a project
+
+[Doc](https://lokalise.co/api2docs/php/#transition-update-a-project-put)
+
+```ruby
+@client.update_project(project_id, params)  # Input:
+                                            ## project_id (string, required)
+                                            ## params (hash, required)
+                                            ### name (string, required)
+                                            ### description (string)
+                                            # Output:
+                                            ## An updated project
+```
+
+#### Empty a project
+
+[Doc](https://lokalise.co/api2docs/php/#transition-empty-a-project-put)
+
+Deletes *all* keys and translations from the project.
+
+```ruby
+@client.empty_project(project_id)   # Input:
+                                    ## project_id (string, required)
+                                    # Output:
+                                    ## A project containing its id and a `keys_deleted => true` attribute
+```
+
+#### Delete a project
+
+[Doc](https://lokalise.co/api2docs/php/#transition-delete-a-project-delete)
+
+```ruby
+@client.delete_project(project_id)    # Input:
+                                      ## project_id (string, required)
+                                      # Output:
+                                      ## A project containing its id and a `project_deleted => true` attribute
+```
+
+### Screenshots
+
+[Screenshot attributes](https://lokalise.co/api2docs/ruby/#resource-screenshots)
+
+#### Fetch screenshots
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-screenshots-get)
+
+```ruby
+@client.screenshots(project_id, params = {})  # Input:
+                                              ## project_id (string, required)
+                                              ## params (hash)
+                                              ### :page and :limit
+                                              # Output:
+                                              ## Collection of project screenshots
+```
+
+#### Fetch a single screenshot
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-screenshot-get)
+
+```ruby
+@client.screeshot(project_id, screeshot_id)     # Input:
+                                                ## project_id (string, required)
+                                                ## screeshot_id (string, required)
+                                                # Output:
+                                                ## A single screenshot 
+```
+
+#### Create screenshots
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-screenshots-post)
+
+```ruby
+@client.create_screenshots(project_id, params)     # Input:
+                                                   ## project_id (string, required)
+                                                   ## params (hash or array of hashes, required)
+                                                   ### :data (string, required) - the actual screenshot, base64-encoded (with leading image type "data:image/jpeg;base64,"). JPG and PNG formats are supported.
+                                                   ### :title (string) 
+                                                   ### :description (string)
+                                                   ### :ocr (boolean) - recognize translations on the image and attach screenshot to all possible keys
+                                                   ### :key_ids (array) - attach the screenshot to key IDs specified
+                                                   ### :tags (array) 
+                                                   # Output:
+                                                   ## Collection of created screenshots
+```
+
+#### Update screenshot
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-screenshot-put)
+
+```ruby
+@client.update_screenshot(project_id, screenshot_id, params = {}) # Input:
+                                                                  ## project_id (string, required)
+                                                                  ## screenshot_id (string, required)
+                                                                  ## params (hash)
+                                                                  ### :title (string) 
+                                                                  ### :description (string)
+                                                                  ### :key_ids (array) - attach the screenshot to key IDs specified
+                                                                  ### :tags (array) 
+                                                                  # Output:
+                                                                  ## Updated screenshot
+```
+
+#### Delete screenshot
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-screenshot-delete)
+
+```ruby
+@client.delete_screenshot(project_id, screenshot_id)    # Input:
+                                                        ## project_id (string, required)
+                                                        ## screenshot_id (string, required)
+                                                        # Output:
+                                                        ## Hash with the project id and "screenshot_deleted" set to "true"
+```
+
+### Snapshots
+
+[Snapshot attributes](https://lokalise.co/api2docs/ruby/#object-snapshots)
+
+#### Fetch snapshots
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-snapshots-get)
+
+```ruby
+@client.snapshots(project_id, params = {})  # Input:
+                                            ## project_id (string, required)
+                                            ## params (hash)
+                                            ### :filter_title (string) - set title filter for the list 
+                                            ### :page and :limit
+                                            # Output:
+                                            ## Collection of project snapshots
+```
+
+#### Create snapshot
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-a-snapshot-post)
+
+```ruby
+@client.create_snapshot(project_id, params = {})  # Input:
+                                                  ## project_id (string, required)
+                                                  ## params (hash)
+                                                  ### :title (string)
+                                                  # Output:
+                                                  ## Created snapshot
+```
+
+#### Restore snapshot
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-restore-a-snapshot-post)
+
+```ruby
+@client.restore_snapshot(project_id, snapshot_id)   # Input:
+                                                    ## project_id (string, required)
+                                                    ## snapshot_id (string, required)
+                                                    # Output:
+                                                    ## Information about the restored project from the specified snapshot
+```
+
+#### Delete snapshot
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-snapshot-delete)
+
+```ruby
+@client.delete_snapshot(project_id, snapshot_id)    # Input:
+                                                    ## project_id (string, required)
+                                                    ## snapshot_id (string, required)
+                                                    # Output:
+                                                    ## Hash with the project id and "snapshot_deleted" set to "true"
+```
+
+### Tasks
+
+[Task attributes](https://lokalise.co/api2docs/ruby/#resource-tasks)
+
+#### Fetch tasks
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-tasks-get)
+
+```ruby
+@client.tasks(project_id, params = {})  # Input:
+                                        ## project_id (string, required)
+                                        ## params (hash)
+                                        ### :filter_title (string) - set title filter for the list 
+                                        ### :page and :limit
+                                        # Output:
+                                        ## Collection of tasks for the project
+```
+
+#### Fetch a single task
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-task-get)
+
+```ruby
+@client.task(project_id, task_id, params = {})  # Input:
+                                                ## project_id (string, required)
+                                                ## task_id (string, required)
+                                                # Output:
+                                                ## Single task for the project
+```
+
+#### Create task
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-create-a-task-post)
+
+```ruby
+@client.create_task(project_id, params)  # Input:
+                                         ## project_id (string, required)
+                                         ## params (hash, required)
+                                         ### title (string, required)
+                                         ### keys (array) - translation key ids. Required if "parent_task_id" is not specified 
+                                         ### languages (array of hashes, required)
+                                         #### language_iso (string)
+                                         #### users (array) - list of users identifiers, assigned to work on the language 
+                                         ### Find other supported options at https://lokalise.co/api2docs/ruby/#transition-create-a-task-post 
+                                         # Output:
+                                         ## A newly created task 
+
+```
+
+#### Update task
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-task-put)
+
+```ruby
+@client.delete_task(project_id, task_id)   # Input:
+                                           ## project_id (string, required)
+                                           ## task_id (string, required) 
+                                           # Output:
+                                           ## Hash with the project id and "task_deleted" set to "true"
+
+```
+
+### Teams
+
+#### Fetch teams
+
+[Doc](https://lokalise.co/api2docs/ruby/#resource-teams)
+
+```ruby
+@client.teams(params = {})  # Input:
+                            ## params (hash)
+                            ### :page and :limit
+                            # Output:
+                            ## Collection of teams
+```
+
+### Team users
+
+[Team user attributes](https://lokalise.co/api2docs/ruby/#object-team-users)
+
+#### Fetch team users
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-team-users-get)
+
+```ruby
+@client.team_users(team_id, params = {})  # Input:
+                                          ## team_id (string, required)
+                                          ## params (hash)
+                                          ### :page and :limit
+                                          # Output:
+                                          ## Collection of team users
+```
+
+#### Fetch a single team user
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-team-user-get)
+
+```ruby
+@client.team_user(team_id, user_id)  # Input:
+                                          ## team_id (string, required)
+                                          ## user_id (string, required)
+                                          # Output:
+                                          ## Team user
+```
+
+#### Update team user
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-team-user-put)
+
+```ruby
+@client.update_team_user(team_id, user_id, params)  # Input:
+                                                    ## team_id (string, required)
+                                                    ## user_id (string, required)
+                                                    ## params (hash, required):
+                                                    ### :role (string, required) - :owner, :admin, or :member 
+                                                    # Output:
+                                                    ## Updated team user
+```
+
+#### Delete team user
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-delete-a-team-user-delete)
+
+```ruby
+@client.delete_team_user(team_id, user_id)  # Input:
+                                            ## team_id (string, required)
+                                            ## user_id (string, required)
+                                            # Output:
+                                            ## Hash with "team_id" and "team_user_deleted" set to "true"
+```
+
+### Translations
+
+[Translation attributes](https://lokalise.co/api2docs/ruby/#resource-translations)
+
+#### Fetch translations
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-list-all-translations-get)
+
+```ruby
+@client.translations(project_id, params = {})   # Input:
+                                                ## project_id (string, required)
+                                                ## params (hash)
+                                                ### :disable_references (string) - whether to disable key references. Supported values are 0 and 1
+                                                ### :page and :limit
+                                                # Output:
+                                                ## Collection of translations for the project
+```
+
+#### Fetch a single translation
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-retrieve-a-translation-get)
+
+```ruby
+@client.translation(project_id, translation_id, params = {})   # Input:
+                                                                ## project_id (string, required)
+                                                                ## translation_id (string, required) 
+                                                                ## params (hash)
+                                                                ### :disable_references (string) - whether to disable key references. Supported values are 0 and 1
+                                                                # Output:
+                                                                ## Single translation for the project
+```
+
+#### Update translation
+
+[Doc](https://lokalise.co/api2docs/ruby/#transition-update-a-translation-put)
+
+```ruby
+@client.update_translation(project_id, translation_id, params = {})   # Input:
+                                                                      ## project_id (string, required)
+                                                                      ## translation_id (string, required) 
+                                                                      ## params (hash, required)
+                                                                      ### :translation (string or hash, required) - the actual translation. Provide hash for plural keys.
+                                                                      ### :is_fuzzy (boolean)
+                                                                      ### :is_reviewed (boolean) 
+                                                                      # Output:
+                                                                      ## Updated translation
+```
+
+## Additional Info
+
+### Error handling
+
+[Error codes](https://lokalise.co/api2docs/curl/#resource-errors)
+
+The gem may raise the following custom exceptions:
+
+* `Lokalise::Error::BadRequest` (`400`) - the provided request incorrect
+* `Lokalise::Error::Unauthorized` (`401`) - token is missing or incorrect
+* `Lokalise::Error::Forbidden` (`403`) - authenticated user does not have sufficient rights to perform the desired action
+* `Lokalise::Error::NotFound` (`404`) - the provided endpoint (resource) cannot be found
+* `Lokalise::Error::NotAcceptable` (`406`) - posted resource is malformed
+* `Lokalise::Error::Conflict` (`409`) - request conflicts with another request
+* `Lokalise::Error::Locked` (`423`) - your token is used simultaneously in multiple requests
+* `Lokalise::Error::TooManyRequests` (`429`)
+* `Lokalise::Error::ServerError` (`500`)
+* `Lokalise::Error::BadGateway` (`502`)
+* `Lokalise::Error::ServiceUnavailable` (`503`)
+* `Lokalise::Error::GatewayTimeout` (`504`)
+
+### API Rate Limits
+
+Lokalise does not [rate-limit API requests](https://lokalise.co/api2docs/ruby/#resource-rate-limits), however retain a right to decline the service in case of excessive use. Only one concurrent request per token is allowed. To ensure data consistency, it is not recommended to access the same project simultaneously using multiple tokens.
+
+## Running Tests
+
+1. Copypaste `.env.example` file as `.env`. Put your API token inside. The `.env` file is excluded from version control so your token is safe. All in all, we use pre-recorded VCR cassettes, so the actual API requests won't be sent. However, providing at least some token is required.
+3. Run `rspec .`. Observe test results and code coverage.
+
+## License
+
+This gem is licensed under the [MIT License](https://github.com/lokalise/ruby-lokalise-api/blob/master/LICENSE).
+
+Copyright (c) [Lokalise team](http://lokalise.co), [Ilya Bodrov](http://bodrovis.tech)