Cliente | @midia-simples/simetra-sdk

Hierarchy

Resource
- Cliente

Index

Constructors

constructor

Methods

Constructors

constructor

new Cliente(config: IConfig): Cliente

Overrides Resource.constructor
- Defined in src/resources/Cliente.ts:39
Parameters
- config: IConfig
Returns Cliente

Methods

CartaoCadastrarNovo

CartaoCadastrarNovo(__namedParameters: { CNPJ_CPF_CLIE: string; COD_CLIE: number; COD_CNTR: number; COD_EMPR_FATR: string; bandeiraCartao: string; cvvCartao: string; dataValidadeCartao: string; nomeCartao: string; numeroCartao: string }): Promise<IClienteCartaoCadastrarNovoResponse>

- Defined in src/resources/Cliente.ts:252
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: string; COD_CLIE: number; COD_CNTR: number; COD_EMPR_FATR: string; bandeiraCartao: string; cvvCartao: string; dataValidadeCartao: string; nomeCartao: string; numeroCartao: string }
  - CNPJ_CPF_CLIE: string
  - COD_CLIE: number
  - COD_CNTR: number
  - COD_EMPR_FATR: string
  - bandeiraCartao: string
  - cvvCartao: string
  - dataValidadeCartao: string
  - nomeCartao: string
  - numeroCartao: string
Returns Promise<IClienteCartaoCadastrarNovoResponse>

CartaoConsultarCadastrados

CartaoConsultarCadastrados(__namedParameters: { CNPJ_CPF_CLIE: string }): Promise<ICartaoConsultarCadastradosResponse>

- Defined in src/resources/Cliente.ts:360
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: string }
  - CNPJ_CPF_CLIE: string
Returns Promise<ICartaoConsultarCadastradosResponse>

CartaoPagamentorapido

CartaoPagamentorapido(__namedParameters: { CNPJ_CPF_CLIE: string; CODE_OPERACAO: string; COD_CLIE: string; COD_CLIE_CARTAO: string; COD_CNTR_TITL: string; NRO_PARCELA: string; OPERACAO_USN: string; VLR_TOTAL: number }): Promise<IClienteCartaoPagamentorapidoResponse>

- Defined in src/resources/Cliente.ts:300
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: string; CODE_OPERACAO: string; COD_CLIE: string; COD_CLIE_CARTAO: string; COD_CNTR_TITL: string; NRO_PARCELA: string; OPERACAO_USN: string; VLR_TOTAL: number }
  - CNPJ_CPF_CLIE: string
  - CODE_OPERACAO: string
  - COD_CLIE: string
  - COD_CLIE_CARTAO: string
  - COD_CNTR_TITL: string
  - NRO_PARCELA: string
  - OPERACAO_USN: string
  - VLR_TOTAL: number
Returns Promise<IClienteCartaoPagamentorapidoResponse>

ConsultarCampanhaIndiqueEGanhe

ConsultarCampanhaIndiqueEGanhe(__namedParameters: { CNPJ_CPF_INDICANTE: string; DATA_FIM: string; DATA_INICIO: string }): Promise<IConsultarCampanhaIndiqueEGanheResponse>

- Defined in src/resources/Cliente.ts:508
Parameters
- __namedParameters: { CNPJ_CPF_INDICANTE: string; DATA_FIM: string; DATA_INICIO: string }
  - CNPJ_CPF_INDICANTE: string
  - DATA_FIM: string
  - DATA_INICIO: string
Returns Promise<IConsultarCampanhaIndiqueEGanheResponse>

ConsultarSaldoIndiqueEGanhe

ConsultarSaldoIndiqueEGanhe(__namedParameters: { CNPJ_CPF_INDICANTE: string }): Promise<IConsultarSaldoIndiqueEGanheResponse>

- Defined in src/resources/Cliente.ts:532
Parameters
- __namedParameters: { CNPJ_CPF_INDICANTE: string }
  - CNPJ_CPF_INDICANTE: string
Returns Promise<IConsultarSaldoIndiqueEGanheResponse>

