addExtraDoc
Add an attachment (extra document)
Overview
Parameters:
Retorno:
ExtraDocResponse - In case of success
Exception - In case of failure
To create this document we will need:
set your apiToken;
original document`s token;
build the extra document;
call the method.
How to use:
Save your apiToken:
const apiToken: string = "YOUR TOKEN";
Save your original document`s token:
const docToken: string = "ORIGINAL DOCUMENT TOKEN";
Build your extra doc with the ExtraDoc class:
const extraDoc: ExtraDocBuilder = ExtraDocBuilder()
.withName("Extra Doc Name")
.withUrlPdf("https://zapsign.s3.amazonaws.com/2022/1/pdf/63d19807-cbfa-4b51-8571-215ad0f4eb98/ca42e7be-c932-482c-b70b-92ad7aea04be.pdf")
.build();
Finally, call the addExtraDoc method to get the ExtraDocResponse or an error message:
async function exempleAddExtraDoc() {
try {
docResponse: DocResponse = await new DocRequests(apiToken).addExtraDoc(docToken, extraDoc);
jsonDocResponse: string = new JsonConverter().extraDocToJson(docResponse);
console.log(jsonDocResponse);
} catch(Err) {
console.log(Err);
}
}
}
Example:
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { ExtraDocBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/ExtraDocBuilder";
const apiToken: string = "YOUR TOKEN";
const docToken: string = "DOCUMENT ORIGINAL TOKEN";
const extraDoc: ExtraDocBuilder = ExtraDocBuilder()
.withName("Extra Doc Name")
.withUrlPdf("https://zapsign.s3.amazonaws.com/2022/1/pdf/63d19807-cbfa-4b51-8571-215ad0f4eb98/ca42e7be-c932-482c-b70b-92ad7aea04be.pdf")
.build();
async function exempleAddExtraDoc() {
try {
docResponse: DocResponse = await new DocRequests(apiToken).addExtraDoc(docToken, extraDoc);
jsonDocResponse: string = new JsonConverter().extraDocToJson(docResponse);
console.log(jsonDocResponse);
} catch(Err) {
console.log(Err);
}
}
Was this helpful?