phrase 4.29.0 → 4.30.1

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 (260) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +4 -4
  4. data/docs/Account.md +8 -8
  5. data/docs/AccountDetails.md +10 -10
  6. data/docs/AccountSearchResult.md +8 -8
  7. data/docs/AffectedCount.md +2 -2
  8. data/docs/AffectedResources.md +2 -2
  9. data/docs/Authorization.md +9 -9
  10. data/docs/AuthorizationCreateParameters.md +4 -4
  11. data/docs/AuthorizationUpdateParameters.md +4 -4
  12. data/docs/AuthorizationWithToken.md +10 -10
  13. data/docs/Automation.md +17 -17
  14. data/docs/AutomationEvent.md +10 -10
  15. data/docs/AutomationEventProject.md +3 -3
  16. data/docs/AutomationsCreateParameters.md +10 -10
  17. data/docs/AutomationsCreateParameters1.md +10 -10
  18. data/docs/BlacklistedKey.md +5 -5
  19. data/docs/BlacklistedKeyCreateParameters.md +2 -2
  20. data/docs/BlacklistedKeyUpdateParameters.md +2 -2
  21. data/docs/Branch.md +12 -12
  22. data/docs/BranchComparison.md +5 -5
  23. data/docs/BranchComparisonChange.md +3 -3
  24. data/docs/BranchComparisonDiff.md +4 -4
  25. data/docs/BranchComparisonDiffConflictsValue.md +3 -3
  26. data/docs/BranchCreateComparisonParameters.md +2 -2
  27. data/docs/BranchCreateParameters.md +3 -3
  28. data/docs/BranchMergeParameters.md +2 -2
  29. data/docs/BranchName.md +2 -2
  30. data/docs/BranchSyncParameters.md +2 -2
  31. data/docs/BranchUpdateParameters.md +2 -2
  32. data/docs/CheckIssue.md +10 -10
  33. data/docs/Comment.md +9 -9
  34. data/docs/CommentCreateParameters.md +4 -4
  35. data/docs/CommentCreateParameters1.md +3 -3
  36. data/docs/CommentMarkReadParameters.md +2 -2
  37. data/docs/CommentReaction.md +7 -7
  38. data/docs/CommentUpdateParameters.md +3 -3
  39. data/docs/CurrentUser.md +9 -9
  40. data/docs/CustomMetadataDataType.md +1 -1
  41. data/docs/CustomMetadataPropertiesCreateParameters.md +6 -6
  42. data/docs/CustomMetadataPropertiesUpdateParameters.md +5 -5
  43. data/docs/CustomMetadataProperty.md +10 -10
  44. data/docs/Distribution.md +9 -9
  45. data/docs/DistributionCreateParameters.md +6 -6
  46. data/docs/DistributionDetails.md +11 -11
  47. data/docs/DistributionUpdateParameters.md +6 -6
  48. data/docs/Document.md +5 -5
  49. data/docs/DocumentDelete422Response.md +3 -3
  50. data/docs/DocumentDelete422ResponseErrorsInner.md +4 -4
  51. data/docs/Error.md +2 -2
  52. data/docs/ErrorError.md +3 -3
  53. data/docs/FigmaAttachment.md +5 -5
  54. data/docs/FigmaAttachmentCreateParameters.md +3 -3
  55. data/docs/FigmaAttachmentUpdateParameters.md +3 -3
  56. data/docs/Format.md +7 -7
  57. data/docs/Glossary.md +7 -7
  58. data/docs/GlossaryCreateParameters.md +4 -4
  59. data/docs/GlossaryTerm.md +10 -10
  60. data/docs/GlossaryTermCreateParameters.md +3 -3
  61. data/docs/GlossaryTermGlossary.md +3 -3
  62. data/docs/GlossaryTermTranslation.md +6 -6
  63. data/docs/GlossaryTermTranslationCreateParameters.md +3 -3
  64. data/docs/GlossaryTermTranslationUpdateParameters.md +3 -3
  65. data/docs/GlossaryTermUpdateParameters.md +3 -3
  66. data/docs/GlossaryUpdateParameters.md +4 -4
  67. data/docs/Icu.md +2 -2
  68. data/docs/IcuSkeletonError.md +2 -2
  69. data/docs/IcuSkeletonParameters.md +5 -5
  70. data/docs/Invitation.md +16 -16
  71. data/docs/InvitationCreateParameters.md +9 -9
  72. data/docs/InvitationUpdateParameters.md +8 -8
  73. data/docs/InvitationUpdateSettingsParameters.md +3 -3
  74. data/docs/Job.md +14 -14
  75. data/docs/JobAnnotation.md +5 -5
  76. data/docs/JobAnnotationShort.md +3 -3
  77. data/docs/JobAnnotationUpdateParameters.md +3 -3
  78. data/docs/JobComment.md +8 -8
  79. data/docs/JobCommentCreateParameters.md +3 -3
  80. data/docs/JobCommentUpdateParameters.md +3 -3
  81. data/docs/JobCompleteParameters.md +2 -2
  82. data/docs/JobCreateParameters.md +11 -11
  83. data/docs/JobDetails.md +22 -22
  84. data/docs/JobKeysCreateParameters.md +3 -3
  85. data/docs/JobKeysDeleteParameters.md +3 -3
  86. data/docs/JobLocale.md +10 -10
  87. data/docs/JobLocaleCompleteParameters.md +2 -2
  88. data/docs/JobLocaleCompleteReviewParameters.md +2 -2
  89. data/docs/JobLocaleReopenParameters.md +2 -2
  90. data/docs/JobLocaleUpdateParameters.md +7 -7
  91. data/docs/JobLocalesCreateParameters.md +7 -7
  92. data/docs/JobPreview.md +4 -4
  93. data/docs/JobReopenParameters.md +2 -2
  94. data/docs/JobStartParameters.md +2 -2
  95. data/docs/JobTemplate.md +9 -9
  96. data/docs/JobTemplateCreateParameters.md +6 -6
  97. data/docs/JobTemplateDetails.md +12 -12
  98. data/docs/JobTemplateLocaleUpdateParameters.md +7 -7
  99. data/docs/JobTemplateLocales.md +6 -6
  100. data/docs/JobTemplateLocalesCreateParameters.md +7 -7
  101. data/docs/JobTemplatePreview.md +3 -3
  102. data/docs/JobTemplateUpdateParameters.md +6 -6
  103. data/docs/JobUpdateParameters.md +6 -8
  104. data/docs/JobsApi.md +3 -1
  105. data/docs/KeyCreateParameters.md +21 -21
  106. data/docs/KeyFormatAnnotationsList200ResponseInner.md +3 -3
  107. data/docs/KeyLink.md +8 -8
  108. data/docs/KeyLinksBatchDestroyParameters.md +4 -4
  109. data/docs/KeyLinksCreateParameters.md +2 -2
  110. data/docs/KeyPreview.md +5 -5
  111. data/docs/KeyUpdateParameters.md +19 -19
  112. data/docs/KeysExcludeParameters.md +5 -5
  113. data/docs/KeysIncludeParameters.md +5 -5
  114. data/docs/KeysSearchParameters.md +6 -6
  115. data/docs/KeysTagParameters.md +5 -5
  116. data/docs/KeysUntagParameters.md +5 -5
  117. data/docs/Locale.md +17 -17
  118. data/docs/LocaleCreateParameters.md +16 -16
  119. data/docs/LocaleDetails.md +18 -18
  120. data/docs/LocaleDownload.md +8 -8
  121. data/docs/LocaleDownloadCreateParameters.md +14 -14
  122. data/docs/LocaleDownloadParams.md +8 -8
  123. data/docs/LocaleDownloadResult.md +2 -2
  124. data/docs/LocalePreview.md +4 -4
  125. data/docs/LocalePreview1.md +3 -3
  126. data/docs/LocaleReport.md +15 -15
  127. data/docs/LocaleStatistics.md +8 -8
  128. data/docs/LocaleTeamPreview.md +4 -4
  129. data/docs/LocaleUpdateParameters.md +14 -14
  130. data/docs/LocaleUserPreview.md +5 -5
  131. data/docs/MachineTranslationLocaleProviderMapping.md +4 -4
  132. data/docs/MachineTranslationLocaleProviderMappingsCreateParameters.md +4 -4
  133. data/docs/MachineTranslationSettings.md +3 -3
  134. data/docs/MachineTranslationSettingsUpdateParameters.md +2 -2
  135. data/docs/Member.md +12 -12
  136. data/docs/MemberProjectDetail.md +11 -11
  137. data/docs/MemberProjectDetailProjectRolesInner.md +3 -3
  138. data/docs/MemberSpacesInner.md +6 -6
  139. data/docs/MemberUpdateParameters.md +8 -8
  140. data/docs/MemberUpdateSettingsParameters.md +3 -3
  141. data/docs/Notification.md +14 -14
  142. data/docs/NotificationGroup.md +5 -5
  143. data/docs/NotificationGroupDetail.md +7 -7
  144. data/docs/OrderConfirmParameters.md +2 -2
  145. data/docs/OrderCreateParameters.md +16 -16
  146. data/docs/OrganizationJobTemplate.md +8 -8
  147. data/docs/OrganizationJobTemplateCreateParameters.md +4 -4
  148. data/docs/OrganizationJobTemplateDetails.md +11 -11
  149. data/docs/OrganizationJobTemplateLocaleUpdateParameters.md +7 -7
  150. data/docs/OrganizationJobTemplateLocalesCreateParameters.md +7 -7
  151. data/docs/OrganizationJobTemplateUpdateParameters.md +4 -4
  152. data/docs/PreTranslation.md +8 -8
  153. data/docs/PreTranslationCreateParameters.md +3 -3
  154. data/docs/Project.md +12 -12
  155. data/docs/ProjectCreateParameters.md +16 -16
  156. data/docs/ProjectDetails.md +18 -18
  157. data/docs/ProjectLocales.md +8 -8
  158. data/docs/ProjectMember.md +7 -7
  159. data/docs/ProjectReport.md +9 -9
  160. data/docs/ProjectShort.md +6 -6
  161. data/docs/ProjectUpdateParameters.md +14 -14
  162. data/docs/QualityPerformanceScoreList200Response.md +4 -4
  163. data/docs/QualityPerformanceScoreList200ResponseAnyOf.md +3 -3
  164. data/docs/QualityPerformanceScoreList200ResponseAnyOfData.md +2 -2
  165. data/docs/QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner.md +4 -4
  166. data/docs/QualityPerformanceScoreList200ResponseAnyOfErrorsInner.md +4 -4
  167. data/docs/QualityPerformanceScoreListRequest.md +2 -2
  168. data/docs/Release.md +14 -14
  169. data/docs/ReleaseCreateParameters.md +8 -8
  170. data/docs/ReleaseCreateParameters1.md +8 -8
  171. data/docs/ReleasePreview.md +13 -13
  172. data/docs/ReleaseTrigger.md +12 -12
  173. data/docs/ReleaseUpdateParameters.md +6 -6
  174. data/docs/ReleaseUpdateParameters1.md +8 -8
  175. data/docs/RepoSync.md +12 -12
  176. data/docs/RepoSyncCreateParameters.md +10 -10
  177. data/docs/RepoSyncEvent.md +8 -8
  178. data/docs/RepoSyncExportParameters.md +3 -3
  179. data/docs/RepoSyncImportParameters.md +3 -3
  180. data/docs/RepoSyncsApi.md +5 -1
  181. data/docs/ReportsApi.md +4 -4
  182. data/docs/Screenshot.md +8 -8
  183. data/docs/ScreenshotMarker.md +7 -7
  184. data/docs/ScreenshotMarkerCreateParameters.md +4 -4
  185. data/docs/ScreenshotMarkerPresentation.md +5 -5
  186. data/docs/ScreenshotMarkerUpdateParameters.md +4 -4
  187. data/docs/ScreenshotUpdateParameters.md +5 -5
  188. data/docs/SearchInAccountParameters.md +4 -4
  189. data/docs/Space.md +7 -7
  190. data/docs/Space1.md +6 -6
  191. data/docs/SpaceCreateParameters.md +2 -2
  192. data/docs/SpaceUpdateParameters.md +2 -2
  193. data/docs/SpacesProjectsCreateParameters.md +2 -2
  194. data/docs/Styleguide.md +5 -5
  195. data/docs/StyleguideCreateParameters.md +14 -14
  196. data/docs/StyleguideDetails.md +18 -18
  197. data/docs/StyleguidePreview.md +3 -3
  198. data/docs/StyleguideUpdateParameters.md +14 -14
  199. data/docs/Subscription.md +3 -3
  200. data/docs/Tag.md +6 -6
  201. data/docs/TagCreateParameters.md +3 -3
  202. data/docs/TagWithStats.md +7 -7
  203. data/docs/TagWithStats1Statistics.md +5 -5
  204. data/docs/TagWithStats1Statistics1.md +3 -3
  205. data/docs/Team.md +8 -8
  206. data/docs/TeamCreateParameters.md +2 -2
  207. data/docs/TeamDetail.md +8 -8
  208. data/docs/TeamShort.md +5 -5
  209. data/docs/TeamUpdateParameters.md +2 -2
  210. data/docs/TeamsProjectsCreateParameters.md +2 -2
  211. data/docs/TeamsSpacesCreateParameters.md +2 -2
  212. data/docs/TeamsUsersCreateParameters.md +2 -2
  213. data/docs/Translation.md +13 -13
  214. data/docs/TranslationCreateParameters.md +9 -9
  215. data/docs/TranslationDetails.md +15 -15
  216. data/docs/TranslationExcludeParameters.md +2 -2
  217. data/docs/TranslationIncludeParameters.md +2 -2
  218. data/docs/TranslationKey.md +11 -11
  219. data/docs/TranslationKeyDetails.md +21 -21
  220. data/docs/TranslationOrder.md +19 -19
  221. data/docs/TranslationParent.md +3 -3
  222. data/docs/TranslationReviewParameters.md +2 -2
  223. data/docs/TranslationUnreviewParameters.md +2 -2
  224. data/docs/TranslationUnverifyParameters.md +2 -2
  225. data/docs/TranslationUpdateParameters.md +7 -7
  226. data/docs/TranslationVerifyParameters.md +2 -2
  227. data/docs/TranslationVersion.md +9 -9
  228. data/docs/TranslationVersionWithUser.md +10 -10
  229. data/docs/TranslationsExcludeParameters.md +5 -5
  230. data/docs/TranslationsIncludeParameters.md +5 -5
  231. data/docs/TranslationsReviewParameters.md +3 -3
  232. data/docs/TranslationsSearchParameters.md +5 -5
  233. data/docs/TranslationsUnreviewParameters.md +3 -3
  234. data/docs/TranslationsUnverifyParameters.md +5 -5
  235. data/docs/TranslationsVerifyParameters.md +4 -4
  236. data/docs/Upload.md +13 -13
  237. data/docs/UploadBatch.md +9 -9
  238. data/docs/UploadBatchesCreateParameters.md +3 -3
  239. data/docs/UploadSummary.md +11 -11
  240. data/docs/UploadsApi.md +2 -2
  241. data/docs/User.md +7 -7
  242. data/docs/UserPreview.md +5 -5
  243. data/docs/Variable.md +5 -5
  244. data/docs/VariableCreateParameters.md +3 -3
  245. data/docs/VariableUpdateParameters.md +3 -3
  246. data/docs/Webhook.md +9 -9
  247. data/docs/WebhookCreateParameters.md +7 -7
  248. data/docs/WebhookDelivery.md +8 -8
  249. data/docs/WebhookUpdateParameters.md +7 -7
  250. data/lib/phrase/api/jobs_api.rb +3 -0
  251. data/lib/phrase/api/repo_syncs_api.rb +6 -0
  252. data/lib/phrase/api/reports_api.rb +4 -4
  253. data/lib/phrase/models/job_update_parameters.rb +1 -11
  254. data/lib/phrase/models/locale_create_parameters.rb +2 -2
  255. data/lib/phrase/version.rb +1 -1
  256. data/spec/api/jobs_api_spec.rb +1 -0
  257. data/spec/api/repo_syncs_api_spec.rb +2 -0
  258. data/spec/api/reports_api_spec.rb +2 -2
  259. data/spec/models/job_update_parameters_spec.rb +0 -6
  260. metadata +264 -264
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
9
9
  ## Code Sample
