phrase 1.0.1 → 1.0.2

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.
Files changed (135) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +50 -387
  3. data/docs/AccountsApi.md +2 -4
  4. data/docs/AuthorizationsApi.md +10 -14
  5. data/docs/BitbucketSyncApi.md +3 -6
  6. data/docs/BlacklistedKeysApi.md +10 -14
  7. data/docs/BranchesApi.md +12 -18
  8. data/docs/CommentsApi.md +13 -20
  9. data/docs/DistributionsApi.md +10 -14
  10. data/docs/FormatsApi.md +1 -2
  11. data/docs/GitLabSyncApi.md +7 -14
  12. data/docs/{GlossaryApi.md → GlossariesApi.md} +26 -30
  13. data/docs/GlossaryTermTranslationsApi.md +8 -10
  14. data/docs/GlossaryTermsApi.md +10 -14
  15. data/docs/InvitationsApi.md +11 -16
  16. data/docs/JobLocalesApi.md +12 -18
  17. data/docs/JobsApi.md +15 -24
  18. data/docs/KeysApi.md +18 -26
  19. data/docs/KeysSearchParameters.md +1 -1
  20. data/docs/KeysTagParameters.md +1 -1
  21. data/docs/KeysUntagParameters.md +1 -1
  22. data/docs/LocalesApi.md +13 -18
  23. data/docs/MembersApi.md +4 -8
  24. data/docs/OrdersApi.md +10 -14
  25. data/docs/ProjectCreateParameters.md +3 -1
  26. data/docs/ProjectsApi.md +10 -14
  27. data/docs/ReleasesApi.md +11 -16
  28. data/docs/ScreenshotMarkersApi.md +10 -14
  29. data/docs/ScreenshotsApi.md +10 -14
  30. data/docs/SpacesApi.md +13 -20
  31. data/docs/StyleGuidesApi.md +10 -14
  32. data/docs/TagsApi.md +9 -12
  33. data/docs/Team.md +29 -0
  34. data/docs/TeamCreateParameters.md +17 -0
  35. data/docs/TeamDetail.md +29 -0
  36. data/docs/TeamUpdateParameters.md +17 -0
  37. data/docs/TeamsApi.md +721 -0
  38. data/docs/TeamsProjectsCreateParameters.md +17 -0
  39. data/docs/TeamsSpacesCreateParameters.md +17 -0
  40. data/docs/TeamsUsersCreateParameters.md +17 -0
  41. data/docs/TranslationsApi.md +28 -44
  42. data/docs/TranslationsExcludeParameters.md +1 -1
  43. data/docs/TranslationsIncludeParameters.md +1 -1
  44. data/docs/TranslationsReviewParameters.md +1 -1
  45. data/docs/TranslationsSearchParameters.md +1 -1
  46. data/docs/TranslationsUnverifyParameters.md +1 -1
  47. data/docs/TranslationsVerifyParameters.md +1 -1
  48. data/docs/UploadCreateParameters.md +2 -2
  49. data/docs/UploadsApi.md +12 -10
  50. data/docs/UsersApi.md +1 -2
  51. data/docs/VersionsHistoryApi.md +2 -4
  52. data/docs/WebhooksApi.md +11 -16
  53. data/git_push.sh +2 -2
  54. data/lib/phrase.rb +9 -1
  55. data/lib/phrase/api/authorizations_api.rb +10 -8
  56. data/lib/phrase/api/bitbucket_sync_api.rb +3 -3
  57. data/lib/phrase/api/blacklisted_keys_api.rb +10 -8
  58. data/lib/phrase/api/branches_api.rb +16 -14
  59. data/lib/phrase/api/comments_api.rb +19 -17
  60. data/lib/phrase/api/distributions_api.rb +10 -8
  61. data/lib/phrase/api/git_lab_sync_api.rb +3 -3
  62. data/lib/phrase/api/{glossary_api.rb → glossaries_api.rb} +31 -29
  63. data/lib/phrase/api/glossary_term_translations_api.rb +10 -8
  64. data/lib/phrase/api/glossary_terms_api.rb +10 -8
  65. data/lib/phrase/api/invitations_api.rb +10 -8
  66. data/lib/phrase/api/job_locales_api.rb +10 -8
  67. data/lib/phrase/api/jobs_api.rb +13 -11
  68. data/lib/phrase/api/keys_api.rb +14 -12
  69. data/lib/phrase/api/locales_api.rb +15 -13
  70. data/lib/phrase/api/members_api.rb +3 -3
  71. data/lib/phrase/api/orders_api.rb +10 -8
  72. data/lib/phrase/api/projects_api.rb +10 -8
  73. data/lib/phrase/api/releases_api.rb +10 -8
  74. data/lib/phrase/api/screenshot_markers_api.rb +10 -8
  75. data/lib/phrase/api/screenshots_api.rb +10 -8
  76. data/lib/phrase/api/spaces_api.rb +16 -14
  77. data/lib/phrase/api/style_guides_api.rb +10 -8
  78. data/lib/phrase/api/tags_api.rb +10 -8
  79. data/lib/phrase/api/teams_api.rb +840 -0
  80. data/lib/phrase/api/translations_api.rb +13 -11
  81. data/lib/phrase/api/uploads_api.rb +13 -5
  82. data/lib/phrase/api/webhooks_api.rb +13 -11
  83. data/lib/phrase/models/keys_search_parameters.rb +1 -1
  84. data/lib/phrase/models/keys_tag_parameters.rb +1 -1
  85. data/lib/phrase/models/keys_untag_parameters.rb +1 -1
  86. data/lib/phrase/models/project_create_parameters.rb +14 -4
  87. data/lib/phrase/models/team.rb +254 -0
  88. data/lib/phrase/models/team_create_parameters.rb +195 -0
  89. data/lib/phrase/models/team_detail.rb +254 -0
  90. data/lib/phrase/models/team_update_parameters.rb +195 -0
  91. data/lib/phrase/models/teams_projects_create_parameters.rb +195 -0
  92. data/lib/phrase/models/teams_spaces_create_parameters.rb +195 -0
  93. data/lib/phrase/models/teams_users_create_parameters.rb +195 -0
  94. data/lib/phrase/models/translations_exclude_parameters.rb +1 -1
  95. data/lib/phrase/models/translations_include_parameters.rb +1 -1
  96. data/lib/phrase/models/translations_review_parameters.rb +1 -1
  97. data/lib/phrase/models/translations_search_parameters.rb +1 -1
  98. data/lib/phrase/models/translations_unverify_parameters.rb +1 -1
  99. data/lib/phrase/models/translations_verify_parameters.rb +1 -1
  100. data/lib/phrase/models/upload_create_parameters.rb +4 -8
  101. data/lib/phrase/version.rb +1 -1
  102. data/spec/api/authorizations_api_spec.rb +1 -1
  103. data/spec/api/blacklisted_keys_api_spec.rb +1 -1
  104. data/spec/api/branches_api_spec.rb +1 -1
  105. data/spec/api/comments_api_spec.rb +1 -1
  106. data/spec/api/distributions_api_spec.rb +1 -1
  107. data/spec/api/{glossary_api_spec.rb → glossaries_api_spec.rb} +7 -7
  108. data/spec/api/glossary_term_translations_api_spec.rb +1 -1
  109. data/spec/api/glossary_terms_api_spec.rb +1 -1
  110. data/spec/api/invitations_api_spec.rb +1 -1
  111. data/spec/api/job_locales_api_spec.rb +1 -1
  112. data/spec/api/jobs_api_spec.rb +1 -1
  113. data/spec/api/keys_api_spec.rb +3 -3
  114. data/spec/api/locales_api_spec.rb +2 -2
  115. data/spec/api/orders_api_spec.rb +1 -1
  116. data/spec/api/projects_api_spec.rb +1 -1
  117. data/spec/api/releases_api_spec.rb +1 -1
  118. data/spec/api/screenshot_markers_api_spec.rb +1 -1
  119. data/spec/api/screenshots_api_spec.rb +1 -1
  120. data/spec/api/spaces_api_spec.rb +1 -1
  121. data/spec/api/style_guides_api_spec.rb +1 -1
  122. data/spec/api/tags_api_spec.rb +1 -1
  123. data/spec/api/teams_api_spec.rb +185 -0
  124. data/spec/api/translations_api_spec.rb +4 -4
  125. data/spec/api/uploads_api_spec.rb +3 -1
  126. data/spec/api/webhooks_api_spec.rb +1 -1
  127. data/spec/models/project_create_parameters_spec.rb +6 -0
  128. data/spec/models/team_create_parameters_spec.rb +29 -0
  129. data/spec/models/team_detail_spec.rb +65 -0
  130. data/spec/models/team_spec.rb +65 -0
  131. data/spec/models/team_update_parameters_spec.rb +29 -0
  132. data/spec/models/teams_projects_create_parameters_spec.rb +29 -0
  133. data/spec/models/teams_spaces_create_parameters_spec.rb +29 -0
  134. data/spec/models/teams_users_create_parameters_spec.rb +29 -0
  135. metadata +183 -151
