phrasetms_client.ConversationsApi

All URIs are relative to https://cloud.memsource.com/web

Method	HTTP request	Description
add_lqa_comment1	POST /api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId}/comments	Add LQA comment
add_plain_comment2	POST /api2/v3/jobs/{jobUid}/conversations/plains/{conversationId}/comments	Add plain comment
create_lqa_conversation1	POST /api2/v2/jobs/{jobUid}/conversations/lqas	Create LQA conversation
create_segment_target_conversation1	POST /api2/v3/jobs/{jobUid}/conversations/plains	Create plain conversation
delete_lqa_comment	DELETE /api2/v1/jobs/{jobUid}/conversations/lqas/{conversationId}/comments/{commentId}	Delete LQA comment
delete_lqa_conversation	DELETE /api2/v1/jobs/{jobUid}/conversations/lqas/{conversationId}	Delete LQA conversation
delete_plain_comment	DELETE /api2/v1/jobs/{jobUid}/conversations/plains/{conversationId}/comments/{commentId}	Delete plain comment
delete_plain_conversation	DELETE /api2/v1/jobs/{jobUid}/conversations/plains/{conversationId}	Delete plain conversation
find_conversations	POST /api2/v1/jobs/conversations/find	Find all conversation
get_lqa_conversation	GET /api2/v1/jobs/{jobUid}/conversations/lqas/{conversationId}	Get LQA conversation
get_plain_conversation	GET /api2/v1/jobs/{jobUid}/conversations/plains/{conversationId}	Get plain conversation
list_all_conversations	GET /api2/v1/jobs/{jobUid}/conversations	List all conversations
list_lqa_conversations	GET /api2/v1/jobs/{jobUid}/conversations/lqas	List LQA conversations
list_plain_conversations	GET /api2/v1/jobs/{jobUid}/conversations/plains	List plain conversations
update_lqa_comment1	PUT /api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId}/comments/{commentId}	Edit LQA comment
update_lqa_conversation1	PUT /api2/v2/jobs/{jobUid}/conversations/lqas/{conversationId}	Update LQA conversation
update_plain_comment1	PUT /api2/v3/jobs/{jobUid}/conversations/plains/{conversationId}/comments/{commentId}	Edit plain comment
update_plain_conversation	PUT /api2/v1/jobs/{jobUid}/conversations/plains/{conversationId}	Edit plain conversation

add_lqa_comment1

AddLqaCommentResultDto add_lqa_comment1(job_uid, conversation_id, body=body)

