phrase 4.22.0 → 4.23.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 (204) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +8 -6
  4. data/docs/AccountDetails.md +1 -1
  5. data/docs/AuthorizationsApi.md +1 -1
  6. data/docs/Automation.md +6 -0
  7. data/docs/AutomationsApi.md +1 -1
  8. data/docs/AutomationsCreateParameters.md +5 -1
  9. data/docs/AutomationsCreateParameters1.md +5 -1
  10. data/docs/BlacklistedKeysApi.md +1 -1
  11. data/docs/Branch.md +2 -0
  12. data/docs/BranchCreateParameters.md +3 -1
  13. data/docs/BranchMergeParameters.md +1 -1
  14. data/docs/BranchSyncParameters.md +1 -1
  15. data/docs/BranchesApi.md +10 -10
  16. data/docs/CommentsApi.md +7 -7
  17. data/docs/Distribution.md +4 -4
  18. data/docs/{DistributionPreview.md → DistributionDetails.md} +9 -3
  19. data/docs/DistributionsApi.md +9 -9
  20. data/docs/DocumentDelete422Response.md +19 -0
  21. data/docs/{CustomMetadataPropertyCreate422ResponseErrorsInner.md → DocumentDelete422ResponseErrorsInner.md} +2 -2
  22. data/docs/DocumentsApi.md +4 -2
  23. data/docs/FigmaAttachmentsApi.md +1 -1
  24. data/docs/GlossariesApi.md +1 -1
  25. data/docs/Glossary.md +2 -0
  26. data/docs/GlossaryTerm.md +2 -0
  27. data/docs/GlossaryTermGlossary.md +19 -0
  28. data/docs/GlossaryTermTranslationsApi.md +1 -1
  29. data/docs/GlossaryTermsApi.md +1 -1
  30. data/docs/IcuSkeletonParameters.md +3 -1
  31. data/docs/Invitation.md +2 -2
  32. data/docs/InvitationsApi.md +1 -1
  33. data/docs/Job.md +5 -1
  34. data/docs/JobDetails.md +8 -2
  35. data/docs/JobTemplate.md +2 -0
  36. data/docs/JobTemplateDetails.md +2 -0
  37. data/docs/JobTemplatesApi.md +1 -1
  38. data/docs/JobsApi.md +15 -9
  39. data/docs/KeyCreateParameters.md +6 -2
  40. data/docs/KeyUpdateParameters.md +6 -2
  41. data/docs/KeysApi.md +1 -1
  42. data/docs/LocalesApi.md +6 -2
  43. data/docs/MembersApi.md +1 -1
  44. data/docs/NotificationsApi.md +3 -1
  45. data/docs/OrdersApi.md +4 -2
  46. data/docs/OrganizationJobTemplate.md +4 -0
  47. data/docs/OrganizationJobTemplateDetails.md +4 -0
  48. data/docs/OrganizationJobTemplatesApi.md +1 -1
  49. data/docs/ProjectCreateParameters.md +17 -1
  50. data/docs/ProjectDetails.md +7 -1
  51. data/docs/ProjectUpdateParameters.md +17 -3
  52. data/docs/ProjectsApi.md +10 -8
  53. data/docs/Release.md +2 -0
  54. data/docs/ReleasesApi.md +1 -1
  55. data/docs/RepoSync.md +2 -0
  56. data/docs/ScreenshotMarker.md +2 -2
  57. data/docs/ScreenshotMarkerPresentation.md +23 -0
  58. data/docs/ScreenshotMarkersApi.md +1 -1
  59. data/docs/ScreenshotUpdateParameters.md +1 -1
  60. data/docs/ScreenshotsApi.md +1 -1
  61. data/docs/SearchInAccountParameters.md +3 -1
  62. data/docs/StyleGuidesApi.md +1 -1
  63. data/docs/StyleguideCreateParameters.md +3 -3
  64. data/docs/StyleguideUpdateParameters.md +3 -3
  65. data/docs/Tag.md +2 -0
  66. data/docs/TagWithStats.md +2 -0
  67. data/docs/TagsApi.md +5 -3
  68. data/docs/TranslationCreateParameters.md +5 -1
  69. data/docs/TranslationOrder.md +2 -2
  70. data/docs/TranslationUpdateParameters.md +3 -1
  71. data/docs/TranslationsApi.md +4 -0
  72. data/docs/UploadBatch.md +4 -2
  73. data/docs/UploadsApi.md +3 -1
  74. data/docs/VariablesApi.md +1 -1
  75. data/docs/WebhooksApi.md +7 -6
  76. data/lib/phrase/api/authorizations_api.rb +2 -0
  77. data/lib/phrase/api/automations_api.rb +2 -0
  78. data/lib/phrase/api/blacklisted_keys_api.rb +2 -0
  79. data/lib/phrase/api/branches_api.rb +20 -14
  80. data/lib/phrase/api/comments_api.rb +18 -4
  81. data/lib/phrase/api/distributions_api.rb +14 -12
  82. data/lib/phrase/api/documents_api.rb +5 -0
  83. data/lib/phrase/api/figma_attachments_api.rb +2 -0
  84. data/lib/phrase/api/glossaries_api.rb +2 -0
  85. data/lib/phrase/api/glossary_term_translations_api.rb +2 -0
  86. data/lib/phrase/api/glossary_terms_api.rb +2 -0
  87. data/lib/phrase/api/invitations_api.rb +2 -0
  88. data/lib/phrase/api/job_templates_api.rb +2 -0
  89. data/lib/phrase/api/jobs_api.rb +18 -6
  90. data/lib/phrase/api/keys_api.rb +2 -0
  91. data/lib/phrase/api/locales_api.rb +8 -0
  92. data/lib/phrase/api/members_api.rb +2 -0
  93. data/lib/phrase/api/notifications_api.rb +3 -0
  94. data/lib/phrase/api/orders_api.rb +5 -0
  95. data/lib/phrase/api/organization_job_templates_api.rb +2 -0
  96. data/lib/phrase/api/projects_api.rb +23 -10
  97. data/lib/phrase/api/releases_api.rb +2 -0
  98. data/lib/phrase/api/screenshot_markers_api.rb +2 -0
  99. data/lib/phrase/api/screenshots_api.rb +2 -0
  100. data/lib/phrase/api/style_guides_api.rb +2 -0
  101. data/lib/phrase/api/tags_api.rb +7 -2
  102. data/lib/phrase/api/translations_api.rb +6 -0
  103. data/lib/phrase/api/uploads_api.rb +3 -0
  104. data/lib/phrase/api/variables_api.rb +2 -0
  105. data/lib/phrase/api/webhooks_api.rb +9 -5
  106. data/lib/phrase/models/account_details.rb +1 -0
  107. data/lib/phrase/models/authorization_create_parameters.rb +22 -0
  108. data/lib/phrase/models/authorization_update_parameters.rb +22 -0
  109. data/lib/phrase/models/automation.rb +34 -1
  110. data/lib/phrase/models/automations_create_parameters.rb +24 -4
  111. data/lib/phrase/models/automations_create_parameters1.rb +24 -4
  112. data/lib/phrase/models/branch.rb +46 -1
  113. data/lib/phrase/models/branch_create_parameters.rb +14 -4
  114. data/lib/phrase/models/branch_merge_parameters.rb +35 -1
  115. data/lib/phrase/models/branch_sync_parameters.rb +35 -1
  116. data/lib/phrase/models/distribution.rb +17 -20
  117. data/lib/phrase/models/{distribution_preview.rb → distribution_details.rb} +46 -7
  118. data/lib/phrase/models/{custom_metadata_property_create422_response.rb → document_delete422_response.rb} +4 -4
  119. data/lib/phrase/models/{custom_metadata_property_create422_response_errors_inner.rb → document_delete422_response_errors_inner.rb} +3 -3
  120. data/lib/phrase/models/glossary.rb +12 -1
  121. data/lib/phrase/models/glossary_term.rb +10 -1
  122. data/lib/phrase/models/glossary_term_glossary.rb +206 -0
  123. data/lib/phrase/models/icu_skeleton_parameters.rb +12 -2
  124. data/lib/phrase/models/invitation.rb +9 -8
  125. data/lib/phrase/models/job.rb +26 -4
  126. data/lib/phrase/models/job_details.rb +37 -4
  127. data/lib/phrase/models/job_template.rb +11 -1
  128. data/lib/phrase/models/job_template_details.rb +11 -1
  129. data/lib/phrase/models/key_create_parameters.rb +26 -4
  130. data/lib/phrase/models/key_update_parameters.rb +26 -4
  131. data/lib/phrase/models/organization_job_template.rb +22 -1
  132. data/lib/phrase/models/organization_job_template_details.rb +22 -1
  133. data/lib/phrase/models/project_create_parameters.rb +115 -1
  134. data/lib/phrase/models/project_details.rb +31 -4
  135. data/lib/phrase/models/project_update_parameters.rb +75 -5
  136. data/lib/phrase/models/release.rb +10 -1
  137. data/lib/phrase/models/repo_sync.rb +12 -1
  138. data/lib/phrase/models/screenshot_marker.rb +2 -1
  139. data/lib/phrase/models/screenshot_marker_presentation.rb +224 -0
  140. data/lib/phrase/models/search_in_account_parameters.rb +16 -4
  141. data/lib/phrase/models/styleguide_create_parameters.rb +61 -3
  142. data/lib/phrase/models/styleguide_update_parameters.rb +61 -3
  143. data/lib/phrase/models/tag.rb +11 -1
  144. data/lib/phrase/models/tag_with_stats.rb +11 -1
  145. data/lib/phrase/models/translation_create_parameters.rb +24 -4
  146. data/lib/phrase/models/translation_order.rb +8 -7
  147. data/lib/phrase/models/translation_update_parameters.rb +14 -4
  148. data/lib/phrase/models/upload_batch.rb +24 -14
  149. data/lib/phrase/version.rb +1 -1
  150. data/lib/phrase.rb +5 -3
  151. data/spec/api/branches_api_spec.rb +7 -7
  152. data/spec/api/comments_api_spec.rb +2 -2
  153. data/spec/api/distributions_api_spec.rb +4 -4
  154. data/spec/api/documents_api_spec.rb +1 -0
  155. data/spec/api/jobs_api_spec.rb +4 -2
  156. data/spec/api/notifications_api_spec.rb +1 -0
  157. data/spec/api/orders_api_spec.rb +1 -0
  158. data/spec/api/projects_api_spec.rb +6 -5
  159. data/spec/api/tags_api_spec.rb +2 -1
  160. data/spec/api/translations_api_spec.rb +2 -0
  161. data/spec/api/webhooks_api_spec.rb +2 -2
  162. data/spec/models/authorization_create_parameters_spec.rb +4 -0
  163. data/spec/models/authorization_update_parameters_spec.rb +4 -0
  164. data/spec/models/automation_spec.rb +18 -0
  165. data/spec/models/automations_create_parameters1_spec.rb +12 -0
  166. data/spec/models/automations_create_parameters_spec.rb +12 -0
  167. data/spec/models/branch_create_parameters_spec.rb +6 -0
  168. data/spec/models/branch_merge_parameters_spec.rb +4 -0
  169. data/spec/models/branch_spec.rb +10 -0
  170. data/spec/models/branch_sync_parameters_spec.rb +4 -0
  171. data/spec/models/{distribution_preview_spec.rb → distribution_details_spec.rb} +24 -6
  172. data/spec/models/distribution_spec.rb +3 -3
  173. data/spec/models/{custom_metadata_property_create422_response_errors_inner_spec.rb → document_delete422_response_errors_inner_spec.rb} +6 -6
  174. data/spec/models/{custom_metadata_property_create422_response_spec.rb → document_delete422_response_spec.rb} +6 -6
  175. data/spec/models/glossary_spec.rb +6 -0
  176. data/spec/models/glossary_term_glossary_spec.rb +35 -0
  177. data/spec/models/glossary_term_spec.rb +6 -0
  178. data/spec/models/icu_skeleton_parameters_spec.rb +6 -0
  179. data/spec/models/invitation_spec.rb +1 -1
  180. data/spec/models/job_details_spec.rb +18 -0
  181. data/spec/models/job_spec.rb +12 -0
  182. data/spec/models/job_template_details_spec.rb +6 -0
  183. data/spec/models/job_template_spec.rb +6 -0
  184. data/spec/models/key_create_parameters_spec.rb +12 -0
  185. data/spec/models/key_update_parameters_spec.rb +12 -0
  186. data/spec/models/organization_job_template_details_spec.rb +12 -0
  187. data/spec/models/organization_job_template_spec.rb +12 -0
  188. data/spec/models/project_create_parameters_spec.rb +52 -0
  189. data/spec/models/project_details_spec.rb +18 -0
  190. data/spec/models/project_update_parameters_spec.rb +42 -0
  191. data/spec/models/release_spec.rb +6 -0
  192. data/spec/models/repo_sync_spec.rb +6 -0
  193. data/spec/models/screenshot_marker_presentation_spec.rb +47 -0
  194. data/spec/models/search_in_account_parameters_spec.rb +6 -0
  195. data/spec/models/styleguide_create_parameters_spec.rb +12 -0
  196. data/spec/models/styleguide_update_parameters_spec.rb +12 -0
  197. data/spec/models/tag_spec.rb +6 -0
  198. data/spec/models/tag_with_stats_spec.rb +6 -0
  199. data/spec/models/translation_create_parameters_spec.rb +12 -0
  200. data/spec/models/translation_order_spec.rb +1 -1
  201. data/spec/models/translation_update_parameters_spec.rb +6 -0
  202. data/spec/models/upload_batch_spec.rb +8 -2
  203. metadata +267 -259
  204. data/docs/CustomMetadataPropertyCreate422Response.md +0 -19