10
10
 
11
11
  ```ruby
12
- require 'Phrase'
12
+ require 'phrase'
13
13
 
14
- instance = Phrase::TranslationUnverifyParameters.new(branch: my-feature-branch)
14
+ instance = Phrase::TranslationUnverifyParameters.new(branch: 'my-feature-branch')
15
15
  ```
16
16
 
17
17
 
@@ -16,14 +16,14 @@ Name | Type | Description | Notes
16
16
  ## Code Sample
17
17
 
18
18
  ```ruby
19
- require 'Phrase'
19
+ require 'phrase'
20
20
 
21
- instance = Phrase::TranslationUpdateParameters.new(branch: my-feature-branch,
22
- content: My translation,
23
- plural_suffix: null,
24
- unverified: null,
25
- excluded: null,
26
- autotranslate: null,
21
+ instance = Phrase::TranslationUpdateParameters.new(branch: 'my-feature-branch',
22
+ content: 'My translation',
23
+ plural_suffix: nil,
24
+ unverified: nil,
25
+ excluded: nil,
26
+ autotranslate: nil,
27
27
  reviewed: true,
28
28
  minor_change: false)
29
29
  ```
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
9
9
  ## Code Sample
10
10
 
11
11
  ```ruby
12
- require 'Phrase'
12
+ require 'phrase'
13
13
 
14
- instance = Phrase::TranslationVerifyParameters.new(branch: my-feature-branch)
14
+ instance = Phrase::TranslationVerifyParameters.new(branch: 'my-feature-branch')
15
15
  ```
