ZapSign API

https://docs.zapsign.com.br
Admin
ZapSign é uma plataforma de assinatura eletrônica de documentos que cumpre os requisitos legais para...
Tokens:119,291
Snippets:841
Trust Score:8.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Complete Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-documentos/createdocfromuploadasync

A full implementation example including imports and all setup steps.

```typescript
import { Signer } from "sdk-node-typescript-zapsign/src/body/signer/Signer";
import { SignerBuilder } from 'sdk-node-typescript-zapsign/src/body/signer/builders/SignerBuilder';
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { DocFromPdfBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/DocFromPdfBuilder";
const signer1: Signer = new SignerBuilder()
                .withName("My First Signer")
                .build();

const signer2: Signer = new SignerBuilder()
                .withName("My Second Signer")
                .withEmail("test@test.com")
                .withLockEmail(true)
                .withLockPhone(true)
                .withPhoneCountry("55")
                .withPhoneNumber("99999999999")
                .withAuthMode("assinaturaTela")
                .withSendAutomaticEmail(false)
                .withSendAutomaticWhatsapp(false)
                .build();
                
let signers: Signer[] = [];
                
signers.push(signer1, signer2);

const docFromPdf: DocFromPdf = new DocFromPdfBuilder()
                                .withSandbox(false)
                                .withName("My Contract")
                                .withPrimaryColor("#000000")
                                .withLang("pt-br")
                                .withSigners(signers)
                                .withUrlPdf("https://zapsign.s3.amazonaws.com/2022/1/pdf/63d19807-cbfa-4b51-8571-215ad0f4eb98/ca42e7be-c932-482c-b70b-92ad7aea04be.pdf")
                                .build();
                                
async function exempleCreateDocFromUploadAsync() {
    try {
        docResponse: DocResponse = await new DocRequests(apiToken).createDocFromUploadAsync(docFromPdf);
        jsonDocResponse: string = new JsonConverter().docAsyncResponseToJson(docResponse);
        console.log(jsonDocResponse);
    } catch(Err) {
        console.log(Err);
    }
}
```

--------------------------------

### Complete Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-documentos/createdocfrompdfbase64.md

A full implementation example combining all steps into a single class.

```java
import body.doc.DocFromPdfBase64;
import body.signer.Signer;
import docs.DocRequests;
import response.DocResponse;
import services.JsonConverter;

import java.io.IOException;
import java.util.ArrayList;
public class CreateDocFromBase64Pdf {
    public static void main(String[] args) throws IOException, InterruptedException  {
        String apiToken = "SEU TOKEN";
        String base64 = "JVBERi0xLjYKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTG..."

                Signer signer1 = Signer.builder()
                .name("My First Signer")
                .build();

        Signer signer2 = Signer.builder()
                .name("My Second Signer")
                .email("test@test.com")
                .lock_email(true)
                .lock_phone(true)
                .phone_country("55")
                .phone_number("99999999999")
                .auth_mode("assinaturaTela")
                .send_automatic_email(false)
                .send_automatic_whatsapp(false)
                .build();

        ArrayList<Signer> signers = new ArrayList<>();
        signers.add(signer1);
        signers.add(signer2);

        DocFromPdfBase64 docFromPdfBase64 = DocFromPdfBase64.docFromPdfBase64Builder()
                .sandbox(false)
                .name("My Contract")
                .brand_primary_color("#000000")
                .lang("pt-br")
                .signers(signers)
                .base64_pdf(base64)
                .build();


        try {
            DocResponse docResponse = new DocRequests(apiToken).createDocFromPdfBase64(docFromPdfBase64);
            String jsonDocResponse = new JsonConverter().docResponseToJson(docResponse);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-documentos/createdocfromuploadasync.md

A full implementation example demonstrating the entire document creation workflow.

```java
import body.doc.DocFromPdf;
import body.signer.Signer;
import docs.DocRequests;
import response.DocAsyncResponse;
import services.JsonConverter;

import java.util.ArrayList;

public class CreateDocFromUploadAsync {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";

        Signer signer1 = Signer.builder()
                .name("My First Signer")
                .build();

        Signer signer2 = Signer.builder()
                .name("My Second Signer")
                .email("test@test.com")
                .lock_email(true)
                .lock_phone(true)
                .phone_country("55")
                .phone_number("99999999999")
                .auth_mode("assinaturaTela")
                .send_automatic_email(false)
                .send_automatic_whatsapp(false)
                .build();

        ArrayList<Signer> signers = new ArrayList<>();
        signers.add(signer1);
        signers.add(signer2);