@@ -0,0 +1,19 @@
1
+ # Phrase::GlossaryTermGlossary
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
+
10
+ ## Code Sample
11
+
12
+ ```ruby
13
+ require 'Phrase'
14
+
15
+ instance = Phrase::GlossaryTermGlossary.new(id: null,
16
+ name: null)
17
+ ```
18
+
19
+
@@ -140,7 +140,7 @@ Response<(nil (empty response body))>
140
140
  ### HTTP request headers
141
141
 
142
142
  - **Content-Type**: Not defined
143
- - **Accept**: Not defined
143
+ - **Accept**: application/json
144
144
 
145
145
 
146
146
  ## glossary_term_translation_update
@@ -138,7 +138,7 @@ Response<(nil (empty response body))>
138
138
  ### HTTP request headers
139
139
 
140
140
  - **Content-Type**: Not defined
141
- - **Accept**: Not defined
141
+ - **Accept**: application/json
142
142
 
143
143
 
144
144
  ## glossary_term_show
@@ -4,7 +4,8 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **content** | **String** | Source content | [optional]
7
+ **content** | **String** | Source content to derive skeletons from. Mutually exclusive with &#x60;id&#x60;; exactly one of the two must be provided. | [optional]
8
+ **id** | **String** | Translation code to source content from. Mutually exclusive with &#x60;content&#x60;; exactly one of the two must be provided. | [optional]
8
9
  **locale_codes** | **Array&lt;String&gt;** | Locale codes | [optional]
