phrase_api.CommentReactionsApi

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

Method	HTTP request	Description
reaction_create	POST /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions	Create a reaction
reaction_delete	DELETE /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}	Delete a reaction
reaction_show	GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id}	Get a single reaction
reactions_list	GET /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions	List reactions

reaction_create

CommentReaction reaction_create(project_id, key_id, comment_id, x_phrase_app_otp=x_phrase_app_otp, branch=branch, emoji=emoji)

Create a reaction

Create a new reaction 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.CommentReactionsApi(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)
    branch = 'my-feature-branch' # str | specify the branch to use
    emoji = '👍' # str | specify the emoji for the reaction

    try:
        # Create a reaction
        api_response = api_instance.reaction_create(project_id, key_id, comment_id, x_phrase_app_otp=x_phrase_app_otp, branch=branch, emoji=emoji)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CommentReactionsApi->reaction_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
x_phrase_app_otp	str	Two-Factor-Authentication token (optional)	[optional]
branch	str	specify the branch to use	[optional]
emoji	str	specify the emoji for the reaction	[optional]

Return type

CommentReaction

Authorization

Basic, Token

HTTP request headers

Content-Type: Not defined
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 -
403	Forbidden	* 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]

reaction_delete

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

Delete a reaction

Delete an existing reaction.

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.CommentReactionsApi(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 reaction
        api_instance.reaction_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 CommentReactionsApi->reaction_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	* X-Rate-Limit-Limit - * X-Rate-Limit-Remaining - * X-Rate-Limit-Reset -
403	Forbidden	* 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]

reaction_show

CommentReaction reaction_show(project_id, key_id, comment_id, id, x_phrase_app_otp=x_phrase_app_otp, branch=branch)

Get a single reaction

Get details on a single reaction.

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.CommentReactionsApi(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 reaction
        api_response = api_instance.reaction_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 CommentReactionsApi->reaction_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

CommentReaction

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 -
403	Forbidden	* 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]

reactions_list

List[CommentReaction] reactions_list(project_id, key_id, comment_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page, branch=branch)

List reactions

List all reactions 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.CommentReactionsApi(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

    try:
        # List reactions
        api_response = api_instance.reactions_list(project_id, key_id, comment_id, x_phrase_app_otp=x_phrase_app_otp, page=page, per_page=per_page, branch=branch)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CommentReactionsApi->reactions_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]

Return type

List[CommentReaction]

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 -
403	Forbidden	* 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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

phrase_api.CommentReactionsApi

reaction_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reaction_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reaction_show

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reactions_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

CommentReactionsApi.md

Latest commit

History

CommentReactionsApi.md

File metadata and controls

phrase_api.CommentReactionsApi

reaction_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reaction_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reaction_show

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

reactions_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details