Class UserDataClient<SecurityDataType>

Title

xivgear-userdata-service

Version

0.0

Type Parameters

SecurityDataType extends unknown

Hierarchy (View Summary)

HttpClient<SecurityDataType>
- UserDataClient

Index

Constructors

constructor

new UserDataClient<SecurityDataType extends unknown>(
apiConfig?: ApiConfig<SecurityDataType>,
): UserDataClient<SecurityDataType>
Type Parameters
- SecurityDataType extends unknown
Parameters
- apiConfig: ApiConfig<SecurityDataType> = {}
Returns UserDataClient<SecurityDataType>
Inherited from HttpClient.constructor
- Defined in packages/user-data-client/src/userdata.ts:167

Properties

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

userdata

userdata: {
    deleteSheet: (
        sheetId: string,
        data: DeleteSheetRequest,
        params?: RequestParams,
    ) => Promise<HttpResponse<DeleteSheetResponse, any>>;
    getPrefs: (
        params?: RequestParams,
    ) => Promise<HttpResponse<GetPreferencesResponse, any>>;
    getSheet: (
        sheetId: string,
        params?: RequestParams,
    ) => Promise<HttpResponse<GetSheetResponse, any>>;
    getSheetsList: (
        params?: RequestParams,
    ) => Promise<HttpResponse<GetSheetsResponse, any>>;
    putPrefs: (
        data: PutPreferencesRequest,
        params?: RequestParams,
    ) => Promise<HttpResponse<void, any>>;
    putSheet: (
        sheetId: string,
        data: PutSheetRequest,
        params?: RequestParams,
    ) => Promise<HttpResponse<PutSheetResponse, any>>;
} = ...

Type Declaration

deleteSheet: (
    sheetId: string,
    data: DeleteSheetRequest,
    params?: RequestParams,
) => Promise<HttpResponse<DeleteSheetResponse, any>>
No description

Name
DeleteSheet

Request
DELETE:/userdata/sheets/{sheetId}

Secure
Response
200 DeleteSheetResponse deleteSheet 200 response
getPrefs: (params?: RequestParams) => Promise<HttpResponse<GetPreferencesResponse, any>>
No description

Name
GetPrefs

Request
GET:/userdata/preferences

Secure
Response
200 GetPreferencesResponse getPrefs 200 response
getSheet: (
sheetId: string,
params?: RequestParams,
) => Promise<HttpResponse<GetSheetResponse, any>>
No description

Name
GetSheet

Request
GET:/userdata/sheets/{sheetId}

Secure
Response
200 GetSheetResponse getSheet 200 response
getSheetsList: (params?: RequestParams) => Promise<HttpResponse<GetSheetsResponse, any>>
No description

Name
GetSheetsList

Request
GET:/userdata/sheets

Secure
Response
200 GetSheetsResponse getSheetsList 200 response
putPrefs: (
data: PutPreferencesRequest,
params?: RequestParams,
) => Promise<HttpResponse<void, any>>
No description

Name
PutPrefs

Request
PUT:/userdata/preferences

Secure
Response
200 void putPrefs 200 response
putSheet: (
    sheetId: string,
    data: PutSheetRequest,
    params?: RequestParams,
) => Promise<HttpResponse<PutSheetResponse, any>>
No description

Name
PutSheet

Request
PUT:/userdata/sheets/{sheetId}

Secure
Response
200 PutSheetResponse putSheet 200 response

Methods

abortRequest

abortRequest(cancelToken: CancelToken): void
Parameters
- cancelToken: CancelToken
Returns void
Inherited from HttpClient.abortRequest
- Defined in packages/user-data-client/src/userdata.ts:274

`Protected`addArrayQueryParam

addArrayQueryParam(query: QueryParamsType, key: string): any
Parameters
- query: QueryParamsType
- key: string
Returns any
Inherited from HttpClient.addArrayQueryParam
- Defined in packages/user-data-client/src/userdata.ts:184

`Protected`addQueryParam

addQueryParam(query: QueryParamsType, key: string): string
Parameters
- query: QueryParamsType
- key: string
Returns string
Inherited from HttpClient.addQueryParam
- Defined in packages/user-data-client/src/userdata.ts:180

