All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| RepoSyncActivate | Post /accounts/{account_id}/repo_syncs/{id}/activate | Activate a Repo Sync |
| RepoSyncDeactivate | Post /accounts/{account_id}/repo_syncs/{id}/deactivate | Deactivate a Repo Sync |
| RepoSyncEventShow | Get /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event |
| RepoSyncEvents | Get /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History |
| RepoSyncExport | Post /accounts/{account_id}/repo_syncs/{id}/export | Export to code repository |
| RepoSyncImport | Post /accounts/{account_id}/repo_syncs/{id}/import | Import from code repository |
| RepoSyncList | Get /accounts/{account_id}/repo_syncs | Get Repo Syncs |
| RepoSyncShow | Get /accounts/{account_id}/repo_syncs/{id} | Get a single Repo Sync |
RepoSync RepoSyncActivate(ctx, accountId, id, optional)
Activate a Repo Sync
Activate a deactivated Repo Sync. Active syncs can be used to import and export translations, and imports to Phrase are automatically triggered by pushes to the repository, if configured.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *RepoSyncActivateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RepoSyncActivateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoSync RepoSyncDeactivate(ctx, accountId, id, optional)
Deactivate a Repo Sync
Deactivate an active Repo Sync. Import and export can't be performed on deactivated syncs and the pushes to the repository won't trigger the import to Phrase.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *RepoSyncDeactivateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RepoSyncDeactivateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoSyncEvent RepoSyncEventShow(ctx, accountId, repoSyncId, id, optional)
Get a single Repo Sync Event
Shows a single Repo Sync event.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| repoSyncId | string | Repo Sync ID | |
| id | string | ID | |
| optional | *RepoSyncEventShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RepoSyncEventShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RepoSyncEvent RepoSyncEvents(ctx, accountId, id, optional)
Repository Syncs History
Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *RepoSyncEventsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RepoSyncEventsOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoSyncEvent RepoSyncExport(ctx, accountId, id, optional)
Export to code repository
Beta: this feature will change in the future. Export translations from Phrase Strings to repository provider according to the .phrase.yml file within the code repository. Export is done asynchronously and may take several seconds depending on the project size.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *RepoSyncExportOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RepoSyncExportOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoSyncEvent RepoSyncImport(ctx, accountId, id, optional)
Import from code repository
Beta: this feature will change in the future. Import translations from repository provider to Phrase Strings according to the .phrase.yml file within the code repository. Import is done asynchronously and may take several seconds depending on the project size.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *RepoSyncImportOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RepoSyncImportOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]RepoSync RepoSyncList(ctx, accountId, optional)
Get Repo Syncs
Lists all Repo Syncs from an account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| optional | *RepoSyncListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RepoSyncListOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RepoSync RepoSyncShow(ctx, accountId, id, optional)
Get a single Repo Sync
Shows a single Repo Sync setting.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accountId | string | Account ID | |
| id | string | ID | |
| optional | *RepoSyncShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a RepoSyncShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]