public class CampaignProbeControllerApi : ICampaignProbeControllerApi, ICampaignProbeControllerApiSync, ICampaignProbeControllerApiAsync, IApiAccessor

Constructors

View Source

CampaignProbeControllerApi()

Initializes a new instance of the CampaignProbeControllerApi class.

Declaration

public CampaignProbeControllerApi()

View Source

CampaignProbeControllerApi(string)

Initializes a new instance of the CampaignProbeControllerApi class.

Declaration

public CampaignProbeControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

CampaignProbeControllerApi(Configuration)

Initializes a new instance of the CampaignProbeControllerApi class using Configuration object

Declaration

public CampaignProbeControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

CampaignProbeControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the CampaignProbeControllerApi class using a Configuration object and client instance.

Declaration

public CampaignProbeControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

CreateCampaignProbe(CreateCampaignProbeOptions, int)

Create campaign probe

Declaration

public 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

CreateCampaignProbeAsync(CreateCampaignProbeOptions, int, CancellationToken)

Create campaign probe

Declaration

public Task<CampaignProbeDto> CreateCampaignProbeAsync(CreateCampaignProbeOptions createCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateCampaignProbeOptions	createCampaignProbeOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CampaignProbeDto>	Task of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateCampaignProbeWithHttpInfo(CreateCampaignProbeOptions, int)

Create campaign probe

Declaration

public 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

CreateCampaignProbeWithHttpInfoAsync(CreateCampaignProbeOptions, int, CancellationToken)

Create campaign probe

Declaration

public Task<ApiResponse<CampaignProbeDto>> CreateCampaignProbeWithHttpInfoAsync(CreateCampaignProbeOptions createCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateCampaignProbeOptions	createCampaignProbeOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CampaignProbeDto>>	Task of ApiResponse (CampaignProbeDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteCampaignProbe(Guid, int)

Delete campaign probe

Declaration

public 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

DeleteCampaignProbeAsync(Guid, int, CancellationToken)

Delete campaign probe

Declaration

public Task DeleteCampaignProbeAsync(Guid probeId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteCampaignProbeWithHttpInfo(Guid, int)

Delete campaign probe

Declaration

public 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

DeleteCampaignProbeWithHttpInfoAsync(Guid, int, CancellationToken)

Delete campaign probe

Declaration

public Task<ApiResponse<object>> DeleteCampaignProbeWithHttpInfoAsync(Guid probeId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetCampaignProbe(Guid, int)

Get campaign probe

Declaration

public 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

GetCampaignProbeAsync(Guid, int, CancellationToken)

Get campaign probe

Declaration

public Task<CampaignProbeDto> GetCampaignProbeAsync(Guid probeId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CampaignProbeDto>	Task of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get campaign probe insights

Declaration

public 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

GetCampaignProbeInsightsAsync(Guid, DateTime?, DateTime?, int, CancellationToken)

Get campaign probe insights

Declaration

public Task<CampaignProbeInsightsDto> GetCampaignProbeInsightsAsync(Guid probeId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CampaignProbeInsightsDto>	Task of CampaignProbeInsightsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get campaign probe insights

Declaration

public 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

GetCampaignProbeInsightsWithHttpInfoAsync(Guid, DateTime?, DateTime?, int, CancellationToken)

Get campaign probe insights

Declaration

public Task<ApiResponse<CampaignProbeInsightsDto>> GetCampaignProbeInsightsWithHttpInfoAsync(Guid probeId, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
DateTime?	since	(optional)
DateTime?	before	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CampaignProbeInsightsDto>>	Task of ApiResponse (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

public 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

GetCampaignProbeRunsAsync(Guid, DateTime?, DateTime?, string, int?, int, CancellationToken)

List campaign probe runs

Declaration

public Task<List<CampaignProbeRunDto>> GetCampaignProbeRunsAsync(Guid probeId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<CampaignProbeRunDto>>	Task of 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

public 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

GetCampaignProbeRunsWithHttpInfoAsync(Guid, DateTime?, DateTime?, string, int?, int, CancellationToken)

List campaign probe runs

Declaration

public Task<ApiResponse<List<CampaignProbeRunDto>>> GetCampaignProbeRunsWithHttpInfoAsync(Guid probeId, DateTime? since = null, DateTime? before = null, string status = null, int? limit = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<CampaignProbeRunDto>>>	Task of ApiResponse (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

public 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

GetCampaignProbeSeriesAsync(Guid, DateTime?, DateTime?, string, int, CancellationToken)

Get campaign probe trend series

Declaration

public Task<CampaignProbeSeriesDto> GetCampaignProbeSeriesAsync(Guid probeId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CampaignProbeSeriesDto>	Task of 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

public 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

GetCampaignProbeSeriesWithHttpInfoAsync(Guid, DateTime?, DateTime?, string, int, CancellationToken)

Get campaign probe trend series

Declaration

public Task<ApiResponse<CampaignProbeSeriesDto>> GetCampaignProbeSeriesWithHttpInfoAsync(Guid probeId, DateTime? since = null, DateTime? before = null, string bucket = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CampaignProbeSeriesDto>>	Task of ApiResponse (CampaignProbeSeriesDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbeWithHttpInfo(Guid, int)

Get campaign probe

Declaration

public 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

GetCampaignProbeWithHttpInfoAsync(Guid, int, CancellationToken)

Get campaign probe

Declaration

public Task<ApiResponse<CampaignProbeDto>> GetCampaignProbeWithHttpInfoAsync(Guid probeId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CampaignProbeDto>>	Task of ApiResponse (CampaignProbeDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbes(int)

List campaign probes

Declaration

public 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

GetCampaignProbesAsync(int, CancellationToken)

List campaign probes

Declaration

public Task<List<CampaignProbeDto>> GetCampaignProbesAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<CampaignProbeDto>>	Task of List<CampaignProbeDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetCampaignProbesWithHttpInfo(int)

List campaign probes

Declaration

public 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

GetCampaignProbesWithHttpInfoAsync(int, CancellationToken)

List campaign probes

Declaration

public Task<ApiResponse<List<CampaignProbeDto>>> GetCampaignProbesWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<CampaignProbeDto>>>	Task of ApiResponse (List<CampaignProbeDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunCampaignProbeNow(Guid, CreateCampaignProbeRunOptions, int)

Run campaign probe now

Declaration

public 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

RunCampaignProbeNowAsync(Guid, CreateCampaignProbeRunOptions, int, CancellationToken)

Run campaign probe now

Declaration

public Task<CampaignProbeRunNowResult> RunCampaignProbeNowAsync(Guid probeId, CreateCampaignProbeRunOptions createCampaignProbeRunOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
CreateCampaignProbeRunOptions	createCampaignProbeRunOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CampaignProbeRunNowResult>	Task of CampaignProbeRunNowResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunCampaignProbeNowWithHttpInfo(Guid, CreateCampaignProbeRunOptions, int)

Run campaign probe now

Declaration

public 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

RunCampaignProbeNowWithHttpInfoAsync(Guid, CreateCampaignProbeRunOptions, int, CancellationToken)

Run campaign probe now

Declaration

public Task<ApiResponse<CampaignProbeRunNowResult>> RunCampaignProbeNowWithHttpInfoAsync(Guid probeId, CreateCampaignProbeRunOptions createCampaignProbeRunOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
CreateCampaignProbeRunOptions	createCampaignProbeRunOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CampaignProbeRunNowResult>>	Task of ApiResponse (CampaignProbeRunNowResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDueCampaignProbes(int?, int)

Run due campaign probes for user

Declaration

public 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

RunDueCampaignProbesAsync(int?, int, CancellationToken)

Run due campaign probes for user

Declaration

public Task<CampaignProbeRunDueResult> RunDueCampaignProbesAsync(int? maxRuns = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	maxRuns	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CampaignProbeRunDueResult>	Task of CampaignProbeRunDueResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RunDueCampaignProbesWithHttpInfo(int?, int)

Run due campaign probes for user

Declaration

public 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

RunDueCampaignProbesWithHttpInfoAsync(int?, int, CancellationToken)

Run due campaign probes for user

Declaration

public Task<ApiResponse<CampaignProbeRunDueResult>> RunDueCampaignProbesWithHttpInfoAsync(int? maxRuns = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	maxRuns	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CampaignProbeRunDueResult>>	Task of ApiResponse (CampaignProbeRunDueResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateCampaignProbe(Guid, UpdateCampaignProbeOptions, int)

Update campaign probe

Declaration

public 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

UpdateCampaignProbeAsync(Guid, UpdateCampaignProbeOptions, int, CancellationToken)

Update campaign probe

Declaration

public Task<CampaignProbeDto> UpdateCampaignProbeAsync(Guid probeId, UpdateCampaignProbeOptions updateCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
UpdateCampaignProbeOptions	updateCampaignProbeOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CampaignProbeDto>	Task of CampaignProbeDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateCampaignProbeWithHttpInfo(Guid, UpdateCampaignProbeOptions, int)

Update campaign probe

Declaration

public 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

View Source

UpdateCampaignProbeWithHttpInfoAsync(Guid, UpdateCampaignProbeOptions, int, CancellationToken)

Update campaign probe

Declaration

public Task<ApiResponse<CampaignProbeDto>> UpdateCampaignProbeWithHttpInfoAsync(Guid probeId, UpdateCampaignProbeOptions updateCampaignProbeOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	probeId
UpdateCampaignProbeOptions	updateCampaignProbeOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CampaignProbeDto>>	Task of ApiResponse (CampaignProbeDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

ICampaignProbeControllerApi

ICampaignProbeControllerApiSync

ICampaignProbeControllerApiAsync

IApiAccessor