Class Imovel

Funções de manipulação de imóveis.

Hierarchy (View Summary)

Requester
- Imovel

Constructors

constructor

new Imovel(parent: Corretor): Imovel
Parameters
- parent: Corretor
Returns Imovel
Overrides Requester.constructor
- Defined in imovel.ts:32

Properties

__PARENT_NAME__

__PARENT_NAME__: string

requester

requester: AxiosInstance

Methods

addDocs

addDocs(id: string, docs: FileUpload[]): Promise<ImovelDocument[]>
Adiciona documento a um imóvel
Parameters
- id: string
  Id do imóvel
- docs: FileUpload[]
  Arquivos a serem adicionados
Returns Promise<ImovelDocument[]>
Uma lista dos arquivos adicionados
- Defined in imovel.ts:224

addPhotos

addPhotos(id: string, files: File[]): Promise<Photo[]>
Adiciona documento a um imóvel
Parameters
- id: string
  Id do imóvel
- files: File[]
Returns Promise<Photo[]>
Uma lista dos arquivos adicionados
- Defined in imovel.ts:261

create

create(data: CreateImovel): Promise<ApiResponse<CreateImovelResponse>>
Adiciona um novo imóvel
Parameters
- data: CreateImovel
  Dados do imóvel, do tipo CreateImovel
Returns Promise<ApiResponse<CreateImovelResponse>>
Dados do novo imóvel criado, do tipo CreateImovelResponse
- Defined in imovel.ts:42

createAnalyticsCard

createAnalyticsCard(
id: string,
cardData: CreateAnalyticsCardData,
): Promise<ApiResponse<AnalyticsCard[]>>
Cria um novo card no analytics
Parameters
- id: string
  Id do imóvel
- cardData: CreateAnalyticsCardData
  Dados do card a ser criado
Returns Promise<ApiResponse<AnalyticsCard[]>>
Uma lista dos cards do analytics do imóvel, incluindo o card recem criado
- Defined in imovel.ts:130

createImovelLead

createImovelLead(
id: string,
lead_data: CreateLead,
): Promise<ApiResponse<ImovelAd>>
Cria um lead e adiciona no imóvel
Parameters
- id: string
  Id do imóvel
- lead_data: CreateLead
  Dados do lead a ser criado e adicionado
Returns Promise<ApiResponse<ImovelAd>>
Uma lista das novos leads do imóvel
- Defined in imovel.ts:314

delete

delete(id: string): Promise<ApiResponse<DeletedImovelResponse>>
Deleta um imóvel específico
Parameters
- id: string
  Id do imóvel
Returns Promise<ApiResponse<DeletedImovelResponse>>
Dados do novo imóvel deletado
- Defined in imovel.ts:68

deleteAnalyticsCard

deleteAnalyticsCard(
id: string,
card_id: string,
): Promise<ApiResponse<AnalyticsCard[]>>
Deleta um card no analytics
Parameters
- id: string
  Id do imóvel
- card_id: string
  Identificador do card a ser deletado
Returns Promise<ApiResponse<AnalyticsCard[]>>
Uma lista dos cards do analytics do imóvel, excluindo o card recem deletado
- Defined in imovel.ts:140

deleteDoc

deleteDoc(id: string, doc_id: string): Promise<ApiResponse<ImovelDocument[]>>
Deleta um documento do imóvel
Parameters
- id: string
  Id do imóvel
- doc_id: string
  Id do documento
Returns Promise<ApiResponse<ImovelDocument[]>>
Lista dos documentos restantes
- Defined in imovel.ts:284

deletePhoto

deletePhoto(id: string, photo_id: string): Promise<ApiResponse<Photo[]>>
Deleta uma foto de um imóvel
Parameters
- id: string
  Id do imóvel
- photo_id: string
  Id da foto a ser deletada
Returns Promise<ApiResponse<Photo[]>>
Uma lista das fotos remanescentes do imóvel
- Defined in imovel.ts:295

editImovel

editImovel(
id: string,
data: Partial<UpdateImovel>,
): Promise<ApiResponse<{ updated: boolean }>>
Altera dados de um imóvel específico
Parameters
- id: string
  Id do imóvel
- data: Partial<UpdateImovel>
  Valores a ser editados
Returns Promise<ApiResponse<{ updated: boolean }>>
boolean se a alteração foi sucedida ou não
- Defined in imovel.ts:78

get

get(id: string): Promise<ApiResponse<SelectedImovelResponse>>
Obtém dados de um imóvel específico
Parameters
- id: string
  Id do imóvel
Returns Promise<ApiResponse<SelectedImovelResponse>>
Dados do novo imóvel selecionado
- Defined in imovel.ts:59

getActivity

getActivity(id: string): Promise<ApiResponse<ActivityResponse[]>>
Obtém dados de atividade de um imóvel
Parameters
- id: string
  Id do imóvel
Returns Promise<ApiResponse<ActivityResponse[]>>
Os dados de atividade do imóvel
- Defined in imovel.ts:187

getAll

getAll(): Promise<ApiResponse<AllImovelResponse[]>>
Obtém todos os imóveis da imobiliária

Returns Promise<ApiResponse<AllImovelResponse[]>>
Dados dos imóveis da imobiliária, do tipo AllImovelResponse[]
- Defined in imovel.ts:50

getAnalyticsCardData

getAnalyticsCardData(
    id: string,
    tipo: "quantidade",
    metric: PanelCardMetrica,
): Promise<ApiResponse<number>>
Parameters
- id: string
- tipo: "quantidade"
- metric: PanelCardMetrica
Returns Promise<ApiResponse<number>>
- Defined in imovel.ts:162
getAnalyticsCardData(
    id: string,
    tipo: "grafico",
    metric: PanelCardMetrica,
): Promise<ApiResponse<GraficoDataPoint[]>>
Parameters
- id: string
- tipo: "grafico"
- metric: PanelCardMetrica
Returns Promise<ApiResponse<GraficoDataPoint[]>>
- Defined in imovel.ts:163