@@ -35,8 +35,7 @@ Phrase.configure do |config|
35
35
 
36
36
  # Configure API key authorization: Token
37
37
  config.api_key['Authorization'] = 'YOUR API KEY'
38
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
- #config.api_key_prefix['Authorization'] = 'Bearer'
38
+ config.api_key_prefix['Authorization'] = 'token'
40
39
  end
41
40
 
42
41
  api_instance = Phrase::JobLocalesApi.new
@@ -103,8 +102,7 @@ Phrase.configure do |config|
103
102
 
104
103
  # Configure API key authorization: Token
105
104
  config.api_key['Authorization'] = 'YOUR API KEY'
106
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
107
- #config.api_key_prefix['Authorization'] = 'Bearer'
105
+ config.api_key_prefix['Authorization'] = 'token'
108
106
  end
109
107
 
110
108
  api_instance = Phrase::JobLocalesApi.new
@@ -170,8 +168,7 @@ Phrase.configure do |config|
170
168
 
171
169
  # Configure API key authorization: Token
172
170
  config.api_key['Authorization'] = 'YOUR API KEY'
173
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
174
- #config.api_key_prefix['Authorization'] = 'Bearer'
171
+ config.api_key_prefix['Authorization'] = 'token'
175
172
  end
176
173
 
