phrase 0.4.31 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
data/docs/Document.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Phrase::Document
|
|
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
|
+
|
|
12
|
+
## Code Sample
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'Phrase'
|
|
16
|
+
|
|
17
|
+
instance = Phrase::Document.new(id: null,
|
|
18
|
+
name: null,
|
|
19
|
+
created_at: null,
|
|
20
|
+
updated_at: null)
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# Phrase::DocumentsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**document_delete**](DocumentsApi.md#document_delete) | **DELETE** /projects/{project_id}/documents/{id} | Delete document
|
|
8
|
+
[**documents_list**](DocumentsApi.md#documents_list) | **GET** /projects/{project_id}/documents | List documents
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## document_delete
|
|
13
|
+
|
|
14
|
+
> document_delete(project_id, id, opts)
|
|
15
|
+
|
|
16
|
+
Delete document
|
|
17
|
+
|
|
18
|
+
Delete an existing document.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
# load the gem
|
|
24
|
+
require 'phrase'
|
|
25
|
+
# setup authorization
|
|
26
|
+
Phrase.configure do |config|
|
|
27
|
+
# Configure HTTP basic authorization: Basic
|
|
28
|
+
config.username = 'YOUR USERNAME'
|
|
29
|
+
config.password = 'YOUR PASSWORD'
|
|
30
|
+
|
|
31
|
+
# Configure API key authorization: Token
|
|
32
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
33
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
api_instance = Phrase::DocumentsApi.new
|
|
37
|
+
project_id = 'project_id_example' # String | Project ID
|
|
38
|
+
id = 'id_example' # String | ID
|
|
39
|
+
opts = {
|
|
40
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
begin
|
|
44
|
+
#Delete document
|
|
45
|
+
api_instance.document_delete(project_id, id, opts)
|
|
46
|
+
rescue Phrase::ApiError => e
|
|
47
|
+
puts "Exception when calling DocumentsApi->document_delete: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
Name | Type | Description | Notes
|
|
55
|
+
------------- | ------------- | ------------- | -------------
|
|
56
|
+
**project_id** | **String**| Project ID |
|
|
57
|
+
**id** | **String**| ID |
|
|
58
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
Response<(nil (empty response body))>
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: Not defined
|
|
71
|
+
- **Accept**: Not defined
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
## documents_list
|
|
75
|
+
|
|
76
|
+
> Array<Document> documents_list(project_id, opts)
|
|
77
|
+
|
|
78
|
+
List documents
|
|
79
|
+
|
|
80
|
+
List all documents the current user has access to.
|
|
81
|
+
|
|
82
|
+
### Example
|
|
83
|
+
|
|
84
|
+
```ruby
|
|
85
|
+
# load the gem
|
|
86
|
+
require 'phrase'
|
|
87
|
+
# setup authorization
|
|
88
|
+
Phrase.configure do |config|
|
|
89
|
+
# Configure HTTP basic authorization: Basic
|
|
90
|
+
config.username = 'YOUR USERNAME'
|
|
91
|
+
config.password = 'YOUR PASSWORD'
|
|
92
|
+
|
|
93
|
+
# Configure API key authorization: Token
|
|
94
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
95
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
api_instance = Phrase::DocumentsApi.new
|
|
99
|
+
project_id = 'project_id_example' # String | Project ID
|
|
100
|
+
opts = {
|
|
101
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
102
|
+
page: 1, # Integer | Page number
|
|
103
|
+
per_page: 25 # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
begin
|
|
107
|
+
#List documents
|
|
108
|
+
result = api_instance.documents_list(project_id, opts)
|
|
109
|
+
pp result
|
|
110
|
+
rescue Phrase::ApiError => e
|
|
111
|
+
puts "Exception when calling DocumentsApi->documents_list: #{e}"
|
|
112
|
+
end
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Parameters
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
Name | Type | Description | Notes
|
|
119
|
+
------------- | ------------- | ------------- | -------------
|
|
120
|
+
**project_id** | **String**| Project ID |
|
|
121
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
122
|
+
**page** | **Integer**| Page number | [optional]
|
|
123
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
124
|
+
|
|
125
|
+
### Return type
|
|
126
|
+
|
|
127
|
+
Response<([**Array<Document>**](Document.md))>
|
|
128
|
+
|
|
129
|
+
### Authorization
|
|
130
|
+
|
|
131
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
132
|
+
|
|
133
|
+
### HTTP request headers
|
|
134
|
+
|
|
135
|
+
- **Content-Type**: Not defined
|
|
136
|
+
- **Accept**: application/json
|
|
137
|
+
|
data/docs/Format.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Phrase::Format
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**name** | **String** | | [optional]
|
|
8
|
+
**api_name** | **String** | | [optional]
|
|
9
|
+
**description** | **String** | | [optional]
|
|
10
|
+
**extension** | **String** | | [optional]
|
|
11
|
+
**default_encoding** | **String** | | [optional]
|
|
12
|
+
**importable** | **Boolean** | | [optional]
|
|
13
|
+
**exportable** | **Boolean** | | [optional]
|
|
14
|
+
**default_file** | **String** | | [optional]
|
|
15
|
+
**renders_default_locale** | **Boolean** | | [optional]
|
|
16
|
+
**includes_locale_information** | **Boolean** | | [optional]
|
|
17
|
+
|
|
18
|
+
## Code Sample
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'Phrase'
|
|
22
|
+
|
|
23
|
+
instance = Phrase::Format.new(name: null,
|
|
24
|
+
api_name: null,
|
|
25
|
+
description: null,
|
|
26
|
+
extension: null,
|
|
27
|
+
default_encoding: null,
|
|
28
|
+
importable: null,
|
|
29
|
+
exportable: null,
|
|
30
|
+
default_file: null,
|
|
31
|
+
renders_default_locale: null,
|
|
32
|
+
includes_locale_information: null)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
|
data/docs/FormatsApi.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Phrase::FormatsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**formats_list**](FormatsApi.md#formats_list) | **GET** /formats | List formats
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## formats_list
|
|
12
|
+
|
|
13
|
+
> Array<Format> formats_list(opts)
|
|
14
|
+
|
|
15
|
+
List formats
|
|
16
|
+
|
|
17
|
+
Get a handy list of all localization file formats supported in Phrase.
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
23
|
+
require 'phrase'
|
|
24
|
+
# setup authorization
|
|
25
|
+
Phrase.configure do |config|
|
|
26
|
+
# Configure HTTP basic authorization: Basic
|
|
27
|
+
config.username = 'YOUR USERNAME'
|
|
28
|
+
config.password = 'YOUR PASSWORD'
|
|
29
|
+
|
|
30
|
+
# Configure API key authorization: Token
|
|
31
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
32
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
api_instance = Phrase::FormatsApi.new
|
|
36
|
+
opts = {
|
|
37
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
begin
|
|
41
|
+
#List formats
|
|
42
|
+
result = api_instance.formats_list(opts)
|
|
43
|
+
pp result
|
|
44
|
+
rescue Phrase::ApiError => e
|
|
45
|
+
puts "Exception when calling FormatsApi->formats_list: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Parameters
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
Name | Type | Description | Notes
|
|
53
|
+
------------- | ------------- | ------------- | -------------
|
|
54
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
55
|
+
|
|
56
|
+
### Return type
|
|
57
|
+
|
|
58
|
+
Response<([**Array<Format>**](Format.md))>
|
|
59
|
+
|
|
60
|
+
### Authorization
|
|
61
|
+
|
|
62
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
63
|
+
|
|
64
|
+
### HTTP request headers
|
|
65
|
+
|
|
66
|
+
- **Content-Type**: Not defined
|
|
67
|
+
- **Accept**: application/json
|
|
68
|
+
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# Phrase::GitHubSyncApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**github_sync_export**](GitHubSyncApi.md#github_sync_export) | **POST** /github_syncs/export | Export from Phrase to GitHub
|
|
8
|
+
[**github_sync_import**](GitHubSyncApi.md#github_sync_import) | **POST** /github_syncs/import | Import to Phrase from GitHub
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## github_sync_export
|
|
13
|
+
|
|
14
|
+
> github_sync_export(github_sync_export_parameters, opts)
|
|
15
|
+
|
|
16
|
+
Export from Phrase to GitHub
|
|
17
|
+
|
|
18
|
+
Export translations from Phrase to GitHub according to the .phraseapp.yml file within the GitHub repository.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
# load the gem
|
|
24
|
+
require 'phrase'
|
|
25
|
+
# setup authorization
|
|
26
|
+
Phrase.configure do |config|
|
|
27
|
+
# Configure HTTP basic authorization: Basic
|
|
28
|
+
config.username = 'YOUR USERNAME'
|
|
29
|
+
config.password = 'YOUR PASSWORD'
|
|
30
|
+
|
|
31
|
+
# Configure API key authorization: Token
|
|
32
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
33
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
api_instance = Phrase::GitHubSyncApi.new
|
|
37
|
+
github_sync_export_parameters = Phrase::GithubSyncExportParameters.new # GithubSyncExportParameters |
|
|
38
|
+
opts = {
|
|
39
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
begin
|
|
43
|
+
#Export from Phrase to GitHub
|
|
44
|
+
api_instance.github_sync_export(github_sync_export_parameters, opts)
|
|
45
|
+
rescue Phrase::ApiError => e
|
|
46
|
+
puts "Exception when calling GitHubSyncApi->github_sync_export: #{e}"
|
|
47
|
+
end
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Parameters
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
Name | Type | Description | Notes
|
|
54
|
+
------------- | ------------- | ------------- | -------------
|
|
55
|
+
**github_sync_export_parameters** | [**GithubSyncExportParameters**](GithubSyncExportParameters.md)| |
|
|
56
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
57
|
+
|
|
58
|
+
### Return type
|
|
59
|
+
|
|
60
|
+
Response<(nil (empty response body))>
|
|
61
|
+
|
|
62
|
+
### Authorization
|
|
63
|
+
|
|
64
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
65
|
+
|
|
66
|
+
### HTTP request headers
|
|
67
|
+
|
|
68
|
+
- **Content-Type**: application/json
|
|
69
|
+
- **Accept**: application/json
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
## github_sync_import
|
|
73
|
+
|
|
74
|
+
> github_sync_import(github_sync_import_parameters, opts)
|
|
75
|
+
|
|
76
|
+
Import to Phrase from GitHub
|
|
77
|
+
|
|
78
|
+
Import files to Phrase from your connected GitHub repository.
|
|
79
|
+
|
|
80
|
+
### Example
|
|
81
|
+
|
|
82
|
+
```ruby
|
|
83
|
+
# load the gem
|
|
84
|
+
require 'phrase'
|
|
85
|
+
# setup authorization
|
|
86
|
+
Phrase.configure do |config|
|
|
87
|
+
# Configure HTTP basic authorization: Basic
|
|
88
|
+
config.username = 'YOUR USERNAME'
|
|
89
|
+
config.password = 'YOUR PASSWORD'
|
|
90
|
+
|
|
91
|
+
# Configure API key authorization: Token
|
|
92
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
93
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
api_instance = Phrase::GitHubSyncApi.new
|
|
97
|
+
github_sync_import_parameters = Phrase::GithubSyncImportParameters.new # GithubSyncImportParameters |
|
|
98
|
+
opts = {
|
|
99
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
begin
|
|
103
|
+
#Import to Phrase from GitHub
|
|
104
|
+
api_instance.github_sync_import(github_sync_import_parameters, opts)
|
|
105
|
+
rescue Phrase::ApiError => e
|
|
106
|
+
puts "Exception when calling GitHubSyncApi->github_sync_import: #{e}"
|
|
107
|
+
end
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Parameters
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
Name | Type | Description | Notes
|
|
114
|
+
------------- | ------------- | ------------- | -------------
|
|
115
|
+
**github_sync_import_parameters** | [**GithubSyncImportParameters**](GithubSyncImportParameters.md)| |
|
|
116
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
Response<(nil (empty response body))>
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: application/json
|
|
129
|
+
- **Accept**: application/json
|
|
130
|
+
|
|
@@ -0,0 +1,463 @@
|
|
|
1
|
+
# Phrase::GitLabSyncApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.phrase.com/v2*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**gitlab_sync_delete**](GitLabSyncApi.md#gitlab_sync_delete) | **DELETE** /gitlab_syncs/{id} | Delete single Sync Setting
|
|
8
|
+
[**gitlab_sync_export**](GitLabSyncApi.md#gitlab_sync_export) | **POST** /gitlab_syncs/{gitlab_sync_id}/export | Export from Phrase to GitLab
|
|
9
|
+
[**gitlab_sync_history**](GitLabSyncApi.md#gitlab_sync_history) | **GET** /gitlab_syncs/{gitlab_sync_id}/history | History of single Sync Setting
|
|
10
|
+
[**gitlab_sync_import**](GitLabSyncApi.md#gitlab_sync_import) | **POST** /gitlab_syncs/{gitlab_sync_id}/import | Import from GitLab to Phrase
|
|
11
|
+
[**gitlab_sync_list**](GitLabSyncApi.md#gitlab_sync_list) | **GET** /gitlab_syncs | List GitLab syncs
|
|
12
|
+
[**gitlab_sync_show**](GitLabSyncApi.md#gitlab_sync_show) | **GET** /gitlab_syncs/{id} | Get single Sync Setting
|
|
13
|
+
[**gitlab_sync_update**](GitLabSyncApi.md#gitlab_sync_update) | **PUT** /gitlab_syncs/{id} | Update single Sync Setting
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## gitlab_sync_delete
|
|
18
|
+
|
|
19
|
+
> gitlab_sync_delete(id, opts)
|
|
20
|
+
|
|
21
|
+
Delete single Sync Setting
|
|
22
|
+
|
|
23
|
+
Deletes a single GitLab Sync Setting.
|
|
24
|
+
|
|
25
|
+
### Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
# load the gem
|
|
29
|
+
require 'phrase'
|
|
30
|
+
# setup authorization
|
|
31
|
+
Phrase.configure do |config|
|
|
32
|
+
# Configure HTTP basic authorization: Basic
|
|
33
|
+
config.username = 'YOUR USERNAME'
|
|
34
|
+
config.password = 'YOUR PASSWORD'
|
|
35
|
+
|
|
36
|
+
# Configure API key authorization: Token
|
|
37
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
38
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
api_instance = Phrase::GitLabSyncApi.new
|
|
42
|
+
id = 'id_example' # String | ID
|
|
43
|
+
opts = {
|
|
44
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
45
|
+
account_id: 'abcd1234' # String | Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
begin
|
|
49
|
+
#Delete single Sync Setting
|
|
50
|
+
api_instance.gitlab_sync_delete(id, opts)
|
|
51
|
+
rescue Phrase::ApiError => e
|
|
52
|
+
puts "Exception when calling GitLabSyncApi->gitlab_sync_delete: #{e}"
|
|
53
|
+
end
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
Name | Type | Description | Notes
|
|
60
|
+
------------- | ------------- | ------------- | -------------
|
|
61
|
+
**id** | **String**| ID |
|
|
62
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
63
|
+
**account_id** | **String**| Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
64
|
+
|
|
65
|
+
### Return type
|
|
66
|
+
|
|
67
|
+
Response<(nil (empty response body))>
|
|
68
|
+
|
|
69
|
+
### Authorization
|
|
70
|
+
|
|
71
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
72
|
+
|
|
73
|
+
### HTTP request headers
|
|
74
|
+
|
|
75
|
+
- **Content-Type**: Not defined
|
|
76
|
+
- **Accept**: Not defined
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## gitlab_sync_export
|
|
80
|
+
|
|
81
|
+
> GitlabSyncExport gitlab_sync_export(gitlab_sync_id, gitlab_sync_export_parameters, opts)
|
|
82
|
+
|
|
83
|
+
Export from Phrase to GitLab
|
|
84
|
+
|
|
85
|
+
Export translations from Phrase to GitLab according to the .phraseapp.yml file within the GitLab repository.
|
|
86
|
+
|
|
87
|
+
### Example
|
|
88
|
+
|
|
89
|
+
```ruby
|
|
90
|
+
# load the gem
|
|
91
|
+
require 'phrase'
|
|
92
|
+
# setup authorization
|
|
93
|
+
Phrase.configure do |config|
|
|
94
|
+
# Configure HTTP basic authorization: Basic
|
|
95
|
+
config.username = 'YOUR USERNAME'
|
|
96
|
+
config.password = 'YOUR PASSWORD'
|
|
97
|
+
|
|
98
|
+
# Configure API key authorization: Token
|
|
99
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
100
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
api_instance = Phrase::GitLabSyncApi.new
|
|
104
|
+
gitlab_sync_id = 'gitlab_sync_id_example' # String | Gitlab Sync ID
|
|
105
|
+
gitlab_sync_export_parameters = Phrase::GitlabSyncExportParameters.new # GitlabSyncExportParameters |
|
|
106
|
+
opts = {
|
|
107
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
begin
|
|
111
|
+
#Export from Phrase to GitLab
|
|
112
|
+
result = api_instance.gitlab_sync_export(gitlab_sync_id, gitlab_sync_export_parameters, opts)
|
|
113
|
+
pp result
|
|
114
|
+
rescue Phrase::ApiError => e
|
|
115
|
+
puts "Exception when calling GitLabSyncApi->gitlab_sync_export: #{e}"
|
|
116
|
+
end
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Parameters
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
Name | Type | Description | Notes
|
|
123
|
+
------------- | ------------- | ------------- | -------------
|
|
124
|
+
**gitlab_sync_id** | **String**| Gitlab Sync ID |
|
|
125
|
+
**gitlab_sync_export_parameters** | [**GitlabSyncExportParameters**](GitlabSyncExportParameters.md)| |
|
|
126
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
127
|
+
|
|
128
|
+
### Return type
|
|
129
|
+
|
|
130
|
+
Response<([**GitlabSyncExport**](GitlabSyncExport.md))>
|
|
131
|
+
|
|
132
|
+
### Authorization
|
|
133
|
+
|
|
134
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
135
|
+
|
|
136
|
+
### HTTP request headers
|
|
137
|
+
|
|
138
|
+
- **Content-Type**: application/json
|
|
139
|
+
- **Accept**: application/json
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
## gitlab_sync_history
|
|
143
|
+
|
|
144
|
+
> Array<GitlabSyncHistory> gitlab_sync_history(gitlab_sync_id, opts)
|
|
145
|
+
|
|
146
|
+
History of single Sync Setting
|
|
147
|
+
|
|
148
|
+
List history for a single Sync Setting.
|
|
149
|
+
|
|
150
|
+
### Example
|
|
151
|
+
|
|
152
|
+
```ruby
|
|
153
|
+
# load the gem
|
|
154
|
+
require 'phrase'
|
|
155
|
+
# setup authorization
|
|
156
|
+
Phrase.configure do |config|
|
|
157
|
+
# Configure HTTP basic authorization: Basic
|
|
158
|
+
config.username = 'YOUR USERNAME'
|
|
159
|
+
config.password = 'YOUR PASSWORD'
|
|
160
|
+
|
|
161
|
+
# Configure API key authorization: Token
|
|
162
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
163
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
api_instance = Phrase::GitLabSyncApi.new
|
|
167
|
+
gitlab_sync_id = 'gitlab_sync_id_example' # String | Gitlab Sync ID
|
|
168
|
+
opts = {
|
|
169
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
170
|
+
page: 1, # Integer | Page number
|
|
171
|
+
per_page: 25, # Integer | allows you to specify a page size up to 100 items, 25 by default
|
|
172
|
+
account_id: 'abcd1234' # String | Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
begin
|
|
176
|
+
#History of single Sync Setting
|
|
177
|
+
result = api_instance.gitlab_sync_history(gitlab_sync_id, opts)
|
|
178
|
+
pp result
|
|
179
|
+
rescue Phrase::ApiError => e
|
|
180
|
+
puts "Exception when calling GitLabSyncApi->gitlab_sync_history: #{e}"
|
|
181
|
+
end
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Parameters
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
Name | Type | Description | Notes
|
|
188
|
+
------------- | ------------- | ------------- | -------------
|
|
189
|
+
**gitlab_sync_id** | **String**| Gitlab Sync ID |
|
|
190
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
191
|
+
**page** | **Integer**| Page number | [optional]
|
|
192
|
+
**per_page** | **Integer**| allows you to specify a page size up to 100 items, 25 by default | [optional]
|
|
193
|
+
**account_id** | **String**| Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
194
|
+
|
|
195
|
+
### Return type
|
|
196
|
+
|
|
197
|
+
Response<([**Array<GitlabSyncHistory>**](GitlabSyncHistory.md))>
|
|
198
|
+
|
|
199
|
+
### Authorization
|
|
200
|
+
|
|
201
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
202
|
+
|
|
203
|
+
### HTTP request headers
|
|
204
|
+
|
|
205
|
+
- **Content-Type**: Not defined
|
|
206
|
+
- **Accept**: application/json
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
## gitlab_sync_import
|
|
210
|
+
|
|
211
|
+
> Array<Upload> gitlab_sync_import(gitlab_sync_id, gitlab_sync_import_parameters, opts)
|
|
212
|
+
|
|
213
|
+
Import from GitLab to Phrase
|
|
214
|
+
|
|
215
|
+
Import translations from GitLab to Phrase according to the .phraseapp.yml file within the GitLab repository.
|
|
216
|
+
|
|
217
|
+
### Example
|
|
218
|
+
|
|
219
|
+
```ruby
|
|
220
|
+
# load the gem
|
|
221
|
+
require 'phrase'
|
|
222
|
+
# setup authorization
|
|
223
|
+
Phrase.configure do |config|
|
|
224
|
+
# Configure HTTP basic authorization: Basic
|
|
225
|
+
config.username = 'YOUR USERNAME'
|
|
226
|
+
config.password = 'YOUR PASSWORD'
|
|
227
|
+
|
|
228
|
+
# Configure API key authorization: Token
|
|
229
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
230
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
api_instance = Phrase::GitLabSyncApi.new
|
|
234
|
+
gitlab_sync_id = 'gitlab_sync_id_example' # String | Gitlab Sync ID
|
|
235
|
+
gitlab_sync_import_parameters = Phrase::GitlabSyncImportParameters.new # GitlabSyncImportParameters |
|
|
236
|
+
opts = {
|
|
237
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional)
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
begin
|
|
241
|
+
#Import from GitLab to Phrase
|
|
242
|
+
result = api_instance.gitlab_sync_import(gitlab_sync_id, gitlab_sync_import_parameters, opts)
|
|
243
|
+
pp result
|
|
244
|
+
rescue Phrase::ApiError => e
|
|
245
|
+
puts "Exception when calling GitLabSyncApi->gitlab_sync_import: #{e}"
|
|
246
|
+
end
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Parameters
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
Name | Type | Description | Notes
|
|
253
|
+
------------- | ------------- | ------------- | -------------
|
|
254
|
+
**gitlab_sync_id** | **String**| Gitlab Sync ID |
|
|
255
|
+
**gitlab_sync_import_parameters** | [**GitlabSyncImportParameters**](GitlabSyncImportParameters.md)| |
|
|
256
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
257
|
+
|
|
258
|
+
### Return type
|
|
259
|
+
|
|
260
|
+
Response<([**Array<Upload>**](Upload.md))>
|
|
261
|
+
|
|
262
|
+
### Authorization
|
|
263
|
+
|
|
264
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
265
|
+
|
|
266
|
+
### HTTP request headers
|
|
267
|
+
|
|
268
|
+
- **Content-Type**: application/json
|
|
269
|
+
- **Accept**: application/json
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
## gitlab_sync_list
|
|
273
|
+
|
|
274
|
+
> Array<GitlabSync> gitlab_sync_list(opts)
|
|
275
|
+
|
|
276
|
+
List GitLab syncs
|
|
277
|
+
|
|
278
|
+
List all GitLab Sync Settings for which synchronisation with Phrase and GitLab is activated.
|
|
279
|
+
|
|
280
|
+
### Example
|
|
281
|
+
|
|
282
|
+
```ruby
|
|
283
|
+
# load the gem
|
|
284
|
+
require 'phrase'
|
|
285
|
+
# setup authorization
|
|
286
|
+
Phrase.configure do |config|
|
|
287
|
+
# Configure HTTP basic authorization: Basic
|
|
288
|
+
config.username = 'YOUR USERNAME'
|
|
289
|
+
config.password = 'YOUR PASSWORD'
|
|
290
|
+
|
|
291
|
+
# Configure API key authorization: Token
|
|
292
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
293
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
api_instance = Phrase::GitLabSyncApi.new
|
|
297
|
+
opts = {
|
|
298
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
299
|
+
account_id: 'abcd1234' # String | Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
begin
|
|
303
|
+
#List GitLab syncs
|
|
304
|
+
result = api_instance.gitlab_sync_list(opts)
|
|
305
|
+
pp result
|
|
306
|
+
rescue Phrase::ApiError => e
|
|
307
|
+
puts "Exception when calling GitLabSyncApi->gitlab_sync_list: #{e}"
|
|
308
|
+
end
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Parameters
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
Name | Type | Description | Notes
|
|
315
|
+
------------- | ------------- | ------------- | -------------
|
|
316
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
317
|
+
**account_id** | **String**| Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
318
|
+
|
|
319
|
+
### Return type
|
|
320
|
+
|
|
321
|
+
Response<([**Array<GitlabSync>**](GitlabSync.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
|
+
|
|
332
|
+
|
|
333
|
+
## gitlab_sync_show
|
|
334
|
+
|
|
335
|
+
> GitlabSync gitlab_sync_show(id, opts)
|
|
336
|
+
|
|
337
|
+
Get single Sync Setting
|
|
338
|
+
|
|
339
|
+
Shows a single GitLab Sync Setting.
|
|
340
|
+
|
|
341
|
+
### Example
|
|
342
|
+
|
|
343
|
+
```ruby
|
|
344
|
+
# load the gem
|
|
345
|
+
require 'phrase'
|
|
346
|
+
# setup authorization
|
|
347
|
+
Phrase.configure do |config|
|
|
348
|
+
# Configure HTTP basic authorization: Basic
|
|
349
|
+
config.username = 'YOUR USERNAME'
|
|
350
|
+
config.password = 'YOUR PASSWORD'
|
|
351
|
+
|
|
352
|
+
# Configure API key authorization: Token
|
|
353
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
354
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
355
|
+
end
|
|
356
|
+
|
|
357
|
+
api_instance = Phrase::GitLabSyncApi.new
|
|
358
|
+
id = 'id_example' # String | ID
|
|
359
|
+
opts = {
|
|
360
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
361
|
+
account_id: 'abcd1234' # String | Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
begin
|
|
365
|
+
#Get single Sync Setting
|
|
366
|
+
result = api_instance.gitlab_sync_show(id, opts)
|
|
367
|
+
pp result
|
|
368
|
+
rescue Phrase::ApiError => e
|
|
369
|
+
puts "Exception when calling GitLabSyncApi->gitlab_sync_show: #{e}"
|
|
370
|
+
end
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### Parameters
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
Name | Type | Description | Notes
|
|
377
|
+
------------- | ------------- | ------------- | -------------
|
|
378
|
+
**id** | **String**| ID |
|
|
379
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
380
|
+
**account_id** | **String**| Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
381
|
+
|
|
382
|
+
### Return type
|
|
383
|
+
|
|
384
|
+
Response<([**GitlabSync**](GitlabSync.md))>
|
|
385
|
+
|
|
386
|
+
### Authorization
|
|
387
|
+
|
|
388
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
389
|
+
|
|
390
|
+
### HTTP request headers
|
|
391
|
+
|
|
392
|
+
- **Content-Type**: Not defined
|
|
393
|
+
- **Accept**: application/json
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
## gitlab_sync_update
|
|
397
|
+
|
|
398
|
+
> GitlabSync gitlab_sync_update(id, opts)
|
|
399
|
+
|
|
400
|
+
Update single Sync Setting
|
|
401
|
+
|
|
402
|
+
Updates a single GitLab Sync Setting.
|
|
403
|
+
|
|
404
|
+
### Example
|
|
405
|
+
|
|
406
|
+
```ruby
|
|
407
|
+
# load the gem
|
|
408
|
+
require 'phrase'
|
|
409
|
+
# setup authorization
|
|
410
|
+
Phrase.configure do |config|
|
|
411
|
+
# Configure HTTP basic authorization: Basic
|
|
412
|
+
config.username = 'YOUR USERNAME'
|
|
413
|
+
config.password = 'YOUR PASSWORD'
|
|
414
|
+
|
|
415
|
+
# Configure API key authorization: Token
|
|
416
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
417
|
+
config.api_key_prefix['Authorization'] = 'token'
|
|
418
|
+
end
|
|
419
|
+
|
|
420
|
+
api_instance = Phrase::GitLabSyncApi.new
|
|
421
|
+
id = 'id_example' # String | ID
|
|
422
|
+
opts = {
|
|
423
|
+
x_phrase_app_otp: 'x_phrase_app_otp_example', # String | Two-Factor-Authentication token (optional)
|
|
424
|
+
account_id: 'abcd1234', # String | Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
|
|
425
|
+
phrase_project_code: '3456abcd', # String | Code of the related Phrase Project.
|
|
426
|
+
gitlab_project_id: 12345, # Integer | ID of the related GitLab Project.
|
|
427
|
+
gitlab_branch_name: 'feature-development' # String | Name of the GitLab Branch.
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
begin
|
|
431
|
+
#Update single Sync Setting
|
|
432
|
+
result = api_instance.gitlab_sync_update(id, opts)
|
|
433
|
+
pp result
|
|
434
|
+
rescue Phrase::ApiError => e
|
|
435
|
+
puts "Exception when calling GitLabSyncApi->gitlab_sync_update: #{e}"
|
|
436
|
+
end
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
### Parameters
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
Name | Type | Description | Notes
|
|
443
|
+
------------- | ------------- | ------------- | -------------
|
|
444
|
+
**id** | **String**| ID |
|
|
445
|
+
**x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional]
|
|
446
|
+
**account_id** | **String**| Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts. | [optional]
|
|
447
|
+
**phrase_project_code** | **String**| Code of the related Phrase Project. | [optional]
|
|
448
|
+
**gitlab_project_id** | **Integer**| ID of the related GitLab Project. | [optional]
|
|
449
|
+
**gitlab_branch_name** | **String**| Name of the GitLab Branch. | [optional]
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
Response<([**GitlabSync**](GitlabSync.md))>
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
[Basic](../README.md#Basic), [Token](../README.md#Token)
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: Not defined
|
|
462
|
+
- **Accept**: application/json
|
|
463
|
+
|