Contrato | @midia-simples/simetra-sdk

Hierarchy

Resource
- Contrato

Index

Constructors

constructor

Methods

Constructors

constructor

new Contrato(config: IConfig): Contrato

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

Methods

alterarDiaDeVencimento

alterarDiaDeVencimento(__namedParameters: { CNPJ_CPF_CLIE: string; COD_CNTR: number; DIA_VENC: number }): Promise<IAlterarDiaDeVencimentoResponse>

- Defined in src/resources/Contrato.ts:127
Parameters
- __namedParameters: { CNPJ_CPF_CLIE: string; COD_CNTR: number; DIA_VENC: number }
  - CNPJ_CPF_CLIE: string
  - COD_CNTR: number
  - DIA_VENC: number
Returns Promise<IAlterarDiaDeVencimentoResponse>

alterarFormaDePagamentoGrupo

alterarFormaDePagamentoGrupo(__namedParameters: { COD_CLIE_CARTAO: undefined | number; COD_CLIE_DEBITO_EM_CONTA: undefined | number; COD_CNTR: string | number; FORM_PAGTO: string; IND_BOLETO_FISICO: undefined | number }): Promise<IAlterarFormaDePagamentoGrupoResponse>

- Defined in src/resources/Contrato.ts:206
Parameters
- __namedParameters: { COD_CLIE_CARTAO: undefined | number; COD_CLIE_DEBITO_EM_CONTA: undefined | number; COD_CNTR: string | number; FORM_PAGTO: string; IND_BOLETO_FISICO: undefined | number }
  - COD_CLIE_CARTAO: undefined | number
  - COD_CLIE_DEBITO_EM_CONTA: undefined | number
  - COD_CNTR: string | number
  - FORM_PAGTO: string
  - IND_BOLETO_FISICO: undefined | number
Returns Promise<IAlterarFormaDePagamentoGrupoResponse>

alterarWifi

alterarWifi(__namedParameters: { COD_CLIE: number; COD_CNTR: number; COD_CNTR_ITEM: number; COD_PROTOCOLO: number; NOM_WIFI_NOVO: string; SEN_WIFI_NOVO: string }): Promise<IAlterarWifiResponse>

- Defined in src/resources/Contrato.ts:147
Parameters
- __namedParameters: { COD_CLIE: number; COD_CNTR: number; COD_CNTR_ITEM: number; COD_PROTOCOLO: number; NOM_WIFI_NOVO: string; SEN_WIFI_NOVO: string }
  - COD_CLIE: number
  - COD_CNTR: number
  - COD_CNTR_ITEM: number
  - COD_PROTOCOLO: number
  - NOM_WIFI_NOVO: string
  - SEN_WIFI_NOVO: string
Returns Promise<IAlterarWifiResponse>

cadastrarAnexo

cadastrarAnexo(__namedParameters: { ANEXO_BUFFER: string; ANEXO_NOME: string; COD_CNTR: string; SEQ_CONTRATO_ANEXO_TIPO: string }): Promise<IContratoCadastrarAnexoResponse | any>

- Defined in src/resources/Contrato.ts:30
Parameters
- __namedParameters: { ANEXO_BUFFER: string; ANEXO_NOME: string; COD_CNTR: string; SEQ_CONTRATO_ANEXO_TIPO: string }
  - ANEXO_BUFFER: string
  - ANEXO_NOME: string
  - COD_CNTR: string
  - SEQ_CONTRATO_ANEXO_TIPO: string
Returns Promise<IContratoCadastrarAnexoResponse | 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>

consultarContratoLinhaMovel

consultarContratoLinhaMovel(__namedParameters: { COD_CNTR: number; DATA_CONSUMO: string; SEQ_LINHA: number }): Promise<IContratoConsultaLinhaMovelResponse>

- Defined in src/resources/Contrato.ts:75
Parameters
- __namedParameters: { COD_CNTR: number; DATA_CONSUMO: string; SEQ_LINHA: number }
  - COD_CNTR: number
  - DATA_CONSUMO: string
  - SEQ_LINHA: number
Returns Promise<IContratoConsultaLinhaMovelResponse>

consultarDiasDeVencimento

consultarDiasDeVencimento(): Promise<IConsultarDiasDeVencimentoResponse>

- Defined in src/resources/Contrato.ts:173
Returns Promise<IConsultarDiasDeVencimentoResponse>

desbloquear

desbloquear(__namedParameters: { COD_CNTR: number }): Promise<IContratoDesbloquearResponse | any>

- Defined in src/resources/Contrato.ts:56
Parameters
- __namedParameters: { COD_CNTR: number }
  - COD_CNTR: number
Returns Promise<IContratoDesbloquearResponse | any>

Protected processResponse

processResponse(response: IApiResponse): IApiResponse

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

tituloPixGerarBoleto

tituloPixGerarBoleto(__namedParameters: { COD_CLIE: string; COD_CNTR_TITL: string }): Promise<ITituloPixGerarBoletoResponse>

