@memberjunction/core-entities 0.9.122 → 0.9.123

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.
@@ -1094,7 +1094,6 @@ export declare class EntityFieldEntity extends BaseEntity {
1094
1094
  * * Field Name: EntityID
1095
1095
  * * Display Name: Entity ID
1096
1096
  * * SQL Data Type: int
1097
- * * Related Entity: Entities
1098
1097
  */
1099
1098
  get EntityID(): number;
1100
1099
  /**
@@ -1122,6 +1121,15 @@ export declare class EntityFieldEntity extends BaseEntity {
1122
1121
  get Description(): string;
1123
1122
  set Description(value: string);
1124
1123
  /**
1124
+ * * Field Name: AutoUpdateDescription
1125
+ * * Display Name: Auto Update Description
1126
+ * * SQL Data Type: bit
1127
+ * * Default Value: 1
1128
+ * * Description: When set to 1 (default), whenever a description is modified in the column within the underlying view (first choice) or table (second choice), the Description column in the entity field definition will be automatically updated. If you never set metadata in the database directly, you can leave this alone. However, if you have metadata set in the database level for description, and you want to provide a DIFFERENT description in this entity field definition, turn this bit off and then set the Description field and future CodeGen runs will NOT override the Description field here.
1129
+ */
1130
+ get AutoUpdateDescription(): boolean;
1131
+ set AutoUpdateDescription(value: boolean);
1132
+ /**
1125
1133
  * * Field Name: IsPrimaryKey
1126
1134
  * * Display Name: Is Primary Key
1127
1135
  * * SQL Data Type: bit
@@ -1295,7 +1303,6 @@ export declare class EntityFieldEntity extends BaseEntity {
1295
1303
  * * Field Name: RelatedEntityID
1296
1304
  * * Display Name: RelatedEntity ID
1297
1305
  * * SQL Data Type: int
1298
- * * Related Entity: Entities
1299
1306
  */
1300
1307
  get RelatedEntityID(): number;
1301
1308
  set RelatedEntityID(value: number);
@@ -1465,6 +1472,15 @@ export declare class EntityEntity extends BaseEntity {
1465
1472
  get Description(): string;
1466
1473
  set Description(value: string);
1467
1474
  /**
1475
+ * * Field Name: AutoUpdateDescription
1476
+ * * Display Name: Auto Update Description
1477
+ * * SQL Data Type: bit
1478
+ * * Default Value: 1
1479
+ * * Description: When set to 1 (default), whenever a description is modified in the underlying view (first choice) or table (second choice), the Description column in the entity definition will be automatically updated. If you never set metadata in the database directly, you can leave this alone. However, if you have metadata set in the database level for description, and you want to provide a DIFFERENT description in this entity definition, turn this bit off and then set the Description field and future CodeGen runs will NOT override the Description field here.
1480
+ */
1481
+ get AutoUpdateDescription(): boolean;
1482
+ set AutoUpdateDescription(value: boolean);
1483
+ /**
1468
1484
  * * Field Name: BaseTable
1469
1485
  * * Display Name: Base Table
1470
1486
  * * SQL Data Type: nvarchar(255)
@@ -2304,7 +2320,6 @@ export declare class UserViewEntity extends BaseEntity {
2304
2320
  * * Field Name: EntityID
2305
2321
  * * Display Name: Entity ID
2306
2322
  * * SQL Data Type: int
2307
- * * Related Entity: Entities
2308
2323
  */
2309
2324
  get EntityID(): number;
2310
2325
  set EntityID(value: number);
@@ -2605,7 +2620,6 @@ export declare class CompanyIntegrationRunDetailEntity extends BaseEntity {
2605
2620
  * * Field Name: EntityID
2606
2621
  * * Display Name: Entity ID
2607
2622
  * * SQL Data Type: int
2608
- * * Related Entity: Entities
2609
2623
  */
2610
2624
  get EntityID(): number;
2611
2625
  set EntityID(value: number);
@@ -2859,7 +2873,6 @@ export declare class ApplicationEntityEntity extends BaseEntity {
2859
2873
  * * Field Name: EntityID
2860
2874
  * * Display Name: Entity ID
2861
2875
  * * SQL Data Type: int
2862
- * * Related Entity: Entities
2863
2876
  */
2864
2877
  get EntityID(): number;
2865
2878
  set EntityID(value: number);
@@ -2958,7 +2971,6 @@ export declare class EntityPermissionEntity extends BaseEntity {
2958
2971
  * * Field Name: EntityID
2959
2972
  * * Display Name: Entity ID
2960
2973
  * * SQL Data Type: int
2961
- * * Related Entity: Entities
2962
2974
  */
2963
2975
  get EntityID(): number;
2964
2976
  set EntityID(value: number);
@@ -3124,7 +3136,6 @@ export declare class UserApplicationEntityEntity extends BaseEntity {
3124
3136
  * * Field Name: EntityID
3125
3137
  * * Display Name: Entity ID
3126
3138
  * * SQL Data Type: int
3127
- * * Related Entity: Entities
3128
3139
  */
3129
3140
  get EntityID(): number;
3130
3141
  set EntityID(value: number);
@@ -3360,7 +3371,6 @@ export declare class ListEntity extends BaseEntity {
3360
3371
  * * Field Name: EntityID
3361
3372
  * * Display Name: Entity ID
3362
3373
  * * SQL Data Type: int
3363
- * * Related Entity: Entities
3364
3374
  */
3365
3375
  get EntityID(): number;
3366
3376
  set EntityID(value: number);
@@ -3402,12 +3412,6 @@ export declare class ListEntity extends BaseEntity {
3402
3412
  */
3403
3413
  get UpdatedAt(): Date;
3404
3414
  /**
3405
- * * Field Name: Entity
3406
- * * Display Name: Entity
3407
- * * SQL Data Type: nvarchar(255)
3408
- */
3409
- get Entity(): string;
3410
- /**
3411
3415
  * * Field Name: User
3412
3416
  * * Display Name: User
3413
3417
  * * SQL Data Type: nvarchar(100)
@@ -4222,7 +4226,6 @@ export declare class AuditLogEntity extends BaseEntity {
4222
4226
  * * Field Name: EntityID
4223
4227
  * * Display Name: Entity ID
4224
4228
  * * SQL Data Type: int
4225
- * * Related Entity: Entities
4226
4229
  */
4227
4230
  get EntityID(): number;
4228
4231
  set EntityID(value: number);
@@ -4253,12 +4256,6 @@ export declare class AuditLogEntity extends BaseEntity {
4253
4256
  * * SQL Data Type: nvarchar(100)
4254
4257
  */
4255
4258
  get User(): string;
4256
- /**
4257
- * * Field Name: Entity
4258
- * * Display Name: Entity
4259
- * * SQL Data Type: nvarchar(255)
4260
- */
4261
- get Entity(): string;
4262
4259
  }
4263
4260
  /**
4264
4261
  * Authorizations - strongly typed entity sub-class
@@ -6298,7 +6295,6 @@ export declare class TaggedItemEntity extends BaseEntity {
6298
6295
  * * Field Name: EntityID
6299
6296
  * * Display Name: Entity ID
6300
6297
  * * SQL Data Type: int
6301
- * * Related Entity: Entities
6302
6298
  */
6303
6299
  get EntityID(): number;
6304
6300
  set EntityID(value: number);
@@ -6315,12 +6311,6 @@ export declare class TaggedItemEntity extends BaseEntity {
6315
6311
  * * SQL Data Type: nvarchar(255)
6316
6312
  */
6317
6313
  get Tag(): string;
6318
- /**
6319
- * * Field Name: Entity
6320
- * * Display Name: Entity
6321
- * * SQL Data Type: nvarchar(255)
6322
- */
6323
- get Entity(): string;
6324
6314
  }
6325
6315
  /**
6326
6316
  * Workspaces - strongly typed entity sub-class
@@ -7237,7 +7227,6 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity {
7237
7227
  * * Field Name: EntityID
7238
7228
  * * Display Name: Entity ID
7239
7229
  * * SQL Data Type: int
7240
- * * Related Entity: Entities
7241
7230
  */
7242
7231
  get EntityID(): number;
7243
7232
  set EntityID(value: number);
@@ -7262,12 +7251,6 @@ export declare class CompanyIntegrationRecordMapEntity extends BaseEntity {
7262
7251
  * * Default Value: getdate()
7263
7252
  */
7264
7253
  get UpdatedAt(): Date;
7265
- /**
7266
- * * Field Name: Entity
7267
- * * Display Name: Entity
7268
- * * SQL Data Type: nvarchar(255)
7269
- */
7270
- get Entity(): string;
7271
7254
  }
7272
7255
  /**
7273
7256
  * Record Merge Logs - strongly typed entity sub-class
@@ -7563,7 +7546,6 @@ export declare class QueryFieldEntity extends BaseEntity {
7563
7546
  * * Field Name: SourceEntityID
7564
7547
  * * Display Name: Source Entity ID
7565
7548
  * * SQL Data Type: int
7566
- * * Related Entity: Entities
7567
7549
  */
7568
7550
  get SourceEntityID(): number;
7569
7551
  set SourceEntityID(value: number);
@@ -7624,12 +7606,6 @@ export declare class QueryFieldEntity extends BaseEntity {
7624
7606
  * * SQL Data Type: nvarchar(255)
7625
7607
  */
7626
7608
  get Query(): string;
7627
- /**
7628
- * * Field Name: SourceEntity
7629
- * * Display Name: Source Entity
7630
- * * SQL Data Type: nvarchar(255)
7631
- */
7632
- get SourceEntity(): string;
7633
7609
  }
7634
7610
  /**
7635
7611
  * Query Categories - strongly typed entity sub-class
@@ -8126,6 +8102,7 @@ export declare class EntityDocumentRunEntity extends BaseEntity {
8126
8102
  * * Display Name: Status
8127
8103
  * * SQL Data Type: nvarchar(15)
8128
8104
  * * Default Value: N'Pending'
8105
+ * * Description: Can be Pending, In Progress, Completed, or Failed
8129
8106
  */
8130
8107
  get Status(): string;
8131
8108
  set Status(value: string);
@@ -8382,7 +8359,6 @@ export declare class EntityDocumentEntity extends BaseEntity {
8382
8359
  * * Field Name: EntityID
8383
8360
  * * Display Name: Entity ID
8384
8361
  * * SQL Data Type: int
8385
- * * Related Entity: Entities
8386
8362
  */
8387
8363
  get EntityID(): number;
8388
8364
  set EntityID(value: number);
@@ -8424,12 +8400,6 @@ export declare class EntityDocumentEntity extends BaseEntity {
8424
8400
  */
8425
8401
  get UpdatedAt(): Date;
8426
8402
  /**
8427
- * * Field Name: Entity
8428
- * * Display Name: Entity
8429
- * * SQL Data Type: nvarchar(255)
8430
- */
8431
- get Entity(): string;
8432
- /**
8433
8403
  * * Field Name: Type
8434
8404
  * * Display Name: Type
8435
8405
  * * SQL Data Type: nvarchar(100)
@@ -8441,6 +8411,7 @@ export declare class EntityDocumentEntity extends BaseEntity {
8441
8411
  * * Schema: admin
8442
8412
  * * Base Table: DataContextItem
8443
8413
  * * Base View: vwDataContextItems
8414
+ * * @description Data Context Items store information about each item within a Data Context. Each item stores a link to a view, query, or raw sql statement and can optionally cache the JSON representing the last run of that data object as well.
8444
8415
  * * Primary Key: ID
8445
8416
  * @extends {BaseEntity}
8446
8417
  * @class
@@ -8479,6 +8450,7 @@ export declare class DataContextItemEntity extends BaseEntity {
8479
8450
  * * Display Name: Data Context ID
8480
8451
  * * SQL Data Type: int
8481
8452
  * * Related Entity: Data Contexts
8453
+ * * Description: Foreign key to the DataContext table
8482
8454
  */
8483
8455
  get DataContextID(): number;
8484
8456
  set DataContextID(value: number);
@@ -8486,13 +8458,41 @@ export declare class DataContextItemEntity extends BaseEntity {
8486
8458
  * * Field Name: Type
8487
8459
  * * Display Name: Type
8488
8460
  * * SQL Data Type: nvarchar(50)
8461
+ * * Description: The type of the item, either "view", "query", "full_entity", "single_record", or "sql"
8489
8462
  */
8490
8463
  get Type(): string;
8491
8464
  set Type(value: string);
8492
8465
  /**
8466
+ * * Field Name: ViewID
8467
+ * * Display Name: View ID
8468
+ * * SQL Data Type: int
8469
+ * * Related Entity: User Views
8470
+ * * Description: Only used if Type='view'
8471
+ */
8472
+ get ViewID(): number;
8473
+ set ViewID(value: number);
8474
+ /**
8475
+ * * Field Name: QueryID
8476
+ * * Display Name: Query ID
8477
+ * * SQL Data Type: int
8478
+ * * Related Entity: Queries
8479
+ * * Description: Only used if Type='query'
8480
+ */
8481
+ get QueryID(): number;
8482
+ set QueryID(value: number);
8483
+ /**
8484
+ * * Field Name: EntityID
8485
+ * * Display Name: Entity ID
8486
+ * * SQL Data Type: int
8487
+ * * Description: Used if type='full_entity' or type='single_record'
8488
+ */
8489
+ get EntityID(): number;
8490
+ set EntityID(value: number);
8491
+ /**
8493
8492
  * * Field Name: RecordID
8494
8493
  * * Display Name: Record ID
8495
8494
  * * SQL Data Type: int
8495
+ * * Description: The ID for the record, only used when Type='single_record'
8496
8496
  */
8497
8497
  get RecordID(): number;
8498
8498
  set RecordID(value: number);
@@ -8500,6 +8500,7 @@ export declare class DataContextItemEntity extends BaseEntity {
8500
8500
  * * Field Name: SQL
8501
8501
  * * Display Name: SQL
8502
8502
  * * SQL Data Type: nvarchar(MAX)
8503
+ * * Description: Only used when Type=sql
8503
8504
  */
8504
8505
  get SQL(): string;
8505
8506
  set SQL(value: string);
@@ -8507,6 +8508,7 @@ export declare class DataContextItemEntity extends BaseEntity {
8507
8508
  * * Field Name: DataJSON
8508
8509
  * * Display Name: Data JSON
8509
8510
  * * SQL Data Type: nvarchar(MAX)
8511
+ * * Description: Optionally used to cache results of an item. This can be used for performance optimization, and also for having snapshots of data for historical comparisons.
8510
8512
  */
8511
8513
  get DataJSON(): string;
8512
8514
  set DataJSON(value: string);
@@ -8514,6 +8516,7 @@ export declare class DataContextItemEntity extends BaseEntity {
8514
8516
  * * Field Name: LastRefreshedAt
8515
8517
  * * Display Name: Last Refreshed At
8516
8518
  * * SQL Data Type: datetime
8519
+ * * Description: If DataJSON is populated, this field will show the date the the data was captured
8517
8520
  */
8518
8521
  get LastRefreshedAt(): Date;
8519
8522
  set LastRefreshedAt(value: Date);
@@ -8535,15 +8538,27 @@ export declare class DataContextItemEntity extends BaseEntity {
8535
8538
  * * Field Name: DataContext
8536
8539
  * * Display Name: Data Context
8537
8540
  * * SQL Data Type: nvarchar(255)
8538
- * * Default Value: null
8539
8541
  */
8540
8542
  get DataContext(): string;
8543
+ /**
8544
+ * * Field Name: View
8545
+ * * Display Name: View
8546
+ * * SQL Data Type: nvarchar(100)
8547
+ */
8548
+ get View(): string;
8549
+ /**
8550
+ * * Field Name: Query
8551
+ * * Display Name: Query
8552
+ * * SQL Data Type: nvarchar(255)
8553
+ */
8554
+ get Query(): string;
8541
8555
  }
8542
8556
  /**
8543
8557
  * Data Contexts - strongly typed entity sub-class
8544
8558
  * * Schema: admin
8545
8559
  * * Base Table: DataContext
8546
8560
  * * Base View: vwDataContexts
8561
+ * * @description Data Contexts are a primitive within the MemberJunction architecture. They store information about data contexts which are groups of data including views, queries, or raw SQL statements. Data contexts can be used in conversations, reports and more.
8547
8562
  * * Primary Key: ID
8548
8563
  * @extends {BaseEntity}
8549
8564
  * @class
@@ -8624,7 +8639,6 @@ export declare class DataContextEntity extends BaseEntity {
8624
8639
  * * Field Name: User
8625
8640
  * * Display Name: User
8626
8641
  * * SQL Data Type: nvarchar(100)
8627
- * * Default Value: null
8628
8642
  */
8629
8643
  get User(): string;
8630
8644
  }
@@ -1537,7 +1537,6 @@ let EntityFieldEntity = class EntityFieldEntity extends core_1.BaseEntity {
1537
1537
  * * Field Name: EntityID
1538
1538
  * * Display Name: Entity ID
1539
1539
  * * SQL Data Type: int
1540
- * * Related Entity: Entities
1541
1540
  */
1542
1541
  get EntityID() {
1543
1542
  return this.Get('EntityID');
@@ -1579,6 +1578,19 @@ let EntityFieldEntity = class EntityFieldEntity extends core_1.BaseEntity {
1579
1578
  this.Set('Description', value);
1580
1579
  }
1581
1580
  /**
1581
+ * * Field Name: AutoUpdateDescription
1582
+ * * Display Name: Auto Update Description
1583
+ * * SQL Data Type: bit
1584
+ * * Default Value: 1
1585
+ * * Description: When set to 1 (default), whenever a description is modified in the column within the underlying view (first choice) or table (second choice), the Description column in the entity field definition will be automatically updated. If you never set metadata in the database directly, you can leave this alone. However, if you have metadata set in the database level for description, and you want to provide a DIFFERENT description in this entity field definition, turn this bit off and then set the Description field and future CodeGen runs will NOT override the Description field here.
1586
+ */
1587
+ get AutoUpdateDescription() {
1588
+ return this.Get('AutoUpdateDescription');
1589
+ }
1590
+ set AutoUpdateDescription(value) {
1591
+ this.Set('AutoUpdateDescription', value);
1592
+ }
1593
+ /**
1582
1594
  * * Field Name: IsPrimaryKey
1583
1595
  * * Display Name: Is Primary Key
1584
1596
  * * SQL Data Type: bit
@@ -1832,7 +1844,6 @@ let EntityFieldEntity = class EntityFieldEntity extends core_1.BaseEntity {
1832
1844
  * * Field Name: RelatedEntityID
1833
1845
  * * Display Name: RelatedEntity ID
1834
1846
  * * SQL Data Type: int
1835
- * * Related Entity: Entities
1836
1847
  */
1837
1848
  get RelatedEntityID() {
1838
1849
  return this.Get('RelatedEntityID');
@@ -2072,6 +2083,19 @@ let EntityEntity = class EntityEntity extends core_1.BaseEntity {
2072
2083
  this.Set('Description', value);
2073
2084
  }
2074
2085
  /**
2086
+ * * Field Name: AutoUpdateDescription
2087
+ * * Display Name: Auto Update Description
2088
+ * * SQL Data Type: bit
2089
+ * * Default Value: 1
2090
+ * * Description: When set to 1 (default), whenever a description is modified in the underlying view (first choice) or table (second choice), the Description column in the entity definition will be automatically updated. If you never set metadata in the database directly, you can leave this alone. However, if you have metadata set in the database level for description, and you want to provide a DIFFERENT description in this entity definition, turn this bit off and then set the Description field and future CodeGen runs will NOT override the Description field here.
2091
+ */
2092
+ get AutoUpdateDescription() {
2093
+ return this.Get('AutoUpdateDescription');
2094
+ }
2095
+ set AutoUpdateDescription(value) {
2096
+ this.Set('AutoUpdateDescription', value);
2097
+ }
2098
+ /**
2075
2099
  * * Field Name: BaseTable
2076
2100
  * * Display Name: Base Table
2077
2101
  * * SQL Data Type: nvarchar(255)
@@ -3275,7 +3299,6 @@ let UserViewEntity = class UserViewEntity extends core_1.BaseEntity {
3275
3299
  * * Field Name: EntityID
3276
3300
  * * Display Name: Entity ID
3277
3301
  * * SQL Data Type: int
3278
- * * Related Entity: Entities
3279
3302
  */
3280
3303
  get EntityID() {
3281
3304
  return this.Get('EntityID');
@@ -3708,7 +3731,6 @@ let CompanyIntegrationRunDetailEntity = class CompanyIntegrationRunDetailEntity
3708
3731
  * * Field Name: EntityID
3709
3732
  * * Display Name: Entity ID
3710
3733
  * * SQL Data Type: int
3711
- * * Related Entity: Entities
3712
3734
  */
3713
3735
  get EntityID() {
3714
3736
  return this.Get('EntityID');
@@ -4072,7 +4094,6 @@ let ApplicationEntityEntity = class ApplicationEntityEntity extends core_1.BaseE
4072
4094
  * * Field Name: EntityID
4073
4095
  * * Display Name: Entity ID
4074
4096
  * * SQL Data Type: int
4075
- * * Related Entity: Entities
4076
4097
  */
4077
4098
  get EntityID() {
4078
4099
  return this.Get('EntityID');
@@ -4209,7 +4230,6 @@ let EntityPermissionEntity = class EntityPermissionEntity extends core_1.BaseEnt
4209
4230
  * * Field Name: EntityID
4210
4231
  * * Display Name: Entity ID
4211
4232
  * * SQL Data Type: int
4212
- * * Related Entity: Entities
4213
4233
  */
4214
4234
  get EntityID() {
4215
4235
  return this.Get('EntityID');
@@ -4445,7 +4465,6 @@ let UserApplicationEntityEntity = class UserApplicationEntityEntity extends core
4445
4465
  * * Field Name: EntityID
4446
4466
  * * Display Name: Entity ID
4447
4467
  * * SQL Data Type: int
4448
- * * Related Entity: Entities
4449
4468
  */
4450
4469
  get EntityID() {
4451
4470
  return this.Get('EntityID');
@@ -4781,7 +4800,6 @@ let ListEntity = class ListEntity extends core_1.BaseEntity {
4781
4800
  * * Field Name: EntityID
4782
4801
  * * Display Name: Entity ID
4783
4802
  * * SQL Data Type: int
4784
- * * Related Entity: Entities
4785
4803
  */
4786
4804
  get EntityID() {
4787
4805
  return this.Get('EntityID');
@@ -4843,14 +4861,6 @@ let ListEntity = class ListEntity extends core_1.BaseEntity {
4843
4861
  return this.Get('UpdatedAt');
4844
4862
  }
4845
4863
  /**
4846
- * * Field Name: Entity
4847
- * * Display Name: Entity
4848
- * * SQL Data Type: nvarchar(255)
4849
- */
4850
- get Entity() {
4851
- return this.Get('Entity');
4852
- }
4853
- /**
4854
4864
  * * Field Name: User
4855
4865
  * * Display Name: User
4856
4866
  * * SQL Data Type: nvarchar(100)
@@ -5993,7 +6003,6 @@ let AuditLogEntity = class AuditLogEntity extends core_1.BaseEntity {
5993
6003
  * * Field Name: EntityID
5994
6004
  * * Display Name: Entity ID
5995
6005
  * * SQL Data Type: int
5996
- * * Related Entity: Entities
5997
6006
  */
5998
6007
  get EntityID() {
5999
6008
  return this.Get('EntityID');
@@ -6038,14 +6047,6 @@ let AuditLogEntity = class AuditLogEntity extends core_1.BaseEntity {
6038
6047
  get User() {
6039
6048
  return this.Get('User');
6040
6049
  }
6041
- /**
6042
- * * Field Name: Entity
6043
- * * Display Name: Entity
6044
- * * SQL Data Type: nvarchar(255)
6045
- */
6046
- get Entity() {
6047
- return this.Get('Entity');
6048
- }
6049
6050
  };
6050
6051
  exports.AuditLogEntity = AuditLogEntity;
6051
6052
  exports.AuditLogEntity = AuditLogEntity = __decorate([
@@ -8901,7 +8902,6 @@ let TaggedItemEntity = class TaggedItemEntity extends core_1.BaseEntity {
8901
8902
  * * Field Name: EntityID
8902
8903
  * * Display Name: Entity ID
8903
8904
  * * SQL Data Type: int
8904
- * * Related Entity: Entities
8905
8905
  */
8906
8906
  get EntityID() {
8907
8907
  return this.Get('EntityID');
@@ -8928,14 +8928,6 @@ let TaggedItemEntity = class TaggedItemEntity extends core_1.BaseEntity {
8928
8928
  get Tag() {
8929
8929
  return this.Get('Tag');
8930
8930
  }
8931
- /**
8932
- * * Field Name: Entity
8933
- * * Display Name: Entity
8934
- * * SQL Data Type: nvarchar(255)
8935
- */
8936
- get Entity() {
8937
- return this.Get('Entity');
8938
- }
8939
8931
  };
8940
8932
  exports.TaggedItemEntity = TaggedItemEntity;
8941
8933
  exports.TaggedItemEntity = TaggedItemEntity = __decorate([
@@ -10224,7 +10216,6 @@ let CompanyIntegrationRecordMapEntity = class CompanyIntegrationRecordMapEntity
10224
10216
  * * Field Name: EntityID
10225
10217
  * * Display Name: Entity ID
10226
10218
  * * SQL Data Type: int
10227
- * * Related Entity: Entities
10228
10219
  */
10229
10220
  get EntityID() {
10230
10221
  return this.Get('EntityID');
@@ -10261,14 +10252,6 @@ let CompanyIntegrationRecordMapEntity = class CompanyIntegrationRecordMapEntity
10261
10252
  get UpdatedAt() {
10262
10253
  return this.Get('UpdatedAt');
10263
10254
  }
10264
- /**
10265
- * * Field Name: Entity
10266
- * * Display Name: Entity
10267
- * * SQL Data Type: nvarchar(255)
10268
- */
10269
- get Entity() {
10270
- return this.Get('Entity');
10271
- }
10272
10255
  };
10273
10256
  exports.CompanyIntegrationRecordMapEntity = CompanyIntegrationRecordMapEntity;
10274
10257
  exports.CompanyIntegrationRecordMapEntity = CompanyIntegrationRecordMapEntity = __decorate([
@@ -10684,7 +10667,6 @@ let QueryFieldEntity = class QueryFieldEntity extends core_1.BaseEntity {
10684
10667
  * * Field Name: SourceEntityID
10685
10668
  * * Display Name: Source Entity ID
10686
10669
  * * SQL Data Type: int
10687
- * * Related Entity: Entities
10688
10670
  */
10689
10671
  get SourceEntityID() {
10690
10672
  return this.Get('SourceEntityID');
@@ -10775,14 +10757,6 @@ let QueryFieldEntity = class QueryFieldEntity extends core_1.BaseEntity {
10775
10757
  get Query() {
10776
10758
  return this.Get('Query');
10777
10759
  }
10778
- /**
10779
- * * Field Name: SourceEntity
10780
- * * Display Name: Source Entity
10781
- * * SQL Data Type: nvarchar(255)
10782
- */
10783
- get SourceEntity() {
10784
- return this.Get('SourceEntity');
10785
- }
10786
10760
  };
10787
10761
  exports.QueryFieldEntity = QueryFieldEntity;
10788
10762
  exports.QueryFieldEntity = QueryFieldEntity = __decorate([
@@ -11467,6 +11441,7 @@ let EntityDocumentRunEntity = class EntityDocumentRunEntity extends core_1.BaseE
11467
11441
  * * Display Name: Status
11468
11442
  * * SQL Data Type: nvarchar(15)
11469
11443
  * * Default Value: N'Pending'
11444
+ * * Description: Can be Pending, In Progress, Completed, or Failed
11470
11445
  */
11471
11446
  get Status() {
11472
11447
  return this.Get('Status');
@@ -11825,7 +11800,6 @@ let EntityDocumentEntity = class EntityDocumentEntity extends core_1.BaseEntity
11825
11800
  * * Field Name: EntityID
11826
11801
  * * Display Name: Entity ID
11827
11802
  * * SQL Data Type: int
11828
- * * Related Entity: Entities
11829
11803
  */
11830
11804
  get EntityID() {
11831
11805
  return this.Get('EntityID');
@@ -11887,14 +11861,6 @@ let EntityDocumentEntity = class EntityDocumentEntity extends core_1.BaseEntity
11887
11861
  return this.Get('UpdatedAt');
11888
11862
  }
11889
11863
  /**
11890
- * * Field Name: Entity
11891
- * * Display Name: Entity
11892
- * * SQL Data Type: nvarchar(255)
11893
- */
11894
- get Entity() {
11895
- return this.Get('Entity');
11896
- }
11897
- /**
11898
11864
  * * Field Name: Type
11899
11865
  * * Display Name: Type
11900
11866
  * * SQL Data Type: nvarchar(100)
@@ -11912,6 +11878,7 @@ exports.EntityDocumentEntity = EntityDocumentEntity = __decorate([
11912
11878
  * * Schema: admin
11913
11879
  * * Base Table: DataContextItem
11914
11880
  * * Base View: vwDataContextItems
11881
+ * * @description Data Context Items store information about each item within a Data Context. Each item stores a link to a view, query, or raw sql statement and can optionally cache the JSON representing the last run of that data object as well.
11915
11882
  * * Primary Key: ID
11916
11883
  * @extends {BaseEntity}
11917
11884
  * @class
@@ -11958,6 +11925,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
11958
11925
  * * Display Name: Data Context ID
11959
11926
  * * SQL Data Type: int
11960
11927
  * * Related Entity: Data Contexts
11928
+ * * Description: Foreign key to the DataContext table
11961
11929
  */
11962
11930
  get DataContextID() {
11963
11931
  return this.Get('DataContextID');
@@ -11969,6 +11937,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
11969
11937
  * * Field Name: Type
11970
11938
  * * Display Name: Type
11971
11939
  * * SQL Data Type: nvarchar(50)
11940
+ * * Description: The type of the item, either "view", "query", "full_entity", "single_record", or "sql"
11972
11941
  */
11973
11942
  get Type() {
11974
11943
  return this.Get('Type');
@@ -11977,9 +11946,48 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
11977
11946
  this.Set('Type', value);
11978
11947
  }
11979
11948
  /**
11949
+ * * Field Name: ViewID
11950
+ * * Display Name: View ID
11951
+ * * SQL Data Type: int
11952
+ * * Related Entity: User Views
11953
+ * * Description: Only used if Type='view'
11954
+ */
11955
+ get ViewID() {
11956
+ return this.Get('ViewID');
11957
+ }
11958
+ set ViewID(value) {
11959
+ this.Set('ViewID', value);
11960
+ }
11961
+ /**
11962
+ * * Field Name: QueryID
11963
+ * * Display Name: Query ID
11964
+ * * SQL Data Type: int
11965
+ * * Related Entity: Queries
11966
+ * * Description: Only used if Type='query'
11967
+ */
11968
+ get QueryID() {
11969
+ return this.Get('QueryID');
11970
+ }
11971
+ set QueryID(value) {
11972
+ this.Set('QueryID', value);
11973
+ }
11974
+ /**
11975
+ * * Field Name: EntityID
11976
+ * * Display Name: Entity ID
11977
+ * * SQL Data Type: int
11978
+ * * Description: Used if type='full_entity' or type='single_record'
11979
+ */
11980
+ get EntityID() {
11981
+ return this.Get('EntityID');
11982
+ }
11983
+ set EntityID(value) {
11984
+ this.Set('EntityID', value);
11985
+ }
11986
+ /**
11980
11987
  * * Field Name: RecordID
11981
11988
  * * Display Name: Record ID
11982
11989
  * * SQL Data Type: int
11990
+ * * Description: The ID for the record, only used when Type='single_record'
11983
11991
  */
11984
11992
  get RecordID() {
11985
11993
  return this.Get('RecordID');
@@ -11991,6 +11999,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
11991
11999
  * * Field Name: SQL
11992
12000
  * * Display Name: SQL
11993
12001
  * * SQL Data Type: nvarchar(MAX)
12002
+ * * Description: Only used when Type=sql
11994
12003
  */
11995
12004
  get SQL() {
11996
12005
  return this.Get('SQL');
@@ -12002,6 +12011,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
12002
12011
  * * Field Name: DataJSON
12003
12012
  * * Display Name: Data JSON
12004
12013
  * * SQL Data Type: nvarchar(MAX)
12014
+ * * Description: Optionally used to cache results of an item. This can be used for performance optimization, and also for having snapshots of data for historical comparisons.
12005
12015
  */
12006
12016
  get DataJSON() {
12007
12017
  return this.Get('DataJSON');
@@ -12013,6 +12023,7 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
12013
12023
  * * Field Name: LastRefreshedAt
12014
12024
  * * Display Name: Last Refreshed At
12015
12025
  * * SQL Data Type: datetime
12026
+ * * Description: If DataJSON is populated, this field will show the date the the data was captured
12016
12027
  */
12017
12028
  get LastRefreshedAt() {
12018
12029
  return this.Get('LastRefreshedAt');
@@ -12042,11 +12053,26 @@ let DataContextItemEntity = class DataContextItemEntity extends core_1.BaseEntit
12042
12053
  * * Field Name: DataContext
12043
12054
  * * Display Name: Data Context
12044
12055
  * * SQL Data Type: nvarchar(255)
12045
- * * Default Value: null
12046
12056
  */
12047
12057
  get DataContext() {
12048
12058
  return this.Get('DataContext');
12049
12059
  }
12060
+ /**
12061
+ * * Field Name: View
12062
+ * * Display Name: View
12063
+ * * SQL Data Type: nvarchar(100)
12064
+ */
12065
+ get View() {
12066
+ return this.Get('View');
12067
+ }
12068
+ /**
12069
+ * * Field Name: Query
12070
+ * * Display Name: Query
12071
+ * * SQL Data Type: nvarchar(255)
12072
+ */
12073
+ get Query() {
12074
+ return this.Get('Query');
12075
+ }
12050
12076
  };
12051
12077
  exports.DataContextItemEntity = DataContextItemEntity;
12052
12078
  exports.DataContextItemEntity = DataContextItemEntity = __decorate([
@@ -12057,6 +12083,7 @@ exports.DataContextItemEntity = DataContextItemEntity = __decorate([
12057
12083
  * * Schema: admin
12058
12084
  * * Base Table: DataContext
12059
12085
  * * Base View: vwDataContexts
12086
+ * * @description Data Contexts are a primitive within the MemberJunction architecture. They store information about data contexts which are groups of data including views, queries, or raw SQL statements. Data contexts can be used in conversations, reports and more.
12060
12087
  * * Primary Key: ID
12061
12088
  * @extends {BaseEntity}
12062
12089
  * @class
@@ -12165,7 +12192,6 @@ let DataContextEntity = class DataContextEntity extends core_1.BaseEntity {
12165
12192
  * * Field Name: User
12166
12193
  * * Display Name: User
12167
12194
  * * SQL Data Type: nvarchar(100)
12168
- * * Default Value: null
12169
12195
  */
12170
12196
  get User() {
12171
12197
  return this.Get('User');