@opusdns/api 0.198.0 → 0.200.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/constants.ts +55 -1
- package/src/helpers/keys.ts +1596 -271
- package/src/helpers/requests.d.ts +241 -2
- package/src/helpers/responses.d.ts +408 -4
- package/src/helpers/schemas-arrays.d.ts +44 -30
- package/src/helpers/schemas.d.ts +160 -16
- package/src/openapi.yaml +684 -27
- package/src/schema.d.ts +622 -23
package/src/helpers/keys.ts
CHANGED
|
@@ -30,16 +30,23 @@
|
|
|
30
30
|
*/
|
|
31
31
|
|
|
32
32
|
import { AllowedNumberOfNameserverBase } from './schemas';
|
|
33
|
+
import { AttributeCondition } from './schemas';
|
|
33
34
|
import { BillingMetadata } from './schemas';
|
|
34
35
|
import { BillingPlan } from './schemas';
|
|
35
36
|
import { BillingTransaction } from './schemas';
|
|
36
37
|
import { BrowserStatsBucket } from './schemas';
|
|
37
38
|
import { ContactAttributeDefinition } from './schemas';
|
|
39
|
+
import { ContactAttributeLinkCreate } from './schemas';
|
|
40
|
+
import { ContactAttributeLinkDetail } from './schemas';
|
|
41
|
+
import { ContactAttributeLink } from './schemas';
|
|
42
|
+
import { ContactAttributeSetCreate } from './schemas';
|
|
43
|
+
import { ContactAttributeSet } from './schemas';
|
|
44
|
+
import { ContactAttributeSetUpdate } from './schemas';
|
|
38
45
|
import { ContactConfigBase } from './schemas';
|
|
39
46
|
import { ContactCreate } from './schemas';
|
|
47
|
+
import { ContactDetail } from './schemas';
|
|
40
48
|
import { ContactHandle } from './schemas';
|
|
41
49
|
import { Contact } from './schemas';
|
|
42
|
-
import { ContactRoleAttributeRequirement } from './schemas';
|
|
43
50
|
import { ContactSchema } from './schemas';
|
|
44
51
|
import { ContactVerificationApi } from './schemas';
|
|
45
52
|
import { ContactVerificationEmail } from './schemas';
|
|
@@ -289,6 +296,108 @@ export const KEYS_ALLOWED_NUMBER_OF_NAMESERVER_BASE = [
|
|
|
289
296
|
KEY_ALLOWED_NUMBER_OF_NAMESERVER_BASE_MIN,
|
|
290
297
|
] as const satisfies (keyof AllowedNumberOfNameserverBase)[];
|
|
291
298
|
|
|
299
|
+
/**
|
|
300
|
+
* field property
|
|
301
|
+
*
|
|
302
|
+
* The attribute key to evaluate
|
|
303
|
+
*
|
|
304
|
+
*
|
|
305
|
+
*
|
|
306
|
+
* @remarks
|
|
307
|
+
* This key constant provides type-safe access to the `field` property of AttributeCondition objects.
|
|
308
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
309
|
+
*
|
|
310
|
+
* @example
|
|
311
|
+
* ```typescript
|
|
312
|
+
* // Direct property access
|
|
313
|
+
* const value = attributecondition[KEY_ATTRIBUTE_CONDITION_FIELD];
|
|
314
|
+
*
|
|
315
|
+
* // Dynamic property access
|
|
316
|
+
* const propertyName = KEY_ATTRIBUTE_CONDITION_FIELD;
|
|
317
|
+
* const value = attributecondition[propertyName];
|
|
318
|
+
* ```
|
|
319
|
+
*
|
|
320
|
+
* @see {@link AttributeCondition} - The TypeScript type definition
|
|
321
|
+
* @see {@link KEYS_ATTRIBUTE_CONDITION} - Array of all keys for this type
|
|
322
|
+
*/
|
|
323
|
+
export const KEY_ATTRIBUTE_CONDITION_FIELD: keyof AttributeCondition = 'field';
|
|
324
|
+
/**
|
|
325
|
+
* operator property
|
|
326
|
+
*
|
|
327
|
+
* The comparison operator
|
|
328
|
+
*
|
|
329
|
+
*
|
|
330
|
+
*
|
|
331
|
+
* @remarks
|
|
332
|
+
* This key constant provides type-safe access to the `operator` property of AttributeCondition objects.
|
|
333
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
334
|
+
*
|
|
335
|
+
* @example
|
|
336
|
+
* ```typescript
|
|
337
|
+
* // Direct property access
|
|
338
|
+
* const value = attributecondition[KEY_ATTRIBUTE_CONDITION_OPERATOR];
|
|
339
|
+
*
|
|
340
|
+
* // Dynamic property access
|
|
341
|
+
* const propertyName = KEY_ATTRIBUTE_CONDITION_OPERATOR;
|
|
342
|
+
* const value = attributecondition[propertyName];
|
|
343
|
+
* ```
|
|
344
|
+
*
|
|
345
|
+
* @see {@link AttributeCondition} - The TypeScript type definition
|
|
346
|
+
* @see {@link KEYS_ATTRIBUTE_CONDITION} - Array of all keys for this type
|
|
347
|
+
*/
|
|
348
|
+
export const KEY_ATTRIBUTE_CONDITION_OPERATOR: keyof AttributeCondition = 'operator';
|
|
349
|
+
/**
|
|
350
|
+
* Value
|
|
351
|
+
*
|
|
352
|
+
* The value(s) to compare against
|
|
353
|
+
*
|
|
354
|
+
*
|
|
355
|
+
*
|
|
356
|
+
* @remarks
|
|
357
|
+
* This key constant provides type-safe access to the `value` property of AttributeCondition objects.
|
|
358
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
359
|
+
*
|
|
360
|
+
* @example
|
|
361
|
+
* ```typescript
|
|
362
|
+
* // Direct property access
|
|
363
|
+
* const value = attributecondition[KEY_ATTRIBUTE_CONDITION_VALUE];
|
|
364
|
+
*
|
|
365
|
+
* // Dynamic property access
|
|
366
|
+
* const propertyName = KEY_ATTRIBUTE_CONDITION_VALUE;
|
|
367
|
+
* const value = attributecondition[propertyName];
|
|
368
|
+
* ```
|
|
369
|
+
*
|
|
370
|
+
* @see {@link AttributeCondition} - The TypeScript type definition
|
|
371
|
+
* @see {@link KEYS_ATTRIBUTE_CONDITION} - Array of all keys for this type
|
|
372
|
+
*/
|
|
373
|
+
export const KEY_ATTRIBUTE_CONDITION_VALUE: keyof AttributeCondition = 'value';
|
|
374
|
+
|
|
375
|
+
/**
|
|
376
|
+
* Array of all AttributeCondition property keys
|
|
377
|
+
*
|
|
378
|
+
* @remarks
|
|
379
|
+
* This constant provides a readonly array containing all valid property keys for AttributeCondition objects.
|
|
380
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
381
|
+
*
|
|
382
|
+
* @example
|
|
383
|
+
* ```typescript
|
|
384
|
+
* // Iterating through all keys
|
|
385
|
+
* for (const key of KEYS_ATTRIBUTE_CONDITION) {
|
|
386
|
+
* console.log(`Property: ${key}, Value: ${attributecondition[key]}`);
|
|
387
|
+
* }
|
|
388
|
+
*
|
|
389
|
+
* // Validation
|
|
390
|
+
* const isValidKey = KEYS_ATTRIBUTE_CONDITION.includes(someKey);
|
|
391
|
+
* ```
|
|
392
|
+
*
|
|
393
|
+
* @see {@link AttributeCondition} - The TypeScript type definition
|
|
394
|
+
*/
|
|
395
|
+
export const KEYS_ATTRIBUTE_CONDITION = [
|
|
396
|
+
KEY_ATTRIBUTE_CONDITION_FIELD,
|
|
397
|
+
KEY_ATTRIBUTE_CONDITION_OPERATOR,
|
|
398
|
+
KEY_ATTRIBUTE_CONDITION_VALUE,
|
|
399
|
+
] as const satisfies (keyof AttributeCondition)[];
|
|
400
|
+
|
|
292
401
|
/**
|
|
293
402
|
* Billing Model
|
|
294
403
|
*
|
|
@@ -1042,6 +1151,56 @@ export const KEYS_BROWSER_STATS_BUCKET = [
|
|
|
1042
1151
|
KEY_BROWSER_STATS_BUCKET_UNIQUE,
|
|
1043
1152
|
] as const satisfies (keyof BrowserStatsBucket)[];
|
|
1044
1153
|
|
|
1154
|
+
/**
|
|
1155
|
+
* Conditions
|
|
1156
|
+
*
|
|
1157
|
+
* Conditions that must ALL be true for this attribute to be active. None means always active.
|
|
1158
|
+
*
|
|
1159
|
+
*
|
|
1160
|
+
*
|
|
1161
|
+
* @remarks
|
|
1162
|
+
* This key constant provides type-safe access to the `conditions` property of ContactAttributeDefinition objects.
|
|
1163
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1164
|
+
*
|
|
1165
|
+
* @example
|
|
1166
|
+
* ```typescript
|
|
1167
|
+
* // Direct property access
|
|
1168
|
+
* const value = contactattributedefinition[KEY_CONTACT_ATTRIBUTE_DEFINITION_CONDITIONS];
|
|
1169
|
+
*
|
|
1170
|
+
* // Dynamic property access
|
|
1171
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_DEFINITION_CONDITIONS;
|
|
1172
|
+
* const value = contactattributedefinition[propertyName];
|
|
1173
|
+
* ```
|
|
1174
|
+
*
|
|
1175
|
+
* @see {@link ContactAttributeDefinition} - The TypeScript type definition
|
|
1176
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_DEFINITION} - Array of all keys for this type
|
|
1177
|
+
*/
|
|
1178
|
+
export const KEY_CONTACT_ATTRIBUTE_DEFINITION_CONDITIONS: keyof ContactAttributeDefinition = 'conditions';
|
|
1179
|
+
/**
|
|
1180
|
+
* Contact Roles
|
|
1181
|
+
*
|
|
1182
|
+
* Contact roles this attribute applies to. None means all roles.
|
|
1183
|
+
*
|
|
1184
|
+
*
|
|
1185
|
+
*
|
|
1186
|
+
* @remarks
|
|
1187
|
+
* This key constant provides type-safe access to the `contact_roles` property of ContactAttributeDefinition objects.
|
|
1188
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1189
|
+
*
|
|
1190
|
+
* @example
|
|
1191
|
+
* ```typescript
|
|
1192
|
+
* // Direct property access
|
|
1193
|
+
* const value = contactattributedefinition[KEY_CONTACT_ATTRIBUTE_DEFINITION_CONTACT_ROLES];
|
|
1194
|
+
*
|
|
1195
|
+
* // Dynamic property access
|
|
1196
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_DEFINITION_CONTACT_ROLES;
|
|
1197
|
+
* const value = contactattributedefinition[propertyName];
|
|
1198
|
+
* ```
|
|
1199
|
+
*
|
|
1200
|
+
* @see {@link ContactAttributeDefinition} - The TypeScript type definition
|
|
1201
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_DEFINITION} - Array of all keys for this type
|
|
1202
|
+
*/
|
|
1203
|
+
export const KEY_CONTACT_ATTRIBUTE_DEFINITION_CONTACT_ROLES: keyof ContactAttributeDefinition = 'contact_roles';
|
|
1045
1204
|
/**
|
|
1046
1205
|
* key property
|
|
1047
1206
|
*
|
|
@@ -1067,6 +1226,32 @@ export const KEYS_BROWSER_STATS_BUCKET = [
|
|
|
1067
1226
|
* @see {@link KEYS_CONTACT_ATTRIBUTE_DEFINITION} - Array of all keys for this type
|
|
1068
1227
|
*/
|
|
1069
1228
|
export const KEY_CONTACT_ATTRIBUTE_DEFINITION_KEY: keyof ContactAttributeDefinition = 'key';
|
|
1229
|
+
/**
|
|
1230
|
+
* Required
|
|
1231
|
+
*
|
|
1232
|
+
* Whether this attribute is required when its conditions are met
|
|
1233
|
+
*
|
|
1234
|
+
* @type {boolean}
|
|
1235
|
+
*
|
|
1236
|
+
*
|
|
1237
|
+
* @remarks
|
|
1238
|
+
* This key constant provides type-safe access to the `required` property of ContactAttributeDefinition objects.
|
|
1239
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1240
|
+
*
|
|
1241
|
+
* @example
|
|
1242
|
+
* ```typescript
|
|
1243
|
+
* // Direct property access
|
|
1244
|
+
* const value = contactattributedefinition[KEY_CONTACT_ATTRIBUTE_DEFINITION_REQUIRED];
|
|
1245
|
+
*
|
|
1246
|
+
* // Dynamic property access
|
|
1247
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_DEFINITION_REQUIRED;
|
|
1248
|
+
* const value = contactattributedefinition[propertyName];
|
|
1249
|
+
* ```
|
|
1250
|
+
*
|
|
1251
|
+
* @see {@link ContactAttributeDefinition} - The TypeScript type definition
|
|
1252
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_DEFINITION} - Array of all keys for this type
|
|
1253
|
+
*/
|
|
1254
|
+
export const KEY_CONTACT_ATTRIBUTE_DEFINITION_REQUIRED: keyof ContactAttributeDefinition = 'required';
|
|
1070
1255
|
/**
|
|
1071
1256
|
* type property
|
|
1072
1257
|
*
|
|
@@ -1139,167 +1324,1380 @@ export const KEY_CONTACT_ATTRIBUTE_DEFINITION_VALUES: keyof ContactAttributeDefi
|
|
|
1139
1324
|
* @see {@link ContactAttributeDefinition} - The TypeScript type definition
|
|
1140
1325
|
*/
|
|
1141
1326
|
export const KEYS_CONTACT_ATTRIBUTE_DEFINITION = [
|
|
1327
|
+
KEY_CONTACT_ATTRIBUTE_DEFINITION_CONDITIONS,
|
|
1328
|
+
KEY_CONTACT_ATTRIBUTE_DEFINITION_CONTACT_ROLES,
|
|
1142
1329
|
KEY_CONTACT_ATTRIBUTE_DEFINITION_KEY,
|
|
1330
|
+
KEY_CONTACT_ATTRIBUTE_DEFINITION_REQUIRED,
|
|
1143
1331
|
KEY_CONTACT_ATTRIBUTE_DEFINITION_TYPE,
|
|
1144
1332
|
KEY_CONTACT_ATTRIBUTE_DEFINITION_VALUES,
|
|
1145
1333
|
] as const satisfies (keyof ContactAttributeDefinition)[];
|
|
1146
1334
|
|
|
1147
1335
|
/**
|
|
1148
|
-
*
|
|
1336
|
+
* Contact Attribute Set Id
|
|
1149
1337
|
*
|
|
1150
|
-
*
|
|
1338
|
+
* The attribute set to link to the contact
|
|
1151
1339
|
*
|
|
1152
|
-
* @type {
|
|
1340
|
+
* @type {string}
|
|
1153
1341
|
*
|
|
1154
1342
|
*
|
|
1155
1343
|
* @remarks
|
|
1156
|
-
* This key constant provides type-safe access to the `
|
|
1344
|
+
* This key constant provides type-safe access to the `contact_attribute_set_id` property of ContactAttributeLinkCreate objects.
|
|
1157
1345
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1158
1346
|
*
|
|
1159
1347
|
* @example
|
|
1160
1348
|
* ```typescript
|
|
1161
1349
|
* // Direct property access
|
|
1162
|
-
* const value =
|
|
1350
|
+
* const value = contactattributelinkcreate[KEY_CONTACT_ATTRIBUTE_LINK_CREATE_CONTACT_ATTRIBUTE_SET_ID];
|
|
1163
1351
|
*
|
|
1164
1352
|
* // Dynamic property access
|
|
1165
|
-
* const propertyName =
|
|
1166
|
-
* const value =
|
|
1353
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CREATE_CONTACT_ATTRIBUTE_SET_ID;
|
|
1354
|
+
* const value = contactattributelinkcreate[propertyName];
|
|
1167
1355
|
* ```
|
|
1168
1356
|
*
|
|
1169
|
-
* @see {@link
|
|
1170
|
-
* @see {@link
|
|
1357
|
+
* @see {@link ContactAttributeLinkCreate} - The TypeScript type definition
|
|
1358
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_CREATE} - Array of all keys for this type
|
|
1171
1359
|
*/
|
|
1172
|
-
export const
|
|
1360
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CREATE_CONTACT_ATTRIBUTE_SET_ID: keyof ContactAttributeLinkCreate = 'contact_attribute_set_id';
|
|
1173
1361
|
/**
|
|
1174
|
-
*
|
|
1362
|
+
* Contact Id
|
|
1175
1363
|
*
|
|
1176
|
-
*
|
|
1364
|
+
* The contact to link
|
|
1177
1365
|
*
|
|
1178
|
-
* @type {
|
|
1366
|
+
* @type {string}
|
|
1179
1367
|
*
|
|
1180
1368
|
*
|
|
1181
1369
|
* @remarks
|
|
1182
|
-
* This key constant provides type-safe access to the `
|
|
1370
|
+
* This key constant provides type-safe access to the `contact_id` property of ContactAttributeLinkCreate objects.
|
|
1371
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1372
|
+
*
|
|
1373
|
+
* @example
|
|
1374
|
+
* ```typescript
|
|
1375
|
+
* // Direct property access
|
|
1376
|
+
* const value = contactattributelinkcreate[KEY_CONTACT_ATTRIBUTE_LINK_CREATE_CONTACT_ID];
|
|
1377
|
+
*
|
|
1378
|
+
* // Dynamic property access
|
|
1379
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CREATE_CONTACT_ID;
|
|
1380
|
+
* const value = contactattributelinkcreate[propertyName];
|
|
1381
|
+
* ```
|
|
1382
|
+
*
|
|
1383
|
+
* @see {@link ContactAttributeLinkCreate} - The TypeScript type definition
|
|
1384
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_CREATE} - Array of all keys for this type
|
|
1385
|
+
*/
|
|
1386
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CREATE_CONTACT_ID: keyof ContactAttributeLinkCreate = 'contact_id';
|
|
1387
|
+
|
|
1388
|
+
/**
|
|
1389
|
+
* Array of all ContactAttributeLinkCreate property keys
|
|
1390
|
+
*
|
|
1391
|
+
* @remarks
|
|
1392
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeLinkCreate objects.
|
|
1393
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1394
|
+
*
|
|
1395
|
+
* @example
|
|
1396
|
+
* ```typescript
|
|
1397
|
+
* // Iterating through all keys
|
|
1398
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_LINK_CREATE) {
|
|
1399
|
+
* console.log(`Property: ${key}, Value: ${contactattributelinkcreate[key]}`);
|
|
1400
|
+
* }
|
|
1401
|
+
*
|
|
1402
|
+
* // Validation
|
|
1403
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_LINK_CREATE.includes(someKey);
|
|
1404
|
+
* ```
|
|
1405
|
+
*
|
|
1406
|
+
* @see {@link ContactAttributeLinkCreate} - The TypeScript type definition
|
|
1407
|
+
*/
|
|
1408
|
+
export const KEYS_CONTACT_ATTRIBUTE_LINK_CREATE = [
|
|
1409
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CREATE_CONTACT_ATTRIBUTE_SET_ID,
|
|
1410
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CREATE_CONTACT_ID,
|
|
1411
|
+
] as const satisfies (keyof ContactAttributeLinkCreate)[];
|
|
1412
|
+
|
|
1413
|
+
/**
|
|
1414
|
+
* Attributes
|
|
1415
|
+
*
|
|
1416
|
+
* The attributes from the linked set
|
|
1417
|
+
*
|
|
1418
|
+
* @type {object}
|
|
1419
|
+
*
|
|
1420
|
+
*
|
|
1421
|
+
* @remarks
|
|
1422
|
+
* This key constant provides type-safe access to the `attributes` property of ContactAttributeLinkDetail objects.
|
|
1423
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1424
|
+
*
|
|
1425
|
+
* @example
|
|
1426
|
+
* ```typescript
|
|
1427
|
+
* // Direct property access
|
|
1428
|
+
* const value = contactattributelinkdetail[KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_ATTRIBUTES];
|
|
1429
|
+
*
|
|
1430
|
+
* // Dynamic property access
|
|
1431
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_ATTRIBUTES;
|
|
1432
|
+
* const value = contactattributelinkdetail[propertyName];
|
|
1433
|
+
* ```
|
|
1434
|
+
*
|
|
1435
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1436
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL} - Array of all keys for this type
|
|
1437
|
+
*/
|
|
1438
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_ATTRIBUTES: keyof ContactAttributeLinkDetail = 'attributes';
|
|
1439
|
+
/**
|
|
1440
|
+
* Contact Attribute Set Id
|
|
1441
|
+
*
|
|
1442
|
+
* The attribute set linked to the contact
|
|
1443
|
+
*
|
|
1444
|
+
* @type {string}
|
|
1445
|
+
*
|
|
1446
|
+
*
|
|
1447
|
+
* @remarks
|
|
1448
|
+
* This key constant provides type-safe access to the `contact_attribute_set_id` property of ContactAttributeLinkDetail objects.
|
|
1449
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1450
|
+
*
|
|
1451
|
+
* @example
|
|
1452
|
+
* ```typescript
|
|
1453
|
+
* // Direct property access
|
|
1454
|
+
* const value = contactattributelinkdetail[KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_CONTACT_ATTRIBUTE_SET_ID];
|
|
1455
|
+
*
|
|
1456
|
+
* // Dynamic property access
|
|
1457
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_CONTACT_ATTRIBUTE_SET_ID;
|
|
1458
|
+
* const value = contactattributelinkdetail[propertyName];
|
|
1459
|
+
* ```
|
|
1460
|
+
*
|
|
1461
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1462
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL} - Array of all keys for this type
|
|
1463
|
+
*/
|
|
1464
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_CONTACT_ATTRIBUTE_SET_ID: keyof ContactAttributeLinkDetail = 'contact_attribute_set_id';
|
|
1465
|
+
/**
|
|
1466
|
+
* Label
|
|
1467
|
+
*
|
|
1468
|
+
* The label of the linked attribute set
|
|
1469
|
+
*
|
|
1470
|
+
* @type {string}
|
|
1471
|
+
*
|
|
1472
|
+
*
|
|
1473
|
+
* @remarks
|
|
1474
|
+
* This key constant provides type-safe access to the `label` property of ContactAttributeLinkDetail objects.
|
|
1475
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1476
|
+
*
|
|
1477
|
+
* @example
|
|
1478
|
+
* ```typescript
|
|
1479
|
+
* // Direct property access
|
|
1480
|
+
* const value = contactattributelinkdetail[KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_LABEL];
|
|
1481
|
+
*
|
|
1482
|
+
* // Dynamic property access
|
|
1483
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_LABEL;
|
|
1484
|
+
* const value = contactattributelinkdetail[propertyName];
|
|
1485
|
+
* ```
|
|
1486
|
+
*
|
|
1487
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1488
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL} - Array of all keys for this type
|
|
1489
|
+
*/
|
|
1490
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_LABEL: keyof ContactAttributeLinkDetail = 'label';
|
|
1491
|
+
/**
|
|
1492
|
+
* Tld
|
|
1493
|
+
*
|
|
1494
|
+
* The TLD this link applies to
|
|
1495
|
+
*
|
|
1496
|
+
* @type {string}
|
|
1497
|
+
*
|
|
1498
|
+
*
|
|
1499
|
+
* @remarks
|
|
1500
|
+
* This key constant provides type-safe access to the `tld` property of ContactAttributeLinkDetail objects.
|
|
1501
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1502
|
+
*
|
|
1503
|
+
* @example
|
|
1504
|
+
* ```typescript
|
|
1505
|
+
* // Direct property access
|
|
1506
|
+
* const value = contactattributelinkdetail[KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_TLD];
|
|
1507
|
+
*
|
|
1508
|
+
* // Dynamic property access
|
|
1509
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_TLD;
|
|
1510
|
+
* const value = contactattributelinkdetail[propertyName];
|
|
1511
|
+
* ```
|
|
1512
|
+
*
|
|
1513
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1514
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL} - Array of all keys for this type
|
|
1515
|
+
*/
|
|
1516
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_TLD: keyof ContactAttributeLinkDetail = 'tld';
|
|
1517
|
+
|
|
1518
|
+
/**
|
|
1519
|
+
* Array of all ContactAttributeLinkDetail property keys
|
|
1520
|
+
*
|
|
1521
|
+
* @remarks
|
|
1522
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeLinkDetail objects.
|
|
1523
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1524
|
+
*
|
|
1525
|
+
* @example
|
|
1526
|
+
* ```typescript
|
|
1527
|
+
* // Iterating through all keys
|
|
1528
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL) {
|
|
1529
|
+
* console.log(`Property: ${key}, Value: ${contactattributelinkdetail[key]}`);
|
|
1530
|
+
* }
|
|
1531
|
+
*
|
|
1532
|
+
* // Validation
|
|
1533
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL.includes(someKey);
|
|
1534
|
+
* ```
|
|
1535
|
+
*
|
|
1536
|
+
* @see {@link ContactAttributeLinkDetail} - The TypeScript type definition
|
|
1537
|
+
*/
|
|
1538
|
+
export const KEYS_CONTACT_ATTRIBUTE_LINK_DETAIL = [
|
|
1539
|
+
KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_ATTRIBUTES,
|
|
1540
|
+
KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_CONTACT_ATTRIBUTE_SET_ID,
|
|
1541
|
+
KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_LABEL,
|
|
1542
|
+
KEY_CONTACT_ATTRIBUTE_LINK_DETAIL_TLD,
|
|
1543
|
+
] as const satisfies (keyof ContactAttributeLinkDetail)[];
|
|
1544
|
+
|
|
1545
|
+
/**
|
|
1546
|
+
* Contact Attribute Link Id
|
|
1547
|
+
*
|
|
1548
|
+
* The unique identifier of the link
|
|
1549
|
+
*
|
|
1550
|
+
* @type {string}
|
|
1551
|
+
*
|
|
1552
|
+
*
|
|
1553
|
+
* @remarks
|
|
1554
|
+
* This key constant provides type-safe access to the `contact_attribute_link_id` property of ContactAttributeLink objects.
|
|
1555
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1556
|
+
*
|
|
1557
|
+
* @example
|
|
1558
|
+
* ```typescript
|
|
1559
|
+
* // Direct property access
|
|
1560
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_LINK_ID];
|
|
1561
|
+
*
|
|
1562
|
+
* // Dynamic property access
|
|
1563
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_LINK_ID;
|
|
1564
|
+
* const value = contactattributelink[propertyName];
|
|
1565
|
+
* ```
|
|
1566
|
+
*
|
|
1567
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1568
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1569
|
+
*/
|
|
1570
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_LINK_ID: keyof ContactAttributeLink = 'contact_attribute_link_id';
|
|
1571
|
+
/**
|
|
1572
|
+
* Contact Attribute Set Id
|
|
1573
|
+
*
|
|
1574
|
+
* The attribute set linked to the contact
|
|
1575
|
+
*
|
|
1576
|
+
* @type {string}
|
|
1577
|
+
*
|
|
1578
|
+
*
|
|
1579
|
+
* @remarks
|
|
1580
|
+
* This key constant provides type-safe access to the `contact_attribute_set_id` property of ContactAttributeLink objects.
|
|
1581
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1582
|
+
*
|
|
1583
|
+
* @example
|
|
1584
|
+
* ```typescript
|
|
1585
|
+
* // Direct property access
|
|
1586
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_SET_ID];
|
|
1587
|
+
*
|
|
1588
|
+
* // Dynamic property access
|
|
1589
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_SET_ID;
|
|
1590
|
+
* const value = contactattributelink[propertyName];
|
|
1591
|
+
* ```
|
|
1592
|
+
*
|
|
1593
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1594
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1595
|
+
*/
|
|
1596
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_SET_ID: keyof ContactAttributeLink = 'contact_attribute_set_id';
|
|
1597
|
+
/**
|
|
1598
|
+
* Contact Id
|
|
1599
|
+
*
|
|
1600
|
+
* The contact this link belongs to
|
|
1601
|
+
*
|
|
1602
|
+
* @type {string}
|
|
1603
|
+
*
|
|
1604
|
+
*
|
|
1605
|
+
* @remarks
|
|
1606
|
+
* This key constant provides type-safe access to the `contact_id` property of ContactAttributeLink objects.
|
|
1607
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1608
|
+
*
|
|
1609
|
+
* @example
|
|
1610
|
+
* ```typescript
|
|
1611
|
+
* // Direct property access
|
|
1612
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ID];
|
|
1613
|
+
*
|
|
1614
|
+
* // Dynamic property access
|
|
1615
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ID;
|
|
1616
|
+
* const value = contactattributelink[propertyName];
|
|
1617
|
+
* ```
|
|
1618
|
+
*
|
|
1619
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1620
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1621
|
+
*/
|
|
1622
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ID: keyof ContactAttributeLink = 'contact_id';
|
|
1623
|
+
/**
|
|
1624
|
+
* Created On
|
|
1625
|
+
*
|
|
1626
|
+
* The date/time the entry was created on
|
|
1627
|
+
*
|
|
1628
|
+
* @type {string}
|
|
1629
|
+
*
|
|
1630
|
+
*
|
|
1631
|
+
* @remarks
|
|
1632
|
+
* This key constant provides type-safe access to the `created_on` property of ContactAttributeLink objects.
|
|
1633
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1634
|
+
*
|
|
1635
|
+
* @example
|
|
1636
|
+
* ```typescript
|
|
1637
|
+
* // Direct property access
|
|
1638
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_CREATED_ON];
|
|
1639
|
+
*
|
|
1640
|
+
* // Dynamic property access
|
|
1641
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_CREATED_ON;
|
|
1642
|
+
* const value = contactattributelink[propertyName];
|
|
1643
|
+
* ```
|
|
1644
|
+
*
|
|
1645
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1646
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1647
|
+
*/
|
|
1648
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_CREATED_ON: keyof ContactAttributeLink = 'created_on';
|
|
1649
|
+
/**
|
|
1650
|
+
* Tld
|
|
1651
|
+
*
|
|
1652
|
+
* The TLD this link applies to
|
|
1653
|
+
*
|
|
1654
|
+
* @type {string}
|
|
1655
|
+
*
|
|
1656
|
+
*
|
|
1657
|
+
* @remarks
|
|
1658
|
+
* This key constant provides type-safe access to the `tld` property of ContactAttributeLink objects.
|
|
1659
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1660
|
+
*
|
|
1661
|
+
* @example
|
|
1662
|
+
* ```typescript
|
|
1663
|
+
* // Direct property access
|
|
1664
|
+
* const value = contactattributelink[KEY_CONTACT_ATTRIBUTE_LINK_TLD];
|
|
1665
|
+
*
|
|
1666
|
+
* // Dynamic property access
|
|
1667
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_LINK_TLD;
|
|
1668
|
+
* const value = contactattributelink[propertyName];
|
|
1669
|
+
* ```
|
|
1670
|
+
*
|
|
1671
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1672
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_LINK} - Array of all keys for this type
|
|
1673
|
+
*/
|
|
1674
|
+
export const KEY_CONTACT_ATTRIBUTE_LINK_TLD: keyof ContactAttributeLink = 'tld';
|
|
1675
|
+
|
|
1676
|
+
/**
|
|
1677
|
+
* Array of all ContactAttributeLink property keys
|
|
1678
|
+
*
|
|
1679
|
+
* @remarks
|
|
1680
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeLink objects.
|
|
1681
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1682
|
+
*
|
|
1683
|
+
* @example
|
|
1684
|
+
* ```typescript
|
|
1685
|
+
* // Iterating through all keys
|
|
1686
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_LINK) {
|
|
1687
|
+
* console.log(`Property: ${key}, Value: ${contactattributelink[key]}`);
|
|
1688
|
+
* }
|
|
1689
|
+
*
|
|
1690
|
+
* // Validation
|
|
1691
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_LINK.includes(someKey);
|
|
1692
|
+
* ```
|
|
1693
|
+
*
|
|
1694
|
+
* @see {@link ContactAttributeLink} - The TypeScript type definition
|
|
1695
|
+
*/
|
|
1696
|
+
export const KEYS_CONTACT_ATTRIBUTE_LINK = [
|
|
1697
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_LINK_ID,
|
|
1698
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ATTRIBUTE_SET_ID,
|
|
1699
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CONTACT_ID,
|
|
1700
|
+
KEY_CONTACT_ATTRIBUTE_LINK_CREATED_ON,
|
|
1701
|
+
KEY_CONTACT_ATTRIBUTE_LINK_TLD,
|
|
1702
|
+
] as const satisfies (keyof ContactAttributeLink)[];
|
|
1703
|
+
|
|
1704
|
+
/**
|
|
1705
|
+
* Attributes
|
|
1706
|
+
*
|
|
1707
|
+
* Key-value map of contact attributes for this set
|
|
1708
|
+
*
|
|
1709
|
+
* @type {object}
|
|
1710
|
+
*
|
|
1711
|
+
*
|
|
1712
|
+
* @remarks
|
|
1713
|
+
* This key constant provides type-safe access to the `attributes` property of ContactAttributeSetCreate objects.
|
|
1714
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1715
|
+
*
|
|
1716
|
+
* @example
|
|
1717
|
+
* ```typescript
|
|
1718
|
+
* // Direct property access
|
|
1719
|
+
* const value = contactattributesetcreate[KEY_CONTACT_ATTRIBUTE_SET_CREATE_ATTRIBUTES];
|
|
1720
|
+
*
|
|
1721
|
+
* // Dynamic property access
|
|
1722
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CREATE_ATTRIBUTES;
|
|
1723
|
+
* const value = contactattributesetcreate[propertyName];
|
|
1724
|
+
* ```
|
|
1725
|
+
*
|
|
1726
|
+
* @see {@link ContactAttributeSetCreate} - The TypeScript type definition
|
|
1727
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET_CREATE} - Array of all keys for this type
|
|
1728
|
+
*/
|
|
1729
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CREATE_ATTRIBUTES: keyof ContactAttributeSetCreate = 'attributes';
|
|
1730
|
+
/**
|
|
1731
|
+
* Label
|
|
1732
|
+
*
|
|
1733
|
+
* A human-readable label explaining the purpose of this attribute set
|
|
1734
|
+
*
|
|
1735
|
+
* @type {string}
|
|
1736
|
+
*
|
|
1737
|
+
*
|
|
1738
|
+
* @remarks
|
|
1739
|
+
* This key constant provides type-safe access to the `label` property of ContactAttributeSetCreate objects.
|
|
1740
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1741
|
+
*
|
|
1742
|
+
* @example
|
|
1743
|
+
* ```typescript
|
|
1744
|
+
* // Direct property access
|
|
1745
|
+
* const value = contactattributesetcreate[KEY_CONTACT_ATTRIBUTE_SET_CREATE_LABEL];
|
|
1746
|
+
*
|
|
1747
|
+
* // Dynamic property access
|
|
1748
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CREATE_LABEL;
|
|
1749
|
+
* const value = contactattributesetcreate[propertyName];
|
|
1750
|
+
* ```
|
|
1751
|
+
*
|
|
1752
|
+
* @see {@link ContactAttributeSetCreate} - The TypeScript type definition
|
|
1753
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET_CREATE} - Array of all keys for this type
|
|
1754
|
+
*/
|
|
1755
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CREATE_LABEL: keyof ContactAttributeSetCreate = 'label';
|
|
1756
|
+
/**
|
|
1757
|
+
* Tld
|
|
1758
|
+
*
|
|
1759
|
+
* The TLD this attribute set applies to (e.g. 'de', '.de', 'DE')
|
|
1760
|
+
*
|
|
1761
|
+
* @type {string}
|
|
1762
|
+
*
|
|
1763
|
+
*
|
|
1764
|
+
* @remarks
|
|
1765
|
+
* This key constant provides type-safe access to the `tld` property of ContactAttributeSetCreate objects.
|
|
1766
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1767
|
+
*
|
|
1768
|
+
* @example
|
|
1769
|
+
* ```typescript
|
|
1770
|
+
* // Direct property access
|
|
1771
|
+
* const value = contactattributesetcreate[KEY_CONTACT_ATTRIBUTE_SET_CREATE_TLD];
|
|
1772
|
+
*
|
|
1773
|
+
* // Dynamic property access
|
|
1774
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CREATE_TLD;
|
|
1775
|
+
* const value = contactattributesetcreate[propertyName];
|
|
1776
|
+
* ```
|
|
1777
|
+
*
|
|
1778
|
+
* @see {@link ContactAttributeSetCreate} - The TypeScript type definition
|
|
1779
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET_CREATE} - Array of all keys for this type
|
|
1780
|
+
*/
|
|
1781
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CREATE_TLD: keyof ContactAttributeSetCreate = 'tld';
|
|
1782
|
+
|
|
1783
|
+
/**
|
|
1784
|
+
* Array of all ContactAttributeSetCreate property keys
|
|
1785
|
+
*
|
|
1786
|
+
* @remarks
|
|
1787
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeSetCreate objects.
|
|
1788
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1789
|
+
*
|
|
1790
|
+
* @example
|
|
1791
|
+
* ```typescript
|
|
1792
|
+
* // Iterating through all keys
|
|
1793
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_SET_CREATE) {
|
|
1794
|
+
* console.log(`Property: ${key}, Value: ${contactattributesetcreate[key]}`);
|
|
1795
|
+
* }
|
|
1796
|
+
*
|
|
1797
|
+
* // Validation
|
|
1798
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_SET_CREATE.includes(someKey);
|
|
1799
|
+
* ```
|
|
1800
|
+
*
|
|
1801
|
+
* @see {@link ContactAttributeSetCreate} - The TypeScript type definition
|
|
1802
|
+
*/
|
|
1803
|
+
export const KEYS_CONTACT_ATTRIBUTE_SET_CREATE = [
|
|
1804
|
+
KEY_CONTACT_ATTRIBUTE_SET_CREATE_ATTRIBUTES,
|
|
1805
|
+
KEY_CONTACT_ATTRIBUTE_SET_CREATE_LABEL,
|
|
1806
|
+
KEY_CONTACT_ATTRIBUTE_SET_CREATE_TLD,
|
|
1807
|
+
] as const satisfies (keyof ContactAttributeSetCreate)[];
|
|
1808
|
+
|
|
1809
|
+
/**
|
|
1810
|
+
* Attributes
|
|
1811
|
+
*
|
|
1812
|
+
* Key-value map of contact attributes for this set
|
|
1813
|
+
*
|
|
1814
|
+
* @type {object}
|
|
1815
|
+
*
|
|
1816
|
+
*
|
|
1817
|
+
* @remarks
|
|
1818
|
+
* This key constant provides type-safe access to the `attributes` property of ContactAttributeSet objects.
|
|
1819
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1820
|
+
*
|
|
1821
|
+
* @example
|
|
1822
|
+
* ```typescript
|
|
1823
|
+
* // Direct property access
|
|
1824
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_ATTRIBUTES];
|
|
1825
|
+
*
|
|
1826
|
+
* // Dynamic property access
|
|
1827
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_ATTRIBUTES;
|
|
1828
|
+
* const value = contactattributeset[propertyName];
|
|
1829
|
+
* ```
|
|
1830
|
+
*
|
|
1831
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1832
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1833
|
+
*/
|
|
1834
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_ATTRIBUTES: keyof ContactAttributeSet = 'attributes';
|
|
1835
|
+
/**
|
|
1836
|
+
* Contact Attribute Set Id
|
|
1837
|
+
*
|
|
1838
|
+
* The unique identifier of the attribute set
|
|
1839
|
+
*
|
|
1840
|
+
* @type {string}
|
|
1841
|
+
*
|
|
1842
|
+
*
|
|
1843
|
+
* @remarks
|
|
1844
|
+
* This key constant provides type-safe access to the `contact_attribute_set_id` property of ContactAttributeSet objects.
|
|
1845
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1846
|
+
*
|
|
1847
|
+
* @example
|
|
1848
|
+
* ```typescript
|
|
1849
|
+
* // Direct property access
|
|
1850
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID];
|
|
1851
|
+
*
|
|
1852
|
+
* // Dynamic property access
|
|
1853
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID;
|
|
1854
|
+
* const value = contactattributeset[propertyName];
|
|
1855
|
+
* ```
|
|
1856
|
+
*
|
|
1857
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1858
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1859
|
+
*/
|
|
1860
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID: keyof ContactAttributeSet = 'contact_attribute_set_id';
|
|
1861
|
+
/**
|
|
1862
|
+
* Created On
|
|
1863
|
+
*
|
|
1864
|
+
* The date/time the entry was created on
|
|
1865
|
+
*
|
|
1866
|
+
* @type {string}
|
|
1867
|
+
*
|
|
1868
|
+
*
|
|
1869
|
+
* @remarks
|
|
1870
|
+
* This key constant provides type-safe access to the `created_on` property of ContactAttributeSet objects.
|
|
1871
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1872
|
+
*
|
|
1873
|
+
* @example
|
|
1874
|
+
* ```typescript
|
|
1875
|
+
* // Direct property access
|
|
1876
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON];
|
|
1877
|
+
*
|
|
1878
|
+
* // Dynamic property access
|
|
1879
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON;
|
|
1880
|
+
* const value = contactattributeset[propertyName];
|
|
1881
|
+
* ```
|
|
1882
|
+
*
|
|
1883
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1884
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1885
|
+
*/
|
|
1886
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON: keyof ContactAttributeSet = 'created_on';
|
|
1887
|
+
/**
|
|
1888
|
+
* Label
|
|
1889
|
+
*
|
|
1890
|
+
* A human-readable label explaining the purpose of this attribute set
|
|
1891
|
+
*
|
|
1892
|
+
* @type {string}
|
|
1893
|
+
*
|
|
1894
|
+
*
|
|
1895
|
+
* @remarks
|
|
1896
|
+
* This key constant provides type-safe access to the `label` property of ContactAttributeSet objects.
|
|
1897
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1898
|
+
*
|
|
1899
|
+
* @example
|
|
1900
|
+
* ```typescript
|
|
1901
|
+
* // Direct property access
|
|
1902
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_LABEL];
|
|
1903
|
+
*
|
|
1904
|
+
* // Dynamic property access
|
|
1905
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_LABEL;
|
|
1906
|
+
* const value = contactattributeset[propertyName];
|
|
1907
|
+
* ```
|
|
1908
|
+
*
|
|
1909
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1910
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1911
|
+
*/
|
|
1912
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_LABEL: keyof ContactAttributeSet = 'label';
|
|
1913
|
+
/**
|
|
1914
|
+
* Organization Id
|
|
1915
|
+
*
|
|
1916
|
+
* The organization that owns this attribute set
|
|
1917
|
+
*
|
|
1918
|
+
* @type {string}
|
|
1919
|
+
*
|
|
1920
|
+
*
|
|
1921
|
+
* @remarks
|
|
1922
|
+
* This key constant provides type-safe access to the `organization_id` property of ContactAttributeSet objects.
|
|
1923
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1924
|
+
*
|
|
1925
|
+
* @example
|
|
1926
|
+
* ```typescript
|
|
1927
|
+
* // Direct property access
|
|
1928
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID];
|
|
1929
|
+
*
|
|
1930
|
+
* // Dynamic property access
|
|
1931
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID;
|
|
1932
|
+
* const value = contactattributeset[propertyName];
|
|
1933
|
+
* ```
|
|
1934
|
+
*
|
|
1935
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1936
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1937
|
+
*/
|
|
1938
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID: keyof ContactAttributeSet = 'organization_id';
|
|
1939
|
+
/**
|
|
1940
|
+
* Tld
|
|
1941
|
+
*
|
|
1942
|
+
* The TLD this attribute set applies to
|
|
1943
|
+
*
|
|
1944
|
+
* @type {string}
|
|
1945
|
+
*
|
|
1946
|
+
*
|
|
1947
|
+
* @remarks
|
|
1948
|
+
* This key constant provides type-safe access to the `tld` property of ContactAttributeSet objects.
|
|
1949
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1950
|
+
*
|
|
1951
|
+
* @example
|
|
1952
|
+
* ```typescript
|
|
1953
|
+
* // Direct property access
|
|
1954
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_TLD];
|
|
1955
|
+
*
|
|
1956
|
+
* // Dynamic property access
|
|
1957
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_TLD;
|
|
1958
|
+
* const value = contactattributeset[propertyName];
|
|
1959
|
+
* ```
|
|
1960
|
+
*
|
|
1961
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1962
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1963
|
+
*/
|
|
1964
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_TLD: keyof ContactAttributeSet = 'tld';
|
|
1965
|
+
/**
|
|
1966
|
+
* Updated On
|
|
1967
|
+
*
|
|
1968
|
+
* The date/time the entry was last updated on
|
|
1969
|
+
*
|
|
1970
|
+
* @type {string}
|
|
1971
|
+
*
|
|
1972
|
+
*
|
|
1973
|
+
* @remarks
|
|
1974
|
+
* This key constant provides type-safe access to the `updated_on` property of ContactAttributeSet objects.
|
|
1975
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1976
|
+
*
|
|
1977
|
+
* @example
|
|
1978
|
+
* ```typescript
|
|
1979
|
+
* // Direct property access
|
|
1980
|
+
* const value = contactattributeset[KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON];
|
|
1981
|
+
*
|
|
1982
|
+
* // Dynamic property access
|
|
1983
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON;
|
|
1984
|
+
* const value = contactattributeset[propertyName];
|
|
1985
|
+
* ```
|
|
1986
|
+
*
|
|
1987
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
1988
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET} - Array of all keys for this type
|
|
1989
|
+
*/
|
|
1990
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON: keyof ContactAttributeSet = 'updated_on';
|
|
1991
|
+
|
|
1992
|
+
/**
|
|
1993
|
+
* Array of all ContactAttributeSet property keys
|
|
1994
|
+
*
|
|
1995
|
+
* @remarks
|
|
1996
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeSet objects.
|
|
1997
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1998
|
+
*
|
|
1999
|
+
* @example
|
|
2000
|
+
* ```typescript
|
|
2001
|
+
* // Iterating through all keys
|
|
2002
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_SET) {
|
|
2003
|
+
* console.log(`Property: ${key}, Value: ${contactattributeset[key]}`);
|
|
2004
|
+
* }
|
|
2005
|
+
*
|
|
2006
|
+
* // Validation
|
|
2007
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_SET.includes(someKey);
|
|
2008
|
+
* ```
|
|
2009
|
+
*
|
|
2010
|
+
* @see {@link ContactAttributeSet} - The TypeScript type definition
|
|
2011
|
+
*/
|
|
2012
|
+
export const KEYS_CONTACT_ATTRIBUTE_SET = [
|
|
2013
|
+
KEY_CONTACT_ATTRIBUTE_SET_ATTRIBUTES,
|
|
2014
|
+
KEY_CONTACT_ATTRIBUTE_SET_CONTACT_ATTRIBUTE_SET_ID,
|
|
2015
|
+
KEY_CONTACT_ATTRIBUTE_SET_CREATED_ON,
|
|
2016
|
+
KEY_CONTACT_ATTRIBUTE_SET_LABEL,
|
|
2017
|
+
KEY_CONTACT_ATTRIBUTE_SET_ORGANIZATION_ID,
|
|
2018
|
+
KEY_CONTACT_ATTRIBUTE_SET_TLD,
|
|
2019
|
+
KEY_CONTACT_ATTRIBUTE_SET_UPDATED_ON,
|
|
2020
|
+
] as const satisfies (keyof ContactAttributeSet)[];
|
|
2021
|
+
|
|
2022
|
+
/**
|
|
2023
|
+
* Label
|
|
2024
|
+
*
|
|
2025
|
+
* A human-readable label explaining the purpose of this attribute set
|
|
2026
|
+
*
|
|
2027
|
+
*
|
|
2028
|
+
*
|
|
2029
|
+
* @remarks
|
|
2030
|
+
* This key constant provides type-safe access to the `label` property of ContactAttributeSetUpdate objects.
|
|
2031
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2032
|
+
*
|
|
2033
|
+
* @example
|
|
2034
|
+
* ```typescript
|
|
2035
|
+
* // Direct property access
|
|
2036
|
+
* const value = contactattributesetupdate[KEY_CONTACT_ATTRIBUTE_SET_UPDATE_LABEL];
|
|
2037
|
+
*
|
|
2038
|
+
* // Dynamic property access
|
|
2039
|
+
* const propertyName = KEY_CONTACT_ATTRIBUTE_SET_UPDATE_LABEL;
|
|
2040
|
+
* const value = contactattributesetupdate[propertyName];
|
|
2041
|
+
* ```
|
|
2042
|
+
*
|
|
2043
|
+
* @see {@link ContactAttributeSetUpdate} - The TypeScript type definition
|
|
2044
|
+
* @see {@link KEYS_CONTACT_ATTRIBUTE_SET_UPDATE} - Array of all keys for this type
|
|
2045
|
+
*/
|
|
2046
|
+
export const KEY_CONTACT_ATTRIBUTE_SET_UPDATE_LABEL: keyof ContactAttributeSetUpdate = 'label';
|
|
2047
|
+
|
|
2048
|
+
/**
|
|
2049
|
+
* Array of all ContactAttributeSetUpdate property keys
|
|
2050
|
+
*
|
|
2051
|
+
* @remarks
|
|
2052
|
+
* This constant provides a readonly array containing all valid property keys for ContactAttributeSetUpdate objects.
|
|
2053
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2054
|
+
*
|
|
2055
|
+
* @example
|
|
2056
|
+
* ```typescript
|
|
2057
|
+
* // Iterating through all keys
|
|
2058
|
+
* for (const key of KEYS_CONTACT_ATTRIBUTE_SET_UPDATE) {
|
|
2059
|
+
* console.log(`Property: ${key}, Value: ${contactattributesetupdate[key]}`);
|
|
2060
|
+
* }
|
|
2061
|
+
*
|
|
2062
|
+
* // Validation
|
|
2063
|
+
* const isValidKey = KEYS_CONTACT_ATTRIBUTE_SET_UPDATE.includes(someKey);
|
|
2064
|
+
* ```
|
|
2065
|
+
*
|
|
2066
|
+
* @see {@link ContactAttributeSetUpdate} - The TypeScript type definition
|
|
2067
|
+
*/
|
|
2068
|
+
export const KEYS_CONTACT_ATTRIBUTE_SET_UPDATE = [
|
|
2069
|
+
KEY_CONTACT_ATTRIBUTE_SET_UPDATE_LABEL,
|
|
2070
|
+
] as const satisfies (keyof ContactAttributeSetUpdate)[];
|
|
2071
|
+
|
|
2072
|
+
/**
|
|
2073
|
+
* Max
|
|
2074
|
+
*
|
|
2075
|
+
* Maximum contacts per domain name
|
|
2076
|
+
*
|
|
2077
|
+
* @type {integer}
|
|
2078
|
+
*
|
|
2079
|
+
*
|
|
2080
|
+
* @remarks
|
|
2081
|
+
* This key constant provides type-safe access to the `max` property of ContactConfigBase objects.
|
|
2082
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2083
|
+
*
|
|
2084
|
+
* @example
|
|
2085
|
+
* ```typescript
|
|
2086
|
+
* // Direct property access
|
|
2087
|
+
* const value = contactconfigbase[KEY_CONTACT_CONFIG_BASE_MAX];
|
|
2088
|
+
*
|
|
2089
|
+
* // Dynamic property access
|
|
2090
|
+
* const propertyName = KEY_CONTACT_CONFIG_BASE_MAX;
|
|
2091
|
+
* const value = contactconfigbase[propertyName];
|
|
2092
|
+
* ```
|
|
2093
|
+
*
|
|
2094
|
+
* @see {@link ContactConfigBase} - The TypeScript type definition
|
|
2095
|
+
* @see {@link KEYS_CONTACT_CONFIG_BASE} - Array of all keys for this type
|
|
2096
|
+
*/
|
|
2097
|
+
export const KEY_CONTACT_CONFIG_BASE_MAX: keyof ContactConfigBase = 'max';
|
|
2098
|
+
/**
|
|
2099
|
+
* Min
|
|
2100
|
+
*
|
|
2101
|
+
* Minimum contacts per domain name
|
|
2102
|
+
*
|
|
2103
|
+
* @type {integer}
|
|
2104
|
+
*
|
|
2105
|
+
*
|
|
2106
|
+
* @remarks
|
|
2107
|
+
* This key constant provides type-safe access to the `min` property of ContactConfigBase objects.
|
|
2108
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2109
|
+
*
|
|
2110
|
+
* @example
|
|
2111
|
+
* ```typescript
|
|
2112
|
+
* // Direct property access
|
|
2113
|
+
* const value = contactconfigbase[KEY_CONTACT_CONFIG_BASE_MIN];
|
|
2114
|
+
*
|
|
2115
|
+
* // Dynamic property access
|
|
2116
|
+
* const propertyName = KEY_CONTACT_CONFIG_BASE_MIN;
|
|
2117
|
+
* const value = contactconfigbase[propertyName];
|
|
2118
|
+
* ```
|
|
2119
|
+
*
|
|
2120
|
+
* @see {@link ContactConfigBase} - The TypeScript type definition
|
|
2121
|
+
* @see {@link KEYS_CONTACT_CONFIG_BASE} - Array of all keys for this type
|
|
2122
|
+
*/
|
|
2123
|
+
export const KEY_CONTACT_CONFIG_BASE_MIN: keyof ContactConfigBase = 'min';
|
|
2124
|
+
/**
|
|
2125
|
+
* type property
|
|
2126
|
+
*
|
|
2127
|
+
* The type of contact
|
|
2128
|
+
*
|
|
2129
|
+
*
|
|
2130
|
+
*
|
|
2131
|
+
* @remarks
|
|
2132
|
+
* This key constant provides type-safe access to the `type` property of ContactConfigBase objects.
|
|
2133
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2134
|
+
*
|
|
2135
|
+
* @example
|
|
2136
|
+
* ```typescript
|
|
2137
|
+
* // Direct property access
|
|
2138
|
+
* const value = contactconfigbase[KEY_CONTACT_CONFIG_BASE_TYPE];
|
|
2139
|
+
*
|
|
2140
|
+
* // Dynamic property access
|
|
2141
|
+
* const propertyName = KEY_CONTACT_CONFIG_BASE_TYPE;
|
|
2142
|
+
* const value = contactconfigbase[propertyName];
|
|
2143
|
+
* ```
|
|
2144
|
+
*
|
|
2145
|
+
* @see {@link ContactConfigBase} - The TypeScript type definition
|
|
2146
|
+
* @see {@link KEYS_CONTACT_CONFIG_BASE} - Array of all keys for this type
|
|
2147
|
+
*/
|
|
2148
|
+
export const KEY_CONTACT_CONFIG_BASE_TYPE: keyof ContactConfigBase = 'type';
|
|
2149
|
+
|
|
2150
|
+
/**
|
|
2151
|
+
* Array of all ContactConfigBase property keys
|
|
2152
|
+
*
|
|
2153
|
+
* @remarks
|
|
2154
|
+
* This constant provides a readonly array containing all valid property keys for ContactConfigBase objects.
|
|
2155
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2156
|
+
*
|
|
2157
|
+
* @example
|
|
2158
|
+
* ```typescript
|
|
2159
|
+
* // Iterating through all keys
|
|
2160
|
+
* for (const key of KEYS_CONTACT_CONFIG_BASE) {
|
|
2161
|
+
* console.log(`Property: ${key}, Value: ${contactconfigbase[key]}`);
|
|
2162
|
+
* }
|
|
2163
|
+
*
|
|
2164
|
+
* // Validation
|
|
2165
|
+
* const isValidKey = KEYS_CONTACT_CONFIG_BASE.includes(someKey);
|
|
2166
|
+
* ```
|
|
2167
|
+
*
|
|
2168
|
+
* @see {@link ContactConfigBase} - The TypeScript type definition
|
|
2169
|
+
*/
|
|
2170
|
+
export const KEYS_CONTACT_CONFIG_BASE = [
|
|
2171
|
+
KEY_CONTACT_CONFIG_BASE_MAX,
|
|
2172
|
+
KEY_CONTACT_CONFIG_BASE_MIN,
|
|
2173
|
+
KEY_CONTACT_CONFIG_BASE_TYPE,
|
|
2174
|
+
] as const satisfies (keyof ContactConfigBase)[];
|
|
2175
|
+
|
|
2176
|
+
/**
|
|
2177
|
+
* City
|
|
2178
|
+
*
|
|
2179
|
+
* The city of the contact
|
|
2180
|
+
*
|
|
2181
|
+
* @type {string}
|
|
2182
|
+
*
|
|
2183
|
+
*
|
|
2184
|
+
* @remarks
|
|
2185
|
+
* This key constant provides type-safe access to the `city` property of ContactCreate objects.
|
|
2186
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2187
|
+
*
|
|
2188
|
+
* @example
|
|
2189
|
+
* ```typescript
|
|
2190
|
+
* // Direct property access
|
|
2191
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_CITY];
|
|
2192
|
+
*
|
|
2193
|
+
* // Dynamic property access
|
|
2194
|
+
* const propertyName = KEY_CONTACT_CREATE_CITY;
|
|
2195
|
+
* const value = contactcreate[propertyName];
|
|
2196
|
+
* ```
|
|
2197
|
+
*
|
|
2198
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2199
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2200
|
+
*/
|
|
2201
|
+
export const KEY_CONTACT_CREATE_CITY: keyof ContactCreate = 'city';
|
|
2202
|
+
/**
|
|
2203
|
+
* Country
|
|
2204
|
+
*
|
|
2205
|
+
* The country of the contact
|
|
2206
|
+
*
|
|
2207
|
+
* @type {string}
|
|
2208
|
+
*
|
|
2209
|
+
*
|
|
2210
|
+
* @remarks
|
|
2211
|
+
* This key constant provides type-safe access to the `country` property of ContactCreate objects.
|
|
2212
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2213
|
+
*
|
|
2214
|
+
* @example
|
|
2215
|
+
* ```typescript
|
|
2216
|
+
* // Direct property access
|
|
2217
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_COUNTRY];
|
|
2218
|
+
*
|
|
2219
|
+
* // Dynamic property access
|
|
2220
|
+
* const propertyName = KEY_CONTACT_CREATE_COUNTRY;
|
|
2221
|
+
* const value = contactcreate[propertyName];
|
|
2222
|
+
* ```
|
|
2223
|
+
*
|
|
2224
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2225
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2226
|
+
*/
|
|
2227
|
+
export const KEY_CONTACT_CREATE_COUNTRY: keyof ContactCreate = 'country';
|
|
2228
|
+
/**
|
|
2229
|
+
* Disclose
|
|
2230
|
+
*
|
|
2231
|
+
* Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
|
|
2232
|
+
*
|
|
2233
|
+
* @type {boolean}
|
|
2234
|
+
*
|
|
2235
|
+
*
|
|
2236
|
+
* @remarks
|
|
2237
|
+
* This key constant provides type-safe access to the `disclose` property of ContactCreate objects.
|
|
2238
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2239
|
+
*
|
|
2240
|
+
* @example
|
|
2241
|
+
* ```typescript
|
|
2242
|
+
* // Direct property access
|
|
2243
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_DISCLOSE];
|
|
2244
|
+
*
|
|
2245
|
+
* // Dynamic property access
|
|
2246
|
+
* const propertyName = KEY_CONTACT_CREATE_DISCLOSE;
|
|
2247
|
+
* const value = contactcreate[propertyName];
|
|
2248
|
+
* ```
|
|
2249
|
+
*
|
|
2250
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2251
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2252
|
+
*/
|
|
2253
|
+
export const KEY_CONTACT_CREATE_DISCLOSE: keyof ContactCreate = 'disclose';
|
|
2254
|
+
/**
|
|
2255
|
+
* Email
|
|
2256
|
+
*
|
|
2257
|
+
* The email of the contact
|
|
2258
|
+
*
|
|
2259
|
+
* @type {string}
|
|
2260
|
+
*
|
|
2261
|
+
*
|
|
2262
|
+
* @remarks
|
|
2263
|
+
* This key constant provides type-safe access to the `email` property of ContactCreate objects.
|
|
2264
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2265
|
+
*
|
|
2266
|
+
* @example
|
|
2267
|
+
* ```typescript
|
|
2268
|
+
* // Direct property access
|
|
2269
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_EMAIL];
|
|
2270
|
+
*
|
|
2271
|
+
* // Dynamic property access
|
|
2272
|
+
* const propertyName = KEY_CONTACT_CREATE_EMAIL;
|
|
2273
|
+
* const value = contactcreate[propertyName];
|
|
2274
|
+
* ```
|
|
2275
|
+
*
|
|
2276
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2277
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2278
|
+
*/
|
|
2279
|
+
export const KEY_CONTACT_CREATE_EMAIL: keyof ContactCreate = 'email';
|
|
2280
|
+
/**
|
|
2281
|
+
* Fax
|
|
2282
|
+
*
|
|
2283
|
+
* The contacts's fax number
|
|
2284
|
+
*
|
|
2285
|
+
*
|
|
2286
|
+
*
|
|
2287
|
+
* @remarks
|
|
2288
|
+
* This key constant provides type-safe access to the `fax` property of ContactCreate objects.
|
|
2289
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2290
|
+
*
|
|
2291
|
+
* @example
|
|
2292
|
+
* ```typescript
|
|
2293
|
+
* // Direct property access
|
|
2294
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_FAX];
|
|
2295
|
+
*
|
|
2296
|
+
* // Dynamic property access
|
|
2297
|
+
* const propertyName = KEY_CONTACT_CREATE_FAX;
|
|
2298
|
+
* const value = contactcreate[propertyName];
|
|
2299
|
+
* ```
|
|
2300
|
+
*
|
|
2301
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2302
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2303
|
+
*/
|
|
2304
|
+
export const KEY_CONTACT_CREATE_FAX: keyof ContactCreate = 'fax';
|
|
2305
|
+
/**
|
|
2306
|
+
* First Name
|
|
2307
|
+
*
|
|
2308
|
+
* The first name of the contact
|
|
2309
|
+
*
|
|
2310
|
+
* @type {string}
|
|
2311
|
+
*
|
|
2312
|
+
*
|
|
2313
|
+
* @remarks
|
|
2314
|
+
* This key constant provides type-safe access to the `first_name` property of ContactCreate objects.
|
|
2315
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2316
|
+
*
|
|
2317
|
+
* @example
|
|
2318
|
+
* ```typescript
|
|
2319
|
+
* // Direct property access
|
|
2320
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_FIRST_NAME];
|
|
2321
|
+
*
|
|
2322
|
+
* // Dynamic property access
|
|
2323
|
+
* const propertyName = KEY_CONTACT_CREATE_FIRST_NAME;
|
|
2324
|
+
* const value = contactcreate[propertyName];
|
|
2325
|
+
* ```
|
|
2326
|
+
*
|
|
2327
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2328
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2329
|
+
*/
|
|
2330
|
+
export const KEY_CONTACT_CREATE_FIRST_NAME: keyof ContactCreate = 'first_name';
|
|
2331
|
+
/**
|
|
2332
|
+
* Last Name
|
|
2333
|
+
*
|
|
2334
|
+
* The last name of the contact
|
|
2335
|
+
*
|
|
2336
|
+
* @type {string}
|
|
2337
|
+
*
|
|
2338
|
+
*
|
|
2339
|
+
* @remarks
|
|
2340
|
+
* This key constant provides type-safe access to the `last_name` property of ContactCreate objects.
|
|
2341
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2342
|
+
*
|
|
2343
|
+
* @example
|
|
2344
|
+
* ```typescript
|
|
2345
|
+
* // Direct property access
|
|
2346
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_LAST_NAME];
|
|
2347
|
+
*
|
|
2348
|
+
* // Dynamic property access
|
|
2349
|
+
* const propertyName = KEY_CONTACT_CREATE_LAST_NAME;
|
|
2350
|
+
* const value = contactcreate[propertyName];
|
|
2351
|
+
* ```
|
|
2352
|
+
*
|
|
2353
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2354
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2355
|
+
*/
|
|
2356
|
+
export const KEY_CONTACT_CREATE_LAST_NAME: keyof ContactCreate = 'last_name';
|
|
2357
|
+
/**
|
|
2358
|
+
* Org
|
|
2359
|
+
*
|
|
2360
|
+
* The organization of the contact
|
|
2361
|
+
*
|
|
2362
|
+
*
|
|
2363
|
+
*
|
|
2364
|
+
* @remarks
|
|
2365
|
+
* This key constant provides type-safe access to the `org` property of ContactCreate objects.
|
|
2366
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2367
|
+
*
|
|
2368
|
+
* @example
|
|
2369
|
+
* ```typescript
|
|
2370
|
+
* // Direct property access
|
|
2371
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_ORG];
|
|
2372
|
+
*
|
|
2373
|
+
* // Dynamic property access
|
|
2374
|
+
* const propertyName = KEY_CONTACT_CREATE_ORG;
|
|
2375
|
+
* const value = contactcreate[propertyName];
|
|
2376
|
+
* ```
|
|
2377
|
+
*
|
|
2378
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2379
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2380
|
+
*/
|
|
2381
|
+
export const KEY_CONTACT_CREATE_ORG: keyof ContactCreate = 'org';
|
|
2382
|
+
/**
|
|
2383
|
+
* Phone
|
|
2384
|
+
*
|
|
2385
|
+
* The contact's phone number
|
|
2386
|
+
*
|
|
2387
|
+
* @type {string}
|
|
2388
|
+
*
|
|
2389
|
+
*
|
|
2390
|
+
* @remarks
|
|
2391
|
+
* This key constant provides type-safe access to the `phone` property of ContactCreate objects.
|
|
2392
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2393
|
+
*
|
|
2394
|
+
* @example
|
|
2395
|
+
* ```typescript
|
|
2396
|
+
* // Direct property access
|
|
2397
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_PHONE];
|
|
2398
|
+
*
|
|
2399
|
+
* // Dynamic property access
|
|
2400
|
+
* const propertyName = KEY_CONTACT_CREATE_PHONE;
|
|
2401
|
+
* const value = contactcreate[propertyName];
|
|
2402
|
+
* ```
|
|
2403
|
+
*
|
|
2404
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2405
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2406
|
+
*/
|
|
2407
|
+
export const KEY_CONTACT_CREATE_PHONE: keyof ContactCreate = 'phone';
|
|
2408
|
+
/**
|
|
2409
|
+
* Postal Code
|
|
2410
|
+
*
|
|
2411
|
+
* The postal code of the contact
|
|
2412
|
+
*
|
|
2413
|
+
* @type {string}
|
|
2414
|
+
*
|
|
2415
|
+
*
|
|
2416
|
+
* @remarks
|
|
2417
|
+
* This key constant provides type-safe access to the `postal_code` property of ContactCreate objects.
|
|
2418
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2419
|
+
*
|
|
2420
|
+
* @example
|
|
2421
|
+
* ```typescript
|
|
2422
|
+
* // Direct property access
|
|
2423
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_POSTAL_CODE];
|
|
2424
|
+
*
|
|
2425
|
+
* // Dynamic property access
|
|
2426
|
+
* const propertyName = KEY_CONTACT_CREATE_POSTAL_CODE;
|
|
2427
|
+
* const value = contactcreate[propertyName];
|
|
2428
|
+
* ```
|
|
2429
|
+
*
|
|
2430
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2431
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2432
|
+
*/
|
|
2433
|
+
export const KEY_CONTACT_CREATE_POSTAL_CODE: keyof ContactCreate = 'postal_code';
|
|
2434
|
+
/**
|
|
2435
|
+
* State
|
|
2436
|
+
*
|
|
2437
|
+
* The state of the contact
|
|
2438
|
+
*
|
|
2439
|
+
*
|
|
2440
|
+
*
|
|
2441
|
+
* @remarks
|
|
2442
|
+
* This key constant provides type-safe access to the `state` property of ContactCreate objects.
|
|
2443
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2444
|
+
*
|
|
2445
|
+
* @example
|
|
2446
|
+
* ```typescript
|
|
2447
|
+
* // Direct property access
|
|
2448
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_STATE];
|
|
2449
|
+
*
|
|
2450
|
+
* // Dynamic property access
|
|
2451
|
+
* const propertyName = KEY_CONTACT_CREATE_STATE;
|
|
2452
|
+
* const value = contactcreate[propertyName];
|
|
2453
|
+
* ```
|
|
2454
|
+
*
|
|
2455
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2456
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2457
|
+
*/
|
|
2458
|
+
export const KEY_CONTACT_CREATE_STATE: keyof ContactCreate = 'state';
|
|
2459
|
+
/**
|
|
2460
|
+
* Street
|
|
2461
|
+
*
|
|
2462
|
+
* The address of the contact
|
|
2463
|
+
*
|
|
2464
|
+
* @type {string}
|
|
2465
|
+
*
|
|
2466
|
+
*
|
|
2467
|
+
* @remarks
|
|
2468
|
+
* This key constant provides type-safe access to the `street` property of ContactCreate objects.
|
|
2469
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2470
|
+
*
|
|
2471
|
+
* @example
|
|
2472
|
+
* ```typescript
|
|
2473
|
+
* // Direct property access
|
|
2474
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_STREET];
|
|
2475
|
+
*
|
|
2476
|
+
* // Dynamic property access
|
|
2477
|
+
* const propertyName = KEY_CONTACT_CREATE_STREET;
|
|
2478
|
+
* const value = contactcreate[propertyName];
|
|
2479
|
+
* ```
|
|
2480
|
+
*
|
|
2481
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2482
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2483
|
+
*/
|
|
2484
|
+
export const KEY_CONTACT_CREATE_STREET: keyof ContactCreate = 'street';
|
|
2485
|
+
/**
|
|
2486
|
+
* Title
|
|
2487
|
+
*
|
|
2488
|
+
* The title of the contact
|
|
2489
|
+
*
|
|
2490
|
+
*
|
|
2491
|
+
*
|
|
2492
|
+
* @remarks
|
|
2493
|
+
* This key constant provides type-safe access to the `title` property of ContactCreate objects.
|
|
2494
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2495
|
+
*
|
|
2496
|
+
* @example
|
|
2497
|
+
* ```typescript
|
|
2498
|
+
* // Direct property access
|
|
2499
|
+
* const value = contactcreate[KEY_CONTACT_CREATE_TITLE];
|
|
2500
|
+
*
|
|
2501
|
+
* // Dynamic property access
|
|
2502
|
+
* const propertyName = KEY_CONTACT_CREATE_TITLE;
|
|
2503
|
+
* const value = contactcreate[propertyName];
|
|
2504
|
+
* ```
|
|
2505
|
+
*
|
|
2506
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2507
|
+
* @see {@link KEYS_CONTACT_CREATE} - Array of all keys for this type
|
|
2508
|
+
*/
|
|
2509
|
+
export const KEY_CONTACT_CREATE_TITLE: keyof ContactCreate = 'title';
|
|
2510
|
+
|
|
2511
|
+
/**
|
|
2512
|
+
* Array of all ContactCreate property keys
|
|
2513
|
+
*
|
|
2514
|
+
* @remarks
|
|
2515
|
+
* This constant provides a readonly array containing all valid property keys for ContactCreate objects.
|
|
2516
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2517
|
+
*
|
|
2518
|
+
* @example
|
|
2519
|
+
* ```typescript
|
|
2520
|
+
* // Iterating through all keys
|
|
2521
|
+
* for (const key of KEYS_CONTACT_CREATE) {
|
|
2522
|
+
* console.log(`Property: ${key}, Value: ${contactcreate[key]}`);
|
|
2523
|
+
* }
|
|
2524
|
+
*
|
|
2525
|
+
* // Validation
|
|
2526
|
+
* const isValidKey = KEYS_CONTACT_CREATE.includes(someKey);
|
|
2527
|
+
* ```
|
|
2528
|
+
*
|
|
2529
|
+
* @see {@link ContactCreate} - The TypeScript type definition
|
|
2530
|
+
*/
|
|
2531
|
+
export const KEYS_CONTACT_CREATE = [
|
|
2532
|
+
KEY_CONTACT_CREATE_CITY,
|
|
2533
|
+
KEY_CONTACT_CREATE_COUNTRY,
|
|
2534
|
+
KEY_CONTACT_CREATE_DISCLOSE,
|
|
2535
|
+
KEY_CONTACT_CREATE_EMAIL,
|
|
2536
|
+
KEY_CONTACT_CREATE_FAX,
|
|
2537
|
+
KEY_CONTACT_CREATE_FIRST_NAME,
|
|
2538
|
+
KEY_CONTACT_CREATE_LAST_NAME,
|
|
2539
|
+
KEY_CONTACT_CREATE_ORG,
|
|
2540
|
+
KEY_CONTACT_CREATE_PHONE,
|
|
2541
|
+
KEY_CONTACT_CREATE_POSTAL_CODE,
|
|
2542
|
+
KEY_CONTACT_CREATE_STATE,
|
|
2543
|
+
KEY_CONTACT_CREATE_STREET,
|
|
2544
|
+
KEY_CONTACT_CREATE_TITLE,
|
|
2545
|
+
] as const satisfies (keyof ContactCreate)[];
|
|
2546
|
+
|
|
2547
|
+
/**
|
|
2548
|
+
* Attribute Sets
|
|
2549
|
+
*
|
|
2550
|
+
* Linked attribute sets for this contact
|
|
2551
|
+
*
|
|
2552
|
+
* @type {array}
|
|
2553
|
+
*
|
|
2554
|
+
*
|
|
2555
|
+
* @remarks
|
|
2556
|
+
* This key constant provides type-safe access to the `attribute_sets` property of ContactDetail objects.
|
|
2557
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2558
|
+
*
|
|
2559
|
+
* @example
|
|
2560
|
+
* ```typescript
|
|
2561
|
+
* // Direct property access
|
|
2562
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_ATTRIBUTE_SETS];
|
|
2563
|
+
*
|
|
2564
|
+
* // Dynamic property access
|
|
2565
|
+
* const propertyName = KEY_CONTACT_DETAIL_ATTRIBUTE_SETS;
|
|
2566
|
+
* const value = contactdetail[propertyName];
|
|
2567
|
+
* ```
|
|
2568
|
+
*
|
|
2569
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2570
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
2571
|
+
*/
|
|
2572
|
+
export const KEY_CONTACT_DETAIL_ATTRIBUTE_SETS: keyof ContactDetail = 'attribute_sets';
|
|
2573
|
+
/**
|
|
2574
|
+
* City
|
|
2575
|
+
*
|
|
2576
|
+
* The city of the contact
|
|
2577
|
+
*
|
|
2578
|
+
* @type {string}
|
|
2579
|
+
*
|
|
2580
|
+
*
|
|
2581
|
+
* @remarks
|
|
2582
|
+
* This key constant provides type-safe access to the `city` property of ContactDetail objects.
|
|
1183
2583
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1184
2584
|
*
|
|
1185
2585
|
* @example
|
|
1186
2586
|
* ```typescript
|
|
1187
2587
|
* // Direct property access
|
|
1188
|
-
* const value =
|
|
2588
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_CITY];
|
|
1189
2589
|
*
|
|
1190
2590
|
* // Dynamic property access
|
|
1191
|
-
* const propertyName =
|
|
1192
|
-
* const value =
|
|
2591
|
+
* const propertyName = KEY_CONTACT_DETAIL_CITY;
|
|
2592
|
+
* const value = contactdetail[propertyName];
|
|
1193
2593
|
* ```
|
|
1194
2594
|
*
|
|
1195
|
-
* @see {@link
|
|
1196
|
-
* @see {@link
|
|
2595
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2596
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1197
2597
|
*/
|
|
1198
|
-
export const
|
|
2598
|
+
export const KEY_CONTACT_DETAIL_CITY: keyof ContactDetail = 'city';
|
|
1199
2599
|
/**
|
|
1200
|
-
*
|
|
2600
|
+
* Contact Id
|
|
1201
2601
|
*
|
|
1202
|
-
* The type of contact
|
|
1203
2602
|
*
|
|
2603
|
+
* @type {string}
|
|
1204
2604
|
*
|
|
1205
2605
|
*
|
|
1206
2606
|
* @remarks
|
|
1207
|
-
* This key constant provides type-safe access to the `
|
|
2607
|
+
* This key constant provides type-safe access to the `contact_id` property of ContactDetail objects.
|
|
1208
2608
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1209
2609
|
*
|
|
1210
2610
|
* @example
|
|
1211
2611
|
* ```typescript
|
|
1212
2612
|
* // Direct property access
|
|
1213
|
-
* const value =
|
|
2613
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_CONTACT_ID];
|
|
1214
2614
|
*
|
|
1215
2615
|
* // Dynamic property access
|
|
1216
|
-
* const propertyName =
|
|
1217
|
-
* const value =
|
|
2616
|
+
* const propertyName = KEY_CONTACT_DETAIL_CONTACT_ID;
|
|
2617
|
+
* const value = contactdetail[propertyName];
|
|
1218
2618
|
* ```
|
|
1219
2619
|
*
|
|
1220
|
-
* @see {@link
|
|
1221
|
-
* @see {@link
|
|
2620
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2621
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1222
2622
|
*/
|
|
1223
|
-
export const
|
|
1224
|
-
|
|
2623
|
+
export const KEY_CONTACT_DETAIL_CONTACT_ID: keyof ContactDetail = 'contact_id';
|
|
1225
2624
|
/**
|
|
1226
|
-
*
|
|
2625
|
+
* Country
|
|
2626
|
+
*
|
|
2627
|
+
* The country of the contact
|
|
2628
|
+
*
|
|
2629
|
+
* @type {string}
|
|
2630
|
+
*
|
|
1227
2631
|
*
|
|
1228
2632
|
* @remarks
|
|
1229
|
-
* This constant provides
|
|
1230
|
-
*
|
|
2633
|
+
* This key constant provides type-safe access to the `country` property of ContactDetail objects.
|
|
2634
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1231
2635
|
*
|
|
1232
2636
|
* @example
|
|
1233
2637
|
* ```typescript
|
|
1234
|
-
* //
|
|
1235
|
-
*
|
|
1236
|
-
* console.log(`Property: ${key}, Value: ${contactconfigbase[key]}`);
|
|
1237
|
-
* }
|
|
2638
|
+
* // Direct property access
|
|
2639
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_COUNTRY];
|
|
1238
2640
|
*
|
|
1239
|
-
* //
|
|
1240
|
-
* const
|
|
2641
|
+
* // Dynamic property access
|
|
2642
|
+
* const propertyName = KEY_CONTACT_DETAIL_COUNTRY;
|
|
2643
|
+
* const value = contactdetail[propertyName];
|
|
1241
2644
|
* ```
|
|
1242
2645
|
*
|
|
1243
|
-
* @see {@link
|
|
2646
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2647
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1244
2648
|
*/
|
|
1245
|
-
export const
|
|
1246
|
-
KEY_CONTACT_CONFIG_BASE_MAX,
|
|
1247
|
-
KEY_CONTACT_CONFIG_BASE_MIN,
|
|
1248
|
-
KEY_CONTACT_CONFIG_BASE_TYPE,
|
|
1249
|
-
] as const satisfies (keyof ContactConfigBase)[];
|
|
1250
|
-
|
|
2649
|
+
export const KEY_CONTACT_DETAIL_COUNTRY: keyof ContactDetail = 'country';
|
|
1251
2650
|
/**
|
|
1252
|
-
*
|
|
2651
|
+
* Created On
|
|
1253
2652
|
*
|
|
1254
|
-
* The
|
|
2653
|
+
* The date/time the entry was created on
|
|
1255
2654
|
*
|
|
1256
2655
|
* @type {string}
|
|
1257
2656
|
*
|
|
1258
2657
|
*
|
|
1259
2658
|
* @remarks
|
|
1260
|
-
* This key constant provides type-safe access to the `
|
|
2659
|
+
* This key constant provides type-safe access to the `created_on` property of ContactDetail objects.
|
|
1261
2660
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1262
2661
|
*
|
|
1263
2662
|
* @example
|
|
1264
2663
|
* ```typescript
|
|
1265
2664
|
* // Direct property access
|
|
1266
|
-
* const value =
|
|
2665
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_CREATED_ON];
|
|
1267
2666
|
*
|
|
1268
2667
|
* // Dynamic property access
|
|
1269
|
-
* const propertyName =
|
|
1270
|
-
* const value =
|
|
2668
|
+
* const propertyName = KEY_CONTACT_DETAIL_CREATED_ON;
|
|
2669
|
+
* const value = contactdetail[propertyName];
|
|
1271
2670
|
* ```
|
|
1272
2671
|
*
|
|
1273
|
-
* @see {@link
|
|
1274
|
-
* @see {@link
|
|
2672
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2673
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1275
2674
|
*/
|
|
1276
|
-
export const
|
|
2675
|
+
export const KEY_CONTACT_DETAIL_CREATED_ON: keyof ContactDetail = 'created_on';
|
|
1277
2676
|
/**
|
|
1278
|
-
*
|
|
2677
|
+
* Deleted On
|
|
1279
2678
|
*
|
|
1280
|
-
* The
|
|
2679
|
+
* The date/time the entry was deleted on
|
|
1281
2680
|
*
|
|
1282
|
-
* @type {string}
|
|
1283
2681
|
*
|
|
1284
2682
|
*
|
|
1285
2683
|
* @remarks
|
|
1286
|
-
* This key constant provides type-safe access to the `
|
|
2684
|
+
* This key constant provides type-safe access to the `deleted_on` property of ContactDetail objects.
|
|
1287
2685
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1288
2686
|
*
|
|
1289
2687
|
* @example
|
|
1290
2688
|
* ```typescript
|
|
1291
2689
|
* // Direct property access
|
|
1292
|
-
* const value =
|
|
2690
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_DELETED_ON];
|
|
1293
2691
|
*
|
|
1294
2692
|
* // Dynamic property access
|
|
1295
|
-
* const propertyName =
|
|
1296
|
-
* const value =
|
|
2693
|
+
* const propertyName = KEY_CONTACT_DETAIL_DELETED_ON;
|
|
2694
|
+
* const value = contactdetail[propertyName];
|
|
1297
2695
|
* ```
|
|
1298
2696
|
*
|
|
1299
|
-
* @see {@link
|
|
1300
|
-
* @see {@link
|
|
2697
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2698
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1301
2699
|
*/
|
|
1302
|
-
export const
|
|
2700
|
+
export const KEY_CONTACT_DETAIL_DELETED_ON: keyof ContactDetail = 'deleted_on';
|
|
1303
2701
|
/**
|
|
1304
2702
|
* Disclose
|
|
1305
2703
|
*
|
|
@@ -1309,23 +2707,23 @@ export const KEY_CONTACT_CREATE_COUNTRY: keyof ContactCreate = 'country';
|
|
|
1309
2707
|
*
|
|
1310
2708
|
*
|
|
1311
2709
|
* @remarks
|
|
1312
|
-
* This key constant provides type-safe access to the `disclose` property of
|
|
2710
|
+
* This key constant provides type-safe access to the `disclose` property of ContactDetail objects.
|
|
1313
2711
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1314
2712
|
*
|
|
1315
2713
|
* @example
|
|
1316
2714
|
* ```typescript
|
|
1317
2715
|
* // Direct property access
|
|
1318
|
-
* const value =
|
|
2716
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_DISCLOSE];
|
|
1319
2717
|
*
|
|
1320
2718
|
* // Dynamic property access
|
|
1321
|
-
* const propertyName =
|
|
1322
|
-
* const value =
|
|
2719
|
+
* const propertyName = KEY_CONTACT_DETAIL_DISCLOSE;
|
|
2720
|
+
* const value = contactdetail[propertyName];
|
|
1323
2721
|
* ```
|
|
1324
2722
|
*
|
|
1325
|
-
* @see {@link
|
|
1326
|
-
* @see {@link
|
|
2723
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2724
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1327
2725
|
*/
|
|
1328
|
-
export const
|
|
2726
|
+
export const KEY_CONTACT_DETAIL_DISCLOSE: keyof ContactDetail = 'disclose';
|
|
1329
2727
|
/**
|
|
1330
2728
|
* Email
|
|
1331
2729
|
*
|
|
@@ -1335,23 +2733,23 @@ export const KEY_CONTACT_CREATE_DISCLOSE: keyof ContactCreate = 'disclose';
|
|
|
1335
2733
|
*
|
|
1336
2734
|
*
|
|
1337
2735
|
* @remarks
|
|
1338
|
-
* This key constant provides type-safe access to the `email` property of
|
|
2736
|
+
* This key constant provides type-safe access to the `email` property of ContactDetail objects.
|
|
1339
2737
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1340
2738
|
*
|
|
1341
2739
|
* @example
|
|
1342
2740
|
* ```typescript
|
|
1343
2741
|
* // Direct property access
|
|
1344
|
-
* const value =
|
|
2742
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_EMAIL];
|
|
1345
2743
|
*
|
|
1346
2744
|
* // Dynamic property access
|
|
1347
|
-
* const propertyName =
|
|
1348
|
-
* const value =
|
|
2745
|
+
* const propertyName = KEY_CONTACT_DETAIL_EMAIL;
|
|
2746
|
+
* const value = contactdetail[propertyName];
|
|
1349
2747
|
* ```
|
|
1350
2748
|
*
|
|
1351
|
-
* @see {@link
|
|
1352
|
-
* @see {@link
|
|
2749
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2750
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1353
2751
|
*/
|
|
1354
|
-
export const
|
|
2752
|
+
export const KEY_CONTACT_DETAIL_EMAIL: keyof ContactDetail = 'email';
|
|
1355
2753
|
/**
|
|
1356
2754
|
* Fax
|
|
1357
2755
|
*
|
|
@@ -1360,23 +2758,23 @@ export const KEY_CONTACT_CREATE_EMAIL: keyof ContactCreate = 'email';
|
|
|
1360
2758
|
*
|
|
1361
2759
|
*
|
|
1362
2760
|
* @remarks
|
|
1363
|
-
* This key constant provides type-safe access to the `fax` property of
|
|
2761
|
+
* This key constant provides type-safe access to the `fax` property of ContactDetail objects.
|
|
1364
2762
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1365
2763
|
*
|
|
1366
2764
|
* @example
|
|
1367
2765
|
* ```typescript
|
|
1368
2766
|
* // Direct property access
|
|
1369
|
-
* const value =
|
|
2767
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_FAX];
|
|
1370
2768
|
*
|
|
1371
2769
|
* // Dynamic property access
|
|
1372
|
-
* const propertyName =
|
|
1373
|
-
* const value =
|
|
2770
|
+
* const propertyName = KEY_CONTACT_DETAIL_FAX;
|
|
2771
|
+
* const value = contactdetail[propertyName];
|
|
1374
2772
|
* ```
|
|
1375
2773
|
*
|
|
1376
|
-
* @see {@link
|
|
1377
|
-
* @see {@link
|
|
2774
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2775
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1378
2776
|
*/
|
|
1379
|
-
export const
|
|
2777
|
+
export const KEY_CONTACT_DETAIL_FAX: keyof ContactDetail = 'fax';
|
|
1380
2778
|
/**
|
|
1381
2779
|
* First Name
|
|
1382
2780
|
*
|
|
@@ -1386,23 +2784,23 @@ export const KEY_CONTACT_CREATE_FAX: keyof ContactCreate = 'fax';
|
|
|
1386
2784
|
*
|
|
1387
2785
|
*
|
|
1388
2786
|
* @remarks
|
|
1389
|
-
* This key constant provides type-safe access to the `first_name` property of
|
|
2787
|
+
* This key constant provides type-safe access to the `first_name` property of ContactDetail objects.
|
|
1390
2788
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1391
2789
|
*
|
|
1392
2790
|
* @example
|
|
1393
2791
|
* ```typescript
|
|
1394
2792
|
* // Direct property access
|
|
1395
|
-
* const value =
|
|
2793
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_FIRST_NAME];
|
|
1396
2794
|
*
|
|
1397
2795
|
* // Dynamic property access
|
|
1398
|
-
* const propertyName =
|
|
1399
|
-
* const value =
|
|
2796
|
+
* const propertyName = KEY_CONTACT_DETAIL_FIRST_NAME;
|
|
2797
|
+
* const value = contactdetail[propertyName];
|
|
1400
2798
|
* ```
|
|
1401
2799
|
*
|
|
1402
|
-
* @see {@link
|
|
1403
|
-
* @see {@link
|
|
2800
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2801
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1404
2802
|
*/
|
|
1405
|
-
export const
|
|
2803
|
+
export const KEY_CONTACT_DETAIL_FIRST_NAME: keyof ContactDetail = 'first_name';
|
|
1406
2804
|
/**
|
|
1407
2805
|
* Last Name
|
|
1408
2806
|
*
|
|
@@ -1412,23 +2810,23 @@ export const KEY_CONTACT_CREATE_FIRST_NAME: keyof ContactCreate = 'first_name';
|
|
|
1412
2810
|
*
|
|
1413
2811
|
*
|
|
1414
2812
|
* @remarks
|
|
1415
|
-
* This key constant provides type-safe access to the `last_name` property of
|
|
2813
|
+
* This key constant provides type-safe access to the `last_name` property of ContactDetail objects.
|
|
1416
2814
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1417
2815
|
*
|
|
1418
2816
|
* @example
|
|
1419
2817
|
* ```typescript
|
|
1420
2818
|
* // Direct property access
|
|
1421
|
-
* const value =
|
|
2819
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_LAST_NAME];
|
|
1422
2820
|
*
|
|
1423
2821
|
* // Dynamic property access
|
|
1424
|
-
* const propertyName =
|
|
1425
|
-
* const value =
|
|
2822
|
+
* const propertyName = KEY_CONTACT_DETAIL_LAST_NAME;
|
|
2823
|
+
* const value = contactdetail[propertyName];
|
|
1426
2824
|
* ```
|
|
1427
2825
|
*
|
|
1428
|
-
* @see {@link
|
|
1429
|
-
* @see {@link
|
|
2826
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2827
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1430
2828
|
*/
|
|
1431
|
-
export const
|
|
2829
|
+
export const KEY_CONTACT_DETAIL_LAST_NAME: keyof ContactDetail = 'last_name';
|
|
1432
2830
|
/**
|
|
1433
2831
|
* Org
|
|
1434
2832
|
*
|
|
@@ -1437,23 +2835,49 @@ export const KEY_CONTACT_CREATE_LAST_NAME: keyof ContactCreate = 'last_name';
|
|
|
1437
2835
|
*
|
|
1438
2836
|
*
|
|
1439
2837
|
* @remarks
|
|
1440
|
-
* This key constant provides type-safe access to the `org` property of
|
|
2838
|
+
* This key constant provides type-safe access to the `org` property of ContactDetail objects.
|
|
1441
2839
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1442
2840
|
*
|
|
1443
2841
|
* @example
|
|
1444
2842
|
* ```typescript
|
|
1445
2843
|
* // Direct property access
|
|
1446
|
-
* const value =
|
|
2844
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_ORG];
|
|
1447
2845
|
*
|
|
1448
2846
|
* // Dynamic property access
|
|
1449
|
-
* const propertyName =
|
|
1450
|
-
* const value =
|
|
2847
|
+
* const propertyName = KEY_CONTACT_DETAIL_ORG;
|
|
2848
|
+
* const value = contactdetail[propertyName];
|
|
1451
2849
|
* ```
|
|
1452
2850
|
*
|
|
1453
|
-
* @see {@link
|
|
1454
|
-
* @see {@link
|
|
2851
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2852
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1455
2853
|
*/
|
|
1456
|
-
export const
|
|
2854
|
+
export const KEY_CONTACT_DETAIL_ORG: keyof ContactDetail = 'org';
|
|
2855
|
+
/**
|
|
2856
|
+
* Organization Id
|
|
2857
|
+
*
|
|
2858
|
+
* The organization that owns the domain
|
|
2859
|
+
*
|
|
2860
|
+
* @type {string}
|
|
2861
|
+
*
|
|
2862
|
+
*
|
|
2863
|
+
* @remarks
|
|
2864
|
+
* This key constant provides type-safe access to the `organization_id` property of ContactDetail objects.
|
|
2865
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2866
|
+
*
|
|
2867
|
+
* @example
|
|
2868
|
+
* ```typescript
|
|
2869
|
+
* // Direct property access
|
|
2870
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_ORGANIZATION_ID];
|
|
2871
|
+
*
|
|
2872
|
+
* // Dynamic property access
|
|
2873
|
+
* const propertyName = KEY_CONTACT_DETAIL_ORGANIZATION_ID;
|
|
2874
|
+
* const value = contactdetail[propertyName];
|
|
2875
|
+
* ```
|
|
2876
|
+
*
|
|
2877
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2878
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
2879
|
+
*/
|
|
2880
|
+
export const KEY_CONTACT_DETAIL_ORGANIZATION_ID: keyof ContactDetail = 'organization_id';
|
|
1457
2881
|
/**
|
|
1458
2882
|
* Phone
|
|
1459
2883
|
*
|
|
@@ -1463,23 +2887,23 @@ export const KEY_CONTACT_CREATE_ORG: keyof ContactCreate = 'org';
|
|
|
1463
2887
|
*
|
|
1464
2888
|
*
|
|
1465
2889
|
* @remarks
|
|
1466
|
-
* This key constant provides type-safe access to the `phone` property of
|
|
2890
|
+
* This key constant provides type-safe access to the `phone` property of ContactDetail objects.
|
|
1467
2891
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1468
2892
|
*
|
|
1469
2893
|
* @example
|
|
1470
2894
|
* ```typescript
|
|
1471
2895
|
* // Direct property access
|
|
1472
|
-
* const value =
|
|
2896
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_PHONE];
|
|
1473
2897
|
*
|
|
1474
2898
|
* // Dynamic property access
|
|
1475
|
-
* const propertyName =
|
|
1476
|
-
* const value =
|
|
2899
|
+
* const propertyName = KEY_CONTACT_DETAIL_PHONE;
|
|
2900
|
+
* const value = contactdetail[propertyName];
|
|
1477
2901
|
* ```
|
|
1478
2902
|
*
|
|
1479
|
-
* @see {@link
|
|
1480
|
-
* @see {@link
|
|
2903
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2904
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1481
2905
|
*/
|
|
1482
|
-
export const
|
|
2906
|
+
export const KEY_CONTACT_DETAIL_PHONE: keyof ContactDetail = 'phone';
|
|
1483
2907
|
/**
|
|
1484
2908
|
* Postal Code
|
|
1485
2909
|
*
|
|
@@ -1489,23 +2913,23 @@ export const KEY_CONTACT_CREATE_PHONE: keyof ContactCreate = 'phone';
|
|
|
1489
2913
|
*
|
|
1490
2914
|
*
|
|
1491
2915
|
* @remarks
|
|
1492
|
-
* This key constant provides type-safe access to the `postal_code` property of
|
|
2916
|
+
* This key constant provides type-safe access to the `postal_code` property of ContactDetail objects.
|
|
1493
2917
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1494
2918
|
*
|
|
1495
2919
|
* @example
|
|
1496
2920
|
* ```typescript
|
|
1497
2921
|
* // Direct property access
|
|
1498
|
-
* const value =
|
|
2922
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_POSTAL_CODE];
|
|
1499
2923
|
*
|
|
1500
2924
|
* // Dynamic property access
|
|
1501
|
-
* const propertyName =
|
|
1502
|
-
* const value =
|
|
2925
|
+
* const propertyName = KEY_CONTACT_DETAIL_POSTAL_CODE;
|
|
2926
|
+
* const value = contactdetail[propertyName];
|
|
1503
2927
|
* ```
|
|
1504
2928
|
*
|
|
1505
|
-
* @see {@link
|
|
1506
|
-
* @see {@link
|
|
2929
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2930
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1507
2931
|
*/
|
|
1508
|
-
export const
|
|
2932
|
+
export const KEY_CONTACT_DETAIL_POSTAL_CODE: keyof ContactDetail = 'postal_code';
|
|
1509
2933
|
/**
|
|
1510
2934
|
* State
|
|
1511
2935
|
*
|
|
@@ -1514,23 +2938,23 @@ export const KEY_CONTACT_CREATE_POSTAL_CODE: keyof ContactCreate = 'postal_code'
|
|
|
1514
2938
|
*
|
|
1515
2939
|
*
|
|
1516
2940
|
* @remarks
|
|
1517
|
-
* This key constant provides type-safe access to the `state` property of
|
|
2941
|
+
* This key constant provides type-safe access to the `state` property of ContactDetail objects.
|
|
1518
2942
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1519
2943
|
*
|
|
1520
2944
|
* @example
|
|
1521
2945
|
* ```typescript
|
|
1522
2946
|
* // Direct property access
|
|
1523
|
-
* const value =
|
|
2947
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_STATE];
|
|
1524
2948
|
*
|
|
1525
2949
|
* // Dynamic property access
|
|
1526
|
-
* const propertyName =
|
|
1527
|
-
* const value =
|
|
2950
|
+
* const propertyName = KEY_CONTACT_DETAIL_STATE;
|
|
2951
|
+
* const value = contactdetail[propertyName];
|
|
1528
2952
|
* ```
|
|
1529
2953
|
*
|
|
1530
|
-
* @see {@link
|
|
1531
|
-
* @see {@link
|
|
2954
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2955
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1532
2956
|
*/
|
|
1533
|
-
export const
|
|
2957
|
+
export const KEY_CONTACT_DETAIL_STATE: keyof ContactDetail = 'state';
|
|
1534
2958
|
/**
|
|
1535
2959
|
* Street
|
|
1536
2960
|
*
|
|
@@ -1540,23 +2964,23 @@ export const KEY_CONTACT_CREATE_STATE: keyof ContactCreate = 'state';
|
|
|
1540
2964
|
*
|
|
1541
2965
|
*
|
|
1542
2966
|
* @remarks
|
|
1543
|
-
* This key constant provides type-safe access to the `street` property of
|
|
2967
|
+
* This key constant provides type-safe access to the `street` property of ContactDetail objects.
|
|
1544
2968
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1545
2969
|
*
|
|
1546
2970
|
* @example
|
|
1547
2971
|
* ```typescript
|
|
1548
2972
|
* // Direct property access
|
|
1549
|
-
* const value =
|
|
2973
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_STREET];
|
|
1550
2974
|
*
|
|
1551
2975
|
* // Dynamic property access
|
|
1552
|
-
* const propertyName =
|
|
1553
|
-
* const value =
|
|
2976
|
+
* const propertyName = KEY_CONTACT_DETAIL_STREET;
|
|
2977
|
+
* const value = contactdetail[propertyName];
|
|
1554
2978
|
* ```
|
|
1555
2979
|
*
|
|
1556
|
-
* @see {@link
|
|
1557
|
-
* @see {@link
|
|
2980
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
2981
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1558
2982
|
*/
|
|
1559
|
-
export const
|
|
2983
|
+
export const KEY_CONTACT_DETAIL_STREET: keyof ContactDetail = 'street';
|
|
1560
2984
|
/**
|
|
1561
2985
|
* Title
|
|
1562
2986
|
*
|
|
@@ -1565,59 +2989,64 @@ export const KEY_CONTACT_CREATE_STREET: keyof ContactCreate = 'street';
|
|
|
1565
2989
|
*
|
|
1566
2990
|
*
|
|
1567
2991
|
* @remarks
|
|
1568
|
-
* This key constant provides type-safe access to the `title` property of
|
|
2992
|
+
* This key constant provides type-safe access to the `title` property of ContactDetail objects.
|
|
1569
2993
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
1570
2994
|
*
|
|
1571
2995
|
* @example
|
|
1572
2996
|
* ```typescript
|
|
1573
2997
|
* // Direct property access
|
|
1574
|
-
* const value =
|
|
2998
|
+
* const value = contactdetail[KEY_CONTACT_DETAIL_TITLE];
|
|
1575
2999
|
*
|
|
1576
3000
|
* // Dynamic property access
|
|
1577
|
-
* const propertyName =
|
|
1578
|
-
* const value =
|
|
3001
|
+
* const propertyName = KEY_CONTACT_DETAIL_TITLE;
|
|
3002
|
+
* const value = contactdetail[propertyName];
|
|
1579
3003
|
* ```
|
|
1580
3004
|
*
|
|
1581
|
-
* @see {@link
|
|
1582
|
-
* @see {@link
|
|
3005
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
3006
|
+
* @see {@link KEYS_CONTACT_DETAIL} - Array of all keys for this type
|
|
1583
3007
|
*/
|
|
1584
|
-
export const
|
|
3008
|
+
export const KEY_CONTACT_DETAIL_TITLE: keyof ContactDetail = 'title';
|
|
1585
3009
|
|
|
1586
3010
|
/**
|
|
1587
|
-
* Array of all
|
|
3011
|
+
* Array of all ContactDetail property keys
|
|
1588
3012
|
*
|
|
1589
3013
|
* @remarks
|
|
1590
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
3014
|
+
* This constant provides a readonly array containing all valid property keys for ContactDetail objects.
|
|
1591
3015
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1592
3016
|
*
|
|
1593
3017
|
* @example
|
|
1594
3018
|
* ```typescript
|
|
1595
3019
|
* // Iterating through all keys
|
|
1596
|
-
* for (const key of
|
|
1597
|
-
* console.log(`Property: ${key}, Value: ${
|
|
3020
|
+
* for (const key of KEYS_CONTACT_DETAIL) {
|
|
3021
|
+
* console.log(`Property: ${key}, Value: ${contactdetail[key]}`);
|
|
1598
3022
|
* }
|
|
1599
3023
|
*
|
|
1600
3024
|
* // Validation
|
|
1601
|
-
* const isValidKey =
|
|
1602
|
-
* ```
|
|
1603
|
-
*
|
|
1604
|
-
* @see {@link
|
|
1605
|
-
*/
|
|
1606
|
-
export const
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
3025
|
+
* const isValidKey = KEYS_CONTACT_DETAIL.includes(someKey);
|
|
3026
|
+
* ```
|
|
3027
|
+
*
|
|
3028
|
+
* @see {@link ContactDetail} - The TypeScript type definition
|
|
3029
|
+
*/
|
|
3030
|
+
export const KEYS_CONTACT_DETAIL = [
|
|
3031
|
+
KEY_CONTACT_DETAIL_ATTRIBUTE_SETS,
|
|
3032
|
+
KEY_CONTACT_DETAIL_CITY,
|
|
3033
|
+
KEY_CONTACT_DETAIL_CONTACT_ID,
|
|
3034
|
+
KEY_CONTACT_DETAIL_COUNTRY,
|
|
3035
|
+
KEY_CONTACT_DETAIL_CREATED_ON,
|
|
3036
|
+
KEY_CONTACT_DETAIL_DELETED_ON,
|
|
3037
|
+
KEY_CONTACT_DETAIL_DISCLOSE,
|
|
3038
|
+
KEY_CONTACT_DETAIL_EMAIL,
|
|
3039
|
+
KEY_CONTACT_DETAIL_FAX,
|
|
3040
|
+
KEY_CONTACT_DETAIL_FIRST_NAME,
|
|
3041
|
+
KEY_CONTACT_DETAIL_LAST_NAME,
|
|
3042
|
+
KEY_CONTACT_DETAIL_ORG,
|
|
3043
|
+
KEY_CONTACT_DETAIL_ORGANIZATION_ID,
|
|
3044
|
+
KEY_CONTACT_DETAIL_PHONE,
|
|
3045
|
+
KEY_CONTACT_DETAIL_POSTAL_CODE,
|
|
3046
|
+
KEY_CONTACT_DETAIL_STATE,
|
|
3047
|
+
KEY_CONTACT_DETAIL_STREET,
|
|
3048
|
+
KEY_CONTACT_DETAIL_TITLE,
|
|
3049
|
+
] as const satisfies (keyof ContactDetail)[];
|
|
1621
3050
|
|
|
1622
3051
|
/**
|
|
1623
3052
|
* Attributes
|
|
@@ -2067,83 +3496,6 @@ export const KEYS_CONTACT = [
|
|
|
2067
3496
|
KEY_CONTACT_TITLE,
|
|
2068
3497
|
] as const satisfies (keyof Contact)[];
|
|
2069
3498
|
|
|
2070
|
-
/**
|
|
2071
|
-
* Attributes
|
|
2072
|
-
*
|
|
2073
|
-
* List of required attribute keys for this role
|
|
2074
|
-
*
|
|
2075
|
-
* @type {array}
|
|
2076
|
-
*
|
|
2077
|
-
*
|
|
2078
|
-
* @remarks
|
|
2079
|
-
* This key constant provides type-safe access to the `attributes` property of ContactRoleAttributeRequirement objects.
|
|
2080
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2081
|
-
*
|
|
2082
|
-
* @example
|
|
2083
|
-
* ```typescript
|
|
2084
|
-
* // Direct property access
|
|
2085
|
-
* const value = contactroleattributerequirement[KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ATTRIBUTES];
|
|
2086
|
-
*
|
|
2087
|
-
* // Dynamic property access
|
|
2088
|
-
* const propertyName = KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ATTRIBUTES;
|
|
2089
|
-
* const value = contactroleattributerequirement[propertyName];
|
|
2090
|
-
* ```
|
|
2091
|
-
*
|
|
2092
|
-
* @see {@link ContactRoleAttributeRequirement} - The TypeScript type definition
|
|
2093
|
-
* @see {@link KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT} - Array of all keys for this type
|
|
2094
|
-
*/
|
|
2095
|
-
export const KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ATTRIBUTES: keyof ContactRoleAttributeRequirement = 'attributes';
|
|
2096
|
-
/**
|
|
2097
|
-
* role property
|
|
2098
|
-
*
|
|
2099
|
-
* The role this requirement applies to
|
|
2100
|
-
*
|
|
2101
|
-
*
|
|
2102
|
-
*
|
|
2103
|
-
* @remarks
|
|
2104
|
-
* This key constant provides type-safe access to the `role` property of ContactRoleAttributeRequirement objects.
|
|
2105
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
2106
|
-
*
|
|
2107
|
-
* @example
|
|
2108
|
-
* ```typescript
|
|
2109
|
-
* // Direct property access
|
|
2110
|
-
* const value = contactroleattributerequirement[KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ROLE];
|
|
2111
|
-
*
|
|
2112
|
-
* // Dynamic property access
|
|
2113
|
-
* const propertyName = KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ROLE;
|
|
2114
|
-
* const value = contactroleattributerequirement[propertyName];
|
|
2115
|
-
* ```
|
|
2116
|
-
*
|
|
2117
|
-
* @see {@link ContactRoleAttributeRequirement} - The TypeScript type definition
|
|
2118
|
-
* @see {@link KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT} - Array of all keys for this type
|
|
2119
|
-
*/
|
|
2120
|
-
export const KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ROLE: keyof ContactRoleAttributeRequirement = 'role';
|
|
2121
|
-
|
|
2122
|
-
/**
|
|
2123
|
-
* Array of all ContactRoleAttributeRequirement property keys
|
|
2124
|
-
*
|
|
2125
|
-
* @remarks
|
|
2126
|
-
* This constant provides a readonly array containing all valid property keys for ContactRoleAttributeRequirement objects.
|
|
2127
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2128
|
-
*
|
|
2129
|
-
* @example
|
|
2130
|
-
* ```typescript
|
|
2131
|
-
* // Iterating through all keys
|
|
2132
|
-
* for (const key of KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT) {
|
|
2133
|
-
* console.log(`Property: ${key}, Value: ${contactroleattributerequirement[key]}`);
|
|
2134
|
-
* }
|
|
2135
|
-
*
|
|
2136
|
-
* // Validation
|
|
2137
|
-
* const isValidKey = KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT.includes(someKey);
|
|
2138
|
-
* ```
|
|
2139
|
-
*
|
|
2140
|
-
* @see {@link ContactRoleAttributeRequirement} - The TypeScript type definition
|
|
2141
|
-
*/
|
|
2142
|
-
export const KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT = [
|
|
2143
|
-
KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ATTRIBUTES,
|
|
2144
|
-
KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ROLE,
|
|
2145
|
-
] as const satisfies (keyof ContactRoleAttributeRequirement)[];
|
|
2146
|
-
|
|
2147
3499
|
/**
|
|
2148
3500
|
* City
|
|
2149
3501
|
*
|
|
@@ -3479,32 +4831,6 @@ export const KEY_CONTACTS_BASE_PRIVACY_PROXY: keyof ContactsBase = 'privacy_prox
|
|
|
3479
4831
|
* @see {@link KEYS_CONTACTS_BASE} - Array of all keys for this type
|
|
3480
4832
|
*/
|
|
3481
4833
|
export const KEY_CONTACTS_BASE_REGISTRANT_CHANGE: keyof ContactsBase = 'registrant_change';
|
|
3482
|
-
/**
|
|
3483
|
-
* Required Attributes
|
|
3484
|
-
*
|
|
3485
|
-
* List of attribute requirements by role
|
|
3486
|
-
*
|
|
3487
|
-
* @type {array}
|
|
3488
|
-
*
|
|
3489
|
-
*
|
|
3490
|
-
* @remarks
|
|
3491
|
-
* This key constant provides type-safe access to the `required_attributes` property of ContactsBase objects.
|
|
3492
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
3493
|
-
*
|
|
3494
|
-
* @example
|
|
3495
|
-
* ```typescript
|
|
3496
|
-
* // Direct property access
|
|
3497
|
-
* const value = contactsbase[KEY_CONTACTS_BASE_REQUIRED_ATTRIBUTES];
|
|
3498
|
-
*
|
|
3499
|
-
* // Dynamic property access
|
|
3500
|
-
* const propertyName = KEY_CONTACTS_BASE_REQUIRED_ATTRIBUTES;
|
|
3501
|
-
* const value = contactsbase[propertyName];
|
|
3502
|
-
* ```
|
|
3503
|
-
*
|
|
3504
|
-
* @see {@link ContactsBase} - The TypeScript type definition
|
|
3505
|
-
* @see {@link KEYS_CONTACTS_BASE} - Array of all keys for this type
|
|
3506
|
-
*/
|
|
3507
|
-
export const KEY_CONTACTS_BASE_REQUIRED_ATTRIBUTES: keyof ContactsBase = 'required_attributes';
|
|
3508
4834
|
/**
|
|
3509
4835
|
* Support Check
|
|
3510
4836
|
*
|
|
@@ -3707,7 +5033,6 @@ export const KEYS_CONTACTS_BASE = [
|
|
|
3707
5033
|
KEY_CONTACTS_BASE_POSSIBLE_ATTRIBUTES,
|
|
3708
5034
|
KEY_CONTACTS_BASE_PRIVACY_PROXY,
|
|
3709
5035
|
KEY_CONTACTS_BASE_REGISTRANT_CHANGE,
|
|
3710
|
-
KEY_CONTACTS_BASE_REQUIRED_ATTRIBUTES,
|
|
3711
5036
|
KEY_CONTACTS_BASE_SUPPORT_CHECK,
|
|
3712
5037
|
KEY_CONTACTS_BASE_SUPPORT_CLIENT_CONTACT_ID,
|
|
3713
5038
|
KEY_CONTACTS_BASE_SUPPORT_TRANSFER,
|