Skip to content

README.md

Latest commit

 

History

History
305 lines (207 loc) · 19.2 KB

README.md

File metadata and controls

305 lines (207 loc) · 19.2 KB
Raw

Support

Overview

Available Operations

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.write scope.

If you're creating the ticket on behalf of another account, then you'll need to specify the /accounts/{partnerAccountID}/tickets.write and /accounts/{accountID}/profile.read scopes.

  • list_tickets - List all the support tickets created under a Moov account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.read scope.

If you're listing another account's tickets, then you'll need to specify the /accounts/{partnerAccountID}/tickets.read and /accounts/{accountID}/profile.read scopes.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.read scope.

If you're retrieving another account's ticket, then you'll need to specify the /accounts/{partnerAccountID}/tickets.read and /accounts/{accountID}/profile.read scopes.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.write scope.

If you're updating the ticket on behalf of another account, then you'll need to specify the /accounts/{partnerAccountID}/tickets.write and /accounts/{accountID}/profile.read scopes.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.read scope.

If you're listing another account's messages, then you'll need to specify the /accounts/{partnerAccountID}/tickets.read and /accounts/{accountID}/profile.read scopes.

create_ticket

Create a support ticket for a Moov account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.write scope.

If you're creating the ticket on behalf of another account, then you'll need to specify the /accounts/{partnerAccountID}/tickets.write and /accounts/{accountID}/profile.read scopes.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.support.create_ticket(account_id="4af4784a-c777-48f6-8211-063d5341f84b", title="<value>", body="<value>", contact={
        "email": "Melany.Roberts@yahoo.com",
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
title str ✔️ N/A
body str ✔️ N/A
contact components.TicketContact ✔️ N/A
author Optional[str] ➖ N/A
foreign_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateTicketResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.CreateTicketError 422 application/json
errors.APIError 4XX, 5XX */*

list_tickets

List all the support tickets created under a Moov account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.read scope.

If you're listing another account's tickets, then you'll need to specify the /accounts/{partnerAccountID}/tickets.read and /accounts/{accountID}/profile.read scopes.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.support.list_tickets(account_id="8ef75c13-2a50-4438-b294-2a850eb4986d", count=20)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
account_id str ✔️ N/A
cursor Optional[str] ➖ N/A
count Optional[int] ➖ Page size. When omitted, the server defaults to 200. 20
status Optional[components.TicketStatus] ➖ N/A
foreign_id Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListTicketsResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*

get_ticket

Retrieve a support ticket by ID.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.read scope.

If you're retrieving another account's ticket, then you'll need to specify the /accounts/{partnerAccountID}/tickets.read and /accounts/{accountID}/profile.read scopes.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.support.get_ticket(account_id="873ccb78-88b3-4520-85f2-7cc2aef5704b", ticket_id="91fea9bf-b373-40f7-86e0-2c80690126e4")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
ticket_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetTicketResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*

update_ticket

Updates a support ticket.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.write scope.

If you're updating the ticket on behalf of another account, then you'll need to specify the /accounts/{partnerAccountID}/tickets.write and /accounts/{accountID}/profile.read scopes.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.support.update_ticket(account_id="7cce2b85-37c2-4c76-954c-03dcec2b12f0", ticket_id="1d621d17-8e7d-4ac0-9f7d-6e9fcebe8eef")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
ticket_id str ✔️ N/A
status Optional[components.UpdateTicketStatus] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateTicketResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.UpdateTicketError 422 application/json
errors.APIError 4XX, 5XX */*

list_ticket_messages

List all the messages for a support ticket.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.read scope.

If you're listing another account's messages, then you'll need to specify the /accounts/{partnerAccountID}/tickets.read and /accounts/{accountID}/profile.read scopes.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.support.list_ticket_messages(account_id="72444918-8529-4986-b10c-41817e45d09e", ticket_id="edeaab65-c54c-45b8-881b-19138f125fb1")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
ticket_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListTicketMessagesResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*