Skip to content

Commit

Permalink
Deploying from phrase/openapi@033be100
Browse files Browse the repository at this point in the history
  • Loading branch information
Phrase committed Dec 20, 2024
1 parent 17d33fb commit df5acd5
Show file tree
Hide file tree
Showing 13 changed files with 522 additions and 441 deletions.
3 changes: 3 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ docs/RepliesListParameters.md
docs/RepoSync.md
docs/RepoSyncEvent.md
docs/RepoSyncEventErrorsInner.md
docs/RepoSyncEventsApi.md
docs/RepoSyncsApi.md
docs/ReportsApi.md
docs/Screenshot.md
Expand Down Expand Up @@ -309,6 +310,7 @@ phrase_api/api/projects_api.py
phrase_api/api/quality_performance_score_api.py
phrase_api/api/release_triggers_api.py
phrase_api/api/releases_api.py
phrase_api/api/repo_sync_events_api.py
phrase_api/api/repo_syncs_api.py
phrase_api/api/reports_api.py
phrase_api/api/screenshot_markers_api.py
Expand Down Expand Up @@ -736,6 +738,7 @@ test/test_replies_list_parameters.py
test/test_repo_sync.py
test/test_repo_sync_event.py
test/test_repo_sync_event_errors_inner.py
test/test_repo_sync_events_api.py
test/test_repo_syncs_api.py
test/test_reports_api.py
test/test_screenshot.py
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -326,10 +326,10 @@ Class | Method | HTTP request | Description
*ReleasesApi* | [**release_show**](docs/ReleasesApi.md#release_show) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Get a single release
*ReleasesApi* | [**release_update**](docs/ReleasesApi.md#release_update) | **PATCH** /accounts/{account_id}/distributions/{distribution_id}/releases/{id} | Update a release
*ReleasesApi* | [**releases_list**](docs/ReleasesApi.md#releases_list) | **GET** /accounts/{account_id}/distributions/{distribution_id}/releases | List releases
*RepoSyncEventsApi* | [**repo_sync_event_list**](docs/RepoSyncEventsApi.md#repo_sync_event_list) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
*RepoSyncEventsApi* | [**repo_sync_event_show**](docs/RepoSyncEventsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
*RepoSyncsApi* | [**repo_sync_activate**](docs/RepoSyncsApi.md#repo_sync_activate) | **POST** /accounts/{account_id}/repo_syncs/{id}/activate | Activate a Repo Sync
*RepoSyncsApi* | [**repo_sync_deactivate**](docs/RepoSyncsApi.md#repo_sync_deactivate) | **POST** /accounts/{account_id}/repo_syncs/{id}/deactivate | Deactivate a Repo Sync
*RepoSyncsApi* | [**repo_sync_event_show**](docs/RepoSyncsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
*RepoSyncsApi* | [**repo_sync_events**](docs/RepoSyncsApi.md#repo_sync_events) | **GET** /accounts/{account_id}/repo_syncs/{id}/events | Repository Syncs History
*RepoSyncsApi* | [**repo_sync_export**](docs/RepoSyncsApi.md#repo_sync_export) | **POST** /accounts/{account_id}/repo_syncs/{id}/export | Export to code repository
*RepoSyncsApi* | [**repo_sync_import**](docs/RepoSyncsApi.md#repo_sync_import) | **POST** /accounts/{account_id}/repo_syncs/{id}/import | Import from code repository
*RepoSyncsApi* | [**repo_sync_list**](docs/RepoSyncsApi.md#repo_sync_list) | **GET** /accounts/{account_id}/repo_syncs | Get Repo Syncs
Expand Down
2 changes: 1 addition & 1 deletion docs/RepoSyncEvent.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional]
**event_type** | **str** | | [optional]
**type** | **str** | | [optional]
**created_at** | **datetime** | | [optional]
**status** | **str** | | [optional]
**pull_request_url** | **str** | URL of the pull request created on export | [optional]
Expand Down
148 changes: 148 additions & 0 deletions docs/RepoSyncEventsApi.md
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)

140 changes: 0 additions & 140 deletions docs/RepoSyncsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**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_event_show**](RepoSyncsApi.md#repo_sync_event_show) | **GET** /accounts/{account_id}/repo_syncs/{repo_sync_id}/events/{id} | Get a single Repo Sync Event
[**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
Expand Down Expand Up @@ -150,144 +148,6 @@ Name | Type | Description | Notes

[[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.RepoSyncsApi(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 RepoSyncsApi->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)

# **repo_sync_events**
> List[RepoSyncEvent] repo_sync_events(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.RepoSyncsApi(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_events(account_id, id, x_phrase_app_otp=x_phrase_app_otp)
pprint(api_response)
except ApiException as e:
print("Exception when calling RepoSyncsApi->repo_sync_events: %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_export**
> RepoSyncEvent repo_sync_export(account_id, id, x_phrase_app_otp=x_phrase_app_otp)
Expand Down
1 change: 1 addition & 0 deletions phrase_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
from phrase_api.api.quality_performance_score_api import QualityPerformanceScoreApi
from phrase_api.api.release_triggers_api import ReleaseTriggersApi
from phrase_api.api.releases_api import ReleasesApi
from phrase_api.api.repo_sync_events_api import RepoSyncEventsApi
from phrase_api.api.repo_syncs_api import RepoSyncsApi
from phrase_api.api.reports_api import ReportsApi
from phrase_api.api.screenshot_markers_api import ScreenshotMarkersApi
Expand Down
1 change: 1 addition & 0 deletions phrase_api/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
from phrase_api.api.quality_performance_score_api import QualityPerformanceScoreApi
from phrase_api.api.release_triggers_api import ReleaseTriggersApi
from phrase_api.api.releases_api import ReleasesApi
from phrase_api.api.repo_sync_events_api import RepoSyncEventsApi
from phrase_api.api.repo_syncs_api import RepoSyncsApi
from phrase_api.api.reports_api import ReportsApi
from phrase_api.api.screenshot_markers_api import ScreenshotMarkersApi
Expand Down
Loading

0 comments on commit df5acd5

Please sign in to comment.