Class: Boldsign::Resources::Document

Inherits:
Boldsign::Resource show all
Defined in:
lib/boldsign/resources/document.rb

Overview

Document endpoints (/v1/document/*) — the bulk of the BoldSign API: sending, listing, downloading, editing, reminding, authenticating, tagging, and embedded signing flows.

Examples:

Send a document

client.documents.send_document(
  title: "NDA",
  signers: [{ name: "Jane", emailAddress: "[email protected]", signerOrder: 1 }],
  files: [...]
)

See Also:

Instance Method Summary collapse

Methods inherited from Boldsign::Resource

#initialize

Constructor Details

This class inherits a constructor from Boldsign::Resource

Instance Method Details

#add_authentication(document_id, body) ⇒ Object 



46
 
# File 'lib/boldsign/resources/document.rb', line 46

def add_authentication(document_id, body);    @client.patch("/v1/document/addAuthentication", body: body, params: { documentId: document_id }); end

#add_tags(body) ⇒ Object 



42
 
# File 'lib/boldsign/resources/document.rb', line 42

def add_tags(body);    @client.patch("/v1/document/addTags", body: body); end

#behalf_list(**params) ⇒ Object 



18
 
# File 'lib/boldsign/resources/document.rb', line 18

def behalf_list(**params); @client.get("/v1/document/behalfList", params); end

#cancel_editing(document_id) ⇒ Object 



24
 
# File 'lib/boldsign/resources/document.rb', line 24

def cancel_editing(document_id); @client.post("/v1/document/cancelEditing", params: { documentId: document_id }); end

#change_access_code(document_id, body) ⇒ Object 



39
 
# File 'lib/boldsign/resources/document.rb', line 39

def change_access_code(document_id, body); @client.patch("/v1/document/changeAccessCode", body: body, params: { documentId: document_id }); end

#change_recipient(document_id, body) ⇒ Object 



40
 
# File 'lib/boldsign/resources/document.rb', line 40

def change_recipient(document_id, body);   @client.patch("/v1/document/changeRecipient", body: body, params: { documentId: document_id }); end

#create_embedded_edit_url(body) ⇒ Object 



27
 
# File 'lib/boldsign/resources/document.rb', line 27

def create_embedded_edit_url(body);    @client.post("/v1/document/createEmbeddedEditUrl", body: body); end

#create_embedded_request_url(body) ⇒ Object 



26
 
# File 'lib/boldsign/resources/document.rb', line 26

def create_embedded_request_url(body); @client.post("/v1/document/createEmbeddedRequestUrl", body: body); end

#delete(document_id) ⇒ Object 



36
 
# File 'lib/boldsign/resources/document.rb', line 36

def delete(document_id);            @client.delete("/v1/document/delete", documentId: document_id); end

#delete_tags(body) ⇒ Object 



43
 
# File 'lib/boldsign/resources/document.rb', line 43

def delete_tags(body); @client.delete("/v1/document/deleteTags", body: body); end

#download(document_id) ⇒ Object 



30
 
# File 'lib/boldsign/resources/document.rb', line 30

def download(document_id);   @client.download("/v1/document/download", documentId: document_id); end

#download_attachment(**params) ⇒ Object 



31
 
# File 'lib/boldsign/resources/document.rb', line 31

def download_attachment(**params); @client.download("/v1/document/downloadAttachment", params); end

#download_audit_log(document_id) ⇒ Object 



32
 
# File 'lib/boldsign/resources/document.rb', line 32

def download_audit_log(document_id); @client.download("/v1/document/downloadAuditLog", documentId: document_id); end

#draft_send(body) ⇒ Object 



22
 
# File 'lib/boldsign/resources/document.rb', line 22

def draft_send(body);     @client.post("/v1/document/draftSend", body: body); end

#edit(document_id, body) ⇒ Object 



23
 
# File 'lib/boldsign/resources/document.rb', line 23

def edit(document_id, body); @client.put("/v1/document/edit", body: body, params: { documentId: document_id }); end

#extend_expiry(document_id, body) ⇒ Object 



37
 
# File 'lib/boldsign/resources/document.rb', line 37

def extend_expiry(document_id, body); @client.patch("/v1/document/extendExpiry", body: body, params: { documentId: document_id }); end

#get_embedded_sign_link(**params) ⇒ Object 



28
 
# File 'lib/boldsign/resources/document.rb', line 28

def get_embedded_sign_link(**params);  @client.get("/v1/document/getEmbeddedSignLink", params); end

#list(**params) ⇒ Object 



16
 
# File 'lib/boldsign/resources/document.rb', line 16

def list(**params);       @client.get("/v1/document/list", params); end

#prefill_fields(document_id, body) ⇒ Object 



48
 
# File 'lib/boldsign/resources/document.rb', line 48

def prefill_fields(document_id, body); @client.patch("/v1/document/prefillFields", body: body, params: { documentId: document_id }); end

#properties(document_id) ⇒ Object 



19
 
# File 'lib/boldsign/resources/document.rb', line 19

def properties(document_id); @client.get("/v1/document/properties", documentId: document_id); end

#remind(document_id, body = {}) ⇒ Object 



35
 
# File 'lib/boldsign/resources/document.rb', line 35

def remind(document_id, body = {}); @client.post("/v1/document/remind", body: body, params: { documentId: document_id }); end

#remove_authentication(document_id, body) ⇒ Object 



45
 
# File 'lib/boldsign/resources/document.rb', line 45

def remove_authentication(document_id, body); @client.patch("/v1/document/RemoveAuthentication", body: body, params: { documentId: document_id }); end

#revoke(document_id, body = {}) ⇒ Object 



34
 
# File 'lib/boldsign/resources/document.rb', line 34

def revoke(document_id, body = {}); @client.post("/v1/document/revoke", body: body, params: { documentId: document_id }); end

#send_document(body) ⇒ Object 



21
 
# File 'lib/boldsign/resources/document.rb', line 21

def send_document(body);  @client.post("/v1/document/send", body: body); end

#team_list(**params) ⇒ Object 



17
 
# File 'lib/boldsign/resources/document.rb', line 17

def team_list(**params);  @client.get("/v1/document/teamlist", params); end