Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

phrase

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

phrase

  • 3.7.0
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

phrase

Phrase - the Ruby gem for the Phrase Strings API Reference

Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • Package version: 3.7.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://developers.phrase.com/api/

Installation

Install from rubygems.org

Install from the command line:

$ gem install phrase

Install via Gemfile:

gem "phrase"

Install from GitHub Packages

Install from the command line:

$ gem install phrase-ruby --source "https://rubygems.pkg.github.com/phrase"

Install via Gemfile:

source "https://rubygems.pkg.github.com/phrase" do
  gem "phrase-ruby"
end

Install from Git

Add the following in the Gemfile:

gem 'phrase', git: 'https://github.com/phrase/phrase-ruby.git'

Build and install a gem on your own

To build the Ruby code into a gem:

gem build phrase.gemspec

Then install the gem locally:

gem install ./phrase-3.7.0.gem

(for development, run gem install --dev ./phrase-3.7.0.gem to install the development dependencies)

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'phrase'

# Setup authorization
Phrase.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'

  # Or configure API key authorization: Token
  config.api_key['Authorization'] = 'YOUR API KEY'
  config.api_key_prefix['Authorization'] = 'token'
end

api_instance = Phrase::AccountsApi.new
id = id_example # String | ID
opts = {
  x_phrase_app_otp: x_phrase_app_otp_example # String | Two-Factor-Authentication token (optional)
}

begin
  #Get a single account
  result = api_instance.account_show(id, opts)
  pp result
  pp result.next_page?
  pp result.next_page
rescue Phrase::ApiError => e
  puts "Exception when calling AccountsApi->account_show: #{e}"
end

Datacenters

The API is only accessible via HTTPS and the current version is v2, which results in a base URL like: https://api.phrase.com/v2 depending on the datacenter.

EU Datacenter

https://api.phrase.com/v2

This is the default datacenter.

US Datacenter

https://api.us.app.phrase.com/v2/

Specifying US Datacenter

You can use the US datacenter by setting the following:

config.host = "api.us.app.phrase.com"

Get help / support

Please contact support@phrase.com and we can take more direct action toward finding a solution.

Documentation for API Endpoints

All URIs are relative to https://api.phrase.com/v2

