phrase 2.2.0 → 2.5.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.
Files changed (144) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -3
  3. data/docs/AccountsApi.md +8 -2
  4. data/docs/AuthorizationsApi.md +20 -5
  5. data/docs/BitbucketSyncApi.md +12 -3
  6. data/docs/BlacklistedKeysApi.md +20 -5
  7. data/docs/BranchesApi.md +28 -7
  8. data/docs/CommentsApi.md +32 -8
  9. data/docs/Distribution.md +2 -0
  10. data/docs/DistributionCreateParameters.md +2 -0
  11. data/docs/DistributionUpdateParameters.md +2 -0
  12. data/docs/DistributionsApi.md +20 -5
  13. data/docs/DocumentsApi.md +8 -2
  14. data/docs/FormatsApi.md +4 -1
  15. data/docs/GitHubSyncApi.md +8 -2
  16. data/docs/GitLabSyncApi.md +28 -7
  17. data/docs/GlossariesApi.md +20 -5
  18. data/docs/GlossaryTermTranslationsApi.md +12 -3
  19. data/docs/GlossaryTermsApi.md +20 -5
  20. data/docs/ICUApi.md +73 -0
  21. data/docs/Icu.md +17 -0
  22. data/docs/IcuSkeletonParameters.md +21 -0
  23. data/docs/InvitationCreateParameters.md +2 -0
  24. data/docs/InvitationUpdateParameters.md +2 -0
  25. data/docs/InvitationsApi.md +28 -7
  26. data/docs/JobLocaleCompleteReviewParameters.md +17 -0
  27. data/docs/JobLocaleUpdateParameters.md +3 -1
  28. data/docs/JobLocalesApi.md +99 -7
  29. data/docs/JobLocalesCreateParameters.md +4 -2
  30. data/docs/JobTemplateLocalesApi.md +20 -5
  31. data/docs/JobTemplatesApi.md +20 -5
  32. data/docs/JobsApi.md +44 -11
  33. data/docs/KeysApi.md +44 -11
  34. data/docs/LocalesApi.md +35 -10
  35. data/docs/Member.md +6 -0
  36. data/docs/MembersApi.md +20 -5
  37. data/docs/NotificationGroupsApi.md +12 -3
  38. data/docs/NotificationsApi.md +12 -3
  39. data/docs/OrdersApi.md +20 -5
  40. data/docs/Project.md +2 -0
  41. data/docs/ProjectDetails.md +2 -0
  42. data/docs/ProjectsApi.md +20 -5
  43. data/docs/ReleaseCreateParameters.md +2 -0
  44. data/docs/ReleasesApi.md +24 -6
  45. data/docs/ScreenshotMarkersApi.md +20 -5
  46. data/docs/ScreenshotsApi.md +20 -5
  47. data/docs/SearchApi.md +4 -1
  48. data/docs/SpacesApi.md +32 -8
  49. data/docs/StyleGuidesApi.md +20 -5
  50. data/docs/TagsApi.md +16 -4
  51. data/docs/Team1.md +23 -0
  52. data/docs/TeamsApi.md +44 -11
  53. data/docs/TranslationsApi.md +68 -17
  54. data/docs/TranslationsVerifyParameters.md +3 -5
  55. data/docs/UploadsApi.md +12 -3
  56. data/docs/UserPreview.md +3 -1
  57. data/docs/UsersApi.md +4 -1
  58. data/docs/VariablesApi.md +20 -5
  59. data/docs/VersionsHistoryApi.md +8 -2
  60. data/docs/WebhooksApi.md +24 -6
  61. data/lib/phrase/api/accounts_api.rb +2 -2
  62. data/lib/phrase/api/authorizations_api.rb +5 -5
  63. data/lib/phrase/api/bitbucket_sync_api.rb +3 -3
  64. data/lib/phrase/api/blacklisted_keys_api.rb +5 -5
  65. data/lib/phrase/api/branches_api.rb +7 -7
  66. data/lib/phrase/api/comments_api.rb +8 -8
  67. data/lib/phrase/api/distributions_api.rb +5 -5
  68. data/lib/phrase/api/documents_api.rb +2 -2
  69. data/lib/phrase/api/formats_api.rb +1 -1
  70. data/lib/phrase/api/git_hub_sync_api.rb +2 -2
  71. data/lib/phrase/api/git_lab_sync_api.rb +7 -7
  72. data/lib/phrase/api/glossaries_api.rb +5 -5
  73. data/lib/phrase/api/glossary_term_translations_api.rb +3 -3
  74. data/lib/phrase/api/glossary_terms_api.rb +5 -5
  75. data/lib/phrase/api/icu_api.rb +78 -0
  76. data/lib/phrase/api/invitations_api.rb +7 -7
  77. data/lib/phrase/api/job_locales_api.rb +93 -7
  78. data/lib/phrase/api/job_template_locales_api.rb +5 -5
  79. data/lib/phrase/api/job_templates_api.rb +5 -5
  80. data/lib/phrase/api/jobs_api.rb +11 -11
  81. data/lib/phrase/api/keys_api.rb +11 -11
  82. data/lib/phrase/api/locales_api.rb +20 -11
  83. data/lib/phrase/api/members_api.rb +5 -5
  84. data/lib/phrase/api/notification_groups_api.rb +3 -3
  85. data/lib/phrase/api/notifications_api.rb +3 -3
  86. data/lib/phrase/api/orders_api.rb +5 -5
  87. data/lib/phrase/api/projects_api.rb +5 -5
  88. data/lib/phrase/api/releases_api.rb +6 -6
  89. data/lib/phrase/api/screenshot_markers_api.rb +5 -5
  90. data/lib/phrase/api/screenshots_api.rb +5 -5
  91. data/lib/phrase/api/search_api.rb +1 -1
  92. data/lib/phrase/api/spaces_api.rb +8 -8
  93. data/lib/phrase/api/style_guides_api.rb +5 -5
  94. data/lib/phrase/api/tags_api.rb +4 -4
  95. data/lib/phrase/api/teams_api.rb +11 -11
  96. data/lib/phrase/api/translations_api.rb +17 -17
  97. data/lib/phrase/api/uploads_api.rb +3 -3
  98. data/lib/phrase/api/users_api.rb +1 -1
  99. data/lib/phrase/api/variables_api.rb +5 -5
  100. data/lib/phrase/api/versions_history_api.rb +2 -2
  101. data/lib/phrase/api/webhooks_api.rb +6 -6
  102. data/lib/phrase/configuration.rb +8 -0
  103. data/lib/phrase/models/distribution.rb +12 -1
  104. data/lib/phrase/models/distribution_create_parameters.rb +13 -1
  105. data/lib/phrase/models/distribution_update_parameters.rb +13 -1
  106. data/lib/phrase/models/icu.rb +195 -0
  107. data/lib/phrase/models/icu_skeleton_parameters.rb +217 -0
  108. data/lib/phrase/models/invitation_create_parameters.rb +13 -1
  109. data/lib/phrase/models/invitation_update_parameters.rb +13 -1
  110. data/lib/phrase/models/job_locale_complete_review_parameters.rb +195 -0
  111. data/lib/phrase/models/job_locale_update_parameters.rb +16 -4
  112. data/lib/phrase/models/job_locales_create_parameters.rb +17 -5
  113. data/lib/phrase/models/member.rb +30 -1
  114. data/lib/phrase/models/project.rb +10 -1
  115. data/lib/phrase/models/project_details.rb +10 -1
  116. data/lib/phrase/models/release_create_parameters.rb +13 -1
  117. data/lib/phrase/models/team1.rb +221 -0
  118. data/lib/phrase/models/translations_verify_parameters.rb +14 -24
  119. data/lib/phrase/models/user_preview.rb +13 -4
  120. data/lib/phrase/response.rb +1 -1
  121. data/lib/phrase/version.rb +1 -1
  122. data/lib/phrase.rb +5 -0
  123. data/phrase.gemspec +2 -2
  124. data/spec/api/icu_api_spec.rb +36 -0
  125. data/spec/api/job_locales_api_spec.rb +16 -0
  126. data/spec/api/locales_api_spec.rb +2 -0
  127. data/spec/models/distribution_create_parameters_spec.rb +6 -0
  128. data/spec/models/distribution_spec.rb +6 -0
  129. data/spec/models/distribution_update_parameters_spec.rb +6 -0
  130. data/spec/models/icu_skeleton_parameters_spec.rb +41 -0
  131. data/spec/models/icu_spec.rb +29 -0
  132. data/spec/models/invitation_create_parameters_spec.rb +6 -0
  133. data/spec/models/invitation_update_parameters_spec.rb +6 -0
  134. data/spec/models/job_locale_complete_review_parameters_spec.rb +29 -0
  135. data/spec/models/job_locale_update_parameters_spec.rb +6 -0
  136. data/spec/models/job_locales_create_parameters_spec.rb +6 -0
  137. data/spec/models/member_spec.rb +18 -0
  138. data/spec/models/project_details_spec.rb +6 -0
  139. data/spec/models/project_spec.rb +6 -0
  140. data/spec/models/release_create_parameters_spec.rb +6 -0
  141. data/spec/models/team1_spec.rb +47 -0
  142. data/spec/models/translations_verify_parameters_spec.rb +2 -8
  143. data/spec/models/user_preview_spec.rb +6 -0
  144. metadata +214 -194
