Class Imobiliarias

Funções de manipulação de imobiliárias cadastradas na Neezy

Hierarchy (View Summary)

Requester
- Imobiliarias

Index

Constructors

Properties

__PARENT_NAME__ requester

Methods

create delete get getAll unwrap update

Constructors

constructor

new Imobiliarias(parent: SuperUser): Imobiliarias
Parameters
- parent: SuperUser
Returns Imobiliarias
Overrides Requester.constructor
- Defined in imobiliarias.ts:10

Properties

__PARENT_NAME__

__PARENT_NAME__: string

requester

requester: AxiosInstance

Methods

create

create(cnpj: string): Promise<ApiResponse<ImobiliariaResponse>>
Cadastrar uma nova imobiliaria
Parameters
- cnpj: string
  CNPJ da imobilaria
Returns Promise<ApiResponse<ImobiliariaResponse>>
O objeto da imobiliaria recem cadastrada
- Defined in imobiliarias.ts:37

delete

delete(
id: string,
): Promise<ApiResponse<Omit<ImobiliariaResponse, "empresa" | "image">>>
Deleta uma imobiliaria com base no ID
Parameters
- id: string
  id da imobilaria
Returns Promise<ApiResponse<Omit<ImobiliariaResponse, "empresa" | "image">>>
O objeto da imobiliaria recem deletada do tipo ImobiliariaResponse
- Defined in imobiliarias.ts:48

get

get(id: string): Promise<ApiResponse<ImobiliariaResponse>>
Obtem uma imobiliaria com base no ID
Parameters
- id: string
  id da imobilaria
Returns Promise<ApiResponse<ImobiliariaResponse>>
O objeto da imobiliaria
- Defined in imobiliarias.ts:28

getAll

getAll(): Promise<ApiResponse<ImobiliariaResponse[]>>
Retorna todas as imobiliarias cadastradas na Neezy

Returns Promise<ApiResponse<ImobiliariaResponse[]>>
Uma lista do tipo ImobiliariaResponse[]
- Defined in imobiliarias.ts:19

`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,
cnpj: string,
): Promise<ApiResponse<Omit<ImobiliariaResponse, "empresa" | "image">>>
Atualiza o valor de uma caracteristica com base no ID
Parameters
- id: string
  id da imobilaria
- cnpj: string
  novo CNPJ da imobilaria
Returns Promise<ApiResponse<Omit<ImobiliariaResponse, "empresa" | "image">>>
O objeto da caracteristica recem atualizada do tipo ImobiliariaResponse
- Defined in imobiliarias.ts:60