ClassMethodHTTP requestDescription
Phrase::AccountsApiaccount_showGET /accounts/{id}Get a single account
Phrase::AccountsApiaccounts_listGET /accountsList accounts
Phrase::AuthorizationsApiauthorization_createPOST /authorizationsCreate an authorization
Phrase::AuthorizationsApiauthorization_deleteDELETE /authorizations/{id}Delete an authorization
Phrase::AuthorizationsApiauthorization_showGET /authorizations/{id}Get a single authorization
Phrase::AuthorizationsApiauthorization_updatePATCH /authorizations/{id}Update an authorization
Phrase::AuthorizationsApiauthorizations_listGET /authorizationsList authorizations
Phrase::BitbucketSyncApibitbucket_sync_exportPOST /bitbucket_syncs/{id}/exportExport from Phrase Strings to Bitbucket
Phrase::BitbucketSyncApibitbucket_sync_importPOST /bitbucket_syncs/{id}/importImport to Phrase Strings from Bitbucket
Phrase::BitbucketSyncApibitbucket_syncs_listGET /bitbucket_syncsList Bitbucket syncs
Phrase::BlacklistedKeysApiblacklisted_key_createPOST /projects/{project_id}/blacklisted_keysCreate a blocked key
Phrase::BlacklistedKeysApiblacklisted_key_deleteDELETE /projects/{project_id}/blacklisted_keys/{id}Delete a blocked key
Phrase::BlacklistedKeysApiblacklisted_key_showGET /projects/{project_id}/blacklisted_keys/{id}Get a single blocked key
Phrase::BlacklistedKeysApiblacklisted_key_updatePATCH /projects/{project_id}/blacklisted_keys/{id}Update a blocked key
Phrase::BlacklistedKeysApiblacklisted_keys_listGET /projects/{project_id}/blacklisted_keysList blocked keys
Phrase::BranchesApibranch_compareGET /projects/{project_id}/branches/{name}/compareCompare branches
Phrase::BranchesApibranch_createPOST /projects/{project_id}/branchesCreate a branch
Phrase::BranchesApibranch_deleteDELETE /projects/{project_id}/branches/{name}Delete a branch
Phrase::BranchesApibranch_mergePATCH /projects/{project_id}/branches/{name}/mergeMerge a branch
Phrase::BranchesApibranch_showGET /projects/{project_id}/branches/{name}Get a single branch
Phrase::BranchesApibranch_updatePATCH /projects/{project_id}/branches/{name}Update a branch
Phrase::BranchesApibranches_listGET /projects/{project_id}/branchesList branches
Phrase::CommentReactionsApireaction_createPOST /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactionsCreate a reaction
Phrase::CommentReactionsApireaction_deleteDELETE /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}Delete a reaction
Phrase::CommentReactionsApireaction_showGET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}Get a single reaction
Phrase::CommentReactionsApireactions_listGET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactionsList reactions
Phrase::CommentRepliesApireplies_listGET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/repliesList replies
Phrase::CommentRepliesApireply_createPOST /projects/{project_id}/keys/{key_id}/comments/{comment_id}/repliesCreate a reply
Phrase::CommentRepliesApireply_deleteDELETE /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}Delete a reply
Phrase::CommentRepliesApireply_mark_as_readPATCH /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_readMark a reply as read
Phrase::CommentRepliesApireply_mark_as_unreadPATCH /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unreadMark a reply as unread
Phrase::CommentRepliesApireply_showGET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}Get a single reply
Phrase::CommentsApicomment_createPOST /projects/{project_id}/keys/{key_id}/commentsCreate a comment
Phrase::CommentsApicomment_deleteDELETE /projects/{project_id}/keys/{key_id}/comments/{id}Delete a comment
Phrase::CommentsApicomment_mark_checkGET /projects/{project_id}/keys/{key_id}/comments/{id}/readCheck if comment is read
Phrase::CommentsApicomment_mark_readPATCH /projects/{project_id}/keys/{key_id}/comments/{id}/readMark a comment as read
Phrase::CommentsApicomment_mark_unreadDELETE /projects/{project_id}/keys/{key_id}/comments/{id}/readMark a comment as unread
Phrase::CommentsApicomment_showGET /projects/{project_id}/keys/{key_id}/comments/{id}Get a single comment
Phrase::CommentsApicomment_updatePATCH /projects/{project_id}/keys/{key_id}/comments/{id}Update a comment
Phrase::CommentsApicomments_listGET /projects/{project_id}/keys/{key_id}/commentsList comments
Phrase::CustomMetadataApicustom_metadata_properties_deleteDELETE /accounts/{account_id}/custom_metadata/properties/{id}Destroy property
Phrase::CustomMetadataApicustom_metadata_properties_listGET /accounts/{account_id}/custom_metadata/propertiesList properties
Phrase::CustomMetadataApicustom_metadata_property_createPOST /accounts/{account_id}/custom_metadata/propertiesCreate a property
Phrase::CustomMetadataApicustom_metadata_property_showGET /accounts/{account_id}/custom_metadata/properties/{id}Get a single property
Phrase::CustomMetadataApicustom_metadata_property_updatePATCH /accounts/{account_id}/custom_metadata/properties/{id}Update a property
Phrase::DistributionsApidistribution_createPOST /accounts/{account_id}/distributionsCreate a distribution
Phrase::DistributionsApidistribution_deleteDELETE /accounts/{account_id}/distributions/{id}Delete a distribution
Phrase::DistributionsApidistribution_showGET /accounts/{account_id}/distributions/{id}Get a single distribution
Phrase::DistributionsApidistribution_updatePATCH /accounts/{account_id}/distributions/{id}Update a distribution
Phrase::DistributionsApidistributions_listGET /accounts/{account_id}/distributionsList distributions
Phrase::DocumentsApidocument_deleteDELETE /projects/{project_id}/documents/{id}Delete document
Phrase::DocumentsApidocuments_listGET /projects/{project_id}/documentsList documents
Phrase::FigmaAttachmentsApifigma_attachment_createPOST /projects/{project_id}/figma_attachmentsCreate a Figma attachment
Phrase::FigmaAttachmentsApifigma_attachment_deleteDELETE /projects/{project_id}/figma_attachments/{id}Delete a Figma attachment
Phrase::FigmaAttachmentsApifigma_attachment_showGET /projects/{project_id}/figma_attachments/{id}Get a single Figma attachment
Phrase::FigmaAttachmentsApifigma_attachment_updatePATCH /projects/{project_id}/figma_attachments/{id}Update a Figma attachment
Phrase::FigmaAttachmentsApifigma_attachments_listGET /projects/{project_id}/figma_attachmentsList Figma attachments
Phrase::FormatsApiformats_listGET /formatsList formats
Phrase::GitHubSyncApigithub_sync_exportPOST /github_syncs/exportExport from Phrase Strings to GitHub
Phrase::GitHubSyncApigithub_sync_importPOST /github_syncs/importImport to Phrase Strings from GitHub
Phrase::GitLabSyncApigitlab_sync_deleteDELETE /gitlab_syncs/{id}Delete single Sync Setting
Phrase::GitLabSyncApigitlab_sync_exportPOST /gitlab_syncs/{gitlab_sync_id}/exportExport from Phrase Strings to GitLab
Phrase::GitLabSyncApigitlab_sync_historyGET /gitlab_syncs/{gitlab_sync_id}/historyHistory of single Sync Setting
Phrase::GitLabSyncApigitlab_sync_importPOST /gitlab_syncs/{gitlab_sync_id}/importImport from GitLab to Phrase
Phrase::GitLabSyncApigitlab_sync_listGET /gitlab_syncsList GitLab syncs
Phrase::GitLabSyncApigitlab_sync_showGET /gitlab_syncs/{id}Get single Sync Setting
Phrase::GitLabSyncApigitlab_sync_updatePUT /gitlab_syncs/{id}Update single Sync Setting
Phrase::GlossariesApiglossaries_listGET /accounts/{account_id}/glossariesList term bases
Phrase::GlossariesApiglossary_createPOST /accounts/{account_id}/glossariesCreate a term base
Phrase::GlossariesApiglossary_deleteDELETE /accounts/{account_id}/glossaries/{id}Delete a term base
Phrase::GlossariesApiglossary_showGET /accounts/{account_id}/glossaries/{id}Get a single term base
Phrase::GlossariesApiglossary_updatePATCH /accounts/{account_id}/glossaries/{id}Update a term base
Phrase::GlossaryTermTranslationsApiglossary_term_translation_createPOST /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translationsCreate a translation for a term
Phrase::GlossaryTermTranslationsApiglossary_term_translation_deleteDELETE /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}Delete a translation for a term
Phrase::GlossaryTermTranslationsApiglossary_term_translation_updatePATCH /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}Update a translation for a term
Phrase::GlossaryTermsApiglossary_term_createPOST /accounts/{account_id}/glossaries/{glossary_id}/termsCreate a term
Phrase::GlossaryTermsApiglossary_term_deleteDELETE /accounts/{account_id}/glossaries/{glossary_id}/terms/{id}Delete a term
Phrase::GlossaryTermsApiglossary_term_showGET /accounts/{account_id}/glossaries/{glossary_id}/terms/{id}Get a single term
Phrase::GlossaryTermsApiglossary_term_updatePATCH /accounts/{account_id}/glossaries/{glossary_id}/terms/{id}Update a term
Phrase::GlossaryTermsApiglossary_terms_listGET /accounts/{account_id}/glossaries/{glossary_id}/termsList terms
Phrase::ICUApiicu_skeletonPOST /icu/skeletonBuild ICU skeletons
Phrase::InvitationsApiinvitation_createPOST /accounts/{account_id}/invitationsCreate a new invitation
Phrase::InvitationsApiinvitation_deleteDELETE /accounts/{account_id}/invitations/{id}Delete an invitation
Phrase::InvitationsApiinvitation_resendPOST /accounts/{account_id}/invitations/{id}/resendResend an invitation
Phrase::InvitationsApiinvitation_showGET /accounts/{account_id}/invitations/{id}Get a single invitation
Phrase::InvitationsApiinvitation_updatePATCH /accounts/{account_id}/invitations/{id}Update an invitation
Phrase::InvitationsApiinvitation_update_settingsPATCH /projects/{project_id}/invitations/{id}Update a member's invitation access
Phrase::InvitationsApiinvitations_listGET /accounts/{account_id}/invitationsList invitations
Phrase::JobCommentsApijob_comment_createPOST /projects/{project_id}/jobs/{job_id}/commentsCreate a job comment
Phrase::JobCommentsApijob_comment_deleteDELETE /projects/{project_id}/jobs/{job_id}/comments/{id}Delete a job comment
Phrase::JobCommentsApijob_comment_showGET /projects/{project_id}/jobs/{job_id}/comments/{id}Get a single job comment
Phrase::JobCommentsApijob_comment_updatePATCH /projects/{project_id}/jobs/{job_id}/comments/{id}Update a job comment
Phrase::JobCommentsApijob_comments_listGET /projects/{project_id}/jobs/{job_id}/commentsList job comments
Phrase::JobLocalesApijob_locale_completePOST /projects/{project_id}/jobs/{job_id}/locales/{id}/completeComplete a job locale
Phrase::JobLocalesApijob_locale_complete_reviewPOST /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_reviewReview a job locale
Phrase::JobLocalesApijob_locale_deleteDELETE /projects/{project_id}/jobs/{job_id}/locales/{id}Remove a target locale from a job
Phrase::JobLocalesApijob_locale_reopenPOST /projects/{project_id}/jobs/{job_id}/locales/{id}/reopenReopen a job locale
Phrase::JobLocalesApijob_locale_showGET /projects/{project_id}/jobs/{job_id}/locales/{id}Show single job target locale
Phrase::JobLocalesApijob_locale_updatePATCH /projects/{project_id}/jobs/{job_id}/locales/{id}Update a job target locale
Phrase::JobLocalesApijob_locales_createPOST /projects/{project_id}/jobs/{job_id}/localesAdd a target locale to a job
Phrase::JobLocalesApijob_locales_listGET /projects/{project_id}/jobs/{job_id}/localesList job target locales
Phrase::JobTemplateLocalesApijob_template_locale_deleteDELETE /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}Delete a job template locale
Phrase::JobTemplateLocalesApijob_template_locale_showGET /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}Get a single job template locale
Phrase::JobTemplateLocalesApijob_template_locale_updatePATCH /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}Update a job template locale
Phrase::JobTemplateLocalesApijob_template_locales_createPOST /projects/{project_id}/job_templates/{job_template_id}/localesCreate a job template locale
Phrase::JobTemplateLocalesApijob_template_locales_listGET /projects/{project_id}/job_templates/{job_template_id}/localesList job template locales
Phrase::JobTemplatesApijob_template_createPOST /projects/{project_id}/job_templatesCreate a job template
Phrase::JobTemplatesApijob_template_deleteDELETE /projects/{project_id}/job_templates/{id}Delete a job template
Phrase::JobTemplatesApijob_template_updatePATCH /projects/{project_id}/job_templates/{id}Update a job template
Phrase::JobTemplatesApijob_templates_listGET /projects/{project_id}/job_templatesList job templates
Phrase::JobTemplatesApijob_templates_showGET /projects/{project_id}/job_templates/{id}Get a single job template
Phrase::JobsApijob_completePOST /projects/{project_id}/jobs/{id}/completeComplete a job
Phrase::JobsApijob_createPOST /projects/{project_id}/jobsCreate a job
Phrase::JobsApijob_deleteDELETE /projects/{project_id}/jobs/{id}Delete a job
Phrase::JobsApijob_keys_createPOST /projects/{project_id}/jobs/{id}/keysAdd keys to job
Phrase::JobsApijob_keys_deleteDELETE /projects/{project_id}/jobs/{id}/keysRemove keys from job
Phrase::JobsApijob_lockPOST /projects/{project_id}/jobs/{id}/lockLock a job
Phrase::JobsApijob_reopenPOST /projects/{project_id}/jobs/{id}/reopenReopen a job
Phrase::JobsApijob_showGET /projects/{project_id}/jobs/{id}Get a single job
Phrase::JobsApijob_startPOST /projects/{project_id}/jobs/{id}/startStart a job
Phrase::JobsApijob_unlockPOST /projects/{project_id}/jobs/{id}/unlockUnlock a job
Phrase::JobsApijob_updatePATCH /projects/{project_id}/jobs/{id}Update a job
Phrase::JobsApijobs_by_accountGET /accounts/{account_id}/jobsList account jobs
Phrase::JobsApijobs_listGET /projects/{project_id}/jobsList jobs
Phrase::KeysApikey_createPOST /projects/{project_id}/keysCreate a key
Phrase::KeysApikey_deleteDELETE /projects/{project_id}/keys/{id}Delete a key
Phrase::KeysApikey_showGET /projects/{project_id}/keys/{id}Get a single key
Phrase::KeysApikey_updatePATCH /projects/{project_id}/keys/{id}Update a key
Phrase::KeysApikeys_delete_collectionDELETE /projects/{project_id}/keysDelete collection of keys
Phrase::KeysApikeys_excludePATCH /projects/{project_id}/keys/excludeExclude a locale on a collection of keys
Phrase::KeysApikeys_includePATCH /projects/{project_id}/keys/includeInclude a locale on a collection of keys
Phrase::KeysApikeys_listGET /projects/{project_id}/keysList keys
Phrase::KeysApikeys_searchPOST /projects/{project_id}/keys/searchSearch keys
Phrase::KeysApikeys_tagPATCH /projects/{project_id}/keys/tagAdd tags to collection of keys
Phrase::KeysApikeys_untagPATCH /projects/{project_id}/keys/untagRemove tags from collection of keys
Phrase::KeysFigmaAttachmentsApifigma_attachment_attach_to_keyPOST /projects/{project_id}/figma_attachments/{figma_attachment_id}/keysAttach the Figma attachment to a key
Phrase::KeysFigmaAttachmentsApifigma_attachment_detach_from_keyDELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}Detach the Figma attachment from a key
Phrase::LinkedKeysApikey_links_batch_destroyDELETE /projects/{project_id}/keys/{id}/key_linksBatch unlink child keys from a parent key
Phrase::LinkedKeysApikey_links_createPOST /projects/{project_id}/keys/{id}/key_linksLink child keys to a parent key
Phrase::LinkedKeysApikey_links_destroyDELETE /projects/{project_id}/keys/{id}/key_links/{child_key_id}Unlink a child key from a parent key
Phrase::LinkedKeysApikey_links_indexGET /projects/{project_id}/keys/{id}/key_linksList child keys of a parent key
Phrase::LocaleDownloadsApilocale_download_createPOST /projects/{project_id}/locales/{locale_id}/downloadsInitiate async download of a locale
Phrase::LocaleDownloadsApilocale_download_showGET /projects/{project_id}/locales/{locale_id}/downloads/{id}Show status of an async locale download
Phrase::LocalesApiaccount_localesGET /accounts/{id}/localesList locales used in account
Phrase::LocalesApilocale_createPOST /projects/{project_id}/localesCreate a locale
Phrase::LocalesApilocale_deleteDELETE /projects/{project_id}/locales/{id}Delete a locale
Phrase::LocalesApilocale_downloadGET /projects/{project_id}/locales/{id}/downloadDownload a locale
Phrase::LocalesApilocale_showGET /projects/{project_id}/locales/{id}Get a single locale
Phrase::LocalesApilocale_updatePATCH /projects/{project_id}/locales/{id}Update a locale
Phrase::LocalesApilocales_listGET /projects/{project_id}/localesList locales
Phrase::MembersApimember_deleteDELETE /accounts/{account_id}/members/{id}Remove a user from the account
Phrase::MembersApimember_showGET /accounts/{account_id}/members/{id}Get single member
Phrase::MembersApimember_updatePATCH /accounts/{account_id}/members/{id}Update a member
Phrase::MembersApimember_update_settingsPATCH /projects/{project_id}/members/{id}Update a member's project settings
Phrase::MembersApimembers_listGET /accounts/{account_id}/membersList members
Phrase::NotificationGroupsApinotification_groups_listGET /notification_groupsList notification groups
Phrase::NotificationGroupsApinotification_groups_mark_all_as_readPATCH /notification_groups/mark_all_as_readMark all notification groups as read
Phrase::NotificationGroupsApinotification_groups_mark_as_readPATCH /notification_groups/{id}/mark_as_readMark a notification group as read
Phrase::NotificationsApinotifications_listGET /notificationsList notifications
Phrase::NotificationsApinotifications_mark_all_as_readPOST /notifications/mark_all_as_readMark all notifications as read
Phrase::NotificationsApinotifications_showGET /notifications/{id}Get a single notification
Phrase::OrdersApiorder_confirmPATCH /projects/{project_id}/orders/{id}/confirmConfirm an order
Phrase::OrdersApiorder_createPOST /projects/{project_id}/ordersCreate a new order
Phrase::OrdersApiorder_deleteDELETE /projects/{project_id}/orders/{id}Cancel an order
Phrase::OrdersApiorder_showGET /projects/{project_id}/orders/{id}Get a single order
Phrase::OrdersApiorders_listGET /projects/{project_id}/ordersList orders
Phrase::OrganizationJobTemplateLocalesApiorganization_job_template_locale_deleteDELETE /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}Delete an organization job template locale
Phrase::OrganizationJobTemplateLocalesApiorganization_job_template_locale_showGET /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}Get a single organization job template locale
Phrase::OrganizationJobTemplateLocalesApiorganization_job_template_locale_updatePATCH /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}Update an organization job template locale
Phrase::OrganizationJobTemplateLocalesApiorganization_job_template_locales_createPOST /accounts/{account_id}/job_templates/{job_template_id}/localesCreate an organization job template locale
Phrase::OrganizationJobTemplateLocalesApiorganization_job_template_locales_listGET /accounts/{account_id}/job_templates/{job_template_id}/localesList organization job template locales
Phrase::OrganizationJobTemplatesApiorganization_job_template_createPOST /accounts/{account_id}/job_templatesCreate an organization job template
Phrase::OrganizationJobTemplatesApiorganization_job_template_deleteDELETE /accounts/{account_id}/job_templates/{id}Delete an organization job template
Phrase::OrganizationJobTemplatesApiorganization_job_template_updatePATCH /accounts/{account_id}/job_templates/{id}Update an organization job template
Phrase::OrganizationJobTemplatesApiorganization_job_templates_listGET /accounts/{account_id}/job_templatesList organization job templates
Phrase::OrganizationJobTemplatesApiorganization_job_templates_showGET /accounts/{account_id}/job_templates/{id}Get a single organization job template
Phrase::ProjectsApiproject_createPOST /projectsCreate a project
Phrase::ProjectsApiproject_deleteDELETE /projects/{id}Delete a project
Phrase::ProjectsApiproject_showGET /projects/{id}Get a single project
Phrase::ProjectsApiproject_updatePATCH /projects/{id}Update a project
Phrase::ProjectsApiprojects_listGET /projectsList projects
Phrase::QualityPerformanceScoreApiprojects_quality_performance_scorePOST /projects/{project_id}/quality_performance_scoreGet Translation Quality
Phrase::ReleaseTriggersApirelease_triggers_createPOST /accounts/{account_id}/distributions/{distribution_id}/release_triggersCreate a release trigger
Phrase::ReleaseTriggersApirelease_triggers_destroyDELETE /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}Delete a single release trigger
Phrase::ReleaseTriggersApirelease_triggers_listGET /accounts/{account_id}/distributions/{distribution_id}/release_triggersList release triggers
Phrase::ReleaseTriggersApirelease_triggers_showGET /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}Get a single release trigger
Phrase::ReleaseTriggersApirelease_triggers_updatePATCH /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}Update a release trigger
Phrase::ReleasesApirelease_createPOST /accounts/{account_id}/distributions/{distribution_id}/releasesCreate a release
Phrase::ReleasesApirelease_deleteDELETE /accounts/{account_id}/distributions/{distribution_id}/releases/{id}Delete a release
Phrase::ReleasesApirelease_publishPOST /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publishPublish a release
Phrase::ReleasesApirelease_showGET /accounts/{account_id}/distributions/{distribution_id}/releases/{id}Get a single release
Phrase::ReleasesApirelease_updatePATCH /accounts/{account_id}/distributions/{distribution_id}/releases/{id}Update a release
Phrase::ReleasesApireleases_listGET /accounts/{account_id}/distributions/{distribution_id}/releasesList releases
Phrase::RepoSyncsApirepo_sync_activatePOST /accounts/{account_id}/repo_syncs/{id}/activateActivate a Repo Sync
Phrase::RepoSyncsApirepo_sync_deactivatePOST /accounts/{account_id}/repo_syncs/{id}/deactivateDeactivate a Repo Sync
Phrase::RepoSyncsApirepo_sync_event_showGET /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id}Get a single Repo Sync Event
Phrase::RepoSyncsApirepo_sync_eventsGET /accounts/{account_id}/repo_syncs/{id}/eventsRepository Syncs History
Phrase::RepoSyncsApirepo_sync_exportPOST /accounts/{account_id}/repo_syncs/{id}/exportExport to code repository
Phrase::RepoSyncsApirepo_sync_importPOST /accounts/{account_id}/repo_syncs/{id}/importImport from code repository
Phrase::RepoSyncsApirepo_sync_listGET /accounts/{account_id}/repo_syncsGet Repo Syncs
Phrase::RepoSyncsApirepo_sync_showGET /accounts/{account_id}/repo_syncs/{id}Get a single Repo Sync
Phrase::ReportsApireport_locales_listGET /projects/{project_id}/report/localesList Locale Reports
Phrase::ReportsApireport_showGET /projects/{project_id}/reportGet Project Report
Phrase::ScreenshotMarkersApiscreenshot_marker_createPOST /projects/{project_id}/screenshots/{screenshot_id}/markersCreate a screenshot marker
Phrase::ScreenshotMarkersApiscreenshot_marker_deleteDELETE /projects/{project_id}/screenshots/{screenshot_id}/markersDelete a screenshot marker
Phrase::ScreenshotMarkersApiscreenshot_marker_showGET /projects/{project_id}/screenshots/{screenshot_id}/markers/{id}Get a single screenshot marker
Phrase::ScreenshotMarkersApiscreenshot_marker_updatePATCH /projects/{project_id}/screenshots/{screenshot_id}/markersUpdate a screenshot marker
Phrase::ScreenshotMarkersApiscreenshot_markers_listGET /projects/{project_id}/screenshots/{id}/markersList screenshot markers
Phrase::ScreenshotsApiscreenshot_createPOST /projects/{project_id}/screenshotsCreate a screenshot
Phrase::ScreenshotsApiscreenshot_deleteDELETE /projects/{project_id}/screenshots/{id}Delete a screenshot
Phrase::ScreenshotsApiscreenshot_showGET /projects/{project_id}/screenshots/{id}Get a single screenshot
Phrase::ScreenshotsApiscreenshot_updatePATCH /projects/{project_id}/screenshots/{id}Update a screenshot
Phrase::ScreenshotsApiscreenshots_listGET /projects/{project_id}/screenshotsList screenshots
Phrase::SearchApisearch_in_accountPOST /accounts/{account_id}/searchSearch across projects
Phrase::SpacesApispace_createPOST /accounts/{account_id}/spacesCreate a Space
Phrase::SpacesApispace_deleteDELETE /accounts/{account_id}/spaces/{id}Delete Space
Phrase::SpacesApispace_showGET /accounts/{account_id}/spaces/{id}Get Space
Phrase::SpacesApispace_updatePATCH /accounts/{account_id}/spaces/{id}Update Space
Phrase::SpacesApispaces_listGET /accounts/{account_id}/spacesList Spaces
Phrase::SpacesApispaces_projects_createPOST /accounts/{account_id}/spaces/{space_id}/projectsAdd Project to Space
Phrase::SpacesApispaces_projects_deleteDELETE /accounts/{account_id}/spaces/{space_id}/projects/{id}Remove Project from Space
Phrase::SpacesApispaces_projects_listGET /accounts/{account_id}/spaces/{space_id}/projectsList Projects in Space
Phrase::StyleGuidesApistyleguide_createPOST /projects/{project_id}/styleguidesCreate a style guide
Phrase::StyleGuidesApistyleguide_deleteDELETE /projects/{project_id}/styleguides/{id}Delete a style guide
Phrase::StyleGuidesApistyleguide_showGET /projects/{project_id}/styleguides/{id}Get a single style guide
Phrase::StyleGuidesApistyleguide_updatePATCH /projects/{project_id}/styleguides/{id}Update a style guide
Phrase::StyleGuidesApistyleguides_listGET /projects/{project_id}/styleguidesList style guides
Phrase::TagsApitag_createPOST /projects/{project_id}/tagsCreate a tag
Phrase::TagsApitag_deleteDELETE /projects/{project_id}/tags/{name}Delete a tag
Phrase::TagsApitag_showGET /projects/{project_id}/tags/{name}Get a single tag
Phrase::TagsApitags_listGET /projects/{project_id}/tagsList tags
Phrase::TeamsApiteam_createPOST /accounts/{account_id}/teamsCreate a Team
Phrase::TeamsApiteam_deleteDELETE /accounts/{account_id}/teams/{id}Delete Team
Phrase::TeamsApiteam_showGET /accounts/{account_id}/teams/{id}Get Team
Phrase::TeamsApiteam_updatePATCH /accounts/{account_id}/teams/{id}Update Team
Phrase::TeamsApiteams_listGET /accounts/{account_id}/teamsList Teams
Phrase::TeamsApiteams_projects_createPOST /accounts/{account_id}/teams/{team_id}/projectsAdd Project to Team
Phrase::TeamsApiteams_projects_deleteDELETE /accounts/{account_id}/teams/{team_id}/projects/{id}Remove Project from Team
Phrase::TeamsApiteams_spaces_createPOST /accounts/{account_id}/teams/{team_id}/spacesAdd Space
Phrase::TeamsApiteams_spaces_deleteDELETE /accounts/{account_id}/teams/{team_id}/spaces/{id}Remove Space
Phrase::TeamsApiteams_users_createPOST /accounts/{account_id}/teams/{team_id}/usersAdd User
Phrase::TeamsApiteams_users_deleteDELETE /accounts/{account_id}/teams/{team_id}/users/{id}Remove User
Phrase::TranslationsApitranslation_createPOST /projects/{project_id}/translationsCreate a translation
Phrase::TranslationsApitranslation_excludePATCH /projects/{project_id}/translations/{id}/excludeExclude a translation from export
Phrase::TranslationsApitranslation_includePATCH /projects/{project_id}/translations/{id}/includeInclude a translation
Phrase::TranslationsApitranslation_reviewPATCH /projects/{project_id}/translations/{id}/reviewReview a translation
Phrase::TranslationsApitranslation_showGET /projects/{project_id}/translations/{id}Get a single translation
Phrase::TranslationsApitranslation_unverifyPATCH /projects/{project_id}/translations/{id}/unverifyMark a translation as unverified
Phrase::TranslationsApitranslation_updatePATCH /projects/{project_id}/translations/{id}Update a translation
Phrase::TranslationsApitranslation_verifyPATCH /projects/{project_id}/translations/{id}/verifyVerify a translation
Phrase::TranslationsApitranslations_by_keyGET /projects/{project_id}/keys/{key_id}/translationsList translations by key
Phrase::TranslationsApitranslations_by_localeGET /projects/{project_id}/locales/{locale_id}/translationsList translations by locale
Phrase::TranslationsApitranslations_exclude_collectionPATCH /projects/{project_id}/translations/excludeExclude translations by query
Phrase::TranslationsApitranslations_include_collectionPATCH /projects/{project_id}/translations/includeInclude translations by query
Phrase::TranslationsApitranslations_listGET /projects/{project_id}/translationsList all translations
Phrase::TranslationsApitranslations_review_collectionPATCH /projects/{project_id}/translations/reviewReview translations selected by query
Phrase::TranslationsApitranslations_searchPOST /projects/{project_id}/translations/searchSearch translations
Phrase::TranslationsApitranslations_unverify_collectionPATCH /projects/{project_id}/translations/unverifyUnverify translations by query
Phrase::TranslationsApitranslations_verify_collectionPATCH /projects/{project_id}/translations/verifyVerify translations by query
Phrase::UploadsApiupload_createPOST /projects/{project_id}/uploadsUpload a new file
Phrase::UploadsApiupload_showGET /projects/{project_id}/uploads/{id}Get a single upload
Phrase::UploadsApiuploads_listGET /projects/{project_id}/uploadsList uploads
Phrase::UsersApishow_userGET /userShow current User
Phrase::VariablesApivariable_createPOST /projects/{project_id}/variablesCreate a variable
Phrase::VariablesApivariable_deleteDELETE /projects/{project_id}/variables/{name}Delete a variable
Phrase::VariablesApivariable_showGET /projects/{project_id}/variables/{name}Get a single variable
Phrase::VariablesApivariable_updatePATCH /projects/{project_id}/variables/{name}Update a variable
Phrase::VariablesApivariables_listGET /projects/{project_id}/variablesList variables
Phrase::VersionsHistoryApiversion_showGET /projects/{project_id}/translations/{translation_id}/versions/{id}Get a single version
Phrase::VersionsHistoryApiversions_listGET /projects/{project_id}/translations/{translation_id}/versionsList all versions
Phrase::WebhookDeliveriesApiwebhook_deliveries_listGET /projects/{project_id}/webhooks/{webhook_id}/deliveriesList webhook deliveries
Phrase::WebhookDeliveriesApiwebhook_deliveries_redeliverPOST /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliverRedeliver a single webhook delivery
Phrase::WebhookDeliveriesApiwebhook_deliveries_showGET /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}Get a single webhook delivery
Phrase::WebhooksApiwebhook_createPOST /projects/{project_id}/webhooksCreate a webhook
Phrase::WebhooksApiwebhook_deleteDELETE /projects/{project_id}/webhooks/{id}Delete a webhook
Phrase::WebhooksApiwebhook_showGET /projects/{project_id}/webhooks/{id}Get a single webhook
Phrase::WebhooksApiwebhook_testPOST /projects/{project_id}/webhooks/{id}/testTest a webhook
Phrase::WebhooksApiwebhook_updatePATCH /projects/{project_id}/webhooks/{id}Update a webhook
Phrase::WebhooksApiwebhooks_listGET /projects/{project_id}/webhooksList webhooks

Documentation for Models

Documentation for Authorization

Token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Basic

  • Type: HTTP basic authentication

FAQs

Package last updated on 03 Dec 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc