Documentation

AgentControllerApi
in package

MailSlurp

AgentControllerApi Class Doc Comment

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['agentAcquireConversationClaim' => ['application/json'], 'agentAddConversationNote' => ['application/json'], 'agentAddSmsNote' => ['application/json'], 'agentCheckInboxSendPolicy' => ['application/json'], 'agentClaimSmsConversation' => ['application/json'], 'agentCompleteWorkItem' => ['application/json'], 'agentCreateEmailDraft' => ['application/json'], 'agentCreateInbox' => ['application/json'], 'agentCreateReplyDraft' => ['application/json'], 'agentCreateTotpDeviceForBase32SecretKey' => ['application/json'], 'agentCreateTotpDeviceForCustom' => ['application/json'], 'agentCreateTotpDeviceForOtpAuthUrl' => ['application/json'], 'agentDeferWorkItem' => ['application/json'], 'agentDeleteEmailDraft' => ['application/json'], 'agentDeleteTotpDevice' => ['application/json'], 'agentExtractEmailAttachmentText' => ['application/json'], 'agentGenerateTotpDeviceCode' => ['application/json'], 'agentGetCapabilities' => ['application/json'], 'agentGetConversationV2' => ['application/json'], 'agentGetEmail' => ['application/json'], 'agentGetEmailDraft' => ['application/json'], 'agentGetEmailSummary' => ['application/json'], 'agentGetEmailThread' => ['application/json'], 'agentGetLatestInboxEmail' => ['application/json'], 'agentGetNextWorkItem' => ['application/json'], 'agentGetPhoneMessageThreadItems' => ['application/json'], 'agentGetPhoneMessageThreads' => ['application/json'], 'agentGetPhoneNumber' => ['application/json'], 'agentGetPhoneNumbers' => ['application/json'], 'agentGetReceivedSmsMessage' => ['application/json'], 'agentGetReceivedSmsMessages' => ['application/json'], 'agentGetSentSmsMessage' => ['application/json'], 'agentGetSentSmsMessages' => ['application/json'], 'agentGetSmsConversation' => ['application/json'], 'agentGetTotpDevice' => ['application/json'], 'agentGetTotpDeviceBy' => ['application/json'], 'agentGetTotpDevices' => ['application/json'], 'agentListAccessibleInboxes' => ['application/json'], 'agentListAutomationEvents' => ['application/json'], 'agentListConversationsV2' => ['application/json'], 'agentListEmailAttachments' => ['application/json'], 'agentListEmailDrafts' => ['application/json'], 'agentListInboxEmails' => ['application/json'], 'agentListInboxThreads' => ['application/json'], 'agentListSmsConversations' => ['application/json'], 'agentPrepareWorkItemReply' => ['application/json'], 'agentReleaseConversationClaim' => ['application/json'], 'agentReleaseSmsClaim' => ['application/json'], 'agentRenewConversationClaim' => ['application/json'], 'agentRenewSmsClaim' => ['application/json'], 'agentReplyToEmail' => ['application/json'], 'agentReplyToSms' => ['application/json'], 'agentReportWorkerHeartbeat' => ['application/json'], 'agentRequestConversationHandoff' => ['application/json'], 'agentRequestSmsHandoff' => ['application/json'], 'agentSearchInboxEmails' => ['application/json'], 'agentSendEmailDraft' => ['application/json'], 'agentSendSms' => ['application/json'], 'agentUpdateEmailDraft' => ['application/json'], 'agentUpdateInbox' => ['application/json'], 'agentUpdateTotpDevice' => ['application/json']]

$client


    protected
        ClientInterface
    $client

$config


    protected
        Configuration
    $config

$headerSelector


    protected
        HeaderSelector
    $headerSelector

$hostIndex


    protected
        int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values

mixed —

agentAcquireConversationClaim()

