DocuSign.Connection (DocuSign v2.1.0)

View Source

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

Functions

Create new conn for provided user ID.

Makes a request.

Types

oauth_error()

@type oauth_error() :: OAuth2.Response.t() | OAuth2.Error.t()

t()

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

Functions

get(user_id)

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

Create new conn for provided user ID.

request(conn, opts \\ [])

@spec request(t(), Keyword.t()) :: {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}

Makes a request.