- Defined in src/resources/Contrato.ts:186
Parameters
- __namedParameters: { COD_CLIE: string; COD_CNTR_TITL: string }
  - COD_CLIE: string
  - COD_CNTR_TITL: string
Returns Promise<ITituloPixGerarBoletoResponse>

trocarFormaPagamento

trocarFormaPagamento(__namedParameters: { BANDEIRACARTAO: undefined | string; COD_CNTR: number; CVVCARTAO: undefined | string; DATAVALIDADECARTAO: undefined | string; FORM_PAGTO: string; IND_BOLETO_FISICO: undefined | number; NOMECARTAO: undefined | string; NUMEROCARTAO: undefined | string }): Promise<ITrocaFormaPagamentoResponse>

- Defined in src/resources/Contrato.ts:97
Parameters
- __namedParameters: { BANDEIRACARTAO: undefined | string; COD_CNTR: number; CVVCARTAO: undefined | string; DATAVALIDADECARTAO: undefined | string; FORM_PAGTO: string; IND_BOLETO_FISICO: undefined | number; NOMECARTAO: undefined | string; NUMEROCARTAO: undefined | string }
  - BANDEIRACARTAO: undefined | string
  - COD_CNTR: number
  - CVVCARTAO: undefined | string
  - DATAVALIDADECARTAO: undefined | string
  - FORM_PAGTO: string
  - IND_BOLETO_FISICO: undefined | number
  - NOMECARTAO: undefined | string
  - NUMEROCARTAO: undefined | string
Returns Promise<ITrocaFormaPagamentoResponse>

Generated using TypeDoc

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

config: IConfig

Returns Contrato

Methods

alterarDiaDeVencimento

Parameters

__namedParameters: { CNPJ_CPF_CLIE: string; COD_CNTR: number; DIA_VENC: number }

CNPJ_CPF_CLIE: string

COD_CNTR: number

DIA_VENC: number

Returns Promise<IAlterarDiaDeVencimentoResponse>

alterarFormaDePagamentoGrupo

Parameters

__namedParameters: { COD_CLIE_CARTAO: undefined | number; COD_CLIE_DEBITO_EM_CONTA: undefined | number; COD_CNTR: string | number; FORM_PAGTO: string; IND_BOLETO_FISICO: undefined | number }

COD_CLIE_CARTAO: undefined | number

COD_CLIE_DEBITO_EM_CONTA: undefined | number

COD_CNTR: string | number

FORM_PAGTO: string

IND_BOLETO_FISICO: undefined | number

Returns Promise<IAlterarFormaDePagamentoGrupoResponse>

alterarWifi

Parameters

__namedParameters: { COD_CLIE: number; COD_CNTR: number; COD_CNTR_ITEM: number; COD_PROTOCOLO: number; NOM_WIFI_NOVO: string; SEN_WIFI_NOVO: string }

COD_CLIE: number

COD_CNTR: number

COD_CNTR_ITEM: number

COD_PROTOCOLO: number

NOM_WIFI_NOVO: string

SEN_WIFI_NOVO: string

Returns Promise<IAlterarWifiResponse>

cadastrarAnexo

Parameters

__namedParameters: { ANEXO_BUFFER: string; ANEXO_NOME: string; COD_CNTR: string; SEQ_CONTRATO_ANEXO_TIPO: string }

ANEXO_BUFFER: string

ANEXO_NOME: string

COD_CNTR: string

SEQ_CONTRATO_ANEXO_TIPO: string

Returns Promise<IContratoCadastrarAnexoResponse | any>

Protected callApi

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>

consultarContratoLinhaMovel

Parameters

__namedParameters: { COD_CNTR: number; DATA_CONSUMO: string; SEQ_LINHA: number }

COD_CNTR: number

DATA_CONSUMO: string

SEQ_LINHA: number

Returns Promise<IContratoConsultaLinhaMovelResponse>

consultarDiasDeVencimento

Returns Promise<IConsultarDiasDeVencimentoResponse>

desbloquear

Parameters

__namedParameters: { COD_CNTR: number }

COD_CNTR: number

Returns Promise<IContratoDesbloquearResponse | any>

Protected processResponse

Parameters

response: IApiResponse

Returns IApiResponse

tituloPixGerarBoleto

Parameters

__namedParameters: { COD_CLIE: string; COD_CNTR_TITL: string }

COD_CLIE: string

COD_CNTR_TITL: string

Returns Promise<ITituloPixGerarBoletoResponse>

trocarFormaPagamento

Parameters

__namedParameters: { BANDEIRACARTAO: undefined | string; COD_CNTR: number; CVVCARTAO: undefined | string; DATAVALIDADECARTAO: undefined | string; FORM_PAGTO: string; IND_BOLETO_FISICO: undefined | number; NOMECARTAO: undefined | string; NUMEROCARTAO: undefined | string }

BANDEIRACARTAO: undefined | string

COD_CNTR: number