177
174
  api_instance = Phrase::JobLocalesApi.new
@@ -238,8 +235,7 @@ Phrase.configure do |config|
238
235
 
239
236
  # Configure API key authorization: Token
240
237
  config.api_key['Authorization'] = 'YOUR API KEY'
241
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
242
- #config.api_key_prefix['Authorization'] = 'Bearer'
238
+ config.api_key_prefix['Authorization'] = 'token'
243
239
  end
244
240
 
245
241
  api_instance = Phrase::JobLocalesApi.new
@@ -306,8 +302,7 @@ Phrase.configure do |config|
306
302
 
307
303
  # Configure API key authorization: Token
308
304
  config.api_key['Authorization'] = 'YOUR API KEY'
309
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
310
- #config.api_key_prefix['Authorization'] = 'Bearer'
305
+ config.api_key_prefix['Authorization'] = 'token'
311
306
  end
312
307
 
313
308
  api_instance = Phrase::JobLocalesApi.new
@@ -355,7 +350,7 @@ Response<([**JobLocale**](JobLocale.md))>
355
350
 
356
351
  ## job_locales_create
357
352
 
358
- > job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
353
+ > JobLocale job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
359
354
 
360
355
  Create a job locale
361
356
 
@@ -374,8 +369,7 @@ Phrase.configure do |config|
374
369
 
375
370
  # Configure API key authorization: Token
376
371
  config.api_key['Authorization'] = 'YOUR API KEY'
377
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
378
- #config.api_key_prefix['Authorization'] = 'Bearer'
372
+ config.api_key_prefix['Authorization'] = 'token'
379
373
  end
380
374
 
381
375
  api_instance = Phrase::JobLocalesApi.new