16
16
 
17
17
 
@@ -16,16 +16,16 @@ Name | Type | Description | Notes
16
16
  ## Code Sample
17
17
 
18
18
  ```ruby
19
- require 'Phrase'
19
+ require 'phrase'
20
20
 
21
- instance = Phrase::TranslationVersion.new(id: null,
22
- content: null,
23
- plural_suffix: null,
24
- key: null,
25
- locale: null,
26
- created_at: null,
27
- updated_at: null,
28
- changed_at: null)
21
+ instance = Phrase::TranslationVersion.new(id: nil,
22
+ content: nil,
23
+ plural_suffix: nil,
24
+ key: nil,
25
+ locale: nil,
26
+ created_at: nil,
27
+ updated_at: nil,
28
+ changed_at: nil)
29
29
  ```
30
30
 
31
31
 
@@ -17,17 +17,17 @@ Name | Type | Description | Notes
17
17
  ## Code Sample
18
18
 
19
19
  ```ruby
20
- require 'Phrase'
20
+ require 'phrase'
21
21
 
22
- instance = Phrase::TranslationVersionWithUser.new(id: null,
23
- content: null,
24
- plural_suffix: null,
25
- key: null,
26
- locale: null,
27
- created_at: null,
28
- updated_at: null,
29
- changed_at: null,
30
- user: null)
22
+ instance = Phrase::TranslationVersionWithUser.new(id: nil,
23
+ content: nil,
24
+ plural_suffix: nil,
25
+ key: nil,
26
+ locale: nil,
27
+ created_at: nil,
28
+ updated_at: nil,
29
+ changed_at: nil,
30
+ user: nil)
31
31
  ```
