ruby-lokalise-api 2.6.0 → 2.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/CHANGELOG.md +5 -0
 - data/README.md +111 -111
 - data/lib/ruby-lokalise-api/version.rb +1 -1
 - data/ruby-lokalise-api.gemspec +1 -1
 - data/spec/lib/ruby-lokalise-api/connection_spec.rb +3 -2
 - metadata +5 -5
 
    
        checksums.yaml
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ---
         
     | 
| 
       2 
2 
     | 
    
         
             
            SHA256:
         
     | 
| 
       3 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       4 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 3 
     | 
    
         
            +
              metadata.gz: 351308874866cd98db13d8bbbf34ade5a37b8901f1badd0e83d0d3fd4b20cbd7
         
     | 
| 
      
 4 
     | 
    
         
            +
              data.tar.gz: be7c9830e9bc5814e475bca1fe93f753b1003d4fc9759f0a6c630674589aecee
         
     | 
| 
       5 
5 
     | 
    
         
             
            SHA512:
         
     | 
| 
       6 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       7 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 6 
     | 
    
         
            +
              metadata.gz: 45b888681cc8dc71d381165f8a4708dc4315cb6d34cd4d64aa08e9ed69ccb0b761e16cbad3930c0468fd4240c4eb6ea8eb44172f97170219c534ab4a76ef92a8
         
     | 
| 
      
 7 
     | 
    
         
            +
              data.tar.gz: 9b57fda5217a2003f8cb7f5f381d93b60d771789962333bc7241320bcf18cd89098ed83acad29ee46aeccfd5c8990727d338b1ffeb4e06c5353b38dc1e6bb247
         
     | 
    
        data/CHANGELOG.md
    CHANGED
    
    | 
         @@ -1,5 +1,10 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            # Changelog
         
     | 
| 
       2 
2 
     | 
    
         | 
| 
      
 3 
     | 
    
         
            +
            ## 2.6.1 (27-Sep-19)
         
     | 
| 
      
 4 
     | 
    
         
            +
             
     | 
| 
      
 5 
     | 
    
         
            +
            * Update dependencies
         
     | 
| 
      
 6 
     | 
    
         
            +
            * Update tests for the latest Faraday (0.16)
         
     | 
| 
      
 7 
     | 
    
         
            +
             
     | 
| 
       3 
8 
     | 
    
         
             
            ## 2.6.0 (21-Aug-19)
         
     | 
| 
       4 
9 
     | 
    
         | 
| 
       5 
