@opusdns/api 0.258.0 → 0.259.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.
@@ -35,6 +35,7 @@ import { BillingMetadata } from './schemas';
35
35
  import { BillingPlan } from './schemas';
36
36
  import { BillingTransaction } from './schemas';
37
37
  import { BrowserStatsBucket } from './schemas';
38
+ import { BulkObjectTagChanges } from './schemas';
38
39
  import { CommandError } from './schemas';
39
40
  import { ContactAttributeDefinition } from './schemas';
40
41
  import { ContactAttributeLinkDetail } from './schemas';
@@ -212,6 +213,8 @@ import { LegalRequirementBase } from './schemas';
212
213
  import { LocalPresenceBase } from './schemas';
213
214
  import { Nameserver } from './schemas';
214
215
  import { ObjectLog } from './schemas';
216
+ import { ObjectTagChanges } from './schemas';
217
+ import { ObjectTagChanges2 } from './schemas';
215
218
  import { Organization } from './schemas';
216
219
  import { OrganizationAttribute } from './schemas';
217
220
  import { OrganizationAttributeCreate } from './schemas';
@@ -274,6 +277,9 @@ import { SldLength } from './schemas';
274
277
  import { SpiceDbRelationshipUpdate } from './schemas';
275
278
  import { StatusChanges } from './schemas';
276
279
  import { StatusCodeStatsBucket } from './schemas';
280
+ import { TagCreate } from './schemas';
281
+ import { Tag } from './schemas';
282
+ import { TagUpdate } from './schemas';
277
283
  import { TimeSeriesBucket } from './schemas';
278
284
  import { TldBase } from './schemas';
279
285
  import { TldResponseShort } from './schemas';
@@ -1233,6 +1239,163 @@ export const KEYS_BROWSER_STATS_BUCKET = [
1233
1239
  KEY_BROWSER_STATS_BUCKET_UNIQUE,
1234
1240
  ] as const satisfies (keyof BrowserStatsBucket)[];
1235
1241
 
