@memberjunction/core-entities 0.9.86 → 0.9.87

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.
@@ -4,14 +4,25 @@ import { BaseEntity } from "@memberjunction/core";
4
4
  * * Schema: admin
5
5
  * * Base Table: Company
6
6
  * * Base View: vwCompanies
7
- * @description List of Companies/Organizations within the top-level business, used for subsidiaries
7
+ * * @description List of Companies/Organizations within the top-level business, used for subsidiaries
8
8
  * * Primary Key: ID
9
- * * Description: List of Companies/Organizations within the top-level business, used for subsidiaries
10
9
  * @extends {BaseEntity}
11
10
  * @class
12
11
  * @public
13
12
  */
14
13
  export declare class CompanyEntity extends BaseEntity {
14
+ /**
15
+ * Loads the Companies record from the database
16
+ * @param ID: Number - primary key value to load the Companies record.
17
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
18
+ * @returns {Promise<boolean>} - true if successful, false otherwise
19
+ * @public
20
+ * @async
21
+ * @memberof CompanyEntity
22
+ * @method
23
+ * @override
24
+ */
25
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
15
26
  /**
16
27
  * * Field Name: ID
17
28
  * * SQL Data Type: int
@@ -69,14 +80,25 @@ export declare class CompanyEntity extends BaseEntity {
69
80
  * * Schema: admin
70
81
  * * Base Table: Employee
71
82
  * * Base View: vwEmployees
72
- * @description Employees
83
+ * * @description Employees
73
84
  * * Primary Key: ID
74
- * * Description: Employees
75
85
  * @extends {BaseEntity}
76
86
  * @class
77
87
  * @public
78
88
  */
79
89
  export declare class EmployeeEntity extends BaseEntity {
90
+ /**
91
+ * Loads the Employees record from the database
92
+ * @param ID: Number - primary key value to load the Employees record.
93
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
94
+ * @returns {Promise<boolean>} - true if successful, false otherwise
95
+ * @public
96
+ * @async
97
+ * @memberof EmployeeEntity
98
+ * @method
99
+ * @override
100
+ */
101
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
80
102
  /**
81
103
  * * Field Name: ID
82
104
  * * SQL Data Type: int
@@ -196,12 +218,23 @@ export declare class EmployeeEntity extends BaseEntity {
196
218
  * * Base Table: UserFavorite
197
219
  * * Base View: vwUserFavorites
198
220
  * * Primary Key: ID
199
- * * Description: null
200
221
  * @extends {BaseEntity}
201
222
  * @class
202
223
  * @public
203
224
  */
204
225
  export declare class UserFavoriteEntity extends BaseEntity {
226
+ /**
227
+ * Loads the User Favorites record from the database
228
+ * @param ID: Number - primary key value to load the User Favorites record.
229
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
230
+ * @returns {Promise<boolean>} - true if successful, false otherwise
231
+ * @public
232
+ * @async
233
+ * @memberof UserFavoriteEntity
234
+ * @method
235
+ * @override
236
+ */
237
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
205
238
  /**
206
239
  * * Field Name: ID
207
240
  * * SQL Data Type: int
@@ -268,12 +301,23 @@ export declare class UserFavoriteEntity extends BaseEntity {
268
301
  * * Base Table: EmployeeCompanyIntegration
269
302
  * * Base View: vwEmployeeCompanyIntegrations
270
303
  * * Primary Key: ID
271
- * * Description: null
272
304
  * @extends {BaseEntity}
273
305
  * @class
274
306
  * @public
275
307
  */
276
308
  export declare class EmployeeCompanyIntegrationEntity extends BaseEntity {
309
+ /**
310
+ * Loads the Employee Company Integrations record from the database
311
+ * @param ID: Number - primary key value to load the Employee Company Integrations record.
312
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
313
+ * @returns {Promise<boolean>} - true if successful, false otherwise
314
+ * @public
315
+ * @async
316
+ * @memberof EmployeeCompanyIntegrationEntity
317
+ * @method
318
+ * @override
319
+ */
320
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
277
321
  /**
278
322
  * * Field Name: ID
279
323
  * * SQL Data Type: int
@@ -331,12 +375,23 @@ export declare class EmployeeCompanyIntegrationEntity extends BaseEntity {
331
375
  * * Base Table: EmployeeRole
332
376
  * * Base View: vwEmployeeRoles
333
377
  * * Primary Key: ID
334
- * * Description: null
335
378
  * @extends {BaseEntity}
336
379
  * @class
337
380
  * @public
338
381
  */
339
382
  export declare class EmployeeRoleEntity extends BaseEntity {
383
+ /**
384
+ * Loads the Employee Roles record from the database
385
+ * @param ID: Number - primary key value to load the Employee Roles record.
386
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
387
+ * @returns {Promise<boolean>} - true if successful, false otherwise
388
+ * @public
389
+ * @async
390
+ * @memberof EmployeeRoleEntity
391
+ * @method
392
+ * @override
393
+ */
394
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
340
395
  /**
341
396
  * * Field Name: ID
342
397
  * * Display Name: ID
@@ -386,12 +441,23 @@ export declare class EmployeeRoleEntity extends BaseEntity {
386
441
  * * Base Table: EmployeeSkill
387
442
  * * Base View: vwEmployeeSkills
388
443
  * * Primary Key: ID
389
- * * Description: null
390
444
  * @extends {BaseEntity}
391
445
  * @class
392
446
  * @public
393
447
  */
394
448
  export declare class EmployeeSkillEntity extends BaseEntity {
449
+ /**
450
+ * Loads the Employee Skills record from the database
451
+ * @param ID: Number - primary key value to load the Employee Skills record.
452
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
453
+ * @returns {Promise<boolean>} - true if successful, false otherwise
454
+ * @public
455
+ * @async
456
+ * @memberof EmployeeSkillEntity
457
+ * @method
458
+ * @override
459
+ */
460
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
395
461
  /**
396
462
  * * Field Name: ID
397
463
  * * Display Name: ID
@@ -441,12 +507,23 @@ export declare class EmployeeSkillEntity extends BaseEntity {
441
507
  * * Base Table: Role
442
508
  * * Base View: vwRoles
443
509
  * * Primary Key: ID
444
- * * Description: null
445
510
  * @extends {BaseEntity}
446
511
  * @class
447
512
  * @public
448
513
  */
449
514
  export declare class RoleEntity extends BaseEntity {
515
+ /**
516
+ * Loads the Roles record from the database
517
+ * @param ID: Number - primary key value to load the Roles record.
518
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
519
+ * @returns {Promise<boolean>} - true if successful, false otherwise
520
+ * @public
521
+ * @async
522
+ * @memberof RoleEntity
523
+ * @method
524
+ * @override
525
+ */
526
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
450
527
  /**
451
528
  * * Field Name: ID
452
529
  * * SQL Data Type: int
@@ -498,12 +575,23 @@ export declare class RoleEntity extends BaseEntity {
498
575
  * * Base Table: Skill
499
576
  * * Base View: vwSkills
500
577
  * * Primary Key: ID
501
- * * Description: null
502
578
  * @extends {BaseEntity}
503
579
  * @class
504
580
  * @public
505
581
  */
506
582
  export declare class SkillEntity extends BaseEntity {
583
+ /**
584
+ * Loads the Skills record from the database
585
+ * @param ID: Number - primary key value to load the Skills record.
586
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
587
+ * @returns {Promise<boolean>} - true if successful, false otherwise
588
+ * @public
589
+ * @async
590
+ * @memberof SkillEntity
591
+ * @method
592
+ * @override
593
+ */
594
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
507
595
  /**
508
596
  * * Field Name: ID
509
597
  * * SQL Data Type: int
@@ -550,12 +638,23 @@ export declare class SkillEntity extends BaseEntity {
550
638
  * * Base Table: IntegrationURLFormat
551
639
  * * Base View: vwIntegrationURLFormats
552
640
  * * Primary Key: ID
553
- * * Description: null
554
641
  * @extends {BaseEntity}
555
642
  * @class
556
643
  * @public
557
644
  */
558
645
  export declare class IntegrationURLFormatEntity extends BaseEntity {
646
+ /**
647
+ * Loads the Integration URL Formats record from the database
648
+ * @param ID: Number - primary key value to load the Integration URL Formats record.
649
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
650
+ * @returns {Promise<boolean>} - true if successful, false otherwise
651
+ * @public
652
+ * @async
653
+ * @memberof IntegrationURLFormatEntity
654
+ * @method
655
+ * @override
656
+ */
657
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
559
658
  /**
560
659
  * * Field Name: ID
561
660
  * * SQL Data Type: int
@@ -613,14 +712,25 @@ export declare class IntegrationURLFormatEntity extends BaseEntity {
613
712
  * * Schema: admin
614
713
  * * Base Table: Integration
615
714
  * * Base View: vwIntegrations
616
- * @description List of integrations that can be executed using the MemberJunction integration architecture.
715
+ * * @description List of integrations that can be executed using the MemberJunction integration architecture.
617
716
  * * Primary Key: ID
618
- * * Description: List of integrations that can be executed using the MemberJunction integration architecture.
619
717
  * @extends {BaseEntity}
620
718
  * @class
621
719
  * @public
622
720
  */
623
721
  export declare class IntegrationEntity extends BaseEntity {
722
+ /**
723
+ * Loads the Integrations record from the database
724
+ * @param ID: Number - primary key value to load the Integrations record.
725
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
726
+ * @returns {Promise<boolean>} - true if successful, false otherwise
727
+ * @public
728
+ * @async
729
+ * @memberof IntegrationEntity
730
+ * @method
731
+ * @override
732
+ */
733
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
624
734
  /**
625
735
  * * Field Name: ID
626
736
  * * SQL Data Type: int
@@ -696,12 +806,23 @@ export declare class IntegrationEntity extends BaseEntity {
696
806
  * * Base Table: CompanyIntegration
697
807
  * * Base View: vwCompanyIntegrations
698
808
  * * Primary Key: ID
699
- * * Description: null
700
809
  * @extends {BaseEntity}
701
810
  * @class
702
811
  * @public
703
812
  */
704
813
  export declare class CompanyIntegrationEntity extends BaseEntity {
814
+ /**
815
+ * Loads the Company Integrations record from the database
816
+ * @param ID: Number - primary key value to load the Company Integrations record.
817
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
818
+ * @returns {Promise<boolean>} - true if successful, false otherwise
819
+ * @public
820
+ * @async
821
+ * @memberof CompanyIntegrationEntity
822
+ * @method
823
+ * @override
824
+ */
825
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
705
826
  /**
706
827
  * * Field Name: ID
707
828
  * * SQL Data Type: int
@@ -866,12 +987,23 @@ export declare class CompanyIntegrationEntity extends BaseEntity {
866
987
  * * Base Table: EntityField
867
988
  * * Base View: vwEntityFields
868
989
  * * Primary Key: ID
869
- * * Description: null
870
990
  * @extends {BaseEntity}
871
991
  * @class
872
992
  * @public
873
993
  */
874
994
  export declare class EntityFieldEntity extends BaseEntity {
995
+ /**
996
+ * Loads the Entity Fields record from the database
997
+ * @param ID: Number - primary key value to load the Entity Fields record.
998
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
999
+ * @returns {Promise<boolean>} - true if successful, false otherwise
1000
+ * @public
1001
+ * @async
1002
+ * @memberof EntityFieldEntity
1003
+ * @method
1004
+ * @override
1005
+ */
1006
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
875
1007
  /**
876
1008
  * * Field Name: ID
877
1009
  * * SQL Data Type: int
@@ -1154,7 +1286,7 @@ export declare class EntityFieldEntity extends BaseEntity {
1154
1286
  /**
1155
1287
  * * Field Name: EntityClassName
1156
1288
  * * Display Name: Entity Class Name
1157
- * * SQL Data Type: nvarchar(511)
1289
+ * * SQL Data Type: nvarchar(4000)
1158
1290
  */
1159
1291
  get EntityClassName(): string;
1160
1292
  /**
@@ -1190,7 +1322,7 @@ export declare class EntityFieldEntity extends BaseEntity {
1190
1322
  /**
1191
1323
  * * Field Name: RelatedEntityClassName
1192
1324
  * * Display Name: Related Entity Class Name
1193
- * * SQL Data Type: nvarchar(511)
1325
+ * * SQL Data Type: nvarchar(4000)
1194
1326
  */
1195
1327
  get RelatedEntityClassName(): string;
1196
1328
  }
@@ -1199,15 +1331,25 @@ export declare class EntityFieldEntity extends BaseEntity {
1199
1331
  * * Schema: admin
1200
1332
  * * Base Table: Entity
1201
1333
  * * Base View: vwEntities
1202
- * @description Metadata about all of the entities in the system. This information is managed by CodeGen, don't modify the parts that come from SQL Server
1334
+ * * @description Metadata about all of the entities in the system. This information is managed by CodeGen, don't modify the parts that come from SQL Server
1203
1335
  * * Primary Key: ID
1204
- * * Description: Metadata about all of the entities in the system. This information is managed by CodeGen, don't modify the parts that come from SQL Server
1205
1336
  * @extends {BaseEntity}
1206
1337
  * @class
1207
1338
  * @public
1208
1339
  */
1209
1340
  export declare class EntityEntity extends BaseEntity {
1210
- Load(ID: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
1341
+ /**
1342
+ * Loads the Entities record from the database
1343
+ * @param ID: Number - primary key value to load the Entities record.
1344
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
1345
+ * @returns {Promise<boolean>} - true if successful, false otherwise
1346
+ * @public
1347
+ * @async
1348
+ * @memberof EntityEntity
1349
+ * @method
1350
+ * @override
1351
+ */
1352
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
1211
1353
  /**
1212
1354
  * * Field Name: ID
1213
1355
  * * SQL Data Type: int
@@ -1522,13 +1664,13 @@ export declare class EntityEntity extends BaseEntity {
1522
1664
  /**
1523
1665
  * * Field Name: ClassName
1524
1666
  * * Display Name: Class Name
1525
- * * SQL Data Type: nvarchar(511)
1667
+ * * SQL Data Type: nvarchar(4000)
1526
1668
  */
1527
1669
  get ClassName(): string;
1528
1670
  /**
1529
1671
  * * Field Name: BaseTableCodeName
1530
1672
  * * Display Name: Base Table Code Name
1531
- * * SQL Data Type: nvarchar(511)
1673
+ * * SQL Data Type: nvarchar(4000)
1532
1674
  */
1533
1675
  get BaseTableCodeName(): string;
1534
1676
  /**
@@ -1556,12 +1698,23 @@ export declare class EntityEntity extends BaseEntity {
1556
1698
  * * Base Table: User
1557
1699
  * * Base View: vwUsers
1558
1700
  * * Primary Key: ID
1559
- * * Description: null
1560
1701
  * @extends {BaseEntity}
1561
1702
  * @class
1562
1703
  * @public
1563
1704
  */
1564
1705
  export declare class UserEntity extends BaseEntity {
1706
+ /**
1707
+ * Loads the Users record from the database
1708
+ * @param ID: Number - primary key value to load the Users record.
1709
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
1710
+ * @returns {Promise<boolean>} - true if successful, false otherwise
1711
+ * @public
1712
+ * @async
1713
+ * @memberof UserEntity
1714
+ * @method
1715
+ * @override
1716
+ */
1717
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
1565
1718
  /**
1566
1719
  * * Field Name: ID
1567
1720
  * * SQL Data Type: int
@@ -1700,12 +1853,23 @@ export declare class UserEntity extends BaseEntity {
1700
1853
  * * Base Table: EntityRelationship
1701
1854
  * * Base View: vwEntityRelationships
1702
1855
  * * Primary Key: ID
1703
- * * Description: null
1704
1856
  * @extends {BaseEntity}
1705
1857
  * @class
1706
1858
  * @public
1707
1859
  */
1708
1860
  export declare class EntityRelationshipEntity extends BaseEntity {
1861
+ /**
1862
+ * Loads the Entity Relationships record from the database
1863
+ * @param ID: Number - primary key value to load the Entity Relationships record.
1864
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
1865
+ * @returns {Promise<boolean>} - true if successful, false otherwise
1866
+ * @public
1867
+ * @async
1868
+ * @memberof EntityRelationshipEntity
1869
+ * @method
1870
+ * @override
1871
+ */
1872
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
1709
1873
  /**
1710
1874
  * * Field Name: ID
1711
1875
  * * SQL Data Type: int
@@ -1859,7 +2023,7 @@ export declare class EntityRelationshipEntity extends BaseEntity {
1859
2023
  /**
1860
2024
  * * Field Name: RelatedEntityClassName
1861
2025
  * * Display Name: Related Entity Class Name
1862
- * * SQL Data Type: nvarchar(511)
2026
+ * * SQL Data Type: nvarchar(4000)
1863
2027
  */
1864
2028
  get RelatedEntityClassName(): string;
1865
2029
  /**
@@ -1871,7 +2035,7 @@ export declare class EntityRelationshipEntity extends BaseEntity {
1871
2035
  /**
1872
2036
  * * Field Name: RelatedEntityBaseTableCodeName
1873
2037
  * * Display Name: Related Entity Base Table Code Name
1874
- * * SQL Data Type: nvarchar(511)
2038
+ * * SQL Data Type: nvarchar(4000)
1875
2039
  */
1876
2040
  get RelatedEntityBaseTableCodeName(): string;
1877
2041
  /**
@@ -1892,14 +2056,25 @@ export declare class EntityRelationshipEntity extends BaseEntity {
1892
2056
  * * Schema: admin
1893
2057
  * * Base Table: UserRecordLog
1894
2058
  * * Base View: vwUserRecordLogs
1895
- * @description Tracks history of user access to records across the system, tracks reads and writes
2059
+ * * @description Tracks history of user access to records across the system, tracks reads and writes
1896
2060
  * * Primary Key: ID
1897
- * * Description: Tracks history of user access to records across the system, tracks reads and writes
1898
2061
  * @extends {BaseEntity}
1899
2062
  * @class
1900
2063
  * @public
1901
2064
  */
1902
2065
  export declare class UserRecordLogEntity extends BaseEntity {
2066
+ /**
2067
+ * Loads the User Record Logs record from the database
2068
+ * @param ID: Number - primary key value to load the User Record Logs record.
2069
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2070
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2071
+ * @public
2072
+ * @async
2073
+ * @memberof UserRecordLogEntity
2074
+ * @method
2075
+ * @override
2076
+ */
2077
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
1903
2078
  /**
1904
2079
  * * Field Name: ID
1905
2080
  * * SQL Data Type: int
@@ -1994,15 +2169,25 @@ export declare class UserRecordLogEntity extends BaseEntity {
1994
2169
  * * Schema: admin
1995
2170
  * * Base Table: UserView
1996
2171
  * * Base View: vwUserViews
1997
- * @description User Views contain the metadata for the user viewing system of entity data
2172
+ * * @description User Views contain the metadata for the user viewing system of entity data
1998
2173
  * * Primary Key: ID
1999
- * * Description: User Views contain the metadata for the user viewing system of entity data
2000
2174
  * @extends {BaseEntity}
2001
2175
  * @class
2002
2176
  * @public
2003
2177
  */
2004
2178
  export declare class UserViewEntity extends BaseEntity {
2005
- Load(ID: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2179
+ /**
2180
+ * Loads the User Views record from the database
2181
+ * @param ID: Number - primary key value to load the User Views record.
2182
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2183
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2184
+ * @public
2185
+ * @async
2186
+ * @memberof UserViewEntity
2187
+ * @method
2188
+ * @override
2189
+ */
2190
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2006
2191
  /**
2007
2192
  * * Field Name: ID
2008
2193
  * * SQL Data Type: int
@@ -2188,14 +2373,25 @@ export declare class UserViewEntity extends BaseEntity {
2188
2373
  * * Schema: admin
2189
2374
  * * Base Table: CompanyIntegrationRun
2190
2375
  * * Base View: vwCompanyIntegrationRuns
2191
- * @description Audit Trail for each run of a given company integration
2376
+ * * @description Audit Trail for each run of a given company integration
2192
2377
  * * Primary Key: ID
2193
- * * Description: Audit Trail for each run of a given company integration
2194
2378
  * @extends {BaseEntity}
2195
2379
  * @class
2196
2380
  * @public
2197
2381
  */
2198
2382
  export declare class CompanyIntegrationRunEntity extends BaseEntity {
2383
+ /**
2384
+ * Loads the Company Integration Runs record from the database
2385
+ * @param ID: Number - primary key value to load the Company Integration Runs record.
2386
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2387
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2388
+ * @public
2389
+ * @async
2390
+ * @memberof CompanyIntegrationRunEntity
2391
+ * @method
2392
+ * @override
2393
+ */
2394
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2199
2395
  /**
2200
2396
  * * Field Name: ID
2201
2397
  * * SQL Data Type: int
@@ -2256,14 +2452,25 @@ export declare class CompanyIntegrationRunEntity extends BaseEntity {
2256
2452
  * * Schema: admin
2257
2453
  * * Base Table: CompanyIntegrationRunDetail
2258
2454
  * * Base View: vwCompanyIntegrationRunDetails
2259
- * @description Record-level details for the audit trail for each integration run
2455
+ * * @description Record-level details for the audit trail for each integration run
2260
2456
  * * Primary Key: ID
2261
- * * Description: Record-level details for the audit trail for each integration run
2262
2457
  * @extends {BaseEntity}
2263
2458
  * @class
2264
2459
  * @public
2265
2460
  */
2266
2461
  export declare class CompanyIntegrationRunDetailEntity extends BaseEntity {
2462
+ /**
2463
+ * Loads the Company Integration Run Details record from the database
2464
+ * @param ID: Number - primary key value to load the Company Integration Run Details record.
2465
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2466
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2467
+ * @public
2468
+ * @async
2469
+ * @memberof CompanyIntegrationRunDetailEntity
2470
+ * @method
2471
+ * @override
2472
+ */
2473
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2267
2474
  /**
2268
2475
  * * Field Name: ID
2269
2476
  * * SQL Data Type: int
@@ -2338,12 +2545,23 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity {
2338
2545
  * * Base Table: ErrorLog
2339
2546
  * * Base View: vwErrorLogs
2340
2547
  * * Primary Key: ID
2341
- * * Description: null
2342
2548
  * @extends {BaseEntity}
2343
2549
  * @class
2344
2550
  * @public
2345
2551
  */
2346
2552
  export declare class ErrorLogEntity extends BaseEntity {
2553
+ /**
2554
+ * Loads the Error Logs record from the database
2555
+ * @param ID: Number - primary key value to load the Error Logs record.
2556
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2557
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2558
+ * @public
2559
+ * @async
2560
+ * @memberof ErrorLogEntity
2561
+ * @method
2562
+ * @override
2563
+ */
2564
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2347
2565
  /**
2348
2566
  * * Field Name: ID
2349
2567
  * * SQL Data Type: int
@@ -2417,12 +2635,23 @@ export declare class ErrorLogEntity extends BaseEntity {
2417
2635
  * * Base Table: Application
2418
2636
  * * Base View: vwApplications
2419
2637
  * * Primary Key: ID
2420
- * * Description: null
2421
2638
  * @extends {BaseEntity}
2422
2639
  * @class
2423
2640
  * @public
2424
2641
  */
2425
2642
  export declare class ApplicationEntity extends BaseEntity {
2643
+ /**
2644
+ * Loads the Applications record from the database
2645
+ * @param ID: Number - primary key value to load the Applications record.
2646
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2647
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2648
+ * @public
2649
+ * @async
2650
+ * @memberof ApplicationEntity
2651
+ * @method
2652
+ * @override
2653
+ */
2654
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2426
2655
  /**
2427
2656
  * * Field Name: ID
2428
2657
  * * SQL Data Type: int
@@ -2461,12 +2690,23 @@ export declare class ApplicationEntity extends BaseEntity {
2461
2690
  * * Base Table: ApplicationEntity
2462
2691
  * * Base View: vwApplicationEntities
2463
2692
  * * Primary Key: ID
2464
- * * Description: null
2465
2693
  * @extends {BaseEntity}
2466
2694
  * @class
2467
2695
  * @public
2468
2696
  */
2469
2697
  export declare class ApplicationEntityEntity extends BaseEntity {
2698
+ /**
2699
+ * Loads the Application Entities record from the database
2700
+ * @param ID: Number - primary key value to load the Application Entities record.
2701
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2702
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2703
+ * @public
2704
+ * @async
2705
+ * @memberof ApplicationEntityEntity
2706
+ * @method
2707
+ * @override
2708
+ */
2709
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2470
2710
  /**
2471
2711
  * * Field Name: ID
2472
2712
  * * SQL Data Type: int
@@ -2541,13 +2781,13 @@ export declare class ApplicationEntityEntity extends BaseEntity {
2541
2781
  /**
2542
2782
  * * Field Name: EntityClassName
2543
2783
  * * Display Name: Entity Class Name
2544
- * * SQL Data Type: nvarchar(511)
2784
+ * * SQL Data Type: nvarchar(4000)
2545
2785
  */
2546
2786
  get EntityClassName(): string;
2547
2787
  /**
2548
2788
  * * Field Name: EntityBaseTableCodeName
2549
2789
  * * Display Name: Entity Base Table Code Name
2550
- * * SQL Data Type: nvarchar(511)
2790
+ * * SQL Data Type: nvarchar(4000)
2551
2791
  */
2552
2792
  get EntityBaseTableCodeName(): string;
2553
2793
  }
@@ -2557,12 +2797,23 @@ export declare class ApplicationEntityEntity extends BaseEntity {
2557
2797
  * * Base Table: EntityPermission
2558
2798
  * * Base View: vwEntityPermissions
2559
2799
  * * Primary Key: ID
2560
- * * Description: null
2561
2800
  * @extends {BaseEntity}
2562
2801
  * @class
2563
2802
  * @public
2564
2803
  */
2565
2804
  export declare class EntityPermissionEntity extends BaseEntity {
2805
+ /**
2806
+ * Loads the Entity Permissions record from the database
2807
+ * @param ID: Number - primary key value to load the Entity Permissions record.
2808
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2809
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2810
+ * @public
2811
+ * @async
2812
+ * @memberof EntityPermissionEntity
2813
+ * @method
2814
+ * @override
2815
+ */
2816
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2566
2817
  /**
2567
2818
  * * Field Name: ID
2568
2819
  * * SQL Data Type: int
@@ -2704,12 +2955,23 @@ export declare class EntityPermissionEntity extends BaseEntity {
2704
2955
  * * Base Table: UserApplicationEntity
2705
2956
  * * Base View: vwUserApplicationEntities
2706
2957
  * * Primary Key: ID
2707
- * * Description: null
2708
2958
  * @extends {BaseEntity}
2709
2959
  * @class
2710
2960
  * @public
2711
2961
  */
2712
2962
  export declare class UserApplicationEntityEntity extends BaseEntity {
2963
+ /**
2964
+ * Loads the User Application Entities record from the database
2965
+ * @param ID: Number - primary key value to load the User Application Entities record.
2966
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
2967
+ * @returns {Promise<boolean>} - true if successful, false otherwise
2968
+ * @public
2969
+ * @async
2970
+ * @memberof UserApplicationEntityEntity
2971
+ * @method
2972
+ * @override
2973
+ */
2974
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2713
2975
  /**
2714
2976
  * * Field Name: ID
2715
2977
  * * SQL Data Type: int
@@ -2763,12 +3025,23 @@ export declare class UserApplicationEntityEntity extends BaseEntity {
2763
3025
  * * Base Table: UserApplication
2764
3026
  * * Base View: vwUserApplications
2765
3027
  * * Primary Key: ID
2766
- * * Description: null
2767
3028
  * @extends {BaseEntity}
2768
3029
  * @class
2769
3030
  * @public
2770
3031
  */
2771
3032
  export declare class UserApplicationEntity extends BaseEntity {
3033
+ /**
3034
+ * Loads the User Applications record from the database
3035
+ * @param ID: Number - primary key value to load the User Applications record.
3036
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3037
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3038
+ * @public
3039
+ * @async
3040
+ * @memberof UserApplicationEntity
3041
+ * @method
3042
+ * @override
3043
+ */
3044
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2772
3045
  /**
2773
3046
  * * Field Name: ID
2774
3047
  * * SQL Data Type: int
@@ -2824,12 +3097,23 @@ export declare class UserApplicationEntity extends BaseEntity {
2824
3097
  * * Base Table: CompanyIntegrationRunAPILog
2825
3098
  * * Base View: vwCompanyIntegrationRunAPILogs
2826
3099
  * * Primary Key: ID
2827
- * * Description: null
2828
3100
  * @extends {BaseEntity}
2829
3101
  * @class
2830
3102
  * @public
2831
3103
  */
2832
3104
  export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity {
3105
+ /**
3106
+ * Loads the Company Integration Run API Logs record from the database
3107
+ * @param ID: Number - primary key value to load the Company Integration Run API Logs record.
3108
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3109
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3110
+ * @public
3111
+ * @async
3112
+ * @memberof CompanyIntegrationRunAPILogEntity
3113
+ * @method
3114
+ * @override
3115
+ */
3116
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2833
3117
  /**
2834
3118
  * * Field Name: ID
2835
3119
  * * SQL Data Type: int
@@ -2885,12 +3169,23 @@ export declare class CompanyIntegrationRunAPILogEntity extends BaseEntity {
2885
3169
  * * Base Table: List
2886
3170
  * * Base View: vwLists
2887
3171
  * * Primary Key: ID
2888
- * * Description: null
2889
3172
  * @extends {BaseEntity}
2890
3173
  * @class
2891
3174
  * @public
2892
3175
  */
2893
3176
  export declare class ListEntity extends BaseEntity {
3177
+ /**
3178
+ * Loads the Lists record from the database
3179
+ * @param ID: Number - primary key value to load the Lists record.
3180
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3181
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3182
+ * @public
3183
+ * @async
3184
+ * @memberof ListEntity
3185
+ * @method
3186
+ * @override
3187
+ */
3188
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2894
3189
  /**
2895
3190
  * * Field Name: ID
2896
3191
  * * SQL Data Type: int
@@ -2972,12 +3267,23 @@ export declare class ListEntity extends BaseEntity {
2972
3267
  * * Base Table: ListDetail
2973
3268
  * * Base View: vwListDetails
2974
3269
  * * Primary Key: ID
2975
- * * Description: null
2976
3270
  * @extends {BaseEntity}
2977
3271
  * @class
2978
3272
  * @public
2979
3273
  */
2980
3274
  export declare class ListDetailEntity extends BaseEntity {
3275
+ /**
3276
+ * Loads the List Details record from the database
3277
+ * @param ID: Number - primary key value to load the List Details record.
3278
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3279
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3280
+ * @public
3281
+ * @async
3282
+ * @memberof ListDetailEntity
3283
+ * @method
3284
+ * @override
3285
+ */
3286
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
2981
3287
  /**
2982
3288
  * * Field Name: ID
2983
3289
  * * SQL Data Type: int
@@ -3012,12 +3318,23 @@ export declare class ListDetailEntity extends BaseEntity {
3012
3318
  * * Base Table: UserViewRun
3013
3319
  * * Base View: vwUserViewRuns
3014
3320
  * * Primary Key: ID
3015
- * * Description: null
3016
3321
  * @extends {BaseEntity}
3017
3322
  * @class
3018
3323
  * @public
3019
3324
  */
3020
3325
  export declare class UserViewRunEntity extends BaseEntity {
3326
+ /**
3327
+ * Loads the User View Runs record from the database
3328
+ * @param ID: Number - primary key value to load the User View Runs record.
3329
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3330
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3331
+ * @public
3332
+ * @async
3333
+ * @memberof UserViewRunEntity
3334
+ * @method
3335
+ * @override
3336
+ */
3337
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3021
3338
  /**
3022
3339
  * * Field Name: ID
3023
3340
  * * SQL Data Type: int
@@ -3065,12 +3382,23 @@ export declare class UserViewRunEntity extends BaseEntity {
3065
3382
  * * Base Table: UserViewRunDetail
3066
3383
  * * Base View: vwUserViewRunDetails
3067
3384
  * * Primary Key: ID
3068
- * * Description: null
3069
3385
  * @extends {BaseEntity}
3070
3386
  * @class
3071
3387
  * @public
3072
3388
  */
3073
3389
  export declare class UserViewRunDetailEntity extends BaseEntity {
3390
+ /**
3391
+ * Loads the User View Run Details record from the database
3392
+ * @param ID: Number - primary key value to load the User View Run Details record.
3393
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3394
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3395
+ * @public
3396
+ * @async
3397
+ * @memberof UserViewRunDetailEntity
3398
+ * @method
3399
+ * @override
3400
+ */
3401
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3074
3402
  /**
3075
3403
  * * Field Name: ID
3076
3404
  * * SQL Data Type: int
@@ -3110,12 +3438,23 @@ export declare class UserViewRunDetailEntity extends BaseEntity {
3110
3438
  * * Base Table: WorkflowRun
3111
3439
  * * Base View: vwWorkflowRuns
3112
3440
  * * Primary Key: ID
3113
- * * Description: null
3114
3441
  * @extends {BaseEntity}
3115
3442
  * @class
3116
3443
  * @public
3117
3444
  */
3118
3445
  export declare class WorkflowRunEntity extends BaseEntity {
3446
+ /**
3447
+ * Loads the Workflow Runs record from the database
3448
+ * @param ID: Number - primary key value to load the Workflow Runs record.
3449
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3450
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3451
+ * @public
3452
+ * @async
3453
+ * @memberof WorkflowRunEntity
3454
+ * @method
3455
+ * @override
3456
+ */
3457
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3119
3458
  /**
3120
3459
  * * Field Name: ID
3121
3460
  * * SQL Data Type: int
@@ -3182,12 +3521,23 @@ export declare class WorkflowRunEntity extends BaseEntity {
3182
3521
  * * Base Table: Workflow
3183
3522
  * * Base View: vwWorkflows
3184
3523
  * * Primary Key: ID
3185
- * * Description: null
3186
3524
  * @extends {BaseEntity}
3187
3525
  * @class
3188
3526
  * @public
3189
3527
  */
3190
3528
  export declare class WorkflowEntity extends BaseEntity {
3529
+ /**
3530
+ * Loads the Workflows record from the database
3531
+ * @param ID: Number - primary key value to load the Workflows record.
3532
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3533
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3534
+ * @public
3535
+ * @async
3536
+ * @memberof WorkflowEntity
3537
+ * @method
3538
+ * @override
3539
+ */
3540
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3191
3541
  /**
3192
3542
  * * Field Name: ID
3193
3543
  * * SQL Data Type: int
@@ -3249,12 +3599,23 @@ export declare class WorkflowEntity extends BaseEntity {
3249
3599
  * * Base Table: WorkflowEngine
3250
3600
  * * Base View: vwWorkflowEngines
3251
3601
  * * Primary Key: ID
3252
- * * Description: null
3253
3602
  * @extends {BaseEntity}
3254
3603
  * @class
3255
3604
  * @public
3256
3605
  */
3257
3606
  export declare class WorkflowEngineEntity extends BaseEntity {
3607
+ /**
3608
+ * Loads the Workflow Engines record from the database
3609
+ * @param ID: Number - primary key value to load the Workflow Engines record.
3610
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3611
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3612
+ * @public
3613
+ * @async
3614
+ * @memberof WorkflowEngineEntity
3615
+ * @method
3616
+ * @override
3617
+ */
3618
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3258
3619
  /**
3259
3620
  * * Field Name: ID
3260
3621
  * * SQL Data Type: int
@@ -3306,14 +3667,25 @@ export declare class WorkflowEngineEntity extends BaseEntity {
3306
3667
  * * Schema: admin
3307
3668
  * * Base Table: RecordChange
3308
3669
  * * Base View: vwRecordChanges
3309
- * @description Tracks history of all pending and complete data changes to records
3670
+ * * @description Tracks history of all pending and complete data changes to records
3310
3671
  * * Primary Key: ID
3311
- * * Description: Tracks history of all pending and complete data changes to records
3312
3672
  * @extends {BaseEntity}
3313
3673
  * @class
3314
3674
  * @public
3315
3675
  */
3316
3676
  export declare class RecordChangeEntity extends BaseEntity {
3677
+ /**
3678
+ * Loads the Record Changes record from the database
3679
+ * @param ID: Number - primary key value to load the Record Changes record.
3680
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3681
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3682
+ * @public
3683
+ * @async
3684
+ * @memberof RecordChangeEntity
3685
+ * @method
3686
+ * @override
3687
+ */
3688
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3317
3689
  /**
3318
3690
  * * Field Name: ID
3319
3691
  * * SQL Data Type: int
@@ -3403,12 +3775,23 @@ export declare class RecordChangeEntity extends BaseEntity {
3403
3775
  * * Base Table: UserRole
3404
3776
  * * Base View: vwUserRoles
3405
3777
  * * Primary Key: ID
3406
- * * Description: null
3407
3778
  * @extends {BaseEntity}
3408
3779
  * @class
3409
3780
  * @public
3410
3781
  */
3411
3782
  export declare class UserRoleEntity extends BaseEntity {
3783
+ /**
3784
+ * Loads the User Roles record from the database
3785
+ * @param ID: Number - primary key value to load the User Roles record.
3786
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3787
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3788
+ * @public
3789
+ * @async
3790
+ * @memberof UserRoleEntity
3791
+ * @method
3792
+ * @override
3793
+ */
3794
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3412
3795
  /**
3413
3796
  * * Field Name: ID
3414
3797
  * * Display Name: ID
@@ -3458,12 +3841,23 @@ export declare class UserRoleEntity extends BaseEntity {
3458
3841
  * * Base Table: RowLevelSecurityFilter
3459
3842
  * * Base View: vwRowLevelSecurityFilters
3460
3843
  * * Primary Key: ID
3461
- * * Description: null
3462
3844
  * @extends {BaseEntity}
3463
3845
  * @class
3464
3846
  * @public
3465
3847
  */
3466
3848
  export declare class RowLevelSecurityFilterEntity extends BaseEntity {
3849
+ /**
3850
+ * Loads the Row Level Security Filters record from the database
3851
+ * @param ID: Number - primary key value to load the Row Level Security Filters record.
3852
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3853
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3854
+ * @public
3855
+ * @async
3856
+ * @memberof RowLevelSecurityFilterEntity
3857
+ * @method
3858
+ * @override
3859
+ */
3860
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3467
3861
  /**
3468
3862
  * * Field Name: ID
3469
3863
  * * Display Name: ID
@@ -3512,12 +3906,23 @@ export declare class RowLevelSecurityFilterEntity extends BaseEntity {
3512
3906
  * * Base Table: AuditLog
3513
3907
  * * Base View: vwAuditLogs
3514
3908
  * * Primary Key: ID
3515
- * * Description: null
3516
3909
  * @extends {BaseEntity}
3517
3910
  * @class
3518
3911
  * @public
3519
3912
  */
3520
3913
  export declare class AuditLogEntity extends BaseEntity {
3914
+ /**
3915
+ * Loads the Audit Logs record from the database
3916
+ * @param ID: Number - primary key value to load the Audit Logs record.
3917
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
3918
+ * @returns {Promise<boolean>} - true if successful, false otherwise
3919
+ * @public
3920
+ * @async
3921
+ * @memberof AuditLogEntity
3922
+ * @method
3923
+ * @override
3924
+ */
3925
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3521
3926
  /**
3522
3927
  * * Field Name: ID
3523
3928
  * * Display Name: ID
@@ -3618,12 +4023,23 @@ export declare class AuditLogEntity extends BaseEntity {
3618
4023
  * * Base Table: Authorization
3619
4024
  * * Base View: vwAuthorizations
3620
4025
  * * Primary Key: ID
3621
- * * Description: null
3622
4026
  * @extends {BaseEntity}
3623
4027
  * @class
3624
4028
  * @public
3625
4029
  */
3626
4030
  export declare class AuthorizationEntity extends BaseEntity {
4031
+ /**
4032
+ * Loads the Authorizations record from the database
4033
+ * @param ID: Number - primary key value to load the Authorizations record.
4034
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4035
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4036
+ * @public
4037
+ * @async
4038
+ * @memberof AuthorizationEntity
4039
+ * @method
4040
+ * @override
4041
+ */
4042
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3627
4043
  /**
3628
4044
  * * Field Name: ID
3629
4045
  * * Display Name: ID
@@ -3689,12 +4105,23 @@ export declare class AuthorizationEntity extends BaseEntity {
3689
4105
  * * Base Table: AuthorizationRole
3690
4106
  * * Base View: vwAuthorizationRoles
3691
4107
  * * Primary Key: ID
3692
- * * Description: null
3693
4108
  * @extends {BaseEntity}
3694
4109
  * @class
3695
4110
  * @public
3696
4111
  */
3697
4112
  export declare class AuthorizationRoleEntity extends BaseEntity {
4113
+ /**
4114
+ * Loads the Authorization Roles record from the database
4115
+ * @param ID: Number - primary key value to load the Authorization Roles record.
4116
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4117
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4118
+ * @public
4119
+ * @async
4120
+ * @memberof AuthorizationRoleEntity
4121
+ * @method
4122
+ * @override
4123
+ */
4124
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3698
4125
  /**
3699
4126
  * * Field Name: ID
3700
4127
  * * Display Name: ID
@@ -3760,12 +4187,23 @@ export declare class AuthorizationRoleEntity extends BaseEntity {
3760
4187
  * * Base Table: AuditLogType
3761
4188
  * * Base View: vwAuditLogTypes
3762
4189
  * * Primary Key: ID
3763
- * * Description: null
3764
4190
  * @extends {BaseEntity}
3765
4191
  * @class
3766
4192
  * @public
3767
4193
  */
3768
4194
  export declare class AuditLogTypeEntity extends BaseEntity {
4195
+ /**
4196
+ * Loads the Audit Log Types record from the database
4197
+ * @param ID: Number - primary key value to load the Audit Log Types record.
4198
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4199
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4200
+ * @public
4201
+ * @async
4202
+ * @memberof AuditLogTypeEntity
4203
+ * @method
4204
+ * @override
4205
+ */
4206
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3769
4207
  /**
3770
4208
  * * Field Name: ID
3771
4209
  * * Display Name: ID
@@ -3829,12 +4267,23 @@ export declare class AuditLogTypeEntity extends BaseEntity {
3829
4267
  * * Base Table: EntityFieldValue
3830
4268
  * * Base View: vwEntityFieldValues
3831
4269
  * * Primary Key: ID
3832
- * * Description: null
3833
4270
  * @extends {BaseEntity}
3834
4271
  * @class
3835
4272
  * @public
3836
4273
  */
3837
4274
  export declare class EntityFieldValueEntity extends BaseEntity {
4275
+ /**
4276
+ * Loads the Entity Field Values record from the database
4277
+ * @param ID: Number - primary key value to load the Entity Field Values record.
4278
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4279
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4280
+ * @public
4281
+ * @async
4282
+ * @memberof EntityFieldValueEntity
4283
+ * @method
4284
+ * @override
4285
+ */
4286
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3838
4287
  /**
3839
4288
  * * Field Name: ID
3840
4289
  * * Display Name: ID
@@ -3912,12 +4361,23 @@ export declare class EntityFieldValueEntity extends BaseEntity {
3912
4361
  * * Base Table: AIModel
3913
4362
  * * Base View: vwAIModels
3914
4363
  * * Primary Key: ID
3915
- * * Description: null
3916
4364
  * @extends {BaseEntity}
3917
4365
  * @class
3918
4366
  * @public
3919
4367
  */
3920
4368
  export declare class AIModelEntity extends BaseEntity {
4369
+ /**
4370
+ * Loads the AI Models record from the database
4371
+ * @param ID: Number - primary key value to load the AI Models record.
4372
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4373
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4374
+ * @public
4375
+ * @async
4376
+ * @memberof AIModelEntity
4377
+ * @method
4378
+ * @override
4379
+ */
4380
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
3921
4381
  /**
3922
4382
  * * Field Name: ID
3923
4383
  * * Display Name: ID
@@ -3996,12 +4456,23 @@ export declare class AIModelEntity extends BaseEntity {
3996
4456
  * * Base Table: AIAction
3997
4457
  * * Base View: vwAIActions
3998
4458
  * * Primary Key: ID
3999
- * * Description: null
4000
4459
  * @extends {BaseEntity}
4001
4460
  * @class
4002
4461
  * @public
4003
4462
  */
4004
4463
  export declare class AIActionEntity extends BaseEntity {
4464
+ /**
4465
+ * Loads the AI Actions record from the database
4466
+ * @param ID: Number - primary key value to load the AI Actions record.
4467
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4468
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4469
+ * @public
4470
+ * @async
4471
+ * @memberof AIActionEntity
4472
+ * @method
4473
+ * @override
4474
+ */
4475
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4005
4476
  /**
4006
4477
  * * Field Name: ID
4007
4478
  * * Display Name: ID
@@ -4072,12 +4543,23 @@ export declare class AIActionEntity extends BaseEntity {
4072
4543
  * * Base Table: AIModelAction
4073
4544
  * * Base View: vwAIModelActions
4074
4545
  * * Primary Key: ID
4075
- * * Description: null
4076
4546
  * @extends {BaseEntity}
4077
4547
  * @class
4078
4548
  * @public
4079
4549
  */
4080
4550
  export declare class AIModelActionEntity extends BaseEntity {
4551
+ /**
4552
+ * Loads the AI Model Actions record from the database
4553
+ * @param ID: Number - primary key value to load the AI Model Actions record.
4554
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4555
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4556
+ * @public
4557
+ * @async
4558
+ * @memberof AIModelActionEntity
4559
+ * @method
4560
+ * @override
4561
+ */
4562
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4081
4563
  /**
4082
4564
  * * Field Name: ID
4083
4565
  * * Display Name: ID
@@ -4141,12 +4623,23 @@ export declare class AIModelActionEntity extends BaseEntity {
4141
4623
  * * Base Table: EntityAIAction
4142
4624
  * * Base View: vwEntityAIActions
4143
4625
  * * Primary Key: ID
4144
- * * Description: null
4145
4626
  * @extends {BaseEntity}
4146
4627
  * @class
4147
4628
  * @public
4148
4629
  */
4149
4630
  export declare class EntityAIActionEntity extends BaseEntity {
4631
+ /**
4632
+ * Loads the Entity AI Actions record from the database
4633
+ * @param ID: Number - primary key value to load the Entity AI Actions record.
4634
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4635
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4636
+ * @public
4637
+ * @async
4638
+ * @memberof EntityAIActionEntity
4639
+ * @method
4640
+ * @override
4641
+ */
4642
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4150
4643
  /**
4151
4644
  * * Field Name: ID
4152
4645
  * * Display Name: ID
@@ -4275,12 +4768,23 @@ export declare class EntityAIActionEntity extends BaseEntity {
4275
4768
  * * Base Table: AIModelType
4276
4769
  * * Base View: vwAIModelTypes
4277
4770
  * * Primary Key: ID
4278
- * * Description: null
4279
4771
  * @extends {BaseEntity}
4280
4772
  * @class
4281
4773
  * @public
4282
4774
  */
4283
4775
  export declare class AIModelTypeEntity extends BaseEntity {
4776
+ /**
4777
+ * Loads the AI Model Types record from the database
4778
+ * @param ID: Number - primary key value to load the AI Model Types record.
4779
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4780
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4781
+ * @public
4782
+ * @async
4783
+ * @memberof AIModelTypeEntity
4784
+ * @method
4785
+ * @override
4786
+ */
4787
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4284
4788
  /**
4285
4789
  * * Field Name: ID
4286
4790
  * * Display Name: ID
@@ -4308,12 +4812,23 @@ export declare class AIModelTypeEntity extends BaseEntity {
4308
4812
  * * Base Table: QueueType
4309
4813
  * * Base View: vwQueueTypes
4310
4814
  * * Primary Key: ID
4311
- * * Description: null
4312
4815
  * @extends {BaseEntity}
4313
4816
  * @class
4314
4817
  * @public
4315
4818
  */
4316
4819
  export declare class QueueTypeEntity extends BaseEntity {
4820
+ /**
4821
+ * Loads the Queue Types record from the database
4822
+ * @param ID: Number - primary key value to load the Queue Types record.
4823
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4824
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4825
+ * @public
4826
+ * @async
4827
+ * @memberof QueueTypeEntity
4828
+ * @method
4829
+ * @override
4830
+ */
4831
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4317
4832
  /**
4318
4833
  * * Field Name: ID
4319
4834
  * * Display Name: ID
@@ -4363,12 +4878,23 @@ export declare class QueueTypeEntity extends BaseEntity {
4363
4878
  * * Base Table: Queue
4364
4879
  * * Base View: vwQueues
4365
4880
  * * Primary Key: ID
4366
- * * Description: null
4367
4881
  * @extends {BaseEntity}
4368
4882
  * @class
4369
4883
  * @public
4370
4884
  */
4371
4885
  export declare class QueueEntity extends BaseEntity {
4886
+ /**
4887
+ * Loads the Queues record from the database
4888
+ * @param ID: Number - primary key value to load the Queues record.
4889
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
4890
+ * @returns {Promise<boolean>} - true if successful, false otherwise
4891
+ * @public
4892
+ * @async
4893
+ * @memberof QueueEntity
4894
+ * @method
4895
+ * @override
4896
+ */
4897
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4372
4898
  /**
4373
4899
  * * Field Name: ID
4374
4900
  * * Display Name: ID
@@ -4517,12 +5043,23 @@ export declare class QueueEntity extends BaseEntity {
4517
5043
  * * Base Table: QueueTask
4518
5044
  * * Base View: vwQueueTasks
4519
5045
  * * Primary Key: ID
4520
- * * Description: null
4521
5046
  * @extends {BaseEntity}
4522
5047
  * @class
4523
5048
  * @public
4524
5049
  */
4525
5050
  export declare class QueueTaskEntity extends BaseEntity {
5051
+ /**
5052
+ * Loads the Queue Tasks record from the database
5053
+ * @param ID: Number - primary key value to load the Queue Tasks record.
5054
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5055
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5056
+ * @public
5057
+ * @async
5058
+ * @memberof QueueTaskEntity
5059
+ * @method
5060
+ * @override
5061
+ */
5062
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4526
5063
  /**
4527
5064
  * * Field Name: ID
4528
5065
  * * Display Name: ID
@@ -4601,12 +5138,23 @@ export declare class QueueTaskEntity extends BaseEntity {
4601
5138
  * * Base Table: Dashboard
4602
5139
  * * Base View: vwDashboards
4603
5140
  * * Primary Key: ID
4604
- * * Description: null
4605
5141
  * @extends {BaseEntity}
4606
5142
  * @class
4607
5143
  * @public
4608
5144
  */
4609
5145
  export declare class DashboardEntity extends BaseEntity {
5146
+ /**
5147
+ * Loads the Dashboards record from the database
5148
+ * @param ID: Number - primary key value to load the Dashboards record.
5149
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5150
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5151
+ * @public
5152
+ * @async
5153
+ * @memberof DashboardEntity
5154
+ * @method
5155
+ * @override
5156
+ */
5157
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4610
5158
  /**
4611
5159
  * * Field Name: ID
4612
5160
  * * Display Name: ID
@@ -4655,12 +5203,23 @@ export declare class DashboardEntity extends BaseEntity {
4655
5203
  * * Base Table: OutputTriggerType
4656
5204
  * * Base View: vwOutputTriggerTypes
4657
5205
  * * Primary Key: ID
4658
- * * Description: null
4659
5206
  * @extends {BaseEntity}
4660
5207
  * @class
4661
5208
  * @public
4662
5209
  */
4663
5210
  export declare class OutputTriggerTypeEntity extends BaseEntity {
5211
+ /**
5212
+ * Loads the Output Trigger Types record from the database
5213
+ * @param ID: Number - primary key value to load the Output Trigger Types record.
5214
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5215
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5216
+ * @public
5217
+ * @async
5218
+ * @memberof OutputTriggerTypeEntity
5219
+ * @method
5220
+ * @override
5221
+ */
5222
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4664
5223
  /**
4665
5224
  * * Field Name: ID
4666
5225
  * * Display Name: ID
@@ -4688,12 +5247,23 @@ export declare class OutputTriggerTypeEntity extends BaseEntity {
4688
5247
  * * Base Table: OutputFormatType
4689
5248
  * * Base View: vwOutputFormatTypes
4690
5249
  * * Primary Key: ID
4691
- * * Description: null
4692
5250
  * @extends {BaseEntity}
4693
5251
  * @class
4694
5252
  * @public
4695
5253
  */
4696
5254
  export declare class OutputFormatTypeEntity extends BaseEntity {
5255
+ /**
5256
+ * Loads the Output Format Types record from the database
5257
+ * @param ID: Number - primary key value to load the Output Format Types record.
5258
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5259
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5260
+ * @public
5261
+ * @async
5262
+ * @memberof OutputFormatTypeEntity
5263
+ * @method
5264
+ * @override
5265
+ */
5266
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4697
5267
  /**
4698
5268
  * * Field Name: ID
4699
5269
  * * Display Name: ID
@@ -4728,12 +5298,23 @@ export declare class OutputFormatTypeEntity extends BaseEntity {
4728
5298
  * * Base Table: OutputDeliveryType
4729
5299
  * * Base View: vwOutputDeliveryTypes
4730
5300
  * * Primary Key: ID
4731
- * * Description: null
4732
5301
  * @extends {BaseEntity}
4733
5302
  * @class
4734
5303
  * @public
4735
5304
  */
4736
5305
  export declare class OutputDeliveryTypeEntity extends BaseEntity {
5306
+ /**
5307
+ * Loads the Output Delivery Types record from the database
5308
+ * @param ID: Number - primary key value to load the Output Delivery Types record.
5309
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5310
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5311
+ * @public
5312
+ * @async
5313
+ * @memberof OutputDeliveryTypeEntity
5314
+ * @method
5315
+ * @override
5316
+ */
5317
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4737
5318
  /**
4738
5319
  * * Field Name: ID
4739
5320
  * * Display Name: ID
@@ -4761,12 +5342,23 @@ export declare class OutputDeliveryTypeEntity extends BaseEntity {
4761
5342
  * * Base Table: Report
4762
5343
  * * Base View: vwReports
4763
5344
  * * Primary Key: ID
4764
- * * Description: null
4765
5345
  * @extends {BaseEntity}
4766
5346
  * @class
4767
5347
  * @public
4768
5348
  */
4769
5349
  export declare class ReportEntity extends BaseEntity {
5350
+ /**
5351
+ * Loads the Reports record from the database
5352
+ * @param ID: Number - primary key value to load the Reports record.
5353
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5354
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5355
+ * @public
5356
+ * @async
5357
+ * @memberof ReportEntity
5358
+ * @method
5359
+ * @override
5360
+ */
5361
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4770
5362
  /**
4771
5363
  * * Field Name: ID
4772
5364
  * * Display Name: ID
@@ -4944,12 +5536,23 @@ export declare class ReportEntity extends BaseEntity {
4944
5536
  * * Base Table: ReportSnapshot
4945
5537
  * * Base View: vwReportSnapshots
4946
5538
  * * Primary Key: ID
4947
- * * Description: null
4948
5539
  * @extends {BaseEntity}
4949
5540
  * @class
4950
5541
  * @public
4951
5542
  */
4952
5543
  export declare class ReportSnapshotEntity extends BaseEntity {
5544
+ /**
5545
+ * Loads the Report Snapshots record from the database
5546
+ * @param ID: Number - primary key value to load the Report Snapshots record.
5547
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5548
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5549
+ * @public
5550
+ * @async
5551
+ * @memberof ReportSnapshotEntity
5552
+ * @method
5553
+ * @override
5554
+ */
5555
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
4953
5556
  /**
4954
5557
  * * Field Name: ID
4955
5558
  * * Display Name: ID
@@ -5005,12 +5608,23 @@ export declare class ReportSnapshotEntity extends BaseEntity {
5005
5608
  * * Base Table: ResourceType
5006
5609
  * * Base View: vwResourceTypes
5007
5610
  * * Primary Key: ID
5008
- * * Description: null
5009
5611
  * @extends {BaseEntity}
5010
5612
  * @class
5011
5613
  * @public
5012
5614
  */
5013
5615
  export declare class ResourceTypeEntity extends BaseEntity {
5616
+ /**
5617
+ * Loads the Resource Types record from the database
5618
+ * @param ID: Number - primary key value to load the Resource Types record.
5619
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5620
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5621
+ * @public
5622
+ * @async
5623
+ * @memberof ResourceTypeEntity
5624
+ * @method
5625
+ * @override
5626
+ */
5627
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5014
5628
  /**
5015
5629
  * * Field Name: ID
5016
5630
  * * Display Name: ID
@@ -5080,12 +5694,23 @@ export declare class ResourceTypeEntity extends BaseEntity {
5080
5694
  * * Base Table: Tag
5081
5695
  * * Base View: vwTags
5082
5696
  * * Primary Key: ID
5083
- * * Description: null
5084
5697
  * @extends {BaseEntity}
5085
5698
  * @class
5086
5699
  * @public
5087
5700
  */
5088
5701
  export declare class TagEntity extends BaseEntity {
5702
+ /**
5703
+ * Loads the Tags record from the database
5704
+ * @param ID: Number - primary key value to load the Tags record.
5705
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5706
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5707
+ * @public
5708
+ * @async
5709
+ * @memberof TagEntity
5710
+ * @method
5711
+ * @override
5712
+ */
5713
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5089
5714
  /**
5090
5715
  * * Field Name: ID
5091
5716
  * * Display Name: ID
@@ -5134,12 +5759,23 @@ export declare class TagEntity extends BaseEntity {
5134
5759
  * * Base Table: TaggedItem
5135
5760
  * * Base View: vwTaggedItems
5136
5761
  * * Primary Key: ID
5137
- * * Description: null
5138
5762
  * @extends {BaseEntity}
5139
5763
  * @class
5140
5764
  * @public
5141
5765
  */
5142
5766
  export declare class TaggedItemEntity extends BaseEntity {
5767
+ /**
5768
+ * Loads the Tagged Items record from the database
5769
+ * @param ID: Number - primary key value to load the Tagged Items record.
5770
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5771
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5772
+ * @public
5773
+ * @async
5774
+ * @memberof TaggedItemEntity
5775
+ * @method
5776
+ * @override
5777
+ */
5778
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5143
5779
  /**
5144
5780
  * * Field Name: ID
5145
5781
  * * Display Name: ID
@@ -5188,12 +5824,23 @@ export declare class TaggedItemEntity extends BaseEntity {
5188
5824
  * * Base Table: Workspace
5189
5825
  * * Base View: vwWorkspaces
5190
5826
  * * Primary Key: ID
5191
- * * Description: null
5192
5827
  * @extends {BaseEntity}
5193
5828
  * @class
5194
5829
  * @public
5195
5830
  */
5196
5831
  export declare class WorkspaceEntity extends BaseEntity {
5832
+ /**
5833
+ * Loads the Workspaces record from the database
5834
+ * @param ID: Number - primary key value to load the Workspaces record.
5835
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5836
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5837
+ * @public
5838
+ * @async
5839
+ * @memberof WorkspaceEntity
5840
+ * @method
5841
+ * @override
5842
+ */
5843
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5197
5844
  /**
5198
5845
  * * Field Name: ID
5199
5846
  * * Display Name: ID
@@ -5235,12 +5882,23 @@ export declare class WorkspaceEntity extends BaseEntity {
5235
5882
  * * Base Table: WorkspaceItem
5236
5883
  * * Base View: vwWorkspaceItems
5237
5884
  * * Primary Key: ID
5238
- * * Description: null
5239
5885
  * @extends {BaseEntity}
5240
5886
  * @class
5241
5887
  * @public
5242
5888
  */
5243
5889
  export declare class WorkspaceItemEntity extends BaseEntity {
5890
+ /**
5891
+ * Loads the Workspace Items record from the database
5892
+ * @param ID: Number - primary key value to load the Workspace Items record.
5893
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5894
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5895
+ * @public
5896
+ * @async
5897
+ * @memberof WorkspaceItemEntity
5898
+ * @method
5899
+ * @override
5900
+ */
5901
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5244
5902
  /**
5245
5903
  * * Field Name: ID
5246
5904
  * * Display Name: ID
@@ -5317,12 +5975,23 @@ export declare class WorkspaceItemEntity extends BaseEntity {
5317
5975
  * * Base Table: Dataset
5318
5976
  * * Base View: vwDatasets
5319
5977
  * * Primary Key: ID
5320
- * * Description: null
5321
5978
  * @extends {BaseEntity}
5322
5979
  * @class
5323
5980
  * @public
5324
5981
  */
5325
5982
  export declare class DatasetEntity extends BaseEntity {
5983
+ /**
5984
+ * Loads the Datasets record from the database
5985
+ * @param ID: Number - primary key value to load the Datasets record.
5986
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
5987
+ * @returns {Promise<boolean>} - true if successful, false otherwise
5988
+ * @public
5989
+ * @async
5990
+ * @memberof DatasetEntity
5991
+ * @method
5992
+ * @override
5993
+ */
5994
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5326
5995
  /**
5327
5996
  * * Field Name: ID
5328
5997
  * * Display Name: ID
@@ -5364,12 +6033,23 @@ export declare class DatasetEntity extends BaseEntity {
5364
6033
  * * Base Table: DatasetItem
5365
6034
  * * Base View: vwDatasetItems
5366
6035
  * * Primary Key: ID
5367
- * * Description: null
5368
6036
  * @extends {BaseEntity}
5369
6037
  * @class
5370
6038
  * @public
5371
6039
  */
5372
6040
  export declare class DatasetItemEntity extends BaseEntity {
6041
+ /**
6042
+ * Loads the Dataset Items record from the database
6043
+ * @param ID: Number - primary key value to load the Dataset Items record.
6044
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6045
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6046
+ * @public
6047
+ * @async
6048
+ * @memberof DatasetItemEntity
6049
+ * @method
6050
+ * @override
6051
+ */
6052
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5373
6053
  /**
5374
6054
  * * Field Name: ID
5375
6055
  * * Display Name: ID
@@ -5455,12 +6135,23 @@ export declare class DatasetItemEntity extends BaseEntity {
5455
6135
  * * Base Table: ConversationDetail
5456
6136
  * * Base View: vwConversationDetails
5457
6137
  * * Primary Key: ID
5458
- * * Description: null
5459
6138
  * @extends {BaseEntity}
5460
6139
  * @class
5461
6140
  * @public
5462
6141
  */
5463
6142
  export declare class ConversationDetailEntity extends BaseEntity {
6143
+ /**
6144
+ * Loads the Conversation Details record from the database
6145
+ * @param ID: Number - primary key value to load the Conversation Details record.
6146
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6147
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6148
+ * @public
6149
+ * @async
6150
+ * @memberof ConversationDetailEntity
6151
+ * @method
6152
+ * @override
6153
+ */
6154
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5464
6155
  /**
5465
6156
  * * Field Name: ID
5466
6157
  * * Display Name: ID
@@ -5531,12 +6222,23 @@ export declare class ConversationDetailEntity extends BaseEntity {
5531
6222
  * * Base Table: Conversation
5532
6223
  * * Base View: vwConversations
5533
6224
  * * Primary Key: ID
5534
- * * Description: null
5535
6225
  * @extends {BaseEntity}
5536
6226
  * @class
5537
6227
  * @public
5538
6228
  */
5539
6229
  export declare class ConversationEntity extends BaseEntity {
6230
+ /**
6231
+ * Loads the Conversations record from the database
6232
+ * @param ID: Number - primary key value to load the Conversations record.
6233
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6234
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6235
+ * @public
6236
+ * @async
6237
+ * @memberof ConversationEntity
6238
+ * @method
6239
+ * @override
6240
+ */
6241
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5540
6242
  /**
5541
6243
  * * Field Name: ID
5542
6244
  * * Display Name: ID
@@ -5592,12 +6294,23 @@ export declare class ConversationEntity extends BaseEntity {
5592
6294
  * * Base Table: UserNotification
5593
6295
  * * Base View: vwUserNotifications
5594
6296
  * * Primary Key: ID
5595
- * * Description: null
5596
6297
  * @extends {BaseEntity}
5597
6298
  * @class
5598
6299
  * @public
5599
6300
  */
5600
6301
  export declare class UserNotificationEntity extends BaseEntity {
6302
+ /**
6303
+ * Loads the User Notifications record from the database
6304
+ * @param ID: Number - primary key value to load the User Notifications record.
6305
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6306
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6307
+ * @public
6308
+ * @async
6309
+ * @memberof UserNotificationEntity
6310
+ * @method
6311
+ * @override
6312
+ */
6313
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5601
6314
  /**
5602
6315
  * * Field Name: ID
5603
6316
  * * Display Name: ID
@@ -5689,12 +6402,23 @@ export declare class UserNotificationEntity extends BaseEntity {
5689
6402
  * * Base Table: ResourceFolder
5690
6403
  * * Base View: vwResourceFolders
5691
6404
  * * Primary Key: ID
5692
- * * Description: null
5693
6405
  * @extends {BaseEntity}
5694
6406
  * @class
5695
6407
  * @public
5696
6408
  */
5697
6409
  export declare class ResourceFolderEntity extends BaseEntity {
6410
+ /**
6411
+ * Loads the Resource Folders record from the database
6412
+ * @param ID: Number - primary key value to load the Resource Folders record.
6413
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6414
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6415
+ * @public
6416
+ * @async
6417
+ * @memberof ResourceFolderEntity
6418
+ * @method
6419
+ * @override
6420
+ */
6421
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5698
6422
  /**
5699
6423
  * * Field Name: ID
5700
6424
  * * Display Name: ID
@@ -5772,12 +6496,23 @@ export declare class ResourceFolderEntity extends BaseEntity {
5772
6496
  * * Base Table: SchemaInfo
5773
6497
  * * Base View: vwSchemaInfos
5774
6498
  * * Primary Key: ID
5775
- * * Description: null
5776
6499
  * @extends {BaseEntity}
5777
6500
  * @class
5778
6501
  * @public
5779
6502
  */
5780
6503
  export declare class SchemaInfoEntity extends BaseEntity {
6504
+ /**
6505
+ * Loads the Schema Info record from the database
6506
+ * @param ID: Number - primary key value to load the Schema Info record.
6507
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6508
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6509
+ * @public
6510
+ * @async
6511
+ * @memberof SchemaInfoEntity
6512
+ * @method
6513
+ * @override
6514
+ */
6515
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5781
6516
  /**
5782
6517
  * * Field Name: ID
5783
6518
  * * Display Name: ID
@@ -5833,12 +6568,23 @@ export declare class SchemaInfoEntity extends BaseEntity {
5833
6568
  * * Base Table: CompanyIntegrationRecordMap
5834
6569
  * * Base View: vwCompanyIntegrationRecordMaps
5835
6570
  * * Primary Key: ID
5836
- * * Description: null
5837
6571
  * @extends {BaseEntity}
5838
6572
  * @class
5839
6573
  * @public
5840
6574
  */
5841
6575
  export declare class CompanyIntegrationRecordMapEntity extends BaseEntity {
6576
+ /**
6577
+ * Loads the Company Integration Record Maps record from the database
6578
+ * @param ID: Number - primary key value to load the Company Integration Record Maps record.
6579
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6580
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6581
+ * @public
6582
+ * @async
6583
+ * @memberof CompanyIntegrationRecordMapEntity
6584
+ * @method
6585
+ * @override
6586
+ */
6587
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5842
6588
  /**
5843
6589
  * * Field Name: ID
5844
6590
  * * Display Name: ID
@@ -5902,12 +6648,23 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity {
5902
6648
  * * Base Table: RecordMergeLog
5903
6649
  * * Base View: vwRecordMergeLogs
5904
6650
  * * Primary Key: ID
5905
- * * Description: null
5906
6651
  * @extends {BaseEntity}
5907
6652
  * @class
5908
6653
  * @public
5909
6654
  */
5910
6655
  export declare class RecordMergeLogEntity extends BaseEntity {
6656
+ /**
6657
+ * Loads the Record Merge Logs record from the database
6658
+ * @param ID: Number - primary key value to load the Record Merge Logs record.
6659
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6660
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6661
+ * @public
6662
+ * @async
6663
+ * @memberof RecordMergeLogEntity
6664
+ * @method
6665
+ * @override
6666
+ */
6667
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
5911
6668
  /**
5912
6669
  * * Field Name: ID
5913
6670
  * * Display Name: ID
@@ -6022,12 +6779,23 @@ export declare class RecordMergeLogEntity extends BaseEntity {
6022
6779
  * * Base Table: RecordMergeDeletionLog
6023
6780
  * * Base View: vwRecordMergeDeletionLogs
6024
6781
  * * Primary Key: ID
6025
- * * Description: null
6026
6782
  * @extends {BaseEntity}
6027
6783
  * @class
6028
6784
  * @public
6029
6785
  */
6030
6786
  export declare class RecordMergeDeletionLogEntity extends BaseEntity {
6787
+ /**
6788
+ * Loads the Record Merge Deletion Logs record from the database
6789
+ * @param ID: Number - primary key value to load the Record Merge Deletion Logs record.
6790
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
6791
+ * @returns {Promise<boolean>} - true if successful, false otherwise
6792
+ * @public
6793
+ * @async
6794
+ * @memberof RecordMergeDeletionLogEntity
6795
+ * @method
6796
+ * @override
6797
+ */
6798
+ Load(ID: Number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
6031
6799
  /**
6032
6800
  * * Field Name: ID
6033
6801
  * * Display Name: ID