View Source Hellosign (hellosign_ex v0.1.5)

Provides API wrappers for Hellosign API See https://developers.hellosign.com/api/quickstart for further info on REST endpoints

Summary

Functions

Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.

Retrieves the requeted file against the provided signature request id.

Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.

Callback implementation for Application.start/2.

Functions

Link to this function

create_embedded(params, config \\ %Config{})

View Source
@spec create_embedded(Hellosign.Embedded.create_request(), Hellosign.Config.t()) ::
  {:ok, Hellosign.Embedded.create_response()} | {:error, map()}

Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.

See: https://developers.hellosign.com/api/reference/operation/signatureRequestCreateEmbedded/

Example request

    Hellosign.Embedded.create_request()

Example response

    Hellosign.Embedded.create_response()
Link to this function

download_file(type, signature_request_id, params, config \\ %Config{})

View Source

Retrieves the requeted file against the provided signature request id.

See when type is set to,

default: https://developers.hellosign.com/api/reference/operation/signatureRequestFiles/
data_uri: https://developers.hellosign.com/api/reference/operation/signatureRequestFilesAsDataUri/
file_url: https://developers.hellosign.com/api/reference/operation/signatureRequestFilesAsFileUrl/
Link to this function

get_embedded_sign_url(signature_id, config \\ %Config{})

View Source
@spec get_embedded_sign_url(
  Hellosign.Embedded.get_sign_url_request(),
  Hellosign.Config.t()
) ::
  {:ok, Hellosign.Embedded.get_sign_url_response()} | {:error, map()}

Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.

See: https://developers.hellosign.com/api/reference/operation/embeddedSignUrl/

Example request

    Hellosign.Embedded.get_sign_url_request()

Example response

    Hellosign.Embedded.get_sign_url_response()

Callback implementation for Application.start/2.