Class AccountServiceClient<SecurityDataType>

Title

xivgear-account-service

Version

0.0

Type Parameters

SecurityDataType extends unknown

Hierarchy (View Summary)

HttpClient<SecurityDataType>
- AccountServiceClient

Index

Constructors

constructor

new AccountServiceClient<SecurityDataType extends unknown>(
apiConfig?: ApiConfig<SecurityDataType>,
): AccountServiceClient<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- apiConfig: ApiConfig<SecurityDataType> = {}
Returns AccountServiceClient<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in packages/account-service-client/src/accountsvc.ts:180

Properties

account

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

accountInfo: (params?: RequestParams) => Promise<HttpResponse<AccountInfo, any>>
No description

Name
AccountInfo

Request
GET:/account/info

Secure
Response
200 AccountInfo accountInfo 200 response
changePassword: (
data: ChangePasswordRequest,
params?: RequestParams,
) => Promise<HttpResponse<ChangePasswordResponse, any>>
No description

Name
ChangePassword

Request
POST:/account/changePassword

Secure
Response
200 ChangePasswordResponse changePassword 200 response
currentAccount: (params?: RequestParams) => Promise<HttpResponse<AccountInfoResponse, any>>
No description

Name
CurrentAccount

Request
GET:/account/current

Secure
Response
200 AccountInfoResponse currentAccount 200 response
finalizePasswordReset: (
data: FinalizePasswordResetRequest,
params?: RequestParams,
) => Promise<HttpResponse<object, ValidationErrorResponse>>
No description

Name
FinalizePasswordReset

Request
POST:/account/finalizePasswordReset

Secure
Response
200 object Successful reset

Response
400 ValidationErrorResponse Validation error
getJwt: (params?: RequestParams) => Promise<HttpResponse<JwtResponse, any>>
No description

Name
GetJwt

Request
GET:/account/jwt

Secure
Response
200 JwtResponse getJwt 200 response
initiatePasswordReset: (
data: InitiatePasswordResetRequest,
params?: RequestParams,
) => Promise<HttpResponse<object, any>>
No description

Name
InitiatePasswordReset

Request
POST:/account/initiatePasswordReset

Secure
Response
200 object initiatePasswordReset 200 response
login: (
data: LoginRequest,
params?: RequestParams,
) => Promise<HttpResponse<LoginResponse, any>>
No description

Name
Login

Request
POST:/account/login

Secure
Response
200 LoginResponse login 200 response
logout: (params?: RequestParams) => Promise<HttpResponse<object, any>>
No description

Name
Logout

Request
POST:/account/logout

Secure
Response
200 object logout 200 response
register: (
data: RegisterRequest,
params?: RequestParams,
) => Promise<HttpResponse<RegisterResponse, ValidationErrorResponse>>
No description

Name
Register

Request
POST:/account/register

Secure
Response
200 RegisterResponse Successful registration

Response
400 ValidationErrorResponse Validation error
resendVerificationCode: (params?: RequestParams) => Promise<HttpResponse<void, any>>
No description

Name
ResendVerificationCode

Request
POST:/account/resendVerificationCode

Secure
Response
200 void resendVerificationCode 200 response
verifyEmail: (
data: VerifyEmailRequest,
params?: RequestParams,
) => Promise<HttpResponse<VerifyEmailResponse, any>>
No description

Name
VerifyEmail

Request
POST:/account/verify

Secure
Response
200 VerifyEmailResponse verifyEmail 200 response

baseUrl

baseUrl: string = ""

healthz

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

Type Declaration

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

Name
HealthCheck

Request
GET:/healthz

Response
200 string healthCheck 200 response

readyz

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

Type Declaration

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

Name
ReadyCheck

Request
GET:/readyz

Response
200 string readyCheck 200 response

Methods

abortRequest

abortRequest(cancelToken: CancelToken): void
Parameters
- cancelToken: CancelToken
Returns void
Inherited from HttpClient.abortRequest
- Defined in packages/account-service-client/src/accountsvc.ts:287

`Protected`addArrayQueryParam

addArrayQueryParam(query: QueryParamsType, key: string): any
Parameters
- query: QueryParamsType
- key: string
Returns any
Inherited from HttpClient.addArrayQueryParam
- Defined in packages/account-service-client/src/accountsvc.ts:197

`Protected`addQueryParam

addQueryParam(query: QueryParamsType, key: string): string
Parameters
- query: QueryParamsType
- key: string
Returns string
Inherited from HttpClient.addQueryParam
- Defined in packages/account-service-client/src/accountsvc.ts:193

`Protected`addQueryParams

