phrase 0.4.31 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile +6 -0
- data/LICENSE +17 -18
- data/README.md +449 -280
- data/Rakefile +7 -4
- data/docs/Account.md +27 -0
- data/docs/AccountDetails.md +27 -0
- data/docs/AccountDetails1.md +17 -0
- data/docs/AccountsApi.md +134 -0
- data/docs/AffectedCount.md +17 -0
- data/docs/AffectedResources.md +17 -0
- data/docs/Authorization.md +31 -0
- data/docs/AuthorizationCreateParameters.md +21 -0
- data/docs/AuthorizationUpdateParameters.md +21 -0
- data/docs/AuthorizationWithToken.md +33 -0
- data/docs/AuthorizationWithToken1.md +17 -0
- data/docs/AuthorizationsApi.md +321 -0
- data/docs/BitbucketSync.md +27 -0
- data/docs/BitbucketSyncApi.md +197 -0
- data/docs/BitbucketSyncExportParameters.md +17 -0
- data/docs/BitbucketSyncExportResponse.md +17 -0
- data/docs/BitbucketSyncImportParameters.md +17 -0
- data/docs/BlacklistedKey.md +23 -0
- data/docs/BlacklistedKeyCreateParameters.md +17 -0
- data/docs/BlacklistedKeyUpdateParameters.md +17 -0
- data/docs/BlacklistedKeysApi.md +333 -0
- data/docs/Branch.md +29 -0
- data/docs/BranchCreateParameters.md +17 -0
- data/docs/BranchMergeParameters.md +17 -0
- data/docs/BranchUpdateParameters.md +17 -0
- data/docs/BranchesApi.md +459 -0
- data/docs/Comment.md +25 -0
- data/docs/CommentCreateParameters.md +19 -0
- data/docs/CommentMarkReadParameters.md +17 -0
- data/docs/CommentUpdateParameters.md +19 -0
- data/docs/CommentsApi.md +548 -0
- data/docs/Distribution.md +29 -0
- data/docs/DistributionCreateParameters.md +29 -0
- data/docs/DistributionPreview.md +29 -0
- data/docs/DistributionUpdateParameters.md +29 -0
- data/docs/DistributionsApi.md +331 -0
- data/docs/Document.md +23 -0
- data/docs/DocumentsApi.md +137 -0
- data/docs/Format.md +35 -0
- data/docs/FormatsApi.md +68 -0
- data/docs/GitHubSyncApi.md +130 -0
- data/docs/GitLabSyncApi.md +463 -0
- data/docs/GithubSyncExportParameters.md +17 -0
- data/docs/GithubSyncImportParameters.md +17 -0
- data/docs/GitlabSync.md +37 -0
- data/docs/GitlabSyncExport.md +19 -0
- data/docs/GitlabSyncExportParameters.md +17 -0
- data/docs/GitlabSyncHistory.md +25 -0
- data/docs/GitlabSyncImportParameters.md +17 -0
- data/docs/GlossariesApi.md +331 -0
- data/docs/Glossary.md +25 -0
- data/docs/GlossaryCreateParameters.md +21 -0
- data/docs/GlossaryTerm.md +31 -0
- data/docs/GlossaryTermCreateParameters.md +23 -0
- data/docs/GlossaryTermTranslation.md +25 -0
- data/docs/GlossaryTermTranslationCreateParameters.md +19 -0
- data/docs/GlossaryTermTranslationUpdateParameters.md +19 -0
- data/docs/GlossaryTermTranslationsApi.md +213 -0
- data/docs/GlossaryTermUpdateParameters.md +23 -0
- data/docs/GlossaryTermsApi.md +341 -0
- data/docs/GlossaryUpdateParameters.md +21 -0
- data/docs/InlineResponse422.md +19 -0
- data/docs/InlineResponse422Errors.md +21 -0
- data/docs/Invitation.md +35 -0
- data/docs/InvitationCreateParameters.md +25 -0
- data/docs/InvitationUpdateParameters.md +23 -0
- data/docs/InvitationsApi.md +395 -0
- data/docs/Job.md +29 -0
- data/docs/JobCompleteParameters.md +17 -0
- data/docs/JobCreateParameters.md +27 -0
- data/docs/JobDetails.md +37 -0
- data/docs/JobDetails1.md +23 -0
- data/docs/JobKeysCreateParameters.md +19 -0
- data/docs/JobLocale.md +23 -0
- data/docs/JobLocaleCompleteParameters.md +17 -0
- data/docs/JobLocaleReopenParameters.md +17 -0
- data/docs/JobLocaleUpdateParameters.md +21 -0
- data/docs/JobLocalesApi.md +483 -0
- data/docs/JobLocalesCreateParameters.md +21 -0
- data/docs/JobPreview.md +21 -0
- data/docs/JobReopenParameters.md +17 -0
- data/docs/JobStartParameters.md +17 -0
- data/docs/JobUpdateParameters.md +23 -0
- data/docs/JobsApi.md +674 -0
- data/docs/KeyCreateParameters.md +45 -0
- data/docs/KeyPreview.md +21 -0
- data/docs/KeyUpdateParameters.md +45 -0
- data/docs/KeysApi.md +609 -0
- data/docs/KeysSearchParameters.md +25 -0
- data/docs/KeysTagParameters.md +23 -0
- data/docs/KeysUntagParameters.md +23 -0
- data/docs/Locale.md +35 -0
- data/docs/LocaleCreateParameters.md +35 -0
- data/docs/LocaleDetails.md +37 -0
- data/docs/LocaleDetails1.md +17 -0
- data/docs/LocalePreview.md +21 -0
- data/docs/LocaleStatistics.md +29 -0
- data/docs/LocaleUpdateParameters.md +35 -0
- data/docs/LocalesApi.md +428 -0
- data/docs/Member.md +25 -0
- data/docs/MemberUpdateParameters.md +23 -0
- data/docs/MembersApi.md +267 -0
- data/docs/OrderConfirmParameters.md +17 -0
- data/docs/OrderCreateParameters.md +43 -0
- data/docs/OrdersApi.md +337 -0
- data/docs/Project.md +31 -0
- data/docs/ProjectCreateParameters.md +29 -0
- data/docs/ProjectDetails.md +33 -0
- data/docs/ProjectDetails1.md +19 -0
- data/docs/ProjectLocales.md +27 -0
- data/docs/ProjectLocales1.md +17 -0
- data/docs/ProjectShort.md +25 -0
- data/docs/ProjectUpdateParameters.md +27 -0
- data/docs/ProjectsApi.md +321 -0
- data/docs/Release.md +37 -0
- data/docs/ReleaseCreateParameters.md +21 -0
- data/docs/ReleasePreview.md +37 -0
- data/docs/ReleaseUpdateParameters.md +21 -0
- data/docs/ReleasesApi.md +407 -0
- data/docs/Screenshot.md +29 -0
- data/docs/ScreenshotCreateParameters.md +21 -0
- data/docs/ScreenshotMarker.md +27 -0
- data/docs/ScreenshotMarkerCreateParameters.md +19 -0
- data/docs/ScreenshotMarkerUpdateParameters.md +19 -0
- data/docs/ScreenshotMarkersApi.md +337 -0
- data/docs/ScreenshotUpdateParameters.md +21 -0
- data/docs/ScreenshotsApi.md +331 -0
- data/docs/Space.md +27 -0
- data/docs/SpaceCreateParameters.md +17 -0
- data/docs/SpaceUpdateParameters.md +17 -0
- data/docs/SpacesApi.md +529 -0
- data/docs/SpacesProjectsCreateParameters.md +17 -0
- data/docs/StyleGuidesApi.md +331 -0
- data/docs/Styleguide.md +23 -0
- data/docs/StyleguideCreateParameters.md +41 -0
- data/docs/StyleguideDetails.md +49 -0
- data/docs/StyleguideDetails1.md +41 -0
- data/docs/StyleguidePreview.md +19 -0
- data/docs/StyleguideUpdateParameters.md +41 -0
- data/docs/Tag.md +23 -0
- data/docs/TagCreateParameters.md +19 -0
- data/docs/TagWithStats.md +25 -0
- data/docs/TagWithStats1.md +17 -0
- data/docs/TagWithStats1Statistics.md +23 -0
- data/docs/TagWithStats1Statistics1.md +19 -0
- data/docs/TagsApi.md +271 -0
- data/docs/Team.md +29 -0
- data/docs/TeamCreateParameters.md +17 -0
- data/docs/TeamDetail.md +29 -0
- data/docs/TeamUpdateParameters.md +17 -0
- data/docs/TeamsApi.md +721 -0
- data/docs/TeamsProjectsCreateParameters.md +17 -0
- data/docs/TeamsSpacesCreateParameters.md +17 -0
- data/docs/TeamsUsersCreateParameters.md +17 -0
- data/docs/Translation.md +37 -0
- data/docs/TranslationCreateParameters.md +31 -0
- data/docs/TranslationDetails.md +41 -0
- data/docs/TranslationDetails1.md +19 -0
- data/docs/TranslationExcludeParameters.md +17 -0
- data/docs/TranslationIncludeParameters.md +17 -0
- data/docs/TranslationKey.md +33 -0
- data/docs/TranslationKeyDetails.md +51 -0
- data/docs/TranslationKeyDetails1.md +33 -0
- data/docs/TranslationOrder.md +49 -0
- data/docs/TranslationReviewParameters.md +17 -0
- data/docs/TranslationUnverifyParameters.md +17 -0
- data/docs/TranslationUpdateParameters.md +27 -0
- data/docs/TranslationVerifyParameters.md +17 -0
- data/docs/TranslationVersion.md +31 -0
- data/docs/TranslationVersionWithUser.md +33 -0
- data/docs/TranslationVersionWithUser1.md +17 -0
- data/docs/TranslationsApi.md +1148 -0
- data/docs/TranslationsExcludeParameters.md +23 -0
- data/docs/TranslationsIncludeParameters.md +23 -0
- data/docs/TranslationsReviewParameters.md +19 -0
- data/docs/TranslationsSearchParameters.md +23 -0
- data/docs/TranslationsUnverifyParameters.md +23 -0
- data/docs/TranslationsVerifyParameters.md +23 -0
- data/docs/Upload.md +31 -0
- data/docs/UploadCreateParameters.md +45 -0
- data/docs/UploadSummary.md +31 -0
- data/docs/UploadsApi.md +234 -0
- data/docs/User.md +29 -0
- data/docs/UserPreview.md +21 -0
- data/docs/UsersApi.md +68 -0
- data/docs/VersionsHistoryApi.md +146 -0
- data/docs/Webhook.md +29 -0
- data/docs/WebhookCreateParameters.md +23 -0
- data/docs/WebhookUpdateParameters.md +23 -0
- data/docs/WebhooksApi.md +394 -0
- data/git_push.sh +58 -0
- data/lib/phrase.rb +212 -55
- data/lib/phrase/api/accounts_api.rb +142 -0
- data/lib/phrase/api/authorizations_api.rb +348 -0
- data/lib/phrase/api/bitbucket_sync_api.rb +219 -0
- data/lib/phrase/api/blacklisted_keys_api.rb +381 -0
- data/lib/phrase/api/branches_api.rb +526 -0
- data/lib/phrase/api/comments_api.rb +659 -0
- data/lib/phrase/api/distributions_api.rb +378 -0
- data/lib/phrase/api/documents_api.rb +152 -0
- data/lib/phrase/api/formats_api.rb +70 -0
- data/lib/phrase/api/git_hub_sync_api.rb +146 -0
- data/lib/phrase/api/git_lab_sync_api.rb +510 -0
- data/lib/phrase/api/glossaries_api.rb +378 -0
- data/lib/phrase/api/glossary_term_translations_api.rb +270 -0
- data/lib/phrase/api/glossary_terms_api.rb +408 -0
- data/lib/phrase/api/invitations_api.rb +450 -0
- data/lib/phrase/api/job_locales_api.rb +589 -0
- data/lib/phrase/api/jobs_api.rb +792 -0
- data/lib/phrase/api/keys_api.rb +702 -0
- data/lib/phrase/api/locales_api.rb +499 -0
- data/lib/phrase/api/members_api.rb +304 -0
- data/lib/phrase/api/orders_api.rb +387 -0
- data/lib/phrase/api/projects_api.rb +348 -0
- data/lib/phrase/api/releases_api.rb +486 -0
- data/lib/phrase/api/screenshot_markers_api.rb +396 -0
- data/lib/phrase/api/screenshots_api.rb +378 -0
- data/lib/phrase/api/spaces_api.rb +610 -0
- data/lib/phrase/api/style_guides_api.rb +378 -0
- data/lib/phrase/api/tags_api.rb +307 -0
- data/lib/phrase/api/teams_api.rb +840 -0
- data/lib/phrase/api/translations_api.rb +1353 -0
- data/lib/phrase/api/uploads_api.rb +273 -0
- data/lib/phrase/api/users_api.rb +70 -0
- data/lib/phrase/api/versions_history_api.rb +172 -0
- data/lib/phrase/api/webhooks_api.rb +448 -0
- data/lib/phrase/api_client.rb +376 -0
- data/lib/phrase/api_error.rb +45 -0
- data/lib/phrase/configuration.rb +243 -0
- data/lib/phrase/models/account.rb +239 -0
- data/lib/phrase/models/account_details.rb +247 -0
- data/lib/phrase/models/account_details1.rb +194 -0
- data/lib/phrase/models/affected_count.rb +194 -0
- data/lib/phrase/models/affected_resources.rb +194 -0
- data/lib/phrase/models/authorization.rb +259 -0
- data/lib/phrase/models/authorization_create_parameters.rb +217 -0
- data/lib/phrase/models/authorization_update_parameters.rb +217 -0
- data/lib/phrase/models/authorization_with_token.rb +276 -0
- data/lib/phrase/models/authorization_with_token1.rb +194 -0
- data/lib/phrase/models/bitbucket_sync.rb +241 -0
- data/lib/phrase/models/bitbucket_sync_export_parameters.rb +195 -0
- data/lib/phrase/models/bitbucket_sync_export_response.rb +194 -0
- data/lib/phrase/models/bitbucket_sync_import_parameters.rb +195 -0
- data/lib/phrase/models/blacklisted_key.rb +221 -0
- data/lib/phrase/models/blacklisted_key_create_parameters.rb +195 -0
- data/lib/phrase/models/blacklisted_key_update_parameters.rb +195 -0
- data/lib/phrase/models/branch.rb +248 -0
- data/lib/phrase/models/branch_create_parameters.rb +195 -0
- data/lib/phrase/models/branch_merge_parameters.rb +195 -0
- data/lib/phrase/models/branch_update_parameters.rb +195 -0
- data/lib/phrase/models/comment.rb +230 -0
- data/lib/phrase/models/comment_create_parameters.rb +205 -0
- data/lib/phrase/models/comment_mark_read_parameters.rb +195 -0
- data/lib/phrase/models/comment_update_parameters.rb +205 -0
- data/lib/phrase/models/distribution.rb +252 -0
- data/lib/phrase/models/distribution_create_parameters.rb +259 -0
- data/lib/phrase/models/distribution_preview.rb +250 -0
- data/lib/phrase/models/distribution_update_parameters.rb +259 -0
- data/lib/phrase/models/document.rb +221 -0
- data/lib/phrase/models/format.rb +275 -0
- data/lib/phrase/models/github_sync_export_parameters.rb +195 -0
- data/lib/phrase/models/github_sync_import_parameters.rb +195 -0
- data/lib/phrase/models/gitlab_sync.rb +284 -0
- data/lib/phrase/models/gitlab_sync_export.rb +203 -0
- data/lib/phrase/models/gitlab_sync_export_parameters.rb +195 -0
- data/lib/phrase/models/gitlab_sync_history.rb +232 -0
- data/lib/phrase/models/gitlab_sync_import_parameters.rb +195 -0
- data/lib/phrase/models/glossary.rb +232 -0
- data/lib/phrase/models/glossary_create_parameters.rb +217 -0
- data/lib/phrase/models/glossary_term.rb +259 -0
- data/lib/phrase/models/glossary_term_create_parameters.rb +225 -0
- data/lib/phrase/models/glossary_term_translation.rb +230 -0
- data/lib/phrase/models/glossary_term_translation_create_parameters.rb +205 -0
- data/lib/phrase/models/glossary_term_translation_update_parameters.rb +205 -0
- data/lib/phrase/models/glossary_term_update_parameters.rb +225 -0
- data/lib/phrase/models/glossary_update_parameters.rb +217 -0
- data/lib/phrase/models/inline_response422.rb +205 -0
- data/lib/phrase/models/inline_response422_errors.rb +212 -0
- data/lib/phrase/models/invitation.rb +279 -0
- data/lib/phrase/models/invitation_create_parameters.rb +237 -0
- data/lib/phrase/models/invitation_update_parameters.rb +227 -0
- data/lib/phrase/models/job.rb +248 -0
- data/lib/phrase/models/job_complete_parameters.rb +195 -0
- data/lib/phrase/models/job_create_parameters.rb +249 -0
- data/lib/phrase/models/job_details.rb +296 -0
- data/lib/phrase/models/job_details1.rb +225 -0
- data/lib/phrase/models/job_keys_create_parameters.rb +207 -0
- data/lib/phrase/models/job_locale.rb +223 -0
- data/lib/phrase/models/job_locale_complete_parameters.rb +195 -0
- data/lib/phrase/models/job_locale_reopen_parameters.rb +195 -0
- data/lib/phrase/models/job_locale_update_parameters.rb +217 -0
- data/lib/phrase/models/job_locales_create_parameters.rb +217 -0
- data/lib/phrase/models/job_preview.rb +212 -0
- data/lib/phrase/models/job_reopen_parameters.rb +195 -0
- data/lib/phrase/models/job_start_parameters.rb +195 -0
- data/lib/phrase/models/job_update_parameters.rb +225 -0
- data/lib/phrase/models/key_create_parameters.rb +335 -0
- data/lib/phrase/models/key_preview.rb +212 -0
- data/lib/phrase/models/key_update_parameters.rb +335 -0
- data/lib/phrase/models/keys_search_parameters.rb +235 -0
- data/lib/phrase/models/keys_tag_parameters.rb +225 -0
- data/lib/phrase/models/keys_untag_parameters.rb +225 -0
- data/lib/phrase/models/locale.rb +277 -0
- data/lib/phrase/models/locale_create_parameters.rb +285 -0
- data/lib/phrase/models/locale_details.rb +294 -0
- data/lib/phrase/models/locale_details1.rb +194 -0
- data/lib/phrase/models/locale_preview.rb +212 -0
- data/lib/phrase/models/locale_statistics.rb +248 -0
- data/lib/phrase/models/locale_update_parameters.rb +285 -0
- data/lib/phrase/models/member.rb +232 -0
- data/lib/phrase/models/member_update_parameters.rb +227 -0
- data/lib/phrase/models/order_confirm_parameters.rb +195 -0
- data/lib/phrase/models/order_create_parameters.rb +327 -0
- data/lib/phrase/models/project.rb +257 -0
- data/lib/phrase/models/project_create_parameters.rb +255 -0
- data/lib/phrase/models/project_details.rb +274 -0
- data/lib/phrase/models/project_details1.rb +203 -0
- data/lib/phrase/models/project_locales.rb +249 -0
- data/lib/phrase/models/project_locales1.rb +196 -0
- data/lib/phrase/models/project_short.rb +230 -0
- data/lib/phrase/models/project_update_parameters.rb +245 -0
- data/lib/phrase/models/release.rb +290 -0
- data/lib/phrase/models/release_create_parameters.rb +217 -0
- data/lib/phrase/models/release_preview.rb +290 -0
- data/lib/phrase/models/release_update_parameters.rb +217 -0
- data/lib/phrase/models/screenshot.rb +248 -0
- data/lib/phrase/models/screenshot_create_parameters.rb +215 -0
- data/lib/phrase/models/screenshot_marker.rb +239 -0
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +205 -0
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +205 -0
- data/lib/phrase/models/screenshot_update_parameters.rb +215 -0
- data/lib/phrase/models/space.rb +241 -0
- data/lib/phrase/models/space_create_parameters.rb +195 -0
- data/lib/phrase/models/space_update_parameters.rb +195 -0
- data/lib/phrase/models/spaces_projects_create_parameters.rb +195 -0
- data/lib/phrase/models/styleguide.rb +221 -0
- data/lib/phrase/models/styleguide_create_parameters.rb +315 -0
- data/lib/phrase/models/styleguide_details.rb +346 -0
- data/lib/phrase/models/styleguide_details1.rb +302 -0
- data/lib/phrase/models/styleguide_preview.rb +203 -0
- data/lib/phrase/models/styleguide_update_parameters.rb +315 -0
- data/lib/phrase/models/tag.rb +221 -0
- data/lib/phrase/models/tag_create_parameters.rb +205 -0
- data/lib/phrase/models/tag_with_stats.rb +240 -0
- data/lib/phrase/models/tag_with_stats1.rb +196 -0
- data/lib/phrase/models/tag_with_stats1_statistics.rb +221 -0
- data/lib/phrase/models/tag_with_stats1_statistics1.rb +203 -0
- data/lib/phrase/models/team.rb +254 -0
- data/lib/phrase/models/team_create_parameters.rb +195 -0
- data/lib/phrase/models/team_detail.rb +254 -0
- data/lib/phrase/models/team_update_parameters.rb +195 -0
- data/lib/phrase/models/teams_projects_create_parameters.rb +195 -0
- data/lib/phrase/models/teams_spaces_create_parameters.rb +195 -0
- data/lib/phrase/models/teams_users_create_parameters.rb +195 -0
- data/lib/phrase/models/translation.rb +286 -0
- data/lib/phrase/models/translation_create_parameters.rb +265 -0
- data/lib/phrase/models/translation_details.rb +312 -0
- data/lib/phrase/models/translation_details1.rb +203 -0
- data/lib/phrase/models/translation_exclude_parameters.rb +195 -0
- data/lib/phrase/models/translation_include_parameters.rb +195 -0
- data/lib/phrase/models/translation_key.rb +268 -0
- data/lib/phrase/models/translation_key_details.rb +357 -0
- data/lib/phrase/models/translation_key_details1.rb +266 -0
- data/lib/phrase/models/translation_order.rb +340 -0
- data/lib/phrase/models/translation_review_parameters.rb +195 -0
- data/lib/phrase/models/translation_unverify_parameters.rb +195 -0
- data/lib/phrase/models/translation_update_parameters.rb +245 -0
- data/lib/phrase/models/translation_verify_parameters.rb +195 -0
- data/lib/phrase/models/translation_version.rb +257 -0
- data/lib/phrase/models/translation_version_with_user.rb +274 -0
- data/lib/phrase/models/translation_version_with_user1.rb +194 -0
- data/lib/phrase/models/translations_exclude_parameters.rb +225 -0
- data/lib/phrase/models/translations_include_parameters.rb +225 -0
- data/lib/phrase/models/translations_review_parameters.rb +205 -0
- data/lib/phrase/models/translations_search_parameters.rb +225 -0
- data/lib/phrase/models/translations_unverify_parameters.rb +225 -0
- data/lib/phrase/models/translations_verify_parameters.rb +225 -0
- data/lib/phrase/models/upload.rb +257 -0
- data/lib/phrase/models/upload_create_parameters.rb +335 -0
- data/lib/phrase/models/upload_summary.rb +257 -0
- data/lib/phrase/models/user.rb +248 -0
- data/lib/phrase/models/user_preview.rb +212 -0
- data/lib/phrase/models/webhook.rb +250 -0
- data/lib/phrase/models/webhook_create_parameters.rb +225 -0
- data/lib/phrase/models/webhook_update_parameters.rb +225 -0
- data/lib/phrase/response.rb +41 -0
- data/lib/phrase/version.rb +1 -1
- data/phrase.gemspec +27 -27
- data/spec/api/accounts_api_spec.rb +50 -0
- data/spec/api/authorizations_api_spec.rb +90 -0
- data/spec/api/bitbucket_sync_api_spec.rb +64 -0
- data/spec/api/blacklisted_keys_api_spec.rb +96 -0
- data/spec/api/branches_api_spec.rb +124 -0
- data/spec/api/comments_api_spec.rb +151 -0
- data/spec/api/distributions_api_spec.rb +95 -0
- data/spec/api/documents_api_spec.rb +52 -0
- data/spec/api/formats_api_spec.rb +35 -0
- data/spec/api/git_hub_sync_api_spec.rb +49 -0
- data/spec/api/git_lab_sync_api_spec.rb +125 -0
- data/spec/api/glossaries_api_spec.rb +95 -0
- data/spec/api/glossary_term_translations_api_spec.rb +72 -0
- data/spec/api/glossary_terms_api_spec.rb +100 -0
- data/spec/api/invitations_api_spec.rb +109 -0
- data/spec/api/job_locales_api_spec.rb +135 -0
- data/spec/api/jobs_api_spec.rb +177 -0
- data/spec/api/keys_api_spec.rb +162 -0
- data/spec/api/locales_api_spec.rb +126 -0
- data/spec/api/members_api_spec.rb +81 -0
- data/spec/api/orders_api_spec.rb +98 -0
- data/spec/api/projects_api_spec.rb +90 -0
- data/spec/api/releases_api_spec.rb +115 -0
- data/spec/api/screenshot_markers_api_spec.rb +98 -0
- data/spec/api/screenshots_api_spec.rb +95 -0
- data/spec/api/spaces_api_spec.rb +141 -0
- data/spec/api/style_guides_api_spec.rb +95 -0
- data/spec/api/tags_api_spec.rb +83 -0
- data/spec/api/teams_api_spec.rb +185 -0
- data/spec/api/translations_api_spec.rb +287 -0
- data/spec/api/uploads_api_spec.rb +82 -0
- data/spec/api/users_api_spec.rb +35 -0
- data/spec/api/versions_history_api_spec.rb +56 -0
- data/spec/api/webhooks_api_spec.rb +109 -0
- data/spec/api_client_spec.rb +214 -0
- data/spec/configuration_spec.rb +30 -0
- data/spec/models/account_details1_spec.rb +29 -0
- data/spec/models/account_details_spec.rb +59 -0
- data/spec/models/account_spec.rb +59 -0
- data/spec/models/affected_count_spec.rb +29 -0
- data/spec/models/affected_resources_spec.rb +29 -0
- data/spec/models/authorization_create_parameters_spec.rb +41 -0
- data/spec/models/authorization_spec.rb +71 -0
- data/spec/models/authorization_update_parameters_spec.rb +41 -0
- data/spec/models/authorization_with_token1_spec.rb +29 -0
- data/spec/models/authorization_with_token_spec.rb +77 -0
- data/spec/models/bitbucket_sync_export_parameters_spec.rb +29 -0
- data/spec/models/bitbucket_sync_export_response_spec.rb +29 -0
- data/spec/models/bitbucket_sync_import_parameters_spec.rb +29 -0
- data/spec/models/bitbucket_sync_spec.rb +59 -0
- data/spec/models/blacklisted_key_create_parameters_spec.rb +29 -0
- data/spec/models/blacklisted_key_spec.rb +47 -0
- data/spec/models/blacklisted_key_update_parameters_spec.rb +29 -0
- data/spec/models/branch_create_parameters_spec.rb +29 -0
- data/spec/models/branch_merge_parameters_spec.rb +29 -0
- data/spec/models/branch_spec.rb +65 -0
- data/spec/models/branch_update_parameters_spec.rb +29 -0
- data/spec/models/comment_create_parameters_spec.rb +35 -0
- data/spec/models/comment_mark_read_parameters_spec.rb +29 -0
- data/spec/models/comment_spec.rb +53 -0
- data/spec/models/comment_update_parameters_spec.rb +35 -0
- data/spec/models/distribution_create_parameters_spec.rb +65 -0
- data/spec/models/distribution_preview_spec.rb +65 -0
- data/spec/models/distribution_spec.rb +65 -0
- data/spec/models/distribution_update_parameters_spec.rb +65 -0
- data/spec/models/document_spec.rb +47 -0
- data/spec/models/format_spec.rb +83 -0
- data/spec/models/github_sync_export_parameters_spec.rb +29 -0
- data/spec/models/github_sync_import_parameters_spec.rb +29 -0
- data/spec/models/gitlab_sync_export_parameters_spec.rb +29 -0
- data/spec/models/gitlab_sync_export_spec.rb +35 -0
- data/spec/models/gitlab_sync_history_spec.rb +53 -0
- data/spec/models/gitlab_sync_import_parameters_spec.rb +29 -0
- data/spec/models/gitlab_sync_spec.rb +89 -0
- data/spec/models/glossary_create_parameters_spec.rb +41 -0
- data/spec/models/glossary_spec.rb +53 -0
- data/spec/models/glossary_term_create_parameters_spec.rb +47 -0
- data/spec/models/glossary_term_spec.rb +71 -0
- data/spec/models/glossary_term_translation_create_parameters_spec.rb +35 -0
- data/spec/models/glossary_term_translation_spec.rb +53 -0
- data/spec/models/glossary_term_translation_update_parameters_spec.rb +35 -0
- data/spec/models/glossary_term_update_parameters_spec.rb +47 -0
- data/spec/models/glossary_update_parameters_spec.rb +41 -0
- data/spec/models/inline_response422_errors_spec.rb +41 -0
- data/spec/models/inline_response422_spec.rb +35 -0
- data/spec/models/invitation_create_parameters_spec.rb +53 -0
- data/spec/models/invitation_spec.rb +83 -0
- data/spec/models/invitation_update_parameters_spec.rb +47 -0
- data/spec/models/job_complete_parameters_spec.rb +29 -0
- data/spec/models/job_create_parameters_spec.rb +59 -0
- data/spec/models/job_details1_spec.rb +47 -0
- data/spec/models/job_details_spec.rb +89 -0
- data/spec/models/job_keys_create_parameters_spec.rb +35 -0
- data/spec/models/job_locale_complete_parameters_spec.rb +29 -0
- data/spec/models/job_locale_reopen_parameters_spec.rb +29 -0
- data/spec/models/job_locale_spec.rb +47 -0
- data/spec/models/job_locale_update_parameters_spec.rb +41 -0
- data/spec/models/job_locales_create_parameters_spec.rb +41 -0
- data/spec/models/job_preview_spec.rb +41 -0
- data/spec/models/job_reopen_parameters_spec.rb +29 -0
- data/spec/models/job_spec.rb +65 -0
- data/spec/models/job_start_parameters_spec.rb +29 -0
- data/spec/models/job_update_parameters_spec.rb +47 -0
- data/spec/models/key_create_parameters_spec.rb +113 -0
- data/spec/models/key_preview_spec.rb +41 -0
- data/spec/models/key_update_parameters_spec.rb +113 -0
- data/spec/models/keys_search_parameters_spec.rb +53 -0
- data/spec/models/keys_tag_parameters_spec.rb +47 -0
- data/spec/models/keys_untag_parameters_spec.rb +47 -0
- data/spec/models/locale_create_parameters_spec.rb +83 -0
- data/spec/models/locale_details1_spec.rb +29 -0
- data/spec/models/locale_details_spec.rb +89 -0
- data/spec/models/locale_preview_spec.rb +41 -0
- data/spec/models/locale_spec.rb +83 -0
- data/spec/models/locale_statistics_spec.rb +65 -0
- data/spec/models/locale_update_parameters_spec.rb +83 -0
- data/spec/models/member_spec.rb +53 -0
- data/spec/models/member_update_parameters_spec.rb +47 -0
- data/spec/models/order_confirm_parameters_spec.rb +29 -0
- data/spec/models/order_create_parameters_spec.rb +107 -0
- data/spec/models/project_create_parameters_spec.rb +65 -0
- data/spec/models/project_details1_spec.rb +35 -0
- data/spec/models/project_details_spec.rb +77 -0
- data/spec/models/project_locales1_spec.rb +29 -0
- data/spec/models/project_locales_spec.rb +59 -0
- data/spec/models/project_short_spec.rb +53 -0
- data/spec/models/project_spec.rb +71 -0
- data/spec/models/project_update_parameters_spec.rb +59 -0
- data/spec/models/release_create_parameters_spec.rb +41 -0
- data/spec/models/release_preview_spec.rb +89 -0
- data/spec/models/release_spec.rb +89 -0
- data/spec/models/release_update_parameters_spec.rb +41 -0
- data/spec/models/screenshot_create_parameters_spec.rb +41 -0
- data/spec/models/screenshot_marker_create_parameters_spec.rb +35 -0
- data/spec/models/screenshot_marker_spec.rb +59 -0
- data/spec/models/screenshot_marker_update_parameters_spec.rb +35 -0
- data/spec/models/screenshot_spec.rb +65 -0
- data/spec/models/screenshot_update_parameters_spec.rb +41 -0
- data/spec/models/space_create_parameters_spec.rb +29 -0
- data/spec/models/space_spec.rb +59 -0
- data/spec/models/space_update_parameters_spec.rb +29 -0
- data/spec/models/spaces_projects_create_parameters_spec.rb +29 -0
- data/spec/models/styleguide_create_parameters_spec.rb +101 -0
- data/spec/models/styleguide_details1_spec.rb +101 -0
- data/spec/models/styleguide_details_spec.rb +125 -0
- data/spec/models/styleguide_preview_spec.rb +35 -0
- data/spec/models/styleguide_spec.rb +47 -0
- data/spec/models/styleguide_update_parameters_spec.rb +101 -0
- data/spec/models/tag_create_parameters_spec.rb +35 -0
- data/spec/models/tag_spec.rb +47 -0
- data/spec/models/tag_with_stats1_spec.rb +29 -0
- data/spec/models/tag_with_stats1_statistics1_spec.rb +35 -0
- data/spec/models/tag_with_stats1_statistics_spec.rb +47 -0
- data/spec/models/tag_with_stats_spec.rb +53 -0
- data/spec/models/team_create_parameters_spec.rb +29 -0
- data/spec/models/team_detail_spec.rb +65 -0
- data/spec/models/team_spec.rb +65 -0
- data/spec/models/team_update_parameters_spec.rb +29 -0
- data/spec/models/teams_projects_create_parameters_spec.rb +29 -0
- data/spec/models/teams_spaces_create_parameters_spec.rb +29 -0
- data/spec/models/teams_users_create_parameters_spec.rb +29 -0
- data/spec/models/translation_create_parameters_spec.rb +71 -0
- data/spec/models/translation_details1_spec.rb +35 -0
- data/spec/models/translation_details_spec.rb +101 -0
- data/spec/models/translation_exclude_parameters_spec.rb +29 -0
- data/spec/models/translation_include_parameters_spec.rb +29 -0
- data/spec/models/translation_key_details1_spec.rb +77 -0
- data/spec/models/translation_key_details_spec.rb +131 -0
- data/spec/models/translation_key_spec.rb +77 -0
- data/spec/models/translation_order_spec.rb +125 -0
- data/spec/models/translation_review_parameters_spec.rb +29 -0
- data/spec/models/translation_spec.rb +89 -0
- data/spec/models/translation_unverify_parameters_spec.rb +29 -0
- data/spec/models/translation_update_parameters_spec.rb +59 -0
- data/spec/models/translation_verify_parameters_spec.rb +29 -0
- data/spec/models/translation_version_spec.rb +71 -0
- data/spec/models/translation_version_with_user1_spec.rb +29 -0
- data/spec/models/translation_version_with_user_spec.rb +77 -0
- data/spec/models/translations_exclude_parameters_spec.rb +47 -0
- data/spec/models/translations_include_parameters_spec.rb +47 -0
- data/spec/models/translations_review_parameters_spec.rb +35 -0
- data/spec/models/translations_search_parameters_spec.rb +47 -0
- data/spec/models/translations_unverify_parameters_spec.rb +47 -0
- data/spec/models/translations_verify_parameters_spec.rb +47 -0
- data/spec/models/upload_create_parameters_spec.rb +113 -0
- data/spec/models/upload_spec.rb +71 -0
- data/spec/models/upload_summary_spec.rb +71 -0
- data/spec/models/user_preview_spec.rb +41 -0
- data/spec/models/user_spec.rb +65 -0
- data/spec/models/webhook_create_parameters_spec.rb +47 -0
- data/spec/models/webhook_spec.rb +65 -0
- data/spec/models/webhook_update_parameters_spec.rb +47 -0
- data/spec/spec_helper.rb +99 -0
- metadata +819 -188
- data/.gitignore +0 -25
- data/.travis.yml +0 -4
- data/Guardfile +0 -29
- data/bin/phrase +0 -8
- data/cacert.pem +0 -3366
- data/lib/ext/all.rb +0 -5
- data/lib/ext/hash.rb +0 -8
- data/lib/ext/object.rb +0 -130
- data/lib/ext/try.rb +0 -57
- data/lib/generators/phrase/install_generator.rb +0 -37
- data/lib/generators/templates/README +0 -11
- data/lib/generators/templates/phrase.rb +0 -21
- data/lib/phrase/adapters/fast_gettext.rb +0 -25
- data/lib/phrase/adapters/i18n.rb +0 -12
- data/lib/phrase/api.rb +0 -7
- data/lib/phrase/api/client.rb +0 -308
- data/lib/phrase/api/client/http.rb +0 -56
- data/lib/phrase/api/config.rb +0 -34
- data/lib/phrase/api/exceptions.rb +0 -9
- data/lib/phrase/api/query_params.rb +0 -22
- data/lib/phrase/backend.rb +0 -7
- data/lib/phrase/backend/base.rb +0 -6
- data/lib/phrase/backend/phrase_service.rb +0 -163
- data/lib/phrase/cache.rb +0 -34
- data/lib/phrase/config.rb +0 -94
- data/lib/phrase/delegate.rb +0 -36
- data/lib/phrase/delegate/fast_gettext.rb +0 -27
- data/lib/phrase/delegate/i18n.rb +0 -166
- data/lib/phrase/engine.rb +0 -14
- data/lib/phrase/formats.rb +0 -172
- data/lib/phrase/formats/angular_translate.rb +0 -19
- data/lib/phrase/formats/csv.rb +0 -19
- data/lib/phrase/formats/custom.rb +0 -40
- data/lib/phrase/formats/gettext.rb +0 -27
- data/lib/phrase/formats/gettext_template.rb +0 -19
- data/lib/phrase/formats/ini.rb +0 -19
- data/lib/phrase/formats/json.rb +0 -19
- data/lib/phrase/formats/laravel.rb +0 -19
- data/lib/phrase/formats/mozilla_properties.rb +0 -8
- data/lib/phrase/formats/nested_json.rb +0 -19
- data/lib/phrase/formats/node_json.rb +0 -23
- data/lib/phrase/formats/php_array.rb +0 -19
- data/lib/phrase/formats/play_properties.rb +0 -15
- data/lib/phrase/formats/plist.rb +0 -19
- data/lib/phrase/formats/properties.rb +0 -19
- data/lib/phrase/formats/properties_xml.rb +0 -19
- data/lib/phrase/formats/qt_phrase_book.rb +0 -19
- data/lib/phrase/formats/qt_translation_source.rb +0 -19
- data/lib/phrase/formats/resx.rb +0 -19
- data/lib/phrase/formats/resx_windowsphone.rb +0 -19
- data/lib/phrase/formats/simple_json.rb +0 -19
- data/lib/phrase/formats/strings.rb +0 -45
- data/lib/phrase/formats/tmx.rb +0 -19
- data/lib/phrase/formats/windows8_resource.rb +0 -19
- data/lib/phrase/formats/xliff.rb +0 -19
- data/lib/phrase/formats/xml.rb +0 -49
- data/lib/phrase/formats/yaml.rb +0 -19
- data/lib/phrase/formats/yaml_symfony.rb +0 -19
- data/lib/phrase/formats/yaml_symfony2.rb +0 -8
- data/lib/phrase/hash_flattener.rb +0 -21
- data/lib/phrase/tool.rb +0 -46
- data/lib/phrase/tool/commands.rb +0 -56
- data/lib/phrase/tool/commands/base.rb +0 -73
- data/lib/phrase/tool/commands/init.rb +0 -51
- data/lib/phrase/tool/commands/pull.rb +0 -109
- data/lib/phrase/tool/commands/push.rb +0 -163
- data/lib/phrase/tool/commands/show_help.rb +0 -26
- data/lib/phrase/tool/commands/show_version.rb +0 -17
- data/lib/phrase/tool/commands/tags.rb +0 -29
- data/lib/phrase/tool/config.rb +0 -120
- data/lib/phrase/tool/encoding_detector.rb +0 -17
- data/lib/phrase/tool/locale.rb +0 -41
- data/lib/phrase/tool/options.rb +0 -32
- data/lib/phrase/tool/options_factory.rb +0 -150
- data/lib/phrase/tool/tag_validator.rb +0 -9
- data/lib/phrase/view_helpers.rb +0 -19
@@ -0,0 +1,21 @@
|
|
1
|
+
# Phrase::ScreenshotUpdateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Name of the screenshot | [optional]
|
8
|
+
**description** | **String** | Description of the screenshot | [optional]
|
9
|
+
**filename** | **File** | Screenshot file | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'Phrase'
|
15
|
+
|
16
|
+
instance = Phrase::ScreenshotUpdateParameters.new(name: A screenshot name,
|
17
|
+
description: A screenshot description,
|
18
|
+
filename: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,331 @@
|
|
1
|
+
# Phrase::ScreenshotsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**screenshot_create**](ScreenshotsApi.md#screenshot_create) | **POST** /projects/{project_id}/screenshots | Create a screenshot
|
8
|
+
[**screenshot_delete**](ScreenshotsApi.md#screenshot_delete) | **DELETE** /projects/{project_id}/screenshots/{id} | Delete a screenshot
|
9
|
+
[**screenshot_show**](ScreenshotsApi.md#screenshot_show) | **GET** /projects/{project_id}/screenshots/{id} | Get a single screenshot
|
10
|
+
[**screenshot_update**](ScreenshotsApi.md#screenshot_update) | **PATCH** /projects/{project_id}/screenshots/{id} | Update a screenshot
|
11
|
+
[**screenshots_list**](ScreenshotsApi.md#screenshots_list) | **GET** /projects/{project_id}/screenshots | List screenshots
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
## screenshot_create
|
16
|
+
|
17
|
+
> Screenshot screenshot_create(project_id, screenshot_create_parameters, opts)
|
18
|
+
|
19
|
+
Create a screenshot
|
20
|
+
|
21
|
+
Create a new screenshot.
|
22
|
+
|
23
|
+
### Example
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'phrase'
|
28
|
+
# setup authorization
|
29
|
+
Phrase.configure do |config|
|
30
|
+
# Configure HTTP basic authorization: Basic
|
31
|
+
config.username = 'YOUR USERNAME'
|
32
|
+
config.password = 'YOUR PASSWORD'
|
33
|
+
|
34
|
+
# Configure API key authorization: Token
|
35
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
36
|
+
config.api_key_prefix['Authorization'] = 'token'
|
37
|
+
end
|
38
|
+
|
39
|
+
api_instance = Phrase::ScreenshotsApi.new
|
40
|
+
project_id = 'project_id_example' # String | Project ID
|
41
|
+
screenshot_create_parameters = Phrase::ScreenshotCreateParameters.new # ScreenshotCreateParameters |
|
42
|
+
opts = {
|
43
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
44
|
+
}
|
45
|
+
|
46
|
+
begin
|
47
|
+
#Create a screenshot
|
48
|
+
result = api_instance.screenshot_create(project_id, screenshot_create_parameters, opts)
|
49
|
+
pp result
|
50
|
+
rescue Phrase::ApiError => e
|
51
|
+
puts "Exception when calling ScreenshotsApi->screenshot_create: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
### Parameters
|
56
|
+
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**project_id** | **String**| Project ID |
|
61
|
+
**screenshot_create_parameters** | [**ScreenshotCreateParameters**](ScreenshotCreateParameters.md)| |
|
62
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
63
|
+
|
64
|
+
### Return type
|
65
|
+
|
66
|
+
Response<([**Screenshot**](Screenshot.md))>
|
67
|
+
|
68
|
+
### Authorization
|
69
|
+
|
70
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
71
|
+
|
72
|
+
### HTTP request headers
|
73
|
+
|
74
|
+
- **Content-Type**: application/json
|
75
|
+
- **Accept**: application/json
|
76
|
+
|
77
|
+
|
78
|
+
## screenshot_delete
|
79
|
+
|
80
|
+
> screenshot_delete(project_id, id, opts)
|
81
|
+
|
82
|
+
Delete a screenshot
|
83
|
+
|
84
|
+
Delete an existing screenshot.
|
85
|
+
|
86
|
+
### Example
|
87
|
+
|
88
|
+
```ruby
|
89
|
+
# load the gem
|
90
|
+
require 'phrase'
|
91
|
+
# setup authorization
|
92
|
+
Phrase.configure do |config|
|
93
|
+
# Configure HTTP basic authorization: Basic
|
94
|
+
config.username = 'YOUR USERNAME'
|
95
|
+
config.password = 'YOUR PASSWORD'
|
96
|
+
|
97
|
+
# Configure API key authorization: Token
|
98
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
99
|
+
config.api_key_prefix['Authorization'] = 'token'
|
100
|
+
end
|
101
|
+
|
102
|
+
api_instance = Phrase::ScreenshotsApi.new
|
103
|
+
project_id = 'project_id_example' # String | Project ID
|
104
|
+
id = 'id_example' # String | ID
|
105
|
+
opts = {
|
106
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
107
|
+
}
|
108
|
+
|
109
|
+
begin
|
110
|
+
#Delete a screenshot
|
111
|
+
api_instance.screenshot_delete(project_id, id, opts)
|
112
|
+
rescue Phrase::ApiError => e
|
113
|
+
puts "Exception when calling ScreenshotsApi->screenshot_delete: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
|
120
|
+
Name | Type | Description | Notes
|
121
|
+
------------- | ------------- | ------------- | -------------
|
122
|
+
**project_id** | **String**| Project ID |
|
123
|
+
**id** | **String**| ID |
|
124
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
125
|
+
|
126
|
+
### Return type
|
127
|
+
|
128
|
+
Response<(nil (empty response body))>
|
129
|
+
|
130
|
+
### Authorization
|
131
|
+
|
132
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
133
|
+
|
134
|
+
### HTTP request headers
|
135
|
+
|
136
|
+
- **Content-Type**: Not defined
|
137
|
+
- **Accept**: Not defined
|
138
|
+
|
139
|
+
|
140
|
+
## screenshot_show
|
141
|
+
|
142
|
+
> Screenshot screenshot_show(project_id, id, opts)
|
143
|
+
|
144
|
+
Get a single screenshot
|
145
|
+
|
146
|
+
Get details on a single screenshot for a given project.
|
147
|
+
|
148
|
+
### Example
|
149
|
+
|
150
|
+
```ruby
|
151
|
+
# load the gem
|
152
|
+
require 'phrase'
|
153
|
+
# setup authorization
|
154
|
+
Phrase.configure do |config|
|
155
|
+
# Configure HTTP basic authorization: Basic
|
156
|
+
config.username = 'YOUR USERNAME'
|
157
|
+
config.password = 'YOUR PASSWORD'
|
158
|
+
|
159
|
+
# Configure API key authorization: Token
|
160
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
161
|
+
config.api_key_prefix['Authorization'] = 'token'
|
162
|
+
end
|
163
|
+
|
164
|
+
api_instance = Phrase::ScreenshotsApi.new
|
165
|
+
project_id = 'project_id_example' # String | Project ID
|
166
|
+
id = 'id_example' # String | ID
|
167
|
+
opts = {
|
168
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
169
|
+
}
|
170
|
+
|
171
|
+
begin
|
172
|
+
#Get a single screenshot
|
173
|
+
result = api_instance.screenshot_show(project_id, id, opts)
|
174
|
+
pp result
|
175
|
+
rescue Phrase::ApiError => e
|
176
|
+
puts "Exception when calling ScreenshotsApi->screenshot_show: #{e}"
|
177
|
+
end
|
178
|
+
```
|
179
|
+
|
180
|
+
### Parameters
|
181
|
+
|
182
|
+
|
183
|
+
Name | Type | Description | Notes
|
184
|
+
------------- | ------------- | ------------- | -------------
|
185
|
+
**project_id** | **String**| Project ID |
|
186
|
+
**id** | **String**| ID |
|
187
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
188
|
+
|
189
|
+
### Return type
|
190
|
+
|
191
|
+
Response<([**Screenshot**](Screenshot.md))>
|
192
|
+
|
193
|
+
### Authorization
|
194
|
+
|
195
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
196
|
+
|
197
|
+
### HTTP request headers
|
198
|
+
|
199
|
+
- **Content-Type**: Not defined
|
200
|
+
- **Accept**: application/json
|
201
|
+
|
202
|
+
|
203
|
+
## screenshot_update
|
204
|
+
|
205
|
+
> Screenshot screenshot_update(project_id, id, screenshot_update_parameters, opts)
|
206
|
+
|
207
|
+
Update a screenshot
|
208
|
+
|
209
|
+
Update an existing screenshot.
|
210
|
+
|
211
|
+
### Example
|
212
|
+
|
213
|
+
```ruby
|
214
|
+
# load the gem
|
215
|
+
require 'phrase'
|
216
|
+
# setup authorization
|
217
|
+
Phrase.configure do |config|
|
218
|
+
# Configure HTTP basic authorization: Basic
|
219
|
+
config.username = 'YOUR USERNAME'
|
220
|
+
config.password = 'YOUR PASSWORD'
|
221
|
+
|
222
|
+
# Configure API key authorization: Token
|
223
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
224
|
+
config.api_key_prefix['Authorization'] = 'token'
|
225
|
+
end
|
226
|
+
|
227
|
+
api_instance = Phrase::ScreenshotsApi.new
|
228
|
+
project_id = 'project_id_example' # String | Project ID
|
229
|
+
id = 'id_example' # String | ID
|
230
|
+
screenshot_update_parameters = Phrase::ScreenshotUpdateParameters.new # ScreenshotUpdateParameters |
|
231
|
+
opts = {
|
232
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
233
|
+
}
|
234
|
+
|
235
|
+
begin
|
236
|
+
#Update a screenshot
|
237
|
+
result = api_instance.screenshot_update(project_id, id, screenshot_update_parameters, opts)
|
238
|
+
pp result
|
239
|
+
rescue Phrase::ApiError => e
|
240
|
+
puts "Exception when calling ScreenshotsApi->screenshot_update: #{e}"
|
241
|
+
end
|
242
|
+
```
|
243
|
+
|
244
|
+
### Parameters
|
245
|
+
|
246
|
+
|
247
|
+
Name | Type | Description | Notes
|
248
|
+
------------- | ------------- | ------------- | -------------
|
249
|
+
**project_id** | **String**| Project ID |
|
250
|
+
**id** | **String**| ID |
|
251
|
+
**screenshot_update_parameters** | [**ScreenshotUpdateParameters**](ScreenshotUpdateParameters.md)| |
|
252
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
253
|
+
|
254
|
+
### Return type
|
255
|
+
|
256
|
+
Response<([**Screenshot**](Screenshot.md))>
|
257
|
+
|
258
|
+
### Authorization
|
259
|
+
|
260
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
261
|
+
|
262
|
+
### HTTP request headers
|
263
|
+
|
264
|
+
- **Content-Type**: application/json
|
265
|
+
- **Accept**: application/json
|
266
|
+
|
267
|
+
|
268
|
+
## screenshots_list
|
269
|
+
|
270
|
+
> Array<Screenshot> screenshots_list(project_id, opts)
|
271
|
+
|
272
|
+
List screenshots
|
273
|
+
|
274
|
+
List all screenshots for the given project.
|
275
|
+
|
276
|
+
### Example
|
277
|
+
|
278
|
+
```ruby
|
279
|
+
# load the gem
|
280
|
+
require 'phrase'
|
281
|
+
# setup authorization
|
282
|
+
Phrase.configure do |config|
|
283
|
+
# Configure HTTP basic authorization: Basic
|
284
|
+
config.username = 'YOUR USERNAME'
|
285
|
+
config.password = 'YOUR PASSWORD'
|
286
|
+
|
287
|
+
# Configure API key authorization: Token
|
288
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
289
|
+
config.api_key_prefix['Authorization'] = 'token'
|
290
|
+
end
|
291
|
+
|
292
|
+
api_instance = Phrase::ScreenshotsApi.new
|
293
|
+
project_id = 'project_id_example' # String | Project ID
|
294
|
+
opts = {
|
295
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
296
|
+
page: 1, # Integer | Page number
|
297
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
298
|
+
}
|
299
|
+
|
300
|
+
begin
|
301
|
+
#List screenshots
|
302
|
+
result = api_instance.screenshots_list(project_id, opts)
|
303
|
+
pp result
|
304
|
+
rescue Phrase::ApiError => e
|
305
|
+
puts "Exception when calling ScreenshotsApi->screenshots_list: #{e}"
|
306
|
+
end
|
307
|
+
```
|
308
|
+
|
309
|
+
### Parameters
|
310
|
+
|
311
|
+
|
312
|
+
Name | Type | Description | Notes
|
313
|
+
------------- | ------------- | ------------- | -------------
|
314
|
+
**project_id** | **String**| Project ID |
|
315
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
316
|
+
**page** | **Integer**| Page number | [optional]
|
317
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
318
|
+
|
319
|
+
### Return type
|
320
|
+
|
321
|
+
Response<([**Array<Screenshot>**](Screenshot.md))>
|
322
|
+
|
323
|
+
### Authorization
|
324
|
+
|
325
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
326
|
+
|
327
|
+
### HTTP request headers
|
328
|
+
|
329
|
+
- **Content-Type**: Not defined
|
330
|
+
- **Accept**: application/json
|
331
|
+
|
data/docs/Space.md
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# Phrase::Space
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
**created_at** | **DateTime** | | [optional]
|
10
|
+
**updated_at** | **DateTime** | | [optional]
|
11
|
+
**projects_count** | **Integer** | | [optional]
|
12
|
+
**projects** | [**Array<Project>**](Project.md) | | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'Phrase'
|
18
|
+
|
19
|
+
instance = Phrase::Space.new(id: null,
|
20
|
+
name: null,
|
21
|
+
created_at: null,
|
22
|
+
updated_at: null,
|
23
|
+
projects_count: null,
|
24
|
+
projects: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Phrase::SpaceCreateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | Name of the space | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'Phrase'
|
13
|
+
|
14
|
+
instance = Phrase::SpaceCreateParameters.new(name: My Android Projects)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# Phrase::SpaceUpdateParameters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**name** | **String** | New name of the space | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'Phrase'
|
13
|
+
|
14
|
+
instance = Phrase::SpaceUpdateParameters.new(name: My Android Projects)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/SpacesApi.md
ADDED
@@ -0,0 +1,529 @@
|
|
1
|
+
# Phrase::SpacesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**space_create**](SpacesApi.md#space_create) | **POST** /accounts/{account_id}/spaces | Create a Space
|
8
|
+
[**space_delete**](SpacesApi.md#space_delete) | **DELETE** /accounts/{account_id}/spaces/{id} | Delete Space
|
9
|
+
[**space_show**](SpacesApi.md#space_show) | **GET** /accounts/{account_id}/spaces/{id} | Get Space
|
10
|
+
[**space_update**](SpacesApi.md#space_update) | **PATCH** /accounts/{account_id}/spaces/{id} | Update Space
|
11
|
+
[**spaces_list**](SpacesApi.md#spaces_list) | **GET** /accounts/{account_id}/spaces | List Spaces
|
12
|
+
[**spaces_projects_create**](SpacesApi.md#spaces_projects_create) | **POST** /accounts/{account_id}/spaces/{space_id}/projects | Add Project
|
13
|
+
[**spaces_projects_delete**](SpacesApi.md#spaces_projects_delete) | **DELETE** /accounts/{account_id}/spaces/{space_id}/projects/{id} | Remove Project
|
14
|
+
[**spaces_projects_list**](SpacesApi.md#spaces_projects_list) | **GET** /accounts/{account_id}/spaces/{space_id}/projects | List Projects
|
15
|
+
|
16
|
+
|
17
|
+
|
18
|
+
## space_create
|
19
|
+
|
20
|
+
> Space space_create(account_id, space_create_parameters, opts)
|
21
|
+
|
22
|
+
Create a Space
|
23
|
+
|
24
|
+
Create a new Space.
|
25
|
+
|
26
|
+
### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
# load the gem
|
30
|
+
require 'phrase'
|
31
|
+
# setup authorization
|
32
|
+
Phrase.configure do |config|
|
33
|
+
# Configure HTTP basic authorization: Basic
|
34
|
+
config.username = 'YOUR USERNAME'
|
35
|
+
config.password = 'YOUR PASSWORD'
|
36
|
+
|
37
|
+
# Configure API key authorization: Token
|
38
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
39
|
+
config.api_key_prefix['Authorization'] = 'token'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = Phrase::SpacesApi.new
|
43
|
+
account_id = 'account_id_example' # String | Account ID
|
44
|
+
space_create_parameters = Phrase::SpaceCreateParameters.new # SpaceCreateParameters |
|
45
|
+
opts = {
|
46
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
47
|
+
}
|
48
|
+
|
49
|
+
begin
|
50
|
+
#Create a Space
|
51
|
+
result = api_instance.space_create(account_id, space_create_parameters, opts)
|
52
|
+
pp result
|
53
|
+
rescue Phrase::ApiError => e
|
54
|
+
puts "Exception when calling SpacesApi->space_create: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
### Parameters
|
59
|
+
|
60
|
+
|
61
|
+
Name | Type | Description | Notes
|
62
|
+
------------- | ------------- | ------------- | -------------
|
63
|
+
**account_id** | **String**| Account ID |
|
64
|
+
**space_create_parameters** | [**SpaceCreateParameters**](SpaceCreateParameters.md)| |
|
65
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
Response<([**Space**](Space.md))>
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: application/json
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
80
|
+
|
81
|
+
## space_delete
|
82
|
+
|
83
|
+
> space_delete(account_id, id, opts)
|
84
|
+
|
85
|
+
Delete Space
|
86
|
+
|
87
|
+
Delete the specified Space.
|
88
|
+
|
89
|
+
### Example
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
# load the gem
|
93
|
+
require 'phrase'
|
94
|
+
# setup authorization
|
95
|
+
Phrase.configure do |config|
|
96
|
+
# Configure HTTP basic authorization: Basic
|
97
|
+
config.username = 'YOUR USERNAME'
|
98
|
+
config.password = 'YOUR PASSWORD'
|
99
|
+
|
100
|
+
# Configure API key authorization: Token
|
101
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
102
|
+
config.api_key_prefix['Authorization'] = 'token'
|
103
|
+
end
|
104
|
+
|
105
|
+
api_instance = Phrase::SpacesApi.new
|
106
|
+
account_id = 'account_id_example' # String | Account ID
|
107
|
+
id = 'id_example' # String | ID
|
108
|
+
opts = {
|
109
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
110
|
+
}
|
111
|
+
|
112
|
+
begin
|
113
|
+
#Delete Space
|
114
|
+
api_instance.space_delete(account_id, id, opts)
|
115
|
+
rescue Phrase::ApiError => e
|
116
|
+
puts "Exception when calling SpacesApi->space_delete: #{e}"
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
### Parameters
|
121
|
+
|
122
|
+
|
123
|
+
Name | Type | Description | Notes
|
124
|
+
------------- | ------------- | ------------- | -------------
|
125
|
+
**account_id** | **String**| Account ID |
|
126
|
+
**id** | **String**| ID |
|
127
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
128
|
+
|
129
|
+
### Return type
|
130
|
+
|
131
|
+
Response<(nil (empty response body))>
|
132
|
+
|
133
|
+
### Authorization
|
134
|
+
|
135
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
136
|
+
|
137
|
+
### HTTP request headers
|
138
|
+
|
139
|
+
- **Content-Type**: Not defined
|
140
|
+
- **Accept**: Not defined
|
141
|
+
|
142
|
+
|
143
|
+
## space_show
|
144
|
+
|
145
|
+
> Space space_show(account_id, id, opts)
|
146
|
+
|
147
|
+
Get Space
|
148
|
+
|
149
|
+
Show the specified Space.
|
150
|
+
|
151
|
+
### Example
|
152
|
+
|
153
|
+
```ruby
|
154
|
+
# load the gem
|
155
|
+
require 'phrase'
|
156
|
+
# setup authorization
|
157
|
+
Phrase.configure do |config|
|
158
|
+
# Configure HTTP basic authorization: Basic
|
159
|
+
config.username = 'YOUR USERNAME'
|
160
|
+
config.password = 'YOUR PASSWORD'
|
161
|
+
|
162
|
+
# Configure API key authorization: Token
|
163
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
164
|
+
config.api_key_prefix['Authorization'] = 'token'
|
165
|
+
end
|
166
|
+
|
167
|
+
api_instance = Phrase::SpacesApi.new
|
168
|
+
account_id = 'account_id_example' # String | Account ID
|
169
|
+
id = 'id_example' # String | ID
|
170
|
+
opts = {
|
171
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
172
|
+
}
|
173
|
+
|
174
|
+
begin
|
175
|
+
#Get Space
|
176
|
+
result = api_instance.space_show(account_id, id, opts)
|
177
|
+
pp result
|
178
|
+
rescue Phrase::ApiError => e
|
179
|
+
puts "Exception when calling SpacesApi->space_show: #{e}"
|
180
|
+
end
|
181
|
+
```
|
182
|
+
|
183
|
+
### Parameters
|
184
|
+
|
185
|
+
|
186
|
+
Name | Type | Description | Notes
|
187
|
+
------------- | ------------- | ------------- | -------------
|
188
|
+
**account_id** | **String**| Account ID |
|
189
|
+
**id** | **String**| ID |
|
190
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
191
|
+
|
192
|
+
### Return type
|
193
|
+
|
194
|
+
Response<([**Space**](Space.md))>
|
195
|
+
|
196
|
+
### Authorization
|
197
|
+
|
198
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
199
|
+
|
200
|
+
### HTTP request headers
|
201
|
+
|
202
|
+
- **Content-Type**: Not defined
|
203
|
+
- **Accept**: application/json
|
204
|
+
|
205
|
+
|
206
|
+
## space_update
|
207
|
+
|
208
|
+
> Space space_update(account_id, id, space_update_parameters, opts)
|
209
|
+
|
210
|
+
Update Space
|
211
|
+
|
212
|
+
Update the specified Space.
|
213
|
+
|
214
|
+
### Example
|
215
|
+
|
216
|
+
```ruby
|
217
|
+
# load the gem
|
218
|
+
require 'phrase'
|
219
|
+
# setup authorization
|
220
|
+
Phrase.configure do |config|
|
221
|
+
# Configure HTTP basic authorization: Basic
|
222
|
+
config.username = 'YOUR USERNAME'
|
223
|
+
config.password = 'YOUR PASSWORD'
|
224
|
+
|
225
|
+
# Configure API key authorization: Token
|
226
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
227
|
+
config.api_key_prefix['Authorization'] = 'token'
|
228
|
+
end
|
229
|
+
|
230
|
+
api_instance = Phrase::SpacesApi.new
|
231
|
+
account_id = 'account_id_example' # String | Account ID
|
232
|
+
id = 'id_example' # String | ID
|
233
|
+
space_update_parameters = Phrase::SpaceUpdateParameters.new # SpaceUpdateParameters |
|
234
|
+
opts = {
|
235
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
236
|
+
}
|
237
|
+
|
238
|
+
begin
|
239
|
+
#Update Space
|
240
|
+
result = api_instance.space_update(account_id, id, space_update_parameters, opts)
|
241
|
+
pp result
|
242
|
+
rescue Phrase::ApiError => e
|
243
|
+
puts "Exception when calling SpacesApi->space_update: #{e}"
|
244
|
+
end
|
245
|
+
```
|
246
|
+
|
247
|
+
### Parameters
|
248
|
+
|
249
|
+
|
250
|
+
Name | Type | Description | Notes
|
251
|
+
------------- | ------------- | ------------- | -------------
|
252
|
+
**account_id** | **String**| Account ID |
|
253
|
+
**id** | **String**| ID |
|
254
|
+
**space_update_parameters** | [**SpaceUpdateParameters**](SpaceUpdateParameters.md)| |
|
255
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
256
|
+
|
257
|
+
### Return type
|
258
|
+
|
259
|
+
Response<([**Space**](Space.md))>
|
260
|
+
|
261
|
+
### Authorization
|
262
|
+
|
263
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
264
|
+
|
265
|
+
### HTTP request headers
|
266
|
+
|
267
|
+
- **Content-Type**: application/json
|
268
|
+
- **Accept**: application/json
|
269
|
+
|
270
|
+
|
271
|
+
## spaces_list
|
272
|
+
|
273
|
+
> Array<Space> spaces_list(account_id, opts)
|
274
|
+
|
275
|
+
List Spaces
|
276
|
+
|
277
|
+
List all Spaces for the given account.
|
278
|
+
|
279
|
+
### Example
|
280
|
+
|
281
|
+
```ruby
|
282
|
+
# load the gem
|
283
|
+
require 'phrase'
|
284
|
+
# setup authorization
|
285
|
+
Phrase.configure do |config|
|
286
|
+
# Configure HTTP basic authorization: Basic
|
287
|
+
config.username = 'YOUR USERNAME'
|
288
|
+
config.password = 'YOUR PASSWORD'
|
289
|
+
|
290
|
+
# Configure API key authorization: Token
|
291
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
292
|
+
config.api_key_prefix['Authorization'] = 'token'
|
293
|
+
end
|
294
|
+
|
295
|
+
api_instance = Phrase::SpacesApi.new
|
296
|
+
account_id = 'account_id_example' # String | Account ID
|
297
|
+
opts = {
|
298
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
299
|
+
page: 1, # Integer | Page number
|
300
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
301
|
+
}
|
302
|
+
|
303
|
+
begin
|
304
|
+
#List Spaces
|
305
|
+
result = api_instance.spaces_list(account_id, opts)
|
306
|
+
pp result
|
307
|
+
rescue Phrase::ApiError => e
|
308
|
+
puts "Exception when calling SpacesApi->spaces_list: #{e}"
|
309
|
+
end
|
310
|
+
```
|
311
|
+
|
312
|
+
### Parameters
|
313
|
+
|
314
|
+
|
315
|
+
Name | Type | Description | Notes
|
316
|
+
------------- | ------------- | ------------- | -------------
|
317
|
+
**account_id** | **String**| Account ID |
|
318
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
319
|
+
**page** | **Integer**| Page number | [optional]
|
320
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
321
|
+
|
322
|
+
### Return type
|
323
|
+
|
324
|
+
Response<([**Array<Space>**](Space.md))>
|
325
|
+
|
326
|
+
### Authorization
|
327
|
+
|
328
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
329
|
+
|
330
|
+
### HTTP request headers
|
331
|
+
|
332
|
+
- **Content-Type**: Not defined
|
333
|
+
- **Accept**: application/json
|
334
|
+
|
335
|
+
|
336
|
+
## spaces_projects_create
|
337
|
+
|
338
|
+
> spaces_projects_create(account_id, space_id, spaces_projects_create_parameters, opts)
|
339
|
+
|
340
|
+
Add Project
|
341
|
+
|
342
|
+
Adds an existing project to the space.
|
343
|
+
|
344
|
+
### Example
|
345
|
+
|
346
|
+
```ruby
|
347
|
+
# load the gem
|
348
|
+
require 'phrase'
|
349
|
+
# setup authorization
|
350
|
+
Phrase.configure do |config|
|
351
|
+
# Configure HTTP basic authorization: Basic
|
352
|
+
config.username = 'YOUR USERNAME'
|
353
|
+
config.password = 'YOUR PASSWORD'
|
354
|
+
|
355
|
+
# Configure API key authorization: Token
|
356
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
357
|
+
config.api_key_prefix['Authorization'] = 'token'
|
358
|
+
end
|
359
|
+
|
360
|
+
api_instance = Phrase::SpacesApi.new
|
361
|
+
account_id = 'account_id_example' # String | Account ID
|
362
|
+
space_id = 'space_id_example' # String | Space ID
|
363
|
+
spaces_projects_create_parameters = Phrase::SpacesProjectsCreateParameters.new # SpacesProjectsCreateParameters |
|
364
|
+
opts = {
|
365
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
366
|
+
}
|
367
|
+
|
368
|
+
begin
|
369
|
+
#Add Project
|
370
|
+
api_instance.spaces_projects_create(account_id, space_id, spaces_projects_create_parameters, opts)
|
371
|
+
rescue Phrase::ApiError => e
|
372
|
+
puts "Exception when calling SpacesApi->spaces_projects_create: #{e}"
|
373
|
+
end
|
374
|
+
```
|
375
|
+
|
376
|
+
### Parameters
|
377
|
+
|
378
|
+
|
379
|
+
Name | Type | Description | Notes
|
380
|
+
------------- | ------------- | ------------- | -------------
|
381
|
+
**account_id** | **String**| Account ID |
|
382
|
+
**space_id** | **String**| Space ID |
|
383
|
+
**spaces_projects_create_parameters** | [**SpacesProjectsCreateParameters**](SpacesProjectsCreateParameters.md)| |
|
384
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
385
|
+
|
386
|
+
### Return type
|
387
|
+
|
388
|
+
Response<(nil (empty response body))>
|
389
|
+
|
390
|
+
### Authorization
|
391
|
+
|
392
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
393
|
+
|
394
|
+
### HTTP request headers
|
395
|
+
|
396
|
+
- **Content-Type**: application/json
|
397
|
+
- **Accept**: Not defined
|
398
|
+
|
399
|
+
|
400
|
+
## spaces_projects_delete
|
401
|
+
|
402
|
+
> spaces_projects_delete(account_id, space_id, id, opts)
|
403
|
+
|
404
|
+
Remove Project
|
405
|
+
|
406
|
+
Removes a specified project from the specified space.
|
407
|
+
|
408
|
+
### Example
|
409
|
+
|
410
|
+
```ruby
|
411
|
+
# load the gem
|
412
|
+
require 'phrase'
|
413
|
+
# setup authorization
|
414
|
+
Phrase.configure do |config|
|
415
|
+
# Configure HTTP basic authorization: Basic
|
416
|
+
config.username = 'YOUR USERNAME'
|
417
|
+
config.password = 'YOUR PASSWORD'
|
418
|
+
|
419
|
+
# Configure API key authorization: Token
|
420
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
421
|
+
config.api_key_prefix['Authorization'] = 'token'
|
422
|
+
end
|
423
|
+
|
424
|
+
api_instance = Phrase::SpacesApi.new
|
425
|
+
account_id = 'account_id_example' # String | Account ID
|
426
|
+
space_id = 'space_id_example' # String | Space ID
|
427
|
+
id = 'id_example' # String | ID
|
428
|
+
opts = {
|
429
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
430
|
+
}
|
431
|
+
|
432
|
+
begin
|
433
|
+
#Remove Project
|
434
|
+
api_instance.spaces_projects_delete(account_id, space_id, id, opts)
|
435
|
+
rescue Phrase::ApiError => e
|
436
|
+
puts "Exception when calling SpacesApi->spaces_projects_delete: #{e}"
|
437
|
+
end
|
438
|
+
```
|
439
|
+
|
440
|
+
### Parameters
|
441
|
+
|
442
|
+
|
443
|
+
Name | Type | Description | Notes
|
444
|
+
------------- | ------------- | ------------- | -------------
|
445
|
+
**account_id** | **String**| Account ID |
|
446
|
+
**space_id** | **String**| Space ID |
|
447
|
+
**id** | **String**| ID |
|
448
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
449
|
+
|
450
|
+
### Return type
|
451
|
+
|
452
|
+
Response<(nil (empty response body))>
|
453
|
+
|
454
|
+
### Authorization
|
455
|
+
|
456
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
457
|
+
|
458
|
+
### HTTP request headers
|
459
|
+
|
460
|
+
- **Content-Type**: Not defined
|
461
|
+
- **Accept**: Not defined
|
462
|
+
|
463
|
+
|
464
|
+
## spaces_projects_list
|
465
|
+
|
466
|
+
> Array<Project> spaces_projects_list(account_id, space_id, opts)
|
467
|
+
|
468
|
+
List Projects
|
469
|
+
|
470
|
+
List all projects for the specified Space.
|
471
|
+
|
472
|
+
### Example
|
473
|
+
|
474
|
+
```ruby
|
475
|
+
# load the gem
|
476
|
+
require 'phrase'
|
477
|
+
# setup authorization
|
478
|
+
Phrase.configure do |config|
|
479
|
+
# Configure HTTP basic authorization: Basic
|
480
|
+
config.username = 'YOUR USERNAME'
|
481
|
+
config.password = 'YOUR PASSWORD'
|
482
|
+
|
483
|
+
# Configure API key authorization: Token
|
484
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
485
|
+
config.api_key_prefix['Authorization'] = 'token'
|
486
|
+
end
|
487
|
+
|
488
|
+
api_instance = Phrase::SpacesApi.new
|
489
|
+
account_id = 'account_id_example' # String | Account ID
|
490
|
+
space_id = 'space_id_example' # String | Space ID
|
491
|
+
opts = {
|
492
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
493
|
+
page: 1, # Integer | Page number
|
494
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
495
|
+
}
|
496
|
+
|
497
|
+
begin
|
498
|
+
#List Projects
|
499
|
+
result = api_instance.spaces_projects_list(account_id, space_id, opts)
|
500
|
+
pp result
|
501
|
+
rescue Phrase::ApiError => e
|
502
|
+
puts "Exception when calling SpacesApi->spaces_projects_list: #{e}"
|
503
|
+
end
|
504
|
+
```
|
505
|
+
|
506
|
+
### Parameters
|
507
|
+
|
508
|
+
|
509
|
+
Name | Type | Description | Notes
|
510
|
+
------------- | ------------- | ------------- | -------------
|
511
|
+
**account_id** | **String**| Account ID |
|
512
|
+
**space_id** | **String**| Space ID |
|
513
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
514
|
+
**page** | **Integer**| Page number | [optional]
|
515
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
516
|
+
|
517
|
+
### Return type
|
518
|
+
|
519
|
+
Response<([**Array<Project>**](Project.md))>
|
520
|
+
|
521
|
+
### Authorization
|
522
|
+
|
523
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
524
|
+
|
525
|
+
### HTTP request headers
|
526
|
+
|
527
|
+
- **Content-Type**: Not defined
|
528
|
+
- **Accept**: application/json
|
529
|
+
|