Module: Phrase

Defined in:
lib/phrase.rb,
lib/phrase/version.rb,
lib/phrase/response.rb,
lib/phrase/api_error.rb,
lib/phrase/api_client.rb,
lib/phrase/models/icu.rb,
lib/phrase/models/job.rb,
lib/phrase/models/tag.rb,
lib/phrase/api/icu_api.rb,
lib/phrase/models/team.rb,
lib/phrase/models/user.rb,
lib/phrase/api/jobs_api.rb,
lib/phrase/api/keys_api.rb,
lib/phrase/api/tags_api.rb,
lib/phrase/models/error.rb,
lib/phrase/models/space.rb,
lib/phrase/api/teams_api.rb,
lib/phrase/api/users_api.rb,
lib/phrase/configuration.rb,
lib/phrase/models/branch.rb,
lib/phrase/models/format.rb,
lib/phrase/models/locale.rb,
lib/phrase/models/member.rb,
lib/phrase/models/space1.rb,
lib/phrase/models/upload.rb,
lib/phrase/api/orders_api.rb,
lib/phrase/api/search_api.rb,
lib/phrase/api/spaces_api.rb,
lib/phrase/models/account.rb,
lib/phrase/models/comment.rb,
lib/phrase/models/project.rb,
lib/phrase/models/release.rb,
lib/phrase/models/webhook.rb,
lib/phrase/api/formats_api.rb,
lib/phrase/api/locales_api.rb,
lib/phrase/api/members_api.rb,
lib/phrase/api/reports_api.rb,
lib/phrase/api/uploads_api.rb,
lib/phrase/models/document.rb,
lib/phrase/models/glossary.rb,
lib/phrase/models/key_link.rb,
lib/phrase/models/variable.rb,
lib/phrase/api/accounts_api.rb,
lib/phrase/api/branches_api.rb,
lib/phrase/api/comments_api.rb,
lib/phrase/api/projects_api.rb,
lib/phrase/api/releases_api.rb,
lib/phrase/api/webhooks_api.rb,
lib/phrase/models/repo_sync.rb,
lib/phrase/api/documents_api.rb,
lib/phrase/api/variables_api.rb,
lib/phrase/models/invitation.rb,
lib/phrase/models/job_locale.rb,
lib/phrase/models/screenshot.rb,
lib/phrase/models/styleguide.rb,
lib/phrase/models/team_short.rb,
lib/phrase/api/glossaries_api.rb,
lib/phrase/api/repo_syncs_api.rb,
lib/phrase/models/branch_name.rb,
lib/phrase/models/error_error.rb,
lib/phrase/models/gitlab_sync.rb,
lib/phrase/models/job_comment.rb,
lib/phrase/models/job_details.rb,
lib/phrase/models/job_preview.rb,
lib/phrase/models/key_preview.rb,
lib/phrase/models/team_detail.rb,
lib/phrase/models/translation.rb,
lib/phrase/api/invitations_api.rb,
lib/phrase/api/job_locales_api.rb,
lib/phrase/api/linked_keys_api.rb,
lib/phrase/api/screenshots_api.rb,
lib/phrase/models/current_user.rb,
lib/phrase/models/distribution.rb,
lib/phrase/models/job_template.rb,
lib/phrase/models/notification.rb,
lib/phrase/models/subscription.rb,
lib/phrase/models/user_preview.rb,
lib/phrase/api/git_hub_sync_api.rb,
lib/phrase/api/git_lab_sync_api.rb,
lib/phrase/api/job_comments_api.rb,
lib/phrase/api/style_guides_api.rb,
lib/phrase/api/translations_api.rb,
lib/phrase/models/authorization.rb,
lib/phrase/models/glossary_term.rb,
lib/phrase/models/locale_report.rb,
lib/phrase/models/project_short.rb,
lib/phrase/api/distributions_api.rb,
lib/phrase/api/job_templates_api.rb,
lib/phrase/api/notifications_api.rb,
lib/phrase/models/affected_count.rb,
lib/phrase/models/bitbucket_sync.rb,
lib/phrase/models/locale_details.rb,
lib/phrase/models/locale_preview.rb,
lib/phrase/models/project_report.rb,
lib/phrase/models/tag_with_stats.rb,
lib/phrase/models/upload_summary.rb,
lib/phrase/api/authorizations_api.rb,
lib/phrase/api/bitbucket_sync_api.rb,
lib/phrase/api/glossary_terms_api.rb,
lib/phrase/models/account_details.rb,
lib/phrase/models/blacklisted_key.rb,
lib/phrase/models/locale_download.rb,
lib/phrase/models/locale_preview1.rb,
lib/phrase/models/project_details.rb,
lib/phrase/models/project_locales.rb,
lib/phrase/models/release_preview.rb,
lib/phrase/models/release_trigger.rb,
lib/phrase/models/repo_sync_event.rb,
lib/phrase/models/translation_key.rb,
lib/phrase/api/comment_replies_api.rb,
lib/phrase/api/custom_metadata_api.rb,
lib/phrase/models/comment_reaction.rb,
lib/phrase/models/figma_attachment.rb,
lib/phrase/models/webhook_delivery.rb,
lib/phrase/api/blacklisted_keys_api.rb,
lib/phrase/api/locale_downloads_api.rb,
lib/phrase/api/release_triggers_api.rb,
lib/phrase/api/versions_history_api.rb,
lib/phrase/models/locale_statistics.rb,
lib/phrase/models/screenshot_marker.rb,
lib/phrase/models/translation_order.rb,
lib/phrase/api/comment_reactions_api.rb,
lib/phrase/api/figma_attachments_api.rb,
lib/phrase/models/affected_resources.rb,
lib/phrase/models/gitlab_sync_export.rb,
lib/phrase/models/notification_group.rb,
lib/phrase/models/styleguide_details.rb,
lib/phrase/models/styleguide_preview.rb,
lib/phrase/models/translation_parent.rb,
lib/phrase/api/screenshot_markers_api.rb,
lib/phrase/api/webhook_deliveries_api.rb,
lib/phrase/models/gitlab_sync_history.rb,
lib/phrase/models/keys_tag_parameters.rb,
lib/phrase/models/locale_team_preview.rb,
lib/phrase/models/locale_user_preview.rb,
lib/phrase/models/member_spaces_inner.rb,
lib/phrase/models/translation_details.rb,
lib/phrase/models/translation_version.rb,
lib/phrase/api/notification_groups_api.rb,
lib/phrase/models/distribution_preview.rb,
lib/phrase/models/job_start_parameters.rb,
lib/phrase/models/job_template_details.rb,
lib/phrase/models/job_template_locales.rb,
lib/phrase/models/job_template_preview.rb,
lib/phrase/api/job_template_locales_api.rb,
lib/phrase/models/account_search_result.rb,
lib/phrase/models/job_create_parameters.rb,
lib/phrase/models/job_reopen_parameters.rb,
lib/phrase/models/job_update_parameters.rb,
lib/phrase/models/key_create_parameters.rb,
lib/phrase/models/key_update_parameters.rb,
lib/phrase/models/keys_untag_parameters.rb,
lib/phrase/models/member_project_detail.rb,
lib/phrase/models/tag_create_parameters.rb,
lib/phrase/models/keys_search_parameters.rb,
lib/phrase/models/locale_download_params.rb,
lib/phrase/models/locale_download_result.rb,
lib/phrase/models/team_create_parameters.rb,
lib/phrase/models/team_update_parameters.rb,
lib/phrase/api/keys_figma_attachments_api.rb,
lib/phrase/models/branch_merge_parameters.rb,
lib/phrase/models/icu_skeleton_parameters.rb,
lib/phrase/models/job_complete_parameters.rb,
lib/phrase/models/keys_exclude_parameters.rb,
lib/phrase/models/keys_include_parameters.rb,
lib/phrase/models/order_create_parameters.rb,
lib/phrase/models/replies_list_parameters.rb,
lib/phrase/models/space_create_parameters.rb,
lib/phrase/models/space_update_parameters.rb,
lib/phrase/models/translation_key_details.rb,
lib/phrase/models/authorization_with_token.rb,
lib/phrase/models/branch_create_parameters.rb,
lib/phrase/models/branch_update_parameters.rb,
lib/phrase/models/comments_list_parameters.rb,
lib/phrase/models/custom_metadata_property.rb,
lib/phrase/models/locale_create_parameters.rb,
lib/phrase/models/locale_update_parameters.rb,
lib/phrase/models/member_update_parameters.rb,
lib/phrase/models/order_confirm_parameters.rb,
lib/phrase/models/comment_create_parameters.rb,
lib/phrase/models/comment_update_parameters.rb,
lib/phrase/models/custom_metadata_data_type.rb,
lib/phrase/models/glossary_term_translation.rb,
lib/phrase/models/notification_group_detail.rb,
lib/phrase/models/organization_job_template.rb,
lib/phrase/models/project_create_parameters.rb,
lib/phrase/models/project_update_parameters.rb,
lib/phrase/models/release_create_parameters.rb,
lib/phrase/models/release_update_parameters.rb,
lib/phrase/models/webhook_create_parameters.rb,
lib/phrase/models/webhook_update_parameters.rb,
lib/phrase/api/quality_performance_score_api.rb,
lib/phrase/models/glossary_create_parameters.rb,
lib/phrase/models/glossary_update_parameters.rb,
lib/phrase/models/job_keys_create_parameters.rb,
lib/phrase/models/release_create_parameters1.rb,
lib/phrase/models/release_update_parameters1.rb,
lib/phrase/models/tag_with_stats1_statistics.rb,
lib/phrase/models/variable_create_parameters.rb,
lib/phrase/models/variable_update_parameters.rb,
lib/phrase/api/glossary_term_translations_api.rb,
lib/phrase/api/organization_job_templates_api.rb,
lib/phrase/models/key_links_create_parameters.rb,
lib/phrase/models/key_links_index400_response.rb,
lib/phrase/models/tag_with_stats1_statistics1.rb,
lib/phrase/models/comment_mark_read_parameters.rb,
lib/phrase/models/invitation_create_parameters.rb,
lib/phrase/models/invitation_update_parameters.rb,
lib/phrase/models/job_locale_reopen_parameters.rb,
lib/phrase/models/job_locale_update_parameters.rb,
lib/phrase/models/repo_sync_event_errors_inner.rb,
lib/phrase/models/screenshot_update_parameters.rb,
lib/phrase/models/search_in_account_parameters.rb,
lib/phrase/models/styleguide_create_parameters.rb,
lib/phrase/models/styleguide_update_parameters.rb,
lib/phrase/models/github_sync_export_parameters.rb,
lib/phrase/models/github_sync_import_parameters.rb,
lib/phrase/models/gitlab_sync_export_parameters.rb,
lib/phrase/models/gitlab_sync_import_parameters.rb,
lib/phrase/models/job_comment_create_parameters.rb,
lib/phrase/models/job_comment_update_parameters.rb,
lib/phrase/models/job_locales_create_parameters.rb,
lib/phrase/models/teams_users_create_parameters.rb,
lib/phrase/models/translation_create_parameters.rb,
lib/phrase/models/translation_review_parameters.rb,
lib/phrase/models/translation_update_parameters.rb,
lib/phrase/models/translation_verify_parameters.rb,
lib/phrase/models/translation_version_with_user.rb,
lib/phrase/models/bitbucket_sync_export_response.rb,
lib/phrase/models/distribution_create_parameters.rb,
lib/phrase/models/distribution_update_parameters.rb,
lib/phrase/models/job_locale_complete_parameters.rb,
lib/phrase/models/job_template_create_parameters.rb,
lib/phrase/models/job_template_update_parameters.rb,
lib/phrase/models/teams_spaces_create_parameters.rb,
lib/phrase/models/translation_exclude_parameters.rb,
lib/phrase/models/translation_include_parameters.rb,
lib/phrase/models/translations_review_parameters.rb,
lib/phrase/models/translations_search_parameters.rb,
lib/phrase/models/translations_verify_parameters.rb,
lib/phrase/models/authorization_create_parameters.rb,
lib/phrase/models/authorization_update_parameters.rb,
lib/phrase/models/glossary_term_create_parameters.rb,
lib/phrase/models/glossary_term_update_parameters.rb,
lib/phrase/models/translation_unverify_parameters.rb,
lib/phrase/models/translations_exclude_parameters.rb,
lib/phrase/models/translations_include_parameters.rb,
lib/phrase/models/bitbucket_sync_export_parameters.rb,
lib/phrase/models/bitbucket_sync_import_parameters.rb,
lib/phrase/models/gitlab_sync_history_errors_inner.rb,
lib/phrase/models/teams_projects_create_parameters.rb,
lib/phrase/models/translations_unverify_parameters.rb,
lib/phrase/models/blacklisted_key_create_parameters.rb,
lib/phrase/models/blacklisted_key_update_parameters.rb,
lib/phrase/models/locale_download_create_parameters.rb,
lib/phrase/models/member_update_settings_parameters.rb,
lib/phrase/models/organization_job_template_details.rb,
lib/phrase/models/spaces_projects_create_parameters.rb,
lib/phrase/api/organization_job_template_locales_api.rb,
lib/phrase/models/figma_attachment_create_parameters.rb,
lib/phrase/models/figma_attachment_update_parameters.rb,
lib/phrase/models/key_links_batch_destroy_parameters.rb,
lib/phrase/models/screenshot_marker_create_parameters.rb,
lib/phrase/models/screenshot_marker_update_parameters.rb,
lib/phrase/models/invitation_update_settings_parameters.rb,
lib/phrase/models/job_locale_complete_review_parameters.rb,
lib/phrase/models/job_template_locale_update_parameters.rb,
lib/phrase/models/job_template_locales_create_parameters.rb,
lib/phrase/models/member_project_detail_project_roles_inner.rb,
lib/phrase/models/projects_quality_performance_score_request.rb,
lib/phrase/models/custom_metadata_property_create422_response.rb,
lib/phrase/models/glossary_term_translation_create_parameters.rb,
lib/phrase/models/glossary_term_translation_update_parameters.rb,
lib/phrase/models/organization_job_template_create_parameters.rb,
lib/phrase/models/organization_job_template_update_parameters.rb,
lib/phrase/models/custom_metadata_properties_create_parameters.rb,
lib/phrase/models/custom_metadata_properties_update_parameters.rb,
lib/phrase/models/projects_quality_performance_score200_response.rb,
lib/phrase/models/organization_job_template_locale_update_parameters.rb,
lib/phrase/models/organization_job_template_locales_create_parameters.rb,
lib/phrase/models/projects_quality_performance_score200_response_any_of.rb,
lib/phrase/models/custom_metadata_property_create422_response_errors_inner.rb,
lib/phrase/models/projects_quality_performance_score200_response_any_of_data.rb,
lib/phrase/models/projects_quality_performance_score200_response_any_of_errors_inner.rb,
lib/phrase/models/projects_quality_performance_score200_response_any_of_data_translations_inner.rb

