Class Propostas

Funções de manipulação de propostas.

Hierarchy (View Summary)

Requester
- Propostas

Index

Constructors

constructor

new Propostas(parent: Corretor): Propostas
Parameters
- parent: Corretor
Returns Propostas
Overrides Requester.constructor
- Defined in propostas.ts:22

Properties

__PARENT_NAME__

__PARENT_NAME__: string

requester

requester: AxiosInstance

Methods

addAnexos

addAnexos(
id: string,
files: File[],
): Promise<ApiResponse<PropostaAnexoResponseDTO[]>>
Adiciona anexos a uma proposta (upload de arquivos)
Parameters
- id: string
  Id da proposta
- files: File[]
  Arquivos a serem enviados (máximo 10)
Returns Promise<ApiResponse<PropostaAnexoResponseDTO[]>>
Lista de anexos criados
- Defined in propostas.ts:123

addAssinatura

addAssinatura(
id: string,
data: CreatePropostaAssinaturaDTO,
): Promise<ApiResponse<PropostaAssinaturaResponseDTO>>
Adiciona uma solicitação de assinatura à proposta
Parameters
- id: string
  Id da proposta
- data: CreatePropostaAssinaturaDTO
  Dados da assinatura (pessoa_id e tipo)
Returns Promise<ApiResponse<PropostaAssinaturaResponseDTO>>
Dados da assinatura criada
- Defined in propostas.ts:168

assinar

assinar(
    propostaId: string,
    assinaturaId: string,
    data: AssinarPropostaDTO,
): Promise<ApiResponse<PropostaAssinaturaResponseDTO>>
Assina digitalmente uma proposta
Parameters
- propostaId: string
  Id da proposta
- assinaturaId: string
  Id da assinatura
- data: AssinarPropostaDTO
  Dados da assinatura (IP opcional)
Returns Promise<ApiResponse<PropostaAssinaturaResponseDTO>>
Dados da assinatura atualizada
- Defined in propostas.ts:181

create

create(data: CreatePropostaDTO): Promise<ApiResponse<PropostaResponseDTO>>
Cria uma nova proposta
Parameters
- data: CreatePropostaDTO
  Dados da proposta a ser criada
Returns Promise<ApiResponse<PropostaResponseDTO>>
Dados da proposta criada
- Defined in propostas.ts:75

getAll

getAll(
query?: GetPropostasQueryDTO,
): Promise<ApiResponse<PaginatedPropostasResponseDTO>>
Lista todas as propostas com filtros e paginação
Parameters
- Optionalquery: GetPropostasQueryDTO
  Filtros de busca (status, tipo_transacao, imovel_id, cliente_id, etc.)
Returns Promise<ApiResponse<PaginatedPropostasResponseDTO>>
Lista paginada de propostas
- Defined in propostas.ts:32

getAssinaturas

getAssinaturas(
id: string,
): Promise<ApiResponse<PropostaAssinaturaResponseDTO[]>>
Lista todas as assinaturas de uma proposta
Parameters
- id: string
  Id da proposta
Returns Promise<ApiResponse<PropostaAssinaturaResponseDTO[]>>
Lista de assinaturas
- Defined in propostas.ts:156

getById

getById(id: string): Promise<ApiResponse<PropostaResponseDTO>>
Busca uma proposta por ID
Parameters
- id: string
  Id da proposta
Returns Promise<ApiResponse<PropostaResponseDTO>>
Dados completos da proposta ou erro se não encontrada
- Defined in propostas.ts:43

getContrato

getContrato(id: string): Promise<ApiResponse<ContratoResponseDTO>>
Busca a minuta do contrato de uma proposta
Parameters
- id: string
  Id da proposta
Returns Promise<ApiResponse<ContratoResponseDTO>>
HTML do contrato
- Defined in propostas.ts:199

getHistorico

getHistorico(id: string): Promise<ApiResponse<PropostaHistoricoResponseDTO[]>>
Busca o histórico de ações de uma proposta
Parameters
- id: string
  Id da proposta
Returns Promise<ApiResponse<PropostaHistoricoResponseDTO[]>>
Lista de eventos do histórico
- Defined in propostas.ts:222

removeAnexo

removeAnexo(propostaId: string, anexoId: string): Promise<ApiResponse<void>>
Remove um anexo da proposta
Parameters
- propostaId: string
  Id da proposta
- anexoId: string
  Id do anexo a ser removido
Returns Promise<ApiResponse<void>>
- Defined in propostas.ts:145

`Protected`unwrap

unwrap<T>(p: Promise<AxiosResponse<T, any, {}>>): Promise<ApiResponse<T>>
Type Parameters
- T
Parameters
- p: Promise<AxiosResponse<T, any, {}>>
Returns Promise<ApiResponse<T>>
Inherited from Requester.unwrap
- Defined in requester.ts:20

update

update(
id: string,
data: UpdatePropostaDTO,
): Promise<ApiResponse<PropostaResponseDTO>>
Atualiza uma proposta existente
Parameters
- id: string
  Id da proposta
- data: UpdatePropostaDTO
  Dados a serem atualizados
Returns Promise<ApiResponse<PropostaResponseDTO>>
Dados da proposta atualizada
- Defined in propostas.ts:87

updateContrato

updateContrato(
id: string,
data: UpdateContratoHtmlDTO,
): Promise<ApiResponse<PropostaResponseDTO>>
Atualiza a minuta do contrato de uma proposta
Parameters
- id: string
  Id da proposta
- data: UpdateContratoHtmlDTO
  HTML do contrato
Returns Promise<ApiResponse<PropostaResponseDTO>>
Dados da proposta atualizada
- Defined in propostas.ts:211

updateStatus

updateStatus(
id: string,
data: UpdatePropostaStatusDTO,
): Promise<ApiResponse<PropostaResponseDTO>>
Atualiza o status de uma proposta
Parameters
- id: string
  Id da proposta
- data: UpdatePropostaStatusDTO
  Status e observação
Returns Promise<ApiResponse<PropostaResponseDTO>>
Dados da proposta atualizada
- Defined in propostas.ts:110

Class Propostas

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Propostas

Properties

__PARENT_NAME__

requester

Methods

addAnexos

Parameters

Returns Promise<ApiResponse<PropostaAnexoResponseDTO[]>>

addAssinatura

Parameters

Returns Promise<ApiResponse<PropostaAssinaturaResponseDTO>>

archive

Parameters

Returns Promise<ApiResponse<PropostaResponseDTO>>

assinar

Parameters

Returns Promise<ApiResponse<PropostaAssinaturaResponseDTO>>

create

Parameters

Returns Promise<ApiResponse<PropostaResponseDTO>>

getAll

Parameters

Returns Promise<ApiResponse<PaginatedPropostasResponseDTO>>

getAssinaturas

Parameters

Returns Promise<ApiResponse<PropostaAssinaturaResponseDTO[]>>

getById

Parameters

Returns Promise<ApiResponse<PropostaResponseDTO>>

getContrato

Parameters

Returns Promise<ApiResponse<ContratoResponseDTO>>

getHistorico

Parameters

Returns Promise<ApiResponse<PropostaHistoricoResponseDTO[]>>

removeAnexo

Parameters

Returns Promise<ApiResponse<void>>

Protectedunwrap

Type Parameters

Parameters

Returns Promise<ApiResponse<T>>

update

Parameters

Returns Promise<ApiResponse<PropostaResponseDTO>>

updateContrato

Parameters

Returns Promise<ApiResponse<PropostaResponseDTO>>

updateStatus

Parameters

Returns Promise<ApiResponse<PropostaResponseDTO>>

Settings

On This Page

`Protected`unwrap