1242
+ /**
1243
+ * Add
1244
+ *
1245
+ * Tag IDs to add to the objects.
1246
+ *
1247
+ * @type {array}
1248
+ *
1249
+ *
1250
+ * @remarks
1251
+ * This key constant provides type-safe access to the `add` property of BulkObjectTagChanges objects.
1252
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1253
+ *
1254
+ * @example
1255
+ * ```typescript
1256
+ * // Direct property access
1257
+ * const value = bulkobjecttagchanges[KEY_BULK_OBJECT_TAG_CHANGES_ADD];
1258
+ *
1259
+ * // Dynamic property access
1260
+ * const propertyName = KEY_BULK_OBJECT_TAG_CHANGES_ADD;
1261
+ * const value = bulkobjecttagchanges[propertyName];
1262
+ * ```
1263
+ *
1264
+ * @see {@link BulkObjectTagChanges} - The TypeScript type definition
1265
+ * @see {@link KEYS_BULK_OBJECT_TAG_CHANGES} - Array of all keys for this type
1266
+ */
1267
+ export const KEY_BULK_OBJECT_TAG_CHANGES_ADD: keyof BulkObjectTagChanges = 'add';
1268
+ /**
1269
+ * Objects
1270
+ *
1271
+ * Object references to operate on. TypeIDs and resource names may be mixed.
1272
+ *
1273
+ * @type {array}
1274
+ *
1275
+ *
1276
+ * @remarks
1277
+ * This key constant provides type-safe access to the `objects` property of BulkObjectTagChanges objects.
1278
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1279
+ *
1280
+ * @example
1281
+ * ```typescript
1282
+ * // Direct property access
1283
+ * const value = bulkobjecttagchanges[KEY_BULK_OBJECT_TAG_CHANGES_OBJECTS];
1284
+ *
1285
+ * // Dynamic property access
1286
+ * const propertyName = KEY_BULK_OBJECT_TAG_CHANGES_OBJECTS;
1287
+ * const value = bulkobjecttagchanges[propertyName];
1288
+ * ```
1289
+ *
1290
+ * @see {@link BulkObjectTagChanges} - The TypeScript type definition
1291
+ * @see {@link KEYS_BULK_OBJECT_TAG_CHANGES} - Array of all keys for this type
1292
+ */
1293
+ export const KEY_BULK_OBJECT_TAG_CHANGES_OBJECTS: keyof BulkObjectTagChanges = 'objects';
1294
+ /**
1295
+ * Remove
1296
+ *
1297
+ * Tag IDs to remove from the objects.
1298
+ *
1299
+ * @type {array}
1300
+ *
1301
+ *
1302
+ * @remarks
1303
+ * This key constant provides type-safe access to the `remove` property of BulkObjectTagChanges objects.
1304
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1305
+ *
1306
+ * @example
1307
+ * ```typescript
1308
+ * // Direct property access
1309
+ * const value = bulkobjecttagchanges[KEY_BULK_OBJECT_TAG_CHANGES_REMOVE];
1310
+ *
1311
+ * // Dynamic property access
1312
+ * const propertyName = KEY_BULK_OBJECT_TAG_CHANGES_REMOVE;
1313
+ * const value = bulkobjecttagchanges[propertyName];
1314
+ * ```
1315
+ *
1316
+ * @see {@link BulkObjectTagChanges} - The TypeScript type definition
1317
+ * @see {@link KEYS_BULK_OBJECT_TAG_CHANGES} - Array of all keys for this type
1318
+ */
1319
+ export const KEY_BULK_OBJECT_TAG_CHANGES_REMOVE: keyof BulkObjectTagChanges = 'remove';
1320
+ /**
1321
+ * Replace
1322
+ *
1323
+ * Tag IDs to set as the complete tag set for the objects, replacing any existing tags. Mutually exclusive with 'add' and 'remove'. An empty list removes all tags.
1324
+ *
1325
+ *
1326
+ *
1327
+ * @remarks
1328
+ * This key constant provides type-safe access to the `replace` property of BulkObjectTagChanges objects.
1329
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1330
+ *
1331
+ * @example
1332
+ * ```typescript
1333
+ * // Direct property access
1334
+ * const value = bulkobjecttagchanges[KEY_BULK_OBJECT_TAG_CHANGES_REPLACE];
1335
+ *
1336
+ * // Dynamic property access
1337
+ * const propertyName = KEY_BULK_OBJECT_TAG_CHANGES_REPLACE;
1338
+ * const value = bulkobjecttagchanges[propertyName];
1339
+ * ```
1340
+ *
1341
+ * @see {@link BulkObjectTagChanges} - The TypeScript type definition
1342
+ * @see {@link KEYS_BULK_OBJECT_TAG_CHANGES} - Array of all keys for this type
1343
+ */
1344
+ export const KEY_BULK_OBJECT_TAG_CHANGES_REPLACE: keyof BulkObjectTagChanges = 'replace';
1345
+ /**
1346
+ * type property
1347
+ *
1348
+ * The object/tag type (e.g. DOMAIN, CONTACT, ZONE)
1349
+ *
1350
+ *
1351
+ *
1352
+ * @remarks
1353
+ * This key constant provides type-safe access to the `type` property of BulkObjectTagChanges objects.
1354
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1355
+ *
1356
+ * @example
1357
+ * ```typescript
1358
+ * // Direct property access
1359
+ * const value = bulkobjecttagchanges[KEY_BULK_OBJECT_TAG_CHANGES_TYPE];
1360
+ *
1361
+ * // Dynamic property access
1362
+ * const propertyName = KEY_BULK_OBJECT_TAG_CHANGES_TYPE;
1363
+ * const value = bulkobjecttagchanges[propertyName];
1364
+ * ```
1365
+ *
1366
+ * @see {@link BulkObjectTagChanges} - The TypeScript type definition
1367
+ * @see {@link KEYS_BULK_OBJECT_TAG_CHANGES} - Array of all keys for this type
1368
+ */
1369
+ export const KEY_BULK_OBJECT_TAG_CHANGES_TYPE: keyof BulkObjectTagChanges = 'type';
1370
+
1371
+ /**
1372
+ * Array of all BulkObjectTagChanges property keys
1373
+ *
1374
+ * @remarks
1375
+ * This constant provides a readonly array containing all valid property keys for BulkObjectTagChanges objects.
1376
+ * Useful for iteration, validation, and generating dynamic UI components.
1377
+ *
1378
+ * @example
1379
+ * ```typescript
1380
+ * // Iterating through all keys
1381
+ * for (const key of KEYS_BULK_OBJECT_TAG_CHANGES) {
1382
+ * console.log(`Property: ${key}, Value: ${bulkobjecttagchanges[key]}`);
1383
+ * }
1384
+ *
1385
+ * // Validation
1386
+ * const isValidKey = KEYS_BULK_OBJECT_TAG_CHANGES.includes(someKey);
1387
+ * ```
1388
+ *
1389
+ * @see {@link BulkObjectTagChanges} - The TypeScript type definition
1390
+ */
1391
+ export const KEYS_BULK_OBJECT_TAG_CHANGES = [
1392
+ KEY_BULK_OBJECT_TAG_CHANGES_ADD,
1393
+ KEY_BULK_OBJECT_TAG_CHANGES_OBJECTS,
1394
+ KEY_BULK_OBJECT_TAG_CHANGES_REMOVE,
1395
+ KEY_BULK_OBJECT_TAG_CHANGES_REPLACE,
1396
+ KEY_BULK_OBJECT_TAG_CHANGES_TYPE,
1397
+ ] as const satisfies (keyof BulkObjectTagChanges)[];
1398
+
1236
1399
  /**
1237
1400
  * Error
1238
1401
  *
@@ -26251,6 +26414,189 @@ export const KEYS_OBJECT_LOG = [
26251
26414
  KEY_OBJECT_LOG_SERVER_REQUEST_ID,
26252
26415
  ] as const satisfies (keyof ObjectLog)[];
26253
26416
 
26417
+ /**
26418
+ * Add
26419
+ *
26420
+ * Object TypeIDs or resource names to tag. TypeIDs and names may be mixed.
26421
+ *
26422
+ * @type {array}
26423
+ *
26424
+ *
26425
+ * @remarks
26426
+ * This key constant provides type-safe access to the `add` property of ObjectTagChanges objects.
26427
+ * Use this constant when you need to access properties dynamically or ensure type safety.
26428
+ *
26429
+ * @example
26430
+ * ```typescript
26431
+ * // Direct property access
26432
+ * const value = objecttagchanges[KEY_OBJECT_TAG_CHANGES_ADD];
26433
+ *
26434
+ * // Dynamic property access
26435
+ * const propertyName = KEY_OBJECT_TAG_CHANGES_ADD;
26436
+ * const value = objecttagchanges[propertyName];
26437
+ * ```
26438
+ *
26439
+ * @see {@link ObjectTagChanges} - The TypeScript type definition
26440
+ * @see {@link KEYS_OBJECT_TAG_CHANGES} - Array of all keys for this type
26441
+ */
26442
+ export const KEY_OBJECT_TAG_CHANGES_ADD: keyof ObjectTagChanges = 'add';
26443
+ /**
26444
+ * Remove
26445
+ *
26446
+ * Object TypeIDs or resource names to untag. TypeIDs and names may be mixed.
26447
+ *
26448
+ * @type {array}
26449
+ *
26450
+ *
26451
+ * @remarks
26452
+ * This key constant provides type-safe access to the `remove` property of ObjectTagChanges objects.
26453
+ * Use this constant when you need to access properties dynamically or ensure type safety.
26454
+ *
26455
+ * @example
26456
+ * ```typescript
26457
+ * // Direct property access
26458
+ * const value = objecttagchanges[KEY_OBJECT_TAG_CHANGES_REMOVE];
26459
+ *
26460
+ * // Dynamic property access
26461
+ * const propertyName = KEY_OBJECT_TAG_CHANGES_REMOVE;
26462
+ * const value = objecttagchanges[propertyName];
26463
+ * ```
26464
+ *
26465
+ * @see {@link ObjectTagChanges} - The TypeScript type definition
26466
+ * @see {@link KEYS_OBJECT_TAG_CHANGES} - Array of all keys for this type
26467
+ */
26468
+ export const KEY_OBJECT_TAG_CHANGES_REMOVE: keyof ObjectTagChanges = 'remove';
26469
+
26470
+ /**
26471
+ * Array of all ObjectTagChanges property keys
26472
+ *
26473
+ * @remarks
26474
+ * This constant provides a readonly array containing all valid property keys for ObjectTagChanges objects.
26475
+ * Useful for iteration, validation, and generating dynamic UI components.
26476
+ *
26477
+ * @example
26478
+ * ```typescript
26479
+ * // Iterating through all keys
26480
+ * for (const key of KEYS_OBJECT_TAG_CHANGES) {
26481
+ * console.log(`Property: ${key}, Value: ${objecttagchanges[key]}`);
26482
+ * }
26483
+ *
26484
+ * // Validation
26485
+ * const isValidKey = KEYS_OBJECT_TAG_CHANGES.includes(someKey);
26486
+ * ```
26487
+ *
26488
+ * @see {@link ObjectTagChanges} - The TypeScript type definition
26489
+ */
26490
+ export const KEYS_OBJECT_TAG_CHANGES = [
26491
+ KEY_OBJECT_TAG_CHANGES_ADD,
26492
+ KEY_OBJECT_TAG_CHANGES_REMOVE,
26493
+ ] as const satisfies (keyof ObjectTagChanges)[];
26494
+
26495
+ /**
26496
+ * Added
26497
+ *
26498
+ * Number of objects tagged
26499
+ *
26500
+ * @type {integer}
26501
+ *
26502
+ *
26503
+ * @remarks
26504
+ * This key constant provides type-safe access to the `added` property of ObjectTagChanges2 objects.
26505
+ * Use this constant when you need to access properties dynamically or ensure type safety.
26506
+ *
26507
+ * @example
26508
+ * ```typescript
26509
+ * // Direct property access
26510
+ * const value = objecttagchanges2[KEY_OBJECT_TAG_CHANGES2_ADDED];
26511
+ *
26512
+ * // Dynamic property access
26513
+ * const propertyName = KEY_OBJECT_TAG_CHANGES2_ADDED;
26514
+ * const value = objecttagchanges2[propertyName];
26515
+ * ```
26516
+ *
26517
+ * @see {@link ObjectTagChanges2} - The TypeScript type definition
26518
+ * @see {@link KEYS_OBJECT_TAG_CHANGES2} - Array of all keys for this type
26519
+ */
26520
+ export const KEY_OBJECT_TAG_CHANGES2_ADDED: keyof ObjectTagChanges2 = 'added';
26521
+ /**
26522
+ * Removed
26523
+ *
26524
+ * Number of objects untagged
26525
+ *
26526
+ * @type {integer}
26527
+ *
26528
+ *
26529
+ * @remarks
26530
+ * This key constant provides type-safe access to the `removed` property of ObjectTagChanges2 objects.
26531
+ * Use this constant when you need to access properties dynamically or ensure type safety.
26532
+ *
26533
+ * @example
26534
+ * ```typescript
26535
+ * // Direct property access
26536
+ * const value = objecttagchanges2[KEY_OBJECT_TAG_CHANGES2_REMOVED];
26537
+ *
26538
+ * // Dynamic property access
26539
+ * const propertyName = KEY_OBJECT_TAG_CHANGES2_REMOVED;
26540
+ * const value = objecttagchanges2[propertyName];
26541
+ * ```
26542
+ *
26543
+ * @see {@link ObjectTagChanges2} - The TypeScript type definition
26544
+ * @see {@link KEYS_OBJECT_TAG_CHANGES2} - Array of all keys for this type
26545
+ */
26546
+ export const KEY_OBJECT_TAG_CHANGES2_REMOVED: keyof ObjectTagChanges2 = 'removed';
26547
+ /**
26548
+ * Unresolved
26549
+ *
26550
+ * References that could not be resolved
26551
+ *
26552
+ * @type {array}
26553
+ *
26554
+ *
26555
+ * @remarks
26556
+ * This key constant provides type-safe access to the `unresolved` property of ObjectTagChanges2 objects.
26557
+ * Use this constant when you need to access properties dynamically or ensure type safety.
26558
+ *
26559
+ * @example
26560
+ * ```typescript
26561
+ * // Direct property access
26562
+ * const value = objecttagchanges2[KEY_OBJECT_TAG_CHANGES2_UNRESOLVED];
26563
+ *
26564
+ * // Dynamic property access
26565
+ * const propertyName = KEY_OBJECT_TAG_CHANGES2_UNRESOLVED;
26566
+ * const value = objecttagchanges2[propertyName];
26567
+ * ```
26568
+ *
26569
+ * @see {@link ObjectTagChanges2} - The TypeScript type definition
26570
+ * @see {@link KEYS_OBJECT_TAG_CHANGES2} - Array of all keys for this type
26571
+ */
26572
+ export const KEY_OBJECT_TAG_CHANGES2_UNRESOLVED: keyof ObjectTagChanges2 = 'unresolved';
26573
+
26574
+ /**
26575
+ * Array of all ObjectTagChanges2 property keys
26576
+ *
26577
+ * @remarks
26578
+ * This constant provides a readonly array containing all valid property keys for ObjectTagChanges2 objects.
26579
+ * Useful for iteration, validation, and generating dynamic UI components.
26580
+ *
26581
+ * @example
26582
+ * ```typescript
26583
+ * // Iterating through all keys
26584
+ * for (const key of KEYS_OBJECT_TAG_CHANGES2) {
26585
+ * console.log(`Property: ${key}, Value: ${objecttagchanges2[key]}`);
26586
+ * }
26587
+ *
26588
+ * // Validation
26589
+ * const isValidKey = KEYS_OBJECT_TAG_CHANGES2.includes(someKey);
26590
+ * ```
26591
+ *
26592
+ * @see {@link ObjectTagChanges2} - The TypeScript type definition
26593
+ */
26594
+ export const KEYS_OBJECT_TAG_CHANGES2 = [
26595
+ KEY_OBJECT_TAG_CHANGES2_ADDED,
26596
+ KEY_OBJECT_TAG_CHANGES2_REMOVED,
26597
+ KEY_OBJECT_TAG_CHANGES2_UNRESOLVED,
26598
+ ] as const satisfies (keyof ObjectTagChanges2)[];
26599
+
26254
26600
  /**
26255
26601
  * Address 1
26256
26602
  *
@@ -34327,6 +34673,474 @@ export const KEYS_STATUS_CODE_STATS_BUCKET = [
34327
34673
  KEY_STATUS_CODE_STATS_BUCKET_TOTAL,
34328
34674
  ] as const satisfies (keyof StatusCodeStatsBucket)[];
34329
34675
 
34676
+ /**
34677
+ * color property
34678
+ *
34679
+ * The color of the tag
34680
+ *
34681
+ *
34682
+ *
34683
+ * @remarks
34684
+ * This key constant provides type-safe access to the `color` property of TagCreate objects.
34685
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34686
+ *
34687
+ * @example
34688
+ * ```typescript
34689
+ * // Direct property access
34690
+ * const value = tagcreate[KEY_TAG_CREATE_COLOR];
34691
+ *
34692
+ * // Dynamic property access
34693
+ * const propertyName = KEY_TAG_CREATE_COLOR;
34694
+ * const value = tagcreate[propertyName];
34695
+ * ```
34696
+ *
34697
+ * @see {@link TagCreate} - The TypeScript type definition
34698
+ * @see {@link KEYS_TAG_CREATE} - Array of all keys for this type
34699
+ */
34700
+ export const KEY_TAG_CREATE_COLOR: keyof TagCreate = 'color';
34701
+ /**
34702
+ * Description
34703
+ *
34704
+ * Optional description of the tag
34705
+ *
34706
+ *
34707
+ *
34708
+ * @remarks
34709
+ * This key constant provides type-safe access to the `description` property of TagCreate objects.
34710
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34711
+ *
34712
+ * @example
34713
+ * ```typescript
34714
+ * // Direct property access
34715
+ * const value = tagcreate[KEY_TAG_CREATE_DESCRIPTION];
34716
+ *
34717
+ * // Dynamic property access
34718
+ * const propertyName = KEY_TAG_CREATE_DESCRIPTION;
34719
+ * const value = tagcreate[propertyName];
34720
+ * ```
34721
+ *
34722
+ * @see {@link TagCreate} - The TypeScript type definition
34723
+ * @see {@link KEYS_TAG_CREATE} - Array of all keys for this type
34724
+ */
34725
+ export const KEY_TAG_CREATE_DESCRIPTION: keyof TagCreate = 'description';
34726
+ /**
34727
+ * Label
34728
+ *
34729
+ * A human-readable label for the tag
34730
+ *
34731
+ * @type {string}
34732
+ *
34733
+ *
34734
+ * @remarks
34735
+ * This key constant provides type-safe access to the `label` property of TagCreate objects.
34736
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34737
+ *
34738
+ * @example
34739
+ * ```typescript
34740
+ * // Direct property access
34741
+ * const value = tagcreate[KEY_TAG_CREATE_LABEL];
34742
+ *
34743
+ * // Dynamic property access
34744
+ * const propertyName = KEY_TAG_CREATE_LABEL;
34745
+ * const value = tagcreate[propertyName];
34746
+ * ```
34747
+ *
34748
+ * @see {@link TagCreate} - The TypeScript type definition
34749
+ * @see {@link KEYS_TAG_CREATE} - Array of all keys for this type
34750
+ */
34751
+ export const KEY_TAG_CREATE_LABEL: keyof TagCreate = 'label';
34752
+ /**
34753
+ * type property
34754
+ *
34755
+ * Which category a tag applies to, cannot be changed once created
34756
+ *
34757
+ *
34758
+ *
34759
+ * @remarks
34760
+ * This key constant provides type-safe access to the `type` property of TagCreate objects.
34761
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34762
+ *
34763
+ * @example
34764
+ * ```typescript
34765
+ * // Direct property access
34766
+ * const value = tagcreate[KEY_TAG_CREATE_TYPE];
34767
+ *
34768
+ * // Dynamic property access
34769
+ * const propertyName = KEY_TAG_CREATE_TYPE;
34770
+ * const value = tagcreate[propertyName];
34771
+ * ```
34772
+ *
34773
+ * @see {@link TagCreate} - The TypeScript type definition
34774
+ * @see {@link KEYS_TAG_CREATE} - Array of all keys for this type
34775
+ */
34776
+ export const KEY_TAG_CREATE_TYPE: keyof TagCreate = 'type';
34777
+
34778
+ /**
34779
+ * Array of all TagCreate property keys
34780
+ *
34781
+ * @remarks
34782
+ * This constant provides a readonly array containing all valid property keys for TagCreate objects.
34783
+ * Useful for iteration, validation, and generating dynamic UI components.
34784
+ *
34785
+ * @example
34786
+ * ```typescript
34787
+ * // Iterating through all keys
34788
+ * for (const key of KEYS_TAG_CREATE) {
34789
+ * console.log(`Property: ${key}, Value: ${tagcreate[key]}`);
34790
+ * }
34791
+ *
34792
+ * // Validation
34793
+ * const isValidKey = KEYS_TAG_CREATE.includes(someKey);
34794
+ * ```
34795
+ *
34796
+ * @see {@link TagCreate} - The TypeScript type definition
34797
+ */
34798
+ export const KEYS_TAG_CREATE = [
34799
+ KEY_TAG_CREATE_COLOR,
34800
+ KEY_TAG_CREATE_DESCRIPTION,
34801
+ KEY_TAG_CREATE_LABEL,
34802
+ KEY_TAG_CREATE_TYPE,
34803
+ ] as const satisfies (keyof TagCreate)[];
34804
+
34805
+ /**
34806
+ * color property
34807
+ *
34808
+ * The color of the tag
34809
+ *
34810
+ *
34811
+ *
34812
+ * @remarks
34813
+ * This key constant provides type-safe access to the `color` property of Tag objects.
34814
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34815
+ *
34816
+ * @example
34817
+ * ```typescript
34818
+ * // Direct property access
34819
+ * const value = tag[KEY_TAG_COLOR];
34820
+ *
34821
+ * // Dynamic property access
34822
+ * const propertyName = KEY_TAG_COLOR;
34823
+ * const value = tag[propertyName];
34824
+ * ```
34825
+ *
34826
+ * @see {@link Tag} - The TypeScript type definition
34827
+ * @see {@link KEYS_TAG} - Array of all keys for this type
34828
+ */
34829
+ export const KEY_TAG_COLOR: keyof Tag = 'color';
34830
+ /**
34831
+ * Created On
34832
+ *
34833
+ * The date/time the tag was created on
34834
+ *
34835
+ * @type {string}
34836
+ *
34837
+ *
34838
+ * @remarks
34839
+ * This key constant provides type-safe access to the `created_on` property of Tag objects.
34840
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34841
+ *
34842
+ * @example
34843
+ * ```typescript
34844
+ * // Direct property access
34845
+ * const value = tag[KEY_TAG_CREATED_ON];
34846
+ *
34847
+ * // Dynamic property access
34848
+ * const propertyName = KEY_TAG_CREATED_ON;
34849
+ * const value = tag[propertyName];
34850
+ * ```
34851
+ *
34852
+ * @see {@link Tag} - The TypeScript type definition
34853
+ * @see {@link KEYS_TAG} - Array of all keys for this type
34854
+ */
34855
+ export const KEY_TAG_CREATED_ON: keyof Tag = 'created_on';
34856
+ /**
34857
+ * Description
34858
+ *
34859
+ * Optional description of the tag
34860
+ *
34861
+ *
34862
+ *
34863
+ * @remarks
34864
+ * This key constant provides type-safe access to the `description` property of Tag objects.
34865
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34866
+ *
34867
+ * @example
34868
+ * ```typescript
34869
+ * // Direct property access
34870
+ * const value = tag[KEY_TAG_DESCRIPTION];
34871
+ *
34872
+ * // Dynamic property access
34873
+ * const propertyName = KEY_TAG_DESCRIPTION;
34874
+ * const value = tag[propertyName];
34875
+ * ```
34876
+ *
34877
+ * @see {@link Tag} - The TypeScript type definition
34878
+ * @see {@link KEYS_TAG} - Array of all keys for this type
34879
+ */
34880
+ export const KEY_TAG_DESCRIPTION: keyof Tag = 'description';
34881
+ /**
34882
+ * Label
34883
+ *
34884
+ * The label of the tag
34885
+ *
34886
+ * @type {string}
34887
+ *
34888
+ *
34889
+ * @remarks
34890
+ * This key constant provides type-safe access to the `label` property of Tag objects.
34891
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34892
+ *
34893
+ * @example
34894
+ * ```typescript
34895
+ * // Direct property access
34896
+ * const value = tag[KEY_TAG_LABEL];
34897
+ *
34898
+ * // Dynamic property access
34899
+ * const propertyName = KEY_TAG_LABEL;
34900
+ * const value = tag[propertyName];
34901
+ * ```
34902
+ *
34903
+ * @see {@link Tag} - The TypeScript type definition
34904
+ * @see {@link KEYS_TAG} - Array of all keys for this type
34905
+ */
34906
+ export const KEY_TAG_LABEL: keyof Tag = 'label';
34907
+ /**
34908
+ * Object Count
34909
+ *
34910
+ * Number of objects tagged with this tag
34911
+ *
34912
+ * @type {integer}
34913
+ *
34914
+ *
34915
+ * @remarks
34916
+ * This key constant provides type-safe access to the `object_count` property of Tag objects.
34917
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34918
+ *
34919
+ * @example
34920
+ * ```typescript
34921
+ * // Direct property access
34922
+ * const value = tag[KEY_TAG_OBJECT_COUNT];
34923
+ *
34924
+ * // Dynamic property access
34925
+ * const propertyName = KEY_TAG_OBJECT_COUNT;
34926
+ * const value = tag[propertyName];
34927
+ * ```
34928
+ *
34929
+ * @see {@link Tag} - The TypeScript type definition
34930
+ * @see {@link KEYS_TAG} - Array of all keys for this type
34931
+ */
34932
+ export const KEY_TAG_OBJECT_COUNT: keyof Tag = 'object_count';
34933
+ /**
34934
+ * Tag Id
34935
+ *
34936
+ * The unique identifier of the tag
34937
+ *
34938
+ * @type {string}
34939
+ *
34940
+ *
34941
+ * @remarks
34942
+ * This key constant provides type-safe access to the `tag_id` property of Tag objects.
34943
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34944
+ *
34945
+ * @example
34946
+ * ```typescript
34947
+ * // Direct property access
34948
+ * const value = tag[KEY_TAG_TAG_ID];
34949
+ *
34950
+ * // Dynamic property access
34951
+ * const propertyName = KEY_TAG_TAG_ID;
34952
+ * const value = tag[propertyName];
34953
+ * ```
34954
+ *
34955
+ * @see {@link Tag} - The TypeScript type definition
34956
+ * @see {@link KEYS_TAG} - Array of all keys for this type
34957
+ */
34958
+ export const KEY_TAG_TAG_ID: keyof Tag = 'tag_id';
34959
+ /**
34960
+ * type property
34961
+ *
34962
+ * Which category a tag applies to, cannot be changed once created
34963
+ *
34964
+ *
34965
+ *
34966
+ * @remarks
34967
+ * This key constant provides type-safe access to the `type` property of Tag objects.
34968
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34969
+ *
34970
+ * @example
34971
+ * ```typescript
34972
+ * // Direct property access
34973
+ * const value = tag[KEY_TAG_TYPE];
34974
+ *
34975
+ * // Dynamic property access
34976
+ * const propertyName = KEY_TAG_TYPE;
34977
+ * const value = tag[propertyName];
34978
+ * ```
34979
+ *
34980
+ * @see {@link Tag} - The TypeScript type definition
34981
+ * @see {@link KEYS_TAG} - Array of all keys for this type
34982
+ */
34983
+ export const KEY_TAG_TYPE: keyof Tag = 'type';
34984
+ /**
34985
+ * Updated On
34986
+ *
34987
+ * The date/time the tag was last updated on
34988
+ *
34989
+ * @type {string}
34990
+ *
34991
+ *
34992
+ * @remarks
34993
+ * This key constant provides type-safe access to the `updated_on` property of Tag objects.
34994
+ * Use this constant when you need to access properties dynamically or ensure type safety.
34995
+ *
34996
+ * @example
34997
+ * ```typescript
34998
+ * // Direct property access
34999
+ * const value = tag[KEY_TAG_UPDATED_ON];
35000
+ *
35001
+ * // Dynamic property access
35002
+ * const propertyName = KEY_TAG_UPDATED_ON;
35003
+ * const value = tag[propertyName];
35004
+ * ```
35005
+ *
35006
+ * @see {@link Tag} - The TypeScript type definition
35007
+ * @see {@link KEYS_TAG} - Array of all keys for this type
35008
+ */
35009
+ export const KEY_TAG_UPDATED_ON: keyof Tag = 'updated_on';
35010
+
35011
+ /**
35012
+ * Array of all Tag property keys
35013
+ *
35014
+ * @remarks
35015
+ * This constant provides a readonly array containing all valid property keys for Tag objects.
35016
+ * Useful for iteration, validation, and generating dynamic UI components.
35017
+ *
35018
+ * @example
35019
+ * ```typescript
35020
+ * // Iterating through all keys
35021
+ * for (const key of KEYS_TAG) {
35022
+ * console.log(`Property: ${key}, Value: ${tag[key]}`);
35023
+ * }
35024
+ *
35025
+ * // Validation
35026
+ * const isValidKey = KEYS_TAG.includes(someKey);
35027
+ * ```
35028
+ *
35029
+ * @see {@link Tag} - The TypeScript type definition
35030
+ */
35031
+ export const KEYS_TAG = [
35032
+ KEY_TAG_COLOR,
35033
+ KEY_TAG_CREATED_ON,
35034
+ KEY_TAG_DESCRIPTION,
35035
+ KEY_TAG_LABEL,
35036
+ KEY_TAG_OBJECT_COUNT,
35037
+ KEY_TAG_TAG_ID,
35038
+ KEY_TAG_TYPE,
35039
+ KEY_TAG_UPDATED_ON,
35040
+ ] as const satisfies (keyof Tag)[];
35041
+
35042
+ /**
35043
+ * color property
35044
+ *
35045
+ * The color of the tag
35046
+ *
35047
+ *
35048
+ *
35049
+ * @remarks
35050
+ * This key constant provides type-safe access to the `color` property of TagUpdate objects.
35051
+ * Use this constant when you need to access properties dynamically or ensure type safety.
35052
+ *
35053
+ * @example
35054
+ * ```typescript
35055
+ * // Direct property access
35056
+ * const value = tagupdate[KEY_TAG_UPDATE_COLOR];
35057
+ *
35058
+ * // Dynamic property access
35059
+ * const propertyName = KEY_TAG_UPDATE_COLOR;
35060
+ * const value = tagupdate[propertyName];
35061
+ * ```
35062
+ *
35063
+ * @see {@link TagUpdate} - The TypeScript type definition
35064
+ * @see {@link KEYS_TAG_UPDATE} - Array of all keys for this type
35065
+ */
35066
+ export const KEY_TAG_UPDATE_COLOR: keyof TagUpdate = 'color';
35067
+ /**
35068
+ * Description
35069
+ *
35070
+ * Optional description of the tag
35071
+ *
35072
+ *
35073
+ *
35074
+ * @remarks
35075
+ * This key constant provides type-safe access to the `description` property of TagUpdate objects.
35076
+ * Use this constant when you need to access properties dynamically or ensure type safety.
35077
+ *
35078
+ * @example
35079
+ * ```typescript
35080
+ * // Direct property access
35081
+ * const value = tagupdate[KEY_TAG_UPDATE_DESCRIPTION];
35082
+ *
35083
+ * // Dynamic property access
35084
+ * const propertyName = KEY_TAG_UPDATE_DESCRIPTION;
35085
+ * const value = tagupdate[propertyName];
35086
+ * ```
35087
+ *
35088
+ * @see {@link TagUpdate} - The TypeScript type definition
35089
+ * @see {@link KEYS_TAG_UPDATE} - Array of all keys for this type
35090
+ */
35091
+ export const KEY_TAG_UPDATE_DESCRIPTION: keyof TagUpdate = 'description';
35092
+ /**
35093
+ * Label
35094
+ *
35095
+ * A human-readable label for the tag
35096
+ *
35097
+ *
35098
+ *
35099
+ * @remarks
35100
+ * This key constant provides type-safe access to the `label` property of TagUpdate objects.
35101
+ * Use this constant when you need to access properties dynamically or ensure type safety.
35102
+ *
35103
+ * @example
35104
+ * ```typescript
35105
+ * // Direct property access
35106
+ * const value = tagupdate[KEY_TAG_UPDATE_LABEL];
35107
+ *
35108
+ * // Dynamic property access
35109
+ * const propertyName = KEY_TAG_UPDATE_LABEL;
35110
+ * const value = tagupdate[propertyName];
35111
+ * ```
35112
+ *
35113
+ * @see {@link TagUpdate} - The TypeScript type definition
35114
+ * @see {@link KEYS_TAG_UPDATE} - Array of all keys for this type
35115
+ */
35116
+ export const KEY_TAG_UPDATE_LABEL: keyof TagUpdate = 'label';
35117
+
35118
+ /**
35119
+ * Array of all TagUpdate property keys
35120
+ *
35121
+ * @remarks
35122
+ * This constant provides a readonly array containing all valid property keys for TagUpdate objects.
35123
+ * Useful for iteration, validation, and generating dynamic UI components.
35124
+ *
35125
+ * @example
35126
+ * ```typescript
35127
+ * // Iterating through all keys
35128
+ * for (const key of KEYS_TAG_UPDATE) {
35129
+ * console.log(`Property: ${key}, Value: ${tagupdate[key]}`);
35130
+ * }
35131
+ *
35132
+ * // Validation
35133
+ * const isValidKey = KEYS_TAG_UPDATE.includes(someKey);
35134
+ * ```
35135
+ *
35136
+ * @see {@link TagUpdate} - The TypeScript type definition
35137
+ */
35138
+ export const KEYS_TAG_UPDATE = [
35139
+ KEY_TAG_UPDATE_COLOR,
35140
+ KEY_TAG_UPDATE_DESCRIPTION,
35141
+ KEY_TAG_UPDATE_LABEL,
35142
+ ] as const satisfies (keyof TagUpdate)[];
35143
+
34330
35144
  /**
34331
35145
  * Timestamp
34332
35146
  *