32
32
 
33
33
 
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
12
12
  ## Code Sample
13
13
 
14
14
  ```ruby
15
- require 'Phrase'
15
+ require 'phrase'
16
16
 
17
- instance = Phrase::TranslationsExcludeParameters.new(branch: my-feature-branch,
18
- q: PhraseApp*%20verified:true%20tags:feature,center,
19
- sort: updated_at,
20
- order: desc)
17
+ instance = Phrase::TranslationsExcludeParameters.new(branch: 'my-feature-branch',
18
+ q: 'PhraseApp*%20verified:true%20tags:feature,center',
19
+ sort: 'updated_at',
20
+ order: 'desc')
21
21
  ```
22
22
 
23
23
 
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
12
12
  ## Code Sample
13
13
 
14
14
  ```ruby
15
- require 'Phrase'
15
+ require 'phrase'
16
16
 
17
- instance = Phrase::TranslationsIncludeParameters.new(branch: my-feature-branch,
18
- q: PhraseApp*%20verified:true%20tags:feature,center,
19
- sort: updated_at,
20
- order: desc)
17
+ instance = Phrase::TranslationsIncludeParameters.new(branch: 'my-feature-branch',
18
+ q: 'PhraseApp*%20verified:true%20tags:feature,center',
19
+ sort: 'updated_at',
20
+ order: 'desc')
21
21
  ```