Defined Under Namespace

Classes: Account, AccountDetails, AccountSearchResult, AccountsApi, AffectedCount, AffectedResources, ApiClient, ApiError, Authorization, AuthorizationCreateParameters, AuthorizationUpdateParameters, AuthorizationWithToken, AuthorizationsApi, BitbucketSync, BitbucketSyncApi, BitbucketSyncExportParameters, BitbucketSyncExportResponse, BitbucketSyncImportParameters, BlacklistedKey, BlacklistedKeyCreateParameters, BlacklistedKeyUpdateParameters, BlacklistedKeysApi, Branch, BranchCreateParameters, BranchMergeParameters, BranchName, BranchUpdateParameters, BranchesApi, Comment, CommentCreateParameters, CommentMarkReadParameters, CommentReaction, CommentReactionsApi, CommentRepliesApi, CommentUpdateParameters, CommentsApi, CommentsListParameters, Configuration, CurrentUser, CustomMetadataApi, CustomMetadataDataType, CustomMetadataPropertiesCreateParameters, CustomMetadataPropertiesUpdateParameters, CustomMetadataProperty, CustomMetadataPropertyCreate422Response, CustomMetadataPropertyCreate422ResponseErrorsInner, Distribution, DistributionCreateParameters, DistributionPreview, DistributionUpdateParameters, DistributionsApi, Document, DocumentsApi, Error, ErrorError, FigmaAttachment, FigmaAttachmentCreateParameters, FigmaAttachmentUpdateParameters, FigmaAttachmentsApi, Format, FormatsApi, GitHubSyncApi, GitLabSyncApi, GithubSyncExportParameters, GithubSyncImportParameters, GitlabSync, GitlabSyncExport, GitlabSyncExportParameters, GitlabSyncHistory, GitlabSyncHistoryErrorsInner, GitlabSyncImportParameters, GlossariesApi, Glossary, GlossaryCreateParameters, GlossaryTerm, GlossaryTermCreateParameters, GlossaryTermTranslation, GlossaryTermTranslationCreateParameters, GlossaryTermTranslationUpdateParameters, GlossaryTermTranslationsApi, GlossaryTermUpdateParameters, GlossaryTermsApi, GlossaryUpdateParameters, ICUApi, Icu, IcuSkeletonParameters, Invitation, InvitationCreateParameters, InvitationUpdateParameters, InvitationUpdateSettingsParameters, InvitationsApi, Job, JobComment, JobCommentCreateParameters, JobCommentUpdateParameters, JobCommentsApi, JobCompleteParameters, JobCreateParameters, JobDetails, JobKeysCreateParameters, JobLocale, JobLocaleCompleteParameters, JobLocaleCompleteReviewParameters, JobLocaleReopenParameters, JobLocaleUpdateParameters, JobLocalesApi, JobLocalesCreateParameters, JobPreview, JobReopenParameters, JobStartParameters, JobTemplate, JobTemplateCreateParameters, JobTemplateDetails, JobTemplateLocaleUpdateParameters, JobTemplateLocales, JobTemplateLocalesApi, JobTemplateLocalesCreateParameters, JobTemplatePreview, JobTemplateUpdateParameters, JobTemplatesApi, JobUpdateParameters, JobsApi, KeyCreateParameters, KeyLink, KeyLinksBatchDestroyParameters, KeyLinksCreateParameters, KeyLinksIndex400Response, KeyPreview, KeyUpdateParameters, KeysApi, KeysExcludeParameters, KeysFigmaAttachmentsApi, KeysIncludeParameters, KeysSearchParameters, KeysTagParameters, KeysUntagParameters, LinkedKeysApi, Locale, LocaleCreateParameters, LocaleDetails, LocaleDownload, LocaleDownloadCreateParameters, LocaleDownloadParams, LocaleDownloadResult, LocaleDownloadsApi, LocalePreview, LocalePreview1, LocaleReport, LocaleStatistics, LocaleTeamPreview, LocaleUpdateParameters, LocaleUserPreview, LocalesApi, Member, MemberProjectDetail, MemberProjectDetailProjectRolesInner, MemberSpacesInner, MemberUpdateParameters, MemberUpdateSettingsParameters, MembersApi, Notification, NotificationGroup, NotificationGroupDetail, NotificationGroupsApi, NotificationsApi, OrderConfirmParameters, OrderCreateParameters, OrdersApi, OrganizationJobTemplate, OrganizationJobTemplateCreateParameters, OrganizationJobTemplateDetails, OrganizationJobTemplateLocaleUpdateParameters, OrganizationJobTemplateLocalesApi, OrganizationJobTemplateLocalesCreateParameters, OrganizationJobTemplateUpdateParameters, OrganizationJobTemplatesApi, Project, ProjectCreateParameters, ProjectDetails, ProjectLocales, ProjectReport, ProjectShort, ProjectUpdateParameters, ProjectsApi, ProjectsQualityPerformanceScore200Response, ProjectsQualityPerformanceScore200ResponseAnyOf, ProjectsQualityPerformanceScore200ResponseAnyOfData, ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner, ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner, ProjectsQualityPerformanceScoreRequest, QualityPerformanceScoreApi, Release, ReleaseCreateParameters, ReleaseCreateParameters1, ReleasePreview, ReleaseTrigger, ReleaseTriggersApi, ReleaseUpdateParameters, ReleaseUpdateParameters1, ReleasesApi, RepliesListParameters, RepoSync, RepoSyncEvent, RepoSyncEventErrorsInner, RepoSyncsApi, ReportsApi, Response, Screenshot, ScreenshotMarker, ScreenshotMarkerCreateParameters, ScreenshotMarkerUpdateParameters, ScreenshotMarkersApi, ScreenshotUpdateParameters, ScreenshotsApi, SearchApi, SearchInAccountParameters, Space, Space1, SpaceCreateParameters, SpaceUpdateParameters, SpacesApi, SpacesProjectsCreateParameters, StyleGuidesApi, Styleguide, StyleguideCreateParameters, StyleguideDetails, StyleguidePreview, StyleguideUpdateParameters, Subscription, Tag, TagCreateParameters, TagWithStats, TagWithStats1Statistics, TagWithStats1Statistics1, TagsApi, Team, TeamCreateParameters, TeamDetail, TeamShort, TeamUpdateParameters, TeamsApi, TeamsProjectsCreateParameters, TeamsSpacesCreateParameters, TeamsUsersCreateParameters, Translation, TranslationCreateParameters, TranslationDetails, TranslationExcludeParameters, TranslationIncludeParameters, TranslationKey, TranslationKeyDetails, TranslationOrder, TranslationParent, TranslationReviewParameters, TranslationUnverifyParameters, TranslationUpdateParameters, TranslationVerifyParameters, TranslationVersion, TranslationVersionWithUser, TranslationsApi, TranslationsExcludeParameters, TranslationsIncludeParameters, TranslationsReviewParameters, TranslationsSearchParameters, TranslationsUnverifyParameters, TranslationsVerifyParameters, Upload, UploadSummary, UploadsApi, User, UserPreview, UsersApi, Variable, VariableCreateParameters, VariableUpdateParameters, VariablesApi, VersionsHistoryApi, Webhook, WebhookCreateParameters, WebhookDeliveriesApi, WebhookDelivery, WebhookUpdateParameters, WebhooksApi

Constant Summary collapse

VERSION = 
'3.6.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Phrase.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



301
302
303
304
305
306
307
 
# File 'lib/phrase.rb', line 301

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end