data/docs/IcuSkeletonParameters.md ADDED
@@ -0,0 +1,21 @@
1
+ # Phrase::IcuSkeletonParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **content** | **String** | Source content | [optional]
8
+ **locale_codes** | **Array<String>** | Locale codes | [optional]
9
+ **zero_form_enabled** | **Boolean** | Indicates whether the zero form should be included or excluded in the returned skeletons | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Phrase'
15
+
16
+ instance = Phrase::IcuSkeletonParameters.new(content: {number, plural, one {One} other {%{n}}},
17
+ locale_codes: ["en"],
18
+ zero_form_enabled: null)
19
+ ```
20
+
21
+
data/docs/InvitationCreateParameters.md CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **project_ids** | **String** | List of project ids the invited user has access to. | [optional]
10
10
  **locale_ids** | **String** | List of locale ids the invited user has access to. | [optional]
11
11
  **space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
12
+ **team_ids** | **Array<String>** | List of teams the user is assigned to. | [optional]
12
13
  **default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
13
14
  **permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. Available permissions are <code>create_upload</code> and <code>review_translations</code> | [optional]
14
15
 
@@ -22,6 +23,7 @@ instance = Phrase::InvitationCreateParameters.new(email: example@mail.com,
22
23
  project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
23
24
  locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
24
25
  space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
26
+ team_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
25
27
  default_locale_codes: ["en","de"],
26
28
  permissions: {"create_upload":true,"review_translations":true})
27
29
  ```
