-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying from phrase/openapi@033be100
- Loading branch information
Phrase
committed
Dec 20, 2024
1 parent
851b28e
commit 5faa764
Showing
229 changed files
with
856 additions
and
755 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| # RepoSyncEventsApi | ||
|
|
||
| All URIs are relative to *https://api.phrase.com/v2* | ||
|
|
||
| Method | HTTP request | Description | ||
| ------------- | ------------- | ------------- | ||
| [**repoSyncEventList**](RepoSyncEventsApi.md#repoSyncEventList) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History | ||
| [**repoSyncEventShow**](RepoSyncEventsApi.md#repoSyncEventShow) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event | ||
|
|
||
|
|
||
| <a name="repoSyncEventList"></a> | ||
| # **repoSyncEventList** | ||
| > List<RepoSyncEvent> repoSyncEventList(accountId, id, xPhraseAppOTP) | ||
| Repository Syncs History | ||
|
|
||
| Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync. | ||
|
|
||
| ### Example | ||
| ```java | ||
| // Import classes: | ||
| import com.phrase.client.ApiClient; | ||
| import com.phrase.client.ApiException; | ||
| import com.phrase.client.Configuration; | ||
| import com.phrase.client.auth.*; | ||
| import com.phrase.client.models.*; | ||
| import com.phrase.client.api.RepoSyncEventsApi; | ||
|
|
||
| public class Example { | ||
| public static void main(String[] args) { | ||
| ApiClient defaultClient = Configuration.getDefaultApiClient(); | ||
| defaultClient.setBasePath("https://api.phrase.com/v2"); | ||
|
|
||
| // Configure HTTP basic authorization: Basic | ||
| HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); | ||
| Basic.setUsername("YOUR USERNAME"); | ||
| Basic.setPassword("YOUR PASSWORD"); | ||
|
|
||
| // Configure API key authorization: Token | ||
| ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); | ||
| Token.setApiKey("YOUR API KEY"); | ||
| Token.setApiKeyPrefix("token"); | ||
|
|
||
| RepoSyncEventsApi apiInstance = new RepoSyncEventsApi(defaultClient); | ||
| String accountId = "accountId_example"; // String | Account ID | ||
| String id = "id_example"; // String | ID | ||
| String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional) | ||
| try { | ||
| List<RepoSyncEvent> result = apiInstance.repoSyncEventList(accountId, id, xPhraseAppOTP); | ||
| System.out.println(result); | ||
| } catch (ApiException e) { | ||
| System.err.println("Exception when calling RepoSyncEventsApi#repoSyncEventList"); | ||
| System.err.println("Status code: " + e.getCode()); | ||
| System.err.println("Reason: " + e.getResponseBody()); | ||
| System.err.println("Response headers: " + e.getResponseHeaders()); | ||
| e.printStackTrace(); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **accountId** | **String**| Account ID | | ||
| **id** | **String**| ID | | ||
| **xPhraseAppOTP** | **String**| Two-Factor-Authentication token (optional) | [optional] | ||
|
|
||
| ### Return type | ||
|
|
||
| [**List<RepoSyncEvent>**](RepoSyncEvent.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [Basic](../README.md#Basic), [Token](../README.md#Token) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **200** | Successful response | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> * Link - <br> * Pagination - <br> | | ||
| **400** | Bad request | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
| **404** | Not Found | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
| **429** | Rate Limiting | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
|
|
||
| <a name="repoSyncEventShow"></a> | ||
| # **repoSyncEventShow** | ||
| > RepoSyncEvent repoSyncEventShow(accountId, repoSyncId, id, xPhraseAppOTP) | ||
| Get a single Repo Sync Event | ||
|
|
||
| Shows a single Repo Sync event. | ||
|
|
||
| ### Example | ||
| ```java | ||
| // Import classes: | ||
| import com.phrase.client.ApiClient; | ||
| import com.phrase.client.ApiException; | ||
| import com.phrase.client.Configuration; | ||
| import com.phrase.client.auth.*; | ||
| import com.phrase.client.models.*; | ||
| import com.phrase.client.api.RepoSyncEventsApi; | ||
|
|
||
| public class Example { | ||
| public static void main(String[] args) { | ||
| ApiClient defaultClient = Configuration.getDefaultApiClient(); | ||
| defaultClient.setBasePath("https://api.phrase.com/v2"); | ||
|
|
||
| // Configure HTTP basic authorization: Basic | ||
| HttpBasicAuth Basic = (HttpBasicAuth) defaultClient.getAuthentication("Basic"); | ||
| Basic.setUsername("YOUR USERNAME"); | ||
| Basic.setPassword("YOUR PASSWORD"); | ||
|
|
||
| // Configure API key authorization: Token | ||
| ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); | ||
| Token.setApiKey("YOUR API KEY"); | ||
| Token.setApiKeyPrefix("token"); | ||
|
|
||
| RepoSyncEventsApi apiInstance = new RepoSyncEventsApi(defaultClient); | ||
| String accountId = "accountId_example"; // String | Account ID | ||
| String repoSyncId = "repoSyncId_example"; // String | Repo Sync ID | ||
| String id = "id_example"; // String | ID | ||
| String xPhraseAppOTP = "xPhraseAppOTP_example"; // String | Two-Factor-Authentication token (optional) | ||
| try { | ||
| RepoSyncEvent result = apiInstance.repoSyncEventShow(accountId, repoSyncId, id, xPhraseAppOTP); | ||
| System.out.println(result); | ||
| } catch (ApiException e) { | ||
| System.err.println("Exception when calling RepoSyncEventsApi#repoSyncEventShow"); | ||
| System.err.println("Status code: " + e.getCode()); | ||
| System.err.println("Reason: " + e.getResponseBody()); | ||
| System.err.println("Response headers: " + e.getResponseHeaders()); | ||
| e.printStackTrace(); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **accountId** | **String**| Account ID | | ||
| **repoSyncId** | **String**| Repo Sync ID | | ||
| **id** | **String**| ID | | ||
| **xPhraseAppOTP** | **String**| Two-Factor-Authentication token (optional) | [optional] | ||
|
|
||
| ### Return type | ||
|
|
||
| [**RepoSyncEvent**](RepoSyncEvent.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [Basic](../README.md#Basic), [Token](../README.md#Token) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: Not defined | ||
| - **Accept**: application/json | ||
|
|
||
| ### HTTP response details | ||
| | Status code | Description | Response headers | | ||
| |-------------|-------------|------------------| | ||
| **200** | OK | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
| **400** | Bad request | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
| **404** | Not Found | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
| **429** | Rate Limiting | * X-Rate-Limit-Limit - <br> * X-Rate-Limit-Remaining - <br> * X-Rate-Limit-Reset - <br> | | ||
|
|
Oops, something went wrong.