Documentation

DevicePreviewsControllerApi
in package

DevicePreviewsControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['cancelDevicePreviewRun' => ['application/json'], 'createDevicePreviewFeedback' => ['application/json'], 'createDevicePreviewFolder' => ['application/json'], 'createDevicePreviewImportAddress' => ['application/json'], 'createDevicePreviewProfile' => ['application/json'], 'createDevicePreviewRun' => ['application/json'], 'createDevicePreviewRunFromFile' => ['multipart/form-data'], 'createDevicePreviewRunFromHtmlImport' => ['application/json'], 'createDevicePreviewRunFromImport' => ['application/json'], 'createDevicePreviewRunFromMultipartImport' => ['multipart/form-data'], 'createDevicePreviewRunFromRawImport' => ['application/json'], 'createDevicePreviewShareLink' => ['application/json'], 'deleteDevicePreviewFolder' => ['application/json'], 'deleteDevicePreviewProfile' => ['application/json'], 'deleteDevicePreviewRun' => ['application/json'], 'deleteDevicePreviewShareLink' => ['application/json'], 'downloadDevicePreviewEmailSubmissionSourceEmail' => ['application/json'], 'downloadDevicePreviewRunSourceEmail' => ['application/json'], 'ensureDevicePreviewRun' => ['application/json'], 'getDevicePreviewEmailDomainOrCreate' => ['application/json'], 'getDevicePreviewEmailRuns' => ['application/json'], 'getDevicePreviewEmailSubmissionSourceEmail' => ['application/json'], 'getDevicePreviewEmailSubmissions' => ['application/json'], 'getDevicePreviewFeedback' => ['application/json'], 'getDevicePreviewFeedbackItems' => ['application/json'], 'getDevicePreviewFolder' => ['application/json'], 'getDevicePreviewFolders' => ['application/json'], 'getDevicePreviewImportAddress' => ['application/json'], 'getDevicePreviewNativeTargetAvailability' => ['application/json'], 'getDevicePreviewProfile' => ['application/json'], 'getDevicePreviewProfiles' => ['application/json'], 'getDevicePreviewRun' => ['application/json'], 'getDevicePreviewRunProviderProgress' => ['application/json'], 'getDevicePreviewRunResults' => ['application/json'], 'getDevicePreviewRunScreenshot' => ['application/json'], 'getDevicePreviewRunSourceEmail' => ['application/json'], 'getDevicePreviewRuns' => ['application/json'], 'getDevicePreviewRunsForAccount' => ['application/json'], 'getDevicePreviewRunsForAccountOffsetPaginated' => ['application/json'], 'getDevicePreviewRunsOffsetPaginated' => ['application/json'], 'getDevicePreviewShareLinks' => ['application/json'], 'getDevicePreviewSharedResult' => ['application/json'], 'getDevicePreviewSharedResultScreenshot' => ['application/json'], 'getDevicePreviewTargets' => ['application/json'], 'moveDevicePreviewRuns' => ['application/json'], 'rerunDevicePreviewTargets' => ['application/json'], 'updateDevicePreviewEmailDomainSubdomain' => ['application/json'], 'updateDevicePreviewFeedback' => ['application/json'], 'updateDevicePreviewFolder' => ['application/json'], 'updateDevicePreviewProfile' => ['application/json'], 'waitForDevicePreviewEmailRuns' => ['application/json'], 'waitForDevicePreviewEmailSubmissions' => ['application/json'], 'waitForDevicePreviewRun' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
cancelDevicePreviewRun()  : CancelDevicePreviewRunResult
Operation cancelDevicePreviewRun
cancelDevicePreviewRunAsync()  : PromiseInterface
Operation cancelDevicePreviewRunAsync
cancelDevicePreviewRunAsyncWithHttpInfo()  : PromiseInterface
Operation cancelDevicePreviewRunAsyncWithHttpInfo
cancelDevicePreviewRunRequest()  : Request
Create request for operation 'cancelDevicePreviewRun'
cancelDevicePreviewRunWithHttpInfo()  : array<string|int, mixed>
Operation cancelDevicePreviewRunWithHttpInfo
createDevicePreviewFeedback()  : DevicePreviewFeedbackDto
Operation createDevicePreviewFeedback
createDevicePreviewFeedbackAsync()  : PromiseInterface
Operation createDevicePreviewFeedbackAsync
createDevicePreviewFeedbackAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewFeedbackAsyncWithHttpInfo
createDevicePreviewFeedbackRequest()  : Request
Create request for operation 'createDevicePreviewFeedback'
createDevicePreviewFeedbackWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewFeedbackWithHttpInfo
createDevicePreviewFolder()  : DevicePreviewFolderDto
Operation createDevicePreviewFolder
createDevicePreviewFolderAsync()  : PromiseInterface
Operation createDevicePreviewFolderAsync
createDevicePreviewFolderAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewFolderAsyncWithHttpInfo
createDevicePreviewFolderRequest()  : Request
Create request for operation 'createDevicePreviewFolder'
createDevicePreviewFolderWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewFolderWithHttpInfo
createDevicePreviewImportAddress()  : DevicePreviewIngestAddressDto
Operation createDevicePreviewImportAddress
createDevicePreviewImportAddressAsync()  : PromiseInterface
Operation createDevicePreviewImportAddressAsync
createDevicePreviewImportAddressAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewImportAddressAsyncWithHttpInfo
createDevicePreviewImportAddressRequest()  : Request
Create request for operation 'createDevicePreviewImportAddress'
createDevicePreviewImportAddressWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewImportAddressWithHttpInfo
createDevicePreviewProfile()  : DevicePreviewProfileDto
Operation createDevicePreviewProfile
createDevicePreviewProfileAsync()  : PromiseInterface
Operation createDevicePreviewProfileAsync
createDevicePreviewProfileAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewProfileAsyncWithHttpInfo
createDevicePreviewProfileRequest()  : Request
Create request for operation 'createDevicePreviewProfile'
createDevicePreviewProfileWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewProfileWithHttpInfo
createDevicePreviewRun()  : CreateDevicePreviewRunResult
Operation createDevicePreviewRun
createDevicePreviewRunAsync()  : PromiseInterface
Operation createDevicePreviewRunAsync
createDevicePreviewRunAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewRunAsyncWithHttpInfo
createDevicePreviewRunFromFile()  : CreateDevicePreviewRunResult
Operation createDevicePreviewRunFromFile
createDevicePreviewRunFromFileAsync()  : PromiseInterface
Operation createDevicePreviewRunFromFileAsync
createDevicePreviewRunFromFileAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewRunFromFileAsyncWithHttpInfo
createDevicePreviewRunFromFileRequest()  : Request
Create request for operation 'createDevicePreviewRunFromFile'
createDevicePreviewRunFromFileWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewRunFromFileWithHttpInfo
createDevicePreviewRunFromHtmlImport()  : CreateDevicePreviewRunResult
Operation createDevicePreviewRunFromHtmlImport
createDevicePreviewRunFromHtmlImportAsync()  : PromiseInterface
Operation createDevicePreviewRunFromHtmlImportAsync
createDevicePreviewRunFromHtmlImportAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewRunFromHtmlImportAsyncWithHttpInfo
createDevicePreviewRunFromHtmlImportRequest()  : Request
Create request for operation 'createDevicePreviewRunFromHtmlImport'
createDevicePreviewRunFromHtmlImportWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewRunFromHtmlImportWithHttpInfo
createDevicePreviewRunFromImport()  : CreateDevicePreviewRunResult
Operation createDevicePreviewRunFromImport
createDevicePreviewRunFromImportAsync()  : PromiseInterface
Operation createDevicePreviewRunFromImportAsync
createDevicePreviewRunFromImportAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewRunFromImportAsyncWithHttpInfo
createDevicePreviewRunFromImportRequest()  : Request
Create request for operation 'createDevicePreviewRunFromImport'
createDevicePreviewRunFromImportWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewRunFromImportWithHttpInfo
createDevicePreviewRunFromMultipartImport()  : CreateDevicePreviewRunResult
Operation createDevicePreviewRunFromMultipartImport
createDevicePreviewRunFromMultipartImportAsync()  : PromiseInterface
Operation createDevicePreviewRunFromMultipartImportAsync
createDevicePreviewRunFromMultipartImportAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewRunFromMultipartImportAsyncWithHttpInfo
createDevicePreviewRunFromMultipartImportRequest()  : Request
Create request for operation 'createDevicePreviewRunFromMultipartImport'
createDevicePreviewRunFromMultipartImportWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewRunFromMultipartImportWithHttpInfo
createDevicePreviewRunFromRawImport()  : CreateDevicePreviewRunResult
Operation createDevicePreviewRunFromRawImport
createDevicePreviewRunFromRawImportAsync()  : PromiseInterface
Operation createDevicePreviewRunFromRawImportAsync
createDevicePreviewRunFromRawImportAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewRunFromRawImportAsyncWithHttpInfo
createDevicePreviewRunFromRawImportRequest()  : Request
Create request for operation 'createDevicePreviewRunFromRawImport'
createDevicePreviewRunFromRawImportWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewRunFromRawImportWithHttpInfo
createDevicePreviewRunRequest()  : Request
Create request for operation 'createDevicePreviewRun'
createDevicePreviewRunWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewRunWithHttpInfo
createDevicePreviewShareLink()  : DevicePreviewShareLinkDto
Operation createDevicePreviewShareLink
createDevicePreviewShareLinkAsync()  : PromiseInterface
Operation createDevicePreviewShareLinkAsync
createDevicePreviewShareLinkAsyncWithHttpInfo()  : PromiseInterface
Operation createDevicePreviewShareLinkAsyncWithHttpInfo
createDevicePreviewShareLinkRequest()  : Request
Create request for operation 'createDevicePreviewShareLink'
createDevicePreviewShareLinkWithHttpInfo()  : array<string|int, mixed>
Operation createDevicePreviewShareLinkWithHttpInfo
deleteDevicePreviewFolder()  : DeleteDevicePreviewFolderResult
Operation deleteDevicePreviewFolder
deleteDevicePreviewFolderAsync()  : PromiseInterface
Operation deleteDevicePreviewFolderAsync
deleteDevicePreviewFolderAsyncWithHttpInfo()  : PromiseInterface
Operation deleteDevicePreviewFolderAsyncWithHttpInfo
deleteDevicePreviewFolderRequest()  : Request
Create request for operation 'deleteDevicePreviewFolder'
deleteDevicePreviewFolderWithHttpInfo()  : array<string|int, mixed>
Operation deleteDevicePreviewFolderWithHttpInfo
deleteDevicePreviewProfile()  : DeleteDevicePreviewProfileResult
Operation deleteDevicePreviewProfile
deleteDevicePreviewProfileAsync()  : PromiseInterface
Operation deleteDevicePreviewProfileAsync
deleteDevicePreviewProfileAsyncWithHttpInfo()  : PromiseInterface
Operation deleteDevicePreviewProfileAsyncWithHttpInfo
deleteDevicePreviewProfileRequest()  : Request
Create request for operation 'deleteDevicePreviewProfile'
deleteDevicePreviewProfileWithHttpInfo()  : array<string|int, mixed>
Operation deleteDevicePreviewProfileWithHttpInfo
deleteDevicePreviewRun()  : DeleteDevicePreviewRunResult
Operation deleteDevicePreviewRun
deleteDevicePreviewRunAsync()  : PromiseInterface
Operation deleteDevicePreviewRunAsync
deleteDevicePreviewRunAsyncWithHttpInfo()  : PromiseInterface
Operation deleteDevicePreviewRunAsyncWithHttpInfo
deleteDevicePreviewRunRequest()  : Request
Create request for operation 'deleteDevicePreviewRun'
deleteDevicePreviewRunWithHttpInfo()  : array<string|int, mixed>
Operation deleteDevicePreviewRunWithHttpInfo
deleteDevicePreviewShareLink()  : DeleteDevicePreviewShareLinkResult
Operation deleteDevicePreviewShareLink
deleteDevicePreviewShareLinkAsync()  : PromiseInterface
Operation deleteDevicePreviewShareLinkAsync
deleteDevicePreviewShareLinkAsyncWithHttpInfo()  : PromiseInterface
Operation deleteDevicePreviewShareLinkAsyncWithHttpInfo
deleteDevicePreviewShareLinkRequest()  : Request
Create request for operation 'deleteDevicePreviewShareLink'
deleteDevicePreviewShareLinkWithHttpInfo()  : array<string|int, mixed>
Operation deleteDevicePreviewShareLinkWithHttpInfo
downloadDevicePreviewEmailSubmissionSourceEmail()  : SplFileObject
Operation downloadDevicePreviewEmailSubmissionSourceEmail
downloadDevicePreviewEmailSubmissionSourceEmailAsync()  : PromiseInterface
Operation downloadDevicePreviewEmailSubmissionSourceEmailAsync
downloadDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo()  : PromiseInterface
Operation downloadDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo
downloadDevicePreviewEmailSubmissionSourceEmailRequest()  : Request
Create request for operation 'downloadDevicePreviewEmailSubmissionSourceEmail'
downloadDevicePreviewEmailSubmissionSourceEmailWithHttpInfo()  : array<string|int, mixed>
Operation downloadDevicePreviewEmailSubmissionSourceEmailWithHttpInfo
downloadDevicePreviewRunSourceEmail()  : SplFileObject
Operation downloadDevicePreviewRunSourceEmail
downloadDevicePreviewRunSourceEmailAsync()  : PromiseInterface
Operation downloadDevicePreviewRunSourceEmailAsync
downloadDevicePreviewRunSourceEmailAsyncWithHttpInfo()  : PromiseInterface
Operation downloadDevicePreviewRunSourceEmailAsyncWithHttpInfo
downloadDevicePreviewRunSourceEmailRequest()  : Request
Create request for operation 'downloadDevicePreviewRunSourceEmail'
downloadDevicePreviewRunSourceEmailWithHttpInfo()  : array<string|int, mixed>
Operation downloadDevicePreviewRunSourceEmailWithHttpInfo
ensureDevicePreviewRun()  : CreateDevicePreviewRunResult
Operation ensureDevicePreviewRun
ensureDevicePreviewRunAsync()  : PromiseInterface
Operation ensureDevicePreviewRunAsync
ensureDevicePreviewRunAsyncWithHttpInfo()  : PromiseInterface
Operation ensureDevicePreviewRunAsyncWithHttpInfo
ensureDevicePreviewRunRequest()  : Request
Create request for operation 'ensureDevicePreviewRun'
ensureDevicePreviewRunWithHttpInfo()  : array<string|int, mixed>
Operation ensureDevicePreviewRunWithHttpInfo
getConfig()  : Configuration
getDevicePreviewEmailDomainOrCreate()  : DevicePreviewAccountSettingsDto
Operation getDevicePreviewEmailDomainOrCreate
getDevicePreviewEmailDomainOrCreateAsync()  : PromiseInterface
Operation getDevicePreviewEmailDomainOrCreateAsync
getDevicePreviewEmailDomainOrCreateAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewEmailDomainOrCreateAsyncWithHttpInfo
getDevicePreviewEmailDomainOrCreateRequest()  : Request
Create request for operation 'getDevicePreviewEmailDomainOrCreate'
getDevicePreviewEmailDomainOrCreateWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewEmailDomainOrCreateWithHttpInfo
getDevicePreviewEmailRuns()  : array<string|int, DevicePreviewRunDto>
Operation getDevicePreviewEmailRuns
getDevicePreviewEmailRunsAsync()  : PromiseInterface
Operation getDevicePreviewEmailRunsAsync
getDevicePreviewEmailRunsAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewEmailRunsAsyncWithHttpInfo
getDevicePreviewEmailRunsRequest()  : Request
Create request for operation 'getDevicePreviewEmailRuns'
getDevicePreviewEmailRunsWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewEmailRunsWithHttpInfo
getDevicePreviewEmailSubmissions()  : array<string|int, DevicePreviewEmailSubmissionDto>
Operation getDevicePreviewEmailSubmissions
getDevicePreviewEmailSubmissionsAsync()  : PromiseInterface
Operation getDevicePreviewEmailSubmissionsAsync
getDevicePreviewEmailSubmissionsAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewEmailSubmissionsAsyncWithHttpInfo
getDevicePreviewEmailSubmissionSourceEmail()  : DevicePreviewSourceEmailDto
Operation getDevicePreviewEmailSubmissionSourceEmail
getDevicePreviewEmailSubmissionSourceEmailAsync()  : PromiseInterface
Operation getDevicePreviewEmailSubmissionSourceEmailAsync
getDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo
getDevicePreviewEmailSubmissionSourceEmailRequest()  : Request
Create request for operation 'getDevicePreviewEmailSubmissionSourceEmail'
getDevicePreviewEmailSubmissionSourceEmailWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewEmailSubmissionSourceEmailWithHttpInfo
getDevicePreviewEmailSubmissionsRequest()  : Request
Create request for operation 'getDevicePreviewEmailSubmissions'
getDevicePreviewEmailSubmissionsWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewEmailSubmissionsWithHttpInfo
getDevicePreviewFeedback()  : DevicePreviewFeedbackDto
Operation getDevicePreviewFeedback
getDevicePreviewFeedbackAsync()  : PromiseInterface
Operation getDevicePreviewFeedbackAsync
getDevicePreviewFeedbackAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewFeedbackAsyncWithHttpInfo
getDevicePreviewFeedbackItems()  : DevicePreviewFeedbackListDto
Operation getDevicePreviewFeedbackItems
getDevicePreviewFeedbackItemsAsync()  : PromiseInterface
Operation getDevicePreviewFeedbackItemsAsync
getDevicePreviewFeedbackItemsAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewFeedbackItemsAsyncWithHttpInfo
getDevicePreviewFeedbackItemsRequest()  : Request
Create request for operation 'getDevicePreviewFeedbackItems'
getDevicePreviewFeedbackItemsWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewFeedbackItemsWithHttpInfo
getDevicePreviewFeedbackRequest()  : Request
Create request for operation 'getDevicePreviewFeedback'
getDevicePreviewFeedbackWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewFeedbackWithHttpInfo
getDevicePreviewFolder()  : DevicePreviewFolderDto
Operation getDevicePreviewFolder
getDevicePreviewFolderAsync()  : PromiseInterface
Operation getDevicePreviewFolderAsync
getDevicePreviewFolderAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewFolderAsyncWithHttpInfo
getDevicePreviewFolderRequest()  : Request
Create request for operation 'getDevicePreviewFolder'
getDevicePreviewFolders()  : array<string|int, DevicePreviewFolderDto>
Operation getDevicePreviewFolders
getDevicePreviewFoldersAsync()  : PromiseInterface
Operation getDevicePreviewFoldersAsync
getDevicePreviewFoldersAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewFoldersAsyncWithHttpInfo
getDevicePreviewFoldersRequest()  : Request
Create request for operation 'getDevicePreviewFolders'
getDevicePreviewFoldersWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewFoldersWithHttpInfo
getDevicePreviewFolderWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewFolderWithHttpInfo
getDevicePreviewImportAddress()  : DevicePreviewIngestAddressDto
Operation getDevicePreviewImportAddress
getDevicePreviewImportAddressAsync()  : PromiseInterface
Operation getDevicePreviewImportAddressAsync
getDevicePreviewImportAddressAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewImportAddressAsyncWithHttpInfo
getDevicePreviewImportAddressRequest()  : Request
Create request for operation 'getDevicePreviewImportAddress'
getDevicePreviewImportAddressWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewImportAddressWithHttpInfo
getDevicePreviewNativeTargetAvailability()  : DevicePreviewNativeTargetAvailabilityListDto
Operation getDevicePreviewNativeTargetAvailability
getDevicePreviewNativeTargetAvailabilityAsync()  : PromiseInterface
Operation getDevicePreviewNativeTargetAvailabilityAsync
getDevicePreviewNativeTargetAvailabilityAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewNativeTargetAvailabilityAsyncWithHttpInfo
getDevicePreviewNativeTargetAvailabilityRequest()  : Request
Create request for operation 'getDevicePreviewNativeTargetAvailability'
getDevicePreviewNativeTargetAvailabilityWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewNativeTargetAvailabilityWithHttpInfo
getDevicePreviewProfile()  : DevicePreviewProfileDto
Operation getDevicePreviewProfile
getDevicePreviewProfileAsync()  : PromiseInterface
Operation getDevicePreviewProfileAsync
getDevicePreviewProfileAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewProfileAsyncWithHttpInfo
getDevicePreviewProfileRequest()  : Request
Create request for operation 'getDevicePreviewProfile'
getDevicePreviewProfiles()  : array<string|int, DevicePreviewProfileDto>
Operation getDevicePreviewProfiles
getDevicePreviewProfilesAsync()  : PromiseInterface
Operation getDevicePreviewProfilesAsync
getDevicePreviewProfilesAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewProfilesAsyncWithHttpInfo
getDevicePreviewProfilesRequest()  : Request
Create request for operation 'getDevicePreviewProfiles'
getDevicePreviewProfilesWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewProfilesWithHttpInfo
getDevicePreviewProfileWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewProfileWithHttpInfo
getDevicePreviewRun()  : DevicePreviewRunDto
Operation getDevicePreviewRun
getDevicePreviewRunAsync()  : PromiseInterface
Operation getDevicePreviewRunAsync
getDevicePreviewRunAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunAsyncWithHttpInfo
getDevicePreviewRunProviderProgress()  : DevicePreviewProviderProgressDto
Operation getDevicePreviewRunProviderProgress
getDevicePreviewRunProviderProgressAsync()  : PromiseInterface
Operation getDevicePreviewRunProviderProgressAsync
getDevicePreviewRunProviderProgressAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunProviderProgressAsyncWithHttpInfo
getDevicePreviewRunProviderProgressRequest()  : Request
Create request for operation 'getDevicePreviewRunProviderProgress'
getDevicePreviewRunProviderProgressWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunProviderProgressWithHttpInfo
getDevicePreviewRunRequest()  : Request
Create request for operation 'getDevicePreviewRun'
getDevicePreviewRunResults()  : DevicePreviewRunResultsDto
Operation getDevicePreviewRunResults
getDevicePreviewRunResultsAsync()  : PromiseInterface
Operation getDevicePreviewRunResultsAsync
getDevicePreviewRunResultsAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunResultsAsyncWithHttpInfo
getDevicePreviewRunResultsRequest()  : Request
Create request for operation 'getDevicePreviewRunResults'
getDevicePreviewRunResultsWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunResultsWithHttpInfo
getDevicePreviewRuns()  : array<string|int, DevicePreviewRunDto>
Operation getDevicePreviewRuns
getDevicePreviewRunsAsync()  : PromiseInterface
Operation getDevicePreviewRunsAsync
getDevicePreviewRunsAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunsAsyncWithHttpInfo
getDevicePreviewRunScreenshot()  : string
Operation getDevicePreviewRunScreenshot
getDevicePreviewRunScreenshotAsync()  : PromiseInterface
Operation getDevicePreviewRunScreenshotAsync
getDevicePreviewRunScreenshotAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunScreenshotAsyncWithHttpInfo
getDevicePreviewRunScreenshotRequest()  : Request
Create request for operation 'getDevicePreviewRunScreenshot'
getDevicePreviewRunScreenshotWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunScreenshotWithHttpInfo
getDevicePreviewRunsForAccount()  : array<string|int, DevicePreviewRunDto>
Operation getDevicePreviewRunsForAccount
getDevicePreviewRunsForAccountAsync()  : PromiseInterface
Operation getDevicePreviewRunsForAccountAsync
getDevicePreviewRunsForAccountAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunsForAccountAsyncWithHttpInfo
getDevicePreviewRunsForAccountOffsetPaginated()  : PageDevicePreviewRunProjection
Operation getDevicePreviewRunsForAccountOffsetPaginated
getDevicePreviewRunsForAccountOffsetPaginatedAsync()  : PromiseInterface
Operation getDevicePreviewRunsForAccountOffsetPaginatedAsync
getDevicePreviewRunsForAccountOffsetPaginatedAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunsForAccountOffsetPaginatedAsyncWithHttpInfo
getDevicePreviewRunsForAccountOffsetPaginatedRequest()  : Request
Create request for operation 'getDevicePreviewRunsForAccountOffsetPaginated'
getDevicePreviewRunsForAccountOffsetPaginatedWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunsForAccountOffsetPaginatedWithHttpInfo
getDevicePreviewRunsForAccountRequest()  : Request
Create request for operation 'getDevicePreviewRunsForAccount'
getDevicePreviewRunsForAccountWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunsForAccountWithHttpInfo
getDevicePreviewRunsOffsetPaginated()  : PageDevicePreviewRunProjection
Operation getDevicePreviewRunsOffsetPaginated
getDevicePreviewRunsOffsetPaginatedAsync()  : PromiseInterface
Operation getDevicePreviewRunsOffsetPaginatedAsync
getDevicePreviewRunsOffsetPaginatedAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunsOffsetPaginatedAsyncWithHttpInfo
getDevicePreviewRunsOffsetPaginatedRequest()  : Request
Create request for operation 'getDevicePreviewRunsOffsetPaginated'
getDevicePreviewRunsOffsetPaginatedWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunsOffsetPaginatedWithHttpInfo
getDevicePreviewRunSourceEmail()  : DevicePreviewSourceEmailDto
Operation getDevicePreviewRunSourceEmail
getDevicePreviewRunSourceEmailAsync()  : PromiseInterface
Operation getDevicePreviewRunSourceEmailAsync
getDevicePreviewRunSourceEmailAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewRunSourceEmailAsyncWithHttpInfo
getDevicePreviewRunSourceEmailRequest()  : Request
Create request for operation 'getDevicePreviewRunSourceEmail'
getDevicePreviewRunSourceEmailWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunSourceEmailWithHttpInfo
getDevicePreviewRunsRequest()  : Request
Create request for operation 'getDevicePreviewRuns'
getDevicePreviewRunsWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunsWithHttpInfo
getDevicePreviewRunWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewRunWithHttpInfo
getDevicePreviewSharedResult()  : DevicePreviewSharedResultDto
Operation getDevicePreviewSharedResult
getDevicePreviewSharedResultAsync()  : PromiseInterface
Operation getDevicePreviewSharedResultAsync
getDevicePreviewSharedResultAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewSharedResultAsyncWithHttpInfo
getDevicePreviewSharedResultRequest()  : Request
Create request for operation 'getDevicePreviewSharedResult'
getDevicePreviewSharedResultScreenshot()  : string
Operation getDevicePreviewSharedResultScreenshot
getDevicePreviewSharedResultScreenshotAsync()  : PromiseInterface
Operation getDevicePreviewSharedResultScreenshotAsync
getDevicePreviewSharedResultScreenshotAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewSharedResultScreenshotAsyncWithHttpInfo
getDevicePreviewSharedResultScreenshotRequest()  : Request
Create request for operation 'getDevicePreviewSharedResultScreenshot'
getDevicePreviewSharedResultScreenshotWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewSharedResultScreenshotWithHttpInfo
getDevicePreviewSharedResultWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewSharedResultWithHttpInfo
getDevicePreviewShareLinks()  : array<string|int, DevicePreviewShareLinkDto>
Operation getDevicePreviewShareLinks
getDevicePreviewShareLinksAsync()  : PromiseInterface
Operation getDevicePreviewShareLinksAsync
getDevicePreviewShareLinksAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewShareLinksAsyncWithHttpInfo
getDevicePreviewShareLinksRequest()  : Request
Create request for operation 'getDevicePreviewShareLinks'
getDevicePreviewShareLinksWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewShareLinksWithHttpInfo
getDevicePreviewTargets()  : DevicePreviewNativeTargetListDto
Operation getDevicePreviewTargets
getDevicePreviewTargetsAsync()  : PromiseInterface
Operation getDevicePreviewTargetsAsync
getDevicePreviewTargetsAsyncWithHttpInfo()  : PromiseInterface
Operation getDevicePreviewTargetsAsyncWithHttpInfo
getDevicePreviewTargetsRequest()  : Request
Create request for operation 'getDevicePreviewTargets'
getDevicePreviewTargetsWithHttpInfo()  : array<string|int, mixed>
Operation getDevicePreviewTargetsWithHttpInfo
getHostIndex()  : int
Get the host index
moveDevicePreviewRuns()  : MoveDevicePreviewRunsResult
Operation moveDevicePreviewRuns
moveDevicePreviewRunsAsync()  : PromiseInterface
Operation moveDevicePreviewRunsAsync
moveDevicePreviewRunsAsyncWithHttpInfo()  : PromiseInterface
Operation moveDevicePreviewRunsAsyncWithHttpInfo
moveDevicePreviewRunsRequest()  : Request
Create request for operation 'moveDevicePreviewRuns'
moveDevicePreviewRunsWithHttpInfo()  : array<string|int, mixed>
Operation moveDevicePreviewRunsWithHttpInfo
rerunDevicePreviewTargets()  : RerunDevicePreviewTargetsResult
Operation rerunDevicePreviewTargets
rerunDevicePreviewTargetsAsync()  : PromiseInterface
Operation rerunDevicePreviewTargetsAsync
rerunDevicePreviewTargetsAsyncWithHttpInfo()  : PromiseInterface
Operation rerunDevicePreviewTargetsAsyncWithHttpInfo
rerunDevicePreviewTargetsRequest()  : Request
Create request for operation 'rerunDevicePreviewTargets'
rerunDevicePreviewTargetsWithHttpInfo()  : array<string|int, mixed>
Operation rerunDevicePreviewTargetsWithHttpInfo
setHostIndex()  : void
Set the host index
updateDevicePreviewEmailDomainSubdomain()  : DevicePreviewAccountSettingsDto
Operation updateDevicePreviewEmailDomainSubdomain
updateDevicePreviewEmailDomainSubdomainAsync()  : PromiseInterface
Operation updateDevicePreviewEmailDomainSubdomainAsync
updateDevicePreviewEmailDomainSubdomainAsyncWithHttpInfo()  : PromiseInterface
Operation updateDevicePreviewEmailDomainSubdomainAsyncWithHttpInfo
updateDevicePreviewEmailDomainSubdomainRequest()  : Request
Create request for operation 'updateDevicePreviewEmailDomainSubdomain'
updateDevicePreviewEmailDomainSubdomainWithHttpInfo()  : array<string|int, mixed>
Operation updateDevicePreviewEmailDomainSubdomainWithHttpInfo
updateDevicePreviewFeedback()  : DevicePreviewFeedbackDto
Operation updateDevicePreviewFeedback
updateDevicePreviewFeedbackAsync()  : PromiseInterface
Operation updateDevicePreviewFeedbackAsync
updateDevicePreviewFeedbackAsyncWithHttpInfo()  : PromiseInterface
Operation updateDevicePreviewFeedbackAsyncWithHttpInfo
updateDevicePreviewFeedbackRequest()  : Request
Create request for operation 'updateDevicePreviewFeedback'
updateDevicePreviewFeedbackWithHttpInfo()  : array<string|int, mixed>
Operation updateDevicePreviewFeedbackWithHttpInfo
updateDevicePreviewFolder()  : DevicePreviewFolderDto
Operation updateDevicePreviewFolder
updateDevicePreviewFolderAsync()  : PromiseInterface
Operation updateDevicePreviewFolderAsync
updateDevicePreviewFolderAsyncWithHttpInfo()  : PromiseInterface
Operation updateDevicePreviewFolderAsyncWithHttpInfo
updateDevicePreviewFolderRequest()  : Request
Create request for operation 'updateDevicePreviewFolder'
updateDevicePreviewFolderWithHttpInfo()  : array<string|int, mixed>
Operation updateDevicePreviewFolderWithHttpInfo
updateDevicePreviewProfile()  : DevicePreviewProfileDto
Operation updateDevicePreviewProfile
updateDevicePreviewProfileAsync()  : PromiseInterface
Operation updateDevicePreviewProfileAsync
updateDevicePreviewProfileAsyncWithHttpInfo()  : PromiseInterface
Operation updateDevicePreviewProfileAsyncWithHttpInfo
updateDevicePreviewProfileRequest()  : Request
Create request for operation 'updateDevicePreviewProfile'
updateDevicePreviewProfileWithHttpInfo()  : array<string|int, mixed>
Operation updateDevicePreviewProfileWithHttpInfo
waitForDevicePreviewEmailRuns()  : DevicePreviewIngestRunWaitResult
Operation waitForDevicePreviewEmailRuns
waitForDevicePreviewEmailRunsAsync()  : PromiseInterface
Operation waitForDevicePreviewEmailRunsAsync
waitForDevicePreviewEmailRunsAsyncWithHttpInfo()  : PromiseInterface
Operation waitForDevicePreviewEmailRunsAsyncWithHttpInfo
waitForDevicePreviewEmailRunsRequest()  : Request
Create request for operation 'waitForDevicePreviewEmailRuns'
waitForDevicePreviewEmailRunsWithHttpInfo()  : array<string|int, mixed>
Operation waitForDevicePreviewEmailRunsWithHttpInfo
waitForDevicePreviewEmailSubmissions()  : DevicePreviewEmailSubmissionWaitResult
Operation waitForDevicePreviewEmailSubmissions
waitForDevicePreviewEmailSubmissionsAsync()  : PromiseInterface
Operation waitForDevicePreviewEmailSubmissionsAsync
waitForDevicePreviewEmailSubmissionsAsyncWithHttpInfo()  : PromiseInterface
Operation waitForDevicePreviewEmailSubmissionsAsyncWithHttpInfo
waitForDevicePreviewEmailSubmissionsRequest()  : Request
Create request for operation 'waitForDevicePreviewEmailSubmissions'
waitForDevicePreviewEmailSubmissionsWithHttpInfo()  : array<string|int, mixed>
Operation waitForDevicePreviewEmailSubmissionsWithHttpInfo
waitForDevicePreviewRun()  : DevicePreviewRunWaitResult
Operation waitForDevicePreviewRun
waitForDevicePreviewRunAsync()  : PromiseInterface
Operation waitForDevicePreviewRunAsync
waitForDevicePreviewRunAsyncWithHttpInfo()  : PromiseInterface
Operation waitForDevicePreviewRunAsyncWithHttpInfo
waitForDevicePreviewRunRequest()  : Request
Create request for operation 'waitForDevicePreviewRun'
waitForDevicePreviewRunWithHttpInfo()  : array<string|int, mixed>
Operation waitForDevicePreviewRunWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['cancelDevicePreviewRun' => ['application/json'], 'createDevicePreviewFeedback' => ['application/json'], 'createDevicePreviewFolder' => ['application/json'], 'createDevicePreviewImportAddress' => ['application/json'], 'createDevicePreviewProfile' => ['application/json'], 'createDevicePreviewRun' => ['application/json'], 'createDevicePreviewRunFromFile' => ['multipart/form-data'], 'createDevicePreviewRunFromHtmlImport' => ['application/json'], 'createDevicePreviewRunFromImport' => ['application/json'], 'createDevicePreviewRunFromMultipartImport' => ['multipart/form-data'], 'createDevicePreviewRunFromRawImport' => ['application/json'], 'createDevicePreviewShareLink' => ['application/json'], 'deleteDevicePreviewFolder' => ['application/json'], 'deleteDevicePreviewProfile' => ['application/json'], 'deleteDevicePreviewRun' => ['application/json'], 'deleteDevicePreviewShareLink' => ['application/json'], 'downloadDevicePreviewEmailSubmissionSourceEmail' => ['application/json'], 'downloadDevicePreviewRunSourceEmail' => ['application/json'], 'ensureDevicePreviewRun' => ['application/json'], 'getDevicePreviewEmailDomainOrCreate' => ['application/json'], 'getDevicePreviewEmailRuns' => ['application/json'], 'getDevicePreviewEmailSubmissionSourceEmail' => ['application/json'], 'getDevicePreviewEmailSubmissions' => ['application/json'], 'getDevicePreviewFeedback' => ['application/json'], 'getDevicePreviewFeedbackItems' => ['application/json'], 'getDevicePreviewFolder' => ['application/json'], 'getDevicePreviewFolders' => ['application/json'], 'getDevicePreviewImportAddress' => ['application/json'], 'getDevicePreviewNativeTargetAvailability' => ['application/json'], 'getDevicePreviewProfile' => ['application/json'], 'getDevicePreviewProfiles' => ['application/json'], 'getDevicePreviewRun' => ['application/json'], 'getDevicePreviewRunProviderProgress' => ['application/json'], 'getDevicePreviewRunResults' => ['application/json'], 'getDevicePreviewRunScreenshot' => ['application/json'], 'getDevicePreviewRunSourceEmail' => ['application/json'], 'getDevicePreviewRuns' => ['application/json'], 'getDevicePreviewRunsForAccount' => ['application/json'], 'getDevicePreviewRunsForAccountOffsetPaginated' => ['application/json'], 'getDevicePreviewRunsOffsetPaginated' => ['application/json'], 'getDevicePreviewShareLinks' => ['application/json'], 'getDevicePreviewSharedResult' => ['application/json'], 'getDevicePreviewSharedResultScreenshot' => ['application/json'], 'getDevicePreviewTargets' => ['application/json'], 'moveDevicePreviewRuns' => ['application/json'], 'rerunDevicePreviewTargets' => ['application/json'], 'updateDevicePreviewEmailDomainSubdomain' => ['application/json'], 'updateDevicePreviewFeedback' => ['application/json'], 'updateDevicePreviewFolder' => ['application/json'], 'updateDevicePreviewProfile' => ['application/json'], 'waitForDevicePreviewEmailRuns' => ['application/json'], 'waitForDevicePreviewEmailSubmissions' => ['application/json'], 'waitForDevicePreviewRun' => ['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 —

cancelDevicePreviewRun()

Operation cancelDevicePreviewRun

public cancelDevicePreviewRun(string $run_id[, CancelDevicePreviewRunOptions $cancel_device_preview_run_options = null ][, string $contentType = self::contentTypes['cancelDevicePreviewRun'][0] ]) : CancelDevicePreviewRunResult

Cancel a running device preview run

Parameters
$run_id : string

run_id (required)

$cancel_device_preview_run_options : CancelDevicePreviewRunOptions = null

cancel_device_preview_run_options (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CancelDevicePreviewRunResult —

cancelDevicePreviewRunAsync()

Operation cancelDevicePreviewRunAsync

public cancelDevicePreviewRunAsync(string $run_id[, CancelDevicePreviewRunOptions $cancel_device_preview_run_options = null ][, string $contentType = self::contentTypes['cancelDevicePreviewRun'][0] ]) : PromiseInterface

Cancel a running device preview run

Parameters
$run_id : string

(required)

$cancel_device_preview_run_options : CancelDevicePreviewRunOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

cancelDevicePreviewRunAsyncWithHttpInfo()

Operation cancelDevicePreviewRunAsyncWithHttpInfo

public cancelDevicePreviewRunAsyncWithHttpInfo(string $run_id[, CancelDevicePreviewRunOptions $cancel_device_preview_run_options = null ][, string $contentType = self::contentTypes['cancelDevicePreviewRun'][0] ]) : PromiseInterface

Cancel a running device preview run

Parameters
$run_id : string

(required)

$cancel_device_preview_run_options : CancelDevicePreviewRunOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

cancelDevicePreviewRunRequest()

Create request for operation 'cancelDevicePreviewRun'

public cancelDevicePreviewRunRequest(string $run_id[, CancelDevicePreviewRunOptions $cancel_device_preview_run_options = null ][, string $contentType = self::contentTypes['cancelDevicePreviewRun'][0] ]) : Request
Parameters
$run_id : string

(required)

$cancel_device_preview_run_options : CancelDevicePreviewRunOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

cancelDevicePreviewRunWithHttpInfo()

Operation cancelDevicePreviewRunWithHttpInfo

public cancelDevicePreviewRunWithHttpInfo(string $run_id[, CancelDevicePreviewRunOptions $cancel_device_preview_run_options = null ][, string $contentType = self::contentTypes['cancelDevicePreviewRun'][0] ]) : array<string|int, mixed>

Cancel a running device preview run

Parameters
$run_id : string

(required)

$cancel_device_preview_run_options : CancelDevicePreviewRunOptions = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['cancelDevicePreviewRun'] 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\CancelDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewFeedback()

Operation createDevicePreviewFeedback

public createDevicePreviewFeedback(CreateDevicePreviewFeedbackOptions $create_device_preview_feedback_options[, string $contentType = self::contentTypes['createDevicePreviewFeedback'][0] ]) : DevicePreviewFeedbackDto

Create device preview feedback

Parameters
$create_device_preview_feedback_options : CreateDevicePreviewFeedbackOptions

create_device_preview_feedback_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewFeedbackDto —

createDevicePreviewFeedbackAsync()

Operation createDevicePreviewFeedbackAsync

public createDevicePreviewFeedbackAsync(CreateDevicePreviewFeedbackOptions $create_device_preview_feedback_options[, string $contentType = self::contentTypes['createDevicePreviewFeedback'][0] ]) : PromiseInterface

Create device preview feedback

Parameters
$create_device_preview_feedback_options : CreateDevicePreviewFeedbackOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewFeedbackAsyncWithHttpInfo()

Operation createDevicePreviewFeedbackAsyncWithHttpInfo

public createDevicePreviewFeedbackAsyncWithHttpInfo(CreateDevicePreviewFeedbackOptions $create_device_preview_feedback_options[, string $contentType = self::contentTypes['createDevicePreviewFeedback'][0] ]) : PromiseInterface

Create device preview feedback

Parameters
$create_device_preview_feedback_options : CreateDevicePreviewFeedbackOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewFeedbackRequest()

Create request for operation 'createDevicePreviewFeedback'

public createDevicePreviewFeedbackRequest(CreateDevicePreviewFeedbackOptions $create_device_preview_feedback_options[, string $contentType = self::contentTypes['createDevicePreviewFeedback'][0] ]) : Request
Parameters
$create_device_preview_feedback_options : CreateDevicePreviewFeedbackOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewFeedbackWithHttpInfo()

Operation createDevicePreviewFeedbackWithHttpInfo

public createDevicePreviewFeedbackWithHttpInfo(CreateDevicePreviewFeedbackOptions $create_device_preview_feedback_options[, string $contentType = self::contentTypes['createDevicePreviewFeedback'][0] ]) : array<string|int, mixed>

Create device preview feedback

Parameters
$create_device_preview_feedback_options : CreateDevicePreviewFeedbackOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewFeedback'] 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\DevicePreviewFeedbackDto, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewFolder()

Operation createDevicePreviewFolder

public createDevicePreviewFolder(CreateDevicePreviewFolderOptions $create_device_preview_folder_options[, string $contentType = self::contentTypes['createDevicePreviewFolder'][0] ]) : DevicePreviewFolderDto

Create a device preview folder

Parameters
$create_device_preview_folder_options : CreateDevicePreviewFolderOptions

create_device_preview_folder_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewFolderDto —

createDevicePreviewFolderAsync()

Operation createDevicePreviewFolderAsync

public createDevicePreviewFolderAsync(CreateDevicePreviewFolderOptions $create_device_preview_folder_options[, string $contentType = self::contentTypes['createDevicePreviewFolder'][0] ]) : PromiseInterface

Create a device preview folder

Parameters
$create_device_preview_folder_options : CreateDevicePreviewFolderOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewFolderAsyncWithHttpInfo()

Operation createDevicePreviewFolderAsyncWithHttpInfo

public createDevicePreviewFolderAsyncWithHttpInfo(CreateDevicePreviewFolderOptions $create_device_preview_folder_options[, string $contentType = self::contentTypes['createDevicePreviewFolder'][0] ]) : PromiseInterface

Create a device preview folder

Parameters
$create_device_preview_folder_options : CreateDevicePreviewFolderOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewFolderRequest()

Create request for operation 'createDevicePreviewFolder'

public createDevicePreviewFolderRequest(CreateDevicePreviewFolderOptions $create_device_preview_folder_options[, string $contentType = self::contentTypes['createDevicePreviewFolder'][0] ]) : Request
Parameters
$create_device_preview_folder_options : CreateDevicePreviewFolderOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewFolderWithHttpInfo()

Operation createDevicePreviewFolderWithHttpInfo

public createDevicePreviewFolderWithHttpInfo(CreateDevicePreviewFolderOptions $create_device_preview_folder_options[, string $contentType = self::contentTypes['createDevicePreviewFolder'][0] ]) : array<string|int, mixed>

Create a device preview folder

Parameters
$create_device_preview_folder_options : CreateDevicePreviewFolderOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewFolder'] 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\DevicePreviewFolderDto, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewImportAddress()

Operation createDevicePreviewImportAddress

public createDevicePreviewImportAddress([CreateDevicePreviewIngestAddressOptions $create_device_preview_ingest_address_options = null ][, string $contentType = self::contentTypes['createDevicePreviewImportAddress'][0] ]) : DevicePreviewIngestAddressDto

Create a temporary email address for device preview import

Parameters
$create_device_preview_ingest_address_options : CreateDevicePreviewIngestAddressOptions = null

create_device_preview_ingest_address_options (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewIngestAddressDto —

createDevicePreviewImportAddressAsync()

Operation createDevicePreviewImportAddressAsync

public createDevicePreviewImportAddressAsync([CreateDevicePreviewIngestAddressOptions $create_device_preview_ingest_address_options = null ][, string $contentType = self::contentTypes['createDevicePreviewImportAddress'][0] ]) : PromiseInterface

Create a temporary email address for device preview import

Parameters
$create_device_preview_ingest_address_options : CreateDevicePreviewIngestAddressOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewImportAddressAsyncWithHttpInfo()

Operation createDevicePreviewImportAddressAsyncWithHttpInfo

public createDevicePreviewImportAddressAsyncWithHttpInfo([CreateDevicePreviewIngestAddressOptions $create_device_preview_ingest_address_options = null ][, string $contentType = self::contentTypes['createDevicePreviewImportAddress'][0] ]) : PromiseInterface

Create a temporary email address for device preview import

Parameters
$create_device_preview_ingest_address_options : CreateDevicePreviewIngestAddressOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewImportAddressRequest()

Create request for operation 'createDevicePreviewImportAddress'

public createDevicePreviewImportAddressRequest([CreateDevicePreviewIngestAddressOptions $create_device_preview_ingest_address_options = null ][, string $contentType = self::contentTypes['createDevicePreviewImportAddress'][0] ]) : Request
Parameters
$create_device_preview_ingest_address_options : CreateDevicePreviewIngestAddressOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewImportAddressWithHttpInfo()

Operation createDevicePreviewImportAddressWithHttpInfo

public createDevicePreviewImportAddressWithHttpInfo([CreateDevicePreviewIngestAddressOptions $create_device_preview_ingest_address_options = null ][, string $contentType = self::contentTypes['createDevicePreviewImportAddress'][0] ]) : array<string|int, mixed>

Create a temporary email address for device preview import

Parameters
$create_device_preview_ingest_address_options : CreateDevicePreviewIngestAddressOptions = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewImportAddress'] 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\DevicePreviewIngestAddressDto, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewProfile()

Operation createDevicePreviewProfile

public createDevicePreviewProfile(CreateDevicePreviewProfileOptions $create_device_preview_profile_options[, string $contentType = self::contentTypes['createDevicePreviewProfile'][0] ]) : DevicePreviewProfileDto

Create a device preview profile

Parameters
$create_device_preview_profile_options : CreateDevicePreviewProfileOptions

create_device_preview_profile_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewProfileDto —

createDevicePreviewProfileAsync()

Operation createDevicePreviewProfileAsync

public createDevicePreviewProfileAsync(CreateDevicePreviewProfileOptions $create_device_preview_profile_options[, string $contentType = self::contentTypes['createDevicePreviewProfile'][0] ]) : PromiseInterface

Create a device preview profile

Parameters
$create_device_preview_profile_options : CreateDevicePreviewProfileOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewProfileAsyncWithHttpInfo()

Operation createDevicePreviewProfileAsyncWithHttpInfo

public createDevicePreviewProfileAsyncWithHttpInfo(CreateDevicePreviewProfileOptions $create_device_preview_profile_options[, string $contentType = self::contentTypes['createDevicePreviewProfile'][0] ]) : PromiseInterface

Create a device preview profile

Parameters
$create_device_preview_profile_options : CreateDevicePreviewProfileOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewProfileRequest()

Create request for operation 'createDevicePreviewProfile'

public createDevicePreviewProfileRequest(CreateDevicePreviewProfileOptions $create_device_preview_profile_options[, string $contentType = self::contentTypes['createDevicePreviewProfile'][0] ]) : Request
Parameters
$create_device_preview_profile_options : CreateDevicePreviewProfileOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewProfileWithHttpInfo()

Operation createDevicePreviewProfileWithHttpInfo

public createDevicePreviewProfileWithHttpInfo(CreateDevicePreviewProfileOptions $create_device_preview_profile_options[, string $contentType = self::contentTypes['createDevicePreviewProfile'][0] ]) : array<string|int, mixed>

Create a device preview profile

Parameters
$create_device_preview_profile_options : CreateDevicePreviewProfileOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewProfile'] 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\DevicePreviewProfileDto, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewRun()

Operation createDevicePreviewRun

public createDevicePreviewRun(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['createDevicePreviewRun'][0] ]) : CreateDevicePreviewRunResult

Create a new device preview run for an email

Parameters
$email_id : string

email_id (required)

$create_device_preview_options : CreateDevicePreviewOptions = null

create_device_preview_options (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CreateDevicePreviewRunResult —

createDevicePreviewRunAsync()

Operation createDevicePreviewRunAsync

public createDevicePreviewRunAsync(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['createDevicePreviewRun'][0] ]) : PromiseInterface

Create a new device preview run for an email

Parameters
$email_id : string

(required)

$create_device_preview_options : CreateDevicePreviewOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunAsyncWithHttpInfo()

Operation createDevicePreviewRunAsyncWithHttpInfo

public createDevicePreviewRunAsyncWithHttpInfo(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['createDevicePreviewRun'][0] ]) : PromiseInterface

Create a new device preview run for an email

Parameters
$email_id : string

(required)

$create_device_preview_options : CreateDevicePreviewOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromFile()

Operation createDevicePreviewRunFromFile

public createDevicePreviewRunFromFile(SplFileObject $file[, string $subject = null ][, string $from = null ][, string $to = null ][, string $source_alias = null ][, string $external_id = null ][, array<string|int, string> $providers = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, bool $email_audit = null ][, bool $domain_monitor = null ][, string $sender_domain = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromFile'][0] ]) : CreateDevicePreviewRunResult

Create a device preview run from an HTML, EML, or ZIP file

Parameters
$file : SplFileObject

An .html, .htm, or .eml file, or a .zip archive containing exactly one supported file. (required)

$subject : string = null

subject (optional)

$from : string = null

from (optional)

$to : string = null

to (optional)

$source_alias : string = null

source_alias (optional)

$external_id : string = null

external_id (optional)

$providers : array<string|int, string> = null

Legacy web-provider keys to render. (optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$email_audit : bool = null

email_audit (optional)

$domain_monitor : bool = null

domain_monitor (optional)

$sender_domain : string = null

sender_domain (optional)

$folder_id : string = null

folder_id (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CreateDevicePreviewRunResult —

createDevicePreviewRunFromFileAsync()

Operation createDevicePreviewRunFromFileAsync

public createDevicePreviewRunFromFileAsync(SplFileObject $file[, string $subject = null ][, string $from = null ][, string $to = null ][, string $source_alias = null ][, string $external_id = null ][, array<string|int, string> $providers = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, bool $email_audit = null ][, bool $domain_monitor = null ][, string $sender_domain = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromFile'][0] ]) : PromiseInterface

Create a device preview run from an HTML, EML, or ZIP file

Parameters
$file : SplFileObject

An .html, .htm, or .eml file, or a .zip archive containing exactly one supported file. (required)

$subject : string = null

(optional)

$from : string = null

(optional)

$to : string = null

(optional)

$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$providers : array<string|int, string> = null

Legacy web-provider keys to render. (optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$email_audit : bool = null

(optional)

$domain_monitor : bool = null

(optional)

$sender_domain : string = null

(optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromFileAsyncWithHttpInfo()

Operation createDevicePreviewRunFromFileAsyncWithHttpInfo

public createDevicePreviewRunFromFileAsyncWithHttpInfo(SplFileObject $file[, string $subject = null ][, string $from = null ][, string $to = null ][, string $source_alias = null ][, string $external_id = null ][, array<string|int, string> $providers = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, bool $email_audit = null ][, bool $domain_monitor = null ][, string $sender_domain = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromFile'][0] ]) : PromiseInterface

Create a device preview run from an HTML, EML, or ZIP file

Parameters
$file : SplFileObject

An .html, .htm, or .eml file, or a .zip archive containing exactly one supported file. (required)

$subject : string = null

(optional)

$from : string = null

(optional)

$to : string = null

(optional)

$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$providers : array<string|int, string> = null

Legacy web-provider keys to render. (optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$email_audit : bool = null

(optional)

$domain_monitor : bool = null

(optional)

$sender_domain : string = null

(optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromFileRequest()

Create request for operation 'createDevicePreviewRunFromFile'

public createDevicePreviewRunFromFileRequest(SplFileObject $file[, string $subject = null ][, string $from = null ][, string $to = null ][, string $source_alias = null ][, string $external_id = null ][, array<string|int, string> $providers = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, bool $email_audit = null ][, bool $domain_monitor = null ][, string $sender_domain = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromFile'][0] ]) : Request
Parameters
$file : SplFileObject

An .html, .htm, or .eml file, or a .zip archive containing exactly one supported file. (required)

$subject : string = null

(optional)

$from : string = null

(optional)

$to : string = null

(optional)

$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$providers : array<string|int, string> = null

Legacy web-provider keys to render. (optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$email_audit : bool = null

(optional)

$domain_monitor : bool = null

(optional)

$sender_domain : string = null

(optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewRunFromFileWithHttpInfo()

Operation createDevicePreviewRunFromFileWithHttpInfo

public createDevicePreviewRunFromFileWithHttpInfo(SplFileObject $file[, string $subject = null ][, string $from = null ][, string $to = null ][, string $source_alias = null ][, string $external_id = null ][, array<string|int, string> $providers = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, bool $email_audit = null ][, bool $domain_monitor = null ][, string $sender_domain = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromFile'][0] ]) : array<string|int, mixed>

Create a device preview run from an HTML, EML, or ZIP file

Parameters
$file : SplFileObject

An .html, .htm, or .eml file, or a .zip archive containing exactly one supported file. (required)

$subject : string = null

(optional)

$from : string = null

(optional)

$to : string = null

(optional)

$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$providers : array<string|int, string> = null

Legacy web-provider keys to render. (optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$email_audit : bool = null

(optional)

$domain_monitor : bool = null

(optional)

$sender_domain : string = null

(optional)

$folder_id : string = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewRunFromFile'] 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\CreateDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewRunFromHtmlImport()

Operation createDevicePreviewRunFromHtmlImport

public createDevicePreviewRunFromHtmlImport(CreateDevicePreviewHtmlImportOptions $create_device_preview_html_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromHtmlImport'][0] ]) : CreateDevicePreviewRunResult

Create a device preview run from HTML

Parameters
$create_device_preview_html_import_options : CreateDevicePreviewHtmlImportOptions

create_device_preview_html_import_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CreateDevicePreviewRunResult —

createDevicePreviewRunFromHtmlImportAsync()

Operation createDevicePreviewRunFromHtmlImportAsync

public createDevicePreviewRunFromHtmlImportAsync(CreateDevicePreviewHtmlImportOptions $create_device_preview_html_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromHtmlImport'][0] ]) : PromiseInterface

Create a device preview run from HTML

Parameters
$create_device_preview_html_import_options : CreateDevicePreviewHtmlImportOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromHtmlImportAsyncWithHttpInfo()

Operation createDevicePreviewRunFromHtmlImportAsyncWithHttpInfo

public createDevicePreviewRunFromHtmlImportAsyncWithHttpInfo(CreateDevicePreviewHtmlImportOptions $create_device_preview_html_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromHtmlImport'][0] ]) : PromiseInterface

Create a device preview run from HTML

Parameters
$create_device_preview_html_import_options : CreateDevicePreviewHtmlImportOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromHtmlImportRequest()

Create request for operation 'createDevicePreviewRunFromHtmlImport'

public createDevicePreviewRunFromHtmlImportRequest(CreateDevicePreviewHtmlImportOptions $create_device_preview_html_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromHtmlImport'][0] ]) : Request
Parameters
$create_device_preview_html_import_options : CreateDevicePreviewHtmlImportOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewRunFromHtmlImportWithHttpInfo()

Operation createDevicePreviewRunFromHtmlImportWithHttpInfo

public createDevicePreviewRunFromHtmlImportWithHttpInfo(CreateDevicePreviewHtmlImportOptions $create_device_preview_html_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromHtmlImport'][0] ]) : array<string|int, mixed>

Create a device preview run from HTML

Parameters
$create_device_preview_html_import_options : CreateDevicePreviewHtmlImportOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewRunFromHtmlImport'] 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\CreateDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewRunFromImport()

Operation createDevicePreviewRunFromImport

public createDevicePreviewRunFromImport(CreateDevicePreviewImportOptions $create_device_preview_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromImport'][0] ]) : CreateDevicePreviewRunResult

Create a device preview run from imported raw MIME

Parameters
$create_device_preview_import_options : CreateDevicePreviewImportOptions

create_device_preview_import_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CreateDevicePreviewRunResult —

createDevicePreviewRunFromImportAsync()

Operation createDevicePreviewRunFromImportAsync

public createDevicePreviewRunFromImportAsync(CreateDevicePreviewImportOptions $create_device_preview_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromImport'][0] ]) : PromiseInterface

Create a device preview run from imported raw MIME

Parameters
$create_device_preview_import_options : CreateDevicePreviewImportOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromImportAsyncWithHttpInfo()

Operation createDevicePreviewRunFromImportAsyncWithHttpInfo

public createDevicePreviewRunFromImportAsyncWithHttpInfo(CreateDevicePreviewImportOptions $create_device_preview_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromImport'][0] ]) : PromiseInterface

Create a device preview run from imported raw MIME

Parameters
$create_device_preview_import_options : CreateDevicePreviewImportOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromImportRequest()

Create request for operation 'createDevicePreviewRunFromImport'

public createDevicePreviewRunFromImportRequest(CreateDevicePreviewImportOptions $create_device_preview_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromImport'][0] ]) : Request
Parameters
$create_device_preview_import_options : CreateDevicePreviewImportOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewRunFromImportWithHttpInfo()

Operation createDevicePreviewRunFromImportWithHttpInfo

public createDevicePreviewRunFromImportWithHttpInfo(CreateDevicePreviewImportOptions $create_device_preview_import_options[, string $contentType = self::contentTypes['createDevicePreviewRunFromImport'][0] ]) : array<string|int, mixed>

Create a device preview run from imported raw MIME

Parameters
$create_device_preview_import_options : CreateDevicePreviewImportOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewRunFromImport'] 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\CreateDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewRunFromMultipartImport()

Operation createDevicePreviewRunFromMultipartImport

public createDevicePreviewRunFromMultipartImport(SplFileObject $file[, string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromMultipartImport'][0] ]) : CreateDevicePreviewRunResult

Create a device preview run from multipart EML upload

Parameters
$file : SplFileObject

file (required)

$source_alias : string = null

source_alias (optional)

$external_id : string = null

external_id (optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

folder_id (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CreateDevicePreviewRunResult —

createDevicePreviewRunFromMultipartImportAsync()

Operation createDevicePreviewRunFromMultipartImportAsync

public createDevicePreviewRunFromMultipartImportAsync(SplFileObject $file[, string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromMultipartImport'][0] ]) : PromiseInterface

Create a device preview run from multipart EML upload

Parameters
$file : SplFileObject

(required)

$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromMultipartImportAsyncWithHttpInfo()

Operation createDevicePreviewRunFromMultipartImportAsyncWithHttpInfo

public createDevicePreviewRunFromMultipartImportAsyncWithHttpInfo(SplFileObject $file[, string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromMultipartImport'][0] ]) : PromiseInterface

Create a device preview run from multipart EML upload

Parameters
$file : SplFileObject

(required)

$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromMultipartImportRequest()

Create request for operation 'createDevicePreviewRunFromMultipartImport'

public createDevicePreviewRunFromMultipartImportRequest(SplFileObject $file[, string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromMultipartImport'][0] ]) : Request
Parameters
$file : SplFileObject

(required)

$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewRunFromMultipartImportWithHttpInfo()

Operation createDevicePreviewRunFromMultipartImportWithHttpInfo

public createDevicePreviewRunFromMultipartImportWithHttpInfo(SplFileObject $file[, string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromMultipartImport'][0] ]) : array<string|int, mixed>

Create a device preview run from multipart EML upload

Parameters
$file : SplFileObject

(required)

$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewRunFromMultipartImport'] 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\CreateDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewRunFromRawImport()

Operation createDevicePreviewRunFromRawImport

public createDevicePreviewRunFromRawImport([string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromRawImport'][0] ]) : CreateDevicePreviewRunResult

Create a device preview run from raw MIME bytes

Parameters
$source_alias : string = null

source_alias (optional)

$external_id : string = null

external_id (optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

folder_id (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CreateDevicePreviewRunResult —

createDevicePreviewRunFromRawImportAsync()

Operation createDevicePreviewRunFromRawImportAsync

public createDevicePreviewRunFromRawImportAsync([string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromRawImport'][0] ]) : PromiseInterface

Create a device preview run from raw MIME bytes

Parameters
$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromRawImportAsyncWithHttpInfo()

Operation createDevicePreviewRunFromRawImportAsyncWithHttpInfo

public createDevicePreviewRunFromRawImportAsyncWithHttpInfo([string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromRawImport'][0] ]) : PromiseInterface

Create a device preview run from raw MIME bytes

Parameters
$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewRunFromRawImportRequest()

Create request for operation 'createDevicePreviewRunFromRawImport'

public createDevicePreviewRunFromRawImportRequest([string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromRawImport'][0] ]) : Request
Parameters
$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewRunFromRawImportWithHttpInfo()

Operation createDevicePreviewRunFromRawImportWithHttpInfo

public createDevicePreviewRunFromRawImportWithHttpInfo([string $source_alias = null ][, string $external_id = null ][, bool $all_targets = null ][, array<string|int, string> $targets = null ][, string $folder_id = null ][, string $contentType = self::contentTypes['createDevicePreviewRunFromRawImport'][0] ]) : array<string|int, mixed>

Create a device preview run from raw MIME bytes

Parameters
$source_alias : string = null

(optional)

$external_id : string = null

(optional)

$all_targets : bool = null

Render every currently configured target. (optional)

$targets : array<string|int, string> = null

Device preview target keys to render. (optional)

$folder_id : string = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewRunFromRawImport'] 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\CreateDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

createDevicePreviewRunRequest()

Create request for operation 'createDevicePreviewRun'

public createDevicePreviewRunRequest(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['createDevicePreviewRun'][0] ]) : Request
Parameters
$email_id : string

(required)

$create_device_preview_options : CreateDevicePreviewOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewRunWithHttpInfo()

Operation createDevicePreviewRunWithHttpInfo

public createDevicePreviewRunWithHttpInfo(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['createDevicePreviewRun'][0] ]) : array<string|int, mixed>

Create a new device preview run for an email

Parameters
$email_id : string

(required)

$create_device_preview_options : CreateDevicePreviewOptions = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewRun'] 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\CreateDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

Operation createDevicePreviewShareLink

public createDevicePreviewShareLink(string $run_id[, CreateDevicePreviewShareLinkOptions $create_device_preview_share_link_options = null ][, string $contentType = self::contentTypes['createDevicePreviewShareLink'][0] ]) : DevicePreviewShareLinkDto

Create a share link for a device preview run

Parameters
$run_id : string

run_id (required)

$create_device_preview_share_link_options : CreateDevicePreviewShareLinkOptions = null

create_device_preview_share_link_options (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewShareLinkDto —

createDevicePreviewShareLinkAsync()

Operation createDevicePreviewShareLinkAsync

public createDevicePreviewShareLinkAsync(string $run_id[, CreateDevicePreviewShareLinkOptions $create_device_preview_share_link_options = null ][, string $contentType = self::contentTypes['createDevicePreviewShareLink'][0] ]) : PromiseInterface

Create a share link for a device preview run

Parameters
$run_id : string

(required)

$create_device_preview_share_link_options : CreateDevicePreviewShareLinkOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewShareLinkAsyncWithHttpInfo()

Operation createDevicePreviewShareLinkAsyncWithHttpInfo

public createDevicePreviewShareLinkAsyncWithHttpInfo(string $run_id[, CreateDevicePreviewShareLinkOptions $create_device_preview_share_link_options = null ][, string $contentType = self::contentTypes['createDevicePreviewShareLink'][0] ]) : PromiseInterface

Create a share link for a device preview run

Parameters
$run_id : string

(required)

$create_device_preview_share_link_options : CreateDevicePreviewShareLinkOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createDevicePreviewShareLinkRequest()

Create request for operation 'createDevicePreviewShareLink'

public createDevicePreviewShareLinkRequest(string $run_id[, CreateDevicePreviewShareLinkOptions $create_device_preview_share_link_options = null ][, string $contentType = self::contentTypes['createDevicePreviewShareLink'][0] ]) : Request
Parameters
$run_id : string

(required)

$create_device_preview_share_link_options : CreateDevicePreviewShareLinkOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

createDevicePreviewShareLinkWithHttpInfo()

Operation createDevicePreviewShareLinkWithHttpInfo

public createDevicePreviewShareLinkWithHttpInfo(string $run_id[, CreateDevicePreviewShareLinkOptions $create_device_preview_share_link_options = null ][, string $contentType = self::contentTypes['createDevicePreviewShareLink'][0] ]) : array<string|int, mixed>

Create a share link for a device preview run

Parameters
$run_id : string

(required)

$create_device_preview_share_link_options : CreateDevicePreviewShareLinkOptions = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['createDevicePreviewShareLink'] 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\DevicePreviewShareLinkDto, HTTP status code, HTTP response headers (array of strings)

deleteDevicePreviewFolder()

Operation deleteDevicePreviewFolder

public deleteDevicePreviewFolder(string $folder_id[, string $contentType = self::contentTypes['deleteDevicePreviewFolder'][0] ]) : DeleteDevicePreviewFolderResult

Delete a folder, preserving renders and child folders

Parameters
$folder_id : string

folder_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DeleteDevicePreviewFolderResult —

deleteDevicePreviewFolderAsync()

Operation deleteDevicePreviewFolderAsync

public deleteDevicePreviewFolderAsync(string $folder_id[, string $contentType = self::contentTypes['deleteDevicePreviewFolder'][0] ]) : PromiseInterface

Delete a folder, preserving renders and child folders

Parameters
$folder_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteDevicePreviewFolderAsyncWithHttpInfo()

Operation deleteDevicePreviewFolderAsyncWithHttpInfo

public deleteDevicePreviewFolderAsyncWithHttpInfo(string $folder_id[, string $contentType = self::contentTypes['deleteDevicePreviewFolder'][0] ]) : PromiseInterface

Delete a folder, preserving renders and child folders

Parameters
$folder_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteDevicePreviewFolderRequest()

Create request for operation 'deleteDevicePreviewFolder'

public deleteDevicePreviewFolderRequest(string $folder_id[, string $contentType = self::contentTypes['deleteDevicePreviewFolder'][0] ]) : Request
Parameters
$folder_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

deleteDevicePreviewFolderWithHttpInfo()

Operation deleteDevicePreviewFolderWithHttpInfo

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

Delete a folder, preserving renders and child folders

Parameters
$folder_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteDevicePreviewFolder'] 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\DeleteDevicePreviewFolderResult, HTTP status code, HTTP response headers (array of strings)

deleteDevicePreviewProfile()

Operation deleteDevicePreviewProfile

public deleteDevicePreviewProfile(string $profile_id[, string $contentType = self::contentTypes['deleteDevicePreviewProfile'][0] ]) : DeleteDevicePreviewProfileResult

Delete a device preview profile

Parameters
$profile_id : string

profile_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DeleteDevicePreviewProfileResult —

deleteDevicePreviewProfileAsync()

Operation deleteDevicePreviewProfileAsync

public deleteDevicePreviewProfileAsync(string $profile_id[, string $contentType = self::contentTypes['deleteDevicePreviewProfile'][0] ]) : PromiseInterface

Delete a device preview profile

Parameters
$profile_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteDevicePreviewProfileAsyncWithHttpInfo()

Operation deleteDevicePreviewProfileAsyncWithHttpInfo

public deleteDevicePreviewProfileAsyncWithHttpInfo(string $profile_id[, string $contentType = self::contentTypes['deleteDevicePreviewProfile'][0] ]) : PromiseInterface

Delete a device preview profile

Parameters
$profile_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteDevicePreviewProfileRequest()

Create request for operation 'deleteDevicePreviewProfile'

public deleteDevicePreviewProfileRequest(string $profile_id[, string $contentType = self::contentTypes['deleteDevicePreviewProfile'][0] ]) : Request
Parameters
$profile_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

deleteDevicePreviewProfileWithHttpInfo()

Operation deleteDevicePreviewProfileWithHttpInfo

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

Delete a device preview profile

Parameters
$profile_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteDevicePreviewProfile'] 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\DeleteDevicePreviewProfileResult, HTTP status code, HTTP response headers (array of strings)

deleteDevicePreviewRun()

Operation deleteDevicePreviewRun

public deleteDevicePreviewRun(string $run_id[, string $contentType = self::contentTypes['deleteDevicePreviewRun'][0] ]) : DeleteDevicePreviewRunResult

Delete local device preview run data

Parameters
$run_id : string

run_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DeleteDevicePreviewRunResult —

deleteDevicePreviewRunAsync()

Operation deleteDevicePreviewRunAsync

public deleteDevicePreviewRunAsync(string $run_id[, string $contentType = self::contentTypes['deleteDevicePreviewRun'][0] ]) : PromiseInterface

Delete local device preview run data

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteDevicePreviewRunAsyncWithHttpInfo()

Operation deleteDevicePreviewRunAsyncWithHttpInfo

public deleteDevicePreviewRunAsyncWithHttpInfo(string $run_id[, string $contentType = self::contentTypes['deleteDevicePreviewRun'][0] ]) : PromiseInterface

Delete local device preview run data

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteDevicePreviewRunRequest()

Create request for operation 'deleteDevicePreviewRun'

public deleteDevicePreviewRunRequest(string $run_id[, string $contentType = self::contentTypes['deleteDevicePreviewRun'][0] ]) : Request
Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

deleteDevicePreviewRunWithHttpInfo()

Operation deleteDevicePreviewRunWithHttpInfo

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

Delete local device preview run data

Parameters
$run_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteDevicePreviewRun'] 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\DeleteDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

Operation deleteDevicePreviewShareLink

public deleteDevicePreviewShareLink(string $share_link_id[, string $contentType = self::contentTypes['deleteDevicePreviewShareLink'][0] ]) : DeleteDevicePreviewShareLinkResult

Revoke a device preview share link

Parameters
$share_link_id : string

share_link_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DeleteDevicePreviewShareLinkResult —

deleteDevicePreviewShareLinkAsync()

Operation deleteDevicePreviewShareLinkAsync

public deleteDevicePreviewShareLinkAsync(string $share_link_id[, string $contentType = self::contentTypes['deleteDevicePreviewShareLink'][0] ]) : PromiseInterface

Revoke a device preview share link

Parameters
$share_link_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteDevicePreviewShareLinkAsyncWithHttpInfo()

Operation deleteDevicePreviewShareLinkAsyncWithHttpInfo

public deleteDevicePreviewShareLinkAsyncWithHttpInfo(string $share_link_id[, string $contentType = self::contentTypes['deleteDevicePreviewShareLink'][0] ]) : PromiseInterface

Revoke a device preview share link

Parameters
$share_link_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteDevicePreviewShareLinkRequest()

Create request for operation 'deleteDevicePreviewShareLink'

public deleteDevicePreviewShareLinkRequest(string $share_link_id[, string $contentType = self::contentTypes['deleteDevicePreviewShareLink'][0] ]) : Request
Parameters
$share_link_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

deleteDevicePreviewShareLinkWithHttpInfo()

Operation deleteDevicePreviewShareLinkWithHttpInfo

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

Revoke a device preview share link

Parameters
$share_link_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['deleteDevicePreviewShareLink'] 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\DeleteDevicePreviewShareLinkResult, HTTP status code, HTTP response headers (array of strings)

downloadDevicePreviewEmailSubmissionSourceEmail()

Operation downloadDevicePreviewEmailSubmissionSourceEmail

public downloadDevicePreviewEmailSubmissionSourceEmail(string $submission_id[, string $contentType = self::contentTypes['downloadDevicePreviewEmailSubmissionSourceEmail'][0] ]) : SplFileObject

Download the original RFC822 email for a device preview submission

Parameters
$submission_id : string

submission_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
SplFileObject —

downloadDevicePreviewEmailSubmissionSourceEmailAsync()

Operation downloadDevicePreviewEmailSubmissionSourceEmailAsync

public downloadDevicePreviewEmailSubmissionSourceEmailAsync(string $submission_id[, string $contentType = self::contentTypes['downloadDevicePreviewEmailSubmissionSourceEmail'][0] ]) : PromiseInterface

Download the original RFC822 email for a device preview submission

Parameters
$submission_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

downloadDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo()

Operation downloadDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo

public downloadDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo(string $submission_id[, string $contentType = self::contentTypes['downloadDevicePreviewEmailSubmissionSourceEmail'][0] ]) : PromiseInterface

Download the original RFC822 email for a device preview submission

Parameters
$submission_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

downloadDevicePreviewEmailSubmissionSourceEmailRequest()

Create request for operation 'downloadDevicePreviewEmailSubmissionSourceEmail'

public downloadDevicePreviewEmailSubmissionSourceEmailRequest(string $submission_id[, string $contentType = self::contentTypes['downloadDevicePreviewEmailSubmissionSourceEmail'][0] ]) : Request
Parameters
$submission_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

downloadDevicePreviewEmailSubmissionSourceEmailWithHttpInfo()

Operation downloadDevicePreviewEmailSubmissionSourceEmailWithHttpInfo

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

Download the original RFC822 email for a device preview submission

Parameters
$submission_id : string

(required)

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

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

Tags
throws
ApiException

on non-2xx response

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

of \SplFileObject, HTTP status code, HTTP response headers (array of strings)

downloadDevicePreviewRunSourceEmail()

Operation downloadDevicePreviewRunSourceEmail

public downloadDevicePreviewRunSourceEmail(string $run_id[, string $contentType = self::contentTypes['downloadDevicePreviewRunSourceEmail'][0] ]) : SplFileObject

Download the original RFC822 email for a device preview run

Parameters
$run_id : string

run_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
SplFileObject —

downloadDevicePreviewRunSourceEmailAsync()

Operation downloadDevicePreviewRunSourceEmailAsync

public downloadDevicePreviewRunSourceEmailAsync(string $run_id[, string $contentType = self::contentTypes['downloadDevicePreviewRunSourceEmail'][0] ]) : PromiseInterface

Download the original RFC822 email for a device preview run

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

downloadDevicePreviewRunSourceEmailAsyncWithHttpInfo()

Operation downloadDevicePreviewRunSourceEmailAsyncWithHttpInfo

public downloadDevicePreviewRunSourceEmailAsyncWithHttpInfo(string $run_id[, string $contentType = self::contentTypes['downloadDevicePreviewRunSourceEmail'][0] ]) : PromiseInterface

Download the original RFC822 email for a device preview run

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

downloadDevicePreviewRunSourceEmailRequest()

Create request for operation 'downloadDevicePreviewRunSourceEmail'

public downloadDevicePreviewRunSourceEmailRequest(string $run_id[, string $contentType = self::contentTypes['downloadDevicePreviewRunSourceEmail'][0] ]) : Request
Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

downloadDevicePreviewRunSourceEmailWithHttpInfo()

Operation downloadDevicePreviewRunSourceEmailWithHttpInfo

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

Download the original RFC822 email for a device preview run

Parameters
$run_id : string

(required)

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

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

Tags
throws
ApiException

on non-2xx response

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

of \SplFileObject, HTTP status code, HTTP response headers (array of strings)

ensureDevicePreviewRun()

Operation ensureDevicePreviewRun

public ensureDevicePreviewRun(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['ensureDevicePreviewRun'][0] ]) : CreateDevicePreviewRunResult

Return active run for email or create one when none exists

Parameters
$email_id : string

email_id (required)

$create_device_preview_options : CreateDevicePreviewOptions = null

create_device_preview_options (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
CreateDevicePreviewRunResult —

ensureDevicePreviewRunAsync()

Operation ensureDevicePreviewRunAsync

public ensureDevicePreviewRunAsync(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['ensureDevicePreviewRun'][0] ]) : PromiseInterface

Return active run for email or create one when none exists

Parameters
$email_id : string

(required)

$create_device_preview_options : CreateDevicePreviewOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

ensureDevicePreviewRunAsyncWithHttpInfo()

Operation ensureDevicePreviewRunAsyncWithHttpInfo

public ensureDevicePreviewRunAsyncWithHttpInfo(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['ensureDevicePreviewRun'][0] ]) : PromiseInterface

Return active run for email or create one when none exists

Parameters
$email_id : string

(required)

$create_device_preview_options : CreateDevicePreviewOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

ensureDevicePreviewRunRequest()

Create request for operation 'ensureDevicePreviewRun'

public ensureDevicePreviewRunRequest(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['ensureDevicePreviewRun'][0] ]) : Request
Parameters
$email_id : string

(required)

$create_device_preview_options : CreateDevicePreviewOptions = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

ensureDevicePreviewRunWithHttpInfo()

Operation ensureDevicePreviewRunWithHttpInfo

public ensureDevicePreviewRunWithHttpInfo(string $email_id[, CreateDevicePreviewOptions $create_device_preview_options = null ][, string $contentType = self::contentTypes['ensureDevicePreviewRun'][0] ]) : array<string|int, mixed>

Return active run for email or create one when none exists

Parameters
$email_id : string

(required)

$create_device_preview_options : CreateDevicePreviewOptions = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['ensureDevicePreviewRun'] 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\CreateDevicePreviewRunResult, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewEmailDomainOrCreate()

Operation getDevicePreviewEmailDomainOrCreate

public getDevicePreviewEmailDomainOrCreate([string $contentType = self::contentTypes['getDevicePreviewEmailDomainOrCreate'][0] ]) : DevicePreviewAccountSettingsDto

Return account device preview email domain setup or create one

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewAccountSettingsDto —

getDevicePreviewEmailDomainOrCreateAsync()

Operation getDevicePreviewEmailDomainOrCreateAsync

public getDevicePreviewEmailDomainOrCreateAsync([string $contentType = self::contentTypes['getDevicePreviewEmailDomainOrCreate'][0] ]) : PromiseInterface

Return account device preview email domain setup or create one

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewEmailDomainOrCreateAsyncWithHttpInfo()

Operation getDevicePreviewEmailDomainOrCreateAsyncWithHttpInfo

public getDevicePreviewEmailDomainOrCreateAsyncWithHttpInfo([string $contentType = self::contentTypes['getDevicePreviewEmailDomainOrCreate'][0] ]) : PromiseInterface

Return account device preview email domain setup or create one

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewEmailDomainOrCreateRequest()

Create request for operation 'getDevicePreviewEmailDomainOrCreate'

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewEmailDomainOrCreateWithHttpInfo()

Operation getDevicePreviewEmailDomainOrCreateWithHttpInfo

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

Return account device preview email domain setup or create one

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewEmailDomainOrCreate'] 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\DevicePreviewAccountSettingsDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewEmailRuns()

Operation getDevicePreviewEmailRuns

public getDevicePreviewEmailRuns(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewEmailRuns'][0] ]) : array<string|int, DevicePreviewRunDto>

List device preview runs created from account email domains

Parameters
$since : DateTime

since (required)

$email_domain_id : string = null

email_domain_id (optional)

$profile_id : string = null

profile_id (optional)

$local_part : string = null

local_part (optional)

$limit : int = 20

limit (optional, default to 20)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, DevicePreviewRunDto> —

getDevicePreviewEmailRunsAsync()

Operation getDevicePreviewEmailRunsAsync

public getDevicePreviewEmailRunsAsync(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewEmailRuns'][0] ]) : PromiseInterface

List device preview runs created from account email domains

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewEmailRunsAsyncWithHttpInfo()

Operation getDevicePreviewEmailRunsAsyncWithHttpInfo

public getDevicePreviewEmailRunsAsyncWithHttpInfo(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewEmailRuns'][0] ]) : PromiseInterface

List device preview runs created from account email domains

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewEmailRunsRequest()

Create request for operation 'getDevicePreviewEmailRuns'

public getDevicePreviewEmailRunsRequest(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewEmailRuns'][0] ]) : Request
Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewEmailRunsWithHttpInfo()

Operation getDevicePreviewEmailRunsWithHttpInfo

public getDevicePreviewEmailRunsWithHttpInfo(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewEmailRuns'][0] ]) : array<string|int, mixed>

List device preview runs created from account email domains

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewEmailRuns'] 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\DevicePreviewRunDto[], HTTP status code, HTTP response headers (array of strings)

getDevicePreviewEmailSubmissions()

Operation getDevicePreviewEmailSubmissions

public getDevicePreviewEmailSubmissions(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissions'][0] ]) : array<string|int, DevicePreviewEmailSubmissionDto>

List received device preview email submissions

Parameters
$since : DateTime

since (required)

$email_domain_id : string = null

email_domain_id (optional)

$profile_id : string = null

profile_id (optional)

$local_part : string = null

local_part (optional)

$limit : int = 20

limit (optional, default to 20)

$recipient_email_address : string = null

recipient_email_address (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, DevicePreviewEmailSubmissionDto> —

getDevicePreviewEmailSubmissionsAsync()

Operation getDevicePreviewEmailSubmissionsAsync

public getDevicePreviewEmailSubmissionsAsync(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissions'][0] ]) : PromiseInterface

List received device preview email submissions

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$recipient_email_address : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewEmailSubmissionsAsyncWithHttpInfo()

Operation getDevicePreviewEmailSubmissionsAsyncWithHttpInfo

public getDevicePreviewEmailSubmissionsAsyncWithHttpInfo(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissions'][0] ]) : PromiseInterface

List received device preview email submissions

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$recipient_email_address : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewEmailSubmissionSourceEmail()

Operation getDevicePreviewEmailSubmissionSourceEmail

public getDevicePreviewEmailSubmissionSourceEmail(string $submission_id[, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissionSourceEmail'][0] ]) : DevicePreviewSourceEmailDto

Get the original email content for a device preview submission

Parameters
$submission_id : string

submission_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewSourceEmailDto —

getDevicePreviewEmailSubmissionSourceEmailAsync()

Operation getDevicePreviewEmailSubmissionSourceEmailAsync

public getDevicePreviewEmailSubmissionSourceEmailAsync(string $submission_id[, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissionSourceEmail'][0] ]) : PromiseInterface

Get the original email content for a device preview submission

Parameters
$submission_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo()

Operation getDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo

public getDevicePreviewEmailSubmissionSourceEmailAsyncWithHttpInfo(string $submission_id[, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissionSourceEmail'][0] ]) : PromiseInterface

Get the original email content for a device preview submission

Parameters
$submission_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewEmailSubmissionSourceEmailRequest()

Create request for operation 'getDevicePreviewEmailSubmissionSourceEmail'

public getDevicePreviewEmailSubmissionSourceEmailRequest(string $submission_id[, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissionSourceEmail'][0] ]) : Request
Parameters
$submission_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewEmailSubmissionSourceEmailWithHttpInfo()

Operation getDevicePreviewEmailSubmissionSourceEmailWithHttpInfo

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

Get the original email content for a device preview submission

Parameters
$submission_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewEmailSubmissionSourceEmail'] 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\DevicePreviewSourceEmailDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewEmailSubmissionsRequest()

Create request for operation 'getDevicePreviewEmailSubmissions'

public getDevicePreviewEmailSubmissionsRequest(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissions'][0] ]) : Request
Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$recipient_email_address : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewEmailSubmissionsWithHttpInfo()

Operation getDevicePreviewEmailSubmissionsWithHttpInfo

public getDevicePreviewEmailSubmissionsWithHttpInfo(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['getDevicePreviewEmailSubmissions'][0] ]) : array<string|int, mixed>

List received device preview email submissions

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$recipient_email_address : string = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewEmailSubmissions'] 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\DevicePreviewEmailSubmissionDto[], HTTP status code, HTTP response headers (array of strings)

getDevicePreviewFeedback()

Operation getDevicePreviewFeedback

public getDevicePreviewFeedback(string $feedback_id[, string $contentType = self::contentTypes['getDevicePreviewFeedback'][0] ]) : DevicePreviewFeedbackDto

Get a single device preview feedback item

Parameters
$feedback_id : string

feedback_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewFeedbackDto —

getDevicePreviewFeedbackAsync()

Operation getDevicePreviewFeedbackAsync

public getDevicePreviewFeedbackAsync(string $feedback_id[, string $contentType = self::contentTypes['getDevicePreviewFeedback'][0] ]) : PromiseInterface

Get a single device preview feedback item

Parameters
$feedback_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewFeedbackAsyncWithHttpInfo()

Operation getDevicePreviewFeedbackAsyncWithHttpInfo

public getDevicePreviewFeedbackAsyncWithHttpInfo(string $feedback_id[, string $contentType = self::contentTypes['getDevicePreviewFeedback'][0] ]) : PromiseInterface

Get a single device preview feedback item

Parameters
$feedback_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewFeedbackItems()

Operation getDevicePreviewFeedbackItems

public getDevicePreviewFeedbackItems([int $page = null ][, int $size = null ][, string $source = null ][, string $run_id = null ][, string $status = null ][, string $provider = null ][, string $category = null ][, string $search = null ][, string $contentType = self::contentTypes['getDevicePreviewFeedbackItems'][0] ]) : DevicePreviewFeedbackListDto

List device preview feedback

Parameters
$page : int = null

page (optional)

$size : int = null

size (optional)

$source : string = null

source (optional)

$run_id : string = null

run_id (optional)

$status : string = null

status (optional)

$provider : string = null

provider (optional)

$category : string = null

category (optional)

$search : string = null

search (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewFeedbackListDto —

getDevicePreviewFeedbackItemsAsync()

Operation getDevicePreviewFeedbackItemsAsync

public getDevicePreviewFeedbackItemsAsync([int $page = null ][, int $size = null ][, string $source = null ][, string $run_id = null ][, string $status = null ][, string $provider = null ][, string $category = null ][, string $search = null ][, string $contentType = self::contentTypes['getDevicePreviewFeedbackItems'][0] ]) : PromiseInterface

List device preview feedback

Parameters
$page : int = null

(optional)

$size : int = null

(optional)

$source : string = null

(optional)

$run_id : string = null

(optional)

$status : string = null

(optional)

$provider : string = null

(optional)

$category : string = null

(optional)

$search : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewFeedbackItemsAsyncWithHttpInfo()

Operation getDevicePreviewFeedbackItemsAsyncWithHttpInfo

public getDevicePreviewFeedbackItemsAsyncWithHttpInfo([int $page = null ][, int $size = null ][, string $source = null ][, string $run_id = null ][, string $status = null ][, string $provider = null ][, string $category = null ][, string $search = null ][, string $contentType = self::contentTypes['getDevicePreviewFeedbackItems'][0] ]) : PromiseInterface

List device preview feedback

Parameters
$page : int = null

(optional)

$size : int = null

(optional)

$source : string = null

(optional)

$run_id : string = null

(optional)

$status : string = null

(optional)

$provider : string = null

(optional)

$category : string = null

(optional)

$search : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewFeedbackItemsRequest()

Create request for operation 'getDevicePreviewFeedbackItems'

public getDevicePreviewFeedbackItemsRequest([int $page = null ][, int $size = null ][, string $source = null ][, string $run_id = null ][, string $status = null ][, string $provider = null ][, string $category = null ][, string $search = null ][, string $contentType = self::contentTypes['getDevicePreviewFeedbackItems'][0] ]) : Request
Parameters
$page : int = null

(optional)

$size : int = null

(optional)

$source : string = null

(optional)

$run_id : string = null

(optional)

$status : string = null

(optional)

$provider : string = null

(optional)

$category : string = null

(optional)

$search : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewFeedbackItemsWithHttpInfo()

Operation getDevicePreviewFeedbackItemsWithHttpInfo

public getDevicePreviewFeedbackItemsWithHttpInfo([int $page = null ][, int $size = null ][, string $source = null ][, string $run_id = null ][, string $status = null ][, string $provider = null ][, string $category = null ][, string $search = null ][, string $contentType = self::contentTypes['getDevicePreviewFeedbackItems'][0] ]) : array<string|int, mixed>

List device preview feedback

Parameters
$page : int = null

(optional)

$size : int = null

(optional)

$source : string = null

(optional)

$run_id : string = null

(optional)

$status : string = null

(optional)

$provider : string = null

(optional)

$category : string = null

(optional)

$search : string = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewFeedbackItems'] 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\DevicePreviewFeedbackListDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewFeedbackRequest()

Create request for operation 'getDevicePreviewFeedback'

public getDevicePreviewFeedbackRequest(string $feedback_id[, string $contentType = self::contentTypes['getDevicePreviewFeedback'][0] ]) : Request
Parameters
$feedback_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewFeedbackWithHttpInfo()

Operation getDevicePreviewFeedbackWithHttpInfo

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

Get a single device preview feedback item

Parameters
$feedback_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewFeedback'] 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\DevicePreviewFeedbackDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewFolder()

Operation getDevicePreviewFolder

public getDevicePreviewFolder(string $folder_id[, string $contentType = self::contentTypes['getDevicePreviewFolder'][0] ]) : DevicePreviewFolderDto

Get a device preview folder

Parameters
$folder_id : string

folder_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewFolderDto —

getDevicePreviewFolderAsync()

Operation getDevicePreviewFolderAsync

public getDevicePreviewFolderAsync(string $folder_id[, string $contentType = self::contentTypes['getDevicePreviewFolder'][0] ]) : PromiseInterface

Get a device preview folder

Parameters
$folder_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewFolderAsyncWithHttpInfo()

Operation getDevicePreviewFolderAsyncWithHttpInfo

public getDevicePreviewFolderAsyncWithHttpInfo(string $folder_id[, string $contentType = self::contentTypes['getDevicePreviewFolder'][0] ]) : PromiseInterface

Get a device preview folder

Parameters
$folder_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewFolderRequest()

Create request for operation 'getDevicePreviewFolder'

public getDevicePreviewFolderRequest(string $folder_id[, string $contentType = self::contentTypes['getDevicePreviewFolder'][0] ]) : Request
Parameters
$folder_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewFolders()

Operation getDevicePreviewFolders

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

List device preview folders

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, DevicePreviewFolderDto> —

getDevicePreviewFoldersAsync()

Operation getDevicePreviewFoldersAsync

public getDevicePreviewFoldersAsync([string $contentType = self::contentTypes['getDevicePreviewFolders'][0] ]) : PromiseInterface

List device preview folders

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewFoldersAsyncWithHttpInfo()

Operation getDevicePreviewFoldersAsyncWithHttpInfo

public getDevicePreviewFoldersAsyncWithHttpInfo([string $contentType = self::contentTypes['getDevicePreviewFolders'][0] ]) : PromiseInterface

List device preview folders

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewFoldersRequest()

Create request for operation 'getDevicePreviewFolders'

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewFoldersWithHttpInfo()

Operation getDevicePreviewFoldersWithHttpInfo

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

List device preview folders

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewFolders'] 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\DevicePreviewFolderDto[], HTTP status code, HTTP response headers (array of strings)

getDevicePreviewFolderWithHttpInfo()

Operation getDevicePreviewFolderWithHttpInfo

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

Get a device preview folder

Parameters
$folder_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewFolder'] 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\DevicePreviewFolderDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewImportAddress()

Operation getDevicePreviewImportAddress

public getDevicePreviewImportAddress(string $session_id[, string $contentType = self::contentTypes['getDevicePreviewImportAddress'][0] ]) : DevicePreviewIngestAddressDto

Get temporary device preview import address status

Parameters
$session_id : string

session_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewIngestAddressDto —

getDevicePreviewImportAddressAsync()

Operation getDevicePreviewImportAddressAsync

public getDevicePreviewImportAddressAsync(string $session_id[, string $contentType = self::contentTypes['getDevicePreviewImportAddress'][0] ]) : PromiseInterface

Get temporary device preview import address status

Parameters
$session_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewImportAddressAsyncWithHttpInfo()

Operation getDevicePreviewImportAddressAsyncWithHttpInfo

public getDevicePreviewImportAddressAsyncWithHttpInfo(string $session_id[, string $contentType = self::contentTypes['getDevicePreviewImportAddress'][0] ]) : PromiseInterface

Get temporary device preview import address status

Parameters
$session_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewImportAddressRequest()

Create request for operation 'getDevicePreviewImportAddress'

public getDevicePreviewImportAddressRequest(string $session_id[, string $contentType = self::contentTypes['getDevicePreviewImportAddress'][0] ]) : Request
Parameters
$session_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewImportAddressWithHttpInfo()

Operation getDevicePreviewImportAddressWithHttpInfo

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

Get temporary device preview import address status

Parameters
$session_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewImportAddress'] 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\DevicePreviewIngestAddressDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewNativeTargetAvailability()

Operation getDevicePreviewNativeTargetAvailability

public getDevicePreviewNativeTargetAvailability([string $contentType = self::contentTypes['getDevicePreviewNativeTargetAvailability'][0] ]) : DevicePreviewNativeTargetAvailabilityListDto

Get native device preview target availability

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewNativeTargetAvailabilityListDto —

getDevicePreviewNativeTargetAvailabilityAsync()

Operation getDevicePreviewNativeTargetAvailabilityAsync

public getDevicePreviewNativeTargetAvailabilityAsync([string $contentType = self::contentTypes['getDevicePreviewNativeTargetAvailability'][0] ]) : PromiseInterface

Get native device preview target availability

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewNativeTargetAvailabilityAsyncWithHttpInfo()

Operation getDevicePreviewNativeTargetAvailabilityAsyncWithHttpInfo

public getDevicePreviewNativeTargetAvailabilityAsyncWithHttpInfo([string $contentType = self::contentTypes['getDevicePreviewNativeTargetAvailability'][0] ]) : PromiseInterface

Get native device preview target availability

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewNativeTargetAvailabilityRequest()

Create request for operation 'getDevicePreviewNativeTargetAvailability'

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewNativeTargetAvailabilityWithHttpInfo()

Operation getDevicePreviewNativeTargetAvailabilityWithHttpInfo

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

Get native device preview target availability

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewNativeTargetAvailability'] 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\DevicePreviewNativeTargetAvailabilityListDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewProfile()

Operation getDevicePreviewProfile

public getDevicePreviewProfile(string $profile_id[, string $contentType = self::contentTypes['getDevicePreviewProfile'][0] ]) : DevicePreviewProfileDto

Get a device preview profile

Parameters
$profile_id : string

profile_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewProfileDto —

getDevicePreviewProfileAsync()

Operation getDevicePreviewProfileAsync

public getDevicePreviewProfileAsync(string $profile_id[, string $contentType = self::contentTypes['getDevicePreviewProfile'][0] ]) : PromiseInterface

Get a device preview profile

Parameters
$profile_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewProfileAsyncWithHttpInfo()

Operation getDevicePreviewProfileAsyncWithHttpInfo

public getDevicePreviewProfileAsyncWithHttpInfo(string $profile_id[, string $contentType = self::contentTypes['getDevicePreviewProfile'][0] ]) : PromiseInterface

Get a device preview profile

Parameters
$profile_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewProfileRequest()

Create request for operation 'getDevicePreviewProfile'

public getDevicePreviewProfileRequest(string $profile_id[, string $contentType = self::contentTypes['getDevicePreviewProfile'][0] ]) : Request
Parameters
$profile_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewProfiles()

Operation getDevicePreviewProfiles

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

List device preview profiles

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, DevicePreviewProfileDto> —

getDevicePreviewProfilesAsync()

Operation getDevicePreviewProfilesAsync

public getDevicePreviewProfilesAsync([string $contentType = self::contentTypes['getDevicePreviewProfiles'][0] ]) : PromiseInterface

List device preview profiles

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewProfilesAsyncWithHttpInfo()

Operation getDevicePreviewProfilesAsyncWithHttpInfo

public getDevicePreviewProfilesAsyncWithHttpInfo([string $contentType = self::contentTypes['getDevicePreviewProfiles'][0] ]) : PromiseInterface

List device preview profiles

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewProfilesRequest()

Create request for operation 'getDevicePreviewProfiles'

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewProfilesWithHttpInfo()

Operation getDevicePreviewProfilesWithHttpInfo

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

List device preview profiles

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewProfiles'] 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\DevicePreviewProfileDto[], HTTP status code, HTTP response headers (array of strings)

getDevicePreviewProfileWithHttpInfo()

Operation getDevicePreviewProfileWithHttpInfo

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

Get a device preview profile

Parameters
$profile_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewProfile'] 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\DevicePreviewProfileDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewRun()

Operation getDevicePreviewRun

public getDevicePreviewRun(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRun'][0] ]) : DevicePreviewRunDto

Get device preview run status

Parameters
$run_id : string

run_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewRunDto —

getDevicePreviewRunAsync()

Operation getDevicePreviewRunAsync

public getDevicePreviewRunAsync(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRun'][0] ]) : PromiseInterface

Get device preview run status

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunAsyncWithHttpInfo()

Operation getDevicePreviewRunAsyncWithHttpInfo

public getDevicePreviewRunAsyncWithHttpInfo(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRun'][0] ]) : PromiseInterface

Get device preview run status

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunProviderProgress()

Operation getDevicePreviewRunProviderProgress

public getDevicePreviewRunProviderProgress(string $run_id, string $provider[, string $contentType = self::contentTypes['getDevicePreviewRunProviderProgress'][0] ]) : DevicePreviewProviderProgressDto

Get provider-level progress for a device preview run

Parameters
$run_id : string

run_id (required)

$provider : string

provider (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewProviderProgressDto —

getDevicePreviewRunProviderProgressAsync()

Operation getDevicePreviewRunProviderProgressAsync

public getDevicePreviewRunProviderProgressAsync(string $run_id, string $provider[, string $contentType = self::contentTypes['getDevicePreviewRunProviderProgress'][0] ]) : PromiseInterface

Get provider-level progress for a device preview run

Parameters
$run_id : string

(required)

$provider : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunProviderProgressAsyncWithHttpInfo()

Operation getDevicePreviewRunProviderProgressAsyncWithHttpInfo

public getDevicePreviewRunProviderProgressAsyncWithHttpInfo(string $run_id, string $provider[, string $contentType = self::contentTypes['getDevicePreviewRunProviderProgress'][0] ]) : PromiseInterface

Get provider-level progress for a device preview run

Parameters
$run_id : string

(required)

$provider : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunProviderProgressRequest()

Create request for operation 'getDevicePreviewRunProviderProgress'

public getDevicePreviewRunProviderProgressRequest(string $run_id, string $provider[, string $contentType = self::contentTypes['getDevicePreviewRunProviderProgress'][0] ]) : Request
Parameters
$run_id : string

(required)

$provider : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunProviderProgressWithHttpInfo()

Operation getDevicePreviewRunProviderProgressWithHttpInfo

public getDevicePreviewRunProviderProgressWithHttpInfo(string $run_id, string $provider[, string $contentType = self::contentTypes['getDevicePreviewRunProviderProgress'][0] ]) : array<string|int, mixed>

Get provider-level progress for a device preview run

Parameters
$run_id : string

(required)

$provider : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewRunProviderProgress'] 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\DevicePreviewProviderProgressDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewRunRequest()

Create request for operation 'getDevicePreviewRun'

public getDevicePreviewRunRequest(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRun'][0] ]) : Request
Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunResults()

Operation getDevicePreviewRunResults

public getDevicePreviewRunResults(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRunResults'][0] ]) : DevicePreviewRunResultsDto

Get device preview run results

Parameters
$run_id : string

run_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewRunResultsDto —

getDevicePreviewRunResultsAsync()

Operation getDevicePreviewRunResultsAsync

public getDevicePreviewRunResultsAsync(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRunResults'][0] ]) : PromiseInterface

Get device preview run results

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunResultsAsyncWithHttpInfo()

Operation getDevicePreviewRunResultsAsyncWithHttpInfo

public getDevicePreviewRunResultsAsyncWithHttpInfo(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRunResults'][0] ]) : PromiseInterface

Get device preview run results

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunResultsRequest()

Create request for operation 'getDevicePreviewRunResults'

public getDevicePreviewRunResultsRequest(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRunResults'][0] ]) : Request
Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunResultsWithHttpInfo()

Operation getDevicePreviewRunResultsWithHttpInfo

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

Get device preview run results

Parameters
$run_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewRunResults'] 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\DevicePreviewRunResultsDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewRuns()

Operation getDevicePreviewRuns

public getDevicePreviewRuns(string $email_id[, int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRuns'][0] ]) : array<string|int, DevicePreviewRunDto>

List previous device preview runs for an email

Parameters
$email_id : string

email_id (required)

$limit : int = 50

limit (optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, DevicePreviewRunDto> —

getDevicePreviewRunsAsync()

Operation getDevicePreviewRunsAsync

public getDevicePreviewRunsAsync(string $email_id[, int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRuns'][0] ]) : PromiseInterface

List previous device preview runs for an email

Parameters
$email_id : string

(required)

$limit : int = 50

(optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunsAsyncWithHttpInfo()

Operation getDevicePreviewRunsAsyncWithHttpInfo

public getDevicePreviewRunsAsyncWithHttpInfo(string $email_id[, int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRuns'][0] ]) : PromiseInterface

List previous device preview runs for an email

Parameters
$email_id : string

(required)

$limit : int = 50

(optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunScreenshot()

Operation getDevicePreviewRunScreenshot

public getDevicePreviewRunScreenshot(string $run_id, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewRunScreenshot'][0] ]) : string

Get a device preview screenshot image

Parameters
$run_id : string

run_id (required)

$screenshot_id : string

screenshot_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
string —

getDevicePreviewRunScreenshotAsync()

Operation getDevicePreviewRunScreenshotAsync

public getDevicePreviewRunScreenshotAsync(string $run_id, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewRunScreenshot'][0] ]) : PromiseInterface

Get a device preview screenshot image

Parameters
$run_id : string

(required)

$screenshot_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunScreenshotAsyncWithHttpInfo()

Operation getDevicePreviewRunScreenshotAsyncWithHttpInfo

public getDevicePreviewRunScreenshotAsyncWithHttpInfo(string $run_id, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewRunScreenshot'][0] ]) : PromiseInterface

Get a device preview screenshot image

Parameters
$run_id : string

(required)

$screenshot_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunScreenshotRequest()

Create request for operation 'getDevicePreviewRunScreenshot'

public getDevicePreviewRunScreenshotRequest(string $run_id, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewRunScreenshot'][0] ]) : Request
Parameters
$run_id : string

(required)

$screenshot_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunScreenshotWithHttpInfo()

Operation getDevicePreviewRunScreenshotWithHttpInfo

public getDevicePreviewRunScreenshotWithHttpInfo(string $run_id, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewRunScreenshot'][0] ]) : array<string|int, mixed>

Get a device preview screenshot image

Parameters
$run_id : string

(required)

$screenshot_id : string

(required)

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

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

Tags
throws
ApiException

on non-2xx response

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

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

getDevicePreviewRunsForAccount()

Operation getDevicePreviewRunsForAccount

public getDevicePreviewRunsForAccount([int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccount'][0] ]) : array<string|int, DevicePreviewRunDto>

List previous device preview runs for account

Parameters
$limit : int = 50

limit (optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, DevicePreviewRunDto> —

getDevicePreviewRunsForAccountAsync()

Operation getDevicePreviewRunsForAccountAsync

public getDevicePreviewRunsForAccountAsync([int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccount'][0] ]) : PromiseInterface

List previous device preview runs for account

Parameters
$limit : int = 50

(optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunsForAccountAsyncWithHttpInfo()

Operation getDevicePreviewRunsForAccountAsyncWithHttpInfo

public getDevicePreviewRunsForAccountAsyncWithHttpInfo([int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccount'][0] ]) : PromiseInterface

List previous device preview runs for account

Parameters
$limit : int = 50

(optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunsForAccountOffsetPaginated()

Operation getDevicePreviewRunsForAccountOffsetPaginated

public getDevicePreviewRunsForAccountOffsetPaginated(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $folder_id = null ][, bool $unfiled_only = false ][, string $email_id = null ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccountOffsetPaginated'][0] ]) : PageDevicePreviewRunProjection

List previous device preview runs for account in paginated form

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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

$folder_id : string = null

folder_id (optional)

$unfiled_only : bool = false

unfiled_only (optional, default to false)

$email_id : string = null

email_id (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageDevicePreviewRunProjection —

getDevicePreviewRunsForAccountOffsetPaginatedAsync()

Operation getDevicePreviewRunsForAccountOffsetPaginatedAsync

public getDevicePreviewRunsForAccountOffsetPaginatedAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $folder_id = null ][, bool $unfiled_only = false ][, string $email_id = null ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccountOffsetPaginated'][0] ]) : PromiseInterface

List previous device preview runs for account in paginated form

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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

$folder_id : string = null

(optional)

$unfiled_only : bool = false

(optional, default to false)

$email_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunsForAccountOffsetPaginatedAsyncWithHttpInfo()

Operation getDevicePreviewRunsForAccountOffsetPaginatedAsyncWithHttpInfo

public getDevicePreviewRunsForAccountOffsetPaginatedAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $folder_id = null ][, bool $unfiled_only = false ][, string $email_id = null ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccountOffsetPaginated'][0] ]) : PromiseInterface

List previous device preview runs for account in paginated form

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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

$folder_id : string = null

(optional)

$unfiled_only : bool = false

(optional, default to false)

$email_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunsForAccountOffsetPaginatedRequest()

Create request for operation 'getDevicePreviewRunsForAccountOffsetPaginated'

public getDevicePreviewRunsForAccountOffsetPaginatedRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $folder_id = null ][, bool $unfiled_only = false ][, string $email_id = null ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccountOffsetPaginated'][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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

$folder_id : string = null

(optional)

$unfiled_only : bool = false

(optional, default to false)

$email_id : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunsForAccountOffsetPaginatedWithHttpInfo()

Operation getDevicePreviewRunsForAccountOffsetPaginatedWithHttpInfo

public getDevicePreviewRunsForAccountOffsetPaginatedWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $folder_id = null ][, bool $unfiled_only = false ][, string $email_id = null ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccountOffsetPaginated'][0] ]) : array<string|int, mixed>

List previous device preview runs for account in paginated form

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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

$folder_id : string = null

(optional)

$unfiled_only : bool = false

(optional, default to false)

$email_id : string = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewRunsForAccountOffsetPaginated'] 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\PageDevicePreviewRunProjection, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewRunsForAccountRequest()

Create request for operation 'getDevicePreviewRunsForAccount'

public getDevicePreviewRunsForAccountRequest([int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccount'][0] ]) : Request
Parameters
$limit : int = 50

(optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunsForAccountWithHttpInfo()

Operation getDevicePreviewRunsForAccountWithHttpInfo

public getDevicePreviewRunsForAccountWithHttpInfo([int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsForAccount'][0] ]) : array<string|int, mixed>

List previous device preview runs for account

Parameters
$limit : int = 50

(optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewRunsForAccount'] 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\DevicePreviewRunDto[], HTTP status code, HTTP response headers (array of strings)

getDevicePreviewRunsOffsetPaginated()

Operation getDevicePreviewRunsOffsetPaginated

public getDevicePreviewRunsOffsetPaginated(string $email_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsOffsetPaginated'][0] ]) : PageDevicePreviewRunProjection

List previous device preview runs for an email in paginated form

Parameters
$email_id : string

email_id (required)

$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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageDevicePreviewRunProjection —

getDevicePreviewRunsOffsetPaginatedAsync()

Operation getDevicePreviewRunsOffsetPaginatedAsync

public getDevicePreviewRunsOffsetPaginatedAsync(string $email_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsOffsetPaginated'][0] ]) : PromiseInterface

List previous device preview runs for an email in paginated form

Parameters
$email_id : string

(required)

$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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunsOffsetPaginatedAsyncWithHttpInfo()

Operation getDevicePreviewRunsOffsetPaginatedAsyncWithHttpInfo

public getDevicePreviewRunsOffsetPaginatedAsyncWithHttpInfo(string $email_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsOffsetPaginated'][0] ]) : PromiseInterface

List previous device preview runs for an email in paginated form

Parameters
$email_id : string

(required)

$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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunsOffsetPaginatedRequest()

Create request for operation 'getDevicePreviewRunsOffsetPaginated'

public getDevicePreviewRunsOffsetPaginatedRequest(string $email_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsOffsetPaginated'][0] ]) : Request
Parameters
$email_id : string

(required)

$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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunsOffsetPaginatedWithHttpInfo()

Operation getDevicePreviewRunsOffsetPaginatedWithHttpInfo

public getDevicePreviewRunsOffsetPaginatedWithHttpInfo(string $email_id, int $page[, int $size = 20 ][, string $sort = 'DESC' ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRunsOffsetPaginated'][0] ]) : array<string|int, mixed>

List previous device preview runs for an email in paginated form

Parameters
$email_id : string

(required)

$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')

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewRunsOffsetPaginated'] 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\PageDevicePreviewRunProjection, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewRunSourceEmail()

Operation getDevicePreviewRunSourceEmail

public getDevicePreviewRunSourceEmail(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRunSourceEmail'][0] ]) : DevicePreviewSourceEmailDto

Get the original email content for a device preview run

Parameters
$run_id : string

run_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewSourceEmailDto —

getDevicePreviewRunSourceEmailAsync()

Operation getDevicePreviewRunSourceEmailAsync

public getDevicePreviewRunSourceEmailAsync(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRunSourceEmail'][0] ]) : PromiseInterface

Get the original email content for a device preview run

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunSourceEmailAsyncWithHttpInfo()

Operation getDevicePreviewRunSourceEmailAsyncWithHttpInfo

public getDevicePreviewRunSourceEmailAsyncWithHttpInfo(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRunSourceEmail'][0] ]) : PromiseInterface

Get the original email content for a device preview run

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewRunSourceEmailRequest()

Create request for operation 'getDevicePreviewRunSourceEmail'

public getDevicePreviewRunSourceEmailRequest(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewRunSourceEmail'][0] ]) : Request
Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunSourceEmailWithHttpInfo()

Operation getDevicePreviewRunSourceEmailWithHttpInfo

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

Get the original email content for a device preview run

Parameters
$run_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewRunSourceEmail'] 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\DevicePreviewSourceEmailDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewRunsRequest()

Create request for operation 'getDevicePreviewRuns'

public getDevicePreviewRunsRequest(string $email_id[, int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRuns'][0] ]) : Request
Parameters
$email_id : string

(required)

$limit : int = 50

(optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewRunsWithHttpInfo()

Operation getDevicePreviewRunsWithHttpInfo

public getDevicePreviewRunsWithHttpInfo(string $email_id[, int $limit = 50 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['getDevicePreviewRuns'][0] ]) : array<string|int, mixed>

List previous device preview runs for an email

Parameters
$email_id : string

(required)

$limit : int = 50

(optional, default to 50)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewRuns'] 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\DevicePreviewRunDto[], HTTP status code, HTTP response headers (array of strings)

getDevicePreviewRunWithHttpInfo()

Operation getDevicePreviewRunWithHttpInfo

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

Get device preview run status

Parameters
$run_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewRun'] 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\DevicePreviewRunDto, HTTP status code, HTTP response headers (array of strings)

getDevicePreviewSharedResult()

Operation getDevicePreviewSharedResult

public getDevicePreviewSharedResult(string $share_token[, string $contentType = self::contentTypes['getDevicePreviewSharedResult'][0] ]) : DevicePreviewSharedResultDto

Get a public shared device preview result

Parameters
$share_token : string

share_token (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewSharedResultDto —

getDevicePreviewSharedResultAsync()

Operation getDevicePreviewSharedResultAsync

public getDevicePreviewSharedResultAsync(string $share_token[, string $contentType = self::contentTypes['getDevicePreviewSharedResult'][0] ]) : PromiseInterface

Get a public shared device preview result

Parameters
$share_token : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewSharedResultAsyncWithHttpInfo()

Operation getDevicePreviewSharedResultAsyncWithHttpInfo

public getDevicePreviewSharedResultAsyncWithHttpInfo(string $share_token[, string $contentType = self::contentTypes['getDevicePreviewSharedResult'][0] ]) : PromiseInterface

Get a public shared device preview result

Parameters
$share_token : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewSharedResultRequest()

Create request for operation 'getDevicePreviewSharedResult'

public getDevicePreviewSharedResultRequest(string $share_token[, string $contentType = self::contentTypes['getDevicePreviewSharedResult'][0] ]) : Request
Parameters
$share_token : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewSharedResultScreenshot()

Operation getDevicePreviewSharedResultScreenshot

public getDevicePreviewSharedResultScreenshot(string $share_token, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewSharedResultScreenshot'][0] ]) : string

Get a public shared device preview screenshot image

Parameters
$share_token : string

share_token (required)

$screenshot_id : string

screenshot_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
string —

getDevicePreviewSharedResultScreenshotAsync()

Operation getDevicePreviewSharedResultScreenshotAsync

public getDevicePreviewSharedResultScreenshotAsync(string $share_token, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewSharedResultScreenshot'][0] ]) : PromiseInterface

Get a public shared device preview screenshot image

Parameters
$share_token : string

(required)

$screenshot_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewSharedResultScreenshotAsyncWithHttpInfo()

Operation getDevicePreviewSharedResultScreenshotAsyncWithHttpInfo

public getDevicePreviewSharedResultScreenshotAsyncWithHttpInfo(string $share_token, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewSharedResultScreenshot'][0] ]) : PromiseInterface

Get a public shared device preview screenshot image

Parameters
$share_token : string

(required)

$screenshot_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewSharedResultScreenshotRequest()

Create request for operation 'getDevicePreviewSharedResultScreenshot'

public getDevicePreviewSharedResultScreenshotRequest(string $share_token, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewSharedResultScreenshot'][0] ]) : Request
Parameters
$share_token : string

(required)

$screenshot_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewSharedResultScreenshotWithHttpInfo()

Operation getDevicePreviewSharedResultScreenshotWithHttpInfo

public getDevicePreviewSharedResultScreenshotWithHttpInfo(string $share_token, string $screenshot_id[, string $contentType = self::contentTypes['getDevicePreviewSharedResultScreenshot'][0] ]) : array<string|int, mixed>

Get a public shared device preview screenshot image

Parameters
$share_token : string

(required)

$screenshot_id : string

(required)

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

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

Tags
throws
ApiException

on non-2xx response

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

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

getDevicePreviewSharedResultWithHttpInfo()

Operation getDevicePreviewSharedResultWithHttpInfo

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

Get a public shared device preview result

Parameters
$share_token : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewSharedResult'] 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\DevicePreviewSharedResultDto, HTTP status code, HTTP response headers (array of strings)

Operation getDevicePreviewShareLinks

public getDevicePreviewShareLinks(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewShareLinks'][0] ]) : array<string|int, DevicePreviewShareLinkDto>

List share links for a device preview run

Parameters
$run_id : string

run_id (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, DevicePreviewShareLinkDto> —

getDevicePreviewShareLinksAsync()

Operation getDevicePreviewShareLinksAsync

public getDevicePreviewShareLinksAsync(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewShareLinks'][0] ]) : PromiseInterface

List share links for a device preview run

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewShareLinksAsyncWithHttpInfo()

Operation getDevicePreviewShareLinksAsyncWithHttpInfo

public getDevicePreviewShareLinksAsyncWithHttpInfo(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewShareLinks'][0] ]) : PromiseInterface

List share links for a device preview run

Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewShareLinksRequest()

Create request for operation 'getDevicePreviewShareLinks'

public getDevicePreviewShareLinksRequest(string $run_id[, string $contentType = self::contentTypes['getDevicePreviewShareLinks'][0] ]) : Request
Parameters
$run_id : string

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewShareLinksWithHttpInfo()

Operation getDevicePreviewShareLinksWithHttpInfo

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

List share links for a device preview run

Parameters
$run_id : string

(required)

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewShareLinks'] 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\DevicePreviewShareLinkDto[], HTTP status code, HTTP response headers (array of strings)

getDevicePreviewTargets()

Operation getDevicePreviewTargets

public getDevicePreviewTargets([string $contentType = self::contentTypes['getDevicePreviewTargets'][0] ]) : DevicePreviewNativeTargetListDto

List device preview targets

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewNativeTargetListDto —

getDevicePreviewTargetsAsync()

Operation getDevicePreviewTargetsAsync

public getDevicePreviewTargetsAsync([string $contentType = self::contentTypes['getDevicePreviewTargets'][0] ]) : PromiseInterface

List device preview targets

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewTargetsAsyncWithHttpInfo()

Operation getDevicePreviewTargetsAsyncWithHttpInfo

public getDevicePreviewTargetsAsyncWithHttpInfo([string $contentType = self::contentTypes['getDevicePreviewTargets'][0] ]) : PromiseInterface

List device preview targets

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDevicePreviewTargetsRequest()

Create request for operation 'getDevicePreviewTargets'

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

getDevicePreviewTargetsWithHttpInfo()

Operation getDevicePreviewTargetsWithHttpInfo

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

List device preview targets

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

The value for the Content-Type header. Check self::contentTypes['getDevicePreviewTargets'] 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\DevicePreviewNativeTargetListDto, HTTP status code, HTTP response headers (array of strings)

moveDevicePreviewRuns()

Operation moveDevicePreviewRuns

public moveDevicePreviewRuns(MoveDevicePreviewRunsOptions $move_device_preview_runs_options[, string $contentType = self::contentTypes['moveDevicePreviewRuns'][0] ]) : MoveDevicePreviewRunsResult

Move device preview runs to a folder or Unfiled

Parameters
$move_device_preview_runs_options : MoveDevicePreviewRunsOptions

move_device_preview_runs_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
MoveDevicePreviewRunsResult —

moveDevicePreviewRunsAsync()

Operation moveDevicePreviewRunsAsync

public moveDevicePreviewRunsAsync(MoveDevicePreviewRunsOptions $move_device_preview_runs_options[, string $contentType = self::contentTypes['moveDevicePreviewRuns'][0] ]) : PromiseInterface

Move device preview runs to a folder or Unfiled

Parameters
$move_device_preview_runs_options : MoveDevicePreviewRunsOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

moveDevicePreviewRunsAsyncWithHttpInfo()

Operation moveDevicePreviewRunsAsyncWithHttpInfo

public moveDevicePreviewRunsAsyncWithHttpInfo(MoveDevicePreviewRunsOptions $move_device_preview_runs_options[, string $contentType = self::contentTypes['moveDevicePreviewRuns'][0] ]) : PromiseInterface

Move device preview runs to a folder or Unfiled

Parameters
$move_device_preview_runs_options : MoveDevicePreviewRunsOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

moveDevicePreviewRunsRequest()

Create request for operation 'moveDevicePreviewRuns'

public moveDevicePreviewRunsRequest(MoveDevicePreviewRunsOptions $move_device_preview_runs_options[, string $contentType = self::contentTypes['moveDevicePreviewRuns'][0] ]) : Request
Parameters
$move_device_preview_runs_options : MoveDevicePreviewRunsOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

moveDevicePreviewRunsWithHttpInfo()

Operation moveDevicePreviewRunsWithHttpInfo

public moveDevicePreviewRunsWithHttpInfo(MoveDevicePreviewRunsOptions $move_device_preview_runs_options[, string $contentType = self::contentTypes['moveDevicePreviewRuns'][0] ]) : array<string|int, mixed>

Move device preview runs to a folder or Unfiled

Parameters
$move_device_preview_runs_options : MoveDevicePreviewRunsOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['moveDevicePreviewRuns'] 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\MoveDevicePreviewRunsResult, HTTP status code, HTTP response headers (array of strings)

rerunDevicePreviewTargets()

Operation rerunDevicePreviewTargets

public rerunDevicePreviewTargets(string $run_id, RerunDevicePreviewTargetsOptions $rerun_device_preview_targets_options[, string $contentType = self::contentTypes['rerunDevicePreviewTargets'][0] ]) : RerunDevicePreviewTargetsResult

Rerun selected device preview targets in the same run

Parameters
$run_id : string

run_id (required)

$rerun_device_preview_targets_options : RerunDevicePreviewTargetsOptions

rerun_device_preview_targets_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
RerunDevicePreviewTargetsResult —

rerunDevicePreviewTargetsAsync()

Operation rerunDevicePreviewTargetsAsync

public rerunDevicePreviewTargetsAsync(string $run_id, RerunDevicePreviewTargetsOptions $rerun_device_preview_targets_options[, string $contentType = self::contentTypes['rerunDevicePreviewTargets'][0] ]) : PromiseInterface

Rerun selected device preview targets in the same run

Parameters
$run_id : string

(required)

$rerun_device_preview_targets_options : RerunDevicePreviewTargetsOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

rerunDevicePreviewTargetsAsyncWithHttpInfo()

Operation rerunDevicePreviewTargetsAsyncWithHttpInfo

public rerunDevicePreviewTargetsAsyncWithHttpInfo(string $run_id, RerunDevicePreviewTargetsOptions $rerun_device_preview_targets_options[, string $contentType = self::contentTypes['rerunDevicePreviewTargets'][0] ]) : PromiseInterface

Rerun selected device preview targets in the same run

Parameters
$run_id : string

(required)

$rerun_device_preview_targets_options : RerunDevicePreviewTargetsOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

rerunDevicePreviewTargetsRequest()

Create request for operation 'rerunDevicePreviewTargets'

public rerunDevicePreviewTargetsRequest(string $run_id, RerunDevicePreviewTargetsOptions $rerun_device_preview_targets_options[, string $contentType = self::contentTypes['rerunDevicePreviewTargets'][0] ]) : Request
Parameters
$run_id : string

(required)

$rerun_device_preview_targets_options : RerunDevicePreviewTargetsOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

rerunDevicePreviewTargetsWithHttpInfo()

Operation rerunDevicePreviewTargetsWithHttpInfo

public rerunDevicePreviewTargetsWithHttpInfo(string $run_id, RerunDevicePreviewTargetsOptions $rerun_device_preview_targets_options[, string $contentType = self::contentTypes['rerunDevicePreviewTargets'][0] ]) : array<string|int, mixed>

Rerun selected device preview targets in the same run

Parameters
$run_id : string

(required)

$rerun_device_preview_targets_options : RerunDevicePreviewTargetsOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['rerunDevicePreviewTargets'] 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\RerunDevicePreviewTargetsResult, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void —

updateDevicePreviewEmailDomainSubdomain()

Operation updateDevicePreviewEmailDomainSubdomain

public updateDevicePreviewEmailDomainSubdomain(UpdateDevicePreviewIngestDomainOptions $update_device_preview_ingest_domain_options[, string $contentType = self::contentTypes['updateDevicePreviewEmailDomainSubdomain'][0] ]) : DevicePreviewAccountSettingsDto

Update account device preview email subdomain

Parameters
$update_device_preview_ingest_domain_options : UpdateDevicePreviewIngestDomainOptions

update_device_preview_ingest_domain_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewAccountSettingsDto —

updateDevicePreviewEmailDomainSubdomainAsync()

Operation updateDevicePreviewEmailDomainSubdomainAsync

public updateDevicePreviewEmailDomainSubdomainAsync(UpdateDevicePreviewIngestDomainOptions $update_device_preview_ingest_domain_options[, string $contentType = self::contentTypes['updateDevicePreviewEmailDomainSubdomain'][0] ]) : PromiseInterface

Update account device preview email subdomain

Parameters
$update_device_preview_ingest_domain_options : UpdateDevicePreviewIngestDomainOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDevicePreviewEmailDomainSubdomainAsyncWithHttpInfo()

Operation updateDevicePreviewEmailDomainSubdomainAsyncWithHttpInfo

public updateDevicePreviewEmailDomainSubdomainAsyncWithHttpInfo(UpdateDevicePreviewIngestDomainOptions $update_device_preview_ingest_domain_options[, string $contentType = self::contentTypes['updateDevicePreviewEmailDomainSubdomain'][0] ]) : PromiseInterface

Update account device preview email subdomain

Parameters
$update_device_preview_ingest_domain_options : UpdateDevicePreviewIngestDomainOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDevicePreviewEmailDomainSubdomainRequest()

Create request for operation 'updateDevicePreviewEmailDomainSubdomain'

public updateDevicePreviewEmailDomainSubdomainRequest(UpdateDevicePreviewIngestDomainOptions $update_device_preview_ingest_domain_options[, string $contentType = self::contentTypes['updateDevicePreviewEmailDomainSubdomain'][0] ]) : Request
Parameters
$update_device_preview_ingest_domain_options : UpdateDevicePreviewIngestDomainOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

updateDevicePreviewEmailDomainSubdomainWithHttpInfo()

Operation updateDevicePreviewEmailDomainSubdomainWithHttpInfo

public updateDevicePreviewEmailDomainSubdomainWithHttpInfo(UpdateDevicePreviewIngestDomainOptions $update_device_preview_ingest_domain_options[, string $contentType = self::contentTypes['updateDevicePreviewEmailDomainSubdomain'][0] ]) : array<string|int, mixed>

Update account device preview email subdomain

Parameters
$update_device_preview_ingest_domain_options : UpdateDevicePreviewIngestDomainOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['updateDevicePreviewEmailDomainSubdomain'] 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\DevicePreviewAccountSettingsDto, HTTP status code, HTTP response headers (array of strings)

updateDevicePreviewFeedback()

Operation updateDevicePreviewFeedback

public updateDevicePreviewFeedback(string $feedback_id, UpdateDevicePreviewFeedbackOptions $update_device_preview_feedback_options[, string $contentType = self::contentTypes['updateDevicePreviewFeedback'][0] ]) : DevicePreviewFeedbackDto

Update device preview feedback

Parameters
$feedback_id : string

feedback_id (required)

$update_device_preview_feedback_options : UpdateDevicePreviewFeedbackOptions

update_device_preview_feedback_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewFeedbackDto —

updateDevicePreviewFeedbackAsync()

Operation updateDevicePreviewFeedbackAsync

public updateDevicePreviewFeedbackAsync(string $feedback_id, UpdateDevicePreviewFeedbackOptions $update_device_preview_feedback_options[, string $contentType = self::contentTypes['updateDevicePreviewFeedback'][0] ]) : PromiseInterface

Update device preview feedback

Parameters
$feedback_id : string

(required)

$update_device_preview_feedback_options : UpdateDevicePreviewFeedbackOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDevicePreviewFeedbackAsyncWithHttpInfo()

Operation updateDevicePreviewFeedbackAsyncWithHttpInfo

public updateDevicePreviewFeedbackAsyncWithHttpInfo(string $feedback_id, UpdateDevicePreviewFeedbackOptions $update_device_preview_feedback_options[, string $contentType = self::contentTypes['updateDevicePreviewFeedback'][0] ]) : PromiseInterface

Update device preview feedback

Parameters
$feedback_id : string

(required)

$update_device_preview_feedback_options : UpdateDevicePreviewFeedbackOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDevicePreviewFeedbackRequest()

Create request for operation 'updateDevicePreviewFeedback'

public updateDevicePreviewFeedbackRequest(string $feedback_id, UpdateDevicePreviewFeedbackOptions $update_device_preview_feedback_options[, string $contentType = self::contentTypes['updateDevicePreviewFeedback'][0] ]) : Request
Parameters
$feedback_id : string

(required)

$update_device_preview_feedback_options : UpdateDevicePreviewFeedbackOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

updateDevicePreviewFeedbackWithHttpInfo()

Operation updateDevicePreviewFeedbackWithHttpInfo

public updateDevicePreviewFeedbackWithHttpInfo(string $feedback_id, UpdateDevicePreviewFeedbackOptions $update_device_preview_feedback_options[, string $contentType = self::contentTypes['updateDevicePreviewFeedback'][0] ]) : array<string|int, mixed>

Update device preview feedback

Parameters
$feedback_id : string

(required)

$update_device_preview_feedback_options : UpdateDevicePreviewFeedbackOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['updateDevicePreviewFeedback'] 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\DevicePreviewFeedbackDto, HTTP status code, HTTP response headers (array of strings)

updateDevicePreviewFolder()

Operation updateDevicePreviewFolder

public updateDevicePreviewFolder(string $folder_id, UpdateDevicePreviewFolderOptions $update_device_preview_folder_options[, string $contentType = self::contentTypes['updateDevicePreviewFolder'][0] ]) : DevicePreviewFolderDto

Rename or move a device preview folder

Parameters
$folder_id : string

folder_id (required)

$update_device_preview_folder_options : UpdateDevicePreviewFolderOptions

update_device_preview_folder_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewFolderDto —

updateDevicePreviewFolderAsync()

Operation updateDevicePreviewFolderAsync

public updateDevicePreviewFolderAsync(string $folder_id, UpdateDevicePreviewFolderOptions $update_device_preview_folder_options[, string $contentType = self::contentTypes['updateDevicePreviewFolder'][0] ]) : PromiseInterface

Rename or move a device preview folder

Parameters
$folder_id : string

(required)

$update_device_preview_folder_options : UpdateDevicePreviewFolderOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDevicePreviewFolderAsyncWithHttpInfo()

Operation updateDevicePreviewFolderAsyncWithHttpInfo

public updateDevicePreviewFolderAsyncWithHttpInfo(string $folder_id, UpdateDevicePreviewFolderOptions $update_device_preview_folder_options[, string $contentType = self::contentTypes['updateDevicePreviewFolder'][0] ]) : PromiseInterface

Rename or move a device preview folder

Parameters
$folder_id : string

(required)

$update_device_preview_folder_options : UpdateDevicePreviewFolderOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDevicePreviewFolderRequest()

Create request for operation 'updateDevicePreviewFolder'

public updateDevicePreviewFolderRequest(string $folder_id, UpdateDevicePreviewFolderOptions $update_device_preview_folder_options[, string $contentType = self::contentTypes['updateDevicePreviewFolder'][0] ]) : Request
Parameters
$folder_id : string

(required)

$update_device_preview_folder_options : UpdateDevicePreviewFolderOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

updateDevicePreviewFolderWithHttpInfo()

Operation updateDevicePreviewFolderWithHttpInfo

public updateDevicePreviewFolderWithHttpInfo(string $folder_id, UpdateDevicePreviewFolderOptions $update_device_preview_folder_options[, string $contentType = self::contentTypes['updateDevicePreviewFolder'][0] ]) : array<string|int, mixed>

Rename or move a device preview folder

Parameters
$folder_id : string

(required)

$update_device_preview_folder_options : UpdateDevicePreviewFolderOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['updateDevicePreviewFolder'] 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\DevicePreviewFolderDto, HTTP status code, HTTP response headers (array of strings)

updateDevicePreviewProfile()

Operation updateDevicePreviewProfile

public updateDevicePreviewProfile(string $profile_id, UpdateDevicePreviewProfileOptions $update_device_preview_profile_options[, string $contentType = self::contentTypes['updateDevicePreviewProfile'][0] ]) : DevicePreviewProfileDto

Update a device preview profile

Parameters
$profile_id : string

profile_id (required)

$update_device_preview_profile_options : UpdateDevicePreviewProfileOptions

update_device_preview_profile_options (required)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewProfileDto —

updateDevicePreviewProfileAsync()

Operation updateDevicePreviewProfileAsync

public updateDevicePreviewProfileAsync(string $profile_id, UpdateDevicePreviewProfileOptions $update_device_preview_profile_options[, string $contentType = self::contentTypes['updateDevicePreviewProfile'][0] ]) : PromiseInterface

Update a device preview profile

Parameters
$profile_id : string

(required)

$update_device_preview_profile_options : UpdateDevicePreviewProfileOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDevicePreviewProfileAsyncWithHttpInfo()

Operation updateDevicePreviewProfileAsyncWithHttpInfo

public updateDevicePreviewProfileAsyncWithHttpInfo(string $profile_id, UpdateDevicePreviewProfileOptions $update_device_preview_profile_options[, string $contentType = self::contentTypes['updateDevicePreviewProfile'][0] ]) : PromiseInterface

Update a device preview profile

Parameters
$profile_id : string

(required)

$update_device_preview_profile_options : UpdateDevicePreviewProfileOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDevicePreviewProfileRequest()

Create request for operation 'updateDevicePreviewProfile'

public updateDevicePreviewProfileRequest(string $profile_id, UpdateDevicePreviewProfileOptions $update_device_preview_profile_options[, string $contentType = self::contentTypes['updateDevicePreviewProfile'][0] ]) : Request
Parameters
$profile_id : string

(required)

$update_device_preview_profile_options : UpdateDevicePreviewProfileOptions

(required)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

updateDevicePreviewProfileWithHttpInfo()

Operation updateDevicePreviewProfileWithHttpInfo

public updateDevicePreviewProfileWithHttpInfo(string $profile_id, UpdateDevicePreviewProfileOptions $update_device_preview_profile_options[, string $contentType = self::contentTypes['updateDevicePreviewProfile'][0] ]) : array<string|int, mixed>

Update a device preview profile

Parameters
$profile_id : string

(required)

$update_device_preview_profile_options : UpdateDevicePreviewProfileOptions

(required)

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

The value for the Content-Type header. Check self::contentTypes['updateDevicePreviewProfile'] 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\DevicePreviewProfileDto, HTTP status code, HTTP response headers (array of strings)

waitForDevicePreviewEmailRuns()

Operation waitForDevicePreviewEmailRuns

public waitForDevicePreviewEmailRuns(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailRuns'][0] ]) : DevicePreviewIngestRunWaitResult

Wait for device preview runs created from account email domains

Parameters
$since : DateTime

since (required)

$email_domain_id : string = null

email_domain_id (optional)

$profile_id : string = null

profile_id (optional)

$local_part : string = null

local_part (optional)

$limit : int = 20

limit (optional, default to 20)

$timeout_millis : int = 25000

timeout_millis (optional, default to 25000)

$poll_interval_millis : int = 1000

poll_interval_millis (optional, default to 1000)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewIngestRunWaitResult —

waitForDevicePreviewEmailRunsAsync()

Operation waitForDevicePreviewEmailRunsAsync

public waitForDevicePreviewEmailRunsAsync(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailRuns'][0] ]) : PromiseInterface

Wait for device preview runs created from account email domains

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForDevicePreviewEmailRunsAsyncWithHttpInfo()

Operation waitForDevicePreviewEmailRunsAsyncWithHttpInfo

public waitForDevicePreviewEmailRunsAsyncWithHttpInfo(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailRuns'][0] ]) : PromiseInterface

Wait for device preview runs created from account email domains

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForDevicePreviewEmailRunsRequest()

Create request for operation 'waitForDevicePreviewEmailRuns'

public waitForDevicePreviewEmailRunsRequest(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailRuns'][0] ]) : Request
Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

waitForDevicePreviewEmailRunsWithHttpInfo()

Operation waitForDevicePreviewEmailRunsWithHttpInfo

public waitForDevicePreviewEmailRunsWithHttpInfo(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, bool $hydrate_thumbnail = false ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailRuns'][0] ]) : array<string|int, mixed>

Wait for device preview runs created from account email domains

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

$hydrate_thumbnail : bool = false

Hydrate each returned run with a nullable primary screenshot thumbnail URL. (optional, default to false)

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

The value for the Content-Type header. Check self::contentTypes['waitForDevicePreviewEmailRuns'] 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\DevicePreviewIngestRunWaitResult, HTTP status code, HTTP response headers (array of strings)

waitForDevicePreviewEmailSubmissions()

Operation waitForDevicePreviewEmailSubmissions

public waitForDevicePreviewEmailSubmissions(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailSubmissions'][0] ]) : DevicePreviewEmailSubmissionWaitResult

Wait for received device preview email submissions

Parameters
$since : DateTime

since (required)

$email_domain_id : string = null

email_domain_id (optional)

$profile_id : string = null

profile_id (optional)

$local_part : string = null

local_part (optional)

$limit : int = 20

limit (optional, default to 20)

$timeout_millis : int = 25000

timeout_millis (optional, default to 25000)

$poll_interval_millis : int = 1000

poll_interval_millis (optional, default to 1000)

$recipient_email_address : string = null

recipient_email_address (optional)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewEmailSubmissionWaitResult —

waitForDevicePreviewEmailSubmissionsAsync()

Operation waitForDevicePreviewEmailSubmissionsAsync

public waitForDevicePreviewEmailSubmissionsAsync(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailSubmissions'][0] ]) : PromiseInterface

Wait for received device preview email submissions

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

$recipient_email_address : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForDevicePreviewEmailSubmissionsAsyncWithHttpInfo()

Operation waitForDevicePreviewEmailSubmissionsAsyncWithHttpInfo

public waitForDevicePreviewEmailSubmissionsAsyncWithHttpInfo(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailSubmissions'][0] ]) : PromiseInterface

Wait for received device preview email submissions

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

$recipient_email_address : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForDevicePreviewEmailSubmissionsRequest()

Create request for operation 'waitForDevicePreviewEmailSubmissions'

public waitForDevicePreviewEmailSubmissionsRequest(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailSubmissions'][0] ]) : Request
Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

$recipient_email_address : string = null

(optional)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

waitForDevicePreviewEmailSubmissionsWithHttpInfo()

Operation waitForDevicePreviewEmailSubmissionsWithHttpInfo

public waitForDevicePreviewEmailSubmissionsWithHttpInfo(DateTime $since[, string $email_domain_id = null ][, string $profile_id = null ][, string $local_part = null ][, int $limit = 20 ][, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $recipient_email_address = null ][, string $contentType = self::contentTypes['waitForDevicePreviewEmailSubmissions'][0] ]) : array<string|int, mixed>

Wait for received device preview email submissions

Parameters
$since : DateTime

(required)

$email_domain_id : string = null

(optional)

$profile_id : string = null

(optional)

$local_part : string = null

(optional)

$limit : int = 20

(optional, default to 20)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

$recipient_email_address : string = null

(optional)

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

The value for the Content-Type header. Check self::contentTypes['waitForDevicePreviewEmailSubmissions'] 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\DevicePreviewEmailSubmissionWaitResult, HTTP status code, HTTP response headers (array of strings)

waitForDevicePreviewRun()

Operation waitForDevicePreviewRun

public waitForDevicePreviewRun(string $run_id[, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $contentType = self::contentTypes['waitForDevicePreviewRun'][0] ]) : DevicePreviewRunWaitResult

Wait for device preview run to complete

Parameters
$run_id : string

run_id (required)

$timeout_millis : int = 25000

timeout_millis (optional, default to 25000)

$poll_interval_millis : int = 1000

poll_interval_millis (optional, default to 1000)

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

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

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
DevicePreviewRunWaitResult —

waitForDevicePreviewRunAsync()

Operation waitForDevicePreviewRunAsync

public waitForDevicePreviewRunAsync(string $run_id[, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $contentType = self::contentTypes['waitForDevicePreviewRun'][0] ]) : PromiseInterface

Wait for device preview run to complete

Parameters
$run_id : string

(required)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForDevicePreviewRunAsyncWithHttpInfo()

Operation waitForDevicePreviewRunAsyncWithHttpInfo

public waitForDevicePreviewRunAsyncWithHttpInfo(string $run_id[, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $contentType = self::contentTypes['waitForDevicePreviewRun'][0] ]) : PromiseInterface

Wait for device preview run to complete

Parameters
$run_id : string

(required)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

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

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

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

waitForDevicePreviewRunRequest()

Create request for operation 'waitForDevicePreviewRun'

public waitForDevicePreviewRunRequest(string $run_id[, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $contentType = self::contentTypes['waitForDevicePreviewRun'][0] ]) : Request
Parameters
$run_id : string

(required)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

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

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

Tags
throws
InvalidArgumentException
Return values
Request —

waitForDevicePreviewRunWithHttpInfo()

Operation waitForDevicePreviewRunWithHttpInfo

public waitForDevicePreviewRunWithHttpInfo(string $run_id[, int $timeout_millis = 25000 ][, int $poll_interval_millis = 1000 ][, string $contentType = self::contentTypes['waitForDevicePreviewRun'][0] ]) : array<string|int, mixed>

Wait for device preview run to complete

Parameters
$run_id : string

(required)

$timeout_millis : int = 25000

(optional, default to 25000)

$poll_interval_millis : int = 1000

(optional, default to 1000)

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

The value for the Content-Type header. Check self::contentTypes['waitForDevicePreviewRun'] 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\DevicePreviewRunWaitResult, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

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

on file opening failure

Return values
array<string|int, mixed> —

of http client options

Search results