10 
     | 
    
         
             
            * Added [`Webhook` endpoint](https://lokalise.co/api2docs/curl/#resource-webhooks) (thanks to [@snkashis](https://github.com/snkashis) for help!)
         
     | 
    
        data/README.md
    CHANGED
    
    | 
         @@ -3,7 +3,7 @@ 
     | 
|
| 
       3 
3 
     | 
    
         
             
            [](https://badge.fury.io/rb/ruby-lokalise-api)
         
     | 
| 
       4 
4 
     | 
    
         
             
            [](https://travis-ci.org/lokalise/ruby-lokalise-api)
         
     | 
| 
       5 
5 
     | 
    
         | 
| 
       6 
     | 
    
         
            -
            Official opinionated Ruby interface for the [Lokalise API](https://lokalise. 
     | 
| 
      
 6 
     | 
    
         
            +
            Official opinionated Ruby interface for the [Lokalise API](https://lokalise.com/api2docs/ruby/) that represents returned data as Ruby objects.
         
     | 
| 
       7 
7 
     | 
    
         | 
| 
       8 
8 
     | 
    
         
             
            ## Index
         
     | 
| 
       9 
9 
     | 
    
         | 
| 
         @@ -52,7 +52,7 @@ $ gem install ruby-lokalise-api 
     | 
|
| 
       52 
52 
     | 
    
         | 
| 
       53 
53 
     | 
    
         
             
            ### Initializing the Client
         
     | 
| 
       54 
54 
     | 
    
         | 
| 
       55 
     | 
    
         
            -
            In order to perform API requests, you require a special token that can be obtained in your [personal profile](https://lokalise. 
     | 
| 
      
 55 
     | 
    
         
            +
            In order to perform API requests, you require a special token that can be obtained in your [personal profile](https://lokalise.com/profile#apitokens) (*API tokens* section). Note that the owner of the token must have admin access rights.
         
     | 
| 
       56 
56 
     | 
    
         | 
| 
       57 
57 
     | 
    
         
             
            After you've obtained the token, initialize the client:
         
     | 
| 
       58 
58 
     | 
    
         | 
| 
         @@ -98,7 +98,7 @@ project = @client.projects.collection.first # => Get the first project 
     | 
|
| 
       98 
98 
     | 
    
         
             
            project.name
         
     | 
| 
       99 
99 
     | 
    
         
             
            ```
         
     | 
| 
       100 
100 
     | 
    
         | 
| 
       101 
     | 
    
         
            -
            Bulk fetches support [pagination](https://lokalise. 
     | 
| 
      
 101 
     | 
    
         
            +
            Bulk fetches support [pagination](https://lokalise.com/api2docs/php/#resource-pagination). There are two common parameters available:
         
     | 
| 
       102 
102 
     | 
    
         | 
| 
       103 
103 
     | 
    
         
             
            * `:limit` (defaults to `100`, maximum is `5000`) - number of records to display per page
         
     | 
| 
       104 
104 
     | 
    
         
             
            * `:page` (defaults  to `1`) - page to fetch
         
     | 
| 
         @@ -142,11 +142,11 @@ translations.prev_page # => will load the previous page while preserving the `li 
     | 
|
| 
       142 
142 
     | 
    
         | 
| 
       143 
143 
     | 
    
         
             
            ### Comments
         
     | 
| 
       144 
144 
     | 
    
         | 
| 
       145 
     | 
    
         
            -
            [Comments attributes](https://lokalise. 
     | 
| 
      
 145 
     | 
    
         
            +
            [Comments attributes](https://lokalise.com/api2docs/ruby/#resource-comments)
         
     | 
| 
       146 
146 
     | 
    
         | 
| 
       147 
147 
     | 
    
         
             
            #### Fetch project comments
         
     | 
| 
       148 
148 
     | 
    
         | 
| 
       149 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 149 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-project-comments-get)
         
     | 
| 
       150 
150 
     | 
    
         | 
| 
       151 
151 
     | 
    
         
             
            ```ruby
         
     | 
| 
       152 
152 
     | 
    
         
             
            @client.project_comments(project_id, params = {})   # Input:
         
     | 
| 
         @@ -159,7 +159,7 @@ translations.prev_page # => will load the previous page while preserving the `li 
     | 
|
| 
       159 
159 
     | 
    
         | 
| 
       160 
160 
     | 
    
         
             
            #### Fetch key comments
         
     | 
| 
       161 
161 
     | 
    
         | 
| 
       162 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 162 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-key-comments-get)
         
     | 
| 
       163 
163 
     | 
    
         | 
| 
       164 
164 
     | 
    
         
             
            ```ruby
         
     | 
| 
       165 
165 
     | 
    
         
             
            @client.comments(project_id, key_id, params = {})   # Input:
         
     | 
| 
         @@ -173,7 +173,7 @@ translations.prev_page # => will load the previous page while preserving the `li 
     | 
|
| 
       173 
173 
     | 
    
         | 
| 
       174 
174 
     | 
    
         
             
            #### Create key comments
         
     | 
| 
       175 
175 
     | 
    
         | 
| 
       176 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 176 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-comments-post)
         
     | 
| 
       177 
177 
     | 
    
         | 
| 
       178 
178 
     | 
    
         
             
            ```ruby
         
     | 
| 
       179 
179 
     | 
    
         
             
            @client.create_comments(project_id, key_id, params)   # Input:
         
     | 
| 
         @@ -187,7 +187,7 @@ translations.prev_page # => will load the previous page while preserving the `li 
     | 
|
| 
       187 
187 
     | 
    
         | 
| 
       188 
188 
     | 
    
         
             
            #### Fetch key comment
         
     | 
| 
       189 
189 
     | 
    
         | 
| 
       190 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 190 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-comment-get)
         
     | 
| 
       191 
191 
     | 
    
         | 
| 
       192 
192 
     | 
    
         
             
            ```ruby
         
     | 
| 
       193 
193 
     | 
    
         
             
            @client.comment(project_id, key_id, comment_id)   # Input:
         
     | 
| 
         @@ -200,7 +200,7 @@ translations.prev_page # => will load the previous page while preserving the `li 
     | 
|
| 
       200 
200 
     | 
    
         | 
| 
       201 
201 
     | 
    
         
             
            #### Delete key comment
         
     | 
| 
       202 
202 
     | 
    
         | 
| 
       203 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 203 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-comment-delete)
         
     | 
| 
       204 
204 
     | 
    
         | 
| 
       205 
205 
     | 
    
         
             
            ```ruby
         
     | 
| 
       206 
206 
     | 
    
         
             
            @client.destroy_comment(project_id, key_id, comment_id)   # Input:
         
     | 
| 
         @@ -222,7 +222,7 @@ comment.destroy 
     | 
|
| 
       222 
222 
     | 
    
         | 
| 
       223 
223 
     | 
    
         
             
            #### Fetch contributors
         
     | 
| 
       224 
224 
     | 
    
         | 
| 
       225 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 225 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-contributors-get)
         
     | 
| 
       226 
226 
     | 
    
         | 
| 
       227 
227 
     | 
    
         
             
            ```ruby
         
     | 
| 
       228 
228 
     | 
    
         
             
            @client.contributors(project_id, params = {})   # Input:
         
     | 
| 
         @@ -235,7 +235,7 @@ comment.destroy 
     | 
|
| 
       235 
235 
     | 
    
         | 
| 
       236 
236 
     | 
    
         
             
            #### Fetch a single contributor
         
     | 
| 
       237 
237 
     | 
    
         | 
| 
       238 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 238 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-contributor-get)
         
     | 
| 
       239 
239 
     | 
    
         | 
| 
       240 
240 
     | 
    
         
             
            ```ruby
         
     | 
| 
       241 
241 
     | 
    
         
             
            @client.contributor(project_id, contributor_id)   # Input:
         
     | 
| 
         @@ -247,7 +247,7 @@ comment.destroy 
     | 
|
| 
       247 
247 
     | 
    
         | 
| 
       248 
248 
     | 
    
         
             
            #### Create contributors
         
     | 
| 
       249 
249 
     | 
    
         | 
| 
       250 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 250 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-contributors-post)
         
     | 
| 
       251 
251 
     | 
    
         | 
| 
       252 
252 
     | 
    
         
             
            ```ruby
         
     | 
| 
       253 
253 
     | 
    
         
             
            @client.create_contributors(project_id, params)  # Input:
         
     | 
| 
         @@ -267,7 +267,7 @@ comment.destroy 
     | 
|
| 
       267 
267 
     | 
    
         | 
| 
       268 
268 
     | 
    
         
             
            #### Update contributor
         
     | 
| 
       269 
269 
     | 
    
         | 
| 
       270 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 270 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-contributor-put)
         
     | 
| 
       271 
271 
     | 
    
         | 
| 
       272 
272 
     | 
    
         
             
            ```ruby
         
     | 
| 
       273 
273 
     | 
    
         
             
            @client.update_contributor(project_id, contributor_id, params)   # Input:
         
     | 
| 
         @@ -293,7 +293,7 @@ contributor.update(params) 
     | 
|
| 
       293 
293 
     | 
    
         | 
| 
       294 
294 
     | 
    
         
             
            #### Delete contributor
         
     | 
| 
       295 
295 
     | 
    
         | 
| 
       296 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 296 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-contributor-delete)
         
     | 
| 
       297 
297 
     | 
    
         | 
| 
       298 
298 
     | 
    
         
             
            ```ruby
         
     | 
| 
       299 
299 
     | 
    
         
             
            @client.destroy_contributor(project_id, contributor_id)    # Input:
         
     | 
| 
         @@ -312,11 +312,11 @@ contributor.destroy 
     | 
|
| 
       312 
312 
     | 
    
         | 
| 
       313 
313 
     | 
    
         
             
            ### Files
         
     | 
| 
       314 
314 
     | 
    
         | 
| 
       315 
     | 
    
         
            -
            [File attributes](https://lokalise. 
     | 
| 
      
 315 
     | 
    
         
            +
            [File attributes](https://lokalise.com/api2docs/ruby/#object-files)
         
     | 
| 
       316 
316 
     | 
    
         | 
| 
       317 
317 
     | 
    
         
             
            #### Fetch translation files
         
     | 
| 
       318 
318 
     | 
    
         | 
| 
       319 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 319 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-files-get)
         
     | 
| 
       320 
320 
     | 
    
         | 
| 
       321 
321 
     | 
    
         
             
            ```ruby
         
     | 
| 
       322 
322 
     | 
    
         
             
            @client.files(project_id, params = {})  # Input:
         
     | 
| 
         @@ -329,7 +329,7 @@ contributor.destroy 
     | 
|
| 
       329 
329 
     | 
    
         | 
| 
       330 
330 
     | 
    
         
             
            #### Download translation files
         
     | 
| 
       331 
331 
     | 
    
         | 
| 
       332 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 332 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-download-files-post)
         
     | 
| 
       333 
333 
     | 
    
         | 
| 
       334 
334 
     | 
    
         
             
            Exports project files as a `.zip` bundle and makes them available to download (the link is valid for 12 months).
         
     | 
| 
       335 
335 
     | 
    
         | 
| 
         @@ -338,14 +338,14 @@ Exports project files as a `.zip` bundle and makes them available to download (t 
     | 
|
| 
       338 
338 
     | 
    
         
             
                                                    ## project_id (string, required)
         
     | 
| 
       339 
339 
     | 
    
         
             
                                                    ## params (hash, required)
         
     | 
| 
       340 
340 
     | 
    
         
             
                                                    ### :format (string, required) - one of the file formats supported by Lokalise (json, xml, po etc).
         
     | 
| 
       341 
     | 
    
         
            -
                                                    ### Find the list of other supported params at https://lokalise. 
     | 
| 
      
 341 
     | 
    
         
            +
                                                    ### Find the list of other supported params at https://lokalise.com/api2docs/ruby/#transition-download-files-post 
         
     | 
| 
       342 
342 
     | 
    
         
             
                                                    # Output:
         
     | 
| 
       343 
343 
     | 
    
         
             
                                                    ## Hash with the project id and a "bundle_url" link
         
     | 
| 
       344 
344 
     | 
    
         
             
            ```
         
     | 
| 
       345 
345 
     | 
    
         | 
| 
       346 
346 
     | 
    
         
             
            #### Upload translation file
         
     | 
| 
       347 
347 
     | 
    
         | 
| 
       348 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 348 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-upload-a-file-post)
         
     | 
| 
       349 
349 
     | 
    
         | 
| 
       350 
350 
     | 
    
         
             
            ```ruby
         
     | 
| 
       351 
351 
     | 
    
         
             
            @client.upload_file(project_id, params) # Input:
         
     | 
| 
         @@ -354,18 +354,18 @@ Exports project files as a `.zip` bundle and makes them available to download (t 
     | 
|
| 
       354 
354 
     | 
    
         
             
                                                    ### :data (string, required) - base64-encoded data (the format must be supported by Lokalise)
         
     | 
| 
       355 
355 
     | 
    
         
             
                                                    ### :filename (string, required)
         
     | 
| 
       356 
356 
     | 
    
         
             
                                                    ### :lang_iso (string, required) 
         
     | 
| 
       357 
     | 
    
         
            -
                                                    ### Find the list of other supported params at https://lokalise. 
     | 
| 
      
 357 
     | 
    
         
            +
                                                    ### Find the list of other supported params at https://lokalise.com/api2docs/ruby/#transition-upload-a-file-post
         
     | 
| 
       358 
358 
     | 
    
         
             
                                                    # Output:
         
     | 
| 
       359 
359 
     | 
    
         
             
                                                    ## Hash with information about the upload
         
     | 
| 
       360 
360 
     | 
    
         
             
            ```
         
     | 
| 
       361 
361 
     | 
    
         | 
| 
       362 
362 
     | 
    
         
             
            ### Keys
         
     | 
| 
       363 
363 
     | 
    
         | 
| 
       364 
     | 
    
         
            -
            [Key attributes](https://lokalise. 
     | 
| 
      
 364 
     | 
    
         
            +
            [Key attributes](https://lokalise.com/api2docs/ruby/#object-keys)
         
     | 
| 
       365 
365 
     | 
    
         | 
| 
       366 
366 
     | 
    
         
             
            #### Fetch project keys
         
     | 
| 
       367 
367 
     | 
    
         | 
| 
       368 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 368 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-keys-get)
         
     | 
| 
       369 
369 
     | 
    
         | 
| 
       370 
370 
     | 
    
         
             
            ```ruby
         
     | 
| 
       371 
371 
     | 
    
         
             
            @client.keys(project_id, params = {})   # Input:
         
     | 
| 
         @@ -378,7 +378,7 @@ Exports project files as a `.zip` bundle and makes them available to download (t 
     | 
|
| 
       378 
378 
     | 
    
         | 
| 
       379 
379 
     | 
    
         
             
            #### Fetch a single project key
         
     | 
| 
       380 
380 
     | 
    
         | 
| 
       381 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 381 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-key-get)
         
     | 
| 
       382 
382 
     | 
    
         | 
| 
       383 
383 
     | 
    
         
             
            ```ruby
         
     | 
| 
       384 
384 
     | 
    
         
             
            @client.key(project_id, key_id, params = {})    # Input:
         
     | 
| 
         @@ -392,7 +392,7 @@ Exports project files as a `.zip` bundle and makes them available to download (t 
     | 
|
| 
       392 
392 
     | 
    
         | 
| 
       393 
393 
     | 
    
         
             
            #### Create project keys
         
     | 
| 
       394 
394 
     | 
    
         | 
| 
       395 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 395 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-keys-post)
         
     | 
| 
       396 
396 
     | 
    
         | 
| 
       397 
397 
     | 
    
         
             
            ```ruby
         
     | 
| 
       398 
398 
     | 
    
         
             
            @client.create_keys(project_id, params)   # Input:
         
     | 
| 
         @@ -400,21 +400,21 @@ Exports project files as a `.zip` bundle and makes them available to download (t 
     | 
|
| 
       400 
400 
     | 
    
         
             
                                                      ## params (array of hashes or hash, required)
         
     | 
| 
       401 
401 
     | 
    
         
             
                                                      ### :key_name (string or hash, required) - for projects with enabled per-platform key names, pass hash with "ios", "android", "web" and "other" params.
         
     | 
| 
       402 
402 
     | 
    
         
             
                                                      ### :platforms (array) - supported values are "ios", "android", "web" and "other"
         
     | 
| 
       403 
     | 
    
         
            -
            ### Find all other supported attributes at https://lokalise. 
     | 
| 
      
 403 
     | 
    
         
            +
            ### Find all other supported attributes at https://lokalise.com/api2docs/ruby/#transition-create-keys-post 
         
     | 
| 
       404 
404 
     | 
    
         
             
                                                      # Output:
         
     | 
| 
       405 
405 
     | 
    
         
             
                                                      ## Collection of newly created keys
         
     | 
| 
       406 
406 
     | 
    
         
             
            ```
         
     | 
| 
       407 
407 
     | 
    
         | 
| 
       408 
408 
     | 
    
         
             
            #### Update project key
         
     | 
| 
       409 
409 
     | 
    
         | 
| 
       410 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 410 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-key-put)
         
     | 
| 
       411 
411 
     | 
    
         | 
| 
       412 
412 
     | 
    
         
             
            ```ruby
         
     | 
| 
       413 
413 
     | 
    
         
             
            @client.update_key(project_id, key_id, params = {})   # Input:
         
     | 
| 
       414 
414 
     | 
    
         
             
                                                                  ## project_id (string, required)
         
     | 
| 
       415 
415 
     | 
    
         
             
                                                                  ## key_id (string, required)  
         
     | 
| 
       416 
416 
     | 
    
         
             
                                                                  ## params (hash)
         
     | 
| 
       417 
     | 
    
         
            -
                                                                  ### Find a list of supported attributes at https://lokalise. 
     | 
| 
      
 417 
     | 
    
         
            +
                                                                  ### Find a list of supported attributes at https://lokalise.com/api2docs/ruby/#transition-update-a-key-put
         
     | 
| 
       418 
418 
     | 
    
         
             
                                                                  # Output:
         
     | 
| 
       419 
419 
     | 
    
         
             
                                                                  ## Updated key
         
     | 
| 
       420 
420 
     | 
    
         
             
            ```
         
     | 
| 
         @@ -428,21 +428,21 @@ key.update(params) 
     | 
|
| 
       428 
428 
     | 
    
         | 
| 
       429 
429 
     | 
    
         
             
            #### Bulk update project keys
         
     | 
| 
       430 
430 
     | 
    
         | 
| 
       431 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 431 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-bulk-update-put)
         
     | 
| 
       432 
432 
     | 
    
         | 
| 
       433 
433 
     | 
    
         
             
            ```ruby
         
     | 
| 
       434 
434 
     | 
    
         
             
            @client.update_keys(project_id, params)  # Input:
         
     | 
| 
       435 
435 
     | 
    
         
             
                                                     ## project_id (string, required)
         
     | 
| 
       436 
436 
     | 
    
         
             
                                                     ## params (hash or array of hashes, required)
         
     | 
| 
       437 
437 
     | 
    
         
             
                                                     ### :key_id (string, required)
         
     | 
| 
       438 
     | 
    
         
            -
                                                     ### Find all other supported attributes at https://lokalise. 
     | 
| 
      
 438 
     | 
    
         
            +
                                                     ### Find all other supported attributes at https://lokalise.com/api2docs/ruby/#transition-bulk-update-put 
         
     | 
| 
       439 
439 
     | 
    
         
             
                                                     # Output:
         
     | 
| 
       440 
440 
     | 
    
         
             
                                                     ## Collection of updated keys
         
     | 
| 
       441 
441 
     | 
    
         
             
            ```
         
     | 
| 
       442 
442 
     | 
    
         | 
| 
       443 
443 
     | 
    
         
             
            #### Delete project key
         
     | 
| 
       444 
444 
     | 
    
         | 
| 
       445 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 445 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-key-delete)
         
     | 
