phrase_api.DistributionsApi

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

Method	HTTP request	Description
distribution_create	POST /accounts/{account_id}/distributions	Create a distribution
distribution_delete	DELETE /accounts/{account_id}/distributions/{id}	Delete a distribution
distribution_show	GET /accounts/{account_id}/distributions/{id}	Get a single distribution
distribution_update	PATCH /accounts/{account_id}/distributions/{id}	Update a distribution
distributions_list	GET /accounts/{account_id}/distributions	List distributions

distribution_create

Distribution distribution_create(account_id, distribution_create_parameters, x_phrase_app_otp=x_phrase_app_otp)

Create a distribution

Create a new distribution.

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.DistributionsApi(api_client)
    account_id = 'account_id_example' # str | Account ID (required)
    distribution_create_parameters = phrase_api.DistributionCreateParameters() # DistributionCreateParameters |  (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Create a distribution
        api_response = api_instance.distribution_create(account_id, distribution_create_parameters, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DistributionsApi->distribution_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	Account ID
distribution_create_parameters	DistributionCreateParameters
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]

Return type

Distribution

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* 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]

distribution_delete

distribution_delete(account_id, id, x_phrase_app_otp=x_phrase_app_otp)

Delete a distribution

Delete an existing distribution.

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.DistributionsApi(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:
        # Delete a distribution
        api_instance.distribution_delete(account_id, id, x_phrase_app_otp=x_phrase_app_otp)
    except ApiException as e:
        print("Exception when calling DistributionsApi->distribution_delete: %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

void (empty response body)

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	The resource was deleted successfully.	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
400	Bad request	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* 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]

distribution_show

Distribution distribution_show(account_id, id, x_phrase_app_otp=x_phrase_app_otp)

Get a single distribution

Get details on a single distribution.

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.DistributionsApi(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:
        # Get a single distribution
        api_response = api_instance.distribution_show(account_id, id, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DistributionsApi->distribution_show: %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

Distribution

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	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* 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]

distribution_update

Distribution distribution_update(account_id, id, distribution_update_parameters, x_phrase_app_otp=x_phrase_app_otp)

Update a distribution

Update an existing distribution.

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.DistributionsApi(api_client)
    account_id = 'account_id_example' # str | Account ID (required)
    id = 'id_example' # str | ID (required)
    distribution_update_parameters = phrase_api.DistributionUpdateParameters() # DistributionUpdateParameters |  (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Update a distribution
        api_response = api_instance.distribution_update(account_id, id, distribution_update_parameters, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DistributionsApi->distribution_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	Account ID
id	str	ID
distribution_update_parameters	DistributionUpdateParameters
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]

Return type

Distribution

Authorization

Basic, Token

HTTP request headers

Content-Type: application/json
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	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* 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]

distributions_list

List[DistributionPreview] distributions_list(account_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page)

List distributions

List all distributions for the given account.

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.DistributionsApi(api_client)
    account_id = 'account_id_example' # str | Account ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    page = 1 # int | Page number
    per_page = 25 # int | Limit on the number of objects to be returned, between 1 and 100. 25 by default

    try:
        # List distributions
        api_response = api_instance.distributions_list(account_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DistributionsApi->distributions_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_id	str	Account ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]
page	int	Page number	[optional]
per_page	int	Limit on the number of objects to be returned, between 1 and 100. 25 by default	[optional]

Return type

List[DistributionPreview]

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 - * Link - * Pagination -
400	Bad request	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
404	Not Found	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
429	Rate Limiting	* 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]

Files

DistributionsApi.md

Latest commit

History

DistributionsApi.md

File metadata and controls

phrase_api.DistributionsApi

distribution_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

distribution_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

distribution_show

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

distribution_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

distributions_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details