Class Lead

Hierarchy

default<void, void>
- Lead

Index

Properties

serializer

Methods

get toJSON create createFormSubmission verifyCaptchaToken

Properties

`Static`serializer

serializer: (model: any) => any

serializer is a pure function that takes a model instance and returns a plain object that describes how to convert the model to JSON

Methods

get

get(key: string): any
Retrieves a value from raw API data. Prioritises DBAPI data if available
Parameters
- key: string
Returns any
Inherited from Model.get
- Defined in src/api/models/model.ts:121

toJSON

toJSON(): any
Special method to define behaviour of JSON.stringify() on model instance

Returns any
Inherited from Model.toJSON
- Defined in src/api/models/model.ts:130

`Static`create

create(
    leadType: LeadType,
    leadParams: LeadParams,
): Promise<
    | { errors: { message: string }[]; lead: null }
    | { errors: null; lead: LeadsApiResponse },
>
Parameters
- leadType: LeadType
- leadParams: LeadParams
Returns Promise<
| { errors: { message: string }[]; lead: null }
| { errors: null; lead: LeadsApiResponse },
>
- Defined in src/api/models/lead.ts:79

`Static`createFormSubmission

createFormSubmission(
    leadParams: CustomFormParams,
): Promise<
    | { errors: { message: string }[]; lead: null; message?: undefined }
    | { errors?: undefined; lead: null; message: {} }
    | { errors: null; lead: CustomLeadsApiResponse; message?: undefined },
>
Parameters
- leadParams: CustomFormParams
Returns Promise<
    | { errors: { message: string }[]; lead: null; message?: undefined }
    | { errors?: undefined; lead: null; message: {} }
    | { errors: null; lead: CustomLeadsApiResponse; message?: undefined },
>
- Defined in src/api/models/lead.ts:151

`Static`verifyCaptchaToken

verifyCaptchaToken(
__namedParameters: { activatedDomain: string; token: string },
): Promise<{ errors: { message: string }[] | null }>
Parameters
- __namedParameters: { activatedDomain: string; token: string }
Returns Promise<{ errors: { message: string }[] | null }>
- Defined in src/api/models/lead.ts:187

Class Lead

Hierarchy

Index

Properties

Methods

Properties

`Static`serializer

Methods

get

Parameters

Returns any

toJSON

Returns any

`Static`create

Parameters

Returns Promise<
| { errors: { message: string }[]; lead: null }
| { errors: null; lead: LeadsApiResponse },
>

`Static`createFormSubmission

Parameters

Returns Promise<
    | { errors: { message: string }[]; lead: null; message?: undefined }
    | { errors?: undefined; lead: null; message: {} }
    | { errors: null; lead: CustomLeadsApiResponse; message?: undefined },
>

`Static`verifyCaptchaToken

Parameters

Returns Promise<{ errors: { message: string }[] | null }>

Settings

On This Page

Class Lead

Hierarchy

Index

Properties

Methods

Properties

Staticserializer

Methods

get

Parameters

Returns any

toJSON

Returns any

Staticcreate

Parameters

Returns Promise< | { errors: { message: string }[]; lead: null } | { errors: null; lead: LeadsApiResponse },>

StaticcreateFormSubmission

Parameters

Returns Promise< | { errors: { message: string }[]; lead: null; message?: undefined } | { errors?: undefined; lead: null; message: {} } | { errors: null; lead: CustomLeadsApiResponse; message?: undefined },>

StaticverifyCaptchaToken

Parameters

Returns Promise<{ errors: { message: string }[] | null }>

Settings

On This Page

`Static`serializer

`Static`create

Returns Promise<
| { errors: { message: string }[]; lead: null }
| { errors: null; lead: LeadsApiResponse },
>

`Static`createFormSubmission

Returns Promise<
| { errors: { message: string }[]; lead: null; message?: undefined }
| { errors?: undefined; lead: null; message: {} }
| { errors: null; lead: CustomLeadsApiResponse; message?: undefined },
>

`Static`verifyCaptchaToken