devopness-sdk-js/dist/api/generated/apis/users-api.d.ts

Devopness API JS/TS SDK - Painless essential DevOps to everyone

/**
 * devopness API
 * Devopness API - Painless essential DevOps to everyone
 *
 * The version of the OpenAPI document: latest
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { ApiBaseService } from "../../../services/ApiBaseService";
import { ApiResponse } from "../../../common/ApiResponse";
import { LoginCredentials } from '../../generated/models';
import { User } from '../../generated/models';
import { UserCreate } from '../../generated/models';
import { UserRefreshTokenCreate } from '../../generated/models';
import { UserTokens } from '../../generated/models';
/**
 * UsersApiService - Auto-generated
 */
export declare class UsersApiService extends ApiBaseService {
    /**
     *
     * @summary Activate an user account
     */
    activateUser(): Promise<ApiResponse<object>>;
    /**
     *
     * @summary Sign up/register a new user
     * @param {UserCreate} userCreate A JSON object containing user essential data
     */
    addUser(userCreate: UserCreate): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Get a user by ID
     * @param {number} id Numeric ID of the user or the string literal &#x60;me&#x60; for the current user
     */
    getUser(id: number): Promise<ApiResponse<User>>;
    /**
     *
     * @summary Login/create a new token for the given credentials
     * @param {LoginCredentials} loginCredentials A JSON object containing user credentials
     */
    login(loginCredentials: LoginCredentials): Promise<ApiResponse<UserTokens>>;
    /**
     *
     * @summary Logout/revoke an existing token
     */
    logout(): Promise<ApiResponse<void>>;
    /**
     *
     * @summary Refresh an existing user access token
     * @param {UserRefreshTokenCreate} userRefreshTokenCreate A JSON object containing user essential data
     */
    refreshToken(userRefreshTokenCreate: UserRefreshTokenCreate): Promise<ApiResponse<UserTokens>>;
}