getAnalyticsPanel

getAnalyticsPanel(id: string): Promise<ApiResponse<AnalyticsCard[]>>
Obtém os cards do painél analytics de um imóvel
Parameters
- id: string
  Id do imóvel
Returns Promise<ApiResponse<AnalyticsCard[]>>
Uma lista dos cards de analytics do imóvel
- Defined in imovel.ts:205

getDocs

getDocs(id: string): Promise<ApiResponse<ImovelDocument[]>>
Obtém documentos de um imóvel
Parameters
- id: string
  Id do imóvel
Returns Promise<ApiResponse<ImovelDocument[]>>
Uma lista dos documentos do imóvel
- Defined in imovel.ts:251

getLeads

getLeads(id: string): Promise<ApiResponse<ImovelLeadResponse[]>>
Obtém leads de um imóvel
Parameters
- id: string
  Id do imóvel
Returns Promise<ApiResponse<ImovelLeadResponse[]>>
Uma lista dos leads do imóvel
- Defined in imovel.ts:214

getPhotos

getPhotos(id: string): Promise<ApiResponse<Photo[]>>
Obtém fotos de um imóvel
Parameters
- id: string
  Id do imóvel
Returns Promise<ApiResponse<Photo[]>>
Uma lista das fotos do imóvel
- Defined in imovel.ts:196

removeLead

removeLead(id: string, lead_id: string): Promise<void>
Desatribui um lead de um imóvel
Parameters
- id: string
  Id do imóvel
- lead_id: string
  Id da foto a ser deletada
Returns Promise<void>
- Defined in imovel.ts:304

`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

updateAnalyticsCardPosition

updateAnalyticsCardPosition(
id: string,
new_position: Omit<Layout, "updated_at">,
): Promise<ApiResponse<any>>
Atualiza a posição de um card no analytics
Parameters
- id: string
  Id do imóvel
- new_position: Omit<Layout, "updated_at">
  Objeto contendo a nova posição do card a ser atualizado
Returns Promise<ApiResponse<any>>
- Defined in imovel.ts:149

updateAnalyticsCardType

updateAnalyticsCardType(
id: string,
new_card: UpdateAnalyticsCardData,
): Promise<ApiResponse<any>>
Atualiza o tipo de um card no analytics
Parameters
- id: string
  Id do imóvel
- new_card: UpdateAnalyticsCardData
  Objeto contendo a nova configuração do card a ser atualizado
Returns Promise<ApiResponse<any>>
- Defined in imovel.ts:158

updateFotoCapa

updateFotoCapa(id: string, pic: File): Promise<ApiResponse<{ url: string }>>
Altera foto de capa do imóvel
Parameters
- id: string
  Id do imóvel
- pic: File
  Arquivo da foto de capa a ser adicionada
Returns Promise<ApiResponse<{ url: string }>>
URL da imagem adicionada se a alteração foi sucedida ou não
- Defined in imovel.ts:88

updateFotoPerfil

updateFotoPerfil(id: string, pic: File): Promise<ApiResponse<{ url: string }>>
Altera foto de perfil do imóvel
Parameters
- id: string
  Id do imóvel
- pic: File
  Arquivo da foto de perfil a ser adicionada
Returns Promise<ApiResponse<{ url: string }>>
URL da imagem adicionada se a alteração foi sucedida ou não
- Defined in imovel.ts:109

Class Imovel

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Imovel

Properties

__PARENT_NAME__

requester

Methods

addDocs

Parameters

Returns Promise<ImovelDocument[]>

addPhotos

Parameters

Returns Promise<Photo[]>

create

Parameters

Returns Promise<ApiResponse<CreateImovelResponse>>

createAnalyticsCard

Parameters

Returns Promise<ApiResponse<AnalyticsCard[]>>

createImovelLead

Parameters

Returns Promise<ApiResponse<ImovelAd>>

delete

Parameters

Returns Promise<ApiResponse<DeletedImovelResponse>>

deleteAnalyticsCard

Parameters

Returns Promise<ApiResponse<AnalyticsCard[]>>

deleteDoc

Parameters

Returns Promise<ApiResponse<ImovelDocument[]>>

deletePhoto

Parameters

Returns Promise<ApiResponse<Photo[]>>

editImovel

Parameters

Returns Promise<ApiResponse<{ updated: boolean }>>

get

Parameters

Returns Promise<ApiResponse<SelectedImovelResponse>>

getActivity

Parameters

Returns Promise<ApiResponse<ActivityResponse[]>>

getAll

Returns Promise<ApiResponse<AllImovelResponse[]>>

getAnalyticsCardData

Parameters

Returns Promise<ApiResponse<number>>

Parameters

Returns Promise<ApiResponse<GraficoDataPoint[]>>

getAnalyticsPanel

Parameters

Returns Promise<ApiResponse<AnalyticsCard[]>>

getDocs

Parameters

Returns Promise<ApiResponse<ImovelDocument[]>>

getLeads

Parameters

Returns Promise<ApiResponse<ImovelLeadResponse[]>>

getPhotos

Parameters

Returns Promise<ApiResponse<Photo[]>>

removeLead

Parameters

Returns Promise<void>

Protectedunwrap

Type Parameters

Parameters

Returns Promise<ApiResponse<T>>

updateAnalyticsCardPosition

Parameters

Returns Promise<ApiResponse<any>>

updateAnalyticsCardType

`Protected`unwrap