Documentation

AgentControllerApiTest extends TestCase
in package

AgentControllerApiTest Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

setUp()  : void
Setup before running each test case
setUpBeforeClass()  : void
Setup before running any test cases
tearDown()  : void
Clean up after running each test case
tearDownAfterClass()  : void
Clean up after running all test cases
testAgentAcquireConversationClaim()  : mixed
Test case for agentAcquireConversationClaim
testAgentAddConversationNote()  : mixed
Test case for agentAddConversationNote
testAgentAddSmsNote()  : mixed
Test case for agentAddSmsNote
testAgentCheckInboxSendPolicy()  : mixed
Test case for agentCheckInboxSendPolicy
testAgentClaimSmsConversation()  : mixed
Test case for agentClaimSmsConversation
testAgentCompleteWorkItem()  : mixed
Test case for agentCompleteWorkItem
testAgentCreateEmailDraft()  : mixed
Test case for agentCreateEmailDraft
testAgentCreateInbox()  : mixed
Test case for agentCreateInbox
testAgentCreateReplyDraft()  : mixed
Test case for agentCreateReplyDraft
testAgentCreateTotpDeviceForBase32SecretKey()  : mixed
Test case for agentCreateTotpDeviceForBase32SecretKey
testAgentCreateTotpDeviceForCustom()  : mixed
Test case for agentCreateTotpDeviceForCustom
testAgentCreateTotpDeviceForOtpAuthUrl()  : mixed
Test case for agentCreateTotpDeviceForOtpAuthUrl
testAgentDeferWorkItem()  : mixed
Test case for agentDeferWorkItem
testAgentDeleteEmailDraft()  : mixed
Test case for agentDeleteEmailDraft
testAgentDeleteTotpDevice()  : mixed
Test case for agentDeleteTotpDevice
testAgentExtractEmailAttachmentText()  : mixed
Test case for agentExtractEmailAttachmentText
testAgentGenerateTotpDeviceCode()  : mixed
Test case for agentGenerateTotpDeviceCode
testAgentGetCapabilities()  : mixed
Test case for agentGetCapabilities
testAgentGetConversationV2()  : mixed
Test case for agentGetConversationV2
testAgentGetEmail()  : mixed
Test case for agentGetEmail
testAgentGetEmailDraft()  : mixed
Test case for agentGetEmailDraft
testAgentGetEmailSummary()  : mixed
Test case for agentGetEmailSummary
testAgentGetEmailThread()  : mixed
Test case for agentGetEmailThread
testAgentGetLatestInboxEmail()  : mixed
Test case for agentGetLatestInboxEmail
testAgentGetNextWorkItem()  : mixed
Test case for agentGetNextWorkItem
testAgentGetPhoneMessageThreadItems()  : mixed
Test case for agentGetPhoneMessageThreadItems
testAgentGetPhoneMessageThreads()  : mixed
Test case for agentGetPhoneMessageThreads
testAgentGetPhoneNumber()  : mixed
Test case for agentGetPhoneNumber
testAgentGetPhoneNumbers()  : mixed
Test case for agentGetPhoneNumbers
testAgentGetReceivedSmsMessage()  : mixed
Test case for agentGetReceivedSmsMessage
testAgentGetReceivedSmsMessages()  : mixed
Test case for agentGetReceivedSmsMessages
testAgentGetSentSmsMessage()  : mixed
Test case for agentGetSentSmsMessage
testAgentGetSentSmsMessages()  : mixed
Test case for agentGetSentSmsMessages
testAgentGetSmsConversation()  : mixed
Test case for agentGetSmsConversation
testAgentGetTotpDevice()  : mixed
Test case for agentGetTotpDevice
testAgentGetTotpDeviceBy()  : mixed
Test case for agentGetTotpDeviceBy
testAgentGetTotpDevices()  : mixed
Test case for agentGetTotpDevices
testAgentListAccessibleInboxes()  : mixed
Test case for agentListAccessibleInboxes
testAgentListAutomationEvents()  : mixed
Test case for agentListAutomationEvents
testAgentListConversationsV2()  : mixed
Test case for agentListConversationsV2
testAgentListEmailAttachments()  : mixed
Test case for agentListEmailAttachments
testAgentListEmailDrafts()  : mixed
Test case for agentListEmailDrafts
testAgentListInboxEmails()  : mixed
Test case for agentListInboxEmails
testAgentListInboxThreads()  : mixed
Test case for agentListInboxThreads
testAgentListSmsConversations()  : mixed
Test case for agentListSmsConversations
testAgentPrepareWorkItemReply()  : mixed
Test case for agentPrepareWorkItemReply
testAgentReleaseConversationClaim()  : mixed
Test case for agentReleaseConversationClaim
testAgentReleaseSmsClaim()  : mixed
Test case for agentReleaseSmsClaim
testAgentRenewConversationClaim()  : mixed
Test case for agentRenewConversationClaim
testAgentRenewSmsClaim()  : mixed
Test case for agentRenewSmsClaim
testAgentReplyToEmail()  : mixed
Test case for agentReplyToEmail
testAgentReplyToSms()  : mixed
Test case for agentReplyToSms
testAgentReportWorkerHeartbeat()  : mixed
Test case for agentReportWorkerHeartbeat
testAgentRequestConversationHandoff()  : mixed
Test case for agentRequestConversationHandoff
testAgentRequestSmsHandoff()  : mixed
Test case for agentRequestSmsHandoff
testAgentSearchInboxEmails()  : mixed
Test case for agentSearchInboxEmails
testAgentSendEmailDraft()  : mixed
Test case for agentSendEmailDraft
testAgentSendSms()  : mixed
Test case for agentSendSms
testAgentUpdateEmailDraft()  : mixed
Test case for agentUpdateEmailDraft
testAgentUpdateInbox()  : mixed
Test case for agentUpdateInbox
testAgentUpdateTotpDevice()  : mixed
Test case for agentUpdateTotpDevice

