Skip to content

Latest commit

 

History

History
112 lines (64 loc) · 4.13 KB

LocaleDownloadsApi.md

File metadata and controls

112 lines (64 loc) · 4.13 KB

\LocaleDownloadsApi

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

Method HTTP request Description
LocaleDownloadCreate Post /projects/{project_id}/locales/{locale_id}/downloads Initiate async download of a locale
LocaleDownloadShow Get /projects/{project_id}/locales/{locale_id}/downloads/{id} Show status of an async locale download

LocaleDownloadCreate

LocaleDownload LocaleDownloadCreate(ctx, projectId, localeId, localeDownloadCreateParameters, optional)

Initiate async download of a locale

Prepare a locale for download in a specific file format.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID
localeId string Locale ID
localeDownloadCreateParameters LocaleDownloadCreateParameters
optional *LocaleDownloadCreateOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a LocaleDownloadCreateOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | ifModifiedSince | optional.String| Last modified condition, see <a href=&quot;#overview--conditional-get-requests--http-caching&quot;>Conditional GET requests / HTTP Caching</a> (optional) | ifNoneMatch | optional.String| ETag condition, see <a href=&quot;#overview--conditional-get-requests--http-caching&quot;>Conditional GET requests / HTTP Caching</a> (optional) |

Return type

LocaleDownload

Authorization

Basic, Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

LocaleDownloadShow

LocaleDownload LocaleDownloadShow(ctx, projectId, localeId, id, optional)

Show status of an async locale download

Show status of already started async locale download. If the download is finished, the download link will be returned.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId string Project ID
localeId string Locale ID
id string ID
optional *LocaleDownloadShowOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a LocaleDownloadShowOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | ifModifiedSince | optional.String| Last modified condition, see <a href=&quot;#overview--conditional-get-requests--http-caching&quot;>Conditional GET requests / HTTP Caching</a> (optional) | ifNoneMatch | optional.String| ETag condition, see <a href=&quot;#overview--conditional-get-requests--http-caching&quot;>Conditional GET requests / HTTP Caching</a> (optional) |

Return type

LocaleDownload

Authorization

Basic, Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]