Class CampaignProbeControllerApi

Hierarchy

BaseAPI
- CampaignProbeControllerApi

Constructors

constructor

new CampaignProbeControllerApi(configuration?: Configuration): CampaignProbeControllerApi
Parameters
- configuration: Configuration = ...
Returns CampaignProbeControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createCampaignProbe

createCampaignProbe(requestParameters: CreateCampaignProbeRequest, initOverrides?: RequestInit): Promise<CampaignProbeDto>
Create campaign probe
Parameters
- requestParameters: CreateCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeDto>

createCampaignProbeRaw

createCampaignProbeRaw(requestParameters: CreateCampaignProbeRequest, initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeDto>>
Create campaign probe
Parameters
- requestParameters: CreateCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeDto>>

deleteCampaignProbe

deleteCampaignProbe(requestParameters: DeleteCampaignProbeRequest, initOverrides?: RequestInit): Promise<void>
Delete campaign probe
Parameters
- requestParameters: DeleteCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteCampaignProbeRaw

deleteCampaignProbeRaw(requestParameters: DeleteCampaignProbeRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete campaign probe
Parameters
- requestParameters: DeleteCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getCampaignProbe

getCampaignProbe(requestParameters: GetCampaignProbeRequest, initOverrides?: RequestInit): Promise<CampaignProbeDto>
Get campaign probe
Parameters
- requestParameters: GetCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeDto>

getCampaignProbeInsights

getCampaignProbeInsights(requestParameters: GetCampaignProbeInsightsRequest, initOverrides?: RequestInit): Promise<CampaignProbeInsightsDto>
Get campaign probe insights
Parameters
- requestParameters: GetCampaignProbeInsightsRequest
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeInsightsDto>

getCampaignProbeInsightsRaw

getCampaignProbeInsightsRaw(requestParameters: GetCampaignProbeInsightsRequest, initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeInsightsDto>>
Get campaign probe insights
Parameters
- requestParameters: GetCampaignProbeInsightsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeInsightsDto>>

getCampaignProbeRaw

getCampaignProbeRaw(requestParameters: GetCampaignProbeRequest, initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeDto>>
Get campaign probe
Parameters
- requestParameters: GetCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeDto>>

getCampaignProbeRuns

getCampaignProbeRuns(requestParameters: GetCampaignProbeRunsRequest, initOverrides?: RequestInit): Promise<CampaignProbeRunDto[]>
List campaign probe runs
Parameters
- requestParameters: GetCampaignProbeRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeRunDto[]>

getCampaignProbeRunsRaw

getCampaignProbeRunsRaw(requestParameters: GetCampaignProbeRunsRequest, initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeRunDto[]>>
List campaign probe runs
Parameters
- requestParameters: GetCampaignProbeRunsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeRunDto[]>>

getCampaignProbeSeries

getCampaignProbeSeries(requestParameters: GetCampaignProbeSeriesRequest, initOverrides?: RequestInit): Promise<CampaignProbeSeriesDto>
Get campaign probe trend series
Parameters
- requestParameters: GetCampaignProbeSeriesRequest
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeSeriesDto>

getCampaignProbeSeriesRaw

getCampaignProbeSeriesRaw(requestParameters: GetCampaignProbeSeriesRequest, initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeSeriesDto>>
Get campaign probe trend series
Parameters
- requestParameters: GetCampaignProbeSeriesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeSeriesDto>>

getCampaignProbes

getCampaignProbes(initOverrides?: RequestInit): Promise<CampaignProbeDto[]>
List campaign probes
Parameters
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeDto[]>

getCampaignProbesRaw

getCampaignProbesRaw(initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeDto[]>>
List campaign probes
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeDto[]>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

runCampaignProbeNow

runCampaignProbeNow(requestParameters: RunCampaignProbeNowRequest, initOverrides?: RequestInit): Promise<CampaignProbeRunNowResult>
Run campaign probe now
Parameters
- requestParameters: RunCampaignProbeNowRequest
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeRunNowResult>

runCampaignProbeNowRaw

runCampaignProbeNowRaw(requestParameters: RunCampaignProbeNowRequest, initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeRunNowResult>>
Run campaign probe now
Parameters
- requestParameters: RunCampaignProbeNowRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeRunNowResult>>

runDueCampaignProbes

runDueCampaignProbes(requestParameters: RunDueCampaignProbesRequest, initOverrides?: RequestInit): Promise<CampaignProbeRunDueResult>
Run due campaign probes for user
Parameters
- requestParameters: RunDueCampaignProbesRequest
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeRunDueResult>

runDueCampaignProbesRaw

runDueCampaignProbesRaw(requestParameters: RunDueCampaignProbesRequest, initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeRunDueResult>>
Run due campaign probes for user
Parameters
- requestParameters: RunDueCampaignProbesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeRunDueResult>>

updateCampaignProbe

updateCampaignProbe(requestParameters: UpdateCampaignProbeRequest, initOverrides?: RequestInit): Promise<CampaignProbeDto>
Update campaign probe
Parameters
- requestParameters: UpdateCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<CampaignProbeDto>

updateCampaignProbeRaw

updateCampaignProbeRaw(requestParameters: UpdateCampaignProbeRequest, initOverrides?: RequestInit): Promise<ApiResponse<CampaignProbeDto>>
Update campaign probe
Parameters
- requestParameters: UpdateCampaignProbeRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CampaignProbeDto>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware