@fullstory/server-api-client
Version:
The official FullStory server API client SDK for NodeJS.
49 lines (48 loc) • 2.3 kB
TypeScript
import { JobStatusResponse, CreateBatchUserImportJobRequest, GetBatchUserImportsResponse, GetBatchUserImportErrorsResponse, CreateBatchUserImportJobResponse } from '../../model/index';
import { FSResponse, FullStoryOptions } from '../../http';
export declare class UsersBatchImportApi {
readonly defaultBasePath = "https://api.fullstory.com";
private basePath;
private httpClient;
constructor(opts: FullStoryOptions);
/**
* Creates a batch user import job with the given list of users\' information.
* @summary Create Batch Import
* @param body
* @param idempotencyKey Optional header for making the request idempotent
*/
createBatchUserImportJob(request: {
body: CreateBatchUserImportJobRequest;
idempotencyKey?: string;
}): Promise<FSResponse<CreateBatchUserImportJobResponse>>;
/**
* Get the error message and code for any users that failed from a user 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
*/
getBatchUserImportErrors(request: {
jobId: string;
pageToken?: string;
}): Promise<FSResponse<GetBatchUserImportErrorsResponse>>;
/**
* Get the status for a batch user 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
*/
getBatchUserImportStatus(request: {
jobId: string;
}): Promise<FSResponse<JobStatusResponse>>;
/**
* Get the FullStory id and user details for successful users imported from a batch user import job.
* @summary Get Batch Imported Users
* @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 schemas in the response.
*/
getBatchUserImports(request: {
jobId: string;
pageToken?: string;
includeSchema?: boolean;
}): Promise<FSResponse<GetBatchUserImportsResponse>>;
}