22
22
 
23
23
 
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
- require 'Phrase'
13
+ require 'phrase'
14
14
 
15
- instance = Phrase::TranslationsReviewParameters.new(branch: my-feature-branch,
16
- q: PhraseApp*%reviewed:false%20tags:feature,center)
15
+ instance = Phrase::TranslationsReviewParameters.new(branch: 'my-feature-branch',
16
+ q: 'PhraseApp*%reviewed:false%20tags:feature,center')
17
17
  ```
18
18
 
19
19
 
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
12
12
  ## Code Sample
13
13
 
14
14
  ```ruby
15
- require 'Phrase'
15
+ require 'phrase'
16
16
 
17
- instance = Phrase::TranslationsSearchParameters.new(branch: my-feature-branch,
18
- sort: updated_at,
19
- order: desc,
20
- q: PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center)
17
+ instance = Phrase::TranslationsSearchParameters.new(branch: 'my-feature-branch',
18
+ sort: 'updated_at',
19
+ order: 'desc',
20
+ q: 'PhraseApp*%20unverified:true%20excluded:true%20tags:feature,center')
21
21
  ```
22
22
 
23
23
 
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
- require 'Phrase'
13
+ require 'phrase'
14
14
 
15
- instance = Phrase::TranslationsUnreviewParameters.new(branch: my-feature-branch,
16
- q: PhraseApp*%reviewed:true%20tags:feature,center)
15
+ instance = Phrase::TranslationsUnreviewParameters.new(branch: 'my-feature-branch',
16
+ q: 'PhraseApp*%reviewed:true%20tags:feature,center')
17
17
  ```
18
18
 
19
19
 
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
12
12
  ## Code Sample
13
13
 
14
14
  ```ruby
15
- require 'Phrase'
15
+ require 'phrase'
16
16
 
17
- instance = Phrase::TranslationsUnverifyParameters.new(branch: my-feature-branch,
18
- q: PhraseApp*%20verified:true%20tags:feature,center,
19
- sort: updated_at,
20
- order: desc)
17
+ instance = Phrase::TranslationsUnverifyParameters.new(branch: 'my-feature-branch',
18
+ q: 'PhraseApp*%20verified:true%20tags:feature,center',
19
+ sort: 'updated_at',
20
+ order: 'desc')
21
21
  ```
22
22
 
23
23
 
@@ -11,11 +11,11 @@ Name | Type | Description | Notes
11
11
  ## Code Sample
12
12
 
13
13
  ```ruby
14
- require 'Phrase'
14
+ require 'phrase'
15
15
 
16
- instance = Phrase::TranslationsVerifyParameters.new(branch: my-feature-branch,
17
- locale_id: fc2f11dd6a658fa9652f6f0a9ebee688,
18
- q: PhraseApp*%20unverified:true%20tags:feature,center)
16
+ instance = Phrase::TranslationsVerifyParameters.new(branch: 'my-feature-branch',
17
+ locale_id: 'fc2f11dd6a658fa9652f6f0a9ebee688',
18
+ q: 'PhraseApp*%20unverified:true%20tags:feature,center')
19
19
  ```
20
20
 
21
21
 
data/docs/Upload.md CHANGED
@@ -20,20 +20,20 @@ Name | Type | Description | Notes
20
20
  ## Code Sample
21
21
 
