All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| AccountLocales | Get /accounts/{id}/locales | List locales used in account |
| LocaleCreate | Post /projects/{project_id}/locales | Create a locale |
| LocaleDelete | Delete /projects/{project_id}/locales/{id} | Delete a locale |
| LocaleDownload | Get /projects/{project_id}/locales/{id}/download | Download a locale |
| LocaleShow | Get /projects/{project_id}/locales/{id} | Get a single locale |
| LocaleUpdate | Patch /projects/{project_id}/locales/{id} | Update a locale |
| LocalesList | Get /projects/{project_id}/locales | List locales |
[]LocalePreview1 AccountLocales(ctx, id, optional)
List locales used in account
List all locales unique by locale code used across all projects within an account.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | ID | |
| optional | *AccountLocalesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a AccountLocalesOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LocaleDetails LocaleCreate(ctx, projectId, localeCreateParameters, optional)
Create a locale
Create a new locale.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| localeCreateParameters | LocaleCreateParameters | ||
| optional | *LocaleCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LocaleCreateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LocaleDelete(ctx, projectId, id, optional)
Delete a locale
Delete an existing locale.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | Locale ID or locale name | |
| optional | *LocaleDeleteOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LocaleDeleteOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File LocaleDownload(ctx, projectId, id, optional)
Download a locale
Download a locale in a specific file format.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | Locale ID or locale name | |
| optional | *LocaleDownloadOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LocaleDownloadOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | ifModifiedSince | optional.String| Last modified condition, see <a href="#overview--conditional-get-requests--http-caching">Conditional GET requests / HTTP Caching</a> (optional) | ifNoneMatch | optional.String| ETag condition, see <a href="#overview--conditional-get-requests--http-caching">Conditional GET requests / HTTP Caching</a> (optional) | branch | optional.String| specify the branch to use | fileFormat | optional.String| File format name. See the <a href="https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for all supported file formats. | tags | optional.String| Limit results to keys tagged with a list of comma separated tag names. | tag | optional.String| Limit download to tagged keys. This parameter is deprecated. Please use the "tags" parameter instead | includeEmptyTranslations | optional.Bool| Indicates whether keys without translations should be included in the output as well. | excludeEmptyZeroForms | optional.Bool| Indicates whether zero forms should be included when empty in pluralized keys. | includeTranslatedKeys | optional.Bool| Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys. | keepNotranslateTags | optional.Bool| Indicates whether [NOTRANSLATE] tags should be kept. | convertEmoji | optional.Bool| This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively. | formatOptions | optional.Interface of map[string]interface{}| Additional formatting and render options. See the <a href="https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code> | encoding | optional.String| Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1". | skipUnverifiedTranslations | optional.Bool| Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>. | includeUnverifiedTranslations | optional.Bool| if set to false unverified translations are excluded | useLastReviewedVersion | optional.Bool| If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project. | fallbackLocaleId | optional.String| If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>. | sourceLocaleId | optional.String| Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job. | translationKeyPrefix | optional.String| Download all translation keys, and remove the specified prefix where possible. Warning: this may create duplicate key names if other keys share the same name after the prefix is removed. | filterByPrefix | optional.Bool| Only download translation keys containing the specified prefix, and remove the prefix from the generated file. | customMetadataFilters | optional.Interface of map[string]interface{}| Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download. |
- Content-Type: Not defined
- Accept: *
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LocaleDetails LocaleShow(ctx, projectId, id, optional)
Get a single locale
Get details on a single locale for a given project.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | Locale ID or locale name | |
| optional | *LocaleShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LocaleShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LocaleDetails LocaleUpdate(ctx, projectId, id, localeUpdateParameters, optional)
Update a locale
Update an existing locale.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | Locale ID or locale name | |
| localeUpdateParameters | LocaleUpdateParameters | ||
| optional | *LocaleUpdateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LocaleUpdateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Locale LocalesList(ctx, projectId, optional)
List locales
List all locales for the given project.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| optional | *LocalesListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a LocalesListOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default | sortBy | optional.String| Sort locales. Valid options are "name_asc", "name_desc", "default_asc", "default_desc". | branch | optional.String| specify the branch to use |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]