9
10
  **keep_content** | **Boolean** | Keep the content and add missing plural forms for each locale | [optional]
10
11
  **zero_form_enabled** | **Boolean** | Indicates whether the zero form should be included or excluded in the returned skeletons | [optional]
@@ -16,6 +17,7 @@ Name | Type | Description | Notes
16
17
  require 'Phrase'
17
18
 
18
19
  instance = Phrase::IcuSkeletonParameters.new(content: {number, plural, one {One} other {%{n}}},
20
+ id: abcd1234abcd1234abcd1234abcd1234,
19
21
  locale_codes: [&quot;en&quot;],
20
22
  keep_content: null,
21
23
  zero_form_enabled: null,
data/docs/Invitation.md CHANGED
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
18
18
  **updated_at** | **Time** | | [optional]
19
19
  **accepted_at** | **Time** | | [optional]
20
20
  **spaces** | [**Array&lt;Space&gt;**](Space.md) | | [optional]
21
- **project_role** | [**Array&lt;MemberProjectDetailProjectRolesInner&gt;**](MemberProjectDetailProjectRolesInner.md) | | [optional]
21
+ **project_roles** | [**Array&lt;MemberProjectDetailProjectRolesInner&gt;**](MemberProjectDetailProjectRolesInner.md) | Per-project roles assigned to the invitee. | [optional]
22
22
 
23
23
  ## Code Sample
24
24
 
@@ -39,7 +39,7 @@ instance = Phrase::Invitation.new(id: null,
39
39
  updated_at: null,
40
40
  accepted_at: null,
41
41
  spaces: null,
42
- project_role: null)
42
+ project_roles: null)
43
43
  ```
44
44
 
45
45
 
@@ -136,7 +136,7 @@ Response<(nil (empty response body))>
136
136
  ### HTTP request headers
137
137
 
138
138
  - **Content-Type**: Not defined
139
- - **Accept**: Not defined
139
+ - **Accept**: application/json
140
140
 
141
141
 
142
142
  ## invitation_resend
data/docs/Job.md CHANGED
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
14
14
  **branch** | [**BranchName**](BranchName.md) | | [optional]
15
15
  **created_at** | **Time** | | [optional]
16
16
  **updated_at** | **Time** | | [optional]
17
+ **automation_id** | **String** | The ID of the automation that created this job, or null if the job was created manually. | [optional]
18
+ **job_template_id** | **String** | The ID of the job template this job was created from, or null if no template was used. | [optional]
17
19
 
18
20
  ## Code Sample
19
21
 
@@ -29,7 +31,9 @@ instance = Phrase::Job.new(id: null,
29
31
  project: null,
30
32
  branch: null,
31
33
  created_at: null,
32
- updated_at: null)
34
+ updated_at: null,
35
+ automation_id: null,
36
+ job_template_id: null)
33
37
  ```
