@nht-pandats/sdk / @nht-pandats/sdk/clients / @nht-pandats/sdk/clients/affiliateApi / AffiliateApiLeadModelDefinition

Interface: AffiliateApiLeadModelDefinition

@nht-pandats/sdk/clients.@nht-pandats/sdk/clients/affiliateApi.AffiliateApiLeadModelDefinition

The model definition for a lead in the Affiliate API.

Since

v1.20240429.0

Hierarchy

• ModuleModelDefinition

  ↳ AffiliateApiLeadModelDefinition

Properties

country

• country: Object

Lead country

Type declaration

Name	Type
inCreatePayload	true
inResponsePayload	true
inUpdatePayload	true
requiredInCreatePayload	true
requiredInUpdatePayload	false
type	PandaTsCountryAlpha2

inCreatePayload: true

-

---

inResponsePayload: true

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: true

-

---

requiredInUpdatePayload: false

-

---

type: PandaTsCountryAlpha2

-

---

Defined in

src/clients/affiliateApi/leads.ts:54

---

createdTime

• createdTime: Object

The date and time when the lead was created

Type declaration

Name	Type
filters	{ match: true ; range: true }
filters.match	true
filters.range	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { match: true ; range: true }

-

---

filters.match: true

-

---

filters.range: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:154

---

email

• email: Object

Lead's email address

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	true
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	true
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: true

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: true

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:39

---

firstName

• firstName: Object

First name. Size range: 2..100

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	true
inResponsePayload	true
inUpdatePayload	true
requiredInCreatePayload	true
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: true

-

---

inResponsePayload: true

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: true

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:65

---

id

• id: Object

The unique identifier of the lead in the database

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:24

---

language

• language: Object

Lead language. Default value: enu for English

Type declaration

Name	Type
inCreatePayload	true
inResponsePayload	true
inUpdatePayload	true
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	PandaTsLanguageIso3

inCreatePayload: true

-

---

inResponsePayload: true

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: PandaTsLanguageIso3

-

---

Defined in

src/clients/affiliateApi/leads.ts:117

---

lastName

• lastName: Object

Last name. Size range: 2..100

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	true
inResponsePayload	true
inUpdatePayload	true
requiredInCreatePayload	true
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: true

-

---

inResponsePayload: true

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: true

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:80

---

leadSource

• leadSource: Object

Leads registration source

Type declaration

Name	Type
filters	{ contain: true ; match: true }
filters.contain	true
filters.match	true
inCreatePayload	true
inResponsePayload	true
inUpdatePayload	true
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

filters: { contain: true ; match: true }

-

---

filters.contain: true

-

---

filters.match: true

-

---

inCreatePayload: true

-

---

inResponsePayload: true

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:139

---

phone

• phone: Object

Phone number

Type declaration

Name	Type
inCreatePayload	true
inResponsePayload	false
inUpdatePayload	true
requiredInCreatePayload	true
requiredInUpdatePayload	false
type	string

inCreatePayload: true

-

---

inResponsePayload: false

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: true

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:95

---

promocode

• promocode: Object

Promocode. Size range: 1..32

Type declaration

Name	Type
inCreatePayload	true
inResponsePayload	false
inUpdatePayload	true
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

inCreatePayload: true

-

---

inResponsePayload: false

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:106

---

referral

• referral: Object

Leads referral string. Format: key0=value0|key1=value1|etc...

Type declaration

Name	Type
inCreatePayload	true
inResponsePayload	true
inUpdatePayload	true
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	string

inCreatePayload: true

-

---

inResponsePayload: true

-

---

inUpdatePayload: true

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: string

-

---

Defined in

src/clients/affiliateApi/leads.ts:128

---

status

• status: Object

CRM lead status

Type declaration

Name	Type
filters	{ match: true ; range: true }
filters.match	true
filters.range	true
inCreatePayload	false
inResponsePayload	true
inUpdatePayload	false
requiredInCreatePayload	false
requiredInUpdatePayload	false
type	number

filters: { match: true ; range: true }

-

---

filters.match: true

-

---

filters.range: true

-

---

inCreatePayload: false

-

---

inResponsePayload: true

-

---

inUpdatePayload: false

-

---

requiredInCreatePayload: false

-

---

requiredInUpdatePayload: false

-

---

type: number

-

---

Defined in

src/clients/affiliateApi/leads.ts:169