# Functions
No description provided by the author
No description provided by the author
ContextWithToken returns a copy of the parent with the access token stored as a value on the new context.
CredsFromContext returns the Credentials from the provided context along with a boolean describing if credentials were available on the specified context.
Construct a new response for an error or simply return unsuccessful.
ErrorStatus returns the HTTP status code from an error or 500 if the error is not a StatusError.
No description provided by the author
No description provided by the author
New creates a new API v1 client that implements the Quarterdeck Client interface.
NotAllowed returns a JSON 405 response for the API.
NotFound returns a JSON 404 response for the API.
No description provided by the author
No description provided by the author
Unverified returns a JSON 403 response indicating that the user has not verified their email address.
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIv1 implements the QuarterdeckClient interface.
FieldError provides a general mechanism for specifying errors with specific API object fields such as missing required field or invalid field and giving some feedback about which fields are the problem.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PageQuery manages paginated list requests.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Reply contains standard fields that are used for generic API responses and errors.
No description provided by the author
No description provided by the author
StatusError decodes an error response from Quarterdeck.
Returned on status requests.
No description provided by the author
No description provided by the author
No description provided by the author
UserInvitePreview contains user-facing information about an invite but not any internal details such as IDs.
UserInviteReply contains detailed information that corresponds to a newly issued invite token.
NOTE: Users can only invite someone to the organization they are currently logged into.
UserInviteToken contains a token that is used to accept an invite.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
Credentials provides a basic interface for loading an access token from Quarterdeck into the Quarterdeck API client.
No description provided by the author
A Reauthenticator generates new access and refresh pair given a valid refresh token.
# Type aliases
ClientOption allows us to configure the APIv1 client when it is created.
A Token is just the JWT base64 encoded token string that is obtained from Quarterdeck either using the authtest server or from a login with the client.