34
38
 
35
39
 
data/docs/JobDetails.md CHANGED
@@ -14,13 +14,16 @@ Name | Type | Description | Notes
14
14
  **branch** | [**BranchName**](BranchName.md) | | [optional]
15
15
  **created_at** | **Time** | | [optional]
16
16
  **updated_at** | **Time** | | [optional]
17
+ **automation_id** | **String** | The ID of the automation that created this job, or null if the job was created manually. | [optional]
18
+ **job_template_id** | **String** | The ID of the job template this job was created from, or null if no template was used. | [optional]
17
19
  **owner** | [**UserPreview**](UserPreview.md) | | [optional]
18
20
  **job_tag_name** | **String** | | [optional]
19
21
  **source_translations_updated_at** | **Time** | | [optional]
20
22
  **source_locale** | [**LocalePreview**](LocalePreview.md) | | [optional]
21
23
  **locales** | [**Array&lt;LocalePreview&gt;**](LocalePreview.md) | | [optional]
22
24
  **keys** | [**Array&lt;KeyPreview&gt;**](KeyPreview.md) | | [optional]
23
- **annotations** | [**Array&lt;JobAnnotationShort&gt;**](JobAnnotationShort.md) | | [optional]
25
+ **annotations** | [**Array&lt;JobAnnotationShort&gt;**](JobAnnotationShort.md) | Returned only when &#x60;include_annotations&#x3D;true&#x60; is supplied on the request. | [optional]
26
+ **locked** | **Boolean** | &#x60;true&#x60; if the job has been locked by the project&#39;s job-locking workflow (translations attached to the job are read-only until the job advances). | [optional]
24
27
 
25
28
  ## Code Sample
26
29
 
@@ -37,13 +40,16 @@ instance = Phrase::JobDetails.new(id: null,
37
40
  branch: null,
38
41
  created_at: null,
39
42
  updated_at: null,
43
+ automation_id: null,
44
+ job_template_id: null,
40
45
  owner: null,
41
46
  job_tag_name: null,
42
47
  source_translations_updated_at: null,
43
48
  source_locale: null,
44
49
  locales: null,
45
50
  keys: null,
46
- annotations: null)
51
+ annotations: null,
52
+ locked: null)
47
53
  ```
48
54
 
49
55
 
data/docs/JobTemplate.md CHANGED
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **briefing** | **String** | | [optional]
10
10
  **project** | [**ProjectShort**](ProjectShort.md) | | [optional]
11
11
  **branch** | [**Branch**](Branch.md) | | [optional]
12
+ **autotranslate_enabled** | **Boolean** | When &#x60;true&#x60;, jobs created from this template are auto-translated on creation. | [optional]
12
13
  **created_at** | **Time** | | [optional]
13
14
  **updated_at** | **Time** | | [optional]
14
15
 
@@ -22,6 +23,7 @@ instance = Phrase::JobTemplate.new(id: null,
22
23
  briefing: null,
23
24
  project: null,
24
25
  branch: null,
26
+ autotranslate_enabled: null,
25
27
  created_at: null,
26
28
  updated_at: null)
27
29
  ```
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **briefing** | **String** | | [optional]
10
10
  **project** | [**ProjectShort**](ProjectShort.md) | | [optional]
11
11
  **branch** | [**Branch**](Branch.md) | | [optional]
12
+ **autotranslate_enabled** | **Boolean** | When &#x60;true&#x60;, jobs created from this template are auto-translated on creation. | [optional]
12
13
  **created_at** | **Time** | | [optional]
13
14
  **updated_at** | **Time** | | [optional]
14
15
  **owner** | [**UserPreview**](UserPreview.md) | | [optional]