22
22
  ```ruby
23
- require 'Phrase'
23
+ require 'phrase'
24
24
 
25
- instance = Phrase::Upload.new(id: null,
26
- filename: null,
27
- format: null,
28
- state: null,
29
- error_message: null,
30
- tag: null,
31
- tags: null,
32
- url: null,
33
- user: null,
34
- summary: null,
35
- created_at: null,
36
- updated_at: null)
25
+ instance = Phrase::Upload.new(id: nil,
26
+ filename: nil,
27
+ format: nil,
28
+ state: nil,
29
+ error_message: nil,
30
+ tag: nil,
31
+ tags: nil,
32
+ url: nil,
33
+ user: nil,
34
+ summary: nil,
35
+ created_at: nil,
36
+ updated_at: nil)
37
37
  ```
38
38
 
39
39
 
data/docs/UploadBatch.md CHANGED
@@ -16,16 +16,16 @@ Name | Type | Description | Notes
16
16
  ## Code Sample
17
17
 
18
18
  ```ruby
19
- require 'Phrase'
19
+ require 'phrase'
20
20
 
21
- instance = Phrase::UploadBatch.new(status: null,
22
- delete_unmentioned_keys: null,
23
- uploads_count: null,
24
- created_at: null,
25
- updated_at: null,
26
- project: null,
27
- user: null,
28
- uploads: null)
21
+ instance = Phrase::UploadBatch.new(status: nil,
22
+ delete_unmentioned_keys: nil,
23
+ uploads_count: nil,
24
+ created_at: nil,
25
+ updated_at: nil,
26
+ project: nil,
27
+ user: nil,
28
+ uploads: nil)
29
29
  ```
30
30
 
31
31
 
@@ -11,11 +11,11 @@ Name | Type | Description | Notes
11
11
  ## Code Sample
12
12
 
13
13
  ```ruby
14
- require 'Phrase'
14
+ require 'phrase'
15
15
 
16
- instance = Phrase::UploadBatchesCreateParameters.new(branch: my-feature-branch,
16
+ instance = Phrase::UploadBatchesCreateParameters.new(branch: 'my-feature-branch',
17
17
  delete_unmentioned_keys: true,
18
- upload_ids: ["abcd1234cdef1234abcd1234cdef1234","bcde2345defg2345bcde2345defg2345"])
18
+ upload_ids: ["abcd1234cdef1234abcd1234cdef1234","bcde2345defg2345bcde2345defg2345"])
19
19
  ```
20
20
 
21
21
 
@@ -18,18 +18,18 @@ Name | Type | Description | Notes
18
18
  ## Code Sample
19
19
 
20
20
  ```ruby
21
- require 'Phrase'
21
+ require 'phrase'
22
22
 
23
- instance = Phrase::UploadSummary.new(locales_created: null,
24
- translation_keys_created: null,
25
- translation_keys_updated: null,
26
- translation_keys_unmentioned: null,
27
- translations_created: null,
28
- translations_updated: null,
29
- tags_created: null,
30
- translation_keys_ignored: null,
31
- processed_translations: null,
32
- upload_total_translations: null)
23
+ instance = Phrase::UploadSummary.new(locales_created: nil,
24
+ translation_keys_created: nil,
25
+ translation_keys_updated: nil,
26
+ translation_keys_unmentioned: nil,
27
+ translations_created: nil,
28
+ translations_updated: nil,
29
+ tags_created: nil,
30
+ translation_keys_ignored: nil,
31
+ processed_translations: nil,
32
+ upload_total_translations: nil)
33
33
  ```
34
34
 
35
35
 
