phrase-java

Phrase Strings API Reference

• API version: 2.0.0
• Package version: 3.23.0

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.

For more information, please visit https://developers.phrase.com/api/

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven/Gradle

Installation

Maven users

Add this dependency to your project's POM:

<dependency>
<groupId>com.phrase</groupId>
<artifactId>phrase-java</artifactId>
<version>3.23.0</version>
<scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.phrase:phrase-java:3.23.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/phrase-java-3.23.0.jar
• target/lib/*.jar

Github package repository

Currently the packages are also automatically deployed to Github package repository, so that you don't need to build them yourself. Follow this guide to set it up in your project.

Getting Started

Please follow the installation instruction and execute the following Java code:

importcom.phrase.client.*;
importcom.phrase.client.auth.*;
importcom.phrase.client.model.*;
importcom.phrase.client.api.AccountsApi;
publicclassAccountsApiExample {
publicstaticvoidmain(String[] args) {
ApiClientdefaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.phrase.com/v2");
// Configure HTTP basic authorization: BasicHttpBasicAuthBasic = (HttpBasicAuth) defaultClient.getAuthentication("Basic");
Basic.setUsername("YOUR USERNAME");
Basic.setPassword("YOUR PASSWORD");
// Configure API key authorization: TokenApiKeyAuthToken = (ApiKeyAuth) defaultClient.getAuthentication("Token");
Token.setApiKey("YOUR API KEY");
Token.setApiKeyPrefix("token");
AccountsApiapiInstance = newAccountsApi(defaultClient);
Stringid = "id_example"; // String | IDStringxPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional)try {
AccountDetailsresult = apiInstance.accountShow(id, xPhraseAppOTP);
System.out.println(result);
} catch (ApiExceptione) {
System.err.println("Exception when calling AccountsApi#accountShow");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountsApi	accountShow	GET /accounts/{id}	Get a single account
AccountsApi	accountsList	GET /accounts	List accounts
AuthorizationsApi	authorizationCreate	POST /authorizations	Create an authorization
AuthorizationsApi	authorizationDelete	DELETE /authorizations/{id}	Delete an authorization
AuthorizationsApi	authorizationShow	GET /authorizations/{id}	Get a single authorization
AuthorizationsApi	authorizationUpdate	PATCH /authorizations/{id}	Update an authorization
AuthorizationsApi	authorizationsList	GET /authorizations	List authorizations
AutomationEventsApi	accountAutomationEventsList	GET /accounts/{account_id}/automation_events	List automation events for an account
AutomationEventsApi	automationEventsList	GET /accounts/{account_id}/automations/{automation_id}/events	List events for an automation
AutomationsApi	automationActivate	POST /accounts/{account_id}/automations/{automation_id}/activate	Activate an automation
AutomationsApi	automationCreate	POST /accounts/{account_id}/automations	Create an automation
AutomationsApi	automationDeactivate	POST /accounts/{account_id}/automations/{automation_id}/deactivate	Deactivate an automation
AutomationsApi	automationDelete	DELETE /accounts/{account_id}/automations/{automation_id}	Destroy automation
AutomationsApi	automationShow	GET /accounts/{account_id}/automations/{automation_id}	Get a single automation
AutomationsApi	automationTrigger	POST /accounts/{account_id}/automations/{automation_id}/trigger	Trigger an automation
AutomationsApi	automationUpdate	PATCH /accounts/{account_id}/automations/{automation_id}	Update an automation
AutomationsApi	automationsList	GET /accounts/{account_id}/automations	List automations
BlacklistedKeysApi	blacklistedKeyCreate	POST /projects/{project_id}/blacklisted_keys	Create a blocked key
BlacklistedKeysApi	blacklistedKeyDelete	DELETE /projects/{project_id}/blacklisted_keys/{id}	Delete a blocked key
BlacklistedKeysApi	blacklistedKeyShow	GET /projects/{project_id}/blacklisted_keys/{id}	Get a single blocked key
BlacklistedKeysApi	blacklistedKeyUpdate	PATCH /projects/{project_id}/blacklisted_keys/{id}	Update a blocked key
BlacklistedKeysApi	blacklistedKeysList	GET /projects/{project_id}/blacklisted_keys	List blocked keys
BranchesApi	branchCompare	GET /projects/{project_id}/branches/{name}/compare	Compare branches
BranchesApi	branchComparisonCreate	POST /projects/{project_id}/branches/{name}/compare	Create comparison (async.)
BranchesApi	branchCreate	POST /projects/{project_id}/branches	Create a branch
BranchesApi	branchDelete	DELETE /projects/{project_id}/branches/{name}	Delete a branch
BranchesApi	branchMerge	PATCH /projects/{project_id}/branches/{name}/merge	Merge a branch
BranchesApi	branchShow	GET /projects/{project_id}/branches/{name}	Get a single branch
BranchesApi	branchSync	PATCH /projects/{project_id}/branches/{name}/sync	Sync a branch
BranchesApi	branchUpdate	PATCH /projects/{project_id}/branches/{name}	Update a branch
BranchesApi	branchesList	GET /projects/{project_id}/branches	List branches
CommentReactionsApi	reactionCreate	POST /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions	Create a reaction
CommentReactionsApi	reactionDelete	DELETE /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}	Delete a reaction
CommentReactionsApi	reactionShow	GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}	Get a single reaction
CommentReactionsApi	reactionsList	GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions	List reactions
CommentRepliesApi	repliesList	GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies	List replies
CommentRepliesApi	replyCreate	POST /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies	Create a reply
CommentRepliesApi	replyDelete	DELETE /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}	Delete a reply
CommentRepliesApi	replyMarkAsRead	PATCH /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read	Mark a reply as read
CommentRepliesApi	replyMarkAsUnread	PATCH /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread	Mark a reply as unread
CommentRepliesApi	replyShow	GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}	Get a single reply
CommentsApi	commentCreate	POST /projects/{project_id}/keys/{key_id}/comments	Create a comment
CommentsApi	commentDelete	DELETE /projects/{project_id}/keys/{key_id}/comments/{id}	Delete a comment
CommentsApi	commentMarkCheck	GET /projects/{project_id}/keys/{key_id}/comments/{id}/read	Check if comment is read
CommentsApi	commentMarkRead	PATCH /projects/{project_id}/keys/{key_id}/comments/{id}/read	Mark a comment as read
CommentsApi	commentMarkUnread	DELETE /projects/{project_id}/keys/{key_id}/comments/{id}/read	Mark a comment as unread
CommentsApi	commentShow	GET /projects/{project_id}/keys/{key_id}/comments/{id}	Get a single comment
CommentsApi	commentUpdate	PATCH /projects/{project_id}/keys/{key_id}/comments/{id}	Update a comment
CommentsApi	commentsList	GET /projects/{project_id}/keys/{key_id}/comments	List comments
CustomMetadataApi	customMetadataPropertiesDelete	DELETE /accounts/{account_id}/custom_metadata/properties/{id}	Destroy property
CustomMetadataApi	customMetadataPropertiesList	GET /accounts/{account_id}/custom_metadata/properties	List properties
CustomMetadataApi	customMetadataPropertyCreate	POST /accounts/{account_id}/custom_metadata/properties	Create a property
CustomMetadataApi	customMetadataPropertyShow	GET /accounts/{account_id}/custom_metadata/properties/{id}	Get a single property
CustomMetadataApi	customMetadataPropertyUpdate	PATCH /accounts/{account_id}/custom_metadata/properties/{id}	Update a property
DistributionsApi	distributionCreate	POST /accounts/{account_id}/distributions	Create a distribution
DistributionsApi	distributionDelete	DELETE /accounts/{account_id}/distributions/{id}	Delete a distribution
DistributionsApi	distributionShow	GET /accounts/{account_id}/distributions/{id}	Get a single distribution
DistributionsApi	distributionUpdate	PATCH /accounts/{account_id}/distributions/{id}	Update a distribution
DistributionsApi	distributionsList	GET /accounts/{account_id}/distributions	List distributions
DocumentsApi	documentDelete	DELETE /projects/{project_id}/documents/{id}	Delete document
DocumentsApi	documentsList	GET /projects/{project_id}/documents	List documents
FigmaAttachmentsApi	figmaAttachmentCreate	POST /projects/{project_id}/figma_attachments	Create a Figma attachment
FigmaAttachmentsApi	figmaAttachmentDelete	DELETE /projects/{project_id}/figma_attachments/{id}	Delete a Figma attachment
FigmaAttachmentsApi	figmaAttachmentShow	GET /projects/{project_id}/figma_attachments/{id}	Get a single Figma attachment
FigmaAttachmentsApi	figmaAttachmentUpdate	PATCH /projects/{project_id}/figma_attachments/{id}	Update a Figma attachment
FigmaAttachmentsApi	figmaAttachmentsList	GET /projects/{project_id}/figma_attachments	List Figma attachments
FormatsApi	formatsList	GET /formats	List formats
GlossariesApi	glossariesList	GET /accounts/{account_id}/glossaries	List term bases
GlossariesApi	glossaryCreate	POST /accounts/{account_id}/glossaries	Create a term base
GlossariesApi	glossaryDelete	DELETE /accounts/{account_id}/glossaries/{id}	Delete a term base
GlossariesApi	glossaryShow	GET /accounts/{account_id}/glossaries/{id}	Get a single term base
GlossariesApi	glossaryUpdate	PATCH /accounts/{account_id}/glossaries/{id}	Update a term base
GlossaryTermTranslationsApi	glossaryTermTranslationCreate	POST /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations	Create a translation for a term
GlossaryTermTranslationsApi	glossaryTermTranslationDelete	DELETE /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}	Delete a translation for a term
GlossaryTermTranslationsApi	glossaryTermTranslationUpdate	PATCH /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id}	Update a translation for a term
GlossaryTermsApi	glossaryTermCreate	POST /accounts/{account_id}/glossaries/{glossary_id}/terms	Create a term
GlossaryTermsApi	glossaryTermDelete	DELETE /accounts/{account_id}/glossaries/{glossary_id}/terms/{id}	Delete a term
GlossaryTermsApi	glossaryTermShow	GET /accounts/{account_id}/glossaries/{glossary_id}/terms/{id}	Get a single term
GlossaryTermsApi	glossaryTermUpdate	PATCH /accounts/{account_id}/glossaries/{glossary_id}/terms/{id}	Update a term
GlossaryTermsApi	glossaryTermsList	GET /accounts/{account_id}/glossaries/{glossary_id}/terms	List terms
IcuApi	icuSkeleton	POST /icu/skeleton	Build ICU skeletons
InvitationsApi	invitationCreate	POST /accounts/{account_id}/invitations	Create a new invitation
InvitationsApi	invitationDelete	DELETE /accounts/{account_id}/invitations/{id}	Delete an invitation
InvitationsApi	invitationResend	POST /accounts/{account_id}/invitations/{id}/resend	Resend an invitation
InvitationsApi	invitationShow	GET /accounts/{account_id}/invitations/{id}	Get a single invitation
InvitationsApi	invitationUpdate	PATCH /accounts/{account_id}/invitations/{id}	Update an invitation
InvitationsApi	invitationUpdateSettings	PATCH /projects/{project_id}/invitations/{id}	Update a member's invitation access
InvitationsApi	invitationsList	GET /accounts/{account_id}/invitations	List invitations
JobAnnotationsApi	jobAnnotationDelete	DELETE /projects/{project_id}/jobs/{job_id}/annotations/{id}	Delete a job annotation
JobAnnotationsApi	jobAnnotationUpdate	PATCH /projects/{project_id}/jobs/{job_id}/annotations/{id}	Create/Update a job annotation
JobAnnotationsApi	jobAnnotationsList	GET /projects/{project_id}/jobs/{job_id}/annotations	List job annotations
JobAnnotationsApi	jobLocaleAnnotationDelete	DELETE /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}	Delete a job locale annotation
JobAnnotationsApi	jobLocaleAnnotationUpdate	PATCH /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations/{id}	Create/Update a job locale annotation
JobAnnotationsApi	jobLocaleAnnotationsList	GET /projects/{project_id}/jobs/{job_id}/locales/{job_locale_id}/annotations	List job locale annotations
JobCommentsApi	jobCommentCreate	POST /projects/{project_id}/jobs/{job_id}/comments	Create a job comment
JobCommentsApi	jobCommentDelete	DELETE /projects/{project_id}/jobs/{job_id}/comments/{id}	Delete a job comment
JobCommentsApi	jobCommentShow	GET /projects/{project_id}/jobs/{job_id}/comments/{id}	Get a single job comment
JobCommentsApi	jobCommentUpdate	PATCH /projects/{project_id}/jobs/{job_id}/comments/{id}	Update a job comment
JobCommentsApi	jobCommentsList	GET /projects/{project_id}/jobs/{job_id}/comments	List job comments
JobLocalesApi	jobLocaleComplete	POST /projects/{project_id}/jobs/{job_id}/locales/{id}/complete	Complete a job locale
JobLocalesApi	jobLocaleCompleteReview	POST /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review	Review a job locale
JobLocalesApi	jobLocaleDelete	DELETE /projects/{project_id}/jobs/{job_id}/locales/{id}	Remove a target locale from a job
JobLocalesApi	jobLocaleReopen	POST /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen	Reopen a job locale
JobLocalesApi	jobLocaleShow	GET /projects/{project_id}/jobs/{job_id}/locales/{id}	Show single job target locale
JobLocalesApi	jobLocaleUpdate	PATCH /projects/{project_id}/jobs/{job_id}/locales/{id}	Update a job target locale
JobLocalesApi	jobLocalesCreate	POST /projects/{project_id}/jobs/{job_id}/locales	Add a target locale to a job
JobLocalesApi	jobLocalesList	GET /projects/{project_id}/jobs/{job_id}/locales	List job target locales
JobTemplateLocalesApi	jobTemplateLocaleDelete	DELETE /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}	Delete a job template locale
JobTemplateLocalesApi	jobTemplateLocaleShow	GET /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}	Get a single job template locale
JobTemplateLocalesApi	jobTemplateLocaleUpdate	PATCH /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}	Update a job template locale
JobTemplateLocalesApi	jobTemplateLocalesCreate	POST /projects/{project_id}/job_templates/{job_template_id}/locales	Create a job template locale
JobTemplateLocalesApi	jobTemplateLocalesList	GET /projects/{project_id}/job_templates/{job_template_id}/locales	List job template locales
JobTemplatesApi	jobTemplateCreate	POST /projects/{project_id}/job_templates	Create a job template
JobTemplatesApi	jobTemplateDelete	DELETE /projects/{project_id}/job_templates/{id}	Delete a job template
JobTemplatesApi	jobTemplateUpdate	PATCH /projects/{project_id}/job_templates/{id}	Update a job template
JobTemplatesApi	jobTemplatesList	GET /projects/{project_id}/job_templates	List job templates
JobTemplatesApi	jobTemplatesShow	GET /projects/{project_id}/job_templates/{id}	Get a single job template
JobsApi	jobComplete	POST /projects/{project_id}/jobs/{id}/complete	Complete a job
JobsApi	jobCreate	POST /projects/{project_id}/jobs	Create a job
JobsApi	jobDelete	DELETE /projects/{project_id}/jobs/{id}	Delete a job
JobsApi	jobKeysCreate	POST /projects/{project_id}/jobs/{id}/keys	Add keys to job
JobsApi	jobKeysDelete	DELETE /projects/{project_id}/jobs/{id}/keys	Remove keys from job
JobsApi	jobLock	POST /projects/{project_id}/jobs/{id}/lock	Lock a job
JobsApi	jobReopen	POST /projects/{project_id}/jobs/{id}/reopen	Reopen a job
JobsApi	jobShow	GET /projects/{project_id}/jobs/{id}	Get a single job
JobsApi	jobStart	POST /projects/{project_id}/jobs/{id}/start	Start a job
JobsApi	jobUnlock	POST /projects/{project_id}/jobs/{id}/unlock	Unlock a job
JobsApi	jobUpdate	PATCH /projects/{project_id}/jobs/{id}	Update a job
JobsApi	jobsByAccount	GET /accounts/{account_id}/jobs	List account jobs
JobsApi	jobsList	GET /projects/{project_id}/jobs	List jobs
KeyFormatAnnotationsApi	keyFormatAnnotationsList	GET /projects/{project_id}/keys/{id}/format_annotations	List format annotations for a key
KeysApi	keyCreate	POST /projects/{project_id}/keys	Create a key
KeysApi	keyDelete	DELETE /projects/{project_id}/keys/{id}	Delete a key
KeysApi	keyShow	GET /projects/{project_id}/keys/{id}	Get a single key
KeysApi	keyUpdate	PATCH /projects/{project_id}/keys/{id}	Update a key
KeysApi	keysDeleteCollection	DELETE /projects/{project_id}/keys	Delete collection of keys
KeysApi	keysExclude	PATCH /projects/{project_id}/keys/exclude	Exclude a locale on a collection of keys
KeysApi	keysInclude	PATCH /projects/{project_id}/keys/include	Include a locale on a collection of keys
KeysApi	keysList	GET /projects/{project_id}/keys	List keys
KeysApi	keysSearch	POST /projects/{project_id}/keys/search	Search keys
KeysApi	keysTag	PATCH /projects/{project_id}/keys/tag	Add tags to collection of keys
KeysApi	keysUntag	PATCH /projects/{project_id}/keys/untag	Remove tags from collection of keys
KeysFigmaAttachmentsApi	figmaAttachmentAttachToKey	POST /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys	Attach the Figma attachment to a key
KeysFigmaAttachmentsApi	figmaAttachmentDetachFromKey	DELETE /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id}	Detach the Figma attachment from a key
LinkedKeysApi	keyLinksBatchDestroy	DELETE /projects/{project_id}/keys/{id}/key_links	Batch unlink child keys from a parent key
LinkedKeysApi	keyLinksCreate	POST /projects/{project_id}/keys/{id}/key_links	Link child keys to a parent key
LinkedKeysApi	keyLinksDestroy	DELETE /projects/{project_id}/keys/{id}/key_links/{child_key_id}	Unlink a child key from a parent key
LinkedKeysApi	keyLinksIndex	GET /projects/{project_id}/keys/{id}/key_links	List child keys of a parent key
LocaleDownloadsApi	localeDownloadCreate	POST /projects/{project_id}/locales/{locale_id}/downloads	Initiate async download of a locale
LocaleDownloadsApi	localeDownloadShow	GET /projects/{project_id}/locales/{locale_id}/downloads/{id}	Show status of an async locale download
LocalesApi	accountLocales	GET /accounts/{id}/locales	List locales used in account
LocalesApi	localeCreate	POST /projects/{project_id}/locales	Create a locale
LocalesApi	localeDelete	DELETE /projects/{project_id}/locales/{id}	Delete a locale
LocalesApi	localeDownload	GET /projects/{project_id}/locales/{id}/download	Download a locale
LocalesApi	localeShow	GET /projects/{project_id}/locales/{id}	Get a single locale
LocalesApi	localeUpdate	PATCH /projects/{project_id}/locales/{id}	Update a locale
LocalesApi	localesList	GET /projects/{project_id}/locales	List locales
MembersApi	memberDelete	DELETE /accounts/{account_id}/members/{id}	Remove a user from the account
MembersApi	memberShow	GET /accounts/{account_id}/members/{id}	Get single member
MembersApi	memberUpdate	PATCH /accounts/{account_id}/members/{id}	Update a member
MembersApi	memberUpdateSettings	PATCH /projects/{project_id}/members/{id}	Update a member's project settings
MembersApi	membersList	GET /accounts/{account_id}/members	List members
NotificationGroupsApi	notificationGroupsList	GET /notification_groups	List notification groups
NotificationGroupsApi	notificationGroupsMarkAllAsRead	PATCH /notification_groups/mark_all_as_read	Mark all notification groups as read
NotificationGroupsApi	notificationGroupsMarkAsRead	PATCH /notification_groups/{id}/mark_as_read	Mark a notification group as read
NotificationsApi	notificationsList	GET /notifications	List notifications
NotificationsApi	notificationsMarkAllAsRead	POST /notifications/mark_all_as_read	Mark all notifications as read
NotificationsApi	notificationsShow	GET /notifications/{id}	Get a single notification
OrdersApi	orderConfirm	PATCH /projects/{project_id}/orders/{id}/confirm	Confirm an order
OrdersApi	orderCreate	POST /projects/{project_id}/orders	Create a new order
OrdersApi	orderDelete	DELETE /projects/{project_id}/orders/{id}	Cancel an order
OrdersApi	orderShow	GET /projects/{project_id}/orders/{id}	Get a single order
OrdersApi	ordersList	GET /projects/{project_id}/orders	List orders
OrganizationJobTemplateLocalesApi	organizationJobTemplateLocaleDelete	DELETE /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}	Delete an organization job template locale
OrganizationJobTemplateLocalesApi	organizationJobTemplateLocaleShow	GET /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}	Get a single organization job template locale
OrganizationJobTemplateLocalesApi	organizationJobTemplateLocaleUpdate	PATCH /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id}	Update an organization job template locale
OrganizationJobTemplateLocalesApi	organizationJobTemplateLocalesCreate	POST /accounts/{account_id}/job_templates/{job_template_id}/locales	Create an organization job template locale
OrganizationJobTemplateLocalesApi	organizationJobTemplateLocalesList	GET /accounts/{account_id}/job_templates/{job_template_id}/locales	List organization job template locales
OrganizationJobTemplatesApi	organizationJobTemplateCreate	POST /accounts/{account_id}/job_templates	Create an organization job template
OrganizationJobTemplatesApi	organizationJobTemplateDelete	DELETE /accounts/{account_id}/job_templates/{id}	Delete an organization job template
OrganizationJobTemplatesApi	organizationJobTemplateUpdate	PATCH /accounts/{account_id}/job_templates/{id}	Update an organization job template
OrganizationJobTemplatesApi	organizationJobTemplatesList	GET /accounts/{account_id}/job_templates	List organization job templates
OrganizationJobTemplatesApi	organizationJobTemplatesShow	GET /accounts/{account_id}/job_templates/{id}	Get a single organization job template
PreTranslationsApi	preTranslationCreate	POST /projects/{project_id}/pre_translations	Create a pre-translation job
PreTranslationsApi	preTranslationShow	GET /projects/{project_id}/pre_translations/{id}	Get a single pre-translation job
PreTranslationsApi	preTranslationsList	GET /projects/{project_id}/pre_translations	List pre-translation jobs
ProjectsApi	projectCreate	POST /projects	Create a project
ProjectsApi	projectDelete	DELETE /projects/{id}	Delete a project
ProjectsApi	projectShow	GET /projects/{id}	Get a single project
ProjectsApi	projectUpdate	PATCH /projects/{id}	Update a project
ProjectsApi	projectsList	GET /projects	List projects
QualityPerformanceScoreApi	qualityPerformanceScoreList	POST /projects/{project_id}/quality_performance_score	Get Translation Quality
ReleaseTriggersApi	releaseTriggersCreate	POST /accounts/{account_id}/distributions/{distribution_id}/release_triggers	Create a release trigger
ReleaseTriggersApi	releaseTriggersDestroy	DELETE /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}	Delete a single release trigger
ReleaseTriggersApi	releaseTriggersList	GET /accounts/{account_id}/distributions/{distribution_id}/release_triggers	List release triggers
ReleaseTriggersApi	releaseTriggersShow	GET /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}	Get a single release trigger
ReleaseTriggersApi	releaseTriggersUpdate	PATCH /accounts/{account_id}/distributions/{distribution_id}/release_triggers/{id}	Update a release trigger
ReleasesApi	releaseCreate	POST /accounts/{account_id}/distributions/{distribution_id}/releases	Create a release
ReleasesApi	releaseDelete	DELETE /accounts/{account_id}/distributions/{distribution_id}/releases/{id}	Delete a release
ReleasesApi	releasePublish	POST /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish	Publish a release
ReleasesApi	releaseShow	GET /accounts/{account_id}/distributions/{distribution_id}/releases/{id}	Get a single release
ReleasesApi	releaseUpdate	PATCH /accounts/{account_id}/distributions/{distribution_id}/releases/{id}	Update a release
ReleasesApi	releasesList	GET /accounts/{account_id}/distributions/{distribution_id}/releases	List releases
RepoSyncEventsApi	repoSyncEventList	GET /accounts/{account_id}/repo_syncs/{id}/events	Repository Syncs History
RepoSyncEventsApi	repoSyncEventShow	GET /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id}	Get a single Repo Sync Event
RepoSyncsApi	repoSyncActivate	POST /accounts/{account_id}/repo_syncs/{id}/activate	Activate a Repo Sync
RepoSyncsApi	repoSyncCreate	POST /accounts/{account_id}/repo_syncs	Create a Repo Sync
RepoSyncsApi	repoSyncDeactivate	POST /accounts/{account_id}/repo_syncs/{id}/deactivate	Deactivate a Repo Sync
RepoSyncsApi	repoSyncExport	POST /accounts/{account_id}/repo_syncs/{id}/export	Export to code repository
RepoSyncsApi	repoSyncImport	POST /accounts/{account_id}/repo_syncs/{id}/import	Import from code repository
RepoSyncsApi	repoSyncList	GET /accounts/{account_id}/repo_syncs	Get Repo Syncs
RepoSyncsApi	repoSyncShow	GET /accounts/{account_id}/repo_syncs/{id}	Get a single Repo Sync
ReportsApi	reportLocalesList	GET /projects/{project_id}/report/locales	List Locale Reports
ReportsApi	reportShow	GET /projects/{project_id}/report	Get Project Report
ScreenshotMarkersApi	screenshotMarkerCreate	POST /projects/{project_id}/screenshots/{screenshot_id}/markers	Create a screenshot marker
ScreenshotMarkersApi	screenshotMarkerDelete	DELETE /projects/{project_id}/screenshots/{screenshot_id}/markers	Delete a screenshot marker
ScreenshotMarkersApi	screenshotMarkerShow	GET /projects/{project_id}/screenshots/{screenshot_id}/markers/{id}	Get a single screenshot marker
ScreenshotMarkersApi	screenshotMarkerUpdate	PATCH /projects/{project_id}/screenshots/{screenshot_id}/markers	Update a screenshot marker
ScreenshotMarkersApi	screenshotMarkersList	GET /projects/{project_id}/screenshots/{id}/markers	List screenshot markers
ScreenshotsApi	screenshotCreate	POST /projects/{project_id}/screenshots	Create a screenshot
ScreenshotsApi	screenshotDelete	DELETE /projects/{project_id}/screenshots/{id}	Delete a screenshot
ScreenshotsApi	screenshotShow	GET /projects/{project_id}/screenshots/{id}	Get a single screenshot
ScreenshotsApi	screenshotUpdate	PATCH /projects/{project_id}/screenshots/{id}	Update a screenshot
ScreenshotsApi	screenshotsList	GET /projects/{project_id}/screenshots	List screenshots
SearchApi	searchInAccount	POST /accounts/{account_id}/search	Search across projects
SpacesApi	spaceCreate	POST /accounts/{account_id}/spaces	Create a Space
SpacesApi	spaceDelete	DELETE /accounts/{account_id}/spaces/{id}	Delete Space
SpacesApi	spaceShow	GET /accounts/{account_id}/spaces/{id}	Get Space
SpacesApi	spaceUpdate	PATCH /accounts/{account_id}/spaces/{id}	Update Space
SpacesApi	spacesList	GET /accounts/{account_id}/spaces	List Spaces
SpacesApi	spacesProjectsCreate	POST /accounts/{account_id}/spaces/{space_id}/projects	Add Project to Space
SpacesApi	spacesProjectsDelete	DELETE /accounts/{account_id}/spaces/{space_id}/projects/{id}	Remove Project from Space
SpacesApi	spacesProjectsList	GET /accounts/{account_id}/spaces/{space_id}/projects	List Projects in Space
StyleGuidesApi	styleguideCreate	POST /projects/{project_id}/styleguides	Create a style guide
StyleGuidesApi	styleguideDelete	DELETE /projects/{project_id}/styleguides/{id}	Delete a style guide
StyleGuidesApi	styleguideShow	GET /projects/{project_id}/styleguides/{id}	Get a single style guide
StyleGuidesApi	styleguideUpdate	PATCH /projects/{project_id}/styleguides/{id}	Update a style guide
StyleGuidesApi	styleguidesList	GET /projects/{project_id}/styleguides	List style guides
TagsApi	tagCreate	POST /projects/{project_id}/tags	Create a tag
TagsApi	tagDelete	DELETE /projects/{project_id}/tags/{name}	Delete a tag
TagsApi	tagShow	GET /projects/{project_id}/tags/{name}	Get a single tag
TagsApi	tagsList	GET /projects/{project_id}/tags	List tags
TeamsApi	teamCreate	POST /accounts/{account_id}/teams	Create a Team
TeamsApi	teamDelete	DELETE /accounts/{account_id}/teams/{id}	Delete Team
TeamsApi	teamShow	GET /accounts/{account_id}/teams/{id}	Get Team
TeamsApi	teamUpdate	PATCH /accounts/{account_id}/teams/{id}	Update Team
TeamsApi	teamsList	GET /accounts/{account_id}/teams	List Teams
TeamsApi	teamsProjectsCreate	POST /accounts/{account_id}/teams/{team_id}/projects	Add Project to Team
TeamsApi	teamsProjectsDelete	DELETE /accounts/{account_id}/teams/{team_id}/projects/{id}	Remove Project from Team
TeamsApi	teamsSpacesCreate	POST /accounts/{account_id}/teams/{team_id}/spaces	Add Space
TeamsApi	teamsSpacesDelete	DELETE /accounts/{account_id}/teams/{team_id}/spaces/{id}	Remove Space
TeamsApi	teamsUsersCreate	POST /accounts/{account_id}/teams/{team_id}/users	Add User
TeamsApi	teamsUsersDelete	DELETE /accounts/{account_id}/teams/{team_id}/users/{id}	Remove User
TranslationsApi	translationCreate	POST /projects/{project_id}/translations	Create a translation
TranslationsApi	translationExclude	PATCH /projects/{project_id}/translations/{id}/exclude	Exclude a translation from export
TranslationsApi	translationInclude	PATCH /projects/{project_id}/translations/{id}/include	Include a translation
TranslationsApi	translationReview	PATCH /projects/{project_id}/translations/{id}/review	Review a translation
TranslationsApi	translationShow	GET /projects/{project_id}/translations/{id}	Get a single translation
TranslationsApi	translationUnreview	PATCH /projects/{project_id}/translations/{id}/unreview	Unreview a translation
TranslationsApi	translationUnverify	PATCH /projects/{project_id}/translations/{id}/unverify	Mark a translation as unverified
TranslationsApi	translationUpdate	PATCH /projects/{project_id}/translations/{id}	Update a translation
TranslationsApi	translationVerify	PATCH /projects/{project_id}/translations/{id}/verify	Verify a translation
TranslationsApi	translationsByKey	GET /projects/{project_id}/keys/{key_id}/translations	List translations by key
TranslationsApi	translationsByLocale	GET /projects/{project_id}/locales/{locale_id}/translations	List translations by locale
TranslationsApi	translationsExcludeCollection	PATCH /projects/{project_id}/translations/exclude	Exclude translations by query
TranslationsApi	translationsIncludeCollection	PATCH /projects/{project_id}/translations/include	Include translations by query
TranslationsApi	translationsList	GET /projects/{project_id}/translations	List all translations
TranslationsApi	translationsReviewCollection	PATCH /projects/{project_id}/translations/review	Review translations selected by query
TranslationsApi	translationsSearch	POST /projects/{project_id}/translations/search	Search translations
TranslationsApi	translationsUnreviewCollection	PATCH /projects/{project_id}/translations/unreview	Unreview translations selected by query
TranslationsApi	translationsUnverifyCollection	PATCH /projects/{project_id}/translations/unverify	Unverify translations by query
TranslationsApi	translationsVerifyCollection	PATCH /projects/{project_id}/translations/verify	Verify translations by query
UploadBatchesApi	uploadBatchesCreate	POST /projects/{project_id}/upload_batches	Create upload batch
UploadsApi	uploadCreate	POST /projects/{project_id}/uploads	Upload a new file
UploadsApi	uploadShow	GET /projects/{project_id}/uploads/{id}	Get a single upload
UploadsApi	uploadsList	GET /projects/{project_id}/uploads	List uploads
UsersApi	showUser	GET /user	Show current User
VariablesApi	variableCreate	POST /projects/{project_id}/variables	Create a variable
VariablesApi	variableDelete	DELETE /projects/{project_id}/variables/{name}	Delete a variable
VariablesApi	variableShow	GET /projects/{project_id}/variables/{name}	Get a single variable
VariablesApi	variableUpdate	PATCH /projects/{project_id}/variables/{name}	Update a variable
VariablesApi	variablesList	GET /projects/{project_id}/variables	List variables
VersionsHistoryApi	versionShow	GET /projects/{project_id}/translations/{translation_id}/versions/{id}	Get a single version
VersionsHistoryApi	versionsList	GET /projects/{project_id}/translations/{translation_id}/versions	List all versions
WebhookDeliveriesApi	webhookDeliveriesList	GET /projects/{project_id}/webhooks/{webhook_id}/deliveries	List webhook deliveries
WebhookDeliveriesApi	webhookDeliveriesRedeliver	POST /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliver	Redeliver a single webhook delivery
WebhookDeliveriesApi	webhookDeliveriesShow	GET /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}	Get a single webhook delivery
WebhooksApi	webhookCreate	POST /projects/{project_id}/webhooks	Create a webhook
WebhooksApi	webhookDelete	DELETE /projects/{project_id}/webhooks/{id}	Delete a webhook
WebhooksApi	webhookShow	GET /projects/{project_id}/webhooks/{id}	Get a single webhook
WebhooksApi	webhookTest	POST /projects/{project_id}/webhooks/{id}/test	Test a webhook
WebhooksApi	webhookUpdate	PATCH /projects/{project_id}/webhooks/{id}	Update a webhook
WebhooksApi	webhooksList	GET /projects/{project_id}/webhooks	List webhooks

Documentation for Models

• Account
• AccountDetails
• AccountSearchResult
• AffectedCount
• AffectedResources
• Authorization
• AuthorizationCreateParameters
• AuthorizationUpdateParameters
• AuthorizationWithToken
• Automation
• AutomationEvent
• AutomationEventProject
• AutomationsCreateParameters
• AutomationsCreateParameters1
• BlacklistedKey
• BlacklistedKeyCreateParameters
• BlacklistedKeyUpdateParameters
• Branch
• BranchComparison
• BranchComparisonChange
• BranchComparisonDiff
• BranchComparisonDiffConflictsValue
• BranchCreateComparisonParameters
• BranchCreateParameters
• BranchMergeParameters
• BranchName
• BranchSyncParameters
• BranchUpdateParameters
• Comment
• CommentCreateParameters
• CommentCreateParameters1
• CommentMarkReadParameters
• CommentReaction
• CommentUpdateParameters
• CurrentUser
• CustomMetadataDataType
• CustomMetadataPropertiesCreateParameters
• CustomMetadataPropertiesUpdateParameters
• CustomMetadataProperty
• Distribution
• DistributionCreateParameters
• DistributionDetails
• DistributionUpdateParameters
• Document
• DocumentDelete422Response
• DocumentDelete422ResponseErrorsInner
• Error
• ErrorError
• FigmaAttachment
• FigmaAttachmentCreateParameters
• FigmaAttachmentUpdateParameters
• Format
• Glossary
• GlossaryCreateParameters
• GlossaryTerm
• GlossaryTermCreateParameters
• GlossaryTermGlossary
• GlossaryTermTranslation
• GlossaryTermTranslationCreateParameters
• GlossaryTermTranslationUpdateParameters
• GlossaryTermUpdateParameters
• GlossaryUpdateParameters
• Icu
• IcuSkeletonError
• IcuSkeletonParameters
• Invitation
• InvitationCreateParameters
• InvitationUpdateParameters
• InvitationUpdateSettingsParameters
• Job
• JobAnnotation
• JobAnnotationShort
• JobAnnotationUpdateParameters
• JobComment
• JobCommentCreateParameters
• JobCommentUpdateParameters
• JobCompleteParameters
• JobCreateParameters
• JobDetails
• JobKeysCreateParameters
• JobKeysDeleteParameters
• JobLocale
• JobLocaleCompleteParameters
• JobLocaleCompleteReviewParameters
• JobLocaleReopenParameters
• JobLocaleUpdateParameters
• JobLocalesCreateParameters
• JobPreview
• JobReopenParameters
• JobStartParameters
• JobTemplate
• JobTemplateCreateParameters
• JobTemplateDetails
• JobTemplateLocaleUpdateParameters
• JobTemplateLocales
• JobTemplateLocalesCreateParameters
• JobTemplatePreview
• JobTemplateUpdateParameters
• JobUpdateParameters
• KeyCreateParameters
• KeyFormatAnnotationsList200ResponseInner
• KeyLink
• KeyLinksBatchDestroyParameters
• KeyLinksCreateParameters
• KeyPreview
• KeyUpdateParameters
• KeysExcludeParameters
• KeysIncludeParameters
• KeysSearchParameters
• KeysTagParameters
• KeysUntagParameters
• Locale
• LocaleCreateParameters
• LocaleDetails
• LocaleDownload
• LocaleDownloadCreateParameters
• LocaleDownloadParams
• LocaleDownloadResult
• LocalePreview
• LocalePreview1
• LocaleReport
• LocaleStatistics
• LocaleTeamPreview
• LocaleUpdateParameters
• LocaleUserPreview
• Member
• MemberProjectDetail
• MemberProjectDetailProjectRolesInner
• MemberSpacesInner
• MemberUpdateParameters
• MemberUpdateSettingsParameters
• Notification
• NotificationGroup
• NotificationGroupDetail
• OrderConfirmParameters
• OrderCreateParameters
• OrganizationJobTemplate
• OrganizationJobTemplateCreateParameters
• OrganizationJobTemplateDetails
• OrganizationJobTemplateLocaleUpdateParameters
• OrganizationJobTemplateLocalesCreateParameters
• OrganizationJobTemplateUpdateParameters
• PreTranslation
• PreTranslationCreateParameters
• Project
• ProjectCreateParameters
• ProjectDetails
• ProjectLocales
• ProjectReport
• ProjectShort
• ProjectUpdateParameters
• QualityPerformanceScoreList200Response
• QualityPerformanceScoreList200ResponseAnyOf
• QualityPerformanceScoreList200ResponseAnyOfData
• QualityPerformanceScoreList200ResponseAnyOfDataTranslationsInner
• QualityPerformanceScoreList200ResponseAnyOfErrorsInner
• QualityPerformanceScoreListRequest
• Release
• ReleaseCreateParameters
• ReleaseCreateParameters1
• ReleasePreview
• ReleaseTrigger
• ReleaseUpdateParameters
• ReleaseUpdateParameters1
• RepoSync
• RepoSyncCreateParameters
• RepoSyncEvent
• RepoSyncExportParameters
• RepoSyncImportParameters
• Screenshot
• ScreenshotMarker
• ScreenshotMarkerCreateParameters
• ScreenshotMarkerPresentation
• ScreenshotMarkerUpdateParameters
• ScreenshotUpdateParameters
• SearchInAccountParameters
• Space
• Space1
• SpaceCreateParameters
• SpaceUpdateParameters
• SpacesProjectsCreateParameters
• Styleguide
• StyleguideCreateParameters
• StyleguideDetails
• StyleguidePreview
• StyleguideUpdateParameters
• Subscription
• Tag
• TagCreateParameters
• TagWithStats
• TagWithStats1Statistics
• TagWithStats1Statistics1
• Team
• TeamCreateParameters
• TeamDetail
• TeamShort
• TeamUpdateParameters
• TeamsProjectsCreateParameters
• TeamsSpacesCreateParameters
• TeamsUsersCreateParameters
• Translation
• TranslationCreateParameters
• TranslationDetails
• TranslationExcludeParameters
• TranslationIncludeParameters
• TranslationKey
• TranslationKeyDetails
• TranslationOrder
• TranslationParent
• TranslationReviewParameters
• TranslationUnreviewParameters
• TranslationUnverifyParameters
• TranslationUpdateParameters
• TranslationVerifyParameters
• TranslationVersion
• TranslationVersionWithUser
• TranslationsExcludeParameters
• TranslationsIncludeParameters
• TranslationsReviewParameters
• TranslationsSearchParameters
• TranslationsUnreviewParameters
• TranslationsUnverifyParameters
• TranslationsVerifyParameters
• Upload
• UploadBatch
• UploadBatchesCreateParameters
• UploadSummary
• User
• UserPreview
• Variable
• VariableCreateParameters
• VariableUpdateParameters
• Webhook
• WebhookCreateParameters
• WebhookDelivery
• WebhookUpdateParameters

Documentation for Authorization

Authentication schemes defined for the API:

Token

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

Basic

• Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@phrase.com

Get help / support

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