phrase 0.4.33 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (620) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +6 -0
  3. data/LICENSE +17 -18
  4. data/README.md +712 -220
  5. data/Rakefile +7 -4
  6. data/docs/Account.md +25 -0
  7. data/docs/AccountDetails.md +27 -0
  8. data/docs/AccountDetails1.md +17 -0
  9. data/docs/AccountsApi.md +136 -0
  10. data/docs/AffectedCount.md +17 -0
  11. data/docs/AffectedResources.md +17 -0
  12. data/docs/Authorization.md +31 -0
  13. data/docs/AuthorizationCreateParameters.md +21 -0
  14. data/docs/AuthorizationUpdateParameters.md +21 -0
  15. data/docs/AuthorizationWithToken.md +33 -0
  16. data/docs/AuthorizationWithToken1.md +17 -0
  17. data/docs/AuthorizationsApi.md +325 -0
  18. data/docs/BitbucketSync.md +27 -0
  19. data/docs/BitbucketSyncApi.md +200 -0
  20. data/docs/BitbucketSyncExportParameters.md +17 -0
  21. data/docs/BitbucketSyncExportResponse.md +17 -0
  22. data/docs/BitbucketSyncImportParameters.md +17 -0
  23. data/docs/BlacklistedKey.md +23 -0
  24. data/docs/BlacklistedKeyCreateParameters.md +17 -0
  25. data/docs/BlacklistedKeyUpdateParameters.md +17 -0
  26. data/docs/BlacklistedKeysApi.md +335 -0
  27. data/docs/Branch.md +29 -0
  28. data/docs/BranchCreateParameters.md +17 -0
  29. data/docs/BranchMergeParameters.md +17 -0
  30. data/docs/BranchUpdateParameters.md +17 -0
  31. data/docs/BranchesApi.md +465 -0
  32. data/docs/Comment.md +25 -0
  33. data/docs/CommentCreateParameters.md +19 -0
  34. data/docs/CommentMarkReadParameters.md +17 -0
  35. data/docs/CommentUpdateParameters.md +19 -0
  36. data/docs/CommentsApi.md +555 -0
  37. data/docs/Distribution.md +29 -0
  38. data/docs/DistributionCreateParameters.md +29 -0
  39. data/docs/DistributionPreview.md +29 -0
  40. data/docs/DistributionUpdateParameters.md +29 -0
  41. data/docs/DistributionsApi.md +335 -0
  42. data/docs/Format.md +35 -0
  43. data/docs/FormatsApi.md +69 -0
  44. data/docs/GitLabSyncApi.md +470 -0
  45. data/docs/GitlabSync.md +37 -0
  46. data/docs/GitlabSyncExport.md +19 -0
  47. data/docs/GitlabSyncExportParameters.md +17 -0
  48. data/docs/GitlabSyncHistory.md +25 -0
  49. data/docs/GitlabSyncImportParameters.md +17 -0
  50. data/docs/Glossary.md +25 -0
  51. data/docs/GlossaryApi.md +335 -0
  52. data/docs/GlossaryCreateParameters.md +21 -0
  53. data/docs/GlossaryTerm.md +31 -0
  54. data/docs/GlossaryTermCreateParameters.md +23 -0
  55. data/docs/GlossaryTermTranslation.md +25 -0
  56. data/docs/GlossaryTermTranslationCreateParameters.md +19 -0
  57. data/docs/GlossaryTermTranslationUpdateParameters.md +19 -0
  58. data/docs/GlossaryTermTranslationsApi.md +215 -0
  59. data/docs/GlossaryTermUpdateParameters.md +23 -0
  60. data/docs/GlossaryTermsApi.md +345 -0
  61. data/docs/GlossaryUpdateParameters.md +21 -0
  62. data/docs/Invitation.md +35 -0
  63. data/docs/InvitationCreateParameters.md +25 -0
  64. data/docs/InvitationUpdateParameters.md +23 -0
  65. data/docs/InvitationsApi.md +400 -0
  66. data/docs/Job.md +29 -0
  67. data/docs/JobCompleteParameters.md +17 -0
  68. data/docs/JobCreateParameters.md +27 -0
  69. data/docs/JobDetails.md +37 -0
  70. data/docs/JobDetails1.md +23 -0
  71. data/docs/JobKeysCreateParameters.md +19 -0
  72. data/docs/JobLocale.md +23 -0
  73. data/docs/JobLocaleCompleteParameters.md +17 -0
  74. data/docs/JobLocaleReopenParameters.md +17 -0
  75. data/docs/JobLocaleUpdateParameters.md +21 -0
  76. data/docs/JobLocalesApi.md +489 -0
  77. data/docs/JobLocalesCreateParameters.md +21 -0
  78. data/docs/JobPreview.md +21 -0
  79. data/docs/JobReopenParameters.md +17 -0
  80. data/docs/JobStartParameters.md +17 -0
  81. data/docs/JobUpdateParameters.md +23 -0
  82. data/docs/JobsApi.md +683 -0
  83. data/docs/KeyCreateParameters.md +45 -0
  84. data/docs/KeyPreview.md +21 -0
  85. data/docs/KeyUpdateParameters.md +45 -0
  86. data/docs/KeysApi.md +617 -0
  87. data/docs/KeysSearchParameters.md +25 -0
  88. data/docs/KeysTagParameters.md +23 -0
  89. data/docs/KeysUntagParameters.md +23 -0
  90. data/docs/Locale.md +35 -0
  91. data/docs/LocaleCreateParameters.md +35 -0
  92. data/docs/LocaleDetails.md +37 -0
  93. data/docs/LocaleDetails1.md +17 -0
  94. data/docs/LocalePreview.md +21 -0
  95. data/docs/LocaleStatistics.md +29 -0
  96. data/docs/LocaleUpdateParameters.md +35 -0
  97. data/docs/LocalesApi.md +433 -0
  98. data/docs/Member.md +25 -0
  99. data/docs/MemberUpdateParameters.md +23 -0
  100. data/docs/MembersApi.md +271 -0
  101. data/docs/OrderConfirmParameters.md +17 -0
  102. data/docs/OrderCreateParameters.md +43 -0
  103. data/docs/OrdersApi.md +341 -0
  104. data/docs/Project.md +29 -0
  105. data/docs/ProjectCreateParameters.md +27 -0
  106. data/docs/ProjectDetails.md +33 -0
  107. data/docs/ProjectDetails1.md +19 -0
  108. data/docs/ProjectLocales.md +27 -0
  109. data/docs/ProjectLocales1.md +17 -0
  110. data/docs/ProjectShort.md +25 -0
  111. data/docs/ProjectUpdateParameters.md +27 -0
  112. data/docs/ProjectsApi.md +325 -0
  113. data/docs/Release.md +37 -0
  114. data/docs/ReleaseCreateParameters.md +21 -0
  115. data/docs/ReleasePreview.md +37 -0
  116. data/docs/ReleaseUpdateParameters.md +21 -0
  117. data/docs/ReleasesApi.md +412 -0
  118. data/docs/Screenshot.md +29 -0
  119. data/docs/ScreenshotCreateParameters.md +21 -0
  120. data/docs/ScreenshotMarker.md +27 -0
  121. data/docs/ScreenshotMarkerCreateParameters.md +19 -0
  122. data/docs/ScreenshotMarkerUpdateParameters.md +19 -0
  123. data/docs/ScreenshotMarkersApi.md +341 -0
  124. data/docs/ScreenshotUpdateParameters.md +21 -0
  125. data/docs/ScreenshotsApi.md +335 -0
  126. data/docs/Space.md +27 -0
  127. data/docs/SpaceCreateParameters.md +17 -0
  128. data/docs/SpaceUpdateParameters.md +17 -0
  129. data/docs/SpacesApi.md +536 -0
  130. data/docs/SpacesProjectsCreateParameters.md +17 -0
  131. data/docs/StyleGuidesApi.md +335 -0
  132. data/docs/Styleguide.md +23 -0
  133. data/docs/StyleguideCreateParameters.md +41 -0
  134. data/docs/StyleguideDetails.md +49 -0
  135. data/docs/StyleguideDetails1.md +41 -0
  136. data/docs/StyleguidePreview.md +19 -0
  137. data/docs/StyleguideUpdateParameters.md +41 -0
  138. data/docs/Tag.md +23 -0
  139. data/docs/TagCreateParameters.md +19 -0
  140. data/docs/TagWithStats.md +25 -0
  141. data/docs/TagWithStats1.md +17 -0
  142. data/docs/TagWithStats1Statistics.md +23 -0
  143. data/docs/TagWithStats1Statistics1.md +19 -0
  144. data/docs/TagsApi.md +274 -0
  145. data/docs/Translation.md +37 -0
  146. data/docs/TranslationCreateParameters.md +31 -0
  147. data/docs/TranslationDetails.md +41 -0
  148. data/docs/TranslationDetails1.md +19 -0
  149. data/docs/TranslationExcludeParameters.md +17 -0
  150. data/docs/TranslationIncludeParameters.md +17 -0
  151. data/docs/TranslationKey.md +33 -0
  152. data/docs/TranslationKeyDetails.md +51 -0
  153. data/docs/TranslationKeyDetails1.md +33 -0
  154. data/docs/TranslationOrder.md +49 -0
  155. data/docs/TranslationReviewParameters.md +17 -0
  156. data/docs/TranslationUnverifyParameters.md +17 -0
  157. data/docs/TranslationUpdateParameters.md +27 -0
  158. data/docs/TranslationVerifyParameters.md +17 -0
  159. data/docs/TranslationVersion.md +31 -0
  160. data/docs/TranslationVersionWithUser.md +33 -0
  161. data/docs/TranslationVersionWithUser1.md +17 -0
  162. data/docs/TranslationsApi.md +1164 -0
  163. data/docs/TranslationsExcludeParameters.md +23 -0
  164. data/docs/TranslationsIncludeParameters.md +23 -0
  165. data/docs/TranslationsReviewParameters.md +19 -0
  166. data/docs/TranslationsSearchParameters.md +23 -0
  167. data/docs/TranslationsUnverifyParameters.md +23 -0
  168. data/docs/TranslationsVerifyParameters.md +23 -0
  169. data/docs/Upload.md +31 -0
  170. data/docs/UploadCreateParameters.md +45 -0
  171. data/docs/UploadSummary.md +31 -0
  172. data/docs/UploadsApi.md +232 -0
  173. data/docs/User.md +29 -0
  174. data/docs/UserPreview.md +21 -0
  175. data/docs/UsersApi.md +69 -0
  176. data/docs/VersionsHistoryApi.md +148 -0
  177. data/docs/Webhook.md +29 -0
  178. data/docs/WebhookCreateParameters.md +23 -0
  179. data/docs/WebhookUpdateParameters.md +23 -0
  180. data/docs/WebhooksApi.md +399 -0
  181. data/git_push.sh +58 -0
  182. data/lib/phrase.rb +197 -55
  183. data/lib/phrase/api/accounts_api.rb +142 -0
  184. data/lib/phrase/api/authorizations_api.rb +346 -0
  185. data/lib/phrase/api/bitbucket_sync_api.rb +219 -0
  186. data/lib/phrase/api/blacklisted_keys_api.rb +376 -0
  187. data/lib/phrase/api/branches_api.rb +524 -0
  188. data/lib/phrase/api/comments_api.rb +657 -0
  189. data/lib/phrase/api/distributions_api.rb +376 -0
  190. data/lib/phrase/api/formats_api.rb +70 -0
  191. data/lib/phrase/api/git_lab_sync_api.rb +510 -0
  192. data/lib/phrase/api/glossary_api.rb +376 -0
  193. data/lib/phrase/api/glossary_term_translations_api.rb +268 -0
  194. data/lib/phrase/api/glossary_terms_api.rb +406 -0
  195. data/lib/phrase/api/invitations_api.rb +448 -0
  196. data/lib/phrase/api/job_locales_api.rb +587 -0
  197. data/lib/phrase/api/jobs_api.rb +790 -0
  198. data/lib/phrase/api/keys_api.rb +700 -0
  199. data/lib/phrase/api/locales_api.rb +497 -0
  200. data/lib/phrase/api/members_api.rb +304 -0
  201. data/lib/phrase/api/orders_api.rb +385 -0
  202. data/lib/phrase/api/projects_api.rb +346 -0
  203. data/lib/phrase/api/releases_api.rb +484 -0
  204. data/lib/phrase/api/screenshot_markers_api.rb +394 -0
  205. data/lib/phrase/api/screenshots_api.rb +376 -0
  206. data/lib/phrase/api/spaces_api.rb +608 -0
  207. data/lib/phrase/api/style_guides_api.rb +376 -0
  208. data/lib/phrase/api/tags_api.rb +305 -0
  209. data/lib/phrase/api/translations_api.rb +1351 -0
  210. data/lib/phrase/api/uploads_api.rb +265 -0
  211. data/lib/phrase/api/users_api.rb +70 -0
  212. data/lib/phrase/api/versions_history_api.rb +172 -0
  213. data/lib/phrase/api/webhooks_api.rb +446 -0
  214. data/lib/phrase/api_client.rb +376 -0
  215. data/lib/phrase/api_error.rb +45 -0
  216. data/lib/phrase/configuration.rb +243 -0
  217. data/lib/phrase/models/account.rb +230 -0
  218. data/lib/phrase/models/account_details.rb +247 -0
  219. data/lib/phrase/models/account_details1.rb +194 -0
  220. data/lib/phrase/models/affected_count.rb +194 -0
  221. data/lib/phrase/models/affected_resources.rb +194 -0
  222. data/lib/phrase/models/authorization.rb +259 -0
  223. data/lib/phrase/models/authorization_create_parameters.rb +217 -0
  224. data/lib/phrase/models/authorization_update_parameters.rb +217 -0
  225. data/lib/phrase/models/authorization_with_token.rb +276 -0
  226. data/lib/phrase/models/authorization_with_token1.rb +194 -0
  227. data/lib/phrase/models/bitbucket_sync.rb +241 -0
  228. data/lib/phrase/models/bitbucket_sync_export_parameters.rb +195 -0
  229. data/lib/phrase/models/bitbucket_sync_export_response.rb +194 -0
  230. data/lib/phrase/models/bitbucket_sync_import_parameters.rb +195 -0
  231. data/lib/phrase/models/blacklisted_key.rb +221 -0
  232. data/lib/phrase/models/blacklisted_key_create_parameters.rb +195 -0
  233. data/lib/phrase/models/blacklisted_key_update_parameters.rb +195 -0
  234. data/lib/phrase/models/branch.rb +248 -0
  235. data/lib/phrase/models/branch_create_parameters.rb +195 -0
  236. data/lib/phrase/models/branch_merge_parameters.rb +195 -0
  237. data/lib/phrase/models/branch_update_parameters.rb +195 -0
  238. data/lib/phrase/models/comment.rb +230 -0
  239. data/lib/phrase/models/comment_create_parameters.rb +205 -0
  240. data/lib/phrase/models/comment_mark_read_parameters.rb +195 -0
  241. data/lib/phrase/models/comment_update_parameters.rb +205 -0
  242. data/lib/phrase/models/distribution.rb +252 -0
  243. data/lib/phrase/models/distribution_create_parameters.rb +259 -0
  244. data/lib/phrase/models/distribution_preview.rb +250 -0
  245. data/lib/phrase/models/distribution_update_parameters.rb +259 -0
  246. data/lib/phrase/models/format.rb +275 -0
  247. data/lib/phrase/models/gitlab_sync.rb +284 -0
  248. data/lib/phrase/models/gitlab_sync_export.rb +203 -0
  249. data/lib/phrase/models/gitlab_sync_export_parameters.rb +195 -0
  250. data/lib/phrase/models/gitlab_sync_history.rb +232 -0
  251. data/lib/phrase/models/gitlab_sync_import_parameters.rb +195 -0
  252. data/lib/phrase/models/glossary.rb +232 -0
  253. data/lib/phrase/models/glossary_create_parameters.rb +217 -0
  254. data/lib/phrase/models/glossary_term.rb +259 -0
  255. data/lib/phrase/models/glossary_term_create_parameters.rb +225 -0
  256. data/lib/phrase/models/glossary_term_translation.rb +230 -0
  257. data/lib/phrase/models/glossary_term_translation_create_parameters.rb +205 -0
  258. data/lib/phrase/models/glossary_term_translation_update_parameters.rb +205 -0
  259. data/lib/phrase/models/glossary_term_update_parameters.rb +225 -0
  260. data/lib/phrase/models/glossary_update_parameters.rb +217 -0
  261. data/lib/phrase/models/invitation.rb +279 -0
  262. data/lib/phrase/models/invitation_create_parameters.rb +237 -0
  263. data/lib/phrase/models/invitation_update_parameters.rb +227 -0
  264. data/lib/phrase/models/job.rb +248 -0
  265. data/lib/phrase/models/job_complete_parameters.rb +195 -0
  266. data/lib/phrase/models/job_create_parameters.rb +249 -0
  267. data/lib/phrase/models/job_details.rb +296 -0
  268. data/lib/phrase/models/job_details1.rb +225 -0
  269. data/lib/phrase/models/job_keys_create_parameters.rb +207 -0
  270. data/lib/phrase/models/job_locale.rb +223 -0
  271. data/lib/phrase/models/job_locale_complete_parameters.rb +195 -0
  272. data/lib/phrase/models/job_locale_reopen_parameters.rb +195 -0
  273. data/lib/phrase/models/job_locale_update_parameters.rb +217 -0
  274. data/lib/phrase/models/job_locales_create_parameters.rb +217 -0
  275. data/lib/phrase/models/job_preview.rb +212 -0
  276. data/lib/phrase/models/job_reopen_parameters.rb +195 -0
  277. data/lib/phrase/models/job_start_parameters.rb +195 -0
  278. data/lib/phrase/models/job_update_parameters.rb +225 -0
  279. data/lib/phrase/models/key_create_parameters.rb +335 -0
  280. data/lib/phrase/models/key_preview.rb +212 -0
  281. data/lib/phrase/models/key_update_parameters.rb +335 -0
  282. data/lib/phrase/models/keys_search_parameters.rb +235 -0
  283. data/lib/phrase/models/keys_tag_parameters.rb +225 -0
  284. data/lib/phrase/models/keys_untag_parameters.rb +225 -0
  285. data/lib/phrase/models/locale.rb +277 -0
  286. data/lib/phrase/models/locale_create_parameters.rb +285 -0
  287. data/lib/phrase/models/locale_details.rb +294 -0
  288. data/lib/phrase/models/locale_details1.rb +194 -0
  289. data/lib/phrase/models/locale_preview.rb +212 -0
  290. data/lib/phrase/models/locale_statistics.rb +248 -0
  291. data/lib/phrase/models/locale_update_parameters.rb +285 -0
  292. data/lib/phrase/models/member.rb +232 -0
  293. data/lib/phrase/models/member_update_parameters.rb +227 -0
  294. data/lib/phrase/models/order_confirm_parameters.rb +195 -0
  295. data/lib/phrase/models/order_create_parameters.rb +327 -0
  296. data/lib/phrase/models/project.rb +248 -0
  297. data/lib/phrase/models/project_create_parameters.rb +245 -0
  298. data/lib/phrase/models/project_details.rb +274 -0
  299. data/lib/phrase/models/project_details1.rb +203 -0
  300. data/lib/phrase/models/project_locales.rb +249 -0
  301. data/lib/phrase/models/project_locales1.rb +196 -0
  302. data/lib/phrase/models/project_short.rb +230 -0
  303. data/lib/phrase/models/project_update_parameters.rb +245 -0
  304. data/lib/phrase/models/release.rb +290 -0
  305. data/lib/phrase/models/release_create_parameters.rb +217 -0
  306. data/lib/phrase/models/release_preview.rb +290 -0
  307. data/lib/phrase/models/release_update_parameters.rb +217 -0
  308. data/lib/phrase/models/screenshot.rb +248 -0
  309. data/lib/phrase/models/screenshot_create_parameters.rb +215 -0
  310. data/lib/phrase/models/screenshot_marker.rb +239 -0
  311. data/lib/phrase/models/screenshot_marker_create_parameters.rb +205 -0
  312. data/lib/phrase/models/screenshot_marker_update_parameters.rb +205 -0
  313. data/lib/phrase/models/screenshot_update_parameters.rb +215 -0
  314. data/lib/phrase/models/space.rb +241 -0
  315. data/lib/phrase/models/space_create_parameters.rb +195 -0
  316. data/lib/phrase/models/space_update_parameters.rb +195 -0
  317. data/lib/phrase/models/spaces_projects_create_parameters.rb +195 -0
  318. data/lib/phrase/models/styleguide.rb +221 -0
  319. data/lib/phrase/models/styleguide_create_parameters.rb +315 -0
  320. data/lib/phrase/models/styleguide_details.rb +346 -0
  321. data/lib/phrase/models/styleguide_details1.rb +302 -0
  322. data/lib/phrase/models/styleguide_preview.rb +203 -0
  323. data/lib/phrase/models/styleguide_update_parameters.rb +315 -0
  324. data/lib/phrase/models/tag.rb +221 -0
  325. data/lib/phrase/models/tag_create_parameters.rb +205 -0
  326. data/lib/phrase/models/tag_with_stats.rb +240 -0
  327. data/lib/phrase/models/tag_with_stats1.rb +196 -0
  328. data/lib/phrase/models/tag_with_stats1_statistics.rb +221 -0
  329. data/lib/phrase/models/tag_with_stats1_statistics1.rb +203 -0
  330. data/lib/phrase/models/translation.rb +286 -0
  331. data/lib/phrase/models/translation_create_parameters.rb +265 -0
  332. data/lib/phrase/models/translation_details.rb +312 -0
  333. data/lib/phrase/models/translation_details1.rb +203 -0
  334. data/lib/phrase/models/translation_exclude_parameters.rb +195 -0
  335. data/lib/phrase/models/translation_include_parameters.rb +195 -0
  336. data/lib/phrase/models/translation_key.rb +268 -0
  337. data/lib/phrase/models/translation_key_details.rb +357 -0
  338. data/lib/phrase/models/translation_key_details1.rb +266 -0
  339. data/lib/phrase/models/translation_order.rb +340 -0
  340. data/lib/phrase/models/translation_review_parameters.rb +195 -0
  341. data/lib/phrase/models/translation_unverify_parameters.rb +195 -0
  342. data/lib/phrase/models/translation_update_parameters.rb +245 -0
  343. data/lib/phrase/models/translation_verify_parameters.rb +195 -0
  344. data/lib/phrase/models/translation_version.rb +257 -0
  345. data/lib/phrase/models/translation_version_with_user.rb +274 -0
  346. data/lib/phrase/models/translation_version_with_user1.rb +194 -0
  347. data/lib/phrase/models/translations_exclude_parameters.rb +225 -0
  348. data/lib/phrase/models/translations_include_parameters.rb +225 -0
  349. data/lib/phrase/models/translations_review_parameters.rb +205 -0
  350. data/lib/phrase/models/translations_search_parameters.rb +225 -0
  351. data/lib/phrase/models/translations_unverify_parameters.rb +225 -0
  352. data/lib/phrase/models/translations_verify_parameters.rb +225 -0
  353. data/lib/phrase/models/upload.rb +257 -0
  354. data/lib/phrase/models/upload_create_parameters.rb +339 -0
  355. data/lib/phrase/models/upload_summary.rb +257 -0
  356. data/lib/phrase/models/user.rb +248 -0
  357. data/lib/phrase/models/user_preview.rb +212 -0
  358. data/lib/phrase/models/webhook.rb +250 -0
  359. data/lib/phrase/models/webhook_create_parameters.rb +225 -0
  360. data/lib/phrase/models/webhook_update_parameters.rb +225 -0
  361. data/lib/phrase/response.rb +41 -0
  362. data/lib/phrase/version.rb +1 -1
  363. data/phrase.gemspec +27 -27
  364. data/spec/api/accounts_api_spec.rb +50 -0
  365. data/spec/api/authorizations_api_spec.rb +90 -0
  366. data/spec/api/bitbucket_sync_api_spec.rb +64 -0
  367. data/spec/api/blacklisted_keys_api_spec.rb +95 -0
  368. data/spec/api/branches_api_spec.rb +124 -0
  369. data/spec/api/comments_api_spec.rb +151 -0
  370. data/spec/api/distributions_api_spec.rb +95 -0
  371. data/spec/api/formats_api_spec.rb +35 -0
  372. data/spec/api/git_lab_sync_api_spec.rb +125 -0
  373. data/spec/api/glossary_api_spec.rb +95 -0
  374. data/spec/api/glossary_term_translations_api_spec.rb +72 -0
  375. data/spec/api/glossary_terms_api_spec.rb +100 -0
  376. data/spec/api/invitations_api_spec.rb +109 -0
  377. data/spec/api/job_locales_api_spec.rb +135 -0
  378. data/spec/api/jobs_api_spec.rb +177 -0
  379. data/spec/api/keys_api_spec.rb +162 -0
  380. data/spec/api/locales_api_spec.rb +126 -0
  381. data/spec/api/members_api_spec.rb +81 -0
  382. data/spec/api/orders_api_spec.rb +98 -0
  383. data/spec/api/projects_api_spec.rb +90 -0
  384. data/spec/api/releases_api_spec.rb +115 -0
  385. data/spec/api/screenshot_markers_api_spec.rb +98 -0
  386. data/spec/api/screenshots_api_spec.rb +95 -0
  387. data/spec/api/spaces_api_spec.rb +141 -0
  388. data/spec/api/style_guides_api_spec.rb +95 -0
  389. data/spec/api/tags_api_spec.rb +83 -0
  390. data/spec/api/translations_api_spec.rb +287 -0
  391. data/spec/api/uploads_api_spec.rb +80 -0
  392. data/spec/api/users_api_spec.rb +35 -0
  393. data/spec/api/versions_history_api_spec.rb +56 -0
  394. data/spec/api/webhooks_api_spec.rb +109 -0
  395. data/spec/api_client_spec.rb +214 -0
  396. data/spec/configuration_spec.rb +30 -0
  397. data/spec/models/account_details1_spec.rb +29 -0
  398. data/spec/models/account_details_spec.rb +59 -0
  399. data/spec/models/account_spec.rb +53 -0
  400. data/spec/models/affected_count_spec.rb +29 -0
  401. data/spec/models/affected_resources_spec.rb +29 -0
  402. data/spec/models/authorization_create_parameters_spec.rb +41 -0
  403. data/spec/models/authorization_spec.rb +71 -0
  404. data/spec/models/authorization_update_parameters_spec.rb +41 -0
  405. data/spec/models/authorization_with_token1_spec.rb +29 -0
  406. data/spec/models/authorization_with_token_spec.rb +77 -0
  407. data/spec/models/bitbucket_sync_export_parameters_spec.rb +29 -0
  408. data/spec/models/bitbucket_sync_export_response_spec.rb +29 -0
  409. data/spec/models/bitbucket_sync_import_parameters_spec.rb +29 -0
  410. data/spec/models/bitbucket_sync_spec.rb +59 -0
  411. data/spec/models/blacklisted_key_create_parameters_spec.rb +29 -0
  412. data/spec/models/blacklisted_key_spec.rb +47 -0
  413. data/spec/models/blacklisted_key_update_parameters_spec.rb +29 -0
  414. data/spec/models/branch_create_parameters_spec.rb +29 -0
  415. data/spec/models/branch_merge_parameters_spec.rb +29 -0
  416. data/spec/models/branch_spec.rb +65 -0
  417. data/spec/models/branch_update_parameters_spec.rb +29 -0
  418. data/spec/models/comment_create_parameters_spec.rb +35 -0
  419. data/spec/models/comment_mark_read_parameters_spec.rb +29 -0
  420. data/spec/models/comment_spec.rb +53 -0
  421. data/spec/models/comment_update_parameters_spec.rb +35 -0
  422. data/spec/models/distribution_create_parameters_spec.rb +65 -0
  423. data/spec/models/distribution_preview_spec.rb +65 -0
  424. data/spec/models/distribution_spec.rb +65 -0
  425. data/spec/models/distribution_update_parameters_spec.rb +65 -0
  426. data/spec/models/format_spec.rb +83 -0
  427. data/spec/models/gitlab_sync_export_parameters_spec.rb +29 -0
  428. data/spec/models/gitlab_sync_export_spec.rb +35 -0
  429. data/spec/models/gitlab_sync_history_spec.rb +53 -0
  430. data/spec/models/gitlab_sync_import_parameters_spec.rb +29 -0
  431. data/spec/models/gitlab_sync_spec.rb +89 -0
  432. data/spec/models/glossary_create_parameters_spec.rb +41 -0
  433. data/spec/models/glossary_spec.rb +53 -0
  434. data/spec/models/glossary_term_create_parameters_spec.rb +47 -0
  435. data/spec/models/glossary_term_spec.rb +71 -0
  436. data/spec/models/glossary_term_translation_create_parameters_spec.rb +35 -0
  437. data/spec/models/glossary_term_translation_spec.rb +53 -0
  438. data/spec/models/glossary_term_translation_update_parameters_spec.rb +35 -0
  439. data/spec/models/glossary_term_update_parameters_spec.rb +47 -0
  440. data/spec/models/glossary_update_parameters_spec.rb +41 -0
  441. data/spec/models/invitation_create_parameters_spec.rb +53 -0
  442. data/spec/models/invitation_spec.rb +83 -0
  443. data/spec/models/invitation_update_parameters_spec.rb +47 -0
  444. data/spec/models/job_complete_parameters_spec.rb +29 -0
  445. data/spec/models/job_create_parameters_spec.rb +59 -0
  446. data/spec/models/job_details1_spec.rb +47 -0
  447. data/spec/models/job_details_spec.rb +89 -0
  448. data/spec/models/job_keys_create_parameters_spec.rb +35 -0
  449. data/spec/models/job_locale_complete_parameters_spec.rb +29 -0
  450. data/spec/models/job_locale_reopen_parameters_spec.rb +29 -0
  451. data/spec/models/job_locale_spec.rb +47 -0
  452. data/spec/models/job_locale_update_parameters_spec.rb +41 -0
  453. data/spec/models/job_locales_create_parameters_spec.rb +41 -0
  454. data/spec/models/job_preview_spec.rb +41 -0
  455. data/spec/models/job_reopen_parameters_spec.rb +29 -0
  456. data/spec/models/job_spec.rb +65 -0
  457. data/spec/models/job_start_parameters_spec.rb +29 -0
  458. data/spec/models/job_update_parameters_spec.rb +47 -0
  459. data/spec/models/key_create_parameters_spec.rb +113 -0
  460. data/spec/models/key_preview_spec.rb +41 -0
  461. data/spec/models/key_update_parameters_spec.rb +113 -0
  462. data/spec/models/keys_search_parameters_spec.rb +53 -0
  463. data/spec/models/keys_tag_parameters_spec.rb +47 -0
  464. data/spec/models/keys_untag_parameters_spec.rb +47 -0
  465. data/spec/models/locale_create_parameters_spec.rb +83 -0
  466. data/spec/models/locale_details1_spec.rb +29 -0
  467. data/spec/models/locale_details_spec.rb +89 -0
  468. data/spec/models/locale_preview_spec.rb +41 -0
  469. data/spec/models/locale_spec.rb +83 -0
  470. data/spec/models/locale_statistics_spec.rb +65 -0
  471. data/spec/models/locale_update_parameters_spec.rb +83 -0
  472. data/spec/models/member_spec.rb +53 -0
  473. data/spec/models/member_update_parameters_spec.rb +47 -0
  474. data/spec/models/order_confirm_parameters_spec.rb +29 -0
  475. data/spec/models/order_create_parameters_spec.rb +107 -0
  476. data/spec/models/project_create_parameters_spec.rb +59 -0
  477. data/spec/models/project_details1_spec.rb +35 -0
  478. data/spec/models/project_details_spec.rb +77 -0
  479. data/spec/models/project_locales1_spec.rb +29 -0
  480. data/spec/models/project_locales_spec.rb +59 -0
  481. data/spec/models/project_short_spec.rb +53 -0
  482. data/spec/models/project_spec.rb +65 -0
  483. data/spec/models/project_update_parameters_spec.rb +59 -0
  484. data/spec/models/release_create_parameters_spec.rb +41 -0
  485. data/spec/models/release_preview_spec.rb +89 -0
  486. data/spec/models/release_spec.rb +89 -0
  487. data/spec/models/release_update_parameters_spec.rb +41 -0
  488. data/spec/models/screenshot_create_parameters_spec.rb +41 -0
  489. data/spec/models/screenshot_marker_create_parameters_spec.rb +35 -0
  490. data/spec/models/screenshot_marker_spec.rb +59 -0
  491. data/spec/models/screenshot_marker_update_parameters_spec.rb +35 -0
  492. data/spec/models/screenshot_spec.rb +65 -0
  493. data/spec/models/screenshot_update_parameters_spec.rb +41 -0
  494. data/spec/models/space_create_parameters_spec.rb +29 -0
  495. data/spec/models/space_spec.rb +59 -0
  496. data/spec/models/space_update_parameters_spec.rb +29 -0
  497. data/spec/models/spaces_projects_create_parameters_spec.rb +29 -0
  498. data/spec/models/styleguide_create_parameters_spec.rb +101 -0
  499. data/spec/models/styleguide_details1_spec.rb +101 -0
  500. data/spec/models/styleguide_details_spec.rb +125 -0
  501. data/spec/models/styleguide_preview_spec.rb +35 -0
  502. data/spec/models/styleguide_spec.rb +47 -0
  503. data/spec/models/styleguide_update_parameters_spec.rb +101 -0
  504. data/spec/models/tag_create_parameters_spec.rb +35 -0
  505. data/spec/models/tag_spec.rb +47 -0
  506. data/spec/models/tag_with_stats1_spec.rb +29 -0
  507. data/spec/models/tag_with_stats1_statistics1_spec.rb +35 -0
  508. data/spec/models/tag_with_stats1_statistics_spec.rb +47 -0
  509. data/spec/models/tag_with_stats_spec.rb +53 -0
  510. data/spec/models/translation_create_parameters_spec.rb +71 -0
  511. data/spec/models/translation_details1_spec.rb +35 -0
  512. data/spec/models/translation_details_spec.rb +101 -0
  513. data/spec/models/translation_exclude_parameters_spec.rb +29 -0
  514. data/spec/models/translation_include_parameters_spec.rb +29 -0
  515. data/spec/models/translation_key_details1_spec.rb +77 -0
  516. data/spec/models/translation_key_details_spec.rb +131 -0
  517. data/spec/models/translation_key_spec.rb +77 -0
  518. data/spec/models/translation_order_spec.rb +125 -0
  519. data/spec/models/translation_review_parameters_spec.rb +29 -0
  520. data/spec/models/translation_spec.rb +89 -0
  521. data/spec/models/translation_unverify_parameters_spec.rb +29 -0
  522. data/spec/models/translation_update_parameters_spec.rb +59 -0
  523. data/spec/models/translation_verify_parameters_spec.rb +29 -0
  524. data/spec/models/translation_version_spec.rb +71 -0
  525. data/spec/models/translation_version_with_user1_spec.rb +29 -0
  526. data/spec/models/translation_version_with_user_spec.rb +77 -0
  527. data/spec/models/translations_exclude_parameters_spec.rb +47 -0
  528. data/spec/models/translations_include_parameters_spec.rb +47 -0
  529. data/spec/models/translations_review_parameters_spec.rb +35 -0
  530. data/spec/models/translations_search_parameters_spec.rb +47 -0
  531. data/spec/models/translations_unverify_parameters_spec.rb +47 -0
  532. data/spec/models/translations_verify_parameters_spec.rb +47 -0
  533. data/spec/models/upload_create_parameters_spec.rb +113 -0
  534. data/spec/models/upload_spec.rb +71 -0
  535. data/spec/models/upload_summary_spec.rb +71 -0
  536. data/spec/models/user_preview_spec.rb +41 -0
  537. data/spec/models/user_spec.rb +65 -0
  538. data/spec/models/webhook_create_parameters_spec.rb +47 -0
  539. data/spec/models/webhook_spec.rb +65 -0
  540. data/spec/models/webhook_update_parameters_spec.rb +47 -0
  541. data/spec/spec_helper.rb +99 -0
  542. metadata +759 -190
  543. data/.gitignore +0 -25
  544. data/.travis.yml +0 -6
  545. data/Guardfile +0 -29
  546. data/bin/phrase +0 -8
  547. data/cacert.pem +0 -3366
  548. data/lib/ext/all.rb +0 -5
  549. data/lib/ext/hash.rb +0 -8
  550. data/lib/ext/object.rb +0 -130
  551. data/lib/ext/try.rb +0 -57
  552. data/lib/generators/phrase/install_generator.rb +0 -37
  553. data/lib/generators/templates/README +0 -11
  554. data/lib/generators/templates/phrase.rb +0 -21
  555. data/lib/phrase/adapters/fast_gettext.rb +0 -25
  556. data/lib/phrase/adapters/i18n.rb +0 -12
  557. data/lib/phrase/api.rb +0 -7
  558. data/lib/phrase/api/client.rb +0 -308
  559. data/lib/phrase/api/client/http.rb +0 -56
  560. data/lib/phrase/api/config.rb +0 -34
  561. data/lib/phrase/api/exceptions.rb +0 -9
  562. data/lib/phrase/api/query_params.rb +0 -22
  563. data/lib/phrase/backend.rb +0 -7
  564. data/lib/phrase/backend/base.rb +0 -6
  565. data/lib/phrase/backend/phrase_service.rb +0 -163
  566. data/lib/phrase/cache.rb +0 -34
  567. data/lib/phrase/config.rb +0 -94
  568. data/lib/phrase/delegate.rb +0 -36
  569. data/lib/phrase/delegate/fast_gettext.rb +0 -27
  570. data/lib/phrase/delegate/i18n.rb +0 -166
  571. data/lib/phrase/engine.rb +0 -17
  572. data/lib/phrase/formats.rb +0 -176
  573. data/lib/phrase/formats/angular_translate.rb +0 -19
  574. data/lib/phrase/formats/csv.rb +0 -19
  575. data/lib/phrase/formats/custom.rb +0 -40
  576. data/lib/phrase/formats/gettext.rb +0 -27
  577. data/lib/phrase/formats/gettext_template.rb +0 -19
  578. data/lib/phrase/formats/go_i18n.rb +0 -23
  579. data/lib/phrase/formats/ini.rb +0 -19
  580. data/lib/phrase/formats/json.rb +0 -19
  581. data/lib/phrase/formats/laravel.rb +0 -19
  582. data/lib/phrase/formats/mozilla_properties.rb +0 -8
  583. data/lib/phrase/formats/nested_json.rb +0 -19
  584. data/lib/phrase/formats/node_json.rb +0 -23
  585. data/lib/phrase/formats/php_array.rb +0 -19
  586. data/lib/phrase/formats/play_properties.rb +0 -15
  587. data/lib/phrase/formats/plist.rb +0 -19
  588. data/lib/phrase/formats/properties.rb +0 -19
  589. data/lib/phrase/formats/properties_xml.rb +0 -19
  590. data/lib/phrase/formats/qt_phrase_book.rb +0 -19
  591. data/lib/phrase/formats/qt_translation_source.rb +0 -19
  592. data/lib/phrase/formats/resx.rb +0 -19
  593. data/lib/phrase/formats/resx_windowsphone.rb +0 -19
  594. data/lib/phrase/formats/simple_json.rb +0 -19
  595. data/lib/phrase/formats/strings.rb +0 -45
  596. data/lib/phrase/formats/stringsdict.rb +0 -15
  597. data/lib/phrase/formats/tmx.rb +0 -19
  598. data/lib/phrase/formats/windows8_resource.rb +0 -19
  599. data/lib/phrase/formats/xliff.rb +0 -19
  600. data/lib/phrase/formats/xml.rb +0 -49
  601. data/lib/phrase/formats/yaml.rb +0 -19
  602. data/lib/phrase/formats/yaml_symfony.rb +0 -19
  603. data/lib/phrase/formats/yaml_symfony2.rb +0 -8
  604. data/lib/phrase/hash_flattener.rb +0 -21
  605. data/lib/phrase/tool.rb +0 -46
  606. data/lib/phrase/tool/commands.rb +0 -56
  607. data/lib/phrase/tool/commands/base.rb +0 -73
  608. data/lib/phrase/tool/commands/init.rb +0 -51
  609. data/lib/phrase/tool/commands/pull.rb +0 -109
  610. data/lib/phrase/tool/commands/push.rb +0 -163
  611. data/lib/phrase/tool/commands/show_help.rb +0 -26
  612. data/lib/phrase/tool/commands/show_version.rb +0 -17
  613. data/lib/phrase/tool/commands/tags.rb +0 -29
  614. data/lib/phrase/tool/config.rb +0 -122
  615. data/lib/phrase/tool/encoding_detector.rb +0 -17
  616. data/lib/phrase/tool/locale.rb +0 -41
  617. data/lib/phrase/tool/options.rb +0 -32
  618. data/lib/phrase/tool/options_factory.rb +0 -150
  619. data/lib/phrase/tool/tag_validator.rb +0 -9
  620. data/lib/phrase/view_helpers.rb +0 -19