@@ -388,7 +382,8 @@ opts = {
388
382
 
389
383
  begin
390
384
  #Create a job locale
391
- api_instance.job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
385
+ result = api_instance.job_locales_create(project_id, job_id, job_locales_create_parameters, opts)
386
+ pp result
392
387
  rescue Phrase::ApiError => e
393
388
  puts "Exception when calling JobLocalesApi->job_locales_create: #{e}"
394
389
  end
@@ -406,7 +401,7 @@ Name | Type | Description | Notes
406
401
 
407
402
  ### Return type
408
403
 
409
- Response<(nil (empty response body))>
404
+ Response<([**JobLocale**](JobLocale.md))>
410
405
 
411
406
  ### Authorization
412
407
 
@@ -415,7 +410,7 @@ Response<(nil (empty response body))>
415
410
  ### HTTP request headers
416
411
 
417
412
  - **Content-Type**: application/json
418
- - **Accept**: Not defined
413
+ - **Accept**: application/json
419
414
 
420
415
 
421
416
  ## job_locales_list
@@ -439,8 +434,7 @@ Phrase.configure do |config|
439
434
 
440
435
  # Configure API key authorization: Token
441
436
  config.api_key['Authorization'] = 'YOUR API KEY'
442
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
443
- #config.api_key_prefix['Authorization'] = 'Bearer'
437
+ config.api_key_prefix['Authorization'] = 'token'
444
438
  end
445
439
 
446
440
  api_instance = Phrase::JobLocalesApi.new
@@ -38,8 +38,7 @@ Phrase.configure do |config|
38
38
 
39
39
  # Configure API key authorization: Token
40
40
  config.api_key['Authorization'] = 'YOUR API KEY'
41
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
42
- #config.api_key_prefix['Authorization'] = 'Bearer'
41
+ config.api_key_prefix['Authorization'] = 'token'
43
42
  end
44
43
 
45
44
  api_instance = Phrase::JobsApi.new
@@ -85,7 +84,7 @@ Response<([**JobDetails**](JobDetails.md))>
85
84
 
86
85
  ## job_create
87
86
 
88
- > job_create(project_id, job_create_parameters, opts)
87
+ > JobDetails job_create(project_id, job_create_parameters, opts)
89
88
 
90
89
  Create a job
91
90
 
@@ -104,8 +103,7 @@ Phrase.configure do |config|
104
103
 
105
104
  # Configure API key authorization: Token
106
105
  config.api_key['Authorization'] = 'YOUR API KEY'
107
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
108
- #config.api_key_prefix['Authorization'] = 'Bearer'
106
+ config.api_key_prefix['Authorization'] = 'token'
109
107
  end
110
108
 
111
109
  api_instance = Phrase::JobsApi.new
@@ -117,7 +115,8 @@ opts = {
117
115
 
118
116
  begin
119
117
  #Create a job
120
- api_instance.job_create(project_id, job_create_parameters, opts)
118
+ result = api_instance.job_create(project_id, job_create_parameters, opts)
119
+ pp result
121
120
  rescue Phrase::ApiError => e
122
121
  puts "Exception when calling JobsApi->job_create: #{e}"
123
122
  end
@@ -134,7 +133,7 @@ Name | Type | Description | Notes
134
133
 
135
134
  ### Return type
136
135
 
137
- Response<(nil (empty response body))>
136
+ Response<([**JobDetails**](JobDetails.md))>
138
137
 
139
138
  ### Authorization
140
139
 
@@ -143,7 +142,7 @@ Response<(nil (empty response body))>
143
142
  ### HTTP request headers
144
143
 
145
144
  - **Content-Type**: application/json
146
- - **Accept**: Not defined
145
+ - **Accept**: application/json
147
146
 
148
147
 
149
148
  ## job_delete
@@ -167,8 +166,7 @@ Phrase.configure do |config|
167
166
 
168
167
  # Configure API key authorization: Token
169
168
  config.api_key['Authorization'] = 'YOUR API KEY'
170
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
171
- #config.api_key_prefix['Authorization'] = 'Bearer'
169
+ config.api_key_prefix['Authorization'] = 'token'
172
170
  end
173
171
 
174
172
  api_instance = Phrase::JobsApi.new
@@ -232,8 +230,7 @@ Phrase.configure do |config|
232
230
 
233
231
  # Configure API key authorization: Token
234
232
  config.api_key['Authorization'] = 'YOUR API KEY'
235
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
236
- #config.api_key_prefix['Authorization'] = 'Bearer'
233
+ config.api_key_prefix['Authorization'] = 'token'
237
234
  end
238
235
 
239
236
  api_instance = Phrase::JobsApi.new
@@ -298,8 +295,7 @@ Phrase.configure do |config|
298
295
 
299
296
  # Configure API key authorization: Token
300
297
  config.api_key['Authorization'] = 'YOUR API KEY'
301
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
302
- #config.api_key_prefix['Authorization'] = 'Bearer'
298
+ config.api_key_prefix['Authorization'] = 'token'
303
299
  end
304
300
 
305
301
  api_instance = Phrase::JobsApi.new
@@ -365,8 +361,7 @@ Phrase.configure do |config|
365
361
 
366
362
  # Configure API key authorization: Token
367
363
  config.api_key['Authorization'] = 'YOUR API KEY'
368
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
369
- #config.api_key_prefix['Authorization'] = 'Bearer'
364
+ config.api_key_prefix['Authorization'] = 'token'
370
365
  end
371
366
 
372
367
  api_instance = Phrase::JobsApi.new
@@ -431,8 +426,7 @@ Phrase.configure do |config|
431
426
 
432
427
  # Configure API key authorization: Token
433
428
  config.api_key['Authorization'] = 'YOUR API KEY'
434
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
435
- #config.api_key_prefix['Authorization'] = 'Bearer'
429
+ config.api_key_prefix['Authorization'] = 'token'
436
430
  end
437
431
 
438
432
  api_instance = Phrase::JobsApi.new
@@ -497,8 +491,7 @@ Phrase.configure do |config|
497
491
 
498
492
  # Configure API key authorization: Token
499
493
  config.api_key['Authorization'] = 'YOUR API KEY'
500
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
501
- #config.api_key_prefix['Authorization'] = 'Bearer'
494
+ config.api_key_prefix['Authorization'] = 'token'
502
495
  end
503
496
 
504
497
  api_instance = Phrase::JobsApi.new
@@ -563,8 +556,7 @@ Phrase.configure do |config|
563
556
 
564
557
  # Configure API key authorization: Token
565
558
  config.api_key['Authorization'] = 'YOUR API KEY'
566
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
567
- #config.api_key_prefix['Authorization'] = 'Bearer'
559
+ config.api_key_prefix['Authorization'] = 'token'
568
560
  end
569
561
 
570
562
  api_instance = Phrase::JobsApi.new
@@ -629,8 +621,7 @@ Phrase.configure do |config|
629
621
 
630
622
  # Configure API key authorization: Token
631
623
  config.api_key['Authorization'] = 'YOUR API KEY'
632
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
633
- #config.api_key_prefix['Authorization'] = 'Bearer'
624
+ config.api_key_prefix['Authorization'] = 'token'
634
625
  end
635
626
 
636
627
  api_instance = Phrase::JobsApi.new
@@ -18,7 +18,7 @@ Method | HTTP request | Description
18
18
 
19
19
  ## key_create
20
20
 
21
- > key_create(project_id, key_create_parameters, opts)
21
+ > TranslationKeyDetails key_create(project_id, key_create_parameters, opts)
22
22
 
23
23
  Create a key
24
24
 
@@ -37,8 +37,7 @@ Phrase.configure do |config|
37
37
 
38
38
  # Configure API key authorization: Token
39
39
  config.api_key['Authorization'] = 'YOUR API KEY'
40
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
41
- #config.api_key_prefix['Authorization'] = 'Bearer'
40
+ config.api_key_prefix['Authorization'] = 'token'
42
41
  end
43
42
 
44
43
  api_instance = Phrase::KeysApi.new
@@ -50,7 +49,8 @@ opts = {
50
49
 
51
50
  begin
52
51
  #Create a key
53
- api_instance.key_create(project_id, key_create_parameters, opts)
52
+ result = api_instance.key_create(project_id, key_create_parameters, opts)
53
+ pp result
54
54
  rescue Phrase::ApiError => e
55
55
  puts "Exception when calling KeysApi->key_create: #{e}"
56
56
  end
@@ -67,7 +67,7 @@ Name | Type | Description | Notes
67
67
 
68
68
  ### Return type
69
69
 
70
- Response<(nil (empty response body))>
70
+ Response<([**TranslationKeyDetails**](TranslationKeyDetails.md))>
71
71
 
72
72
  ### Authorization
73
73
 
@@ -76,7 +76,7 @@ Response<(nil (empty response body))>
76
76
  ### HTTP request headers
77
77
 
78
78
  - **Content-Type**: application/json
79
- - **Accept**: Not defined
79
+ - **Accept**: application/json
80
80
 
81
81
 
82
82
  ## key_delete
@@ -100,8 +100,7 @@ Phrase.configure do |config|
100
100
 
101
101
  # Configure API key authorization: Token
102
102
  config.api_key['Authorization'] = 'YOUR API KEY'
103
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
104
- #config.api_key_prefix['Authorization'] = 'Bearer'
103
+ config.api_key_prefix['Authorization'] = 'token'
105
104
  end
106
105
 
107
106
  api_instance = Phrase::KeysApi.new
@@ -165,8 +164,7 @@ Phrase.configure do |config|
165
164
 
166
165
  # Configure API key authorization: Token
167
166
  config.api_key['Authorization'] = 'YOUR API KEY'
168
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
169
- #config.api_key_prefix['Authorization'] = 'Bearer'
167
+ config.api_key_prefix['Authorization'] = 'token'
170
168
  end
171
169
 
172
170
  api_instance = Phrase::KeysApi.new
@@ -231,8 +229,7 @@ Phrase.configure do |config|
231
229
 
232
230
  # Configure API key authorization: Token
233
231
  config.api_key['Authorization'] = 'YOUR API KEY'
234
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
235
- #config.api_key_prefix['Authorization'] = 'Bearer'
232
+ config.api_key_prefix['Authorization'] = 'token'
236
233
  end
237
234
 
238
235
  api_instance = Phrase::KeysApi.new
@@ -297,8 +294,7 @@ Phrase.configure do |config|
297
294
 
298
295
  # Configure API key authorization: Token
299
296
  config.api_key['Authorization'] = 'YOUR API KEY'
300
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
301
- #config.api_key_prefix['Authorization'] = 'Bearer'
297
+ config.api_key_prefix['Authorization'] = 'token'
302
298
  end
303
299
 
304
300
  api_instance = Phrase::KeysApi.new
@@ -306,7 +302,7 @@ project_id = 'project_id_example' # String | Project ID
306
302
  opts = {
307
303
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
308
304
  branch: 'my-feature-branch', # String | specify the branch to use
309
- q: 'mykey* translated:true', # String | q_description_placeholder
305
+ q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
310
306
  locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
311
307
  }
312
308
 
@@ -327,7 +323,7 @@ Name | Type | Description | Notes
327
323
  **project_id** | **String**| Project ID |
328
324
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
329
325
  **branch** | **String**| specify the branch to use | [optional]
330
- **q** | **String**| q_description_placeholder | [optional]
326
+ **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\&quot;\\\\\\\&quot;)&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
331
327
  **locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
332
328
 
333
329
  ### Return type
@@ -365,8 +361,7 @@ Phrase.configure do |config|
365
361
 
366
362
  # Configure API key authorization: Token
367
363
  config.api_key['Authorization'] = 'YOUR API KEY'
368
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
369
- #config.api_key_prefix['Authorization'] = 'Bearer'
364
+ config.api_key_prefix['Authorization'] = 'token'
370
365
  end
371
366
 
372
367
  api_instance = Phrase::KeysApi.new
@@ -378,7 +373,7 @@ opts = {
378
373
  branch: 'my-feature-branch', # String | specify the branch to use
379
374
  sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
380
375
  order: 'desc', # String | Order direction. Can be one of: asc, desc.
381
- q: 'mykey* translated:true', # String | q_description_placeholder
376
+ q: 'mykey* translated:true', # String | Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\"\\\\\\\")</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
382
377
  locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
383
378
  }
384
379
 
@@ -403,7 +398,7 @@ Name | Type | Description | Notes
403
398
  **branch** | **String**| specify the branch to use | [optional]
404
399
  **sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
405
400
  **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
406
- **q** | **String**| q_description_placeholder | [optional]
401
+ **q** | **String**| Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\&quot;\\\\\\\&quot;)&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
407
402
  **locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
408
403
 
409
404
  ### Return type
@@ -441,8 +436,7 @@ Phrase.configure do |config|
441
436
 
442
437
  # Configure API key authorization: Token
443
438
  config.api_key['Authorization'] = 'YOUR API KEY'
444
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
445
- #config.api_key_prefix['Authorization'] = 'Bearer'
439
+ config.api_key_prefix['Authorization'] = 'token'
446
440
  end
447
441
 
448
442
  api_instance = Phrase::KeysApi.new
@@ -509,8 +503,7 @@ Phrase.configure do |config|
509
503
 
510
504
  # Configure API key authorization: Token
511
505
  config.api_key['Authorization'] = 'YOUR API KEY'
512
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
513
- #config.api_key_prefix['Authorization'] = 'Bearer'
506
+ config.api_key_prefix['Authorization'] = 'token'
514
507
  end
515
508
 
516
509
  api_instance = Phrase::KeysApi.new
@@ -573,8 +566,7 @@ Phrase.configure do |config|
573
566
 
574
567
  # Configure API key authorization: Token
575
568
  config.api_key['Authorization'] = 'YOUR API KEY'
576
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
577
- #config.api_key_prefix['Authorization'] = 'Bearer'
569
+ config.api_key_prefix['Authorization'] = 'token'
578
570
  end
579
571
 
580
572
  api_instance = Phrase::KeysApi.new
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
8
  **sort** | **String** | Sort by field. Can be one of: name, created_at, updated_at. | [optional]
9
9
  **order** | **String** | Order direction. Can be one of: asc, desc. | [optional]
10
- **q** | **String** | q_description_placeholder | [optional]
10
+ **q** | **String** | Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\&quot;\\\\\\\&quot;)&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
11
11
  **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
