Skip to content

phrase/phrase-python

BranchesTags

Repository files navigation

phrase-api

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 Python package is automatically generated by the OpenAPI Generator project:

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

pip install phrase-api

Then import the package:

import phrase_api

pip install from Github repository

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/phrase/phrase-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/phrase/phrase-python.git)

Then import the package:

import phrase_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import phrase_api

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import phrase_api
from phrase_api.rest import ApiException
from pprint import pprint

configuration = phrase_api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

# Defining host is optional and default to https://api.phrase.com/v2
configuration.host = "https://api.phrase.com/v2"
# Enter a context with an instance of the API client
with phrase_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrase_api.AccountsApi(api_client)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Get a single account
        api_response = api_instance.account_show(id, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->account_show: %s\n" % e)

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:

configuration.host = "https://api.us.app.phrase.com/v2/"

Documentation For Authorization

Token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
import phrase-api

configuration = phrase-api.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
configuration.api_key_prefix['Authorization'] = 'token'

Basic

  • Type: HTTP basic authentication
import phrase-api

configuration = phrase-api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

Documentation for API Endpoints

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

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

Documentation For Models

Author

[email protected]

Get help / support

Please contact [email protected] and we can take more direct action toward finding a solution.

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

6 stars

Watchers

16 watching

Forks

3 forks
Report repository

Releases 48

2.5.0 Latest
Oct 2, 2024
+ 47 releases

Packages

No packages published

Languages