Class ApiSimple<T, D, Q, C>

Type Parameters

T = Payload
D = T
Q extends ApiSimpleQuery = ApiSimpleQuery
C extends ApiConfig = ApiConfig

Hierarchy (View Summary)

ApiBase<C>
- ApiSimple
  - ArchivistApi

Index

Constructors

constructor

new ApiSimple<
    T = Payload,
    D = T,
    Q extends PayloadFindFilter = PayloadFindFilter,
    C extends ApiConfig = ApiConfig,
>(
    config: C,
): ApiSimple<T, D, Q, C>
Type Parameters
- T = Payload
- D = T
- Q extends PayloadFindFilter = PayloadFindFilter
- C extends ApiConfig = ApiConfig
Parameters
- config: C
Returns ApiSimple<T, D, Q, C>
Inherited from ApiBase.constructor
- Defined in packages/sdk-utils/packages/api/src/Base.ts:18

Properties

`Protected`axios

axios: AxiosJson

`Readonly`config

config: C

Accessors

authenticated

get authenticated(): boolean
Returns boolean
Inherited from ApiBase.authenticated
- Defined in packages/sdk-utils/packages/api/src/Base.ts:23

`Protected`headers

get headers(): Record<string, string>
Returns Record<string, string>
Inherited from ApiBase.headers
- Defined in packages/sdk-utils/packages/api/src/Base.ts:27

`Protected`query

get query(): string
Returns string
Inherited from ApiBase.query
- Defined in packages/sdk-utils/packages/api/src/Base.ts:38

`Protected`root

get root(): string
Returns string
Inherited from ApiBase.root
- Defined in packages/sdk-utils/packages/api/src/Base.ts:42

Methods

delete

delete(): Promise<ApiResponseBody<T>>
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:12
delete(responseType?: "body"): Promise<ApiResponseBody<T>>
Parameters
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:13
delete(responseType?: "tuple"): Promise<ApiResponseTuple<T>>
Parameters
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:14

`Protected`deleteEndpoint

deleteEndpoint<T = unknown>(endPoint?: string): Promise<ApiResponseBody<T>>
Type Parameters
- T = unknown
Parameters
- OptionalendPoint: string
Returns Promise<ApiResponseBody<T>>
Inherited from ApiBase.deleteEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:70
deleteEndpoint<T = unknown>(
endPoint?: string,
responseType?: "body",
): Promise<ApiResponseBody<T>>
Type Parameters
- T = unknown
Parameters
- OptionalendPoint: string
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
Inherited from ApiBase.deleteEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:71
deleteEndpoint<T = unknown>(
endPoint?: string,
responseType?: "tuple",
): Promise<ApiResponseTuple<T>>
Type Parameters
- T = unknown
Parameters
- OptionalendPoint: string
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
Inherited from ApiBase.deleteEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:72

find

find(query?: Q): Promise<ApiResponseBody<T>>
Parameters
- Optionalquery: Q
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:26
find(query?: Q, responseType?: "body"): Promise<ApiResponseBody<T>>
Parameters
- Optionalquery: Q
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:27
find(query?: Q, responseType?: "tuple"): Promise<ApiResponseTuple<T>>
Parameters
- Optionalquery: Q
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:28

get

get(): Promise<ApiResponseBody<T>>
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:40
get(responseType?: "body"): Promise<ApiResponseBody<T>>
Parameters
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:41
get(responseType?: "tuple"): Promise<ApiResponseTuple<T>>
Parameters
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:42

`Protected`getEndpoint

getEndpoint<T = unknown>(endPoint?: string): Promise<ApiResponseBody<T>>
Type Parameters
- T = unknown
Parameters
- OptionalendPoint: string
Returns Promise<ApiResponseBody<T>>
Inherited from ApiBase.getEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:80
getEndpoint<T = unknown>(
endPoint?: string,
responseType?: "body",
): Promise<ApiResponseBody<T>>
Type Parameters
- T = unknown
Parameters
- OptionalendPoint: string
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
Inherited from ApiBase.getEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:81
getEndpoint<T = unknown>(
endPoint?: string,
responseType?: "tuple",
): Promise<ApiResponseTuple<T>>
Type Parameters
- T = unknown
Parameters
- OptionalendPoint: string
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
Inherited from ApiBase.getEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:82

`Protected`handleMonitorResponseError

handleMonitorResponseError<T>(
error: ApiError,
trapAxiosException: boolean,
): undefined | ApiResponse<ApiEnvelope<T>>
Type Parameters
- T
Parameters
- error: ApiError
- trapAxiosException: boolean
Returns undefined | ApiResponse<ApiEnvelope<T>>
Inherited from ApiBase.handleMonitorResponseError
- Defined in packages/sdk-utils/packages/api/src/Base.ts:90

`Protected`monitorResponse

monitorResponse<T>(
closure: () => Promise<ApiResponse<ApiEnvelope<T>>>,
): Promise<undefined | ApiResponse<ApiEnvelope<T>>>
Type Parameters
- T
Parameters
- closure: () => Promise<ApiResponse<ApiEnvelope<T>>>
Returns Promise<undefined | ApiResponse<ApiEnvelope<T>>>
Inherited from ApiBase.monitorResponse
- Defined in packages/sdk-utils/packages/api/src/Base.ts:105

onError

onError(error: ApiError, depth?: number): void
Parameters
- error: ApiError
- depth: number = 0
Returns void
Inherited from ApiBase.onError
- Defined in packages/sdk-utils/packages/api/src/Base.ts:55

onFailure

onFailure(response: ApiResponse, depth?: number): void
Parameters
- response: ApiResponse
- depth: number = 0
Returns void
Inherited from ApiBase.onFailure
- Defined in packages/sdk-utils/packages/api/src/Base.ts:60