Operation agentAcquireConversationClaim


    public
                    agentAcquireConversationClaim(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentAcquireConversationClaim'][0] ]) : AgentConversationClaimDto

Acquire a renewable conversation claim

Parameters

$conversation_id : string: conversation_id (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: acquire_agent_conversation_claim_options (required)
$contentType : string = self::contentTypes['agentAcquireConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentAcquireConversationClaim'] to see the possible values for this operation

Return values

AgentConversationClaimDto —

agentAcquireConversationClaimAsync()

Operation agentAcquireConversationClaimAsync


    public
                    agentAcquireConversationClaimAsync(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentAcquireConversationClaim'][0] ]) : PromiseInterface

Acquire a renewable conversation claim

Parameters

$conversation_id : string: (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentAcquireConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentAcquireConversationClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentAcquireConversationClaimAsyncWithHttpInfo()

Operation agentAcquireConversationClaimAsyncWithHttpInfo


    public
                    agentAcquireConversationClaimAsyncWithHttpInfo(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentAcquireConversationClaim'][0] ]) : PromiseInterface

Acquire a renewable conversation claim

Parameters

$conversation_id : string: (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentAcquireConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentAcquireConversationClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentAcquireConversationClaimRequest()

Create request for operation 'agentAcquireConversationClaim'


    public
                    agentAcquireConversationClaimRequest(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentAcquireConversationClaim'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentAcquireConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentAcquireConversationClaim'] to see the possible values for this operation

Return values

Request —

agentAcquireConversationClaimWithHttpInfo()

Operation agentAcquireConversationClaimWithHttpInfo


    public
                    agentAcquireConversationClaimWithHttpInfo(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentAcquireConversationClaim'][0] ]) : array<string|int, mixed>

Acquire a renewable conversation claim

Parameters

$conversation_id : string: (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentAcquireConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentAcquireConversationClaim'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationClaimDto, HTTP status code, HTTP response headers (array of strings)

agentAddConversationNote()

Operation agentAddConversationNote


    public
                    agentAddConversationNote(string $conversation_id, CreateAgentConversationNoteOptions $create_agent_conversation_note_options[, string $contentType = self::contentTypes['agentAddConversationNote'][0] ]) : AgentConversationNoteDto

Add an internal conversation note

Parameters

$conversation_id : string: conversation_id (required)
$create_agent_conversation_note_options : CreateAgentConversationNoteOptions: create_agent_conversation_note_options (required)
$contentType : string = self::contentTypes['agentAddConversationNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddConversationNote'] to see the possible values for this operation

Return values

AgentConversationNoteDto —

agentAddConversationNoteAsync()

Operation agentAddConversationNoteAsync


    public
                    agentAddConversationNoteAsync(string $conversation_id, CreateAgentConversationNoteOptions $create_agent_conversation_note_options[, string $contentType = self::contentTypes['agentAddConversationNote'][0] ]) : PromiseInterface

Add an internal conversation note

Parameters

$conversation_id : string: (required)
$create_agent_conversation_note_options : CreateAgentConversationNoteOptions: (required)
$contentType : string = self::contentTypes['agentAddConversationNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddConversationNote'] to see the possible values for this operation

Return values

PromiseInterface —

agentAddConversationNoteAsyncWithHttpInfo()

Operation agentAddConversationNoteAsyncWithHttpInfo


    public
                    agentAddConversationNoteAsyncWithHttpInfo(string $conversation_id, CreateAgentConversationNoteOptions $create_agent_conversation_note_options[, string $contentType = self::contentTypes['agentAddConversationNote'][0] ]) : PromiseInterface

Add an internal conversation note

Parameters

$conversation_id : string: (required)
$create_agent_conversation_note_options : CreateAgentConversationNoteOptions: (required)
$contentType : string = self::contentTypes['agentAddConversationNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddConversationNote'] to see the possible values for this operation

Return values

PromiseInterface —

agentAddConversationNoteRequest()

Create request for operation 'agentAddConversationNote'


    public
                    agentAddConversationNoteRequest(string $conversation_id, CreateAgentConversationNoteOptions $create_agent_conversation_note_options[, string $contentType = self::contentTypes['agentAddConversationNote'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$create_agent_conversation_note_options : CreateAgentConversationNoteOptions: (required)
$contentType : string = self::contentTypes['agentAddConversationNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddConversationNote'] to see the possible values for this operation

Return values

Request —

agentAddConversationNoteWithHttpInfo()

Operation agentAddConversationNoteWithHttpInfo


    public
                    agentAddConversationNoteWithHttpInfo(string $conversation_id, CreateAgentConversationNoteOptions $create_agent_conversation_note_options[, string $contentType = self::contentTypes['agentAddConversationNote'][0] ]) : array<string|int, mixed>

Add an internal conversation note

Parameters

$conversation_id : string: (required)
$create_agent_conversation_note_options : CreateAgentConversationNoteOptions: (required)
$contentType : string = self::contentTypes['agentAddConversationNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddConversationNote'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationNoteDto, HTTP status code, HTTP response headers (array of strings)

agentAddSmsNote()

Operation agentAddSmsNote


    public
                    agentAddSmsNote(string $conversation_id, CreateAgentSmsConversationNoteOptions $create_agent_sms_conversation_note_options[, string $contentType = self::contentTypes['agentAddSmsNote'][0] ]) : AgentConversationNoteDto

Add an internal SMS conversation note

Parameters

$conversation_id : string: conversation_id (required)
$create_agent_sms_conversation_note_options : CreateAgentSmsConversationNoteOptions: create_agent_sms_conversation_note_options (required)
$contentType : string = self::contentTypes['agentAddSmsNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddSmsNote'] to see the possible values for this operation

Return values

AgentConversationNoteDto —

agentAddSmsNoteAsync()

Operation agentAddSmsNoteAsync


    public
                    agentAddSmsNoteAsync(string $conversation_id, CreateAgentSmsConversationNoteOptions $create_agent_sms_conversation_note_options[, string $contentType = self::contentTypes['agentAddSmsNote'][0] ]) : PromiseInterface

Add an internal SMS conversation note

Parameters

$conversation_id : string: (required)
$create_agent_sms_conversation_note_options : CreateAgentSmsConversationNoteOptions: (required)
$contentType : string = self::contentTypes['agentAddSmsNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddSmsNote'] to see the possible values for this operation

Return values

PromiseInterface —

agentAddSmsNoteAsyncWithHttpInfo()

Operation agentAddSmsNoteAsyncWithHttpInfo


    public
                    agentAddSmsNoteAsyncWithHttpInfo(string $conversation_id, CreateAgentSmsConversationNoteOptions $create_agent_sms_conversation_note_options[, string $contentType = self::contentTypes['agentAddSmsNote'][0] ]) : PromiseInterface

Add an internal SMS conversation note

Parameters

$conversation_id : string: (required)
$create_agent_sms_conversation_note_options : CreateAgentSmsConversationNoteOptions: (required)
$contentType : string = self::contentTypes['agentAddSmsNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddSmsNote'] to see the possible values for this operation

Return values

PromiseInterface —

agentAddSmsNoteRequest()

Create request for operation 'agentAddSmsNote'


    public
                    agentAddSmsNoteRequest(string $conversation_id, CreateAgentSmsConversationNoteOptions $create_agent_sms_conversation_note_options[, string $contentType = self::contentTypes['agentAddSmsNote'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$create_agent_sms_conversation_note_options : CreateAgentSmsConversationNoteOptions: (required)
$contentType : string = self::contentTypes['agentAddSmsNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddSmsNote'] to see the possible values for this operation

Return values

Request —

agentAddSmsNoteWithHttpInfo()

Operation agentAddSmsNoteWithHttpInfo


    public
                    agentAddSmsNoteWithHttpInfo(string $conversation_id, CreateAgentSmsConversationNoteOptions $create_agent_sms_conversation_note_options[, string $contentType = self::contentTypes['agentAddSmsNote'][0] ]) : array<string|int, mixed>

Add an internal SMS conversation note

Parameters

$conversation_id : string: (required)
$create_agent_sms_conversation_note_options : CreateAgentSmsConversationNoteOptions: (required)
$contentType : string = self::contentTypes['agentAddSmsNote'][0]: The value for the Content-Type header. Check self::contentTypes['agentAddSmsNote'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationNoteDto, HTTP status code, HTTP response headers (array of strings)

agentCheckInboxSendPolicy()

Operation agentCheckInboxSendPolicy


    public
                    agentCheckInboxSendPolicy(string $inbox_id, AgentInboxSendPolicyCheckOptions $agent_inbox_send_policy_check_options[, string $contentType = self::contentTypes['agentCheckInboxSendPolicy'][0] ]) : AgentInboxSendPolicyDto

Check whether sending rules allow recipients

Parameters

$inbox_id : string: inbox_id (required)
$agent_inbox_send_policy_check_options : AgentInboxSendPolicyCheckOptions: agent_inbox_send_policy_check_options (required)
$contentType : string = self::contentTypes['agentCheckInboxSendPolicy'][0]: The value for the Content-Type header. Check self::contentTypes['agentCheckInboxSendPolicy'] to see the possible values for this operation

Return values

AgentInboxSendPolicyDto —

agentCheckInboxSendPolicyAsync()

Operation agentCheckInboxSendPolicyAsync


    public
                    agentCheckInboxSendPolicyAsync(string $inbox_id, AgentInboxSendPolicyCheckOptions $agent_inbox_send_policy_check_options[, string $contentType = self::contentTypes['agentCheckInboxSendPolicy'][0] ]) : PromiseInterface

Check whether sending rules allow recipients

Parameters

$inbox_id : string: (required)
$agent_inbox_send_policy_check_options : AgentInboxSendPolicyCheckOptions: (required)
$contentType : string = self::contentTypes['agentCheckInboxSendPolicy'][0]: The value for the Content-Type header. Check self::contentTypes['agentCheckInboxSendPolicy'] to see the possible values for this operation

Return values

PromiseInterface —

agentCheckInboxSendPolicyAsyncWithHttpInfo()

Operation agentCheckInboxSendPolicyAsyncWithHttpInfo


    public
                    agentCheckInboxSendPolicyAsyncWithHttpInfo(string $inbox_id, AgentInboxSendPolicyCheckOptions $agent_inbox_send_policy_check_options[, string $contentType = self::contentTypes['agentCheckInboxSendPolicy'][0] ]) : PromiseInterface

Check whether sending rules allow recipients

Parameters

$inbox_id : string: (required)
$agent_inbox_send_policy_check_options : AgentInboxSendPolicyCheckOptions: (required)
$contentType : string = self::contentTypes['agentCheckInboxSendPolicy'][0]: The value for the Content-Type header. Check self::contentTypes['agentCheckInboxSendPolicy'] to see the possible values for this operation

Return values

PromiseInterface —

agentCheckInboxSendPolicyRequest()

Create request for operation 'agentCheckInboxSendPolicy'


    public
                    agentCheckInboxSendPolicyRequest(string $inbox_id, AgentInboxSendPolicyCheckOptions $agent_inbox_send_policy_check_options[, string $contentType = self::contentTypes['agentCheckInboxSendPolicy'][0] ]) : Request

Parameters

$inbox_id : string: (required)
$agent_inbox_send_policy_check_options : AgentInboxSendPolicyCheckOptions: (required)
$contentType : string = self::contentTypes['agentCheckInboxSendPolicy'][0]: The value for the Content-Type header. Check self::contentTypes['agentCheckInboxSendPolicy'] to see the possible values for this operation

Return values

Request —

agentCheckInboxSendPolicyWithHttpInfo()

Operation agentCheckInboxSendPolicyWithHttpInfo


    public
                    agentCheckInboxSendPolicyWithHttpInfo(string $inbox_id, AgentInboxSendPolicyCheckOptions $agent_inbox_send_policy_check_options[, string $contentType = self::contentTypes['agentCheckInboxSendPolicy'][0] ]) : array<string|int, mixed>

Check whether sending rules allow recipients

Parameters

$inbox_id : string: (required)
$agent_inbox_send_policy_check_options : AgentInboxSendPolicyCheckOptions: (required)
$contentType : string = self::contentTypes['agentCheckInboxSendPolicy'][0]: The value for the Content-Type header. Check self::contentTypes['agentCheckInboxSendPolicy'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentInboxSendPolicyDto, HTTP status code, HTTP response headers (array of strings)

agentClaimSmsConversation()

Operation agentClaimSmsConversation


    public
                    agentClaimSmsConversation(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentClaimSmsConversation'][0] ]) : AgentConversationClaimDto

Acquire an SMS conversation claim

Parameters

$conversation_id : string: conversation_id (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: acquire_agent_conversation_claim_options (required)
$contentType : string = self::contentTypes['agentClaimSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentClaimSmsConversation'] to see the possible values for this operation

Return values

AgentConversationClaimDto —

agentClaimSmsConversationAsync()

Operation agentClaimSmsConversationAsync


    public
                    agentClaimSmsConversationAsync(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentClaimSmsConversation'][0] ]) : PromiseInterface

Acquire an SMS conversation claim

Parameters

$conversation_id : string: (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentClaimSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentClaimSmsConversation'] to see the possible values for this operation

Return values

PromiseInterface —

agentClaimSmsConversationAsyncWithHttpInfo()

Operation agentClaimSmsConversationAsyncWithHttpInfo


    public
                    agentClaimSmsConversationAsyncWithHttpInfo(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentClaimSmsConversation'][0] ]) : PromiseInterface

Acquire an SMS conversation claim

Parameters

$conversation_id : string: (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentClaimSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentClaimSmsConversation'] to see the possible values for this operation

Return values

PromiseInterface —

agentClaimSmsConversationRequest()

Create request for operation 'agentClaimSmsConversation'


    public
                    agentClaimSmsConversationRequest(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentClaimSmsConversation'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentClaimSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentClaimSmsConversation'] to see the possible values for this operation

Return values

Request —

agentClaimSmsConversationWithHttpInfo()

Operation agentClaimSmsConversationWithHttpInfo


    public
                    agentClaimSmsConversationWithHttpInfo(string $conversation_id, AcquireAgentConversationClaimOptions $acquire_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentClaimSmsConversation'][0] ]) : array<string|int, mixed>

Acquire an SMS conversation claim

Parameters

$conversation_id : string: (required)
$acquire_agent_conversation_claim_options : AcquireAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentClaimSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentClaimSmsConversation'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationClaimDto, HTTP status code, HTTP response headers (array of strings)

agentCompleteWorkItem()

Operation agentCompleteWorkItem


    public
                    agentCompleteWorkItem(string $conversation_id, CompleteAgentWorkItemOptions $complete_agent_work_item_options[, string $contentType = self::contentTypes['agentCompleteWorkItem'][0] ]) : AgentCompletedWorkItemDto|AgentApiErrorDto

Complete a work item with an idempotent reply

Parameters

$conversation_id : string: conversation_id (required)
$complete_agent_work_item_options : CompleteAgentWorkItemOptions: complete_agent_work_item_options (required)
$contentType : string = self::contentTypes['agentCompleteWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentCompleteWorkItem'] to see the possible values for this operation

Return values

AgentCompletedWorkItemDto|AgentApiErrorDto —

agentCompleteWorkItemAsync()

Operation agentCompleteWorkItemAsync


    public
                    agentCompleteWorkItemAsync(string $conversation_id, CompleteAgentWorkItemOptions $complete_agent_work_item_options[, string $contentType = self::contentTypes['agentCompleteWorkItem'][0] ]) : PromiseInterface

Complete a work item with an idempotent reply

Parameters

$conversation_id : string: (required)
$complete_agent_work_item_options : CompleteAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentCompleteWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentCompleteWorkItem'] to see the possible values for this operation

Return values

PromiseInterface —

agentCompleteWorkItemAsyncWithHttpInfo()

Operation agentCompleteWorkItemAsyncWithHttpInfo


    public
                    agentCompleteWorkItemAsyncWithHttpInfo(string $conversation_id, CompleteAgentWorkItemOptions $complete_agent_work_item_options[, string $contentType = self::contentTypes['agentCompleteWorkItem'][0] ]) : PromiseInterface

Complete a work item with an idempotent reply

Parameters

$conversation_id : string: (required)
$complete_agent_work_item_options : CompleteAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentCompleteWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentCompleteWorkItem'] to see the possible values for this operation

Return values

PromiseInterface —

agentCompleteWorkItemRequest()

Create request for operation 'agentCompleteWorkItem'


    public
                    agentCompleteWorkItemRequest(string $conversation_id, CompleteAgentWorkItemOptions $complete_agent_work_item_options[, string $contentType = self::contentTypes['agentCompleteWorkItem'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$complete_agent_work_item_options : CompleteAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentCompleteWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentCompleteWorkItem'] to see the possible values for this operation

Return values

Request —

agentCompleteWorkItemWithHttpInfo()

Operation agentCompleteWorkItemWithHttpInfo


    public
                    agentCompleteWorkItemWithHttpInfo(string $conversation_id, CompleteAgentWorkItemOptions $complete_agent_work_item_options[, string $contentType = self::contentTypes['agentCompleteWorkItem'][0] ]) : array<string|int, mixed>

Complete a work item with an idempotent reply

Parameters

$conversation_id : string: (required)
$complete_agent_work_item_options : CompleteAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentCompleteWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentCompleteWorkItem'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentCompletedWorkItemDto|\MailSlurp\Models\AgentApiErrorDto, HTTP status code, HTTP response headers (array of strings)

agentCreateEmailDraft()

Operation agentCreateEmailDraft


    public
                    agentCreateEmailDraft(string $inbox_id, SendEmailOptions $send_email_options[, string $source_email_id = null ][, string $contentType = self::contentTypes['agentCreateEmailDraft'][0] ]) : EmailDraftDto

Create a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox to save the draft against (required)
$send_email_options : SendEmailOptions: send_email_options (required)
$source_email_id : string = null: Optional source email this draft responds to. When supplied, MailSlurp links the draft and later draft actions to that conversation. (optional)
$contentType : string = self::contentTypes['agentCreateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateEmailDraft'] to see the possible values for this operation

Return values

EmailDraftDto —

agentCreateEmailDraftAsync()

Operation agentCreateEmailDraftAsync


    public
                    agentCreateEmailDraftAsync(string $inbox_id, SendEmailOptions $send_email_options[, string $source_email_id = null ][, string $contentType = self::contentTypes['agentCreateEmailDraft'][0] ]) : PromiseInterface

Create a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox to save the draft against (required)
$send_email_options : SendEmailOptions: (required)
$source_email_id : string = null: Optional source email this draft responds to. When supplied, MailSlurp links the draft and later draft actions to that conversation. (optional)
$contentType : string = self::contentTypes['agentCreateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateEmailDraftAsyncWithHttpInfo()

Operation agentCreateEmailDraftAsyncWithHttpInfo


    public
                    agentCreateEmailDraftAsyncWithHttpInfo(string $inbox_id, SendEmailOptions $send_email_options[, string $source_email_id = null ][, string $contentType = self::contentTypes['agentCreateEmailDraft'][0] ]) : PromiseInterface

Create a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox to save the draft against (required)
$send_email_options : SendEmailOptions: (required)
$source_email_id : string = null: Optional source email this draft responds to. When supplied, MailSlurp links the draft and later draft actions to that conversation. (optional)
$contentType : string = self::contentTypes['agentCreateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateEmailDraftRequest()

Create request for operation 'agentCreateEmailDraft'


    public
                    agentCreateEmailDraftRequest(string $inbox_id, SendEmailOptions $send_email_options[, string $source_email_id = null ][, string $contentType = self::contentTypes['agentCreateEmailDraft'][0] ]) : Request

Parameters

$inbox_id : string: ID of inbox to save the draft against (required)
$send_email_options : SendEmailOptions: (required)
$source_email_id : string = null: Optional source email this draft responds to. When supplied, MailSlurp links the draft and later draft actions to that conversation. (optional)
$contentType : string = self::contentTypes['agentCreateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateEmailDraft'] to see the possible values for this operation

Return values

Request —

agentCreateEmailDraftWithHttpInfo()

Operation agentCreateEmailDraftWithHttpInfo


    public
                    agentCreateEmailDraftWithHttpInfo(string $inbox_id, SendEmailOptions $send_email_options[, string $source_email_id = null ][, string $contentType = self::contentTypes['agentCreateEmailDraft'][0] ]) : array<string|int, mixed>

Create a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox to save the draft against (required)
$send_email_options : SendEmailOptions: (required)
$source_email_id : string = null: Optional source email this draft responds to. When supplied, MailSlurp links the draft and later draft actions to that conversation. (optional)
$contentType : string = self::contentTypes['agentCreateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateEmailDraft'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailDraftDto, HTTP status code, HTTP response headers (array of strings)

agentCreateInbox()

Operation agentCreateInbox


    public
                    agentCreateInbox(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['agentCreateInbox'][0] ]) : InboxDto

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

Parameters

$create_inbox_dto : CreateInboxDto: create_inbox_dto (required)
$contentType : string = self::contentTypes['agentCreateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateInbox'] to see the possible values for this operation

Return values

InboxDto —

agentCreateInboxAsync()

Operation agentCreateInboxAsync


    public
                    agentCreateInboxAsync(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['agentCreateInbox'][0] ]) : PromiseInterface

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

Parameters

$create_inbox_dto : CreateInboxDto: (required)
$contentType : string = self::contentTypes['agentCreateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateInbox'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateInboxAsyncWithHttpInfo()

Operation agentCreateInboxAsyncWithHttpInfo


    public
                    agentCreateInboxAsyncWithHttpInfo(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['agentCreateInbox'][0] ]) : PromiseInterface

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

Parameters

$create_inbox_dto : CreateInboxDto: (required)
$contentType : string = self::contentTypes['agentCreateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateInbox'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateInboxRequest()

Create request for operation 'agentCreateInbox'


    public
                    agentCreateInboxRequest(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['agentCreateInbox'][0] ]) : Request

Parameters

$create_inbox_dto : CreateInboxDto: (required)
$contentType : string = self::contentTypes['agentCreateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateInbox'] to see the possible values for this operation

Return values

Request —

agentCreateInboxWithHttpInfo()

Operation agentCreateInboxWithHttpInfo


    public
                    agentCreateInboxWithHttpInfo(CreateInboxDto $create_inbox_dto[, string $contentType = self::contentTypes['agentCreateInbox'][0] ]) : array<string|int, mixed>

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

Parameters

$create_inbox_dto : CreateInboxDto: (required)
$contentType : string = self::contentTypes['agentCreateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateInbox'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\InboxDto, HTTP status code, HTTP response headers (array of strings)

agentCreateReplyDraft()

Operation agentCreateReplyDraft


    public
                    agentCreateReplyDraft(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['agentCreateReplyDraft'][0] ]) : EmailDraftDto

Create a correctly threaded reply draft

Parameters

$email_id : string: email_id (required)
$reply_to_email_options : ReplyToEmailOptions: reply_to_email_options (required)
$contentType : string = self::contentTypes['agentCreateReplyDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateReplyDraft'] to see the possible values for this operation

Return values

EmailDraftDto —

agentCreateReplyDraftAsync()

Operation agentCreateReplyDraftAsync


    public
                    agentCreateReplyDraftAsync(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['agentCreateReplyDraft'][0] ]) : PromiseInterface

Create a correctly threaded reply draft

Parameters

$email_id : string: (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$contentType : string = self::contentTypes['agentCreateReplyDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateReplyDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateReplyDraftAsyncWithHttpInfo()

Operation agentCreateReplyDraftAsyncWithHttpInfo


    public
                    agentCreateReplyDraftAsyncWithHttpInfo(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['agentCreateReplyDraft'][0] ]) : PromiseInterface

Create a correctly threaded reply draft

Parameters

$email_id : string: (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$contentType : string = self::contentTypes['agentCreateReplyDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateReplyDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateReplyDraftRequest()

Create request for operation 'agentCreateReplyDraft'


    public
                    agentCreateReplyDraftRequest(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['agentCreateReplyDraft'][0] ]) : Request

Parameters

$email_id : string: (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$contentType : string = self::contentTypes['agentCreateReplyDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateReplyDraft'] to see the possible values for this operation

Return values

Request —

agentCreateReplyDraftWithHttpInfo()

Operation agentCreateReplyDraftWithHttpInfo


    public
                    agentCreateReplyDraftWithHttpInfo(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $contentType = self::contentTypes['agentCreateReplyDraft'][0] ]) : array<string|int, mixed>

Create a correctly threaded reply draft

Parameters

$email_id : string: (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$contentType : string = self::contentTypes['agentCreateReplyDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateReplyDraft'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailDraftDto, HTTP status code, HTTP response headers (array of strings)

agentCreateTotpDeviceForBase32SecretKey()

Operation agentCreateTotpDeviceForBase32SecretKey


    public
                    agentCreateTotpDeviceForBase32SecretKey(CreateTotpDeviceBase32SecretKeyOptions $create_totp_device_base32_secret_key_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0] ]) : TotpDeviceDto

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

Parameters

$create_totp_device_base32_secret_key_options : CreateTotpDeviceBase32SecretKeyOptions: create_totp_device_base32_secret_key_options (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'] to see the possible values for this operation

Return values

TotpDeviceDto —

agentCreateTotpDeviceForBase32SecretKeyAsync()

Operation agentCreateTotpDeviceForBase32SecretKeyAsync


    public
                    agentCreateTotpDeviceForBase32SecretKeyAsync(CreateTotpDeviceBase32SecretKeyOptions $create_totp_device_base32_secret_key_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0] ]) : PromiseInterface

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

Parameters

$create_totp_device_base32_secret_key_options : CreateTotpDeviceBase32SecretKeyOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateTotpDeviceForBase32SecretKeyAsyncWithHttpInfo()

Operation agentCreateTotpDeviceForBase32SecretKeyAsyncWithHttpInfo


    public
                    agentCreateTotpDeviceForBase32SecretKeyAsyncWithHttpInfo(CreateTotpDeviceBase32SecretKeyOptions $create_totp_device_base32_secret_key_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0] ]) : PromiseInterface

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

Parameters

$create_totp_device_base32_secret_key_options : CreateTotpDeviceBase32SecretKeyOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateTotpDeviceForBase32SecretKeyRequest()

Create request for operation 'agentCreateTotpDeviceForBase32SecretKey'


    public
                    agentCreateTotpDeviceForBase32SecretKeyRequest(CreateTotpDeviceBase32SecretKeyOptions $create_totp_device_base32_secret_key_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0] ]) : Request

Parameters

$create_totp_device_base32_secret_key_options : CreateTotpDeviceBase32SecretKeyOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'] to see the possible values for this operation

Return values

Request —

agentCreateTotpDeviceForBase32SecretKeyWithHttpInfo()

Operation agentCreateTotpDeviceForBase32SecretKeyWithHttpInfo


    public
                    agentCreateTotpDeviceForBase32SecretKeyWithHttpInfo(CreateTotpDeviceBase32SecretKeyOptions $create_totp_device_base32_secret_key_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0] ]) : array<string|int, mixed>

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

Parameters

$create_totp_device_base32_secret_key_options : CreateTotpDeviceBase32SecretKeyOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForBase32SecretKey'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\TotpDeviceDto, HTTP status code, HTTP response headers (array of strings)

agentCreateTotpDeviceForCustom()

Operation agentCreateTotpDeviceForCustom


    public
                    agentCreateTotpDeviceForCustom(CreateTotpDeviceCustomOptions $create_totp_device_custom_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForCustom'][0] ]) : TotpDeviceDto

Create an agent-managed TOTP device from custom options

Parameters

$create_totp_device_custom_options : CreateTotpDeviceCustomOptions: create_totp_device_custom_options (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForCustom'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForCustom'] to see the possible values for this operation

Return values

TotpDeviceDto —

agentCreateTotpDeviceForCustomAsync()

Operation agentCreateTotpDeviceForCustomAsync


    public
                    agentCreateTotpDeviceForCustomAsync(CreateTotpDeviceCustomOptions $create_totp_device_custom_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForCustom'][0] ]) : PromiseInterface

Create an agent-managed TOTP device from custom options

Parameters

$create_totp_device_custom_options : CreateTotpDeviceCustomOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForCustom'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForCustom'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateTotpDeviceForCustomAsyncWithHttpInfo()

Operation agentCreateTotpDeviceForCustomAsyncWithHttpInfo


    public
                    agentCreateTotpDeviceForCustomAsyncWithHttpInfo(CreateTotpDeviceCustomOptions $create_totp_device_custom_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForCustom'][0] ]) : PromiseInterface

Create an agent-managed TOTP device from custom options

Parameters

$create_totp_device_custom_options : CreateTotpDeviceCustomOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForCustom'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForCustom'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateTotpDeviceForCustomRequest()

Create request for operation 'agentCreateTotpDeviceForCustom'


    public
                    agentCreateTotpDeviceForCustomRequest(CreateTotpDeviceCustomOptions $create_totp_device_custom_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForCustom'][0] ]) : Request

Parameters

$create_totp_device_custom_options : CreateTotpDeviceCustomOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForCustom'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForCustom'] to see the possible values for this operation

Return values

Request —

agentCreateTotpDeviceForCustomWithHttpInfo()

Operation agentCreateTotpDeviceForCustomWithHttpInfo


    public
                    agentCreateTotpDeviceForCustomWithHttpInfo(CreateTotpDeviceCustomOptions $create_totp_device_custom_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForCustom'][0] ]) : array<string|int, mixed>

Create an agent-managed TOTP device from custom options

Parameters

$create_totp_device_custom_options : CreateTotpDeviceCustomOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForCustom'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForCustom'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\TotpDeviceDto, HTTP status code, HTTP response headers (array of strings)

agentCreateTotpDeviceForOtpAuthUrl()

Operation agentCreateTotpDeviceForOtpAuthUrl


    public
                    agentCreateTotpDeviceForOtpAuthUrl(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0] ]) : TotpDeviceDto

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

Parameters

$create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions: create_totp_device_otp_auth_url_options (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'] to see the possible values for this operation

Return values

TotpDeviceDto —

agentCreateTotpDeviceForOtpAuthUrlAsync()

Operation agentCreateTotpDeviceForOtpAuthUrlAsync


    public
                    agentCreateTotpDeviceForOtpAuthUrlAsync(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0] ]) : PromiseInterface

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

Parameters

$create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateTotpDeviceForOtpAuthUrlAsyncWithHttpInfo()

Operation agentCreateTotpDeviceForOtpAuthUrlAsyncWithHttpInfo


    public
                    agentCreateTotpDeviceForOtpAuthUrlAsyncWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0] ]) : PromiseInterface

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

Parameters

$create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'] to see the possible values for this operation

Return values

PromiseInterface —

agentCreateTotpDeviceForOtpAuthUrlRequest()

Create request for operation 'agentCreateTotpDeviceForOtpAuthUrl'


    public
                    agentCreateTotpDeviceForOtpAuthUrlRequest(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0] ]) : Request

Parameters

$create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'] to see the possible values for this operation

Return values

Request —

agentCreateTotpDeviceForOtpAuthUrlWithHttpInfo()

Operation agentCreateTotpDeviceForOtpAuthUrlWithHttpInfo


    public
                    agentCreateTotpDeviceForOtpAuthUrlWithHttpInfo(CreateTotpDeviceOtpAuthUrlOptions $create_totp_device_otp_auth_url_options[, string $contentType = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0] ]) : array<string|int, mixed>

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

Parameters

$create_totp_device_otp_auth_url_options : CreateTotpDeviceOtpAuthUrlOptions: (required)
$contentType : string = self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'][0]: The value for the Content-Type header. Check self::contentTypes['agentCreateTotpDeviceForOtpAuthUrl'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\TotpDeviceDto, HTTP status code, HTTP response headers (array of strings)

agentDeferWorkItem()

Operation agentDeferWorkItem


    public
                    agentDeferWorkItem(string $conversation_id, DeferAgentWorkItemOptions $defer_agent_work_item_options[, string $contentType = self::contentTypes['agentDeferWorkItem'][0] ]) : AgentDeferredWorkItemDto|AgentApiErrorDto

Defer a work item to human review

Parameters

$conversation_id : string: conversation_id (required)
$defer_agent_work_item_options : DeferAgentWorkItemOptions: defer_agent_work_item_options (required)
$contentType : string = self::contentTypes['agentDeferWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeferWorkItem'] to see the possible values for this operation

Return values

AgentDeferredWorkItemDto|AgentApiErrorDto —

agentDeferWorkItemAsync()

Operation agentDeferWorkItemAsync


    public
                    agentDeferWorkItemAsync(string $conversation_id, DeferAgentWorkItemOptions $defer_agent_work_item_options[, string $contentType = self::contentTypes['agentDeferWorkItem'][0] ]) : PromiseInterface

Defer a work item to human review

Parameters

$conversation_id : string: (required)
$defer_agent_work_item_options : DeferAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentDeferWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeferWorkItem'] to see the possible values for this operation

Return values

PromiseInterface —

agentDeferWorkItemAsyncWithHttpInfo()

Operation agentDeferWorkItemAsyncWithHttpInfo


    public
                    agentDeferWorkItemAsyncWithHttpInfo(string $conversation_id, DeferAgentWorkItemOptions $defer_agent_work_item_options[, string $contentType = self::contentTypes['agentDeferWorkItem'][0] ]) : PromiseInterface

Defer a work item to human review

Parameters

$conversation_id : string: (required)
$defer_agent_work_item_options : DeferAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentDeferWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeferWorkItem'] to see the possible values for this operation

Return values

PromiseInterface —

agentDeferWorkItemRequest()

Create request for operation 'agentDeferWorkItem'


    public
                    agentDeferWorkItemRequest(string $conversation_id, DeferAgentWorkItemOptions $defer_agent_work_item_options[, string $contentType = self::contentTypes['agentDeferWorkItem'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$defer_agent_work_item_options : DeferAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentDeferWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeferWorkItem'] to see the possible values for this operation

Return values

Request —

agentDeferWorkItemWithHttpInfo()

Operation agentDeferWorkItemWithHttpInfo


    public
                    agentDeferWorkItemWithHttpInfo(string $conversation_id, DeferAgentWorkItemOptions $defer_agent_work_item_options[, string $contentType = self::contentTypes['agentDeferWorkItem'][0] ]) : array<string|int, mixed>

Defer a work item to human review

Parameters

$conversation_id : string: (required)
$defer_agent_work_item_options : DeferAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentDeferWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeferWorkItem'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentDeferredWorkItemDto|\MailSlurp\Models\AgentApiErrorDto, HTTP status code, HTTP response headers (array of strings)

agentDeleteEmailDraft()

Operation agentDeleteEmailDraft


    public
                    agentDeleteEmailDraft(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentDeleteEmailDraft'][0] ]) : void

Delete a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentDeleteEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteEmailDraft'] to see the possible values for this operation

Return values

void —

agentDeleteEmailDraftAsync()

Operation agentDeleteEmailDraftAsync


    public
                    agentDeleteEmailDraftAsync(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentDeleteEmailDraft'][0] ]) : PromiseInterface

Delete a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentDeleteEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentDeleteEmailDraftAsyncWithHttpInfo()

Operation agentDeleteEmailDraftAsyncWithHttpInfo


    public
                    agentDeleteEmailDraftAsyncWithHttpInfo(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentDeleteEmailDraft'][0] ]) : PromiseInterface

Delete a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentDeleteEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentDeleteEmailDraftRequest()

Create request for operation 'agentDeleteEmailDraft'


    public
                    agentDeleteEmailDraftRequest(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentDeleteEmailDraft'][0] ]) : Request

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentDeleteEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteEmailDraft'] to see the possible values for this operation

Return values

Request —

agentDeleteEmailDraftWithHttpInfo()

Operation agentDeleteEmailDraftWithHttpInfo


    public
                    agentDeleteEmailDraftWithHttpInfo(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentDeleteEmailDraft'][0] ]) : array<string|int, mixed>

Delete a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentDeleteEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteEmailDraft'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

agentDeleteTotpDevice()

Operation agentDeleteTotpDevice


    public
                    agentDeleteTotpDevice(string $id[, string $contentType = self::contentTypes['agentDeleteTotpDevice'][0] ]) : void

Delete an agent-managed TOTP device

Parameters

$id : string: id (required)
$contentType : string = self::contentTypes['agentDeleteTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteTotpDevice'] to see the possible values for this operation

Return values

void —

agentDeleteTotpDeviceAsync()

Operation agentDeleteTotpDeviceAsync


    public
                    agentDeleteTotpDeviceAsync(string $id[, string $contentType = self::contentTypes['agentDeleteTotpDevice'][0] ]) : PromiseInterface

Delete an agent-managed TOTP device

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['agentDeleteTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteTotpDevice'] to see the possible values for this operation

Return values

PromiseInterface —

agentDeleteTotpDeviceAsyncWithHttpInfo()

Operation agentDeleteTotpDeviceAsyncWithHttpInfo


    public
                    agentDeleteTotpDeviceAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['agentDeleteTotpDevice'][0] ]) : PromiseInterface

Delete an agent-managed TOTP device

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['agentDeleteTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteTotpDevice'] to see the possible values for this operation

Return values

PromiseInterface —

agentDeleteTotpDeviceRequest()

Create request for operation 'agentDeleteTotpDevice'


    public
                    agentDeleteTotpDeviceRequest(string $id[, string $contentType = self::contentTypes['agentDeleteTotpDevice'][0] ]) : Request

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['agentDeleteTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteTotpDevice'] to see the possible values for this operation

Return values

Request —

agentDeleteTotpDeviceWithHttpInfo()

Operation agentDeleteTotpDeviceWithHttpInfo


    public
                    agentDeleteTotpDeviceWithHttpInfo(string $id[, string $contentType = self::contentTypes['agentDeleteTotpDevice'][0] ]) : array<string|int, mixed>

Delete an agent-managed TOTP device

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['agentDeleteTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentDeleteTotpDevice'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

agentExtractEmailAttachmentText()

Operation agentExtractEmailAttachmentText


    public
                    agentExtractEmailAttachmentText(string $email_id, string $attachment_id[, ExtractAttachmentTextOptions $extract_attachment_text_options = null ][, string $contentType = self::contentTypes['agentExtractEmailAttachmentText'][0] ]) : ExtractAttachmentTextResult

Extract text from a scoped email attachment for an agent

Parameters

$email_id : string: email_id (required)
$attachment_id : string: attachment_id (required)
$extract_attachment_text_options : ExtractAttachmentTextOptions = null: extract_attachment_text_options (optional)
$contentType : string = self::contentTypes['agentExtractEmailAttachmentText'][0]: The value for the Content-Type header. Check self::contentTypes['agentExtractEmailAttachmentText'] to see the possible values for this operation

Return values

ExtractAttachmentTextResult —

agentExtractEmailAttachmentTextAsync()

Operation agentExtractEmailAttachmentTextAsync


    public
                    agentExtractEmailAttachmentTextAsync(string $email_id, string $attachment_id[, ExtractAttachmentTextOptions $extract_attachment_text_options = null ][, string $contentType = self::contentTypes['agentExtractEmailAttachmentText'][0] ]) : PromiseInterface

Extract text from a scoped email attachment for an agent

Parameters

$email_id : string: (required)
$attachment_id : string: (required)
$extract_attachment_text_options : ExtractAttachmentTextOptions = null: (optional)
$contentType : string = self::contentTypes['agentExtractEmailAttachmentText'][0]: The value for the Content-Type header. Check self::contentTypes['agentExtractEmailAttachmentText'] to see the possible values for this operation

Return values

PromiseInterface —

agentExtractEmailAttachmentTextAsyncWithHttpInfo()

Operation agentExtractEmailAttachmentTextAsyncWithHttpInfo


    public
                    agentExtractEmailAttachmentTextAsyncWithHttpInfo(string $email_id, string $attachment_id[, ExtractAttachmentTextOptions $extract_attachment_text_options = null ][, string $contentType = self::contentTypes['agentExtractEmailAttachmentText'][0] ]) : PromiseInterface

Extract text from a scoped email attachment for an agent

Parameters

$email_id : string: (required)
$attachment_id : string: (required)
$extract_attachment_text_options : ExtractAttachmentTextOptions = null: (optional)
$contentType : string = self::contentTypes['agentExtractEmailAttachmentText'][0]: The value for the Content-Type header. Check self::contentTypes['agentExtractEmailAttachmentText'] to see the possible values for this operation

Return values

PromiseInterface —

agentExtractEmailAttachmentTextRequest()

Create request for operation 'agentExtractEmailAttachmentText'


    public
                    agentExtractEmailAttachmentTextRequest(string $email_id, string $attachment_id[, ExtractAttachmentTextOptions $extract_attachment_text_options = null ][, string $contentType = self::contentTypes['agentExtractEmailAttachmentText'][0] ]) : Request

Parameters

$email_id : string: (required)
$attachment_id : string: (required)
$extract_attachment_text_options : ExtractAttachmentTextOptions = null: (optional)
$contentType : string = self::contentTypes['agentExtractEmailAttachmentText'][0]: The value for the Content-Type header. Check self::contentTypes['agentExtractEmailAttachmentText'] to see the possible values for this operation

Return values

Request —

agentExtractEmailAttachmentTextWithHttpInfo()

Operation agentExtractEmailAttachmentTextWithHttpInfo


    public
                    agentExtractEmailAttachmentTextWithHttpInfo(string $email_id, string $attachment_id[, ExtractAttachmentTextOptions $extract_attachment_text_options = null ][, string $contentType = self::contentTypes['agentExtractEmailAttachmentText'][0] ]) : array<string|int, mixed>

Extract text from a scoped email attachment for an agent

Parameters

$email_id : string: (required)
$attachment_id : string: (required)
$extract_attachment_text_options : ExtractAttachmentTextOptions = null: (optional)
$contentType : string = self::contentTypes['agentExtractEmailAttachmentText'][0]: The value for the Content-Type header. Check self::contentTypes['agentExtractEmailAttachmentText'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\ExtractAttachmentTextResult, HTTP status code, HTTP response headers (array of strings)

agentGenerateTotpDeviceCode()

Operation agentGenerateTotpDeviceCode


    public
                    agentGenerateTotpDeviceCode(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['agentGenerateTotpDeviceCode'][0] ]) : TotpDeviceCodeDto

Generate a code for an agent-managed TOTP device

Parameters

$id : string: id (required)
$at : DateTime = null: at (optional)
$min_seconds_until_expire : int = 5: Minimum remaining code lifetime. The request may wait for the next period when needed. (optional, default to 5)
$contentType : string = self::contentTypes['agentGenerateTotpDeviceCode'][0]: The value for the Content-Type header. Check self::contentTypes['agentGenerateTotpDeviceCode'] to see the possible values for this operation

Return values

TotpDeviceCodeDto —

agentGenerateTotpDeviceCodeAsync()

Operation agentGenerateTotpDeviceCodeAsync


    public
                    agentGenerateTotpDeviceCodeAsync(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['agentGenerateTotpDeviceCode'][0] ]) : PromiseInterface

Generate a code for an agent-managed TOTP device

Parameters

$id : string: (required)
$at : DateTime = null: (optional)
$min_seconds_until_expire : int = 5: Minimum remaining code lifetime. The request may wait for the next period when needed. (optional, default to 5)
$contentType : string = self::contentTypes['agentGenerateTotpDeviceCode'][0]: The value for the Content-Type header. Check self::contentTypes['agentGenerateTotpDeviceCode'] to see the possible values for this operation

Return values

PromiseInterface —

agentGenerateTotpDeviceCodeAsyncWithHttpInfo()

Operation agentGenerateTotpDeviceCodeAsyncWithHttpInfo


    public
                    agentGenerateTotpDeviceCodeAsyncWithHttpInfo(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['agentGenerateTotpDeviceCode'][0] ]) : PromiseInterface

Generate a code for an agent-managed TOTP device

Parameters

$id : string: (required)
$at : DateTime = null: (optional)
$min_seconds_until_expire : int = 5: Minimum remaining code lifetime. The request may wait for the next period when needed. (optional, default to 5)
$contentType : string = self::contentTypes['agentGenerateTotpDeviceCode'][0]: The value for the Content-Type header. Check self::contentTypes['agentGenerateTotpDeviceCode'] to see the possible values for this operation

Return values

PromiseInterface —

agentGenerateTotpDeviceCodeRequest()

Create request for operation 'agentGenerateTotpDeviceCode'


    public
                    agentGenerateTotpDeviceCodeRequest(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['agentGenerateTotpDeviceCode'][0] ]) : Request

Parameters

$id : string: (required)
$at : DateTime = null: (optional)
$min_seconds_until_expire : int = 5: Minimum remaining code lifetime. The request may wait for the next period when needed. (optional, default to 5)
$contentType : string = self::contentTypes['agentGenerateTotpDeviceCode'][0]: The value for the Content-Type header. Check self::contentTypes['agentGenerateTotpDeviceCode'] to see the possible values for this operation

Return values

Request —

agentGenerateTotpDeviceCodeWithHttpInfo()

Operation agentGenerateTotpDeviceCodeWithHttpInfo


    public
                    agentGenerateTotpDeviceCodeWithHttpInfo(string $id[, DateTime $at = null ][, int $min_seconds_until_expire = 5 ][, string $contentType = self::contentTypes['agentGenerateTotpDeviceCode'][0] ]) : array<string|int, mixed>

Generate a code for an agent-managed TOTP device

Parameters

$id : string: (required)
$at : DateTime = null: (optional)
$min_seconds_until_expire : int = 5: Minimum remaining code lifetime. The request may wait for the next period when needed. (optional, default to 5)
$contentType : string = self::contentTypes['agentGenerateTotpDeviceCode'][0]: The value for the Content-Type header. Check self::contentTypes['agentGenerateTotpDeviceCode'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\TotpDeviceCodeDto, HTTP status code, HTTP response headers (array of strings)

agentGetCapabilities()

Operation agentGetCapabilities


    public
                    agentGetCapabilities([string $contentType = self::contentTypes['agentGetCapabilities'][0] ]) : AgentCapabilitiesDto

Discover this agent connection's capabilities

Parameters

$contentType : string = self::contentTypes['agentGetCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetCapabilities'] to see the possible values for this operation

Return values

AgentCapabilitiesDto —

agentGetCapabilitiesAsync()

Operation agentGetCapabilitiesAsync


    public
                    agentGetCapabilitiesAsync([string $contentType = self::contentTypes['agentGetCapabilities'][0] ]) : PromiseInterface

Discover this agent connection's capabilities

Parameters

$contentType : string = self::contentTypes['agentGetCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetCapabilities'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetCapabilitiesAsyncWithHttpInfo()

Operation agentGetCapabilitiesAsyncWithHttpInfo


    public
                    agentGetCapabilitiesAsyncWithHttpInfo([string $contentType = self::contentTypes['agentGetCapabilities'][0] ]) : PromiseInterface

Discover this agent connection's capabilities

Parameters

$contentType : string = self::contentTypes['agentGetCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetCapabilities'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetCapabilitiesRequest()

Create request for operation 'agentGetCapabilities'


    public
                    agentGetCapabilitiesRequest([string $contentType = self::contentTypes['agentGetCapabilities'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['agentGetCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetCapabilities'] to see the possible values for this operation

Return values

Request —

agentGetCapabilitiesWithHttpInfo()

Operation agentGetCapabilitiesWithHttpInfo


    public
                    agentGetCapabilitiesWithHttpInfo([string $contentType = self::contentTypes['agentGetCapabilities'][0] ]) : array<string|int, mixed>

Discover this agent connection's capabilities

Parameters

$contentType : string = self::contentTypes['agentGetCapabilities'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetCapabilities'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentCapabilitiesDto, HTTP status code, HTTP response headers (array of strings)

agentGetConversationV2()

Operation agentGetConversationV2


    public
                    agentGetConversationV2(string $conversation_id[, string $contentType = self::contentTypes['agentGetConversationV2'][0] ]) : AgentConversationDetailV2Dto

Get one scoped conversation

Parameters

$conversation_id : string: conversation_id (required)
$contentType : string = self::contentTypes['agentGetConversationV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetConversationV2'] to see the possible values for this operation

Return values

AgentConversationDetailV2Dto —

agentGetConversationV2Async()

Operation agentGetConversationV2Async


    public
                    agentGetConversationV2Async(string $conversation_id[, string $contentType = self::contentTypes['agentGetConversationV2'][0] ]) : PromiseInterface

Get one scoped conversation

Parameters

$conversation_id : string: (required)
$contentType : string = self::contentTypes['agentGetConversationV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetConversationV2'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetConversationV2AsyncWithHttpInfo()

Operation agentGetConversationV2AsyncWithHttpInfo


    public
                    agentGetConversationV2AsyncWithHttpInfo(string $conversation_id[, string $contentType = self::contentTypes['agentGetConversationV2'][0] ]) : PromiseInterface

Get one scoped conversation

Parameters

$conversation_id : string: (required)
$contentType : string = self::contentTypes['agentGetConversationV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetConversationV2'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetConversationV2Request()

Create request for operation 'agentGetConversationV2'


    public
                    agentGetConversationV2Request(string $conversation_id[, string $contentType = self::contentTypes['agentGetConversationV2'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$contentType : string = self::contentTypes['agentGetConversationV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetConversationV2'] to see the possible values for this operation

Return values

Request —

agentGetConversationV2WithHttpInfo()

Operation agentGetConversationV2WithHttpInfo


    public
                    agentGetConversationV2WithHttpInfo(string $conversation_id[, string $contentType = self::contentTypes['agentGetConversationV2'][0] ]) : array<string|int, mixed>

Get one scoped conversation

Parameters

$conversation_id : string: (required)
$contentType : string = self::contentTypes['agentGetConversationV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetConversationV2'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationDetailV2Dto, HTTP status code, HTTP response headers (array of strings)

agentGetEmail()

Operation agentGetEmail


    public
                    agentGetEmail(string $email_id[, string $contentType = self::contentTypes['agentGetEmail'][0] ]) : Email

Get scoped hydrated email for an agent

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmail'] to see the possible values for this operation

Return values

Email —

agentGetEmailAsync()

Operation agentGetEmailAsync


    public
                    agentGetEmailAsync(string $email_id[, string $contentType = self::contentTypes['agentGetEmail'][0] ]) : PromiseInterface

Get scoped hydrated email for an agent

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmail'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetEmailAsyncWithHttpInfo()

Operation agentGetEmailAsyncWithHttpInfo


    public
                    agentGetEmailAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['agentGetEmail'][0] ]) : PromiseInterface

Get scoped hydrated email for an agent

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmail'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetEmailDraft()

Operation agentGetEmailDraft


    public
                    agentGetEmailDraft(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentGetEmailDraft'][0] ]) : EmailDraftDto

Get a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentGetEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailDraft'] to see the possible values for this operation

Return values

EmailDraftDto —

agentGetEmailDraftAsync()

Operation agentGetEmailDraftAsync


    public
                    agentGetEmailDraftAsync(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentGetEmailDraft'][0] ]) : PromiseInterface

Get a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentGetEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetEmailDraftAsyncWithHttpInfo()

Operation agentGetEmailDraftAsyncWithHttpInfo


    public
                    agentGetEmailDraftAsyncWithHttpInfo(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentGetEmailDraft'][0] ]) : PromiseInterface

Get a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentGetEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetEmailDraftRequest()

Create request for operation 'agentGetEmailDraft'


    public
                    agentGetEmailDraftRequest(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentGetEmailDraft'][0] ]) : Request

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentGetEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailDraft'] to see the possible values for this operation

Return values

Request —

agentGetEmailDraftWithHttpInfo()

Operation agentGetEmailDraftWithHttpInfo


    public
                    agentGetEmailDraftWithHttpInfo(string $inbox_id, string $draft_id[, string $contentType = self::contentTypes['agentGetEmailDraft'][0] ]) : array<string|int, mixed>

Get a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$contentType : string = self::contentTypes['agentGetEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailDraft'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailDraftDto, HTTP status code, HTTP response headers (array of strings)

agentGetEmailRequest()

Create request for operation 'agentGetEmail'


    public
                    agentGetEmailRequest(string $email_id[, string $contentType = self::contentTypes['agentGetEmail'][0] ]) : Request

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmail'] to see the possible values for this operation

Return values

Request —

agentGetEmailSummary()

Operation agentGetEmailSummary


    public
                    agentGetEmailSummary(string $email_id[, string $contentType = self::contentTypes['agentGetEmailSummary'][0] ]) : EmailPreview

Get scoped email summary for an agent

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmailSummary'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailSummary'] to see the possible values for this operation

Return values

EmailPreview —

agentGetEmailSummaryAsync()

Operation agentGetEmailSummaryAsync


    public
                    agentGetEmailSummaryAsync(string $email_id[, string $contentType = self::contentTypes['agentGetEmailSummary'][0] ]) : PromiseInterface

Get scoped email summary for an agent

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmailSummary'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailSummary'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetEmailSummaryAsyncWithHttpInfo()

Operation agentGetEmailSummaryAsyncWithHttpInfo


    public
                    agentGetEmailSummaryAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['agentGetEmailSummary'][0] ]) : PromiseInterface

Get scoped email summary for an agent

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmailSummary'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailSummary'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetEmailSummaryRequest()

Create request for operation 'agentGetEmailSummary'


    public
                    agentGetEmailSummaryRequest(string $email_id[, string $contentType = self::contentTypes['agentGetEmailSummary'][0] ]) : Request

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmailSummary'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailSummary'] to see the possible values for this operation

Return values

Request —

agentGetEmailSummaryWithHttpInfo()

Operation agentGetEmailSummaryWithHttpInfo


    public
                    agentGetEmailSummaryWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['agentGetEmailSummary'][0] ]) : array<string|int, mixed>

Get scoped email summary for an agent

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmailSummary'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailSummary'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailPreview, HTTP status code, HTTP response headers (array of strings)

agentGetEmailThread()

Operation agentGetEmailThread


    public
                    agentGetEmailThread(string $email_id[, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentGetEmailThread'][0] ]) : ScopedEmailThread

Get a scoped email thread for an agent

Parameters

$email_id : string: email_id (required)
$sort : string = 'ASC': sort (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentGetEmailThread'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailThread'] to see the possible values for this operation

Return values

ScopedEmailThread —

agentGetEmailThreadAsync()

Operation agentGetEmailThreadAsync


    public
                    agentGetEmailThreadAsync(string $email_id[, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentGetEmailThread'][0] ]) : PromiseInterface

Get a scoped email thread for an agent

Parameters

$email_id : string: (required)
$sort : string = 'ASC': (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentGetEmailThread'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailThread'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetEmailThreadAsyncWithHttpInfo()

Operation agentGetEmailThreadAsyncWithHttpInfo


    public
                    agentGetEmailThreadAsyncWithHttpInfo(string $email_id[, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentGetEmailThread'][0] ]) : PromiseInterface

Get a scoped email thread for an agent

Parameters

$email_id : string: (required)
$sort : string = 'ASC': (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentGetEmailThread'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailThread'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetEmailThreadRequest()

Create request for operation 'agentGetEmailThread'


    public
                    agentGetEmailThreadRequest(string $email_id[, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentGetEmailThread'][0] ]) : Request

Parameters

$email_id : string: (required)
$sort : string = 'ASC': (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentGetEmailThread'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailThread'] to see the possible values for this operation

Return values

Request —

agentGetEmailThreadWithHttpInfo()

Operation agentGetEmailThreadWithHttpInfo


    public
                    agentGetEmailThreadWithHttpInfo(string $email_id[, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentGetEmailThread'][0] ]) : array<string|int, mixed>

Get a scoped email thread for an agent

Parameters

$email_id : string: (required)
$sort : string = 'ASC': (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentGetEmailThread'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmailThread'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\ScopedEmailThread, HTTP status code, HTTP response headers (array of strings)

agentGetEmailWithHttpInfo()

Operation agentGetEmailWithHttpInfo


    public
                    agentGetEmailWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['agentGetEmail'][0] ]) : array<string|int, mixed>

Get scoped hydrated email for an agent

Parameters

$email_id : string: ID of email to inspect (required)
$contentType : string = self::contentTypes['agentGetEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\Email, HTTP status code, HTTP response headers (array of strings)

agentGetLatestInboxEmail()

Operation agentGetLatestInboxEmail


    public
                    agentGetLatestInboxEmail(string $inbox_id[, int $timeout_millis = 30000 ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentGetLatestInboxEmail'][0] ]) : Email

Get latest scoped inbox email for an agent

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$timeout_millis : int = 30000: Timeout milliseconds to wait for latest email (optional, default to 30000)
$unread_only : bool = false: Only return unread emails (optional, default to false)
$since : DateTime = null: Only return email received at or after this time (optional)
$before : DateTime = null: Only return email received before this time (optional)
$contentType : string = self::contentTypes['agentGetLatestInboxEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetLatestInboxEmail'] to see the possible values for this operation

Return values

Email —

agentGetLatestInboxEmailAsync()

Operation agentGetLatestInboxEmailAsync


    public
                    agentGetLatestInboxEmailAsync(string $inbox_id[, int $timeout_millis = 30000 ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentGetLatestInboxEmail'][0] ]) : PromiseInterface

Get latest scoped inbox email for an agent

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$timeout_millis : int = 30000: Timeout milliseconds to wait for latest email (optional, default to 30000)
$unread_only : bool = false: Only return unread emails (optional, default to false)
$since : DateTime = null: Only return email received at or after this time (optional)
$before : DateTime = null: Only return email received before this time (optional)
$contentType : string = self::contentTypes['agentGetLatestInboxEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetLatestInboxEmail'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetLatestInboxEmailAsyncWithHttpInfo()

Operation agentGetLatestInboxEmailAsyncWithHttpInfo


    public
                    agentGetLatestInboxEmailAsyncWithHttpInfo(string $inbox_id[, int $timeout_millis = 30000 ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentGetLatestInboxEmail'][0] ]) : PromiseInterface

Get latest scoped inbox email for an agent

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$timeout_millis : int = 30000: Timeout milliseconds to wait for latest email (optional, default to 30000)
$unread_only : bool = false: Only return unread emails (optional, default to false)
$since : DateTime = null: Only return email received at or after this time (optional)
$before : DateTime = null: Only return email received before this time (optional)
$contentType : string = self::contentTypes['agentGetLatestInboxEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetLatestInboxEmail'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetLatestInboxEmailRequest()

Create request for operation 'agentGetLatestInboxEmail'


    public
                    agentGetLatestInboxEmailRequest(string $inbox_id[, int $timeout_millis = 30000 ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentGetLatestInboxEmail'][0] ]) : Request

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$timeout_millis : int = 30000: Timeout milliseconds to wait for latest email (optional, default to 30000)
$unread_only : bool = false: Only return unread emails (optional, default to false)
$since : DateTime = null: Only return email received at or after this time (optional)
$before : DateTime = null: Only return email received before this time (optional)
$contentType : string = self::contentTypes['agentGetLatestInboxEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetLatestInboxEmail'] to see the possible values for this operation

Return values

Request —

agentGetLatestInboxEmailWithHttpInfo()

Operation agentGetLatestInboxEmailWithHttpInfo


    public
                    agentGetLatestInboxEmailWithHttpInfo(string $inbox_id[, int $timeout_millis = 30000 ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentGetLatestInboxEmail'][0] ]) : array<string|int, mixed>

Get latest scoped inbox email for an agent

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$timeout_millis : int = 30000: Timeout milliseconds to wait for latest email (optional, default to 30000)
$unread_only : bool = false: Only return unread emails (optional, default to false)
$since : DateTime = null: Only return email received at or after this time (optional)
$before : DateTime = null: Only return email received before this time (optional)
$contentType : string = self::contentTypes['agentGetLatestInboxEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetLatestInboxEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\Email, HTTP status code, HTTP response headers (array of strings)

agentGetNextWorkItem()

Operation agentGetNextWorkItem


    public
                    agentGetNextWorkItem(GetNextAgentWorkItemOptions $get_next_agent_work_item_options[, string $contentType = self::contentTypes['agentGetNextWorkItem'][0] ]) : AgentWorkItemDto|AgentApiErrorDto

Claim the next conversation work item

Parameters

$get_next_agent_work_item_options : GetNextAgentWorkItemOptions: get_next_agent_work_item_options (required)
$contentType : string = self::contentTypes['agentGetNextWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetNextWorkItem'] to see the possible values for this operation

Return values

AgentWorkItemDto|AgentApiErrorDto —

agentGetNextWorkItemAsync()

Operation agentGetNextWorkItemAsync


    public
                    agentGetNextWorkItemAsync(GetNextAgentWorkItemOptions $get_next_agent_work_item_options[, string $contentType = self::contentTypes['agentGetNextWorkItem'][0] ]) : PromiseInterface

Claim the next conversation work item

Parameters

$get_next_agent_work_item_options : GetNextAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentGetNextWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetNextWorkItem'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetNextWorkItemAsyncWithHttpInfo()

Operation agentGetNextWorkItemAsyncWithHttpInfo


    public
                    agentGetNextWorkItemAsyncWithHttpInfo(GetNextAgentWorkItemOptions $get_next_agent_work_item_options[, string $contentType = self::contentTypes['agentGetNextWorkItem'][0] ]) : PromiseInterface

Claim the next conversation work item

Parameters

$get_next_agent_work_item_options : GetNextAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentGetNextWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetNextWorkItem'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetNextWorkItemRequest()

Create request for operation 'agentGetNextWorkItem'


    public
                    agentGetNextWorkItemRequest(GetNextAgentWorkItemOptions $get_next_agent_work_item_options[, string $contentType = self::contentTypes['agentGetNextWorkItem'][0] ]) : Request

Parameters

$get_next_agent_work_item_options : GetNextAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentGetNextWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetNextWorkItem'] to see the possible values for this operation

Return values

Request —

agentGetNextWorkItemWithHttpInfo()

Operation agentGetNextWorkItemWithHttpInfo


    public
                    agentGetNextWorkItemWithHttpInfo(GetNextAgentWorkItemOptions $get_next_agent_work_item_options[, string $contentType = self::contentTypes['agentGetNextWorkItem'][0] ]) : array<string|int, mixed>

Claim the next conversation work item

Parameters

$get_next_agent_work_item_options : GetNextAgentWorkItemOptions: (required)
$contentType : string = self::contentTypes['agentGetNextWorkItem'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetNextWorkItem'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentWorkItemDto|\MailSlurp\Models\AgentApiErrorDto, HTTP status code, HTTP response headers (array of strings)

agentGetPhoneMessageThreadItems()

Operation agentGetPhoneMessageThreadItems


    public
                    agentGetPhoneMessageThreadItems(string $phone_number_id, string $other_phone_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreadItems'][0] ]) : PagePhoneMessageThreadItemProjection

List SMS thread messages

Parameters

$phone_number_id : string: phone_number_id (required)
$other_phone_number : string: Other participant phone number in E.164 format (required)
$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreadItems'] to see the possible values for this operation

Return values

PagePhoneMessageThreadItemProjection —

agentGetPhoneMessageThreadItemsAsync()

Operation agentGetPhoneMessageThreadItemsAsync


    public
                    agentGetPhoneMessageThreadItemsAsync(string $phone_number_id, string $other_phone_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreadItems'][0] ]) : PromiseInterface

List SMS thread messages

Parameters

$phone_number_id : string: (required)
$other_phone_number : string: Other participant phone number in E.164 format (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreadItems'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetPhoneMessageThreadItemsAsyncWithHttpInfo()

Operation agentGetPhoneMessageThreadItemsAsyncWithHttpInfo


    public
                    agentGetPhoneMessageThreadItemsAsyncWithHttpInfo(string $phone_number_id, string $other_phone_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreadItems'][0] ]) : PromiseInterface

List SMS thread messages

Parameters

$phone_number_id : string: (required)
$other_phone_number : string: Other participant phone number in E.164 format (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreadItems'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetPhoneMessageThreadItemsRequest()

Create request for operation 'agentGetPhoneMessageThreadItems'


    public
                    agentGetPhoneMessageThreadItemsRequest(string $phone_number_id, string $other_phone_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreadItems'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$other_phone_number : string: Other participant phone number in E.164 format (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreadItems'] to see the possible values for this operation

Return values

Request —

agentGetPhoneMessageThreadItemsWithHttpInfo()

Operation agentGetPhoneMessageThreadItemsWithHttpInfo


    public
                    agentGetPhoneMessageThreadItemsWithHttpInfo(string $phone_number_id, string $other_phone_number, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreadItems'][0] ]) : array<string|int, mixed>

List SMS thread messages

Parameters

$phone_number_id : string: (required)
$other_phone_number : string: Other participant phone number in E.164 format (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreadItems'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreadItems'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PagePhoneMessageThreadItemProjection, HTTP status code, HTTP response headers (array of strings)

agentGetPhoneMessageThreads()

Operation agentGetPhoneMessageThreads


    public
                    agentGetPhoneMessageThreads(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreads'][0] ]) : PagePhoneMessageThreadProjection

List SMS threads

Parameters

$phone_number_id : string: phone_number_id (required)
$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreads'] to see the possible values for this operation

Return values

PagePhoneMessageThreadProjection —

agentGetPhoneMessageThreadsAsync()

Operation agentGetPhoneMessageThreadsAsync


    public
                    agentGetPhoneMessageThreadsAsync(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreads'][0] ]) : PromiseInterface

List SMS threads

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreads'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetPhoneMessageThreadsAsyncWithHttpInfo()

Operation agentGetPhoneMessageThreadsAsyncWithHttpInfo


    public
                    agentGetPhoneMessageThreadsAsyncWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreads'][0] ]) : PromiseInterface

List SMS threads

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreads'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetPhoneMessageThreadsRequest()

Create request for operation 'agentGetPhoneMessageThreads'


    public
                    agentGetPhoneMessageThreadsRequest(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreads'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreads'] to see the possible values for this operation

Return values

Request —

agentGetPhoneMessageThreadsWithHttpInfo()

Operation agentGetPhoneMessageThreadsWithHttpInfo


    public
                    agentGetPhoneMessageThreadsWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $contentType = self::contentTypes['agentGetPhoneMessageThreads'][0] ]) : array<string|int, mixed>

List SMS threads

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentGetPhoneMessageThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneMessageThreads'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PagePhoneMessageThreadProjection, HTTP status code, HTTP response headers (array of strings)

agentGetPhoneNumber()

Operation agentGetPhoneNumber


    public
                    agentGetPhoneNumber(string $phone_number_id[, string $contentType = self::contentTypes['agentGetPhoneNumber'][0] ]) : PhoneNumberDto

Get an assigned phone number

Parameters

$phone_number_id : string: phone_number_id (required)
$contentType : string = self::contentTypes['agentGetPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumber'] to see the possible values for this operation

Return values

PhoneNumberDto —

agentGetPhoneNumberAsync()

Operation agentGetPhoneNumberAsync


    public
                    agentGetPhoneNumberAsync(string $phone_number_id[, string $contentType = self::contentTypes['agentGetPhoneNumber'][0] ]) : PromiseInterface

Get an assigned phone number

Parameters

$phone_number_id : string: (required)
$contentType : string = self::contentTypes['agentGetPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetPhoneNumberAsyncWithHttpInfo()

Operation agentGetPhoneNumberAsyncWithHttpInfo


    public
                    agentGetPhoneNumberAsyncWithHttpInfo(string $phone_number_id[, string $contentType = self::contentTypes['agentGetPhoneNumber'][0] ]) : PromiseInterface

Get an assigned phone number

Parameters

$phone_number_id : string: (required)
$contentType : string = self::contentTypes['agentGetPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumber'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetPhoneNumberRequest()

Create request for operation 'agentGetPhoneNumber'


    public
                    agentGetPhoneNumberRequest(string $phone_number_id[, string $contentType = self::contentTypes['agentGetPhoneNumber'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$contentType : string = self::contentTypes['agentGetPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumber'] to see the possible values for this operation

Return values

Request —

agentGetPhoneNumbers()

Operation agentGetPhoneNumbers


    public
                    agentGetPhoneNumbers(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, string $contentType = self::contentTypes['agentGetPhoneNumbers'][0] ]) : PageAgentPhoneNumber

List assigned phone numbers

Parameters

$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$sort : string = 'DESC': sort (optional, default to 'DESC')
$search : string = null: search (optional)
$contentType : string = self::contentTypes['agentGetPhoneNumbers'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumbers'] to see the possible values for this operation

Return values

PageAgentPhoneNumber —

agentGetPhoneNumbersAsync()

Operation agentGetPhoneNumbersAsync


    public
                    agentGetPhoneNumbersAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, string $contentType = self::contentTypes['agentGetPhoneNumbers'][0] ]) : PromiseInterface

List assigned phone numbers

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$search : string = null: (optional)
$contentType : string = self::contentTypes['agentGetPhoneNumbers'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumbers'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetPhoneNumbersAsyncWithHttpInfo()

Operation agentGetPhoneNumbersAsyncWithHttpInfo


    public
                    agentGetPhoneNumbersAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, string $contentType = self::contentTypes['agentGetPhoneNumbers'][0] ]) : PromiseInterface

List assigned phone numbers

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$search : string = null: (optional)
$contentType : string = self::contentTypes['agentGetPhoneNumbers'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumbers'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetPhoneNumbersRequest()

Create request for operation 'agentGetPhoneNumbers'


    public
                    agentGetPhoneNumbersRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, string $contentType = self::contentTypes['agentGetPhoneNumbers'][0] ]) : Request

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$search : string = null: (optional)
$contentType : string = self::contentTypes['agentGetPhoneNumbers'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumbers'] to see the possible values for this operation

Return values

Request —

agentGetPhoneNumbersWithHttpInfo()

Operation agentGetPhoneNumbersWithHttpInfo


    public
                    agentGetPhoneNumbersWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, string $contentType = self::contentTypes['agentGetPhoneNumbers'][0] ]) : array<string|int, mixed>

List assigned phone numbers

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$search : string = null: (optional)
$contentType : string = self::contentTypes['agentGetPhoneNumbers'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumbers'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageAgentPhoneNumber, HTTP status code, HTTP response headers (array of strings)

agentGetPhoneNumberWithHttpInfo()

Operation agentGetPhoneNumberWithHttpInfo


    public
                    agentGetPhoneNumberWithHttpInfo(string $phone_number_id[, string $contentType = self::contentTypes['agentGetPhoneNumber'][0] ]) : array<string|int, mixed>

Get an assigned phone number

Parameters

$phone_number_id : string: (required)
$contentType : string = self::contentTypes['agentGetPhoneNumber'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetPhoneNumber'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PhoneNumberDto, HTTP status code, HTTP response headers (array of strings)

agentGetReceivedSmsMessage()

Operation agentGetReceivedSmsMessage


    public
                    agentGetReceivedSmsMessage(string $phone_number_id, string $sms_id[, string $contentType = self::contentTypes['agentGetReceivedSmsMessage'][0] ]) : SmsDto

Get received SMS

Parameters

$phone_number_id : string: phone_number_id (required)
$sms_id : string: sms_id (required)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessage'] to see the possible values for this operation

Return values

SmsDto —

agentGetReceivedSmsMessageAsync()

Operation agentGetReceivedSmsMessageAsync


    public
                    agentGetReceivedSmsMessageAsync(string $phone_number_id, string $sms_id[, string $contentType = self::contentTypes['agentGetReceivedSmsMessage'][0] ]) : PromiseInterface

Get received SMS

Parameters

$phone_number_id : string: (required)
$sms_id : string: (required)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessage'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetReceivedSmsMessageAsyncWithHttpInfo()

Operation agentGetReceivedSmsMessageAsyncWithHttpInfo


    public
                    agentGetReceivedSmsMessageAsyncWithHttpInfo(string $phone_number_id, string $sms_id[, string $contentType = self::contentTypes['agentGetReceivedSmsMessage'][0] ]) : PromiseInterface

Get received SMS

Parameters

$phone_number_id : string: (required)
$sms_id : string: (required)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessage'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetReceivedSmsMessageRequest()

Create request for operation 'agentGetReceivedSmsMessage'


    public
                    agentGetReceivedSmsMessageRequest(string $phone_number_id, string $sms_id[, string $contentType = self::contentTypes['agentGetReceivedSmsMessage'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$sms_id : string: (required)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessage'] to see the possible values for this operation

Return values

Request —

agentGetReceivedSmsMessages()

Operation agentGetReceivedSmsMessages


    public
                    agentGetReceivedSmsMessages(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = null ][, string $contentType = self::contentTypes['agentGetReceivedSmsMessages'][0] ]) : PageSmsProjection

List received SMS for an assigned phone number

Parameters

$phone_number_id : string: phone_number_id (required)
$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$sort : string = 'DESC': sort (optional, default to 'DESC')
$since : DateTime = null: since (optional)
$before : DateTime = null: before (optional)
$search : string = null: search (optional)
$favourite : bool = null: favourite (optional)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessages'] to see the possible values for this operation

Return values

PageSmsProjection —

agentGetReceivedSmsMessagesAsync()

Operation agentGetReceivedSmsMessagesAsync


    public
                    agentGetReceivedSmsMessagesAsync(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = null ][, string $contentType = self::contentTypes['agentGetReceivedSmsMessages'][0] ]) : PromiseInterface

List received SMS for an assigned phone number

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$favourite : bool = null: (optional)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessages'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetReceivedSmsMessagesAsyncWithHttpInfo()

Operation agentGetReceivedSmsMessagesAsyncWithHttpInfo


    public
                    agentGetReceivedSmsMessagesAsyncWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = null ][, string $contentType = self::contentTypes['agentGetReceivedSmsMessages'][0] ]) : PromiseInterface

List received SMS for an assigned phone number

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$favourite : bool = null: (optional)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessages'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetReceivedSmsMessagesRequest()

Create request for operation 'agentGetReceivedSmsMessages'


    public
                    agentGetReceivedSmsMessagesRequest(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = null ][, string $contentType = self::contentTypes['agentGetReceivedSmsMessages'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$favourite : bool = null: (optional)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessages'] to see the possible values for this operation

Return values

Request —

agentGetReceivedSmsMessagesWithHttpInfo()

Operation agentGetReceivedSmsMessagesWithHttpInfo


    public
                    agentGetReceivedSmsMessagesWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, bool $favourite = null ][, string $contentType = self::contentTypes['agentGetReceivedSmsMessages'][0] ]) : array<string|int, mixed>

List received SMS for an assigned phone number

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$favourite : bool = null: (optional)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessages'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageSmsProjection, HTTP status code, HTTP response headers (array of strings)

agentGetReceivedSmsMessageWithHttpInfo()

Operation agentGetReceivedSmsMessageWithHttpInfo


    public
                    agentGetReceivedSmsMessageWithHttpInfo(string $phone_number_id, string $sms_id[, string $contentType = self::contentTypes['agentGetReceivedSmsMessage'][0] ]) : array<string|int, mixed>

Get received SMS

Parameters

$phone_number_id : string: (required)
$sms_id : string: (required)
$contentType : string = self::contentTypes['agentGetReceivedSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetReceivedSmsMessage'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SmsDto, HTTP status code, HTTP response headers (array of strings)

agentGetSentSmsMessage()

Operation agentGetSentSmsMessage


    public
                    agentGetSentSmsMessage(string $phone_number_id, string $sent_sms_id[, string $contentType = self::contentTypes['agentGetSentSmsMessage'][0] ]) : SentSmsDto

Get sent SMS

Parameters

$phone_number_id : string: phone_number_id (required)
$sent_sms_id : string: sent_sms_id (required)
$contentType : string = self::contentTypes['agentGetSentSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessage'] to see the possible values for this operation

Return values

SentSmsDto —

agentGetSentSmsMessageAsync()

Operation agentGetSentSmsMessageAsync


    public
                    agentGetSentSmsMessageAsync(string $phone_number_id, string $sent_sms_id[, string $contentType = self::contentTypes['agentGetSentSmsMessage'][0] ]) : PromiseInterface

Get sent SMS

Parameters

$phone_number_id : string: (required)
$sent_sms_id : string: (required)
$contentType : string = self::contentTypes['agentGetSentSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessage'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetSentSmsMessageAsyncWithHttpInfo()

Operation agentGetSentSmsMessageAsyncWithHttpInfo


    public
                    agentGetSentSmsMessageAsyncWithHttpInfo(string $phone_number_id, string $sent_sms_id[, string $contentType = self::contentTypes['agentGetSentSmsMessage'][0] ]) : PromiseInterface

Get sent SMS

Parameters

$phone_number_id : string: (required)
$sent_sms_id : string: (required)
$contentType : string = self::contentTypes['agentGetSentSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessage'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetSentSmsMessageRequest()

Create request for operation 'agentGetSentSmsMessage'


    public
                    agentGetSentSmsMessageRequest(string $phone_number_id, string $sent_sms_id[, string $contentType = self::contentTypes['agentGetSentSmsMessage'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$sent_sms_id : string: (required)
$contentType : string = self::contentTypes['agentGetSentSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessage'] to see the possible values for this operation

Return values

Request —

agentGetSentSmsMessages()

Operation agentGetSentSmsMessages


    public
                    agentGetSentSmsMessages(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['agentGetSentSmsMessages'][0] ]) : PageSentSmsProjection

List sent SMS for an assigned phone number

Parameters

$phone_number_id : string: phone_number_id (required)
$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$sort : string = 'DESC': sort (optional, default to 'DESC')
$since : DateTime = null: since (optional)
$before : DateTime = null: before (optional)
$search : string = null: search (optional)
$contentType : string = self::contentTypes['agentGetSentSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessages'] to see the possible values for this operation

Return values

PageSentSmsProjection —

agentGetSentSmsMessagesAsync()

Operation agentGetSentSmsMessagesAsync


    public
                    agentGetSentSmsMessagesAsync(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['agentGetSentSmsMessages'][0] ]) : PromiseInterface

List sent SMS for an assigned phone number

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$contentType : string = self::contentTypes['agentGetSentSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessages'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetSentSmsMessagesAsyncWithHttpInfo()

Operation agentGetSentSmsMessagesAsyncWithHttpInfo


    public
                    agentGetSentSmsMessagesAsyncWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['agentGetSentSmsMessages'][0] ]) : PromiseInterface

List sent SMS for an assigned phone number

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$contentType : string = self::contentTypes['agentGetSentSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessages'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetSentSmsMessagesRequest()

Create request for operation 'agentGetSentSmsMessages'


    public
                    agentGetSentSmsMessagesRequest(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['agentGetSentSmsMessages'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$contentType : string = self::contentTypes['agentGetSentSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessages'] to see the possible values for this operation

Return values

Request —

agentGetSentSmsMessagesWithHttpInfo()

Operation agentGetSentSmsMessagesWithHttpInfo


    public
                    agentGetSentSmsMessagesWithHttpInfo(string $phone_number_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $contentType = self::contentTypes['agentGetSentSmsMessages'][0] ]) : array<string|int, mixed>

List sent SMS for an assigned phone number

Parameters

$phone_number_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$contentType : string = self::contentTypes['agentGetSentSmsMessages'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessages'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageSentSmsProjection, HTTP status code, HTTP response headers (array of strings)

agentGetSentSmsMessageWithHttpInfo()

Operation agentGetSentSmsMessageWithHttpInfo


    public
                    agentGetSentSmsMessageWithHttpInfo(string $phone_number_id, string $sent_sms_id[, string $contentType = self::contentTypes['agentGetSentSmsMessage'][0] ]) : array<string|int, mixed>

Get sent SMS

Parameters

$phone_number_id : string: (required)
$sent_sms_id : string: (required)
$contentType : string = self::contentTypes['agentGetSentSmsMessage'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSentSmsMessage'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SentSmsDto, HTTP status code, HTTP response headers (array of strings)

agentGetSmsConversation()

Operation agentGetSmsConversation


    public
                    agentGetSmsConversation(string $conversation_id[, string $contentType = self::contentTypes['agentGetSmsConversation'][0] ]) : AgentSmsConversationDetailDto

Get one SMS conversation

Parameters

$conversation_id : string: conversation_id (required)
$contentType : string = self::contentTypes['agentGetSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSmsConversation'] to see the possible values for this operation

Return values

AgentSmsConversationDetailDto —

agentGetSmsConversationAsync()

Operation agentGetSmsConversationAsync


    public
                    agentGetSmsConversationAsync(string $conversation_id[, string $contentType = self::contentTypes['agentGetSmsConversation'][0] ]) : PromiseInterface

Get one SMS conversation

Parameters

$conversation_id : string: (required)
$contentType : string = self::contentTypes['agentGetSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSmsConversation'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetSmsConversationAsyncWithHttpInfo()

Operation agentGetSmsConversationAsyncWithHttpInfo


    public
                    agentGetSmsConversationAsyncWithHttpInfo(string $conversation_id[, string $contentType = self::contentTypes['agentGetSmsConversation'][0] ]) : PromiseInterface

Get one SMS conversation

Parameters

$conversation_id : string: (required)
$contentType : string = self::contentTypes['agentGetSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSmsConversation'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetSmsConversationRequest()

Create request for operation 'agentGetSmsConversation'


    public
                    agentGetSmsConversationRequest(string $conversation_id[, string $contentType = self::contentTypes['agentGetSmsConversation'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$contentType : string = self::contentTypes['agentGetSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSmsConversation'] to see the possible values for this operation

Return values

Request —

agentGetSmsConversationWithHttpInfo()

Operation agentGetSmsConversationWithHttpInfo


    public
                    agentGetSmsConversationWithHttpInfo(string $conversation_id[, string $contentType = self::contentTypes['agentGetSmsConversation'][0] ]) : array<string|int, mixed>

Get one SMS conversation

Parameters

$conversation_id : string: (required)
$contentType : string = self::contentTypes['agentGetSmsConversation'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetSmsConversation'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentSmsConversationDetailDto, HTTP status code, HTTP response headers (array of strings)

agentGetTotpDevice()

Operation agentGetTotpDevice


    public
                    agentGetTotpDevice(string $id[, string $contentType = self::contentTypes['agentGetTotpDevice'][0] ]) : TotpDeviceDto

Get an agent-accessible TOTP device

Parameters

$id : string: id (required)
$contentType : string = self::contentTypes['agentGetTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevice'] to see the possible values for this operation

Return values

TotpDeviceDto —

agentGetTotpDeviceAsync()

Operation agentGetTotpDeviceAsync


    public
                    agentGetTotpDeviceAsync(string $id[, string $contentType = self::contentTypes['agentGetTotpDevice'][0] ]) : PromiseInterface

Get an agent-accessible TOTP device

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['agentGetTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevice'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetTotpDeviceAsyncWithHttpInfo()

Operation agentGetTotpDeviceAsyncWithHttpInfo


    public
                    agentGetTotpDeviceAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['agentGetTotpDevice'][0] ]) : PromiseInterface

Get an agent-accessible TOTP device

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['agentGetTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevice'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetTotpDeviceBy()

Operation agentGetTotpDeviceBy


    public
                    agentGetTotpDeviceBy([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDeviceBy'][0] ]) : TotpDeviceOptionalDto

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

Parameters

$name : string = null: name (optional)
$issuer : string = null: issuer (optional)
$username : string = null: username (optional)
$contentType : string = self::contentTypes['agentGetTotpDeviceBy'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDeviceBy'] to see the possible values for this operation

Return values

TotpDeviceOptionalDto —

agentGetTotpDeviceByAsync()

Operation agentGetTotpDeviceByAsync


    public
                    agentGetTotpDeviceByAsync([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDeviceBy'][0] ]) : PromiseInterface

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

Parameters

$name : string = null: (optional)
$issuer : string = null: (optional)
$username : string = null: (optional)
$contentType : string = self::contentTypes['agentGetTotpDeviceBy'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDeviceBy'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetTotpDeviceByAsyncWithHttpInfo()

Operation agentGetTotpDeviceByAsyncWithHttpInfo


    public
                    agentGetTotpDeviceByAsyncWithHttpInfo([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDeviceBy'][0] ]) : PromiseInterface

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

Parameters

$name : string = null: (optional)
$issuer : string = null: (optional)
$username : string = null: (optional)
$contentType : string = self::contentTypes['agentGetTotpDeviceBy'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDeviceBy'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetTotpDeviceByRequest()

Create request for operation 'agentGetTotpDeviceBy'


    public
                    agentGetTotpDeviceByRequest([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDeviceBy'][0] ]) : Request

Parameters

$name : string = null: (optional)
$issuer : string = null: (optional)
$username : string = null: (optional)
$contentType : string = self::contentTypes['agentGetTotpDeviceBy'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDeviceBy'] to see the possible values for this operation

Return values

Request —

agentGetTotpDeviceByWithHttpInfo()

Operation agentGetTotpDeviceByWithHttpInfo


    public
                    agentGetTotpDeviceByWithHttpInfo([string $name = null ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDeviceBy'][0] ]) : array<string|int, mixed>

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

Parameters

$name : string = null: (optional)
$issuer : string = null: (optional)
$username : string = null: (optional)
$contentType : string = self::contentTypes['agentGetTotpDeviceBy'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDeviceBy'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\TotpDeviceOptionalDto, HTTP status code, HTTP response headers (array of strings)

agentGetTotpDeviceRequest()

Create request for operation 'agentGetTotpDevice'


    public
                    agentGetTotpDeviceRequest(string $id[, string $contentType = self::contentTypes['agentGetTotpDevice'][0] ]) : Request

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['agentGetTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevice'] to see the possible values for this operation

Return values

Request —

agentGetTotpDevices()

Operation agentGetTotpDevices


    public
                    agentGetTotpDevices(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDevices'][0] ]) : PageTotpDeviceProjection

List agent-accessible TOTP devices

Parameters

$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$sort : string = 'DESC': sort (optional, default to 'DESC')
$issuer : string = null: issuer (optional)
$username : string = null: username (optional)
$contentType : string = self::contentTypes['agentGetTotpDevices'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevices'] to see the possible values for this operation

Return values

PageTotpDeviceProjection —

agentGetTotpDevicesAsync()

Operation agentGetTotpDevicesAsync


    public
                    agentGetTotpDevicesAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDevices'][0] ]) : PromiseInterface

List agent-accessible TOTP devices

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$issuer : string = null: (optional)
$username : string = null: (optional)
$contentType : string = self::contentTypes['agentGetTotpDevices'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevices'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetTotpDevicesAsyncWithHttpInfo()

Operation agentGetTotpDevicesAsyncWithHttpInfo


    public
                    agentGetTotpDevicesAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDevices'][0] ]) : PromiseInterface

List agent-accessible TOTP devices

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$issuer : string = null: (optional)
$username : string = null: (optional)
$contentType : string = self::contentTypes['agentGetTotpDevices'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevices'] to see the possible values for this operation

Return values

PromiseInterface —

agentGetTotpDevicesRequest()

Create request for operation 'agentGetTotpDevices'


    public
                    agentGetTotpDevicesRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDevices'][0] ]) : Request

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$issuer : string = null: (optional)
$username : string = null: (optional)
$contentType : string = self::contentTypes['agentGetTotpDevices'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevices'] to see the possible values for this operation

Return values

Request —

agentGetTotpDevicesWithHttpInfo()

Operation agentGetTotpDevicesWithHttpInfo


    public
                    agentGetTotpDevicesWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $issuer = null ][, string $username = null ][, string $contentType = self::contentTypes['agentGetTotpDevices'][0] ]) : array<string|int, mixed>

List agent-accessible TOTP devices

Parameters

$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$issuer : string = null: (optional)
$username : string = null: (optional)
$contentType : string = self::contentTypes['agentGetTotpDevices'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevices'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageTotpDeviceProjection, HTTP status code, HTTP response headers (array of strings)

agentGetTotpDeviceWithHttpInfo()

Operation agentGetTotpDeviceWithHttpInfo


    public
                    agentGetTotpDeviceWithHttpInfo(string $id[, string $contentType = self::contentTypes['agentGetTotpDevice'][0] ]) : array<string|int, mixed>

Get an agent-accessible TOTP device

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['agentGetTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentGetTotpDevice'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\TotpDeviceDto, HTTP status code, HTTP response headers (array of strings)

agentListAccessibleInboxes()

Operation agentListAccessibleInboxes


    public
                    agentListAccessibleInboxes([int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListAccessibleInboxes'][0] ]) : AccessibleInboxList

List inboxes accessible to an agent

Parameters

$size : int = 20: size (optional, default to 20)
$sort : string = 'ASC': sort (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListAccessibleInboxes'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAccessibleInboxes'] to see the possible values for this operation

Return values

AccessibleInboxList —

agentListAccessibleInboxesAsync()

Operation agentListAccessibleInboxesAsync


    public
                    agentListAccessibleInboxesAsync([int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListAccessibleInboxes'][0] ]) : PromiseInterface

List inboxes accessible to an agent

Parameters

$size : int = 20: (optional, default to 20)
$sort : string = 'ASC': (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListAccessibleInboxes'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAccessibleInboxes'] to see the possible values for this operation

Return values

PromiseInterface —

agentListAccessibleInboxesAsyncWithHttpInfo()

Operation agentListAccessibleInboxesAsyncWithHttpInfo


    public
                    agentListAccessibleInboxesAsyncWithHttpInfo([int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListAccessibleInboxes'][0] ]) : PromiseInterface

List inboxes accessible to an agent

Parameters

$size : int = 20: (optional, default to 20)
$sort : string = 'ASC': (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListAccessibleInboxes'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAccessibleInboxes'] to see the possible values for this operation

Return values

PromiseInterface —

agentListAccessibleInboxesRequest()

Create request for operation 'agentListAccessibleInboxes'


    public
                    agentListAccessibleInboxesRequest([int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListAccessibleInboxes'][0] ]) : Request

Parameters

$size : int = 20: (optional, default to 20)
$sort : string = 'ASC': (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListAccessibleInboxes'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAccessibleInboxes'] to see the possible values for this operation

Return values

Request —

agentListAccessibleInboxesWithHttpInfo()

Operation agentListAccessibleInboxesWithHttpInfo


    public
                    agentListAccessibleInboxesWithHttpInfo([int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListAccessibleInboxes'][0] ]) : array<string|int, mixed>

List inboxes accessible to an agent

Parameters

$size : int = 20: (optional, default to 20)
$sort : string = 'ASC': (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListAccessibleInboxes'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAccessibleInboxes'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AccessibleInboxList, HTTP status code, HTTP response headers (array of strings)

agentListAutomationEvents()

Operation agentListAutomationEvents


    public
                    agentListAutomationEvents([string $cursor = null ][, array<string|int, string> $event_type = null ][, int $size = 20 ], int $wait_seconds[, string $contentType = self::contentTypes['agentListAutomationEvents'][0] ]) : AgentAutomationEventPageDto

Read durable scoped automation events

Parameters

$cursor : string = null: cursor (optional)
$event_type : array<string|int, string> = null: event_type (optional)
$size : int = 20: size (optional, default to 20)
$wait_seconds : int: wait_seconds (optional, default to 0)
$contentType : string = self::contentTypes['agentListAutomationEvents'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAutomationEvents'] to see the possible values for this operation

Return values

AgentAutomationEventPageDto —

agentListAutomationEventsAsync()

Operation agentListAutomationEventsAsync


    public
                    agentListAutomationEventsAsync([string $cursor = null ][, array<string|int, string> $event_type = null ][, int $size = 20 ], int $wait_seconds[, string $contentType = self::contentTypes['agentListAutomationEvents'][0] ]) : PromiseInterface

Read durable scoped automation events

Parameters

$cursor : string = null: (optional)
$event_type : array<string|int, string> = null: (optional)
$size : int = 20: (optional, default to 20)
$wait_seconds : int: (optional, default to 0)
$contentType : string = self::contentTypes['agentListAutomationEvents'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAutomationEvents'] to see the possible values for this operation

Return values

PromiseInterface —

agentListAutomationEventsAsyncWithHttpInfo()

Operation agentListAutomationEventsAsyncWithHttpInfo


    public
                    agentListAutomationEventsAsyncWithHttpInfo([string $cursor = null ][, array<string|int, string> $event_type = null ][, int $size = 20 ], int $wait_seconds[, string $contentType = self::contentTypes['agentListAutomationEvents'][0] ]) : PromiseInterface

Read durable scoped automation events

Parameters

$cursor : string = null: (optional)
$event_type : array<string|int, string> = null: (optional)
$size : int = 20: (optional, default to 20)
$wait_seconds : int: (optional, default to 0)
$contentType : string = self::contentTypes['agentListAutomationEvents'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAutomationEvents'] to see the possible values for this operation

Return values

PromiseInterface —

agentListAutomationEventsRequest()

Create request for operation 'agentListAutomationEvents'


    public
                    agentListAutomationEventsRequest([string $cursor = null ][, array<string|int, string> $event_type = null ][, int $size = 20 ], int $wait_seconds[, string $contentType = self::contentTypes['agentListAutomationEvents'][0] ]) : Request

Parameters

$cursor : string = null: (optional)
$event_type : array<string|int, string> = null: (optional)
$size : int = 20: (optional, default to 20)
$wait_seconds : int: (optional, default to 0)
$contentType : string = self::contentTypes['agentListAutomationEvents'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAutomationEvents'] to see the possible values for this operation

Return values

Request —

agentListAutomationEventsWithHttpInfo()

Operation agentListAutomationEventsWithHttpInfo


    public
                    agentListAutomationEventsWithHttpInfo([string $cursor = null ][, array<string|int, string> $event_type = null ][, int $size = 20 ], int $wait_seconds[, string $contentType = self::contentTypes['agentListAutomationEvents'][0] ]) : array<string|int, mixed>

Read durable scoped automation events

Parameters

$cursor : string = null: (optional)
$event_type : array<string|int, string> = null: (optional)
$size : int = 20: (optional, default to 20)
$wait_seconds : int: (optional, default to 0)
$contentType : string = self::contentTypes['agentListAutomationEvents'][0]: The value for the Content-Type header. Check self::contentTypes['agentListAutomationEvents'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentAutomationEventPageDto, HTTP status code, HTTP response headers (array of strings)

agentListConversationsV2()

Operation agentListConversationsV2


    public
                    agentListConversationsV2([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $inbox_id = null ][, bool $unread = null ][, bool $has_attachments = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListConversationsV2'][0] ]) : AgentConversationCursorPageDto

List active conversations with an opaque keyset cursor

Parameters

$workflow_state : string = null: workflow_state (optional)
$outcome : string = null: outcome (optional)
$review_status : string = null: review_status (optional)
$inbox_id : string = null: inbox_id (optional)
$unread : bool = null: unread (optional)
$has_attachments : bool = null: has_attachments (optional)
$since : DateTime = null: since (optional)
$before : DateTime = null: before (optional)
$search : string = null: search (optional)
$sort : string = 'LAST_MESSAGE_DESC': sort (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: cursor (optional)
$size : int = 20: size (optional, default to 20)
$contentType : string = self::contentTypes['agentListConversationsV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentListConversationsV2'] to see the possible values for this operation

Return values

AgentConversationCursorPageDto —

agentListConversationsV2Async()

Operation agentListConversationsV2Async


    public
                    agentListConversationsV2Async([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $inbox_id = null ][, bool $unread = null ][, bool $has_attachments = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListConversationsV2'][0] ]) : PromiseInterface

List active conversations with an opaque keyset cursor

Parameters

$workflow_state : string = null: (optional)
$outcome : string = null: (optional)
$review_status : string = null: (optional)
$inbox_id : string = null: (optional)
$unread : bool = null: (optional)
$has_attachments : bool = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$sort : string = 'LAST_MESSAGE_DESC': (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: (optional)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentListConversationsV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentListConversationsV2'] to see the possible values for this operation

Return values

PromiseInterface —

agentListConversationsV2AsyncWithHttpInfo()

Operation agentListConversationsV2AsyncWithHttpInfo


    public
                    agentListConversationsV2AsyncWithHttpInfo([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $inbox_id = null ][, bool $unread = null ][, bool $has_attachments = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListConversationsV2'][0] ]) : PromiseInterface

List active conversations with an opaque keyset cursor

Parameters

$workflow_state : string = null: (optional)
$outcome : string = null: (optional)
$review_status : string = null: (optional)
$inbox_id : string = null: (optional)
$unread : bool = null: (optional)
$has_attachments : bool = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$sort : string = 'LAST_MESSAGE_DESC': (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: (optional)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentListConversationsV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentListConversationsV2'] to see the possible values for this operation

Return values

PromiseInterface —

agentListConversationsV2Request()

Create request for operation 'agentListConversationsV2'


    public
                    agentListConversationsV2Request([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $inbox_id = null ][, bool $unread = null ][, bool $has_attachments = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListConversationsV2'][0] ]) : Request

Parameters

$workflow_state : string = null: (optional)
$outcome : string = null: (optional)
$review_status : string = null: (optional)
$inbox_id : string = null: (optional)
$unread : bool = null: (optional)
$has_attachments : bool = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$sort : string = 'LAST_MESSAGE_DESC': (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: (optional)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentListConversationsV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentListConversationsV2'] to see the possible values for this operation

Return values

Request —

agentListConversationsV2WithHttpInfo()

Operation agentListConversationsV2WithHttpInfo


    public
                    agentListConversationsV2WithHttpInfo([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $inbox_id = null ][, bool $unread = null ][, bool $has_attachments = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListConversationsV2'][0] ]) : array<string|int, mixed>

List active conversations with an opaque keyset cursor

Parameters

$workflow_state : string = null: (optional)
$outcome : string = null: (optional)
$review_status : string = null: (optional)
$inbox_id : string = null: (optional)
$unread : bool = null: (optional)
$has_attachments : bool = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$sort : string = 'LAST_MESSAGE_DESC': (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: (optional)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentListConversationsV2'][0]: The value for the Content-Type header. Check self::contentTypes['agentListConversationsV2'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationCursorPageDto, HTTP status code, HTTP response headers (array of strings)

agentListEmailAttachments()

Operation agentListEmailAttachments


    public
                    agentListEmailAttachments(string $email_id[, string $contentType = self::contentTypes['agentListEmailAttachments'][0] ]) : array<string|int, AttachmentMetaData>

List attachments on a scoped email for an agent

Parameters

$email_id : string: email_id (required)
$contentType : string = self::contentTypes['agentListEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailAttachments'] to see the possible values for this operation

Return values

array<string|int, AttachmentMetaData> —

agentListEmailAttachmentsAsync()

Operation agentListEmailAttachmentsAsync


    public
                    agentListEmailAttachmentsAsync(string $email_id[, string $contentType = self::contentTypes['agentListEmailAttachments'][0] ]) : PromiseInterface

List attachments on a scoped email for an agent

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['agentListEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailAttachments'] to see the possible values for this operation

Return values

PromiseInterface —

agentListEmailAttachmentsAsyncWithHttpInfo()

Operation agentListEmailAttachmentsAsyncWithHttpInfo


    public
                    agentListEmailAttachmentsAsyncWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['agentListEmailAttachments'][0] ]) : PromiseInterface

List attachments on a scoped email for an agent

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['agentListEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailAttachments'] to see the possible values for this operation

Return values

PromiseInterface —

agentListEmailAttachmentsRequest()

Create request for operation 'agentListEmailAttachments'


    public
                    agentListEmailAttachmentsRequest(string $email_id[, string $contentType = self::contentTypes['agentListEmailAttachments'][0] ]) : Request

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['agentListEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailAttachments'] to see the possible values for this operation

Return values

Request —

agentListEmailAttachmentsWithHttpInfo()

Operation agentListEmailAttachmentsWithHttpInfo


    public
                    agentListEmailAttachmentsWithHttpInfo(string $email_id[, string $contentType = self::contentTypes['agentListEmailAttachments'][0] ]) : array<string|int, mixed>

List attachments on a scoped email for an agent

Parameters

$email_id : string: (required)
$contentType : string = self::contentTypes['agentListEmailAttachments'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailAttachments'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AttachmentMetaData[], HTTP status code, HTTP response headers (array of strings)

agentListEmailDrafts()

Operation agentListEmailDrafts


    public
                    agentListEmailDrafts(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListEmailDrafts'][0] ]) : PageEmailDraftProjection

List scoped email drafts for an agent

Parameters

$inbox_id : string: ID of inbox to list drafts for (required)
$page : int: Optional page index in draft pagination (optional, default to 0)
$size : int = 20: Optional page size in draft pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListEmailDrafts'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailDrafts'] to see the possible values for this operation

Return values

PageEmailDraftProjection —

agentListEmailDraftsAsync()

Operation agentListEmailDraftsAsync


    public
                    agentListEmailDraftsAsync(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListEmailDrafts'][0] ]) : PromiseInterface

List scoped email drafts for an agent

Parameters

$inbox_id : string: ID of inbox to list drafts for (required)
$page : int: Optional page index in draft pagination (optional, default to 0)
$size : int = 20: Optional page size in draft pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListEmailDrafts'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailDrafts'] to see the possible values for this operation

Return values

PromiseInterface —

agentListEmailDraftsAsyncWithHttpInfo()

Operation agentListEmailDraftsAsyncWithHttpInfo


    public
                    agentListEmailDraftsAsyncWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListEmailDrafts'][0] ]) : PromiseInterface

List scoped email drafts for an agent

Parameters

$inbox_id : string: ID of inbox to list drafts for (required)
$page : int: Optional page index in draft pagination (optional, default to 0)
$size : int = 20: Optional page size in draft pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListEmailDrafts'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailDrafts'] to see the possible values for this operation

Return values

PromiseInterface —

agentListEmailDraftsRequest()

Create request for operation 'agentListEmailDrafts'


    public
                    agentListEmailDraftsRequest(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListEmailDrafts'][0] ]) : Request

Parameters

$inbox_id : string: ID of inbox to list drafts for (required)
$page : int: Optional page index in draft pagination (optional, default to 0)
$size : int = 20: Optional page size in draft pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListEmailDrafts'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailDrafts'] to see the possible values for this operation

Return values

Request —

agentListEmailDraftsWithHttpInfo()

Operation agentListEmailDraftsWithHttpInfo


    public
                    agentListEmailDraftsWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $contentType = self::contentTypes['agentListEmailDrafts'][0] ]) : array<string|int, mixed>

List scoped email drafts for an agent

Parameters

$inbox_id : string: ID of inbox to list drafts for (required)
$page : int: Optional page index in draft pagination (optional, default to 0)
$size : int = 20: Optional page size in draft pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$contentType : string = self::contentTypes['agentListEmailDrafts'][0]: The value for the Content-Type header. Check self::contentTypes['agentListEmailDrafts'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageEmailDraftProjection, HTTP status code, HTTP response headers (array of strings)

agentListInboxEmails()

Operation agentListInboxEmails


    public
                    agentListInboxEmails(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $sync_connectors = null ][, string $contentType = self::contentTypes['agentListInboxEmails'][0] ]) : PageEmailPreview

List scoped inbox emails for an agent

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$page : int: Optional page index in inbox emails list pagination (optional, default to 0)
$size : int = 20: Optional page size in inbox emails list pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$since : DateTime = null: Optional filter by received after given date time (optional)
$before : DateTime = null: Optional filter by received before given date time (optional)
$sync_connectors : bool = null: Sync connectors before fetching emails (optional)
$contentType : string = self::contentTypes['agentListInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxEmails'] to see the possible values for this operation

Return values

PageEmailPreview —

agentListInboxEmailsAsync()

Operation agentListInboxEmailsAsync


    public
                    agentListInboxEmailsAsync(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $sync_connectors = null ][, string $contentType = self::contentTypes['agentListInboxEmails'][0] ]) : PromiseInterface

List scoped inbox emails for an agent

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$page : int: Optional page index in inbox emails list pagination (optional, default to 0)
$size : int = 20: Optional page size in inbox emails list pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$since : DateTime = null: Optional filter by received after given date time (optional)
$before : DateTime = null: Optional filter by received before given date time (optional)
$sync_connectors : bool = null: Sync connectors before fetching emails (optional)
$contentType : string = self::contentTypes['agentListInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxEmails'] to see the possible values for this operation

Return values

PromiseInterface —

agentListInboxEmailsAsyncWithHttpInfo()

Operation agentListInboxEmailsAsyncWithHttpInfo


    public
                    agentListInboxEmailsAsyncWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $sync_connectors = null ][, string $contentType = self::contentTypes['agentListInboxEmails'][0] ]) : PromiseInterface

List scoped inbox emails for an agent

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$page : int: Optional page index in inbox emails list pagination (optional, default to 0)
$size : int = 20: Optional page size in inbox emails list pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$since : DateTime = null: Optional filter by received after given date time (optional)
$before : DateTime = null: Optional filter by received before given date time (optional)
$sync_connectors : bool = null: Sync connectors before fetching emails (optional)
$contentType : string = self::contentTypes['agentListInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxEmails'] to see the possible values for this operation

Return values

PromiseInterface —

agentListInboxEmailsRequest()

Create request for operation 'agentListInboxEmails'


    public
                    agentListInboxEmailsRequest(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $sync_connectors = null ][, string $contentType = self::contentTypes['agentListInboxEmails'][0] ]) : Request

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$page : int: Optional page index in inbox emails list pagination (optional, default to 0)
$size : int = 20: Optional page size in inbox emails list pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$since : DateTime = null: Optional filter by received after given date time (optional)
$before : DateTime = null: Optional filter by received before given date time (optional)
$sync_connectors : bool = null: Sync connectors before fetching emails (optional)
$contentType : string = self::contentTypes['agentListInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxEmails'] to see the possible values for this operation

Return values

Request —

agentListInboxEmailsWithHttpInfo()

Operation agentListInboxEmailsWithHttpInfo


    public
                    agentListInboxEmailsWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $sync_connectors = null ][, string $contentType = self::contentTypes['agentListInboxEmails'][0] ]) : array<string|int, mixed>

List scoped inbox emails for an agent

Parameters

$inbox_id : string: ID of inbox the agent may read (required)
$page : int: Optional page index in inbox emails list pagination (optional, default to 0)
$size : int = 20: Optional page size in inbox emails list pagination (optional, default to 20)
$sort : string = 'ASC': Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
$since : DateTime = null: Optional filter by received after given date time (optional)
$before : DateTime = null: Optional filter by received before given date time (optional)
$sync_connectors : bool = null: Sync connectors before fetching emails (optional)
$contentType : string = self::contentTypes['agentListInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxEmails'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageEmailPreview, HTTP status code, HTTP response headers (array of strings)

agentListInboxThreads()

Operation agentListInboxThreads


    public
                    agentListInboxThreads(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentListInboxThreads'][0] ]) : PageEmailThreadProjection

List scoped inbox threads for an agent

Parameters

$inbox_id : string: inbox_id (required)
$page : int: page (optional, default to 0)
$size : int = 20: size (optional, default to 20)
$sort : string = 'DESC': sort (optional, default to 'DESC')
$search : string = null: search (optional)
$since : DateTime = null: since (optional)
$before : DateTime = null: before (optional)
$contentType : string = self::contentTypes['agentListInboxThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxThreads'] to see the possible values for this operation

Return values

PageEmailThreadProjection —

agentListInboxThreadsAsync()

Operation agentListInboxThreadsAsync


    public
                    agentListInboxThreadsAsync(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentListInboxThreads'][0] ]) : PromiseInterface

List scoped inbox threads for an agent

Parameters

$inbox_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$search : string = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$contentType : string = self::contentTypes['agentListInboxThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxThreads'] to see the possible values for this operation

Return values

PromiseInterface —

agentListInboxThreadsAsyncWithHttpInfo()

Operation agentListInboxThreadsAsyncWithHttpInfo


    public
                    agentListInboxThreadsAsyncWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentListInboxThreads'][0] ]) : PromiseInterface

List scoped inbox threads for an agent

Parameters

$inbox_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$search : string = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$contentType : string = self::contentTypes['agentListInboxThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxThreads'] to see the possible values for this operation

Return values

PromiseInterface —

agentListInboxThreadsRequest()

Create request for operation 'agentListInboxThreads'


    public
                    agentListInboxThreadsRequest(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentListInboxThreads'][0] ]) : Request

Parameters

$inbox_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$search : string = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$contentType : string = self::contentTypes['agentListInboxThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxThreads'] to see the possible values for this operation

Return values

Request —

agentListInboxThreadsWithHttpInfo()

Operation agentListInboxThreadsWithHttpInfo


    public
                    agentListInboxThreadsWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['agentListInboxThreads'][0] ]) : array<string|int, mixed>

List scoped inbox threads for an agent

Parameters

$inbox_id : string: (required)
$page : int: (optional, default to 0)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$search : string = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$contentType : string = self::contentTypes['agentListInboxThreads'][0]: The value for the Content-Type header. Check self::contentTypes['agentListInboxThreads'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\PageEmailThreadProjection, HTTP status code, HTTP response headers (array of strings)

agentListSmsConversations()

Operation agentListSmsConversations


    public
                    agentListSmsConversations([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $phone_number_id = null ][, bool $unread = null ][, bool $has_media = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListSmsConversations'][0] ]) : AgentSmsConversationCursorPageDto

List active SMS conversations

Parameters

$workflow_state : string = null: workflow_state (optional)
$outcome : string = null: outcome (optional)
$review_status : string = null: review_status (optional)
$phone_number_id : string = null: phone_number_id (optional)
$unread : bool = null: unread (optional)
$has_media : bool = null: has_media (optional)
$since : DateTime = null: since (optional)
$before : DateTime = null: before (optional)
$search : string = null: search (optional)
$sort : string = 'LAST_MESSAGE_DESC': sort (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: cursor (optional)
$size : int = 20: size (optional, default to 20)
$contentType : string = self::contentTypes['agentListSmsConversations'][0]: The value for the Content-Type header. Check self::contentTypes['agentListSmsConversations'] to see the possible values for this operation

Return values

AgentSmsConversationCursorPageDto —

agentListSmsConversationsAsync()

Operation agentListSmsConversationsAsync


    public
                    agentListSmsConversationsAsync([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $phone_number_id = null ][, bool $unread = null ][, bool $has_media = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListSmsConversations'][0] ]) : PromiseInterface

List active SMS conversations

Parameters

$workflow_state : string = null: (optional)
$outcome : string = null: (optional)
$review_status : string = null: (optional)
$phone_number_id : string = null: (optional)
$unread : bool = null: (optional)
$has_media : bool = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$sort : string = 'LAST_MESSAGE_DESC': (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: (optional)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentListSmsConversations'][0]: The value for the Content-Type header. Check self::contentTypes['agentListSmsConversations'] to see the possible values for this operation

Return values

PromiseInterface —

agentListSmsConversationsAsyncWithHttpInfo()

Operation agentListSmsConversationsAsyncWithHttpInfo


    public
                    agentListSmsConversationsAsyncWithHttpInfo([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $phone_number_id = null ][, bool $unread = null ][, bool $has_media = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListSmsConversations'][0] ]) : PromiseInterface

List active SMS conversations

Parameters

$workflow_state : string = null: (optional)
$outcome : string = null: (optional)
$review_status : string = null: (optional)
$phone_number_id : string = null: (optional)
$unread : bool = null: (optional)
$has_media : bool = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$sort : string = 'LAST_MESSAGE_DESC': (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: (optional)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentListSmsConversations'][0]: The value for the Content-Type header. Check self::contentTypes['agentListSmsConversations'] to see the possible values for this operation

Return values

PromiseInterface —

agentListSmsConversationsRequest()

Create request for operation 'agentListSmsConversations'


    public
                    agentListSmsConversationsRequest([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $phone_number_id = null ][, bool $unread = null ][, bool $has_media = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListSmsConversations'][0] ]) : Request

Parameters

$workflow_state : string = null: (optional)
$outcome : string = null: (optional)
$review_status : string = null: (optional)
$phone_number_id : string = null: (optional)
$unread : bool = null: (optional)
$has_media : bool = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$sort : string = 'LAST_MESSAGE_DESC': (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: (optional)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentListSmsConversations'][0]: The value for the Content-Type header. Check self::contentTypes['agentListSmsConversations'] to see the possible values for this operation

Return values

Request —

agentListSmsConversationsWithHttpInfo()

Operation agentListSmsConversationsWithHttpInfo


    public
                    agentListSmsConversationsWithHttpInfo([string $workflow_state = null ][, string $outcome = null ][, string $review_status = null ][, string $phone_number_id = null ][, bool $unread = null ][, bool $has_media = null ][, DateTime $since = null ][, DateTime $before = null ][, string $search = null ][, string $sort = 'LAST_MESSAGE_DESC' ][, string $cursor = null ][, int $size = 20 ][, string $contentType = self::contentTypes['agentListSmsConversations'][0] ]) : array<string|int, mixed>

List active SMS conversations

Parameters

$workflow_state : string = null: (optional)
$outcome : string = null: (optional)
$review_status : string = null: (optional)
$phone_number_id : string = null: (optional)
$unread : bool = null: (optional)
$has_media : bool = null: (optional)
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$search : string = null: (optional)
$sort : string = 'LAST_MESSAGE_DESC': (optional, default to 'LAST_MESSAGE_DESC')
$cursor : string = null: (optional)
$size : int = 20: (optional, default to 20)
$contentType : string = self::contentTypes['agentListSmsConversations'][0]: The value for the Content-Type header. Check self::contentTypes['agentListSmsConversations'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentSmsConversationCursorPageDto, HTTP status code, HTTP response headers (array of strings)

agentPrepareWorkItemReply()

Operation agentPrepareWorkItemReply


    public
                    agentPrepareWorkItemReply(string $conversation_id, PrepareAgentReplyOptions $prepare_agent_reply_options[, string $contentType = self::contentTypes['agentPrepareWorkItemReply'][0] ]) : AgentPreparedReplyDto|AgentApiErrorDto

Prepare a guarded reply draft

Parameters

$conversation_id : string: conversation_id (required)
$prepare_agent_reply_options : PrepareAgentReplyOptions: prepare_agent_reply_options (required)
$contentType : string = self::contentTypes['agentPrepareWorkItemReply'][0]: The value for the Content-Type header. Check self::contentTypes['agentPrepareWorkItemReply'] to see the possible values for this operation

Return values

AgentPreparedReplyDto|AgentApiErrorDto —

agentPrepareWorkItemReplyAsync()

Operation agentPrepareWorkItemReplyAsync


    public
                    agentPrepareWorkItemReplyAsync(string $conversation_id, PrepareAgentReplyOptions $prepare_agent_reply_options[, string $contentType = self::contentTypes['agentPrepareWorkItemReply'][0] ]) : PromiseInterface

Prepare a guarded reply draft

Parameters

$conversation_id : string: (required)
$prepare_agent_reply_options : PrepareAgentReplyOptions: (required)
$contentType : string = self::contentTypes['agentPrepareWorkItemReply'][0]: The value for the Content-Type header. Check self::contentTypes['agentPrepareWorkItemReply'] to see the possible values for this operation

Return values

PromiseInterface —

agentPrepareWorkItemReplyAsyncWithHttpInfo()

Operation agentPrepareWorkItemReplyAsyncWithHttpInfo


    public
                    agentPrepareWorkItemReplyAsyncWithHttpInfo(string $conversation_id, PrepareAgentReplyOptions $prepare_agent_reply_options[, string $contentType = self::contentTypes['agentPrepareWorkItemReply'][0] ]) : PromiseInterface

Prepare a guarded reply draft

Parameters

$conversation_id : string: (required)
$prepare_agent_reply_options : PrepareAgentReplyOptions: (required)
$contentType : string = self::contentTypes['agentPrepareWorkItemReply'][0]: The value for the Content-Type header. Check self::contentTypes['agentPrepareWorkItemReply'] to see the possible values for this operation

Return values

PromiseInterface —

agentPrepareWorkItemReplyRequest()

Create request for operation 'agentPrepareWorkItemReply'


    public
                    agentPrepareWorkItemReplyRequest(string $conversation_id, PrepareAgentReplyOptions $prepare_agent_reply_options[, string $contentType = self::contentTypes['agentPrepareWorkItemReply'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$prepare_agent_reply_options : PrepareAgentReplyOptions: (required)
$contentType : string = self::contentTypes['agentPrepareWorkItemReply'][0]: The value for the Content-Type header. Check self::contentTypes['agentPrepareWorkItemReply'] to see the possible values for this operation

Return values

Request —

agentPrepareWorkItemReplyWithHttpInfo()

Operation agentPrepareWorkItemReplyWithHttpInfo


    public
                    agentPrepareWorkItemReplyWithHttpInfo(string $conversation_id, PrepareAgentReplyOptions $prepare_agent_reply_options[, string $contentType = self::contentTypes['agentPrepareWorkItemReply'][0] ]) : array<string|int, mixed>

Prepare a guarded reply draft

Parameters

$conversation_id : string: (required)
$prepare_agent_reply_options : PrepareAgentReplyOptions: (required)
$contentType : string = self::contentTypes['agentPrepareWorkItemReply'][0]: The value for the Content-Type header. Check self::contentTypes['agentPrepareWorkItemReply'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentPreparedReplyDto|\MailSlurp\Models\AgentApiErrorDto, HTTP status code, HTTP response headers (array of strings)

agentReleaseConversationClaim()

Operation agentReleaseConversationClaim


    public
                    agentReleaseConversationClaim(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseConversationClaim'][0] ]) : void

Release a conversation claim

Parameters

$conversation_id : string: conversation_id (required)
$claim_id : string: claim_id (required)
$contentType : string = self::contentTypes['agentReleaseConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseConversationClaim'] to see the possible values for this operation

Return values

void —

agentReleaseConversationClaimAsync()

Operation agentReleaseConversationClaimAsync


    public
                    agentReleaseConversationClaimAsync(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseConversationClaim'][0] ]) : PromiseInterface

Release a conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$contentType : string = self::contentTypes['agentReleaseConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseConversationClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentReleaseConversationClaimAsyncWithHttpInfo()

Operation agentReleaseConversationClaimAsyncWithHttpInfo


    public
                    agentReleaseConversationClaimAsyncWithHttpInfo(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseConversationClaim'][0] ]) : PromiseInterface

Release a conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$contentType : string = self::contentTypes['agentReleaseConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseConversationClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentReleaseConversationClaimRequest()

Create request for operation 'agentReleaseConversationClaim'


    public
                    agentReleaseConversationClaimRequest(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseConversationClaim'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$contentType : string = self::contentTypes['agentReleaseConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseConversationClaim'] to see the possible values for this operation

Return values

Request —

agentReleaseConversationClaimWithHttpInfo()

Operation agentReleaseConversationClaimWithHttpInfo


    public
                    agentReleaseConversationClaimWithHttpInfo(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseConversationClaim'][0] ]) : array<string|int, mixed>

Release a conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$contentType : string = self::contentTypes['agentReleaseConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseConversationClaim'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

agentReleaseSmsClaim()

Operation agentReleaseSmsClaim


    public
                    agentReleaseSmsClaim(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseSmsClaim'][0] ]) : void

Release an SMS conversation claim

Parameters

$conversation_id : string: conversation_id (required)
$claim_id : string: claim_id (required)
$contentType : string = self::contentTypes['agentReleaseSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseSmsClaim'] to see the possible values for this operation

Return values

void —

agentReleaseSmsClaimAsync()

Operation agentReleaseSmsClaimAsync


    public
                    agentReleaseSmsClaimAsync(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseSmsClaim'][0] ]) : PromiseInterface

Release an SMS conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$contentType : string = self::contentTypes['agentReleaseSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseSmsClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentReleaseSmsClaimAsyncWithHttpInfo()

Operation agentReleaseSmsClaimAsyncWithHttpInfo


    public
                    agentReleaseSmsClaimAsyncWithHttpInfo(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseSmsClaim'][0] ]) : PromiseInterface

Release an SMS conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$contentType : string = self::contentTypes['agentReleaseSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseSmsClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentReleaseSmsClaimRequest()

Create request for operation 'agentReleaseSmsClaim'


    public
                    agentReleaseSmsClaimRequest(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseSmsClaim'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$contentType : string = self::contentTypes['agentReleaseSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseSmsClaim'] to see the possible values for this operation

Return values

Request —

agentReleaseSmsClaimWithHttpInfo()

Operation agentReleaseSmsClaimWithHttpInfo


    public
                    agentReleaseSmsClaimWithHttpInfo(string $conversation_id, string $claim_id[, string $contentType = self::contentTypes['agentReleaseSmsClaim'][0] ]) : array<string|int, mixed>

Release an SMS conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$contentType : string = self::contentTypes['agentReleaseSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentReleaseSmsClaim'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

agentRenewConversationClaim()

Operation agentRenewConversationClaim


    public
                    agentRenewConversationClaim(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewConversationClaim'][0] ]) : AgentConversationClaimDto

Renew a conversation claim

Parameters

$conversation_id : string: conversation_id (required)
$claim_id : string: claim_id (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: renew_agent_conversation_claim_options (required)
$contentType : string = self::contentTypes['agentRenewConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewConversationClaim'] to see the possible values for this operation

Return values

AgentConversationClaimDto —

agentRenewConversationClaimAsync()

Operation agentRenewConversationClaimAsync


    public
                    agentRenewConversationClaimAsync(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewConversationClaim'][0] ]) : PromiseInterface

Renew a conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentRenewConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewConversationClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentRenewConversationClaimAsyncWithHttpInfo()

Operation agentRenewConversationClaimAsyncWithHttpInfo


    public
                    agentRenewConversationClaimAsyncWithHttpInfo(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewConversationClaim'][0] ]) : PromiseInterface

Renew a conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentRenewConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewConversationClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentRenewConversationClaimRequest()

Create request for operation 'agentRenewConversationClaim'


    public
                    agentRenewConversationClaimRequest(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewConversationClaim'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentRenewConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewConversationClaim'] to see the possible values for this operation

Return values

Request —

agentRenewConversationClaimWithHttpInfo()

Operation agentRenewConversationClaimWithHttpInfo


    public
                    agentRenewConversationClaimWithHttpInfo(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewConversationClaim'][0] ]) : array<string|int, mixed>

Renew a conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentRenewConversationClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewConversationClaim'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationClaimDto, HTTP status code, HTTP response headers (array of strings)

agentRenewSmsClaim()

Operation agentRenewSmsClaim


    public
                    agentRenewSmsClaim(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewSmsClaim'][0] ]) : AgentConversationClaimDto

Renew an SMS conversation claim

Parameters

$conversation_id : string: conversation_id (required)
$claim_id : string: claim_id (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: renew_agent_conversation_claim_options (required)
$contentType : string = self::contentTypes['agentRenewSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewSmsClaim'] to see the possible values for this operation

Return values

AgentConversationClaimDto —

agentRenewSmsClaimAsync()

Operation agentRenewSmsClaimAsync


    public
                    agentRenewSmsClaimAsync(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewSmsClaim'][0] ]) : PromiseInterface

Renew an SMS conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentRenewSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewSmsClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentRenewSmsClaimAsyncWithHttpInfo()

Operation agentRenewSmsClaimAsyncWithHttpInfo


    public
                    agentRenewSmsClaimAsyncWithHttpInfo(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewSmsClaim'][0] ]) : PromiseInterface

Renew an SMS conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentRenewSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewSmsClaim'] to see the possible values for this operation

Return values

PromiseInterface —

agentRenewSmsClaimRequest()

Create request for operation 'agentRenewSmsClaim'


    public
                    agentRenewSmsClaimRequest(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewSmsClaim'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentRenewSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewSmsClaim'] to see the possible values for this operation

Return values

Request —

agentRenewSmsClaimWithHttpInfo()

Operation agentRenewSmsClaimWithHttpInfo


    public
                    agentRenewSmsClaimWithHttpInfo(string $conversation_id, string $claim_id, RenewAgentConversationClaimOptions $renew_agent_conversation_claim_options[, string $contentType = self::contentTypes['agentRenewSmsClaim'][0] ]) : array<string|int, mixed>

Renew an SMS conversation claim

Parameters

$conversation_id : string: (required)
$claim_id : string: (required)
$renew_agent_conversation_claim_options : RenewAgentConversationClaimOptions: (required)
$contentType : string = self::contentTypes['agentRenewSmsClaim'][0]: The value for the Content-Type header. Check self::contentTypes['agentRenewSmsClaim'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationClaimDto, HTTP status code, HTTP response headers (array of strings)

agentReplyToEmail()

Operation agentReplyToEmail


    public
                    agentReplyToEmail(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_email_id = null ][, string $contentType = self::contentTypes['agentReplyToEmail'][0] ]) : SentEmailDto

Reply to a scoped email as an agent

Parameters

$email_id : string: ID of email to reply to (required)
$reply_to_email_options : ReplyToEmailOptions: reply_to_email_options (required)
$idempotency_key : string = null: idempotency_key (optional)
$expected_conversation_version : int = null: expected_conversation_version (optional)
$expected_latest_email_id : string = null: expected_latest_email_id (optional)
$contentType : string = self::contentTypes['agentReplyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToEmail'] to see the possible values for this operation

Return values

SentEmailDto —

agentReplyToEmailAsync()

Operation agentReplyToEmailAsync


    public
                    agentReplyToEmailAsync(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_email_id = null ][, string $contentType = self::contentTypes['agentReplyToEmail'][0] ]) : PromiseInterface

Reply to a scoped email as an agent

Parameters

$email_id : string: ID of email to reply to (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_email_id : string = null: (optional)
$contentType : string = self::contentTypes['agentReplyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToEmail'] to see the possible values for this operation

Return values

PromiseInterface —

agentReplyToEmailAsyncWithHttpInfo()

Operation agentReplyToEmailAsyncWithHttpInfo


    public
                    agentReplyToEmailAsyncWithHttpInfo(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_email_id = null ][, string $contentType = self::contentTypes['agentReplyToEmail'][0] ]) : PromiseInterface

Reply to a scoped email as an agent

Parameters

$email_id : string: ID of email to reply to (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_email_id : string = null: (optional)
$contentType : string = self::contentTypes['agentReplyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToEmail'] to see the possible values for this operation

Return values

PromiseInterface —

agentReplyToEmailRequest()

Create request for operation 'agentReplyToEmail'


    public
                    agentReplyToEmailRequest(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_email_id = null ][, string $contentType = self::contentTypes['agentReplyToEmail'][0] ]) : Request

Parameters

$email_id : string: ID of email to reply to (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_email_id : string = null: (optional)
$contentType : string = self::contentTypes['agentReplyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToEmail'] to see the possible values for this operation

Return values

Request —

agentReplyToEmailWithHttpInfo()

Operation agentReplyToEmailWithHttpInfo


    public
                    agentReplyToEmailWithHttpInfo(string $email_id, ReplyToEmailOptions $reply_to_email_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_email_id = null ][, string $contentType = self::contentTypes['agentReplyToEmail'][0] ]) : array<string|int, mixed>

Reply to a scoped email as an agent

Parameters

$email_id : string: ID of email to reply to (required)
$reply_to_email_options : ReplyToEmailOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_email_id : string = null: (optional)
$contentType : string = self::contentTypes['agentReplyToEmail'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToEmail'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SentEmailDto, HTTP status code, HTTP response headers (array of strings)

agentReplyToSms()

Operation agentReplyToSms


    public
                    agentReplyToSms(string $phone_number_id, string $sms_id, SmsReplyOptions $sms_reply_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentReplyToSms'][0] ]) : SentSmsDto

Reply to received SMS

Parameters

$phone_number_id : string: phone_number_id (required)
$sms_id : string: sms_id (required)
$sms_reply_options : SmsReplyOptions: sms_reply_options (required)
$idempotency_key : string = null: idempotency_key (optional)
$expected_conversation_version : int = null: expected_conversation_version (optional)
$expected_latest_message_id : string = null: expected_latest_message_id (optional)
$contentType : string = self::contentTypes['agentReplyToSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToSms'] to see the possible values for this operation

Return values

SentSmsDto —

agentReplyToSmsAsync()

Operation agentReplyToSmsAsync


    public
                    agentReplyToSmsAsync(string $phone_number_id, string $sms_id, SmsReplyOptions $sms_reply_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentReplyToSms'][0] ]) : PromiseInterface

Reply to received SMS

Parameters

$phone_number_id : string: (required)
$sms_id : string: (required)
$sms_reply_options : SmsReplyOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_message_id : string = null: (optional)
$contentType : string = self::contentTypes['agentReplyToSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToSms'] to see the possible values for this operation

Return values

PromiseInterface —

agentReplyToSmsAsyncWithHttpInfo()

Operation agentReplyToSmsAsyncWithHttpInfo


    public
                    agentReplyToSmsAsyncWithHttpInfo(string $phone_number_id, string $sms_id, SmsReplyOptions $sms_reply_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentReplyToSms'][0] ]) : PromiseInterface

Reply to received SMS

Parameters

$phone_number_id : string: (required)
$sms_id : string: (required)
$sms_reply_options : SmsReplyOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_message_id : string = null: (optional)
$contentType : string = self::contentTypes['agentReplyToSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToSms'] to see the possible values for this operation

Return values

PromiseInterface —

agentReplyToSmsRequest()

Create request for operation 'agentReplyToSms'


    public
                    agentReplyToSmsRequest(string $phone_number_id, string $sms_id, SmsReplyOptions $sms_reply_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentReplyToSms'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$sms_id : string: (required)
$sms_reply_options : SmsReplyOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_message_id : string = null: (optional)
$contentType : string = self::contentTypes['agentReplyToSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToSms'] to see the possible values for this operation

Return values

Request —

agentReplyToSmsWithHttpInfo()

Operation agentReplyToSmsWithHttpInfo


    public
                    agentReplyToSmsWithHttpInfo(string $phone_number_id, string $sms_id, SmsReplyOptions $sms_reply_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentReplyToSms'][0] ]) : array<string|int, mixed>

Reply to received SMS

Parameters

$phone_number_id : string: (required)
$sms_id : string: (required)
$sms_reply_options : SmsReplyOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_message_id : string = null: (optional)
$contentType : string = self::contentTypes['agentReplyToSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentReplyToSms'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SentSmsDto, HTTP status code, HTTP response headers (array of strings)

agentReportWorkerHeartbeat()

Operation agentReportWorkerHeartbeat


    public
                    agentReportWorkerHeartbeat(AgentWorkerHeartbeatOptions $agent_worker_heartbeat_options[, string $contentType = self::contentTypes['agentReportWorkerHeartbeat'][0] ]) : AgentWorkerHeartbeatDto

Report a worker heartbeat

Parameters

$agent_worker_heartbeat_options : AgentWorkerHeartbeatOptions: agent_worker_heartbeat_options (required)
$contentType : string = self::contentTypes['agentReportWorkerHeartbeat'][0]: The value for the Content-Type header. Check self::contentTypes['agentReportWorkerHeartbeat'] to see the possible values for this operation

Return values

AgentWorkerHeartbeatDto —

agentReportWorkerHeartbeatAsync()

Operation agentReportWorkerHeartbeatAsync


    public
                    agentReportWorkerHeartbeatAsync(AgentWorkerHeartbeatOptions $agent_worker_heartbeat_options[, string $contentType = self::contentTypes['agentReportWorkerHeartbeat'][0] ]) : PromiseInterface

Report a worker heartbeat

Parameters

$agent_worker_heartbeat_options : AgentWorkerHeartbeatOptions: (required)
$contentType : string = self::contentTypes['agentReportWorkerHeartbeat'][0]: The value for the Content-Type header. Check self::contentTypes['agentReportWorkerHeartbeat'] to see the possible values for this operation

Return values

PromiseInterface —

agentReportWorkerHeartbeatAsyncWithHttpInfo()

Operation agentReportWorkerHeartbeatAsyncWithHttpInfo


    public
                    agentReportWorkerHeartbeatAsyncWithHttpInfo(AgentWorkerHeartbeatOptions $agent_worker_heartbeat_options[, string $contentType = self::contentTypes['agentReportWorkerHeartbeat'][0] ]) : PromiseInterface

Report a worker heartbeat

Parameters

$agent_worker_heartbeat_options : AgentWorkerHeartbeatOptions: (required)
$contentType : string = self::contentTypes['agentReportWorkerHeartbeat'][0]: The value for the Content-Type header. Check self::contentTypes['agentReportWorkerHeartbeat'] to see the possible values for this operation

Return values

PromiseInterface —

agentReportWorkerHeartbeatRequest()

Create request for operation 'agentReportWorkerHeartbeat'


    public
                    agentReportWorkerHeartbeatRequest(AgentWorkerHeartbeatOptions $agent_worker_heartbeat_options[, string $contentType = self::contentTypes['agentReportWorkerHeartbeat'][0] ]) : Request

Parameters

$agent_worker_heartbeat_options : AgentWorkerHeartbeatOptions: (required)
$contentType : string = self::contentTypes['agentReportWorkerHeartbeat'][0]: The value for the Content-Type header. Check self::contentTypes['agentReportWorkerHeartbeat'] to see the possible values for this operation

Return values

Request —

agentReportWorkerHeartbeatWithHttpInfo()

Operation agentReportWorkerHeartbeatWithHttpInfo


    public
                    agentReportWorkerHeartbeatWithHttpInfo(AgentWorkerHeartbeatOptions $agent_worker_heartbeat_options[, string $contentType = self::contentTypes['agentReportWorkerHeartbeat'][0] ]) : array<string|int, mixed>

Report a worker heartbeat

Parameters

$agent_worker_heartbeat_options : AgentWorkerHeartbeatOptions: (required)
$contentType : string = self::contentTypes['agentReportWorkerHeartbeat'][0]: The value for the Content-Type header. Check self::contentTypes['agentReportWorkerHeartbeat'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentWorkerHeartbeatDto, HTTP status code, HTTP response headers (array of strings)

agentRequestConversationHandoff()

Operation agentRequestConversationHandoff


    public
                    agentRequestConversationHandoff(string $conversation_id, CreateAgentConversationHandoffOptions $create_agent_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestConversationHandoff'][0] ]) : AgentConversationHandoffDto

Request human review for a conversation

Parameters

$conversation_id : string: conversation_id (required)
$create_agent_conversation_handoff_options : CreateAgentConversationHandoffOptions: create_agent_conversation_handoff_options (required)
$contentType : string = self::contentTypes['agentRequestConversationHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestConversationHandoff'] to see the possible values for this operation

Return values

AgentConversationHandoffDto —

agentRequestConversationHandoffAsync()

Operation agentRequestConversationHandoffAsync


    public
                    agentRequestConversationHandoffAsync(string $conversation_id, CreateAgentConversationHandoffOptions $create_agent_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestConversationHandoff'][0] ]) : PromiseInterface

Request human review for a conversation

Parameters

$conversation_id : string: (required)
$create_agent_conversation_handoff_options : CreateAgentConversationHandoffOptions: (required)
$contentType : string = self::contentTypes['agentRequestConversationHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestConversationHandoff'] to see the possible values for this operation

Return values

PromiseInterface —

agentRequestConversationHandoffAsyncWithHttpInfo()

Operation agentRequestConversationHandoffAsyncWithHttpInfo


    public
                    agentRequestConversationHandoffAsyncWithHttpInfo(string $conversation_id, CreateAgentConversationHandoffOptions $create_agent_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestConversationHandoff'][0] ]) : PromiseInterface

Request human review for a conversation

Parameters

$conversation_id : string: (required)
$create_agent_conversation_handoff_options : CreateAgentConversationHandoffOptions: (required)
$contentType : string = self::contentTypes['agentRequestConversationHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestConversationHandoff'] to see the possible values for this operation

Return values

PromiseInterface —

agentRequestConversationHandoffRequest()

Create request for operation 'agentRequestConversationHandoff'


    public
                    agentRequestConversationHandoffRequest(string $conversation_id, CreateAgentConversationHandoffOptions $create_agent_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestConversationHandoff'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$create_agent_conversation_handoff_options : CreateAgentConversationHandoffOptions: (required)
$contentType : string = self::contentTypes['agentRequestConversationHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestConversationHandoff'] to see the possible values for this operation

Return values

Request —

agentRequestConversationHandoffWithHttpInfo()

Operation agentRequestConversationHandoffWithHttpInfo


    public
                    agentRequestConversationHandoffWithHttpInfo(string $conversation_id, CreateAgentConversationHandoffOptions $create_agent_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestConversationHandoff'][0] ]) : array<string|int, mixed>

Request human review for a conversation

Parameters

$conversation_id : string: (required)
$create_agent_conversation_handoff_options : CreateAgentConversationHandoffOptions: (required)
$contentType : string = self::contentTypes['agentRequestConversationHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestConversationHandoff'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationHandoffDto, HTTP status code, HTTP response headers (array of strings)

agentRequestSmsHandoff()

Operation agentRequestSmsHandoff


    public
                    agentRequestSmsHandoff(string $conversation_id, CreateAgentSmsConversationHandoffOptions $create_agent_sms_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestSmsHandoff'][0] ]) : AgentConversationHandoffDto

Request human review for an SMS conversation

Parameters

$conversation_id : string: conversation_id (required)
$create_agent_sms_conversation_handoff_options : CreateAgentSmsConversationHandoffOptions: create_agent_sms_conversation_handoff_options (required)
$contentType : string = self::contentTypes['agentRequestSmsHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestSmsHandoff'] to see the possible values for this operation

Return values

AgentConversationHandoffDto —

agentRequestSmsHandoffAsync()

Operation agentRequestSmsHandoffAsync


    public
                    agentRequestSmsHandoffAsync(string $conversation_id, CreateAgentSmsConversationHandoffOptions $create_agent_sms_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestSmsHandoff'][0] ]) : PromiseInterface

Request human review for an SMS conversation

Parameters

$conversation_id : string: (required)
$create_agent_sms_conversation_handoff_options : CreateAgentSmsConversationHandoffOptions: (required)
$contentType : string = self::contentTypes['agentRequestSmsHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestSmsHandoff'] to see the possible values for this operation

Return values

PromiseInterface —

agentRequestSmsHandoffAsyncWithHttpInfo()

Operation agentRequestSmsHandoffAsyncWithHttpInfo


    public
                    agentRequestSmsHandoffAsyncWithHttpInfo(string $conversation_id, CreateAgentSmsConversationHandoffOptions $create_agent_sms_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestSmsHandoff'][0] ]) : PromiseInterface

Request human review for an SMS conversation

Parameters

$conversation_id : string: (required)
$create_agent_sms_conversation_handoff_options : CreateAgentSmsConversationHandoffOptions: (required)
$contentType : string = self::contentTypes['agentRequestSmsHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestSmsHandoff'] to see the possible values for this operation

Return values

PromiseInterface —

agentRequestSmsHandoffRequest()

Create request for operation 'agentRequestSmsHandoff'


    public
                    agentRequestSmsHandoffRequest(string $conversation_id, CreateAgentSmsConversationHandoffOptions $create_agent_sms_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestSmsHandoff'][0] ]) : Request

Parameters

$conversation_id : string: (required)
$create_agent_sms_conversation_handoff_options : CreateAgentSmsConversationHandoffOptions: (required)
$contentType : string = self::contentTypes['agentRequestSmsHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestSmsHandoff'] to see the possible values for this operation

Return values

Request —

agentRequestSmsHandoffWithHttpInfo()

Operation agentRequestSmsHandoffWithHttpInfo


    public
                    agentRequestSmsHandoffWithHttpInfo(string $conversation_id, CreateAgentSmsConversationHandoffOptions $create_agent_sms_conversation_handoff_options[, string $contentType = self::contentTypes['agentRequestSmsHandoff'][0] ]) : array<string|int, mixed>

Request human review for an SMS conversation

Parameters

$conversation_id : string: (required)
$create_agent_sms_conversation_handoff_options : CreateAgentSmsConversationHandoffOptions: (required)
$contentType : string = self::contentTypes['agentRequestSmsHandoff'][0]: The value for the Content-Type header. Check self::contentTypes['agentRequestSmsHandoff'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\AgentConversationHandoffDto, HTTP status code, HTTP response headers (array of strings)

agentSearchInboxEmails()

Operation agentSearchInboxEmails


    public
                    agentSearchInboxEmails(string $inbox_id, MatchOptions $match_options[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $unread_only = null ][, string $contentType = self::contentTypes['agentSearchInboxEmails'][0] ]) : array<string|int, EmailPreview>

Search scoped inbox emails for an agent

Parameters

$inbox_id : string: inbox_id (required)
$match_options : MatchOptions: match_options (required)
$size : int = 20: size (optional, default to 20)
$sort : string = 'DESC': sort (optional, default to 'DESC')
$since : DateTime = null: since (optional)
$before : DateTime = null: before (optional)
$unread_only : bool = null: unread_only (optional)
$contentType : string = self::contentTypes['agentSearchInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentSearchInboxEmails'] to see the possible values for this operation

Return values

array<string|int, EmailPreview> —

agentSearchInboxEmailsAsync()

Operation agentSearchInboxEmailsAsync


    public
                    agentSearchInboxEmailsAsync(string $inbox_id, MatchOptions $match_options[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $unread_only = null ][, string $contentType = self::contentTypes['agentSearchInboxEmails'][0] ]) : PromiseInterface

Search scoped inbox emails for an agent

Parameters

$inbox_id : string: (required)
$match_options : MatchOptions: (required)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$unread_only : bool = null: (optional)
$contentType : string = self::contentTypes['agentSearchInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentSearchInboxEmails'] to see the possible values for this operation

Return values

PromiseInterface —

agentSearchInboxEmailsAsyncWithHttpInfo()

Operation agentSearchInboxEmailsAsyncWithHttpInfo


    public
                    agentSearchInboxEmailsAsyncWithHttpInfo(string $inbox_id, MatchOptions $match_options[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $unread_only = null ][, string $contentType = self::contentTypes['agentSearchInboxEmails'][0] ]) : PromiseInterface

Search scoped inbox emails for an agent

Parameters

$inbox_id : string: (required)
$match_options : MatchOptions: (required)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$unread_only : bool = null: (optional)
$contentType : string = self::contentTypes['agentSearchInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentSearchInboxEmails'] to see the possible values for this operation

Return values

PromiseInterface —

agentSearchInboxEmailsRequest()

Create request for operation 'agentSearchInboxEmails'


    public
                    agentSearchInboxEmailsRequest(string $inbox_id, MatchOptions $match_options[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $unread_only = null ][, string $contentType = self::contentTypes['agentSearchInboxEmails'][0] ]) : Request

Parameters

$inbox_id : string: (required)
$match_options : MatchOptions: (required)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$unread_only : bool = null: (optional)
$contentType : string = self::contentTypes['agentSearchInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentSearchInboxEmails'] to see the possible values for this operation

Return values

Request —

agentSearchInboxEmailsWithHttpInfo()

Operation agentSearchInboxEmailsWithHttpInfo


    public
                    agentSearchInboxEmailsWithHttpInfo(string $inbox_id, MatchOptions $match_options[, int $size = 20 ][, string $sort = 'DESC' ][, DateTime $since = null ][, DateTime $before = null ][, bool $unread_only = null ][, string $contentType = self::contentTypes['agentSearchInboxEmails'][0] ]) : array<string|int, mixed>

Search scoped inbox emails for an agent

Parameters

$inbox_id : string: (required)
$match_options : MatchOptions: (required)
$size : int = 20: (optional, default to 20)
$sort : string = 'DESC': (optional, default to 'DESC')
$since : DateTime = null: (optional)
$before : DateTime = null: (optional)
$unread_only : bool = null: (optional)
$contentType : string = self::contentTypes['agentSearchInboxEmails'][0]: The value for the Content-Type header. Check self::contentTypes['agentSearchInboxEmails'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailPreview[], HTTP status code, HTTP response headers (array of strings)

agentSendEmailDraft()

Operation agentSendEmailDraft


    public
                    agentSendEmailDraft(string $inbox_id, string $draft_id[, string $idempotency_key = null ][, string $contentType = self::contentTypes['agentSendEmailDraft'][0] ]) : SentEmailDto

Send a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$idempotency_key : string = null: idempotency_key (optional)
$contentType : string = self::contentTypes['agentSendEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendEmailDraft'] to see the possible values for this operation

Return values

SentEmailDto —

agentSendEmailDraftAsync()

Operation agentSendEmailDraftAsync


    public
                    agentSendEmailDraftAsync(string $inbox_id, string $draft_id[, string $idempotency_key = null ][, string $contentType = self::contentTypes['agentSendEmailDraft'][0] ]) : PromiseInterface

Send a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$idempotency_key : string = null: (optional)
$contentType : string = self::contentTypes['agentSendEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentSendEmailDraftAsyncWithHttpInfo()

Operation agentSendEmailDraftAsyncWithHttpInfo


    public
                    agentSendEmailDraftAsyncWithHttpInfo(string $inbox_id, string $draft_id[, string $idempotency_key = null ][, string $contentType = self::contentTypes['agentSendEmailDraft'][0] ]) : PromiseInterface

Send a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$idempotency_key : string = null: (optional)
$contentType : string = self::contentTypes['agentSendEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentSendEmailDraftRequest()

Create request for operation 'agentSendEmailDraft'


    public
                    agentSendEmailDraftRequest(string $inbox_id, string $draft_id[, string $idempotency_key = null ][, string $contentType = self::contentTypes['agentSendEmailDraft'][0] ]) : Request

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$idempotency_key : string = null: (optional)
$contentType : string = self::contentTypes['agentSendEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendEmailDraft'] to see the possible values for this operation

Return values

Request —

agentSendEmailDraftWithHttpInfo()

Operation agentSendEmailDraftWithHttpInfo


    public
                    agentSendEmailDraftWithHttpInfo(string $inbox_id, string $draft_id[, string $idempotency_key = null ][, string $contentType = self::contentTypes['agentSendEmailDraft'][0] ]) : array<string|int, mixed>

Send a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$idempotency_key : string = null: (optional)
$contentType : string = self::contentTypes['agentSendEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendEmailDraft'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SentEmailDto, HTTP status code, HTTP response headers (array of strings)

agentSendSms()

Operation agentSendSms


    public
                    agentSendSms(string $phone_number_id, SmsSendOptions $sms_send_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentSendSms'][0] ]) : SentSmsDto

Send SMS from an assigned phone number

Parameters

$phone_number_id : string: phone_number_id (required)
$sms_send_options : SmsSendOptions: sms_send_options (required)
$idempotency_key : string = null: idempotency_key (optional)
$expected_conversation_version : int = null: expected_conversation_version (optional)
$expected_latest_message_id : string = null: expected_latest_message_id (optional)
$contentType : string = self::contentTypes['agentSendSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendSms'] to see the possible values for this operation

Return values

SentSmsDto —

agentSendSmsAsync()

Operation agentSendSmsAsync


    public
                    agentSendSmsAsync(string $phone_number_id, SmsSendOptions $sms_send_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentSendSms'][0] ]) : PromiseInterface

Send SMS from an assigned phone number

Parameters

$phone_number_id : string: (required)
$sms_send_options : SmsSendOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_message_id : string = null: (optional)
$contentType : string = self::contentTypes['agentSendSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendSms'] to see the possible values for this operation

Return values

PromiseInterface —

agentSendSmsAsyncWithHttpInfo()

Operation agentSendSmsAsyncWithHttpInfo


    public
                    agentSendSmsAsyncWithHttpInfo(string $phone_number_id, SmsSendOptions $sms_send_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentSendSms'][0] ]) : PromiseInterface

Send SMS from an assigned phone number

Parameters

$phone_number_id : string: (required)
$sms_send_options : SmsSendOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_message_id : string = null: (optional)
$contentType : string = self::contentTypes['agentSendSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendSms'] to see the possible values for this operation

Return values

PromiseInterface —

agentSendSmsRequest()

Create request for operation 'agentSendSms'


    public
                    agentSendSmsRequest(string $phone_number_id, SmsSendOptions $sms_send_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentSendSms'][0] ]) : Request

Parameters

$phone_number_id : string: (required)
$sms_send_options : SmsSendOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_message_id : string = null: (optional)
$contentType : string = self::contentTypes['agentSendSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendSms'] to see the possible values for this operation

Return values

Request —

agentSendSmsWithHttpInfo()

Operation agentSendSmsWithHttpInfo


    public
                    agentSendSmsWithHttpInfo(string $phone_number_id, SmsSendOptions $sms_send_options[, string $idempotency_key = null ][, int $expected_conversation_version = null ][, string $expected_latest_message_id = null ][, string $contentType = self::contentTypes['agentSendSms'][0] ]) : array<string|int, mixed>

Send SMS from an assigned phone number

Parameters

$phone_number_id : string: (required)
$sms_send_options : SmsSendOptions: (required)
$idempotency_key : string = null: (optional)
$expected_conversation_version : int = null: (optional)
$expected_latest_message_id : string = null: (optional)
$contentType : string = self::contentTypes['agentSendSms'][0]: The value for the Content-Type header. Check self::contentTypes['agentSendSms'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\SentSmsDto, HTTP status code, HTTP response headers (array of strings)

agentUpdateEmailDraft()

Operation agentUpdateEmailDraft


    public
                    agentUpdateEmailDraft(string $inbox_id, string $draft_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['agentUpdateEmailDraft'][0] ]) : EmailDraftDto

Update a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$send_email_options : SendEmailOptions: send_email_options (required)
$contentType : string = self::contentTypes['agentUpdateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateEmailDraft'] to see the possible values for this operation

Return values

EmailDraftDto —

agentUpdateEmailDraftAsync()

Operation agentUpdateEmailDraftAsync


    public
                    agentUpdateEmailDraftAsync(string $inbox_id, string $draft_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['agentUpdateEmailDraft'][0] ]) : PromiseInterface

Update a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$send_email_options : SendEmailOptions: (required)
$contentType : string = self::contentTypes['agentUpdateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentUpdateEmailDraftAsyncWithHttpInfo()

Operation agentUpdateEmailDraftAsyncWithHttpInfo


    public
                    agentUpdateEmailDraftAsyncWithHttpInfo(string $inbox_id, string $draft_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['agentUpdateEmailDraft'][0] ]) : PromiseInterface

Update a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$send_email_options : SendEmailOptions: (required)
$contentType : string = self::contentTypes['agentUpdateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateEmailDraft'] to see the possible values for this operation

Return values

PromiseInterface —

agentUpdateEmailDraftRequest()

Create request for operation 'agentUpdateEmailDraft'


    public
                    agentUpdateEmailDraftRequest(string $inbox_id, string $draft_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['agentUpdateEmailDraft'][0] ]) : Request

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$send_email_options : SendEmailOptions: (required)
$contentType : string = self::contentTypes['agentUpdateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateEmailDraft'] to see the possible values for this operation

Return values

Request —

agentUpdateEmailDraftWithHttpInfo()

Operation agentUpdateEmailDraftWithHttpInfo


    public
                    agentUpdateEmailDraftWithHttpInfo(string $inbox_id, string $draft_id, SendEmailOptions $send_email_options[, string $contentType = self::contentTypes['agentUpdateEmailDraft'][0] ]) : array<string|int, mixed>

Update a scoped email draft for an agent

Parameters

$inbox_id : string: ID of inbox the draft belongs to (required)
$draft_id : string: ID of draft (required)
$send_email_options : SendEmailOptions: (required)
$contentType : string = self::contentTypes['agentUpdateEmailDraft'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateEmailDraft'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\EmailDraftDto, HTTP status code, HTTP response headers (array of strings)

agentUpdateInbox()

Operation agentUpdateInbox


    public
                    agentUpdateInbox(string $inbox_id, UpdateInboxOptions $update_inbox_options[, string $contentType = self::contentTypes['agentUpdateInbox'][0] ]) : InboxDto

Update an inbox visible to an inbox-manager connection

Parameters

$inbox_id : string: inbox_id (required)
$update_inbox_options : UpdateInboxOptions: update_inbox_options (required)
$contentType : string = self::contentTypes['agentUpdateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateInbox'] to see the possible values for this operation

Return values

InboxDto —

agentUpdateInboxAsync()

Operation agentUpdateInboxAsync


    public
                    agentUpdateInboxAsync(string $inbox_id, UpdateInboxOptions $update_inbox_options[, string $contentType = self::contentTypes['agentUpdateInbox'][0] ]) : PromiseInterface

Update an inbox visible to an inbox-manager connection

Parameters

$inbox_id : string: (required)
$update_inbox_options : UpdateInboxOptions: (required)
$contentType : string = self::contentTypes['agentUpdateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateInbox'] to see the possible values for this operation

Return values

PromiseInterface —

agentUpdateInboxAsyncWithHttpInfo()

Operation agentUpdateInboxAsyncWithHttpInfo


    public
                    agentUpdateInboxAsyncWithHttpInfo(string $inbox_id, UpdateInboxOptions $update_inbox_options[, string $contentType = self::contentTypes['agentUpdateInbox'][0] ]) : PromiseInterface

Update an inbox visible to an inbox-manager connection

Parameters

$inbox_id : string: (required)
$update_inbox_options : UpdateInboxOptions: (required)
$contentType : string = self::contentTypes['agentUpdateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateInbox'] to see the possible values for this operation

Return values

PromiseInterface —

agentUpdateInboxRequest()

Create request for operation 'agentUpdateInbox'


    public
                    agentUpdateInboxRequest(string $inbox_id, UpdateInboxOptions $update_inbox_options[, string $contentType = self::contentTypes['agentUpdateInbox'][0] ]) : Request

Parameters

$inbox_id : string: (required)
$update_inbox_options : UpdateInboxOptions: (required)
$contentType : string = self::contentTypes['agentUpdateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateInbox'] to see the possible values for this operation

Return values

Request —

agentUpdateInboxWithHttpInfo()

Operation agentUpdateInboxWithHttpInfo


    public
                    agentUpdateInboxWithHttpInfo(string $inbox_id, UpdateInboxOptions $update_inbox_options[, string $contentType = self::contentTypes['agentUpdateInbox'][0] ]) : array<string|int, mixed>

Update an inbox visible to an inbox-manager connection

Parameters

$inbox_id : string: (required)
$update_inbox_options : UpdateInboxOptions: (required)
$contentType : string = self::contentTypes['agentUpdateInbox'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateInbox'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\InboxDto, HTTP status code, HTTP response headers (array of strings)

agentUpdateTotpDevice()

Operation agentUpdateTotpDevice


    public
                    agentUpdateTotpDevice(string $id, UpdateTotpDeviceOptions $update_totp_device_options[, string $contentType = self::contentTypes['agentUpdateTotpDevice'][0] ]) : TotpDeviceDto

Update an agent-managed TOTP device

Parameters

$id : string: id (required)
$update_totp_device_options : UpdateTotpDeviceOptions: update_totp_device_options (required)
$contentType : string = self::contentTypes['agentUpdateTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateTotpDevice'] to see the possible values for this operation

Return values

TotpDeviceDto —

agentUpdateTotpDeviceAsync()

Operation agentUpdateTotpDeviceAsync


    public
                    agentUpdateTotpDeviceAsync(string $id, UpdateTotpDeviceOptions $update_totp_device_options[, string $contentType = self::contentTypes['agentUpdateTotpDevice'][0] ]) : PromiseInterface

Update an agent-managed TOTP device

Parameters

$id : string: (required)
$update_totp_device_options : UpdateTotpDeviceOptions: (required)
$contentType : string = self::contentTypes['agentUpdateTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateTotpDevice'] to see the possible values for this operation

Return values

PromiseInterface —

agentUpdateTotpDeviceAsyncWithHttpInfo()

Operation agentUpdateTotpDeviceAsyncWithHttpInfo


    public
                    agentUpdateTotpDeviceAsyncWithHttpInfo(string $id, UpdateTotpDeviceOptions $update_totp_device_options[, string $contentType = self::contentTypes['agentUpdateTotpDevice'][0] ]) : PromiseInterface

Update an agent-managed TOTP device

Parameters

$id : string: (required)
$update_totp_device_options : UpdateTotpDeviceOptions: (required)
$contentType : string = self::contentTypes['agentUpdateTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateTotpDevice'] to see the possible values for this operation

Return values

PromiseInterface —

agentUpdateTotpDeviceRequest()

Create request for operation 'agentUpdateTotpDevice'


    public
                    agentUpdateTotpDeviceRequest(string $id, UpdateTotpDeviceOptions $update_totp_device_options[, string $contentType = self::contentTypes['agentUpdateTotpDevice'][0] ]) : Request

Parameters

$id : string: (required)
$update_totp_device_options : UpdateTotpDeviceOptions: (required)
$contentType : string = self::contentTypes['agentUpdateTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateTotpDevice'] to see the possible values for this operation

Return values

Request —

agentUpdateTotpDeviceWithHttpInfo()

Operation agentUpdateTotpDeviceWithHttpInfo


    public
                    agentUpdateTotpDeviceWithHttpInfo(string $id, UpdateTotpDeviceOptions $update_totp_device_options[, string $contentType = self::contentTypes['agentUpdateTotpDevice'][0] ]) : array<string|int, mixed>

Update an agent-managed TOTP device

Parameters

$id : string: (required)
$update_totp_device_options : UpdateTotpDeviceOptions: (required)
$contentType : string = self::contentTypes['agentUpdateTotpDevice'][0]: The value for the Content-Type header. Check self::contentTypes['agentUpdateTotpDevice'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \MailSlurp\Models\TotpDeviceDto, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration —

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

Return values

void —

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

AgentControllerApi in package MailSlurp

Tags

Table of Contents

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

Return values

agentAcquireConversationClaim()

Parameters

Tags

Return values

agentAcquireConversationClaimAsync()

Parameters

Tags

Return values

agentAcquireConversationClaimAsyncWithHttpInfo()

Parameters

Tags

Return values

agentAcquireConversationClaimRequest()

Parameters

Tags

Return values

agentAcquireConversationClaimWithHttpInfo()

Parameters

Tags

Return values

agentAddConversationNote()

Parameters

Tags

Return values

agentAddConversationNoteAsync()

Parameters

Tags

Return values

agentAddConversationNoteAsyncWithHttpInfo()

Parameters

Tags

Return values

agentAddConversationNoteRequest()

Parameters

Tags

Return values

agentAddConversationNoteWithHttpInfo()

Parameters

Tags

Return values

agentAddSmsNote()

Parameters

Tags

Return values

agentAddSmsNoteAsync()

Parameters

Tags

Return values

agentAddSmsNoteAsyncWithHttpInfo()

Parameters

Tags

Return values

agentAddSmsNoteRequest()

Parameters

Tags

Return values

agentAddSmsNoteWithHttpInfo()

Parameters

Tags

Return values

agentCheckInboxSendPolicy()

Parameters

Tags

Return values

agentCheckInboxSendPolicyAsync()

Parameters

AgentControllerApi
in package

MailSlurp