| 
       446 
446 
     | 
    
         | 
| 
       447 
447 
     | 
    
         
             
            ```ruby
         
     | 
| 
       448 
448 
     | 
    
         
             
            @client.destroy_key(project_id, key_id) # Input:
         
     | 
| 
         @@ -461,7 +461,7 @@ key.destroy 
     | 
|
| 
       461 
461 
     | 
    
         | 
| 
       462 
462 
     | 
    
         
             
            #### Bulk delete project keys
         
     | 
| 
       463 
463 
     | 
    
         | 
| 
       464 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 464 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-multiple-keys-delete)
         
     | 
| 
       465 
465 
     | 
    
         | 
| 
       466 
466 
     | 
    
         
             
            ```ruby
         
     | 
| 
       467 
467 
     | 
    
         
             
            @client.destroy_keys(project_id, key_ids) # Input:
         
     | 
| 
         @@ -480,11 +480,11 @@ keys.destroy_all # => will effectively destroy all keys in the project 
     | 
|
| 
       480 
480 
     | 
    
         | 
| 
       481 
481 
     | 
    
         
             
            ### Languages
         
     | 
| 
       482 
482 
     | 
    
         | 
| 
       483 
     | 
    
         
            -
            [Language attributes](https://lokalise. 
     | 
| 
      
 483 
     | 
    
         
            +
            [Language attributes](https://lokalise.com/api2docs/ruby/#object-languages)
         
     | 
| 
       484 
484 
     | 
    
         | 
| 
       485 
485 
     | 
    
         
             
            #### Fetch system languages
         
     | 
| 
       486 
486 
     | 
    
         | 
| 
       487 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 487 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-system-languages-get)
         
     | 
| 
       488 
488 
     | 
    
         | 
| 
       489 
489 
     | 
    
         
             
            ```ruby
         
     | 
| 
       490 
490 
     | 
    
         
             
            @client.system_languages(params = {})   # Input:
         
     | 
| 
         @@ -496,7 +496,7 @@ keys.destroy_all # => will effectively destroy all keys in the project 
     | 
|
| 
       496 
496 
     | 
    
         | 
| 
       497 
497 
     | 
    
         
             
            #### Fetch project languages
         
     | 
| 
       498 
498 
     | 
    
         | 
| 
       499 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 499 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-project-languages-get)
         
     | 
| 
       500 
500 
     | 
    
         | 
| 
       501 
501 
     | 
    
         
             
            ```ruby
         
     | 
| 
       502 
502 
     | 
    
         
             
            @client.project_languages(project_id, params = {})    # Input:
         
     | 
| 
         @@ -509,7 +509,7 @@ keys.destroy_all # => will effectively destroy all keys in the project 
     | 
|
| 
       509 
509 
     | 
    
         | 
| 
       510 
510 
     | 
    
         
             
            #### Fetch a single project language
         
     | 
| 
       511 
511 
     | 
    
         | 
| 
       512 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 512 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-language-get)
         
     | 
| 
       513 
513 
     | 
    
         | 
| 
       514 
514 
     | 
    
         
             
            ```ruby
         
     | 
| 
       515 
515 
     | 
    
         
             
            @client.language(project_id, language_id)     # Input:
         
     | 
| 
         @@ -521,7 +521,7 @@ keys.destroy_all # => will effectively destroy all keys in the project 
     | 
|
| 
       521 
521 
     | 
    
         | 
| 
       522 
522 
     | 
    
         
             
            #### Create project languages
         
     | 
| 
       523 
523 
     | 
    
         | 
| 
       524 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 524 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-languages-post)
         
     | 
| 
       525 
525 
     | 
    
         | 
| 
       526 
526 
     | 
    
         
             
            ```ruby
         
     | 
| 
       527 
527 
     | 
    
         
             
            @client.create_languages(project_id, params)    # Input:
         
     | 
| 
         @@ -537,7 +537,7 @@ keys.destroy_all # => will effectively destroy all keys in the project 
     | 
|
| 
       537 
537 
     | 
    
         | 
| 
       538 
538 
     | 
    
         
             
            #### Update project language
         
     | 
| 
       539 
539 
     | 
    
         | 
| 
       540 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 540 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-language-put)
         
     | 
| 
       541 
541 
     | 
    
         | 
| 
       542 
542 
     | 
    
         
             
            ```ruby
         
     | 
| 
       543 
543 
     | 
    
         
             
            @client.update_language(project_id, language_id, params)    # Input:
         
     | 
| 
         @@ -560,7 +560,7 @@ language.update(params) 
     | 
|
| 
       560 
560 
     | 
    
         | 
| 
       561 
561 
     | 
    
         
             
            #### Delete project language
         
     | 
| 
       562 
562 
     | 
    
         | 
| 
       563 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 563 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-language-delete)
         
     | 
| 
       564 
564 
     | 
    
         | 
| 
       565 
565 
     | 
    
         
             
            ```ruby
         
     | 
| 
       566 
566 
     | 
    
         
             
            @client.destroy_language(project_id, language_id)    # Input:
         
     | 
| 
         @@ -579,11 +579,11 @@ language.destroy 
     | 
|
| 
       579 
579 
     | 
    
         | 
| 
       580 
580 
     | 
    
         
             
            ### Orders
         
     | 
| 
       581 
581 
     | 
    
         | 
