@datadog/datadog-api-client

import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi"; import { Configuration } from "../../datadog-api-client-common/configuration"; import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http"; import { DeletedSuitesRequestDeleteRequest } from "../models/DeletedSuitesRequestDeleteRequest"; import { DeletedSuitesResponse } from "../models/DeletedSuitesResponse"; import { DeletedTestsRequestDeleteRequest } from "../models/DeletedTestsRequestDeleteRequest"; import { DeletedTestsResponse } from "../models/DeletedTestsResponse"; import { GlobalVariableJsonPatchRequest } from "../models/GlobalVariableJsonPatchRequest"; import { GlobalVariableResponse } from "../models/GlobalVariableResponse"; import { OnDemandConcurrencyCapAttributes } from "../models/OnDemandConcurrencyCapAttributes"; import { OnDemandConcurrencyCapResponse } from "../models/OnDemandConcurrencyCapResponse"; import { SuiteCreateEditRequest } from "../models/SuiteCreateEditRequest"; import { SuiteJsonPatchRequest } from "../models/SuiteJsonPatchRequest"; import { SyntheticsApiMultistepParentTestsResponse } from "../models/SyntheticsApiMultistepParentTestsResponse"; import { SyntheticsApiMultistepSubtestsResponse } from "../models/SyntheticsApiMultistepSubtestsResponse"; import { SyntheticsDowntimeRequest } from "../models/SyntheticsDowntimeRequest"; import { SyntheticsDowntimeResponse } from "../models/SyntheticsDowntimeResponse"; import { SyntheticsDowntimesResponse } from "../models/SyntheticsDowntimesResponse"; import { SyntheticsFastTestResult } from "../models/SyntheticsFastTestResult"; import { SyntheticsNetworkTestEditRequest } from "../models/SyntheticsNetworkTestEditRequest"; import { SyntheticsNetworkTestResponse } from "../models/SyntheticsNetworkTestResponse"; import { SyntheticsPollTestResultsResponse } from "../models/SyntheticsPollTestResultsResponse"; import { SyntheticsSuiteResponse } from "../models/SyntheticsSuiteResponse"; import { SyntheticsSuiteSearchResponse } from "../models/SyntheticsSuiteSearchResponse"; import { SyntheticsTestFileAbortMultipartUploadRequest } from "../models/SyntheticsTestFileAbortMultipartUploadRequest"; import { SyntheticsTestFileCompleteMultipartUploadRequest } from "../models/SyntheticsTestFileCompleteMultipartUploadRequest"; import { SyntheticsTestFileDownloadRequest } from "../models/SyntheticsTestFileDownloadRequest"; import { SyntheticsTestFileDownloadResponse } from "../models/SyntheticsTestFileDownloadResponse"; import { SyntheticsTestFileMultipartPresignedUrlsRequest } from "../models/SyntheticsTestFileMultipartPresignedUrlsRequest"; import { SyntheticsTestFileMultipartPresignedUrlsResponse } from "../models/SyntheticsTestFileMultipartPresignedUrlsResponse"; import { SyntheticsTestLatestResultsResponse } from "../models/SyntheticsTestLatestResultsResponse"; import { SyntheticsTestParentSuitesResponse } from "../models/SyntheticsTestParentSuitesResponse"; import { SyntheticsTestResultResponse } from "../models/SyntheticsTestResultResponse"; import { SyntheticsTestResultRunType } from "../models/SyntheticsTestResultRunType"; import { SyntheticsTestResultStatus } from "../models/SyntheticsTestResultStatus"; import { SyntheticsTestVersionHistoryResponse } from "../models/SyntheticsTestVersionHistoryResponse"; import { SyntheticsTestVersionResponse } from "../models/SyntheticsTestVersionResponse"; export declare class SyntheticsApiRequestFactory extends BaseAPIRequestFactory { abortTestFileMultipartUpload(publicId: string, body: SyntheticsTestFileAbortMultipartUploadRequest, _options?: Configuration): Promise<RequestContext>; addTestToSyntheticsDowntime(downtimeId: string, testId: string, _options?: Configuration): Promise<RequestContext>; completeTestFileMultipartUpload(publicId: string, body: SyntheticsTestFileCompleteMultipartUploadRequest, _options?: Configuration): Promise<RequestContext>; createSyntheticsDowntime(body: SyntheticsDowntimeRequest, _options?: Configuration): Promise<RequestContext>; createSyntheticsNetworkTest(body: SyntheticsNetworkTestEditRequest, _options?: Configuration): Promise<RequestContext>; createSyntheticsSuite(body: SuiteCreateEditRequest, _options?: Configuration): Promise<RequestContext>; deleteSyntheticsDowntime(downtimeId: string, _options?: Configuration): Promise<RequestContext>; deleteSyntheticsSuites(body: DeletedSuitesRequestDeleteRequest, _options?: Configuration): Promise<RequestContext>; deleteSyntheticsTests(body: DeletedTestsRequestDeleteRequest, _options?: Configuration): Promise<RequestContext>; editSyntheticsSuite(publicId: string, body: SuiteCreateEditRequest, _options?: Configuration): Promise<RequestContext>; getApiMultistepSubtestParents(publicId: string, _options?: Configuration): Promise<RequestContext>; getApiMultistepSubtests(publicId: string, _options?: Configuration): Promise<RequestContext>; getOnDemandConcurrencyCap(_options?: Configuration): Promise<RequestContext>; getSyntheticsBrowserTestResult(publicId: string, resultId: string, eventId?: string, timestamp?: number, _options?: Configuration): Promise<RequestContext>; getSyntheticsDowntime(downtimeId: string, _options?: Configuration): Promise<RequestContext>; getSyntheticsFastTestResult(id: string, _options?: Configuration): Promise<RequestContext>; getSyntheticsNetworkTest(publicId: string, _options?: Configuration): Promise<RequestContext>; getSyntheticsSuite(publicId: string, _options?: Configuration): Promise<RequestContext>; getSyntheticsTestResult(publicId: string, resultId: string, eventId?: string, timestamp?: number, _options?: Configuration): Promise<RequestContext>; getSyntheticsTestVersion(publicId: string, versionNumber: number, includeChangeMetadata?: boolean, onlyCheckExistence?: boolean, _options?: Configuration): Promise<RequestContext>; getTestFileDownloadUrl(publicId: string, body: SyntheticsTestFileDownloadRequest, _options?: Configuration): Promise<RequestContext>; getTestFileMultipartPresignedUrls(publicId: string, body: SyntheticsTestFileMultipartPresignedUrlsRequest, _options?: Configuration): Promise<RequestContext>; getTestParentSuites(publicId: string, _options?: Configuration): Promise<RequestContext>; listSyntheticsBrowserTestLatestResults(publicId: string, fromTs?: number, toTs?: number, status?: SyntheticsTestResultStatus, runType?: SyntheticsTestResultRunType, probeDc?: Array<string>, deviceId?: Array<string>, _options?: Configuration): Promise<RequestContext>; listSyntheticsDowntimes(filterTestIds?: string, filterActive?: string, _options?: Configuration): Promise<RequestContext>; listSyntheticsTestLatestResults(publicId: string, fromTs?: number, toTs?: number, status?: SyntheticsTestResultStatus, runType?: SyntheticsTestResultRunType, probeDc?: Array<string>, deviceId?: Array<string>, _options?: Configuration): Promise<RequestContext>; listSyntheticsTestVersions(publicId: string, lastVersionNumber?: number, limit?: number, _options?: Configuration): Promise<RequestContext>; patchGlobalVariable(variableId: string, body: GlobalVariableJsonPatchRequest, _options?: Configuration): Promise<RequestContext>; patchTestSuite(publicId: string, body: SuiteJsonPatchRequest, _options?: Configuration): Promise<RequestContext>; pollSyntheticsTestResults(resultIds: string, _options?: Configuration): Promise<RequestContext>; removeTestFromSyntheticsDowntime(downtimeId: string, testId: string, _options?: Configuration): Promise<RequestContext>; searchSuites(query?: string, sort?: string, facetsOnly?: boolean, start?: number, count?: number, _options?: Configuration): Promise<RequestContext>; setOnDemandConcurrencyCap(body: OnDemandConcurrencyCapAttributes, _options?: Configuration): Promise<RequestContext>; updateSyntheticsDowntime(downtimeId: string, body: SyntheticsDowntimeRequest, _options?: Configuration): Promise<RequestContext>; updateSyntheticsNetworkTest(publicId: string, body: SyntheticsNetworkTestEditRequest, _options?: Configuration): Promise<RequestContext>; } export declare class SyntheticsApiResponseProcessor { /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to abortTestFileMultipartUpload * @throws ApiException if the response code was not in [200, 299] */ abortTestFileMultipartUpload(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to addTestToSyntheticsDowntime * @throws ApiException if the response code was not in [200, 299] */ addTestToSyntheticsDowntime(response: ResponseContext): Promise<SyntheticsDowntimeResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to completeTestFileMultipartUpload * @throws ApiException if the response code was not in [200, 299] */ completeTestFileMultipartUpload(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createSyntheticsDowntime * @throws ApiException if the response code was not in [200, 299] */ createSyntheticsDowntime(response: ResponseContext): Promise<SyntheticsDowntimeResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createSyntheticsNetworkTest * @throws ApiException if the response code was not in [200, 299] */ createSyntheticsNetworkTest(response: ResponseContext): Promise<SyntheticsNetworkTestResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to createSyntheticsSuite * @throws ApiException if the response code was not in [200, 299] */ createSyntheticsSuite(response: ResponseContext): Promise<SyntheticsSuiteResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteSyntheticsDowntime * @throws ApiException if the response code was not in [200, 299] */ deleteSyntheticsDowntime(response: ResponseContext): Promise<void>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteSyntheticsSuites * @throws ApiException if the response code was not in [200, 299] */ deleteSyntheticsSuites(response: ResponseContext): Promise<DeletedSuitesResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to deleteSyntheticsTests * @throws ApiException if the response code was not in [200, 299] */ deleteSyntheticsTests(response: ResponseContext): Promise<DeletedTestsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to editSyntheticsSuite * @throws ApiException if the response code was not in [200, 299] */ editSyntheticsSuite(response: ResponseContext): Promise<SyntheticsSuiteResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getApiMultistepSubtestParents * @throws ApiException if the response code was not in [200, 299] */ getApiMultistepSubtestParents(response: ResponseContext): Promise<SyntheticsApiMultistepParentTestsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getApiMultistepSubtests * @throws ApiException if the response code was not in [200, 299] */ getApiMultistepSubtests(response: ResponseContext): Promise<SyntheticsApiMultistepSubtestsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getOnDemandConcurrencyCap * @throws ApiException if the response code was not in [200, 299] */ getOnDemandConcurrencyCap(response: ResponseContext): Promise<OnDemandConcurrencyCapResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSyntheticsBrowserTestResult * @throws ApiException if the response code was not in [200, 299] */ getSyntheticsBrowserTestResult(response: ResponseContext): Promise<SyntheticsTestResultResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSyntheticsDowntime * @throws ApiException if the response code was not in [200, 299] */ getSyntheticsDowntime(response: ResponseContext): Promise<SyntheticsDowntimeResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSyntheticsFastTestResult * @throws ApiException if the response code was not in [200, 299] */ getSyntheticsFastTestResult(response: ResponseContext): Promise<SyntheticsFastTestResult>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSyntheticsNetworkTest * @throws ApiException if the response code was not in [200, 299] */ getSyntheticsNetworkTest(response: ResponseContext): Promise<SyntheticsNetworkTestResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSyntheticsSuite * @throws ApiException if the response code was not in [200, 299] */ getSyntheticsSuite(response: ResponseContext): Promise<SyntheticsSuiteResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSyntheticsTestResult * @throws ApiException if the response code was not in [200, 299] */ getSyntheticsTestResult(response: ResponseContext): Promise<SyntheticsTestResultResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getSyntheticsTestVersion * @throws ApiException if the response code was not in [200, 299] */ getSyntheticsTestVersion(response: ResponseContext): Promise<SyntheticsTestVersionResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getTestFileDownloadUrl * @throws ApiException if the response code was not in [200, 299] */ getTestFileDownloadUrl(response: ResponseContext): Promise<SyntheticsTestFileDownloadResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getTestFileMultipartPresignedUrls * @throws ApiException if the response code was not in [200, 299] */ getTestFileMultipartPresignedUrls(response: ResponseContext): Promise<SyntheticsTestFileMultipartPresignedUrlsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to getTestParentSuites * @throws ApiException if the response code was not in [200, 299] */ getTestParentSuites(response: ResponseContext): Promise<SyntheticsTestParentSuitesResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listSyntheticsBrowserTestLatestResults * @throws ApiException if the response code was not in [200, 299] */ listSyntheticsBrowserTestLatestResults(response: ResponseContext): Promise<SyntheticsTestLatestResultsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listSyntheticsDowntimes * @throws ApiException if the response code was not in [200, 299] */ listSyntheticsDowntimes(response: ResponseContext): Promise<SyntheticsDowntimesResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listSyntheticsTestLatestResults * @throws ApiException if the response code was not in [200, 299] */ listSyntheticsTestLatestResults(response: ResponseContext): Promise<SyntheticsTestLatestResultsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to listSyntheticsTestVersions * @throws ApiException if the response code was not in [200, 299] */ listSyntheticsTestVersions(response: ResponseContext): Promise<SyntheticsTestVersionHistoryResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to patchGlobalVariable * @throws ApiException if the response code was not in [200, 299] */ patchGlobalVariable(response: ResponseContext): Promise<GlobalVariableResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to patchTestSuite * @throws ApiException if the response code was not in [200, 299] */ patchTestSuite(response: ResponseContext): Promise<SyntheticsSuiteResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to pollSyntheticsTestResults * @throws ApiException if the response code was not in [200, 299] */ pollSyntheticsTestResults(response: ResponseContext): Promise<SyntheticsPollTestResultsResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to removeTestFromSyntheticsDowntime * @throws ApiException if the response code was not in [200, 299] */ removeTestFromSyntheticsDowntime(response: ResponseContext): Promise<SyntheticsDowntimeResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to searchSuites * @throws ApiException if the response code was not in [200, 299] */ searchSuites(response: ResponseContext): Promise<SyntheticsSuiteSearchResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to setOnDemandConcurrencyCap * @throws ApiException if the response code was not in [200, 299] */ setOnDemandConcurrencyCap(response: ResponseContext): Promise<OnDemandConcurrencyCapResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to updateSyntheticsDowntime * @throws ApiException if the response code was not in [200, 299] */ updateSyntheticsDowntime(response: ResponseContext): Promise<SyntheticsDowntimeResponse>; /** * Unwraps the actual response sent by the server from the response context and deserializes the response content * to the expected objects * * @params response Response returned by the server for a request to updateSyntheticsNetworkTest * @throws ApiException if the response code was not in [200, 299] */ updateSyntheticsNetworkTest(response: ResponseContext): Promise<SyntheticsNetworkTestResponse>; } export interface SyntheticsApiAbortTestFileMultipartUploadRequest { /** * The public ID of the Synthetic test. * @type string */ publicId: string; /** * @type SyntheticsTestFileAbortMultipartUploadRequest */ body: SyntheticsTestFileAbortMultipartUploadRequest; } export interface SyntheticsApiAddTestToSyntheticsDowntimeRequest { /** * The ID of the downtime. * @type string */ downtimeId: string; /** * The public ID of the Synthetics test to associate with the downtime. * @type string */ testId: string; } export interface SyntheticsApiCompleteTestFileMultipartUploadRequest { /** * The public ID of the Synthetic test. * @type string */ publicId: string; /** * @type SyntheticsTestFileCompleteMultipartUploadRequest */ body: SyntheticsTestFileCompleteMultipartUploadRequest; } export interface SyntheticsApiCreateSyntheticsDowntimeRequest { /** * @type SyntheticsDowntimeRequest */ body: SyntheticsDowntimeRequest; } export interface SyntheticsApiCreateSyntheticsNetworkTestRequest { /** * @type SyntheticsNetworkTestEditRequest */ body: SyntheticsNetworkTestEditRequest; } export interface SyntheticsApiCreateSyntheticsSuiteRequest { /** * @type SuiteCreateEditRequest */ body: SuiteCreateEditRequest; } export interface SyntheticsApiDeleteSyntheticsDowntimeRequest { /** * The ID of the downtime to delete. * @type string */ downtimeId: string; } export interface SyntheticsApiDeleteSyntheticsSuitesRequest { /** * @type DeletedSuitesRequestDeleteRequest */ body: DeletedSuitesRequestDeleteRequest; } export interface SyntheticsApiDeleteSyntheticsTestsRequest { /** * @type DeletedTestsRequestDeleteRequest */ body: DeletedTestsRequestDeleteRequest; } export interface SyntheticsApiEditSyntheticsSuiteRequest { /** * The public ID of the suite to edit. * @type string */ publicId: string; /** * New suite details to be saved. * @type SuiteCreateEditRequest */ body: SuiteCreateEditRequest; } export interface SyntheticsApiGetApiMultistepSubtestParentsRequest { /** * The public ID of the subtest. * @type string */ publicId: string; } export interface SyntheticsApiGetApiMultistepSubtestsRequest { /** * The public ID of the API multistep test. * @type string */ publicId: string; } export interface SyntheticsApiGetSyntheticsBrowserTestResultRequest { /** * The public ID of the Synthetic browser test to which the target result belongs. * @type string */ publicId: string; /** * The ID of the result to get. * @type string */ resultId: string; /** * The event ID used to look up the result in the event store. * @type string */ eventId?: string; /** * Timestamp in seconds to look up the result. * @type number */ timestamp?: number; } export interface SyntheticsApiGetSyntheticsDowntimeRequest { /** * The ID of the downtime to retrieve. * @type string */ downtimeId: string; } export interface SyntheticsApiGetSyntheticsFastTestResultRequest { /** * The UUID of the fast test to retrieve the result for. * @type string */ id: string; } export interface SyntheticsApiGetSyntheticsNetworkTestRequest { /** * The public ID of the Network Path test to get details from. * @type string */ publicId: string; } export interface SyntheticsApiGetSyntheticsSuiteRequest { /** * The public ID of the suite to get details from. * @type string */ publicId: string; } export interface SyntheticsApiGetSyntheticsTestResultRequest { /** * The public ID of the Synthetic test to which the target result belongs. * @type string */ publicId: string; /** * The ID of the result to get. * @type string */ resultId: string; /** * The event ID used to look up the result in the event store. * @type string */ eventId?: string; /** * Timestamp in seconds to look up the result. * @type number */ timestamp?: number; } export interface SyntheticsApiGetSyntheticsTestVersionRequest { /** * The public ID of the Synthetic test. * @type string */ publicId: string; /** * The version number to retrieve. * @type number */ versionNumber: number; /** * If `true`, include change metadata in the response. * @type boolean */ includeChangeMetadata?: boolean; /** * If `true`, only check whether the version exists without returning its full payload. * Returns an empty object if the version exists, or 404 if not. * @type boolean */ onlyCheckExistence?: boolean; } export interface SyntheticsApiGetTestFileDownloadUrlRequest { /** * The public ID of the Synthetic test. * @type string */ publicId: string; /** * @type SyntheticsTestFileDownloadRequest */ body: SyntheticsTestFileDownloadRequest; } export interface SyntheticsApiGetTestFileMultipartPresignedUrlsRequest { /** * The public ID of the Synthetic test. * @type string */ publicId: string; /** * @type SyntheticsTestFileMultipartPresignedUrlsRequest */ body: SyntheticsTestFileMultipartPresignedUrlsRequest; } export interface SyntheticsApiGetTestParentSuitesRequest { /** * The public ID of the Synthetic test. * @type string */ publicId: string; } export interface SyntheticsApiListSyntheticsBrowserTestLatestResultsRequest { /** * The public ID of the Synthetic browser test for which to search results. * @type string */ publicId: string; /** * Timestamp in milliseconds from which to start querying results. * @type number */ fromTs?: number; /** * Timestamp in milliseconds up to which to query results. * @type number */ toTs?: number; /** * Filter results by status. * @type SyntheticsTestResultStatus */ status?: SyntheticsTestResultStatus; /** * Filter results by run type. * @type SyntheticsTestResultRunType */ runType?: SyntheticsTestResultRunType; /** * Locations for which to query results. * @type Array<string> */ probeDc?: Array<string>; /** * Device IDs for which to query results. * @type Array<string> */ deviceId?: Array<string>; } export interface SyntheticsApiListSyntheticsDowntimesRequest { /** * Comma-separated list of Synthetics test public IDs to filter downtimes by. * @type string */ filterTestIds?: string; /** * If set to `true`, return only downtimes that are currently active. * @type string */ filterActive?: string; } export interface SyntheticsApiListSyntheticsTestLatestResultsRequest { /** * The public ID of the Synthetic test for which to search results. * @type string */ publicId: string; /** * Timestamp in milliseconds from which to start querying results. * @type number */ fromTs?: number; /** * Timestamp in milliseconds up to which to query results. * @type number */ toTs?: number; /** * Filter results by status. * @type SyntheticsTestResultStatus */ status?: SyntheticsTestResultStatus; /** * Filter results by run type. * @type SyntheticsTestResultRunType */ runType?: SyntheticsTestResultRunType; /** * Locations for which to query results. * @type Array<string> */ probeDc?: Array<string>; /** * Device IDs for which to query results. * @type Array<string> */ deviceId?: Array<string>; } export interface SyntheticsApiListSyntheticsTestVersionsRequest { /** * The public ID of the Synthetic test. * @type string */ publicId: string; /** * The version number of the last item from the previous page. Omit to get the first page. * @type number */ lastVersionNumber?: number; /** * Maximum number of version records to return per page. * @type number */ limit?: number; } export interface SyntheticsApiPatchGlobalVariableRequest { /** * The ID of the global variable. * @type string */ variableId: string; /** * JSON Patch document with operations to apply. * @type GlobalVariableJsonPatchRequest */ body: GlobalVariableJsonPatchRequest; } export interface SyntheticsApiPatchTestSuiteRequest { /** * The public ID of the Synthetic test suite to patch. * @type string */ publicId: string; /** * JSON Patch document with operations to apply. * @type SuiteJsonPatchRequest */ body: SuiteJsonPatchRequest; } export interface SyntheticsApiPollSyntheticsTestResultsRequest { /** * A JSON-encoded array of result IDs to poll for. * @type string */ resultIds: string; } export interface SyntheticsApiRemoveTestFromSyntheticsDowntimeRequest { /** * The ID of the downtime. * @type string */ downtimeId: string; /** * The public ID of the Synthetics test to disassociate from the downtime. * @type string */ testId: string; } export interface SyntheticsApiSearchSuitesRequest { /** * The search query. * @type string */ query?: string; /** * The sort order for the results (e.g., `name,asc` or `name,desc`). * @type string */ sort?: string; /** * If true, return only facets instead of full test details. * @type boolean */ facetsOnly?: boolean; /** * The offset from which to start returning results. * @type number */ start?: number; /** * The maximum number of results to return. * @type number */ count?: number; } export interface SyntheticsApiSetOnDemandConcurrencyCapRequest { /** * . * @type OnDemandConcurrencyCapAttributes */ body: OnDemandConcurrencyCapAttributes; } export interface SyntheticsApiUpdateSyntheticsDowntimeRequest { /** * The ID of the downtime to update. * @type string */ downtimeId: string; /** * @type SyntheticsDowntimeRequest */ body: SyntheticsDowntimeRequest; } export interface SyntheticsApiUpdateSyntheticsNetworkTestRequest { /** * The public ID of the Network Path test to edit. * @type string */ publicId: string; /** * New Network Path test details to be saved. * @type SyntheticsNetworkTestEditRequest */ body: SyntheticsNetworkTestEditRequest; } export declare class SyntheticsApi { private requestFactory; private responseProcessor; private configuration; constructor(configuration: Configuration, requestFactory?: SyntheticsApiRequestFactory, responseProcessor?: SyntheticsApiResponseProcessor); /** * Abort an in-progress multipart file upload for a Synthetic test. This cancels the upload * and releases any storage used by already-uploaded parts. * @param param The request object */ abortTestFileMultipartUpload(param: SyntheticsApiAbortTestFileMultipartUploadRequest, options?: Configuration): Promise<void>; /** * Associate a Synthetics test with a downtime. * @param param The request object */ addTestToSyntheticsDowntime(param: SyntheticsApiAddTestToSyntheticsDowntimeRequest, options?: Configuration): Promise<SyntheticsDowntimeResponse>; /** * Complete a multipart file upload for a Synthetic test. Call this endpoint after all parts * have been uploaded using the presigned URLs obtained from the multipart presigned URLs endpoint. * @param param The request object */ completeTestFileMultipartUpload(param: SyntheticsApiCompleteTestFileMultipartUploadRequest, options?: Configuration): Promise<void>; /** * Create a new Synthetics downtime. * @param param The request object */ createSyntheticsDowntime(param: SyntheticsApiCreateSyntheticsDowntimeRequest, options?: Configuration): Promise<SyntheticsDowntimeResponse>; /** * @param param The request object */ createSyntheticsNetworkTest(param: SyntheticsApiCreateSyntheticsNetworkTestRequest, options?: Configuration): Promise<SyntheticsNetworkTestResponse>; /** * @param param The request object */ createSyntheticsSuite(param: SyntheticsApiCreateSyntheticsSuiteRequest, options?: Configuration): Promise<SyntheticsSuiteResponse>; /** * Delete a Synthetics downtime by its ID. * @param param The request object */ deleteSyntheticsDowntime(param: SyntheticsApiDeleteSyntheticsDowntimeRequest, options?: Configuration): Promise<void>; /** * @param param The request object */ deleteSyntheticsSuites(param: SyntheticsApiDeleteSyntheticsSuitesRequest, options?: Configuration): Promise<DeletedSuitesResponse>; /** * @param param The request object */ deleteSyntheticsTests(param: SyntheticsApiDeleteSyntheticsTestsRequest, options?: Configuration): Promise<DeletedTestsResponse>; /** * @param param The request object */ editSyntheticsSuite(param: SyntheticsApiEditSyntheticsSuiteRequest, options?: Configuration): Promise<SyntheticsSuiteResponse>; /** * Get the list of API multistep tests that include a given subtest, * along with their monitor status. * @param param The request object */ getApiMultistepSubtestParents(param: SyntheticsApiGetApiMultistepSubtestParentsRequest, options?: Configuration): Promise<SyntheticsApiMultistepParentTestsResponse>; /** * Get the list of API tests that can be added as subtests to a given API multistep test. * The current test is excluded from the list since a test cannot be a subtest of itself. * @param param The request object */ getApiMultistepSubtests(param: SyntheticsApiGetApiMultistepSubtestsRequest, options?: Configuration): Promise<SyntheticsApiMultistepSubtestsResponse>; /** * Get the on-demand concurrency cap. * @param param The request object */ getOnDemandConcurrencyCap(options?: Configuration): Promise<OnDemandConcurrencyCapResponse>; /** * Get a specific full result from a given Synthetic browser test. * @param param The request object */ getSyntheticsBrowserTestResult(param: SyntheticsApiGetSyntheticsBrowserTestResultRequest, options?: Configuration): Promise<SyntheticsTestResultResponse>; /** * Get a Synthetics downtime by its ID. * @param param The request object */ getSyntheticsDowntime(param: SyntheticsApiGetSyntheticsDowntimeRequest, options?: Configuration): Promise<SyntheticsDowntimeResponse>; /** * @param param The request object */ getSyntheticsFastTestResult(param: SyntheticsApiGetSyntheticsFastTestResultRequest, options?: Configuration): Promise<SyntheticsFastTestResult>; /** * @param param The request object */ getSyntheticsNetworkTest(param: SyntheticsApiGetSyntheticsNetworkTestRequest, options?: Configuration): Promise<SyntheticsNetworkTestResponse>; /** * @param param The request object */ getSyntheticsSuite(param: SyntheticsApiGetSyntheticsSuiteRequest, options?: Configuration): Promise<SyntheticsSuiteResponse>; /** * Get a specific full result from a given Synthetic test. * @param param The request object */ getSyntheticsTestResult(param: SyntheticsApiGetSyntheticsTestResultRequest, options?: Configuration): Promise<SyntheticsTestResultResponse>; /** * Get a specific version of a Synthetic test by its version number. * @param param The request object */ getSyntheticsTestVersion(param: SyntheticsApiGetSyntheticsTestVersionRequest, options?: Configuration): Promise<SyntheticsTestVersionResponse>; /** * Get a presigned URL to download a file attached to a Synthetic test. * The returned URL is temporary and expires after a short period. * @param param The request object */ getTestFileDownloadUrl(param: SyntheticsApiGetTestFileDownloadUrlRequest, options?: Configuration): Promise<SyntheticsTestFileDownloadResponse>; /** * Get presigned URLs for uploading a file to a Synthetic test using multipart upload. * Returns the presigned URLs for each part along with the bucket key that references the file. * @param param The request object */ getTestFileMultipartPresignedUrls(param: SyntheticsApiGetTestFileMultipartPresignedUrlsRequest, options?: Configuration): Promise<SyntheticsTestFileMultipartPresignedUrlsResponse>; /** * Get the list of parent suites and their status for a given Synthetic test. * @param param The request object */ getTestParentSuites(param: SyntheticsApiGetTestParentSuitesRequest, options?: Configuration): Promise<SyntheticsTestParentSuitesResponse>; /** * Get the latest result summaries for a given Synthetic browser test. * @param param The request object */ listSyntheticsBrowserTestLatestResults(param: SyntheticsApiListSyntheticsBrowserTestLatestResultsRequest, options?: Configuration): Promise<SyntheticsTestLatestResultsResponse>; /** * Get a list of all Synthetics downtimes for your organization. * @param param The request object */ listSyntheticsDowntimes(param?: SyntheticsApiListSyntheticsDowntimesRequest, options?: Configuration): Promise<SyntheticsDowntimesResponse>; /** * Get the latest result summaries for a given Synthetic test. * @param param The request object */ listSyntheticsTestLatestResults(param: SyntheticsApiListSyntheticsTestLatestResultsRequest, options?: Configuration): Promise<SyntheticsTestLatestResultsResponse>; /** * Get the paginated version history for a Synthetic test. * @param param The request object */ listSyntheticsTestVersions(param: SyntheticsApiListSyntheticsTestVersionsRequest, options?: Configuration): Promise<SyntheticsTestVersionHistoryResponse>; /** * Patch a global variable using JSON Patch (RFC 6902). * This endpoint allows partial updates to a global variable by specifying only the fields to modify. * * Common operations include: * - Replace field values: `{"op": "replace", "path": "/name", "value": "new_name"}` * - Update nested values: `{"op": "replace", "path": "/value/value", "value": "new_value"}` * - Add/update tags: `{"op": "add", "path": "/tags/-", "value": "new_tag"}` * - Remove fields: `{"op": "remove", "path": "/description"}` * @param param The request object */ patchGlobalVariable(param: SyntheticsApiPatchGlobalVariableRequest, options?: Configuration): Promise<GlobalVariableResponse>; /** * Patch a Synthetic test suite using JSON Patch (RFC 6902). * Use partial updates to modify only specific fields of a test suite. * * Common operations include: * - Replace field values: `{"op": "replace", "path": "/name", "value": "new_name"}` * - Add/update tags: `{"op": "add", "path": "/tags/-", "value": "new_tag"}` * - Remove fields: `{"op": "remove", "path": "/message"}` * @param param The request object */ patchTestSuite(param: SyntheticsApiPatchTestSuiteRequest, options?: Configuration): Promise<SyntheticsSuiteResponse>; /** * Poll for test results given a list of result IDs. This is typically used after * triggering tests with CI/CD to retrieve results once they are available. * @param param The request object */ pollSyntheticsTestResults(param: SyntheticsApiPollSyntheticsTestResultsRequest, options?: Configuration): Promise<SyntheticsPollTestResultsResponse>; /** * Disassociate a Synthetics test from a downtime. * @param param The request object */ removeTestFromSyntheticsDowntime(param: SyntheticsApiRemoveTestFromSyntheticsDowntimeRequest, options?: Configuration): Promise<SyntheticsDowntimeResponse>; /** * Search for test suites. * @param param The request object */ searchSuites(param?: SyntheticsApiSearchSuitesRequest, options?: Configuration): Promise<SyntheticsSuiteSearchResponse>; /** * Save new value for on-demand concurrency cap. * @param param The request object */ setOnDemandConcurrencyCap(param: SyntheticsApiSetOnDemandConcurrencyCapRequest, options?: Configuration): Promise<OnDemandConcurrencyCapResponse>; /** * Update a Synthetics downtime by its ID. * @param param The request object */ updateSyntheticsDowntime(param: SyntheticsApiUpdateSyntheticsDowntimeRequest, options?: Configuration): Promise<SyntheticsDowntimeResponse>; /** * @param param The request object */ updateSyntheticsNetworkTest(param: SyntheticsApiUpdateSyntheticsNetworkTestRequest, options?: Configuration): Promise<SyntheticsNetworkTestResponse>; }