@fullstory/server-api-client
Version:
The official FullStory server API client SDK for NodeJS.
49 lines (48 loc) • 2.4 kB
TypeScript
import { JobStatusResponse, GetBatchEventsImportErrorsResponse, CreateBatchEventsImportJobRequest, GetBatchEventsImportsResponse, CreateBatchEventsImportJobResponse } from '../../model/index';
import { FSResponse, FullStoryOptions } from '../../http';
export declare class EventsBatchImportApi {
readonly defaultBasePath = "https://api.fullstory.com";
private basePath;
private httpClient;
constructor(opts: FullStoryOptions);
/**
* Creates a batch events import job with the given list of event information.
* @summary Create Events Batch Import
* @param body The request payloads contains the list of events to be imported
* @param idempotencyKey Optional header for marking the request to be idempotent
*/
createBatchEventsImportJob(request: {
body: CreateBatchEventsImportJobRequest;
idempotencyKey?: string;
}): Promise<FSResponse<CreateBatchEventsImportJobResponse>>;
/**
* Get the error message and code for any events that failed from an events import job.
* @summary Get Batch Import Errors
* @param jobId ID that can be used to check the status and retrieve results for the batch import
* @param pageToken The token that can be used in a request to fetch the next page of results
*/
getBatchEventsImportErrors(request: {
jobId: string;
pageToken?: string;
}): Promise<FSResponse<GetBatchEventsImportErrorsResponse>>;
/**
* Get the status for a batch events import job with job details.
* @summary Get Batch Import Job Details
* @param jobId ID that can be used to check the status and retrieve results for the batch import
*/
getBatchEventsImportStatus(request: {
jobId: string;
}): Promise<FSResponse<JobStatusResponse>>;
/**
* Get the event details for successful events imported from a batch events import job.
* @summary Get Batch Imported Events
* @param jobId ID that can be used to check the status and retrieve results for the batch import
* @param pageToken The token that can be used in a request to fetch the next page of results
* @param includeSchema Whether to include the schema in the response.
*/
getBatchEventsImports(request: {
jobId: string;
pageToken?: string;
includeSchema?: boolean;
}): Promise<FSResponse<GetBatchEventsImportsResponse>>;
}