/** * Dashboard API * Dashboard API documentation * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { BulkUserCreateResponse, InternalBulkUpdateUserFields, InternalUpdatableUserFields, InternalUserFields, SessionsResponse, UserOauthAccessTokenResponse, UserResponse, UserSearchFilterParams, UsersResponse } from '../models'; export interface BulkCreateUserRequest { environmentId: string; internalUserFields: Array; upsert?: boolean; } export interface CreateUserRequest { environmentId: string; internalBulkUpdateUserFields: InternalBulkUpdateUserFields; } export interface DeleteUserRequest { environmentId: string; userId: string; } export interface DeleteUserLegacyRequest { userId: string; } export interface GetEnvironmentUsersRequest { environmentId: string; filter?: UserSearchFilterParams; orderBy?: string; offset?: number; limit?: number; includeSessions?: boolean; } export interface GetUserRequest { environmentId: string; userId: string; } export interface GetUserLegacyRequest { userId: string; } export interface GetUserOauthAccessTokenRequest { oauthAccountId: string; } export interface GetUserSessionsRequest { environmentId: string; userId: string; limit?: number; offset?: number; revoked?: boolean; } export interface RevokeUserSessionsRequest { environmentId: string; userId: string; } export interface RevokeUserSessionsLegacyRequest { userId: string; } export interface UpdateUserRequest { environmentId: string; userId: string; internalUpdatableUserFields: InternalUpdatableUserFields; } export interface UpdateUserLegacyRequest { userId: string; internalUpdatableUserFields: InternalUpdatableUserFields; } /** * */ export declare class UsersApi extends runtime.BaseAPI { /** * Creates multiple users in a single request. * Bulk create users */ bulkCreateUserRaw(requestParameters: BulkCreateUserRequest, initOverrides?: RequestInit): Promise>; /** * Creates multiple users in a single request. * Bulk create users */ bulkCreateUser(requestParameters: BulkCreateUserRequest, initOverrides?: RequestInit): Promise; /** * Creates a new user for the specified environment. * Create a user */ createUserRaw(requestParameters: CreateUserRequest, initOverrides?: RequestInit): Promise>; /** * Creates a new user for the specified environment. * Create a user */ createUser(requestParameters: CreateUserRequest, initOverrides?: RequestInit): Promise; /** * Permanently removes the specified user. * Delete user */ deleteUserRaw(requestParameters: DeleteUserRequest, initOverrides?: RequestInit): Promise>; /** * Permanently removes the specified user. * Delete user */ deleteUser(requestParameters: DeleteUserRequest, initOverrides?: RequestInit): Promise; /** * Permanently removes the specified user (deprecated). * Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead) */ deleteUserLegacyRaw(requestParameters: DeleteUserLegacyRequest, initOverrides?: RequestInit): Promise>; /** * Permanently removes the specified user (deprecated). * Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead) */ deleteUserLegacy(requestParameters: DeleteUserLegacyRequest, initOverrides?: RequestInit): Promise; /** * Returns all users for the specified environment. * Get all users for an environment */ getEnvironmentUsersRaw(requestParameters: GetEnvironmentUsersRequest, initOverrides?: RequestInit): Promise>; /** * Returns all users for the specified environment. * Get all users for an environment */ getEnvironmentUsers(requestParameters: GetEnvironmentUsersRequest, initOverrides?: RequestInit): Promise; /** * Returns a user by their unique identifier. * Get a user by Id */ getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit): Promise>; /** * Returns a user by their unique identifier. * Get a user by Id */ getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit): Promise; /** * Returns a user by their ID (deprecated). * Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead) */ getUserLegacyRaw(requestParameters: GetUserLegacyRequest, initOverrides?: RequestInit): Promise>; /** * Returns a user by their ID (deprecated). * Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead) */ getUserLegacy(requestParameters: GetUserLegacyRequest, initOverrides?: RequestInit): Promise; /** * Returns the OAuth access token for the specified user account. * Get the access token for a user OAuth account */ getUserOauthAccessTokenRaw(requestParameters: GetUserOauthAccessTokenRequest, initOverrides?: RequestInit): Promise>; /** * Returns the OAuth access token for the specified user account. * Get the access token for a user OAuth account */ getUserOauthAccessToken(requestParameters: GetUserOauthAccessTokenRequest, initOverrides?: RequestInit): Promise; /** * Returns all sessions for the specified user. * Get all sessions for a user by user ID */ getUserSessionsRaw(requestParameters: GetUserSessionsRequest, initOverrides?: RequestInit): Promise>; /** * Returns all sessions for the specified user. * Get all sessions for a user by user ID */ getUserSessions(requestParameters: GetUserSessionsRequest, initOverrides?: RequestInit): Promise; /** * Revokes all sessions for the specified user. * Revoke sessions by user ID */ revokeUserSessionsRaw(requestParameters: RevokeUserSessionsRequest, initOverrides?: RequestInit): Promise>; /** * Revokes all sessions for the specified user. * Revoke sessions by user ID */ revokeUserSessions(requestParameters: RevokeUserSessionsRequest, initOverrides?: RequestInit): Promise; /** * This endpoint is deprecated. Use /environments/{environmentId}/users/{userId}/sessions/revoke instead. * Revoke sessions by user ID */ revokeUserSessionsLegacyRaw(requestParameters: RevokeUserSessionsLegacyRequest, initOverrides?: RequestInit): Promise>; /** * This endpoint is deprecated. Use /environments/{environmentId}/users/{userId}/sessions/revoke instead. * Revoke sessions by user ID */ revokeUserSessionsLegacy(requestParameters: RevokeUserSessionsLegacyRequest, initOverrides?: RequestInit): Promise; /** * Updates the specified user. * Update a user */ updateUserRaw(requestParameters: UpdateUserRequest, initOverrides?: RequestInit): Promise>; /** * Updates the specified user. * Update a user */ updateUser(requestParameters: UpdateUserRequest, initOverrides?: RequestInit): Promise; /** * Updates the specified user (deprecated). * Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead) */ updateUserLegacyRaw(requestParameters: UpdateUserLegacyRequest, initOverrides?: RequestInit): Promise>; /** * Updates the specified user (deprecated). * Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead) */ updateUserLegacy(requestParameters: UpdateUserLegacyRequest, initOverrides?: RequestInit): Promise; }