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,45 @@
1
+ # Phrase::KeyCreateParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **branch** | **String** | specify the branch to use | [optional]
8
+ **name** | **String** | Key name | [optional]
9
+ **description** | **String** | Key description (usually includes contextual information for translators) | [optional]
10
+ **plural** | **Boolean** | Indicates whether key supports pluralization | [optional]
11
+ **name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional]
12
+ **data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional]
13
+ **tags** | **String** | List of tags separated by comma to be associated with the key. | [optional]
14
+ **max_characters_allowed** | **Integer** | Max. number of characters translations for this key can have. | [optional]
15
+ **screenshot** | **File** | Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
16
+ **remove_screenshot** | **Boolean** | Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
17
+ **unformatted** | **Boolean** | Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats. | [optional]
18
+ **xml_space_preserve** | **Boolean** | Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats. | [optional]
19
+ **original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
20
+ **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
21
+ **localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
22
+
23
+ ## Code Sample
24
+
25
+ ```ruby
26
+ require 'Phrase'
27
+
28
+ instance = Phrase::KeyCreateParameters.new(branch: my-feature-branch,
29
+ name: home.index.headline,
30
+ description: Some description worth knowing...,
31
+ plural: null,
32
+ name_plural: home.index.headlines,
33
+ data_type: number,
34
+ tags: awesome-feature,needs-proofreading,
35
+ max_characters_allowed: 140,
36
+ screenshot: null,
37
+ remove_screenshot: null,
38
+ unformatted: null,
39
+ xml_space_preserve: null,
40
+ original_file: null,
41
+ localized_format_string: null,
42
+ localized_format_key: null)
43
+ ```
44
+
45
+
@@ -0,0 +1,21 @@
1
+ # Phrase::KeyPreview
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **id** | **String** | | [optional]
8
+ **name** | **String** | | [optional]
9
+ **plural** | **Boolean** | | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Phrase'
15
+
16
+ instance = Phrase::KeyPreview.new(id: null,
17
+ name: null,
18
+ plural: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,45 @@
1
+ # Phrase::KeyUpdateParameters
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **branch** | **String** | specify the branch to use | [optional]
8
+ **name** | **String** | Key name | [optional]
9
+ **description** | **String** | Key description (usually includes contextual information for translators) | [optional]
10
+ **plural** | **Boolean** | Indicates whether key supports pluralization | [optional]
11
+ **name_plural** | **String** | Plural name for the key (used in some file formats, e.g. Gettext) | [optional]
12
+ **data_type** | **String** | Type of the key. Can be one of the following: string, number, boolean, array, markdown. | [optional]
13
+ **tags** | **String** | List of tags separated by comma to be associated with the key. | [optional]
14
+ **max_characters_allowed** | **Integer** | Max. number of characters translations for this key can have. | [optional]
15
+ **screenshot** | **File** | Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
16
+ **remove_screenshot** | **Boolean** | Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead. | [optional]
17
+ **unformatted** | **Boolean** | Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats. | [optional]
18
+ **xml_space_preserve** | **Boolean** | Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats. | [optional]
19
+ **original_file** | **String** | Original file attribute. Used in some formats, e.g. XLIFF. | [optional]
20
+ **localized_format_string** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
21
+ **localized_format_key** | **String** | NSStringLocalizedFormatKey attribute. Used in .stringsdict format. | [optional]
22
+
23
+ ## Code Sample
24
+
25
+ ```ruby
26
+ require 'Phrase'
27
+
28
+ instance = Phrase::KeyUpdateParameters.new(branch: my-feature-branch,
29
+ name: home.index.headline,
30
+ description: Some description worth knowing...,
31
+ plural: null,
32
+ name_plural: home.index.headlines,
33
+ data_type: number,
34
+ tags: awesome-feature,needs-proofreading,
35
+ max_characters_allowed: 140,
36
+ screenshot: null,
37
+ remove_screenshot: null,
38
+ unformatted: null,
39
+ xml_space_preserve: null,
40
+ original_file: null,
41
+ localized_format_string: null,
42
+ localized_format_key: null)
43
+ ```
44
+
45
+
@@ -0,0 +1,617 @@
1
+ # Phrase::KeysApi
2
+
3
+ All URIs are relative to *https://api.phrase.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**key_create**](KeysApi.md#key_create) | **POST** /projects/{project_id}/keys | Create a key
8
+ [**key_delete**](KeysApi.md#key_delete) | **DELETE** /projects/{project_id}/keys/{id} | Delete a key
9
+ [**key_show**](KeysApi.md#key_show) | **GET** /projects/{project_id}/keys/{id} | Get a single key
10
+ [**key_update**](KeysApi.md#key_update) | **PATCH** /projects/{project_id}/keys/{id} | Update a key
11
+ [**keys_delete**](KeysApi.md#keys_delete) | **DELETE** /projects/{project_id}/keys | Delete collection of keys
12
+ [**keys_list**](KeysApi.md#keys_list) | **GET** /projects/{project_id}/keys | List keys
13
+ [**keys_search**](KeysApi.md#keys_search) | **POST** /projects/{project_id}/keys/search | Search keys
14
+ [**keys_tag**](KeysApi.md#keys_tag) | **PATCH** /projects/{project_id}/keys/tag | Add tags to collection of keys
15
+ [**keys_untag**](KeysApi.md#keys_untag) | **PATCH** /projects/{project_id}/keys/untag | Remove tags from collection of keys
16
+
17
+
18
+
19
+ ## key_create
20
+
21
+ > key_create(project_id, key_create_parameters, opts)
22
+
23
+ Create a key
24
+
25
+ Create a new key.
26
+
27
+ ### Example
28
+
29
+ ```ruby
30
+ # load the gem
31
+ require 'phrase'
32
+ # setup authorization
33
+ Phrase.configure do |config|
34
+ # Configure HTTP basic authorization: Basic
35
+ config.username = 'YOUR USERNAME'
36
+ config.password = 'YOUR PASSWORD'
37
+
38
+ # Configure API key authorization: Token
39
+ config.api_key['Authorization'] = 'YOUR API KEY'
40
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
41
+ #config.api_key_prefix['Authorization'] = 'Bearer'
42
+ end
43
+
44
+ api_instance = Phrase::KeysApi.new
45
+ project_id = 'project_id_example' # String | Project ID
46
+ key_create_parameters = Phrase::KeyCreateParameters.new # KeyCreateParameters |
47
+ opts = {
48
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
49
+ }
50
+
51
+ begin
52
+ #Create a key
53
+ api_instance.key_create(project_id, key_create_parameters, opts)
54
+ rescue Phrase::ApiError => e
55
+ puts "Exception when calling KeysApi->key_create: #{e}"
56
+ end
57
+ ```
58
+
59
+ ### Parameters
60
+
61
+
62
+ Name | Type | Description | Notes
63
+ ------------- | ------------- | ------------- | -------------
64
+ **project_id** | **String**| Project ID |
65
+ **key_create_parameters** | [**KeyCreateParameters**](KeyCreateParameters.md)| |
66
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
67
+
68
+ ### Return type
69
+
70
+ Response<(nil (empty response body))>
71
+
72
+ ### Authorization
73
+
74
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json
79
+ - **Accept**: Not defined
80
+
81
+
82
+ ## key_delete
83
+
84
+ > key_delete(project_id, id, opts)
85
+
86
+ Delete a key
87
+
88
+ Delete an existing key.
89
+
90
+ ### Example
91
+
92
+ ```ruby
93
+ # load the gem
94
+ require 'phrase'
95
+ # setup authorization
96
+ Phrase.configure do |config|
97
+ # Configure HTTP basic authorization: Basic
98
+ config.username = 'YOUR USERNAME'
99
+ config.password = 'YOUR PASSWORD'
100
+
101
+ # Configure API key authorization: Token
102
+ config.api_key['Authorization'] = 'YOUR API KEY'
103
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
104
+ #config.api_key_prefix['Authorization'] = 'Bearer'
105
+ end
106
+
107
+ api_instance = Phrase::KeysApi.new
108
+ project_id = 'project_id_example' # String | Project ID
109
+ id = 'id_example' # String | ID
110
+ opts = {
111
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
112
+ branch: 'my-feature-branch' # String | specify the branch to use
113
+ }
114
+
115
+ begin
116
+ #Delete a key
117
+ api_instance.key_delete(project_id, id, opts)
118
+ rescue Phrase::ApiError => e
119
+ puts "Exception when calling KeysApi->key_delete: #{e}"
120
+ end
121
+ ```
122
+
123
+ ### Parameters
124
+
125
+
126
+ Name | Type | Description | Notes
127
+ ------------- | ------------- | ------------- | -------------
128
+ **project_id** | **String**| Project ID |
129
+ **id** | **String**| ID |
130
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
131
+ **branch** | **String**| specify the branch to use | [optional]
132
+
133
+ ### Return type
134
+
135
+ Response<(nil (empty response body))>
136
+
137
+ ### Authorization
138
+
139
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
140
+
141
+ ### HTTP request headers
142
+
143
+ - **Content-Type**: Not defined
144
+ - **Accept**: Not defined
145
+
146
+
147
+ ## key_show
148
+
149
+ > TranslationKeyDetails key_show(project_id, id, opts)
150
+
151
+ Get a single key
152
+
153
+ Get details on a single key for a given project.
154
+
155
+ ### Example
156
+
157
+ ```ruby
158
+ # load the gem
159
+ require 'phrase'
160
+ # setup authorization
161
+ Phrase.configure do |config|
162
+ # Configure HTTP basic authorization: Basic
163
+ config.username = 'YOUR USERNAME'
164
+ config.password = 'YOUR PASSWORD'
165
+
166
+ # Configure API key authorization: Token
167
+ config.api_key['Authorization'] = 'YOUR API KEY'
168
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
169
+ #config.api_key_prefix['Authorization'] = 'Bearer'
170
+ end
171
+
172
+ api_instance = Phrase::KeysApi.new
173
+ project_id = 'project_id_example' # String | Project ID
174
+ id = 'id_example' # String | ID
175
+ opts = {
176
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
177
+ branch: 'my-feature-branch' # String | specify the branch to use
178
+ }
179
+
180
+ begin
181
+ #Get a single key
182
+ result = api_instance.key_show(project_id, id, opts)
183
+ pp result
184
+ rescue Phrase::ApiError => e
185
+ puts "Exception when calling KeysApi->key_show: #{e}"
186
+ end
187
+ ```
188
+
189
+ ### Parameters
190
+
191
+
192
+ Name | Type | Description | Notes
193
+ ------------- | ------------- | ------------- | -------------
194
+ **project_id** | **String**| Project ID |
195
+ **id** | **String**| ID |
196
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
197
+ **branch** | **String**| specify the branch to use | [optional]
198
+
199
+ ### Return type
200
+
201
+ Response<([**TranslationKeyDetails**](TranslationKeyDetails.md))>
202
+
203
+ ### Authorization
204
+
205
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
206
+
207
+ ### HTTP request headers
208
+
209
+ - **Content-Type**: Not defined
210
+ - **Accept**: application/json
211
+
212
+
213
+ ## key_update
214
+
215
+ > TranslationKeyDetails key_update(project_id, id, key_update_parameters, opts)
216
+
217
+ Update a key
218
+
219
+ Update an existing key.
220
+
221
+ ### Example
222
+
223
+ ```ruby
224
+ # load the gem
225
+ require 'phrase'
226
+ # setup authorization
227
+ Phrase.configure do |config|
228
+ # Configure HTTP basic authorization: Basic
229
+ config.username = 'YOUR USERNAME'
230
+ config.password = 'YOUR PASSWORD'
231
+
232
+ # Configure API key authorization: Token
233
+ config.api_key['Authorization'] = 'YOUR API KEY'
234
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
235
+ #config.api_key_prefix['Authorization'] = 'Bearer'
236
+ end
237
+
238
+ api_instance = Phrase::KeysApi.new
239
+ project_id = 'project_id_example' # String | Project ID
240
+ id = 'id_example' # String | ID
241
+ key_update_parameters = Phrase::KeyUpdateParameters.new # KeyUpdateParameters |
242
+ opts = {
243
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
244
+ }
245
+
246
+ begin
247
+ #Update a key
248
+ result = api_instance.key_update(project_id, id, key_update_parameters, opts)
249
+ pp result
250
+ rescue Phrase::ApiError => e
251
+ puts "Exception when calling KeysApi->key_update: #{e}"
252
+ end
253
+ ```
254
+
255
+ ### Parameters
256
+
257
+
258
+ Name | Type | Description | Notes
259
+ ------------- | ------------- | ------------- | -------------
260
+ **project_id** | **String**| Project ID |
261
+ **id** | **String**| ID |
262
+ **key_update_parameters** | [**KeyUpdateParameters**](KeyUpdateParameters.md)| |
263
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
264
+
265
+ ### Return type
266
+
267
+ Response<([**TranslationKeyDetails**](TranslationKeyDetails.md))>
268
+
269
+ ### Authorization
270
+
271
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
272
+
273
+ ### HTTP request headers
274
+
275
+ - **Content-Type**: application/json
276
+ - **Accept**: application/json
277
+
278
+
279
+ ## keys_delete
280
+
281
+ > AffectedResources keys_delete(project_id, opts)
282
+
283
+ Delete collection of keys
284
+
285
+ Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.
286
+
287
+ ### Example
288
+
289
+ ```ruby
290
+ # load the gem
291
+ require 'phrase'
292
+ # setup authorization
293
+ Phrase.configure do |config|
294
+ # Configure HTTP basic authorization: Basic
295
+ config.username = 'YOUR USERNAME'
296
+ config.password = 'YOUR PASSWORD'
297
+
298
+ # Configure API key authorization: Token
299
+ config.api_key['Authorization'] = 'YOUR API KEY'
300
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
301
+ #config.api_key_prefix['Authorization'] = 'Bearer'
302
+ end
303
+
304
+ api_instance = Phrase::KeysApi.new
305
+ project_id = 'project_id_example' # String | Project ID
306
+ opts = {
307
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
308
+ branch: 'my-feature-branch', # String | specify the branch to use
309
+ q: 'mykey* translated:true', # String | q_description_placeholder
310
+ locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
311
+ }
312
+
313
+ begin
314
+ #Delete collection of keys
315
+ result = api_instance.keys_delete(project_id, opts)
316
+ pp result
317
+ rescue Phrase::ApiError => e
318
+ puts "Exception when calling KeysApi->keys_delete: #{e}"
319
+ end
320
+ ```
321
+
322
+ ### Parameters
323
+
324
+
325
+ Name | Type | Description | Notes
326
+ ------------- | ------------- | ------------- | -------------
327
+ **project_id** | **String**| Project ID |
328
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
329
+ **branch** | **String**| specify the branch to use | [optional]
330
+ **q** | **String**| q_description_placeholder | [optional]
331
+ **locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
332
+
333
+ ### Return type
334
+
335
+ Response<([**AffectedResources**](AffectedResources.md))>
336
+
337
+ ### Authorization
338
+
339
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
340
+
341
+ ### HTTP request headers
342
+
343
+ - **Content-Type**: Not defined
344
+ - **Accept**: application/json
345
+
346
+
347
+ ## keys_list
348
+
349
+ > Array&lt;TranslationKey&gt; keys_list(project_id, opts)
350
+
351
+ List keys
352
+
353
+ List all keys for the given project. Alternatively you can POST requests to /search.
354
+
355
+ ### Example
356
+
357
+ ```ruby
358
+ # load the gem
359
+ require 'phrase'
360
+ # setup authorization
361
+ Phrase.configure do |config|
362
+ # Configure HTTP basic authorization: Basic
363
+ config.username = 'YOUR USERNAME'
364
+ config.password = 'YOUR PASSWORD'
365
+
366
+ # Configure API key authorization: Token
367
+ config.api_key['Authorization'] = 'YOUR API KEY'
368
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
369
+ #config.api_key_prefix['Authorization'] = 'Bearer'
370
+ end
371
+
372
+ api_instance = Phrase::KeysApi.new
373
+ project_id = 'project_id_example' # String | Project ID
374
+ opts = {
375
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
376
+ page: 1, # Integer | Page number
377
+ per_page: 10, # Integer | allows you to specify a page size up to 100 items, 10 by default
378
+ branch: 'my-feature-branch', # String | specify the branch to use
379
+ sort: 'updated_at', # String | Sort by field. Can be one of: name, created_at, updated_at.
380
+ order: 'desc', # String | Order direction. Can be one of: asc, desc.
381
+ q: 'mykey* translated:true', # String | q_description_placeholder
382
+ locale_id: 'abcd1234abcd1234abcd1234abcd1234' # String | Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
383
+ }
384
+
385
+ begin
386
+ #List keys
387
+ result = api_instance.keys_list(project_id, opts)
388
+ pp result
389
+ rescue Phrase::ApiError => e
390
+ puts "Exception when calling KeysApi->keys_list: #{e}"
391
+ end
392
+ ```
393
+
394
+ ### Parameters
395
+
396
+
397
+ Name | Type | Description | Notes
398
+ ------------- | ------------- | ------------- | -------------
399
+ **project_id** | **String**| Project ID |
400
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
401
+ **page** | **Integer**| Page number | [optional]
402
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
403
+ **branch** | **String**| specify the branch to use | [optional]
404
+ **sort** | **String**| Sort by field. Can be one of: name, created_at, updated_at. | [optional]
405
+ **order** | **String**| Order direction. Can be one of: asc, desc. | [optional]
406
+ **q** | **String**| q_description_placeholder | [optional]
407
+ **locale_id** | **String**| Locale used to determine the translation state of a key when filtering for untranslated or translated keys. | [optional]
408
+
409
+ ### Return type
410
+
411
+ Response<([**Array&lt;TranslationKey&gt;**](TranslationKey.md))>
412
+
413
+ ### Authorization
414
+
415
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
416
+
417
+ ### HTTP request headers
418
+
419
+ - **Content-Type**: Not defined
420
+ - **Accept**: application/json
421
+
422
+
423
+ ## keys_search
424
+
425
+ > Array&lt;TranslationKey&gt; keys_search(project_id, keys_search_parameters, opts)
426
+
427
+ Search keys
428
+
429
+ Search keys for the given project matching query.
430
+
431
+ ### Example
432
+
433
+ ```ruby
434
+ # load the gem
435
+ require 'phrase'
436
+ # setup authorization
437
+ Phrase.configure do |config|
438
+ # Configure HTTP basic authorization: Basic
439
+ config.username = 'YOUR USERNAME'
440
+ config.password = 'YOUR PASSWORD'
441
+
442
+ # Configure API key authorization: Token
443
+ config.api_key['Authorization'] = 'YOUR API KEY'
444
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
445
+ #config.api_key_prefix['Authorization'] = 'Bearer'
446
+ end
447
+
448
+ api_instance = Phrase::KeysApi.new
449
+ project_id = 'project_id_example' # String | Project ID
450
+ keys_search_parameters = Phrase::KeysSearchParameters.new # KeysSearchParameters |
451
+ opts = {
452
+ x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
453
+ page: 1, # Integer | Page number
454
+ per_page: 10 # Integer | allows you to specify a page size up to 100 items, 10 by default
455
+ }
456
+
457
+ begin
458
+ #Search keys
459
+ result = api_instance.keys_search(project_id, keys_search_parameters, opts)
460
+ pp result
461
+ rescue Phrase::ApiError => e
462
+ puts "Exception when calling KeysApi->keys_search: #{e}"
463
+ end
464
+ ```
465
+
466
+ ### Parameters
467
+
468
+
469
+ Name | Type | Description | Notes
470
+ ------------- | ------------- | ------------- | -------------
471
+ **project_id** | **String**| Project ID |
472
+ **keys_search_parameters** | [**KeysSearchParameters**](KeysSearchParameters.md)| |
473
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
474
+ **page** | **Integer**| Page number | [optional]
475
+ **per_page** | **Integer**| allows you to specify a page size up to 100 items, 10 by default | [optional]
476
+
477
+ ### Return type
478
+
479
+ Response<([**Array&lt;TranslationKey&gt;**](TranslationKey.md))>
480
+
481
+ ### Authorization
482
+
483
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
484
+
485
+ ### HTTP request headers
486
+
487
+ - **Content-Type**: application/json
488
+ - **Accept**: application/json
489
+
490
+
491
+ ## keys_tag
492
+
493
+ > AffectedResources keys_tag(project_id, keys_tag_parameters, opts)
494
+
495
+ Add tags to collection of keys
496
+
497
+ Tags all keys matching query. Same constraints as list.
498
+
499
+ ### Example
500
+
501
+ ```ruby
502
+ # load the gem
503
+ require 'phrase'
504
+ # setup authorization
505
+ Phrase.configure do |config|
506
+ # Configure HTTP basic authorization: Basic
507
+ config.username = 'YOUR USERNAME'
508
+ config.password = 'YOUR PASSWORD'
509
+
510
+ # Configure API key authorization: Token
511
+ config.api_key['Authorization'] = 'YOUR API KEY'
512
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
513
+ #config.api_key_prefix['Authorization'] = 'Bearer'
514
+ end
515
+
516
+ api_instance = Phrase::KeysApi.new
517
+ project_id = 'project_id_example' # String | Project ID
518
+ keys_tag_parameters = Phrase::KeysTagParameters.new # KeysTagParameters |
519
+ opts = {
520
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
521
+ }
522
+
523
+ begin
524
+ #Add tags to collection of keys
525
+ result = api_instance.keys_tag(project_id, keys_tag_parameters, opts)
526
+ pp result
527
+ rescue Phrase::ApiError => e
528
+ puts "Exception when calling KeysApi->keys_tag: #{e}"
529
+ end
530
+ ```
531
+
532
+ ### Parameters
533
+
534
+
535
+ Name | Type | Description | Notes
536
+ ------------- | ------------- | ------------- | -------------
537
+ **project_id** | **String**| Project ID |
538
+ **keys_tag_parameters** | [**KeysTagParameters**](KeysTagParameters.md)| |
539
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
540
+
541
+ ### Return type
542
+
543
+ Response<([**AffectedResources**](AffectedResources.md))>
544
+
545
+ ### Authorization
546
+
547
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
548
+
549
+ ### HTTP request headers
550
+
551
+ - **Content-Type**: application/json
552
+ - **Accept**: application/json
553
+
554
+
555
+ ## keys_untag
556
+
557
+ > AffectedResources keys_untag(project_id, keys_untag_parameters, opts)
558
+
559
+ Remove tags from collection of keys
560
+
561
+ Removes specified tags from keys matching query.
562
+
563
+ ### Example
564
+
565
+ ```ruby
566
+ # load the gem
567
+ require 'phrase'
568
+ # setup authorization
569
+ Phrase.configure do |config|
570
+ # Configure HTTP basic authorization: Basic
571
+ config.username = 'YOUR USERNAME'
572
+ config.password = 'YOUR PASSWORD'
573
+
574
+ # Configure API key authorization: Token
575
+ config.api_key['Authorization'] = 'YOUR API KEY'
576
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
577
+ #config.api_key_prefix['Authorization'] = 'Bearer'
578
+ end
579
+
580
+ api_instance = Phrase::KeysApi.new
581
+ project_id = 'project_id_example' # String | Project ID
582
+ keys_untag_parameters = Phrase::KeysUntagParameters.new # KeysUntagParameters |
583
+ opts = {
584
+ x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
585
+ }
586
+
587
+ begin
588
+ #Remove tags from collection of keys
589
+ result = api_instance.keys_untag(project_id, keys_untag_parameters, opts)
590
+ pp result
591
+ rescue Phrase::ApiError => e
592
+ puts "Exception when calling KeysApi->keys_untag: #{e}"
593
+ end
594
+ ```
595
+
596
+ ### Parameters
597
+
598
+
599
+ Name | Type | Description | Notes
600
+ ------------- | ------------- | ------------- | -------------
601
+ **project_id** | **String**| Project ID |
602
+ **keys_untag_parameters** | [**KeysUntagParameters**](KeysUntagParameters.md)| |
603
+ **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
604
+
605
+ ### Return type
606
+
607
+ Response<([**AffectedResources**](AffectedResources.md))>
608
+
609
+ ### Authorization
610
+
611
+ [Basic](../README.md#Basic), [Token](../README.md#Token)
612
+
613
+ ### HTTP request headers
614
+
615
+ - **Content-Type**: application/json
616
+ - **Accept**: application/json
617
+