ruby-lokalise-api 2.10.0 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/CODE_OF_CONDUCT.md +1 -1
- data/.github/CONTRIBUTING.md +2 -2
- data/CHANGELOG.md +23 -0
- data/README.md +275 -180
- data/lib/ruby-lokalise-api.rb +2 -0
- data/lib/ruby-lokalise-api/client.rb +1 -0
- data/lib/ruby-lokalise-api/collections/base.rb +3 -2
- data/lib/ruby-lokalise-api/collections/queued_process.rb +15 -0
- data/lib/ruby-lokalise-api/data/attributes.json +12 -1
- data/lib/ruby-lokalise-api/resources/base.rb +33 -17
- data/lib/ruby-lokalise-api/resources/branch.rb +1 -1
- data/lib/ruby-lokalise-api/resources/contributor.rb +1 -1
- data/lib/ruby-lokalise-api/resources/custom_translation_status.rb +1 -1
- data/lib/ruby-lokalise-api/resources/file.rb +4 -1
- data/lib/ruby-lokalise-api/resources/key.rb +1 -1
- data/lib/ruby-lokalise-api/resources/key_comment.rb +1 -1
- data/lib/ruby-lokalise-api/resources/order.rb +2 -0
- data/lib/ruby-lokalise-api/resources/payment_card.rb +1 -1
- data/lib/ruby-lokalise-api/resources/project.rb +1 -1
- data/lib/ruby-lokalise-api/resources/queued_process.rb +18 -0
- data/lib/ruby-lokalise-api/resources/screenshot.rb +1 -1
- data/lib/ruby-lokalise-api/resources/snapshot.rb +3 -1
- data/lib/ruby-lokalise-api/resources/task.rb +1 -1
- data/lib/ruby-lokalise-api/resources/team_user.rb +1 -1
- data/lib/ruby-lokalise-api/resources/translation.rb +1 -1
- data/lib/ruby-lokalise-api/resources/webhook.rb +1 -1
- data/lib/ruby-lokalise-api/rest/comments.rb +5 -5
- data/lib/ruby-lokalise-api/rest/contributors.rb +5 -5
- data/lib/ruby-lokalise-api/rest/custom_translation_statuses.rb +6 -6
- data/lib/ruby-lokalise-api/rest/files.rb +3 -3
- data/lib/ruby-lokalise-api/rest/keys.rb +7 -7
- data/lib/ruby-lokalise-api/rest/languages.rb +6 -6
- data/lib/ruby-lokalise-api/rest/payment_cards.rb +3 -3
- data/lib/ruby-lokalise-api/rest/projects.rb +6 -6
- data/lib/ruby-lokalise-api/rest/queued_processes.rb +26 -0
- data/lib/ruby-lokalise-api/rest/screenshots.rb +5 -5
- data/lib/ruby-lokalise-api/rest/snapshots.rb +4 -4
- data/lib/ruby-lokalise-api/rest/tasks.rb +5 -5
- data/lib/ruby-lokalise-api/rest/team_users.rb +4 -4
- data/lib/ruby-lokalise-api/rest/teams.rb +1 -1
- data/lib/ruby-lokalise-api/rest/translation_providers.rb +2 -2
- data/lib/ruby-lokalise-api/rest/translations.rb +3 -3
- data/lib/ruby-lokalise-api/rest/webhooks.rb +5 -5
- data/lib/ruby-lokalise-api/version.rb +1 -1
- data/ruby-lokalise-api.gemspec +1 -2
- data/spec/lib/ruby-lokalise-api/error_spec.rb +8 -0
- data/spec/lib/ruby-lokalise-api/rest/branches_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/comments_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/contributors_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/custom_translation_statuses_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/files_spec.rb +17 -9
- data/spec/lib/ruby-lokalise-api/rest/keys_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/orders_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/payment_cards_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/projects_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/queued_processes_spec.rb +58 -0
- data/spec/lib/ruby-lokalise-api/rest/screenshots_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/snapshots_spec.rb +25 -0
- data/spec/lib/ruby-lokalise-api/rest/tasks_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/team_users_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/translations_spec.rb +12 -0
- data/spec/lib/ruby-lokalise-api/rest/webhooks_spec.rb +13 -0
- metadata +11 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6c602350ca0a108c9b135614ec1fd5a9adeee0db4c6b22393b3f06e402bb8ff7
|
4
|
+
data.tar.gz: 1c124b4a7f0cd712768abfc9c9053835c66cc73fa65e929c0f24fad7184510a6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dc370463afa08c3ab8d9102f33960bb229dbfa582d813ae212af4928c5f2402f2130d8210e9dd98ddb7e6f1b6183ea8ed4d8977cc8d2c632439274aacd8602ad
|
7
|
+
data.tar.gz: e37ce2b8540b59235aa9ab867967daba685bd4cbffab690b4c24803ecbf35f85dbebb9c25ad7ca9088b07d4caf90603681c6c2c052b71865dc65c8e409ed7151
|
data/.github/CODE_OF_CONDUCT.md
CHANGED
@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
|
|
34
34
|
|
35
35
|
## Enforcement
|
36
36
|
|
37
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@lokalise.
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@lokalise.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
38
38
|
|
39
39
|
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
40
40
|
|
data/.github/CONTRIBUTING.md
CHANGED
@@ -10,5 +10,5 @@
|
|
10
10
|
8. [Submit a pull request.][pr]
|
11
11
|
|
12
12
|
[fork]: http://help.github.com/fork-a-repo/
|
13
|
-
[branch]:
|
14
|
-
[pr]:
|
13
|
+
[branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches
|
14
|
+
[pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,28 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 3.0.0 (14-May-20)
|
4
|
+
|
5
|
+
* **Breaking change** Uploading files in the background is now a preferred method, and the only method in version 3. Synchronous uploading is still supported and allowed in version 2 but will be removed in the near future. Find more info [in the docs](https://github.com/lokalise/ruby-lokalise-api#upload-translation-file).
|
6
|
+
* Added support for [background import](https://github.com/lokalise/ruby-lokalise-api#upload-translation-file). Background import will return a queued process with the status of the job:
|
7
|
+
|
8
|
+
```ruby
|
9
|
+
queued_process = @client.upload_file project_id,
|
10
|
+
data: 'Base-64 encoded data... ZnI6DQogI...',
|
11
|
+
filename: 'my_file.yml',
|
12
|
+
lang_iso: 'en'
|
13
|
+
|
14
|
+
queued_process.status # => 'queued'
|
15
|
+
# ...after some time...
|
16
|
+
queued_process = queued_process.reload_data
|
17
|
+
queued_process.status # => 'finished'
|
18
|
+
```
|
19
|
+
|
20
|
+
* Added support for [`QueuedProcess` endpoint](https://app.lokalise.com/api2docs/curl/#resource-queued-processes)
|
21
|
+
* Many resources now respond to the `reload_data` method which fetches new data from the API
|
22
|
+
* Various code improvements
|
23
|
+
* Test against more recent Rubies
|
24
|
+
* Fixed documentation links in code comments
|
25
|
+
|
3
26
|
## 2.10.0 (28-Feb-20)
|
4
27
|
|
5
28
|
* Added methods to [regenerate webhook secret](https://lokalise.com/api2docs/curl/#transition-regenerate-a-webhook-secret-patch):
|
data/README.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
[![Build Status](https://travis-ci.org/lokalise/ruby-lokalise-api.svg?branch=master)](https://travis-ci.org/lokalise/ruby-lokalise-api)
|
5
5
|
[![Test Coverage](https://codecov.io/gh/lokalise/ruby-lokalise-api/graph/badge.svg)](https://codecov.io/gh/lokalise/ruby-lokalise-api)
|
6
6
|
|
7
|
-
Official opinionated Ruby interface for the [Lokalise API](https://lokalise.com/api2docs/curl/) that represents returned data as Ruby objects.
|
7
|
+
Official opinionated Ruby interface for the [Lokalise API](https://app.lokalise.com/api2docs/curl/) that represents returned data as Ruby objects.
|
8
8
|
|
9
9
|
## Index
|
10
10
|
|
@@ -18,12 +18,13 @@ Official opinionated Ruby interface for the [Lokalise API](https://lokalise.com/
|
|
18
18
|
+ [Branches](#branches)
|
19
19
|
+ [Comments](#comments)
|
20
20
|
+ [Contributors](#contributors)
|
21
|
-
+ [Files](#files)
|
21
|
+
+ [Files](#translation-files)
|
22
22
|
+ [Keys](#keys)
|
23
23
|
+ [Languages](#languages)
|
24
24
|
+ [Orders](#orders)
|
25
25
|
+ [Payment cards](#payment-cards)
|
26
26
|
+ [Projects](#projects)
|
27
|
+
+ [Queued processes](#queued-processes)
|
27
28
|
+ [Screenshots](#screenshots)
|
28
29
|
+ [Snapshots](#snapshots)
|
29
30
|
+ [Tasks](#tasks)
|
@@ -80,6 +81,14 @@ project.description
|
|
80
81
|
project.created_by
|
81
82
|
```
|
82
83
|
|
84
|
+
Many resources have common methods like `project_id` and `branch`:
|
85
|
+
|
86
|
+
```ruby
|
87
|
+
webhook = client.webhook project_id, '123.abc'
|
88
|
+
webhook.project_id
|
89
|
+
webhook.branch
|
90
|
+
```
|
91
|
+
|
83
92
|
To get access to raw data returned by the API, use `#raw_data`:
|
84
93
|
|
85
94
|
```ruby
|
@@ -92,6 +101,18 @@ Models support method chaining, meaning you can fetch a resource, update and del
|
|
92
101
|
@client.project('123').update(name: 'New name').destroy
|
93
102
|
```
|
94
103
|
|
104
|
+
#### Reloading data
|
105
|
+
|
106
|
+
Most of the resources can be reloaded using the `reload_data` method. This method will fetch the latest data for the resource:
|
107
|
+
|
108
|
+
```ruby
|
109
|
+
project = client.project '123'
|
110
|
+
# do something else...
|
111
|
+
# project might be updated via UI, so load new data:
|
112
|
+
reloaded_project = project.reload_data
|
113
|
+
# now `reloaded_project` has fresh data from the API
|
114
|
+
```
|
115
|
+
|
95
116
|
### Collections of resources and pagination
|
96
117
|
|
97
118
|
Fetching (or creating/updating) multiple objects will return a *collection* of objects. To get access to the actual data, use `#collection` method:
|
@@ -101,7 +122,7 @@ project = @client.projects.collection.first # => Get the first project
|
|
101
122
|
project.name
|
102
123
|
```
|
103
124
|
|
104
|
-
Bulk fetches support [pagination](https://lokalise.com/api2docs/curl/#resource-pagination). There are two common parameters available:
|
125
|
+
Bulk fetches support [pagination](https://app.lokalise.com/api2docs/curl/#resource-pagination). There are two common parameters available:
|
105
126
|
|
106
127
|
* `:limit` (defaults to `100`, maximum is `5000`) - number of records to display per page
|
107
128
|
* `:page` (defaults to `1`) - page to fetch
|
@@ -153,11 +174,11 @@ If you are using [project branching feature](https://docs.lokalise.com/en/articl
|
|
153
174
|
|
154
175
|
### Branches
|
155
176
|
|
156
|
-
[Branches attributes](https://lokalise.com/api2docs/curl/#resource-branches)
|
177
|
+
[Branches attributes](https://app.lokalise.com/api2docs/curl/#resource-branches)
|
157
178
|
|
158
179
|
#### Fetch branches
|
159
180
|
|
160
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-branches-get)
|
181
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-branches-get)
|
161
182
|
|
162
183
|
```ruby
|
163
184
|
@client.branches(project_id, params = {}) # Input:
|
@@ -170,39 +191,39 @@ If you are using [project branching feature](https://docs.lokalise.com/en/articl
|
|
170
191
|
|
171
192
|
#### Fetch branch
|
172
193
|
|
173
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-branch-get)
|
194
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-branch-get)
|
174
195
|
|
175
196
|
```ruby
|
176
197
|
@client.branch(project_id, branch_id) # Input:
|
177
198
|
## project_id (string, required)
|
178
|
-
## branch_id (string or integer, required)
|
199
|
+
## branch_id (string or integer, required)
|
179
200
|
# Output:
|
180
201
|
## Branch inside the given project
|
181
202
|
```
|
182
203
|
|
183
204
|
#### Create branch
|
184
205
|
|
185
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-branch-get)
|
206
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-branch-get)
|
186
207
|
|
187
208
|
```ruby
|
188
209
|
@client.create_branch(project_id, params) # Input:
|
189
210
|
## project_id (string, required)
|
190
211
|
## params (hash, required):
|
191
|
-
### :name (string) - name of the branch
|
212
|
+
### :name (string) - name of the branch
|
192
213
|
# Output:
|
193
214
|
## Created branch
|
194
215
|
```
|
195
216
|
|
196
217
|
#### Update branch
|
197
218
|
|
198
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-branch-put)
|
219
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-branch-put)
|
199
220
|
|
200
221
|
```ruby
|
201
222
|
@client.update_branch(project_id, branch_id, params) # Input:
|
202
223
|
## project_id (string, required)
|
203
|
-
## branch_id (string or integer, required)
|
224
|
+
## branch_id (string or integer, required)
|
204
225
|
## params (hash, required):
|
205
|
-
### :name (string) - name of the branch
|
226
|
+
### :name (string) - name of the branch
|
206
227
|
# Output:
|
207
228
|
## Updated branch
|
208
229
|
```
|
@@ -216,12 +237,12 @@ branch.update params
|
|
216
237
|
|
217
238
|
#### Delete branch
|
218
239
|
|
219
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-branch-delete)
|
240
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-branch-delete)
|
220
241
|
|
221
242
|
```ruby
|
222
243
|
@client.destroy_branch(project_id, branch_id) # Input:
|
223
244
|
## project_id (string, required)
|
224
|
-
## branch_id (string or integer, required)
|
245
|
+
## branch_id (string or integer, required)
|
225
246
|
# Output:
|
226
247
|
## Hash with the project's id and "branch_deleted"=>true
|
227
248
|
```
|
@@ -235,13 +256,13 @@ branch.destroy
|
|
235
256
|
|
236
257
|
#### Merge branch
|
237
258
|
|
238
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-merge-a-branch-post)
|
259
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-merge-a-branch-post)
|
239
260
|
|
240
261
|
```ruby
|
241
262
|
@client.merge_branch(project_id, branch_id, params) # Input:
|
242
263
|
## project_id (string, required)
|
243
|
-
## branch_id (string or integer, required)
|
244
|
-
## params (hash)
|
264
|
+
## branch_id (string or integer, required)
|
265
|
+
## params (hash)
|
245
266
|
# Output:
|
246
267
|
## Hash with the project's id, "branch_merged"=>true, and branch attributes
|
247
268
|
```
|
@@ -255,11 +276,11 @@ branch.merge params
|
|
255
276
|
|
256
277
|
### Comments
|
257
278
|
|
258
|
-
[Comments attributes](https://lokalise.com/api2docs/curl/#resource-comments)
|
279
|
+
[Comments attributes](https://app.lokalise.com/api2docs/curl/#resource-comments)
|
259
280
|
|
260
281
|
#### Fetch project comments
|
261
282
|
|
262
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-project-comments-get)
|
283
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-project-comments-get)
|
263
284
|
|
264
285
|
```ruby
|
265
286
|
@client.project_comments(project_id, params = {}) # Input:
|
@@ -272,12 +293,12 @@ branch.merge params
|
|
272
293
|
|
273
294
|
#### Fetch key comments
|
274
295
|
|
275
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-key-comments-get)
|
296
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-key-comments-get)
|
276
297
|
|
277
298
|
```ruby
|
278
299
|
@client.comments(project_id, key_id, params = {}) # Input:
|
279
300
|
## project_id (string, required)
|
280
|
-
## key_id (string, required)
|
301
|
+
## key_id (string, required)
|
281
302
|
## params (hash)
|
282
303
|
### :page and :limit
|
283
304
|
# Output:
|
@@ -286,12 +307,12 @@ branch.merge params
|
|
286
307
|
|
287
308
|
#### Create key comments
|
288
309
|
|
289
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-comments-post)
|
310
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-comments-post)
|
290
311
|
|
291
312
|
```ruby
|
292
313
|
@client.create_comments(project_id, key_id, params) # Input:
|
293
314
|
## project_id (string, required)
|
294
|
-
## key_id (string, required)
|
315
|
+
## key_id (string, required)
|
295
316
|
## params (array or hash, required) - contains parameter of newly created comments. Pass array of hashes to create multiple comments, or a hash to create a single comment
|
296
317
|
### :comment (string, required)
|
297
318
|
# Output:
|
@@ -300,26 +321,26 @@ branch.merge params
|
|
300
321
|
|
301
322
|
#### Fetch key comment
|
302
323
|
|
303
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-comment-get)
|
324
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-comment-get)
|
304
325
|
|
305
326
|
```ruby
|
306
327
|
@client.comment(project_id, key_id, comment_id) # Input:
|
307
328
|
## project_id (string, required)
|
308
|
-
## key_id (string, required)
|
309
|
-
## comment_id (string, required)
|
329
|
+
## key_id (string, required)
|
330
|
+
## comment_id (string, required)
|
310
331
|
# Output:
|
311
332
|
## Comment for the key in the given project
|
312
333
|
```
|
313
334
|
|
314
335
|
#### Delete key comment
|
315
336
|
|
316
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-comment-delete)
|
337
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-comment-delete)
|
317
338
|
|
318
339
|
```ruby
|
319
340
|
@client.destroy_comment(project_id, key_id, comment_id) # Input:
|
320
341
|
## project_id (string, required)
|
321
|
-
## key_id (string, required)
|
322
|
-
## comment_id (string, required)
|
342
|
+
## key_id (string, required)
|
343
|
+
## comment_id (string, required)
|
323
344
|
# Output:
|
324
345
|
## Hash with the project's id and "comment_deleted"=>true
|
325
346
|
```
|
@@ -335,7 +356,7 @@ comment.destroy
|
|
335
356
|
|
336
357
|
#### Fetch contributors
|
337
358
|
|
338
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-contributors-get)
|
359
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-contributors-get)
|
339
360
|
|
340
361
|
```ruby
|
341
362
|
@client.contributors(project_id, params = {}) # Input:
|
@@ -348,7 +369,7 @@ comment.destroy
|
|
348
369
|
|
349
370
|
#### Fetch a single contributor
|
350
371
|
|
351
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-contributor-get)
|
372
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-contributor-get)
|
352
373
|
|
353
374
|
```ruby
|
354
375
|
@client.contributor(project_id, contributor_id) # Input:
|
@@ -360,39 +381,39 @@ comment.destroy
|
|
360
381
|
|
361
382
|
#### Create contributors
|
362
383
|
|
363
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-contributors-post)
|
384
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-contributors-post)
|
364
385
|
|
365
386
|
```ruby
|
366
387
|
@client.create_contributors(project_id, params) # Input:
|
367
388
|
## project_id (string, required)
|
368
389
|
## params (array of hashes or hash, required) - parameters for the newly created contributors. Pass array of hashes to create multiple contributors, or a hash to create a single contributor
|
369
390
|
### :email (string, required)
|
370
|
-
### :fullname (string)
|
391
|
+
### :fullname (string)
|
371
392
|
### :is_admin (boolean)
|
372
393
|
### :is_reviewer (boolean)
|
373
394
|
### :languages (array of hashes, required if "is_admin" set to false) - possible languages attributes:
|
374
395
|
#### :lang_iso (string, required)
|
375
|
-
#### :is_writable (boolean)
|
376
|
-
### :admin_rights (array)
|
396
|
+
#### :is_writable (boolean)
|
397
|
+
### :admin_rights (array)
|
377
398
|
# Output:
|
378
399
|
## Collection of newly created contributors
|
379
400
|
```
|
380
401
|
|
381
402
|
#### Update contributor
|
382
403
|
|
383
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-contributor-put)
|
404
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-contributor-put)
|
384
405
|
|
385
406
|
```ruby
|
386
407
|
@client.update_contributor(project_id, contributor_id, params) # Input:
|
387
408
|
## project_id (string, required)
|
388
|
-
## contributor_id (string, required)
|
409
|
+
## contributor_id (string, required)
|
389
410
|
## params (hash, required)
|
390
411
|
### :is_admin (boolean)
|
391
412
|
### :is_reviewer (boolean)
|
392
413
|
### :languages (array of hashes) - possible languages attributes:
|
393
414
|
#### :lang_iso (string, required)
|
394
|
-
#### :is_writable (boolean)
|
395
|
-
### :admin_rights (array)
|
415
|
+
#### :is_writable (boolean)
|
416
|
+
### :admin_rights (array)
|
396
417
|
# Output:
|
397
418
|
## Updated contributor
|
398
419
|
```
|
@@ -406,7 +427,7 @@ contributor.update(params)
|
|
406
427
|
|
407
428
|
#### Delete contributor
|
408
429
|
|
409
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-contributor-delete)
|
430
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-contributor-delete)
|
410
431
|
|
411
432
|
```ruby
|
412
433
|
@client.destroy_contributor(project_id, contributor_id) # Input:
|
@@ -423,13 +444,13 @@ contributor = @client.contributor('project_id', 'id')
|
|
423
444
|
contributor.destroy
|
424
445
|
```
|
425
446
|
|
426
|
-
###
|
447
|
+
### Translation files
|
427
448
|
|
428
|
-
[File attributes](https://lokalise.com/api2docs/curl/#object-files)
|
449
|
+
[File attributes](https://app.lokalise.com/api2docs/curl/#object-files)
|
429
450
|
|
430
451
|
#### Fetch translation files
|
431
452
|
|
432
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-files-get)
|
453
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-files-get)
|
433
454
|
|
434
455
|
```ruby
|
435
456
|
@client.files(project_id, params = {}) # Input:
|
@@ -442,7 +463,7 @@ contributor.destroy
|
|
442
463
|
|
443
464
|
#### Download translation files
|
444
465
|
|
445
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-download-files-post)
|
466
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-download-files-post)
|
446
467
|
|
447
468
|
Exports project files as a `.zip` bundle and makes them available to download (the link is valid for 12 months).
|
448
469
|
|
@@ -451,14 +472,16 @@ Exports project files as a `.zip` bundle and makes them available to download (t
|
|
451
472
|
## project_id (string, required)
|
452
473
|
## params (hash, required)
|
453
474
|
### :format (string, required) - one of the file formats supported by Lokalise (json, xml, po etc).
|
454
|
-
### Find the list of other supported params at https://lokalise.com/api2docs/curl/#transition-download-files-post
|
475
|
+
### Find the list of other supported params at https://app.lokalise.com/api2docs/curl/#transition-download-files-post
|
455
476
|
# Output:
|
456
477
|
## Hash with the project id and a "bundle_url" link
|
457
478
|
```
|
458
479
|
|
459
480
|
#### Upload translation file
|
460
481
|
|
461
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-upload-a-file-post)
|
482
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-upload-a-file-post)
|
483
|
+
|
484
|
+
Starting from 9 May 2020, **background uploading is the preferred method of importing translation files**. Version 3 supports only asynchronous uploading. Version 2 still allows synchronous uploading but this feature will be removed in the near future.
|
462
485
|
|
463
486
|
```ruby
|
464
487
|
@client.upload_file(project_id, params) # Input:
|
@@ -466,19 +489,64 @@ Exports project files as a `.zip` bundle and makes them available to download (t
|
|
466
489
|
## params (hash, required)
|
467
490
|
### :data (string, required) - base64-encoded data (the format must be supported by Lokalise)
|
468
491
|
### :filename (string, required)
|
469
|
-
### :lang_iso (string, required)
|
470
|
-
### Find the list of other supported params at https://lokalise.com/api2docs/curl/#transition-upload-a-file-post
|
492
|
+
### :lang_iso (string, required)
|
493
|
+
### Find the list of other supported params at https://app.lokalise.com/api2docs/curl/#transition-upload-a-file-post
|
471
494
|
# Output:
|
472
|
-
##
|
495
|
+
## QueuedProcess resource
|
496
|
+
```
|
497
|
+
|
498
|
+
A [`QueuedProcess`](#queued-processes) resource will be returned. This resource contains a status of the import job, process ID to manually check the status, and some other attributes:
|
499
|
+
|
500
|
+
```ruby
|
501
|
+
queued_process = @client.upload_file project_id,
|
502
|
+
data: 'Base-64 encoded data... ZnI6DQogI...',
|
503
|
+
filename: 'my_file.yml',
|
504
|
+
lang_iso: 'en'
|
505
|
+
|
506
|
+
queued_process.status # => 'queued'
|
507
|
+
queued_process.process_id # => 'ff1876382b7ba81f2bb465da8f030196ec401fa6'
|
508
|
+
```
|
509
|
+
|
510
|
+
Your job is to periodically reload data for the queued process and check the `status` attribute:
|
511
|
+
|
512
|
+
```ruby
|
513
|
+
reloaded_process = queued_process.reload_data # loads new data from the API
|
514
|
+
reloaded_process.status # => 'finished'
|
515
|
+
```
|
516
|
+
|
517
|
+
Alternatively, you may use the `queued_process` method:
|
518
|
+
|
519
|
+
```ruby
|
520
|
+
reloaded_process = @client.queued_process project_id, queued_process.process_id
|
521
|
+
```
|
522
|
+
|
523
|
+
It is up to you to decide how to poll API for changes (remember that larger files will take more time to be imported), but here's a simple example:
|
524
|
+
|
525
|
+
```ruby
|
526
|
+
def uploaded?(process)
|
527
|
+
5.times do # try to check the status 5 times
|
528
|
+
queued_process = queued_process.reload_data # load new data
|
529
|
+
return(true) if queued_process.status == 'finished' # return true is the upload has finished
|
530
|
+
sleep 1 # wait for 1 second, adjust this number with regards to the upload size
|
531
|
+
end
|
532
|
+
|
533
|
+
return false # if all 5 checks failed, return false (probably something is wrong)
|
534
|
+
end
|
535
|
+
|
536
|
+
queued_process = @client.upload_file project_id,
|
537
|
+
data: 'Base-64 encoded data... ZnI6DQogI...',
|
538
|
+
filename: 'my_file.yml',
|
539
|
+
lang_iso: 'en'
|
540
|
+
uploaded? queued_process
|
473
541
|
```
|
474
542
|
|
475
543
|
### Keys
|
476
544
|
|
477
|
-
[Key attributes](https://lokalise.com/api2docs/curl/#object-keys)
|
545
|
+
[Key attributes](https://app.lokalise.com/api2docs/curl/#object-keys)
|
478
546
|
|
479
547
|
#### Fetch project keys
|
480
548
|
|
481
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-keys-get)
|
549
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-keys-get)
|
482
550
|
|
483
551
|
```ruby
|
484
552
|
@client.keys(project_id, params = {}) # Input:
|
@@ -491,12 +559,12 @@ Exports project files as a `.zip` bundle and makes them available to download (t
|
|
491
559
|
|
492
560
|
#### Fetch a single project key
|
493
561
|
|
494
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-key-get)
|
562
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-key-get)
|
495
563
|
|
496
564
|
```ruby
|
497
565
|
@client.key(project_id, key_id, params = {}) # Input:
|
498
566
|
## project_id (string, required)
|
499
|
-
## key_id (string, required)
|
567
|
+
## key_id (string, required)
|
500
568
|
## params (hash)
|
501
569
|
### :disable_references (string) - possible values are "1" and "0".
|
502
570
|
# Output:
|
@@ -505,7 +573,7 @@ Exports project files as a `.zip` bundle and makes them available to download (t
|
|
505
573
|
|
506
574
|
#### Create project keys
|
507
575
|
|
508
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-keys-post)
|
576
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-keys-post)
|
509
577
|
|
510
578
|
```ruby
|
511
579
|
@client.create_keys(project_id, params) # Input:
|
@@ -513,21 +581,21 @@ Exports project files as a `.zip` bundle and makes them available to download (t
|
|
513
581
|
## params (array of hashes or hash, required)
|
514
582
|
### :key_name (string or hash, required) - for projects with enabled per-platform key names, pass hash with "ios", "android", "web" and "other" params.
|
515
583
|
### :platforms (array) - supported values are "ios", "android", "web" and "other"
|
516
|
-
### Find all other supported attributes at https://lokalise.com/api2docs/curl/#transition-create-keys-post
|
584
|
+
### Find all other supported attributes at https://app.lokalise.com/api2docs/curl/#transition-create-keys-post
|
517
585
|
# Output:
|
518
586
|
## Collection of newly created keys
|
519
587
|
```
|
520
588
|
|
521
589
|
#### Update project key
|
522
590
|
|
523
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-key-put)
|
591
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-key-put)
|
524
592
|
|
525
593
|
```ruby
|
526
594
|
@client.update_key(project_id, key_id, params = {}) # Input:
|
527
595
|
## project_id (string, required)
|
528
|
-
## key_id (string, required)
|
596
|
+
## key_id (string, required)
|
529
597
|
## params (hash)
|
530
|
-
### Find a list of supported attributes at https://lokalise.com/api2docs/curl/#transition-update-a-key-put
|
598
|
+
### Find a list of supported attributes at https://app.lokalise.com/api2docs/curl/#transition-update-a-key-put
|
531
599
|
# Output:
|
532
600
|
## Updated key
|
533
601
|
```
|
@@ -541,26 +609,26 @@ key.update(params)
|
|
541
609
|
|
542
610
|
#### Bulk update project keys
|
543
611
|
|
544
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-bulk-update-put)
|
612
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-bulk-update-put)
|
545
613
|
|
546
614
|
```ruby
|
547
615
|
@client.update_keys(project_id, params) # Input:
|
548
616
|
## project_id (string, required)
|
549
617
|
## params (hash or array of hashes, required)
|
550
618
|
### :key_id (string, required)
|
551
|
-
### Find all other supported attributes at https://lokalise.com/api2docs/curl/#transition-bulk-update-put
|
619
|
+
### Find all other supported attributes at https://app.lokalise.com/api2docs/curl/#transition-bulk-update-put
|
552
620
|
# Output:
|
553
621
|
## Collection of updated keys
|
554
622
|
```
|
555
623
|
|
556
624
|
#### Delete project key
|
557
625
|
|
558
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-key-delete)
|
626
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-key-delete)
|
559
627
|
|
560
628
|
```ruby
|
561
629
|
@client.destroy_key(project_id, key_id) # Input:
|
562
630
|
## project_id (string, required)
|
563
|
-
## key_id (string, required)
|
631
|
+
## key_id (string, required)
|
564
632
|
# Output:
|
565
633
|
## Hash with project_id and "key_removed" set to "true"
|
566
634
|
```
|
@@ -574,12 +642,12 @@ key.destroy
|
|
574
642
|
|
575
643
|
#### Bulk delete project keys
|
576
644
|
|
577
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-multiple-keys-delete)
|
645
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-multiple-keys-delete)
|
578
646
|
|
579
647
|
```ruby
|
580
648
|
@client.destroy_keys(project_id, key_ids) # Input:
|
581
649
|
## project_id (string, required)
|
582
|
-
## key_ids (array, required)
|
650
|
+
## key_ids (array, required)
|
583
651
|
# Output:
|
584
652
|
## Hash with project_id and "keys_removed" set to "true"
|
585
653
|
```
|
@@ -593,11 +661,11 @@ keys.destroy_all # => will effectively destroy all keys in the project
|
|
593
661
|
|
594
662
|
### Languages
|
595
663
|
|
596
|
-
[Language attributes](https://lokalise.com/api2docs/curl/#object-languages)
|
664
|
+
[Language attributes](https://app.lokalise.com/api2docs/curl/#object-languages)
|
597
665
|
|
598
666
|
#### Fetch system languages
|
599
667
|
|
600
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-system-languages-get)
|
668
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-system-languages-get)
|
601
669
|
|
602
670
|
```ruby
|
603
671
|
@client.system_languages(params = {}) # Input:
|
@@ -609,7 +677,7 @@ keys.destroy_all # => will effectively destroy all keys in the project
|
|
609
677
|
|
610
678
|
#### Fetch project languages
|
611
679
|
|
612
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-project-languages-get)
|
680
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-project-languages-get)
|
613
681
|
|
614
682
|
```ruby
|
615
683
|
@client.project_languages(project_id, params = {}) # Input:
|
@@ -622,7 +690,7 @@ keys.destroy_all # => will effectively destroy all keys in the project
|
|
622
690
|
|
623
691
|
#### Fetch a single project language
|
624
692
|
|
625
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-language-get)
|
693
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-language-get)
|
626
694
|
|
627
695
|
```ruby
|
628
696
|
@client.language(project_id, language_id) # Input:
|
@@ -634,14 +702,14 @@ keys.destroy_all # => will effectively destroy all keys in the project
|
|
634
702
|
|
635
703
|
#### Create project languages
|
636
704
|
|
637
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-languages-post)
|
705
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-languages-post)
|
638
706
|
|
639
707
|
```ruby
|
640
708
|
@client.create_languages(project_id, params) # Input:
|
641
709
|
## project_id (string, required)
|
642
710
|
## params (array of hashes or hash, required) - contains parameter of newly created languages. Pass array of hashes to create multiple languages, or a hash to create a single language
|
643
711
|
### :lang_iso (string, required)
|
644
|
-
### :custom_iso (string)
|
712
|
+
### :custom_iso (string)
|
645
713
|
### :custom_name (string)
|
646
714
|
### :custom_plural_forms (array) - can contain only plural forms initially supported by Lokalise
|
647
715
|
# Output:
|
@@ -650,16 +718,16 @@ keys.destroy_all # => will effectively destroy all keys in the project
|
|
650
718
|
|
651
719
|
#### Update project language
|
652
720
|
|
653
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-language-put)
|
721
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-language-put)
|
654
722
|
|
655
723
|
```ruby
|
656
724
|
@client.update_language(project_id, language_id, params) # Input:
|
657
725
|
## project_id (string, required)
|
658
|
-
## language_id (string, required)
|
726
|
+
## language_id (string, required)
|
659
727
|
## params (hash, required)
|
660
728
|
### :lang_iso (string, required)
|
661
729
|
### :custom_name (string)
|
662
|
-
### :plural_forms (array) - can contain only plural forms initially supported by Lokalise
|
730
|
+
### :plural_forms (array) - can contain only plural forms initially supported by Lokalise
|
663
731
|
# Output:
|
664
732
|
## Updated language
|
665
733
|
```
|
@@ -673,7 +741,7 @@ language.update(params)
|
|
673
741
|
|
674
742
|
#### Delete project language
|
675
743
|
|
676
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-language-delete)
|
744
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-language-delete)
|
677
745
|
|
678
746
|
```ruby
|
679
747
|
@client.destroy_language(project_id, language_id) # Input:
|
@@ -692,11 +760,11 @@ language.destroy
|
|
692
760
|
|
693
761
|
### Orders
|
694
762
|
|
695
|
-
[Order attributes](https://lokalise.com/api2docs/curl/#object-orders)
|
763
|
+
[Order attributes](https://app.lokalise.com/api2docs/curl/#object-orders)
|
696
764
|
|
697
765
|
#### Fetch order collection
|
698
766
|
|
699
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-orders-get)
|
767
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-orders-get)
|
700
768
|
|
701
769
|
```ruby
|
702
770
|
@client.orders(team_id, params = {}) # Input:
|
@@ -709,7 +777,7 @@ language.destroy
|
|
709
777
|
|
710
778
|
#### Fetch a single order
|
711
779
|
|
712
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-an-order-get)
|
780
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-an-order-get)
|
713
781
|
|
714
782
|
```ruby
|
715
783
|
@client.order(team_id, order_id) # Input:
|
@@ -721,7 +789,7 @@ language.destroy
|
|
721
789
|
|
722
790
|
#### Create an order
|
723
791
|
|
724
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-an-order-post)
|
792
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-an-order-post)
|
725
793
|
|
726
794
|
```ruby
|
727
795
|
@client.create_order(team_id, params) # Input:
|
@@ -730,13 +798,13 @@ language.destroy
|
|
730
798
|
### project_id (string, required)
|
731
799
|
### card_id (integer, string, required) - card to process payment
|
732
800
|
### briefing (string, required)
|
733
|
-
### source_language_iso (string, required)
|
801
|
+
### source_language_iso (string, required)
|
734
802
|
### target_language_isos (array of strings, required)
|
735
803
|
### keys (array of integers, required) - keys to include in the order
|
736
804
|
### provider_slug (string, required)
|
737
|
-
### translation_tier (integer, required)
|
805
|
+
### translation_tier (integer, required)
|
738
806
|
### dry_run (boolean) - return the response without actually placing an order. Useful for price estimation. Default is `false`
|
739
|
-
### translation_style (string) - only for gengo provider. Available values are `formal`, `informal`, `business`, `friendly`. Defaults to `friendly`.
|
807
|
+
### translation_style (string) - only for gengo provider. Available values are `formal`, `informal`, `business`, `friendly`. Defaults to `friendly`.
|
740
808
|
# Output:
|
741
809
|
## A newly created order
|
742
810
|
|
@@ -744,23 +812,23 @@ language.destroy
|
|
744
812
|
|
745
813
|
### Payment cards
|
746
814
|
|
747
|
-
[Payment card attributes](https://lokalise.com/api2docs/curl/#object-payment-cards)
|
815
|
+
[Payment card attributes](https://app.lokalise.com/api2docs/curl/#object-payment-cards)
|
748
816
|
|
749
817
|
#### Fetch payment card collection
|
750
818
|
|
751
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-cards-get)
|
819
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-cards-get)
|
752
820
|
|
753
821
|
```ruby
|
754
822
|
@client.payment_cards(params = {}) # Input:
|
755
823
|
## params (hash)
|
756
824
|
### :page and :limit
|
757
825
|
# Output:
|
758
|
-
## Collection of payment cards under the `payment_cards` attribute
|
826
|
+
## Collection of payment cards under the `payment_cards` attribute
|
759
827
|
```
|
760
828
|
|
761
829
|
#### Fetch a single payment card
|
762
830
|
|
763
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-card-get)
|
831
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-card-get)
|
764
832
|
|
765
833
|
```ruby
|
766
834
|
@client.payment_card(card_id) # Input:
|
@@ -771,7 +839,7 @@ language.destroy
|
|
771
839
|
|
772
840
|
#### Create a payment card
|
773
841
|
|
774
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-a-card-post)
|
842
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-a-card-post)
|
775
843
|
|
776
844
|
```ruby
|
777
845
|
@client.create_payment_card(params) # Input:
|
@@ -781,13 +849,13 @@ language.destroy
|
|
781
849
|
### exp_month (integer, required) - card expiration month (1 - 12)
|
782
850
|
### exp_year (integer, required) - card expiration year (for example, 2019)
|
783
851
|
# Output:
|
784
|
-
## A newly created payment card
|
852
|
+
## A newly created payment card
|
785
853
|
|
786
854
|
```
|
787
855
|
|
788
856
|
#### Delete a payment card
|
789
857
|
|
790
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-card-delete)
|
858
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-card-delete)
|
791
859
|
|
792
860
|
```ruby
|
793
861
|
@client.destroy_payment_card(card_id) # Input:
|
@@ -805,11 +873,11 @@ card.destroy
|
|
805
873
|
|
806
874
|
### Projects
|
807
875
|
|
808
|
-
[Project attributes](https://lokalise.com/api2docs/curl/#object-projects)
|
876
|
+
[Project attributes](https://app.lokalise.com/api2docs/curl/#object-projects)
|
809
877
|
|
810
878
|
#### Fetch projects collection
|
811
879
|
|
812
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-projects-get)
|
880
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-projects-get)
|
813
881
|
|
814
882
|
```ruby
|
815
883
|
@client.projects(params = {}) # Input:
|
@@ -817,38 +885,38 @@ card.destroy
|
|
817
885
|
### :filter_team_id (string) - load projects only for the given team
|
818
886
|
### :page and :limit
|
819
887
|
# Output:
|
820
|
-
## Collection of projects under the `projects` attribute
|
888
|
+
## Collection of projects under the `projects` attribute
|
821
889
|
```
|
822
890
|
|
823
891
|
#### Fetch a single project
|
824
892
|
|
825
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-project-get)
|
893
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-project-get)
|
826
894
|
|
827
895
|
```ruby
|
828
896
|
@client.project(project_id) # Input:
|
829
897
|
## project_id (string, required)
|
830
898
|
# Output:
|
831
|
-
## A single project
|
899
|
+
## A single project
|
832
900
|
```
|
833
901
|
|
834
902
|
#### Create a project
|
835
903
|
|
836
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-a-project-post)
|
904
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-a-project-post)
|
837
905
|
|
838
906
|
```ruby
|
839
907
|
@client.create_project(params) # Input:
|
840
908
|
## params (hash, required)
|
841
909
|
### name (string, required)
|
842
910
|
### description (string)
|
843
|
-
### team_id (integer) - you must be an admin of the chosen team. When omitted, defaults to the current team of the token's owner
|
911
|
+
### team_id (integer) - you must be an admin of the chosen team. When omitted, defaults to the current team of the token's owner
|
844
912
|
# Output:
|
845
|
-
## A newly created project
|
913
|
+
## A newly created project
|
846
914
|
|
847
915
|
```
|
848
916
|
|
849
917
|
#### Update a project
|
850
918
|
|
851
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-project-put)
|
919
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-project-put)
|
852
920
|
|
853
921
|
```ruby
|
854
922
|
@client.update_project(project_id, params) # Input:
|
@@ -869,7 +937,7 @@ project.update(params)
|
|
869
937
|
|
870
938
|
#### Empty a project
|
871
939
|
|
872
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-empty-a-project-put)
|
940
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-empty-a-project-put)
|
873
941
|
|
874
942
|
Deletes *all* keys and translations from the project.
|
875
943
|
|
@@ -889,7 +957,7 @@ project.empty
|
|
889
957
|
|
890
958
|
#### Delete a project
|
891
959
|
|
892
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-project-delete)
|
960
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-project-delete)
|
893
961
|
|
894
962
|
```ruby
|
895
963
|
@client.destroy_project(project_id) # Input:
|
@@ -905,13 +973,40 @@ project = @client.project('project_id')
|
|
905
973
|
project.destroy
|
906
974
|
```
|
907
975
|
|
976
|
+
### Queued processes
|
977
|
+
|
978
|
+
[Queued processes attributes](https://app.lokalise.com/api2docs/curl/#object-queued-processes)
|
979
|
+
|
980
|
+
#### Fetch queued processes
|
981
|
+
|
982
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-processes-get)
|
983
|
+
|
984
|
+
```ruby
|
985
|
+
@client.queued_processes(project_id) # Input:
|
986
|
+
## project_id (string, required)
|
987
|
+
# Output:
|
988
|
+
## Collection of queued processes
|
989
|
+
```
|
990
|
+
|
991
|
+
#### Fetch a single queued process
|
992
|
+
|
993
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-process-get)
|
994
|
+
|
995
|
+
```ruby
|
996
|
+
@client.queued_process(project_id, process_id) # Input:
|
997
|
+
## project_id (string, required)
|
998
|
+
## process_id (string, required)
|
999
|
+
# Output:
|
1000
|
+
## Queued process resource
|
1001
|
+
```
|
1002
|
+
|
908
1003
|
### Screenshots
|
909
1004
|
|
910
|
-
[Screenshot attributes](https://lokalise.com/api2docs/curl/#resource-screenshots)
|
1005
|
+
[Screenshot attributes](https://app.lokalise.com/api2docs/curl/#resource-screenshots)
|
911
1006
|
|
912
1007
|
#### Fetch screenshots
|
913
1008
|
|
914
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-screenshots-get)
|
1009
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-screenshots-get)
|
915
1010
|
|
916
1011
|
```ruby
|
917
1012
|
@client.screenshots(project_id, params = {}) # Input:
|
@@ -924,47 +1019,47 @@ project.destroy
|
|
924
1019
|
|
925
1020
|
#### Fetch a single screenshot
|
926
1021
|
|
927
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-screenshot-get)
|
1022
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-screenshot-get)
|
928
1023
|
|
929
1024
|
```ruby
|
930
1025
|
@client.screeshot(project_id, screeshot_id) # Input:
|
931
1026
|
## project_id (string, required)
|
932
1027
|
## screeshot_id (string, required)
|
933
1028
|
# Output:
|
934
|
-
## A single screenshot
|
1029
|
+
## A single screenshot
|
935
1030
|
```
|
936
1031
|
|
937
1032
|
#### Create screenshots
|
938
1033
|
|
939
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-screenshots-post)
|
1034
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-screenshots-post)
|
940
1035
|
|
941
1036
|
```ruby
|
942
1037
|
@client.create_screenshots(project_id, params) # Input:
|
943
1038
|
## project_id (string, required)
|
944
1039
|
## params (hash or array of hashes, required)
|
945
1040
|
### :data (string, required) - the actual screenshot, base64-encoded (with leading image type "data:image/jpeg;base64,"). JPG and PNG formats are supported.
|
946
|
-
### :title (string)
|
1041
|
+
### :title (string)
|
947
1042
|
### :description (string)
|
948
1043
|
### :ocr (boolean) - recognize translations on the image and attach screenshot to all possible keys
|
949
1044
|
### :key_ids (array) - attach the screenshot to key IDs specified
|
950
|
-
### :tags (array)
|
1045
|
+
### :tags (array)
|
951
1046
|
# Output:
|
952
1047
|
## Collection of created screenshots
|
953
1048
|
```
|
954
1049
|
|
955
1050
|
#### Update screenshot
|
956
1051
|
|
957
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-screenshot-put)
|
1052
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-screenshot-put)
|
958
1053
|
|
959
1054
|
```ruby
|
960
1055
|
@client.update_screenshot(project_id, screenshot_id, params = {}) # Input:
|
961
1056
|
## project_id (string, required)
|
962
1057
|
## screenshot_id (string, required)
|
963
1058
|
## params (hash)
|
964
|
-
### :title (string)
|
1059
|
+
### :title (string)
|
965
1060
|
### :description (string)
|
966
1061
|
### :key_ids (array) - attach the screenshot to key IDs specified
|
967
|
-
### :tags (array)
|
1062
|
+
### :tags (array)
|
968
1063
|
# Output:
|
969
1064
|
## Updated screenshot
|
970
1065
|
```
|
@@ -978,7 +1073,7 @@ screenshot.update(params)
|
|
978
1073
|
|
979
1074
|
#### Delete screenshot
|
980
1075
|
|
981
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-screenshot-delete)
|
1076
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-screenshot-delete)
|
982
1077
|
|
983
1078
|
```ruby
|
984
1079
|
@client.destroy_screenshot(project_id, screenshot_id) # Input:
|
@@ -997,17 +1092,17 @@ screenshot.destroy
|
|
997
1092
|
|
998
1093
|
### Snapshots
|
999
1094
|
|
1000
|
-
[Snapshot attributes](https://lokalise.com/api2docs/curl/#object-snapshots)
|
1095
|
+
[Snapshot attributes](https://app.lokalise.com/api2docs/curl/#object-snapshots)
|
1001
1096
|
|
1002
1097
|
#### Fetch snapshots
|
1003
1098
|
|
1004
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-snapshots-get)
|
1099
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-snapshots-get)
|
1005
1100
|
|
1006
1101
|
```ruby
|
1007
1102
|
@client.snapshots(project_id, params = {}) # Input:
|
1008
1103
|
## project_id (string, required)
|
1009
1104
|
## params (hash)
|
1010
|
-
### :filter_title (string) - set title filter for the list
|
1105
|
+
### :filter_title (string) - set title filter for the list
|
1011
1106
|
### :page and :limit
|
1012
1107
|
# Output:
|
1013
1108
|
## Collection of project snapshots
|
@@ -1015,7 +1110,7 @@ screenshot.destroy
|
|
1015
1110
|
|
1016
1111
|
#### Create snapshot
|
1017
1112
|
|
1018
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-a-snapshot-post)
|
1113
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-a-snapshot-post)
|
1019
1114
|
|
1020
1115
|
```ruby
|
1021
1116
|
@client.create_snapshot(project_id, params = {}) # Input:
|
@@ -1028,7 +1123,7 @@ screenshot.destroy
|
|
1028
1123
|
|
1029
1124
|
#### Restore snapshot
|
1030
1125
|
|
1031
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-restore-a-snapshot-post)
|
1126
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-restore-a-snapshot-post)
|
1032
1127
|
|
1033
1128
|
```ruby
|
1034
1129
|
@client.restore_snapshot(project_id, snapshot_id) # Input:
|
@@ -1047,7 +1142,7 @@ snapshot.restore
|
|
1047
1142
|
|
1048
1143
|
#### Delete snapshot
|
1049
1144
|
|
1050
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-snapshot-delete)
|
1145
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-snapshot-delete)
|
1051
1146
|
|
1052
1147
|
```ruby
|
1053
1148
|
@client.destroy_snapshot(project_id, snapshot_id) # Input:
|
@@ -1066,17 +1161,17 @@ snapshot.destroy
|
|
1066
1161
|
|
1067
1162
|
### Tasks
|
1068
1163
|
|
1069
|
-
[Task attributes](https://lokalise.com/api2docs/curl/#resource-tasks)
|
1164
|
+
[Task attributes](https://app.lokalise.com/api2docs/curl/#resource-tasks)
|
1070
1165
|
|
1071
1166
|
#### Fetch tasks
|
1072
1167
|
|
1073
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-tasks-get)
|
1168
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-tasks-get)
|
1074
1169
|
|
1075
1170
|
```ruby
|
1076
1171
|
@client.tasks(project_id, params = {}) # Input:
|
1077
1172
|
## project_id (string, required)
|
1078
1173
|
## params (hash)
|
1079
|
-
### :filter_title (string) - set title filter for the list
|
1174
|
+
### :filter_title (string) - set title filter for the list
|
1080
1175
|
### :page and :limit
|
1081
1176
|
# Output:
|
1082
1177
|
## Collection of tasks for the project
|
@@ -1084,7 +1179,7 @@ snapshot.destroy
|
|
1084
1179
|
|
1085
1180
|
#### Fetch a single task
|
1086
1181
|
|
1087
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-task-get)
|
1182
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-task-get)
|
1088
1183
|
|
1089
1184
|
```ruby
|
1090
1185
|
@client.task(project_id, task_id, params = {}) # Input:
|
@@ -1096,35 +1191,35 @@ snapshot.destroy
|
|
1096
1191
|
|
1097
1192
|
#### Create task
|
1098
1193
|
|
1099
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-a-task-post)
|
1194
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-a-task-post)
|
1100
1195
|
|
1101
1196
|
```ruby
|
1102
1197
|
@client.create_task(project_id, params) # Input:
|
1103
1198
|
## project_id (string, required)
|
1104
1199
|
## params (hash, required)
|
1105
1200
|
### title (string, required)
|
1106
|
-
### keys (array) - translation key ids. Required if "parent_task_id" is not specified
|
1201
|
+
### keys (array) - translation key ids. Required if "parent_task_id" is not specified
|
1107
1202
|
### languages (array of hashes, required)
|
1108
1203
|
#### language_iso (string)
|
1109
|
-
#### users (array) - list of users identifiers, assigned to work on the language
|
1110
|
-
### Find other supported options at https://lokalise.com/api2docs/curl/#transition-create-a-task-post
|
1204
|
+
#### users (array) - list of users identifiers, assigned to work on the language
|
1205
|
+
### Find other supported options at https://app.lokalise.com/api2docs/curl/#transition-create-a-task-post
|
1111
1206
|
# Output:
|
1112
|
-
## A newly created task
|
1207
|
+
## A newly created task
|
1113
1208
|
|
1114
1209
|
```
|
1115
1210
|
|
1116
1211
|
#### Update task
|
1117
1212
|
|
1118
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-task-put)
|
1213
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-task-put)
|
1119
1214
|
|
1120
1215
|
```ruby
|
1121
1216
|
@client.update_task(project_id, task_id, params = {}) # Input:
|
1122
1217
|
## project_id (string, required)
|
1123
|
-
## task_id (string or integer, required)
|
1218
|
+
## task_id (string or integer, required)
|
1124
1219
|
## params (hash)
|
1125
|
-
### Find supported params at https://lokalise.com/api2docs/curl/#transition-update-a-task-put
|
1220
|
+
### Find supported params at https://app.lokalise.com/api2docs/curl/#transition-update-a-task-put
|
1126
1221
|
# Output:
|
1127
|
-
## An updated task
|
1222
|
+
## An updated task
|
1128
1223
|
|
1129
1224
|
```
|
1130
1225
|
|
@@ -1137,12 +1232,12 @@ task.update(params)
|
|
1137
1232
|
|
1138
1233
|
#### Delete task
|
1139
1234
|
|
1140
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-task-delete)
|
1235
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-task-delete)
|
1141
1236
|
|
1142
1237
|
```ruby
|
1143
1238
|
@client.destroy_task(project_id, task_id) # Input:
|
1144
1239
|
## project_id (string, required)
|
1145
|
-
## task_id (string, required)
|
1240
|
+
## task_id (string, required)
|
1146
1241
|
# Output:
|
1147
1242
|
## Hash with the project id and "task_deleted" set to "true"
|
1148
1243
|
|
@@ -1159,7 +1254,7 @@ task.destroy
|
|
1159
1254
|
|
1160
1255
|
#### Fetch teams
|
1161
1256
|
|
1162
|
-
[Doc](https://lokalise.com/api2docs/curl/#resource-teams)
|
1257
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#resource-teams)
|
1163
1258
|
|
1164
1259
|
```ruby
|
1165
1260
|
@client.teams(params = {}) # Input:
|
@@ -1171,11 +1266,11 @@ task.destroy
|
|
1171
1266
|
|
1172
1267
|
### Team users
|
1173
1268
|
|
1174
|
-
[Team user attributes](https://lokalise.com/api2docs/curl/#object-team-users)
|
1269
|
+
[Team user attributes](https://app.lokalise.com/api2docs/curl/#object-team-users)
|
1175
1270
|
|
1176
1271
|
#### Fetch team users
|
1177
1272
|
|
1178
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-team-users-get)
|
1273
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-team-users-get)
|
1179
1274
|
|
1180
1275
|
```ruby
|
1181
1276
|
@client.team_users(team_id, params = {}) # Input:
|
@@ -1188,7 +1283,7 @@ task.destroy
|
|
1188
1283
|
|
1189
1284
|
#### Fetch a single team user
|
1190
1285
|
|
1191
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-team-user-get)
|
1286
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-team-user-get)
|
1192
1287
|
|
1193
1288
|
```ruby
|
1194
1289
|
@client.team_user(team_id, user_id) # Input:
|
@@ -1200,14 +1295,14 @@ task.destroy
|
|
1200
1295
|
|
1201
1296
|
#### Update team user
|
1202
1297
|
|
1203
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-team-user-put)
|
1298
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-team-user-put)
|
1204
1299
|
|
1205
1300
|
```ruby
|
1206
1301
|
@client.update_team_user(team_id, user_id, params) # Input:
|
1207
1302
|
## team_id (string, required)
|
1208
1303
|
## user_id (string, required)
|
1209
1304
|
## params (hash, required):
|
1210
|
-
### :role (string, required) - :owner, :admin, or :member
|
1305
|
+
### :role (string, required) - :owner, :admin, or :member
|
1211
1306
|
# Output:
|
1212
1307
|
## Updated team user
|
1213
1308
|
```
|
@@ -1221,7 +1316,7 @@ user.update(params)
|
|
1221
1316
|
|
1222
1317
|
#### Delete team user
|
1223
1318
|
|
1224
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-team-user-delete)
|
1319
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-team-user-delete)
|
1225
1320
|
|
1226
1321
|
```ruby
|
1227
1322
|
@client.destroy_team_user(team_id, user_id) # Input:
|
@@ -1240,11 +1335,11 @@ user.destroy
|
|
1240
1335
|
|
1241
1336
|
### Team user groups
|
1242
1337
|
|
1243
|
-
[Team user group attributes](https://lokalise.com/api2docs/curl/#object-team-user-groups)
|
1338
|
+
[Team user group attributes](https://app.lokalise.com/api2docs/curl/#object-team-user-groups)
|
1244
1339
|
|
1245
1340
|
#### Fetch team user groups
|
1246
1341
|
|
1247
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-groups-get)
|
1342
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-groups-get)
|
1248
1343
|
|
1249
1344
|
```ruby
|
1250
1345
|
@client.team_user_groups(team_id, params = {}) # Input:
|
@@ -1257,7 +1352,7 @@ user.destroy
|
|
1257
1352
|
|
1258
1353
|
#### Fetch a single group
|
1259
1354
|
|
1260
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-group-get)
|
1355
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-group-get)
|
1261
1356
|
|
1262
1357
|
```ruby
|
1263
1358
|
@client.team_user_group(team_id, group_id) # Input:
|
@@ -1269,7 +1364,7 @@ user.destroy
|
|
1269
1364
|
|
1270
1365
|
#### Create group
|
1271
1366
|
|
1272
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-a-group-post)
|
1367
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-a-group-post)
|
1273
1368
|
|
1274
1369
|
```ruby
|
1275
1370
|
@client.create_team_user_group(team_id, params) # Input:
|
@@ -1286,7 +1381,7 @@ user.destroy
|
|
1286
1381
|
|
1287
1382
|
#### Update group
|
1288
1383
|
|
1289
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-group-put)
|
1384
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-group-put)
|
1290
1385
|
|
1291
1386
|
```ruby
|
1292
1387
|
@client.update_team_user_group(team_id, group_id, params) # Input:
|
@@ -1311,7 +1406,7 @@ group.update(params)
|
|
1311
1406
|
|
1312
1407
|
#### Add projects to group
|
1313
1408
|
|
1314
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-add-projects-to-group-put)
|
1409
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-add-projects-to-group-put)
|
1315
1410
|
|
1316
1411
|
```ruby
|
1317
1412
|
@client.add_projects_to_group(team_id, group_id, project_ids) # Input:
|
@@ -1329,7 +1424,7 @@ group.add_projects projects: [project_id1, project_id2]
|
|
1329
1424
|
|
1330
1425
|
#### Remove projects from group
|
1331
1426
|
|
1332
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-remove-projects-from-group-put)
|
1427
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-remove-projects-from-group-put)
|
1333
1428
|
|
1334
1429
|
```ruby
|
1335
1430
|
@client.remove_projects_from_group(team_id, group_id, project_ids) # Input:
|
@@ -1347,7 +1442,7 @@ group.remove_projects projects: [project_id1, project_id2]
|
|
1347
1442
|
|
1348
1443
|
#### Add users (members) to group
|
1349
1444
|
|
1350
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-add-members-to-group-put)
|
1445
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-add-members-to-group-put)
|
1351
1446
|
|
1352
1447
|
```ruby
|
1353
1448
|
@client.add_users_to_group(team_id, group_id, user_ids) # Input:
|
@@ -1365,7 +1460,7 @@ group.add_users users: [user_id1, user_id2]
|
|
1365
1460
|
|
1366
1461
|
#### Remove users (members) from group
|
1367
1462
|
|
1368
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-remove-members-from-group-put)
|
1463
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-remove-members-from-group-put)
|
1369
1464
|
|
1370
1465
|
```ruby
|
1371
1466
|
@client.remove_users_from_group(team_id, group_id, user_ids) # Input:
|
@@ -1383,7 +1478,7 @@ group.remove_users users: [user_id1, user_id2]
|
|
1383
1478
|
|
1384
1479
|
#### Destroy group
|
1385
1480
|
|
1386
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-group-delete)
|
1481
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-group-delete)
|
1387
1482
|
|
1388
1483
|
```ruby
|
1389
1484
|
@client.destroy_team_user_group(team_id, group_id) # Input:
|
@@ -1402,11 +1497,11 @@ group.destroy
|
|
1402
1497
|
|
1403
1498
|
### Translations
|
1404
1499
|
|
1405
|
-
[Translation attributes](https://lokalise.com/api2docs/curl/#resource-translations)
|
1500
|
+
[Translation attributes](https://app.lokalise.com/api2docs/curl/#resource-translations)
|
1406
1501
|
|
1407
1502
|
#### Fetch translations
|
1408
1503
|
|
1409
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-translations-get)
|
1504
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-translations-get)
|
1410
1505
|
|
1411
1506
|
```ruby
|
1412
1507
|
@client.translations(project_id, params = {}) # Input:
|
@@ -1420,12 +1515,12 @@ group.destroy
|
|
1420
1515
|
|
1421
1516
|
#### Fetch a single translation
|
1422
1517
|
|
1423
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-translation-get)
|
1518
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-translation-get)
|
1424
1519
|
|
1425
1520
|
```ruby
|
1426
1521
|
@client.translation(project_id, translation_id, params = {}) # Input:
|
1427
1522
|
## project_id (string, required)
|
1428
|
-
## translation_id (string, required)
|
1523
|
+
## translation_id (string, required)
|
1429
1524
|
## params (hash)
|
1430
1525
|
### :disable_references (string) - whether to disable key references. Supported values are 0 and 1
|
1431
1526
|
# Output:
|
@@ -1434,16 +1529,16 @@ group.destroy
|
|
1434
1529
|
|
1435
1530
|
#### Update translation
|
1436
1531
|
|
1437
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-translation-put)
|
1532
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-translation-put)
|
1438
1533
|
|
1439
1534
|
```ruby
|
1440
1535
|
@client.update_translation(project_id, translation_id, params = {}) # Input:
|
1441
1536
|
## project_id (string, required)
|
1442
|
-
## translation_id (string, required)
|
1537
|
+
## translation_id (string, required)
|
1443
1538
|
## params (hash, required)
|
1444
1539
|
### :translation (string or hash, required) - the actual translation. Provide hash for plural keys.
|
1445
1540
|
### :is_fuzzy (boolean)
|
1446
|
-
### :is_reviewed (boolean)
|
1541
|
+
### :is_reviewed (boolean)
|
1447
1542
|
# Output:
|
1448
1543
|
## Updated translation
|
1449
1544
|
```
|
@@ -1457,11 +1552,11 @@ translation.update(params)
|
|
1457
1552
|
|
1458
1553
|
### Translation Providers
|
1459
1554
|
|
1460
|
-
[Translation provider attributes](https://lokalise.com/api2docs/curl/#object-translation-providers)
|
1555
|
+
[Translation provider attributes](https://app.lokalise.com/api2docs/curl/#object-translation-providers)
|
1461
1556
|
|
1462
1557
|
#### Fetch translation providers
|
1463
1558
|
|
1464
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-providers-get)
|
1559
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-providers-get)
|
1465
1560
|
|
1466
1561
|
```ruby
|
1467
1562
|
@client.translation_providers(team_id, params = {}) # Input:
|
@@ -1474,25 +1569,25 @@ translation.update(params)
|
|
1474
1569
|
|
1475
1570
|
#### Fetch a single translation provider
|
1476
1571
|
|
1477
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-provider-get)
|
1572
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-provider-get)
|
1478
1573
|
|
1479
1574
|
```ruby
|
1480
1575
|
@client.translation_provider(team_id, provider_id) # Input:
|
1481
1576
|
## team_id (string, required)
|
1482
|
-
## provider_id (string, required)
|
1577
|
+
## provider_id (string, required)
|
1483
1578
|
# Output:
|
1484
1579
|
## Single provider for the team
|
1485
1580
|
```
|
1486
1581
|
|
1487
1582
|
### Translation Statuses
|
1488
1583
|
|
1489
|
-
[Translation Status attributes](https://lokalise.com/api2docs/curl/#object-translation-statuses)
|
1584
|
+
[Translation Status attributes](https://app.lokalise.com/api2docs/curl/#object-translation-statuses)
|
1490
1585
|
|
1491
1586
|
*Custom translation statuses must be enabled for the project before using this endpoint!* It can be done in the project settings.
|
1492
1587
|
|
1493
1588
|
#### Fetch translation statuses
|
1494
1589
|
|
1495
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-custom-translation-statuses-get)
|
1590
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-custom-translation-statuses-get)
|
1496
1591
|
|
1497
1592
|
```ruby
|
1498
1593
|
@client.translation_statuses(project_id, params = {}) # Input:
|
@@ -1505,7 +1600,7 @@ translation.update(params)
|
|
1505
1600
|
|
1506
1601
|
#### Fetch a single translation status
|
1507
1602
|
|
1508
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-custom-translation-status-get)
|
1603
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-custom-translation-status-get)
|
1509
1604
|
|
1510
1605
|
```ruby
|
1511
1606
|
@client.translation_status(project_id, status_id) # Input:
|
@@ -1517,7 +1612,7 @@ translation.update(params)
|
|
1517
1612
|
|
1518
1613
|
#### Create translation status
|
1519
1614
|
|
1520
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-a-custom-translation-status-post)
|
1615
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-a-custom-translation-status-post)
|
1521
1616
|
|
1522
1617
|
```ruby
|
1523
1618
|
@client.create_translation_status(project_id, params) # Input:
|
@@ -1531,7 +1626,7 @@ translation.update(params)
|
|
1531
1626
|
|
1532
1627
|
#### Update translation status
|
1533
1628
|
|
1534
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-custom-translation-status-put)
|
1629
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-custom-translation-status-put)
|
1535
1630
|
|
1536
1631
|
```ruby
|
1537
1632
|
@client.update_translation_status(project_id, status_id, params) # Input:
|
@@ -1553,7 +1648,7 @@ status.update(params)
|
|
1553
1648
|
|
1554
1649
|
#### Delete translation status
|
1555
1650
|
|
1556
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-custom-translation-status-delete)
|
1651
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-custom-translation-status-delete)
|
1557
1652
|
|
1558
1653
|
```ruby
|
1559
1654
|
@client.destroy_translation_status(project_id, status_id) # Input:
|
@@ -1572,7 +1667,7 @@ status.destroy
|
|
1572
1667
|
|
1573
1668
|
#### Supported color codes for translation statuses
|
1574
1669
|
|
1575
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-available-colors-for-custom-translation-statuses-get)
|
1670
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-available-colors-for-custom-translation-statuses-get)
|
1576
1671
|
|
1577
1672
|
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.
|
1578
1673
|
|
@@ -1585,11 +1680,11 @@ As long as Lokalise supports only very limited array of color hexadecimal codes
|
|
1585
1680
|
|
1586
1681
|
### Webhooks
|
1587
1682
|
|
1588
|
-
[Webhook attributes](https://lokalise.com/api2docs/curl/#object-webhooks)
|
1683
|
+
[Webhook attributes](https://app.lokalise.com/api2docs/curl/#object-webhooks)
|
1589
1684
|
|
1590
1685
|
#### Fetch webhooks
|
1591
1686
|
|
1592
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-list-all-webhooks-get)
|
1687
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-list-all-webhooks-get)
|
1593
1688
|
|
1594
1689
|
```ruby
|
1595
1690
|
@client.webhooks(project_id, params = {}) # Input:
|
@@ -1602,19 +1697,19 @@ As long as Lokalise supports only very limited array of color hexadecimal codes
|
|
1602
1697
|
|
1603
1698
|
#### Fetch a single webhook
|
1604
1699
|
|
1605
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-retrieve-a-webhook-get)
|
1700
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-webhook-get)
|
1606
1701
|
|
1607
1702
|
```ruby
|
1608
1703
|
@client.webhook(project_id, webhook_id) # Input:
|
1609
1704
|
## project_id (string, required)
|
1610
|
-
## webhook_id (string
|
1705
|
+
## webhook_id (string, required)
|
1611
1706
|
# Output:
|
1612
1707
|
## Webhook for the given project
|
1613
1708
|
```
|
1614
1709
|
|
1615
1710
|
#### Create webhook
|
1616
1711
|
|
1617
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-create-a-webhook-post)
|
1712
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-create-a-webhook-post)
|
1618
1713
|
|
1619
1714
|
```ruby
|
1620
1715
|
@client.create_webhook(project_id, params) # Input:
|
@@ -1629,12 +1724,12 @@ As long as Lokalise supports only very limited array of color hexadecimal codes
|
|
1629
1724
|
|
1630
1725
|
#### Update webhook
|
1631
1726
|
|
1632
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-update-a-webhook-put)
|
1727
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-update-a-webhook-put)
|
1633
1728
|
|
1634
1729
|
```ruby
|
1635
1730
|
@client.update_webhook(project_id, webhook_id, params) # Input:
|
1636
1731
|
## project_id (string, required)
|
1637
|
-
## webhook_id (string
|
1732
|
+
## webhook_id (string, required)
|
1638
1733
|
## params (hash)
|
1639
1734
|
### :url (string) - webhook URL
|
1640
1735
|
### :events (array) - events to subscribe to. Check the API docs to find the list of supported events
|
@@ -1652,12 +1747,12 @@ webhook.update(params)
|
|
1652
1747
|
|
1653
1748
|
#### Delete webhook
|
1654
1749
|
|
1655
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-delete-a-webhook-delete)
|
1750
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-delete-a-webhook-delete)
|
1656
1751
|
|
1657
1752
|
```ruby
|
1658
1753
|
@client.destroy_webhook(project_id, webhook_id) # Input:
|
1659
1754
|
## project_id (string, required)
|
1660
|
-
## webhook_id (string
|
1755
|
+
## webhook_id (string, required)
|
1661
1756
|
# Output:
|
1662
1757
|
## Result of the delete operation
|
1663
1758
|
```
|
@@ -1671,12 +1766,12 @@ webhook.destroy
|
|
1671
1766
|
|
1672
1767
|
#### Regenerate webhook secret
|
1673
1768
|
|
1674
|
-
[Doc](https://lokalise.com/api2docs/curl/#transition-regenerate-a-webhook-secret-patch)
|
1769
|
+
[Doc](https://app.lokalise.com/api2docs/curl/#transition-regenerate-a-webhook-secret-patch)
|
1675
1770
|
|
1676
1771
|
```ruby
|
1677
1772
|
@client.regenerate_webhook_secret(project_id, webhook_id) # Input:
|
1678
1773
|
## project_id (string, required)
|
1679
|
-
## webhook_id (string
|
1774
|
+
## webhook_id (string, required)
|
1680
1775
|
# Output:
|
1681
1776
|
## Hash containing `project_id` and new `secret`
|
1682
1777
|
```
|
@@ -1735,7 +1830,7 @@ For example, to use [Oj](https://github.com/ohler55/oj) you would do the followi
|
|
1735
1830
|
require 'oj'
|
1736
1831
|
|
1737
1832
|
module Lokalise
|
1738
|
-
module JsonHandler
|
1833
|
+
module JsonHandler
|
1739
1834
|
# This method accepts a Ruby object and must return a JSON string
|
1740
1835
|
def custom_dump(obj)
|
1741
1836
|
Oj.dump obj
|
@@ -1751,7 +1846,7 @@ end
|
|
1751
1846
|
|
1752
1847
|
### Error handling
|
1753
1848
|
|
1754
|
-
[Error codes](https://lokalise.com/api2docs/curl/#resource-errors)
|
1849
|
+
[Error codes](https://app.lokalise.com/api2docs/curl/#resource-errors)
|
1755
1850
|
|
1756
1851
|
The gem may raise the following custom exceptions:
|
1757
1852
|
|
@@ -1771,7 +1866,7 @@ The gem may raise the following custom exceptions:
|
|
1771
1866
|
|
1772
1867
|
### API Rate Limits
|
1773
1868
|
|
1774
|
-
Lokalise does not [rate-limit API requests](https://lokalise.com/api2docs/curl/#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.
|
1869
|
+
Lokalise does not [rate-limit API requests](https://app.lokalise.com/api2docs/curl/#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.
|
1775
1870
|
|
1776
1871
|
## Running Tests
|
1777
1872
|
|