EnviarEmail

EnviarEmail(__namedParameters: { CNPJ_CPF_CLIE: string; EMAIL_ASSUNTO: string; EMAIL_DESTINO: string; EMAIL_MENSAGEM: string; EMAIL_SENDER: string }): Promise<IEnviarEmailResponse>

- Defined in src/resources/Cliente.ts:334
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: string; EMAIL_ASSUNTO: string; EMAIL_DESTINO: string; EMAIL_MENSAGEM: string; EMAIL_SENDER: string }
  - CNPJ_CPF_CLIE: string
  - EMAIL_ASSUNTO: string
  - EMAIL_DESTINO: string
  - EMAIL_MENSAGEM: string
  - EMAIL_SENDER: string
Returns Promise<IEnviarEmailResponse>

EnviarSMS

EnviarSMS(__namedParameters: { Celular: string; Cod_Cntr: number; Texto: string }): Promise<IEnviarSMSResponse>

- Defined in src/resources/Cliente.ts:460
Parameters
- __namedParameters: { Celular: string; Cod_Cntr: number; Texto: string }
  - Celular: string
  - Cod_Cntr: number
  - Texto: string
Returns Promise<IEnviarSMSResponse>

IndicarNovoLead

IndicarNovoLead(__namedParameters: { CNPJ_CPF: undefined | string; CNPJ_CPF_INDICANTE: string; DATA_NASCIMENTO: undefined | string; DDD_CELULAR1: string; DDD_CELULAR2: undefined | string; DDD_CELULAR3: undefined | string; DDD_TELEFONE1: undefined | string; DDD_TELEFONE2: undefined | string; DDD_TELEFONE3: undefined | string; EMAIL: undefined | string; ENDERECO_BAIRRO: undefined | string; ENDERECO_CEP: undefined | string; ENDERECO_CIDADE: undefined | string; ENDERECO_COMPLEMENTO: undefined | string; ENDERECO_LOGRADOURO: undefined | string; ENDERECO_LOGRADOURO_TIPO: undefined | string; ENDERECO_NUMERO: undefined | string; ENDERECO_UF: undefined | string; INSCRICAO_MUNICIPAL: undefined | string; NOME_CLIENTE: string; NOME_MAE: undefined | string; NOME_PAI: undefined | string; NUMERO_CELULAR1: string; NUMERO_CELULAR2: undefined | string; NUMERO_CELULAR3: undefined | string; NUMERO_TELEFONE1: undefined | string; NUMERO_TELEFONE2: undefined | string; NUMERO_TELEFONE3: undefined | string; ORIGEM: undefined | string; RAZAO_SOCIAL: undefined | string; RG: undefined | string; SEXO: undefined | "M" | "F" }): Promise<IIndicarNovoLeadResponse>

