Skip to content

Latest commit

 

History

History
149 lines (84 loc) · 4.98 KB

BitbucketSyncApi.md

File metadata and controls

149 lines (84 loc) · 4.98 KB
Raw

\BitbucketSyncApi

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

Method HTTP request Description
BitbucketSyncExport Post /bitbucket_syncs/{id}/export Export from Phrase Strings to Bitbucket
BitbucketSyncImport Post /bitbucket_syncs/{id}/import Import to Phrase Strings from Bitbucket
BitbucketSyncsList Get /bitbucket_syncs List Bitbucket syncs

BitbucketSyncExport

BitbucketSyncExportResponse BitbucketSyncExport(ctx, id, bitbucketSyncExportParameters, optional)

Export from Phrase Strings to Bitbucket

Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository.

Note: Export is done asynchronously and may take several seconds depending on the project size.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID
bitbucketSyncExportParameters BitbucketSyncExportParameters
optional *BitbucketSyncExportOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BitbucketSyncExportOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

BitbucketSyncExportResponse

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]

BitbucketSyncImport

BitbucketSyncImport(ctx, id, bitbucketSyncImportParameters, optional)

Import to Phrase Strings from Bitbucket

Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository.

Note: Import is done asynchronously and may take several seconds depending on the project size.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID
bitbucketSyncImportParameters BitbucketSyncImportParameters
optional *BitbucketSyncImportOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BitbucketSyncImportOpts struct

Name Type Description Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

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

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

BitbucketSyncsList

[]BitbucketSync BitbucketSyncsList(ctx, optional)

List Bitbucket syncs

List all Bitbucket repositories for which synchronisation with Phrase Strings is activated.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *BitbucketSyncsListOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a BitbucketSyncsListOpts struct

Name Type Description Notes
xPhraseAppOTP optional.String Two-Factor-Authentication token (optional)
accountId optional.String Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.

Return type

[]BitbucketSync

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]