Interface ICampaignProbeControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface ICampaignProbeControllerApiSync : IApiAccessor

Methods

View Source

CreateCampaignProbe(CreateCampaignProbeOptions, int)

Create campaign probe

Declaration

CampaignProbeDto CreateCampaignProbe(CreateCampaignProbeOptions createCampaignProbeOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateCampaignProbeOptions	createCampaignProbeOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CampaignProbeDto	CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateCampaignProbeWithHttpInfo(CreateCampaignProbeOptions, int)

Create campaign probe

Declaration

ApiResponse<CampaignProbeDto> CreateCampaignProbeWithHttpInfo(CreateCampaignProbeOptions createCampaignProbeOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateCampaignProbeOptions	createCampaignProbeOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CampaignProbeDto>	ApiResponse of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteCampaignProbe(Guid, int)

Delete campaign probe

Declaration

void DeleteCampaignProbe(Guid probeId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteCampaignProbeWithHttpInfo(Guid, int)

Delete campaign probe

Declaration

ApiResponse<object> DeleteCampaignProbeWithHttpInfo(Guid probeId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbe(Guid, int)

Get campaign probe

Declaration

CampaignProbeDto GetCampaignProbe(Guid probeId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CampaignProbeDto	CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeInsights(Guid, DateTime?, DateTime?, int)

Get campaign probe insights

Declaration

CampaignProbeInsightsDto GetCampaignProbeInsights(Guid probeId, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CampaignProbeInsightsDto	CampaignProbeInsightsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeInsightsWithHttpInfo(Guid, DateTime?, DateTime?, int)

Get campaign probe insights

Declaration

ApiResponse<CampaignProbeInsightsDto> GetCampaignProbeInsightsWithHttpInfo(Guid probeId, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CampaignProbeInsightsDto>	ApiResponse of CampaignProbeInsightsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeRuns(Guid, DateTime?, DateTime?, string, int?, int)

List campaign probe runs

Declaration

List<CampaignProbeRunDto> GetCampaignProbeRuns(Guid probeId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
DateTime?	since	(optional)
DateTime?	before	(optional)
string	status	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<CampaignProbeRunDto>	List<CampaignProbeRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeRunsWithHttpInfo(Guid, DateTime?, DateTime?, string, int?, int)

List campaign probe runs

Declaration

ApiResponse<List<CampaignProbeRunDto>> GetCampaignProbeRunsWithHttpInfo(Guid probeId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
DateTime?	since	(optional)
DateTime?	before	(optional)
string	status	(optional)
int?	limit	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<CampaignProbeRunDto>>	ApiResponse of List<CampaignProbeRunDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeSeries(Guid, DateTime?, DateTime?, string, int)

Get campaign probe trend series

Declaration

CampaignProbeSeriesDto GetCampaignProbeSeries(Guid probeId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
DateTime?	since	(optional)
DateTime?	before	(optional)
string	bucket	(optional, default to DAY)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CampaignProbeSeriesDto	CampaignProbeSeriesDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeSeriesWithHttpInfo(Guid, DateTime?, DateTime?, string, int)

Get campaign probe trend series

Declaration

ApiResponse<CampaignProbeSeriesDto> GetCampaignProbeSeriesWithHttpInfo(Guid probeId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
DateTime?	since	(optional)
DateTime?	before	(optional)
string	bucket	(optional, default to DAY)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CampaignProbeSeriesDto>	ApiResponse of CampaignProbeSeriesDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeWithHttpInfo(Guid, int)

Get campaign probe

Declaration

ApiResponse<CampaignProbeDto> GetCampaignProbeWithHttpInfo(Guid probeId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CampaignProbeDto>	ApiResponse of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbes(int)

List campaign probes

Declaration

List<CampaignProbeDto> GetCampaignProbes(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<CampaignProbeDto>	List<CampaignProbeDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbesWithHttpInfo(int)

List campaign probes

Declaration

ApiResponse<List<CampaignProbeDto>> GetCampaignProbesWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<CampaignProbeDto>>	ApiResponse of List<CampaignProbeDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunCampaignProbeNow(Guid, CreateCampaignProbeRunOptions, int)

Run campaign probe now

Declaration

CampaignProbeRunNowResult RunCampaignProbeNow(Guid probeId, CreateCampaignProbeRunOptions createCampaignProbeRunOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
CreateCampaignProbeRunOptions	createCampaignProbeRunOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CampaignProbeRunNowResult	CampaignProbeRunNowResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunCampaignProbeNowWithHttpInfo(Guid, CreateCampaignProbeRunOptions, int)

Run campaign probe now

Declaration

ApiResponse<CampaignProbeRunNowResult> RunCampaignProbeNowWithHttpInfo(Guid probeId, CreateCampaignProbeRunOptions createCampaignProbeRunOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
CreateCampaignProbeRunOptions	createCampaignProbeRunOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CampaignProbeRunNowResult>	ApiResponse of CampaignProbeRunNowResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDueCampaignProbes(int?, int)

Run due campaign probes for user

Declaration

CampaignProbeRunDueResult RunDueCampaignProbes(int? maxRuns = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	maxRuns	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CampaignProbeRunDueResult	CampaignProbeRunDueResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDueCampaignProbesWithHttpInfo(int?, int)

Run due campaign probes for user

Declaration

ApiResponse<CampaignProbeRunDueResult> RunDueCampaignProbesWithHttpInfo(int? maxRuns = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	maxRuns	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CampaignProbeRunDueResult>	ApiResponse of CampaignProbeRunDueResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateCampaignProbe(Guid, UpdateCampaignProbeOptions, int)

Update campaign probe

Declaration

CampaignProbeDto UpdateCampaignProbe(Guid probeId, UpdateCampaignProbeOptions updateCampaignProbeOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
UpdateCampaignProbeOptions	updateCampaignProbeOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
CampaignProbeDto	CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateCampaignProbeWithHttpInfo(Guid, UpdateCampaignProbeOptions, int)

Update campaign probe

Declaration

ApiResponse<CampaignProbeDto> UpdateCampaignProbeWithHttpInfo(Guid probeId, UpdateCampaignProbeOptions updateCampaignProbeOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	probeId
UpdateCampaignProbeOptions	updateCampaignProbeOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<CampaignProbeDto>	ApiResponse of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call