12
12
 
13
13
  ## Code Sample
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
- **q** | **String** | q_description_placeholder | [optional]
8
+ **q** | **String** | Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\&quot;\\\\\\\&quot;)&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
9
9
  **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
10
10
  **tags** | **String** | Tag or comma-separated list of tags to add to the matching collection of keys | [optional]
11
11
 
@@ -5,7 +5,7 @@
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
- **q** | **String** | q_description_placeholder | [optional]
8
+ **q** | **String** | Specify a query to do broad search for keys by name (including wildcards).&lt;br&gt;&lt;br&gt; The following qualifiers are also supported in the search term:&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;ids:key_id,...&lt;/code&gt; for queries on a comma-separated list of ids&lt;/li&gt; &lt;li&gt;&lt;code&gt;name:key_name&lt;/code&gt; for text queries on exact key names - whitespaces need to be prefixed with a backspace (\\\&quot;\\\\\\\&quot;)&lt;/li&gt; &lt;li&gt;&lt;code&gt;tags:tag_name&lt;/code&gt; to filter for keys with certain tags&lt;/li&gt; &lt;li&gt;&lt;code&gt;translated:{true|false}&lt;/code&gt; for translation status (also requires &lt;code&gt;locale_id&lt;/code&gt; to be specified)&lt;/li&gt; &lt;li&gt;&lt;code&gt;updated_at:{&gt;&#x3D;|&lt;&#x3D;}2013-02-21T00:00:00Z&lt;/code&gt; for date range queries&lt;/li&gt; &lt;li&gt;&lt;code&gt;unmentioned_in_upload:upload_id&lt;/code&gt; to filter keys unmentioned within upload&lt;/li&gt; &lt;/ul&gt; Find more examples &lt;a href&#x3D;\&quot;#overview--usage-examples\&quot;&gt;here&lt;/a&gt;. | [optional]
9
9
  **locale_id** | **String** | Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
10
10
  **tags** | **String** | Tag or comma-separated list of tags to remove from the matching collection of keys | [optional]
11
11
 
@@ -15,7 +15,7 @@ Method | HTTP request | Description
15
15
 
16
16
  ## locale_create
17
17
 
18
- > locale_create(project_id, locale_create_parameters, opts)
18
+ > LocaleDetails locale_create(project_id, locale_create_parameters, opts)
19
19
 
20
20
  Create a locale
21
21
 
@@ -34,8 +34,7 @@ Phrase.configure do |config|
34
34
 
35
35
  # Configure API key authorization: Token
36
36
  config.api_key['Authorization'] = 'YOUR API KEY'
37
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
- #config.api_key_prefix['Authorization'] = 'Bearer'
37
+ config.api_key_prefix['Authorization'] = 'token'
39
38
  end
40
39
 
41
40
  api_instance = Phrase::LocalesApi.new
@@ -47,7 +46,8 @@ opts = {
47
46
 
48
47
  begin
49
48
  #Create a locale
50
- api_instance.locale_create(project_id, locale_create_parameters, opts)
49
+ result = api_instance.locale_create(project_id, locale_create_parameters, opts)
50
+ pp result
51
51
  rescue Phrase::ApiError => e
52
52
  puts "Exception when calling LocalesApi->locale_create: #{e}"
53
53
  end
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
64
64
 
65
65
  ### Return type
66
66
 
67
- Response<(nil (empty response body))>
67
+ Response<([**LocaleDetails**](LocaleDetails.md))>
68
68
 
69
69
  ### Authorization
70
70
 
@@ -73,7 +73,7 @@ Response<(nil (empty response body))>
73
73
  ### HTTP request headers
74
74
 
75
75
  - **Content-Type**: application/json
76
- - **Accept**: Not defined
76
+ - **Accept**: application/json
77
77
 
78
78
 
79
79
  ## locale_delete
@@ -97,8 +97,7 @@ Phrase.configure do |config|
97
97
 
98
98
  # Configure API key authorization: Token
99
99
  config.api_key['Authorization'] = 'YOUR API KEY'
100
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
- #config.api_key_prefix['Authorization'] = 'Bearer'
100
+ config.api_key_prefix['Authorization'] = 'token'
102
101
  end
103
102
 
104
103
  api_instance = Phrase::LocalesApi.new
@@ -162,8 +161,7 @@ Phrase.configure do |config|
162
161
 
163
162
  # Configure API key authorization: Token
164
163
  config.api_key['Authorization'] = 'YOUR API KEY'
165
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
166
- #config.api_key_prefix['Authorization'] = 'Bearer'
164
+ config.api_key_prefix['Authorization'] = 'token'
167
165
  end
168
166
 
169
167
  api_instance = Phrase::LocalesApi.new
@@ -179,7 +177,7 @@ opts = {
179
177
  include_translated_keys: true, # Boolean | Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
180
178
  keep_notranslate_tags: true, # Boolean | Indicates whether [NOTRANSLATE] tags should be kept.
181
179
  convert_emoji: true, # Boolean | This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
182
- format_options: {'key' => 'format_options_example'}, # Hash<String, String> | Additional formatting and render options. See the <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
180
+ format_options: nil, # Object | Additional formatting and render options. See the <a href=\"https://help.phrase.com/help/supported-platforms-and-formats\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
183
181
  encoding: 'encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
184
182
  skip_unverified_translations: true, # Boolean | Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
185
183
  include_unverified_translations: true, # Boolean | if set to false unverified translations are excluded
@@ -211,7 +209,7 @@ Name | Type | Description | Notes
211
209
  **include_translated_keys** | **Boolean**| Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | [optional]
212
210
  **keep_notranslate_tags** | **Boolean**| Indicates whether [NOTRANSLATE] tags should be kept. | [optional]
213
211
  **convert_emoji** | **Boolean**| This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. | [optional]
214
- **format_options** | [**Hash&lt;String, String&gt;**](String.md)| Additional formatting and render options. See the &lt;a href&#x3D;\&quot;https://help.phrase.com/help/supported-platforms-and-formats\&quot;&gt;format guide&lt;/a&gt; for a list of options available for each format. Specify format options like this: &lt;code&gt;...&amp;format_options[foo]&#x3D;bar&lt;/code&gt; | [optional]
212
+ **format_options** | [**Object**](.md)| Additional formatting and render options. See the &lt;a href&#x3D;\&quot;https://help.phrase.com/help/supported-platforms-and-formats\&quot;&gt;format guide&lt;/a&gt; for a list of options available for each format. Specify format options like this: &lt;code&gt;...&amp;format_options[foo]&#x3D;bar&lt;/code&gt; | [optional]
215
213
  **encoding** | **String**| Enforces a specific encoding on the file contents. Valid options are \&quot;UTF-8\&quot;, \&quot;UTF-16\&quot; and \&quot;ISO-8859-1\&quot;. | [optional]
216
214
  **skip_unverified_translations** | **Boolean**| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with &lt;code&gt;include_unverified_translations&lt;/code&gt;. | [optional]
217
215
  **include_unverified_translations** | **Boolean**| if set to false unverified translations are excluded | [optional]
@@ -253,8 +251,7 @@ Phrase.configure do |config|
253
251
 
254
252
  # Configure API key authorization: Token
255
253
  config.api_key['Authorization'] = 'YOUR API KEY'
256
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
257
- #config.api_key_prefix['Authorization'] = 'Bearer'
254
+ config.api_key_prefix['Authorization'] = 'token'
258
255
  end
259
256
 
260
257
  api_instance = Phrase::LocalesApi.new
@@ -319,8 +316,7 @@ Phrase.configure do |config|
319
316
 
320
317
  # Configure API key authorization: Token
321
318
  config.api_key['Authorization'] = 'YOUR API KEY'
322
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
323
- #config.api_key_prefix['Authorization'] = 'Bearer'
319
+ config.api_key_prefix['Authorization'] = 'token'
324
320
  end
325
321
 
326
322
  api_instance = Phrase::LocalesApi.new
@@ -385,8 +381,7 @@ Phrase.configure do |config|
385
381
 
386
382
  # Configure API key authorization: Token
387
383
  config.api_key['Authorization'] = 'YOUR API KEY'
388
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
389
- #config.api_key_prefix['Authorization'] = 'Bearer'
384
+ config.api_key_prefix['Authorization'] = 'token'
390
385
  end
391
386
 
392
387
  api_instance = Phrase::LocalesApi.new