package
4.3.1+incompatible
Repository: https://github.com/nuts-foundation/nuts-node.git
Documentation: pkg.go.dev

# Functions

Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCreateAccessTokenRequestWithBody generates requests for CreateAccessToken with any type of body.
NewCreateJwtGrantRequest calls the generic CreateJwtGrant builder with application/json body.
NewCreateJwtGrantRequestWithBody generates requests for CreateJwtGrant with any type of body.
NewCreateSignSessionRequest calls the generic CreateSignSession builder with application/json body.
NewCreateSignSessionRequestWithBody generates requests for CreateSignSession with any type of body.
NewDrawUpContractRequest calls the generic DrawUpContract builder with application/json body.
NewDrawUpContractRequestWithBody generates requests for DrawUpContract with any type of body.
NewGetContractByTypeRequest generates requests for GetContractByType.
NewGetSignSessionStatusRequest generates requests for GetSignSessionStatus.
NewHTTPClient creates a new HTTPClient using the generated OAS client.
NewIntrospectAccessTokenRequestWithBody generates requests for IntrospectAccessToken with any type of body.
NewRequestAccessTokenRequest calls the generic RequestAccessToken builder with application/json body.
NewRequestAccessTokenRequestWithBody generates requests for RequestAccessToken with any type of body.
NewVerifyAccessTokenRequest generates requests for VerifyAccessToken.
NewVerifySignatureRequest calls the generic VerifySignature builder with application/json body.
NewVerifySignatureRequestWithBody generates requests for VerifySignature with any type of body.
ParseCreateAccessTokenResponse parses an HTTP response from a CreateAccessTokenWithResponse call.
ParseCreateJwtGrantResponse parses an HTTP response from a CreateJwtGrantWithResponse call.
ParseCreateSignSessionResponse parses an HTTP response from a CreateSignSessionWithResponse call.
ParseDrawUpContractResponse parses an HTTP response from a DrawUpContractWithResponse call.
ParseGetContractByTypeResponse parses an HTTP response from a GetContractByTypeWithResponse call.
ParseGetSignSessionStatusResponse parses an HTTP response from a GetSignSessionStatusWithResponse call.
ParseIntrospectAccessTokenResponse parses an HTTP response from a IntrospectAccessTokenWithResponse call.
ParseRequestAccessTokenResponse parses an HTTP response from a RequestAccessTokenWithResponse call.
ParseVerifyAccessTokenResponse parses an HTTP response from a VerifyAccessTokenWithResponse call.
ParseVerifySignatureResponse parses an HTTP response from a VerifySignatureWithResponse call.
RegisterHandlers adds each server route to the EchoRouter.
Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

Defines values for AccessTokenRequestFailedResponseError.
Defines values for AccessTokenRequestFailedResponseError.
Defines values for SignSessionRequestMeans.
Defines values for SignSessionRequestMeans.
Defines values for SignSessionResponseMeans.
Defines values for SignSessionResponseMeans.
Defines values for AccessTokenRequestFailedResponseError.

# Structs

Error response when access token request fails as described in rfc6749 section 5.2.
Successful response as described in rfc6749 section 5.1.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
Contract defines model for Contract.
ContractResponse defines model for ContractResponse.
ContractSigningRequest defines model for ContractSigningRequest.
Request as described in RFC7523 section 2.1.
No description provided by the author
Request for a JWT Grant.
No description provided by the author
No description provided by the author
DrawUpContractRequest defines model for DrawUpContractRequest.
No description provided by the author
GetContractByTypeParams defines parameters for GetContractByType.
No description provided by the author
No description provided by the author
HTTPClient holds the server address and other basic settings for the http client.
No description provided by the author
Response with a JWT Grant.
Request for a JWT Grant and use it as authorization grant to get the access token from the authorizer.
No description provided by the author
ServerInterfaceWrapper converts echo contexts to parameters.
SignatureVerificationRequest defines model for SignatureVerificationRequest.
Contains the signature verification result.
SignSessionRequest defines model for SignSessionRequest.
SignSessionResponse defines model for SignSessionResponse.
SignSessionStatusResponse defines model for SignSessionStatusResponse.
Token introspection request as described in RFC7662 section 2.1.
Token introspection response as described in RFC7662 section 2.2.
VerifyAccessTokenParams defines parameters for VerifyAccessToken.
No description provided by the author
No description provided by the author
Wrapper bridges the generated api types and http logic to the internal types and logic.

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration.
No description provided by the author
Doer performs HTTP requests.
No description provided by the author
ServerInterface represents all server handlers.

# Type aliases

AccessTokenRequestFailedResponseError defines model for AccessTokenRequestFailedResponse.Error.
ClientOption allows setting custom parameters during construction.
Language of the contract in all caps.
Type of which contract to sign.
Version of the contract.
CreateJwtGrantJSONBody defines parameters for CreateJwtGrant.
CreateJwtGrantJSONRequestBody defines body for CreateJwtGrant for application/json ContentType.
CreateSignSessionJSONBody defines parameters for CreateSignSession.
CreateSignSessionJSONRequestBody defines body for CreateSignSession for application/json ContentType.
DrawUpContractJSONBody defines parameters for DrawUpContract.
DrawUpContractJSONRequestBody defines body for DrawUpContract for application/json ContentType.
DID of the organization as registered in the Nuts registry.
RequestAccessTokenJSONBody defines parameters for RequestAccessToken.
RequestAccessTokenJSONRequestBody defines body for RequestAccessToken for application/json ContentType.
RequestEditorFn is the function signature for the RequestEditor callback function.
SignSessionRequestMeans defines model for SignSessionRequest.Means.
The means this session uses to sign.
VerifiableCredential is an alias to use from within the API.
VerifiablePresentation is an alias to use from within the API.
VerifySignatureJSONBody defines parameters for VerifySignature.
VerifySignatureJSONRequestBody defines body for VerifySignature for application/json ContentType.