@@ -25,6 +26,7 @@ instance = Phrase::JobTemplateDetails.new(id: null,
25
26
  briefing: null,
26
27
  project: null,
27
28
  branch: null,
29
+ autotranslate_enabled: null,
28
30
  created_at: null,
29
31
  updated_at: null,
30
32
  owner: null,
@@ -136,7 +136,7 @@ Response<(nil (empty response body))>
136
136
  ### HTTP request headers
137
137
 
138
138
  - **Content-Type**: Not defined
139
- - **Accept**: Not defined
139
+ - **Accept**: application/json
140
140
 
141
141
 
142
142
  ## job_template_update
data/docs/JobsApi.md CHANGED
@@ -209,7 +209,7 @@ Response<(nil (empty response body))>
209
209
  ### HTTP request headers
210
210
 
211
211
  - **Content-Type**: Not defined
212
- - **Accept**: Not defined
212
+ - **Accept**: application/json
213
213
 
214
214
 
215
215
  ## job_keys_create
@@ -343,7 +343,7 @@ Response<(nil (empty response body))>
343
343
 
344
344
  ## job_lock
345
345
 
346
- > job_lock(project_id, id, opts)
346
+ > JobDetails job_lock(project_id, id, opts)
347
347
 
348
348
  Lock a job
349
349
 
@@ -375,7 +375,8 @@ opts = {
375
375
 
376
376
  begin
377
377
  #Lock a job
378
- api_instance.job_lock(project_id, id, opts)
378
+ result = api_instance.job_lock(project_id, id, opts)
379
+ pp result
379
380
  rescue Phrase::ApiError => e
380
381
  puts "Exception when calling JobsApi->job_lock: #{e}"
381
382
  end
@@ -393,7 +394,7 @@ Name | Type | Description | Notes
393
394
 
394
395
  ### Return type
395
396
 
396
- Response<(nil (empty response body))>
397
+ Response<([**JobDetails**](JobDetails.md))>
397
398
 
398
399
  ### Authorization
399
400
 
@@ -402,7 +403,7 @@ Response<(nil (empty response body))>
402
403
  ### HTTP request headers
403
404
 
404
405
  - **Content-Type**: Not defined
405
- - **Accept**: Not defined
406
+ - **Accept**: application/json
406
407
 
407
408
 
408
409
  ## job_reopen
@@ -606,7 +607,7 @@ Response<([**JobDetails**](JobDetails.md))>
606
607
 
607
608
  ## job_unlock
608
609
 
609
- > job_unlock(project_id, id, opts)
610
+ > JobDetails job_unlock(project_id, id, opts)
610
611
 
611
612
  Unlock a job
612
613
 
@@ -638,7 +639,8 @@ opts = {
638
639
 
639
640
  begin
640
641
  #Unlock a job
641
- api_instance.job_unlock(project_id, id, opts)
642
+ result = api_instance.job_unlock(project_id, id, opts)
643
+ pp result
642
644
  rescue Phrase::ApiError => e
643
645
  puts "Exception when calling JobsApi->job_unlock: #{e}"
644
646
  end
@@ -656,7 +658,7 @@ Name | Type | Description | Notes
656
658
 
657
659
  ### Return type
658
660
 
659
- Response<(nil (empty response body))>
661
+ Response<([**JobDetails**](JobDetails.md))>
660
662
 
661
663
  ### Authorization
662
664
 
@@ -665,7 +667,7 @@ Response<(nil (empty response body))>
665
667
  ### HTTP request headers
666
668
 
667
669
  - **Content-Type**: Not defined
668
- - **Accept**: Not defined
670
+ - **Accept**: application/json
669
671
 
670
672
 
671
673
  ## job_update
@@ -840,6 +842,8 @@ opts = {
840
842
  owned_by: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user owning job
841
843
  assigned_to: 'abcd1234cdef1234abcd1234cdef1234', # String | filter by user assigned to job
842
844
  state: 'completed', # String | filter by state of job; valid states are: `draft`, `in_progress`, `completed`
845
+ states: ['inner_example'], # Array<String> | Filter by multiple job states at once. Accepted values are the same as `state`. When supplied, `state` is ignored. Rejected with `400 Bad Request` if any value is unknown.
846
+ key_id: 'abcd1234cdef1234abcd1234cdef1234', # String | Filter to jobs that include the translation key identified by this code (matches via the job's tags).
843
847
  updated_since: '2013-02-21T00:00:00.000Z' # String | filter by jobs updated since given date
844
848
  }
845
849
 
@@ -865,6 +869,8 @@ Name | Type | Description | Notes
865
869
  **owned_by** | **String**| filter by user owning job | [optional]
866
870
  **assigned_to** | **String**| filter by user assigned to job | [optional]
867
871
  **state** | **String**| filter by state of job; valid states are: &#x60;draft&#x60;, &#x60;in_progress&#x60;, &#x60;completed&#x60; | [optional]
872
+ **states** | [**Array&lt;String&gt;**](String.md)| Filter by multiple job states at once. Accepted values are the same as &#x60;state&#x60;. When supplied, &#x60;state&#x60; is ignored. Rejected with &#x60;400 Bad Request&#x60; if any value is unknown. | [optional]
873
+ **key_id** | **String**| Filter to jobs that include the translation key identified by this code (matches via the job&#39;s tags). | [optional]
868
874
  **updated_since** | **String**| filter by jobs updated since given date | [optional]
869
875
 
870
876
  ### Return type
@@ -23,6 +23,8 @@ Name | Type | Description | Notes
23
23
  **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
24
24
  **localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
25
25
  **custom_metadata** | **Object** | Custom metadata property name and value pairs to be associated with key. | [optional]
26
+ **excluded_in_locales** | **Array&lt;String&gt;** | Locales for which translations of this key are excluded from exports. Pass an empty array to clear exclusions. | [optional]
27
+ **format_value_type** | **String** | Override of the value type for the key in the export. Most useful for formats like Android XML that distinguish string vs. plural resources. | [optional]
26
28
 
27
29
  ## Code Sample
28
30
 
@@ -38,7 +40,7 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
38
40
  data_type: number,
39
41
  tags: awesome-feature,needs-proofreading,
40
42
  max_characters_allowed: 140,
41
- screenshot: [B@70a8ebfc,
43
+ screenshot: [B@6e0576da,
42
44
  remove_screenshot: null,
43
45
  unformatted: null,
44
46
  default_translation_content: Default translation content,
@@ -47,7 +49,9 @@ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
47
49
  original_file: null,
48
50
  localized_format_string: null,
49
51
  localized_format_key: null,
50
- custom_metadata: {&quot;fruit&quot;:&quot;Apple&quot;,&quot;vegetable&quot;:&quot;Tomato&quot;})
52
+ custom_metadata: {&quot;fruit&quot;:&quot;Apple&quot;,&quot;vegetable&quot;:&quot;Tomato&quot;},
53
+ excluded_in_locales: [&quot;de&quot;,&quot;fr&quot;],
54
+ format_value_type: string)
51
55
  ```
52
56
 
53
57
 
@@ -21,6 +21,8 @@ Name | Type | Description | Notes
21
21
  **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
22
22
  **localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
23
23
  **custom_metadata** | **Object** | Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value. | [optional]
24
+ **excluded_in_locales** | **Array&lt;String&gt;** | Locales for which translations of this key are excluded from exports. Pass an empty array to clear exclusions. | [optional]
25
+ **format_value_type** | **String** | Override of the value type for the key in the export. Most useful for formats like Android XML that distinguish string vs. plural resources. | [optional]
24
26
 
25
27
  ## Code Sample
26
28
 
@@ -36,14 +38,16 @@ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
36
38
  data_type: number,
37
39
  tags: awesome-feature,needs-proofreading,
38
40
  max_characters_allowed: 140,
39
- screenshot: [B@4be2f788,
41
+ screenshot: [B@20b6e853,
40
42
  remove_screenshot: null,
41
43
  unformatted: null,
42
44
  xml_space_preserve: null,
43
45
  original_file: null,
44
46
  localized_format_string: null,
45
47
  localized_format_key: null,
46
- custom_metadata: {&quot;fruit&quot;:&quot;Apple&quot;,&quot;vegetable&quot;:&quot;Tomato&quot;})
48
+ custom_metadata: {&quot;fruit&quot;:&quot;Apple&quot;,&quot;vegetable&quot;:&quot;Tomato&quot;},
49
+ excluded_in_locales: [&quot;de&quot;,&quot;fr&quot;],
50
+ format_value_type: string)
47
51
  ```
48
52
 
49
53
 
data/docs/KeysApi.md CHANGED
@@ -142,7 +142,7 @@ Response<(nil (empty response body))>
142
142
  ### HTTP request headers
143
143
 
144
144
  - **Content-Type**: Not defined
145
- - **Accept**: Not defined
145
+ - **Accept**: application/json
146
146
 
147
147
 
148
148
  ## key_show
data/docs/LocalesApi.md CHANGED
@@ -41,7 +41,9 @@ end
41
41
  api_instance = Phrase::LocalesApi.new
42
42
  id = 'id_example' # String | ID
43
43
  opts = {
44
- x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
44
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
45
+ page: 1, # Integer | Page number
46
+ per_page: 25 # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
45
47
  }
46
48
 
47
49
  begin
@@ -60,6 +62,8 @@ Name | Type | Description | Notes
60
62
  ------------- | ------------- | ------------- | -------------
61
63
  **id** | **String**| ID |
62
64
  **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
65
+ **page** | **Integer**| Page number | [optional]
66
+ **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
63
67
 
64
68
  ### Return type
65
69
 
@@ -199,7 +203,7 @@ Response<(nil (empty response body))>
199
203
  ### HTTP request headers
200
204
 
201
205
  - **Content-Type**: Not defined
202
- - **Accept**: Not defined
206
+ - **Accept**: application/json
203
207
 
204
208
 
205
209
  ## locale_download
data/docs/MembersApi.md CHANGED
@@ -71,7 +71,7 @@ Response<(nil (empty response body))>
71
71
  ### HTTP request headers
72
72
 
73
73
  - **Content-Type**: Not defined
74
- - **Accept**: Not defined
74
+ - **Accept**: application/json
75
75
 
76
76
 
77
77
  ## member_show
@@ -39,7 +39,8 @@ opts = {
39
39
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
40
40
  page: 1, # Integer | Page number
41
41
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
42
- unseen: true # Boolean | Include only unseen notifications
42
+ unseen: true, # Boolean | Include only unseen notifications
43
+ last_days: 7 # Integer | Restrict the results to notifications created within the last N days. Coerced to integer; non-numeric values resolve to 0 (returning nothing).
43
44
  }
44
45
 
45
46
  begin
@@ -60,6 +61,7 @@ Name | Type | Description | Notes
60
61
  **page** | **Integer**| Page number | [optional]
61
62
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
62
63
  **unseen** | **Boolean**| Include only unseen notifications | [optional]
64
+ **last_days** | **Integer**| Restrict the results to notifications created within the last N days. Coerced to integer; non-numeric values resolve to 0 (returning nothing). | [optional]
63
65
 
64
66
  ### Return type
65
67
 
data/docs/OrdersApi.md CHANGED
@@ -201,7 +201,7 @@ Response<(nil (empty response body))>
201
201
  ### HTTP request headers
202
202
 
203
203
  - **Content-Type**: Not defined
204
- - **Accept**: Not defined
204
+ - **Accept**: application/json
205
205
 
206
206
 
207
207
  ## order_show
@@ -299,7 +299,8 @@ opts = {
299
299
  x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
300
300
  page: 1, # Integer | Page number
301
301
  per_page: 25, # Integer | Limit on the number of objects to be returned, between 1 and 100. 25 by default
302
- branch: 'my-feature-branch' # String | specify the branch to use
302
+ branch: 'my-feature-branch', # String | specify the branch to use
303
+ translation_id: 'abcd1234cdef1234abcd1234cdef1234' # String | Filter the result to orders that include the given translation. When supplied with a translation code that does not exist, an empty list is returned.
303
304
  }
304
305
 
305
306
  begin
@@ -321,6 +322,7 @@ Name | Type | Description | Notes
321
322
  **page** | **Integer**| Page number | [optional]
322
323
  **per_page** | **Integer**| Limit on the number of objects to be returned, between 1 and 100. 25 by default | [optional]
323
324
  **branch** | **String**| specify the branch to use | [optional]
325
+ **translation_id** | **String**| Filter the result to orders that include the given translation. When supplied with a translation code that does not exist, an empty list is returned. | [optional]
324
326
 
325
327
  ### Return type
326
328
 
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
7
7
  **id** | **String** | | [optional]
8
8
  **name** | **String** | | [optional]
9
9
  **briefing** | **String** | | [optional]
10
+ **autotranslate_enabled** | **Boolean** | When &#x60;true&#x60;, jobs created from this template are auto-translated on creation. Maps to the &#x60;autotranslate&#x60; field on the request body. | [optional]
11
+ **source_locale_id** | **String** | Optional. ID of the source locale used by jobs created from this template. When omitted, the project&#39;s default source locale is used. | [optional]
10
12
  **created_at** | **Time** | | [optional]
11
13
  **updated_at** | **Time** | | [optional]
12
14
 
@@ -18,6 +20,8 @@ require 'Phrase'
18
20
  instance = Phrase::OrganizationJobTemplate.new(id: null,
19
21
  name: null,
20
22
  briefing: null,
23
+ autotranslate_enabled: null,
24
+ source_locale_id: null,
21
25
  created_at: null,
22
26
  updated_at: null)
23
27
  ```
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
7
7
  **id** | **String** | | [optional]
8
8
  **name** | **String** | | [optional]
9
9
  **briefing** | **String** | | [optional]
10
+ **autotranslate_enabled** | **Boolean** | When &#x60;true&#x60;, jobs created from this template are auto-translated on creation. Maps to the &#x60;autotranslate&#x60; field on the request body. | [optional]
11
+ **source_locale_id** | **String** | Optional. ID of the source locale used by jobs created from this template. When omitted, the project&#39;s default source locale is used. | [optional]
10
12
  **created_at** | **Time** | | [optional]
11
13
  **updated_at** | **Time** | | [optional]
12
14
  **owner** | [**UserPreview**](UserPreview.md) | | [optional]
@@ -21,6 +23,8 @@ require 'Phrase'
21
23
  instance = Phrase::OrganizationJobTemplateDetails.new(id: null,
22
24
  name: null,
23
25
  briefing: null,
26
+ autotranslate_enabled: null,
27
+ source_locale_id: null,
24
28
  created_at: null,
25
29
  updated_at: null,
26
30
  owner: null,
@@ -134,7 +134,7 @@ Response<(nil (empty response body))>
134
134
  ### HTTP request headers
135
135
 
136
136
  - **Content-Type**: Not defined
137
- - **Accept**: Not defined
137
+ - **Accept**: application/json
138
138
 
139
139
 
140
140
  ## organization_job_template_update
@@ -28,6 +28,14 @@ Name | Type | Description | Notes
28
28
  **autotranslate_use_machine_translation** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
29
29
  **autotranslate_use_translation_memory** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
30
30
  **autotranslate_overwrite_unverified_translations** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
31
+ **autocomplete_job_enabled** | **Boolean** | (Optional) Enable autocomplete-job behavior so that newly created keys and locales are automatically added to in-progress jobs. | [optional]
32
+ **job_locking_enabled** | **Boolean** | (Optional) When enabled, translations are locked once a job moves into review. | [optional]
33
+ **smart_suggest_enabled** | **Boolean** | (Optional) Enable Smart Suggest for the project. Defaults to &#x60;true&#x60; when omitted. | [optional]
34
+ **smart_suggest_use_glossary** | **Boolean** | (Optional) Allow Smart Suggest to source suggestions from the project glossary. Defaults to &#x60;true&#x60; when omitted. | [optional]
35
+ **smart_suggest_use_machine_translation** | **Boolean** | (Optional) Allow Smart Suggest to source suggestions from machine translation. Defaults to &#x60;true&#x60; when omitted. | [optional]
36
+ **translation_keys_sort_collation** | **String** | (Optional) Collation used when sorting translation keys alphabetically. Defaults to &#x60;unicode_ci&#x60; when omitted. | [optional]
37
+ **default_encoding** | **String** | (Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the [&#x60;file_encoding&#x60;](/en/api/strings/uploads/upload-a-new-file) parameter for Uploads. | [optional]
38
+ **cldr_version** | **String** | (Optional) CLDR plural-rule version used by the project. | [optional]
31
39
  **placeholder_styles** | **Array&lt;String&gt;** | (Optional) List of placeholder styles enabled for the project. | [optional]
32
40
 
33
41
  ## Code Sample
@@ -39,7 +47,7 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
39
47
  main_format: yml,
40
48
  media: Python,
41
49
  shares_translation_memory: true,
42
- project_image: [B@5fdd9b96,
50
+ project_image: [B@35afca01,
43
51
  remove_project_image: null,
44
52
  account_id: abcd1234,
45
53
  point_of_contact: abcd1234,
@@ -59,6 +67,14 @@ instance = Phrase::ProjectCreateParameters.new(name: My Android Project,
59
67
  autotranslate_use_machine_translation: true,
60
68
  autotranslate_use_translation_memory: true,
61
69
  autotranslate_overwrite_unverified_translations: true,
70
+ autocomplete_job_enabled: false,
71
+ job_locking_enabled: false,
72
+ smart_suggest_enabled: true,
73
+ smart_suggest_use_glossary: true,
74
+ smart_suggest_use_machine_translation: true,
75
+ translation_keys_sort_collation: unicode_ci,
76
+ default_encoding: UTF-8,
77
+ cldr_version: cldr48,
62
78
  placeholder_styles: [&quot;angular&quot;,&quot;iOS&quot;])
63
79
  ```
64
80
 
@@ -29,10 +29,13 @@ Name | Type | Description | Notes
29
29
  **autotranslate_mark_as_unverified** | **Boolean** | | [optional]
30
30
  **autotranslate_use_machine_translation** | **Boolean** | | [optional]
31
31
  **autotranslate_use_translation_memory** | **Boolean** | | [optional]
32
+ **autotranslate_overwrite_unverified_translations** | **Boolean** | | [optional]
33
+ **autocomplete_job_enabled** | **Boolean** | | [optional]
32
34
  **default_encoding** | **String** | | [optional]
33
35
  **cldr_version** | **String** | | [optional]
34
36
  **job_locking_enabled** | **Boolean** | | [optional]
35
37
  **placeholder_styles** | **Array&lt;String&gt;** | | [optional]
38
+ **branch** | [**Branch**](Branch.md) | | [optional]
36
39
 
37
40
  ## Code Sample
38
41
 
@@ -64,10 +67,13 @@ instance = Phrase::ProjectDetails.new(id: null,
64
67
  autotranslate_mark_as_unverified: false,
65
68
  autotranslate_use_machine_translation: false,
66
69
  autotranslate_use_translation_memory: true,
70
+ autotranslate_overwrite_unverified_translations: false,
71
+ autocomplete_job_enabled: false,
67
72
  default_encoding: UTF-8,
68
73
  cldr_version: legacy,
69
74
  job_locking_enabled: false,
70
- placeholder_styles: [&quot;angular&quot;,&quot;iOS&quot;])
75
+ placeholder_styles: [&quot;angular&quot;,&quot;iOS&quot;],
76
+ branch: null)
71
77
  ```
72
78
 
73
79
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
- **account_id** | **String** | Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in. | [optional]
7
+ **account_id** | **String** | (Optional) ID of an account the requesting user belongs to. Used only to disambiguate the request context; the project itself cannot be moved between accounts through this endpoint. | [optional]
8
8
  **name** | **String** | (Optional) Name of the project | [optional]
9
9
  **point_of_contact** | **String** | (Optional) User ID of the point of contact for the project. Pass &#x60;null&#x60; to unset. | [optional]
10
10
  **main_format** | **String** | (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see [Format Guide](https://support.phrase.com/hc/en-us/sections/6111343326364) or our [Formats API Endpoint](#formats). | [optional]
@@ -29,6 +29,13 @@ Name | Type | Description | Notes
29
29
  **autotranslate_overwrite_unverified_translations** | **Boolean** | (Optional) Requires autotranslate_enabled to be true | [optional]
30
30
  **default_encoding** | **String** | (Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the [&#x60;file_encoding&#x60;](/en/api/strings/uploads/upload-a-new-file) parameter for Uploads. | [optional]
31
31
  **placeholder_styles** | **Array&lt;String&gt;** | (Optional) List of placeholder styles enabled for the project. | [optional]
32
+ **autocomplete_job_enabled** | **Boolean** | (Optional) Enable autocomplete-job behavior so that newly created keys and locales are automatically added to in-progress jobs. | [optional]
33
+ **job_locking_enabled** | **Boolean** | (Optional) When enabled, translations are locked once a job moves into review. | [optional]
34
+ **smart_suggest_enabled** | **Boolean** | (Optional) Enable Smart Suggest for the project. | [optional]
35
+ **smart_suggest_use_glossary** | **Boolean** | (Optional) Allow Smart Suggest to source suggestions from the project glossary. | [optional]
36
+ **smart_suggest_use_machine_translation** | **Boolean** | (Optional) Allow Smart Suggest to source suggestions from machine translation. | [optional]
37
+ **translation_keys_sort_collation** | **String** | (Optional) Collation used when sorting translation keys alphabetically. | [optional]
38
+ **cldr_version** | **String** | (Optional) CLDR plural-rule version used by the project. | [optional]
32
39
 
33
40
  ## Code Sample
34
41
 
@@ -41,7 +48,7 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
41
48
  main_format: yml,
42
49
  media: Python,
43
50
  shares_translation_memory: true,
44
- project_image: [B@50ed6392,
51
+ project_image: [B@2c4c5627,
45
52
  remove_project_image: false,
46
53
  workflow: review,
47
54
  machine_translation_enabled: true,
@@ -59,7 +66,14 @@ instance = Phrase::ProjectUpdateParameters.new(account_id: abcd1234,
59
66
  autotranslate_use_translation_memory: true,
60
67
  autotranslate_overwrite_unverified_translations: true,
61
68
  default_encoding: UTF-8,
62
- placeholder_styles: [&quot;angular&quot;,&quot;iOS&quot;])
69
+ placeholder_styles: [&quot;angular&quot;,&quot;iOS&quot;],
70
+ autocomplete_job_enabled: false,
71
+ job_locking_enabled: false,
72
+ smart_suggest_enabled: true,
73
+ smart_suggest_use_glossary: true,
74
+ smart_suggest_use_machine_translation: true,
75
+ translation_keys_sort_collation: unicode_ci,
76
+ cldr_version: legacy)
63
77
  ```
64
78
 
65
79