| 
       582 
     | 
    
         
            -
            [Order attributes](https://lokalise. 
     | 
| 
      
 582 
     | 
    
         
            +
            [Order attributes](https://lokalise.com/api2docs/curl/#object-orders)
         
     | 
| 
       583 
583 
     | 
    
         | 
| 
       584 
584 
     | 
    
         
             
            #### Fetch order collection
         
     | 
| 
       585 
585 
     | 
    
         | 
| 
       586 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 586 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/curl/#transition-list-all-orders-get)
         
     | 
| 
       587 
587 
     | 
    
         | 
| 
       588 
588 
     | 
    
         
             
            ```ruby
         
     | 
| 
       589 
589 
     | 
    
         
             
            @client.orders(team_id, params = {})  # Input:
         
     | 
| 
         @@ -596,7 +596,7 @@ language.destroy 
     | 
|
| 
       596 
596 
     | 
    
         | 
| 
       597 
597 
     | 
    
         
             
            #### Fetch a single order
         
     | 
| 
       598 
598 
     | 
    
         | 
| 
       599 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 599 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-an-order-get)
         
     | 
| 
       600 
600 
     | 
    
         | 
| 
       601 
601 
     | 
    
         
             
            ```ruby
         
     | 
| 
       602 
602 
     | 
    
         
             
            @client.order(team_id, order_id)  # Input:
         
     | 
| 
         @@ -608,7 +608,7 @@ language.destroy 
     | 
|
| 
       608 
608 
     | 
    
         | 
| 
       609 
609 
     | 
    
         
             
            #### Create an order
         
     | 
| 
       610 
610 
     | 
    
         | 
| 
       611 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 611 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/curl/#transition-create-an-order-post)
         
     | 
| 
       612 
612 
     | 
    
         | 
| 
       613 
613 
     | 
    
         
             
            ```ruby
         
     | 
| 
       614 
614 
     | 
    
         
             
            @client.create_order(team_id, params)  # Input:
         
     | 
| 
         @@ -631,11 +631,11 @@ language.destroy 
     | 
|
| 
       631 
631 
     | 
    
         | 
| 
       632 
632 
     | 
    
         
             
            ### Payment cards
         
     | 
| 
       633 
633 
     | 
    
         | 
| 
       634 
     | 
    
         
            -
            [Payment card attributes](https://lokalise. 
     | 
| 
      
 634 
     | 
    
         
            +
            [Payment card attributes](https://lokalise.com/api2docs/ruby/#object-payment-cards)
         
     | 
| 
       635 
635 
     | 
    
         | 
| 
       636 
636 
     | 
    
         
             
            #### Fetch payment card collection
         
     | 
| 
       637 
637 
     | 
    
         | 
| 
       638 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 638 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-cards-get)
         
     | 
| 
       639 
639 
     | 
    
         | 
| 
       640 
640 
     | 
    
         
             
            ```ruby
         
     | 
| 
       641 
641 
     | 
    
         
             
            @client.payment_cards(params = {})    # Input:
         
     | 
| 
         @@ -647,7 +647,7 @@ language.destroy 
     | 
|
| 
       647 
647 
     | 
    
         | 
| 
       648 
648 
     | 
    
         
             
            #### Fetch a single payment card
         
     | 
| 
       649 
649 
     | 
    
         | 
| 
       650 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 650 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-card-get)
         
     | 
| 
       651 
651 
     | 
    
         | 
| 
       652 
652 
     | 
    
         
             
            ```ruby
         
     | 
| 
       653 
653 
     | 
    
         
             
            @client.payment_card(card_id)     # Input:
         
     | 
| 
         @@ -658,7 +658,7 @@ language.destroy 
     | 
|
| 
       658 
658 
     | 
    
         | 
| 
       659 
659 
     | 
    
         
             
            #### Create a payment card
         
     | 
| 
       660 
660 
     | 
    
         | 
| 
       661 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 661 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-a-card-post)
         
     | 
| 
       662 
662 
     | 
    
         | 
| 
       663 
663 
     | 
    
         
             
            ```ruby
         
     | 
| 
       664 
664 
     | 
    
         
             
            @client.create_payment_card(params)   # Input:
         
     | 
| 
         @@ -674,7 +674,7 @@ language.destroy 
     | 
|
| 
       674 
674 
     | 
    
         | 
| 
       675 
675 
     | 
    
         
             
            #### Delete a payment card
         
     | 
| 
       676 
676 
     | 
    
         | 
| 
       677 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 677 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-card-delete)
         
     | 
| 
       678 
678 
     | 
    
         | 
| 
       679 
679 
     | 
    
         
             
            ```ruby
         
     | 
| 
       680 
680 
     | 
    
         
             
            @client.destroy_payment_card(card_id)   # Input:
         
     | 
| 
         @@ -692,11 +692,11 @@ card.destroy 
     | 
|
| 
       692 
692 
     | 
    
         | 
| 
       693 
693 
     | 
    
         
             
            ### Projects
         
     | 
| 
       694 
694 
     | 
    
         | 
| 
       695 
     | 
    
         
            -
            [Project attributes](https://lokalise. 
     | 
| 
      
 695 
     | 
    
         
            +
            [Project attributes](https://lokalise.com/api2docs/php/#object-projects)
         
     | 
| 
       696 
696 
     | 
    
         | 
| 
       697 
697 
     | 
    
         
             
            #### Fetch projects collection
         
     | 
| 
       698 
698 
     | 
    
         | 
| 
       699 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 699 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/php/#transition-list-all-projects-get)
         
     | 
| 
       700 
700 
     | 
    
         | 
| 
       701 
701 
     | 
    
         
             
            ```ruby
         
     | 
| 
       702 
702 
     | 
    
         
             
            @client.projects(params = {})   # Input:
         
     | 
| 
         @@ -709,7 +709,7 @@ card.destroy 
     | 
|
| 
       709 
709 
     | 
    
         | 
| 
       710 
710 
     | 
    
         
             
            #### Fetch a single project
         
     | 
| 
       711 
711 
     | 
    
         | 
| 
       712 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 712 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/php/#transition-retrieve-a-project-get)
         
     | 
| 
       713 
713 
     | 
    
         | 
| 
       714 
714 
     | 
    
         
             
            ```ruby
         
     | 
| 
       715 
715 
     | 
    
         
             
            @client.project(project_id)     # Input:
         
     | 
| 
         @@ -720,7 +720,7 @@ card.destroy 
     | 
|
| 
       720 
720 
     | 
    
         | 
| 
       721 
721 
     | 
    
         
             
            #### Create a project
         
     | 
| 
       722 
722 
     | 
    
         | 
| 
       723 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 723 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/php/#transition-create-a-project-post)
         
     | 
| 
       724 
724 
     | 
    
         | 
| 
       725 
725 
     | 
    
         
             
            ```ruby
         
     | 
| 
       726 
726 
     | 
    
         
             
            @client.create_project(params)  # Input:
         
     | 
| 
         @@ -735,7 +735,7 @@ card.destroy 
     | 
|
| 
       735 
735 
     | 
    
         | 
| 
       736 
736 
     | 
    
         
             
            #### Update a project
         
     | 
| 
       737 
737 
     | 
    
         | 
| 
       738 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 738 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/php/#transition-update-a-project-put)
         
     | 
| 
       739 
739 
     | 
    
         | 
| 
       740 
740 
     | 
    
         
             
            ```ruby
         
     | 
| 
       741 
741 
     | 
    
         
             
            @client.update_project(project_id, params)  # Input:
         
     | 
| 
         @@ -756,7 +756,7 @@ project.update(params) 
     | 
|
| 
       756 
756 
     | 
    
         | 
| 
       757 
757 
     | 
    
         
             
            #### Empty a project
         
     | 
| 
       758 
758 
     | 
    
         | 
| 
       759 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 759 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/php/#transition-empty-a-project-put)
         
     | 
| 
       760 
760 
     | 
    
         | 
| 
       761 
761 
     | 
    
         
             
            Deletes *all* keys and translations from the project.
         
     | 
| 
       762 
762 
     | 
    
         | 
| 
         @@ -776,7 +776,7 @@ project.empty 
     | 
|
| 
       776 
776 
     | 
    
         | 
| 
       777 
777 
     | 
    
         
             
            #### Delete a project
         
     | 
| 
       778 
778 
     | 
    
         | 
| 
       779 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 779 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/php/#transition-delete-a-project-delete)
         
     | 
| 
       780 
780 
     | 
    
         | 
| 
       781 
781 
     | 
    
         
             
            ```ruby
         
     | 
| 
       782 
782 
     | 
    
         
             
            @client.destroy_project(project_id)   # Input:
         
     | 
| 
         @@ -794,11 +794,11 @@ project.destroy 
     | 
|
| 
       794 
794 
     | 
    
         | 
| 
       795 
795 
     | 
    
         
             
            ### Screenshots
         
     | 
| 
       796 
796 
     | 
    
         | 
| 
       797 
     | 
    
         
            -
            [Screenshot attributes](https://lokalise. 
     | 
| 
      
 797 
     | 
    
         
            +
            [Screenshot attributes](https://lokalise.com/api2docs/ruby/#resource-screenshots)
         
     | 
| 
       798 
798 
     | 
    
         | 
| 
       799 
799 
     | 
    
         
             
            #### Fetch screenshots
         
     | 
| 
       800 
800 
     | 
    
         | 
| 
       801 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 801 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-screenshots-get)
         
     | 
| 
       802 
802 
     | 
    
         | 
| 
       803 
803 
     | 
    
         
             
            ```ruby
         
     | 
| 
       804 
804 
     | 
    
         
             
            @client.screenshots(project_id, params = {})  # Input:
         
     | 
| 
         @@ -811,7 +811,7 @@ project.destroy 
     | 
|
| 
       811 
811 
     | 
    
         | 
| 
       812 
812 
     | 
    
         
             
            #### Fetch a single screenshot
         
     | 
| 
       813 
813 
     | 
    
         | 
| 
       814 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 814 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-screenshot-get)
         
     | 
| 
       815 
815 
     | 
    
         | 
| 
       816 
816 
     | 
    
         
             
            ```ruby
         
     | 
| 
       817 
817 
     | 
    
         
             
            @client.screeshot(project_id, screeshot_id)     # Input:
         
     | 
| 
         @@ -823,7 +823,7 @@ project.destroy 
     | 
|
| 
       823 
823 
     | 
    
         | 
| 
       824 
824 
     | 
    
         
             
            #### Create screenshots
         
     | 
| 
       825 
825 
     | 
    
         | 
| 
       826 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 826 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-screenshots-post)
         
     | 
