docs/RepoSyncsApi.md in phrase-3.1.0 vs docs/RepoSyncsApi.md in phrase-3.1.1

- old
+ new

@@ -2,23 +2,23 @@ All URIs are relative to *https://api.phrase.com/v2* Method | HTTP request | Description ------------- | ------------- | ------------- -[**repo_sync_activate**](RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{repo_sync_id}/activate | Activate a Repo Sync -[**repo_sync_deactivate**](RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{repo_sync_id}/deactivate | Deactivate a Repo Sync -[**repo_sync_events**](RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events | Repository Syncs History -[**repo_sync_export**](RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{repo_sync_id}/export | Export to code repository -[**repo_sync_import**](RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{repo_sync_id}/import | Import from code repository +[**repo_sync_activate**](RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{id}/activate | Activate a Repo Sync +[**repo_sync_deactivate**](RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{id}/deactivate | Deactivate a Repo Sync +[**repo_sync_events**](RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History +[**repo_sync_export**](RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{id}/export | Export to code repository +[**repo_sync_import**](RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{id}/import | Import from code repository [**repo_sync_list**](RepoSyncsApi.md#repo_sync_list) | **GET** /accounts/{account_id}/repo_syncs | Get Repo Syncs -[**repo_sync_show**](RepoSyncsApi.md#repo_sync_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id} | Get a single Repo Sync +[**repo_sync_show**](RepoSyncsApi.md#repo_sync_show) | **GET** /accounts/{account_id}/repo_syncs/{id} | Get a single Repo Sync ## repo_sync_activate -> RepoSync repo_sync_activate(account_id, repo_sync_id, opts) +> RepoSync repo_sync_activate(account_id, id, opts) 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. @@ -38,18 +38,18 @@ config.api_key_prefix['Authorization'] = 'token' end api_instance = Phrase::RepoSyncsApi.new account_id = 'account_id_example' # String | Account ID -repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID +id = 'id_example' # String | ID opts = { x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional) } begin #Activate a Repo Sync - result = api_instance.repo_sync_activate(account_id, repo_sync_id, opts) + result = api_instance.repo_sync_activate(account_id, id, opts) pp result rescue Phrase::ApiError => e puts "Exception when calling RepoSyncsApi->repo_sync_activate: #{e}" end ``` @@ -58,11 +58,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **String**| Account ID | - **repo_sync_id** | **String**| Repo Sync ID | + **id** | **String**| ID | **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] ### Return type Response<([**RepoSync**](RepoSync.md))> @@ -77,11 +77,11 @@ - **Accept**: application/json ## repo_sync_deactivate -> RepoSync repo_sync_deactivate(account_id, repo_sync_id, opts) +> RepoSync repo_sync_deactivate(account_id, id, opts) 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. @@ -101,18 +101,18 @@ config.api_key_prefix['Authorization'] = 'token' end api_instance = Phrase::RepoSyncsApi.new account_id = 'account_id_example' # String | Account ID -repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID +id = 'id_example' # String | ID opts = { x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional) } begin #Deactivate a Repo Sync - result = api_instance.repo_sync_deactivate(account_id, repo_sync_id, opts) + result = api_instance.repo_sync_deactivate(account_id, id, opts) pp result rescue Phrase::ApiError => e puts "Exception when calling RepoSyncsApi->repo_sync_deactivate: #{e}" end ``` @@ -121,11 +121,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **String**| Account ID | - **repo_sync_id** | **String**| Repo Sync ID | + **id** | **String**| ID | **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] ### Return type Response<([**RepoSync**](RepoSync.md))> @@ -140,11 +140,11 @@ - **Accept**: application/json ## repo_sync_events -> Array&lt;RepoSyncEvent&gt; repo_sync_events(account_id, repo_sync_id, opts) +> Array&lt;RepoSyncEvent&gt; repo_sync_events(account_id, id, opts) Repository Syncs History Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync. @@ -164,18 +164,18 @@ config.api_key_prefix['Authorization'] = 'token' end api_instance = Phrase::RepoSyncsApi.new account_id = 'account_id_example' # String | Account ID -repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID +id = 'id_example' # String | ID opts = { x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional) } begin #Repository Syncs History - result = api_instance.repo_sync_events(account_id, repo_sync_id, opts) + result = api_instance.repo_sync_events(account_id, id, opts) pp result rescue Phrase::ApiError => e puts "Exception when calling RepoSyncsApi->repo_sync_events: #{e}" end ``` @@ -184,11 +184,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **String**| Account ID | - **repo_sync_id** | **String**| Repo Sync ID | + **id** | **String**| ID | **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] ### Return type Response<([**Array&lt;RepoSyncEvent&gt;**](RepoSyncEvent.md))> @@ -203,11 +203,11 @@ - **Accept**: application/json ## repo_sync_export -> RepoSyncExport repo_sync_export(account_id, repo_sync_id, opts) +> RepoSyncExport repo_sync_export(account_id, id, opts) 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.* @@ -227,18 +227,18 @@ config.api_key_prefix['Authorization'] = 'token' end api_instance = Phrase::RepoSyncsApi.new account_id = 'account_id_example' # String | Account ID -repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID +id = 'id_example' # String | ID opts = { x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional) } begin #Export to code repository - result = api_instance.repo_sync_export(account_id, repo_sync_id, opts) + result = api_instance.repo_sync_export(account_id, id, opts) pp result rescue Phrase::ApiError => e puts "Exception when calling RepoSyncsApi->repo_sync_export: #{e}" end ``` @@ -247,11 +247,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **String**| Account ID | - **repo_sync_id** | **String**| Repo Sync ID | + **id** | **String**| ID | **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] ### Return type Response<([**RepoSyncExport**](RepoSyncExport.md))> @@ -266,11 +266,11 @@ - **Accept**: application/json ## repo_sync_import -> RepoSyncImport repo_sync_import(account_id, repo_sync_id, opts) +> RepoSyncImport repo_sync_import(account_id, id, opts) 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._ @@ -290,18 +290,18 @@ config.api_key_prefix['Authorization'] = 'token' end api_instance = Phrase::RepoSyncsApi.new account_id = 'account_id_example' # String | Account ID -repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID +id = 'id_example' # String | ID opts = { x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional) } begin #Import from code repository - result = api_instance.repo_sync_import(account_id, repo_sync_id, opts) + result = api_instance.repo_sync_import(account_id, id, opts) pp result rescue Phrase::ApiError => e puts "Exception when calling RepoSyncsApi->repo_sync_import: #{e}" end ``` @@ -310,11 +310,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **String**| Account ID | - **repo_sync_id** | **String**| Repo Sync ID | + **id** | **String**| ID | **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] ### Return type Response<([**RepoSyncImport**](RepoSyncImport.md))> @@ -390,11 +390,11 @@ - **Accept**: application/json ## repo_sync_show -> RepoSync repo_sync_show(account_id, repo_sync_id, opts) +> RepoSync repo_sync_show(account_id, id, opts) Get a single Repo Sync Shows a single Repo Sync setting. @@ -414,18 +414,18 @@ config.api_key_prefix['Authorization'] = 'token' end api_instance = Phrase::RepoSyncsApi.new account_id = 'account_id_example' # String | Account ID -repo_sync_id = 'repo_sync_id_example' # String | Repo Sync ID +id = 'id_example' # String | ID opts = { x_phrase_app_otp: 'x_phrase_app_otp_example' # String | Two-Factor-Authentication token (optional) } begin #Get a single Repo Sync - result = api_instance.repo_sync_show(account_id, repo_sync_id, opts) + result = api_instance.repo_sync_show(account_id, id, opts) pp result rescue Phrase::ApiError => e puts "Exception when calling RepoSyncsApi->repo_sync_show: #{e}" end ``` @@ -434,10 +434,10 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **account_id** | **String**| Account ID | - **repo_sync_id** | **String**| Repo Sync ID | + **id** | **String**| ID | **x_phrase_app_otp** | **String**| Two-Factor-Authentication token (optional) | [optional] ### Return type Response<([**RepoSync**](RepoSync.md))>