Methods

setUpBeforeClass()

Setup before running any test cases

public static setUpBeforeClass() : void
Return values
void —

tearDown()

Clean up after running each test case

public tearDown() : void
Return values
void —

tearDownAfterClass()

Clean up after running all test cases

public static tearDownAfterClass() : void
Return values
void —

testAgentAcquireConversationClaim()

Test case for agentAcquireConversationClaim

public testAgentAcquireConversationClaim() : mixed

Acquire a renewable conversation claim.

Return values
mixed —

testAgentAddConversationNote()

Test case for agentAddConversationNote

public testAgentAddConversationNote() : mixed

Add an internal conversation note.

Return values
mixed —

testAgentAddSmsNote()

Test case for agentAddSmsNote

public testAgentAddSmsNote() : mixed

Add an internal SMS conversation note.

Return values
mixed —

testAgentCheckInboxSendPolicy()

Test case for agentCheckInboxSendPolicy

public testAgentCheckInboxSendPolicy() : mixed

Check whether sending rules allow recipients.

Return values
mixed —

testAgentClaimSmsConversation()

Test case for agentClaimSmsConversation

public testAgentClaimSmsConversation() : mixed

Acquire an SMS conversation claim.

Return values
mixed —

testAgentCompleteWorkItem()

Test case for agentCompleteWorkItem

public testAgentCompleteWorkItem() : mixed

Complete a work item with an idempotent reply.

Return values
mixed —

testAgentCreateEmailDraft()

Test case for agentCreateEmailDraft

public testAgentCreateEmailDraft() : mixed

Create a scoped email draft for an agent.

Return values
mixed —

testAgentCreateInbox()

Test case for agentCreateInbox

public testAgentCreateInbox() : mixed

Create an inbox with an account-wide inbox-manager connection.

Return values
mixed —

testAgentCreateReplyDraft()

Test case for agentCreateReplyDraft

public testAgentCreateReplyDraft() : mixed

Create a correctly threaded reply draft.

Return values
mixed —

testAgentCreateTotpDeviceForBase32SecretKey()

Test case for agentCreateTotpDeviceForBase32SecretKey

public testAgentCreateTotpDeviceForBase32SecretKey() : mixed

Create an agent-managed TOTP device from a base32 secret key.

Return values
mixed —

testAgentCreateTotpDeviceForCustom()

Test case for agentCreateTotpDeviceForCustom

public testAgentCreateTotpDeviceForCustom() : mixed

Create an agent-managed TOTP device from custom options.

Return values
mixed —

testAgentCreateTotpDeviceForOtpAuthUrl()

Test case for agentCreateTotpDeviceForOtpAuthUrl

public testAgentCreateTotpDeviceForOtpAuthUrl() : mixed

Create an agent-managed TOTP device from an OTP Auth URL.

Return values
mixed —

testAgentDeferWorkItem()

Test case for agentDeferWorkItem

public testAgentDeferWorkItem() : mixed

Defer a work item to human review.

Return values
mixed —