`Protected`addQueryParams

addQueryParams(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from HttpClient.addQueryParams
- Defined in packages/user-data-client/src/userdata.ts:203

`Protected`createAbortSignal

createAbortSignal(cancelToken: CancelToken): AbortSignal | undefined
Parameters
- cancelToken: CancelToken
Returns AbortSignal | undefined
Inherited from HttpClient.createAbortSignal
- Defined in packages/user-data-client/src/userdata.ts:258

`Protected`encodeQueryParam

encodeQueryParam(key: string, value: any): string
Parameters
- key: string
- value: any
Returns string
Inherited from HttpClient.encodeQueryParam
- Defined in packages/user-data-client/src/userdata.ts:175

`Protected`mergeRequestParams

mergeRequestParams(
params1: RequestParams,
params2?: RequestParams,
): RequestParams
Parameters
- params1: RequestParams
- Optionalparams2: RequestParams
Returns RequestParams
Inherited from HttpClient.mergeRequestParams
- Defined in packages/user-data-client/src/userdata.ts:242

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/user-data-client/src/userdata.ts:283

setSecurityData

setSecurityData(data: SecurityDataType | null): void
Parameters
- data: SecurityDataType | null
Returns void
Inherited from HttpClient.setSecurityData
- Defined in packages/user-data-client/src/userdata.ts:171

`Protected`toQueryString

toQueryString(rawQuery?: QueryParamsType): string
Parameters
- OptionalrawQuery: QueryParamsType
Returns string
Inherited from HttpClient.toQueryString
- Defined in packages/user-data-client/src/userdata.ts:189

Class UserDataClient<SecurityDataType>

Title

Version

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UserDataClient<SecurityDataType>

Properties

baseUrl

healthz

Type Declaration

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

Name

Request

Response

readyz

Type Declaration

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

Name

Request

Response

userdata

Type Declaration

deleteSheet: ( sheetId: string, data: DeleteSheetRequest, params?: RequestParams,) => Promise<HttpResponse<DeleteSheetResponse, any>>

Name

Request

Secure

Response

getPrefs: (params?: RequestParams) => Promise<HttpResponse<GetPreferencesResponse, any>>

Name

Request

Secure

Response

getSheet: ( sheetId: string, params?: RequestParams,) => Promise<HttpResponse<GetSheetResponse, any>>

Name

Request

Secure

Response

getSheetsList: (params?: RequestParams) => Promise<HttpResponse<GetSheetsResponse, any>>

Name

Request

Secure

Response

putPrefs: ( data: PutPreferencesRequest, params?: RequestParams,) => Promise<HttpResponse<void, any>>

Name

Request

Secure

Response

putSheet: ( sheetId: string, data: PutSheetRequest, params?: RequestParams,) => Promise<HttpResponse<PutSheetResponse, any>>

Name

Request

Secure

Response

Methods

abortRequest

Parameters

Returns void

ProtectedaddArrayQueryParam

Parameters

Returns any

ProtectedaddQueryParam

Parameters

Returns string

ProtectedaddQueryParams

Parameters

Returns string

ProtectedcreateAbortSignal

Parameters

Returns AbortSignal | undefined

ProtectedencodeQueryParam

Parameters

Returns string

ProtectedmergeRequestParams

deleteSheet: (
sheetId: string,
data: DeleteSheetRequest,
params?: RequestParams,
) => Promise<HttpResponse<DeleteSheetResponse, any>>

getSheet: (
sheetId: string,
params?: RequestParams,
) => Promise<HttpResponse<GetSheetResponse, any>>

putPrefs: (
data: PutPreferencesRequest,
params?: RequestParams,
) => Promise<HttpResponse<void, any>>

putSheet: (
sheetId: string,
data: PutSheetRequest,
params?: RequestParams,
) => Promise<HttpResponse<PutSheetResponse, any>>

`Protected`addArrayQueryParam

`Protected`addQueryParam

`Protected`addQueryParams

`Protected`createAbortSignal

`Protected`encodeQueryParam

`Protected`mergeRequestParams

`Protected`toQueryString