- Defined in src/resources/Cliente.ts:380
Parameters
- __namedParameters: { CNPJ_CPF: undefined | string; CNPJ_CPF_INDICANTE: string; DATA_NASCIMENTO: undefined | string; DDD_CELULAR1: string; DDD_CELULAR2: undefined | string; DDD_CELULAR3: undefined | string; DDD_TELEFONE1: undefined | string; DDD_TELEFONE2: undefined | string; DDD_TELEFONE3: undefined | string; EMAIL: undefined | string; ENDERECO_BAIRRO: undefined | string; ENDERECO_CEP: undefined | string; ENDERECO_CIDADE: undefined | string; ENDERECO_COMPLEMENTO: undefined | string; ENDERECO_LOGRADOURO: undefined | string; ENDERECO_LOGRADOURO_TIPO: undefined | string; ENDERECO_NUMERO: undefined | string; ENDERECO_UF: undefined | string; INSCRICAO_MUNICIPAL: undefined | string; NOME_CLIENTE: string; NOME_MAE: undefined | string; NOME_PAI: undefined | string; NUMERO_CELULAR1: string; NUMERO_CELULAR2: undefined | string; NUMERO_CELULAR3: undefined | string; NUMERO_TELEFONE1: undefined | string; NUMERO_TELEFONE2: undefined | string; NUMERO_TELEFONE3: undefined | string; ORIGEM: undefined | string; RAZAO_SOCIAL: undefined | string; RG: undefined | string; SEXO: undefined | "M" | "F" }
  - CNPJ_CPF: undefined | string
  - CNPJ_CPF_INDICANTE: string
  - DATA_NASCIMENTO: undefined | string
  - DDD_CELULAR1: string
  - DDD_CELULAR2: undefined | string
  - DDD_CELULAR3: undefined | string
  - DDD_TELEFONE1: undefined | string
  - DDD_TELEFONE2: undefined | string
  - DDD_TELEFONE3: undefined | string
  - EMAIL: undefined | string
  - ENDERECO_BAIRRO: undefined | string
  - ENDERECO_CEP: undefined | string
  - ENDERECO_CIDADE: undefined | string
  - ENDERECO_COMPLEMENTO: undefined | string
  - ENDERECO_LOGRADOURO: undefined | string
  - ENDERECO_LOGRADOURO_TIPO: undefined | string
  - ENDERECO_NUMERO: undefined | string
  - ENDERECO_UF: undefined | string
  - INSCRICAO_MUNICIPAL: undefined | string
  - NOME_CLIENTE: string
  - NOME_MAE: undefined | string
  - NOME_PAI: undefined | string
  - NUMERO_CELULAR1: string
  - NUMERO_CELULAR2: undefined | string
  - NUMERO_CELULAR3: undefined | string
  - NUMERO_TELEFONE1: undefined | string
  - NUMERO_TELEFONE2: undefined | string
  - NUMERO_TELEFONE3: undefined | string
  - ORIGEM: undefined | string
  - RAZAO_SOCIAL: undefined | string
  - RG: undefined | string
  - SEXO: undefined | "M" | "F"
Returns Promise<IIndicarNovoLeadResponse>

RegistrarLogDeAcesso

RegistrarLogDeAcesso(__namedParameters: { AUDIT_APL_INCL: string; AUDIT_IP_INCL: string; CNPJ_CPF_CLIE: string; COD_CLIE: number; COD_CLIE_PORTAL_LOG_ACAO: number }): Promise<IRegistrarLogDeAcessoResponse>

- Defined in src/resources/Cliente.ts:482
Parameters
- __namedParameters: { AUDIT_APL_INCL: string; AUDIT_IP_INCL: string; CNPJ_CPF_CLIE: string; COD_CLIE: number; COD_CLIE_PORTAL_LOG_ACAO: number }
  - AUDIT_APL_INCL: string
  - AUDIT_IP_INCL: string
  - CNPJ_CPF_CLIE: string
  - COD_CLIE: number
  - COD_CLIE_PORTAL_LOG_ACAO: number
Returns Promise<IRegistrarLogDeAcessoResponse>

atualizar

atualizar(__namedParameters: { CNPJ_CPF_CLIE: string; COD_CLIE: string; EMAIL: string; TELEFONE1: string; TELEFONE2: string; TELEFONE3: string; TELEFONE4: string }): Promise<IClientAtualizarResponse | any>

- Defined in src/resources/Cliente.ts:210
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: string; COD_CLIE: string; EMAIL: string; TELEFONE1: string; TELEFONE2: string; TELEFONE3: string; TELEFONE4: string }
  - CNPJ_CPF_CLIE: string
  - COD_CLIE: string
  - EMAIL: string
  - TELEFONE1: string
  - TELEFONE2: string
  - TELEFONE3: string
  - TELEFONE4: string
Returns Promise<IClientAtualizarResponse | any>

cadastrarContrato

