Class ConectorClient

Parameters

• data: activateDocument

  Dados do documento a ser ativado

Returns Promise<success>

Retorna o resultado da ação

Conector.activateDocument({
  docId: 5,
  reason: "Optional",
})
  .then(console.log)
  .catch((error) => console.log(error));

try{
  const response = await Conector.activateDocument({
    docId: 5,
    reason: "",
  })
  console.log(response);
  //do something
}catch(error){
  console.log(error);
}

Conector.auth({
  email: 'example@test.com',
  password: '123456'
})
  .then(console.log)
  .catch((error)=>console.log(error));

Parameters

• data: auth

  dados de login para autenticar o client

Returns Promise<authentication>

dados referentes a seção criada

Conector
  .authenticate({
    documentType: 4,
    documentFile: '../files/example.xml',
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const checkValidation = await Conector.authenticate({
    documentType: 4,
    documentFile: '../files/example.xml',
  });
  console.log(checkValidation);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: authenticate

  Dados do documento a ser verificado

Returns Promise<authenticateResponse>

Detalhes da autenticidade do documento

Parameters

• params: deleteParams

  Opções do documento a ser deletado

Returns Promise<deleteResponse>

Retorna o número de documentos deletados

Conector
  .deleteDocument({
     docId: 456,
     cascade: true //opcional
   })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const deletedDocument = await Conector.deleteDocument({
     docId: 456,
     cascade: true //opcional
   });
  console.log(deletedDocument);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• params: deleteGroupParams

  Opções do grupo a ser deletado

Returns Promise<deleteResponse>

Retorna o número de documentos deletados

Parameters

• params: docIdOrSecurityCodeOrYourNumber

  opções do documento a ser consultado

Returns Promise<getDocumentResponse>

Informações do documento consultado

Conector
  .getDocument({
    docId: 5
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const document = await Conector.getDocument({
    docId: 5
  });
  console.log(document);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• params: securityCode

  opções do documento a ser consultado

Returns Promise<getDocumentResponse>

Informações do documento consultado

Conector
  .getDocumentBySecurityCode({
    securityCode: 'Dip1234'
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const document = await Conector.getDocumentBySecurityCode({
    securityCode: 'Dip1234'
  });
  console.log(document);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: getDocumentFile

  Dados do documento a ser consultado

Returns Promise<documentFile>

Retorna o nome do arquivo salvo no diretório de downloads informado em outDir, por padrão a pasta de downloads é download_files

Conector
  .getDocumentFile({
    docId: 5,
    version: "registeredDocument", //generatedDocument, signedDocument or registeredDocument
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const documentXml = await Conector.getDocumentFile({
    docId: "",
    version: "registeredDocument", //generatedDocument, signedDocument or registeredDocument
  });
  console.log(documentXml);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: documentFileRetrieve

  Dados do documento a ser consultado

Returns Promise<documentFile>

Retorna o nome do arquivo salvo no diretório de downloads informado em outDir, por padrão a pasta de downloads é download_files

Conector
  .getDocumentFileRetrieve({
    documentType: 4,
    yourNumber: '123456',
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const documentXml = await Conector.getDocumentFileRetrieve({
    documentType: 4,
    yourNumber: '123456',
  });
  console.log(documentXml);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: docId

  Dados do documento a ser consultado

  Conector
    .getDocumentHistory({docId: 5}) //remember the docId or security code
    .then(console.log)
    .catch((error)=>console.log);
  

  try{
    const documentHistory = await Conector.getDocumentHistory({docId: 5});
    console.log(documentHistory);
    //do something
  }catch(error){
    console.log(error);
  }
  

Returns Promise<documentHistory[]>

Parameters

• data: docId

  Dado do documento a ser consultado

  Conector
    .getDocumentReceipt({docId: 5}) //remember the docId
    .then(console.log)
    .catch((error)=>console.log);
  

  try{
    const documentReceipt = await Conector.getDocumentReceipt({docId: 5});
    console.log(documentReceipt);
    //do something
  }catch(error){
    console.log(error);
  }
  

Returns Promise<documentReceipt>

Conector
  .getDocumentState({
    docId: 5
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const documentState = await Conector.getDocumentState({docId: 5});
  console.log(documentState);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: docId

  Dados do documento a ser consultado

Returns Promise<documentState>

Parameters

• Optional options: getDocumentsParams

  filtros para a consulta dos documentos, se null retornará todos os documentos

Returns Promise<getDocumentsResponse[]>

lista de documentos encontrados com base nos filtros

Conector
  .getDocuments()
  .then(console.log)
  .catch((error)=>console.log);

try{
  const documents = await Conector.getDocuments();
  console.log(documents);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: getFileContent

  Dados do documento a ser consultado

Returns Promise<fileContent>

Retorna o conteúdo de visualização do arquivo de representação de um documento

Conector
  .getFileContent({
    docId: 5,
    format: "html" //html or json
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const documentContent = await Conector.getFileContent({
    docId: "",
    format: "html" //html or json
  });
  console.log(documentContent.content);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• params: getGroupParams

  opções do group a ser consultado

Returns Promise<getGroupResponse>

Informações do grupo consultado

Conector
  .getGroup({
    groupId: '5'
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const document = await Conector.getGroup({
    groupId: '5'
  });
  console.log(document);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• Optional options: getGroups

  filtros para a consulta dos grupos, se null retornará todos os grupos

Returns Promise<getGroupResponse[]>

lista de grupos encontrados com base nos filtros

Conector
  .getGroups({page: 1, limit: 5})
  .then(console.log)
  .catch((error)=>console.log);

try{
  const groups = await Conector.getGroups();
  console.log(groups);
  //do something
}catch(error){
  console.log(error);
}

Returns Promise<TSignatureConfiguration>

Lista as configurações de assinatura dos documentos incluindo os assinadores, seus substitutos e as respectivas tags.

Returns Promise<healthCheck>

Parameters

• data: insertDocument

  Dados do documento a ser inserido no Conector

Returns Promise<insertDocumentResponse>

Retorna o ID do documento criado

const jsonData = '{ "meta":{ "client_id":...';

Conector.insertDocument({
  documentType: 5,
  documentData: jsonData, //it must be a string
  documentFile: './doc.pdf'
})
  .then(console.log)
  .catch((error) => console.log(error));

try{
  const myData = {
      meta: {
        client_id: "aa-bb-cc",
        your_number: 123456,
        ...
      }
    }

  const jsonData = JSON.stringify(myData);

  const { documentId } = await Conector.insertDocument({
    documentType: 4,
    documentData: jsonData, //it must be a string
  });

  console.log(documentId);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: insertDocuments

  Dados dos documentos a serem inseridos no conector

Returns Promise<insertDocumentResponse[]>

Um array contendo o documentId de cada documento inserido

const jsonData = '[ { "meta":{ "client_id":...';

Conector.insertDocuments({
  documentType: 5,
  documentData: jsonData, //it must be a string
  documentFile: ['./doc.pdf']
})
  .then(console.log)
  .catch((error) => console.log(error));

try{
  const myListOfDocuments = [
    {
      meta: {
        client_id: "aa-bb-cc",
        your_number: 123456,
        ...
      }
    },
    {
      meta: {
        client_id: "aa-bb-cc",
        your_number: 654321,
        ...
      }
    }
  ];

  const jsonData = JSON.stringify(myListOfDocuments);

  const insertedDocuments = await Conector.insertDocuments({
    documentType: 4,
    documentData: jsonData, //it must be a string
  });

  console.log(insertedDocuments);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: retry

  Dados para reexecutar um processo Se o processCode não for informado será detectado automaticamente qual o status atual do documento e o mesmo será reexecutado.

  Conector.retry({docId: 5, processCode: 502})
    .then(console.log)
    .catch((error) => console.log(error));
  

  try{
    const response = await Conector.retry({docId: 5, processCode: 502});
  
    console.log(response);
    //do something
  }catch(error){
    console.log(error);
  }
  

Returns Promise<retryProcess>

Parameters

• data: retrySignature

  Dados para reexecutar um processo de assinatura Se o type não for informado será reexecutado o último processo de assinatura do documento.

  Conector.retrySignature({docId: 5, type: 'SIGNATURE'})
    .then(console.log)
    .catch((error) => console.log(error));
  

  try{
    const response = await Conector.retrySignature({docId: 5, type: 'SIGNATURE'});
  
    console.log(response);
    //do something
  }catch(error){
    console.log(error);
  }
  

Returns Promise<retrySignatureProcess>

Parameters

• data: revokeDocument

  Dados do documento a ser revogado

Returns Promise<success>

Retorna o resultado da ação

Conector.revokeDocument({
  docId: 5,
  reason: TYPES.RevokeReason.decisaoJudicial,
})
  .then(console.log)
  .catch((error) => console.log(error));

try{
  const response = await Conector.revokeDocument({
    docId: 5,
    reason: TYPES.RevokeReason.decisaoJudicial,
  })
  console.log(response);
  //do something
}catch(error){
  console.log(error);
}

Conector
  .setAuthorization({
    docId: '4',
    documentAuthorization: 'authorized',
    authorizationDescription: 'update authorization',
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const result = await Conector.setAuthorization({
    docId: '4',
    documentAuthorization: 'authorized',
    authorizationDescription: 'update authorization',
  });
  console.log(result);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: setAuthorizationParams

  Dados do documento a ser alterado

Returns Promise<setAuthorizationResponse>

ID do documento alterado

Conector
  .setAuthorizationPut({
    docId: '4',
    documentAuthorization: 'authorized',
    authorizationDescription: 'update authorization',
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const result = await Conector.setAuthorizationPut({
    docId: '4',
    documentAuthorization: 'authorized',
    authorizationDescription: 'update authorization',
  });
  console.log(result);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: setAuthorizationParams

  Dados do documento a ser alterado

Returns Promise<setAuthorizationResponse>

ID do documento alterado

Parameters

• data: suspendDocument

  Dados do documento a ser suspenso

Returns Promise<success>

Retorna o resultado da ação

Conector.suspendDocument({
  docId: 5,
  reason: "Optional",
})
  .then(console.log)
  .catch((error) => console.log(error));

try{
  const response = await Conector.suspendDocument({
    docId: 5,
    reason: "",
  })
  console.log(response);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• data: updateDocument

  Dados do documento a ser atualizado

Returns Promise<documentId>

O documentId do documento atualizado

const jsonData = '{ "meta":{ "client_id":...';

Conector.updateDocument({
  docId: 5,
  documentType: 4,
  documentData: jsonData, //it must be a string
  updateDescription: 'Correção do CPF', //Obrigatório
})
  .then(console.log)
  .catch((error) => console.log(error));

try{
  const myDocumentData = {
    meta: {
      client_id: "aa-bb-cc",
      your_number: 123456,
      ...
    }
  }


  const jsonData = JSON.stringify(myDocumentData);

  const updatedDocument = await Conector.updateDocument({
    docId: 5,
    documentType: 4,
    documentData: jsonData, //it must be a string
    updateDescription: 'Correção do CPF', //Obrigatório
  });

  console.log(updatedDocument);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• input: TValidationInput

Returns Promise<TValidationOutput>

Resultado da validação

Conector
  .validateJson({
    type: 4,
    version: '1.05',
    data: '{\"meta\":{\"clientId\":\"a15344ce-d4b6-40af-b7b8-0922db25fda5\",\"clientSignature\"...'
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const validationResult = await Conector.validateJson({
    type: 4,
    version: '1.05',
    data: '{\"meta\":{\"clientId\":\"a15344ce-d4b6-40af-b7b8-0922db25fda5\",\"clientSignature\"...'
  });
  console.log(validationResult);
  //do something
}catch(error){
  console.log(error);
}

Parameters

• input: TValidationInput

Returns Promise<TValidationOutput>

Resultado da validação

Conector
  .validateXml({
    type: 4,
    version: '1.05',
    data: '<?xml version=\"1.0\" encoding=\"UTF-8\"?><DocumentacaoAcademicaRegistro...'
  })
  .then(console.log)
  .catch((error)=>console.log);

try{
  const validationResult = await Conector.validateXml({
    type: 4,
    version: '1.05',
    data: '<?xml version=\"1.0\" encoding=\"UTF-8\"?><DocumentacaoAcademicaRegistro...'
  });
  console.log(validationResult);
  //do something
}catch(error){
  console.log(error);
}