data/docs/UploadsApi.md CHANGED
@@ -53,8 +53,8 @@ opts = {
53
53
  skip_upload_tags: true, # Boolean | Indicates whether the upload should not create upload tags.
54
54
  skip_unverification: true, # Boolean | Indicates whether the upload should unverify updated translations.
55
55
  file_encoding: 'file_encoding_example', # String | Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\".
56
- locale_mapping: { ... }, # Object | Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
57
- format_options: { ... }, # Object | Additional options available for specific formats. See our format guide for the [complete list](https://support.phrase.com/hc/en-us/articles/9652464547740-List-of-Supported-File-Types-Strings).
56
+ locale_mapping: {}, # Object | Mapping between locale names and translation columns. Required in some formats like CSV or XLSX.
57
+ format_options: {}, # Object | Additional options available for specific formats. See our format guide for the [complete list](https://support.phrase.com/hc/en-us/articles/9652464547740-List-of-Supported-File-Types-Strings).
58
58
  autotranslate: true, # Boolean | If set, translations for the uploaded language will be fetched automatically.
59
59
  verify_mentioned_translations: true, # Boolean | Indicates whether all translations mentioned in the upload should be verified.
60
60
  mark_reviewed: true, # Boolean | Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
data/docs/User.md CHANGED
@@ -14,14 +14,14 @@ Name | Type | Description | Notes
14
14
  ## Code Sample
15
15
 
16
16
  ```ruby
17
- require 'Phrase'
17
+ require 'phrase'
18
18
 
19
- instance = Phrase::User.new(id: null,
20
- username: null,
21
- name: null,
22
- position: null,
23
- created_at: null,
24
- updated_at: null)
19
+ instance = Phrase::User.new(id: nil,
20
+ username: nil,
21
+ name: nil,
22
+ position: nil,
23
+ created_at: nil,
24
+ updated_at: nil)
25
25
  ```
26
26
 
27
27
 
data/docs/UserPreview.md CHANGED
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
12
12
  ## Code Sample
13
13
 
14
14
  ```ruby
15
- require 'Phrase'
15
+ require 'phrase'
16
16
 
17
- instance = Phrase::UserPreview.new(id: null,
18
- username: null,
19
- name: null,
20
- gravatar_uid: null)
17
+ instance = Phrase::UserPreview.new(id: nil,
18
+ username: nil,
19
+ name: nil,
20
+ gravatar_uid: nil)
21
21
  ```
22
22
 
23
23
 
data/docs/Variable.md CHANGED
@@ -12,12 +12,12 @@ Name | Type | Description | Notes
12
12
  ## Code Sample
13
13
 
14
14
  ```ruby
15
- require 'Phrase'
15
+ require 'phrase'
16
16
 
17
- instance = Phrase::Variable.new(name: null,
18
- value: null,
19
- created_at: null,
20
- updated_at: null)
17
+ instance = Phrase::Variable.new(name: nil,
18
+ value: nil,
19
+ created_at: nil,
20
+ updated_at: nil)
21
21
  ```
22
22
 
23
23
 
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
- require 'Phrase'
13
+ require 'phrase'
14
14
 
15
- instance = Phrase::VariableCreateParameters.new(name: MY_VARIABLE,
16
- value: Hello World)
15
+ instance = Phrase::VariableCreateParameters.new(name: 'MY_VARIABLE',
16
+ value: 'Hello World')
17
17
  ```
18
18
 
19
19
 
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
10
10
  ## Code Sample
11
11
 
12
12
  ```ruby
13
- require 'Phrase'
13
+ require 'phrase'
14
14
 
15
- instance = Phrase::VariableUpdateParameters.new(name: MY_VARIABLE,
16
- value: Hello World)
15
+ instance = Phrase::VariableUpdateParameters.new(name: 'MY_VARIABLE',
16
+ value: 'Hello World')
17
17
  ```
18
18
 
19
19
 
data/docs/Webhook.md CHANGED
@@ -16,16 +16,16 @@ Name | Type | Description | Notes
16
16
  ## Code Sample
17
17
 
18
18
  ```ruby
19
- require 'Phrase'
19
+ require 'phrase'
20
20
 
21
- instance = Phrase::Webhook.new(id: null,
22
- callback_url: null,
23
- description: null,
24
- events: null,
25
- active: null,
26
- include_branches: null,
27
- created_at: null,
28
- updated_at: null)
21
+ instance = Phrase::Webhook.new(id: nil,
22
+ callback_url: nil,
23
+ description: nil,
24
+ events: nil,
25
+ active: nil,
26
+ include_branches: nil,
27
+ created_at: nil,
28
+ updated_at: nil)
29
29
  ```
30
30
 
31
31
 
@@ -14,14 +14,14 @@ Name | Type | Description | Notes
14
14
  ## Code Sample
15
15
 
16
16
  ```ruby
17
- require 'Phrase'
17
+ require 'phrase'
18
18
 
19
- instance = Phrase::WebhookCreateParameters.new(callback_url: http://example.com/hooks/phraseapp-notifications,
20
- secret: secr3t,
21
- description: My webhook for chat notifications,
22
- events: locales:create,translations:update,
23
- active: null,
24
- include_branches: null)
19
+ instance = Phrase::WebhookCreateParameters.new(callback_url: 'http://example.com/hooks/phraseapp-notifications',
20
+ secret: 'secr3t',
21
+ description: 'My webhook for chat notifications',
22
+ events: 'locales:create,translations:update',
23
+ active: nil,
24
+ include_branches: nil)
25
25
  ```
26
26
 
27
27
 
@@ -15,15 +15,15 @@ Name | Type | Description | Notes
15
15
  ## Code Sample
16
16
 
17
17
  ```ruby
18
- require 'Phrase'
18
+ require 'phrase'
19
19
 
20
- instance = Phrase::WebhookDelivery.new(id: null,
21
- webhook_id: null,
22
- response_status_code: null,
23
- delivered_at: null,
24
- duration_ms: null,
25
- created_at: null,
26
- updated_at: null)
20
+ instance = Phrase::WebhookDelivery.new(id: nil,
21
+ webhook_id: nil,
22
+ response_status_code: nil,
23
+ delivered_at: nil,
24
+ duration_ms: nil,
25
+ created_at: nil,
26
+ updated_at: nil)
27
27
  ```
28
28
 
29
29
 
@@ -14,14 +14,14 @@ Name | Type | Description | Notes
14
14
  ## Code Sample
15
15
 
16
16
  ```ruby
17
- require 'Phrase'
17
+ require 'phrase'
18
18
 
19
- instance = Phrase::WebhookUpdateParameters.new(callback_url: http://example.com/hooks/phraseapp-notifications,
20
- secret: secr3t,
21
- description: My webhook for chat notifications,
22
- events: locales:create,translations:update,
23
- active: null,
24
- include_branches: null)
19
+ instance = Phrase::WebhookUpdateParameters.new(callback_url: 'http://example.com/hooks/phraseapp-notifications',
20
+ secret: 'secr3t',
21
+ description: 'My webhook for chat notifications',
22
+ events: 'locales:create,translations:update',
23
+ active: nil,
24
+ include_branches: nil)
25
25
  ```
26
26
 
27
27
 
@@ -792,6 +792,7 @@ module Phrase
792
792
  # @param job_update_parameters [JobUpdateParameters]
793
793
  # @param [Hash] opts the optional parameters
794
794
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
795
+ # @option opts [String] :branch Branch to use
795
796
  # @return [JobDetails]
796
797
  def job_update(project_id, id, job_update_parameters, opts = {})
797
798
  data, _status_code, _headers = job_update_with_http_info(project_id, id, job_update_parameters, opts)
@@ -805,6 +806,7 @@ module Phrase
805
806
  # @param job_update_parameters [JobUpdateParameters]
806
807
  # @param [Hash] opts the optional parameters
807
808
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
809
+ # @option opts [String] :branch Branch to use
808
810
  # @return [Array<(Response<(JobDetails)>, Integer, Hash)>] Response<(JobDetails)> data, response status code and response headers
809
811
  def job_update_with_http_info(project_id, id, job_update_parameters, opts = {})
810
812
  if @api_client.config.debugging
@@ -827,6 +829,7 @@ module Phrase
827
829
 
828
830
  # query parameters
829
831
  query_params = opts[:query_params] || {}
832
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
830
833
 
831
834
  # header parameters
832
835
  header_params = opts[:header_params] || {}
@@ -382,6 +382,8 @@ module Phrase
382
382
  # @param account_id [String] Account ID
383
383
  # @param [Hash] opts the optional parameters
384
384
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
385
+ # @option opts [Integer] :page Page number
386
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
385
387
  # @return [Array<RepoSync>]
386
388
  def repo_sync_list(account_id, opts = {})
387
389
  data, _status_code, _headers = repo_sync_list_with_http_info(account_id, opts)
@@ -393,6 +395,8 @@ module Phrase
393
395
  # @param account_id [String] Account ID
394
396
  # @param [Hash] opts the optional parameters
395
397
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
398
+ # @option opts [Integer] :page Page number
399
+ # @option opts [Integer] :per_page Limit on the number of objects to be returned, between 1 and 100. 25 by default
396
400
  # @return [Array<(Response<(Array<RepoSync>)>, Integer, Hash)>] Response<(Array<RepoSync>)> data, response status code and response headers
397
401
  def repo_sync_list_with_http_info(account_id, opts = {})
398
402
  if @api_client.config.debugging
@@ -407,6 +411,8 @@ module Phrase
407
411
 
408
412
  # query parameters
409
413
  query_params = opts[:query_params] || {}
414
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
415
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
410
416
 
411
417
  # header parameters
412
418
  header_params = opts[:header_params] || {}
@@ -7,8 +7,8 @@ module Phrase
7
7
  def initialize(api_client = ApiClient.default)
8
8
  @api_client = api_client
9
9
  end
10
- # List Locale Reports
11
- # List all locale reports for the given project
10
+ # List Locale Reports (word count, character count, translation statistics)
11
+ # List all locale reports for the given project. Each report includes translation statistics per locale, including word count and character count fields (`source_word_count`, `word_count`, `word_count_unverified`, `word_count_missing`) as well as translation completion statistics (`keys_count`, `completed_translations_count`, `untranslated_keys_count`, `unverified_translations_count`, `reviewed_translations_count`, and their percentages). Use the `tag` parameter to scope the report to a specific job (e.g. its job tag) to get job-scoped word count statistics.
12
12
  # @param project_id [String] Project ID
13
13
  # @param [Hash] opts the optional parameters
14
14
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
@@ -23,8 +23,8 @@ module Phrase
23
23
  data
24
24
  end
25
25
 
26
- # List Locale Reports
27
- # List all locale reports for the given project
26
+ # List Locale Reports (word count, character count, translation statistics)
27
+ # List all locale reports for the given project. Each report includes translation statistics per locale, including word count and character count fields (&#x60;source_word_count&#x60;, &#x60;word_count&#x60;, &#x60;word_count_unverified&#x60;, &#x60;word_count_missing&#x60;) as well as translation completion statistics (&#x60;keys_count&#x60;, &#x60;completed_translations_count&#x60;, &#x60;untranslated_keys_count&#x60;, &#x60;unverified_translations_count&#x60;, &#x60;reviewed_translations_count&#x60;, and their percentages). Use the &#x60;tag&#x60; parameter to scope the report to a specific job (e.g. its job tag) to get job-scoped word count statistics.
28
28
  # @param project_id [String] Project ID
29
29
  # @param [Hash] opts the optional parameters
30
30
  # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)