cadastrarContrato(__namedParameters: { AGENCIA: string; Bairro: string; COD_BANCO: string; Cep: string; Cidade: string; Cod_prod: string; Complemento: string; Conta: string; Cpf: string; DataInstalacao: string; DataNascimento: string; DddCelular: string; DddTelefone: string; Dia_Vencimento: string; Email: string; FormaPagto: string; Logradouro: string; Nome: string; NomeMae: string; NomePai: string; Numero: string; NumeroCelular: string; NumeroTelefone: string; Parc_instalacao: string; PeriodoInstalacao: string; Rg: string; TIPOCONTA: string; Uf: string; dvConta: string; fixo: string[]; movel: string[] }): Promise<IClientCadastrarContratoResponse | any>

- Defined in src/resources/Cliente.ts:84
Parameters
- __namedParameters: { AGENCIA: string; Bairro: string; COD_BANCO: string; Cep: string; Cidade: string; Cod_prod: string; Complemento: string; Conta: string; Cpf: string; DataInstalacao: string; DataNascimento: string; DddCelular: string; DddTelefone: string; Dia_Vencimento: string; Email: string; FormaPagto: string; Logradouro: string; Nome: string; NomeMae: string; NomePai: string; Numero: string; NumeroCelular: string; NumeroTelefone: string; Parc_instalacao: string; PeriodoInstalacao: string; Rg: string; TIPOCONTA: string; Uf: string; dvConta: string; fixo: string[]; movel: string[] }
  - AGENCIA: string
  - Bairro: string
  - COD_BANCO: string
  - Cep: string
  - Cidade: string
  - Cod_prod: string
  - Complemento: string
  - Conta: string
  - Cpf: string
  - DataInstalacao: string
  - DataNascimento: string
  - DddCelular: string
  - DddTelefone: string
  - Dia_Vencimento: string
  - Email: string
  - FormaPagto: string
  - Logradouro: string
  - Nome: string
  - NomeMae: string
  - NomePai: string
  - Numero: string
  - NumeroCelular: string
  - NumeroTelefone: string
  - Parc_instalacao: string
  - PeriodoInstalacao: string
  - Rg: string
  - TIPOCONTA: string
  - Uf: string
  - dvConta: string
  - fixo: string[]
  - movel: string[]
Returns Promise<IClientCadastrarContratoResponse | any>

cadastrarVindi

cadastrarVindi(__namedParameters: { CNPJ_CPF_CLIE: string; bandeiraCartao: string; cvvCartao: string; dataValidadeCartao: string; nomeCartao: string; numeroCartao: string }): Promise<IClientCadastrarVindiResponse | any>

- Defined in src/resources/Cliente.ts:160
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: string; bandeiraCartao: string; cvvCartao: string; dataValidadeCartao: string; nomeCartao: string; numeroCartao: string }
  - CNPJ_CPF_CLIE: string
  - bandeiraCartao: string
  - cvvCartao: string
  - dataValidadeCartao: string
  - nomeCartao: string
  - numeroCartao: string
Returns Promise<IClientCadastrarVindiResponse | any>

Protected callApi

callApi(__namedParameters: { data: any; method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "link" | "LINK" | "unlink" | "UNLINK"; params: any }): Promise<IApiResponse>

Inherited from Resource.callApi
- Defined in src/resources/Resource.ts:51
Parameters
- __namedParameters: { data: any; method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "link" | "LINK" | "unlink" | "UNLINK"; params: any }
  - data: any
  - method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "link" | "LINK" | "unlink" | "UNLINK"
  - params: any
Returns Promise<IApiResponse>

consulta

consulta(__namedParameters: { CNPJ_CPF_CLIE: undefined | string; COD_CNTR: undefined | string }): Promise<IClientConsultaResponse | any>

- Defined in src/resources/Cliente.ts:44
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: undefined | string; COD_CNTR: undefined | string }
  - CNPJ_CPF_CLIE: undefined | string
  - COD_CNTR: undefined | string
Returns Promise<IClientConsultaResponse | any>

consultaCadastroVindi

consultaCadastroVindi(__namedParameters: { CNPJ_CPF_CLIE: string }): Promise<IClientConsultaCadastroVindiResponse | any>

- Defined in src/resources/Cliente.ts:190
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: string }
  - CNPJ_CPF_CLIE: string
