DocuSign.OAuth (DocuSign v0.3.3) View Source

This module implements an oauth2 strategy for DocuSign.

Examples

client = DocuSign.OAuth2Strategy.get_token! {:ok, user_info } = OAuth2.Client.get(client, "/oauth/userinfo")

Link to this section Summary

Functions

Create new API client

Retrieve access token and return a client

Retrieve a new time to auto refresh token.

Check expiration of token return true if token is expired

Link to this section Types

Specs

headers() :: [{binary(), binary()}]

Specs

param() :: binary() | %{required(binary()) => param()} | [param()]

Specs

params() :: %{required(binary()) => param()} | Keyword.t()

Link to this section Functions

Specs

assertion() :: binary() | no_return()
Link to this function

authorize_url(client, params)

View Source

Callback implementation for OAuth2.Strategy.authorize_url/2.

Specs

client(Keyword.t()) :: OAuth2.Client.t()

Create new API client

Link to this function

get_token(client, params, headers)

View Source

Specs

get_token(OAuth2.Client.t(), Keyword.t(), Keyword.t()) :: binary() | no_return()

Callback implementation for OAuth2.Strategy.get_token/3.

Link to this function

get_token!(client, params \\ [], headers \\ [], opts \\ [])

View Source

Specs

get_token!(OAuth2.Client.t(), params(), headers(), Keyword.t()) ::
  OAuth2.Client.t() | OAuth2.Error.t()

Retrieve access token and return a client

Link to this function

interval_refresh_token(client)

View Source

Specs

interval_refresh_token(OAuth2.Client.t()) :: integer()

Retrieve a new time to auto refresh token.

Link to this function

refresh_token!(client, force \\ false)

View Source

Specs

refresh_token!(OAuth2.Client.t(), boolean()) :: OAuth2.Client.t()

Refresh token

Specs

token_expired?(OAuth2.AccessToken.t() | nil | OAuth2.Client.t()) :: boolean()

Check expiration of token return true if token is expired