Skip to content

RepoSyncEventsApi.md

Latest commit

 

History

History
148 lines (106 loc) · 6.57 KB

RepoSyncEventsApi.md

File metadata and controls

148 lines (106 loc) · 6.57 KB
Raw

phrase_api.RepoSyncEventsApi

All URIs are relative to https://api.phrase.com/v2

Method HTTP request Description
repo_sync_event_list GET /accounts/{account_id}/repo_syncs/{id}/events Repository Syncs History
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

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]

Authorization

Basic, 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 -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
* Link -
* Pagination -
400 Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry. * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
404 Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry. * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
429 Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying. * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

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

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

Authorization

Basic, 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 -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
400 Bad request. The request could not be parsed or a parameter failed validation. Verify the request body, the content type, and the parameter types, then retry. * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
404 Not found. The requested resource does not exist or is not visible to the authenticated user. Verify the identifiers in the request path and that the token has access to them, then retry. * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -
429 Too many requests. The rate limit has been exceeded. Wait until the time indicated by the `X-Rate-Limit-Reset` response header before retrying. * X-Rate-Limit-Limit -
* X-Rate-Limit-Remaining -
* X-Rate-Limit-Reset -

[Back to top] [Back to API list] [Back to Model list] [Back to README]