CampaignProbeControllerApi
in package
CampaignProbeControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['compareCampaignProbeRuns' => ['application/json'], 'createCampaignProbe' => ['application/json'], 'deleteCampaignProbe' => ['application/json'], 'getCampaignProbe' => ['application/json'], 'getCampaignProbeInsights' => ['application/json'], 'getCampaignProbeRun' => ['application/json'], 'getCampaignProbeRuns' => ['application/json'], 'getCampaignProbeSeries' => ['application/json'], 'getCampaignProbes' => ['application/json'], 'runCampaignProbeNow' => ['application/json'], 'runDueCampaignProbes' => ['application/json'], 'updateCampaignProbe' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- compareCampaignProbeRuns() : CampaignProbeRunComparisonDto
- Operation compareCampaignProbeRuns
- compareCampaignProbeRunsAsync() : PromiseInterface
- Operation compareCampaignProbeRunsAsync
- compareCampaignProbeRunsAsyncWithHttpInfo() : PromiseInterface
- Operation compareCampaignProbeRunsAsyncWithHttpInfo
- compareCampaignProbeRunsRequest() : Request
- Create request for operation 'compareCampaignProbeRuns'
- compareCampaignProbeRunsWithHttpInfo() : array<string|int, mixed>
- Operation compareCampaignProbeRunsWithHttpInfo
- createCampaignProbe() : CampaignProbeDto
- Operation createCampaignProbe
- createCampaignProbeAsync() : PromiseInterface
- Operation createCampaignProbeAsync
- createCampaignProbeAsyncWithHttpInfo() : PromiseInterface
- Operation createCampaignProbeAsyncWithHttpInfo
- createCampaignProbeRequest() : Request
- Create request for operation 'createCampaignProbe'
- createCampaignProbeWithHttpInfo() : array<string|int, mixed>
- Operation createCampaignProbeWithHttpInfo
- deleteCampaignProbe() : void
- Operation deleteCampaignProbe
- deleteCampaignProbeAsync() : PromiseInterface
- Operation deleteCampaignProbeAsync
- deleteCampaignProbeAsyncWithHttpInfo() : PromiseInterface
- Operation deleteCampaignProbeAsyncWithHttpInfo
- deleteCampaignProbeRequest() : Request
- Create request for operation 'deleteCampaignProbe'
- deleteCampaignProbeWithHttpInfo() : array<string|int, mixed>
- Operation deleteCampaignProbeWithHttpInfo
- getCampaignProbe() : CampaignProbeDto
- Operation getCampaignProbe
- getCampaignProbeAsync() : PromiseInterface
- Operation getCampaignProbeAsync
- getCampaignProbeAsyncWithHttpInfo() : PromiseInterface
- Operation getCampaignProbeAsyncWithHttpInfo
- getCampaignProbeInsights() : CampaignProbeInsightsDto
- Operation getCampaignProbeInsights
- getCampaignProbeInsightsAsync() : PromiseInterface
- Operation getCampaignProbeInsightsAsync
- getCampaignProbeInsightsAsyncWithHttpInfo() : PromiseInterface
- Operation getCampaignProbeInsightsAsyncWithHttpInfo
- getCampaignProbeInsightsRequest() : Request
- Create request for operation 'getCampaignProbeInsights'
- getCampaignProbeInsightsWithHttpInfo() : array<string|int, mixed>
- Operation getCampaignProbeInsightsWithHttpInfo
- getCampaignProbeRequest() : Request
- Create request for operation 'getCampaignProbe'
- getCampaignProbeRun() : CampaignProbeRunDto
- Operation getCampaignProbeRun
- getCampaignProbeRunAsync() : PromiseInterface
- Operation getCampaignProbeRunAsync
- getCampaignProbeRunAsyncWithHttpInfo() : PromiseInterface
- Operation getCampaignProbeRunAsyncWithHttpInfo
- getCampaignProbeRunRequest() : Request
- Create request for operation 'getCampaignProbeRun'
- getCampaignProbeRuns() : array<string|int, CampaignProbeRunDto>
- Operation getCampaignProbeRuns
- getCampaignProbeRunsAsync() : PromiseInterface
- Operation getCampaignProbeRunsAsync
- getCampaignProbeRunsAsyncWithHttpInfo() : PromiseInterface
- Operation getCampaignProbeRunsAsyncWithHttpInfo
- getCampaignProbeRunsRequest() : Request
- Create request for operation 'getCampaignProbeRuns'
- getCampaignProbeRunsWithHttpInfo() : array<string|int, mixed>
- Operation getCampaignProbeRunsWithHttpInfo
- getCampaignProbeRunWithHttpInfo() : array<string|int, mixed>
- Operation getCampaignProbeRunWithHttpInfo
- getCampaignProbes() : array<string|int, CampaignProbeDto>
- Operation getCampaignProbes
- getCampaignProbesAsync() : PromiseInterface
- Operation getCampaignProbesAsync
- getCampaignProbesAsyncWithHttpInfo() : PromiseInterface
- Operation getCampaignProbesAsyncWithHttpInfo
- getCampaignProbeSeries() : CampaignProbeSeriesDto
- Operation getCampaignProbeSeries
- getCampaignProbeSeriesAsync() : PromiseInterface
- Operation getCampaignProbeSeriesAsync
- getCampaignProbeSeriesAsyncWithHttpInfo() : PromiseInterface
- Operation getCampaignProbeSeriesAsyncWithHttpInfo
- getCampaignProbeSeriesRequest() : Request
- Create request for operation 'getCampaignProbeSeries'
- getCampaignProbeSeriesWithHttpInfo() : array<string|int, mixed>
- Operation getCampaignProbeSeriesWithHttpInfo
- getCampaignProbesRequest() : Request
- Create request for operation 'getCampaignProbes'
- getCampaignProbesWithHttpInfo() : array<string|int, mixed>
- Operation getCampaignProbesWithHttpInfo
- getCampaignProbeWithHttpInfo() : array<string|int, mixed>
- Operation getCampaignProbeWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- runCampaignProbeNow() : CampaignProbeRunNowResult
- Operation runCampaignProbeNow
- runCampaignProbeNowAsync() : PromiseInterface
- Operation runCampaignProbeNowAsync
- runCampaignProbeNowAsyncWithHttpInfo() : PromiseInterface
- Operation runCampaignProbeNowAsyncWithHttpInfo
- runCampaignProbeNowRequest() : Request
- Create request for operation 'runCampaignProbeNow'
- runCampaignProbeNowWithHttpInfo() : array<string|int, mixed>
- Operation runCampaignProbeNowWithHttpInfo
- runDueCampaignProbes() : CampaignProbeRunDueResult
- Operation runDueCampaignProbes
- runDueCampaignProbesAsync() : PromiseInterface
- Operation runDueCampaignProbesAsync
- runDueCampaignProbesAsyncWithHttpInfo() : PromiseInterface
- Operation runDueCampaignProbesAsyncWithHttpInfo
- runDueCampaignProbesRequest() : Request
- Create request for operation 'runDueCampaignProbes'
- runDueCampaignProbesWithHttpInfo() : array<string|int, mixed>
- Operation runDueCampaignProbesWithHttpInfo
- setHostIndex() : void
- Set the host index
- updateCampaignProbe() : CampaignProbeDto
- Operation updateCampaignProbe
- updateCampaignProbeAsync() : PromiseInterface
- Operation updateCampaignProbeAsync
- updateCampaignProbeAsyncWithHttpInfo() : PromiseInterface
- Operation updateCampaignProbeAsyncWithHttpInfo
- updateCampaignProbeRequest() : Request
- Create request for operation 'updateCampaignProbe'
- updateCampaignProbeWithHttpInfo() : array<string|int, mixed>
- Operation updateCampaignProbeWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['compareCampaignProbeRuns' => ['application/json'], 'createCampaignProbe' => ['application/json'], 'deleteCampaignProbe' => ['application/json'], 'getCampaignProbe' => ['application/json'], 'getCampaignProbeInsights' => ['application/json'], 'getCampaignProbeRun' => ['application/json'], 'getCampaignProbeRuns' => ['application/json'], 'getCampaignProbeSeries' => ['application/json'], 'getCampaignProbes' => ['application/json'], 'runCampaignProbeNow' => ['application/json'], 'runDueCampaignProbes' => ['application/json'], 'updateCampaignProbe' => ['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 —compareCampaignProbeRuns()
Operation compareCampaignProbeRuns
public
compareCampaignProbeRuns(string $probe_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareCampaignProbeRuns'][0] ]) : CampaignProbeRunComparisonDto
Compare two campaign probe runs
Parameters
- $probe_id : string
-
probe_id (required)
- $run_id : string
-
run_id (required)
- $other_run_id : string
-
other_run_id (required)
- $contentType : string = self::contentTypes['compareCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
CampaignProbeRunComparisonDto —compareCampaignProbeRunsAsync()
Operation compareCampaignProbeRunsAsync
public
compareCampaignProbeRunsAsync(string $probe_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareCampaignProbeRuns'][0] ]) : PromiseInterface
Compare two campaign probe runs
Parameters
- $probe_id : string
-
(required)
- $run_id : string
-
(required)
- $other_run_id : string
-
(required)
- $contentType : string = self::contentTypes['compareCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —compareCampaignProbeRunsAsyncWithHttpInfo()
Operation compareCampaignProbeRunsAsyncWithHttpInfo
public
compareCampaignProbeRunsAsyncWithHttpInfo(string $probe_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareCampaignProbeRuns'][0] ]) : PromiseInterface
Compare two campaign probe runs
Parameters
- $probe_id : string
-
(required)
- $run_id : string
-
(required)
- $other_run_id : string
-
(required)
- $contentType : string = self::contentTypes['compareCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —compareCampaignProbeRunsRequest()
Create request for operation 'compareCampaignProbeRuns'
public
compareCampaignProbeRunsRequest(string $probe_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareCampaignProbeRuns'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $run_id : string
-
(required)
- $other_run_id : string
-
(required)
- $contentType : string = self::contentTypes['compareCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
Request —compareCampaignProbeRunsWithHttpInfo()
Operation compareCampaignProbeRunsWithHttpInfo
public
compareCampaignProbeRunsWithHttpInfo(string $probe_id, string $run_id, string $other_run_id[, string $contentType = self::contentTypes['compareCampaignProbeRuns'][0] ]) : array<string|int, mixed>
Compare two campaign probe runs
Parameters
- $probe_id : string
-
(required)
- $run_id : string
-
(required)
- $other_run_id : string
-
(required)
- $contentType : string = self::contentTypes['compareCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['compareCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeRunComparisonDto, HTTP status code, HTTP response headers (array of strings)
createCampaignProbe()
Operation createCampaignProbe
public
createCampaignProbe(CreateCampaignProbeOptions $create_campaign_probe_options[, string $contentType = self::contentTypes['createCampaignProbe'][0] ]) : CampaignProbeDto
Create campaign probe
Parameters
- $create_campaign_probe_options : CreateCampaignProbeOptions
-
create_campaign_probe_options (required)
- $contentType : string = self::contentTypes['createCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['createCampaignProbe'] to see the possible values for this operation
Tags
Return values
CampaignProbeDto —createCampaignProbeAsync()
Operation createCampaignProbeAsync
public
createCampaignProbeAsync(CreateCampaignProbeOptions $create_campaign_probe_options[, string $contentType = self::contentTypes['createCampaignProbe'][0] ]) : PromiseInterface
Create campaign probe
Parameters
- $create_campaign_probe_options : CreateCampaignProbeOptions
-
(required)
- $contentType : string = self::contentTypes['createCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['createCampaignProbe'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createCampaignProbeAsyncWithHttpInfo()
Operation createCampaignProbeAsyncWithHttpInfo
public
createCampaignProbeAsyncWithHttpInfo(CreateCampaignProbeOptions $create_campaign_probe_options[, string $contentType = self::contentTypes['createCampaignProbe'][0] ]) : PromiseInterface
Create campaign probe
Parameters
- $create_campaign_probe_options : CreateCampaignProbeOptions
-
(required)
- $contentType : string = self::contentTypes['createCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['createCampaignProbe'] to see the possible values for this operation
Tags
Return values
PromiseInterface —createCampaignProbeRequest()
Create request for operation 'createCampaignProbe'
public
createCampaignProbeRequest(CreateCampaignProbeOptions $create_campaign_probe_options[, string $contentType = self::contentTypes['createCampaignProbe'][0] ]) : Request
Parameters
- $create_campaign_probe_options : CreateCampaignProbeOptions
-
(required)
- $contentType : string = self::contentTypes['createCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['createCampaignProbe'] to see the possible values for this operation
Tags
Return values
Request —createCampaignProbeWithHttpInfo()
Operation createCampaignProbeWithHttpInfo
public
createCampaignProbeWithHttpInfo(CreateCampaignProbeOptions $create_campaign_probe_options[, string $contentType = self::contentTypes['createCampaignProbe'][0] ]) : array<string|int, mixed>
Create campaign probe
Parameters
- $create_campaign_probe_options : CreateCampaignProbeOptions
-
(required)
- $contentType : string = self::contentTypes['createCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['createCampaignProbe'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeDto, HTTP status code, HTTP response headers (array of strings)
deleteCampaignProbe()
Operation deleteCampaignProbe
public
deleteCampaignProbe(string $probe_id[, string $contentType = self::contentTypes['deleteCampaignProbe'][0] ]) : void
Delete campaign probe
Parameters
- $probe_id : string
-
probe_id (required)
- $contentType : string = self::contentTypes['deleteCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteCampaignProbe'] to see the possible values for this operation
Tags
Return values
void —deleteCampaignProbeAsync()
Operation deleteCampaignProbeAsync
public
deleteCampaignProbeAsync(string $probe_id[, string $contentType = self::contentTypes['deleteCampaignProbe'][0] ]) : PromiseInterface
Delete campaign probe
Parameters
- $probe_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteCampaignProbe'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteCampaignProbeAsyncWithHttpInfo()
Operation deleteCampaignProbeAsyncWithHttpInfo
public
deleteCampaignProbeAsyncWithHttpInfo(string $probe_id[, string $contentType = self::contentTypes['deleteCampaignProbe'][0] ]) : PromiseInterface
Delete campaign probe
Parameters
- $probe_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteCampaignProbe'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteCampaignProbeRequest()
Create request for operation 'deleteCampaignProbe'
public
deleteCampaignProbeRequest(string $probe_id[, string $contentType = self::contentTypes['deleteCampaignProbe'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteCampaignProbe'] to see the possible values for this operation
Tags
Return values
Request —deleteCampaignProbeWithHttpInfo()
Operation deleteCampaignProbeWithHttpInfo
public
deleteCampaignProbeWithHttpInfo(string $probe_id[, string $contentType = self::contentTypes['deleteCampaignProbe'][0] ]) : array<string|int, mixed>
Delete campaign probe
Parameters
- $probe_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteCampaignProbe'] 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)
getCampaignProbe()
Operation getCampaignProbe
public
getCampaignProbe(string $probe_id[, string $contentType = self::contentTypes['getCampaignProbe'][0] ]) : CampaignProbeDto
Get campaign probe
Parameters
- $probe_id : string
-
probe_id (required)
- $contentType : string = self::contentTypes['getCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbe'] to see the possible values for this operation
Tags
Return values
CampaignProbeDto —getCampaignProbeAsync()
Operation getCampaignProbeAsync
public
getCampaignProbeAsync(string $probe_id[, string $contentType = self::contentTypes['getCampaignProbe'][0] ]) : PromiseInterface
Get campaign probe
Parameters
- $probe_id : string
-
(required)
- $contentType : string = self::contentTypes['getCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbe'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeAsyncWithHttpInfo()
Operation getCampaignProbeAsyncWithHttpInfo
public
getCampaignProbeAsyncWithHttpInfo(string $probe_id[, string $contentType = self::contentTypes['getCampaignProbe'][0] ]) : PromiseInterface
Get campaign probe
Parameters
- $probe_id : string
-
(required)
- $contentType : string = self::contentTypes['getCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbe'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeInsights()
Operation getCampaignProbeInsights
public
getCampaignProbeInsights(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getCampaignProbeInsights'][0] ]) : CampaignProbeInsightsDto
Get campaign probe insights
Parameters
- $probe_id : string
-
probe_id (required)
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $contentType : string = self::contentTypes['getCampaignProbeInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeInsights'] to see the possible values for this operation
Tags
Return values
CampaignProbeInsightsDto —getCampaignProbeInsightsAsync()
Operation getCampaignProbeInsightsAsync
public
getCampaignProbeInsightsAsync(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getCampaignProbeInsights'][0] ]) : PromiseInterface
Get campaign probe insights
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getCampaignProbeInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeInsights'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeInsightsAsyncWithHttpInfo()
Operation getCampaignProbeInsightsAsyncWithHttpInfo
public
getCampaignProbeInsightsAsyncWithHttpInfo(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getCampaignProbeInsights'][0] ]) : PromiseInterface
Get campaign probe insights
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getCampaignProbeInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeInsights'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeInsightsRequest()
Create request for operation 'getCampaignProbeInsights'
public
getCampaignProbeInsightsRequest(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getCampaignProbeInsights'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getCampaignProbeInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeInsights'] to see the possible values for this operation
Tags
Return values
Request —getCampaignProbeInsightsWithHttpInfo()
Operation getCampaignProbeInsightsWithHttpInfo
public
getCampaignProbeInsightsWithHttpInfo(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getCampaignProbeInsights'][0] ]) : array<string|int, mixed>
Get campaign probe insights
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $contentType : string = self::contentTypes['getCampaignProbeInsights'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeInsights'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeInsightsDto, HTTP status code, HTTP response headers (array of strings)
getCampaignProbeRequest()
Create request for operation 'getCampaignProbe'
public
getCampaignProbeRequest(string $probe_id[, string $contentType = self::contentTypes['getCampaignProbe'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $contentType : string = self::contentTypes['getCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbe'] to see the possible values for this operation
Tags
Return values
Request —getCampaignProbeRun()
Operation getCampaignProbeRun
public
getCampaignProbeRun(string $probe_id, string $run_id[, string $contentType = self::contentTypes['getCampaignProbeRun'][0] ]) : CampaignProbeRunDto
Get campaign probe run
Parameters
- $probe_id : string
-
probe_id (required)
- $run_id : string
-
run_id (required)
- $contentType : string = self::contentTypes['getCampaignProbeRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRun'] to see the possible values for this operation
Tags
Return values
CampaignProbeRunDto —getCampaignProbeRunAsync()
Operation getCampaignProbeRunAsync
public
getCampaignProbeRunAsync(string $probe_id, string $run_id[, string $contentType = self::contentTypes['getCampaignProbeRun'][0] ]) : PromiseInterface
Get campaign probe run
Parameters
- $probe_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getCampaignProbeRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRun'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeRunAsyncWithHttpInfo()
Operation getCampaignProbeRunAsyncWithHttpInfo
public
getCampaignProbeRunAsyncWithHttpInfo(string $probe_id, string $run_id[, string $contentType = self::contentTypes['getCampaignProbeRun'][0] ]) : PromiseInterface
Get campaign probe run
Parameters
- $probe_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getCampaignProbeRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRun'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeRunRequest()
Create request for operation 'getCampaignProbeRun'
public
getCampaignProbeRunRequest(string $probe_id, string $run_id[, string $contentType = self::contentTypes['getCampaignProbeRun'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getCampaignProbeRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRun'] to see the possible values for this operation
Tags
Return values
Request —getCampaignProbeRuns()
Operation getCampaignProbeRuns
public
getCampaignProbeRuns(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getCampaignProbeRuns'][0] ]) : array<string|int, CampaignProbeRunDto>
List campaign probe runs
Parameters
- $probe_id : string
-
probe_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['getCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
array<string|int, CampaignProbeRunDto> —getCampaignProbeRunsAsync()
Operation getCampaignProbeRunsAsync
public
getCampaignProbeRunsAsync(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getCampaignProbeRuns'][0] ]) : PromiseInterface
List campaign probe runs
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $status : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeRunsAsyncWithHttpInfo()
Operation getCampaignProbeRunsAsyncWithHttpInfo
public
getCampaignProbeRunsAsyncWithHttpInfo(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getCampaignProbeRuns'][0] ]) : PromiseInterface
List campaign probe runs
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $status : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeRunsRequest()
Create request for operation 'getCampaignProbeRuns'
public
getCampaignProbeRunsRequest(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getCampaignProbeRuns'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $status : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
Request —getCampaignProbeRunsWithHttpInfo()
Operation getCampaignProbeRunsWithHttpInfo
public
getCampaignProbeRunsWithHttpInfo(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $status = null ][, int $limit = null ][, string $contentType = self::contentTypes['getCampaignProbeRuns'][0] ]) : array<string|int, mixed>
List campaign probe runs
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $status : string = null
-
(optional)
- $limit : int = null
-
(optional)
- $contentType : string = self::contentTypes['getCampaignProbeRuns'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRuns'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeRunDto[], HTTP status code, HTTP response headers (array of strings)
getCampaignProbeRunWithHttpInfo()
Operation getCampaignProbeRunWithHttpInfo
public
getCampaignProbeRunWithHttpInfo(string $probe_id, string $run_id[, string $contentType = self::contentTypes['getCampaignProbeRun'][0] ]) : array<string|int, mixed>
Get campaign probe run
Parameters
- $probe_id : string
-
(required)
- $run_id : string
-
(required)
- $contentType : string = self::contentTypes['getCampaignProbeRun'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeRun'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeRunDto, HTTP status code, HTTP response headers (array of strings)
getCampaignProbes()
Operation getCampaignProbes
public
getCampaignProbes([string $contentType = self::contentTypes['getCampaignProbes'][0] ]) : array<string|int, CampaignProbeDto>
List campaign probes
Parameters
- $contentType : string = self::contentTypes['getCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbes'] to see the possible values for this operation
Tags
Return values
array<string|int, CampaignProbeDto> —getCampaignProbesAsync()
Operation getCampaignProbesAsync
public
getCampaignProbesAsync([string $contentType = self::contentTypes['getCampaignProbes'][0] ]) : PromiseInterface
List campaign probes
Parameters
- $contentType : string = self::contentTypes['getCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbesAsyncWithHttpInfo()
Operation getCampaignProbesAsyncWithHttpInfo
public
getCampaignProbesAsyncWithHttpInfo([string $contentType = self::contentTypes['getCampaignProbes'][0] ]) : PromiseInterface
List campaign probes
Parameters
- $contentType : string = self::contentTypes['getCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeSeries()
Operation getCampaignProbeSeries
public
getCampaignProbeSeries(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getCampaignProbeSeries'][0] ]) : CampaignProbeSeriesDto
Get campaign probe trend series
Parameters
- $probe_id : string
-
probe_id (required)
- $since : DateTime = null
-
since (optional)
- $before : DateTime = null
-
before (optional)
- $bucket : string = 'DAY'
-
bucket (optional, default to 'DAY')
- $contentType : string = self::contentTypes['getCampaignProbeSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeSeries'] to see the possible values for this operation
Tags
Return values
CampaignProbeSeriesDto —getCampaignProbeSeriesAsync()
Operation getCampaignProbeSeriesAsync
public
getCampaignProbeSeriesAsync(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getCampaignProbeSeries'][0] ]) : PromiseInterface
Get campaign probe trend series
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $contentType : string = self::contentTypes['getCampaignProbeSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeSeries'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeSeriesAsyncWithHttpInfo()
Operation getCampaignProbeSeriesAsyncWithHttpInfo
public
getCampaignProbeSeriesAsyncWithHttpInfo(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getCampaignProbeSeries'][0] ]) : PromiseInterface
Get campaign probe trend series
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $contentType : string = self::contentTypes['getCampaignProbeSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeSeries'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getCampaignProbeSeriesRequest()
Create request for operation 'getCampaignProbeSeries'
public
getCampaignProbeSeriesRequest(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getCampaignProbeSeries'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $contentType : string = self::contentTypes['getCampaignProbeSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeSeries'] to see the possible values for this operation
Tags
Return values
Request —getCampaignProbeSeriesWithHttpInfo()
Operation getCampaignProbeSeriesWithHttpInfo
public
getCampaignProbeSeriesWithHttpInfo(string $probe_id[, DateTime $since = null ][, DateTime $before = null ][, string $bucket = 'DAY' ][, string $contentType = self::contentTypes['getCampaignProbeSeries'][0] ]) : array<string|int, mixed>
Get campaign probe trend series
Parameters
- $probe_id : string
-
(required)
- $since : DateTime = null
-
(optional)
- $before : DateTime = null
-
(optional)
- $bucket : string = 'DAY'
-
(optional, default to 'DAY')
- $contentType : string = self::contentTypes['getCampaignProbeSeries'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbeSeries'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeSeriesDto, HTTP status code, HTTP response headers (array of strings)
getCampaignProbesRequest()
Create request for operation 'getCampaignProbes'
public
getCampaignProbesRequest([string $contentType = self::contentTypes['getCampaignProbes'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbes'] to see the possible values for this operation
Tags
Return values
Request —getCampaignProbesWithHttpInfo()
Operation getCampaignProbesWithHttpInfo
public
getCampaignProbesWithHttpInfo([string $contentType = self::contentTypes['getCampaignProbes'][0] ]) : array<string|int, mixed>
List campaign probes
Parameters
- $contentType : string = self::contentTypes['getCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbes'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeDto[], HTTP status code, HTTP response headers (array of strings)
getCampaignProbeWithHttpInfo()
Operation getCampaignProbeWithHttpInfo
public
getCampaignProbeWithHttpInfo(string $probe_id[, string $contentType = self::contentTypes['getCampaignProbe'][0] ]) : array<string|int, mixed>
Get campaign probe
Parameters
- $probe_id : string
-
(required)
- $contentType : string = self::contentTypes['getCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['getCampaignProbe'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeDto, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
runCampaignProbeNow()
Operation runCampaignProbeNow
public
runCampaignProbeNow(string $probe_id, CreateCampaignProbeRunOptions $create_campaign_probe_run_options[, string $contentType = self::contentTypes['runCampaignProbeNow'][0] ]) : CampaignProbeRunNowResult
Run campaign probe now
Parameters
- $probe_id : string
-
probe_id (required)
- $create_campaign_probe_run_options : CreateCampaignProbeRunOptions
-
create_campaign_probe_run_options (required)
- $contentType : string = self::contentTypes['runCampaignProbeNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runCampaignProbeNow'] to see the possible values for this operation
Tags
Return values
CampaignProbeRunNowResult —runCampaignProbeNowAsync()
Operation runCampaignProbeNowAsync
public
runCampaignProbeNowAsync(string $probe_id, CreateCampaignProbeRunOptions $create_campaign_probe_run_options[, string $contentType = self::contentTypes['runCampaignProbeNow'][0] ]) : PromiseInterface
Run campaign probe now
Parameters
- $probe_id : string
-
(required)
- $create_campaign_probe_run_options : CreateCampaignProbeRunOptions
-
(required)
- $contentType : string = self::contentTypes['runCampaignProbeNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runCampaignProbeNow'] to see the possible values for this operation
Tags
Return values
PromiseInterface —runCampaignProbeNowAsyncWithHttpInfo()
Operation runCampaignProbeNowAsyncWithHttpInfo
public
runCampaignProbeNowAsyncWithHttpInfo(string $probe_id, CreateCampaignProbeRunOptions $create_campaign_probe_run_options[, string $contentType = self::contentTypes['runCampaignProbeNow'][0] ]) : PromiseInterface
Run campaign probe now
Parameters
- $probe_id : string
-
(required)
- $create_campaign_probe_run_options : CreateCampaignProbeRunOptions
-
(required)
- $contentType : string = self::contentTypes['runCampaignProbeNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runCampaignProbeNow'] to see the possible values for this operation
Tags
Return values
PromiseInterface —runCampaignProbeNowRequest()
Create request for operation 'runCampaignProbeNow'
public
runCampaignProbeNowRequest(string $probe_id, CreateCampaignProbeRunOptions $create_campaign_probe_run_options[, string $contentType = self::contentTypes['runCampaignProbeNow'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $create_campaign_probe_run_options : CreateCampaignProbeRunOptions
-
(required)
- $contentType : string = self::contentTypes['runCampaignProbeNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runCampaignProbeNow'] to see the possible values for this operation
Tags
Return values
Request —runCampaignProbeNowWithHttpInfo()
Operation runCampaignProbeNowWithHttpInfo
public
runCampaignProbeNowWithHttpInfo(string $probe_id, CreateCampaignProbeRunOptions $create_campaign_probe_run_options[, string $contentType = self::contentTypes['runCampaignProbeNow'][0] ]) : array<string|int, mixed>
Run campaign probe now
Parameters
- $probe_id : string
-
(required)
- $create_campaign_probe_run_options : CreateCampaignProbeRunOptions
-
(required)
- $contentType : string = self::contentTypes['runCampaignProbeNow'][0]
-
The value for the Content-Type header. Check self::contentTypes['runCampaignProbeNow'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeRunNowResult, HTTP status code, HTTP response headers (array of strings)
runDueCampaignProbes()
Operation runDueCampaignProbes
public
runDueCampaignProbes([int $max_runs = null ][, string $contentType = self::contentTypes['runDueCampaignProbes'][0] ]) : CampaignProbeRunDueResult
Run due campaign probes for user
Parameters
- $max_runs : int = null
-
max_runs (optional)
- $contentType : string = self::contentTypes['runDueCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueCampaignProbes'] to see the possible values for this operation
Tags
Return values
CampaignProbeRunDueResult —runDueCampaignProbesAsync()
Operation runDueCampaignProbesAsync
public
runDueCampaignProbesAsync([int $max_runs = null ][, string $contentType = self::contentTypes['runDueCampaignProbes'][0] ]) : PromiseInterface
Run due campaign probes for user
Parameters
- $max_runs : int = null
-
(optional)
- $contentType : string = self::contentTypes['runDueCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueCampaignProbes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —runDueCampaignProbesAsyncWithHttpInfo()
Operation runDueCampaignProbesAsyncWithHttpInfo
public
runDueCampaignProbesAsyncWithHttpInfo([int $max_runs = null ][, string $contentType = self::contentTypes['runDueCampaignProbes'][0] ]) : PromiseInterface
Run due campaign probes for user
Parameters
- $max_runs : int = null
-
(optional)
- $contentType : string = self::contentTypes['runDueCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueCampaignProbes'] to see the possible values for this operation
Tags
Return values
PromiseInterface —runDueCampaignProbesRequest()
Create request for operation 'runDueCampaignProbes'
public
runDueCampaignProbesRequest([int $max_runs = null ][, string $contentType = self::contentTypes['runDueCampaignProbes'][0] ]) : Request
Parameters
- $max_runs : int = null
-
(optional)
- $contentType : string = self::contentTypes['runDueCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueCampaignProbes'] to see the possible values for this operation
Tags
Return values
Request —runDueCampaignProbesWithHttpInfo()
Operation runDueCampaignProbesWithHttpInfo
public
runDueCampaignProbesWithHttpInfo([int $max_runs = null ][, string $contentType = self::contentTypes['runDueCampaignProbes'][0] ]) : array<string|int, mixed>
Run due campaign probes for user
Parameters
- $max_runs : int = null
-
(optional)
- $contentType : string = self::contentTypes['runDueCampaignProbes'][0]
-
The value for the Content-Type header. Check self::contentTypes['runDueCampaignProbes'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeRunDueResult, 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 —updateCampaignProbe()
Operation updateCampaignProbe
public
updateCampaignProbe(string $probe_id, UpdateCampaignProbeOptions $update_campaign_probe_options[, string $contentType = self::contentTypes['updateCampaignProbe'][0] ]) : CampaignProbeDto
Update campaign probe
Parameters
- $probe_id : string
-
probe_id (required)
- $update_campaign_probe_options : UpdateCampaignProbeOptions
-
update_campaign_probe_options (required)
- $contentType : string = self::contentTypes['updateCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateCampaignProbe'] to see the possible values for this operation
Tags
Return values
CampaignProbeDto —updateCampaignProbeAsync()
Operation updateCampaignProbeAsync
public
updateCampaignProbeAsync(string $probe_id, UpdateCampaignProbeOptions $update_campaign_probe_options[, string $contentType = self::contentTypes['updateCampaignProbe'][0] ]) : PromiseInterface
Update campaign probe
Parameters
- $probe_id : string
-
(required)
- $update_campaign_probe_options : UpdateCampaignProbeOptions
-
(required)
- $contentType : string = self::contentTypes['updateCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateCampaignProbe'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateCampaignProbeAsyncWithHttpInfo()
Operation updateCampaignProbeAsyncWithHttpInfo
public
updateCampaignProbeAsyncWithHttpInfo(string $probe_id, UpdateCampaignProbeOptions $update_campaign_probe_options[, string $contentType = self::contentTypes['updateCampaignProbe'][0] ]) : PromiseInterface
Update campaign probe
Parameters
- $probe_id : string
-
(required)
- $update_campaign_probe_options : UpdateCampaignProbeOptions
-
(required)
- $contentType : string = self::contentTypes['updateCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateCampaignProbe'] to see the possible values for this operation
Tags
Return values
PromiseInterface —updateCampaignProbeRequest()
Create request for operation 'updateCampaignProbe'
public
updateCampaignProbeRequest(string $probe_id, UpdateCampaignProbeOptions $update_campaign_probe_options[, string $contentType = self::contentTypes['updateCampaignProbe'][0] ]) : Request
Parameters
- $probe_id : string
-
(required)
- $update_campaign_probe_options : UpdateCampaignProbeOptions
-
(required)
- $contentType : string = self::contentTypes['updateCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateCampaignProbe'] to see the possible values for this operation
Tags
Return values
Request —updateCampaignProbeWithHttpInfo()
Operation updateCampaignProbeWithHttpInfo
public
updateCampaignProbeWithHttpInfo(string $probe_id, UpdateCampaignProbeOptions $update_campaign_probe_options[, string $contentType = self::contentTypes['updateCampaignProbe'][0] ]) : array<string|int, mixed>
Update campaign probe
Parameters
- $probe_id : string
-
(required)
- $update_campaign_probe_options : UpdateCampaignProbeOptions
-
(required)
- $contentType : string = self::contentTypes['updateCampaignProbe'][0]
-
The value for the Content-Type header. Check self::contentTypes['updateCampaignProbe'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CampaignProbeDto, 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