Getter of the driver's code field name.
Getter of the driver's data field name.
Getter that determines whether this driver uses seconds (rather than milliseconds) to express a timestamp in UTC format.
Method to execute a request calling the driver's provider API.
The access token attached as a Bearer token to the request.
The endpoint URI of the driver's provider API.
(Optional) The HTTP method used for the request, e.g. "GET". Defaults to "GET".
(Optional) The body of the request, as used with "POST" or "PUT" requests. Defaults to an empty object.
(Optional) An options object that is directly passed to axios before request execution. Defaults to an empty object.
A promise containing the response and status in ResponseStatusDTO.
Method to return the access token from the driver's provider.
The required code field value.
The required data field value.
A promise containing the result AccessTokenDTO.
Method to return the authorize url of this driver's provider.
The data field value to include in this query.
The full authorize url to send request to.
Method to transform an entity as described by the data provider
API. Typically, this method is used to handle the transformation
of remote objects (from data provider API) to internal objects in
the backend runtime's database.
e.g. This method is used to transform activity data as defined
by the Strava API, into ActivityData as defined internally.
The API Response object that will be transformed.
The type of entity as described in OAuthEntityType.
A parsed entity object.
Method to return an updated access token from the driver's provider using a refresh token.
The user's refresh token.
A promise containing the result AccessTokenDTO.
Generated using TypeDoc
OAuthDriver
This interface defines the fields and methods of an OAuth driver which determines communication, transport and process that are used to connect and integrate to custom providers.
v0.3.0