phrase 2.5.0 → 2.7.0
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/README.md +7 -11
- data/docs/AccountsApi.md +2 -8
- data/docs/AuthorizationsApi.md +5 -20
- data/docs/BitbucketSyncApi.md +3 -12
- data/docs/BlacklistedKeysApi.md +5 -20
- data/docs/BranchesApi.md +7 -28
- data/docs/CommentsApi.md +8 -32
- data/docs/DistributionsApi.md +5 -20
- data/docs/DocumentsApi.md +2 -8
- data/docs/FormatsApi.md +1 -4
- data/docs/GitHubSyncApi.md +2 -8
- data/docs/GitLabSyncApi.md +7 -28
- data/docs/GlossariesApi.md +5 -20
- data/docs/GlossaryTermTranslationsApi.md +3 -12
- data/docs/GlossaryTermsApi.md +5 -20
- data/docs/ICUApi.md +1 -4
- data/docs/IcuSkeletonParameters.md +2 -0
- data/docs/Invitation.md +3 -1
- data/docs/InvitationsApi.md +7 -28
- data/docs/JobCreateParameters.md +3 -1
- data/docs/JobLocalesApi.md +8 -32
- data/docs/JobTemplateLocalesApi.md +5 -20
- data/docs/JobTemplatesApi.md +5 -20
- data/docs/JobsApi.md +141 -44
- data/docs/KeyCreateParameters.md +2 -0
- data/docs/KeysApi.md +11 -44
- data/docs/LocalesApi.md +7 -28
- data/docs/Member.md +1 -1
- data/docs/MembersApi.md +5 -20
- data/docs/NotificationGroupsApi.md +3 -12
- data/docs/NotificationsApi.md +3 -12
- data/docs/OrdersApi.md +5 -20
- data/docs/ProjectLocales.md +2 -0
- data/docs/ProjectMemberSpecific.md +27 -0
- data/docs/ProjectsApi.md +5 -20
- data/docs/ReleasesApi.md +6 -24
- data/docs/ScreenshotMarkersApi.md +5 -20
- data/docs/ScreenshotsApi.md +5 -20
- data/docs/SearchApi.md +1 -4
- data/docs/SpacesApi.md +8 -32
- data/docs/StyleGuidesApi.md +5 -20
- data/docs/TagsApi.md +4 -16
- data/docs/{Team1.md → TeamShort.md} +2 -2
- data/docs/TeamsApi.md +11 -44
- data/docs/TranslationsApi.md +17 -68
- data/docs/UploadsApi.md +3 -12
- data/docs/UsersApi.md +1 -4
- data/docs/VariablesApi.md +5 -20
- data/docs/VersionsHistoryApi.md +2 -8
- data/docs/WebhooksApi.md +6 -24
- data/lib/phrase/api/accounts_api.rb +2 -2
- data/lib/phrase/api/authorizations_api.rb +5 -5
- data/lib/phrase/api/bitbucket_sync_api.rb +3 -3
- data/lib/phrase/api/blacklisted_keys_api.rb +5 -5
- data/lib/phrase/api/branches_api.rb +7 -7
- data/lib/phrase/api/comments_api.rb +8 -8
- data/lib/phrase/api/distributions_api.rb +5 -5
- data/lib/phrase/api/documents_api.rb +2 -2
- data/lib/phrase/api/formats_api.rb +1 -1
- data/lib/phrase/api/git_hub_sync_api.rb +2 -2
- data/lib/phrase/api/git_lab_sync_api.rb +7 -7
- data/lib/phrase/api/glossaries_api.rb +5 -5
- data/lib/phrase/api/glossary_term_translations_api.rb +3 -3
- data/lib/phrase/api/glossary_terms_api.rb +5 -5
- data/lib/phrase/api/icu_api.rb +1 -1
- data/lib/phrase/api/invitations_api.rb +7 -7
- data/lib/phrase/api/job_locales_api.rb +8 -8
- data/lib/phrase/api/job_template_locales_api.rb +5 -5
- data/lib/phrase/api/job_templates_api.rb +5 -5
- data/lib/phrase/api/jobs_api.rb +157 -11
- data/lib/phrase/api/keys_api.rb +11 -11
- data/lib/phrase/api/locales_api.rb +7 -7
- data/lib/phrase/api/members_api.rb +5 -5
- data/lib/phrase/api/notification_groups_api.rb +3 -3
- data/lib/phrase/api/notifications_api.rb +3 -3
- data/lib/phrase/api/orders_api.rb +5 -5
- data/lib/phrase/api/projects_api.rb +5 -5
- data/lib/phrase/api/releases_api.rb +6 -6
- data/lib/phrase/api/screenshot_markers_api.rb +5 -5
- data/lib/phrase/api/screenshots_api.rb +5 -5
- data/lib/phrase/api/search_api.rb +1 -1
- data/lib/phrase/api/spaces_api.rb +8 -8
- data/lib/phrase/api/style_guides_api.rb +5 -5
- data/lib/phrase/api/tags_api.rb +4 -4
- data/lib/phrase/api/teams_api.rb +11 -11
- data/lib/phrase/api/translations_api.rb +17 -17
- data/lib/phrase/api/uploads_api.rb +3 -3
- data/lib/phrase/api/users_api.rb +1 -1
- data/lib/phrase/api/variables_api.rb +5 -5
- data/lib/phrase/api/versions_history_api.rb +2 -2
- data/lib/phrase/api/webhooks_api.rb +6 -6
- data/lib/phrase/configuration.rb +0 -8
- data/lib/phrase/models/icu_skeleton_parameters.rb +11 -1
- data/lib/phrase/models/invitation.rb +13 -2
- data/lib/phrase/models/job_create_parameters.rb +14 -4
- data/lib/phrase/models/key_create_parameters.rb +11 -1
- data/lib/phrase/models/member.rb +1 -1
- data/lib/phrase/models/project_locales.rb +11 -2
- data/lib/phrase/models/project_member_specific.rb +239 -0
- data/lib/phrase/models/{team1.rb → team_short.rb} +3 -3
- data/lib/phrase/version.rb +1 -1
- data/lib/phrase.rb +2 -1
- data/spec/api/jobs_api_spec.rb +30 -0
- data/spec/models/icu_skeleton_parameters_spec.rb +6 -0
- data/spec/models/invitation_spec.rb +6 -0
- data/spec/models/job_create_parameters_spec.rb +6 -0
- data/spec/models/key_create_parameters_spec.rb +6 -0
- data/spec/models/project_locales_spec.rb +6 -0
- data/spec/models/project_member_specific_spec.rb +59 -0
- data/spec/models/{team1_spec.rb → team_short_spec.rb} +6 -6
- metadata +204 -200
data/docs/JobsApi.md
CHANGED
|
@@ -9,9 +9,11 @@ Method | HTTP request | Description
|
|
|
9
9
|
[**job_delete**](JobsApi.md#job_delete) | **DELETE** /projects/{project_id}/jobs/{id} | Delete a job
|
|
10
10
|
[**job_keys_create**](JobsApi.md#job_keys_create) | **POST** /projects/{project_id}/jobs/{id}/keys | Add keys to job
|
|
11
11
|
[**job_keys_delete**](JobsApi.md#job_keys_delete) | **DELETE** /projects/{project_id}/jobs/{id}/keys | Remove keys from job
|
|
12
|
+
[**job_lock**](JobsApi.md#job_lock) | **POST** /projects/{project_id}/jobs/{id}/lock | Lock a job
|
|
12
13
|
[**job_reopen**](JobsApi.md#job_reopen) | **POST** /projects/{project_id}/jobs/{id}/reopen | Reopen a job
|
|
13
14
|
[**job_show**](JobsApi.md#job_show) | **GET** /projects/{project_id}/jobs/{id} | Get a single job
|
|
14
15
|
[**job_start**](JobsApi.md#job_start) | **POST** /projects/{project_id}/jobs/{id}/start | Start a job
|
|
16
|
+
[**job_unlock**](JobsApi.md#job_unlock) | **POST** /projects/{project_id}/jobs/{id}/unlock | Unlock a job
|
|
15
17
|
[**job_update**](JobsApi.md#job_update) | **PATCH** /projects/{project_id}/jobs/{id} | Update a job
|
|
16
18
|
[**jobs_by_account**](JobsApi.md#jobs_by_account) | **GET** /accounts/{account_id}/jobs | List account jobs
|
|
17
19
|
[**jobs_list**](JobsApi.md#jobs_list) | **GET** /projects/{project_id}/jobs | List jobs
|
|
@@ -40,9 +42,6 @@ Phrase.configure do |config|
|
|
|
40
42
|
# Configure API key authorization: Token
|
|
41
43
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
42
44
|
config.api_key_prefix['Authorization'] = 'token'
|
|
43
|
-
|
|
44
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
45
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
46
45
|
end
|
|
47
46
|
|
|
48
47
|
api_instance = Phrase::JobsApi.new
|
|
@@ -78,7 +77,7 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
78
77
|
|
|
79
78
|
### Authorization
|
|
80
79
|
|
|
81
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
80
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
82
81
|
|
|
83
82
|
### HTTP request headers
|
|
84
83
|
|
|
@@ -108,9 +107,6 @@ Phrase.configure do |config|
|
|
|
108
107
|
# Configure API key authorization: Token
|
|
109
108
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
110
109
|
config.api_key_prefix['Authorization'] = 'token'
|
|
111
|
-
|
|
112
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
113
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
114
110
|
end
|
|
115
111
|
|
|
116
112
|
api_instance = Phrase::JobsApi.new
|
|
@@ -144,7 +140,7 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
144
140
|
|
|
145
141
|
### Authorization
|
|
146
142
|
|
|
147
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
143
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
148
144
|
|
|
149
145
|
### HTTP request headers
|
|
150
146
|
|
|
@@ -174,9 +170,6 @@ Phrase.configure do |config|
|
|
|
174
170
|
# Configure API key authorization: Token
|
|
175
171
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
176
172
|
config.api_key_prefix['Authorization'] = 'token'
|
|
177
|
-
|
|
178
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
179
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
180
173
|
end
|
|
181
174
|
|
|
182
175
|
api_instance = Phrase::JobsApi.new
|
|
@@ -211,7 +204,7 @@ Response<(nil (empty response body))>
|
|
|
211
204
|
|
|
212
205
|
### Authorization
|
|
213
206
|
|
|
214
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
207
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
215
208
|
|
|
216
209
|
### HTTP request headers
|
|
217
210
|
|
|
@@ -241,9 +234,6 @@ Phrase.configure do |config|
|
|
|
241
234
|
# Configure API key authorization: Token
|
|
242
235
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
243
236
|
config.api_key_prefix['Authorization'] = 'token'
|
|
244
|
-
|
|
245
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
246
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
247
237
|
end
|
|
248
238
|
|
|
249
239
|
api_instance = Phrase::JobsApi.new
|
|
@@ -279,7 +269,7 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
279
269
|
|
|
280
270
|
### Authorization
|
|
281
271
|
|
|
282
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
272
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
283
273
|
|
|
284
274
|
### HTTP request headers
|
|
285
275
|
|
|
@@ -309,9 +299,6 @@ Phrase.configure do |config|
|
|
|
309
299
|
# Configure API key authorization: Token
|
|
310
300
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
311
301
|
config.api_key_prefix['Authorization'] = 'token'
|
|
312
|
-
|
|
313
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
314
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
315
302
|
end
|
|
316
303
|
|
|
317
304
|
api_instance = Phrase::JobsApi.new
|
|
@@ -348,7 +335,71 @@ Response<(nil (empty response body))>
|
|
|
348
335
|
|
|
349
336
|
### Authorization
|
|
350
337
|
|
|
351
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
338
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
339
|
+
|
|
340
|
+
### HTTP request headers
|
|
341
|
+
|
|
342
|
+
- **Content-Type**: Not defined
|
|
343
|
+
- **Accept**: Not defined
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
## job_lock
|
|
347
|
+
|
|
348
|
+
> job_lock(project_id, id, opts)
|
|
349
|
+
|
|
350
|
+
Lock a job
|
|
351
|
+
|
|
352
|
+
If you are the job owner, you may lock a job using this API request.
|
|
353
|
+
|
|
354
|
+
### Example
|
|
355
|
+
|
|
356
|
+
```ruby
|
|
357
|
+
# load the gem
|
|
358
|
+
require 'phrase'
|
|
359
|
+
# setup authorization
|
|
360
|
+
Phrase.configure do |config|
|
|
361
|
+
# Configure HTTP basic authorization: Basic
|
|
362
|
+
config.username = 'YOUR USERNAME'
|
|
363
|
+
config.password = 'YOUR PASSWORD'
|
|
364
|
+
|
|
365
|
+
# Configure API key authorization: Token
|
|
366
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
367
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
368
|
+
end
|
|
369
|
+
|
|
370
|
+
api_instance = Phrase::JobsApi.new
|
|
371
|
+
project_id = 'project_id_example' # String | Project ID
|
|
372
|
+
id = 'id_example' # String | ID
|
|
373
|
+
opts = {
|
|
374
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
375
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
begin
|
|
379
|
+
#Lock a job
|
|
380
|
+
api_instance.job_lock(project_id, id, opts)
|
|
381
|
+
rescue Phrase::ApiError => e
|
|
382
|
+
puts "Exception when calling JobsApi->job_lock: #{e}"
|
|
383
|
+
end
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
### Parameters
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
Name | Type | Description | Notes
|
|
390
|
+
------------- | ------------- | ------------- | -------------
|
|
391
|
+
**project_id** | **String**| Project ID |
|
|
392
|
+
**id** | **String**| ID |
|
|
393
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
394
|
+
**branch** | **String**| specify the branch to use | [optional]
|
|
395
|
+
|
|
396
|
+
### Return type
|
|
397
|
+
|
|
398
|
+
Response<(nil (empty response body))>
|
|
399
|
+
|
|
400
|
+
### Authorization
|
|
401
|
+
|
|
402
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
352
403
|
|
|
353
404
|
### HTTP request headers
|
|
354
405
|
|
|
@@ -378,9 +429,6 @@ Phrase.configure do |config|
|
|
|
378
429
|
# Configure API key authorization: Token
|
|
379
430
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
380
431
|
config.api_key_prefix['Authorization'] = 'token'
|
|
381
|
-
|
|
382
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
383
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
384
432
|
end
|
|
385
433
|
|
|
386
434
|
api_instance = Phrase::JobsApi.new
|
|
@@ -416,7 +464,7 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
416
464
|
|
|
417
465
|
### Authorization
|
|
418
466
|
|
|
419
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
467
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
420
468
|
|
|
421
469
|
### HTTP request headers
|
|
422
470
|
|
|
@@ -446,9 +494,6 @@ Phrase.configure do |config|
|
|
|
446
494
|
# Configure API key authorization: Token
|
|
447
495
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
448
496
|
config.api_key_prefix['Authorization'] = 'token'
|
|
449
|
-
|
|
450
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
451
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
452
497
|
end
|
|
453
498
|
|
|
454
499
|
api_instance = Phrase::JobsApi.new
|
|
@@ -484,7 +529,7 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
484
529
|
|
|
485
530
|
### Authorization
|
|
486
531
|
|
|
487
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
532
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
488
533
|
|
|
489
534
|
### HTTP request headers
|
|
490
535
|
|
|
@@ -514,9 +559,6 @@ Phrase.configure do |config|
|
|
|
514
559
|
# Configure API key authorization: Token
|
|
515
560
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
516
561
|
config.api_key_prefix['Authorization'] = 'token'
|
|
517
|
-
|
|
518
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
519
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
520
562
|
end
|
|
521
563
|
|
|
522
564
|
api_instance = Phrase::JobsApi.new
|
|
@@ -552,7 +594,7 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
552
594
|
|
|
553
595
|
### Authorization
|
|
554
596
|
|
|
555
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
597
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
556
598
|
|
|
557
599
|
### HTTP request headers
|
|
558
600
|
|
|
@@ -560,6 +602,70 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
560
602
|
- **Accept**: application/json
|
|
561
603
|
|
|
562
604
|
|
|
605
|
+
## job_unlock
|
|
606
|
+
|
|
607
|
+
> job_unlock(project_id, id, opts)
|
|
608
|
+
|
|
609
|
+
Unlock a job
|
|
610
|
+
|
|
611
|
+
If you are the job owner, you may unlock a locked job using this API request.
|
|
612
|
+
|
|
613
|
+
### Example
|
|
614
|
+
|
|
615
|
+
```ruby
|
|
616
|
+
# load the gem
|
|
617
|
+
require 'phrase'
|
|
618
|
+
# setup authorization
|
|
619
|
+
Phrase.configure do |config|
|
|
620
|
+
# Configure HTTP basic authorization: Basic
|
|
621
|
+
config.username = 'YOUR USERNAME'
|
|
622
|
+
config.password = 'YOUR PASSWORD'
|
|
623
|
+
|
|
624
|
+
# Configure API key authorization: Token
|
|
625
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
626
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
627
|
+
end
|
|
628
|
+
|
|
629
|
+
api_instance = Phrase::JobsApi.new
|
|
630
|
+
project_id = 'project_id_example' # String | Project ID
|
|
631
|
+
id = 'id_example' # String | ID
|
|
632
|
+
opts = {
|
|
633
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
634
|
+
branch: 'my-feature-branch' # String | specify the branch to use
|
|
635
|
+
}
|
|
636
|
+
|
|
637
|
+
begin
|
|
638
|
+
#Unlock a job
|
|
639
|
+
api_instance.job_unlock(project_id, id, opts)
|
|
640
|
+
rescue Phrase::ApiError => e
|
|
641
|
+
puts "Exception when calling JobsApi->job_unlock: #{e}"
|
|
642
|
+
end
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
### Parameters
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
Name | Type | Description | Notes
|
|
649
|
+
------------- | ------------- | ------------- | -------------
|
|
650
|
+
**project_id** | **String**| Project ID |
|
|
651
|
+
**id** | **String**| ID |
|
|
652
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
653
|
+
**branch** | **String**| specify the branch to use | [optional]
|
|
654
|
+
|
|
655
|
+
### Return type
|
|
656
|
+
|
|
657
|
+
Response<(nil (empty response body))>
|
|
658
|
+
|
|
659
|
+
### Authorization
|
|
660
|
+
|
|
661
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
662
|
+
|
|
663
|
+
### HTTP request headers
|
|
664
|
+
|
|
665
|
+
- **Content-Type**: Not defined
|
|
666
|
+
- **Accept**: Not defined
|
|
667
|
+
|
|
668
|
+
|
|
563
669
|
## job_update
|
|
564
670
|
|
|
565
671
|
> JobDetails job_update(project_id, id, job_update_parameters, opts)
|
|
@@ -582,9 +688,6 @@ Phrase.configure do |config|
|
|
|
582
688
|
# Configure API key authorization: Token
|
|
583
689
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
584
690
|
config.api_key_prefix['Authorization'] = 'token'
|
|
585
|
-
|
|
586
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
587
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
588
691
|
end
|
|
589
692
|
|
|
590
693
|
api_instance = Phrase::JobsApi.new
|
|
@@ -620,7 +723,7 @@ Response<([**JobDetails**](JobDetails.md))>
|
|
|
620
723
|
|
|
621
724
|
### Authorization
|
|
622
725
|
|
|
623
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
726
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
624
727
|
|
|
625
728
|
### HTTP request headers
|
|
626
729
|
|
|
@@ -650,9 +753,6 @@ Phrase.configure do |config|
|
|
|
650
753
|
# Configure API key authorization: Token
|
|
651
754
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
652
755
|
config.api_key_prefix['Authorization'] = 'token'
|
|
653
|
-
|
|
654
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
655
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
656
756
|
end
|
|
657
757
|
|
|
658
758
|
api_instance = Phrase::JobsApi.new
|
|
@@ -694,7 +794,7 @@ Response<([**Array<Job>**](Job.md))>
|
|
|
694
794
|
|
|
695
795
|
### Authorization
|
|
696
796
|
|
|
697
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
797
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
698
798
|
|
|
699
799
|
### HTTP request headers
|
|
700
800
|
|
|
@@ -724,9 +824,6 @@ Phrase.configure do |config|
|
|
|
724
824
|
# Configure API key authorization: Token
|
|
725
825
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
726
826
|
config.api_key_prefix['Authorization'] = 'token'
|
|
727
|
-
|
|
728
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
729
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
730
827
|
end
|
|
731
828
|
|
|
732
829
|
api_instance = Phrase::JobsApi.new
|
|
@@ -770,7 +867,7 @@ Response<([**Array<Job>**](Job.md))>
|
|
|
770
867
|
|
|
771
868
|
### Authorization
|
|
772
869
|
|
|
773
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
870
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
774
871
|
|
|
775
872
|
### HTTP request headers
|
|
776
873
|
|
data/docs/KeyCreateParameters.md
CHANGED
|
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**screenshot** | **File** | Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
|
|
16
16
|
**remove_screenshot** | **Boolean** | Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
|
|
17
17
|
**unformatted** | **Boolean** | Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats. | [optional]
|
|
18
|
+
**default_translation_content** | **String** | Creates a translation in the default locale with the specified content | [optional]
|
|
18
19
|
**xml_space_preserve** | **Boolean** | Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats. | [optional]
|
|
19
20
|
**original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
|
|
20
21
|
**localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
|
|
@@ -36,6 +37,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
|
|
|
36
37
|
screenshot: null,
|
|
37
38
|
remove_screenshot: null,
|
|
38
39
|
unformatted: null,
|
|
40
|
+
default_translation_content: Default translation content,
|
|
39
41
|
xml_space_preserve: null,
|
|
40
42
|
original_file: null,
|
|
41
43
|
localized_format_string: null,
|
data/docs/KeysApi.md
CHANGED
|
@@ -40,9 +40,6 @@ Phrase.configure do |config|
|
|
|
40
40
|
# Configure API key authorization: Token
|
|
41
41
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
42
42
|
config.api_key_prefix['Authorization'] = 'token'
|
|
43
|
-
|
|
44
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
45
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
46
43
|
end
|
|
47
44
|
|
|
48
45
|
api_instance = Phrase::KeysApi.new
|
|
@@ -76,7 +73,7 @@ Response<([**TranslationKeyDetails**](TranslationKeyDetails.md))>
|
|
|
76
73
|
|
|
77
74
|
### Authorization
|
|
78
75
|
|
|
79
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
76
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
80
77
|
|
|
81
78
|
### HTTP request headers
|
|
82
79
|
|
|
@@ -106,9 +103,6 @@ Phrase.configure do |config|
|
|
|
106
103
|
# Configure API key authorization: Token
|
|
107
104
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
108
105
|
config.api_key_prefix['Authorization'] = 'token'
|
|
109
|
-
|
|
110
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
111
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
112
106
|
end
|
|
113
107
|
|
|
114
108
|
api_instance = Phrase::KeysApi.new
|
|
@@ -143,7 +137,7 @@ Response<(nil (empty response body))>
|
|
|
143
137
|
|
|
144
138
|
### Authorization
|
|
145
139
|
|
|
146
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
140
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
147
141
|
|
|
148
142
|
### HTTP request headers
|
|
149
143
|
|
|
@@ -173,9 +167,6 @@ Phrase.configure do |config|
|
|
|
173
167
|
# Configure API key authorization: Token
|
|
174
168
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
175
169
|
config.api_key_prefix['Authorization'] = 'token'
|
|
176
|
-
|
|
177
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
178
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
179
170
|
end
|
|
180
171
|
|
|
181
172
|
api_instance = Phrase::KeysApi.new
|
|
@@ -211,7 +202,7 @@ Response<([**TranslationKeyDetails**](TranslationKeyDetails.md))>
|
|
|
211
202
|
|
|
212
203
|
### Authorization
|
|
213
204
|
|
|
214
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
205
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
215
206
|
|
|
216
207
|
### HTTP request headers
|
|
217
208
|
|
|
@@ -241,9 +232,6 @@ Phrase.configure do |config|
|
|
|
241
232
|
# Configure API key authorization: Token
|
|
242
233
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
243
234
|
config.api_key_prefix['Authorization'] = 'token'
|
|
244
|
-
|
|
245
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
246
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
247
235
|
end
|
|
248
236
|
|
|
249
237
|
api_instance = Phrase::KeysApi.new
|
|
@@ -279,7 +267,7 @@ Response<([**TranslationKeyDetails**](TranslationKeyDetails.md))>
|
|
|
279
267
|
|
|
280
268
|
### Authorization
|
|
281
269
|
|
|
282
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
270
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
283
271
|
|
|
284
272
|
### HTTP request headers
|
|
285
273
|
|
|
@@ -309,9 +297,6 @@ Phrase.configure do |config|
|
|
|
309
297
|
# Configure API key authorization: Token
|
|
310
298
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
311
299
|
config.api_key_prefix['Authorization'] = 'token'
|
|
312
|
-
|
|
313
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
314
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
315
300
|
end
|
|
316
301
|
|
|
317
302
|
api_instance = Phrase::KeysApi.new
|
|
@@ -349,7 +334,7 @@ Response<([**AffectedResources**](AffectedResources.md))>
|
|
|
349
334
|
|
|
350
335
|
### Authorization
|
|
351
336
|
|
|
352
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
337
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
353
338
|
|
|
354
339
|
### HTTP request headers
|
|
355
340
|
|
|
@@ -379,9 +364,6 @@ Phrase.configure do |config|
|
|
|
379
364
|
# Configure API key authorization: Token
|
|
380
365
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
381
366
|
config.api_key_prefix['Authorization'] = 'token'
|
|
382
|
-
|
|
383
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
384
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
385
367
|
end
|
|
386
368
|
|
|
387
369
|
api_instance = Phrase::KeysApi.new
|
|
@@ -415,7 +397,7 @@ Response<([**AffectedResources**](AffectedResources.md))>
|
|
|
415
397
|
|
|
416
398
|
### Authorization
|
|
417
399
|
|
|
418
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
400
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
419
401
|
|
|
420
402
|
### HTTP request headers
|
|
421
403
|
|
|
@@ -445,9 +427,6 @@ Phrase.configure do |config|
|
|
|
445
427
|
# Configure API key authorization: Token
|
|
446
428
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
447
429
|
config.api_key_prefix['Authorization'] = 'token'
|
|
448
|
-
|
|
449
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
450
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
451
430
|
end
|
|
452
431
|
|
|
453
432
|
api_instance = Phrase::KeysApi.new
|
|
@@ -481,7 +460,7 @@ Response<([**AffectedResources**](AffectedResources.md))>
|
|
|
481
460
|
|
|
482
461
|
### Authorization
|
|
483
462
|
|
|
484
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
463
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
485
464
|
|
|
486
465
|
### HTTP request headers
|
|
487
466
|
|
|
@@ -511,9 +490,6 @@ Phrase.configure do |config|
|
|
|
511
490
|
# Configure API key authorization: Token
|
|
512
491
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
513
492
|
config.api_key_prefix['Authorization'] = 'token'
|
|
514
|
-
|
|
515
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
516
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
517
493
|
end
|
|
518
494
|
|
|
519
495
|
api_instance = Phrase::KeysApi.new
|
|
@@ -559,7 +535,7 @@ Response<([**Array<TranslationKey>**](TranslationKey.md))>
|
|
|
559
535
|
|
|
560
536
|
### Authorization
|
|
561
537
|
|
|
562
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
538
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
563
539
|
|
|
564
540
|
### HTTP request headers
|
|
565
541
|
|
|
@@ -589,9 +565,6 @@ Phrase.configure do |config|
|
|
|
589
565
|
# Configure API key authorization: Token
|
|
590
566
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
591
567
|
config.api_key_prefix['Authorization'] = 'token'
|
|
592
|
-
|
|
593
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
594
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
595
568
|
end
|
|
596
569
|
|
|
597
570
|
api_instance = Phrase::KeysApi.new
|
|
@@ -629,7 +602,7 @@ Response<([**Array<TranslationKey>**](TranslationKey.md))>
|
|
|
629
602
|
|
|
630
603
|
### Authorization
|
|
631
604
|
|
|
632
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
605
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
633
606
|
|
|
634
607
|
### HTTP request headers
|
|
635
608
|
|
|
@@ -659,9 +632,6 @@ Phrase.configure do |config|
|
|
|
659
632
|
# Configure API key authorization: Token
|
|
660
633
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
661
634
|
config.api_key_prefix['Authorization'] = 'token'
|
|
662
|
-
|
|
663
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
664
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
665
635
|
end
|
|
666
636
|
|
|
667
637
|
api_instance = Phrase::KeysApi.new
|
|
@@ -695,7 +665,7 @@ Response<([**AffectedResources**](AffectedResources.md))>
|
|
|
695
665
|
|
|
696
666
|
### Authorization
|
|
697
667
|
|
|
698
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
668
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
699
669
|
|
|
700
670
|
### HTTP request headers
|
|
701
671
|
|
|
@@ -725,9 +695,6 @@ Phrase.configure do |config|
|
|
|
725
695
|
# Configure API key authorization: Token
|
|
726
696
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
727
697
|
config.api_key_prefix['Authorization'] = 'token'
|
|
728
|
-
|
|
729
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
730
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
731
698
|
end
|
|
732
699
|
|
|
733
700
|
api_instance = Phrase::KeysApi.new
|
|
@@ -761,7 +728,7 @@ Response<([**AffectedResources**](AffectedResources.md))>
|
|
|
761
728
|
|
|
762
729
|
### Authorization
|
|
763
730
|
|
|
764
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
731
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
765
732
|
|
|
766
733
|
### HTTP request headers
|
|
767
734
|
|
data/docs/LocalesApi.md
CHANGED
|
@@ -36,9 +36,6 @@ Phrase.configure do |config|
|
|
|
36
36
|
# Configure API key authorization: Token
|
|
37
37
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
38
38
|
config.api_key_prefix['Authorization'] = 'token'
|
|
39
|
-
|
|
40
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
41
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
42
39
|
end
|
|
43
40
|
|
|
44
41
|
api_instance = Phrase::LocalesApi.new
|
|
@@ -74,7 +71,7 @@ Response<([**Array<LocalePreview1>**](LocalePreview1.md))>
|
|
|
74
71
|
|
|
75
72
|
### Authorization
|
|
76
73
|
|
|
77
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
74
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
78
75
|
|
|
79
76
|
### HTTP request headers
|
|
80
77
|
|
|
@@ -104,9 +101,6 @@ Phrase.configure do |config|
|
|
|
104
101
|
# Configure API key authorization: Token
|
|
105
102
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
106
103
|
config.api_key_prefix['Authorization'] = 'token'
|
|
107
|
-
|
|
108
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
109
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
110
104
|
end
|
|
111
105
|
|
|
112
106
|
api_instance = Phrase::LocalesApi.new
|
|
@@ -140,7 +134,7 @@ Response<([**LocaleDetails**](LocaleDetails.md))>
|
|
|
140
134
|
|
|
141
135
|
### Authorization
|
|
142
136
|
|
|
143
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
137
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
144
138
|
|
|
145
139
|
### HTTP request headers
|
|
146
140
|
|
|
@@ -170,9 +164,6 @@ Phrase.configure do |config|
|
|
|
170
164
|
# Configure API key authorization: Token
|
|
171
165
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
172
166
|
config.api_key_prefix['Authorization'] = 'token'
|
|
173
|
-
|
|
174
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
175
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
176
167
|
end
|
|
177
168
|
|
|
178
169
|
api_instance = Phrase::LocalesApi.new
|
|
@@ -207,7 +198,7 @@ Response<(nil (empty response body))>
|
|
|
207
198
|
|
|
208
199
|
### Authorization
|
|
209
200
|
|
|
210
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
201
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
211
202
|
|
|
212
203
|
### HTTP request headers
|
|
213
204
|
|
|
@@ -237,9 +228,6 @@ Phrase.configure do |config|
|
|
|
237
228
|
# Configure API key authorization: Token
|
|
238
229
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
239
230
|
config.api_key_prefix['Authorization'] = 'token'
|
|
240
|
-
|
|
241
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
242
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
243
231
|
end
|
|
244
232
|
|
|
245
233
|
api_instance = Phrase::LocalesApi.new
|
|
@@ -305,7 +293,7 @@ Response<(**File**)>
|
|
|
305
293
|
|
|
306
294
|
### Authorization
|
|
307
295
|
|
|
308
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
296
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
309
297
|
|
|
310
298
|
### HTTP request headers
|
|
311
299
|
|
|
@@ -335,9 +323,6 @@ Phrase.configure do |config|
|
|
|
335
323
|
# Configure API key authorization: Token
|
|
336
324
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
337
325
|
config.api_key_prefix['Authorization'] = 'token'
|
|
338
|
-
|
|
339
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
340
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
341
326
|
end
|
|
342
327
|
|
|
343
328
|
api_instance = Phrase::LocalesApi.new
|
|
@@ -373,7 +358,7 @@ Response<([**LocaleDetails**](LocaleDetails.md))>
|
|
|
373
358
|
|
|
374
359
|
### Authorization
|
|
375
360
|
|
|
376
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
361
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
377
362
|
|
|
378
363
|
### HTTP request headers
|
|
379
364
|
|
|
@@ -403,9 +388,6 @@ Phrase.configure do |config|
|
|
|
403
388
|
# Configure API key authorization: Token
|
|
404
389
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
405
390
|
config.api_key_prefix['Authorization'] = 'token'
|
|
406
|
-
|
|
407
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
408
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
409
391
|
end
|
|
410
392
|
|
|
411
393
|
api_instance = Phrase::LocalesApi.new
|
|
@@ -441,7 +423,7 @@ Response<([**LocaleDetails**](LocaleDetails.md))>
|
|
|
441
423
|
|
|
442
424
|
### Authorization
|
|
443
425
|
|
|
444
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
426
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
445
427
|
|
|
446
428
|
### HTTP request headers
|
|
447
429
|
|
|
@@ -471,9 +453,6 @@ Phrase.configure do |config|
|
|
|
471
453
|
# Configure API key authorization: Token
|
|
472
454
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
473
455
|
config.api_key_prefix['Authorization'] = 'token'
|
|
474
|
-
|
|
475
|
-
# Configure Bearer authorization (JWT): bearerAuth
|
|
476
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
477
456
|
end
|
|
478
457
|
|
|
479
458
|
api_instance = Phrase::LocalesApi.new
|
|
@@ -513,7 +492,7 @@ Response<([**Array<Locale>**](Locale.md))>
|
|
|
513
492
|
|
|
514
493
|
### Authorization
|
|
515
494
|
|
|
516
|
-
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
495
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
517
496
|
|
|
518
497
|
### HTTP request headers
|
|
519
498
|
|