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,406 @@
1
+ require 'cgi'
2
+
3
+ module Phrase
4
+ class GlossaryTermsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+ # Create a glossary term
11
+ # Create a new glossary term.
12
+ # @param account_id [String] Account ID
13
+ # @param glossary_id [String] Glossary ID
14
+ # @param glossary_term_create_parameters [GlossaryTermCreateParameters]
15
+ # @param [Hash] opts the optional parameters
16
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
17
+ # @return [nil]
18
+ def glossary_term_create(account_id, glossary_id, glossary_term_create_parameters, opts = {})
19
+ glossary_term_create_with_http_info(account_id, glossary_id, glossary_term_create_parameters, opts)
20
+ nil
21
+ end
22
+
23
+ # Create a glossary term
24
+ # Create a new glossary term.
25
+ # @param account_id [String] Account ID
26
+ # @param glossary_id [String] Glossary ID
27
+ # @param glossary_term_create_parameters [GlossaryTermCreateParameters]
28
+ # @param [Hash] opts the optional parameters
29
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
30
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
31
+ def glossary_term_create_with_http_info(account_id, glossary_id, glossary_term_create_parameters, opts = {})
32
+ if @api_client.config.debugging
33
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_create ...'
34
+ end
35
+ # verify the required parameter 'account_id' is set
36
+ if @api_client.config.client_side_validation && account_id.nil?
37
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_create"
38
+ end
39
+ # verify the required parameter 'glossary_id' is set
40
+ if @api_client.config.client_side_validation && glossary_id.nil?
41
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_create"
42
+ end
43
+ # verify the required parameter 'glossary_term_create_parameters' is set
44
+ if @api_client.config.client_side_validation && glossary_term_create_parameters.nil?
45
+ fail ArgumentError, "Missing the required parameter 'glossary_term_create_parameters' when calling GlossaryTermsApi.glossary_term_create"
46
+ end
47
+ # resource path
48
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s))
49
+
50
+ # query parameters
51
+ query_params = opts[:query_params] || {}
52
+
53
+ # header parameters
54
+ header_params = opts[:header_params] || {}
55
+ # HTTP header 'Content-Type'
56
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
57
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
58
+
59
+ # form parameters
60
+ form_params = opts[:form_params] || {}
61
+
62
+ # http body (model)
63
+ post_body = opts[:body] || @api_client.object_to_http_body(glossary_term_create_parameters)
64
+
65
+ # return_type
66
+ return_type = opts[:return_type]
67
+
68
+ # auth_names
69
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
70
+
71
+ new_options = opts.merge(
72
+ :header_params => header_params,
73
+ :query_params => query_params,
74
+ :form_params => form_params,
75
+ :body => post_body,
76
+ :auth_names => auth_names,
77
+ :return_type => return_type
78
+ )
79
+
80
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
81
+ if @api_client.config.debugging
82
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
83
+ end
84
+ response = ::Phrase::Response.new(data, headers)
85
+ return response, status_code, headers
86
+ end
87
+
88
+ # Delete a glossary term
89
+ # Delete an existing glossary term.
90
+ # @param account_id [String] Account ID
91
+ # @param glossary_id [String] Glossary ID
92
+ # @param id [String] ID
93
+ # @param [Hash] opts the optional parameters
94
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
95
+ # @return [nil]
96
+ def glossary_term_delete(account_id, glossary_id, id, opts = {})
97
+ glossary_term_delete_with_http_info(account_id, glossary_id, id, opts)
98
+ nil
99
+ end
100
+
101
+ # Delete a glossary term
102
+ # Delete an existing glossary term.
103
+ # @param account_id [String] Account ID
104
+ # @param glossary_id [String] Glossary ID
105
+ # @param id [String] ID
106
+ # @param [Hash] opts the optional parameters
107
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
108
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
109
+ def glossary_term_delete_with_http_info(account_id, glossary_id, id, opts = {})
110
+ if @api_client.config.debugging
111
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_delete ...'
112
+ end
113
+ # verify the required parameter 'account_id' is set
114
+ if @api_client.config.client_side_validation && account_id.nil?
115
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_delete"
116
+ end
117
+ # verify the required parameter 'glossary_id' is set
118
+ if @api_client.config.client_side_validation && glossary_id.nil?
119
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_delete"
120
+ end
121
+ # verify the required parameter 'id' is set
122
+ if @api_client.config.client_side_validation && id.nil?
123
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_delete"
124
+ end
125
+ # resource path
126
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
127
+
128
+ # query parameters
129
+ query_params = opts[:query_params] || {}
130
+
131
+ # header parameters
132
+ header_params = opts[:header_params] || {}
133
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
134
+
135
+ # form parameters
136
+ form_params = opts[:form_params] || {}
137
+
138
+ # http body (model)
139
+ post_body = opts[:body]
140
+
141
+ # return_type
142
+ return_type = opts[:return_type]
143
+
144
+ # auth_names
145
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
146
+
147
+ new_options = opts.merge(
148
+ :header_params => header_params,
149
+ :query_params => query_params,
150
+ :form_params => form_params,
151
+ :body => post_body,
152
+ :auth_names => auth_names,
153
+ :return_type => return_type
154
+ )
155
+
156
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
157
+ if @api_client.config.debugging
158
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
159
+ end
160
+ response = ::Phrase::Response.new(data, headers)
161
+ return response, status_code, headers
162
+ end
163
+
164
+ # Get a single glossary term
165
+ # Get details on a single glossary term.
166
+ # @param account_id [String] Account ID
167
+ # @param glossary_id [String] Glossary ID
168
+ # @param id [String] ID
169
+ # @param [Hash] opts the optional parameters
170
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
171
+ # @return [GlossaryTerm]
172
+ def glossary_term_show(account_id, glossary_id, id, opts = {})
173
+ data, _status_code, _headers = glossary_term_show_with_http_info(account_id, glossary_id, id, opts)
174
+ data
175
+ end
176
+
177
+ # Get a single glossary term
178
+ # Get details on a single glossary term.
179
+ # @param account_id [String] Account ID
180
+ # @param glossary_id [String] Glossary ID
181
+ # @param id [String] ID
182
+ # @param [Hash] opts the optional parameters
183
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
184
+ # @return [Array<(Response<(GlossaryTerm)>, Integer, Hash)>] Response<(GlossaryTerm)> data, response status code and response headers
185
+ def glossary_term_show_with_http_info(account_id, glossary_id, id, opts = {})
186
+ if @api_client.config.debugging
187
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_show ...'
188
+ end
189
+ # verify the required parameter 'account_id' is set
190
+ if @api_client.config.client_side_validation && account_id.nil?
191
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_show"
192
+ end
193
+ # verify the required parameter 'glossary_id' is set
194
+ if @api_client.config.client_side_validation && glossary_id.nil?
195
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_show"
196
+ end
197
+ # verify the required parameter 'id' is set
198
+ if @api_client.config.client_side_validation && id.nil?
199
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_show"
200
+ end
201
+ # resource path
202
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
203
+
204
+ # query parameters
205
+ query_params = opts[:query_params] || {}
206
+
207
+ # header parameters
208
+ header_params = opts[:header_params] || {}
209
+ # HTTP header 'Accept' (if needed)
210
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
211
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
212
+
213
+ # form parameters
214
+ form_params = opts[:form_params] || {}
215
+
216
+ # http body (model)
217
+ post_body = opts[:body]
218
+
219
+ # return_type
220
+ return_type = opts[:return_type] || 'GlossaryTerm'
221
+
222
+ # auth_names
223
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
224
+
225
+ new_options = opts.merge(
226
+ :header_params => header_params,
227
+ :query_params => query_params,
228
+ :form_params => form_params,
229
+ :body => post_body,
230
+ :auth_names => auth_names,
231
+ :return_type => return_type
232
+ )
233
+
234
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
235
+ if @api_client.config.debugging
236
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
237
+ end
238
+ response = ::Phrase::Response.new(data, headers)
239
+ return response, status_code, headers
240
+ end
241
+
242
+ # Update a glossary term
243
+ # Update an existing glossary term.
244
+ # @param account_id [String] Account ID
245
+ # @param glossary_id [String] Glossary ID
246
+ # @param id [String] ID
247
+ # @param glossary_term_update_parameters [GlossaryTermUpdateParameters]
248
+ # @param [Hash] opts the optional parameters
249
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
250
+ # @return [GlossaryTerm]
251
+ def glossary_term_update(account_id, glossary_id, id, glossary_term_update_parameters, opts = {})
252
+ data, _status_code, _headers = glossary_term_update_with_http_info(account_id, glossary_id, id, glossary_term_update_parameters, opts)
253
+ data
254
+ end
255
+
256
+ # Update a glossary term
257
+ # Update an existing glossary term.
258
+ # @param account_id [String] Account ID
259
+ # @param glossary_id [String] Glossary ID
260
+ # @param id [String] ID
261
+ # @param glossary_term_update_parameters [GlossaryTermUpdateParameters]
262
+ # @param [Hash] opts the optional parameters
263
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
264
+ # @return [Array<(Response<(GlossaryTerm)>, Integer, Hash)>] Response<(GlossaryTerm)> data, response status code and response headers
265
+ def glossary_term_update_with_http_info(account_id, glossary_id, id, glossary_term_update_parameters, opts = {})
266
+ if @api_client.config.debugging
267
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_term_update ...'
268
+ end
269
+ # verify the required parameter 'account_id' is set
270
+ if @api_client.config.client_side_validation && account_id.nil?
271
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_term_update"
272
+ end
273
+ # verify the required parameter 'glossary_id' is set
274
+ if @api_client.config.client_side_validation && glossary_id.nil?
275
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_term_update"
276
+ end
277
+ # verify the required parameter 'id' is set
278
+ if @api_client.config.client_side_validation && id.nil?
279
+ fail ArgumentError, "Missing the required parameter 'id' when calling GlossaryTermsApi.glossary_term_update"
280
+ end
281
+ # verify the required parameter 'glossary_term_update_parameters' is set
282
+ if @api_client.config.client_side_validation && glossary_term_update_parameters.nil?
283
+ fail ArgumentError, "Missing the required parameter 'glossary_term_update_parameters' when calling GlossaryTermsApi.glossary_term_update"
284
+ end
285
+ # resource path
286
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
287
+
288
+ # query parameters
289
+ query_params = opts[:query_params] || {}
290
+
291
+ # header parameters
292
+ header_params = opts[:header_params] || {}
293
+ # HTTP header 'Accept' (if needed)
294
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
295
+ # HTTP header 'Content-Type'
296
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
297
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
298
+
299
+ # form parameters
300
+ form_params = opts[:form_params] || {}
301
+
302
+ # http body (model)
303
+ post_body = opts[:body] || @api_client.object_to_http_body(glossary_term_update_parameters)
304
+
305
+ # return_type
306
+ return_type = opts[:return_type] || 'GlossaryTerm'
307
+
308
+ # auth_names
309
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
310
+
311
+ new_options = opts.merge(
312
+ :header_params => header_params,
313
+ :query_params => query_params,
314
+ :form_params => form_params,
315
+ :body => post_body,
316
+ :auth_names => auth_names,
317
+ :return_type => return_type
318
+ )
319
+
320
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
321
+ if @api_client.config.debugging
322
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_term_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
323
+ end
324
+ response = ::Phrase::Response.new(data, headers)
325
+ return response, status_code, headers
326
+ end
327
+
328
+ # List glossary terms
329
+ # List all glossary terms the current user has access to.
330
+ # @param account_id [String] Account ID
331
+ # @param glossary_id [String] Glossary ID
332
+ # @param [Hash] opts the optional parameters
333
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
334
+ # @option opts [Integer] :page Page number
335
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
336
+ # @return [Array<GlossaryTerm>]
337
+ def glossary_terms_list(account_id, glossary_id, opts = {})
338
+ data, _status_code, _headers = glossary_terms_list_with_http_info(account_id, glossary_id, opts)
339
+ data
340
+ end
341
+
342
+ # List glossary terms
343
+ # List all glossary terms the current user has access to.
344
+ # @param account_id [String] Account ID
345
+ # @param glossary_id [String] Glossary ID
346
+ # @param [Hash] opts the optional parameters
347
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
348
+ # @option opts [Integer] :page Page number
349
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
350
+ # @return [Array<(Response<(Array<GlossaryTerm>)>, Integer, Hash)>] Response<(Array<GlossaryTerm>)> data, response status code and response headers
351
+ def glossary_terms_list_with_http_info(account_id, glossary_id, opts = {})
352
+ if @api_client.config.debugging
353
+ @api_client.config.logger.debug 'Calling API: GlossaryTermsApi.glossary_terms_list ...'
354
+ end
355
+ # verify the required parameter 'account_id' is set
356
+ if @api_client.config.client_side_validation && account_id.nil?
357
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling GlossaryTermsApi.glossary_terms_list"
358
+ end
359
+ # verify the required parameter 'glossary_id' is set
360
+ if @api_client.config.client_side_validation && glossary_id.nil?
361
+ fail ArgumentError, "Missing the required parameter 'glossary_id' when calling GlossaryTermsApi.glossary_terms_list"
362
+ end
363
+ # resource path
364
+ local_var_path = '/accounts/{account_id}/glossaries/{glossary_id}/terms'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'glossary_id' + '}', CGI.escape(glossary_id.to_s))
365
+
366
+ # query parameters
367
+ query_params = opts[:query_params] || {}
368
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
369
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
370
+
371
+ # header parameters
372
+ header_params = opts[:header_params] || {}
373
+ # HTTP header 'Accept' (if needed)
374
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
375
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
376
+
377
+ # form parameters
378
+ form_params = opts[:form_params] || {}
379
+
380
+ # http body (model)
381
+ post_body = opts[:body]
382
+
383
+ # return_type
384
+ return_type = opts[:return_type] || 'Array<GlossaryTerm>'
385
+
386
+ # auth_names
387
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
388
+
389
+ new_options = opts.merge(
390
+ :header_params => header_params,
391
+ :query_params => query_params,
392
+ :form_params => form_params,
393
+ :body => post_body,
394
+ :auth_names => auth_names,
395
+ :return_type => return_type
396
+ )
397
+
398
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
399
+ if @api_client.config.debugging
400
+ @api_client.config.logger.debug "API called: GlossaryTermsApi#glossary_terms_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
401
+ end
402
+ response = ::Phrase::Response.new(data, headers)
403
+ return response, status_code, headers
404
+ end
405
+ end
406
+ end
@@ -0,0 +1,448 @@
1
+ require 'cgi'
2
+
3
+ module Phrase
4
+ class InvitationsApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+ # Create a new invitation
11
+ # Invite a person to an account. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
12
+ # @param account_id [String] Account ID
13
+ # @param invitation_create_parameters [InvitationCreateParameters]
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 invitation_create(account_id, invitation_create_parameters, opts = {})
18
+ invitation_create_with_http_info(account_id, invitation_create_parameters, opts)
19
+ nil
20
+ end
21
+
22
+ # Create a new invitation
23
+ # Invite a person to an account. Developers and translators need &lt;code&gt;project_ids&lt;/code&gt; and &lt;code&gt;locale_ids&lt;/code&gt; assigned to access them. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
24
+ # @param account_id [String] Account ID
25
+ # @param invitation_create_parameters [InvitationCreateParameters]
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 invitation_create_with_http_info(account_id, invitation_create_parameters, opts = {})
30
+ if @api_client.config.debugging
31
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_create ...'
32
+ end
33
+ # verify the required parameter 'account_id' is set
34
+ if @api_client.config.client_side_validation && account_id.nil?
35
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_create"
36
+ end
37
+ # verify the required parameter 'invitation_create_parameters' is set
38
+ if @api_client.config.client_side_validation && invitation_create_parameters.nil?
39
+ fail ArgumentError, "Missing the required parameter 'invitation_create_parameters' when calling InvitationsApi.invitation_create"
40
+ end
41
+ # resource path
42
+ local_var_path = '/accounts/{account_id}/invitations'.sub('{' + 'account_id' + '}', CGI.escape(account_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(invitation_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: InvitationsApi#invitation_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 an invitation
83
+ # Delete an existing invitation (must not be accepted yet). Access token scope must include <code>team.manage</code>.
84
+ # @param account_id [String] Account 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
+ # @return [nil]
89
+ def invitation_delete(account_id, id, opts = {})
90
+ invitation_delete_with_http_info(account_id, id, opts)
91
+ nil
92
+ end
93
+
94
+ # Delete an invitation
95
+ # Delete an existing invitation (must not be accepted yet). Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
96
+ # @param account_id [String] Account ID
97
+ # @param id [String] ID
98
+ # @param [Hash] opts the optional parameters
99
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
100
+ # @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
101
+ def invitation_delete_with_http_info(account_id, id, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_delete ...'
104
+ end
105
+ # verify the required parameter 'account_id' is set
106
+ if @api_client.config.client_side_validation && account_id.nil?
107
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_delete"
108
+ end
109
+ # verify the required parameter 'id' is set
110
+ if @api_client.config.client_side_validation && id.nil?
111
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvitationsApi.invitation_delete"
112
+ end
113
+ # resource path
114
+ local_var_path = '/accounts/{account_id}/invitations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
115
+
116
+ # query parameters
117
+ query_params = opts[:query_params] || {}
118
+
119
+ # header parameters
120
+ header_params = opts[:header_params] || {}
121
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
122
+
123
+ # form parameters
124
+ form_params = opts[:form_params] || {}
125
+
126
+ # http body (model)
127
+ post_body = opts[:body]
128
+
129
+ # return_type
130
+ return_type = opts[:return_type]
131
+
132
+ # auth_names
133
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
134
+
135
+ new_options = opts.merge(
136
+ :header_params => header_params,
137
+ :query_params => query_params,
138
+ :form_params => form_params,
139
+ :body => post_body,
140
+ :auth_names => auth_names,
141
+ :return_type => return_type
142
+ )
143
+
144
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
145
+ if @api_client.config.debugging
146
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
147
+ end
148
+ response = ::Phrase::Response.new(data, headers)
149
+ return response, status_code, headers
150
+ end
151
+
152
+ # Resend an invitation
153
+ # Resend the invitation email (must not be accepted yet). Access token scope must include <code>team.manage</code>.
154
+ # @param account_id [String] Account ID
155
+ # @param id [String] ID
156
+ # @param [Hash] opts the optional parameters
157
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
158
+ # @return [Invitation]
159
+ def invitation_resend(account_id, id, opts = {})
160
+ data, _status_code, _headers = invitation_resend_with_http_info(account_id, id, opts)
161
+ data
162
+ end
163
+
164
+ # Resend an invitation
165
+ # Resend the invitation email (must not be accepted yet). Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
166
+ # @param account_id [String] Account ID
167
+ # @param id [String] ID
168
+ # @param [Hash] opts the optional parameters
169
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
170
+ # @return [Array<(Response<(Invitation)>, Integer, Hash)>] Response<(Invitation)> data, response status code and response headers
171
+ def invitation_resend_with_http_info(account_id, id, opts = {})
172
+ if @api_client.config.debugging
173
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_resend ...'
174
+ end
175
+ # verify the required parameter 'account_id' is set
176
+ if @api_client.config.client_side_validation && account_id.nil?
177
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_resend"
178
+ end
179
+ # verify the required parameter 'id' is set
180
+ if @api_client.config.client_side_validation && id.nil?
181
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvitationsApi.invitation_resend"
182
+ end
183
+ # resource path
184
+ local_var_path = '/accounts/{account_id}/invitations/{id}/resend'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
185
+
186
+ # query parameters
187
+ query_params = opts[:query_params] || {}
188
+
189
+ # header parameters
190
+ header_params = opts[:header_params] || {}
191
+ # HTTP header 'Accept' (if needed)
192
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
193
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
194
+
195
+ # form parameters
196
+ form_params = opts[:form_params] || {}
197
+
198
+ # http body (model)
199
+ post_body = opts[:body]
200
+
201
+ # return_type
202
+ return_type = opts[:return_type] || 'Invitation'
203
+
204
+ # auth_names
205
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
206
+
207
+ new_options = opts.merge(
208
+ :header_params => header_params,
209
+ :query_params => query_params,
210
+ :form_params => form_params,
211
+ :body => post_body,
212
+ :auth_names => auth_names,
213
+ :return_type => return_type
214
+ )
215
+
216
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
217
+ if @api_client.config.debugging
218
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_resend\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
219
+ end
220
+ response = ::Phrase::Response.new(data, headers)
221
+ return response, status_code, headers
222
+ end
223
+
224
+ # Get a single invitation
225
+ # Get details on a single invitation. Access token scope must include <code>team.manage</code>.
226
+ # @param account_id [String] Account ID
227
+ # @param id [String] ID
228
+ # @param [Hash] opts the optional parameters
229
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
230
+ # @return [Invitation]
231
+ def invitation_show(account_id, id, opts = {})
232
+ data, _status_code, _headers = invitation_show_with_http_info(account_id, id, opts)
233
+ data
234
+ end
235
+
236
+ # Get a single invitation
237
+ # Get details on a single invitation. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
238
+ # @param account_id [String] Account ID
239
+ # @param id [String] ID
240
+ # @param [Hash] opts the optional parameters
241
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
242
+ # @return [Array<(Response<(Invitation)>, Integer, Hash)>] Response<(Invitation)> data, response status code and response headers
243
+ def invitation_show_with_http_info(account_id, id, opts = {})
244
+ if @api_client.config.debugging
245
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_show ...'
246
+ end
247
+ # verify the required parameter 'account_id' is set
248
+ if @api_client.config.client_side_validation && account_id.nil?
249
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_show"
250
+ end
251
+ # verify the required parameter 'id' is set
252
+ if @api_client.config.client_side_validation && id.nil?
253
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvitationsApi.invitation_show"
254
+ end
255
+ # resource path
256
+ local_var_path = '/accounts/{account_id}/invitations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
257
+
258
+ # query parameters
259
+ query_params = opts[:query_params] || {}
260
+
261
+ # header parameters
262
+ header_params = opts[:header_params] || {}
263
+ # HTTP header 'Accept' (if needed)
264
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
265
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
266
+
267
+ # form parameters
268
+ form_params = opts[:form_params] || {}
269
+
270
+ # http body (model)
271
+ post_body = opts[:body]
272
+
273
+ # return_type
274
+ return_type = opts[:return_type] || 'Invitation'
275
+
276
+ # auth_names
277
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
278
+
279
+ new_options = opts.merge(
280
+ :header_params => header_params,
281
+ :query_params => query_params,
282
+ :form_params => form_params,
283
+ :body => post_body,
284
+ :auth_names => auth_names,
285
+ :return_type => return_type
286
+ )
287
+
288
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
289
+ if @api_client.config.debugging
290
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
291
+ end
292
+ response = ::Phrase::Response.new(data, headers)
293
+ return response, status_code, headers
294
+ end
295
+
296
+ # Update an invitation
297
+ # Update an existing invitation (must not be accepted yet). The <code>email</code> cannot be updated. Developers and translators need <code>project_ids</code> and <code>locale_ids</code> assigned to access them. Access token scope must include <code>team.manage</code>.
298
+ # @param account_id [String] Account ID
299
+ # @param id [String] ID
300
+ # @param invitation_update_parameters [InvitationUpdateParameters]
301
+ # @param [Hash] opts the optional parameters
302
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
303
+ # @return [Invitation]
304
+ def invitation_update(account_id, id, invitation_update_parameters, opts = {})
305
+ data, _status_code, _headers = invitation_update_with_http_info(account_id, id, invitation_update_parameters, opts)
306
+ data
307
+ end
308
+
309
+ # Update an invitation
310
+ # Update an existing invitation (must not be accepted yet). The &lt;code&gt;email&lt;/code&gt; cannot be updated. Developers and translators need &lt;code&gt;project_ids&lt;/code&gt; and &lt;code&gt;locale_ids&lt;/code&gt; assigned to access them. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
311
+ # @param account_id [String] Account ID
312
+ # @param id [String] ID
313
+ # @param invitation_update_parameters [InvitationUpdateParameters]
314
+ # @param [Hash] opts the optional parameters
315
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
316
+ # @return [Array<(Response<(Invitation)>, Integer, Hash)>] Response<(Invitation)> data, response status code and response headers
317
+ def invitation_update_with_http_info(account_id, id, invitation_update_parameters, opts = {})
318
+ if @api_client.config.debugging
319
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitation_update ...'
320
+ end
321
+ # verify the required parameter 'account_id' is set
322
+ if @api_client.config.client_side_validation && account_id.nil?
323
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitation_update"
324
+ end
325
+ # verify the required parameter 'id' is set
326
+ if @api_client.config.client_side_validation && id.nil?
327
+ fail ArgumentError, "Missing the required parameter 'id' when calling InvitationsApi.invitation_update"
328
+ end
329
+ # verify the required parameter 'invitation_update_parameters' is set
330
+ if @api_client.config.client_side_validation && invitation_update_parameters.nil?
331
+ fail ArgumentError, "Missing the required parameter 'invitation_update_parameters' when calling InvitationsApi.invitation_update"
332
+ end
333
+ # resource path
334
+ local_var_path = '/accounts/{account_id}/invitations/{id}'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
335
+
336
+ # query parameters
337
+ query_params = opts[:query_params] || {}
338
+
339
+ # header parameters
340
+ header_params = opts[:header_params] || {}
341
+ # HTTP header 'Accept' (if needed)
342
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
343
+ # HTTP header 'Content-Type'
344
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
345
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
346
+
347
+ # form parameters
348
+ form_params = opts[:form_params] || {}
349
+
350
+ # http body (model)
351
+ post_body = opts[:body] || @api_client.object_to_http_body(invitation_update_parameters)
352
+
353
+ # return_type
354
+ return_type = opts[:return_type] || 'Invitation'
355
+
356
+ # auth_names
357
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
358
+
359
+ new_options = opts.merge(
360
+ :header_params => header_params,
361
+ :query_params => query_params,
362
+ :form_params => form_params,
363
+ :body => post_body,
364
+ :auth_names => auth_names,
365
+ :return_type => return_type
366
+ )
367
+
368
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
369
+ if @api_client.config.debugging
370
+ @api_client.config.logger.debug "API called: InvitationsApi#invitation_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
371
+ end
372
+ response = ::Phrase::Response.new(data, headers)
373
+ return response, status_code, headers
374
+ end
375
+
376
+ # List invitations
377
+ # List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include <code>team.manage</code>.
378
+ # @param account_id [String] Account ID
379
+ # @param [Hash] opts the optional parameters
380
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
381
+ # @option opts [Integer] :page Page number
382
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
383
+ # @return [Array<Invitation>]
384
+ def invitations_list(account_id, opts = {})
385
+ data, _status_code, _headers = invitations_list_with_http_info(account_id, opts)
386
+ data
387
+ end
388
+
389
+ # List invitations
390
+ # List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.
391
+ # @param account_id [String] Account ID
392
+ # @param [Hash] opts the optional parameters
393
+ # @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
394
+ # @option opts [Integer] :page Page number
395
+ # @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
396
+ # @return [Array<(Response<(Array<Invitation>)>, Integer, Hash)>] Response<(Array<Invitation>)> data, response status code and response headers
397
+ def invitations_list_with_http_info(account_id, opts = {})
398
+ if @api_client.config.debugging
399
+ @api_client.config.logger.debug 'Calling API: InvitationsApi.invitations_list ...'
400
+ end
401
+ # verify the required parameter 'account_id' is set
402
+ if @api_client.config.client_side_validation && account_id.nil?
403
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling InvitationsApi.invitations_list"
404
+ end
405
+ # resource path
406
+ local_var_path = '/accounts/{account_id}/invitations'.sub('{' + 'account_id' + '}', CGI.escape(account_id.to_s))
407
+
408
+ # query parameters
409
+ query_params = opts[:query_params] || {}
410
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
411
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
412
+
413
+ # header parameters
414
+ header_params = opts[:header_params] || {}
415
+ # HTTP header 'Accept' (if needed)
416
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
417
+ header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
418
+
419
+ # form parameters
420
+ form_params = opts[:form_params] || {}
421
+
422
+ # http body (model)
423
+ post_body = opts[:body]
424
+
425
+ # return_type
426
+ return_type = opts[:return_type] || 'Array<Invitation>'
427
+
428
+ # auth_names
429
+ auth_names = opts[:auth_names] || ['Basic', 'Token']
430
+
431
+ new_options = opts.merge(
432
+ :header_params => header_params,
433
+ :query_params => query_params,
434
+ :form_params => form_params,
435
+ :body => post_body,
436
+ :auth_names => auth_names,
437
+ :return_type => return_type
438
+ )
439
+
440
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
441
+ if @api_client.config.debugging
442
+ @api_client.config.logger.debug "API called: InvitationsApi#invitations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
443
+ end
444
+ response = ::Phrase::Response.new(data, headers)
445
+ return response, status_code, headers
446
+ end
447
+ end
448
+ end