data/docs/InvitationUpdateParameters.md CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **project_ids** | **String** | List of project ids the invited user has access to | [optional]
9
9
  **locale_ids** | **String** | List of locale ids the invited user has access to | [optional]
10
10
  **space_ids** | **Array<String>** | List of spaces the user is assigned to. | [optional]
11
+ **team_ids** | **Array<String>** | List of teams the user is assigned to. | [optional]
11
12
  **default_locale_codes** | **Array<String>** | List of default locales for the user. | [optional]
12
13
  **permissions** | **Hash<String, String>** | Additional permissions depending on invitation role. | [optional]
13
14
 
@@ -20,6 +21,7 @@ instance = Phrase::InvitationUpdateParameters.new(role: Invitiation role,
20
21
  project_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
21
22
  locale_ids: abcd1234abcd1234abcd1234,abcd1234abcd1234abcd1235,
22
23
  space_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
24
+ team_ids: ["abcd1234abcd1234abcd1234","abcd1234abcd1234abcd1235"],
23
25
  default_locale_codes: ["en","de"],
24
26
  permissions: {"create_upload":true})
25
27
  ```
data/docs/InvitationsApi.md CHANGED
@@ -36,6 +36,9 @@ 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'
39
42
  end
40
43
 
41
44
  api_instance = Phrase::InvitationsApi.new
@@ -69,7 +72,7 @@ Response<([**Invitation**](Invitation.md))>
69
72
 
70
73
  ### Authorization
71
74
 
72
- [Basic](../README.md#Basic), [Token](../README.md#Token)
75
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
73
76
 
74
77
  ### HTTP request headers
75
78
 
@@ -99,6 +102,9 @@ Phrase.configure do |config|
99
102
  # Configure API key authorization: Token
100
103
  config.api_key['Authorization'] = 'YOUR API KEY'
101
104
  config.api_key_prefix['Authorization'] = 'token'
105
+
106
+ # Configure Bearer authorization (JWT): bearerAuth
107
+ config.access_token = 'YOUR_BEARER_TOKEN'
102
108
  end
103
109
 
104
110
  api_instance = Phrase::InvitationsApi.new
@@ -131,7 +137,7 @@ Response<(nil (empty response body))>
131
137
 
132
138
  ### Authorization
133
139
 
134
- [Basic](../README.md#Basic), [Token](../README.md#Token)
140
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
135
141
 
136
142
  ### HTTP request headers
137
143
 
@@ -161,6 +167,9 @@ Phrase.configure do |config|
161
167
  # Configure API key authorization: Token
162
168
  config.api_key['Authorization'] = 'YOUR API KEY'
163
169
  config.api_key_prefix['Authorization'] = 'token'
170
+
171
+ # Configure Bearer authorization (JWT): bearerAuth
172
+ config.access_token = 'YOUR_BEARER_TOKEN'
164
173
  end
165
174
 
166
175
  api_instance = Phrase::InvitationsApi.new
@@ -194,7 +203,7 @@ Response<([**Invitation**](Invitation.md))>
194
203
 
195
204
  ### Authorization
196
205
 
197
- [Basic](../README.md#Basic), [Token](../README.md#Token)
206
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
198
207
 
199
208
  ### HTTP request headers
200
209
 
@@ -224,6 +233,9 @@ Phrase.configure do |config|
224
233
  # Configure API key authorization: Token
225
234
  config.api_key['Authorization'] = 'YOUR API KEY'
226
235
  config.api_key_prefix['Authorization'] = 'token'
236
+
237
+ # Configure Bearer authorization (JWT): bearerAuth
238
+ config.access_token = 'YOUR_BEARER_TOKEN'
227
239
  end
228
240
 
229
241
  api_instance = Phrase::InvitationsApi.new
@@ -257,7 +269,7 @@ Response<([**Invitation**](Invitation.md))>
257
269
 
258
270
  ### Authorization
259
271
 
260
- [Basic](../README.md#Basic), [Token](../README.md#Token)
272
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
261
273
 
262
274
  ### HTTP request headers
263
275
 
@@ -287,6 +299,9 @@ Phrase.configure do |config|
287
299
  # Configure API key authorization: Token
288
300
  config.api_key['Authorization'] = 'YOUR API KEY'
289
301
  config.api_key_prefix['Authorization'] = 'token'
302
+
303
+ # Configure Bearer authorization (JWT): bearerAuth
304
+ config.access_token = 'YOUR_BEARER_TOKEN'
290
305
  end
291
306
 
292
307
  api_instance = Phrase::InvitationsApi.new
@@ -322,7 +337,7 @@ Response<([**Invitation**](Invitation.md))>
322
337
 
323
338
  ### Authorization
324
339
 
325
- [Basic](../README.md#Basic), [Token](../README.md#Token)
340
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
326
341
 
327
342
  ### HTTP request headers
328
343
 
@@ -352,6 +367,9 @@ Phrase.configure do |config|
352
367
  # Configure API key authorization: Token
353
368
  config.api_key['Authorization'] = 'YOUR API KEY'
354
369
  config.api_key_prefix['Authorization'] = 'token'
370
+
371
+ # Configure Bearer authorization (JWT): bearerAuth
372
+ config.access_token = 'YOUR_BEARER_TOKEN'
355
373
  end
356
374
 
357
375
  api_instance = Phrase::InvitationsApi.new
@@ -387,7 +405,7 @@ Response<([**Invitation**](Invitation.md))>
387
405
 
388
406
  ### Authorization
389
407
 
390
- [Basic](../README.md#Basic), [Token](../README.md#Token)
408
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
391
409
 
392
410
  ### HTTP request headers
393
411
 
@@ -417,6 +435,9 @@ Phrase.configure do |config|
417
435
  # Configure API key authorization: Token
418
436
  config.api_key['Authorization'] = 'YOUR API KEY'
419
437
  config.api_key_prefix['Authorization'] = 'token'
438
+
439
+ # Configure Bearer authorization (JWT): bearerAuth
440
+ config.access_token = 'YOUR_BEARER_TOKEN'
420
441
  end
421
442
 
422
443
  api_instance = Phrase::InvitationsApi.new
@@ -452,7 +473,7 @@ Response<([**Array&lt;Invitation&gt;**](Invitation.md))>
452
473
 
453
474
  ### Authorization
454
475
 
455
- [Basic](../README.md#Basic), [Token](../README.md#Token)
476
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
456
477
 
457
478
  ### HTTP request headers
458
479
 
data/docs/JobLocaleCompleteReviewParameters.md ADDED
@@ -0,0 +1,17 @@
1
+ # Phrase::JobLocaleCompleteReviewParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **branch** | **String** | specify the branch to use | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Phrase'
13
+
14
+ instance = Phrase::JobLocaleCompleteReviewParameters.new(branch: my-feature-branch)
15
+ ```
16
+
17
+
data/docs/JobLocaleUpdateParameters.md CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
8
  **locale_id** | **String** | locale id | [optional]
