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,497 @@
1
+ require 'cgi'
2
+
3
+ module Phrase
4
+ class LocalesApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+ # Create a locale
11
+ # Create a new locale.
12
+ # @param project_id [String] Project ID
13
+ # @param locale_create_parameters [LocaleCreateParameters]
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 locale_create(project_id, locale_create_parameters, opts = {})
18
+ locale_create_with_http_info(project_id, locale_create_parameters, opts)
19
+ nil
20
+ end
21
+
22
+ # Create a locale
23
+ # Create a new locale.
24
+ # @param project_id [String] Project ID
25
+ # @param locale_create_parameters [LocaleCreateParameters]
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 locale_create_with_http_info(project_id, locale_create_parameters, opts = {})
30
+ if @api_client.config.debugging
31
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_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 LocalesApi.locale_create"
36
+ end
37
+ # verify the required parameter 'locale_create_parameters' is set
38
+ if @api_client.config.client_side_validation && locale_create_parameters.nil?
39
+ fail ArgumentError, "Missing the required parameter 'locale_create_parameters' when calling LocalesApi.locale_create"
40
+ end
41
+ # resource path
42
+ local_var_path = '/projects/{project_id}/locales'.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(locale_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: LocalesApi#locale_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
+ # Delete a locale
83
+ # Delete an existing locale.
84
+ # @param project_id [String] Project ID
85
+ # @param id [String] ID
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
88
+ # @option opts [String] :branch specify the branch to use
89
+ # @return [nil]
90
+ def locale_delete(project_id, id, opts = {})
91
+ locale_delete_with_http_info(project_id, id, opts)
92
+ nil
93
+ end
94
+
95
+ # Delete a locale
96
+ # Delete an existing locale.
97
+ # @param project_id [String] Project ID
98
+ # @param id [String] ID
99
+ # @param [Hash] opts the optional parameters
100
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
101
+ # @option opts [String] :branch specify the branch to use
102
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
103
+ def locale_delete_with_http_info(project_id, id, opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_delete ...'
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 LocalesApi.locale_delete"
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 LocalesApi.locale_delete"
114
+ end
115
+ # resource path
116
+ local_var_path = '/projects/{project_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
117
+
118
+ # query parameters
119
+ query_params = opts[:query_params] || {}
120
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
121
+
122
+ # header parameters
123
+ header_params = opts[:header_params] || {}
124
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
125
+
126
+ # form parameters
127
+ form_params = opts[:form_params] || {}
128
+
129
+ # http body (model)
130
+ post_body = opts[:body]
131
+
132
+ # return_type
133
+ return_type = opts[:return_type]
134
+
135
+ # auth_names
136
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
137
+
138
+ new_options = opts.merge(
139
+ :header_params => header_params,
140
+ :query_params => query_params,
141
+ :form_params => form_params,
142
+ :body => post_body,
143
+ :auth_names => auth_names,
144
+ :return_type => return_type
145
+ )
146
+
147
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
148
+ if @api_client.config.debugging
149
+ @api_client.config.logger.debug "API called: LocalesApi#locale_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
150
+ end
151
+ response = ::Phrase::Response.new(data, headers)
152
+ return response, status_code, headers
153
+ end
154
+
155
+ # Download a locale
156
+ # Download a locale in a specific file format.
157
+ # @param project_id [String] Project ID
158
+ # @param id [String] ID
159
+ # @param [Hash] opts the optional parameters
160
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
161
+ # @option opts [String] :branch specify the branch to use
162
+ # @option opts [String] :file_format File format name. See the format guide for all supported file formats.
163
+ # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
164
+ # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \&quot;tags\&quot; parameter instead
165
+ # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
166
+ # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
167
+ # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
168
+ # @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
169
+ # @option opts [Hash<String, String>] :format_options Additional formatting and render options. See the &lt;a href&#x3D;\&quot;https://help.phrase.com/help/supported-platforms-and-formats\&quot;&gt;format guide&lt;/a&gt; for a list of options available for each format. Specify format options like this: &lt;code&gt;...&amp;format_options[foo]&#x3D;bar&lt;/code&gt;
170
+ # @option opts [String] :encoding Enforces a specific encoding on the file contents. Valid options are \&quot;UTF-8\&quot;, \&quot;UTF-16\&quot; and \&quot;ISO-8859-1\&quot;.
171
+ # @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with &lt;code&gt;include_unverified_translations&lt;/code&gt;.
172
+ # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
173
+ # @option opts [Boolean] :use_last_reviewed_version If set to true the last reviewed version of a translation is used. This is only available if the review workflow (currently in beta) is enabled for the project.
174
+ # @option opts [String] :fallback_locale_id If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to &lt;code&gt;true&lt;/code&gt;.
175
+ # @return [nil]
176
+ def locale_download(project_id, id, opts = {})
177
+ locale_download_with_http_info(project_id, id, opts)
178
+ nil
179
+ end
180
+
181
+ # Download a locale
182
+ # Download a locale in a specific file format.
183
+ # @param project_id [String] Project ID
184
+ # @param id [String] ID
185
+ # @param [Hash] opts the optional parameters
186
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
187
+ # @option opts [String] :branch specify the branch to use
188
+ # @option opts [String] :file_format File format name. See the format guide for all supported file formats.
189
+ # @option opts [String] :tags Limit results to keys tagged with a list of comma separated tag names.
190
+ # @option opts [String] :tag Limit download to tagged keys. This parameter is deprecated. Please use the \&quot;tags\&quot; parameter instead
191
+ # @option opts [Boolean] :include_empty_translations Indicates whether keys without translations should be included in the output as well.
192
+ # @option opts [Boolean] :include_translated_keys Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
193
+ # @option opts [Boolean] :keep_notranslate_tags Indicates whether [NOTRANSLATE] tags should be kept.
194
+ # @option opts [Boolean] :convert_emoji This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
195
+ # @option opts [Hash<String, String>] :format_options Additional formatting and render options. See the &lt;a href&#x3D;\&quot;https://help.phrase.com/help/supported-platforms-and-formats\&quot;&gt;format guide&lt;/a&gt; for a list of options available for each format. Specify format options like this: &lt;code&gt;...&amp;format_options[foo]&#x3D;bar&lt;/code&gt;
196
+ # @option opts [String] :encoding Enforces a specific encoding on the file contents. Valid options are \&quot;UTF-8\&quot;, \&quot;UTF-16\&quot; and \&quot;ISO-8859-1\&quot;.
197
+ # @option opts [Boolean] :skip_unverified_translations Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with &lt;code&gt;include_unverified_translations&lt;/code&gt;.
198
+ # @option opts [Boolean] :include_unverified_translations if set to false unverified translations are excluded
199
+ # @option opts [Boolean] :use_last_reviewed_version If set to true the last reviewed version of a translation is used. This is only available if the review workflow (currently in beta) is enabled for the project.
200
+ # @option opts [String] :fallback_locale_id If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to &lt;code&gt;true&lt;/code&gt;.
201
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
202
+ def locale_download_with_http_info(project_id, id, opts = {})
203
+ if @api_client.config.debugging
204
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_download ...'
205
+ end
206
+ # verify the required parameter 'project_id' is set
207
+ if @api_client.config.client_side_validation && project_id.nil?
208
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locale_download"
209
+ end
210
+ # verify the required parameter 'id' is set
211
+ if @api_client.config.client_side_validation && id.nil?
212
+ fail ArgumentError, "Missing the required parameter 'id' when calling LocalesApi.locale_download"
213
+ end
214
+ # resource path
215
+ local_var_path = '/projects/{project_id}/locales/{id}/download'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
216
+
217
+ # query parameters
218
+ query_params = opts[:query_params] || {}
219
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
220
+ query_params[:'file_format'] = opts[:'file_format'] if !opts[:'file_format'].nil?
221
+ query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
222
+ query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
223
+ query_params[:'include_empty_translations'] = opts[:'include_empty_translations'] if !opts[:'include_empty_translations'].nil?
224
+ query_params[:'include_translated_keys'] = opts[:'include_translated_keys'] if !opts[:'include_translated_keys'].nil?
225
+ query_params[:'keep_notranslate_tags'] = opts[:'keep_notranslate_tags'] if !opts[:'keep_notranslate_tags'].nil?
226
+ query_params[:'convert_emoji'] = opts[:'convert_emoji'] if !opts[:'convert_emoji'].nil?
227
+ query_params[:'format_options'] = opts[:'format_options'] if !opts[:'format_options'].nil?
228
+ query_params[:'encoding'] = opts[:'encoding'] if !opts[:'encoding'].nil?
229
+ query_params[:'skip_unverified_translations'] = opts[:'skip_unverified_translations'] if !opts[:'skip_unverified_translations'].nil?
230
+ query_params[:'include_unverified_translations'] = opts[:'include_unverified_translations'] if !opts[:'include_unverified_translations'].nil?
231
+ query_params[:'use_last_reviewed_version'] = opts[:'use_last_reviewed_version'] if !opts[:'use_last_reviewed_version'].nil?
232
+ query_params[:'fallback_locale_id'] = opts[:'fallback_locale_id'] if !opts[:'fallback_locale_id'].nil?
233
+
234
+ # header parameters
235
+ header_params = opts[:header_params] || {}
236
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
237
+
238
+ # form parameters
239
+ form_params = opts[:form_params] || {}
240
+
241
+ # http body (model)
242
+ post_body = opts[:body]
243
+
244
+ # return_type
245
+ return_type = opts[:return_type]
246
+
247
+ # auth_names
248
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
249
+
250
+ new_options = opts.merge(
251
+ :header_params => header_params,
252
+ :query_params => query_params,
253
+ :form_params => form_params,
254
+ :body => post_body,
255
+ :auth_names => auth_names,
256
+ :return_type => return_type
257
+ )
258
+
259
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
260
+ if @api_client.config.debugging
261
+ @api_client.config.logger.debug "API called: LocalesApi#locale_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
262
+ end
263
+ response = ::Phrase::Response.new(data, headers)
264
+ return response, status_code, headers
265
+ end
266
+
267
+ # Get a single locale
268
+ # Get details on a single locale for a given project.
269
+ # @param project_id [String] Project ID
270
+ # @param id [String] ID
271
+ # @param [Hash] opts the optional parameters
272
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
273
+ # @option opts [String] :branch specify the branch to use
274
+ # @return [LocaleDetails]
275
+ def locale_show(project_id, id, opts = {})
276
+ data, _status_code, _headers = locale_show_with_http_info(project_id, id, opts)
277
+ data
278
+ end
279
+
280
+ # Get a single locale
281
+ # Get details on a single locale for a given project.
282
+ # @param project_id [String] Project ID
283
+ # @param id [String] ID
284
+ # @param [Hash] opts the optional parameters
285
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
286
+ # @option opts [String] :branch specify the branch to use
287
+ # @return [Array<(Response<(LocaleDetails)>, Integer, Hash)>] Response<(LocaleDetails)> data, response status code and response headers
288
+ def locale_show_with_http_info(project_id, id, opts = {})
289
+ if @api_client.config.debugging
290
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_show ...'
291
+ end
292
+ # verify the required parameter 'project_id' is set
293
+ if @api_client.config.client_side_validation && project_id.nil?
294
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locale_show"
295
+ end
296
+ # verify the required parameter 'id' is set
297
+ if @api_client.config.client_side_validation && id.nil?
298
+ fail ArgumentError, "Missing the required parameter 'id' when calling LocalesApi.locale_show"
299
+ end
300
+ # resource path
301
+ local_var_path = '/projects/{project_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
302
+
303
+ # query parameters
304
+ query_params = opts[:query_params] || {}
305
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
306
+
307
+ # header parameters
308
+ header_params = opts[:header_params] || {}
309
+ # HTTP header 'Accept' (if needed)
310
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
311
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
312
+
313
+ # form parameters
314
+ form_params = opts[:form_params] || {}
315
+
316
+ # http body (model)
317
+ post_body = opts[:body]
318
+
319
+ # return_type
320
+ return_type = opts[:return_type] || 'LocaleDetails'
321
+
322
+ # auth_names
323
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
324
+
325
+ new_options = opts.merge(
326
+ :header_params => header_params,
327
+ :query_params => query_params,
328
+ :form_params => form_params,
329
+ :body => post_body,
330
+ :auth_names => auth_names,
331
+ :return_type => return_type
332
+ )
333
+
334
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
335
+ if @api_client.config.debugging
336
+ @api_client.config.logger.debug "API called: LocalesApi#locale_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
337
+ end
338
+ response = ::Phrase::Response.new(data, headers)
339
+ return response, status_code, headers
340
+ end
341
+
342
+ # Update a locale
343
+ # Update an existing locale.
344
+ # @param project_id [String] Project ID
345
+ # @param id [String] ID
346
+ # @param locale_update_parameters [LocaleUpdateParameters]
347
+ # @param [Hash] opts the optional parameters
348
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
349
+ # @return [LocaleDetails]
350
+ def locale_update(project_id, id, locale_update_parameters, opts = {})
351
+ data, _status_code, _headers = locale_update_with_http_info(project_id, id, locale_update_parameters, opts)
352
+ data
353
+ end
354
+
355
+ # Update a locale
356
+ # Update an existing locale.
357
+ # @param project_id [String] Project ID
358
+ # @param id [String] ID
359
+ # @param locale_update_parameters [LocaleUpdateParameters]
360
+ # @param [Hash] opts the optional parameters
361
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
362
+ # @return [Array<(Response<(LocaleDetails)>, Integer, Hash)>] Response<(LocaleDetails)> data, response status code and response headers
363
+ def locale_update_with_http_info(project_id, id, locale_update_parameters, opts = {})
364
+ if @api_client.config.debugging
365
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locale_update ...'
366
+ end
367
+ # verify the required parameter 'project_id' is set
368
+ if @api_client.config.client_side_validation && project_id.nil?
369
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locale_update"
370
+ end
371
+ # verify the required parameter 'id' is set
372
+ if @api_client.config.client_side_validation && id.nil?
373
+ fail ArgumentError, "Missing the required parameter 'id' when calling LocalesApi.locale_update"
374
+ end
375
+ # verify the required parameter 'locale_update_parameters' is set
376
+ if @api_client.config.client_side_validation && locale_update_parameters.nil?
377
+ fail ArgumentError, "Missing the required parameter 'locale_update_parameters' when calling LocalesApi.locale_update"
378
+ end
379
+ # resource path
380
+ local_var_path = '/projects/{project_id}/locales/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
381
+
382
+ # query parameters
383
+ query_params = opts[:query_params] || {}
384
+
385
+ # header parameters
386
+ header_params = opts[:header_params] || {}
387
+ # HTTP header 'Accept' (if needed)
388
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
389
+ # HTTP header 'Content-Type'
390
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
391
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
392
+
393
+ # form parameters
394
+ form_params = opts[:form_params] || {}
395
+
396
+ # http body (model)
397
+ post_body = opts[:body] || @api_client.object_to_http_body(locale_update_parameters)
398
+
399
+ # return_type
400
+ return_type = opts[:return_type] || 'LocaleDetails'
401
+
402
+ # auth_names
403
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
404
+
405
+ new_options = opts.merge(
406
+ :header_params => header_params,
407
+ :query_params => query_params,
408
+ :form_params => form_params,
409
+ :body => post_body,
410
+ :auth_names => auth_names,
411
+ :return_type => return_type
412
+ )
413
+
414
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
415
+ if @api_client.config.debugging
416
+ @api_client.config.logger.debug "API called: LocalesApi#locale_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
417
+ end
418
+ response = ::Phrase::Response.new(data, headers)
419
+ return response, status_code, headers
420
+ end
421
+
422
+ # List locales
423
+ # List all locales for the given project.
424
+ # @param project_id [String] Project ID
425
+ # @param [Hash] opts the optional parameters
426
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
427
+ # @option opts [Integer] :page Page number
428
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
429
+ # @option opts [String] :branch specify the branch to use
430
+ # @return [Array<Locale>]
431
+ def locales_list(project_id, opts = {})
432
+ data, _status_code, _headers = locales_list_with_http_info(project_id, opts)
433
+ data
434
+ end
435
+
436
+ # List locales
437
+ # List all locales for the given project.
438
+ # @param project_id [String] Project ID
439
+ # @param [Hash] opts the optional parameters
440
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
441
+ # @option opts [Integer] :page Page number
442
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
443
+ # @option opts [String] :branch specify the branch to use
444
+ # @return [Array<(Response<(Array<Locale>)>, Integer, Hash)>] Response<(Array<Locale>)> data, response status code and response headers
445
+ def locales_list_with_http_info(project_id, opts = {})
446
+ if @api_client.config.debugging
447
+ @api_client.config.logger.debug 'Calling API: LocalesApi.locales_list ...'
448
+ end
449
+ # verify the required parameter 'project_id' is set
450
+ if @api_client.config.client_side_validation && project_id.nil?
451
+ fail ArgumentError, "Missing the required parameter 'project_id' when calling LocalesApi.locales_list"
452
+ end
453
+ # resource path
454
+ local_var_path = '/projects/{project_id}/locales'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
455
+
456
+ # query parameters
457
+ query_params = opts[:query_params] || {}
458
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
459
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
460
+ query_params[:'branch'] = opts[:'branch'] if !opts[:'branch'].nil?
461
+
462
+ # header parameters
463
+ header_params = opts[:header_params] || {}
464
+ # HTTP header 'Accept' (if needed)
465
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
466
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
467
+
468
+ # form parameters
469
+ form_params = opts[:form_params] || {}
470
+
471
+ # http body (model)
472
+ post_body = opts[:body]
473
+
474
+ # return_type
475
+ return_type = opts[:return_type] || 'Array<Locale>'
476
+
477
+ # auth_names
478
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
479
+
480
+ new_options = opts.merge(
481
+ :header_params => header_params,
482
+ :query_params => query_params,
483
+ :form_params => form_params,
484
+ :body => post_body,
485
+ :auth_names => auth_names,
486
+ :return_type => return_type
487
+ )
488
+
489
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
490
+ if @api_client.config.debugging
491
+ @api_client.config.logger.debug "API called: LocalesApi#locales_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
492
+ end
493
+ response = ::Phrase::Response.new(data, headers)
494
+ return response, status_code, headers
495
+ end
496
+ end
497
+ end