        DocFromPdf docFromPdf = DocFromPdf.docFromPdfBuilder()
                .sandbox(false)
                .name("My Contract")
                .brand_primary_color("#000000")
                .lang("pt-br")
                .signers(signers)
                .url_pdf("https://zapsign.s3.amazonaws.com/2022/1/pdf/63d19807-cbfa-4b51-8571-215ad0f4eb98/ca42e7be-c932-482c-b70b-92ad7aea04be.pdf")
                .build();

        try {
            DocAsyncResponse docAsyncResponse = new DocRequests(apiToken).createDocFromUploadAsync(docFromPdf);
            String jsonDocResponse = new JsonConverter().docAsyncResponseToJson(docAsyncResponse);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-documentos/createdocfromuploadpdf

A full implementation example including imports and the complete workflow.

```typescript
import { SignerBuilder } from 'sdk-node-typescript-zapsign/src/body/signer/builders/SignerBuilder';
import { Signer } from "sdk-node-typescript-zapsign/src/body/signer/Signer";
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { DocFromPdfBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/DocFromPdfBuilder";

apiToken: string = "SEU TOKEN";

signer1: Signer = new SignerBuilder()
                .withName("My First Signer")
                .build();

signer2: Signer = new SignerBuilder()
                .withName("My Second Signer")
                .withEmail("test@test.com")
                .withLockEmail(true)
                .withLockPhone(true)
                .withPhoneCountry("55")
                .withPhoneNumber("99999999999")
                .withAuthMode("assinaturaTela")
                .withSendAutomaticEmail(false)
                .withSendAutomaticWhatsapp(false)
                .build();
                
let signers: Signer[] = [];
                
signers.push(signer1, signer2);

const docFromPdf: DocFromPdf = new DocFromPdfBuilder()
                                .withSandbox(false)
                                .withName("My Contract")
                                .withBrandLogo("#000000")
                                .withLang("pt-br")
                                .withSigners(signers)
                                .withUrlPdf("https://zapsign.s3.amazonaws.com/2022/1/pdf/63d19807-cbfa-4b51-8571-215ad0f4eb98/ca42e7be-c932-482c-b70b-92ad7aea04be.pdf")
                                .build();
                                
async function exempleCreateDocFromUploadPdf() {
    try {
        docResponse: DocResponse = await new DocRequests(apiToken).createDocFromUploadPdf(docFromPdf);
        jsonDocResponse: string = new JsonConverter().docResponseToJson(docResponse);
        console.log(jsonDocResponse);
    } catch(Err) {
        console.log(Err);
    }
}
```

--------------------------------

### Complete Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-documentos/createdocfromtemplateasync.md

A full implementation example of the createDocFromTemplateAsync workflow.

```java
import body.doc.DeParaTemplate;
import body.doc.DocFromTemplate;
import docs.DocRequests;
import response.DocResponse;
import services.JsonConverter;

import java.util.ArrayList;

public class CreateDocFromTemplate {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";

        DeParaTemplate deParaTemplateName = DeParaTemplate.deParaTemplateBuilder()
                .de("{{NOME COMPLETO}}")
                .para("Full Name")
                .build();

        DeParaTemplate deParaTemplateCpf= DeParaTemplate.deParaTemplateBuilder()
                .de("{{NÚMERO DO CPF}}")
                .para("Social Security Number")
                .build();

        DeParaTemplate deParaTemplateEnd = DeParaTemplate.deParaTemplateBuilder()
                .de("{{ENDEREÇO COMPLETO}}")
                .para("Full address")
                .build();

        ArrayList<DeParaTemplate> deParaTemplates = new ArrayList<>();
        deParaTemplates.add(deParaTemplateName);
        deParaTemplates.add(deParaTemplateCpf);
        deParaTemplates.add(deParaTemplateEnd);

        DocFromTemplate docFromTemplate = DocFromTemplate.docFromTemplateBuilder()
                .sandbox(false)
                .brand_primary_color("#000000")
                .lang("pt-br")
                .signer_name("My Signer for template")
                .template_id("75a3a92b-36d5-451f-95cd-5af9a927a392")
                .data(deParaTemplates)
                .build();

        try {
            DocAsyncResponse docAsyncResponse = new DocRequests(apiToken).createDocFromTemplateAsync(docFromTemplate);
            String jsonDocResponse = new JsonConverter().docAsyncResponseToJson(docAsyncResponse);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete UpdateSigner Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-signatarios/updatesigner.md

A full implementation example demonstrating the entire update process.

```java
import body.signer.Signer;
import services.JsonConverter;
import signers.SignerRequest;

public class UpdateSigner {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";
        String signerToken= "TOKEN DO SIGNATÁRIO";

        Signer signer = Signer.builder()
                .name("New Name")
                .email("newEmail@test.com")
                .lock_email(true)
                .lock_phone(true)
                .phone_country("55")
                .phone_number("99999999999")
                .auth_mode("assinaturaTela")
                .send_automatic_email(false)
                .send_automatic_whatsapp(false)
                .build();

        try {
            Signer signerResponse = new SignerRequest(apiToken).updateSigner(signerToken, signer);
            String jsonDocResponse = new JsonConverter().signerToJson(signerResponse);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-documentos/createdocfrompdfbase64

A full implementation example showing imports, configuration, and the asynchronous request execution.

```typescript
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";

const apiToken: string = "SEU TOKEN";

const base64: string = "JVBERi0xLjYKJcOkw7zDtsOfCjIgMCBvYmoKP...";

const signer1: Signer = new SignerBuilder()
                .withName("My First Signer")
                .build();

const signer2: Signer = new SignerBuilder()
                .withName("My Second Signer")
                .withEmail("test@test.com")
                .withLockEmail(true)
                .withLockPhone(true)
                .withPhoneCountry("55")
                .withPhoneNumber("99999999999")
                .withAuthMode("assinaturaTela")
                .withSendAutomaticEmail(false)
                .withSendAutomaticWhatsapp(false)
                .build();
                
let signers: Signer[] = [];
                
signers.push(signer1, signer2);

const docFromPdfBase64 = DocFromPdfBase64Builder()
    .withSandbox(false)
    .withName("My Contract")
    .withBrandPrimaryColor("#000000")
    .build();

async function exempleDocFRomPdfBase64() {
    try {
                docResponse: DocResponse = await new DocRequests(apiToken).createDocFromPdfBase64(docFromPdfBase64);
                jsonDocResponse: string = new JsonConverter().docResponseToJson(docResponse);
                console.log(jsonDocResponse);
    } catch(Err) {
                console.log(Err);
    }
  }
}
```

--------------------------------

### Complete SignInBatch Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-signatarios/signinbatch.md

A full implementation example for the signInBatch operation.

```java
import body.signer.SignBatch;
import signers.SignerRequest;

import java.util.ArrayList;

public class SignInBatch {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";
        String userToken = "TOKEN USUÁRIO";
        String signer_token1 = "TOKEN DO SIGNATÁRIO 1";
        String signer_token2 = "TOKEN DO SIGNATÁRIO 2";

        ArrayList<String> signers_token = new ArrayList<>();
        signers_token.add(signer_token1);
        signers_token.add(signer_token2);

        SignBatch signBatch = SignBatch.builder()
                .user_token(userToken)
                .signer_tokens(signers_token)
                .build();

        try {
            String response = new SignerRequest(apiToken).signInBatch(signBatch);
            System.out.println(response);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete SignInBatch Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-signatarios/signinbatch

A full implementation example including imports, configuration, and execution.

```typescript
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { SignBatchBuilder } from "sdk-node-typescript-zapsign/src/body/signer/builders/SignBatchBuilder";

const apiToken: string = "SEU TOKEN";
const userToken: string = "TOKEN USUÁRIO";

const signerToken1: string = "TOKEN DO SIGNATÁRIO 1";
const signerToken2: string = "TOKEN DO SIGNATÁRIO 2";

let signersToken: string[]  = [];
signersToken.push(signerToken1, signerToken2);

const signBatch = SignBatchBuilder()
                .withUserToken(userToken)
                .withSignerTokens(signersToken)
                .build();
                
async function exempleSignInBatch() {
    try {
        signerResponse: string = new SignerRequest(apiToken).signInBatch(signBatch);
        jsonDocResponse: string = new JsonConverter().signerToJson(signerResponse);
        console.log(jsonDocResponse);
    }
    catch(Err) {
        console.log(Err);
    }   
}
```

--------------------------------

### Complete Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-documentos/createdocfromtemplate

A full implementation example combining all steps for creating a document from a template.

```typescript
import { DeParaTemplateBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/DeParaTemplateBuilder";
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { DocFromTemplate } from "sdk-node-typescript-zapsign/src/body/doc/builders/DocFromTemplate";

const apiToken: string = "SEU TOKEN";

const deParaTemplateName: DeParaTemplateBuilder = deParaTemplateBuilder()
        .de("{{NOME COMPLETO}}")
        .para("{{Full Name}}")
        .build();
        
const deParaTemplateCpf: DeParaTemplateBuilder = deParaTemplateBuilder()
        .de("{{NÚMERO DO CPF}}")
        .para("{{Social Security Number}}")
        .build();
        
const deParaTemplateEndereco: DeParaTemplateBuilder = deParaTemplateBuilder()
        .de("{{ENDEREÇO COMPLETO}}")
        .para("{{Full address}}")
        .build();
        
let deParaTemplates: DeParaTemplatesBuilder[] = [];

deParaTemplates.push(deParaTemplateName, deParaTemplateCpf, deParaTemplateEndereco);

const docFromTemplate: DocFomTemplateBuilder = new DocFromTemplateBuilder()
        .withSandbox(false)
        .withPrimaryColor("#000000")
        .withSignerName("My Signer for Template")
        .withTemplateId("SEU TEMPLATE ID")
        .withData(deParaTemplates)
        .build();

async function exempleCreateDocFromTemplate() {
        try {
                docResponse: DocResponse = await new DocRequests(apiToken).createDocFromTemplate(docFromTemplate);
                jsonDocResponse: string = new JsonConverter().docAsyncResponseToJson(docResponse);
                console.log(jsonDocResponse);
            } catch(Err) {
                console.log(Err);
            }
}
```

--------------------------------

### Complete getDocs Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-documentos/getdocs.md

A full implementation example showing the class structure and method usage.

```java
import docs.DocRequests;
import response.DocsResponse;
import services.JsonConverter;

public class GetDocs {
    public static void main(String[] args) throws Exception {
    String apiToken = "SEU TOKEN";

        try {
            DocsResponse docsResponse = new DocRequests(apiToken).getDocs();

            String jsonDocResponse = new JsonConverter().docsResponseToJson(docsResponse);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete placeSignatures example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-documentos/placesignatures.md

A full implementation example demonstrating the entire flow from imports to method execution.

```java
import body.doc.Rubrica;
import body.doc.RubricaList;
import docs.DocRequests;

import java.util.ArrayList;

public class PlaceSignatures {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";

        String docToken = "TOKEN DOCUMENTO";

        Rubrica rubrica1 = Rubrica.builder()
                .page(0)
                .relative_position_bottom(52.50)
                .relative_position_left(75.71)
                .relative_size_x(19.55)
                .relative_size_y(9.42)
                .type("signature")
                .signer_token("TOKEN SIGNER")
                .build();

        Rubrica rubrica2 = Rubrica.builder()
        .page(0)
        .relative_position_bottom(13.50)
        .relative_position_left(20.71)
        .relative_size_x(19.55)
        .relative_size_y(9.42)
        .type("visto")
        .signer_token("TOKEN SIGNER")
        .build();

        ArrayList<Rubrica> _rubricas = new ArrayList<>();
        _rubricas.add(rubrica1);
        _rubricas.add(rubrica2);

        RubricaList rubricaList = RubricaList.builder()
                .rubricas(_rubricas)
                .build();

        try {
            int statusCode = new DocRequests(apiToken).placeSignatures(docToken, rubricaList);
            System.out.println(statusCode);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete DeleteDoc Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-documentos/deletedoc.md

A full implementation example for deleting a document.

```java
import docs.DocRequests;
import response.DocResponse;
import services.JsonConverter;

public class DeleteDoc {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";
        String docToken = "TOKEN DOCUMENTO";

        try {
            DocResponse docResponse = new DocRequests(apiToken).deleteDoc(docToken);

            String jsonDocResponse = new JsonConverter().docResponseToJson(docResponse);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete Implementation Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-documentos/placesignatures

A full example demonstrating imports, configuration, and execution of the placeSignatures method.

```typescript
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { RubricaBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/RubricaBuilder";
import { RubricasArray } from "sdk-node-typescript-zapsign/src/body/doc/RubricasArray";

const apiToken: string = "SEU TOKEN";

const docToken: string = "TOKEN DOCUMENTO ORIGINAL";

const rubrica1: RubricaBuilder = RubricaBuilder()
                .withPage(0)
                .withtRelativePositionBottom(52.50)
                .withRelativePositionLeft(75.71)
                .withRelativeSizeX(19.55)
                .withRelativePositionSizeY(9.42)
                .withType("signature")
                .withSignerToken("TOKEN SIGNER")
                .build();
                
const rubrica2: RubricaBuilder = rubricaBuilder()
                .withPage(0)
                .withtRelativePositionBottom(13.50)
                .withRelativePositionLeft(20.71)
                .withRelativeSizeX(19.55)
                .withRelativePositionSizeY(9.42)
                .withType("signature")
                .withSignerToken("TOKEN SIGNER")
                .build();
                
let rubricas = RubricaBuilder[];
rubricas.push(rubrica1, rubrica2);

const rubricasArray = new RubricasArray(rubricas);

async function exempleAddExtraDoc() {
        try {
                statusCode: number = await new DocRequests(apiToken).placeSignatures(docToken, rubricasArray);
                console.log(statusCode);
        } catch(Err) {
            console.log(Err);
        }
    }
}
```

--------------------------------

### Complete detailSigner Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-signatarios/detailsigner

A full implementation example including necessary imports and the method call.

```typescript
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";

const apiToken: string = "SEU TOKEN";

const signerToken: string = "TOKEN DO SIGNATÁRIO";

async function exempleDetailSigner() {
    try {
           const signerRequest: SignerRequest = await new SignerRequest(apiToken).detailSigner(signerToken);
           const jsonDocResponse: string = new JsonConverter().signerToJson(docResponse);
           console.log(jsonDocResponse);
         } catch(Err) {
           console.log(Err);
     }
   }
}
```

--------------------------------

### Complete UpdateSigner Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-signatarios/updatesigner

A full implementation example including imports, configuration, and the update execution.

```typescript
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { SignerBuilder } from "sdk-node-typescript-zapsign/src/body/signer/builders/SignerBuilder";

const apiToken: string = "SEU TOKEN";

const signerToken: string = "TOKEN DO SIGNATÁRIO";

const signerBuilder = SignerBuilder()
    .withName("New Signer Name")
    .withEmail("newEmail@test.com")
    .withLockEmail(true)
    .withLockPhone(true)
    .withPhoneCountry("55")
    .withPhoneNumber("999999999")
    .withAuthMode("assinaturaTela")
    .withSendAutomaticAemail(false)
    .withSendAutomaticWhatsApp(false)
    .build();
    
async function exempleUpdateSigner() {
    try {
        signerResponse: string = new SignerRequest(apiToken).updateSigner(signerToken, signer);
        jsonDocResponse: string = new JsonConverter().signerToJson(signerResponse);
        console.log(jsonDocResponse);
    }
    catch(Err) {
        console.log(Err);
    }    
}
```

--------------------------------

### Complete Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-documentos/createdocfromtemplateasync

A full implementation example combining token definition, variable mapping, document configuration, and execution.

```typescript
import { DeParaTemplateBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/DeParaTemplateBuilder";
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { DocFromTemplateBuilder } from "sdk-node-typescript-zapsign/src/body/doc/builders/DocFromTemplateBuilder";
const apiToken: string = "SEU TOKEN";

const deParaTemplateName: DeParaTemplateBuilder = deParaTemplateBuilder()
        .de("{{NOME COMPLETO}}")
        .para("{{Full Name}}")
        .build();
        
const deParaTemplateCpf: DeParaTemplateBuilder = deParaTemplateBuilder()
        .de("{{NÚMERO DO CPF}}")
        .para("{{Social Security Number}}")
        .build();
        
const deParaTemplateEndereco: DeParaTemplateBuilder = deParaTemplateBuilder()
        .de("{{ENDEREÇO COMPLETO}}")
        .para("{{Full address}}")
        .build();
        
let deParaTemplates: DeParaTemplatesBuilder[] = [];

deParaTemplates.push(deParaTemplateName, deParaTemplateCpf, deParaTemplateEndereco);

const docFromTemplate: DocFomTemplateBuilder = new DocFromTemplateBuilder()
        .withSandbox(false)
        .withPrimaryColor("#000000")
        .withSignerName("My Signer for Template")
        .withTemplateId("SEU TEMPLATE ID")
        .withData(deParaTemplates)
        .build();

async function exempleCreateDocFromTemplateAsync() {
        try {
                docResponse: DocResponse = await new DocRequests(apiToken).createDocFromTemplateAsync(docFromTemplate);
                jsonDocResponse: string = new JsonConverter().docAsyncResponseToJson(docResponse);
                console.log(jsonDocResponse);
            } catch(Err) {
                console.log(Err);
            }
}
```

--------------------------------

### Complete DetailDoc Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-documentos/detaildoc.md

A full class implementation demonstrating the detailDoc workflow.

```java
import docs.DocRequests;
import response.DocResponse;
import services.JsonConverter;

public class DetailDoc {
    public static void main(String[] args) throws Exception {
    String apiToken = "SEU TOKEN";
    String docToken = "TOKEN DOCUMENTO"

        try {
            DocResponse docResponse = new DocRequests(apiToken).detailDoc(docToken);

            String jsonDocResponse = new JsonConverter().docResponseToJson(docResponse);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Complete addSigner Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-signatarios/addsigner

A full implementation example including imports, configuration, and the addSigner method call.

```typescript
import SignerRequest from "sdk-node-typescript-zapsign/src/signer/SignerRequest";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";
import { SignerBuilder } from "sdk-node-typescript-zapsign/src/body/signer/builders/SignerBuilder";

const apiToken: string = "SEU TOKEN";
const docToken: string = "TOKEN DOCUMENTO";

const signerBuilder = SignerBuilder()
    .withName("New Signer Name")
    .withEmail("newEmail@test.com")
    .withLockEmail(true)
    .withLockPhone(true)
    .withPhoneCountry("55")
    .withPhoneNumber("999999999")
    .withAuthMode("assinaturaTela")
    .withSendAutomaticAemail(false)
    .withSendAutomaticWhatsApp(false)
    .build();
    
async function exempleAddSigner() {
    try {
        signerResponse: string = new SignerRequest(apiToken).addSigner(signerToken, signer);
        jsonDocResponse: string = new JsonConverter().signerToJson(signerResponse);
        console.log(jsonDocResponse);
    }
    catch(Err) {
        console.log(Err);
    }    
}
```

--------------------------------

### Complete detailDoc Example

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-documentos/detaildoc

A full implementation example including necessary imports and the detailDoc method call.

```typescript
import DocRequests from "sdk-node-typescript-zapsign/src/docs/DocRequests";
import { JsonConverter } from "sdk-node-typescript-zapsign/src/services/JsonConverter";

const apiToken: string = "SEU TOKEN";

const docToken: string = "TOKEN DOCUMENTO ORIGINAL";

async function exempleDetailDoc() {
      try {
            const docResponse: DocResponse = await new DocRequests(apiToken).detailDoc(docToken);
            const jsonDocResponse: string = new JsonConverter().docResponseToJson(docResponse);
            console.log(jsonDocResponse);
         } catch(Err) {
            console.log(Err);
         }
}
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.zapsign.com.br/autenticacao/jwt-recomendado.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve information dynamically.

```http
GET https://docs.zapsign.com.br/autenticacao/jwt-recomendado.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/classes-usadas/body/docfrompdfbase64.md

Perform an HTTP GET request to the documentation URL to ask questions or retrieve information dynamically.

```http
GET https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/classes-usadas/body/docfrompdfbase64.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Consultar documentação via HTTP GET

Source: https://docs.zapsign.com.br/alerta-de-incidentes.md

Realize consultas dinâmicas à documentação enviando uma requisição GET com os parâmetros ask e goal.

```http
GET https://docs.zapsign.com.br/alerta-de-incidentes.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Complete detailSigner implementation

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-signatarios/detailsigner.md

A full class example demonstrating the complete flow for retrieving signer details.

```java
import body.signer.Signer;
import services.JsonConverter;
import signers.SignerRequest;

public class DetailSigner {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";
        String signerToken= "TOKEN DO SIGNATÁRIO";

        try {
            Signer signer = new SignerRequest(apiToken).detailSigner(signerToken);
            String jsonDocResponse = new JsonConverter().signerToJson(signer);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Executing detailSigner request

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-signatarios/detailsigner.md

Example of calling the detailSigner method and handling the response or potential errors.

```java
try {
    Signer signer = new SignerRequest(apiToken).detailSigner(signerToken);
    String jsonDocResponse = new JsonConverter().signerToJson(signer);
    System.out.println(jsonDocResponse);
}
catch(Exception exceptionError) {
    System.out.println(exceptionError.getMessage());
}
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.zapsign.com.br/documentos/oneclick.md

Use this request format to query the documentation dynamically by appending an ask parameter to the page URL.

```http
GET https://docs.zapsign.com.br/documentos/oneclick.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Email bounce webhook payload example

Source: https://docs.zapsign.com.br/webhooks/eventos/signer/email-bounce.md

Example of the JSON payload received when an email bounce event occurs.

```json
{
  "email": "teste@truora.com",
  "token": "853fda7d-ca1c-45cf-829d-9006a4bdfb9e",
  "type": "link_email",
  "status": "dropped",
  "status_code": null,
  "error": "ZapSign did not send the message to this email address because there was a previous delivery failure to this same email. We recommend checking the email, and if you believe there was an error, please contact support@zapsign.com.br.",
  "delivered": false,
  "event_type": "email_bounce"
}
```

--------------------------------

### Exemplo completo de implementação

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-signatarios/addsigner.md

Exemplo consolidado contendo todas as etapas para adicionar um signatário.

```java
import body.signer.Signer;
import services.JsonConverter;
import signers.SignerRequest;

public class AddSigner {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";
        String docToken = "TOKEN DOCUMENTO";

        Signer signer = Signer.builder()
                .name("New signer Name")
                .email("newEmail@test.com")
                .lock_email(true)
                .lock_phone(true)
                .phone_country("55")
                .phone_number("99999999999")
                .auth_mode("assinaturaTela")
                .send_automatic_email(false)
                .send_automatic_whatsapp(false)
                .build();

        try {
            Signer signerResponse = new SignerRequest(apiToken).addSigner(docToken, signer);
            String jsonDocResponse = new JsonConverter().signerToJson(signerResponse);
            System.out.println(jsonDocResponse);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Exemplo completo de implementação

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/requisicoes-para-documentos/addextradoc.md

Exemplo consolidado contendo a estrutura completa da classe para adicionar um documento extra.

```java
import body.doc.ExtraDoc;
import docs.DocRequests;
import response.ExtraDocResponse;
import services.JsonConverter;

public class AddExtraDoc {
    public static void main(String[] args) throws Exception {
        String apiToken = "SEU TOKEN";

        String docToken = "TOKEN DOCUMENTO ORIGINAL";

        ExtraDoc extraDoc = ExtraDoc.extraDocBuilder()
                .name("Extra doc")
                .url_pdf("https://zapsign.s3.amazonaws.com/2022/1/pdf/63d19807-cbfa-4b51-8571-215ad0f4eb98/ca42e7be-c932-482c-b70b-92ad7aea04be.pdf")
                .build();

        try {
            ExtraDocResponse extraDocResponse = new DocRequests(apiToken).addExtraDoc(docToken, extraDoc);
            String jsonExtraDocs = new JsonConverter().extraDocToJson(extraDocResponse);
            System.out.println(jsonExtraDocs);
        }
        catch(Exception exceptionError) {
            System.out.println(exceptionError.getMessage());
        }
    }
}
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/classes-usadas/response.md

Use this request format to ask questions about the documentation dynamically by appending the ask and goal parameters to the page URL.

```http
GET https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/classes-usadas/response.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /status-de-erros.md

Source: https://docs.zapsign.com.br/status-de-erros.md

Consulta dinâmica de documentação através da API do GitBook.

```APIDOC
## GET /status-de-erros.md

### Description
Realiza uma consulta dinâmica à documentação para obter respostas sobre erros ou outros tópicos.

### Method
GET

### Endpoint
https://docs.zapsign.com.br/status-de-erros.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - A pergunta específica sobre a documentação.
- **goal** (string) - Optional - O objetivo final que se deseja alcançar.
```

--------------------------------

### Instalar dependência do SDK

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript.md

Comando para adicionar o pacote do SDK da ZapSign ao seu projeto Node.js.

```bash
npm i sdk-node-typescript-zapsign
```

--------------------------------

### GET /facilitadores/sdks/sdk-em-java/classes-usadas/response/signer-response.md

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/classes-usadas/response/signer-response.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /facilitadores/sdks/sdk-em-java/classes-usadas/response/signer-response.md

### Description
Performs a query against the documentation page to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-java/classes-usadas/response/signer-response.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### Consultar documentação via HTTP GET

Source: https://docs.zapsign.com.br/webhooks/testando-webhooks.md

Utilize este formato de requisição para realizar consultas dinâmicas à documentação do GitBook, fornecendo uma pergunta específica e um objetivo opcional.

```http
GET https://docs.zapsign.com.br/webhooks/testando-webhooks.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /documentos/criar-documento.md

Source: https://docs.zapsign.com.br/documentos/criar-documento.md

Queries the documentation page content dynamically using an ask parameter.

```APIDOC
## GET /documentos/criar-documento.md

### Description
Performs a query against the documentation page to retrieve answers or context based on a specific question.

### Method
GET

### Endpoint
https://docs.zapsign.com.br/documentos/criar-documento.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### Exemplo Completo de Implementação

Source: https://docs.zapsign.com.br/facilitadores/sdks/sdk-em-typescript/requisicoes-para-documentos/addextradoc

Exemplo consolidado contendo importações, configuração e execução do método.

```typescript
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 = "SEU TOKEN";

const docToken: string = "TOKEN DOCUMENTO ORIGINAL";

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);
                }
}
```

--------------------------------

### GET /webhooks/eventos/document.md

Source: https://docs.zapsign.com.br/webhooks/eventos/document.md

Query the documentation dynamically by asking a question related to document webhook events.

```APIDOC
## GET /webhooks/eventos/document.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using the `ask` query parameter.

### Method
GET

### Endpoint
https://docs.zapsign.com.br/webhooks/eventos/document.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

--------------------------------

### GET https://api.zapsign.com.br/api/v1/templates/

Source: https://docs.zapsign.com.br/modelos/listar-modelos.md

Recupera uma lista paginada de modelos de documentos.

```APIDOC
## GET https://api.zapsign.com.br/api/v1/templates/

### Description
Este endpoint facilita o controle sobre seus modelos, permitindo que você visualize informações importantes como o nome, o tipo de arquivo, a data de criação e a última atualização.

### Method
GET

### Endpoint
https://api.zapsign.com.br/api/v1/templates/

### Parameters
#### Query Parameters
- **page** (number) - Optional - 1, 2, 3, n... (20 resultados por página)

#### Headers
- **Authorization** (string) - Required - Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

### Response
#### Success Response (200)
- **count** (number) - Total de registros
- **next** (string) - URL da próxima página
- **previous** (string) - URL da página anterior
- **results** (array) - Lista de modelos

#### Response Example
{
	"count": 31,
	"next": "http://api.zapsign.com.br/api/v1/templates/?page=2",
	"previous": null,
	"results": [
		{
			"token": "152f8416-xxxx-xxxx-xxxx-1aaf785dd335",
			"template_type": "docx",
			"name": "Template name",
			"active": true,
			"template_file": "https://zapsign.s3.amazonaws.com/2022/1/docs/xxxxx-d66b-495f-9b51-xxxx.docx",
			"created_at": "2022-01-05T12:59:42.563218Z",
			"last_update_at": "2022-01-05T13:03:22.242003Z",
			"redirect_link": "",
			"folder_path": "",
			"lang": "pt-br"
		}
	]
}
```

--------------------------------

### Exemplo de resposta de sucesso (200 OK)

Source: https://docs.zapsign.com.br/modelos/detalhar-modelo.md

Estrutura JSON retornada ao detalhar um modelo com sucesso, contendo informações de configuração, signatários e inputs.

```json
{
	"token": "152f8416-xxxx-xxxx-xxxx-1aaf785dd335",
	"template_type": "docx",
	"name": "Template name",
	"active": true,
	"template_file": "https://zapsign.s3.amazonaws.com/2022/1/docs/xxxxx-d66b-495f-9b51-xxxx.docx",
	"created_at": "2022-01-05T12:59:42.563218Z",
	"last_update_at": "2022-01-05T13:03:22.242003Z",
	"redirect_link": "",
	"folder_path": "",
	"lang": "pt-br"
	"signers": [
		{
			"name": "{{NOME COMPLETO}}",
			"auth_mode": "assinaturaTela",
			"email": "",
			"phone_country": "",
			"phone_number": "",
			"lock_name": true,
			"lock_phone": false,
			"lock_email": false,
			"hide_phone": false,
			"blank_phone": false,
			"hide_email": false,
			"blank_email": false,
			"require_selfie_photo": false,
			"require_document_photo": false,
			"selfie_validation_type": "none",
			"qualification": ""
		}
	],
	"inputs": [
		{
			"variable": "{{NOME COMPLETO}}",
			"input_type": "input",
			"label": "NOME COMPLETO",
			"help_text": "",
			"options": "",
			"required": false,
			"order": 1
		},
		{
			"variable": "{{CNPJ}}",
			"input_type": "input",
			"label": "CNPJ",
			"help_text": "",
			"options": "",
			"required": false,
			"order": 2
		},
		{
			"variable": "{{CPF}}",
			"input_type": "input",
			"label": "CRO",
			"help_text": "",
			"options": "",
			"required": false,
			"order": 3
		}
	]
}
```

--------------------------------

### GET https://api.zapsign.com.br/api/v1/users/

Source: https://docs.zapsign.com.br/conta/listar-usuarios-da-conta.md

Recupera uma lista paginada de usuários da organização.

```APIDOC
## GET https://api.zapsign.com.br/api/v1/users/

### Description
Este endpoint permite que você liste todos os usuários de sua organização, oferecendo informações detalhadas como o primeiro nome, último nome, e-mail, status de verificação do e-mail e nível de permissão de cada usuário.

### Method
GET

### Endpoint
https://api.zapsign.com.br/api/v1/users/

### Parameters
#### Query Parameters
- **page** (number) - Optional - 1, 2, 3, n... (25 resultados por página)

#### Headers
- **Authorization** (string) - Required - Api token a frente do texto "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

### Response
#### Success Response (200)
- **count** (number) - Total de usuários
- **next** (string) - URL da próxima página
- **previous** (string) - URL da página anterior
- **results** (array) - Lista de objetos de usuário

#### Response Example
{
	"count": 31,
	"next": "http://api.zapsign.com.br/api/v1/users/?page=2",
	"previous": null,
	"results": [
    	    {
                "first_name": "Name",
                "last_name": "Last",
                "email": "adm@adm.com",
                "email_verified": true,
                "user_group": {
                    "name": "owner"
                }
            },
            {
                "first_name": "Lorem",
                "last_name": "Ipsum",
                "email": "loremipsum@email.com",
                "email_verified": false,
                "user_group": {
                    "name": "self_docs_limited"
                }
            }
	]
}
```
Tokens:
Raw