ApiEndpoint
Defined in: wp-typia-api-client/src/client.ts:85
Contract definition for one generated endpoint.
Remarks
Section titled “Remarks”Endpoints combine request/response validators with enough metadata to build the final transport request in a transport-neutral way.
Type Parameters
Section titled “Type Parameters”Req
Res
Properties
Section titled “Properties”authIntent?
Section titled “authIntent?”
optionalauthIntent?:EndpointAuthIntent
Defined in: wp-typia-api-client/src/client.ts:86
authMode?
Section titled “authMode?”
optionalauthMode?:string
Defined in: wp-typia-api-client/src/client.ts:87
buildRequestOptions?
Section titled “buildRequestOptions?”
optionalbuildRequestOptions?: (request) =>Partial<EndpointTransportRequest>
Defined in: wp-typia-api-client/src/client.ts:88
Parameters
Section titled “Parameters”request
Section titled “request”Req
Returns
Section titled “Returns”Partial<EndpointTransportRequest>
method
Section titled “method”method:
EndpointMethod
Defined in: wp-typia-api-client/src/client.ts:89
operationId?
Section titled “operationId?”
optionaloperationId?:string
Defined in: wp-typia-api-client/src/client.ts:90
path:
string
Defined in: wp-typia-api-client/src/client.ts:91
requestLocation?
Section titled “requestLocation?”
optionalrequestLocation?:"query"|"body"|"query-and-body"
Defined in: wp-typia-api-client/src/client.ts:92
validateRequest
Section titled “validateRequest”validateRequest: (
input) =>ValidationResult<Req>
Defined in: wp-typia-api-client/src/client.ts:93
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”ValidationResult<Req>
validateResponse
Section titled “validateResponse”validateResponse: (
input) =>ValidationResult<Res>
Defined in: wp-typia-api-client/src/client.ts:94
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”ValidationResult<Res>