Help for package docuSignr

Title: Connect to 'DocuSign' API

Version: 0.0.3

Description: Connect to the 'DocuSign' Rest API https://www.docusign.com/p/RESTAPIGuide/RESTAPIGuide.htm, which supports embedded signing, and sending of documents.

Depends: R (≥ 3.2.2)

License: GPL-3

Encoding: UTF-8

LazyData: true

Imports: httr, jsonlite, magrittr

RoxygenNote: 6.0.1

Suggests: testthat, covr, drat

URL: https://github.com/CannaData/docuSignr

BugReports: https://github.com/CannaData/docuSignr/issues

NeedsCompilation: no

Packaged: 2017年10月22日 02:03:25 UTC; carl

Author: Carl Ganz [aut, cre], CannaData Solutions [cph]

Maintainer: Carl Ganz <carl@cannadatasolutions.com>

Repository: CRAN

Date/Publication: 2017年10月22日 03:09:17 UTC

Create XML authentication string

Description

Create XML authentication string

Usage

docu_auth(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"))

Arguments

username

docuSign username

password

docuSign password

integrator_key

docusign integratorKey

Download Document from DocuSign

Description

Download Document from DocuSign

Usage

docu_download(file, username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"), base_url,
 envelope_id)

Arguments

file

a character string naming a file

username

docuSign username

password

docuSign password

integrator_key

docusign integratorKey

base_url

base_url

envelope_id

id of envelope

Examples

## Not run: 
login <- docu_login(demo = TRUE)
 envelopes <- docu_list_envelopes(base_url = login$baseUrl[1], from_date = "2017/1/1")
 envelope_id <- envelopes[envelopes$status == "completed","envelopeId"][1]
 file <- tempfile()
 document <- docu_download(file, base_url = login[1, 3], 
 envelope_id = envelope_id)
## End(Not run)

Embedded docuSign

Description

Get URL for embedded docuSign

Usage

docu_embedded_sign(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"), base_url,
 return_url, envelope_id, signer_name, signer_email, client_user_id,
 authentication_method = "None")
docu_embedded_send(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"), base_url,
 return_url, uri, signer_name, signer_email, client_user_id,
 authentication_method = "None")

Arguments

username

docuSign username

password

docuSign password

integrator_key

docusign integratorKey

base_url

docuSign baseURL

return_url

URL to return to after signing

envelope_id

ID for envelope returned from docu_envelope

signer_name

Name of person signing document

signer_email

Email of person signing document

client_user_id

ID for signer

authentication_method

Method application uses to authenticate user. Defaults to "None".

uri

uri path

Examples

## Not run: 
# assuming env variables are properly set up
login <- docu_login()
template <- docu_templates(base_url = login[1, "baseUrl"])
env <- docu_envelope(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"),
 account_id = login[1, "accountId"], base_url = login[1, "baseUrl"],
 template_id = template$templateId,
 template_roles = list(name = "Name", email = "email@example.com",
 roleName = "Role", clientUserId = "1"),
 email_subject = "Subject", email_blurb = "Body"
 )
URL <- docu_embed(
 base_url = login[1, "baseUrl"], return_url = "www.google.com",
 signer_name = "Name", signer_email = "email@example.com",
 client_user_id = "1",
 envelope_id = env$envelopeId
)
## End(Not run)

Create document for particular instance to be signed

Description

Does envelope stuff

Usage

docu_envelope(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"), account_id,
 status = "sent", base_url, template_id, template_roles, email_subject,
 email_blurb)

Arguments

username

docuSign username

password

docuSign password

integrator_key

docusign integratorKey

account_id

docuSign accountId

status

envelope status

base_url

docuSign baseURL

template_id

docuSign templateId

template_roles

list of parameters passed to template

email_subject

docuSign emailSubject

email_blurb

docuSign emailBlurb

Examples

## Not run: 
# assuming env variables are properly set up
login <- docu_login()
template <- docu_templates(base_url = login[1, "baseUrl"])
(env <- docu_envelope(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"),
 account_id = login[1, "accountId"], base_url = login[1, "baseUrl"],
 template_id = template$templateId,
 template_roles = list(name = "Name", email = "email@example.com",
 roleName = "Role", clientUserId = "1"),
 email_subject = "Subject", email_blurb = "Body"
 ))
 
## End(Not run)

Check status of envelope

Description

Check status of envelope

Usage

docu_envelope_status(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"), base_url,
 envelope_id)

Arguments

username

docuSign username

password

docuSign password

integrator_key

docusign integratorKey

base_url

base_url

envelope_id

id of envelope

Examples

## Not run: 
login <- docu_login(demo = TRUE)
 envelopes <- docu_list_envelopes(base_url = login$baseUrl[1], from_date = "2017/1/1")
 envelope_id <- envelopes[envelopes$status == "completed","envelopeId"][1]
 status <- docu_envelope_status(base_url = login[1, 3], 
 envelope_id = envelope_id)
## End(Not run)

Create header for docuSign

Description

Create header for authentication with docuSign

Usage

docu_header(auth)

Arguments

auth

XML object with authentication info

List envelopes since date

Description

List envelopes since date

Usage

docu_list_envelopes(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"), base_url, from_date)

Arguments

username

docuSign username

password

docuSign password

integrator_key

docusign integratorKey

base_url

base_url

from_date

character indicating begin date of search

Examples

## Not run: 
login <- docu_login(demo = TRUE)
envelopes <- docu_list_envelopes(base_url = login$baseUrl[1], from_date = "2017/1/1")
## End(Not run)

Authenticate DocuSign

Description

Usage

docu_login(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"), demo = FALSE)

Arguments

username

docuSign username

password

docuSign password

integrator_key

docusign integratorKey

demo

indicate whether to use DocuSign demo server

Examples

## Not run: 
# assuming env variables are properly set up
(login <- docu_login())
## End(Not run)

View templates

Description

See all templates associated with account

Usage

docu_templates(username = Sys.getenv("docuSign_username"),
 password = Sys.getenv("docuSign_password"),
 integrator_key = Sys.getenv("docuSign_integrator_key"), base_url)

Arguments

username

docuSign username

password

docuSign password

integrator_key

docusign integratorKey

base_url

docuSign baseURL

Examples

## Not run: 
login <- docu_login()
templates <- docu_templates(base_url = login[1, 3])
## End(Not run)

Process results from POST or GET

Description

Process results from POST or GET

Usage

parse_response(response)

Arguments

response

Result of POST or GET