testAgentDeleteEmailDraft()

Test case for agentDeleteEmailDraft

public testAgentDeleteEmailDraft() : mixed

Delete a scoped email draft for an agent.

Return values
mixed —

testAgentDeleteTotpDevice()

Test case for agentDeleteTotpDevice

public testAgentDeleteTotpDevice() : mixed

Delete an agent-managed TOTP device.

Return values
mixed —

testAgentExtractEmailAttachmentText()

Test case for agentExtractEmailAttachmentText

public testAgentExtractEmailAttachmentText() : mixed

Extract text from a scoped email attachment for an agent.

Return values
mixed —

testAgentGenerateTotpDeviceCode()

Test case for agentGenerateTotpDeviceCode

public testAgentGenerateTotpDeviceCode() : mixed

Generate a code for an agent-managed TOTP device.

Return values
mixed —

testAgentGetCapabilities()

Test case for agentGetCapabilities

public testAgentGetCapabilities() : mixed

Discover this agent connection's capabilities.

Return values
mixed —

testAgentGetConversationV2()

Test case for agentGetConversationV2

public testAgentGetConversationV2() : mixed

Get one scoped conversation.

Return values
mixed —

testAgentGetEmail()

Test case for agentGetEmail

public testAgentGetEmail() : mixed

Get scoped hydrated email for an agent.

Return values
mixed —

testAgentGetEmailDraft()

Test case for agentGetEmailDraft

public testAgentGetEmailDraft() : mixed

Get a scoped email draft for an agent.

Return values
mixed —

testAgentGetEmailSummary()

Test case for agentGetEmailSummary

public testAgentGetEmailSummary() : mixed

Get scoped email summary for an agent.

Return values
mixed —

testAgentGetEmailThread()

Test case for agentGetEmailThread

public testAgentGetEmailThread() : mixed

Get a scoped email thread for an agent.

Return values
mixed —

testAgentGetLatestInboxEmail()

Test case for agentGetLatestInboxEmail

public testAgentGetLatestInboxEmail() : mixed

Get latest scoped inbox email for an agent.

Return values
mixed —

testAgentGetNextWorkItem()

Test case for agentGetNextWorkItem

public testAgentGetNextWorkItem() : mixed

Claim the next conversation work item.

Return values
mixed —

testAgentGetPhoneMessageThreadItems()

Test case for agentGetPhoneMessageThreadItems

public testAgentGetPhoneMessageThreadItems() : mixed

List SMS thread messages.

Return values
mixed —

testAgentGetPhoneMessageThreads()

Test case for agentGetPhoneMessageThreads

public testAgentGetPhoneMessageThreads() : mixed

List SMS threads.

Return values
mixed —

testAgentGetPhoneNumber()

Test case for agentGetPhoneNumber

public testAgentGetPhoneNumber() : mixed

Get an assigned phone number.

Return values
mixed —

testAgentGetPhoneNumbers()

Test case for agentGetPhoneNumbers

public testAgentGetPhoneNumbers() : mixed

List assigned phone numbers.

Return values
mixed —

testAgentGetReceivedSmsMessage()

Test case for agentGetReceivedSmsMessage

public testAgentGetReceivedSmsMessage() : mixed

Get received SMS.

Return values
mixed —

testAgentGetReceivedSmsMessages()

Test case for agentGetReceivedSmsMessages

public testAgentGetReceivedSmsMessages() : mixed

List received SMS for an assigned phone number.

Return values
mixed —

testAgentGetSentSmsMessage()

Test case for agentGetSentSmsMessage

public testAgentGetSentSmsMessage() : mixed

Get sent SMS.

Return values
mixed —

testAgentGetSentSmsMessages()

Test case for agentGetSentSmsMessages

public testAgentGetSentSmsMessages() : mixed

List sent SMS for an assigned phone number.

Return values
mixed —

testAgentGetSmsConversation()

Test case for agentGetSmsConversation

public testAgentGetSmsConversation() : mixed

Get one SMS conversation.

Return values
mixed —

testAgentGetTotpDevice()

Test case for agentGetTotpDevice

public testAgentGetTotpDevice() : mixed

Get an agent-accessible TOTP device.

Return values
mixed —

testAgentGetTotpDeviceBy()

Test case for agentGetTotpDeviceBy

public testAgentGetTotpDeviceBy() : mixed

Find an agent-accessible TOTP device by name, issuer, or username.

Return values
mixed —

testAgentGetTotpDevices()

Test case for agentGetTotpDevices