9
9
  **user_ids** | **Array&lt;String&gt;** | Array of user ids to be assigned to the job locale | [optional]
10
+ **reviewer_ids** | **Array&lt;String&gt;** | Array of reviewer ids to be assigned to the job locale as reviewers | [optional]
10
11
 
11
12
  ## Code Sample
12
13
 
@@ -15,7 +16,8 @@ require 'Phrase'
15
16
 
16
17
  instance = Phrase::JobLocaleUpdateParameters.new(branch: my-feature-branch,
17
18
  locale_id: abcd1234cdef1234abcd1234cdef1234,
18
- user_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;])
19
+ user_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;],
20
+ reviewer_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;])
19
21
  ```
20
22
 
21
23
 
data/docs/JobLocalesApi.md CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.phrase.com/v2*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**job_locale_complete**](JobLocalesApi.md#job_locale_complete) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete | Complete a job locale
8
+ [**job_locale_complete_review**](JobLocalesApi.md#job_locale_complete_review) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review | Review a job locale
8
9
  [**job_locale_delete**](JobLocalesApi.md#job_locale_delete) | **DELETE** /projects/{project_id}/jobs/{job_id}/locales/{id} | Delete a job locale
9
10
  [**job_locale_reopen**](JobLocalesApi.md#job_locale_reopen) | **POST** /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen | Reopen a job locale
10
11
  [**job_locale_show**](JobLocalesApi.md#job_locale_show) | **GET** /projects/{project_id}/jobs/{job_id}/locale/{id} | Get a single job locale
@@ -36,6 +37,9 @@ Phrase.configure do |config|
36
37
  # Configure API key authorization: Token
37
38
  config.api_key['Authorization'] = 'YOUR API KEY'
38
39
  config.api_key_prefix['Authorization'] = 'token'
40
+
41
+ # Configure Bearer authorization (JWT): bearerAuth
42
+ config.access_token = 'YOUR_BEARER_TOKEN'
39
43
  end
40
44
 
41
45
  api_instance = Phrase::JobLocalesApi.new
@@ -73,7 +77,77 @@ Response<([**JobLocale**](JobLocale.md))>
73
77
 
74
78
  ### Authorization
75
79
 
76
- [Basic](../README.md#Basic), [Token](../README.md#Token)
80
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: application/json
85
+ - **Accept**: application/json
86
+
87
+
88
+ ## job_locale_complete_review
89
+
90
+ > JobLocale job_locale_complete_review(project_id, job_id, id, job_locale_complete_review_parameters, opts)
91
+
92
+ Review a job locale
93
+
94
+ Mark job locale as reviewed.
95
+
96
+ ### Example
97
+
98
+ ```ruby
99
+ # load the gem
100
+ require 'phrase'
101
+ # setup authorization
102
+ Phrase.configure do |config|
103
+ # Configure HTTP basic authorization: Basic
104
+ config.username = 'YOUR USERNAME'
105
+ config.password = 'YOUR PASSWORD'
106
+
107
+ # Configure API key authorization: Token
108
+ config.api_key['Authorization'] = 'YOUR API KEY'
109
+ config.api_key_prefix['Authorization'] = 'token'
110
+
111
+ # Configure Bearer authorization (JWT): bearerAuth
112
+ config.access_token = 'YOUR_BEARER_TOKEN'
113
+ end
114
+
115
+ api_instance = Phrase::JobLocalesApi.new
116
+ project_id = 'project_id_example' # String | Project ID
117
+ job_id = 'job_id_example' # String | Job ID
118
+ id = 'id_example' # String | ID
119
+ job_locale_complete_review_parameters = Phrase::JobLocaleCompleteReviewParameters.new # JobLocaleCompleteReviewParameters |
120
+ opts = {
121
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
122
+ }
123
+
124
+ begin
125
+ #Review a job locale
126
+ result = api_instance.job_locale_complete_review(project_id, job_id, id, job_locale_complete_review_parameters, opts)
127
+ pp result
128
+ rescue Phrase::ApiError => e
129
+ puts "Exception when calling JobLocalesApi->job_locale_complete_review: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+
136
+ Name | Type | Description | Notes
137
+ ------------- | ------------- | ------------- | -------------
138
+ **project_id** | **String**| Project ID |
139
+ **job_id** | **String**| Job ID |
140
+ **id** | **String**| ID |
141
+ **job_locale_complete_review_parameters** | [**JobLocaleCompleteReviewParameters**](JobLocaleCompleteReviewParameters.md)| |
142
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
143
+
144
+ ### Return type
145
+
146
+ Response<([**JobLocale**](JobLocale.md))>
147
+
148
+ ### Authorization
149
+
150
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
77
151
 
78
152
  ### HTTP request headers
79
153
 
@@ -103,6 +177,9 @@ Phrase.configure do |config|
103
177
  # Configure API key authorization: Token
104
178
  config.api_key['Authorization'] = 'YOUR API KEY'
105
179
  config.api_key_prefix['Authorization'] = 'token'
180
+
181
+ # Configure Bearer authorization (JWT): bearerAuth
182
+ config.access_token = 'YOUR_BEARER_TOKEN'
106
183
  end
107
184
 
108
185
  api_instance = Phrase::JobLocalesApi.new
@@ -139,7 +216,7 @@ Response<(nil (empty response body))>
139
216
 
140
217
  ### Authorization
141
218
 
142
- [Basic](../README.md#Basic), [Token](../README.md#Token)
219
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
143
220
 
144
221
  ### HTTP request headers
145
222
 
@@ -169,6 +246,9 @@ Phrase.configure do |config|
169
246
  # Configure API key authorization: Token
170
247
  config.api_key['Authorization'] = 'YOUR API KEY'
171
248
  config.api_key_prefix['Authorization'] = 'token'
249
+
250
+ # Configure Bearer authorization (JWT): bearerAuth
251
+ config.access_token = 'YOUR_BEARER_TOKEN'
172
252
  end
173
253
 
174
254
  api_instance = Phrase::JobLocalesApi.new
@@ -206,7 +286,7 @@ Response<([**JobLocale**](JobLocale.md))>
206
286
 
207
287
  ### Authorization
208
288
 
209
- [Basic](../README.md#Basic), [Token](../README.md#Token)
289
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
210
290
 
211
291
  ### HTTP request headers
212
292
 
@@ -236,6 +316,9 @@ Phrase.configure do |config|
236
316
  # Configure API key authorization: Token
237
317
  config.api_key['Authorization'] = 'YOUR API KEY'
238
318
  config.api_key_prefix['Authorization'] = 'token'
319
+
320
+ # Configure Bearer authorization (JWT): bearerAuth
321
+ config.access_token = 'YOUR_BEARER_TOKEN'
239
322
  end
240
323
 
241
324
  api_instance = Phrase::JobLocalesApi.new
@@ -273,7 +356,7 @@ Response<([**JobLocale**](JobLocale.md))>
273
356
 
274
357
  ### Authorization
275
358
 
276
- [Basic](../README.md#Basic), [Token](../README.md#Token)
359
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
277
360
 
278
361
  ### HTTP request headers
279
362
 
@@ -303,6 +386,9 @@ Phrase.configure do |config|
303
386
  # Configure API key authorization: Token
304
387
  config.api_key['Authorization'] = 'YOUR API KEY'
305
388
  config.api_key_prefix['Authorization'] = 'token'
389
+
390
+ # Configure Bearer authorization (JWT): bearerAuth
391
+ config.access_token = 'YOUR_BEARER_TOKEN'
306
392
  end
307
393
 
308
394
  api_instance = Phrase::JobLocalesApi.new
@@ -340,7 +426,7 @@ Response<([**JobLocale**](JobLocale.md))>
340
426
 
341
427
  ### Authorization
342
428
 
343
- [Basic](../README.md#Basic), [Token](../README.md#Token)
429
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
344
430
 
345
431
  ### HTTP request headers
346
432
 
@@ -370,6 +456,9 @@ Phrase.configure do |config|
370
456
  # Configure API key authorization: Token
371
457
  config.api_key['Authorization'] = 'YOUR API KEY'
372
458
  config.api_key_prefix['Authorization'] = 'token'
459
+
460
+ # Configure Bearer authorization (JWT): bearerAuth
461
+ config.access_token = 'YOUR_BEARER_TOKEN'
373
462
  end
374
463
 
375
464
  api_instance = Phrase::JobLocalesApi.new
@@ -405,7 +494,7 @@ Response<([**JobLocale**](JobLocale.md))>
405
494
 
406
495
  ### Authorization
407
496
 
408
- [Basic](../README.md#Basic), [Token](../README.md#Token)
497
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
409
498
 
410
499
  ### HTTP request headers
411
500
 
@@ -435,6 +524,9 @@ Phrase.configure do |config|
435
524
  # Configure API key authorization: Token
436
525
  config.api_key['Authorization'] = 'YOUR API KEY'
437
526
  config.api_key_prefix['Authorization'] = 'token'
527
+
528
+ # Configure Bearer authorization (JWT): bearerAuth
529
+ config.access_token = 'YOUR_BEARER_TOKEN'
438
530
  end
439
531
 
440
532
  api_instance = Phrase::JobLocalesApi.new
@@ -474,7 +566,7 @@ Response<([**Array&lt;JobLocale&gt;**](JobLocale.md))>
474
566
 
475
567
  ### Authorization
476
568
 
477
- [Basic](../README.md#Basic), [Token](../README.md#Token)
569
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
478
570
 
479
571
  ### HTTP request headers
480
572
 
data/docs/JobLocalesCreateParameters.md CHANGED
@@ -6,7 +6,8 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **branch** | **String** | specify the branch to use | [optional]
8
8
  **locale_id** | **String** | locale id | [optional]
9
- **user_ids** | **Array&lt;String&gt;** | Array of user ids to be assigned to the job locale | [optional]
9
+ **user_ids** | **Array&lt;String&gt;** | Array of user ids to be assigned to the job locale as translators | [optional]
10
+ **reviewer_ids** | **Array&lt;String&gt;** | Array of reviewer ids to be assigned to the job locale as reviewers | [optional]
10
11
 
11
12
  ## Code Sample
12
13
 
@@ -15,7 +16,8 @@ require 'Phrase'
15
16
 
16
17
  instance = Phrase::JobLocalesCreateParameters.new(branch: my-feature-branch,
17
18
  locale_id: abcd1234cdef1234abcd1234cdef1234,
18
- user_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;])
19
+ user_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;],
20
+ reviewer_ids: [&quot;abcd1234cdef1234abcd1234cdef1234&quot;])
19
21
  ```
20
22
 
21
23
 
data/docs/JobTemplateLocalesApi.md CHANGED
@@ -34,6 +34,9 @@ Phrase.configure do |config|
34
34
  # Configure API key authorization: Token
35
35
  config.api_key['Authorization'] = 'YOUR API KEY'
36
36
  config.api_key_prefix['Authorization'] = 'token'
37
+
38
+ # Configure Bearer authorization (JWT): bearerAuth
39
+ config.access_token = 'YOUR_BEARER_TOKEN'
37
40
  end
38
41
 
39
42
  api_instance = Phrase::JobTemplateLocalesApi.new
@@ -70,7 +73,7 @@ Response<(nil (empty response body))>
70
73
 
71
74
  ### Authorization
72
75
 
73
- [Basic](../README.md#Basic), [Token](../README.md#Token)
76
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
74
77
 
75
78
  ### HTTP request headers
76
79
 
@@ -100,6 +103,9 @@ Phrase.configure do |config|
100
103
  # Configure API key authorization: Token
101
104
  config.api_key['Authorization'] = 'YOUR API KEY'
102
105
  config.api_key_prefix['Authorization'] = 'token'
106
+
107
+ # Configure Bearer authorization (JWT): bearerAuth
108
+ config.access_token = 'YOUR_BEARER_TOKEN'
103
109
  end
104
110
 
105
111
  api_instance = Phrase::JobTemplateLocalesApi.new
@@ -137,7 +143,7 @@ Response<(**Object**)>
137
143
 
138
144
  ### Authorization
139
145
 
140
- [Basic](../README.md#Basic), [Token](../README.md#Token)
146
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
141
147
 
142
148
  ### HTTP request headers
143
149
 
@@ -167,6 +173,9 @@ Phrase.configure do |config|
167
173
  # Configure API key authorization: Token
168
174
  config.api_key['Authorization'] = 'YOUR API KEY'
169
175
  config.api_key_prefix['Authorization'] = 'token'
176
+
177
+ # Configure Bearer authorization (JWT): bearerAuth
178
+ config.access_token = 'YOUR_BEARER_TOKEN'
170
179
  end
171
180
 
172
181
  api_instance = Phrase::JobTemplateLocalesApi.new
@@ -204,7 +213,7 @@ Response<(**Object**)>
204
213
 
205
214
  ### Authorization
206
215
 
207
- [Basic](../README.md#Basic), [Token](../README.md#Token)
216
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
208
217
 
209
218
  ### HTTP request headers
210
219
 
@@ -234,6 +243,9 @@ Phrase.configure do |config|
234
243
  # Configure API key authorization: Token
235
244
  config.api_key['Authorization'] = 'YOUR API KEY'
236
245
  config.api_key_prefix['Authorization'] = 'token'
246
+
247
+ # Configure Bearer authorization (JWT): bearerAuth
248
+ config.access_token = 'YOUR_BEARER_TOKEN'
237
249
  end
238
250
 
239
251
  api_instance = Phrase::JobTemplateLocalesApi.new
@@ -269,7 +281,7 @@ Response<([**JobTemplateLocale**](JobTemplateLocale.md))>
269
281
 
270
282
  ### Authorization
271
283
 
272
- [Basic](../README.md#Basic), [Token](../README.md#Token)
284
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
273
285
 
274
286
  ### HTTP request headers
275
287
 
@@ -299,6 +311,9 @@ Phrase.configure do |config|
299
311
  # Configure API key authorization: Token
300
312
  config.api_key['Authorization'] = 'YOUR API KEY'
301
313
  config.api_key_prefix['Authorization'] = 'token'
314
+
315
+ # Configure Bearer authorization (JWT): bearerAuth
316
+ config.access_token = 'YOUR_BEARER_TOKEN'
302
317
  end
303
318
 
304
319
  api_instance = Phrase::JobTemplateLocalesApi.new
@@ -338,7 +353,7 @@ Response<(**Array&lt;Object&gt;**)>
338
353
 
339
354
  ### Authorization
340
355
 
341
- [Basic](../README.md#Basic), [Token](../README.md#Token)
356
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
342
357
 
343
358
  ### HTTP request headers
344
359
 
data/docs/JobTemplatesApi.md CHANGED
@@ -34,6 +34,9 @@ Phrase.configure do |config|
34
34
  # Configure API key authorization: Token
35
35
  config.api_key['Authorization'] = 'YOUR API KEY'
36
36
  config.api_key_prefix['Authorization'] = 'token'
37
+
38
+ # Configure Bearer authorization (JWT): bearerAuth
39
+ config.access_token = 'YOUR_BEARER_TOKEN'
37
40
  end
38
41
 
39
42
  api_instance = Phrase::JobTemplatesApi.new
@@ -67,7 +70,7 @@ Response<(**Object**)>
67
70
 
68
71
  ### Authorization
69
72
 
70
- [Basic](../README.md#Basic), [Token](../README.md#Token)
73
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
71
74
 
72
75
  ### HTTP request headers
73
76
 
@@ -97,6 +100,9 @@ Phrase.configure do |config|
97
100
  # Configure API key authorization: Token
98
101
  config.api_key['Authorization'] = 'YOUR API KEY'
99
102
  config.api_key_prefix['Authorization'] = 'token'
103
+
104
+ # Configure Bearer authorization (JWT): bearerAuth
105
+ config.access_token = 'YOUR_BEARER_TOKEN'
100
106
  end
101
107
 
102
108
  api_instance = Phrase::JobTemplatesApi.new
@@ -131,7 +137,7 @@ Response<(nil (empty response body))>
131
137
 
132
138
  ### Authorization
133
139
 
134
- [Basic](../README.md#Basic), [Token](../README.md#Token)
140
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
135
141
 
136
142
  ### HTTP request headers
137
143
 
@@ -161,6 +167,9 @@ Phrase.configure do |config|
161
167
  # Configure API key authorization: Token
162
168
  config.api_key['Authorization'] = 'YOUR API KEY'
163
169
  config.api_key_prefix['Authorization'] = 'token'
170
+
171
+ # Configure Bearer authorization (JWT): bearerAuth
172
+ config.access_token = 'YOUR_BEARER_TOKEN'
164
173
  end
165
174
 
166
175
  api_instance = Phrase::JobTemplatesApi.new
@@ -196,7 +205,7 @@ Response<(**Object**)>
196
205
 
197
206
  ### Authorization
198
207
 
199
- [Basic](../README.md#Basic), [Token](../README.md#Token)
208
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
200
209
 
201
210
  ### HTTP request headers
202
211
 
@@ -226,6 +235,9 @@ Phrase.configure do |config|
226
235
  # Configure API key authorization: Token
227
236
  config.api_key['Authorization'] = 'YOUR API KEY'
228
237
  config.api_key_prefix['Authorization'] = 'token'
238
+
239
+ # Configure Bearer authorization (JWT): bearerAuth
240
+ config.access_token = 'YOUR_BEARER_TOKEN'
229
241
  end
230
242
 
231
243
  api_instance = Phrase::JobTemplatesApi.new
@@ -261,7 +273,7 @@ Response<(**Object**)>
261
273
 
262
274
  ### Authorization
263
275
 
264
- [Basic](../README.md#Basic), [Token](../README.md#Token)
276
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
265
277
 
266
278
  ### HTTP request headers
267
279
 
@@ -291,6 +303,9 @@ Phrase.configure do |config|
291
303
  # Configure API key authorization: Token
292
304
  config.api_key['Authorization'] = 'YOUR API KEY'
293
305
  config.api_key_prefix['Authorization'] = 'token'
306
+
307
+ # Configure Bearer authorization (JWT): bearerAuth
308
+ config.access_token = 'YOUR_BEARER_TOKEN'
294
309
  end
295
310
 
296
311
  api_instance = Phrase::JobTemplatesApi.new
@@ -328,7 +343,7 @@ Response<([**Array&lt;JobTemplate&gt;**](JobTemplate.md))>
328
343
 
329
344
  ### Authorization
330
345
 
331
- [Basic](../README.md#Basic), [Token](../README.md#Token)
346
+ [Basic](../README.md#Basic), [Token](../README.md#Token), [bearerAuth](../README.md#bearerAuth)
332
347
 
333
348
  ### HTTP request headers
334
349