Package io.moov.sdk

Class Support

java.lang.Object

io.moov.sdk.Support

public class Support
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CreateTicketRequestBuilder	createTicket()	Create a support ticket for a Moov account.
CreateTicketResponse	createTicket(java.lang.String accountID, CreateTicket createTicket)	Create a support ticket for a Moov account.
GetTicketRequestBuilder	getTicket()	Retrieve a support ticket by ID.
GetTicketResponse	getTicket(java.lang.String accountID, java.lang.String ticketID)	Retrieve a support ticket by ID.
ListTicketMessagesRequestBuilder	listTicketMessages()	List all the messages for a support ticket.
ListTicketMessagesResponse	listTicketMessages(java.lang.String accountID, java.lang.String ticketID)	List all the messages for a support ticket.
ListTicketsRequestBuilder	listTickets()	List all the support tickets created under a Moov account.
ListTicketsResponse	listTickets(java.lang.String accountID)	List all the support tickets created under a Moov account.
ListTicketsResponse	listTickets(java.util.Optional<java.lang.String> cursor, java.util.Optional<java.lang.Long> count, java.util.Optional<? extends TicketStatus> status, java.lang.String accountID)	List all the support tickets created under a Moov account.
UpdateTicketRequestBuilder	updateTicket()	Updates a support ticket.
UpdateTicketResponse	updateTicket(java.lang.String accountID, java.lang.String ticketID, UpdateTicket updateTicket)	Updates a support ticket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createTicket

public CreateTicketRequestBuilder createTicket()

Create a support ticket for a Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Returns:

The call builder

createTicket

public CreateTicketResponse createTicket(java.lang.String accountID,
                                         CreateTicket createTicket)
                                  throws java.lang.Exception

Create a support ticket for a Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Parameters:

accountID -

createTicket - Request to create a new support ticket.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listTickets

public ListTicketsRequestBuilder listTickets()

List all the support tickets created under a Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Returns:

The call builder

listTickets

public ListTicketsResponse listTickets(java.lang.String accountID)
                                throws java.lang.Exception

List all the support tickets created under a Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Parameters:

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listTickets

public ListTicketsResponse listTickets(java.util.Optional<java.lang.String> cursor,
                                       java.util.Optional<java.lang.Long> count,
                                       java.util.Optional<? extends TicketStatus> status,
                                       java.lang.String accountID)
                                throws java.lang.Exception

List all the support tickets created under a Moov account.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Parameters:

cursor -

count -

status -

accountID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getTicket

public GetTicketRequestBuilder getTicket()

Retrieve a support ticket by ID.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Returns:

The call builder

getTicket

public GetTicketResponse getTicket(java.lang.String accountID,
                                   java.lang.String ticketID)
                            throws java.lang.Exception

Retrieve a support ticket by ID.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Parameters:

accountID -

ticketID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

updateTicket

public UpdateTicketRequestBuilder updateTicket()

Updates a support ticket.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Returns:

The call builder

updateTicket

public UpdateTicketResponse updateTicket(java.lang.String accountID,
                                         java.lang.String ticketID,
                                         UpdateTicket updateTicket)
                                  throws java.lang.Exception

Updates a support ticket.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Parameters:

accountID -

ticketID -

updateTicket - Request to update a support ticket.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listTicketMessages

public ListTicketMessagesRequestBuilder listTicketMessages()

List all the messages for a support ticket.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Returns:

The call builder

listTicketMessages

public ListTicketMessagesResponse listTicketMessages(java.lang.String accountID,
                                                     java.lang.String ticketID)
                                              throws java.lang.Exception

List all the messages for a support ticket.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 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.

Parameters:

accountID -

ticketID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails