Skip to content

phrase/phrase-ruby

BranchesTags

Repository files navigation

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.6.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.6.0.gem

(for development, run gem install --dev ./phrase-3.6.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 [email protected] 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

Class Method HTTP request Description
Phrase::AccountsApi account_show GET /accounts/{id} Get a single account
Phrase::AccountsApi accounts_list GET /accounts List accounts
Phrase::AuthorizationsApi authorization_create POST /authorizations Create an authorization
Phrase::AuthorizationsApi authorization_delete DELETE /authorizations/{id} Delete an authorization
Phrase::AuthorizationsApi authorization_show GET /authorizations/{id} Get a single authorization
Phrase::AuthorizationsApi authorization_update PATCH /authorizations/{id} Update an authorization
Phrase::AuthorizationsApi authorizations_list GET /authorizations List authorizations
Phrase::BitbucketSyncApi bitbucket_sync_export POST /bitbucket_syncs/{id}/export Export from Phrase Strings to Bitbucket
Phrase::BitbucketSyncApi bitbucket_sync_import POST /bitbucket_syncs/{id}/import Import to Phrase Strings from Bitbucket
Phrase::BitbucketSyncApi bitbucket_syncs_list GET /bitbucket_syncs List Bitbucket syncs
Phrase::BlacklistedKeysApi blacklisted_key_create POST /projects/{project_id}/blacklisted_keys Create a blocked key
Phrase::BlacklistedKeysApi blacklisted_key_delete DELETE /projects/{project_id}/blacklisted_keys/{id} Delete a blocked key
Phrase::BlacklistedKeysApi blacklisted_key_show GET /projects/{project_id}/blacklisted_keys/{id} Get a single blocked key
Phrase::BlacklistedKeysApi blacklisted_key_update PATCH /projects/{project_id}/blacklisted_keys/{id} Update a blocked key
Phrase::BlacklistedKeysApi blacklisted_keys_list GET /projects/{project_id}/blacklisted_keys List blocked keys
Phrase::BranchesApi branch_compare GET /projects/{project_id}/branches/{name}/compare Compare branches
Phrase::BranchesApi branch_create POST /projects/{project_id}/branches Create a branch
Phrase::BranchesApi branch_delete DELETE /projects/{project_id}/branches/{name} Delete a branch
Phrase::BranchesApi branch_merge PATCH /projects/{project_id}/branches/{name}/merge Merge a branch
Phrase::BranchesApi branch_show GET /projects/{project_id}/branches/{name} Get a single branch
Phrase::BranchesApi branch_update PATCH /projects/{project_id}/branches/{name} Update a branch
Phrase::BranchesApi branches_list GET /projects/{project_id}/branches List branches
Phrase::CommentReactionsApi reaction_create POST /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions Create a reaction
Phrase::CommentReactionsApi reaction_delete DELETE /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} Delete a reaction
Phrase::CommentReactionsApi reaction_show GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} Get a single reaction
Phrase::CommentReactionsApi reactions_list GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions List reactions
Phrase::CommentRepliesApi replies_list GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies List replies
Phrase::CommentRepliesApi reply_create POST /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies Create a reply
Phrase::CommentRepliesApi reply_delete DELETE /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} Delete a reply
Phrase::CommentRepliesApi reply_mark_as_read PATCH /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read Mark a reply as read
Phrase::CommentRepliesApi reply_mark_as_unread PATCH /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread Mark a reply as unread
Phrase::CommentRepliesApi reply_show GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} Get a single reply
Phrase::CommentsApi comment_create POST /projects/{project_id}/keys/{key_id}/comments Create a comment
Phrase::CommentsApi comment_delete DELETE /projects/{project_id}/keys/{key_id}/comments/{id} Delete a comment
Phrase::CommentsApi comment_mark_check GET /projects/{project_id}/keys/{key_id}/comments/{id}/read Check if comment is read
Phrase::CommentsApi comment_mark_read PATCH /projects/{project_id}/keys/{key_id}/comments/{id}/read Mark a comment as read
Phrase::CommentsApi comment_mark_unread DELETE /projects/{project_id}/keys/{key_id}/comments/{id}/read Mark a comment as unread
Phrase::CommentsApi comment_show GET /projects/{project_id}/keys/{key_id}/comments/{id} Get a single comment
Phrase::CommentsApi comment_update PATCH /projects/{project_id}/keys/{key_id}/comments/{id} Update a comment
Phrase::CommentsApi comments_list GET /projects/{project_id}/keys/{key_id}/comments List comments
Phrase::CustomMetadataApi custom_metadata_properties_delete DELETE /accounts/{account_id}/custom_metadata/properties/{id} Destroy property
Phrase::CustomMetadataApi custom_metadata_properties_list GET /accounts/{account_id}/custom_metadata/properties List properties
Phrase::CustomMetadataApi custom_metadata_property_create POST /accounts/{account_id}/custom_metadata/properties Create a property
Phrase::CustomMetadataApi custom_metadata_property_show GET /accounts/{account_id}/custom_metadata/properties/{id} Get a single property
Phrase::CustomMetadataApi custom_metadata_property_update PATCH /accounts/{account_id}/custom_metadata/properties/{id} Update a property
Phrase::DistributionsApi distribution_create POST /accounts/{account_id}/distributions Create a distribution
Phrase::DistributionsApi distribution_delete DELETE /accounts/{account_id}/distributions/{id} Delete a distribution
Phrase::DistributionsApi distribution_show GET /accounts/{account_id}/distributions/{id} Get a single distribution
Phrase::DistributionsApi distribution_update PATCH /accounts/{account_id}/distributions/{id} Update a distribution
Phrase::DistributionsApi distributions_list GET /accounts/{account_id}/distributions List distributions
Phrase::DocumentsApi document_delete DELETE /projects/{project_id}/documents/{id} Delete document
Phrase::DocumentsApi documents_list GET /projects/{project_id}/documents List documents
Phrase::FigmaAttachmentsApi figma_attachment_create POST /projects/{project_id}/figma_attachments Create a Figma attachment
Phrase::FigmaAttachmentsApi figma_attachment_delete DELETE /projects/{project_id}/figma_attachments/{id} Delete a Figma attachment
Phrase::FigmaAttachmentsApi figma_attachment_show GET /projects/{project_id}/figma_attachments/{id} Get a single Figma attachment
Phrase::FigmaAttachmentsApi figma_attachment_update PATCH /projects/{project_id}/figma_attachments/{id} Update a Figma attachment
Phrase::FigmaAttachmentsApi figma_attachments_list GET /projects/{project_id}/figma_attachments List Figma attachments
Phrase::FormatsApi formats_list GET /formats List formats
Phrase::GitHubSyncApi github_sync_export POST /github_syncs/export Export from Phrase Strings to GitHub
Phrase::GitHubSyncApi github_sync_import POST /github_syncs/import Import to Phrase Strings from GitHub
Phrase::GitLabSyncApi gitlab_sync_delete DELETE /gitlab_syncs/{id} Delete single Sync Setting
Phrase::GitLabSyncApi gitlab_sync_export POST /gitlab_syncs/{gitlab_sync_id}/export Export from Phrase Strings to GitLab
Phrase::GitLabSyncApi gitlab_sync_history GET /gitlab_syncs/{gitlab_sync_id}/history History of single Sync Setting
Phrase::GitLabSyncApi gitlab_sync_import POST /gitlab_syncs/{gitlab_sync_id}/import Import from GitLab to Phrase
Phrase::GitLabSyncApi gitlab_sync_list GET /gitlab_syncs List GitLab syncs
Phrase::GitLabSyncApi gitlab_sync_show GET /gitlab_syncs/{id} Get single Sync Setting
Phrase::GitLabSyncApi gitlab_sync_update PUT /gitlab_syncs/{id} Update single Sync Setting
Phrase::GlossariesApi glossaries_list GET /accounts/{account_id}/glossaries List term bases
Phrase::GlossariesApi glossary_create POST /accounts/{account_id}/glossaries Create a term base
Phrase::GlossariesApi glossary_delete DELETE /accounts/{account_id}/glossaries/{id} Delete a term base
Phrase::GlossariesApi glossary_show GET /accounts/{account_id}/glossaries/{id} Get a single term base
Phrase::GlossariesApi glossary_update PATCH /accounts/{account_id}/glossaries/{id} Update a term base
Phrase::GlossaryTermTranslationsApi glossary_term_translation_create POST /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations Create a translation for a term
Phrase::GlossaryTermTranslationsApi glossary_term_translation_delete DELETE /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id} Delete a translation for a term
Phrase::GlossaryTermTranslationsApi glossary_term_translation_update PATCH /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id} Update a translation for a term
Phrase::GlossaryTermsApi glossary_term_create POST /accounts/{account_id}/glossaries/{glossary_id}/terms Create a term
Phrase::GlossaryTermsApi glossary_term_delete DELETE /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Delete a term
Phrase::GlossaryTermsApi glossary_term_show GET /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Get a single term
Phrase::GlossaryTermsApi glossary_term_update PATCH /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Update a term
Phrase::GlossaryTermsApi glossary_terms_list GET /accounts/{account_id}/glossaries/{glossary_id}/terms List terms
Phrase::ICUApi icu_skeleton POST /icu/skeleton Build ICU skeletons
Phrase::InvitationsApi invitation_create POST /accounts/{account_id}/invitations Create a new invitation
Phrase::InvitationsApi invitation_delete DELETE /accounts/{account_id}/invitations/{id} Delete an invitation
Phrase::InvitationsApi invitation_resend POST /accounts/{account_id}/invitations/{id}/resend Resend an invitation
Phrase::InvitationsApi invitation_show GET /accounts/{account_id}/invitations/{id} Get a single invitation
Phrase::InvitationsApi invitation_update PATCH /accounts/{account_id}/invitations/{id} Update an invitation
Phrase::InvitationsApi invitation_update_settings PATCH /projects/{project_id}/invitations/{id} Update a member's invitation access
Phrase::InvitationsApi invitations_list GET /accounts/{account_id}/invitations List invitations
Phrase::JobCommentsApi job_comment_create POST /projects/{project_id}/jobs/{job_id}/comments Create a job comment
Phrase::JobCommentsApi job_comment_delete DELETE /projects/{project_id}/jobs/{job_id}/comments/{id} Delete a job comment
Phrase::JobCommentsApi job_comment_show GET /projects/{project_id}/jobs/{job_id}/comments/{id} Get a single job comment
Phrase::JobCommentsApi job_comment_update PATCH /projects/{project_id}/jobs/{job_id}/comments/{id} Update a job comment
Phrase::JobCommentsApi job_comments_list GET /projects/{project_id}/jobs/{job_id}/comments List job comments
Phrase::JobLocalesApi job_locale_complete POST /projects/{project_id}/jobs/{job_id}/locales/{id}/complete Complete a job locale
Phrase::JobLocalesApi job_locale_complete_review POST /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review Review a job locale
Phrase::JobLocalesApi job_locale_delete DELETE /projects/{project_id}/jobs/{job_id}/locales/{id} Remove a target locale from a job
Phrase::JobLocalesApi job_locale_reopen POST /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen Reopen a job locale
Phrase::JobLocalesApi job_locale_show GET /projects/{project_id}/jobs/{job_id}/locales/{id} Show single job target locale
Phrase::JobLocalesApi job_locale_update PATCH /projects/{project_id}/jobs/{job_id}/locales/{id} Update a job target locale
Phrase::JobLocalesApi job_locales_create POST /projects/{project_id}/jobs/{job_id}/locales Add a target locale to a job
Phrase::JobLocalesApi job_locales_list GET /projects/{project_id}/jobs/{job_id}/locales List job target locales
Phrase::JobTemplateLocalesApi job_template_locale_delete DELETE /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Delete a job template locale
Phrase::JobTemplateLocalesApi job_template_locale_show GET /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Get a single job template locale
Phrase::JobTemplateLocalesApi job_template_locale_update PATCH /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Update a job template locale
Phrase::JobTemplateLocalesApi job_template_locales_create POST /projects/{project_id}/job_templates/{job_template_id}/locales Create a job template locale
Phrase::JobTemplateLocalesApi job_template_locales_list GET /projects/{project_id}/job_templates/{job_template_id}/locales List job template locales
Phrase::JobTemplatesApi job_template_create POST /projects/{project_id}/job_templates Create a job template
Phrase::JobTemplatesApi job_template_delete DELETE /projects/{project_id}/job_templates/{id} Delete a job template
Phrase::JobTemplatesApi job_template_update PATCH /projects/{project_id}/job_templates/{id} Update a job template
Phrase::JobTemplatesApi job_templates_list GET /projects/{project_id}/job_templates List job templates
Phrase::JobTemplatesApi job_templates_show GET /projects/{project_id}/job_templates/{id} Get a single job template
Phrase::JobsApi job_complete POST /projects/{project_id}/jobs/{id}/complete Complete a job
Phrase::JobsApi job_create POST /projects/{project_id}/jobs Create a job
Phrase::JobsApi job_delete DELETE /projects/{project_id}/jobs/{id} Delete a job
Phrase::JobsApi job_keys_create POST /projects/{project_id}/jobs/{id}/keys Add keys to job
Phrase::JobsApi job_keys_delete DELETE /projects/{project_id}/jobs/{id}/keys Remove keys from job
Phrase::JobsApi job_lock POST /projects/{project_id}/jobs/{id}/lock Lock a job
Phrase::JobsApi job_reopen POST /projects/{project_id}/jobs/{id}/reopen Reopen a job
Phrase::JobsApi job_show GET /projects/{project_id}/jobs/{id} Get a single job
Phrase::JobsApi job_start POST /projects/{project_id}/jobs/{id}/start Start a job
Phrase::JobsApi job_unlock POST /projects/{project_id}/jobs/{id}/unlock Unlock a job
Phrase::JobsApi job_update PATCH /projects/{project_id}/jobs/{id} Update a job
Phrase::JobsApi jobs_by_account GET /accounts/{account_id}/jobs List account jobs
Phrase::JobsApi jobs_list GET /projects/{project_id}/jobs List jobs
Phrase::KeysApi key_create POST /projects/{project_id}/keys Create a key
Phrase::KeysApi key_delete DELETE /projects/{project_id}/keys/{id} Delete a key
Phrase::KeysApi key_show GET /projects/{project_id}/keys/{id} Get a single key
Phrase::KeysApi key_update PATCH /projects/{project_id}/keys/{id} Update a key
Phrase::KeysApi keys_delete_collection DELETE /projects/{project_id}/keys Delete collection of keys
Phrase::KeysApi keys_exclude PATCH /projects/{project_id}/keys/exclude Exclude a locale on a collection of keys
Phrase::KeysApi keys_include PATCH /projects/{project_id}/keys/include Include a locale on a collection of keys
Phrase::KeysApi keys_list GET /projects/{project_id}/keys List keys
Phrase::KeysApi keys_search POST /projects/{project_id}/keys/search Search keys
Phrase::KeysApi keys_tag PATCH /projects/{project_id}/keys/tag Add tags to collection of keys
Phrase::KeysApi keys_untag PATCH /projects/{project_id}/keys/untag Remove tags from collection of keys
Phrase::KeysFigmaAttachmentsApi figma_attachment_attach_to_key POST /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys Attach the Figma attachment to a key
Phrase::KeysFigmaAttachmentsApi figma_attachment_detach_from_key DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} Detach the Figma attachment from a key
Phrase::LinkedKeysApi key_links_batch_destroy DELETE /projects/{project_id}/keys/{id}/key_links Batch unlink child keys from a parent key
Phrase::LinkedKeysApi key_links_create POST /projects/{project_id}/keys/{id}/key_links Link child keys to a parent key
Phrase::LinkedKeysApi key_links_destroy DELETE /projects/{project_id}/keys/{id}/key_links/{child_key_id} Unlink a child key from a parent key
Phrase::LinkedKeysApi key_links_index GET /projects/{project_id}/keys/{id}/key_links List child keys of a parent key
Phrase::LocaleDownloadsApi locale_download_create POST /projects/{project_id}/locales/{locale_id}/downloads Initiate async download of a locale
Phrase::LocaleDownloadsApi locale_download_show GET /projects/{project_id}/locales/{locale_id}/downloads/{id} Show status of an async locale download
Phrase::LocalesApi account_locales GET /accounts/{id}/locales List locales used in account
Phrase::LocalesApi locale_create POST /projects/{project_id}/locales Create a locale
Phrase::LocalesApi locale_delete DELETE /projects/{project_id}/locales/{id} Delete a locale
Phrase::LocalesApi locale_download GET /projects/{project_id}/locales/{id}/download Download a locale
Phrase::LocalesApi locale_show GET /projects/{project_id}/locales/{id} Get a single locale
Phrase::LocalesApi locale_update PATCH /projects/{project_id}/locales/{id} Update a locale
Phrase::LocalesApi locales_list GET /projects/{project_id}/locales List locales
Phrase::MembersApi member_delete DELETE /accounts/{account_id}/members/{id} Remove a user from the account
Phrase::MembersApi member_show GET /accounts/{account_id}/members/{id} Get single member
Phrase::MembersApi member_update PATCH /accounts/{account_id}/members/{id} Update a member
Phrase::MembersApi member_update_settings PATCH /projects/{project_id}/members/{id} Update a member's project settings
Phrase::MembersApi members_list GET /accounts/{account_id}/members List members
Phrase::NotificationGroupsApi notification_groups_list GET /notification_groups List notification groups
Phrase::NotificationGroupsApi notification_groups_mark_all_as_read PATCH /notification_groups/mark_all_as_read Mark all notification groups as read
Phrase::NotificationGroupsApi notification_groups_mark_as_read PATCH /notification_groups/{id}/mark_as_read Mark a notification group as read
Phrase::NotificationsApi notifications_list GET /notifications List notifications
Phrase::NotificationsApi notifications_mark_all_as_read POST /notifications/mark_all_as_read Mark all notifications as read
Phrase::NotificationsApi notifications_show GET /notifications/{id} Get a single notification
Phrase::OrdersApi order_confirm PATCH /projects/{project_id}/orders/{id}/confirm Confirm an order
Phrase::OrdersApi order_create POST /projects/{project_id}/orders Create a new order
Phrase::OrdersApi order_delete DELETE /projects/{project_id}/orders/{id} Cancel an order
Phrase::OrdersApi order_show GET /projects/{project_id}/orders/{id} Get a single order
Phrase::OrdersApi orders_list GET /projects/{project_id}/orders List orders
Phrase::OrganizationJobTemplateLocalesApi organization_job_template_locale_delete DELETE /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Delete an organization job template locale
Phrase::OrganizationJobTemplateLocalesApi organization_job_template_locale_show GET /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Get a single organization job template locale
Phrase::OrganizationJobTemplateLocalesApi organization_job_template_locale_update PATCH /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Update an organization job template locale
Phrase::OrganizationJobTemplateLocalesApi organization_job_template_locales_create POST /accounts/{account_id}/job_templates/{job_template_id}/locales Create an organization job template locale
Phrase::OrganizationJobTemplateLocalesApi organization_job_template_locales_list GET /accounts/{account_id}/job_templates/{job_template_id}/locales List organization job template locales
Phrase::OrganizationJobTemplatesApi organization_job_template_create POST /accounts/{account_id}/job_templates Create an organization job template
Phrase::OrganizationJobTemplatesApi organization_job_template_delete DELETE /accounts/{account_id}/job_templates/{id} Delete an organization job template
Phrase::OrganizationJobTemplatesApi organization_job_template_update PATCH /accounts/{account_id}/job_templates/{id} Update an organization job template
Phrase::OrganizationJobTemplatesApi organization_job_templates_list GET /accounts/{account_id}/job_templates List organization job templates
Phrase::OrganizationJobTemplatesApi organization_job_templates_show GET /accounts/{account_id}/job_templates/{id} Get a single organization job template
Phrase::ProjectsApi project_create POST /projects Create a project
Phrase::ProjectsApi project_delete DELETE /projects/{id} Delete a project
Phrase::ProjectsApi project_show GET /projects/{id} Get a single project
Phrase::ProjectsApi project_update PATCH /projects/{id} Update a project
Phrase::ProjectsApi projects_list GET /projects List projects
Phrase::QualityPerformanceScoreApi projects_quality_performance_score POST /projects/{project_id}/quality_performance_score Get Translation Quality
Phrase::ReleaseTriggersApi release_triggers_create POST /accounts/{account_id}/distributions/{distribution_id}/release_triggers Create a release trigger
Phrase::ReleaseTriggersApi release_triggers_destroy DELETE /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} Delete a single release trigger
Phrase::ReleaseTriggersApi release_triggers_list GET /accounts/{account_id}/distributions/{distribution_id}/release_triggers List release triggers
Phrase::ReleaseTriggersApi release_triggers_show GET /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} Get a single release trigger
Phrase::ReleaseTriggersApi release_triggers_update PATCH /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id} Update a release trigger
Phrase::ReleasesApi release_create POST /accounts/{account_id}/distributions/{distribution_id}/releases Create a release
Phrase::ReleasesApi release_delete DELETE /accounts/{account_id}/distributions/{distribution_id}/releases/{id} Delete a release
Phrase::ReleasesApi release_publish POST /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish Publish a release
Phrase::ReleasesApi release_show GET /accounts/{account_id}/distributions/{distribution_id}/releases/{id} Get a single release
Phrase::ReleasesApi release_update PATCH /accounts/{account_id}/distributions/{distribution_id}/releases/{id} Update a release
Phrase::ReleasesApi releases_list GET /accounts/{account_id}/distributions/{distribution_id}/releases List releases
Phrase::RepoSyncsApi repo_sync_activate POST /accounts/{account_id}/repo_syncs/{id}/activate Activate a Repo Sync
Phrase::RepoSyncsApi repo_sync_deactivate POST /accounts/{account_id}/repo_syncs/{id}/deactivate Deactivate a Repo Sync
Phrase::RepoSyncsApi repo_sync_event_show GET /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} Get a single Repo Sync Event
Phrase::RepoSyncsApi repo_sync_events GET /accounts/{account_id}/repo_syncs/{id}/events Repository Syncs History
Phrase::RepoSyncsApi repo_sync_export POST /accounts/{account_id}/repo_syncs/{id}/export Export to code repository
Phrase::RepoSyncsApi repo_sync_import POST /accounts/{account_id}/repo_syncs/{id}/import Import from code repository
Phrase::RepoSyncsApi repo_sync_list GET /accounts/{account_id}/repo_syncs Get Repo Syncs
Phrase::RepoSyncsApi repo_sync_show GET /accounts/{account_id}/repo_syncs/{id} Get a single Repo Sync
Phrase::ReportsApi report_locales_list GET /projects/{project_id}/report/locales List Locale Reports
Phrase::ReportsApi report_show GET /projects/{project_id}/report Get Project Report
Phrase::ScreenshotMarkersApi screenshot_marker_create POST /projects/{project_id}/screenshots/{screenshot_id}/markers Create a screenshot marker
Phrase::ScreenshotMarkersApi screenshot_marker_delete DELETE /projects/{project_id}/screenshots/{screenshot_id}/markers Delete a screenshot marker
Phrase::ScreenshotMarkersApi screenshot_marker_show GET /projects/{project_id}/screenshots/{screenshot_id}/markers/{id} Get a single screenshot marker
Phrase::ScreenshotMarkersApi screenshot_marker_update PATCH /projects/{project_id}/screenshots/{screenshot_id}/markers Update a screenshot marker
Phrase::ScreenshotMarkersApi screenshot_markers_list GET /projects/{project_id}/screenshots/{id}/markers List screenshot markers
Phrase::ScreenshotsApi screenshot_create POST /projects/{project_id}/screenshots Create a screenshot
Phrase::ScreenshotsApi screenshot_delete DELETE /projects/{project_id}/screenshots/{id} Delete a screenshot
Phrase::ScreenshotsApi screenshot_show GET /projects/{project_id}/screenshots/{id} Get a single screenshot
Phrase::ScreenshotsApi screenshot_update PATCH /projects/{project_id}/screenshots/{id} Update a screenshot
Phrase::ScreenshotsApi screenshots_list GET /projects/{project_id}/screenshots List screenshots
Phrase::SearchApi search_in_account POST /accounts/{account_id}/search Search across projects
Phrase::SpacesApi space_create POST /accounts/{account_id}/spaces Create a Space
Phrase::SpacesApi space_delete DELETE /accounts/{account_id}/spaces/{id} Delete Space
Phrase::SpacesApi space_show GET /accounts/{account_id}/spaces/{id} Get Space
Phrase::SpacesApi space_update PATCH /accounts/{account_id}/spaces/{id} Update Space
Phrase::SpacesApi spaces_list GET /accounts/{account_id}/spaces List Spaces
Phrase::SpacesApi spaces_projects_create POST /accounts/{account_id}/spaces/{space_id}/projects Add Project to Space
Phrase::SpacesApi spaces_projects_delete DELETE /accounts/{account_id}/spaces/{space_id}/projects/{id} Remove Project from Space
Phrase::SpacesApi spaces_projects_list GET /accounts/{account_id}/spaces/{space_id}/projects List Projects in Space
Phrase::StyleGuidesApi styleguide_create POST /projects/{project_id}/styleguides Create a style guide
Phrase::StyleGuidesApi styleguide_delete DELETE /projects/{project_id}/styleguides/{id} Delete a style guide
Phrase::StyleGuidesApi styleguide_show GET /projects/{project_id}/styleguides/{id} Get a single style guide
Phrase::StyleGuidesApi styleguide_update PATCH /projects/{project_id}/styleguides/{id} Update a style guide
Phrase::StyleGuidesApi styleguides_list GET /projects/{project_id}/styleguides List style guides
Phrase::TagsApi tag_create POST /projects/{project_id}/tags Create a tag
Phrase::TagsApi tag_delete DELETE /projects/{project_id}/tags/{name} Delete a tag
Phrase::TagsApi tag_show GET /projects/{project_id}/tags/{name} Get a single tag
Phrase::TagsApi tags_list GET /projects/{project_id}/tags List tags
Phrase::TeamsApi team_create POST /accounts/{account_id}/teams Create a Team
Phrase::TeamsApi team_delete DELETE /accounts/{account_id}/teams/{id} Delete Team
Phrase::TeamsApi team_show GET /accounts/{account_id}/teams/{id} Get Team
Phrase::TeamsApi team_update PATCH /accounts/{account_id}/teams/{id} Update Team
Phrase::TeamsApi teams_list GET /accounts/{account_id}/teams List Teams
Phrase::TeamsApi teams_projects_create POST /accounts/{account_id}/teams/{team_id}/projects Add Project to Team
Phrase::TeamsApi teams_projects_delete DELETE /accounts/{account_id}/teams/{team_id}/projects/{id} Remove Project from Team
Phrase::TeamsApi teams_spaces_create POST /accounts/{account_id}/teams/{team_id}/spaces Add Space
Phrase::TeamsApi teams_spaces_delete DELETE /accounts/{account_id}/teams/{team_id}/spaces/{id} Remove Space
Phrase::TeamsApi teams_users_create POST /accounts/{account_id}/teams/{team_id}/users Add User
Phrase::TeamsApi teams_users_delete DELETE /accounts/{account_id}/teams/{team_id}/users/{id} Remove User
Phrase::TranslationsApi translation_create POST /projects/{project_id}/translations Create a translation
Phrase::TranslationsApi translation_exclude PATCH /projects/{project_id}/translations/{id}/exclude Exclude a translation from export
Phrase::TranslationsApi translation_include PATCH /projects/{project_id}/translations/{id}/include Include a translation
Phrase::TranslationsApi translation_review PATCH /projects/{project_id}/translations/{id}/review Review a translation
Phrase::TranslationsApi translation_show GET /projects/{project_id}/translations/{id} Get a single translation
Phrase::TranslationsApi translation_unverify PATCH /projects/{project_id}/translations/{id}/unverify Mark a translation as unverified
Phrase::TranslationsApi translation_update PATCH /projects/{project_id}/translations/{id} Update a translation
Phrase::TranslationsApi translation_verify PATCH /projects/{project_id}/translations/{id}/verify Verify a translation
Phrase::TranslationsApi translations_by_key GET /projects/{project_id}/keys/{key_id}/translations List translations by key
Phrase::TranslationsApi translations_by_locale GET /projects/{project_id}/locales/{locale_id}/translations List translations by locale
Phrase::TranslationsApi translations_exclude_collection PATCH /projects/{project_id}/translations/exclude Exclude translations by query
Phrase::TranslationsApi translations_include_collection PATCH /projects/{project_id}/translations/include Include translations by query
Phrase::TranslationsApi translations_list GET /projects/{project_id}/translations List all translations
Phrase::TranslationsApi translations_review_collection PATCH /projects/{project_id}/translations/review Review translations selected by query
Phrase::TranslationsApi translations_search POST /projects/{project_id}/translations/search Search translations
Phrase::TranslationsApi translations_unverify_collection PATCH /projects/{project_id}/translations/unverify Unverify translations by query
Phrase::TranslationsApi translations_verify_collection PATCH /projects/{project_id}/translations/verify Verify translations by query
Phrase::UploadsApi upload_create POST /projects/{project_id}/uploads Upload a new file
Phrase::UploadsApi upload_show GET /projects/{project_id}/uploads/{id} Get a single upload
Phrase::UploadsApi uploads_list GET /projects/{project_id}/uploads List uploads
Phrase::UsersApi show_user GET /user Show current User
Phrase::VariablesApi variable_create POST /projects/{project_id}/variables Create a variable
Phrase::VariablesApi variable_delete DELETE /projects/{project_id}/variables/{name} Delete a variable
Phrase::VariablesApi variable_show GET /projects/{project_id}/variables/{name} Get a single variable
Phrase::VariablesApi variable_update PATCH /projects/{project_id}/variables/{name} Update a variable
Phrase::VariablesApi variables_list GET /projects/{project_id}/variables List variables
Phrase::VersionsHistoryApi version_show GET /projects/{project_id}/translations/{translation_id}/versions/{id} Get a single version
Phrase::VersionsHistoryApi versions_list GET /projects/{project_id}/translations/{translation_id}/versions List all versions
Phrase::WebhookDeliveriesApi webhook_deliveries_list GET /projects/{project_id}/webhooks/{webhook_id}/deliveries List webhook deliveries
Phrase::WebhookDeliveriesApi webhook_deliveries_redeliver POST /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliver Redeliver a single webhook delivery
Phrase::WebhookDeliveriesApi webhook_deliveries_show GET /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id} Get a single webhook delivery
Phrase::WebhooksApi webhook_create POST /projects/{project_id}/webhooks Create a webhook
Phrase::WebhooksApi webhook_delete DELETE /projects/{project_id}/webhooks/{id} Delete a webhook
Phrase::WebhooksApi webhook_show GET /projects/{project_id}/webhooks/{id} Get a single webhook
Phrase::WebhooksApi webhook_test POST /projects/{project_id}/webhooks/{id}/test Test a webhook
Phrase::WebhooksApi webhook_update PATCH /projects/{project_id}/webhooks/{id} Update a webhook
Phrase::WebhooksApi webhooks_list GET /projects/{project_id}/webhooks List webhooks

Documentation for Models

Documentation for Authorization

Token

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

Basic

  • Type: HTTP basic authentication

About

auto-generated Ruby API client for Phrase

developers.phrase.com/api/

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

3 stars

Watchers

16 watching

Forks

9 forks
Report repository

Releases 61

3.6.0 Latest
Oct 2, 2024
+ 60 releases

Packages

 
 
 

Contributors 2

  •  
  •  

Languages