| 
       827 
827 
     | 
    
         | 
| 
       828 
828 
     | 
    
         
             
            ```ruby
         
     | 
| 
       829 
829 
     | 
    
         
             
            @client.create_screenshots(project_id, params)     # Input:
         
     | 
| 
         @@ -841,7 +841,7 @@ project.destroy 
     | 
|
| 
       841 
841 
     | 
    
         | 
| 
       842 
842 
     | 
    
         
             
            #### Update screenshot
         
     | 
| 
       843 
843 
     | 
    
         | 
| 
       844 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 844 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-screenshot-put)
         
     | 
| 
       845 
845 
     | 
    
         | 
| 
       846 
846 
     | 
    
         
             
            ```ruby
         
     | 
| 
       847 
847 
     | 
    
         
             
            @client.update_screenshot(project_id, screenshot_id, params = {}) # Input:
         
     | 
| 
         @@ -865,7 +865,7 @@ screenshot.update(params) 
     | 
|
| 
       865 
865 
     | 
    
         | 
| 
       866 
866 
     | 
    
         
             
            #### Delete screenshot
         
     | 
| 
       867 
867 
     | 
    
         | 
| 
       868 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 868 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-screenshot-delete)
         
     | 
| 
       869 
869 
     | 
    
         | 
| 
       870 
870 
     | 
    
         
             
            ```ruby
         
     | 
| 
       871 
871 
     | 
    
         
             
            @client.destroy_screenshot(project_id, screenshot_id)   # Input:
         
     | 
| 
         @@ -884,11 +884,11 @@ screenshot.destroy 
     | 
|
| 
       884 
884 
     | 
    
         | 
| 
       885 
885 
     | 
    
         
             
            ### Snapshots
         
     | 
| 
       886 
886 
     | 
    
         | 
| 
       887 
     | 
    
         
            -
            [Snapshot attributes](https://lokalise. 
     | 
| 
      
 887 
     | 
    
         
            +
            [Snapshot attributes](https://lokalise.com/api2docs/ruby/#object-snapshots)
         
     | 
| 
       888 
888 
     | 
    
         | 
| 
       889 
889 
     | 
    
         
             
            #### Fetch snapshots
         
     | 
| 
       890 
890 
     | 
    
         | 
| 
       891 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 891 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-snapshots-get)
         
     | 
| 
       892 
892 
     | 
    
         | 
| 
       893 
893 
     | 
    
         
             
            ```ruby
         
     | 
| 
       894 
894 
     | 
    
         
             
            @client.snapshots(project_id, params = {})  # Input:
         
     | 
| 
         @@ -902,7 +902,7 @@ screenshot.destroy 
     | 
|
| 
       902 
902 
     | 
    
         | 
| 
       903 
903 
     | 
    
         
             
            #### Create snapshot
         
     | 
| 
       904 
904 
     | 
    
         | 
| 
       905 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 905 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-a-snapshot-post)
         
     | 
| 
       906 
906 
     | 
    
         | 
| 
       907 
907 
     | 
    
         
             
            ```ruby
         
     | 
| 
       908 
908 
     | 
    
         
             
            @client.create_snapshot(project_id, params = {})  # Input:
         
     | 
| 
         @@ -915,7 +915,7 @@ screenshot.destroy 
     | 
|
| 
       915 
915 
     | 
    
         | 
| 
       916 
916 
     | 
    
         
             
            #### Restore snapshot
         
     | 
| 
       917 
917 
     | 
    
         | 
| 
       918 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 918 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-restore-a-snapshot-post)
         
     | 
| 
       919 
919 
     | 
    
         | 
| 
       920 
920 
     | 
    
         
             
            ```ruby
         
     | 
| 
       921 
921 
     | 
    
         
             
            @client.restore_snapshot(project_id, snapshot_id)   # Input:
         
     | 
| 
         @@ -934,7 +934,7 @@ snapshot.restore 
     | 
|
| 
       934 
934 
     | 
    
         | 
| 
       935 
935 
     | 
    
         
             
            #### Delete snapshot
         
     | 
| 
       936 
936 
     | 
    
         | 
| 
       937 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 937 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-snapshot-delete)
         
     | 
| 
       938 
938 
     | 
    
         | 
| 
       939 
939 
     | 
    
         
             
            ```ruby
         
     | 
| 
       940 
940 
     | 
    
         
             
            @client.destroy_snapshot(project_id, snapshot_id)   # Input:
         
     | 
| 
         @@ -953,11 +953,11 @@ snapshot.destroy 
     | 
|
| 
       953 
953 
     | 
    
         | 
| 
       954 
954 
     | 
    
         
             
            ### Tasks
         
     | 
| 
       955 
955 
     | 
    
         | 
| 
       956 
     | 
    
         
            -
            [Task attributes](https://lokalise. 
     | 
| 
      
 956 
     | 
    
         
            +
            [Task attributes](https://lokalise.com/api2docs/ruby/#resource-tasks)
         
     | 
| 
       957 
957 
     | 
    
         | 
| 
       958 
958 
     | 
    
         
             
            #### Fetch tasks
         
     | 
| 
       959 
959 
     | 
    
         | 
| 
       960 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 960 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-tasks-get)
         
     | 
| 
       961 
961 
     | 
    
         | 
| 
       962 
962 
     | 
    
         
             
            ```ruby
         
     | 
| 
       963 
963 
     | 
    
         
             
            @client.tasks(project_id, params = {})  # Input:
         
     | 
| 
         @@ -971,7 +971,7 @@ snapshot.destroy 
     | 
|
| 
       971 
971 
     | 
    
         | 
| 
       972 
972 
     | 
    
         
             
            #### Fetch a single task
         
     | 
| 
       973 
973 
     | 
    
         | 
| 
       974 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 974 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-task-get)
         
     | 
| 
       975 
975 
     | 
    
         | 
| 
       976 
976 
     | 
    
         
             
            ```ruby
         
     | 
| 
       977 
977 
     | 
    
         
             
            @client.task(project_id, task_id, params = {})  # Input:
         
     | 
| 
         @@ -983,7 +983,7 @@ snapshot.destroy 
     | 
|
| 
       983 
983 
     | 
    
         | 
| 
       984 
984 
     | 
    
         
             
            #### Create task
         
     | 
| 
       985 
985 
     | 
    
         | 
| 
       986 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 986 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-a-task-post)
         
     | 
| 
       987 
987 
     | 
    
         | 
| 
       988 
988 
     | 
    
         
             
            ```ruby
         
     | 
| 
       989 
989 
     | 
    
         
             
            @client.create_task(project_id, params)  # Input:
         
     | 
| 
         @@ -994,7 +994,7 @@ snapshot.destroy 
     | 
|
| 
       994 
994 
     | 
    
         
             
                                                     ### languages (array of hashes, required)
         
     | 
| 
       995 
995 
     | 
    
         
             
                                                     #### language_iso (string)
         
     | 
| 
       996 
996 
     | 
    
         
             
                                                     #### users (array) - list of users identifiers, assigned to work on the language 
         
     | 
| 
       997 
     | 
    
         
            -
                                                     ### Find other supported options at https://lokalise. 
     | 
| 
      
 997 
     | 
    
         
            +
                                                     ### Find other supported options at https://lokalise.com/api2docs/ruby/#transition-create-a-task-post 
         
     | 
| 
       998 
998 
     | 
    
         
             
                                                     # Output:
         
     | 
| 
       999 
999 
     | 
    
         
             
                                                     ## A newly created task 
         
     | 
| 
       1000 
1000 
     | 
    
         | 
| 
         @@ -1002,14 +1002,14 @@ snapshot.destroy 
     | 
|
| 
       1002 
1002 
     | 
    
         | 
| 
       1003 
1003 
     | 
    
         
             
            #### Update task
         
     | 
| 
       1004 
1004 
     | 
    
         | 
| 
       1005 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1005 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-task-put)
         
     | 
| 
       1006 
1006 
     | 
    
         | 
| 
       1007 
1007 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1008 
1008 
     | 
    
         
             
            @client.update_task(project_id, task_id, params = {})  # Input:
         
     | 
| 
       1009 
1009 
     | 
    
         
             
                                                                   ## project_id (string, required)
         
     | 
| 
       1010 
1010 
     | 
    
         
             
                                                                   ## task_id (string or integer, required) 
         
     | 
| 
       1011 
1011 
     | 
    
         
             
                                                                   ## params (hash)
         
     | 
| 
       1012 
     | 
    
         
            -
                                                                   ### Find supported params at https://lokalise. 
     | 
| 
      
 1012 
     | 
    
         
            +
                                                                   ### Find supported params at https://lokalise.com/api2docs/ruby/#transition-update-a-task-put 
         
     | 
| 
       1013 
1013 
     | 
    
         
             
                                                                   # Output:
         
     | 
| 
       1014 
1014 
     | 
    
         
             
                                                                   ## An updated task 
         
     | 
| 
       1015 
1015 
     | 
    
         | 
| 
         @@ -1024,7 +1024,7 @@ task.update(params) 
     | 
|
| 
       1024 
1024 
     | 
    
         | 
| 
       1025 
1025 
     | 
    
         
             
            #### Delete task
         
     | 
| 
       1026 
1026 
     | 
    
         | 
| 
       1027 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1027 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-task-delete)
         
     | 
| 
       1028 
1028 
     | 
    
         | 
| 
       1029 
1029 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1030 
1030 
     | 
    
         
             
            @client.destroy_task(project_id, task_id)  # Input:
         
     | 
| 
         @@ -1046,7 +1046,7 @@ task.destroy 
     | 
|
| 
       1046 
1046 
     | 
    
         | 
| 
       1047 
1047 
     | 
    
         
             
            #### Fetch teams
         
     | 
| 
       1048 
1048 
     | 
    
         | 
| 
       1049 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1049 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#resource-teams)
         
     | 
| 
       1050 
1050 
     | 
    
         | 
| 
       1051 
1051 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1052 
1052 
     | 
    
         
             
            @client.teams(params = {})  # Input:
         
     | 
| 
         @@ -1058,11 +1058,11 @@ task.destroy 
     | 
|
| 
       1058 
1058 
     | 
    
         | 
| 
       1059 
1059 
     | 
    
         
             
            ### Team users
         
     | 
| 
       1060 
1060 
     | 
    
         | 
| 
       1061 
     | 
    
         
            -
            [Team user attributes](https://lokalise. 
     | 
| 
      
 1061 
     | 
    
         
            +
            [Team user attributes](https://lokalise.com/api2docs/ruby/#object-team-users)
         
     | 
| 
       1062 
1062 
     | 
    
         | 
| 
       1063 
1063 
     | 
    
         
             
            #### Fetch team users
         
     | 
| 
       1064 
1064 
     | 
    
         | 
| 
       1065 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1065 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-team-users-get)
         
     | 
| 
       1066 
1066 
     | 
    
         | 
| 
       1067 
1067 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1068 
1068 
     | 
    
         
             
            @client.team_users(team_id, params = {})  # Input:
         
     | 
| 
         @@ -1075,7 +1075,7 @@ task.destroy 
     | 
|
| 
       1075 
1075 
     | 
    
         | 
| 
       1076 
1076 
     | 
    
         
             
            #### Fetch a single team user
         
     | 
| 
       1077 
1077 
     | 
    
         | 
| 
       1078 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1078 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-team-user-get)
         
     | 
| 
       1079 
1079 
     | 
    
         | 
| 
       1080 
1080 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1081 
1081 
     | 
    
         
             
            @client.team_user(team_id, user_id) # Input:
         
     | 
| 
         @@ -1087,7 +1087,7 @@ task.destroy 
     | 
|
| 
       1087 
1087 
     | 
    
         | 
| 
       1088 
1088 
     | 
    
         
             
            #### Update team user
         
     | 
| 
       1089 
1089 
     | 
    
         | 
| 
       1090 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1090 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-team-user-put)
         
     | 
| 
       1091 
1091 
     | 
    
         | 
| 
       1092 
1092 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1093 
1093 
     | 
    
         
             
            @client.update_team_user(team_id, user_id, params)  # Input:
         
     | 
| 
         @@ -1108,7 +1108,7 @@ user.update(params) 
     | 
|
| 
       1108 
1108 
     | 
    
         | 
| 
       1109 
1109 
     | 
    
         
             
            #### Delete team user
         
     | 
| 
       1110 
1110 
     | 
    
         | 
| 
       1111 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1111 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-team-user-delete)
         
     | 
| 
       1112 
1112 
     | 
    
         | 
| 
       1113 
1113 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1114 
1114 
     | 
    
         
             
            @client.destroy_team_user(team_id, user_id) # Input:
         
     | 
| 
         @@ -1127,11 +1127,11 @@ user.destroy 
     | 
|
| 
       1127 
1127 
     | 
    
         | 
| 
       1128 
1128 
     | 
    
         
             
            ### Team user groups
         
     | 
| 
       1129 
1129 
     | 
    
         | 
| 
       1130 
     | 
    
         
            -
            [Team user group attributes](https://lokalise. 
     | 
| 
      
 1130 
     | 
    
         
            +
            [Team user group attributes](https://lokalise.com/api2docs/ruby/#object-team-user-groups)
         
     | 
| 
       1131 
1131 
     | 
    
         | 
| 
       1132 
1132 
     | 
    
         
             
            #### Fetch team user groups
         
     | 
| 
       1133 
1133 
     | 
    
         | 
| 
       1134 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1134 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-groups-get)
         
     | 
| 
       1135 
1135 
     | 
    
         | 
| 
       1136 
1136 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1137 
1137 
     | 
    
         
             
            @client.team_user_groups(team_id, params = {})  # Input:
         
     | 
| 
         @@ -1144,7 +1144,7 @@ user.destroy 
     | 
|
| 
       1144 
1144 
     | 
    
         | 
| 
       1145 
1145 
     | 
    
         
             
            #### Fetch a single group
         
     | 
| 
       1146 
1146 
     | 
    
         | 
| 
       1147 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1147 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-group-get)
         
     | 
| 
       1148 
1148 
     | 
    
         | 
| 
       1149 
1149 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1150 
1150 
     | 
    
         
             
            @client.team_user_group(team_id, group_id)  # Input:
         
     | 
| 
         @@ -1156,7 +1156,7 @@ user.destroy 
     | 
|
| 
       1156 
1156 
     | 
    
         | 
| 
       1157 
1157 
     | 
    
         
             
            #### Create group
         
     | 
| 
       1158 
1158 
     | 
    
         | 
| 
       1159 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1159 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-a-group-post)
         
     | 
| 
       1160 
1160 
     | 
    
         | 
| 
       1161 
1161 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1162 
1162 
     | 
    
         
             
            @client.create_team_user_group(team_id, params) # Input:
         
     | 
| 
         @@ -1173,7 +1173,7 @@ user.destroy 
     | 
|
| 
       1173 
1173 
     | 
    
         | 
| 
       1174 
1174 
     | 
    
         
             
            #### Update group
         
     | 
| 
       1175 
1175 
     | 
    
         | 
| 
       1176 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1176 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-group-put)
         
     | 
| 
       1177 
1177 
     | 
    
         | 
| 
       1178 
1178 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1179 
1179 
     | 
    
         
             
            @client.update_team_user_group(team_id, group_id, params) # Input:
         
     | 
| 
         @@ -1198,7 +1198,7 @@ group.update(params) 
     | 
|
| 
       1198 
1198 
     | 
    
         | 
| 
       1199 
1199 
     | 
    
         
             
            #### Add projects to group
         
     | 
| 
       1200 
1200 
     | 
    
         | 
| 
       1201 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1201 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-add-projects-to-group-put)
         
     | 
| 
       1202 
1202 
     | 
    
         | 
| 
       1203 
1203 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1204 
1204 
     | 
    
         
             
            @client.add_projects_to_group(team_id, group_id, project_ids) # Input:
         
     | 
| 
         @@ -1216,7 +1216,7 @@ group.add_projects projects: [project_id1, project_id2] 
     | 
|
| 
       1216 
1216 
     | 
    
         | 
| 
       1217 
1217 
     | 
    
         
             
            #### Remove projects from group
         
     | 
| 
       1218 
1218 
     | 
    
         | 
| 
       1219 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1219 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-remove-projects-from-group-put)
         
     | 
| 
       1220 
1220 
     | 
    
         | 
| 
       1221 
1221 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1222 
1222 
     | 
    
         
             
            @client.remove_projects_from_group(team_id, group_id, project_ids)  # Input:
         
     | 
| 
         @@ -1234,7 +1234,7 @@ group.remove_projects projects: [project_id1, project_id2] 
     | 
|
| 
       1234 
1234 
     | 
    
         | 
| 
       1235 
1235 
     | 
    
         
             
            #### Add users (members) to group
         
     | 
| 
       1236 
1236 
     | 
    
         | 
| 
       1237 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1237 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-add-members-to-group-put)
         
     | 
| 
       1238 
1238 
     | 
    
         | 
| 
       1239 
1239 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1240 
1240 
     | 
    
         
             
            @client.add_users_to_group(team_id, group_id, user_ids) # Input:
         
     | 
| 
         @@ -1252,7 +1252,7 @@ group.add_users users: [user_id1, user_id2] 
     | 
|
| 
       1252 
1252 
     | 
    
         | 
| 
       1253 
1253 
     | 
    
         
             
            #### Remove users (members) from group
         
     | 
| 
       1254 
1254 
     | 
    
         | 
| 
       1255 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1255 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-remove-members-from-group-put)
         
     | 
| 
       1256 
1256 
     | 
    
         | 
| 
       1257 
1257 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1258 
1258 
     | 
    
         
             
            @client.remove_users_from_group(team_id, group_id, user_ids)  # Input:
         
     | 
| 
         @@ -1270,7 +1270,7 @@ group.remove_users users: [user_id1, user_id2] 
     | 
|
| 
       1270 
1270 
     | 
    
         | 
| 
       1271 
1271 
     | 
    
         
             
            #### Destroy group
         
     | 
| 
       1272 
1272 
     | 
    
         | 
| 
       1273 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1273 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-group-delete)
         
     | 
| 
       1274 
1274 
     | 
    
         | 
| 
       1275 
1275 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1276 
1276 
     | 
    
         
             
            @client.destroy_team_user_group(team_id, group_id)  # Input:
         
     | 
| 
         @@ -1289,11 +1289,11 @@ group.destroy 
     | 
|
| 
       1289 
1289 
     | 
    
         | 
| 
       1290 
1290 
     | 
    
         
             
            ### Translations
         
     | 
| 
       1291 
1291 
     | 
    
         | 
