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

Interface: AffiliateApiCustomerModelDefinition

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

The model definition for a customer in the Affiliate API.

Since

v1.20240429.0

Hierarchy

ModuleModelDefinition
↳ AffiliateApiCustomerModelDefinition

Properties

acceptPromotions

• acceptPromotions: Object

Accepted promotions and news later

Type declaration

Name	Type
`filters`	{ `match`: `true` }
`filters.match`	`true`
`inCreatePayload`	`true`
`inResponsePayload`	`true`
`inUpdatePayload`	`true`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`boolean`

filters: { match: true }

filters.match: true

inCreatePayload: true

inResponsePayload: true

inUpdatePayload: true

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: boolean

Defined in

src/clients/affiliateApi/customers.ts:294

acceptTermsAndConditions

• acceptTermsAndConditions: Object

Accepted service terms and conditions

Type declaration

Name	Type
`inCreatePayload`	`true`
`inResponsePayload`	`true`
`inUpdatePayload`	`true`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`boolean`

inCreatePayload: true

inResponsePayload: true

inUpdatePayload: true

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: boolean

Defined in

src/clients/affiliateApi/customers.ts:308

address

• address: Object

Address. Size range: 2..100

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/customers.ts:158

birthday

• birthday: Object

Date of birth (YYYY-MM-DD)

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/customers.ts:238

citizenship

• citizenship: Object

Customer citizenship. Default value: Will be taken from country field. Size range: 2

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/customers.ts:202

city

• city: Object

City. Size range: 2..100

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/customers.ts:147

clientSource

• clientSource: Object

Customers 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/customers.ts:279

clientStatus

• clientStatus: Object

CRM customer status 0 = Demo 1 = Real

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/customers.ts:394

complianceStatus

• complianceStatus: Object

Customer compliance 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`	`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/customers.ts:409

country

• country: Object

Customer 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/customers.ts:84

createdTime

• createdTime: Object

The date and time when the customer 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/customers.ts:333

crmId

• crmId: Object

The unique identifier of the customer in the CRM

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/customers.ts:28

currency

• currency: Object

Customer default currency. Size range: 3

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/customers.ts:136

custom1

• custom1: Object

Custom Parameter 1

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/customers.ts:439

custom2

• custom2: Object

Custom Parameter 2

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/customers.ts:450

custom3

• custom3: Object

Custom Parameter 3

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/customers.ts:461

disabled

• disabled: Object

If the customer is disabled

Type declaration

Name	Type
`filters`	{ `match`: `true` }
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`boolean`

filters: { match: true }

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: boolean

Defined in

src/clients/affiliateApi/customers.ts:319

email

• email: Object

Customer'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/customers.ts:58

firstDepositDate

• firstDepositDate: Object

The date and time when the customer made their first deposit

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/customers.ts:363

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/customers.ts:95

ftd

• ftd: Object

If the customer made their first deposit

Type declaration

Name	Type
`filters`	{ `match`: `true` }
`filters.match`	`true`
`inCreatePayload`	`false`
`inResponsePayload`	`true`
`inUpdatePayload`	`false`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`boolean`

filters: { match: true }

filters.match: true

inCreatePayload: false

inResponsePayload: true

inUpdatePayload: false

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: boolean

Defined in

src/clients/affiliateApi/customers.ts:378

id

• id: Object

The unique identifier of the customer 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/customers.ts:43

ip

• ip: Object

Customers IP

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/customers.ts:264

language

• language: Object

Customer 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/customers.ts:180

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/customers.ts:110

modifiedTime

• modifiedTime: Object

The date and time when the customer was last modified

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/customers.ts:348

password

• password: Object

Customer password. Note: Must contain letters and numbers. Size range: 6..12

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/customers.ts:73

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/customers.ts:125

postalCode

• postalCode: Object

Postal code (zip). Size range: 1..15

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/customers.ts:191

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/customers.ts:169

referral

• referral: Object

Customers 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/customers.ts:253

tradesNumber

• tradesNumber: Object

Number of trades that the client has made

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/customers.ts:424

usCitizen

• usCitizen: Object

Is United States citizen

Type declaration

Name	Type
`filters`	{ `match`: `true` }
`filters.match`	`true`
`inCreatePayload`	`true`
`inResponsePayload`	`true`
`inUpdatePayload`	`true`
`requiredInCreatePayload`	`false`
`requiredInUpdatePayload`	`false`
`type`	`boolean`

filters: { match: true }

filters.match: true

inCreatePayload: true

inResponsePayload: true

inUpdatePayload: true

requiredInCreatePayload: false

requiredInUpdatePayload: false

type: boolean

Defined in

src/clients/affiliateApi/customers.ts:213

usTaxId

• usTaxId: Object

United States tax id

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/customers.ts:227

Interface: AffiliateApiCustomerModelDefinition ​

Hierarchy ​

Properties ​

acceptPromotions ​

Type declaration ​

Defined in ​

acceptTermsAndConditions ​

Type declaration ​

Defined in ​

address ​

Type declaration ​

Defined in ​

birthday ​

Type declaration ​

Defined in ​

citizenship ​

Type declaration ​

Defined in ​

city ​

Type declaration ​

Defined in ​

clientSource ​

Type declaration ​

Defined in ​

clientStatus ​

Type declaration ​

Defined in ​

complianceStatus ​

Type declaration ​

Defined in ​

country ​

Type declaration ​

Defined in ​

createdTime ​

Type declaration ​

Defined in ​

crmId ​

Type declaration ​

Defined in ​

currency ​

Type declaration ​

Defined in ​

custom1 ​

Type declaration ​

Defined in ​

custom2 ​

Type declaration ​

Defined in ​

custom3 ​

Type declaration ​

Defined in ​

disabled ​

Type declaration ​

Defined in ​

email ​

Type declaration ​

Defined in ​

firstDepositDate ​

Type declaration ​

Defined in ​

firstName ​

Type declaration ​

Defined in ​

ftd ​

Type declaration ​

Defined in ​

id ​

Type declaration ​

Defined in ​

ip ​

Type declaration ​

Defined in ​

language ​

Type declaration ​

Defined in ​

lastName ​

Type declaration ​

Defined in ​

modifiedTime ​

Type declaration ​

Interface: AffiliateApiCustomerModelDefinition

Hierarchy

Properties

acceptPromotions

Type declaration

Defined in

acceptTermsAndConditions

Type declaration

Defined in

address

Type declaration

Defined in

birthday

Type declaration

Defined in

citizenship

Type declaration

Defined in

city

Type declaration

Defined in

clientSource

Type declaration

Defined in

clientStatus

Type declaration

Defined in

complianceStatus

Type declaration

Defined in

country

Type declaration

Defined in

createdTime

Type declaration

Defined in

crmId

Type declaration

Defined in

currency

Type declaration

Defined in

custom1

Type declaration

Defined in

custom2

Type declaration

Defined in

custom3

Type declaration

Defined in

disabled

Type declaration

Defined in

email

Type declaration

Defined in

firstDepositDate

Type declaration

Defined in

firstName

Type declaration

Defined in

ftd

Type declaration

Defined in

id

Type declaration

Defined in

ip

Type declaration

Defined in

language

Type declaration

Defined in

lastName

Type declaration

Defined in

modifiedTime

Type declaration