View Source DocuSign.Connection (DocuSign v1.2.0)

The module is intended to be used to establish a connection with DocuSign eSignature API and then perform requests to it.

Example 

iex> user_id = "74830914-547328-5432-5432543"
iex> account_id = "61ac4bd1-c83c-4aa6-8654-ddf3tg5"
iex> {:ok, conn} = DocuSign.Connection.get(user_id)
iex> {:ok, users} = DocuSign.Api.Users.users_get_users(conn, account_id)
{:ok, %DocuSign.Model.UserInformationList{...}}

Summary

Types

oauth_error()
t()

Functions

default_account() deprecated

Retrieves the default account of default user configured

get(user_id)

Create new conn for provided user ID.

new() deprecated

Create new conn for default configured user ID

request(conn, opts \\ [])

Makes a request.

Types

Link to this type

oauth_error()

View Source 
@type oauth_error() :: OAuth2.Response.t() | OAuth2.Error.t()
Link to this type

t()

View Source 
@type t() :: %DocuSign.Connection{app_account: term(), client: term()}

Functions

Link to this function

default_account()

View Source
This function is deprecated. Please use `Docusign.Connection.get/1`. The returned structs includes `app_account`, which is the default account. . 
@spec default_account() :: DocuSign.User.AppAccount.t()

Retrieves the default account of default user configured

Link to this function

get(user_id)

View Source 
@spec get(String.t()) :: {:ok, t()} | {:error, oauth_error()}

Create new conn for provided user ID.

Link to this function

new()

View Source
This function is deprecated. Use DocuSign.Connection.get/1 instead.. 
@spec new() :: t()

Create new conn for default configured user ID

Link to this function

request(conn, opts \\ [])

View Source 
@spec request(t(), Keyword.t()) :: %OAuth2.Response{
  body: term(),
  headers: term(),
  status_code: term()
}

Makes a request.