| 
       1292 
     | 
    
         
            -
            [Translation attributes](https://lokalise. 
     | 
| 
      
 1292 
     | 
    
         
            +
            [Translation attributes](https://lokalise.com/api2docs/ruby/#resource-translations)
         
     | 
| 
       1293 
1293 
     | 
    
         | 
| 
       1294 
1294 
     | 
    
         
             
            #### Fetch translations
         
     | 
| 
       1295 
1295 
     | 
    
         | 
| 
       1296 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1296 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-translations-get)
         
     | 
| 
       1297 
1297 
     | 
    
         | 
| 
       1298 
1298 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1299 
1299 
     | 
    
         
             
            @client.translations(project_id, params = {})   # Input:
         
     | 
| 
         @@ -1307,7 +1307,7 @@ group.destroy 
     | 
|
| 
       1307 
1307 
     | 
    
         | 
| 
       1308 
1308 
     | 
    
         
             
            #### Fetch a single translation
         
     | 
| 
       1309 
1309 
     | 
    
         | 
| 
       1310 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1310 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-translation-get)
         
     | 
| 
       1311 
1311 
     | 
    
         | 
| 
       1312 
1312 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1313 
1313 
     | 
    
         
             
            @client.translation(project_id, translation_id, params = {})   # Input:
         
     | 
| 
         @@ -1321,7 +1321,7 @@ group.destroy 
     | 
|
| 
       1321 
1321 
     | 
    
         | 
| 
       1322 
1322 
     | 
    
         
             
            #### Update translation
         
     | 
| 
       1323 
1323 
     | 
    
         | 
| 
       1324 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1324 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-translation-put)
         
     | 
| 
       1325 
1325 
     | 
    
         | 
| 
       1326 
1326 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1327 
1327 
     | 
    
         
             
            @client.update_translation(project_id, translation_id, params = {})   # Input:
         
     | 
| 
         @@ -1344,11 +1344,11 @@ translation.update(params) 
     | 
|
| 
       1344 
1344 
     | 
    
         | 
| 
       1345 
1345 
     | 
    
         
             
            ### Translation Providers
         
     | 
| 
       1346 
1346 
     | 
    
         | 
| 
       1347 
     | 
    
         
            -
            [Translation provider attributes](https://lokalise. 
     | 
| 
      
 1347 
     | 
    
         
            +
            [Translation provider attributes](https://lokalise.com/api2docs/ruby/#object-translation-providers)
         
     | 
| 
       1348 
1348 
     | 
    
         | 
| 
       1349 
1349 
     | 
    
         
             
            #### Fetch translations
         
     | 
| 
       1350 
1350 
     | 
    
         | 
| 
       1351 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1351 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-providers-get)
         
     | 
| 
       1352 
1352 
     | 
    
         | 
| 
       1353 
1353 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1354 
1354 
     | 
    
         
             
            @client.translation_providers(team_id, params = {})   # Input:
         
     | 
| 
         @@ -1361,7 +1361,7 @@ translation.update(params) 
     | 
|
| 
       1361 
1361 
     | 
    
         | 
| 
       1362 
1362 
     | 
    
         
             
            #### Fetch a single translation
         
     | 
| 
       1363 
1363 
     | 
    
         | 
| 
       1364 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1364 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-provider-get)
         
     | 
| 
       1365 
1365 
     | 
    
         | 
| 
       1366 
1366 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1367 
1367 
     | 
    
         
             
            @client.translation_provider(team_id, provider_id)  # Input:
         
     | 
| 
         @@ -1373,13 +1373,13 @@ translation.update(params) 
     | 
|
| 
       1373 
1373 
     | 
    
         | 
| 
       1374 
1374 
     | 
    
         
             
            ### Translation Statuses
         
     | 
| 
       1375 
1375 
     | 
    
         | 
| 
       1376 
     | 
    
         
            -
            [Translation Status attributes](https://lokalise. 
     | 
| 
      
 1376 
     | 
    
         
            +
            [Translation Status attributes](https://lokalise.com/api2docs/ruby/#object-translation-statuses)
         
     | 
| 
       1377 
1377 
     | 
    
         | 
| 
       1378 
1378 
     | 
    
         
             
            *Custom translation statuses must be enabled for the project before using this endpoint!* It can be done in the project settings.
         
     | 
| 
       1379 
1379 
     | 
    
         | 
| 
       1380 
1380 
     | 
    
         
             
            #### Fetch translation statuses
         
     | 
| 
       1381 
1381 
     | 
    
         | 
| 
       1382 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1382 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-custom-translation-statuses-get)
         
     | 
| 
       1383 
1383 
     | 
    
         | 
| 
       1384 
1384 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1385 
1385 
     | 
    
         
             
            @client.translation_statuses(project_id, params = {}) # Input:
         
     | 
| 
         @@ -1392,7 +1392,7 @@ translation.update(params) 
     | 
|
| 
       1392 
1392 
     | 
    
         | 
| 
       1393 
1393 
     | 
    
         
             
            #### Fetch a single translation status
         
     | 
| 
       1394 
1394 
     | 
    
         | 
| 
       1395 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1395 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-custom-translation-status-get)
         
     | 
| 
       1396 
1396 
     | 
    
         | 
| 
       1397 
1397 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1398 
1398 
     | 
    
         
             
            @client.translation_status(project_id, status_id) # Input:
         
     | 
| 
         @@ -1404,7 +1404,7 @@ translation.update(params) 
     | 
|
| 
       1404 
1404 
     | 
    
         | 
| 
       1405 
1405 
     | 
    
         
             
            #### Create translation status
         
     | 
| 
       1406 
1406 
     | 
    
         | 
| 
       1407 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1407 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-a-custom-translation-status-post)
         
     | 
| 
       1408 
1408 
     | 
    
         | 
| 
       1409 
1409 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1410 
1410 
     | 
    
         
             
            @client.create_translation_status(project_id, params) # Input:
         
     | 
| 
         @@ -1418,7 +1418,7 @@ translation.update(params) 
     | 
|
| 
       1418 
1418 
     | 
    
         | 
| 
       1419 
1419 
     | 
    
         
             
            #### Update translation status
         
     | 
| 
       1420 
1420 
     | 
    
         | 
| 
       1421 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1421 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-custom-translation-status-put)
         
     | 
| 
       1422 
1422 
     | 
    
         | 
| 
       1423 
1423 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1424 
1424 
     | 
    
         
             
            @client.update_translation_status(project_id, status_id, params)  # Input:
         
     | 
| 
         @@ -1440,7 +1440,7 @@ status.update(params) 
     | 
|
| 
       1440 
1440 
     | 
    
         | 
| 
       1441 
1441 
     | 
    
         
             
            #### Delete translation status
         
     | 
| 
       1442 
1442 
     | 
    
         | 
| 
       1443 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1443 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-custom-translation-status-delete)
         
     | 
| 
       1444 
1444 
     | 
    
         | 
| 
       1445 
1445 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1446 
1446 
     | 
    
         
             
            @client.destroy_translation_status(project_id, status_id) # Input:
         
     | 
| 
         @@ -1459,7 +1459,7 @@ status.destroy 
     | 
|
| 
       1459 
1459 
     | 
    
         | 
| 
       1460 
1460 
     | 
    
         
             
            #### Supported color codes for translation statuses
         
     | 
| 
       1461 
1461 
     | 
    
         | 
| 
       1462 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1462 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-available-colors-for-custom-translation-statuses-get)
         
     | 
| 
       1463 
1463 
     | 
    
         | 
| 
       1464 
1464 
     | 
    
         
             
            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.
         
     | 
| 
       1465 
1465 
     | 
    
         | 
| 
         @@ -1472,11 +1472,11 @@ As long as Lokalise supports only very limited array of color hexadecimal codes 
     | 
|
| 
       1472 
1472 
     | 
    
         | 
| 
       1473 
1473 
     | 
    
         
             
            ### Webhooks
         
     | 
| 
       1474 
1474 
     | 
    
         | 
| 
       1475 
     | 
    
         
            -
            [Webhook attributes](https://lokalise. 
     | 
| 
      
 1475 
     | 
    
         
            +
            [Webhook attributes](https://lokalise.com/api2docs/ruby/#object-webhooks)
         
     | 
| 
       1476 
1476 
     | 
    
         | 
| 
       1477 
1477 
     | 
    
         
             
            #### Fetch webhooks
         
     | 
| 
       1478 
1478 
     | 
    
         | 
| 
       1479 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1479 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-list-all-webhooks-get)
         
     | 
| 
       1480 
1480 
     | 
    
         | 
| 
       1481 
1481 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1482 
1482 
     | 
    
         
             
            @client.webhooks(project_id, params = {}) # Input:
         
     | 
| 
         @@ -1489,7 +1489,7 @@ As long as Lokalise supports only very limited array of color hexadecimal codes 
     | 
|
| 
       1489 
1489 
     | 
    
         | 
| 
       1490 
1490 
     | 
    
         
             
            #### Fetch a single webhook
         
     | 
| 
       1491 
1491 
     | 
    
         | 
| 
       1492 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1492 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-retrieve-a-webhook-get)
         
     | 
| 
       1493 
1493 
     | 
    
         | 
| 
       1494 
1494 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1495 
1495 
     | 
    
         
             
            @client.webhook(project_id, webhook_id)   # Input:
         
     | 
| 
         @@ -1501,7 +1501,7 @@ As long as Lokalise supports only very limited array of color hexadecimal codes 
     | 
|
| 
       1501 
1501 
     | 
    
         | 
| 
       1502 
1502 
     | 
    
         
             
            #### Create webhook
         
     | 
| 
       1503 
1503 
     | 
    
         | 
| 
       1504 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1504 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-create-a-webhook-post)
         
     | 
| 
       1505 