onSuccess

onSuccess(response: ApiResponse, depth?: number): void
Parameters
- response: ApiResponse
- depth: number = 0
Returns void
Inherited from ApiBase.onSuccess
- Defined in packages/sdk-utils/packages/api/src/Base.ts:65

post

post(data?: D): Promise<ApiResponseBody<T>>
Parameters
- Optionaldata: D
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:54
post(data?: D, responseType?: "body"): Promise<ApiResponseBody<T>>
Parameters
- Optionaldata: D
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:55
post(data?: D, responseType?: "tuple"): Promise<ApiResponseTuple<T>>
Parameters
- Optionaldata: D
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:56

`Protected`postEndpoint

postEndpoint<T = unknown, D = unknown>(
endPoint?: string,
data?: D,
): Promise<ApiResponseBody<T>>
Type Parameters
- T = unknown
- D = unknown
Parameters
- OptionalendPoint: string
- Optionaldata: D
Returns Promise<ApiResponseBody<T>>
Inherited from ApiBase.postEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:122
postEndpoint<T = unknown, D = unknown>(
    endPoint?: string,
    data?: D,
    responseType?: "body",
): Promise<ApiResponseBody<T>>
Type Parameters
- T = unknown
- D = unknown
Parameters
- OptionalendPoint: string
- Optionaldata: D
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
Inherited from ApiBase.postEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:123
postEndpoint<T = unknown, D = unknown>(
    endPoint?: string,
    data?: D,
    responseType?: "tuple",
): Promise<ApiResponseTuple<T>>
Type Parameters
- T = unknown
- D = unknown
Parameters
- OptionalendPoint: string
- Optionaldata: D
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
Inherited from ApiBase.postEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:124

put

put(data?: D): Promise<ApiResponseBody<T>>
Parameters
- Optionaldata: D
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:68
put(data?: D, responseType?: "body"): Promise<ApiResponseBody<T>>
Parameters
- Optionaldata: D
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:69
put(data?: D, responseType?: "tuple"): Promise<ApiResponseTuple<T>>
Parameters
- Optionaldata: D
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
- Defined in packages/sdk-utils/packages/api/src/Simple.ts:70

`Protected`putEndpoint

putEndpoint<T = unknown, D = unknown>(
endPoint?: string,
data?: D,
): Promise<ApiResponseBody<T>>
Type Parameters
- T = unknown
- D = unknown
Parameters
- OptionalendPoint: string
- Optionaldata: D
Returns Promise<ApiResponseBody<T>>
Inherited from ApiBase.putEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:136
putEndpoint<T = unknown, D = unknown>(
    endPoint?: string,
    data?: D,
    responseType?: "body",
): Promise<ApiResponseBody<T>>
Type Parameters
- T = unknown
- D = unknown
Parameters
- OptionalendPoint: string
- Optionaldata: D
- OptionalresponseType: "body"
Returns Promise<ApiResponseBody<T>>
Inherited from ApiBase.putEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:137
putEndpoint<T = unknown, D = unknown>(
    endPoint?: string,
    data?: D,
    responseType?: "tuple",
): Promise<ApiResponseTuple<T>>
Type Parameters
- T = unknown
- D = unknown
Parameters
- OptionalendPoint: string
- Optionaldata: D
- OptionalresponseType: "tuple"
Returns Promise<ApiResponseTuple<T>>
Inherited from ApiBase.putEndpoint
- Defined in packages/sdk-utils/packages/api/src/Base.ts:138

Class ApiSimple<T, D, Q, C>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ApiSimple<T, D, Q, C>

Properties

Protectedaxios

Readonlyconfig

Accessors

authenticated

Returns boolean

Protectedheaders

Returns Record<string, string>

Protectedquery

Returns string

Protectedroot

Returns string

Methods

delete

Returns Promise<ApiResponseBody<T>>

Parameters

Returns Promise<ApiResponseBody<T>>

Parameters

Returns Promise<ApiResponseTuple<T>>

ProtecteddeleteEndpoint

Type Parameters

Parameters

Returns Promise<ApiResponseBody<T>>

Type Parameters

Parameters

Returns Promise<ApiResponseBody<T>>

Type Parameters

Parameters

Returns Promise<ApiResponseTuple<T>>

find

Parameters

Returns Promise<ApiResponseBody<T>>

Parameters

Returns Promise<ApiResponseBody<T>>

Parameters

Returns Promise<ApiResponseTuple<T>>

get

Returns Promise<ApiResponseBody<T>>

Parameters

Returns Promise<ApiResponseBody<T>>

Parameters

Returns Promise<ApiResponseTuple<T>>

ProtectedgetEndpoint

Type Parameters

Parameters

Returns Promise<ApiResponseBody<T>>

Type Parameters

Parameters

Returns Promise<ApiResponseBody<T>>

Type Parameters

Parameters

Returns Promise<ApiResponseTuple<T>>

ProtectedhandleMonitorResponseError

Type Parameters

Parameters

Returns undefined | ApiResponse<ApiEnvelope<T>>

ProtectedmonitorResponse

Type Parameters

Parameters

Returns Promise<undefined | ApiResponse<ApiEnvelope<T>>>

onError

Parameters

Returns void

onFailure

Parameters

Returns void

onSuccess

`Protected`axios

`Readonly`config

`Protected`headers

`Protected`query

`Protected`root

`Protected`deleteEndpoint

`Protected`getEndpoint

`Protected`handleMonitorResponseError

`Protected`monitorResponse

`Protected`postEndpoint

`Protected`putEndpoint