Class Leads

Funções de manipulações dos leads da imobiliária.

Hierarchy (View Summary)

Requester
- Leads

Index

Constructors

constructor

new Leads(parent: Corretor): Leads
Parameters
- parent: Corretor
Returns Leads
Overrides Requester.constructor
- Defined in leads.ts:11

Properties

__PARENT_NAME__

__PARENT_NAME__: string

requester

requester: AxiosInstance

Methods

addProfilePic

addProfilePic(
id: string,
profilePic: File,
): Promise<ApiResponse<{ message: string }>>
Adiciona uma foto de perfil no lead
Parameters
- id: string
  Id do lead a ser movido, do tipo string
- profilePic: File
  Arquivo da foto de perfil a ser adicionada
Returns Promise<ApiResponse<{ message: string }>>
- Defined in leads.ts:115

create

create(data: CreateLead): Promise<CreateLeadResponse>
Adiciona um novo lead
Parameters
- data: CreateLead
  Dados do lead, do tipo CreateLead
Returns Promise<CreateLeadResponse>
Dados do novo lead criado, do tipo CreateLeadResponse
- Defined in leads.ts:66

editLead

editLead(
    id: string,
    data: {
        corretor_id?: string;
        email: string;
        nome_completo: string;
        telefone: string;
    },
): Promise<ApiResponse<Pessoa>>
Edita os dados de um lead
Parameters
- id: string
  Id do lead a ser movido, do tipo string
- data: { corretor_id?: string; email: string; nome_completo: string; telefone: string }
  Dados a serem editados do lead
Returns Promise<ApiResponse<Pessoa>>
- Defined in leads.ts:106

getAll

getAll(): Promise<
    ApiResponse<
        {
            pessoa: {
                address_id: null
                | string;
                arquivado: boolean;
                cpf: null | string;
                created_at: string;
                data_de_nascimento: null | string;
                delete_at: null | string;
                email: null | string;
                id: string;
                image_id: null | string;
                nome_completo: null | string;
                profilePic: string;
                rg: null | string;
                telefone: null | string;
                updated_at: string;
            };
        } & {
            corretor_id: string;
            created_at: string;
            funil_etapa_id: string;
            id: string;
            imobiliaria_id: string;
            pessoa_id: string;
            updated_at: string;
        }[],
    >,
>
Obtém todos os leads cadastrados na imobiliária

Returns Promise<
    ApiResponse<
        {
            pessoa: {
                address_id: null
                | string;
                arquivado: boolean;
                cpf: null | string;
                created_at: string;
                data_de_nascimento: null | string;
                delete_at: null | string;
                email: null | string;
                id: string;
                image_id: null | string;
                nome_completo: null | string;
                profilePic: string;
                rg: null | string;
                telefone: null | string;
                updated_at: string;
            };
        } & {
            corretor_id: string;
            created_at: string;
            funil_etapa_id: string;
            id: string;
            imobiliaria_id: string;
            pessoa_id: string;
            updated_at: string;
        }[],
    >,
>
O histórico de conversa entre o usuário e o eezy
- Defined in leads.ts:20

getFunil

getFunil(): Promise<ApiResponse<FunilStep[]>>
Obtém as etapas do funil juntamente com os leads em cada etapa

Returns Promise<ApiResponse<FunilStep[]>>
Uma lista das etapas do funil, junto com os leads de cada
- Defined in leads.ts:57

moveLead

moveLead(id: string, etapa_id: string): Promise<ApiResponse<null>>
Move um lead de etapa no funil
Parameters
- id: string
  Id do lead a ser movido, do tipo string
- etapa_id: string
  Id da etapa para onde o lead será movido, do tipo string
Returns Promise<ApiResponse<null>>
- Defined in leads.ts:97

`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

Class Leads

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Leads

Properties

__PARENT_NAME__

requester

Methods

addProfilePic

Parameters

Returns Promise<ApiResponse<{ message: string }>>

create

Parameters

Returns Promise<CreateLeadResponse>

editLead

Parameters

Returns Promise<ApiResponse<Pessoa>>

getAll

getFunil

Returns Promise<ApiResponse<FunilStep[]>>

moveLead

Parameters

Returns Promise<ApiResponse<null>>

`Protected`unwrap

Type Parameters

Parameters

Returns Promise<ApiResponse<T>>

Settings

On This Page

Class Leads

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Leads

Properties

__PARENT_NAME__

requester

Methods

addProfilePic

Parameters

Returns Promise<ApiResponse<{ message: string }>>

create

Parameters

Returns Promise<CreateLeadResponse>

editLead

Parameters

Returns Promise<ApiResponse<Pessoa>>

getAll

getFunil

Returns Promise<ApiResponse<FunilStep[]>>

moveLead

Parameters

Returns Promise<ApiResponse<null>>

Protectedunwrap

Type Parameters

Parameters

Returns Promise<ApiResponse<T>>

Settings

On This Page

`Protected`unwrap