signatures

Get the DocuSign connection status, or disconnect DocuSign.

Code
Args:
    action: "disconnect" to remove the connection; omit it to get the status.

Returns:
    The service's connection status and authorization link, or only `success` for a disconnect.

Code
Endpoint to retrieve and save settings on e-signature service

Parameters: ----------- GET method PATCH method: json_dict : dict { "data": { "type": str, "attributes": { "enabled_esignature_documents": [ { "document_parent_type": str, "document_type_id": str, "state_id": str, "effective_date_id": str, "policy_type_id": str }, ] } } } version : str, optional The meta.version of the configuration the caller edited. When given, the save is refused if the stored configuration has changed since. Without it the save is unconditional. Returns ------- success : bool True if successful, false if not error_code : str, optional esignature_config_invalid when the payload writes configuration without a policy type, esignature_config_stale when version is no longer the stored version. data : list The data response; a GET also carries the configuration version in meta.version: :: { "data": { "data": { "attributes": { "enabled_esignature_documents": [ { "policy_type_id": "275292e7-1572-4625-a767-a14bf74ae386", "document_parent_type": "Deliverable", "state_id": "339ff8b0-8c0e-11de-b1cc-000c2976c0ee", "document_type_id": "07d54bcc-dce1-4f39-a27b-9df9baee5a85", "effective_date_id": "6608d0f9-8e83-4e03-aff1-f7c680d4b84c" } ] }, "type": "config" }, "meta": {"version": "3f2a..."} }, "messages": [], "success": true }

Flushes all cached data used by the e-signature integration.

Code
Endpoint to return a signature or signatures that are related to a revision

Parameters:
 -----------
 GET method
 revision_id: the revision of the signature
 envelope_id: the id of an envelope

Returns:
 -----------
success : bool
    True if successful, false if not
data : list or Dict
    List of envelopes if revision_id provided
    Dictionary with envelope data if envelope_id provided

Code
Endpoint to retrieve individual signature statuses

Parameters:
 -----------
 GET method
 revision_id: the revision of the signature
 include_complete: bool, if we should return complete status.

Returns:
 -----------
success : bool
    True if successful, false if not
data : list
    List of each individual signer

Code
Endpoint to regenerate an envelope for e-signature

Code
Parameters
----------
envelope_id : str
    Id of the envelope
status : str
    Status of the signature
    One of the following
        sent
        viewed
        signed
        completed
        declined
        voided
        errored
signers: List of individual signers with states


Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : If successful a dict with the envelope_id, status, and revision_id associated with the signatures
and a list of updated individual signers

Voids a signature request envelope.