@fullstory/server-api-client/lib/api/users/UsersApi.d.ts

The official FullStory server API client SDK for NodeJS.

import { GetUserResponse, ListUsersResponse, CreateUserResponse, UpdateUserResponse, CreateUserRequest, UpdateUserRequest } from '../../model/index';
import { FSResponse, FullStoryOptions } from '../../http';
export declare class UsersApi {
    readonly defaultBasePath = "https://api.fullstory.com";
    private basePath;
    private httpClient;
    constructor(opts: FullStoryOptions);
    /**
     * Creates a user with the specified details.
     * @summary Create User
     * @param body
     * @param idempotencyKey Optional header for making the request idempotent
    */
    createUser(request: {
        body: CreateUserRequest;
        idempotencyKey?: string;
    }): Promise<FSResponse<CreateUserResponse>>;
    /**
     * Delete a single user by FullStory generated user ID.
     * @summary Delete User
     * @param id The FullStory-generated id for the user.
    */
    deleteUser(request: {
        id: string;
    }): Promise<FSResponse<void>>;
    /**
     * Delete a single user by uid.
     * @summary Delete User
     * @param uid The application-specific ID you've given to the user
    */
    deleteUserByUid(request: {
        uid?: string;
    }): Promise<FSResponse<void>>;
    /**
     * Retrieve details for a single user
     * @summary Get User
     * @param id The FullStory assigned user ID
     * @param includeSchema Whether to include the schema in the response.
    */
    getUser(request: {
        id: string;
        includeSchema?: boolean;
    }): Promise<FSResponse<GetUserResponse>>;
    /**
     * Retrieve a list of users matching the supplied filter criteria
     * @summary Get Users
     * @param uid The application-specific ID you've given to a user
     * @param email The email address associated with a user
     * @param displayName The nice-looking name for a user
     * @param isIdentified Whether or not a user is anonymous or identified
     * @param pageToken The token indicating the page of users to fetch. The same filter criteria should be supplied. This value should not be specified when requesting the first page of users.
     * @param includeSchema Whether to include schemas in the response.
    */
    listUsers(request: {
        uid?: string;
        email?: string;
        displayName?: string;
        isIdentified?: boolean;
        pageToken?: string;
        includeSchema?: boolean;
    }): Promise<FSResponse<ListUsersResponse>>;
    /**
     * Updates a user with the specified details
     * @summary Update User
     * @param id The FullStory assigned user ID
     * @param body
    */
    updateUser(request: {
        id: string;
        body: UpdateUserRequest;
    }): Promise<FSResponse<UpdateUserResponse>>;
}