Documentation

WebhookControllerApi
in package

WebhookControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['createAccountWebhook' => ['application/json'], 'createWebhook' => ['application/json'], 'createWebhookForPhoneNumber' => ['application/json'], 'deleteAllWebhooks' => ['application/json'], 'deleteWebhook' => ['application/json'], 'deleteWebhookById' => ['application/json'], 'getAllAccountWebhooks' => ['application/json'], 'getAllWebhookResults' => ['application/json'], 'getAllWebhooks' => ['application/json'], 'getInboxWebhooksPaginated' => ['application/json'], 'getJsonSchemaForWebhookEvent' => ['application/json'], 'getJsonSchemaForWebhookPayload' => ['application/json'], 'getPhoneNumberWebhooksPaginated' => ['application/json'], 'getTestWebhookPayload' => ['application/json'], 'getTestWebhookPayloadBounce' => ['application/json'], 'getTestWebhookPayloadBounceRecipient' => ['application/json'], 'getTestWebhookPayloadDeliveryStatus' => ['application/json'], 'getTestWebhookPayloadEmailOpened' => ['application/json'], 'getTestWebhookPayloadEmailRead' => ['application/json'], 'getTestWebhookPayloadForWebhook' => ['application/json'], 'getTestWebhookPayloadNewAttachment' => ['application/json'], 'getTestWebhookPayloadNewContact' => ['application/json'], 'getTestWebhookPayloadNewEmail' => ['application/json'], 'getTestWebhookPayloadNewSms' => ['application/json'], 'getWebhook' => ['application/json'], 'getWebhookResult' => ['application/json'], 'getWebhookResults' => ['application/json'], 'getWebhookResultsCount' => ['application/json'], 'getWebhookResultsUnseenErrorCount' => ['application/json'], 'getWebhooks' => ['application/json'], 'redriveAllWebhookResults' => ['application/json'], 'redriveWebhookResult' => ['application/json'], 'sendTestData' => ['application/json'], 'updateWebhookHeaders' => ['application/json'], 'verifyWebhookSignature' => ['application/json'], 'waitForWebhookResults' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
createAccountWebhook()  : WebhookDto
Operation createAccountWebhook
createAccountWebhookAsync()  : PromiseInterface
Operation createAccountWebhookAsync
createAccountWebhookAsyncWithHttpInfo()  : PromiseInterface
Operation createAccountWebhookAsyncWithHttpInfo
createAccountWebhookRequest()  : Request
Create request for operation 'createAccountWebhook'
createAccountWebhookWithHttpInfo()  : array<string|int, mixed>
Operation createAccountWebhookWithHttpInfo
createWebhook()  : WebhookDto
Operation createWebhook
createWebhookAsync()  : PromiseInterface
Operation createWebhookAsync
createWebhookAsyncWithHttpInfo()  : PromiseInterface
Operation createWebhookAsyncWithHttpInfo
createWebhookForPhoneNumber()  : WebhookDto
Operation createWebhookForPhoneNumber
createWebhookForPhoneNumberAsync()  : PromiseInterface
Operation createWebhookForPhoneNumberAsync
createWebhookForPhoneNumberAsyncWithHttpInfo()  : PromiseInterface
Operation createWebhookForPhoneNumberAsyncWithHttpInfo
createWebhookForPhoneNumberRequest()  : Request
Create request for operation 'createWebhookForPhoneNumber'
createWebhookForPhoneNumberWithHttpInfo()  : array<string|int, mixed>
Operation createWebhookForPhoneNumberWithHttpInfo
createWebhookRequest()  : Request
Create request for operation 'createWebhook'
createWebhookWithHttpInfo()  : array<string|int, mixed>
Operation createWebhookWithHttpInfo
deleteAllWebhooks()  : void
Operation deleteAllWebhooks
deleteAllWebhooksAsync()  : PromiseInterface
Operation deleteAllWebhooksAsync
deleteAllWebhooksAsyncWithHttpInfo()  : PromiseInterface
Operation deleteAllWebhooksAsyncWithHttpInfo
deleteAllWebhooksRequest()  : Request
Create request for operation 'deleteAllWebhooks'
deleteAllWebhooksWithHttpInfo()  : array<string|int, mixed>
Operation deleteAllWebhooksWithHttpInfo
deleteWebhook()  : void
Operation deleteWebhook
deleteWebhookAsync()  : PromiseInterface
Operation deleteWebhookAsync
deleteWebhookAsyncWithHttpInfo()  : PromiseInterface
Operation deleteWebhookAsyncWithHttpInfo
deleteWebhookById()  : void
Operation deleteWebhookById
deleteWebhookByIdAsync()  : PromiseInterface
Operation deleteWebhookByIdAsync
deleteWebhookByIdAsyncWithHttpInfo()  : PromiseInterface
Operation deleteWebhookByIdAsyncWithHttpInfo
deleteWebhookByIdRequest()  : Request
Create request for operation 'deleteWebhookById'
deleteWebhookByIdWithHttpInfo()  : array<string|int, mixed>
Operation deleteWebhookByIdWithHttpInfo
deleteWebhookRequest()  : Request
Create request for operation 'deleteWebhook'
deleteWebhookWithHttpInfo()  : array<string|int, mixed>
Operation deleteWebhookWithHttpInfo
getAllAccountWebhooks()  : PageWebhookProjection
Operation getAllAccountWebhooks
getAllAccountWebhooksAsync()  : PromiseInterface
Operation getAllAccountWebhooksAsync
getAllAccountWebhooksAsyncWithHttpInfo()  : PromiseInterface
Operation getAllAccountWebhooksAsyncWithHttpInfo
getAllAccountWebhooksRequest()  : Request
Create request for operation 'getAllAccountWebhooks'
getAllAccountWebhooksWithHttpInfo()  : array<string|int, mixed>
Operation getAllAccountWebhooksWithHttpInfo
getAllWebhookResults()  : PageWebhookResult
Operation getAllWebhookResults
getAllWebhookResultsAsync()  : PromiseInterface
Operation getAllWebhookResultsAsync
getAllWebhookResultsAsyncWithHttpInfo()  : PromiseInterface
Operation getAllWebhookResultsAsyncWithHttpInfo
getAllWebhookResultsRequest()  : Request
Create request for operation 'getAllWebhookResults'
getAllWebhookResultsWithHttpInfo()  : array<string|int, mixed>
Operation getAllWebhookResultsWithHttpInfo
getAllWebhooks()  : PageWebhookProjection
Operation getAllWebhooks
getAllWebhooksAsync()  : PromiseInterface
Operation getAllWebhooksAsync
getAllWebhooksAsyncWithHttpInfo()  : PromiseInterface
Operation getAllWebhooksAsyncWithHttpInfo
getAllWebhooksRequest()  : Request
Create request for operation 'getAllWebhooks'
getAllWebhooksWithHttpInfo()  : array<string|int, mixed>
Operation getAllWebhooksWithHttpInfo
getConfig()  : Configuration
getHostIndex()  : int
Get the host index
getInboxWebhooksPaginated()  : PageWebhookProjection
Operation getInboxWebhooksPaginated
getInboxWebhooksPaginatedAsync()  : PromiseInterface
Operation getInboxWebhooksPaginatedAsync
getInboxWebhooksPaginatedAsyncWithHttpInfo()  : PromiseInterface
Operation getInboxWebhooksPaginatedAsyncWithHttpInfo
getInboxWebhooksPaginatedRequest()  : Request
Create request for operation 'getInboxWebhooksPaginated'
getInboxWebhooksPaginatedWithHttpInfo()  : array<string|int, mixed>
Operation getInboxWebhooksPaginatedWithHttpInfo
getJsonSchemaForWebhookEvent()  : JSONSchemaDto
Operation getJsonSchemaForWebhookEvent
getJsonSchemaForWebhookEventAsync()  : PromiseInterface
Operation getJsonSchemaForWebhookEventAsync
getJsonSchemaForWebhookEventAsyncWithHttpInfo()  : PromiseInterface
Operation getJsonSchemaForWebhookEventAsyncWithHttpInfo
getJsonSchemaForWebhookEventRequest()  : Request
Create request for operation 'getJsonSchemaForWebhookEvent'
getJsonSchemaForWebhookEventWithHttpInfo()  : array<string|int, mixed>
Operation getJsonSchemaForWebhookEventWithHttpInfo
getJsonSchemaForWebhookPayload()  : JSONSchemaDto
Operation getJsonSchemaForWebhookPayload
getJsonSchemaForWebhookPayloadAsync()  : PromiseInterface
Operation getJsonSchemaForWebhookPayloadAsync
getJsonSchemaForWebhookPayloadAsyncWithHttpInfo()  : PromiseInterface
Operation getJsonSchemaForWebhookPayloadAsyncWithHttpInfo
getJsonSchemaForWebhookPayloadRequest()  : Request
Create request for operation 'getJsonSchemaForWebhookPayload'
getJsonSchemaForWebhookPayloadWithHttpInfo()  : array<string|int, mixed>
Operation getJsonSchemaForWebhookPayloadWithHttpInfo
getPhoneNumberWebhooksPaginated()  : PageWebhookProjection
Operation getPhoneNumberWebhooksPaginated
getPhoneNumberWebhooksPaginatedAsync()  : PromiseInterface
Operation getPhoneNumberWebhooksPaginatedAsync
getPhoneNumberWebhooksPaginatedAsyncWithHttpInfo()  : PromiseInterface
Operation getPhoneNumberWebhooksPaginatedAsyncWithHttpInfo
getPhoneNumberWebhooksPaginatedRequest()  : Request
Create request for operation 'getPhoneNumberWebhooksPaginated'
getPhoneNumberWebhooksPaginatedWithHttpInfo()  : array<string|int, mixed>
Operation getPhoneNumberWebhooksPaginatedWithHttpInfo
getTestWebhookPayload()  : AbstractWebhookPayload
Operation getTestWebhookPayload
getTestWebhookPayloadAsync()  : PromiseInterface
Operation getTestWebhookPayloadAsync
getTestWebhookPayloadAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadAsyncWithHttpInfo
getTestWebhookPayloadBounce()  : WebhookBouncePayload
Operation getTestWebhookPayloadBounce
getTestWebhookPayloadBounceAsync()  : PromiseInterface
Operation getTestWebhookPayloadBounceAsync
getTestWebhookPayloadBounceAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadBounceAsyncWithHttpInfo
getTestWebhookPayloadBounceRecipient()  : WebhookBounceRecipientPayload
Operation getTestWebhookPayloadBounceRecipient
getTestWebhookPayloadBounceRecipientAsync()  : PromiseInterface
Operation getTestWebhookPayloadBounceRecipientAsync
getTestWebhookPayloadBounceRecipientAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadBounceRecipientAsyncWithHttpInfo
getTestWebhookPayloadBounceRecipientRequest()  : Request
Create request for operation 'getTestWebhookPayloadBounceRecipient'
getTestWebhookPayloadBounceRecipientWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadBounceRecipientWithHttpInfo
getTestWebhookPayloadBounceRequest()  : Request
Create request for operation 'getTestWebhookPayloadBounce'
getTestWebhookPayloadBounceWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadBounceWithHttpInfo
getTestWebhookPayloadDeliveryStatus()  : WebhookDeliveryStatusPayload
Operation getTestWebhookPayloadDeliveryStatus
getTestWebhookPayloadDeliveryStatusAsync()  : PromiseInterface
Operation getTestWebhookPayloadDeliveryStatusAsync
getTestWebhookPayloadDeliveryStatusAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadDeliveryStatusAsyncWithHttpInfo
getTestWebhookPayloadDeliveryStatusRequest()  : Request
Create request for operation 'getTestWebhookPayloadDeliveryStatus'
getTestWebhookPayloadDeliveryStatusWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadDeliveryStatusWithHttpInfo
getTestWebhookPayloadEmailOpened()  : WebhookEmailOpenedPayload
Operation getTestWebhookPayloadEmailOpened
getTestWebhookPayloadEmailOpenedAsync()  : PromiseInterface
Operation getTestWebhookPayloadEmailOpenedAsync
getTestWebhookPayloadEmailOpenedAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadEmailOpenedAsyncWithHttpInfo
getTestWebhookPayloadEmailOpenedRequest()  : Request
Create request for operation 'getTestWebhookPayloadEmailOpened'
getTestWebhookPayloadEmailOpenedWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadEmailOpenedWithHttpInfo
getTestWebhookPayloadEmailRead()  : WebhookEmailReadPayload
Operation getTestWebhookPayloadEmailRead
getTestWebhookPayloadEmailReadAsync()  : PromiseInterface
Operation getTestWebhookPayloadEmailReadAsync
getTestWebhookPayloadEmailReadAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadEmailReadAsyncWithHttpInfo
getTestWebhookPayloadEmailReadRequest()  : Request
Create request for operation 'getTestWebhookPayloadEmailRead'
getTestWebhookPayloadEmailReadWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadEmailReadWithHttpInfo
getTestWebhookPayloadForWebhook()  : AbstractWebhookPayload
Operation getTestWebhookPayloadForWebhook
getTestWebhookPayloadForWebhookAsync()  : PromiseInterface
Operation getTestWebhookPayloadForWebhookAsync
getTestWebhookPayloadForWebhookAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadForWebhookAsyncWithHttpInfo
getTestWebhookPayloadForWebhookRequest()  : Request
Create request for operation 'getTestWebhookPayloadForWebhook'
getTestWebhookPayloadForWebhookWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadForWebhookWithHttpInfo
getTestWebhookPayloadNewAttachment()  : WebhookNewAttachmentPayload
Operation getTestWebhookPayloadNewAttachment
getTestWebhookPayloadNewAttachmentAsync()  : PromiseInterface
Operation getTestWebhookPayloadNewAttachmentAsync
getTestWebhookPayloadNewAttachmentAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadNewAttachmentAsyncWithHttpInfo
getTestWebhookPayloadNewAttachmentRequest()  : Request
Create request for operation 'getTestWebhookPayloadNewAttachment'
getTestWebhookPayloadNewAttachmentWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadNewAttachmentWithHttpInfo
getTestWebhookPayloadNewContact()  : WebhookNewContactPayload
Operation getTestWebhookPayloadNewContact
getTestWebhookPayloadNewContactAsync()  : PromiseInterface
Operation getTestWebhookPayloadNewContactAsync
getTestWebhookPayloadNewContactAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadNewContactAsyncWithHttpInfo
getTestWebhookPayloadNewContactRequest()  : Request
Create request for operation 'getTestWebhookPayloadNewContact'
getTestWebhookPayloadNewContactWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadNewContactWithHttpInfo
getTestWebhookPayloadNewEmail()  : WebhookNewEmailPayload
Operation getTestWebhookPayloadNewEmail
getTestWebhookPayloadNewEmailAsync()  : PromiseInterface
Operation getTestWebhookPayloadNewEmailAsync
getTestWebhookPayloadNewEmailAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadNewEmailAsyncWithHttpInfo
getTestWebhookPayloadNewEmailRequest()  : Request
Create request for operation 'getTestWebhookPayloadNewEmail'
getTestWebhookPayloadNewEmailWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadNewEmailWithHttpInfo
getTestWebhookPayloadNewSms()  : WebhookNewSmsPayload
Operation getTestWebhookPayloadNewSms
getTestWebhookPayloadNewSmsAsync()  : PromiseInterface
Operation getTestWebhookPayloadNewSmsAsync
getTestWebhookPayloadNewSmsAsyncWithHttpInfo()  : PromiseInterface
Operation getTestWebhookPayloadNewSmsAsyncWithHttpInfo
getTestWebhookPayloadNewSmsRequest()  : Request
Create request for operation 'getTestWebhookPayloadNewSms'
getTestWebhookPayloadNewSmsWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadNewSmsWithHttpInfo
getTestWebhookPayloadRequest()  : Request
Create request for operation 'getTestWebhookPayload'
getTestWebhookPayloadWithHttpInfo()  : array<string|int, mixed>
Operation getTestWebhookPayloadWithHttpInfo
getWebhook()  : WebhookDto
Operation getWebhook
getWebhookAsync()  : PromiseInterface
Operation getWebhookAsync
getWebhookAsyncWithHttpInfo()  : PromiseInterface
Operation getWebhookAsyncWithHttpInfo
getWebhookRequest()  : Request
Create request for operation 'getWebhook'
getWebhookResult()  : WebhookResultDto
Operation getWebhookResult
getWebhookResultAsync()  : PromiseInterface
Operation getWebhookResultAsync
getWebhookResultAsyncWithHttpInfo()  : PromiseInterface
Operation getWebhookResultAsyncWithHttpInfo
getWebhookResultRequest()  : Request
Create request for operation 'getWebhookResult'
getWebhookResults()  : PageWebhookResult
Operation getWebhookResults
getWebhookResultsAsync()  : PromiseInterface
Operation getWebhookResultsAsync
getWebhookResultsAsyncWithHttpInfo()  : PromiseInterface
Operation getWebhookResultsAsyncWithHttpInfo
getWebhookResultsCount()  : CountDto
Operation getWebhookResultsCount
getWebhookResultsCountAsync()  : PromiseInterface
Operation getWebhookResultsCountAsync
getWebhookResultsCountAsyncWithHttpInfo()  : PromiseInterface
Operation getWebhookResultsCountAsyncWithHttpInfo
getWebhookResultsCountRequest()  : Request
Create request for operation 'getWebhookResultsCount'
getWebhookResultsCountWithHttpInfo()  : array<string|int, mixed>
Operation getWebhookResultsCountWithHttpInfo
getWebhookResultsRequest()  : Request
Create request for operation 'getWebhookResults'
getWebhookResultsUnseenErrorCount()  : UnseenErrorCountDto
Operation getWebhookResultsUnseenErrorCount
getWebhookResultsUnseenErrorCountAsync()  : PromiseInterface
Operation getWebhookResultsUnseenErrorCountAsync
getWebhookResultsUnseenErrorCountAsyncWithHttpInfo()  : PromiseInterface
Operation getWebhookResultsUnseenErrorCountAsyncWithHttpInfo
getWebhookResultsUnseenErrorCountRequest()  : Request
Create request for operation 'getWebhookResultsUnseenErrorCount'
getWebhookResultsUnseenErrorCountWithHttpInfo()  : array<string|int, mixed>
Operation getWebhookResultsUnseenErrorCountWithHttpInfo
getWebhookResultsWithHttpInfo()  : array<string|int, mixed>
Operation getWebhookResultsWithHttpInfo
getWebhookResultWithHttpInfo()  : array<string|int, mixed>
Operation getWebhookResultWithHttpInfo
getWebhooks()  : array<string|int, WebhookDto>
Operation getWebhooks
getWebhooksAsync()  : PromiseInterface
Operation getWebhooksAsync
getWebhooksAsyncWithHttpInfo()  : PromiseInterface
Operation getWebhooksAsyncWithHttpInfo
getWebhooksRequest()  : Request
Create request for operation 'getWebhooks'
getWebhooksWithHttpInfo()  : array<string|int, mixed>
Operation getWebhooksWithHttpInfo
getWebhookWithHttpInfo()  : array<string|int, mixed>
Operation getWebhookWithHttpInfo
redriveAllWebhookResults()  : WebhookRedriveAllResult
Operation redriveAllWebhookResults
redriveAllWebhookResultsAsync()  : PromiseInterface
Operation redriveAllWebhookResultsAsync
redriveAllWebhookResultsAsyncWithHttpInfo()  : PromiseInterface
Operation redriveAllWebhookResultsAsyncWithHttpInfo
redriveAllWebhookResultsRequest()  : Request
Create request for operation 'redriveAllWebhookResults'
redriveAllWebhookResultsWithHttpInfo()  : array<string|int, mixed>
Operation redriveAllWebhookResultsWithHttpInfo
redriveWebhookResult()  : WebhookRedriveResult
Operation redriveWebhookResult
redriveWebhookResultAsync()  : PromiseInterface
Operation redriveWebhookResultAsync
redriveWebhookResultAsyncWithHttpInfo()  : PromiseInterface
Operation redriveWebhookResultAsyncWithHttpInfo
redriveWebhookResultRequest()  : Request
Create request for operation 'redriveWebhookResult'
redriveWebhookResultWithHttpInfo()  : array<string|int, mixed>
Operation redriveWebhookResultWithHttpInfo
sendTestData()  : WebhookTestResult
Operation sendTestData
sendTestDataAsync()  : PromiseInterface
Operation sendTestDataAsync
sendTestDataAsyncWithHttpInfo()  : PromiseInterface
Operation sendTestDataAsyncWithHttpInfo
sendTestDataRequest()  : Request
Create request for operation 'sendTestData'
sendTestDataWithHttpInfo()  : array<string|int, mixed>
Operation sendTestDataWithHttpInfo
setHostIndex()  : void
Set the host index
updateWebhookHeaders()  : WebhookDto
Operation updateWebhookHeaders
updateWebhookHeadersAsync()  : PromiseInterface
Operation updateWebhookHeadersAsync
updateWebhookHeadersAsyncWithHttpInfo()  : PromiseInterface
Operation updateWebhookHeadersAsyncWithHttpInfo
updateWebhookHeadersRequest()  : Request
Create request for operation 'updateWebhookHeaders'
updateWebhookHeadersWithHttpInfo()  : array<string|int, mixed>
Operation updateWebhookHeadersWithHttpInfo
verifyWebhookSignature()  : VerifyWebhookSignatureResults
Operation verifyWebhookSignature
verifyWebhookSignatureAsync()  : PromiseInterface
Operation verifyWebhookSignatureAsync
verifyWebhookSignatureAsyncWithHttpInfo()  : PromiseInterface
Operation verifyWebhookSignatureAsyncWithHttpInfo
verifyWebhookSignatureRequest()  : Request
Create request for operation 'verifyWebhookSignature'
verifyWebhookSignatureWithHttpInfo()  : array<string|int, mixed>
Operation verifyWebhookSignatureWithHttpInfo
waitForWebhookResults()  : array<string|int, WebhookResultDto>
Operation waitForWebhookResults
waitForWebhookResultsAsync()  : PromiseInterface
Operation waitForWebhookResultsAsync
waitForWebhookResultsAsyncWithHttpInfo()  : PromiseInterface
Operation waitForWebhookResultsAsyncWithHttpInfo
waitForWebhookResultsRequest()  : Request
Create request for operation 'waitForWebhookResults'
waitForWebhookResultsWithHttpInfo()  : array<string|int, mixed>
Operation waitForWebhookResultsWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['createAccountWebhook' => ['application/json'], 'createWebhook' => ['application/json'], 'createWebhookForPhoneNumber' => ['application/json'], 'deleteAllWebhooks' => ['application/json'], 'deleteWebhook' => ['application/json'], 'deleteWebhookById' => ['application/json'], 'getAllAccountWebhooks' => ['application/json'], 'getAllWebhookResults' => ['application/json'], 'getAllWebhooks' => ['application/json'], 'getInboxWebhooksPaginated' => ['application/json'], 'getJsonSchemaForWebhookEvent' => ['application/json'], 'getJsonSchemaForWebhookPayload' => ['application/json'], 'getPhoneNumberWebhooksPaginated' => ['application/json'], 'getTestWebhookPayload' => ['application/json'], 'getTestWebhookPayloadBounce' => ['application/json'], 'getTestWebhookPayloadBounceRecipient' => ['application/json'], 'getTestWebhookPayloadDeliveryStatus' => ['application/json'], 'getTestWebhookPayloadEmailOpened' => ['application/json'], 'getTestWebhookPayloadEmailRead' => ['application/json'], 'getTestWebhookPayloadForWebhook' => ['application/json'], 'getTestWebhookPayloadNewAttachment' => ['application/json'], 'getTestWebhookPayloadNewContact' => ['application/json'], 'getTestWebhookPayloadNewEmail' => ['application/json'], 'getTestWebhookPayloadNewSms' => ['application/json'], 'getWebhook' => ['application/json'], 'getWebhookResult' => ['application/json'], 'getWebhookResults' => ['application/json'], 'getWebhookResultsCount' => ['application/json'], 'getWebhookResultsUnseenErrorCount' => ['application/json'], 'getWebhooks' => ['application/json'], 'redriveAllWebhookResults' => ['application/json'], 'redriveWebhookResult' => ['application/json'], 'sendTestData' => ['application/json'], 'updateWebhookHeaders' => ['application/json'], 'verifyWebhookSignature' => ['application/json'], 'waitForWebhookResults' => ['application/json']]

Properties

Methods

__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

createAccountWebhook()

Operation createAccountWebhook

public createAccountWebhook(CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createAccountWebhook'][0] ]) : WebhookDto

Attach a WebHook URL to an inbox

Parameters
$create_webhook_options : CreateWebhookOptions

create_webhook_options (required)

$contentType : string = self::contentTypes['createAccountWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createAccountWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookDto

createAccountWebhookAsync()

Operation createAccountWebhookAsync

public createAccountWebhookAsync(CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createAccountWebhook'][0] ]) : PromiseInterface

Attach a WebHook URL to an inbox

Parameters
$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createAccountWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createAccountWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createAccountWebhookAsyncWithHttpInfo()

Operation createAccountWebhookAsyncWithHttpInfo

public createAccountWebhookAsyncWithHttpInfo(CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createAccountWebhook'][0] ]) : PromiseInterface

Attach a WebHook URL to an inbox

Parameters
$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createAccountWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createAccountWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createAccountWebhookRequest()

Create request for operation 'createAccountWebhook'

public createAccountWebhookRequest(CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createAccountWebhook'][0] ]) : Request
Parameters
$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createAccountWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createAccountWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createAccountWebhookWithHttpInfo()

Operation createAccountWebhookWithHttpInfo

public createAccountWebhookWithHttpInfo(CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createAccountWebhook'][0] ]) : array<string|int, mixed>

Attach a WebHook URL to an inbox

Parameters
$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createAccountWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createAccountWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

createWebhook()

Operation createWebhook

public createWebhook(string $inbox_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhook'][0] ]) : WebhookDto

Attach a WebHook URL to an inbox

Parameters
$inbox_id : string

inbox_id (required)

$create_webhook_options : CreateWebhookOptions

create_webhook_options (required)

$contentType : string = self::contentTypes['createWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookDto

createWebhookAsync()

Operation createWebhookAsync

public createWebhookAsync(string $inbox_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhook'][0] ]) : PromiseInterface

Attach a WebHook URL to an inbox

Parameters
$inbox_id : string

(required)

$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createWebhookAsyncWithHttpInfo()

Operation createWebhookAsyncWithHttpInfo

public createWebhookAsyncWithHttpInfo(string $inbox_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhook'][0] ]) : PromiseInterface

Attach a WebHook URL to an inbox

Parameters
$inbox_id : string

(required)

$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createWebhookForPhoneNumber()

Operation createWebhookForPhoneNumber

public createWebhookForPhoneNumber(string $phone_number_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhookForPhoneNumber'][0] ]) : WebhookDto

Attach a WebHook URL to a phone number

Parameters
$phone_number_id : string

phone_number_id (required)

$create_webhook_options : CreateWebhookOptions

create_webhook_options (required)

$contentType : string = self::contentTypes['createWebhookForPhoneNumber'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhookForPhoneNumber'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookDto

createWebhookForPhoneNumberAsync()

Operation createWebhookForPhoneNumberAsync

public createWebhookForPhoneNumberAsync(string $phone_number_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhookForPhoneNumber'][0] ]) : PromiseInterface

Attach a WebHook URL to a phone number

Parameters
$phone_number_id : string

(required)

$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createWebhookForPhoneNumber'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhookForPhoneNumber'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createWebhookForPhoneNumberAsyncWithHttpInfo()

Operation createWebhookForPhoneNumberAsyncWithHttpInfo

public createWebhookForPhoneNumberAsyncWithHttpInfo(string $phone_number_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhookForPhoneNumber'][0] ]) : PromiseInterface

Attach a WebHook URL to a phone number

Parameters
$phone_number_id : string

(required)

$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createWebhookForPhoneNumber'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhookForPhoneNumber'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createWebhookForPhoneNumberRequest()

Create request for operation 'createWebhookForPhoneNumber'

public createWebhookForPhoneNumberRequest(string $phone_number_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhookForPhoneNumber'][0] ]) : Request
Parameters
$phone_number_id : string

(required)

$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createWebhookForPhoneNumber'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhookForPhoneNumber'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createWebhookForPhoneNumberWithHttpInfo()

Operation createWebhookForPhoneNumberWithHttpInfo

public createWebhookForPhoneNumberWithHttpInfo(string $phone_number_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhookForPhoneNumber'][0] ]) : array<string|int, mixed>

Attach a WebHook URL to a phone number

Parameters
$phone_number_id : string

(required)

$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createWebhookForPhoneNumber'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhookForPhoneNumber'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

createWebhookRequest()

Create request for operation 'createWebhook'

public createWebhookRequest(string $inbox_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhook'][0] ]) : Request
Parameters
$inbox_id : string

(required)

$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createWebhookWithHttpInfo()

Operation createWebhookWithHttpInfo

public createWebhookWithHttpInfo(string $inbox_id, CreateWebhookOptions $create_webhook_options[, string $contentType = self::contentTypes['createWebhook'][0] ]) : array<string|int, mixed>

Attach a WebHook URL to an inbox

Parameters
$inbox_id : string

(required)

$create_webhook_options : CreateWebhookOptions

(required)

$contentType : string = self::contentTypes['createWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['createWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

deleteAllWebhooks()

Operation deleteAllWebhooks

public deleteAllWebhooks([DateTime $before = null ][, string $contentType = self::contentTypes['deleteAllWebhooks'][0] ]) : void

Delete all webhooks

Parameters
$before : DateTime = null

before (optional)

$contentType : string = self::contentTypes['deleteAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAllWebhooks'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteAllWebhooksAsync()

Operation deleteAllWebhooksAsync

public deleteAllWebhooksAsync([DateTime $before = null ][, string $contentType = self::contentTypes['deleteAllWebhooks'][0] ]) : PromiseInterface

Delete all webhooks

Parameters
$before : DateTime = null

before (optional)

$contentType : string = self::contentTypes['deleteAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAllWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllWebhooksAsyncWithHttpInfo()

Operation deleteAllWebhooksAsyncWithHttpInfo

public deleteAllWebhooksAsyncWithHttpInfo([DateTime $before = null ][, string $contentType = self::contentTypes['deleteAllWebhooks'][0] ]) : PromiseInterface

Delete all webhooks

Parameters
$before : DateTime = null

before (optional)

$contentType : string = self::contentTypes['deleteAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAllWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteAllWebhooksRequest()

Create request for operation 'deleteAllWebhooks'

public deleteAllWebhooksRequest([DateTime $before = null ][, string $contentType = self::contentTypes['deleteAllWebhooks'][0] ]) : Request
Parameters
$before : DateTime = null

before (optional)

$contentType : string = self::contentTypes['deleteAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAllWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteAllWebhooksWithHttpInfo()

Operation deleteAllWebhooksWithHttpInfo

public deleteAllWebhooksWithHttpInfo([DateTime $before = null ][, string $contentType = self::contentTypes['deleteAllWebhooks'][0] ]) : array<string|int, mixed>

Delete all webhooks

Parameters
$before : DateTime = null

before (optional)

$contentType : string = self::contentTypes['deleteAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['deleteAllWebhooks'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

deleteWebhook()

Operation deleteWebhook

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

Delete and disable a Webhook for an Inbox

Parameters
$inbox_id : string

inbox_id (required)

$webhook_id : string

webhook_id (required)

$contentType : string = self::contentTypes['deleteWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteWebhookAsync()

Operation deleteWebhookAsync

public deleteWebhookAsync(string $inbox_id, string $webhook_id[, string $contentType = self::contentTypes['deleteWebhook'][0] ]) : PromiseInterface

Delete and disable a Webhook for an Inbox

Parameters
$inbox_id : string

(required)

$webhook_id : string

(required)

$contentType : string = self::contentTypes['deleteWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteWebhookAsyncWithHttpInfo()

Operation deleteWebhookAsyncWithHttpInfo

public deleteWebhookAsyncWithHttpInfo(string $inbox_id, string $webhook_id[, string $contentType = self::contentTypes['deleteWebhook'][0] ]) : PromiseInterface

Delete and disable a Webhook for an Inbox

Parameters
$inbox_id : string

(required)

$webhook_id : string

(required)

$contentType : string = self::contentTypes['deleteWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteWebhookById()

Operation deleteWebhookById

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

Delete a webhook

Parameters
$webhook_id : string

webhook_id (required)

$contentType : string = self::contentTypes['deleteWebhookById'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhookById'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteWebhookByIdAsync()

Operation deleteWebhookByIdAsync

public deleteWebhookByIdAsync(string $webhook_id[, string $contentType = self::contentTypes['deleteWebhookById'][0] ]) : PromiseInterface

Delete a webhook

Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['deleteWebhookById'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhookById'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteWebhookByIdAsyncWithHttpInfo()

Operation deleteWebhookByIdAsyncWithHttpInfo

public deleteWebhookByIdAsyncWithHttpInfo(string $webhook_id[, string $contentType = self::contentTypes['deleteWebhookById'][0] ]) : PromiseInterface

Delete a webhook

Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['deleteWebhookById'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhookById'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteWebhookByIdRequest()

Create request for operation 'deleteWebhookById'

public deleteWebhookByIdRequest(string $webhook_id[, string $contentType = self::contentTypes['deleteWebhookById'][0] ]) : Request
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['deleteWebhookById'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhookById'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteWebhookByIdWithHttpInfo()

Operation deleteWebhookByIdWithHttpInfo

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

Delete a webhook

Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['deleteWebhookById'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhookById'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

deleteWebhookRequest()

Create request for operation 'deleteWebhook'

public deleteWebhookRequest(string $inbox_id, string $webhook_id[, string $contentType = self::contentTypes['deleteWebhook'][0] ]) : Request
Parameters
$inbox_id : string

(required)

$webhook_id : string

(required)

$contentType : string = self::contentTypes['deleteWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteWebhookWithHttpInfo()

Operation deleteWebhookWithHttpInfo

public deleteWebhookWithHttpInfo(string $inbox_id, string $webhook_id[, string $contentType = self::contentTypes['deleteWebhook'][0] ]) : array<string|int, mixed>

Delete and disable a Webhook for an Inbox

Parameters
$inbox_id : string

(required)

$webhook_id : string

(required)

$contentType : string = self::contentTypes['deleteWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['deleteWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getAllAccountWebhooks()

Operation getAllAccountWebhooks

public getAllAccountWebhooks(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $event_type = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllAccountWebhooks'][0] ]) : PageWebhookProjection

List account webhooks Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$event_type : string = null

Optional event type (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllAccountWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllAccountWebhooks'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageWebhookProjection

getAllAccountWebhooksAsync()

Operation getAllAccountWebhooksAsync

public getAllAccountWebhooksAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $event_type = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllAccountWebhooks'][0] ]) : PromiseInterface

List account webhooks Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$event_type : string = null

Optional event type (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllAccountWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllAccountWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllAccountWebhooksAsyncWithHttpInfo()

Operation getAllAccountWebhooksAsyncWithHttpInfo

public getAllAccountWebhooksAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $event_type = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllAccountWebhooks'][0] ]) : PromiseInterface

List account webhooks Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$event_type : string = null

Optional event type (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllAccountWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllAccountWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllAccountWebhooksRequest()

Create request for operation 'getAllAccountWebhooks'

public getAllAccountWebhooksRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $event_type = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllAccountWebhooks'][0] ]) : Request
Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$event_type : string = null

Optional event type (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllAccountWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllAccountWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAllAccountWebhooksWithHttpInfo()

Operation getAllAccountWebhooksWithHttpInfo

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

List account webhooks Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$event_type : string = null

Optional event type (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllAccountWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllAccountWebhooks'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getAllWebhookResults()

Operation getAllWebhookResults

public getAllWebhookResults(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getAllWebhookResults'][0] ]) : PageWebhookResult

Get results for all webhooks

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getAllWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhookResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageWebhookResult

getAllWebhookResultsAsync()

Operation getAllWebhookResultsAsync

public getAllWebhookResultsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getAllWebhookResults'][0] ]) : PromiseInterface

Get results for all webhooks

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getAllWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhookResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllWebhookResultsAsyncWithHttpInfo()

Operation getAllWebhookResultsAsyncWithHttpInfo

public getAllWebhookResultsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getAllWebhookResults'][0] ]) : PromiseInterface

Get results for all webhooks

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getAllWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhookResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllWebhookResultsRequest()

Create request for operation 'getAllWebhookResults'

public getAllWebhookResultsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getAllWebhookResults'][0] ]) : Request
Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getAllWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhookResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAllWebhookResultsWithHttpInfo()

Operation getAllWebhookResultsWithHttpInfo

public getAllWebhookResultsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getAllWebhookResults'][0] ]) : array<string|int, mixed>

Get results for all webhooks

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getAllWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhookResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getAllWebhooks()

Operation getAllWebhooks

public getAllWebhooks(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, string $inbox_id = null ][, string $phone_id = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllWebhooks'][0] ]) : PageWebhookProjection

List Webhooks Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$inbox_id : string = null

Filter by inboxId (optional)

$phone_id : string = null

Filter by phoneId (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhooks'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageWebhookProjection

getAllWebhooksAsync()

Operation getAllWebhooksAsync

public getAllWebhooksAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, string $inbox_id = null ][, string $phone_id = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllWebhooks'][0] ]) : PromiseInterface

List Webhooks Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$inbox_id : string = null

Filter by inboxId (optional)

$phone_id : string = null

Filter by phoneId (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllWebhooksAsyncWithHttpInfo()

Operation getAllWebhooksAsyncWithHttpInfo

public getAllWebhooksAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, string $inbox_id = null ][, string $phone_id = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllWebhooks'][0] ]) : PromiseInterface

List Webhooks Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$inbox_id : string = null

Filter by inboxId (optional)

$phone_id : string = null

Filter by phoneId (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllWebhooksRequest()

Create request for operation 'getAllWebhooks'

public getAllWebhooksRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, string $inbox_id = null ][, string $phone_id = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllWebhooks'][0] ]) : Request
Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$inbox_id : string = null

Filter by inboxId (optional)

$phone_id : string = null

Filter by phoneId (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAllWebhooksWithHttpInfo()

Operation getAllWebhooksWithHttpInfo

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

List Webhooks Paginated

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size for paginated result list. (optional, default to 20)

$sort : string = 'DESC'

Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$inbox_id : string = null

Filter by inboxId (optional)

$phone_id : string = null

Filter by phoneId (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getAllWebhooks'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int

Host index

getInboxWebhooksPaginated()

Operation getInboxWebhooksPaginated

public getInboxWebhooksPaginated(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxWebhooksPaginated'][0] ]) : PageWebhookProjection

Get paginated webhooks for an Inbox

Parameters
$inbox_id : string

inbox_id (required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getInboxWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getInboxWebhooksPaginated'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageWebhookProjection

getInboxWebhooksPaginatedAsync()

Operation getInboxWebhooksPaginatedAsync

public getInboxWebhooksPaginatedAsync(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxWebhooksPaginated'][0] ]) : PromiseInterface

Get paginated webhooks for an Inbox

Parameters
$inbox_id : string

(required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getInboxWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getInboxWebhooksPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxWebhooksPaginatedAsyncWithHttpInfo()

Operation getInboxWebhooksPaginatedAsyncWithHttpInfo

public getInboxWebhooksPaginatedAsyncWithHttpInfo(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxWebhooksPaginated'][0] ]) : PromiseInterface

Get paginated webhooks for an Inbox

Parameters
$inbox_id : string

(required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getInboxWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getInboxWebhooksPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getInboxWebhooksPaginatedRequest()

Create request for operation 'getInboxWebhooksPaginated'

public getInboxWebhooksPaginatedRequest(string $inbox_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getInboxWebhooksPaginated'][0] ]) : Request
Parameters
$inbox_id : string

(required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getInboxWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getInboxWebhooksPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getInboxWebhooksPaginatedWithHttpInfo()

Operation getInboxWebhooksPaginatedWithHttpInfo

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

Get paginated webhooks for an Inbox

Parameters
$inbox_id : string

(required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getInboxWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getInboxWebhooksPaginated'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getJsonSchemaForWebhookEvent()

Operation getJsonSchemaForWebhookEvent

public getJsonSchemaForWebhookEvent(string $event[, string $contentType = self::contentTypes['getJsonSchemaForWebhookEvent'][0] ]) : JSONSchemaDto
Parameters
$event : string

event (required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookEvent'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
JSONSchemaDto

getJsonSchemaForWebhookEventAsync()

Operation getJsonSchemaForWebhookEventAsync

public getJsonSchemaForWebhookEventAsync(string $event[, string $contentType = self::contentTypes['getJsonSchemaForWebhookEvent'][0] ]) : PromiseInterface
Parameters
$event : string

(required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookEvent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getJsonSchemaForWebhookEventAsyncWithHttpInfo()

Operation getJsonSchemaForWebhookEventAsyncWithHttpInfo

public getJsonSchemaForWebhookEventAsyncWithHttpInfo(string $event[, string $contentType = self::contentTypes['getJsonSchemaForWebhookEvent'][0] ]) : PromiseInterface
Parameters
$event : string

(required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookEvent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getJsonSchemaForWebhookEventRequest()

Create request for operation 'getJsonSchemaForWebhookEvent'

public getJsonSchemaForWebhookEventRequest(string $event[, string $contentType = self::contentTypes['getJsonSchemaForWebhookEvent'][0] ]) : Request
Parameters
$event : string

(required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookEvent'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getJsonSchemaForWebhookEventWithHttpInfo()

Operation getJsonSchemaForWebhookEventWithHttpInfo

public getJsonSchemaForWebhookEventWithHttpInfo(string $event[, string $contentType = self::contentTypes['getJsonSchemaForWebhookEvent'][0] ]) : array<string|int, mixed>
Parameters
$event : string

(required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookEvent'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookEvent'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getJsonSchemaForWebhookPayload()

Operation getJsonSchemaForWebhookPayload

public getJsonSchemaForWebhookPayload(string $webhook_id[, string $contentType = self::contentTypes['getJsonSchemaForWebhookPayload'][0] ]) : JSONSchemaDto
Parameters
$webhook_id : string

webhook_id (required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookPayload'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
JSONSchemaDto

getJsonSchemaForWebhookPayloadAsync()

Operation getJsonSchemaForWebhookPayloadAsync

public getJsonSchemaForWebhookPayloadAsync(string $webhook_id[, string $contentType = self::contentTypes['getJsonSchemaForWebhookPayload'][0] ]) : PromiseInterface
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookPayload'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getJsonSchemaForWebhookPayloadAsyncWithHttpInfo()

Operation getJsonSchemaForWebhookPayloadAsyncWithHttpInfo

public getJsonSchemaForWebhookPayloadAsyncWithHttpInfo(string $webhook_id[, string $contentType = self::contentTypes['getJsonSchemaForWebhookPayload'][0] ]) : PromiseInterface
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookPayload'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getJsonSchemaForWebhookPayloadRequest()

Create request for operation 'getJsonSchemaForWebhookPayload'

public getJsonSchemaForWebhookPayloadRequest(string $webhook_id[, string $contentType = self::contentTypes['getJsonSchemaForWebhookPayload'][0] ]) : Request
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookPayload'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getJsonSchemaForWebhookPayloadWithHttpInfo()

Operation getJsonSchemaForWebhookPayloadWithHttpInfo

public getJsonSchemaForWebhookPayloadWithHttpInfo(string $webhook_id[, string $contentType = self::contentTypes['getJsonSchemaForWebhookPayload'][0] ]) : array<string|int, mixed>
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getJsonSchemaForWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getJsonSchemaForWebhookPayload'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getPhoneNumberWebhooksPaginated()

Operation getPhoneNumberWebhooksPaginated

public getPhoneNumberWebhooksPaginated(string $phone_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumberWebhooksPaginated'][0] ]) : PageWebhookProjection

Get paginated webhooks for a phone number

Parameters
$phone_id : string

phone_id (required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getPhoneNumberWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getPhoneNumberWebhooksPaginated'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageWebhookProjection

getPhoneNumberWebhooksPaginatedAsync()

Operation getPhoneNumberWebhooksPaginatedAsync

public getPhoneNumberWebhooksPaginatedAsync(string $phone_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumberWebhooksPaginated'][0] ]) : PromiseInterface

Get paginated webhooks for a phone number

Parameters
$phone_id : string

(required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getPhoneNumberWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getPhoneNumberWebhooksPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getPhoneNumberWebhooksPaginatedAsyncWithHttpInfo()

Operation getPhoneNumberWebhooksPaginatedAsyncWithHttpInfo

public getPhoneNumberWebhooksPaginatedAsyncWithHttpInfo(string $phone_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumberWebhooksPaginated'][0] ]) : PromiseInterface

Get paginated webhooks for a phone number

Parameters
$phone_id : string

(required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getPhoneNumberWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getPhoneNumberWebhooksPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getPhoneNumberWebhooksPaginatedRequest()

Create request for operation 'getPhoneNumberWebhooksPaginated'

public getPhoneNumberWebhooksPaginatedRequest(string $phone_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumberWebhooksPaginated'][0] ]) : Request
Parameters
$phone_id : string

(required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getPhoneNumberWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getPhoneNumberWebhooksPaginated'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getPhoneNumberWebhooksPaginatedWithHttpInfo()

Operation getPhoneNumberWebhooksPaginatedWithHttpInfo

public getPhoneNumberWebhooksPaginatedWithHttpInfo(string $phone_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getPhoneNumberWebhooksPaginated'][0] ]) : array<string|int, mixed>

Get paginated webhooks for a phone number

Parameters
$phone_id : string

(required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getPhoneNumberWebhooksPaginated'][0]

The value for the Content-Type header. Check self::contentTypes['getPhoneNumberWebhooksPaginated'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayload()

Operation getTestWebhookPayload

public getTestWebhookPayload([string $event_name = null ][, string $contentType = self::contentTypes['getTestWebhookPayload'][0] ]) : AbstractWebhookPayload
Parameters
$event_name : string = null

event_name (optional)

$contentType : string = self::contentTypes['getTestWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayload'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AbstractWebhookPayload

getTestWebhookPayloadAsync()

Operation getTestWebhookPayloadAsync

public getTestWebhookPayloadAsync([string $event_name = null ][, string $contentType = self::contentTypes['getTestWebhookPayload'][0] ]) : PromiseInterface
Parameters
$event_name : string = null

(optional)

$contentType : string = self::contentTypes['getTestWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayload'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadAsyncWithHttpInfo()

Operation getTestWebhookPayloadAsyncWithHttpInfo

public getTestWebhookPayloadAsyncWithHttpInfo([string $event_name = null ][, string $contentType = self::contentTypes['getTestWebhookPayload'][0] ]) : PromiseInterface
Parameters
$event_name : string = null

(optional)

$contentType : string = self::contentTypes['getTestWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayload'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadBounce()

Operation getTestWebhookPayloadBounce

public getTestWebhookPayloadBounce([string $contentType = self::contentTypes['getTestWebhookPayloadBounce'][0] ]) : WebhookBouncePayload
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadBounce'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounce'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookBouncePayload

getTestWebhookPayloadBounceAsync()

Operation getTestWebhookPayloadBounceAsync

public getTestWebhookPayloadBounceAsync([string $contentType = self::contentTypes['getTestWebhookPayloadBounce'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadBounce'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounce'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadBounceAsyncWithHttpInfo()

Operation getTestWebhookPayloadBounceAsyncWithHttpInfo

public getTestWebhookPayloadBounceAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadBounce'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadBounce'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounce'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadBounceRecipient()

Operation getTestWebhookPayloadBounceRecipient

public getTestWebhookPayloadBounceRecipient([string $contentType = self::contentTypes['getTestWebhookPayloadBounceRecipient'][0] ]) : WebhookBounceRecipientPayload
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadBounceRecipient'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounceRecipient'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookBounceRecipientPayload

getTestWebhookPayloadBounceRecipientAsync()

Operation getTestWebhookPayloadBounceRecipientAsync

public getTestWebhookPayloadBounceRecipientAsync([string $contentType = self::contentTypes['getTestWebhookPayloadBounceRecipient'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadBounceRecipient'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounceRecipient'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadBounceRecipientAsyncWithHttpInfo()

Operation getTestWebhookPayloadBounceRecipientAsyncWithHttpInfo

public getTestWebhookPayloadBounceRecipientAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadBounceRecipient'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadBounceRecipient'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounceRecipient'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadBounceRecipientRequest()

Create request for operation 'getTestWebhookPayloadBounceRecipient'

public getTestWebhookPayloadBounceRecipientRequest([string $contentType = self::contentTypes['getTestWebhookPayloadBounceRecipient'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadBounceRecipient'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounceRecipient'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadBounceRecipientWithHttpInfo()

Operation getTestWebhookPayloadBounceRecipientWithHttpInfo

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

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounceRecipient'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadBounceRequest()

Create request for operation 'getTestWebhookPayloadBounce'

public getTestWebhookPayloadBounceRequest([string $contentType = self::contentTypes['getTestWebhookPayloadBounce'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadBounce'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounce'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadBounceWithHttpInfo()

Operation getTestWebhookPayloadBounceWithHttpInfo

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

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadBounce'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadDeliveryStatus()

Operation getTestWebhookPayloadDeliveryStatus

public getTestWebhookPayloadDeliveryStatus([string $contentType = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0] ]) : WebhookDeliveryStatusPayload

Get webhook test payload for delivery status event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadDeliveryStatus'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookDeliveryStatusPayload

getTestWebhookPayloadDeliveryStatusAsync()

Operation getTestWebhookPayloadDeliveryStatusAsync

public getTestWebhookPayloadDeliveryStatusAsync([string $contentType = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0] ]) : PromiseInterface

Get webhook test payload for delivery status event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadDeliveryStatus'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadDeliveryStatusAsyncWithHttpInfo()

Operation getTestWebhookPayloadDeliveryStatusAsyncWithHttpInfo

public getTestWebhookPayloadDeliveryStatusAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0] ]) : PromiseInterface

Get webhook test payload for delivery status event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadDeliveryStatus'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadDeliveryStatusRequest()

Create request for operation 'getTestWebhookPayloadDeliveryStatus'

public getTestWebhookPayloadDeliveryStatusRequest([string $contentType = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadDeliveryStatus'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadDeliveryStatusWithHttpInfo()

Operation getTestWebhookPayloadDeliveryStatusWithHttpInfo

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

Get webhook test payload for delivery status event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadDeliveryStatus'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadDeliveryStatus'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadEmailOpened()

Operation getTestWebhookPayloadEmailOpened

public getTestWebhookPayloadEmailOpened([string $contentType = self::contentTypes['getTestWebhookPayloadEmailOpened'][0] ]) : WebhookEmailOpenedPayload
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadEmailOpened'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailOpened'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookEmailOpenedPayload

getTestWebhookPayloadEmailOpenedAsync()

Operation getTestWebhookPayloadEmailOpenedAsync

public getTestWebhookPayloadEmailOpenedAsync([string $contentType = self::contentTypes['getTestWebhookPayloadEmailOpened'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadEmailOpened'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailOpened'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadEmailOpenedAsyncWithHttpInfo()

Operation getTestWebhookPayloadEmailOpenedAsyncWithHttpInfo

public getTestWebhookPayloadEmailOpenedAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadEmailOpened'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadEmailOpened'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailOpened'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadEmailOpenedRequest()

Create request for operation 'getTestWebhookPayloadEmailOpened'

public getTestWebhookPayloadEmailOpenedRequest([string $contentType = self::contentTypes['getTestWebhookPayloadEmailOpened'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadEmailOpened'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailOpened'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadEmailOpenedWithHttpInfo()

Operation getTestWebhookPayloadEmailOpenedWithHttpInfo

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

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailOpened'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadEmailRead()

Operation getTestWebhookPayloadEmailRead

public getTestWebhookPayloadEmailRead([string $contentType = self::contentTypes['getTestWebhookPayloadEmailRead'][0] ]) : WebhookEmailReadPayload
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadEmailRead'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailRead'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookEmailReadPayload

getTestWebhookPayloadEmailReadAsync()

Operation getTestWebhookPayloadEmailReadAsync

public getTestWebhookPayloadEmailReadAsync([string $contentType = self::contentTypes['getTestWebhookPayloadEmailRead'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadEmailRead'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailRead'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadEmailReadAsyncWithHttpInfo()

Operation getTestWebhookPayloadEmailReadAsyncWithHttpInfo

public getTestWebhookPayloadEmailReadAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadEmailRead'][0] ]) : PromiseInterface
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadEmailRead'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailRead'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadEmailReadRequest()

Create request for operation 'getTestWebhookPayloadEmailRead'

public getTestWebhookPayloadEmailReadRequest([string $contentType = self::contentTypes['getTestWebhookPayloadEmailRead'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadEmailRead'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailRead'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadEmailReadWithHttpInfo()

Operation getTestWebhookPayloadEmailReadWithHttpInfo

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

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadEmailRead'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadForWebhook()

Operation getTestWebhookPayloadForWebhook

public getTestWebhookPayloadForWebhook(string $webhook_id[, string $contentType = self::contentTypes['getTestWebhookPayloadForWebhook'][0] ]) : AbstractWebhookPayload
Parameters
$webhook_id : string

webhook_id (required)

$contentType : string = self::contentTypes['getTestWebhookPayloadForWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadForWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
AbstractWebhookPayload

getTestWebhookPayloadForWebhookAsync()

Operation getTestWebhookPayloadForWebhookAsync

public getTestWebhookPayloadForWebhookAsync(string $webhook_id[, string $contentType = self::contentTypes['getTestWebhookPayloadForWebhook'][0] ]) : PromiseInterface
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getTestWebhookPayloadForWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadForWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadForWebhookAsyncWithHttpInfo()

Operation getTestWebhookPayloadForWebhookAsyncWithHttpInfo

public getTestWebhookPayloadForWebhookAsyncWithHttpInfo(string $webhook_id[, string $contentType = self::contentTypes['getTestWebhookPayloadForWebhook'][0] ]) : PromiseInterface
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getTestWebhookPayloadForWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadForWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadForWebhookRequest()

Create request for operation 'getTestWebhookPayloadForWebhook'

public getTestWebhookPayloadForWebhookRequest(string $webhook_id[, string $contentType = self::contentTypes['getTestWebhookPayloadForWebhook'][0] ]) : Request
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getTestWebhookPayloadForWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadForWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadForWebhookWithHttpInfo()

Operation getTestWebhookPayloadForWebhookWithHttpInfo

public getTestWebhookPayloadForWebhookWithHttpInfo(string $webhook_id[, string $contentType = self::contentTypes['getTestWebhookPayloadForWebhook'][0] ]) : array<string|int, mixed>
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getTestWebhookPayloadForWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadForWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadNewAttachment()

Operation getTestWebhookPayloadNewAttachment

public getTestWebhookPayloadNewAttachment([string $contentType = self::contentTypes['getTestWebhookPayloadNewAttachment'][0] ]) : WebhookNewAttachmentPayload

Get webhook test payload for new attachment event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewAttachment'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewAttachment'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookNewAttachmentPayload

getTestWebhookPayloadNewAttachmentAsync()

Operation getTestWebhookPayloadNewAttachmentAsync

public getTestWebhookPayloadNewAttachmentAsync([string $contentType = self::contentTypes['getTestWebhookPayloadNewAttachment'][0] ]) : PromiseInterface

Get webhook test payload for new attachment event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewAttachment'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewAttachment'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadNewAttachmentAsyncWithHttpInfo()

Operation getTestWebhookPayloadNewAttachmentAsyncWithHttpInfo

public getTestWebhookPayloadNewAttachmentAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadNewAttachment'][0] ]) : PromiseInterface

Get webhook test payload for new attachment event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewAttachment'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewAttachment'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadNewAttachmentRequest()

Create request for operation 'getTestWebhookPayloadNewAttachment'

public getTestWebhookPayloadNewAttachmentRequest([string $contentType = self::contentTypes['getTestWebhookPayloadNewAttachment'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewAttachment'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewAttachment'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadNewAttachmentWithHttpInfo()

Operation getTestWebhookPayloadNewAttachmentWithHttpInfo

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

Get webhook test payload for new attachment event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewAttachment'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewAttachment'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadNewContact()

Operation getTestWebhookPayloadNewContact

public getTestWebhookPayloadNewContact([string $contentType = self::contentTypes['getTestWebhookPayloadNewContact'][0] ]) : WebhookNewContactPayload

Get webhook test payload for new contact event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewContact'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewContact'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookNewContactPayload

getTestWebhookPayloadNewContactAsync()

Operation getTestWebhookPayloadNewContactAsync

public getTestWebhookPayloadNewContactAsync([string $contentType = self::contentTypes['getTestWebhookPayloadNewContact'][0] ]) : PromiseInterface

Get webhook test payload for new contact event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewContact'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadNewContactAsyncWithHttpInfo()

Operation getTestWebhookPayloadNewContactAsyncWithHttpInfo

public getTestWebhookPayloadNewContactAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadNewContact'][0] ]) : PromiseInterface

Get webhook test payload for new contact event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewContact'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadNewContactRequest()

Create request for operation 'getTestWebhookPayloadNewContact'

public getTestWebhookPayloadNewContactRequest([string $contentType = self::contentTypes['getTestWebhookPayloadNewContact'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewContact'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadNewContactWithHttpInfo()

Operation getTestWebhookPayloadNewContactWithHttpInfo

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

Get webhook test payload for new contact event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewContact'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewContact'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadNewEmail()

Operation getTestWebhookPayloadNewEmail

public getTestWebhookPayloadNewEmail([string $contentType = self::contentTypes['getTestWebhookPayloadNewEmail'][0] ]) : WebhookNewEmailPayload

Get webhook test payload for new email event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewEmail'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewEmail'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookNewEmailPayload

getTestWebhookPayloadNewEmailAsync()

Operation getTestWebhookPayloadNewEmailAsync

public getTestWebhookPayloadNewEmailAsync([string $contentType = self::contentTypes['getTestWebhookPayloadNewEmail'][0] ]) : PromiseInterface

Get webhook test payload for new email event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewEmail'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewEmail'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadNewEmailAsyncWithHttpInfo()

Operation getTestWebhookPayloadNewEmailAsyncWithHttpInfo

public getTestWebhookPayloadNewEmailAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadNewEmail'][0] ]) : PromiseInterface

Get webhook test payload for new email event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewEmail'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewEmail'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadNewEmailRequest()

Create request for operation 'getTestWebhookPayloadNewEmail'

public getTestWebhookPayloadNewEmailRequest([string $contentType = self::contentTypes['getTestWebhookPayloadNewEmail'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewEmail'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewEmail'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadNewEmailWithHttpInfo()

Operation getTestWebhookPayloadNewEmailWithHttpInfo

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

Get webhook test payload for new email event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewEmail'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewEmail'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadNewSms()

Operation getTestWebhookPayloadNewSms

public getTestWebhookPayloadNewSms([string $contentType = self::contentTypes['getTestWebhookPayloadNewSms'][0] ]) : WebhookNewSmsPayload

Get webhook test payload for new sms event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewSms'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewSms'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookNewSmsPayload

getTestWebhookPayloadNewSmsAsync()

Operation getTestWebhookPayloadNewSmsAsync

public getTestWebhookPayloadNewSmsAsync([string $contentType = self::contentTypes['getTestWebhookPayloadNewSms'][0] ]) : PromiseInterface

Get webhook test payload for new sms event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewSms'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewSms'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadNewSmsAsyncWithHttpInfo()

Operation getTestWebhookPayloadNewSmsAsyncWithHttpInfo

public getTestWebhookPayloadNewSmsAsyncWithHttpInfo([string $contentType = self::contentTypes['getTestWebhookPayloadNewSms'][0] ]) : PromiseInterface

Get webhook test payload for new sms event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewSms'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewSms'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getTestWebhookPayloadNewSmsRequest()

Create request for operation 'getTestWebhookPayloadNewSms'

public getTestWebhookPayloadNewSmsRequest([string $contentType = self::contentTypes['getTestWebhookPayloadNewSms'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewSms'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewSms'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadNewSmsWithHttpInfo()

Operation getTestWebhookPayloadNewSmsWithHttpInfo

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

Get webhook test payload for new sms event

Parameters
$contentType : string = self::contentTypes['getTestWebhookPayloadNewSms'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayloadNewSms'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getTestWebhookPayloadRequest()

Create request for operation 'getTestWebhookPayload'

public getTestWebhookPayloadRequest([string $event_name = null ][, string $contentType = self::contentTypes['getTestWebhookPayload'][0] ]) : Request
Parameters
$event_name : string = null

(optional)

$contentType : string = self::contentTypes['getTestWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayload'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getTestWebhookPayloadWithHttpInfo()

Operation getTestWebhookPayloadWithHttpInfo

public getTestWebhookPayloadWithHttpInfo([string $event_name = null ][, string $contentType = self::contentTypes['getTestWebhookPayload'][0] ]) : array<string|int, mixed>
Parameters
$event_name : string = null

(optional)

$contentType : string = self::contentTypes['getTestWebhookPayload'][0]

The value for the Content-Type header. Check self::contentTypes['getTestWebhookPayload'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getWebhook()

Operation getWebhook

public getWebhook(string $webhook_id[, string $contentType = self::contentTypes['getWebhook'][0] ]) : WebhookDto

Get a webhook

Parameters
$webhook_id : string

webhook_id (required)

$contentType : string = self::contentTypes['getWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookDto

getWebhookAsync()

Operation getWebhookAsync

public getWebhookAsync(string $webhook_id[, string $contentType = self::contentTypes['getWebhook'][0] ]) : PromiseInterface

Get a webhook

Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookAsyncWithHttpInfo()

Operation getWebhookAsyncWithHttpInfo

public getWebhookAsyncWithHttpInfo(string $webhook_id[, string $contentType = self::contentTypes['getWebhook'][0] ]) : PromiseInterface

Get a webhook

Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookRequest()

Create request for operation 'getWebhook'

public getWebhookRequest(string $webhook_id[, string $contentType = self::contentTypes['getWebhook'][0] ]) : Request
Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhook'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getWebhookResult()

Operation getWebhookResult

public getWebhookResult(string $webhook_result_id[, string $contentType = self::contentTypes['getWebhookResult'][0] ]) : WebhookResultDto

Get a webhook result for a webhook

Parameters
$webhook_result_id : string

Webhook Result ID (required)

$contentType : string = self::contentTypes['getWebhookResult'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResult'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
WebhookResultDto

getWebhookResultAsync()

Operation getWebhookResultAsync

public getWebhookResultAsync(string $webhook_result_id[, string $contentType = self::contentTypes['getWebhookResult'][0] ]) : PromiseInterface

Get a webhook result for a webhook

Parameters
$webhook_result_id : string

Webhook Result ID (required)

$contentType : string = self::contentTypes['getWebhookResult'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResult'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookResultAsyncWithHttpInfo()

Operation getWebhookResultAsyncWithHttpInfo

public getWebhookResultAsyncWithHttpInfo(string $webhook_result_id[, string $contentType = self::contentTypes['getWebhookResult'][0] ]) : PromiseInterface

Get a webhook result for a webhook

Parameters
$webhook_result_id : string

Webhook Result ID (required)

$contentType : string = self::contentTypes['getWebhookResult'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResult'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookResultRequest()

Create request for operation 'getWebhookResult'

public getWebhookResultRequest(string $webhook_result_id[, string $contentType = self::contentTypes['getWebhookResult'][0] ]) : Request
Parameters
$webhook_result_id : string

Webhook Result ID (required)

$contentType : string = self::contentTypes['getWebhookResult'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResult'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getWebhookResults()

Operation getWebhookResults

public getWebhookResults(string $webhook_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getWebhookResults'][0] ]) : PageWebhookResult

Get a webhook results for a webhook

Parameters
$webhook_id : string

ID of webhook to get results for (required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageWebhookResult

getWebhookResultsAsync()

Operation getWebhookResultsAsync

public getWebhookResultsAsync(string $webhook_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getWebhookResults'][0] ]) : PromiseInterface

Get a webhook results for a webhook

Parameters
$webhook_id : string

ID of webhook to get results for (required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookResultsAsyncWithHttpInfo()

Operation getWebhookResultsAsyncWithHttpInfo

public getWebhookResultsAsyncWithHttpInfo(string $webhook_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getWebhookResults'][0] ]) : PromiseInterface

Get a webhook results for a webhook

Parameters
$webhook_id : string

ID of webhook to get results for (required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookResultsCount()

Operation getWebhookResultsCount

public getWebhookResultsCount(string $webhook_id[, string $contentType = self::contentTypes['getWebhookResultsCount'][0] ]) : CountDto

Get a webhook results count for a webhook

Parameters
$webhook_id : string

ID of webhook to get results for (required)

$contentType : string = self::contentTypes['getWebhookResultsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CountDto

getWebhookResultsCountAsync()

Operation getWebhookResultsCountAsync

public getWebhookResultsCountAsync(string $webhook_id[, string $contentType = self::contentTypes['getWebhookResultsCount'][0] ]) : PromiseInterface

Get a webhook results count for a webhook

Parameters
$webhook_id : string

ID of webhook to get results for (required)

$contentType : string = self::contentTypes['getWebhookResultsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookResultsCountAsyncWithHttpInfo()

Operation getWebhookResultsCountAsyncWithHttpInfo

public getWebhookResultsCountAsyncWithHttpInfo(string $webhook_id[, string $contentType = self::contentTypes['getWebhookResultsCount'][0] ]) : PromiseInterface

Get a webhook results count for a webhook

Parameters
$webhook_id : string

ID of webhook to get results for (required)

$contentType : string = self::contentTypes['getWebhookResultsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookResultsCountRequest()

Create request for operation 'getWebhookResultsCount'

public getWebhookResultsCountRequest(string $webhook_id[, string $contentType = self::contentTypes['getWebhookResultsCount'][0] ]) : Request
Parameters
$webhook_id : string

ID of webhook to get results for (required)

$contentType : string = self::contentTypes['getWebhookResultsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getWebhookResultsCountWithHttpInfo()

Operation getWebhookResultsCountWithHttpInfo

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

Get a webhook results count for a webhook

Parameters
$webhook_id : string

ID of webhook to get results for (required)

$contentType : string = self::contentTypes['getWebhookResultsCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getWebhookResultsRequest()

Create request for operation 'getWebhookResults'

public getWebhookResultsRequest(string $webhook_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getWebhookResults'][0] ]) : Request
Parameters
$webhook_id : string

ID of webhook to get results for (required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResults'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getWebhookResultsUnseenErrorCount()

Operation getWebhookResultsUnseenErrorCount

public getWebhookResultsUnseenErrorCount([string $contentType = self::contentTypes['getWebhookResultsUnseenErrorCount'][0] ]) : UnseenErrorCountDto

Get count of unseen webhook results with error status

Parameters
$contentType : string = self::contentTypes['getWebhookResultsUnseenErrorCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsUnseenErrorCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
UnseenErrorCountDto

getWebhookResultsUnseenErrorCountAsync()

Operation getWebhookResultsUnseenErrorCountAsync

public getWebhookResultsUnseenErrorCountAsync([string $contentType = self::contentTypes['getWebhookResultsUnseenErrorCount'][0] ]) : PromiseInterface

Get count of unseen webhook results with error status

Parameters
$contentType : string = self::contentTypes['getWebhookResultsUnseenErrorCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsUnseenErrorCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookResultsUnseenErrorCountAsyncWithHttpInfo()

Operation getWebhookResultsUnseenErrorCountAsyncWithHttpInfo

public getWebhookResultsUnseenErrorCountAsyncWithHttpInfo([string $contentType = self::contentTypes['getWebhookResultsUnseenErrorCount'][0] ]) : PromiseInterface

Get count of unseen webhook results with error status

Parameters
$contentType : string = self::contentTypes['getWebhookResultsUnseenErrorCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsUnseenErrorCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getWebhookResultsUnseenErrorCountRequest()

Create request for operation 'getWebhookResultsUnseenErrorCount'

public getWebhookResultsUnseenErrorCountRequest([string $contentType = self::contentTypes['getWebhookResultsUnseenErrorCount'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getWebhookResultsUnseenErrorCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsUnseenErrorCount'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getWebhookResultsUnseenErrorCountWithHttpInfo()

Operation getWebhookResultsUnseenErrorCountWithHttpInfo

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

Get count of unseen webhook results with error status

Parameters
$contentType : string = self::contentTypes['getWebhookResultsUnseenErrorCount'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResultsUnseenErrorCount'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getWebhookResultsWithHttpInfo()

Operation getWebhookResultsWithHttpInfo

public getWebhookResultsWithHttpInfo(string $webhook_id, int $page[, int $size = 20 ][, string $sort = 'ASC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $unseen_only = null ][, string $result_type = null ][, string $event_name = null ][, int $min_status_code = null ][, int $max_status_code = null ][, string $inbox_id = null ][, string $sms_id = null ][, string $attachment_id = null ][, string $email_id = null ][, string $phone_id = null ][, string $contentType = self::contentTypes['getWebhookResults'][0] ]) : array<string|int, mixed>

Get a webhook results for a webhook

Parameters
$webhook_id : string

ID of webhook to get results for (required)

$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$search_filter : string = null

Optional search filter (optional)

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$unseen_only : bool = null

Filter for unseen exceptions only (optional)

$result_type : string = null

Filter by result type (optional)

$event_name : string = null

Filter by event name (optional)

$min_status_code : int = null

Minimum response status (optional)

$max_status_code : int = null

Maximum response status (optional)

$inbox_id : string = null

Inbox ID (optional)

$sms_id : string = null

Sms ID (optional)

$attachment_id : string = null

Attachment ID (optional)

$email_id : string = null

Email ID (optional)

$phone_id : string = null

Phone ID (optional)

$contentType : string = self::contentTypes['getWebhookResults'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResults'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getWebhookResultWithHttpInfo()

Operation getWebhookResultWithHttpInfo

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

Get a webhook result for a webhook

Parameters
$webhook_result_id : string

Webhook Result ID (required)

$contentType : string = self::contentTypes['getWebhookResult'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhookResult'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

getWebhooks()

Operation getWebhooks

public getWebhooks(string $inbox_id[, string $contentType = self::contentTypes['getWebhooks'][0] ]) : array<string|int, WebhookDto>

Get all webhooks for an Inbox

Parameters
$inbox_id : string

inbox_id (required)

$contentType : string = self::contentTypes['getWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhooks'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
deprecated
Return values
array<string|int, WebhookDto>

getWebhooksAsync()

Operation getWebhooksAsync

public getWebhooksAsync(string $inbox_id[, string $contentType = self::contentTypes['getWebhooks'][0] ]) : PromiseInterface

Get all webhooks for an Inbox

Parameters
$inbox_id : string

(required)

$contentType : string = self::contentTypes['getWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
deprecated
Return values
PromiseInterface

getWebhooksAsyncWithHttpInfo()

Operation getWebhooksAsyncWithHttpInfo

public getWebhooksAsyncWithHttpInfo(string $inbox_id[, string $contentType = self::contentTypes['getWebhooks'][0] ]) : PromiseInterface

Get all webhooks for an Inbox

Parameters
$inbox_id : string

(required)

$contentType : string = self::contentTypes['getWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
deprecated
Return values
PromiseInterface

getWebhooksRequest()

Create request for operation 'getWebhooks'

public getWebhooksRequest(string $inbox_id[, string $contentType = self::contentTypes['getWebhooks'][0] ]) : Request
Parameters
$inbox_id : string

(required)

$contentType : string = self::contentTypes['getWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhooks'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
deprecated
Return values
Request

getWebhooksWithHttpInfo()

Operation getWebhooksWithHttpInfo

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

Get all webhooks for an Inbox

Parameters
$inbox_id : string

(required)

$contentType : string = self::contentTypes['getWebhooks'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhooks'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
deprecated
Return values
array<string|int, mixed>

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

getWebhookWithHttpInfo()

Operation getWebhookWithHttpInfo

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

Get a webhook

Parameters
$webhook_id : string

(required)

$contentType : string = self::contentTypes['getWebhook'][0]

The value for the Content-Type header. Check self::contentTypes['getWebhook'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

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

redriveAllWebhookResults()

Operation redriveAllWebhookResults

public redriveAllWebhookResults([string $contentType = self::contentTypes['redriveAllWebhookResults'][0] ]) : WebhookRedriveAllResult

Redrive all webhook results that have failed status

Parameters
$contentType : string = self::contentTypes['redriveAllWebhookResults'][0]