addQueryParams(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from HttpClient.addQueryParams
- Defined in packages/account-service-client/src/accountsvc.ts:216

`Protected`createAbortSignal

createAbortSignal(cancelToken: CancelToken): AbortSignal | undefined
Parameters
- cancelToken: CancelToken
Returns AbortSignal | undefined
Inherited from HttpClient.createAbortSignal
- Defined in packages/account-service-client/src/accountsvc.ts:271

`Protected`encodeQueryParam

encodeQueryParam(key: string, value: any): string
Parameters
- key: string
- value: any
Returns string
Inherited from HttpClient.encodeQueryParam
- Defined in packages/account-service-client/src/accountsvc.ts:188

`Protected`mergeRequestParams

mergeRequestParams(
params1: RequestParams,
params2?: RequestParams,
): RequestParams
Parameters
- params1: RequestParams
- Optionalparams2: RequestParams
Returns RequestParams
Inherited from HttpClient.mergeRequestParams
- Defined in packages/account-service-client/src/accountsvc.ts:255

request

request<T = any, E = any>(
__namedParameters: FullRequestParams,
): Promise<HttpResponse<T, E>>
Type Parameters
- T = any
- E = any
Parameters
- __namedParameters: FullRequestParams
Returns Promise<HttpResponse<T, E>>
Inherited from HttpClient.request
- Defined in packages/account-service-client/src/accountsvc.ts:296

setSecurityData

setSecurityData(data: SecurityDataType | null): void
Parameters
- data: SecurityDataType | null
Returns void
Inherited from HttpClient.setSecurityData
- Defined in packages/account-service-client/src/accountsvc.ts:184

`Protected`toQueryString

toQueryString(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from HttpClient.toQueryString
- Defined in packages/account-service-client/src/accountsvc.ts:202

Class AccountServiceClient<SecurityDataType>

Title

Version

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AccountServiceClient<SecurityDataType>

Properties

account

Type Declaration

accountInfo: (params?: RequestParams) => Promise<HttpResponse<AccountInfo, any>>

Name

Request

Secure

Response

changePassword: ( data: ChangePasswordRequest, params?: RequestParams,) => Promise<HttpResponse<ChangePasswordResponse, any>>

Name

Request

Secure

Response

currentAccount: (params?: RequestParams) => Promise<HttpResponse<AccountInfoResponse, any>>

Name

Request

Secure

Response

finalizePasswordReset: ( data: FinalizePasswordResetRequest, params?: RequestParams,) => Promise<HttpResponse<object, ValidationErrorResponse>>

Name

Request

Secure

Response

Response

getJwt: (params?: RequestParams) => Promise<HttpResponse<JwtResponse, any>>

Name

Request

Secure

Response

initiatePasswordReset: ( data: InitiatePasswordResetRequest, params?: RequestParams,) => Promise<HttpResponse<object, any>>

Name

Request

Secure

Response

login: ( data: LoginRequest, params?: RequestParams,) => Promise<HttpResponse<LoginResponse, any>>

Name

Request

Secure

Response

logout: (params?: RequestParams) => Promise<HttpResponse<object, any>>

Name

Request

Secure

Response

register: ( data: RegisterRequest, params?: RequestParams,) => Promise<HttpResponse<RegisterResponse, ValidationErrorResponse>>

Name

Request

Secure

Response

Response

resendVerificationCode: (params?: RequestParams) => Promise<HttpResponse<void, any>>

Name

Request

Secure

Response

verifyEmail: ( data: VerifyEmailRequest, params?: RequestParams,) => Promise<HttpResponse<VerifyEmailResponse, any>>

Name

Request

Secure

Response

baseUrl

healthz

Type Declaration

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

Name

Request

changePassword: (
data: ChangePasswordRequest,
params?: RequestParams,
) => Promise<HttpResponse<ChangePasswordResponse, any>>

finalizePasswordReset: (
data: FinalizePasswordResetRequest,
params?: RequestParams,
) => Promise<HttpResponse<object, ValidationErrorResponse>>

initiatePasswordReset: (
data: InitiatePasswordResetRequest,
params?: RequestParams,
) => Promise<HttpResponse<object, any>>

login: (
data: LoginRequest,
params?: RequestParams,
) => Promise<HttpResponse<LoginResponse, any>>

register: (
data: RegisterRequest,
params?: RequestParams,
) => Promise<HttpResponse<RegisterResponse, ValidationErrorResponse>>

verifyEmail: (
data: VerifyEmailRequest,
params?: RequestParams,
) => Promise<HttpResponse<VerifyEmailResponse, any>>

`Protected`addArrayQueryParam

`Protected`addQueryParam

`Protected`addQueryParams

`Protected`createAbortSignal

`Protected`encodeQueryParam

`Protected`mergeRequestParams

`Protected`toQueryString