Xivgear Types Documentation
    Preparing search index...

    Class AccountServiceClient<SecurityDataType>

    xivgear-account-service

    0.0

    Type Parameters

    • SecurityDataType extends unknown

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    account: {
        accountInfo: (
            params?: RequestParams,
        ) => Promise<HttpResponse<AccountInfo, any>>;
        changePassword: (
            data: ChangePasswordRequest,
            params?: RequestParams,
        ) => Promise<HttpResponse<ChangePasswordResponse, any>>;
        currentAccount: (
            params?: RequestParams,
        ) => Promise<HttpResponse<AccountInfoResponse, any>>;
        finalizePasswordReset: (
            data: FinalizePasswordResetRequest,
            params?: RequestParams,
        ) => Promise<HttpResponse<object, ValidationErrorResponse>>;
        getJwt: (params?: RequestParams) => Promise<HttpResponse<JwtResponse, any>>;
        initiatePasswordReset: (
            data: InitiatePasswordResetRequest,
            params?: RequestParams,
        ) => Promise<HttpResponse<object, any>>;
        login: (
            data: LoginRequest,
            params?: RequestParams,
        ) => Promise<HttpResponse<LoginResponse, any>>;
        logout: (params?: RequestParams) => Promise<HttpResponse<object, any>>;
        register: (
            data: RegisterRequest,
            params?: RequestParams,
        ) => Promise<HttpResponse<RegisterResponse, ValidationErrorResponse>>;
        resendVerificationCode: (
            params?: RequestParams,
        ) => Promise<HttpResponse<void, any>>;
        verifyEmail: (
            data: VerifyEmailRequest,
            params?: RequestParams,
        ) => Promise<HttpResponse<VerifyEmailResponse, any>>;
    } = ...

    Type Declaration

    baseUrl: string = ""
    healthz: {
        healthCheck: (
            params?: RequestParams,
        ) => Promise<HttpResponse<string, any>>;
    } = ...

    Type Declaration

    • healthCheck: (params?: RequestParams) => Promise<HttpResponse<string, any>>

      No description

      HealthCheck

      GET:/healthz

      200 string healthCheck 200 response

    readyz: {
        readyCheck: (
            params?: RequestParams,
        ) => Promise<HttpResponse<string, any>>;
    } = ...

    Type Declaration

    • readyCheck: (params?: RequestParams) => Promise<HttpResponse<string, any>>

      No description

      ReadyCheck

      GET:/readyz

      200 string readyCheck 200 response

    Methods