@@ -0,0 +1,1351 @@
1
+ require 'cgi'
2
+
3
+ module Phrase
4
+ class TranslationsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+ # Create a translation
11
+ # Create a translation.
12
+ # @param project_id [String] Project ID
13
+ # @param translation_create_parameters [TranslationCreateParameters]
14
+ # @param [Hash] opts the optional parameters
15
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
16
+ # @return [nil]
17
+ def translation_create(project_id, translation_create_parameters, opts = {})
18
+ translation_create_with_http_info(project_id, translation_create_parameters, opts)
19
+ nil
20
+ end
21
+
22
+ # Create a translation
23
+ # Create a translation.
24
+ # @param project_id [String] Project ID
25
+ # @param translation_create_parameters [TranslationCreateParameters]
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
28
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
29
+ def translation_create_with_http_info(project_id, translation_create_parameters, opts = {})
30
+ if @api_client.config.debugging
31
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_create ...'
32
+ end
33
+ # verify the required parameter 'project_id' is set
34
+ if @api_client.config.client_side_validation && project_id.nil?
35
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_create"
36
+ end
37
+ # verify the required parameter 'translation_create_parameters' is set
38
+ if @api_client.config.client_side_validation && translation_create_parameters.nil?
39
+ fail ArgumentError, "Missing the required parameter 'translation_create_parameters' when calling TranslationsApi.translation_create"
40
+ end
41
+ # resource path
42
+ local_var_path = '/projects/{project_id}/translations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
43
+
44
+ # query parameters
45
+ query_params = opts[:query_params] || {}
46
+
47
+ # header parameters
48
+ header_params = opts[:header_params] || {}
49
+ # HTTP header 'Content-Type'
50
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
51
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
52
+
53
+ # form parameters
54
+ form_params = opts[:form_params] || {}
55
+
56
+ # http body (model)
57
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_create_parameters)
58
+
59
+ # return_type
60
+ return_type = opts[:return_type]
61
+
62
+ # auth_names
63
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
64
+
65
+ new_options = opts.merge(
66
+ :header_params => header_params,
67
+ :query_params => query_params,
68
+ :form_params => form_params,
69
+ :body => post_body,
70
+ :auth_names => auth_names,
71
+ :return_type => return_type
72
+ )
73
+
74
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
75
+ if @api_client.config.debugging
76
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
77
+ end
78
+ response = ::Phrase::Response.new(data, headers)
79
+ return response, status_code, headers
80
+ end
81
+
82
+ # Exclude a translation from export
83
+ # Set exclude from export flag on an existing translation.
84
+ # @param project_id [String] Project ID
85
+ # @param id [String] ID
86
+ # @param translation_exclude_parameters [TranslationExcludeParameters]
87
+ # @param [Hash] opts the optional parameters
88
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
89
+ # @return [TranslationDetails]
90
+ def translation_exclude(project_id, id, translation_exclude_parameters, opts = {})
91
+ data, _status_code, _headers = translation_exclude_with_http_info(project_id, id, translation_exclude_parameters, opts)
92
+ data
93
+ end
94
+
95
+ # Exclude a translation from export
96
+ # Set exclude from export flag on an existing translation.
97
+ # @param project_id [String] Project ID
98
+ # @param id [String] ID
99
+ # @param translation_exclude_parameters [TranslationExcludeParameters]
100
+ # @param [Hash] opts the optional parameters
101
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
102
+ # @return [Array<(Response<(TranslationDetails)>, Integer, Hash)>] Response<(TranslationDetails)> data, response status code and response headers
103
+ def translation_exclude_with_http_info(project_id, id, translation_exclude_parameters, opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_exclude ...'
106
+ end
107
+ # verify the required parameter 'project_id' is set
108
+ if @api_client.config.client_side_validation && project_id.nil?
109
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_exclude"
110
+ end
111
+ # verify the required parameter 'id' is set
112
+ if @api_client.config.client_side_validation && id.nil?
113
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_exclude"
114
+ end
115
+ # verify the required parameter 'translation_exclude_parameters' is set
116
+ if @api_client.config.client_side_validation && translation_exclude_parameters.nil?
117
+ fail ArgumentError, "Missing the required parameter 'translation_exclude_parameters' when calling TranslationsApi.translation_exclude"
118
+ end
119
+ # resource path
120
+ local_var_path = '/projects/{project_id}/translations/{id}/exclude'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
121
+
122
+ # query parameters
123
+ query_params = opts[:query_params] || {}
124
+
125
+ # header parameters
126
+ header_params = opts[:header_params] || {}
127
+ # HTTP header 'Accept' (if needed)
128
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
129
+ # HTTP header 'Content-Type'
130
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
131
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
132
+
133
+ # form parameters
134
+ form_params = opts[:form_params] || {}
135
+
136
+ # http body (model)
137
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_exclude_parameters)
138
+
139
+ # return_type
140
+ return_type = opts[:return_type] || 'TranslationDetails'
141
+
142
+ # auth_names
143
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
144
+
145
+ new_options = opts.merge(
146
+ :header_params => header_params,
147
+ :query_params => query_params,
148
+ :form_params => form_params,
149
+ :body => post_body,
150
+ :auth_names => auth_names,
151
+ :return_type => return_type
152
+ )
153
+
154
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
155
+ if @api_client.config.debugging
156
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_exclude\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
157
+ end
158
+ response = ::Phrase::Response.new(data, headers)
159
+ return response, status_code, headers
160
+ end
161
+
162
+ # Revoke exclusion of a translation in export
163
+ # Remove exclude from export flag from an existing translation.
164
+ # @param project_id [String] Project ID
165
+ # @param id [String] ID
166
+ # @param translation_include_parameters [TranslationIncludeParameters]
167
+ # @param [Hash] opts the optional parameters
168
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
169
+ # @return [TranslationDetails]
170
+ def translation_include(project_id, id, translation_include_parameters, opts = {})
171
+ data, _status_code, _headers = translation_include_with_http_info(project_id, id, translation_include_parameters, opts)
172
+ data
173
+ end
174
+
175
+ # Revoke exclusion of a translation in export
176
+ # Remove exclude from export flag from an existing translation.
177
+ # @param project_id [String] Project ID
178
+ # @param id [String] ID
179
+ # @param translation_include_parameters [TranslationIncludeParameters]
180
+ # @param [Hash] opts the optional parameters
181
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
182
+ # @return [Array<(Response<(TranslationDetails)>, Integer, Hash)>] Response<(TranslationDetails)> data, response status code and response headers
183
+ def translation_include_with_http_info(project_id, id, translation_include_parameters, opts = {})
184
+ if @api_client.config.debugging
185
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_include ...'
186
+ end
187
+ # verify the required parameter 'project_id' is set
188
+ if @api_client.config.client_side_validation && project_id.nil?
189
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_include"
190
+ end
191
+ # verify the required parameter 'id' is set
192
+ if @api_client.config.client_side_validation && id.nil?
193
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_include"
194
+ end
195
+ # verify the required parameter 'translation_include_parameters' is set
196
+ if @api_client.config.client_side_validation && translation_include_parameters.nil?
197
+ fail ArgumentError, "Missing the required parameter 'translation_include_parameters' when calling TranslationsApi.translation_include"
198
+ end
199
+ # resource path
200
+ local_var_path = '/projects/{project_id}/translations/{id}/include'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
201
+
202
+ # query parameters
203
+ query_params = opts[:query_params] || {}
204
+
205
+ # header parameters
206
+ header_params = opts[:header_params] || {}
207
+ # HTTP header 'Accept' (if needed)
208
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
209
+ # HTTP header 'Content-Type'
210
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
211
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
212
+
213
+ # form parameters
214
+ form_params = opts[:form_params] || {}
215
+
216
+ # http body (model)
217
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_include_parameters)
218
+
219
+ # return_type
220
+ return_type = opts[:return_type] || 'TranslationDetails'
221
+
222
+ # auth_names
223
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
224
+
225
+ new_options = opts.merge(
226
+ :header_params => header_params,
227
+ :query_params => query_params,
228
+ :form_params => form_params,
229
+ :body => post_body,
230
+ :auth_names => auth_names,
231
+ :return_type => return_type
232
+ )
233
+
234
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
235
+ if @api_client.config.debugging
236
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_include\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
237
+ end
238
+ response = ::Phrase::Response.new(data, headers)
239
+ return response, status_code, headers
240
+ end
241
+
242
+ # Review a translation
243
+ # Mark an existing translation as reviewed.
244
+ # @param project_id [String] Project ID
245
+ # @param id [String] ID
246
+ # @param translation_review_parameters [TranslationReviewParameters]
247
+ # @param [Hash] opts the optional parameters
248
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
249
+ # @return [TranslationDetails]
250
+ def translation_review(project_id, id, translation_review_parameters, opts = {})
251
+ data, _status_code, _headers = translation_review_with_http_info(project_id, id, translation_review_parameters, opts)
252
+ data
253
+ end
254
+
255
+ # Review a translation
256
+ # Mark an existing translation as reviewed.
257
+ # @param project_id [String] Project ID
258
+ # @param id [String] ID
259
+ # @param translation_review_parameters [TranslationReviewParameters]
260
+ # @param [Hash] opts the optional parameters
261
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
262
+ # @return [Array<(Response<(TranslationDetails)>, Integer, Hash)>] Response<(TranslationDetails)> data, response status code and response headers
263
+ def translation_review_with_http_info(project_id, id, translation_review_parameters, opts = {})
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_review ...'
266
+ end
267
+ # verify the required parameter 'project_id' is set
268
+ if @api_client.config.client_side_validation && project_id.nil?
269
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_review"
270
+ end
271
+ # verify the required parameter 'id' is set
272
+ if @api_client.config.client_side_validation && id.nil?
273
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_review"
274
+ end
275
+ # verify the required parameter 'translation_review_parameters' is set
276
+ if @api_client.config.client_side_validation && translation_review_parameters.nil?
277
+ fail ArgumentError, "Missing the required parameter 'translation_review_parameters' when calling TranslationsApi.translation_review"
278
+ end
279
+ # resource path
280
+ local_var_path = '/projects/{project_id}/translations/{id}/review'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
281
+
282
+ # query parameters
283
+ query_params = opts[:query_params] || {}
284
+
285
+ # header parameters
286
+ header_params = opts[:header_params] || {}
287
+ # HTTP header 'Accept' (if needed)
288
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
289
+ # HTTP header 'Content-Type'
290
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
291
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
292
+
293
+ # form parameters
294
+ form_params = opts[:form_params] || {}
295
+
296
+ # http body (model)
297
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_review_parameters)
298
+
299
+ # return_type
300
+ return_type = opts[:return_type] || 'TranslationDetails'
301
+
302
+ # auth_names
303
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
304
+
305
+ new_options = opts.merge(
306
+ :header_params => header_params,
307
+ :query_params => query_params,
308
+ :form_params => form_params,
309
+ :body => post_body,
310
+ :auth_names => auth_names,
311
+ :return_type => return_type
312
+ )
313
+
314
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
315
+ if @api_client.config.debugging
316
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
317
+ end
318
+ response = ::Phrase::Response.new(data, headers)
319
+ return response, status_code, headers
320
+ end
321
+
322
+ # Get a single translation
323
+ # Get details on a single translation.
324
+ # @param project_id [String] Project ID
325
+ # @param id [String] ID
326
+ # @param [Hash] opts the optional parameters
327
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
328
+ # @option opts [String] :branch specify the branch to use
329
+ # @return [TranslationDetails]
330
+ def translation_show(project_id, id, opts = {})
331
+ data, _status_code, _headers = translation_show_with_http_info(project_id, id, opts)
332
+ data
333
+ end
334
+
335
+ # Get a single translation
336
+ # Get details on a single translation.
337
+ # @param project_id [String] Project ID
338
+ # @param id [String] ID
339
+ # @param [Hash] opts the optional parameters
340
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
341
+ # @option opts [String] :branch specify the branch to use
342
+ # @return [Array<(Response<(TranslationDetails)>, Integer, Hash)>] Response<(TranslationDetails)> data, response status code and response headers
343
+ def translation_show_with_http_info(project_id, id, opts = {})
344
+ if @api_client.config.debugging
345
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_show ...'
346
+ end
347
+ # verify the required parameter 'project_id' is set
348
+ if @api_client.config.client_side_validation && project_id.nil?
349
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_show"
350
+ end
351
+ # verify the required parameter 'id' is set
352
+ if @api_client.config.client_side_validation && id.nil?
353
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_show"
354
+ end
355
+ # resource path
356
+ local_var_path = '/projects/{project_id}/translations/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
357
+
358
+ # query parameters
359
+ query_params = opts[:query_params] || {}
360
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
361
+
362
+ # header parameters
363
+ header_params = opts[:header_params] || {}
364
+ # HTTP header 'Accept' (if needed)
365
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
366
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
367
+
368
+ # form parameters
369
+ form_params = opts[:form_params] || {}
370
+
371
+ # http body (model)
372
+ post_body = opts[:body]
373
+
374
+ # return_type
375
+ return_type = opts[:return_type] || 'TranslationDetails'
376
+
377
+ # auth_names
378
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
379
+
380
+ new_options = opts.merge(
381
+ :header_params => header_params,
382
+ :query_params => query_params,
383
+ :form_params => form_params,
384
+ :body => post_body,
385
+ :auth_names => auth_names,
386
+ :return_type => return_type
387
+ )
388
+
389
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
390
+ if @api_client.config.debugging
391
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
392
+ end
393
+ response = ::Phrase::Response.new(data, headers)
394
+ return response, status_code, headers
395
+ end
396
+
397
+ # Mark a translation as unverified
398
+ # Mark an existing translation as unverified.
399
+ # @param project_id [String] Project ID
400
+ # @param id [String] ID
401
+ # @param translation_unverify_parameters [TranslationUnverifyParameters]
402
+ # @param [Hash] opts the optional parameters
403
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
404
+ # @return [TranslationDetails]
405
+ def translation_unverify(project_id, id, translation_unverify_parameters, opts = {})
406
+ data, _status_code, _headers = translation_unverify_with_http_info(project_id, id, translation_unverify_parameters, opts)
407
+ data
408
+ end
409
+
410
+ # Mark a translation as unverified
411
+ # Mark an existing translation as unverified.
412
+ # @param project_id [String] Project ID
413
+ # @param id [String] ID
414
+ # @param translation_unverify_parameters [TranslationUnverifyParameters]
415
+ # @param [Hash] opts the optional parameters
416
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
417
+ # @return [Array<(Response<(TranslationDetails)>, Integer, Hash)>] Response<(TranslationDetails)> data, response status code and response headers
418
+ def translation_unverify_with_http_info(project_id, id, translation_unverify_parameters, opts = {})
419
+ if @api_client.config.debugging
420
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_unverify ...'
421
+ end
422
+ # verify the required parameter 'project_id' is set
423
+ if @api_client.config.client_side_validation && project_id.nil?
424
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_unverify"
425
+ end
426
+ # verify the required parameter 'id' is set
427
+ if @api_client.config.client_side_validation && id.nil?
428
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_unverify"
429
+ end
430
+ # verify the required parameter 'translation_unverify_parameters' is set
431
+ if @api_client.config.client_side_validation && translation_unverify_parameters.nil?
432
+ fail ArgumentError, "Missing the required parameter 'translation_unverify_parameters' when calling TranslationsApi.translation_unverify"
433
+ end
434
+ # resource path
435
+ local_var_path = '/projects/{project_id}/translations/{id}/unverify'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
436
+
437
+ # query parameters
438
+ query_params = opts[:query_params] || {}
439
+
440
+ # header parameters
441
+ header_params = opts[:header_params] || {}
442
+ # HTTP header 'Accept' (if needed)
443
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
444
+ # HTTP header 'Content-Type'
445
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
446
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
447
+
448
+ # form parameters
449
+ form_params = opts[:form_params] || {}
450
+
451
+ # http body (model)
452
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_unverify_parameters)
453
+
454
+ # return_type
455
+ return_type = opts[:return_type] || 'TranslationDetails'
456
+
457
+ # auth_names
458
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
459
+
460
+ new_options = opts.merge(
461
+ :header_params => header_params,
462
+ :query_params => query_params,
463
+ :form_params => form_params,
464
+ :body => post_body,
465
+ :auth_names => auth_names,
466
+ :return_type => return_type
467
+ )
468
+
469
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
470
+ if @api_client.config.debugging
471
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_unverify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
472
+ end
473
+ response = ::Phrase::Response.new(data, headers)
474
+ return response, status_code, headers
475
+ end
476
+
477
+ # Update a translation
478
+ # Update an existing translation.
479
+ # @param project_id [String] Project ID
480
+ # @param id [String] ID
481
+ # @param translation_update_parameters [TranslationUpdateParameters]
482
+ # @param [Hash] opts the optional parameters
483
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
484
+ # @return [TranslationDetails]
485
+ def translation_update(project_id, id, translation_update_parameters, opts = {})
486
+ data, _status_code, _headers = translation_update_with_http_info(project_id, id, translation_update_parameters, opts)
487
+ data
488
+ end
489
+
490
+ # Update a translation
491
+ # Update an existing translation.
492
+ # @param project_id [String] Project ID
493
+ # @param id [String] ID
494
+ # @param translation_update_parameters [TranslationUpdateParameters]
495
+ # @param [Hash] opts the optional parameters
496
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
497
+ # @return [Array<(Response<(TranslationDetails)>, Integer, Hash)>] Response<(TranslationDetails)> data, response status code and response headers
498
+ def translation_update_with_http_info(project_id, id, translation_update_parameters, opts = {})
499
+ if @api_client.config.debugging
500
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_update ...'
501
+ end
502
+ # verify the required parameter 'project_id' is set
503
+ if @api_client.config.client_side_validation && project_id.nil?
504
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_update"
505
+ end
506
+ # verify the required parameter 'id' is set
507
+ if @api_client.config.client_side_validation && id.nil?
508
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_update"
509
+ end
510
+ # verify the required parameter 'translation_update_parameters' is set
511
+ if @api_client.config.client_side_validation && translation_update_parameters.nil?
512
+ fail ArgumentError, "Missing the required parameter 'translation_update_parameters' when calling TranslationsApi.translation_update"
513
+ end
514
+ # resource path
515
+ local_var_path = '/projects/{project_id}/translations/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
516
+
517
+ # query parameters
518
+ query_params = opts[:query_params] || {}
519
+
520
+ # header parameters
521
+ header_params = opts[:header_params] || {}
522
+ # HTTP header 'Accept' (if needed)
523
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
524
+ # HTTP header 'Content-Type'
525
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
526
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
527
+
528
+ # form parameters
529
+ form_params = opts[:form_params] || {}
530
+
531
+ # http body (model)
532
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_update_parameters)
533
+
534
+ # return_type
535
+ return_type = opts[:return_type] || 'TranslationDetails'
536
+
537
+ # auth_names
538
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
539
+
540
+ new_options = opts.merge(
541
+ :header_params => header_params,
542
+ :query_params => query_params,
543
+ :form_params => form_params,
544
+ :body => post_body,
545
+ :auth_names => auth_names,
546
+ :return_type => return_type
547
+ )
548
+
549
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
550
+ if @api_client.config.debugging
551
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
552
+ end
553
+ response = ::Phrase::Response.new(data, headers)
554
+ return response, status_code, headers
555
+ end
556
+
557
+ # Verify a translation
558
+ # Verify an existing translation.
559
+ # @param project_id [String] Project ID
560
+ # @param id [String] ID
561
+ # @param translation_verify_parameters [TranslationVerifyParameters]
562
+ # @param [Hash] opts the optional parameters
563
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
564
+ # @return [TranslationDetails]
565
+ def translation_verify(project_id, id, translation_verify_parameters, opts = {})
566
+ data, _status_code, _headers = translation_verify_with_http_info(project_id, id, translation_verify_parameters, opts)
567
+ data
568
+ end
569
+
570
+ # Verify a translation
571
+ # Verify an existing translation.
572
+ # @param project_id [String] Project ID
573
+ # @param id [String] ID
574
+ # @param translation_verify_parameters [TranslationVerifyParameters]
575
+ # @param [Hash] opts the optional parameters
576
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
577
+ # @return [Array<(Response<(TranslationDetails)>, Integer, Hash)>] Response<(TranslationDetails)> data, response status code and response headers
578
+ def translation_verify_with_http_info(project_id, id, translation_verify_parameters, opts = {})
579
+ if @api_client.config.debugging
580
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translation_verify ...'
581
+ end
582
+ # verify the required parameter 'project_id' is set
583
+ if @api_client.config.client_side_validation && project_id.nil?
584
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translation_verify"
585
+ end
586
+ # verify the required parameter 'id' is set
587
+ if @api_client.config.client_side_validation && id.nil?
588
+ fail ArgumentError, "Missing the required parameter 'id' when calling TranslationsApi.translation_verify"
589
+ end
590
+ # verify the required parameter 'translation_verify_parameters' is set
591
+ if @api_client.config.client_side_validation && translation_verify_parameters.nil?
592
+ fail ArgumentError, "Missing the required parameter 'translation_verify_parameters' when calling TranslationsApi.translation_verify"
593
+ end
594
+ # resource path
595
+ local_var_path = '/projects/{project_id}/translations/{id}/verify'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
596
+
597
+ # query parameters
598
+ query_params = opts[:query_params] || {}
599
+
600
+ # header parameters
601
+ header_params = opts[:header_params] || {}
602
+ # HTTP header 'Accept' (if needed)
603
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
604
+ # HTTP header 'Content-Type'
605
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
606
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
607
+
608
+ # form parameters
609
+ form_params = opts[:form_params] || {}
610
+
611
+ # http body (model)
612
+ post_body = opts[:body] || @api_client.object_to_http_body(translation_verify_parameters)
613
+
614
+ # return_type
615
+ return_type = opts[:return_type] || 'TranslationDetails'
616
+
617
+ # auth_names
618
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
619
+
620
+ new_options = opts.merge(
621
+ :header_params => header_params,
622
+ :query_params => query_params,
623
+ :form_params => form_params,
624
+ :body => post_body,
625
+ :auth_names => auth_names,
626
+ :return_type => return_type
627
+ )
628
+
629
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
630
+ if @api_client.config.debugging
631
+ @api_client.config.logger.debug "API called: TranslationsApi#translation_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
632
+ end
633
+ response = ::Phrase::Response.new(data, headers)
634
+ return response, status_code, headers
635
+ end
636
+
637
+ # List translations by key
638
+ # List translations for a specific key.
639
+ # @param project_id [String] Project ID
640
+ # @param key_id [String] Translation Key ID
641
+ # @param [Hash] opts the optional parameters
642
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
643
+ # @option opts [Integer] :page Page number
644
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
645
+ # @option opts [String] :branch specify the branch to use
646
+ # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
647
+ # @option opts [String] :order Order direction. Can be one of: asc, desc.
648
+ # @option opts [String] :q q_description_placeholder
649
+ # @return [Array<Translation>]
650
+ def translations_by_key(project_id, key_id, opts = {})
651
+ data, _status_code, _headers = translations_by_key_with_http_info(project_id, key_id, opts)
652
+ data
653
+ end
654
+
655
+ # List translations by key
656
+ # List translations for a specific key.
657
+ # @param project_id [String] Project ID
658
+ # @param key_id [String] Translation Key ID
659
+ # @param [Hash] opts the optional parameters
660
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
661
+ # @option opts [Integer] :page Page number
662
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
663
+ # @option opts [String] :branch specify the branch to use
664
+ # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
665
+ # @option opts [String] :order Order direction. Can be one of: asc, desc.
666
+ # @option opts [String] :q q_description_placeholder
667
+ # @return [Array<(Response<(Array<Translation>)>, Integer, Hash)>] Response<(Array<Translation>)> data, response status code and response headers
668
+ def translations_by_key_with_http_info(project_id, key_id, opts = {})
669
+ if @api_client.config.debugging
670
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_by_key ...'
671
+ end
672
+ # verify the required parameter 'project_id' is set
673
+ if @api_client.config.client_side_validation && project_id.nil?
674
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_by_key"
675
+ end
676
+ # verify the required parameter 'key_id' is set
677
+ if @api_client.config.client_side_validation && key_id.nil?
678
+ fail ArgumentError, "Missing the required parameter 'key_id' when calling TranslationsApi.translations_by_key"
679
+ end
680
+ # resource path
681
+ local_var_path = '/projects/{project_id}/keys/{key_id}/translations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))
682
+
683
+ # query parameters
684
+ query_params = opts[:query_params] || {}
685
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
686
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
687
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
688
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
689
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
690
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
691
+
692
+ # header parameters
693
+ header_params = opts[:header_params] || {}
694
+ # HTTP header 'Accept' (if needed)
695
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
696
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
697
+
698
+ # form parameters
699
+ form_params = opts[:form_params] || {}
700
+
701
+ # http body (model)
702
+ post_body = opts[:body]
703
+
704
+ # return_type
705
+ return_type = opts[:return_type] || 'Array<Translation>'
706
+
707
+ # auth_names
708
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
709
+
710
+ new_options = opts.merge(
711
+ :header_params => header_params,
712
+ :query_params => query_params,
713
+ :form_params => form_params,
714
+ :body => post_body,
715
+ :auth_names => auth_names,
716
+ :return_type => return_type
717
+ )
718
+
719
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
720
+ if @api_client.config.debugging
721
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_by_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
722
+ end
723
+ response = ::Phrase::Response.new(data, headers)
724
+ return response, status_code, headers
725
+ end
726
+
727
+ # List translations by locale
728
+ # List translations for a specific locale. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
729
+ # @param project_id [String] Project ID
730
+ # @param locale_id [String] Locale ID
731
+ # @param [Hash] opts the optional parameters
732
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
733
+ # @option opts [Integer] :page Page number
734
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
735
+ # @option opts [String] :branch specify the branch to use
736
+ # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
737
+ # @option opts [String] :order Order direction. Can be one of: asc, desc.
738
+ # @option opts [String] :q q_description_placeholder
739
+ # @return [Array<Translation>]
740
+ def translations_by_locale(project_id, locale_id, opts = {})
741
+ data, _status_code, _headers = translations_by_locale_with_http_info(project_id, locale_id, opts)
742
+ data
743
+ end
744
+
745
+ # List translations by locale
746
+ # List translations for a specific locale. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.
747
+ # @param project_id [String] Project ID
748
+ # @param locale_id [String] Locale ID
749
+ # @param [Hash] opts the optional parameters
750
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
751
+ # @option opts [Integer] :page Page number
752
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
753
+ # @option opts [String] :branch specify the branch to use
754
+ # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
755
+ # @option opts [String] :order Order direction. Can be one of: asc, desc.
756
+ # @option opts [String] :q q_description_placeholder
757
+ # @return [Array<(Response<(Array<Translation>)>, Integer, Hash)>] Response<(Array<Translation>)> data, response status code and response headers
758
+ def translations_by_locale_with_http_info(project_id, locale_id, opts = {})
759
+ if @api_client.config.debugging
760
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_by_locale ...'
761
+ end
762
+ # verify the required parameter 'project_id' is set
763
+ if @api_client.config.client_side_validation && project_id.nil?
764
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_by_locale"
765
+ end
766
+ # verify the required parameter 'locale_id' is set
767
+ if @api_client.config.client_side_validation && locale_id.nil?
768
+ fail ArgumentError, "Missing the required parameter 'locale_id' when calling TranslationsApi.translations_by_locale"
769
+ end
770
+ # resource path
771
+ local_var_path = '/projects/{project_id}/locales/{locale_id}/translations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'locale_id' + '}', CGI.escape(locale_id.to_s))
772
+
773
+ # query parameters
774
+ query_params = opts[:query_params] || {}
775
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
776
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
777
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
778
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
779
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
780
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
781
+
782
+ # header parameters
783
+ header_params = opts[:header_params] || {}
784
+ # HTTP header 'Accept' (if needed)
785
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
786
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
787
+
788
+ # form parameters
789
+ form_params = opts[:form_params] || {}
790
+
791
+ # http body (model)
792
+ post_body = opts[:body]
793
+
794
+ # return_type
795
+ return_type = opts[:return_type] || 'Array<Translation>'
796
+
797
+ # auth_names
798
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
799
+
800
+ new_options = opts.merge(
801
+ :header_params => header_params,
802
+ :query_params => query_params,
803
+ :form_params => form_params,
804
+ :body => post_body,
805
+ :auth_names => auth_names,
806
+ :return_type => return_type
807
+ )
808
+
809
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
810
+ if @api_client.config.debugging
811
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_by_locale\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
812
+ end
813
+ response = ::Phrase::Response.new(data, headers)
814
+ return response, status_code, headers
815
+ end
816
+
817
+ # Set exclude from export flag on translations selected by query
818
+ # Exclude translations matching query from locale export.
819
+ # @param project_id [String] Project ID
820
+ # @param translations_exclude_parameters [TranslationsExcludeParameters]
821
+ # @param [Hash] opts the optional parameters
822
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
823
+ # @return [AffectedCount]
824
+ def translations_exclude(project_id, translations_exclude_parameters, opts = {})
825
+ data, _status_code, _headers = translations_exclude_with_http_info(project_id, translations_exclude_parameters, opts)
826
+ data
827
+ end
828
+
829
+ # Set exclude from export flag on translations selected by query
830
+ # Exclude translations matching query from locale export.
831
+ # @param project_id [String] Project ID
832
+ # @param translations_exclude_parameters [TranslationsExcludeParameters]
833
+ # @param [Hash] opts the optional parameters
834
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
835
+ # @return [Array<(Response<(AffectedCount)>, Integer, Hash)>] Response<(AffectedCount)> data, response status code and response headers
836
+ def translations_exclude_with_http_info(project_id, translations_exclude_parameters, opts = {})
837
+ if @api_client.config.debugging
838
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_exclude ...'
839
+ end
840
+ # verify the required parameter 'project_id' is set
841
+ if @api_client.config.client_side_validation && project_id.nil?
842
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_exclude"
843
+ end
844
+ # verify the required parameter 'translations_exclude_parameters' is set
845
+ if @api_client.config.client_side_validation && translations_exclude_parameters.nil?
846
+ fail ArgumentError, "Missing the required parameter 'translations_exclude_parameters' when calling TranslationsApi.translations_exclude"
847
+ end
848
+ # resource path
849
+ local_var_path = '/projects/{project_id}/translations/exclude'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
850
+
851
+ # query parameters
852
+ query_params = opts[:query_params] || {}
853
+
854
+ # header parameters
855
+ header_params = opts[:header_params] || {}
856
+ # HTTP header 'Accept' (if needed)
857
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
858
+ # HTTP header 'Content-Type'
859
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
860
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
861
+
862
+ # form parameters
863
+ form_params = opts[:form_params] || {}
864
+
865
+ # http body (model)
866
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_exclude_parameters)
867
+
868
+ # return_type
869
+ return_type = opts[:return_type] || 'AffectedCount'
870
+
871
+ # auth_names
872
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
873
+
874
+ new_options = opts.merge(
875
+ :header_params => header_params,
876
+ :query_params => query_params,
877
+ :form_params => form_params,
878
+ :body => post_body,
879
+ :auth_names => auth_names,
880
+ :return_type => return_type
881
+ )
882
+
883
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
884
+ if @api_client.config.debugging
885
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_exclude\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
886
+ end
887
+ response = ::Phrase::Response.new(data, headers)
888
+ return response, status_code, headers
889
+ end
890
+
891
+ # Remove exlude from import flag from translations selected by query
892
+ # Include translations matching query in locale export.
893
+ # @param project_id [String] Project ID
894
+ # @param translations_include_parameters [TranslationsIncludeParameters]
895
+ # @param [Hash] opts the optional parameters
896
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
897
+ # @return [AffectedCount]
898
+ def translations_include(project_id, translations_include_parameters, opts = {})
899
+ data, _status_code, _headers = translations_include_with_http_info(project_id, translations_include_parameters, opts)
900
+ data
901
+ end
902
+
903
+ # Remove exlude from import flag from translations selected by query
904
+ # Include translations matching query in locale export.
905
+ # @param project_id [String] Project ID
906
+ # @param translations_include_parameters [TranslationsIncludeParameters]
907
+ # @param [Hash] opts the optional parameters
908
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
909
+ # @return [Array<(Response<(AffectedCount)>, Integer, Hash)>] Response<(AffectedCount)> data, response status code and response headers
910
+ def translations_include_with_http_info(project_id, translations_include_parameters, opts = {})
911
+ if @api_client.config.debugging
912
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_include ...'
913
+ end
914
+ # verify the required parameter 'project_id' is set
915
+ if @api_client.config.client_side_validation && project_id.nil?
916
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_include"
917
+ end
918
+ # verify the required parameter 'translations_include_parameters' is set
919
+ if @api_client.config.client_side_validation && translations_include_parameters.nil?
920
+ fail ArgumentError, "Missing the required parameter 'translations_include_parameters' when calling TranslationsApi.translations_include"
921
+ end
922
+ # resource path
923
+ local_var_path = '/projects/{project_id}/translations/include'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
924
+
925
+ # query parameters
926
+ query_params = opts[:query_params] || {}
927
+
928
+ # header parameters
929
+ header_params = opts[:header_params] || {}
930
+ # HTTP header 'Accept' (if needed)
931
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
932
+ # HTTP header 'Content-Type'
933
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
934
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
935
+
936
+ # form parameters
937
+ form_params = opts[:form_params] || {}
938
+
939
+ # http body (model)
940
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_include_parameters)
941
+
942
+ # return_type
943
+ return_type = opts[:return_type] || 'AffectedCount'
944
+
945
+ # auth_names
946
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
947
+
948
+ new_options = opts.merge(
949
+ :header_params => header_params,
950
+ :query_params => query_params,
951
+ :form_params => form_params,
952
+ :body => post_body,
953
+ :auth_names => auth_names,
954
+ :return_type => return_type
955
+ )
956
+
957
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
958
+ if @api_client.config.debugging
959
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_include\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
960
+ end
961
+ response = ::Phrase::Response.new(data, headers)
962
+ return response, status_code, headers
963
+ end
964
+
965
+ # List all translations
966
+ # List translations for the given project. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
967
+ # @param project_id [String] Project ID
968
+ # @param [Hash] opts the optional parameters
969
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
970
+ # @option opts [Integer] :page Page number
971
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
972
+ # @option opts [String] :branch specify the branch to use
973
+ # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
974
+ # @option opts [String] :order Order direction. Can be one of: asc, desc.
975
+ # @option opts [String] :q q_description_placeholder
976
+ # @return [Array<Translation>]
977
+ def translations_list(project_id, opts = {})
978
+ data, _status_code, _headers = translations_list_with_http_info(project_id, opts)
979
+ data
980
+ end
981
+
982
+ # List all translations
983
+ # List translations for the given project. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.
984
+ # @param project_id [String] Project ID
985
+ # @param [Hash] opts the optional parameters
986
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
987
+ # @option opts [Integer] :page Page number
988
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
989
+ # @option opts [String] :branch specify the branch to use
990
+ # @option opts [String] :sort Sort criteria. Can be one of: key_name, created_at, updated_at.
991
+ # @option opts [String] :order Order direction. Can be one of: asc, desc.
992
+ # @option opts [String] :q q_description_placeholder
993
+ # @return [Array<(Response<(Array<Translation>)>, Integer, Hash)>] Response<(Array<Translation>)> data, response status code and response headers
994
+ def translations_list_with_http_info(project_id, opts = {})
995
+ if @api_client.config.debugging
996
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_list ...'
997
+ end
998
+ # verify the required parameter 'project_id' is set
999
+ if @api_client.config.client_side_validation && project_id.nil?
1000
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_list"
1001
+ end
1002
+ # resource path
1003
+ local_var_path = '/projects/{project_id}/translations'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
1004
+
1005
+ # query parameters
1006
+ query_params = opts[:query_params] || {}
1007
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1008
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
1009
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
1010
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1011
+ query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
1012
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
1013
+
1014
+ # header parameters
1015
+ header_params = opts[:header_params] || {}
1016
+ # HTTP header 'Accept' (if needed)
1017
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1018
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
1019
+
1020
+ # form parameters
1021
+ form_params = opts[:form_params] || {}
1022
+
1023
+ # http body (model)
1024
+ post_body = opts[:body]
1025
+
1026
+ # return_type
1027
+ return_type = opts[:return_type] || 'Array<Translation>'
1028
+
1029
+ # auth_names
1030
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
1031
+
1032
+ new_options = opts.merge(
1033
+ :header_params => header_params,
1034
+ :query_params => query_params,
1035
+ :form_params => form_params,
1036
+ :body => post_body,
1037
+ :auth_names => auth_names,
1038
+ :return_type => return_type
1039
+ )
1040
+
1041
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1042
+ if @api_client.config.debugging
1043
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1044
+ end
1045
+ response = ::Phrase::Response.new(data, headers)
1046
+ return response, status_code, headers
1047
+ end
1048
+
1049
+ # Review translations selected by query
1050
+ # Review translations matching query.
1051
+ # @param project_id [String] Project ID
1052
+ # @param translations_review_parameters [TranslationsReviewParameters]
1053
+ # @param [Hash] opts the optional parameters
1054
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1055
+ # @return [AffectedCount]
1056
+ def translations_review(project_id, translations_review_parameters, opts = {})
1057
+ data, _status_code, _headers = translations_review_with_http_info(project_id, translations_review_parameters, opts)
1058
+ data
1059
+ end
1060
+
1061
+ # Review translations selected by query
1062
+ # Review translations matching query.
1063
+ # @param project_id [String] Project ID
1064
+ # @param translations_review_parameters [TranslationsReviewParameters]
1065
+ # @param [Hash] opts the optional parameters
1066
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1067
+ # @return [Array<(Response<(AffectedCount)>, Integer, Hash)>] Response<(AffectedCount)> data, response status code and response headers
1068
+ def translations_review_with_http_info(project_id, translations_review_parameters, opts = {})
1069
+ if @api_client.config.debugging
1070
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_review ...'
1071
+ end
1072
+ # verify the required parameter 'project_id' is set
1073
+ if @api_client.config.client_side_validation && project_id.nil?
1074
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_review"
1075
+ end
1076
+ # verify the required parameter 'translations_review_parameters' is set
1077
+ if @api_client.config.client_side_validation && translations_review_parameters.nil?
1078
+ fail ArgumentError, "Missing the required parameter 'translations_review_parameters' when calling TranslationsApi.translations_review"
1079
+ end
1080
+ # resource path
1081
+ local_var_path = '/projects/{project_id}/translations/review'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
1082
+
1083
+ # query parameters
1084
+ query_params = opts[:query_params] || {}
1085
+
1086
+ # header parameters
1087
+ header_params = opts[:header_params] || {}
1088
+ # HTTP header 'Accept' (if needed)
1089
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1090
+ # HTTP header 'Content-Type'
1091
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1092
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
1093
+
1094
+ # form parameters
1095
+ form_params = opts[:form_params] || {}
1096
+
1097
+ # http body (model)
1098
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_review_parameters)
1099
+
1100
+ # return_type
1101
+ return_type = opts[:return_type] || 'AffectedCount'
1102
+
1103
+ # auth_names
1104
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
1105
+
1106
+ new_options = opts.merge(
1107
+ :header_params => header_params,
1108
+ :query_params => query_params,
1109
+ :form_params => form_params,
1110
+ :body => post_body,
1111
+ :auth_names => auth_names,
1112
+ :return_type => return_type
1113
+ )
1114
+
1115
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1116
+ if @api_client.config.debugging
1117
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_review\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1118
+ end
1119
+ response = ::Phrase::Response.new(data, headers)
1120
+ return response, status_code, headers
1121
+ end
1122
+
1123
+ # Search translations
1124
+ # Search translations for the given project. Provides the same search interface as <code>translations#index</code> but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the <code>locales#download</code> endpoint.
1125
+ # @param project_id [String] Project ID
1126
+ # @param translations_search_parameters [TranslationsSearchParameters]
1127
+ # @param [Hash] opts the optional parameters
1128
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1129
+ # @option opts [Integer] :page Page number
1130
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
1131
+ # @return [Array<Translation>]
1132
+ def translations_search(project_id, translations_search_parameters, opts = {})
1133
+ data, _status_code, _headers = translations_search_with_http_info(project_id, translations_search_parameters, opts)
1134
+ data
1135
+ end
1136
+
1137
+ # Search translations
1138
+ # Search translations for the given project. Provides the same search interface as &lt;code&gt;translations#index&lt;/code&gt; but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.
1139
+ # @param project_id [String] Project ID
1140
+ # @param translations_search_parameters [TranslationsSearchParameters]
1141
+ # @param [Hash] opts the optional parameters
1142
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1143
+ # @option opts [Integer] :page Page number
1144
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
1145
+ # @return [Array<(Response<(Array<Translation>)>, Integer, Hash)>] Response<(Array<Translation>)> data, response status code and response headers
1146
+ def translations_search_with_http_info(project_id, translations_search_parameters, opts = {})
1147
+ if @api_client.config.debugging
1148
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_search ...'
1149
+ end
1150
+ # verify the required parameter 'project_id' is set
1151
+ if @api_client.config.client_side_validation && project_id.nil?
1152
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_search"
1153
+ end
1154
+ # verify the required parameter 'translations_search_parameters' is set
1155
+ if @api_client.config.client_side_validation && translations_search_parameters.nil?
1156
+ fail ArgumentError, "Missing the required parameter 'translations_search_parameters' when calling TranslationsApi.translations_search"
1157
+ end
1158
+ # resource path
1159
+ local_var_path = '/projects/{project_id}/translations/search'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
1160
+
1161
+ # query parameters
1162
+ query_params = opts[:query_params] || {}
1163
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1164
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
1165
+
1166
+ # header parameters
1167
+ header_params = opts[:header_params] || {}
1168
+ # HTTP header 'Accept' (if needed)
1169
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1170
+ # HTTP header 'Content-Type'
1171
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1172
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
1173
+
1174
+ # form parameters
1175
+ form_params = opts[:form_params] || {}
1176
+
1177
+ # http body (model)
1178
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_search_parameters)
1179
+
1180
+ # return_type
1181
+ return_type = opts[:return_type] || 'Array<Translation>'
1182
+
1183
+ # auth_names
1184
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
1185
+
1186
+ new_options = opts.merge(
1187
+ :header_params => header_params,
1188
+ :query_params => query_params,
1189
+ :form_params => form_params,
1190
+ :body => post_body,
1191
+ :auth_names => auth_names,
1192
+ :return_type => return_type
1193
+ )
1194
+
1195
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1196
+ if @api_client.config.debugging
1197
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1198
+ end
1199
+ response = ::Phrase::Response.new(data, headers)
1200
+ return response, status_code, headers
1201
+ end
1202
+
1203
+ # Mark translations selected by query as unverified
1204
+ # Mark translations matching query as unverified.
1205
+ # @param project_id [String] Project ID
1206
+ # @param translations_unverify_parameters [TranslationsUnverifyParameters]
1207
+ # @param [Hash] opts the optional parameters
1208
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1209
+ # @return [AffectedCount]
1210
+ def translations_unverify(project_id, translations_unverify_parameters, opts = {})
1211
+ data, _status_code, _headers = translations_unverify_with_http_info(project_id, translations_unverify_parameters, opts)
1212
+ data
1213
+ end
1214
+
1215
+ # Mark translations selected by query as unverified
1216
+ # Mark translations matching query as unverified.
1217
+ # @param project_id [String] Project ID
1218
+ # @param translations_unverify_parameters [TranslationsUnverifyParameters]
1219
+ # @param [Hash] opts the optional parameters
1220
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1221
+ # @return [Array<(Response<(AffectedCount)>, Integer, Hash)>] Response<(AffectedCount)> data, response status code and response headers
1222
+ def translations_unverify_with_http_info(project_id, translations_unverify_parameters, opts = {})
1223
+ if @api_client.config.debugging
1224
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_unverify ...'
1225
+ end
1226
+ # verify the required parameter 'project_id' is set
1227
+ if @api_client.config.client_side_validation && project_id.nil?
1228
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_unverify"
1229
+ end
1230
+ # verify the required parameter 'translations_unverify_parameters' is set
1231
+ if @api_client.config.client_side_validation && translations_unverify_parameters.nil?
1232
+ fail ArgumentError, "Missing the required parameter 'translations_unverify_parameters' when calling TranslationsApi.translations_unverify"
1233
+ end
1234
+ # resource path
1235
+ local_var_path = '/projects/{project_id}/translations/unverify'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
1236
+
1237
+ # query parameters
1238
+ query_params = opts[:query_params] || {}
1239
+
1240
+ # header parameters
1241
+ header_params = opts[:header_params] || {}
1242
+ # HTTP header 'Accept' (if needed)
1243
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1244
+ # HTTP header 'Content-Type'
1245
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1246
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
1247
+
1248
+ # form parameters
1249
+ form_params = opts[:form_params] || {}
1250
+
1251
+ # http body (model)
1252
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_unverify_parameters)
1253
+
1254
+ # return_type
1255
+ return_type = opts[:return_type] || 'AffectedCount'
1256
+
1257
+ # auth_names
1258
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
1259
+
1260
+ new_options = opts.merge(
1261
+ :header_params => header_params,
1262
+ :query_params => query_params,
1263
+ :form_params => form_params,
1264
+ :body => post_body,
1265
+ :auth_names => auth_names,
1266
+ :return_type => return_type
1267
+ )
1268
+
1269
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1270
+ if @api_client.config.debugging
1271
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_unverify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1272
+ end
1273
+ response = ::Phrase::Response.new(data, headers)
1274
+ return response, status_code, headers
1275
+ end
1276
+
1277
+ # Verify translations selected by query
1278
+ # Verify translations matching query.
1279
+ # @param project_id [String] Project ID
1280
+ # @param translations_verify_parameters [TranslationsVerifyParameters]
1281
+ # @param [Hash] opts the optional parameters
1282
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1283
+ # @return [AffectedCount]
1284
+ def translations_verify(project_id, translations_verify_parameters, opts = {})
1285
+ data, _status_code, _headers = translations_verify_with_http_info(project_id, translations_verify_parameters, opts)
1286
+ data
1287
+ end
1288
+
1289
+ # Verify translations selected by query
1290
+ # Verify translations matching query.
1291
+ # @param project_id [String] Project ID
1292
+ # @param translations_verify_parameters [TranslationsVerifyParameters]
1293
+ # @param [Hash] opts the optional parameters
1294
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
1295
+ # @return [Array<(Response<(AffectedCount)>, Integer, Hash)>] Response<(AffectedCount)> data, response status code and response headers
1296
+ def translations_verify_with_http_info(project_id, translations_verify_parameters, opts = {})
1297
+ if @api_client.config.debugging
1298
+ @api_client.config.logger.debug 'Calling API: TranslationsApi.translations_verify ...'
1299
+ end
1300
+ # verify the required parameter 'project_id' is set
1301
+ if @api_client.config.client_side_validation && project_id.nil?
1302
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling TranslationsApi.translations_verify"
1303
+ end
1304
+ # verify the required parameter 'translations_verify_parameters' is set
1305
+ if @api_client.config.client_side_validation && translations_verify_parameters.nil?
1306
+ fail ArgumentError, "Missing the required parameter 'translations_verify_parameters' when calling TranslationsApi.translations_verify"
1307
+ end
1308
+ # resource path
1309
+ local_var_path = '/projects/{project_id}/translations/verify'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
1310
+
1311
+ # query parameters
1312
+ query_params = opts[:query_params] || {}
1313
+
1314
+ # header parameters
1315
+ header_params = opts[:header_params] || {}
1316
+ # HTTP header 'Accept' (if needed)
1317
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1318
+ # HTTP header 'Content-Type'
1319
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1320
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
1321
+
1322
+ # form parameters
1323
+ form_params = opts[:form_params] || {}
1324
+
1325
+ # http body (model)
1326
+ post_body = opts[:body] || @api_client.object_to_http_body(translations_verify_parameters)
1327
+
1328
+ # return_type
1329
+ return_type = opts[:return_type] || 'AffectedCount'
1330
+
1331
+ # auth_names
1332
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
1333
+
1334
+ new_options = opts.merge(
1335
+ :header_params => header_params,
1336
+ :query_params => query_params,
1337
+ :form_params => form_params,
1338
+ :body => post_body,
1339
+ :auth_names => auth_names,
1340
+ :return_type => return_type
1341
+ )
1342
+
1343
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1344
+ if @api_client.config.debugging
1345
+ @api_client.config.logger.debug "API called: TranslationsApi#translations_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1346
+ end
1347
+ response = ::Phrase::Response.new(data, headers)
1348
+ return response, status_code, headers
1349
+ end
1350
+ end
1351
+ end