Returns Promise<IClientConsultaCadastroVindiResponse | any>

login

- Defined in src/resources/Cliente.ts:64
Parameters
- __namedParameters: { ASSINANTE_SENHA: string; CNPJ_CPF_CLIE: string }
  - ASSINANTE_SENHA: string
  - CNPJ_CPF_CLIE: string
Returns Promise<IClientLoginResponse | any>

Protected processResponse

processResponse(response: IApiResponse): IApiResponse

Inherited from Resource.processResponse
- Defined in src/resources/Resource.ts:24
Parameters
- response: IApiResponse
Returns IApiResponse

Generated using TypeDoc

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: IConfig

Returns Cliente

Methods

CartaoCadastrarNovo

Parameters

__namedParameters: { CNPJ_CPF_CLIE: string; COD_CLIE: number; COD_CNTR: number; COD_EMPR_FATR: string; bandeiraCartao: string; cvvCartao: string; dataValidadeCartao: string; nomeCartao: string; numeroCartao: string }

CNPJ_CPF_CLIE: string

COD_CLIE: number

COD_CNTR: number

COD_EMPR_FATR: string

bandeiraCartao: string

cvvCartao: string

dataValidadeCartao: string

nomeCartao: string

numeroCartao: string

Returns Promise<IClienteCartaoCadastrarNovoResponse>

CartaoConsultarCadastrados

Parameters

__namedParameters: { CNPJ_CPF_CLIE: string }

CNPJ_CPF_CLIE: string

Returns Promise<ICartaoConsultarCadastradosResponse>

CartaoPagamentorapido

Parameters

__namedParameters: { CNPJ_CPF_CLIE: string; CODE_OPERACAO: string; COD_CLIE: string; COD_CLIE_CARTAO: string; COD_CNTR_TITL: string; NRO_PARCELA: string; OPERACAO_USN: string; VLR_TOTAL: number }

CNPJ_CPF_CLIE: string

CODE_OPERACAO: string

COD_CLIE: string

COD_CLIE_CARTAO: string

COD_CNTR_TITL: string

NRO_PARCELA: string

OPERACAO_USN: string

VLR_TOTAL: number

Returns Promise<IClienteCartaoPagamentorapidoResponse>

ConsultarCampanhaIndiqueEGanhe

Parameters

__namedParameters: { CNPJ_CPF_INDICANTE: string; DATA_FIM: string; DATA_INICIO: string }

CNPJ_CPF_INDICANTE: string

DATA_FIM: string

DATA_INICIO: string

Returns Promise<IConsultarCampanhaIndiqueEGanheResponse>

ConsultarSaldoIndiqueEGanhe

Parameters

__namedParameters: { CNPJ_CPF_INDICANTE: string }

CNPJ_CPF_INDICANTE: string

Returns Promise<IConsultarSaldoIndiqueEGanheResponse>

EnviarEmail

Parameters

__namedParameters: { CNPJ_CPF_CLIE: string; EMAIL_ASSUNTO: string; EMAIL_DESTINO: string; EMAIL_MENSAGEM: string; EMAIL_SENDER: string }

CNPJ_CPF_CLIE: string

EMAIL_ASSUNTO: string

EMAIL_DESTINO: string

EMAIL_MENSAGEM: string

EMAIL_SENDER: string

Returns Promise<IEnviarEmailResponse>

EnviarSMS

Parameters

__namedParameters: { Celular: string; Cod_Cntr: number; Texto: string }

Celular: string

Cod_Cntr: number

Texto: string

Returns Promise<IEnviarSMSResponse>

IndicarNovoLead

Parameters

CNPJ_CPF: undefined | string

CNPJ_CPF_INDICANTE: string

DATA_NASCIMENTO: undefined | string

DDD_CELULAR1: string

DDD_CELULAR2: undefined | string

DDD_CELULAR3: undefined | string

DDD_TELEFONE1: undefined | string

DDD_TELEFONE2: undefined | string

DDD_TELEFONE3: undefined | string

EMAIL: undefined | string