1505 
     | 
    
         | 
| 
       1506 
1506 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1507 
1507 
     | 
    
         
             
            @client.create_webhook(project_id, params)    # Input:
         
     | 
| 
         @@ -1516,7 +1516,7 @@ As long as Lokalise supports only very limited array of color hexadecimal codes 
     | 
|
| 
       1516 
1516 
     | 
    
         | 
| 
       1517 
1517 
     | 
    
         
             
            #### Update webhook
         
     | 
| 
       1518 
1518 
     | 
    
         | 
| 
       1519 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1519 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-update-a-webhook-put)
         
     | 
| 
       1520 
1520 
     | 
    
         | 
| 
       1521 
1521 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1522 
1522 
     | 
    
         
             
            @client.update_webhook(project_id, webhook_id, params)    # Input:
         
     | 
| 
         @@ -1539,7 +1539,7 @@ webhook.update(params) 
     | 
|
| 
       1539 
1539 
     | 
    
         | 
| 
       1540 
1540 
     | 
    
         
             
            #### Delete webhook
         
     | 
| 
       1541 
1541 
     | 
    
         | 
| 
       1542 
     | 
    
         
            -
            [Doc](https://lokalise. 
     | 
| 
      
 1542 
     | 
    
         
            +
            [Doc](https://lokalise.com/api2docs/ruby/#transition-delete-a-webhook-delete)
         
     | 
| 
       1543 
1543 
     | 
    
         | 
| 
       1544 
1544 
     | 
    
         
             
            ```ruby
         
     | 
| 
       1545 
1545 
     | 
    
         
             
            @client.destroy_webhook(project_id, webhook_id)   # Input:
         
     | 
| 
         @@ -1619,7 +1619,7 @@ end 
     | 
|
| 
       1619 
1619 
     | 
    
         | 
| 
       1620 
1620 
     | 
    
         
             
            ### Error handling
         
     | 
| 
       1621 
1621 
     | 
    
         | 
| 
       1622 
     | 
    
         
            -
            [Error codes](https://lokalise. 
     | 
| 
      
 1622 
     | 
    
         
            +
            [Error codes](https://lokalise.com/api2docs/curl/#resource-errors)
         
     | 
| 
       1623 
1623 
     | 
    
         | 
| 
       1624 
1624 
     | 
    
         
             
            The gem may raise the following custom exceptions:
         
     | 
| 
       1625 
1625 
     | 
    
         | 
| 
         @@ -1639,7 +1639,7 @@ The gem may raise the following custom exceptions: 
     | 
|
| 
       1639 
1639 
     | 
    
         | 
| 
       1640 
1640 
     | 
    
         
             
            ### API Rate Limits
         
     | 
| 
       1641 
1641 
     | 
    
         | 
| 
       1642 
     | 
    
         
            -
            Lokalise does not [rate-limit API requests](https://lokalise. 
     | 
| 
      
 1642 
     | 
    
         
            +
            Lokalise does not [rate-limit API requests](https://lokalise.com/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.
         
     | 
| 
       1643 
1643 
     | 
    
         | 
| 
       1644 
1644 
     | 
    
         
             
            ## Running Tests
         
     | 
| 
       1645 
1645 
     | 
    
         | 
    
        data/ruby-lokalise-api.gemspec
    CHANGED
    
    | 
         @@ -25,7 +25,7 @@ Gem::Specification.new do |spec| 
     | 
|
| 
       25 
25 
     | 
    
         | 
| 
       26 
26 
     | 
    
         
             
              spec.add_development_dependency 'dotenv',                    '~> 2.5'
         
     | 
| 
       27 
27 
     | 
    
         
             
              spec.add_development_dependency 'oj',                        '~> 3.8'
         
     | 
| 
       28 
     | 
    
         
            -
              spec.add_development_dependency 'rake',                      '~>  
     | 
| 
      
 28 
     | 
    
         
            +
              spec.add_development_dependency 'rake',                      '~> 13.0'
         
     | 
| 
       29 
29 
     | 
    
         
             
              spec.add_development_dependency 'rspec',                     '~> 3.6'
         
     | 
| 
       30 
30 
     | 
    
         
             
              spec.add_development_dependency 'rubocop',                   '~> 0.60'
         
     | 
| 
       31 
31 
     | 
    
         
             
              spec.add_development_dependency 'rubocop-performance',       '~> 1.0'
         
     | 
| 
         @@ -31,11 +31,12 @@ RSpec.describe Lokalise::Connection do 
     | 
|
| 
       31 
31 
     | 
    
         | 
| 
       32 
32 
     | 
    
         
             
              it 'should be possible to customize adapter' do
         
     | 
| 
       33 
33 
     | 
    
         
             
                conn = connection test_client
         
     | 
| 
       34 
     | 
    
         
            -
                expect(conn.builder. 
     | 
| 
      
 34 
     | 
    
         
            +
                expect(conn.builder.adapter).to eq(Faraday::Adapter::NetHttp)
         
     | 
| 
       35 
35 
     | 
    
         | 
| 
       36 
36 
     | 
    
         
             
                Faraday.default_adapter = :excon
         
     | 
| 
       37 
37 
     | 
    
         | 
| 
       38 
38 
     | 
    
         
             
                another_conn = connection test_client
         
     | 
| 
       39 
     | 
    
         
            -
                expect(another_conn.builder. 
     | 
| 
      
 39 
     | 
    
         
            +
                expect(another_conn.builder.adapter).to eq(Faraday::Adapter::Excon)
         
     | 
| 
      
 40 
     | 
    
         
            +
                expect(conn.builder.adapter).to eq(Faraday::Adapter::NetHttp)
         
     | 
| 
       40 
41 
     | 
    
         
             
              end
         
     | 
| 
       41 
42 
     | 
    
         
             
            end
         
     | 
    
        metadata
    CHANGED
    
    | 
         @@ -1,14 +1,14 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            --- !ruby/object:Gem::Specification
         
     | 
| 
       2 
2 
     | 
    
         
             
            name: ruby-lokalise-api
         
     | 
| 
       3 
3 
     | 
    
         
             
            version: !ruby/object:Gem::Version
         
     | 
| 
       4 
     | 
    
         
            -
              version: 2.6. 
     | 
| 
      
 4 
     | 
    
         
            +
              version: 2.6.1
         
     | 
| 
       5 
5 
     | 
    
         
             
            platform: ruby
         
     | 
| 
       6 
6 
     | 
    
         
             
            authors:
         
     | 
| 
       7 
7 
     | 
    
         
             
            - Ilya Bodrov
         
     | 
| 
       8 
8 
     | 
    
         
             
            autorequire: 
         
     | 
| 
       9 
9 
     | 
    
         
             
            bindir: bin
         
     | 
| 
       10 
10 
     | 
    
         
             
            cert_chain: []
         
     | 
| 
       11 
     | 
    
         
            -
            date: 2019- 
     | 
| 
      
 11 
     | 
    
         
            +
            date: 2019-09-27 00:00:00.000000000 Z
         
     | 
| 
       12 
12 
     | 
    
         
             
            dependencies:
         
     | 
| 
       13 
13 
     | 
    
         
             
            - !ruby/object:Gem::Dependency
         
     | 
| 
       14 
14 
     | 
    
         
             
              name: addressable
         
     | 
| 
         @@ -72,14 +72,14 @@ dependencies: 
     | 
|
| 
       72 
72 
     | 
    
         
             
                requirements:
         
     | 
| 
       73 
73 
     | 
    
         
             
                - - "~>"
         
     | 
| 
       74 
74 
     | 
    
         
             
                  - !ruby/object:Gem::Version
         
     | 
| 
       75 
     | 
    
         
            -
                    version: ' 
     | 
| 
      
 75 
     | 
    
         
            +
                    version: '13.0'
         
     | 
| 
       76 
76 
     | 
    
         
             
              type: :development
         
     | 
| 
       77 
77 
     | 
    
         
             
              prerelease: false
         
     | 
| 
       78 
78 
     | 
    
         
             
              version_requirements: !ruby/object:Gem::Requirement
         
     | 
| 
       79 
79 
     | 
    
         
             
                requirements:
         
     | 
| 
       80 
80 
     | 
    
         
             
                - - "~>"
         
     | 
| 
       81 
81 
     | 
    
         
             
                  - !ruby/object:Gem::Version
         
     | 
| 
       82 
     | 
    
         
            -
                    version: ' 
     | 
| 
      
 82 
     | 
    
         
            +
                    version: '13.0'
         
     | 
| 
       83 
83 
     | 
    
         
             
            - !ruby/object:Gem::Dependency
         
     | 
| 
       84 
84 
     | 
    
         
             
              name: rspec
         
     | 
| 
       85 
85 
     | 
    
         
             
              requirement: !ruby/object:Gem::Requirement
         
     | 
| 
         @@ -284,7 +284,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement 
     | 
|
| 
       284 
284 
     | 
    
         
             
                - !ruby/object:Gem::Version
         
     | 
| 
       285 
285 
     | 
    
         
             
                  version: '0'
         
     | 
| 
       286 
286 
     | 
    
         
             
            requirements: []
         
     | 
| 
       287 
     | 
    
         
            -
            rubygems_version: 3.0. 
     | 
| 
      
 287 
     | 
    
         
            +
            rubygems_version: 3.0.6
         
     | 
| 
       288 
288 
     | 
    
         
             
            signing_key: 
         
     | 
| 
       289 
289 
     | 
    
         
             
            specification_version: 4
         
     | 
| 
       290 
290 
     | 
    
         
             
            summary: Ruby interface to the Lokalise API
         
     |