public testAgentGetTotpDevices() : mixed

List agent-accessible TOTP devices.

Return values
mixed —

testAgentListAccessibleInboxes()

Test case for agentListAccessibleInboxes

public testAgentListAccessibleInboxes() : mixed

List inboxes accessible to an agent.

Return values
mixed —

testAgentListAutomationEvents()

Test case for agentListAutomationEvents

public testAgentListAutomationEvents() : mixed

Read durable scoped automation events.

Return values
mixed —

testAgentListConversationsV2()

Test case for agentListConversationsV2

public testAgentListConversationsV2() : mixed

List active conversations with an opaque keyset cursor.

Return values
mixed —

testAgentListEmailAttachments()

Test case for agentListEmailAttachments

public testAgentListEmailAttachments() : mixed

List attachments on a scoped email for an agent.

Return values
mixed —

testAgentListEmailDrafts()

Test case for agentListEmailDrafts

public testAgentListEmailDrafts() : mixed

List scoped email drafts for an agent.

Return values
mixed —

testAgentListInboxEmails()

Test case for agentListInboxEmails

public testAgentListInboxEmails() : mixed

List scoped inbox emails for an agent.

Return values
mixed —

testAgentListInboxThreads()

Test case for agentListInboxThreads

public testAgentListInboxThreads() : mixed

List scoped inbox threads for an agent.

Return values
mixed —

testAgentListSmsConversations()

Test case for agentListSmsConversations

public testAgentListSmsConversations() : mixed

List active SMS conversations.

Return values
mixed —

testAgentPrepareWorkItemReply()

Test case for agentPrepareWorkItemReply

public testAgentPrepareWorkItemReply() : mixed

Prepare a guarded reply draft.

Return values
mixed —

testAgentReleaseConversationClaim()

Test case for agentReleaseConversationClaim

public testAgentReleaseConversationClaim() : mixed

Release a conversation claim.

Return values
mixed —

testAgentReleaseSmsClaim()

Test case for agentReleaseSmsClaim

public testAgentReleaseSmsClaim() : mixed

Release an SMS conversation claim.

Return values
mixed —

testAgentRenewConversationClaim()

Test case for agentRenewConversationClaim

public testAgentRenewConversationClaim() : mixed

Renew a conversation claim.

Return values
mixed —

testAgentRenewSmsClaim()

Test case for agentRenewSmsClaim

public testAgentRenewSmsClaim() : mixed

Renew an SMS conversation claim.

Return values
mixed —

testAgentReplyToEmail()

Test case for agentReplyToEmail

public testAgentReplyToEmail() : mixed

Reply to a scoped email as an agent.

Return values
mixed —

testAgentReplyToSms()

Test case for agentReplyToSms

public testAgentReplyToSms() : mixed

Reply to received SMS.

Return values
mixed —

testAgentReportWorkerHeartbeat()

Test case for agentReportWorkerHeartbeat

public testAgentReportWorkerHeartbeat() : mixed

Report a worker heartbeat.

Return values
mixed —

testAgentRequestConversationHandoff()

Test case for agentRequestConversationHandoff

public testAgentRequestConversationHandoff() : mixed

Request human review for a conversation.

Return values
mixed —

testAgentRequestSmsHandoff()

Test case for agentRequestSmsHandoff

public testAgentRequestSmsHandoff() : mixed

Request human review for an SMS conversation.

Return values
mixed —

testAgentSearchInboxEmails()

Test case for agentSearchInboxEmails

public testAgentSearchInboxEmails() : mixed

Search scoped inbox emails for an agent.

Return values
mixed —

testAgentSendEmailDraft()

Test case for agentSendEmailDraft

public testAgentSendEmailDraft() : mixed

Send a scoped email draft for an agent.

Return values
mixed —

testAgentSendSms()

Test case for agentSendSms

public testAgentSendSms() : mixed

Send SMS from an assigned phone number.

Return values
mixed —

testAgentUpdateEmailDraft()

Test case for agentUpdateEmailDraft

public testAgentUpdateEmailDraft() : mixed

Update a scoped email draft for an agent.

Return values
mixed —

testAgentUpdateInbox()

Test case for agentUpdateInbox

public testAgentUpdateInbox() : mixed

Update an inbox visible to an inbox-manager connection.

Return values
mixed —

testAgentUpdateTotpDevice()

Test case for agentUpdateTotpDevice

public testAgentUpdateTotpDevice() : mixed

Update an agent-managed TOTP device.

Return values
mixed —

Search results