phrase_api.CommentRepliesApi

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

Method	HTTP request	Description
replies_list	GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies	List replies
reply_create	POST /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies	Create a reply
reply_delete	DELETE /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}	Delete a reply
reply_mark_as_read	PATCH /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read	Mark a reply as read
reply_mark_as_unread	PATCH /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread	Mark a reply as unread
reply_show	GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}	Get a single reply

replies_list

List[Comment] replies_list(project_id, key_id, comment_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page, branch=branch, query=query, filters=filters, order=order)

List replies

List all replies for a comment.

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.CommentRepliesApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    key_id = 'key_id_example' # str | Translation Key ID (required)
    comment_id = 'comment_id_example' # str | Comment 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
    branch = 'my-feature-branch' # str | specify the branch to use
    query = 'Some comment content' # str | Search query for comment messages
    filters = ['[\"read\",\"unread\"]'] # List[str] | Specify the filter for the comments
    order = 'desc' # str | Order direction. Can be one of: asc, desc.

    try:
        # List replies
        api_response = api_instance.replies_list(project_id, key_id, comment_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page, branch=branch, query=query, filters=filters, order=order)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CommentRepliesApi->replies_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
key_id	str	Translation Key ID
comment_id	str	Comment 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]
branch	str	specify the branch to use	[optional]
query	str	Search query for comment messages	[optional]
filters	List[str]	Specify the filter for the comments	[optional]
order	str	Order direction. Can be one of: asc, desc.	[optional]

Return type

List[Comment]

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. 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 -
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* 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]

reply_create

Comment reply_create(project_id, key_id, comment_id, comment_create_parameters1, x_phrase_app_otp=x_phrase_app_otp)

Create a reply

Create a new reply for a comment.

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.CommentRepliesApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    key_id = 'key_id_example' # str | Translation Key ID (required)
    comment_id = 'comment_id_example' # str | Comment ID (required)
    comment_create_parameters1 = phrase_api.CommentCreateParameters1() # CommentCreateParameters1 |  (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)

    try:
        # Create a reply
        api_response = api_instance.reply_create(project_id, key_id, comment_id, comment_create_parameters1, x_phrase_app_otp=x_phrase_app_otp)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CommentRepliesApi->reply_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
key_id	str	Translation Key ID
comment_id	str	Comment ID
comment_create_parameters1	CommentCreateParameters1
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]

Return type

Comment

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. 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 -
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* 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]

reply_delete

reply_delete(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Delete a reply

Delete an existing reply.

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.CommentRepliesApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    key_id = 'key_id_example' # str | Translation Key ID (required)
    comment_id = 'comment_id_example' # str | Comment ID (required)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    branch = 'my-feature-branch' # str | specify the branch to use

    try:
        # Delete a reply
        api_instance.reply_delete(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
    except ApiException as e:
        print("Exception when calling CommentRepliesApi->reply_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
key_id	str	Translation Key ID
comment_id	str	Comment ID
id	str	ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]
branch	str	specify the branch to use	[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. 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 -
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* 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]

reply_mark_as_read

reply_mark_as_read(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Mark a reply as read

Mark a reply as read.

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.CommentRepliesApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    key_id = 'key_id_example' # str | Translation Key ID (required)
    comment_id = 'comment_id_example' # str | Comment ID (required)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    branch = 'my-feature-branch' # str | specify the branch to use

    try:
        # Mark a reply as read
        api_instance.reply_mark_as_read(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
    except ApiException as e:
        print("Exception when calling CommentRepliesApi->reply_mark_as_read: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
key_id	str	Translation Key ID
comment_id	str	Comment ID
id	str	ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]
branch	str	specify the branch to use	[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. 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 -
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* 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]

reply_mark_as_unread

reply_mark_as_unread(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Mark a reply as unread

Mark a reply as unread.

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.CommentRepliesApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    key_id = 'key_id_example' # str | Translation Key ID (required)
    comment_id = 'comment_id_example' # str | Comment ID (required)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    branch = 'my-feature-branch' # str | specify the branch to use

    try:
        # Mark a reply as unread
        api_instance.reply_mark_as_unread(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
    except ApiException as e:
        print("Exception when calling CommentRepliesApi->reply_mark_as_unread: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
key_id	str	Translation Key ID
comment_id	str	Comment ID
id	str	ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]
branch	str	specify the branch to use	[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. 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 -
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* 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]

reply_show

Comment reply_show(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Get a single reply

Get details on a single reply.

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.CommentRepliesApi(api_client)
    project_id = 'project_id_example' # str | Project ID (required)
    key_id = 'key_id_example' # str | Translation Key ID (required)
    comment_id = 'comment_id_example' # str | Comment ID (required)
    id = 'id_example' # str | ID (required)
    x_phrase_app_otp = 'x_phrase_app_otp_example' # str | Two-Factor-Authentication token (optional)
    branch = 'my-feature-branch' # str | specify the branch to use

    try:
        # Get a single reply
        api_response = api_instance.reply_show(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CommentRepliesApi->reply_show: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_id	str	Project ID
key_id	str	Translation Key ID
comment_id	str	Comment ID
id	str	ID
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]
branch	str	specify the branch to use	[optional]

Return type

Comment

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 -
403	Forbidden. The credentials are valid but not permitted for this request: the access token may lack the required scope, the user may lack permission on the resource, or the account plan may not include the feature. Use a token with the required scope on an account and user that hold the necessary permissions.	* 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]

Uh oh!

FilesExpand file tree

CommentRepliesApi.md

Latest commit

History

CommentRepliesApi.md

File metadata and controls

phrase_api.CommentRepliesApi

replies_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reply_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reply_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reply_mark_as_read

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reply_mark_as_unread

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reply_show

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details