service/lead | proxy-use

Index

Enumerations

LeadsSorts

Type aliases

Functions

Type aliases

LeadInfo

LeadInfo<T, P, K>: { activity: string; convertTime: string; createTime: string; kvLead: { id: string; properties: Record<string, string> }; leadSource: { sourceDescribe: string; sourceType: string }; mql: T extends true ? { activeScores: string; becomingMQLTime: string; isMQL: boolean; leadId: string; teamId: string; tenantId: string; updateTime: string } : undefined; scoreDimensions: P extends true ? [{ id: string; name: string; scoreUpdateTime: string; scores: number; tagIds: string[] }] : undefined; source: { sourceDescribe: string; sourceType: string }; tags: K extends true ? { id: string; name: string; path: string[] }[] : undefined; updateTime: string }

Type parameters

T: boolean
P = true
K = false

Type declaration

activity: string
convertTime: string
createTime: string
kvLead: { id: string; properties: Record<string, string> }
- id: string
- properties: Record<string, string>
leadSource: { sourceDescribe: string; sourceType: string }
- sourceDescribe: string
- sourceType: string
mql: T extends true ? { activeScores: string; becomingMQLTime: string; isMQL: boolean; leadId: string; teamId: string; tenantId: string; updateTime: string } : undefined
scoreDimensions: P extends true ? [{ id: string; name: string; scoreUpdateTime: string; scores: number; tagIds: string[] }] : undefined
source: { sourceDescribe: string; sourceType: string }
- sourceDescribe: string
- sourceType: string
tags: K extends true ? { id: string; name: string; path: string[] }[] : undefined
updateTime: string

LeadReferrerType

LeadReferrerType: "Staff" | null

推荐人类型

Functions

getLead

getLead<T, P, K>(leadId: string, params: { fields?: string[]; mql?: T; scoreDimension?: P; tag?: K }): Promise<LeadInfo<T, P, K>>

- Defined in service/lead.ts:102
获取联系人详情

Type parameters
- T: boolean = false
- P: boolean = false
- K: boolean = false
Parameters
- leadId: string
  
  联系人id
- params: { fields?: string[]; mql?: T; scoreDimension?: P; tag?: K }
  - Optional fields?: string[]
  - Optional mql?: T
  - Optional scoreDimension?: P
  - Optional tag?: K
Returns Promise<LeadInfo<T, P, K>>

getLeadFields

getLeadFields(): Promise<{ dataType: string; fields?: { dataType: string; enumItems: { label: string; value: string }[]; name: string; serial: string; title: string; type: string }[]; name: string; quesTemplate?: string; title: string; type: string }[]>

- Defined in service/lead.ts:118
获取联系人字段列表

Returns Promise<{ dataType: string; fields?: { dataType: string; enumItems: { label: string; value: string }[]; name: string; serial: string; title: string; type: string }[]; name: string; quesTemplate?: string; title: string; type: string }[]>

getLeads

getLeads<T>(params: { isLead?: boolean; mql?: T; sorts?: LeadsSorts[] } & ListPagination): ListResponse<LeadInfo<T>[]>

- Defined in service/lead.ts:83
获取由本人生成的联系人列表

remarks
mql是否包含营销线索相关数据

Type parameters
- T: boolean = false
Parameters
- params: { isLead?: boolean; mql?: T; sorts?: LeadsSorts[] } & ListPagination
Returns ListResponse<LeadInfo<T>[]>

leadApi

leadApi(target: string, data?: any): Promise<any>

- Defined in service/lead.ts:9
宽虚热吧的代理接口

export
Parameters
- target: string
  
  请求路由
- Optional data: any
Returns Promise<any>

searchLeads

searchLeads<T>(field: string, keyword: string, params: { isLead?: boolean; mql?: T; sorts?: LeadsSorts[]; tagId: string } & ListPagination): ListResponse<LeadInfo<T>[]>

- Defined in service/lead.ts:92
搜索由本人生成的联系人列表

Type parameters
- T: boolean = false
Parameters
- field: string
  
  搜索字段
- keyword: string
  
  搜索值
- params: { isLead?: boolean; mql?: T; sorts?: LeadsSorts[]; tagId: string } & ListPagination
Returns ListResponse<LeadInfo<T>[]>

updateLead

updateLead(params: { lead: string; properties: Record<string, string>; referrerId?: string; referrerType?: LeadReferrerType; source?: { sourceDescribe?: string; sourceType: string } }): Promise<void>

- Defined in service/lead.ts:111
更新联系人

Parameters
- params: { lead: string; properties: Record<string, string>; referrerId?: string; referrerType?: LeadReferrerType; source?: { sourceDescribe?: string; sourceType: string } }
  - lead: string
  - properties: Record<string, string>
  - Optional referrerId?: string
  - Optional referrerType?: LeadReferrerType
  - Optional source?: { sourceDescribe?: string; sourceType: string }
    - Optional sourceDescribe?: string
    - sourceType: string
Returns Promise<void>

Index

Enumerations

Type aliases

Functions

Type aliases

LeadInfo

Type parameters

T: boolean

P = true

K = false

Type declaration

activity: string

convertTime: string

createTime: string

kvLead: { id: string; properties: Record<string, string> }

id: string

properties: Record<string, string>

leadSource: { sourceDescribe: string; sourceType: string }

sourceDescribe: string

sourceType: string

mql: T extends true ? { activeScores: string; becomingMQLTime: string; isMQL: boolean; leadId: string; teamId: string; tenantId: string; updateTime: string } : undefined

scoreDimensions: P extends true ? [{ id: string; name: string; scoreUpdateTime: string; scores: number; tagIds: string[] }] : undefined

source: { sourceDescribe: string; sourceType: string }

sourceDescribe: string

sourceType: string

tags: K extends true ? { id: string; name: string; path: string[] }[] : undefined

updateTime: string

LeadReferrerType

Functions

getLead

Type parameters

T: boolean = false

P: boolean = false

K: boolean = false

Parameters

leadId: string

params: { fields?: string[]; mql?: T; scoreDimension?: P; tag?: K }

Optional fields?: string[]

Optional mql?: T

Optional scoreDimension?: P

Optional tag?: K

Returns Promise<LeadInfo<T, P, K>>

getLeadFields

Returns Promise<{ dataType: string; fields?: { dataType: string; enumItems: { label: string; value: string }[]; name: string; serial: string; title: string; type: string }[]; name: string; quesTemplate?: string; title: string; type: string }[]>

getLeads

Type parameters

T: boolean = false

Parameters

params: { isLead?: boolean; mql?: T; sorts?: LeadsSorts[] } & ListPagination

Returns ListResponse<LeadInfo<T>[]>

leadApi

Parameters

target: string

Optional data: any

Returns Promise<any>

searchLeads

Type parameters

T: boolean = false

Parameters

field: string

keyword: string

params: { isLead?: boolean; mql?: T; sorts?: LeadsSorts[]; tagId: string } & ListPagination

Returns ListResponse<LeadInfo<T>[]>

updateLead

Parameters

params: { lead: string; properties: Record<string, string>; referrerId?: string; referrerType?: LeadReferrerType; source?: { sourceDescribe?: string; sourceType: string } }

lead: string

properties: Record<string, string>

Optional referrerId?: string

Optional referrerType?: LeadReferrerType

Optional source?: { sourceDescribe?: string; sourceType: string }

Optional sourceDescribe?: string

sourceType: string

Returns Promise<void>