api-credito-pessoal-demo

ApiCrditoPessoalDemo - JavaScript client for api-credito-pessoal-demo API para tratamento de propostas de crédito pessoal utilizada para estudos do fluxo de crédito da Portocred This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install api-credito-pessoal-demo --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your api-credito-pessoal-demo from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('api-credito-pessoal-demo') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/api-credito-pessoal-demo then install it via:

    npm install YOUR_USERNAME/api-credito-pessoal-demo --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ApiCrditoPessoalDemo = require('api-credito-pessoal-demo');

var api = new ApiCrditoPessoalDemo.ClientesApi()

var clientId = "clientId_example"; // {String} 

var cpf = 8.14; // {Number} CPF de uma pessoa que se deseja consultar


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clientesCpfContratosGet(clientId, cpf, callback);

Documentation for API Endpoints

All URIs are relative to https://sb-api.portocred.com.br/credito-pessoal-demo/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ApiCrditoPessoalDemo.ClientesApi | clientesCpfContratosGet | GET /clientes/{cpf}/contratos | Consulta todos os contratos ativos de um cliente ApiCrditoPessoalDemo.ClientesApi | clientesCpfGet | GET /clientes/{cpf} | Consulta dados de um cliente ApiCrditoPessoalDemo.ClientesApi | clientesCpfPropostasGet | GET /clientes/{cpf}/propostas | Consulta a proposta ativa de um cliente ApiCrditoPessoalDemo.ContratosApi | contratosContratoCancelamentoPatch | PATCH /contratos/{contrato}/cancelamento | Cancela um contrato. ApiCrditoPessoalDemo.ContratosApi | contratosContratoPagamentoPatch | PATCH /contratos/{contrato}/pagamento | Registra o pagamento de uma parcela do contrato. ApiCrditoPessoalDemo.ContratosApi | contratosContratoParcelasNumeroParcelaBoletoGet | GET /contratos/{contrato}/parcelas/{numero-parcela}/boleto | Gerar o boleto da parcela indicada ApiCrditoPessoalDemo.PropostasApi | propostasPost | POST /propostas | Inclui uma proposta de crédito. ApiCrditoPessoalDemo.PropostasApi | propostasPropostaCondicoesGet | GET /propostas/{proposta}/condicoes | Retorna o texto das condições da operação ApiCrditoPessoalDemo.PropostasApi | propostasPropostaDocumentosGet | GET /propostas/{proposta}/documentos | Retonar os documentos salvos relacionados a proposta ApiCrditoPessoalDemo.PropostasApi | propostasPropostaDocumentosPost | POST /propostas/{proposta}/documentos | Faz o upload de algum documento da operação ApiCrditoPessoalDemo.PropostasApi | propostasPropostaEfetivacaoPatch | PATCH /propostas/{proposta}/efetivacao | Efetiva uma proposta de crédito (Ato de gerar contrato). ApiCrditoPessoalDemo.PropostasApi | propostasPropostaGet | GET /propostas/{proposta} | Consulta uma proposta pelo número, retornando todos os seus dados ApiCrditoPessoalDemo.PropostasApi | propostasPropostaOfertasIdOfertaSelecaoPut | PUT /propostas/{proposta}/ofertas/{id-oferta}/selecao | Atualiza a proposta com a oferta selecionada. ApiCrditoPessoalDemo.PropostasApi | propostasPropostaPendenciasGet | GET /propostas/{proposta}/pendencias | Consulta as pendências de uma proposta que a impedem de ser efetivada ApiCrditoPessoalDemo.PropostasApi | propostasPropostaPut | PUT /propostas/{proposta} | Altera uma proposta de crédito. Postar apenas os campos que serão alterados. ApiCrditoPessoalDemo.PropostasApi | propostasPropostaStatusGet | GET /propostas/{proposta}/status | Consulta a situação de uma proposta pelo número, retornando a situação corrente e dados adicionais de acordo com a situação [BAD PRACTICE RISK => POOLING] ApiCrditoPessoalDemo.SimulaesApi | simulacoesPost | POST /simulacoes | Faz cálculos simulados de valores de propostas

Documentation for Models

• ApiCrditoPessoalDemo.Body
• ApiCrditoPessoalDemo.Body1
• ApiCrditoPessoalDemo.Body2
• ApiCrditoPessoalDemo.CamposCet
• ApiCrditoPessoalDemo.CamposCliente
• ApiCrditoPessoalDemo.CamposProposta
• ApiCrditoPessoalDemo.CamposcetCet
• ApiCrditoPessoalDemo.CamposclienteContasbancarias
• ApiCrditoPessoalDemo.CamposclienteDocumentos
• ApiCrditoPessoalDemo.CamposclienteEnderecoresidencial
• ApiCrditoPessoalDemo.CamposclienteRedessociais
• ApiCrditoPessoalDemo.CamposclienteSituacaoprofissional
• ApiCrditoPessoalDemo.CamposclienteSituacaoprofissionalEnderecocomercial
• ApiCrditoPessoalDemo.CamposclienteTelefones
• ApiCrditoPessoalDemo.CampospropostaDadosadicionais
• ApiCrditoPessoalDemo.CampospropostaProposta
• ApiCrditoPessoalDemo.Error
• ApiCrditoPessoalDemo.ErrorValidation
• ApiCrditoPessoalDemo.InlineResponse200
• ApiCrditoPessoalDemo.InlineResponse2001
• ApiCrditoPessoalDemo.InlineResponse20010
• ApiCrditoPessoalDemo.InlineResponse20011
• ApiCrditoPessoalDemo.InlineResponse20011Metadata
• ApiCrditoPessoalDemo.InlineResponse20011Parcelas
• ApiCrditoPessoalDemo.InlineResponse20011Results
• ApiCrditoPessoalDemo.InlineResponse2002
• ApiCrditoPessoalDemo.InlineResponse2003
• ApiCrditoPessoalDemo.InlineResponse2003Pendencias
• ApiCrditoPessoalDemo.InlineResponse2004
• ApiCrditoPessoalDemo.InlineResponse2005
• ApiCrditoPessoalDemo.InlineResponse2006
• ApiCrditoPessoalDemo.InlineResponse2007
• ApiCrditoPessoalDemo.InlineResponse2008
• ApiCrditoPessoalDemo.InlineResponse2009
• ApiCrditoPessoalDemo.InlineResponse201

Documentation for Authorization

All endpoints do not require authorization.