DomainMonitorControllerApi
in package
DomainMonitorControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['compareDomainMonitorRuns' => ['application/json'], 'createDomainMonitor' => ['application/json'], 'createDomainMonitorAlertSink' => ['application/json'], 'createDomainMonitorEmailVerificationAddress' => ['application/json'], 'deleteDomainMonitor' => ['application/json'], 'deleteDomainMonitorAlertSink' => ['application/json'], 'deleteDomainMonitorObservedAuthSample' => ['application/json'], 'exportDomainMonitorRunResults' => ['application/json'], 'getDomainMonitor' => ['application/json'], 'getDomainMonitorAlertSinks' => ['application/json'], 'getDomainMonitorAuthStack' => ['application/json'], 'getDomainMonitorEmailVerification' => ['application/json'], 'getDomainMonitorInsights' => ['application/json'], 'getDomainMonitorObservedAuthSamples' => ['application/json'], 'getDomainMonitorRun' => ['application/json'], 'getDomainMonitorRuns' => ['application/json'], 'getDomainMonitorSeries' => ['application/json'], 'getDomainMonitorSummary' => ['application/json'], 'getDomainMonitors' => ['application/json'], 'runDomainMonitorNow' => ['application/json'], 'runDueDomainMonitors' => ['application/json'], 'updateDomainMonitor' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- compareDomainMonitorRuns() : DomainMonitorRunComparisonDto
- Operation compareDomainMonitorRuns
- compareDomainMonitorRunsAsync() : PromiseInterface
- Operation compareDomainMonitorRunsAsync
- compareDomainMonitorRunsAsyncWithHttpInfo() : PromiseInterface
- Operation compareDomainMonitorRunsAsyncWithHttpInfo
- compareDomainMonitorRunsRequest() : Request
- Create request for operation 'compareDomainMonitorRuns'
- compareDomainMonitorRunsWithHttpInfo() : array<string|int, mixed>
- Operation compareDomainMonitorRunsWithHttpInfo
- createDomainMonitor() : DomainMonitorDto
- Operation createDomainMonitor
- createDomainMonitorAlertSink() : DomainMonitorAlertSinkDto
- Operation createDomainMonitorAlertSink
- createDomainMonitorAlertSinkAsync() : PromiseInterface
- Operation createDomainMonitorAlertSinkAsync
- createDomainMonitorAlertSinkAsyncWithHttpInfo() : PromiseInterface
- Operation createDomainMonitorAlertSinkAsyncWithHttpInfo
- createDomainMonitorAlertSinkRequest() : Request
- Create request for operation 'createDomainMonitorAlertSink'
- createDomainMonitorAlertSinkWithHttpInfo() : array<string|int, mixed>
- Operation createDomainMonitorAlertSinkWithHttpInfo
- createDomainMonitorAsync() : PromiseInterface
- Operation createDomainMonitorAsync
- createDomainMonitorAsyncWithHttpInfo() : PromiseInterface
- Operation createDomainMonitorAsyncWithHttpInfo
- createDomainMonitorEmailVerificationAddress() : DomainMonitorEmailVerificationDto
- Operation createDomainMonitorEmailVerificationAddress
- createDomainMonitorEmailVerificationAddressAsync() : PromiseInterface
- Operation createDomainMonitorEmailVerificationAddressAsync
- createDomainMonitorEmailVerificationAddressAsyncWithHttpInfo() : PromiseInterface
- Operation createDomainMonitorEmailVerificationAddressAsyncWithHttpInfo
- createDomainMonitorEmailVerificationAddressRequest() : Request
- Create request for operation 'createDomainMonitorEmailVerificationAddress'
- createDomainMonitorEmailVerificationAddressWithHttpInfo() : array<string|int, mixed>
- Operation createDomainMonitorEmailVerificationAddressWithHttpInfo
- createDomainMonitorRequest() : Request
- Create request for operation 'createDomainMonitor'
- createDomainMonitorWithHttpInfo() : array<string|int, mixed>
- Operation createDomainMonitorWithHttpInfo
- deleteDomainMonitor() : void
- Operation deleteDomainMonitor
- deleteDomainMonitorAlertSink() : void
- Operation deleteDomainMonitorAlertSink
- deleteDomainMonitorAlertSinkAsync() : PromiseInterface
- Operation deleteDomainMonitorAlertSinkAsync
- deleteDomainMonitorAlertSinkAsyncWithHttpInfo() : PromiseInterface
- Operation deleteDomainMonitorAlertSinkAsyncWithHttpInfo
- deleteDomainMonitorAlertSinkRequest() : Request
- Create request for operation 'deleteDomainMonitorAlertSink'
- deleteDomainMonitorAlertSinkWithHttpInfo() : array<string|int, mixed>
- Operation deleteDomainMonitorAlertSinkWithHttpInfo
- deleteDomainMonitorAsync() : PromiseInterface
- Operation deleteDomainMonitorAsync
- deleteDomainMonitorAsyncWithHttpInfo() : PromiseInterface
- Operation deleteDomainMonitorAsyncWithHttpInfo
- deleteDomainMonitorObservedAuthSample() : void
- Operation deleteDomainMonitorObservedAuthSample
- deleteDomainMonitorObservedAuthSampleAsync() : PromiseInterface
- Operation deleteDomainMonitorObservedAuthSampleAsync
- deleteDomainMonitorObservedAuthSampleAsyncWithHttpInfo() : PromiseInterface
- Operation deleteDomainMonitorObservedAuthSampleAsyncWithHttpInfo
- deleteDomainMonitorObservedAuthSampleRequest() : Request
- Create request for operation 'deleteDomainMonitorObservedAuthSample'
- deleteDomainMonitorObservedAuthSampleWithHttpInfo() : array<string|int, mixed>
- Operation deleteDomainMonitorObservedAuthSampleWithHttpInfo
- deleteDomainMonitorRequest() : Request
- Create request for operation 'deleteDomainMonitor'
- deleteDomainMonitorWithHttpInfo() : array<string|int, mixed>
- Operation deleteDomainMonitorWithHttpInfo
- exportDomainMonitorRunResults() : void
- Operation exportDomainMonitorRunResults
- exportDomainMonitorRunResultsAsync() : PromiseInterface
- Operation exportDomainMonitorRunResultsAsync
- exportDomainMonitorRunResultsAsyncWithHttpInfo() : PromiseInterface
- Operation exportDomainMonitorRunResultsAsyncWithHttpInfo
- exportDomainMonitorRunResultsRequest() : Request
- Create request for operation 'exportDomainMonitorRunResults'
- exportDomainMonitorRunResultsWithHttpInfo() : array<string|int, mixed>
- Operation exportDomainMonitorRunResultsWithHttpInfo
- getConfig() : Configuration
- getDomainMonitor() : DomainMonitorDto
- Operation getDomainMonitor
- getDomainMonitorAlertSinks() : array<string|int, DomainMonitorAlertSinkDto>
- Operation getDomainMonitorAlertSinks
- getDomainMonitorAlertSinksAsync() : PromiseInterface
- Operation getDomainMonitorAlertSinksAsync
- getDomainMonitorAlertSinksAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorAlertSinksAsyncWithHttpInfo
- getDomainMonitorAlertSinksRequest() : Request
- Create request for operation 'getDomainMonitorAlertSinks'
- getDomainMonitorAlertSinksWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorAlertSinksWithHttpInfo
- getDomainMonitorAsync() : PromiseInterface
- Operation getDomainMonitorAsync
- getDomainMonitorAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorAsyncWithHttpInfo
- getDomainMonitorAuthStack() : CheckEmailAuthStackResults
- Operation getDomainMonitorAuthStack
- getDomainMonitorAuthStackAsync() : PromiseInterface
- Operation getDomainMonitorAuthStackAsync
- getDomainMonitorAuthStackAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorAuthStackAsyncWithHttpInfo
- getDomainMonitorAuthStackRequest() : Request
- Create request for operation 'getDomainMonitorAuthStack'
- getDomainMonitorAuthStackWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorAuthStackWithHttpInfo
- getDomainMonitorEmailVerification() : DomainMonitorEmailVerificationDto
- Operation getDomainMonitorEmailVerification
- getDomainMonitorEmailVerificationAsync() : PromiseInterface
- Operation getDomainMonitorEmailVerificationAsync
- getDomainMonitorEmailVerificationAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorEmailVerificationAsyncWithHttpInfo
- getDomainMonitorEmailVerificationRequest() : Request
- Create request for operation 'getDomainMonitorEmailVerification'
- getDomainMonitorEmailVerificationWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorEmailVerificationWithHttpInfo
- getDomainMonitorInsights() : DomainMonitorInsightsDto
- Operation getDomainMonitorInsights
- getDomainMonitorInsightsAsync() : PromiseInterface
- Operation getDomainMonitorInsightsAsync
- getDomainMonitorInsightsAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorInsightsAsyncWithHttpInfo
- getDomainMonitorInsightsRequest() : Request
- Create request for operation 'getDomainMonitorInsights'
- getDomainMonitorInsightsWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorInsightsWithHttpInfo
- getDomainMonitorObservedAuthSamples() : array<string|int, DomainMonitorObservedAuthSampleDto>
- Operation getDomainMonitorObservedAuthSamples
- getDomainMonitorObservedAuthSamplesAsync() : PromiseInterface
- Operation getDomainMonitorObservedAuthSamplesAsync
- getDomainMonitorObservedAuthSamplesAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorObservedAuthSamplesAsyncWithHttpInfo
- getDomainMonitorObservedAuthSamplesRequest() : Request
- Create request for operation 'getDomainMonitorObservedAuthSamples'
- getDomainMonitorObservedAuthSamplesWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorObservedAuthSamplesWithHttpInfo
- getDomainMonitorRequest() : Request
- Create request for operation 'getDomainMonitor'
- getDomainMonitorRun() : DomainMonitorRunDto
- Operation getDomainMonitorRun
- getDomainMonitorRunAsync() : PromiseInterface
- Operation getDomainMonitorRunAsync
- getDomainMonitorRunAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorRunAsyncWithHttpInfo
- getDomainMonitorRunRequest() : Request
- Create request for operation 'getDomainMonitorRun'
- getDomainMonitorRuns() : array<string|int, DomainMonitorRunDto>
- Operation getDomainMonitorRuns
- getDomainMonitorRunsAsync() : PromiseInterface
- Operation getDomainMonitorRunsAsync
- getDomainMonitorRunsAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorRunsAsyncWithHttpInfo
- getDomainMonitorRunsRequest() : Request
- Create request for operation 'getDomainMonitorRuns'
- getDomainMonitorRunsWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorRunsWithHttpInfo
- getDomainMonitorRunWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorRunWithHttpInfo
- getDomainMonitors() : array<string|int, DomainMonitorDto>
- Operation getDomainMonitors
- getDomainMonitorsAsync() : PromiseInterface
- Operation getDomainMonitorsAsync
- getDomainMonitorsAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorsAsyncWithHttpInfo
- getDomainMonitorSeries() : DomainMonitorSeriesDto
- Operation getDomainMonitorSeries
- getDomainMonitorSeriesAsync() : PromiseInterface
- Operation getDomainMonitorSeriesAsync
- getDomainMonitorSeriesAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorSeriesAsyncWithHttpInfo
- getDomainMonitorSeriesRequest() : Request
- Create request for operation 'getDomainMonitorSeries'
- getDomainMonitorSeriesWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorSeriesWithHttpInfo
- getDomainMonitorsRequest() : Request
- Create request for operation 'getDomainMonitors'
- getDomainMonitorSummary() : DomainMonitorSummaryDto
- Operation getDomainMonitorSummary
- getDomainMonitorSummaryAsync() : PromiseInterface
- Operation getDomainMonitorSummaryAsync
- getDomainMonitorSummaryAsyncWithHttpInfo() : PromiseInterface
- Operation getDomainMonitorSummaryAsyncWithHttpInfo
- getDomainMonitorSummaryRequest() : Request
- Create request for operation 'getDomainMonitorSummary'
- getDomainMonitorSummaryWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorSummaryWithHttpInfo
- getDomainMonitorsWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorsWithHttpInfo
- getDomainMonitorWithHttpInfo() : array<string|int, mixed>
- Operation getDomainMonitorWithHttpInfo
- getHostIndex() : int
- Get the host index
- runDomainMonitorNow() : DomainMonitorRunNowResult
- Operation runDomainMonitorNow
- runDomainMonitorNowAsync() : PromiseInterface
- Operation runDomainMonitorNowAsync
- runDomainMonitorNowAsyncWithHttpInfo() : PromiseInterface
- Operation runDomainMonitorNowAsyncWithHttpInfo
- runDomainMonitorNowRequest() : Request
- Create request for operation 'runDomainMonitorNow'
- runDomainMonitorNowWithHttpInfo() : array<string|int, mixed>
- Operation runDomainMonitorNowWithHttpInfo
- runDueDomainMonitors() : DomainMonitorRunDueResult
- Operation runDueDomainMonitors
- runDueDomainMonitorsAsync() : PromiseInterface
- Operation runDueDomainMonitorsAsync
- runDueDomainMonitorsAsyncWithHttpInfo() : PromiseInterface
- Operation runDueDomainMonitorsAsyncWithHttpInfo
- runDueDomainMonitorsRequest() : Request
- Create request for operation 'runDueDomainMonitors'
- runDueDomainMonitorsWithHttpInfo() : array<string|int, mixed>
- Operation runDueDomainMonitorsWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateDomainMonitor() : DomainMonitorDto
- Operation updateDomainMonitor
- updateDomainMonitorAsync() : PromiseInterface
- Operation updateDomainMonitorAsync
- updateDomainMonitorAsyncWithHttpInfo() : PromiseInterface
- Operation updateDomainMonitorAsyncWithHttpInfo
- updateDomainMonitorRequest() : Request
- Create request for operation 'updateDomainMonitor'
- updateDomainMonitorWithHttpInfo() : array<string|int, mixed>
- Operation updateDomainMonitorWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['compareDomainMonitorRuns' => ['application/json'], 'createDomainMonitor' => ['application/json'], 'createDomainMonitorAlertSink' => ['application/json'], 'createDomainMonitorEmailVerificationAddress' => ['application/json'], 'deleteDomainMonitor' => ['application/json'], 'deleteDomainMonitorAlertSink' => ['application/json'], 'deleteDomainMonitorObservedAuthSample' => ['application/json'], 'exportDomainMonitorRunResults' => ['application/json'], 'getDomainMonitor' => ['application/json'], 'getDomainMonitorAlertSinks' => ['application/json'], 'getDomainMonitorAuthStack' => ['application/json'], 'getDomainMonitorEmailVerification' => ['application/json'], 'getDomainMonitorInsights' => ['application/json'], 'getDomainMonitorObservedAuthSamples' => ['application/json'], 'getDomainMonitorRun' => ['application/json'], 'getDomainMonitorRuns' => ['application/json'], 'getDomainMonitorSeries' => ['application/json'], 'getDomainMonitorSummary' => ['application/json'], 'getDomainMonitors' => ['application/json'], 'runDomainMonitorNow' => ['application/json'], 'runDueDomainMonitors' => ['application/json'], 'updateDomainMonitor' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
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 —compareDomainMonitorRuns()
Operation compareDomainMonitorRuns
public
compareDomainMonitorRuns(string $monitor_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareDomainMonitorRuns'][0] ]) : DomainMonitorRunComparisonDto
Compare two monitor runs
Parameters
- $monitor_id : string
-
monitor_id (required)
- $run_id : string
-
run_id (required)
- $other_run_id : string
-
other_run_id (required)
- $contentType : string = self::contentTypes['compareDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
DomainMonitorRunComparisonDto —compareDomainMonitorRunsAsync()
Operation compareDomainMonitorRunsAsync
public
compareDomainMonitorRunsAsync(string $monitor_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareDomainMonitorRuns'][0] ]) : PromiseInterface
Compare two monitor runs
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $other_run_id : string
-
(required)
- $contentType : string = self::contentTypes['compareDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —compareDomainMonitorRunsAsyncWithHttpInfo()
Operation compareDomainMonitorRunsAsyncWithHttpInfo
public
compareDomainMonitorRunsAsyncWithHttpInfo(string $monitor_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareDomainMonitorRuns'][0] ]) : PromiseInterface
Compare two monitor runs
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $other_run_id : string
-
(required)
- $contentType : string = self::contentTypes['compareDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —compareDomainMonitorRunsRequest()
Create request for operation 'compareDomainMonitorRuns'
public
compareDomainMonitorRunsRequest(string $monitor_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareDomainMonitorRuns'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $other_run_id : string
-
(required)
- $contentType : string = self::contentTypes['compareDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
Request —compareDomainMonitorRunsWithHttpInfo()
Operation compareDomainMonitorRunsWithHttpInfo
public
compareDomainMonitorRunsWithHttpInfo(string $monitor_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareDomainMonitorRuns'][0] ]) : array<string|int, mixed>
Compare two monitor runs
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $other_run_id : string
-
(required)
- $contentType : string = self::contentTypes['compareDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorRunComparisonDto, HTTP status code, HTTP response headers (array of strings)
createDomainMonitor()
Operation createDomainMonitor
public
createDomainMonitor(CreateDomainMonitorOptions $create_domain_monitor_options[, string $contentType = self::contentTypes['createDomainMonitor'][0] ]) : DomainMonitorDto
Create domain monitor
Parameters
- $create_domain_monitor_options : CreateDomainMonitorOptions
-
create_domain_monitor_options (required)
- $contentType : string = self::contentTypes['createDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitor'] to see the possible values for this operation
Tags
Return values
DomainMonitorDto —createDomainMonitorAlertSink()
Operation createDomainMonitorAlertSink
public
createDomainMonitorAlertSink(string $monitor_id, CreateDomainMonitorAlertSinkOptions $create_domain_monitor_alert_sink_options[, string $contentType = self::contentTypes['createDomainMonitorAlertSink'][0] ]) : DomainMonitorAlertSinkDto
Create alert sink for monitor
Parameters
- $monitor_id : string
-
monitor_id (required)
- $create_domain_monitor_alert_sink_options : CreateDomainMonitorAlertSinkOptions
-
create_domain_monitor_alert_sink_options (required)
- $contentType : string = self::contentTypes['createDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
DomainMonitorAlertSinkDto —createDomainMonitorAlertSinkAsync()
Operation createDomainMonitorAlertSinkAsync
public
createDomainMonitorAlertSinkAsync(string $monitor_id, CreateDomainMonitorAlertSinkOptions $create_domain_monitor_alert_sink_options[, string $contentType = self::contentTypes['createDomainMonitorAlertSink'][0] ]) : PromiseInterface
Create alert sink for monitor
Parameters
- $monitor_id : string
-
(required)
- $create_domain_monitor_alert_sink_options : CreateDomainMonitorAlertSinkOptions
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDomainMonitorAlertSinkAsyncWithHttpInfo()
Operation createDomainMonitorAlertSinkAsyncWithHttpInfo
public
createDomainMonitorAlertSinkAsyncWithHttpInfo(string $monitor_id, CreateDomainMonitorAlertSinkOptions $create_domain_monitor_alert_sink_options[, string $contentType = self::contentTypes['createDomainMonitorAlertSink'][0] ]) : PromiseInterface
Create alert sink for monitor
Parameters
- $monitor_id : string
-
(required)
- $create_domain_monitor_alert_sink_options : CreateDomainMonitorAlertSinkOptions
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDomainMonitorAlertSinkRequest()
Create request for operation 'createDomainMonitorAlertSink'
public
createDomainMonitorAlertSinkRequest(string $monitor_id, CreateDomainMonitorAlertSinkOptions $create_domain_monitor_alert_sink_options[, string $contentType = self::contentTypes['createDomainMonitorAlertSink'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $create_domain_monitor_alert_sink_options : CreateDomainMonitorAlertSinkOptions
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
Request —createDomainMonitorAlertSinkWithHttpInfo()
Operation createDomainMonitorAlertSinkWithHttpInfo
public
createDomainMonitorAlertSinkWithHttpInfo(string $monitor_id, CreateDomainMonitorAlertSinkOptions $create_domain_monitor_alert_sink_options[, string $contentType = self::contentTypes['createDomainMonitorAlertSink'][0] ]) : array<string|int, mixed>
Create alert sink for monitor
Parameters
- $monitor_id : string
-
(required)
- $create_domain_monitor_alert_sink_options : CreateDomainMonitorAlertSinkOptions
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorAlertSinkDto, HTTP status code, HTTP response headers (array of strings)
createDomainMonitorAsync()
Operation createDomainMonitorAsync
public
createDomainMonitorAsync(CreateDomainMonitorOptions $create_domain_monitor_options[, string $contentType = self::contentTypes['createDomainMonitor'][0] ]) : PromiseInterface
Create domain monitor
Parameters
- $create_domain_monitor_options : CreateDomainMonitorOptions
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitor'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDomainMonitorAsyncWithHttpInfo()
Operation createDomainMonitorAsyncWithHttpInfo
public
createDomainMonitorAsyncWithHttpInfo(CreateDomainMonitorOptions $create_domain_monitor_options[, string $contentType = self::contentTypes['createDomainMonitor'][0] ]) : PromiseInterface
Create domain monitor
Parameters
- $create_domain_monitor_options : CreateDomainMonitorOptions
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitor'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDomainMonitorEmailVerificationAddress()
Operation createDomainMonitorEmailVerificationAddress
public
createDomainMonitorEmailVerificationAddress(string $monitor_id[, string $contentType = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0] ]) : DomainMonitorEmailVerificationDto
Create or rotate domain monitor email verification address
Parameters
- $monitor_id : string
-
monitor_id (required)
- $contentType : string = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorEmailVerificationAddress'] to see the possible values for this operation
Tags
Return values
DomainMonitorEmailVerificationDto —createDomainMonitorEmailVerificationAddressAsync()
Operation createDomainMonitorEmailVerificationAddressAsync
public
createDomainMonitorEmailVerificationAddressAsync(string $monitor_id[, string $contentType = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0] ]) : PromiseInterface
Create or rotate domain monitor email verification address
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorEmailVerificationAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDomainMonitorEmailVerificationAddressAsyncWithHttpInfo()
Operation createDomainMonitorEmailVerificationAddressAsyncWithHttpInfo
public
createDomainMonitorEmailVerificationAddressAsyncWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0] ]) : PromiseInterface
Create or rotate domain monitor email verification address
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorEmailVerificationAddress'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createDomainMonitorEmailVerificationAddressRequest()
Create request for operation 'createDomainMonitorEmailVerificationAddress'
public
createDomainMonitorEmailVerificationAddressRequest(string $monitor_id[, string $contentType = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorEmailVerificationAddress'] to see the possible values for this operation
Tags
Return values
Request —createDomainMonitorEmailVerificationAddressWithHttpInfo()
Operation createDomainMonitorEmailVerificationAddressWithHttpInfo
public
createDomainMonitorEmailVerificationAddressWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0] ]) : array<string|int, mixed>
Create or rotate domain monitor email verification address
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitorEmailVerificationAddress'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitorEmailVerificationAddress'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorEmailVerificationDto, HTTP status code, HTTP response headers (array of strings)
createDomainMonitorRequest()
Create request for operation 'createDomainMonitor'
public
createDomainMonitorRequest(CreateDomainMonitorOptions $create_domain_monitor_options[, string $contentType = self::contentTypes['createDomainMonitor'][0] ]) : Request
Parameters
- $create_domain_monitor_options : CreateDomainMonitorOptions
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitor'] to see the possible values for this operation
Tags
Return values
Request —createDomainMonitorWithHttpInfo()
Operation createDomainMonitorWithHttpInfo
public
createDomainMonitorWithHttpInfo(CreateDomainMonitorOptions $create_domain_monitor_options[, string $contentType = self::contentTypes['createDomainMonitor'][0] ]) : array<string|int, mixed>
Create domain monitor
Parameters
- $create_domain_monitor_options : CreateDomainMonitorOptions
-
(required)
- $contentType : string = self::contentTypes['createDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['createDomainMonitor'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorDto, HTTP status code, HTTP response headers (array of strings)
deleteDomainMonitor()
Operation deleteDomainMonitor
public
deleteDomainMonitor(string $monitor_id[, string $contentType = self::contentTypes['deleteDomainMonitor'][0] ]) : void
Delete domain monitor
Parameters
- $monitor_id : string
-
monitor_id (required)
- $contentType : string = self::contentTypes['deleteDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitor'] to see the possible values for this operation
Tags
Return values
void —deleteDomainMonitorAlertSink()
Operation deleteDomainMonitorAlertSink
public
deleteDomainMonitorAlertSink(string $monitor_id, string $sink_id[, string $contentType = self::contentTypes['deleteDomainMonitorAlertSink'][0] ]) : void
Delete monitor alert sink
Parameters
- $monitor_id : string
-
monitor_id (required)
- $sink_id : string
-
sink_id (required)
- $contentType : string = self::contentTypes['deleteDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
void —deleteDomainMonitorAlertSinkAsync()
Operation deleteDomainMonitorAlertSinkAsync
public
deleteDomainMonitorAlertSinkAsync(string $monitor_id, string $sink_id[, string $contentType = self::contentTypes['deleteDomainMonitorAlertSink'][0] ]) : PromiseInterface
Delete monitor alert sink
Parameters
- $monitor_id : string
-
(required)
- $sink_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDomainMonitorAlertSinkAsyncWithHttpInfo()
Operation deleteDomainMonitorAlertSinkAsyncWithHttpInfo
public
deleteDomainMonitorAlertSinkAsyncWithHttpInfo(string $monitor_id, string $sink_id[, string $contentType = self::contentTypes['deleteDomainMonitorAlertSink'][0] ]) : PromiseInterface
Delete monitor alert sink
Parameters
- $monitor_id : string
-
(required)
- $sink_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDomainMonitorAlertSinkRequest()
Create request for operation 'deleteDomainMonitorAlertSink'
public
deleteDomainMonitorAlertSinkRequest(string $monitor_id, string $sink_id[, string $contentType = self::contentTypes['deleteDomainMonitorAlertSink'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $sink_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
Request —deleteDomainMonitorAlertSinkWithHttpInfo()
Operation deleteDomainMonitorAlertSinkWithHttpInfo
public
deleteDomainMonitorAlertSinkWithHttpInfo(string $monitor_id, string $sink_id[, string $contentType = self::contentTypes['deleteDomainMonitorAlertSink'][0] ]) : array<string|int, mixed>
Delete monitor alert sink
Parameters
- $monitor_id : string
-
(required)
- $sink_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitorAlertSink'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorAlertSink'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteDomainMonitorAsync()
Operation deleteDomainMonitorAsync
public
deleteDomainMonitorAsync(string $monitor_id[, string $contentType = self::contentTypes['deleteDomainMonitor'][0] ]) : PromiseInterface
Delete domain monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitor'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDomainMonitorAsyncWithHttpInfo()
Operation deleteDomainMonitorAsyncWithHttpInfo
public
deleteDomainMonitorAsyncWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['deleteDomainMonitor'][0] ]) : PromiseInterface
Delete domain monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitor'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDomainMonitorObservedAuthSample()
Operation deleteDomainMonitorObservedAuthSample
public
deleteDomainMonitorObservedAuthSample(string $monitor_id, string $sample_id[, string $contentType = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0] ]) : void
Delete domain monitor observed authentication sample
Parameters
- $monitor_id : string
-
monitor_id (required)
- $sample_id : string
-
sample_id (required)
- $contentType : string = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorObservedAuthSample'] to see the possible values for this operation
Tags
Return values
void —deleteDomainMonitorObservedAuthSampleAsync()
Operation deleteDomainMonitorObservedAuthSampleAsync
public
deleteDomainMonitorObservedAuthSampleAsync(string $monitor_id, string $sample_id[, string $contentType = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0] ]) : PromiseInterface
Delete domain monitor observed authentication sample
Parameters
- $monitor_id : string
-
(required)
- $sample_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorObservedAuthSample'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDomainMonitorObservedAuthSampleAsyncWithHttpInfo()
Operation deleteDomainMonitorObservedAuthSampleAsyncWithHttpInfo
public
deleteDomainMonitorObservedAuthSampleAsyncWithHttpInfo(string $monitor_id, string $sample_id[, string $contentType = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0] ]) : PromiseInterface
Delete domain monitor observed authentication sample
Parameters
- $monitor_id : string
-
(required)
- $sample_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorObservedAuthSample'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteDomainMonitorObservedAuthSampleRequest()
Create request for operation 'deleteDomainMonitorObservedAuthSample'
public
deleteDomainMonitorObservedAuthSampleRequest(string $monitor_id, string $sample_id[, string $contentType = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $sample_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorObservedAuthSample'] to see the possible values for this operation
Tags
Return values
Request —deleteDomainMonitorObservedAuthSampleWithHttpInfo()
Operation deleteDomainMonitorObservedAuthSampleWithHttpInfo
public
deleteDomainMonitorObservedAuthSampleWithHttpInfo(string $monitor_id, string $sample_id[, string $contentType = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0] ]) : array<string|int, mixed>
Delete domain monitor observed authentication sample
Parameters
- $monitor_id : string
-
(required)
- $sample_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitorObservedAuthSample'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitorObservedAuthSample'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteDomainMonitorRequest()
Create request for operation 'deleteDomainMonitor'
public
deleteDomainMonitorRequest(string $monitor_id[, string $contentType = self::contentTypes['deleteDomainMonitor'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitor'] to see the possible values for this operation
Tags
Return values
Request —deleteDomainMonitorWithHttpInfo()
Operation deleteDomainMonitorWithHttpInfo
public
deleteDomainMonitorWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['deleteDomainMonitor'][0] ]) : array<string|int, mixed>
Delete domain monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteDomainMonitor'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
exportDomainMonitorRunResults()
Operation exportDomainMonitorRunResults
public
exportDomainMonitorRunResults(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['exportDomainMonitorRunResults'][0] ]) : void
Export monitor run results as CSV
Parameters
- $monitor_id : string
-
monitor_id (required)
- $run_id : string
-
run_id (required)
- $contentType : string = self::contentTypes['exportDomainMonitorRunResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDomainMonitorRunResults'] to see the possible values for this operation
Tags
Return values
void —exportDomainMonitorRunResultsAsync()
Operation exportDomainMonitorRunResultsAsync
public
exportDomainMonitorRunResultsAsync(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['exportDomainMonitorRunResults'][0] ]) : PromiseInterface
Export monitor run results as CSV
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['exportDomainMonitorRunResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDomainMonitorRunResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportDomainMonitorRunResultsAsyncWithHttpInfo()
Operation exportDomainMonitorRunResultsAsyncWithHttpInfo
public
exportDomainMonitorRunResultsAsyncWithHttpInfo(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['exportDomainMonitorRunResults'][0] ]) : PromiseInterface
Export monitor run results as CSV
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['exportDomainMonitorRunResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDomainMonitorRunResults'] to see the possible values for this operation
Tags
Return values
PromiseInterface —exportDomainMonitorRunResultsRequest()
Create request for operation 'exportDomainMonitorRunResults'
public
exportDomainMonitorRunResultsRequest(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['exportDomainMonitorRunResults'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['exportDomainMonitorRunResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDomainMonitorRunResults'] to see the possible values for this operation
Tags
Return values
Request —exportDomainMonitorRunResultsWithHttpInfo()
Operation exportDomainMonitorRunResultsWithHttpInfo
public
exportDomainMonitorRunResultsWithHttpInfo(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['exportDomainMonitorRunResults'][0] ]) : array<string|int, mixed>
Export monitor run results as CSV
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['exportDomainMonitorRunResults'][0]
-
The value for the Content-Type header. Check self::contentTypes['exportDomainMonitorRunResults'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getDomainMonitor()
Operation getDomainMonitor
public
getDomainMonitor(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitor'][0] ]) : DomainMonitorDto
Get domain monitor
Parameters
- $monitor_id : string
-
monitor_id (required)
- $contentType : string = self::contentTypes['getDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitor'] to see the possible values for this operation
Tags
Return values
DomainMonitorDto —getDomainMonitorAlertSinks()
Operation getDomainMonitorAlertSinks
public
getDomainMonitorAlertSinks(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorAlertSinks'][0] ]) : array<string|int, DomainMonitorAlertSinkDto>
List alert sinks for monitor
Parameters
- $monitor_id : string
-
monitor_id (required)
- $contentType : string = self::contentTypes['getDomainMonitorAlertSinks'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAlertSinks'] to see the possible values for this operation
Tags
Return values
array<string|int, DomainMonitorAlertSinkDto> —getDomainMonitorAlertSinksAsync()
Operation getDomainMonitorAlertSinksAsync
public
getDomainMonitorAlertSinksAsync(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorAlertSinks'][0] ]) : PromiseInterface
List alert sinks for monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorAlertSinks'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAlertSinks'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorAlertSinksAsyncWithHttpInfo()
Operation getDomainMonitorAlertSinksAsyncWithHttpInfo
public
getDomainMonitorAlertSinksAsyncWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorAlertSinks'][0] ]) : PromiseInterface
List alert sinks for monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorAlertSinks'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAlertSinks'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorAlertSinksRequest()
Create request for operation 'getDomainMonitorAlertSinks'
public
getDomainMonitorAlertSinksRequest(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorAlertSinks'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorAlertSinks'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAlertSinks'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorAlertSinksWithHttpInfo()
Operation getDomainMonitorAlertSinksWithHttpInfo
public
getDomainMonitorAlertSinksWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorAlertSinks'][0] ]) : array<string|int, mixed>
List alert sinks for monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorAlertSinks'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAlertSinks'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorAlertSinkDto[], HTTP status code, HTTP response headers (array of strings)
getDomainMonitorAsync()
Operation getDomainMonitorAsync
public
getDomainMonitorAsync(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitor'][0] ]) : PromiseInterface
Get domain monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitor'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorAsyncWithHttpInfo()
Operation getDomainMonitorAsyncWithHttpInfo
public
getDomainMonitorAsyncWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitor'][0] ]) : PromiseInterface
Get domain monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitor'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorAuthStack()
Operation getDomainMonitorAuthStack
public
getDomainMonitorAuthStack(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorAuthStack'][0] ]) : CheckEmailAuthStackResults
Get current auth stack for monitor domain
Parameters
- $monitor_id : string
-
monitor_id (required)
- $dkim_selector : string = null
-
dkim_selector (optional)
- $contentType : string = self::contentTypes['getDomainMonitorAuthStack'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAuthStack'] to see the possible values for this operation
Tags
Return values
CheckEmailAuthStackResults —getDomainMonitorAuthStackAsync()
Operation getDomainMonitorAuthStackAsync
public
getDomainMonitorAuthStackAsync(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorAuthStack'][0] ]) : PromiseInterface
Get current auth stack for monitor domain
Parameters
- $monitor_id : string
-
(required)
- $dkim_selector : string = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorAuthStack'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAuthStack'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorAuthStackAsyncWithHttpInfo()
Operation getDomainMonitorAuthStackAsyncWithHttpInfo
public
getDomainMonitorAuthStackAsyncWithHttpInfo(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorAuthStack'][0] ]) : PromiseInterface
Get current auth stack for monitor domain
Parameters
- $monitor_id : string
-
(required)
- $dkim_selector : string = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorAuthStack'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAuthStack'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorAuthStackRequest()
Create request for operation 'getDomainMonitorAuthStack'
public
getDomainMonitorAuthStackRequest(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorAuthStack'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $dkim_selector : string = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorAuthStack'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAuthStack'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorAuthStackWithHttpInfo()
Operation getDomainMonitorAuthStackWithHttpInfo
public
getDomainMonitorAuthStackWithHttpInfo(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorAuthStack'][0] ]) : array<string|int, mixed>
Get current auth stack for monitor domain
Parameters
- $monitor_id : string
-
(required)
- $dkim_selector : string = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorAuthStack'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorAuthStack'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CheckEmailAuthStackResults, HTTP status code, HTTP response headers (array of strings)
getDomainMonitorEmailVerification()
Operation getDomainMonitorEmailVerification
public
getDomainMonitorEmailVerification(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorEmailVerification'][0] ]) : DomainMonitorEmailVerificationDto
Get domain monitor email verification setup
Parameters
- $monitor_id : string
-
monitor_id (required)
- $contentType : string = self::contentTypes['getDomainMonitorEmailVerification'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorEmailVerification'] to see the possible values for this operation
Tags
Return values
DomainMonitorEmailVerificationDto —getDomainMonitorEmailVerificationAsync()
Operation getDomainMonitorEmailVerificationAsync
public
getDomainMonitorEmailVerificationAsync(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorEmailVerification'][0] ]) : PromiseInterface
Get domain monitor email verification setup
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorEmailVerification'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorEmailVerification'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorEmailVerificationAsyncWithHttpInfo()
Operation getDomainMonitorEmailVerificationAsyncWithHttpInfo
public
getDomainMonitorEmailVerificationAsyncWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorEmailVerification'][0] ]) : PromiseInterface
Get domain monitor email verification setup
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorEmailVerification'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorEmailVerification'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorEmailVerificationRequest()
Create request for operation 'getDomainMonitorEmailVerification'
public
getDomainMonitorEmailVerificationRequest(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorEmailVerification'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorEmailVerification'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorEmailVerification'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorEmailVerificationWithHttpInfo()
Operation getDomainMonitorEmailVerificationWithHttpInfo
public
getDomainMonitorEmailVerificationWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorEmailVerification'][0] ]) : array<string|int, mixed>
Get domain monitor email verification setup
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorEmailVerification'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorEmailVerification'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorEmailVerificationDto, HTTP status code, HTTP response headers (array of strings)
getDomainMonitorInsights()
Operation getDomainMonitorInsights
public
getDomainMonitorInsights(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDomainMonitorInsights'][0] ]) : DomainMonitorInsightsDto
Get monitor insights
Parameters
- $monitor_id : string
-
monitor_id (required)
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $contentType : string = self::contentTypes['getDomainMonitorInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorInsights'] to see the possible values for this operation
Tags
Return values
DomainMonitorInsightsDto —getDomainMonitorInsightsAsync()
Operation getDomainMonitorInsightsAsync
public
getDomainMonitorInsightsAsync(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDomainMonitorInsights'][0] ]) : PromiseInterface
Get monitor insights
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorInsights'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorInsightsAsyncWithHttpInfo()
Operation getDomainMonitorInsightsAsyncWithHttpInfo
public
getDomainMonitorInsightsAsyncWithHttpInfo(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDomainMonitorInsights'][0] ]) : PromiseInterface
Get monitor insights
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorInsights'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorInsightsRequest()
Create request for operation 'getDomainMonitorInsights'
public
getDomainMonitorInsightsRequest(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDomainMonitorInsights'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorInsights'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorInsightsWithHttpInfo()
Operation getDomainMonitorInsightsWithHttpInfo
public
getDomainMonitorInsightsWithHttpInfo(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getDomainMonitorInsights'][0] ]) : array<string|int, mixed>
Get monitor insights
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorInsights'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorInsightsDto, HTTP status code, HTTP response headers (array of strings)
getDomainMonitorObservedAuthSamples()
Operation getDomainMonitorObservedAuthSamples
public
getDomainMonitorObservedAuthSamples(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorObservedAuthSamples'][0] ]) : array<string|int, DomainMonitorObservedAuthSampleDto>
List domain monitor observed authentication samples
Parameters
- $monitor_id : string
-
monitor_id (required)
- $contentType : string = self::contentTypes['getDomainMonitorObservedAuthSamples'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorObservedAuthSamples'] to see the possible values for this operation
Tags
Return values
array<string|int, DomainMonitorObservedAuthSampleDto> —getDomainMonitorObservedAuthSamplesAsync()
Operation getDomainMonitorObservedAuthSamplesAsync
public
getDomainMonitorObservedAuthSamplesAsync(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorObservedAuthSamples'][0] ]) : PromiseInterface
List domain monitor observed authentication samples
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorObservedAuthSamples'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorObservedAuthSamples'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorObservedAuthSamplesAsyncWithHttpInfo()
Operation getDomainMonitorObservedAuthSamplesAsyncWithHttpInfo
public
getDomainMonitorObservedAuthSamplesAsyncWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorObservedAuthSamples'][0] ]) : PromiseInterface
List domain monitor observed authentication samples
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorObservedAuthSamples'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorObservedAuthSamples'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorObservedAuthSamplesRequest()
Create request for operation 'getDomainMonitorObservedAuthSamples'
public
getDomainMonitorObservedAuthSamplesRequest(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorObservedAuthSamples'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorObservedAuthSamples'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorObservedAuthSamples'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorObservedAuthSamplesWithHttpInfo()
Operation getDomainMonitorObservedAuthSamplesWithHttpInfo
public
getDomainMonitorObservedAuthSamplesWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitorObservedAuthSamples'][0] ]) : array<string|int, mixed>
List domain monitor observed authentication samples
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorObservedAuthSamples'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorObservedAuthSamples'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorObservedAuthSampleDto[], HTTP status code, HTTP response headers (array of strings)
getDomainMonitorRequest()
Create request for operation 'getDomainMonitor'
public
getDomainMonitorRequest(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitor'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitor'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorRun()
Operation getDomainMonitorRun
public
getDomainMonitorRun(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['getDomainMonitorRun'][0] ]) : DomainMonitorRunDto
Get monitor run
Parameters
- $monitor_id : string
-
monitor_id (required)
- $run_id : string
-
run_id (required)
- $contentType : string = self::contentTypes['getDomainMonitorRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRun'] to see the possible values for this operation
Tags
Return values
DomainMonitorRunDto —getDomainMonitorRunAsync()
Operation getDomainMonitorRunAsync
public
getDomainMonitorRunAsync(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['getDomainMonitorRun'][0] ]) : PromiseInterface
Get monitor run
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRun'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorRunAsyncWithHttpInfo()
Operation getDomainMonitorRunAsyncWithHttpInfo
public
getDomainMonitorRunAsyncWithHttpInfo(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['getDomainMonitorRun'][0] ]) : PromiseInterface
Get monitor run
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRun'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorRunRequest()
Create request for operation 'getDomainMonitorRun'
public
getDomainMonitorRunRequest(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['getDomainMonitorRun'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRun'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorRuns()
Operation getDomainMonitorRuns
public
getDomainMonitorRuns(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDomainMonitorRuns'][0] ]) : array<string|int, DomainMonitorRunDto>
List monitor runs
Parameters
- $monitor_id : string
-
monitor_id (required)
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $status : string = null
-
status (optional)
- $limit : int = null
-
limit (optional)
- $contentType : string = self::contentTypes['getDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
array<string|int, DomainMonitorRunDto> —getDomainMonitorRunsAsync()
Operation getDomainMonitorRunsAsync
public
getDomainMonitorRunsAsync(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDomainMonitorRuns'][0] ]) : PromiseInterface
List monitor runs
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $status : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorRunsAsyncWithHttpInfo()
Operation getDomainMonitorRunsAsyncWithHttpInfo
public
getDomainMonitorRunsAsyncWithHttpInfo(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDomainMonitorRuns'][0] ]) : PromiseInterface
List monitor runs
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $status : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorRunsRequest()
Create request for operation 'getDomainMonitorRuns'
public
getDomainMonitorRunsRequest(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDomainMonitorRuns'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $status : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorRunsWithHttpInfo()
Operation getDomainMonitorRunsWithHttpInfo
public
getDomainMonitorRunsWithHttpInfo(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getDomainMonitorRuns'][0] ]) : array<string|int, mixed>
List monitor runs
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $status : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRuns'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorRunDto[], HTTP status code, HTTP response headers (array of strings)
getDomainMonitorRunWithHttpInfo()
Operation getDomainMonitorRunWithHttpInfo
public
getDomainMonitorRunWithHttpInfo(string $monitor_id, string $run_id[, string $contentType = self::contentTypes['getDomainMonitorRun'][0] ]) : array<string|int, mixed>
Get monitor run
Parameters
- $monitor_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitorRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorRun'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorRunDto, HTTP status code, HTTP response headers (array of strings)
getDomainMonitors()
Operation getDomainMonitors
public
getDomainMonitors([string $contentType = self::contentTypes['getDomainMonitors'][0] ]) : array<string|int, DomainMonitorDto>
List domain monitors
Parameters
- $contentType : string = self::contentTypes['getDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitors'] to see the possible values for this operation
Tags
Return values
array<string|int, DomainMonitorDto> —getDomainMonitorsAsync()
Operation getDomainMonitorsAsync
public
getDomainMonitorsAsync([string $contentType = self::contentTypes['getDomainMonitors'][0] ]) : PromiseInterface
List domain monitors
Parameters
- $contentType : string = self::contentTypes['getDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitors'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorsAsyncWithHttpInfo()
Operation getDomainMonitorsAsyncWithHttpInfo
public
getDomainMonitorsAsyncWithHttpInfo([string $contentType = self::contentTypes['getDomainMonitors'][0] ]) : PromiseInterface
List domain monitors
Parameters
- $contentType : string = self::contentTypes['getDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitors'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorSeries()
Operation getDomainMonitorSeries
public
getDomainMonitorSeries(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getDomainMonitorSeries'][0] ]) : DomainMonitorSeriesDto
Get monitor trend series
Parameters
- $monitor_id : string
-
monitor_id (required)
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $bucket : string = 'DAY'
-
bucket (optional, default to 'DAY')
- $contentType : string = self::contentTypes['getDomainMonitorSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSeries'] to see the possible values for this operation
Tags
Return values
DomainMonitorSeriesDto —getDomainMonitorSeriesAsync()
Operation getDomainMonitorSeriesAsync
public
getDomainMonitorSeriesAsync(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getDomainMonitorSeries'][0] ]) : PromiseInterface
Get monitor trend series
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $contentType : string = self::contentTypes['getDomainMonitorSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSeries'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorSeriesAsyncWithHttpInfo()
Operation getDomainMonitorSeriesAsyncWithHttpInfo
public
getDomainMonitorSeriesAsyncWithHttpInfo(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getDomainMonitorSeries'][0] ]) : PromiseInterface
Get monitor trend series
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $contentType : string = self::contentTypes['getDomainMonitorSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSeries'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorSeriesRequest()
Create request for operation 'getDomainMonitorSeries'
public
getDomainMonitorSeriesRequest(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getDomainMonitorSeries'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $contentType : string = self::contentTypes['getDomainMonitorSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSeries'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorSeriesWithHttpInfo()
Operation getDomainMonitorSeriesWithHttpInfo
public
getDomainMonitorSeriesWithHttpInfo(string $monitor_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getDomainMonitorSeries'][0] ]) : array<string|int, mixed>
Get monitor trend series
Parameters
- $monitor_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $contentType : string = self::contentTypes['getDomainMonitorSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSeries'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorSeriesDto, HTTP status code, HTTP response headers (array of strings)
getDomainMonitorsRequest()
Create request for operation 'getDomainMonitors'
public
getDomainMonitorsRequest([string $contentType = self::contentTypes['getDomainMonitors'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitors'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorSummary()
Operation getDomainMonitorSummary
public
getDomainMonitorSummary(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorSummary'][0] ]) : DomainMonitorSummaryDto
Get domain monitor summary
Parameters
- $monitor_id : string
-
monitor_id (required)
- $dkim_selector : string = null
-
dkim_selector (optional)
- $contentType : string = self::contentTypes['getDomainMonitorSummary'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSummary'] to see the possible values for this operation
Tags
Return values
DomainMonitorSummaryDto —getDomainMonitorSummaryAsync()
Operation getDomainMonitorSummaryAsync
public
getDomainMonitorSummaryAsync(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorSummary'][0] ]) : PromiseInterface
Get domain monitor summary
Parameters
- $monitor_id : string
-
(required)
- $dkim_selector : string = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorSummary'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSummary'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorSummaryAsyncWithHttpInfo()
Operation getDomainMonitorSummaryAsyncWithHttpInfo
public
getDomainMonitorSummaryAsyncWithHttpInfo(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorSummary'][0] ]) : PromiseInterface
Get domain monitor summary
Parameters
- $monitor_id : string
-
(required)
- $dkim_selector : string = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorSummary'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSummary'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getDomainMonitorSummaryRequest()
Create request for operation 'getDomainMonitorSummary'
public
getDomainMonitorSummaryRequest(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorSummary'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $dkim_selector : string = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorSummary'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSummary'] to see the possible values for this operation
Tags
Return values
Request —getDomainMonitorSummaryWithHttpInfo()
Operation getDomainMonitorSummaryWithHttpInfo
public
getDomainMonitorSummaryWithHttpInfo(string $monitor_id[, string $dkim_selector = null ][, string $contentType = self::contentTypes['getDomainMonitorSummary'][0] ]) : array<string|int, mixed>
Get domain monitor summary
Parameters
- $monitor_id : string
-
(required)
- $dkim_selector : string = null
-
(optional)
- $contentType : string = self::contentTypes['getDomainMonitorSummary'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitorSummary'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorSummaryDto, HTTP status code, HTTP response headers (array of strings)
getDomainMonitorsWithHttpInfo()
Operation getDomainMonitorsWithHttpInfo
public
getDomainMonitorsWithHttpInfo([string $contentType = self::contentTypes['getDomainMonitors'][0] ]) : array<string|int, mixed>
List domain monitors
Parameters
- $contentType : string = self::contentTypes['getDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitors'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorDto[], HTTP status code, HTTP response headers (array of strings)
getDomainMonitorWithHttpInfo()
Operation getDomainMonitorWithHttpInfo
public
getDomainMonitorWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['getDomainMonitor'][0] ]) : array<string|int, mixed>
Get domain monitor
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['getDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['getDomainMonitor'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorDto, HTTP status code, HTTP response headers (array of strings)
getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
runDomainMonitorNow()
Operation runDomainMonitorNow
public
runDomainMonitorNow(string $monitor_id[, string $contentType = self::contentTypes['runDomainMonitorNow'][0] ]) : DomainMonitorRunNowResult
Run monitor now
Parameters
- $monitor_id : string
-
monitor_id (required)
- $contentType : string = self::contentTypes['runDomainMonitorNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDomainMonitorNow'] to see the possible values for this operation
Tags
Return values
DomainMonitorRunNowResult —runDomainMonitorNowAsync()
Operation runDomainMonitorNowAsync
public
runDomainMonitorNowAsync(string $monitor_id[, string $contentType = self::contentTypes['runDomainMonitorNow'][0] ]) : PromiseInterface
Run monitor now
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['runDomainMonitorNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDomainMonitorNow'] to see the possible values for this operation
Tags
Return values
PromiseInterface —runDomainMonitorNowAsyncWithHttpInfo()
Operation runDomainMonitorNowAsyncWithHttpInfo
public
runDomainMonitorNowAsyncWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['runDomainMonitorNow'][0] ]) : PromiseInterface
Run monitor now
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['runDomainMonitorNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDomainMonitorNow'] to see the possible values for this operation
Tags
Return values
PromiseInterface —runDomainMonitorNowRequest()
Create request for operation 'runDomainMonitorNow'
public
runDomainMonitorNowRequest(string $monitor_id[, string $contentType = self::contentTypes['runDomainMonitorNow'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['runDomainMonitorNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDomainMonitorNow'] to see the possible values for this operation
Tags
Return values
Request —runDomainMonitorNowWithHttpInfo()
Operation runDomainMonitorNowWithHttpInfo
public
runDomainMonitorNowWithHttpInfo(string $monitor_id[, string $contentType = self::contentTypes['runDomainMonitorNow'][0] ]) : array<string|int, mixed>
Run monitor now
Parameters
- $monitor_id : string
-
(required)
- $contentType : string = self::contentTypes['runDomainMonitorNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDomainMonitorNow'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorRunNowResult, HTTP status code, HTTP response headers (array of strings)
runDueDomainMonitors()
Operation runDueDomainMonitors
public
runDueDomainMonitors([int $max_runs = null ][, string $contentType = self::contentTypes['runDueDomainMonitors'][0] ]) : DomainMonitorRunDueResult
Run due monitors for user
Parameters
- $max_runs : int = null
-
max_runs (optional)
- $contentType : string = self::contentTypes['runDueDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueDomainMonitors'] to see the possible values for this operation
Tags
Return values
DomainMonitorRunDueResult —runDueDomainMonitorsAsync()
Operation runDueDomainMonitorsAsync
public
runDueDomainMonitorsAsync([int $max_runs = null ][, string $contentType = self::contentTypes['runDueDomainMonitors'][0] ]) : PromiseInterface
Run due monitors for user
Parameters
- $max_runs : int = null
-
(optional)
- $contentType : string = self::contentTypes['runDueDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueDomainMonitors'] to see the possible values for this operation
Tags
Return values
PromiseInterface —runDueDomainMonitorsAsyncWithHttpInfo()
Operation runDueDomainMonitorsAsyncWithHttpInfo
public
runDueDomainMonitorsAsyncWithHttpInfo([int $max_runs = null ][, string $contentType = self::contentTypes['runDueDomainMonitors'][0] ]) : PromiseInterface
Run due monitors for user
Parameters
- $max_runs : int = null
-
(optional)
- $contentType : string = self::contentTypes['runDueDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueDomainMonitors'] to see the possible values for this operation
Tags
Return values
PromiseInterface —runDueDomainMonitorsRequest()
Create request for operation 'runDueDomainMonitors'
public
runDueDomainMonitorsRequest([int $max_runs = null ][, string $contentType = self::contentTypes['runDueDomainMonitors'][0] ]) : Request
Parameters
- $max_runs : int = null
-
(optional)
- $contentType : string = self::contentTypes['runDueDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueDomainMonitors'] to see the possible values for this operation
Tags
Return values
Request —runDueDomainMonitorsWithHttpInfo()
Operation runDueDomainMonitorsWithHttpInfo
public
runDueDomainMonitorsWithHttpInfo([int $max_runs = null ][, string $contentType = self::contentTypes['runDueDomainMonitors'][0] ]) : array<string|int, mixed>
Run due monitors for user
Parameters
- $max_runs : int = null
-
(optional)
- $contentType : string = self::contentTypes['runDueDomainMonitors'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueDomainMonitors'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorRunDueResult, 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 —updateDomainMonitor()
Operation updateDomainMonitor
public
updateDomainMonitor(string $monitor_id, UpdateDomainMonitorOptions $update_domain_monitor_options[, string $contentType = self::contentTypes['updateDomainMonitor'][0] ]) : DomainMonitorDto
Update domain monitor
Parameters
- $monitor_id : string
-
monitor_id (required)
- $update_domain_monitor_options : UpdateDomainMonitorOptions
-
update_domain_monitor_options (required)
- $contentType : string = self::contentTypes['updateDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomainMonitor'] to see the possible values for this operation
Tags
Return values
DomainMonitorDto —updateDomainMonitorAsync()
Operation updateDomainMonitorAsync
public
updateDomainMonitorAsync(string $monitor_id, UpdateDomainMonitorOptions $update_domain_monitor_options[, string $contentType = self::contentTypes['updateDomainMonitor'][0] ]) : PromiseInterface
Update domain monitor
Parameters
- $monitor_id : string
-
(required)
- $update_domain_monitor_options : UpdateDomainMonitorOptions
-
(required)
- $contentType : string = self::contentTypes['updateDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomainMonitor'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateDomainMonitorAsyncWithHttpInfo()
Operation updateDomainMonitorAsyncWithHttpInfo
public
updateDomainMonitorAsyncWithHttpInfo(string $monitor_id, UpdateDomainMonitorOptions $update_domain_monitor_options[, string $contentType = self::contentTypes['updateDomainMonitor'][0] ]) : PromiseInterface
Update domain monitor
Parameters
- $monitor_id : string
-
(required)
- $update_domain_monitor_options : UpdateDomainMonitorOptions
-
(required)
- $contentType : string = self::contentTypes['updateDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomainMonitor'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateDomainMonitorRequest()
Create request for operation 'updateDomainMonitor'
public
updateDomainMonitorRequest(string $monitor_id, UpdateDomainMonitorOptions $update_domain_monitor_options[, string $contentType = self::contentTypes['updateDomainMonitor'][0] ]) : Request
Parameters
- $monitor_id : string
-
(required)
- $update_domain_monitor_options : UpdateDomainMonitorOptions
-
(required)
- $contentType : string = self::contentTypes['updateDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomainMonitor'] to see the possible values for this operation
Tags
Return values
Request —updateDomainMonitorWithHttpInfo()
Operation updateDomainMonitorWithHttpInfo
public
updateDomainMonitorWithHttpInfo(string $monitor_id, UpdateDomainMonitorOptions $update_domain_monitor_options[, string $contentType = self::contentTypes['updateDomainMonitor'][0] ]) : array<string|int, mixed>
Update domain monitor
Parameters
- $monitor_id : string
-
(required)
- $update_domain_monitor_options : UpdateDomainMonitorOptions
-
(required)
- $contentType : string = self::contentTypes['updateDomainMonitor'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateDomainMonitor'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\DomainMonitorDto, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options