Add LQA comment

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.add_comment_dto import AddCommentDto
from phrasetms_client.models.add_lqa_comment_result_dto import AddLqaCommentResultDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 
    body = phrasetms_client.AddCommentDto() # AddCommentDto |  (optional)

    try:
        # Add LQA comment
        api_response = api_instance.add_lqa_comment1(job_uid, conversation_id, body=body)
        print("The response of ConversationsApi->add_lqa_comment1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->add_lqa_comment1: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
conversation_id	str
body	AddCommentDto	[optional]

Return type

AddLqaCommentResultDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

add_plain_comment2

AddPlainCommentResultDto add_plain_comment2(job_uid, conversation_id, body=body)

Add plain comment

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.add_comment_dto import AddCommentDto
from phrasetms_client.models.add_plain_comment_result_dto import AddPlainCommentResultDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 
    body = phrasetms_client.AddCommentDto() # AddCommentDto |  (optional)

    try:
        # Add plain comment
        api_response = api_instance.add_plain_comment2(job_uid, conversation_id, body=body)
        print("The response of ConversationsApi->add_plain_comment2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->add_plain_comment2: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
conversation_id	str
body	AddCommentDto	[optional]

Return type

AddPlainCommentResultDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

create_lqa_conversation1

LQAConversationDto create_lqa_conversation1(job_uid, body=body)

Create LQA conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.create_lqa_conversation_dto import CreateLqaConversationDto
from phrasetms_client.models.lqa_conversation_dto import LQAConversationDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    body = phrasetms_client.CreateLqaConversationDto() # CreateLqaConversationDto |  (optional)

    try:
        # Create LQA conversation
        api_response = api_instance.create_lqa_conversation1(job_uid, body=body)
        print("The response of ConversationsApi->create_lqa_conversation1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->create_lqa_conversation1: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_uid	str
body	CreateLqaConversationDto		[optional]

Return type

LQAConversationDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

create_segment_target_conversation1

PlainConversationDto create_segment_target_conversation1(job_uid, body=body)

Create plain conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.create_plain_conversation_dto import CreatePlainConversationDto
from phrasetms_client.models.plain_conversation_dto import PlainConversationDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    body = phrasetms_client.CreatePlainConversationDto() # CreatePlainConversationDto |  (optional)

    try:
        # Create plain conversation
        api_response = api_instance.create_segment_target_conversation1(job_uid, body=body)
        print("The response of ConversationsApi->create_segment_target_conversation1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->create_segment_target_conversation1: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_uid	str
body	CreatePlainConversationDto		[optional]

Return type

PlainConversationDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

delete_lqa_comment

delete_lqa_comment(job_uid, conversation_id, comment_id)

Delete LQA comment

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 
    comment_id = 'comment_id_example' # str | 

    try:
        # Delete LQA comment
        api_instance.delete_lqa_comment(job_uid, conversation_id, comment_id)
    except Exception as e:
        print("Exception when calling ConversationsApi->delete_lqa_comment: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_uid	str
conversation_id	str
comment_id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

delete_lqa_conversation

delete_lqa_conversation(job_uid, conversation_id)

Delete LQA conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 

    try:
        # Delete LQA conversation
        api_instance.delete_lqa_conversation(job_uid, conversation_id)
    except Exception as e:
        print("Exception when calling ConversationsApi->delete_lqa_conversation: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_uid	str
conversation_id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

delete_plain_comment

delete_plain_comment(job_uid, conversation_id, comment_id)

Delete plain comment

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 
    comment_id = 'comment_id_example' # str | 

    try:
        # Delete plain comment
        api_instance.delete_plain_comment(job_uid, conversation_id, comment_id)
    except Exception as e:
        print("Exception when calling ConversationsApi->delete_plain_comment: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_uid	str
conversation_id	str
comment_id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

delete_plain_conversation

delete_plain_conversation(job_uid, conversation_id)

Delete plain conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 

    try:
        # Delete plain conversation
        api_instance.delete_plain_conversation(job_uid, conversation_id)
    except Exception as e:
        print("Exception when calling ConversationsApi->delete_plain_conversation: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_uid	str
conversation_id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

find_conversations

ConversationListDto find_conversations(body=body)

Find all conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.conversation_list_dto import ConversationListDto
from phrasetms_client.models.find_conversations_dto import FindConversationsDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    body = phrasetms_client.FindConversationsDto() # FindConversationsDto |  (optional)

    try:
        # Find all conversation
        api_response = api_instance.find_conversations(body=body)
        print("The response of ConversationsApi->find_conversations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->find_conversations: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	FindConversationsDto		[optional]

Return type

ConversationListDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

get_lqa_conversation

LQAConversationDto get_lqa_conversation(job_uid, conversation_id)

Get LQA conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.lqa_conversation_dto import LQAConversationDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 

    try:
        # Get LQA conversation
        api_response = api_instance.get_lqa_conversation(job_uid, conversation_id)
        print("The response of ConversationsApi->get_lqa_conversation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->get_lqa_conversation: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_uid	str
conversation_id	str

Return type

LQAConversationDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

get_plain_conversation

PlainConversationDto get_plain_conversation(job_uid, conversation_id)

Get plain conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.plain_conversation_dto import PlainConversationDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 

    try:
        # Get plain conversation
        api_response = api_instance.get_plain_conversation(job_uid, conversation_id)
        print("The response of ConversationsApi->get_plain_conversation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->get_plain_conversation: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_uid	str
conversation_id	str

Return type

PlainConversationDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

list_all_conversations

ConversationListDto list_all_conversations(job_uid, include_deleted=include_deleted, since=since)

List all conversations

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.conversation_list_dto import ConversationListDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    include_deleted = False # bool |  (optional) (default to False)
    since = 'since_example' # str |  (optional)

    try:
        # List all conversations
        api_response = api_instance.list_all_conversations(job_uid, include_deleted=include_deleted, since=since)
        print("The response of ConversationsApi->list_all_conversations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->list_all_conversations: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
include_deleted	bool	[optional] [default to False]
since	str	[optional]

Return type

ConversationListDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

list_lqa_conversations

LQAConversationsListDto list_lqa_conversations(job_uid, include_deleted=include_deleted, since=since)

List LQA conversations

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.lqa_conversations_list_dto import LQAConversationsListDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    include_deleted = False # bool |  (optional) (default to False)
    since = 'since_example' # str |  (optional)

    try:
        # List LQA conversations
        api_response = api_instance.list_lqa_conversations(job_uid, include_deleted=include_deleted, since=since)
        print("The response of ConversationsApi->list_lqa_conversations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->list_lqa_conversations: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
include_deleted	bool	[optional] [default to False]
since	str	[optional]

Return type

LQAConversationsListDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

list_plain_conversations

PlainConversationsListDto list_plain_conversations(job_uid, include_deleted=include_deleted, since=since)

List plain conversations

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.plain_conversations_list_dto import PlainConversationsListDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    include_deleted = False # bool |  (optional) (default to False)
    since = 'since_example' # str |  (optional)

    try:
        # List plain conversations
        api_response = api_instance.list_plain_conversations(job_uid, include_deleted=include_deleted, since=since)
        print("The response of ConversationsApi->list_plain_conversations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->list_plain_conversations: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
include_deleted	bool	[optional] [default to False]
since	str	[optional]

Return type

PlainConversationsListDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

update_lqa_comment1

LQAConversationDto update_lqa_comment1(job_uid, conversation_id, comment_id, body=body)

Edit LQA comment

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.add_comment_dto import AddCommentDto
from phrasetms_client.models.lqa_conversation_dto import LQAConversationDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    body = phrasetms_client.AddCommentDto() # AddCommentDto |  (optional)

    try:
        # Edit LQA comment
        api_response = api_instance.update_lqa_comment1(job_uid, conversation_id, comment_id, body=body)
        print("The response of ConversationsApi->update_lqa_comment1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->update_lqa_comment1: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
conversation_id	str
comment_id	str
body	AddCommentDto	[optional]

Return type

LQAConversationDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Updated	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

update_lqa_conversation1

LQAConversationDto update_lqa_conversation1(job_uid, conversation_id, body=body)

Update LQA conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.edit_lqa_conversation_dto import EditLqaConversationDto
from phrasetms_client.models.lqa_conversation_dto import LQAConversationDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 
    body = phrasetms_client.EditLqaConversationDto() # EditLqaConversationDto |  (optional)

    try:
        # Update LQA conversation
        api_response = api_instance.update_lqa_conversation1(job_uid, conversation_id, body=body)
        print("The response of ConversationsApi->update_lqa_conversation1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->update_lqa_conversation1: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
conversation_id	str
body	EditLqaConversationDto	[optional]

Return type

LQAConversationDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Updated	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

update_plain_comment1

PlainConversationDto update_plain_comment1(job_uid, conversation_id, comment_id, body=body)

Edit plain comment

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.add_comment_dto import AddCommentDto
from phrasetms_client.models.plain_conversation_dto import PlainConversationDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    body = phrasetms_client.AddCommentDto() # AddCommentDto |  (optional)

    try:
        # Edit plain comment
        api_response = api_instance.update_plain_comment1(job_uid, conversation_id, comment_id, body=body)
        print("The response of ConversationsApi->update_plain_comment1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->update_plain_comment1: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
conversation_id	str
comment_id	str
body	AddCommentDto	[optional]

Return type

PlainConversationDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
202	Updated	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

update_plain_conversation

PlainConversationDto update_plain_conversation(job_uid, conversation_id, body=body)

Edit plain conversation

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.edit_plain_conversation_dto import EditPlainConversationDto
from phrasetms_client.models.plain_conversation_dto import PlainConversationDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.ConversationsApi(api_client)
    job_uid = 'job_uid_example' # str | 
    conversation_id = 'conversation_id_example' # str | 
    body = phrasetms_client.EditPlainConversationDto() # EditPlainConversationDto |  (optional)

    try:
        # Edit plain conversation
        api_response = api_instance.update_plain_conversation(job_uid, conversation_id, body=body)
        print("The response of ConversationsApi->update_plain_conversation:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConversationsApi->update_plain_conversation: %s\n" % e)

Parameters

Name	Type	Notes
job_uid	str
conversation_id	str
body	EditPlainConversationDto	[optional]

Return type

PlainConversationDto

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

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

Files

ConversationsApi.md

Latest commit

History

ConversationsApi.md

File metadata and controls

phrasetms_client.ConversationsApi

add_lqa_comment1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_plain_comment2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_lqa_conversation1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_segment_target_conversation1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_lqa_comment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_lqa_conversation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_plain_comment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_plain_conversation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_conversations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_lqa_conversation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_plain_conversation

Example

Parameters