-
Notifications
You must be signed in to change notification settings - Fork 3
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
17d33fb
commit df5acd5
Showing
13 changed files
with
522 additions
and
441 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,148 @@ | ||
# phrase_api.RepoSyncEventsApi | ||
|
||
All URIs are relative to *https://api.phrase.com/v2* | ||
|
||
Method | HTTP request | Description | ||
------------- | ------------- | ------------- | ||
[**repo_sync_event_list**](RepoSyncEventsApi.md#repo_sync_event_list) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History | ||
[**repo_sync_event_show**](RepoSyncEventsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event | ||
|
||
|
||
# **repo_sync_event_list** | ||
> List[RepoSyncEvent] repo_sync_event_list(account_id, id, x_phrase_app_otp=x_phrase_app_otp) | ||
Repository Syncs History | ||
|
||
Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync. | ||
|
||
### Example | ||
|
||
```python | ||
from __future__ import print_function | ||
import time | ||
import phrase_api | ||
from phrase_api.rest import ApiException | ||
from pprint import pprint | ||
|
||
configuration = phrase_api.Configuration() | ||
configuration.api_key['Authorization'] = 'YOUR_API_KEY' | ||
configuration.api_key_prefix['Authorization'] = 'token' | ||
|
||
# Enter a context with an instance of the API client | ||
with phrase_api.ApiClient(configuration) as api_client: | ||
# Create an instance of the API class | ||
api_instance = phrase_api.RepoSyncEventsApi(api_client) | ||
account_id = 'account_id_example' # str | Account ID (required) | ||
id = 'id_example' # str | ID (required) | ||
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional) | ||
|
||
try: | ||
# Repository Syncs History | ||
api_response = api_instance.repo_sync_event_list(account_id, id, x_phrase_app_otp=x_phrase_app_otp) | ||
pprint(api_response) | ||
except ApiException as e: | ||
print("Exception when calling RepoSyncEventsApi->repo_sync_event_list: %s\n" % e) | ||
``` | ||
|
||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**account_id** | **str**| Account ID | | ||
**id** | **str**| ID | | ||
**x_phrase_app_otp** | **str**| 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> | | ||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | ||
|
||
# **repo_sync_event_show** | ||
> RepoSyncEvent repo_sync_event_show(account_id, repo_sync_id, id, x_phrase_app_otp=x_phrase_app_otp) | ||
Get a single Repo Sync Event | ||
|
||
Shows a single Repo Sync event. | ||
|
||
### Example | ||
|
||
```python | ||
from __future__ import print_function | ||
import time | ||
import phrase_api | ||
from phrase_api.rest import ApiException | ||
from pprint import pprint | ||
|
||
configuration = phrase_api.Configuration() | ||
configuration.api_key['Authorization'] = 'YOUR_API_KEY' | ||
configuration.api_key_prefix['Authorization'] = 'token' | ||
|
||
# Enter a context with an instance of the API client | ||
with phrase_api.ApiClient(configuration) as api_client: | ||
# Create an instance of the API class | ||
api_instance = phrase_api.RepoSyncEventsApi(api_client) | ||
account_id = 'account_id_example' # str | Account ID (required) | ||
repo_sync_id = 'repo_sync_id_example' # str | Repo Sync ID (required) | ||
id = 'id_example' # str | ID (required) | ||
x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional) | ||
|
||
try: | ||
# Get a single Repo Sync Event | ||
api_response = api_instance.repo_sync_event_show(account_id, repo_sync_id, id, x_phrase_app_otp=x_phrase_app_otp) | ||
pprint(api_response) | ||
except ApiException as e: | ||
print("Exception when calling RepoSyncEventsApi->repo_sync_event_show: %s\n" % e) | ||
``` | ||
|
||
|
||
### Parameters | ||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**account_id** | **str**| Account ID | | ||
**repo_sync_id** | **str**| Repo Sync ID | | ||
**id** | **str**| ID | | ||
**x_phrase_app_otp** | **str**| 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> | | ||
|
||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) | ||
|
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
Oops, something went wrong.