@memberjunction/core-entities 3.1.1 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4611,6 +4611,8 @@ export declare const FileStorageProviderSchema: z.ZodObject<{
4611
4611
  __mj_CreatedAt: z.ZodDate;
4612
4612
  __mj_UpdatedAt: z.ZodDate;
4613
4613
  SupportsSearch: z.ZodBoolean;
4614
+ Configuration: z.ZodNullable<z.ZodString>;
4615
+ RequiresOAuth: z.ZodBoolean;
4614
4616
  }, "strip", z.ZodTypeAny, {
4615
4617
  ID?: string;
4616
4618
  __mj_CreatedAt?: Date;
@@ -4619,9 +4621,11 @@ export declare const FileStorageProviderSchema: z.ZodObject<{
4619
4621
  Description?: string;
4620
4622
  IsActive?: boolean;
4621
4623
  Priority?: number;
4624
+ Configuration?: string;
4622
4625
  ServerDriverKey?: string;
4623
4626
  ClientDriverKey?: string;
4624
4627
  SupportsSearch?: boolean;
4628
+ RequiresOAuth?: boolean;
4625
4629
  }, {
4626
4630
  ID?: string;
4627
4631
  __mj_CreatedAt?: Date;
@@ -4630,9 +4634,11 @@ export declare const FileStorageProviderSchema: z.ZodObject<{
4630
4634
  Description?: string;
4631
4635
  IsActive?: boolean;
4632
4636
  Priority?: number;
4637
+ Configuration?: string;
4633
4638
  ServerDriverKey?: string;
4634
4639
  ClientDriverKey?: string;
4635
4640
  SupportsSearch?: boolean;
4641
+ RequiresOAuth?: boolean;
4636
4642
  }>;
4637
4643
  export type FileStorageProviderEntityType = z.infer<typeof FileStorageProviderSchema>;
4638
4644
  /**
@@ -4679,50 +4685,6 @@ export declare const FileSchema: z.ZodObject<{
4679
4685
  Provider?: string;
4680
4686
  }>;
4681
4687
  export type FileEntityType = z.infer<typeof FileSchema>;
4682
- /**
4683
- * zod schema definition for the entity Flyway _schema _histories
4684
- */
4685
- export declare const flyway_schema_historySchema: z.ZodObject<{
4686
- installed_rank: z.ZodNumber;
4687
- version: z.ZodNullable<z.ZodString>;
4688
- description: z.ZodNullable<z.ZodString>;
4689
- type: z.ZodString;
4690
- script: z.ZodString;
4691
- checksum: z.ZodNullable<z.ZodNumber>;
4692
- installed_by: z.ZodString;
4693
- installed_on: z.ZodDate;
4694
- execution_time: z.ZodNumber;
4695
- success: z.ZodBoolean;
4696
- __mj_CreatedAt: z.ZodDate;
4697
- __mj_UpdatedAt: z.ZodDate;
4698
- }, "strip", z.ZodTypeAny, {
4699
- __mj_CreatedAt?: Date;
4700
- __mj_UpdatedAt?: Date;
4701
- type?: string;
4702
- installed_rank?: number;
4703
- version?: string;
4704
- description?: string;
4705
- script?: string;
4706
- checksum?: number;
4707
- installed_by?: string;
4708
- installed_on?: Date;
4709
- execution_time?: number;
4710
- success?: boolean;
4711
- }, {
4712
- __mj_CreatedAt?: Date;
4713
- __mj_UpdatedAt?: Date;
4714
- type?: string;
4715
- installed_rank?: number;
4716
- version?: string;
4717
- description?: string;
4718
- script?: string;
4719
- checksum?: number;
4720
- installed_by?: string;
4721
- installed_on?: Date;
4722
- execution_time?: number;
4723
- success?: boolean;
4724
- }>;
4725
- export type flyway_schema_historyEntityType = z.infer<typeof flyway_schema_historySchema>;
4726
4688
  /**
4727
4689
  * zod schema definition for the entity Generated Code Categories
4728
4690
  */
@@ -7088,6 +7050,152 @@ export declare const AIVendorSchema: z.ZodObject<{
7088
7050
  CredentialType?: string;
7089
7051
  }>;
7090
7052
  export type AIVendorEntityType = z.infer<typeof AIVendorSchema>;
7053
+ /**
7054
+ * zod schema definition for the entity MJ: API Key Scopes
7055
+ */
7056
+ export declare const APIKeyScopeSchema: z.ZodObject<{
7057
+ ID: z.ZodString;
7058
+ APIKeyID: z.ZodString;
7059
+ ScopeID: z.ZodString;
7060
+ __mj_CreatedAt: z.ZodDate;
7061
+ __mj_UpdatedAt: z.ZodDate;
7062
+ APIKey: z.ZodString;
7063
+ Scope: z.ZodString;
7064
+ }, "strip", z.ZodTypeAny, {
7065
+ ID?: string;
7066
+ __mj_CreatedAt?: Date;
7067
+ __mj_UpdatedAt?: Date;
7068
+ APIKey?: string;
7069
+ Scope?: string;
7070
+ APIKeyID?: string;
7071
+ ScopeID?: string;
7072
+ }, {
7073
+ ID?: string;
7074
+ __mj_CreatedAt?: Date;
7075
+ __mj_UpdatedAt?: Date;
7076
+ APIKey?: string;
7077
+ Scope?: string;
7078
+ APIKeyID?: string;
7079
+ ScopeID?: string;
7080
+ }>;
7081
+ export type APIKeyScopeEntityType = z.infer<typeof APIKeyScopeSchema>;
7082
+ /**
7083
+ * zod schema definition for the entity MJ: API Key Usage Logs
7084
+ */
7085
+ export declare const APIKeyUsageLogSchema: z.ZodObject<{
7086
+ ID: z.ZodString;
7087
+ APIKeyID: z.ZodString;
7088
+ Endpoint: z.ZodString;
7089
+ Operation: z.ZodNullable<z.ZodString>;
7090
+ Method: z.ZodString;
7091
+ StatusCode: z.ZodNumber;
7092
+ ResponseTimeMs: z.ZodNullable<z.ZodNumber>;
7093
+ IPAddress: z.ZodNullable<z.ZodString>;
7094
+ UserAgent: z.ZodNullable<z.ZodString>;
7095
+ __mj_CreatedAt: z.ZodDate;
7096
+ __mj_UpdatedAt: z.ZodDate;
7097
+ APIKey: z.ZodString;
7098
+ }, "strip", z.ZodTypeAny, {
7099
+ ID?: string;
7100
+ __mj_CreatedAt?: Date;
7101
+ __mj_UpdatedAt?: Date;
7102
+ APIKey?: string;
7103
+ APIKeyID?: string;
7104
+ Endpoint?: string;
7105
+ Operation?: string;
7106
+ Method?: string;
7107
+ StatusCode?: number;
7108
+ ResponseTimeMs?: number;
7109
+ IPAddress?: string;
7110
+ UserAgent?: string;
7111
+ }, {
7112
+ ID?: string;
7113
+ __mj_CreatedAt?: Date;
7114
+ __mj_UpdatedAt?: Date;
7115
+ APIKey?: string;
7116
+ APIKeyID?: string;
7117
+ Endpoint?: string;
7118
+ Operation?: string;
7119
+ Method?: string;
7120
+ StatusCode?: number;
7121
+ ResponseTimeMs?: number;
7122
+ IPAddress?: string;
7123
+ UserAgent?: string;
7124
+ }>;
7125
+ export type APIKeyUsageLogEntityType = z.infer<typeof APIKeyUsageLogSchema>;
7126
+ /**
7127
+ * zod schema definition for the entity MJ: API Keys
7128
+ */
7129
+ export declare const APIKeySchema: z.ZodObject<{
7130
+ ID: z.ZodString;
7131
+ Hash: z.ZodString;
7132
+ UserID: z.ZodString;
7133
+ Label: z.ZodString;
7134
+ Description: z.ZodNullable<z.ZodString>;
7135
+ Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Revoked">]>;
7136
+ ExpiresAt: z.ZodNullable<z.ZodDate>;
7137
+ LastUsedAt: z.ZodNullable<z.ZodDate>;
7138
+ CreatedByUserID: z.ZodString;
7139
+ __mj_CreatedAt: z.ZodDate;
7140
+ __mj_UpdatedAt: z.ZodDate;
7141
+ User: z.ZodString;
7142
+ CreatedByUser: z.ZodString;
7143
+ }, "strip", z.ZodTypeAny, {
7144
+ ID?: string;
7145
+ __mj_CreatedAt?: Date;
7146
+ __mj_UpdatedAt?: Date;
7147
+ Description?: string;
7148
+ Status?: "Active" | "Revoked";
7149
+ UserID?: string;
7150
+ User?: string;
7151
+ ExpiresAt?: Date;
7152
+ Label?: string;
7153
+ Hash?: string;
7154
+ LastUsedAt?: Date;
7155
+ CreatedByUserID?: string;
7156
+ CreatedByUser?: string;
7157
+ }, {
7158
+ ID?: string;
7159
+ __mj_CreatedAt?: Date;
7160
+ __mj_UpdatedAt?: Date;
7161
+ Description?: string;
7162
+ Status?: "Active" | "Revoked";
7163
+ UserID?: string;
7164
+ User?: string;
7165
+ ExpiresAt?: Date;
7166
+ Label?: string;
7167
+ Hash?: string;
7168
+ LastUsedAt?: Date;
7169
+ CreatedByUserID?: string;
7170
+ CreatedByUser?: string;
7171
+ }>;
7172
+ export type APIKeyEntityType = z.infer<typeof APIKeySchema>;
7173
+ /**
7174
+ * zod schema definition for the entity MJ: API Scopes
7175
+ */
7176
+ export declare const APIScopeSchema: z.ZodObject<{
7177
+ ID: z.ZodString;
7178
+ Name: z.ZodString;
7179
+ Category: z.ZodString;
7180
+ Description: z.ZodNullable<z.ZodString>;
7181
+ __mj_CreatedAt: z.ZodDate;
7182
+ __mj_UpdatedAt: z.ZodDate;
7183
+ }, "strip", z.ZodTypeAny, {
7184
+ ID?: string;
7185
+ __mj_CreatedAt?: Date;
7186
+ __mj_UpdatedAt?: Date;
7187
+ Name?: string;
7188
+ Description?: string;
7189
+ Category?: string;
7190
+ }, {
7191
+ ID?: string;
7192
+ __mj_CreatedAt?: Date;
7193
+ __mj_UpdatedAt?: Date;
7194
+ Name?: string;
7195
+ Description?: string;
7196
+ Category?: string;
7197
+ }>;
7198
+ export type APIScopeEntityType = z.infer<typeof APIScopeSchema>;
7091
7199
  /**
7092
7200
  * zod schema definition for the entity MJ: Artifact Permissions
7093
7201
  */
@@ -8069,9 +8177,9 @@ export declare const CredentialSchema: z.ZodObject<{
8069
8177
  IsDefault?: boolean;
8070
8178
  CredentialTypeID?: string;
8071
8179
  CredentialType?: string;
8180
+ LastUsedAt?: Date;
8072
8181
  Values?: string;
8073
8182
  LastValidatedAt?: Date;
8074
- LastUsedAt?: Date;
8075
8183
  }, {
8076
8184
  ID?: string;
8077
8185
  __mj_CreatedAt?: Date;
@@ -8086,9 +8194,9 @@ export declare const CredentialSchema: z.ZodObject<{
8086
8194
  IsDefault?: boolean;
8087
8195
  CredentialTypeID?: string;
8088
8196
  CredentialType?: string;
8197
+ LastUsedAt?: Date;
8089
8198
  Values?: string;
8090
8199
  LastValidatedAt?: Date;
8091
- LastUsedAt?: Date;
8092
8200
  }>;
8093
8201
  export type CredentialEntityType = z.infer<typeof CredentialSchema>;
8094
8202
  /**
@@ -8501,6 +8609,41 @@ export declare const EnvironmentSchema: z.ZodObject<{
8501
8609
  Settings?: string;
8502
8610
  }>;
8503
8611
  export type EnvironmentEntityType = z.infer<typeof EnvironmentSchema>;
8612
+ /**
8613
+ * zod schema definition for the entity MJ: File Storage Accounts
8614
+ */
8615
+ export declare const FileStorageAccountSchema: z.ZodObject<{
8616
+ ID: z.ZodString;
8617
+ Name: z.ZodString;
8618
+ Description: z.ZodNullable<z.ZodString>;
8619
+ ProviderID: z.ZodString;
8620
+ CredentialID: z.ZodString;
8621
+ __mj_CreatedAt: z.ZodDate;
8622
+ __mj_UpdatedAt: z.ZodDate;
8623
+ Provider: z.ZodString;
8624
+ Credential: z.ZodString;
8625
+ }, "strip", z.ZodTypeAny, {
8626
+ ID?: string;
8627
+ __mj_CreatedAt?: Date;
8628
+ __mj_UpdatedAt?: Date;
8629
+ Name?: string;
8630
+ Description?: string;
8631
+ ProviderID?: string;
8632
+ Provider?: string;
8633
+ CredentialID?: string;
8634
+ Credential?: string;
8635
+ }, {
8636
+ ID?: string;
8637
+ __mj_CreatedAt?: Date;
8638
+ __mj_UpdatedAt?: Date;
8639
+ Name?: string;
8640
+ Description?: string;
8641
+ ProviderID?: string;
8642
+ Provider?: string;
8643
+ CredentialID?: string;
8644
+ Credential?: string;
8645
+ }>;
8646
+ export type FileStorageAccountEntityType = z.infer<typeof FileStorageAccountSchema>;
8504
8647
  /**
8505
8648
  * zod schema definition for the entity MJ: List Invitations
8506
8649
  */
@@ -8527,9 +8670,9 @@ export declare const ListInvitationSchema: z.ZodObject<{
8527
8670
  List?: string;
8528
8671
  ListID?: string;
8529
8672
  ExpiresAt?: Date;
8530
- Token?: string;
8531
8673
  CreatedByUserID?: string;
8532
8674
  CreatedByUser?: string;
8675
+ Token?: string;
8533
8676
  }, {
8534
8677
  ID?: string;
8535
8678
  __mj_CreatedAt?: Date;
@@ -8540,9 +8683,9 @@ export declare const ListInvitationSchema: z.ZodObject<{
8540
8683
  List?: string;
8541
8684
  ListID?: string;
8542
8685
  ExpiresAt?: Date;
8543
- Token?: string;
8544
8686
  CreatedByUserID?: string;
8545
8687
  CreatedByUser?: string;
8688
+ Token?: string;
8546
8689
  }>;
8547
8690
  export type ListInvitationEntityType = z.infer<typeof ListInvitationSchema>;
8548
8691
  /**
@@ -9643,6 +9786,106 @@ export declare const TestSchema: z.ZodObject<{
9643
9786
  RepeatCount?: number;
9644
9787
  }>;
9645
9788
  export type TestEntityType = z.infer<typeof TestSchema>;
9789
+ /**
9790
+ * zod schema definition for the entity MJ: User Notification Preferences
9791
+ */
9792
+ export declare const UserNotificationPreferenceSchema: z.ZodObject<{
9793
+ ID: z.ZodString;
9794
+ UserID: z.ZodString;
9795
+ NotificationTypeID: z.ZodString;
9796
+ InAppEnabled: z.ZodNullable<z.ZodBoolean>;
9797
+ EmailEnabled: z.ZodNullable<z.ZodBoolean>;
9798
+ SMSEnabled: z.ZodNullable<z.ZodBoolean>;
9799
+ Enabled: z.ZodNullable<z.ZodBoolean>;
9800
+ __mj_CreatedAt: z.ZodDate;
9801
+ __mj_UpdatedAt: z.ZodDate;
9802
+ User: z.ZodString;
9803
+ NotificationType: z.ZodString;
9804
+ }, "strip", z.ZodTypeAny, {
9805
+ ID?: string;
9806
+ __mj_CreatedAt?: Date;
9807
+ __mj_UpdatedAt?: Date;
9808
+ UserID?: string;
9809
+ User?: string;
9810
+ NotificationTypeID?: string;
9811
+ InAppEnabled?: boolean;
9812
+ EmailEnabled?: boolean;
9813
+ SMSEnabled?: boolean;
9814
+ Enabled?: boolean;
9815
+ NotificationType?: string;
9816
+ }, {
9817
+ ID?: string;
9818
+ __mj_CreatedAt?: Date;
9819
+ __mj_UpdatedAt?: Date;
9820
+ UserID?: string;
9821
+ User?: string;
9822
+ NotificationTypeID?: string;
9823
+ InAppEnabled?: boolean;
9824
+ EmailEnabled?: boolean;
9825
+ SMSEnabled?: boolean;
9826
+ Enabled?: boolean;
9827
+ NotificationType?: string;
9828
+ }>;
9829
+ export type UserNotificationPreferenceEntityType = z.infer<typeof UserNotificationPreferenceSchema>;
9830
+ /**
9831
+ * zod schema definition for the entity MJ: User Notification Types
9832
+ */
9833
+ export declare const UserNotificationTypeSchema: z.ZodObject<{
9834
+ ID: z.ZodString;
9835
+ Name: z.ZodString;
9836
+ Description: z.ZodNullable<z.ZodString>;
9837
+ DefaultInApp: z.ZodBoolean;
9838
+ DefaultEmail: z.ZodBoolean;
9839
+ DefaultSMS: z.ZodBoolean;
9840
+ AllowUserPreference: z.ZodNullable<z.ZodBoolean>;
9841
+ EmailTemplateID: z.ZodNullable<z.ZodString>;
9842
+ SMSTemplateID: z.ZodNullable<z.ZodString>;
9843
+ Icon: z.ZodNullable<z.ZodString>;
9844
+ Color: z.ZodNullable<z.ZodString>;
9845
+ AutoExpireDays: z.ZodNullable<z.ZodNumber>;
9846
+ Priority: z.ZodNullable<z.ZodNumber>;
9847
+ __mj_CreatedAt: z.ZodDate;
9848
+ __mj_UpdatedAt: z.ZodDate;
9849
+ EmailTemplate: z.ZodNullable<z.ZodString>;
9850
+ SMSTemplate: z.ZodNullable<z.ZodString>;
9851
+ }, "strip", z.ZodTypeAny, {
9852
+ ID?: string;
9853
+ __mj_CreatedAt?: Date;
9854
+ __mj_UpdatedAt?: Date;
9855
+ Name?: string;
9856
+ Description?: string;
9857
+ Priority?: number;
9858
+ Icon?: string;
9859
+ Color?: string;
9860
+ DefaultInApp?: boolean;
9861
+ DefaultEmail?: boolean;
9862
+ DefaultSMS?: boolean;
9863
+ AllowUserPreference?: boolean;
9864
+ EmailTemplateID?: string;
9865
+ SMSTemplateID?: string;
9866
+ AutoExpireDays?: number;
9867
+ EmailTemplate?: string;
9868
+ SMSTemplate?: string;
9869
+ }, {
9870
+ ID?: string;
9871
+ __mj_CreatedAt?: Date;
9872
+ __mj_UpdatedAt?: Date;
9873
+ Name?: string;
9874
+ Description?: string;
9875
+ Priority?: number;
9876
+ Icon?: string;
9877
+ Color?: string;
9878
+ DefaultInApp?: boolean;
9879
+ DefaultEmail?: boolean;
9880
+ DefaultSMS?: boolean;
9881
+ AllowUserPreference?: boolean;
9882
+ EmailTemplateID?: string;
9883
+ SMSTemplateID?: string;
9884
+ AutoExpireDays?: number;
9885
+ EmailTemplate?: string;
9886
+ SMSTemplate?: string;
9887
+ }>;
9888
+ export type UserNotificationTypeEntityType = z.infer<typeof UserNotificationTypeSchema>;
9646
9889
  /**
9647
9890
  * zod schema definition for the entity MJ: User Settings
9648
9891
  */
@@ -11389,8 +11632,10 @@ export declare const UserNotificationSchema: z.ZodObject<{
11389
11632
  __mj_CreatedAt: z.ZodDate;
11390
11633
  __mj_UpdatedAt: z.ZodDate;
11391
11634
  ResourceRecordID: z.ZodNullable<z.ZodString>;
11635
+ NotificationTypeID: z.ZodNullable<z.ZodString>;
11392
11636
  User: z.ZodString;
11393
11637
  ResourceType: z.ZodNullable<z.ZodString>;
11638
+ NotificationType: z.ZodNullable<z.ZodString>;
11394
11639
  }, "strip", z.ZodTypeAny, {
11395
11640
  ID?: string;
11396
11641
  __mj_CreatedAt?: Date;
@@ -11400,6 +11645,8 @@ export declare const UserNotificationSchema: z.ZodObject<{
11400
11645
  User?: string;
11401
11646
  Title?: string;
11402
11647
  ResourceType?: string;
11648
+ NotificationTypeID?: string;
11649
+ NotificationType?: string;
11403
11650
  ResourceTypeID?: string;
11404
11651
  ResourceRecordID?: string;
11405
11652
  ResourceConfiguration?: string;
@@ -11414,6 +11661,8 @@ export declare const UserNotificationSchema: z.ZodObject<{
11414
11661
  User?: string;
11415
11662
  Title?: string;
11416
11663
  ResourceType?: string;
11664
+ NotificationTypeID?: string;
11665
+ NotificationType?: string;
11417
11666
  ResourceTypeID?: string;
11418
11667
  ResourceRecordID?: string;
11419
11668
  ResourceConfiguration?: string;
@@ -25065,7 +25314,7 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
25065
25314
  set Priority(value: number);
25066
25315
  /**
25067
25316
  * * Field Name: IsActive
25068
- * * Display Name: Is Active
25317
+ * * Display Name: Active
25069
25318
  * * SQL Data Type: bit
25070
25319
  * * Default Value: 1
25071
25320
  * * Description: Whether this storage provider is currently available for use.
@@ -25095,6 +25344,23 @@ export declare class FileStorageProviderEntity extends BaseEntity<FileStoragePro
25095
25344
  */
25096
25345
  get SupportsSearch(): boolean;
25097
25346
  set SupportsSearch(value: boolean);
25347
+ /**
25348
+ * * Field Name: Configuration
25349
+ * * Display Name: Configuration
25350
+ * * SQL Data Type: nvarchar(MAX)
25351
+ * * Description: Optional JSON configuration for providers that don't use Credential Engine. Used as fallback when CredentialID is not set on FileStorageAccount.
25352
+ */
25353
+ get Configuration(): string | null;
25354
+ set Configuration(value: string | null);
25355
+ /**
25356
+ * * Field Name: RequiresOAuth
25357
+ * * Display Name: Requires OAuth
25358
+ * * SQL Data Type: bit
25359
+ * * Default Value: 0
25360
+ * * Description: If true, this provider requires OAuth authentication. Enterprise OAuth integration via Credential Engine is planned but not yet implemented.
25361
+ */
25362
+ get RequiresOAuth(): boolean;
25363
+ set RequiresOAuth(value: boolean);
25098
25364
  }
25099
25365
  /**
25100
25366
  * Files - strongly typed entity sub-class
@@ -25210,115 +25476,6 @@ export declare class FileEntity extends BaseEntity<FileEntityType> {
25210
25476
  */
25211
25477
  get Provider(): string;
25212
25478
  }
25213
- /**
25214
- * Flyway _schema _histories - strongly typed entity sub-class
25215
- * * Schema: __mj
25216
- * * Base Table: flyway_schema_history
25217
- * * Base View: vwFlyway_schema_histories
25218
- * * Primary Key: installed_rank
25219
- * @extends {BaseEntity}
25220
- * @class
25221
- * @public
25222
- */
25223
- export declare class flyway_schema_historyEntity extends BaseEntity<flyway_schema_historyEntityType> {
25224
- /**
25225
- * Loads the Flyway _schema _histories record from the database
25226
- * @param installed_rank: number - primary key value to load the Flyway _schema _histories record.
25227
- * @param EntityRelationshipsToLoad - (optional) the relationships to load
25228
- * @returns {Promise<boolean>} - true if successful, false otherwise
25229
- * @public
25230
- * @async
25231
- * @memberof flyway_schema_historyEntity
25232
- * @method
25233
- * @override
25234
- */
25235
- Load(installed_rank: number, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
25236
- /**
25237
- * * Field Name: installed_rank
25238
- * * Display Name: installed _rank
25239
- * * SQL Data Type: int
25240
- */
25241
- get installed_rank(): number;
25242
- set installed_rank(value: number);
25243
- /**
25244
- * * Field Name: version
25245
- * * Display Name: version
25246
- * * SQL Data Type: nvarchar(50)
25247
- */
25248
- get version(): string | null;
25249
- set version(value: string | null);
25250
- /**
25251
- * * Field Name: description
25252
- * * Display Name: description
25253
- * * SQL Data Type: nvarchar(200)
25254
- */
25255
- get description(): string | null;
25256
- set description(value: string | null);
25257
- /**
25258
- * * Field Name: type
25259
- * * Display Name: type
25260
- * * SQL Data Type: nvarchar(20)
25261
- */
25262
- get type(): string;
25263
- set type(value: string);
25264
- /**
25265
- * * Field Name: script
25266
- * * Display Name: script
25267
- * * SQL Data Type: nvarchar(1000)
25268
- */
25269
- get script(): string;
25270
- set script(value: string);
25271
- /**
25272
- * * Field Name: checksum
25273
- * * Display Name: checksum
25274
- * * SQL Data Type: int
25275
- */
25276
- get checksum(): number | null;
25277
- set checksum(value: number | null);
25278
- /**
25279
- * * Field Name: installed_by
25280
- * * Display Name: installed _by
25281
- * * SQL Data Type: nvarchar(100)
25282
- */
25283
- get installed_by(): string;
25284
- set installed_by(value: string);
25285
- /**
25286
- * * Field Name: installed_on
25287
- * * Display Name: installed _on
25288
- * * SQL Data Type: datetime
25289
- * * Default Value: getdate()
25290
- */
25291
- get installed_on(): Date;
25292
- set installed_on(value: Date);
25293
- /**
25294
- * * Field Name: execution_time
25295
- * * Display Name: execution _time
25296
- * * SQL Data Type: int
25297
- */
25298
- get execution_time(): number;
25299
- set execution_time(value: number);
25300
- /**
25301
- * * Field Name: success
25302
- * * Display Name: success
25303
- * * SQL Data Type: bit
25304
- */
25305
- get success(): boolean;
25306
- set success(value: boolean);
25307
- /**
25308
- * * Field Name: __mj_CreatedAt
25309
- * * Display Name: Created At
25310
- * * SQL Data Type: datetimeoffset
25311
- * * Default Value: getutcdate()
25312
- */
25313
- get __mj_CreatedAt(): Date;
25314
- /**
25315
- * * Field Name: __mj_UpdatedAt
25316
- * * Display Name: Updated At
25317
- * * SQL Data Type: datetimeoffset
25318
- * * Default Value: getutcdate()
25319
- */
25320
- get __mj_UpdatedAt(): Date;
25321
- }
25322
25479
  /**
25323
25480
  * Generated Code Categories - strongly typed entity sub-class
25324
25481
  * * Schema: __mj
@@ -32239,6 +32396,397 @@ export declare class AIVendorEntity extends BaseEntity<AIVendorEntityType> {
32239
32396
  */
32240
32397
  get CredentialType(): string | null;
32241
32398
  }
32399
+ /**
32400
+ * MJ: API Key Scopes - strongly typed entity sub-class
32401
+ * * Schema: __mj
32402
+ * * Base Table: APIKeyScope
32403
+ * * Base View: vwAPIKeyScopes
32404
+ * * @description Junction table linking API keys to their assigned permission scopes. Each key can have multiple scopes, and scopes can be shared across multiple keys.
32405
+ * * Primary Key: ID
32406
+ * @extends {BaseEntity}
32407
+ * @class
32408
+ * @public
32409
+ */
32410
+ export declare class APIKeyScopeEntity extends BaseEntity<APIKeyScopeEntityType> {
32411
+ /**
32412
+ * Loads the MJ: API Key Scopes record from the database
32413
+ * @param ID: string - primary key value to load the MJ: API Key Scopes record.
32414
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
32415
+ * @returns {Promise<boolean>} - true if successful, false otherwise
32416
+ * @public
32417
+ * @async
32418
+ * @memberof APIKeyScopeEntity
32419
+ * @method
32420
+ * @override
32421
+ */
32422
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
32423
+ /**
32424
+ * * Field Name: ID
32425
+ * * Display Name: ID
32426
+ * * SQL Data Type: uniqueidentifier
32427
+ * * Default Value: newsequentialid()
32428
+ */
32429
+ get ID(): string;
32430
+ set ID(value: string);
32431
+ /**
32432
+ * * Field Name: APIKeyID
32433
+ * * Display Name: API Key
32434
+ * * SQL Data Type: uniqueidentifier
32435
+ * * Related Entity/Foreign Key: MJ: API Keys (vwAPIKeys.ID)
32436
+ */
32437
+ get APIKeyID(): string;
32438
+ set APIKeyID(value: string);
32439
+ /**
32440
+ * * Field Name: ScopeID
32441
+ * * Display Name: Scope
32442
+ * * SQL Data Type: uniqueidentifier
32443
+ * * Related Entity/Foreign Key: MJ: API Scopes (vwAPIScopes.ID)
32444
+ */
32445
+ get ScopeID(): string;
32446
+ set ScopeID(value: string);
32447
+ /**
32448
+ * * Field Name: __mj_CreatedAt
32449
+ * * Display Name: Created At
32450
+ * * SQL Data Type: datetimeoffset
32451
+ * * Default Value: getutcdate()
32452
+ */
32453
+ get __mj_CreatedAt(): Date;
32454
+ /**
32455
+ * * Field Name: __mj_UpdatedAt
32456
+ * * Display Name: Updated At
32457
+ * * SQL Data Type: datetimeoffset
32458
+ * * Default Value: getutcdate()
32459
+ */
32460
+ get __mj_UpdatedAt(): Date;
32461
+ /**
32462
+ * * Field Name: APIKey
32463
+ * * Display Name: API Key
32464
+ * * SQL Data Type: nvarchar(255)
32465
+ */
32466
+ get APIKey(): string;
32467
+ /**
32468
+ * * Field Name: Scope
32469
+ * * Display Name: Scope Name
32470
+ * * SQL Data Type: nvarchar(100)
32471
+ */
32472
+ get Scope(): string;
32473
+ }
32474
+ /**
32475
+ * MJ: API Key Usage Logs - strongly typed entity sub-class
32476
+ * * Schema: __mj
32477
+ * * Base Table: APIKeyUsageLog
32478
+ * * Base View: vwAPIKeyUsageLogs
32479
+ * * @description Audit log tracking all API key usage for analytics, debugging, and security monitoring. Records each request including endpoint, response status, timing, and client information.
32480
+ * * Primary Key: ID
32481
+ * @extends {BaseEntity}
32482
+ * @class
32483
+ * @public
32484
+ */
32485
+ export declare class APIKeyUsageLogEntity extends BaseEntity<APIKeyUsageLogEntityType> {
32486
+ /**
32487
+ * Loads the MJ: API Key Usage Logs record from the database
32488
+ * @param ID: string - primary key value to load the MJ: API Key Usage Logs record.
32489
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
32490
+ * @returns {Promise<boolean>} - true if successful, false otherwise
32491
+ * @public
32492
+ * @async
32493
+ * @memberof APIKeyUsageLogEntity
32494
+ * @method
32495
+ * @override
32496
+ */
32497
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
32498
+ /**
32499
+ * * Field Name: ID
32500
+ * * Display Name: ID
32501
+ * * SQL Data Type: uniqueidentifier
32502
+ * * Default Value: newsequentialid()
32503
+ */
32504
+ get ID(): string;
32505
+ set ID(value: string);
32506
+ /**
32507
+ * * Field Name: APIKeyID
32508
+ * * Display Name: API Key
32509
+ * * SQL Data Type: uniqueidentifier
32510
+ * * Related Entity/Foreign Key: MJ: API Keys (vwAPIKeys.ID)
32511
+ */
32512
+ get APIKeyID(): string;
32513
+ set APIKeyID(value: string);
32514
+ /**
32515
+ * * Field Name: Endpoint
32516
+ * * Display Name: Endpoint
32517
+ * * SQL Data Type: nvarchar(500)
32518
+ * * Description: The API endpoint path that was accessed (e.g., /mcp, /graphql, /api/v1/entities).
32519
+ */
32520
+ get Endpoint(): string;
32521
+ set Endpoint(value: string);
32522
+ /**
32523
+ * * Field Name: Operation
32524
+ * * Display Name: Operation
32525
+ * * SQL Data Type: nvarchar(255)
32526
+ * * Description: The specific operation performed, such as the GraphQL operation name or MCP tool invoked (e.g., Get_Users_Record, Run_Agent).
32527
+ */
32528
+ get Operation(): string | null;
32529
+ set Operation(value: string | null);
32530
+ /**
32531
+ * * Field Name: Method
32532
+ * * Display Name: Method
32533
+ * * SQL Data Type: nvarchar(10)
32534
+ * * Description: HTTP method used for the request (GET, POST, PUT, DELETE, etc.).
32535
+ */
32536
+ get Method(): string;
32537
+ set Method(value: string);
32538
+ /**
32539
+ * * Field Name: StatusCode
32540
+ * * Display Name: Status Code
32541
+ * * SQL Data Type: int
32542
+ * * Description: HTTP response status code returned to the client (e.g., 200 for success, 401 for unauthorized, 500 for server error).
32543
+ */
32544
+ get StatusCode(): number;
32545
+ set StatusCode(value: number);
32546
+ /**
32547
+ * * Field Name: ResponseTimeMs
32548
+ * * Display Name: Response Time (ms)
32549
+ * * SQL Data Type: int
32550
+ * * Description: Total time in milliseconds to process the request and return a response. Useful for performance monitoring.
32551
+ */
32552
+ get ResponseTimeMs(): number | null;
32553
+ set ResponseTimeMs(value: number | null);
32554
+ /**
32555
+ * * Field Name: IPAddress
32556
+ * * Display Name: IP Address
32557
+ * * SQL Data Type: nvarchar(45)
32558
+ * * Description: Client IP address that made the request. Supports both IPv4 and IPv6 addresses (up to 45 characters).
32559
+ */
32560
+ get IPAddress(): string | null;
32561
+ set IPAddress(value: string | null);
32562
+ /**
32563
+ * * Field Name: UserAgent
32564
+ * * Display Name: User Agent
32565
+ * * SQL Data Type: nvarchar(500)
32566
+ * * Description: User-Agent header from the HTTP request, identifying the client application or library making the API call.
32567
+ */
32568
+ get UserAgent(): string | null;
32569
+ set UserAgent(value: string | null);
32570
+ /**
32571
+ * * Field Name: __mj_CreatedAt
32572
+ * * Display Name: Created At
32573
+ * * SQL Data Type: datetimeoffset
32574
+ * * Default Value: getutcdate()
32575
+ */
32576
+ get __mj_CreatedAt(): Date;
32577
+ /**
32578
+ * * Field Name: __mj_UpdatedAt
32579
+ * * Display Name: Updated At
32580
+ * * SQL Data Type: datetimeoffset
32581
+ * * Default Value: getutcdate()
32582
+ */
32583
+ get __mj_UpdatedAt(): Date;
32584
+ /**
32585
+ * * Field Name: APIKey
32586
+ * * Display Name: API Key
32587
+ * * SQL Data Type: nvarchar(255)
32588
+ */
32589
+ get APIKey(): string;
32590
+ }
32591
+ /**
32592
+ * MJ: API Keys - strongly typed entity sub-class
32593
+ * * Schema: __mj
32594
+ * * Base Table: APIKey
32595
+ * * Base View: vwAPIKeys
32596
+ * * @description Stores API keys for programmatic access to MemberJunction services. Keys are stored as SHA-256 hashes for security. Each key is associated with a user context and can have multiple permission scopes assigned.
32597
+ * * Primary Key: ID
32598
+ * @extends {BaseEntity}
32599
+ * @class
32600
+ * @public
32601
+ */
32602
+ export declare class APIKeyEntity extends BaseEntity<APIKeyEntityType> {
32603
+ /**
32604
+ * Loads the MJ: API Keys record from the database
32605
+ * @param ID: string - primary key value to load the MJ: API Keys record.
32606
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
32607
+ * @returns {Promise<boolean>} - true if successful, false otherwise
32608
+ * @public
32609
+ * @async
32610
+ * @memberof APIKeyEntity
32611
+ * @method
32612
+ * @override
32613
+ */
32614
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
32615
+ /**
32616
+ * * Field Name: ID
32617
+ * * Display Name: ID
32618
+ * * SQL Data Type: uniqueidentifier
32619
+ * * Default Value: newsequentialid()
32620
+ */
32621
+ get ID(): string;
32622
+ set ID(value: string);
32623
+ /**
32624
+ * * Field Name: Hash
32625
+ * * Display Name: Hash
32626
+ * * SQL Data Type: nvarchar(64)
32627
+ * * Description: SHA-256 hash of the raw API key (64 hexadecimal characters). The raw key is only shown once at creation time and cannot be recovered.
32628
+ */
32629
+ get Hash(): string;
32630
+ set Hash(value: string);
32631
+ /**
32632
+ * * Field Name: UserID
32633
+ * * Display Name: User
32634
+ * * SQL Data Type: uniqueidentifier
32635
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
32636
+ */
32637
+ get UserID(): string;
32638
+ set UserID(value: string);
32639
+ /**
32640
+ * * Field Name: Label
32641
+ * * Display Name: Label
32642
+ * * SQL Data Type: nvarchar(255)
32643
+ * * Description: User-friendly name for identifying the key purpose (e.g., Cowork Integration, CI/CD Pipeline, Mobile App).
32644
+ */
32645
+ get Label(): string;
32646
+ set Label(value: string);
32647
+ /**
32648
+ * * Field Name: Description
32649
+ * * Display Name: Description
32650
+ * * SQL Data Type: nvarchar(1000)
32651
+ * * Description: Optional detailed description of the key's intended use, integration details, or other notes.
32652
+ */
32653
+ get Description(): string | null;
32654
+ set Description(value: string | null);
32655
+ /**
32656
+ * * Field Name: Status
32657
+ * * Display Name: Status
32658
+ * * SQL Data Type: nvarchar(20)
32659
+ * * Default Value: Active
32660
+ * * Value List Type: List
32661
+ * * Possible Values
32662
+ * * Active
32663
+ * * Revoked
32664
+ * * Description: Current lifecycle status of the key. Active keys can be used for authentication; Revoked keys are permanently disabled.
32665
+ */
32666
+ get Status(): 'Active' | 'Revoked';
32667
+ set Status(value: 'Active' | 'Revoked');
32668
+ /**
32669
+ * * Field Name: ExpiresAt
32670
+ * * Display Name: Expires At
32671
+ * * SQL Data Type: datetimeoffset
32672
+ * * Description: Optional expiration timestamp. Keys with NULL expiration never expire. Expired keys are rejected during authentication.
32673
+ */
32674
+ get ExpiresAt(): Date | null;
32675
+ set ExpiresAt(value: Date | null);
32676
+ /**
32677
+ * * Field Name: LastUsedAt
32678
+ * * Display Name: Last Used At
32679
+ * * SQL Data Type: datetimeoffset
32680
+ * * Description: Timestamp of the most recent successful authentication using this key. Updated on each valid API request.
32681
+ */
32682
+ get LastUsedAt(): Date | null;
32683
+ set LastUsedAt(value: Date | null);
32684
+ /**
32685
+ * * Field Name: CreatedByUserID
32686
+ * * Display Name: Created By User
32687
+ * * SQL Data Type: uniqueidentifier
32688
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
32689
+ */
32690
+ get CreatedByUserID(): string;
32691
+ set CreatedByUserID(value: string);
32692
+ /**
32693
+ * * Field Name: __mj_CreatedAt
32694
+ * * Display Name: Created At
32695
+ * * SQL Data Type: datetimeoffset
32696
+ * * Default Value: getutcdate()
32697
+ */
32698
+ get __mj_CreatedAt(): Date;
32699
+ /**
32700
+ * * Field Name: __mj_UpdatedAt
32701
+ * * Display Name: Updated At
32702
+ * * SQL Data Type: datetimeoffset
32703
+ * * Default Value: getutcdate()
32704
+ */
32705
+ get __mj_UpdatedAt(): Date;
32706
+ /**
32707
+ * * Field Name: User
32708
+ * * Display Name: User
32709
+ * * SQL Data Type: nvarchar(100)
32710
+ */
32711
+ get User(): string;
32712
+ /**
32713
+ * * Field Name: CreatedByUser
32714
+ * * Display Name: Created By User
32715
+ * * SQL Data Type: nvarchar(100)
32716
+ */
32717
+ get CreatedByUser(): string;
32718
+ }
32719
+ /**
32720
+ * MJ: API Scopes - strongly typed entity sub-class
32721
+ * * Schema: __mj
32722
+ * * Base Table: APIScope
32723
+ * * Base View: vwAPIScopes
32724
+ * * @description Defines reusable permission scopes that can be assigned to API keys. Scopes follow a hierarchical naming convention (e.g., entities:read, agents:execute, admin:*) and are grouped by category for organizational purposes.
32725
+ * * Primary Key: ID
32726
+ * @extends {BaseEntity}
32727
+ * @class
32728
+ * @public
32729
+ */
32730
+ export declare class APIScopeEntity extends BaseEntity<APIScopeEntityType> {
32731
+ /**
32732
+ * Loads the MJ: API Scopes record from the database
32733
+ * @param ID: string - primary key value to load the MJ: API Scopes record.
32734
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
32735
+ * @returns {Promise<boolean>} - true if successful, false otherwise
32736
+ * @public
32737
+ * @async
32738
+ * @memberof APIScopeEntity
32739
+ * @method
32740
+ * @override
32741
+ */
32742
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
32743
+ /**
32744
+ * * Field Name: ID
32745
+ * * Display Name: ID
32746
+ * * SQL Data Type: uniqueidentifier
32747
+ * * Default Value: newsequentialid()
32748
+ */
32749
+ get ID(): string;
32750
+ set ID(value: string);
32751
+ /**
32752
+ * * Field Name: Name
32753
+ * * Display Name: Scope Name
32754
+ * * SQL Data Type: nvarchar(100)
32755
+ * * Description: Unique scope identifier following the pattern category:permission (e.g., entities:read, agents:execute, admin:*). Supports wildcard (*) for broad permissions.
32756
+ */
32757
+ get Name(): string;
32758
+ set Name(value: string);
32759
+ /**
32760
+ * * Field Name: Category
32761
+ * * Display Name: Scope Category
32762
+ * * SQL Data Type: nvarchar(100)
32763
+ * * Description: Grouping category for the scope (e.g., Entities, Agents, Admin). Used for organizing and filtering scopes in the UI.
32764
+ */
32765
+ get Category(): string;
32766
+ set Category(value: string);
32767
+ /**
32768
+ * * Field Name: Description
32769
+ * * Display Name: Description
32770
+ * * SQL Data Type: nvarchar(500)
32771
+ * * Description: Human-readable description explaining what permissions this scope grants.
32772
+ */
32773
+ get Description(): string | null;
32774
+ set Description(value: string | null);
32775
+ /**
32776
+ * * Field Name: __mj_CreatedAt
32777
+ * * Display Name: Created At
32778
+ * * SQL Data Type: datetimeoffset
32779
+ * * Default Value: getutcdate()
32780
+ */
32781
+ get __mj_CreatedAt(): Date;
32782
+ /**
32783
+ * * Field Name: __mj_UpdatedAt
32784
+ * * Display Name: Updated At
32785
+ * * SQL Data Type: datetimeoffset
32786
+ * * Default Value: getutcdate()
32787
+ */
32788
+ get __mj_UpdatedAt(): Date;
32789
+ }
32242
32790
  /**
32243
32791
  * MJ: Artifact Permissions - strongly typed entity sub-class
32244
32792
  * * Schema: __mj
@@ -36218,6 +36766,100 @@ export declare class EnvironmentEntity extends BaseEntity<EnvironmentEntityType>
36218
36766
  */
36219
36767
  get __mj_UpdatedAt(): Date;
36220
36768
  }
36769
+ /**
36770
+ * MJ: File Storage Accounts - strongly typed entity sub-class
36771
+ * * Schema: __mj
36772
+ * * Base Table: FileStorageAccount
36773
+ * * Base View: vwFileStorageAccounts
36774
+ * * @description Enterprise-level file storage accounts. Each account represents a configured connection to a storage provider (e.g., Marketing Dropbox, Engineering Google Drive) with credentials managed centrally.
36775
+ * * Primary Key: ID
36776
+ * @extends {BaseEntity}
36777
+ * @class
36778
+ * @public
36779
+ */
36780
+ export declare class FileStorageAccountEntity extends BaseEntity<FileStorageAccountEntityType> {
36781
+ /**
36782
+ * Loads the MJ: File Storage Accounts record from the database
36783
+ * @param ID: string - primary key value to load the MJ: File Storage Accounts record.
36784
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
36785
+ * @returns {Promise<boolean>} - true if successful, false otherwise
36786
+ * @public
36787
+ * @async
36788
+ * @memberof FileStorageAccountEntity
36789
+ * @method
36790
+ * @override
36791
+ */
36792
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
36793
+ /**
36794
+ * * Field Name: ID
36795
+ * * Display Name: ID
36796
+ * * SQL Data Type: uniqueidentifier
36797
+ * * Default Value: newsequentialid()
36798
+ * * Description: Primary key
36799
+ */
36800
+ get ID(): string;
36801
+ set ID(value: string);
36802
+ /**
36803
+ * * Field Name: Name
36804
+ * * Display Name: Name
36805
+ * * SQL Data Type: nvarchar(200)
36806
+ * * Description: Display name for the storage account (e.g., Marketing Files, Engineering Docs). Must be unique per provider.
36807
+ */
36808
+ get Name(): string;
36809
+ set Name(value: string);
36810
+ /**
36811
+ * * Field Name: Description
36812
+ * * Display Name: Description
36813
+ * * SQL Data Type: nvarchar(MAX)
36814
+ * * Description: Optional description providing additional context about the account purpose or contents.
36815
+ */
36816
+ get Description(): string | null;
36817
+ set Description(value: string | null);
36818
+ /**
36819
+ * * Field Name: ProviderID
36820
+ * * Display Name: Provider
36821
+ * * SQL Data Type: uniqueidentifier
36822
+ * * Related Entity/Foreign Key: File Storage Providers (vwFileStorageProviders.ID)
36823
+ * * Description: Foreign key to FileStorageProvider indicating which storage service this account uses (Dropbox, Google Drive, S3, etc.).
36824
+ */
36825
+ get ProviderID(): string;
36826
+ set ProviderID(value: string);
36827
+ /**
36828
+ * * Field Name: CredentialID
36829
+ * * Display Name: Credential
36830
+ * * SQL Data Type: uniqueidentifier
36831
+ * * Related Entity/Foreign Key: MJ: Credentials (vwCredentials.ID)
36832
+ * * Description: Foreign key to Credential containing the authentication details (OAuth tokens, API keys, etc.) for this account. Credentials are decrypted at runtime by the Credential Engine.
36833
+ */
36834
+ get CredentialID(): string;
36835
+ set CredentialID(value: string);
36836
+ /**
36837
+ * * Field Name: __mj_CreatedAt
36838
+ * * Display Name: Created At
36839
+ * * SQL Data Type: datetimeoffset
36840
+ * * Default Value: getutcdate()
36841
+ */
36842
+ get __mj_CreatedAt(): Date;
36843
+ /**
36844
+ * * Field Name: __mj_UpdatedAt
36845
+ * * Display Name: Updated At
36846
+ * * SQL Data Type: datetimeoffset
36847
+ * * Default Value: getutcdate()
36848
+ */
36849
+ get __mj_UpdatedAt(): Date;
36850
+ /**
36851
+ * * Field Name: Provider
36852
+ * * Display Name: Provider Name
36853
+ * * SQL Data Type: nvarchar(50)
36854
+ */
36855
+ get Provider(): string;
36856
+ /**
36857
+ * * Field Name: Credential
36858
+ * * Display Name: Credential Name
36859
+ * * SQL Data Type: nvarchar(200)
36860
+ */
36861
+ get Credential(): string;
36862
+ }
36221
36863
  /**
36222
36864
  * MJ: List Invitations - strongly typed entity sub-class
36223
36865
  * * Schema: __mj
@@ -39492,6 +40134,268 @@ export declare class TestEntity extends BaseEntity<TestEntityType> {
39492
40134
  */
39493
40135
  get Type(): string;
39494
40136
  }
40137
+ /**
40138
+ * MJ: User Notification Preferences - strongly typed entity sub-class
40139
+ * * Schema: __mj
40140
+ * * Base Table: UserNotificationPreference
40141
+ * * Base View: vwUserNotificationPreferences
40142
+ * * @description Per-user preferences for each notification type (delivery method overrides)
40143
+ * * Primary Key: ID
40144
+ * @extends {BaseEntity}
40145
+ * @class
40146
+ * @public
40147
+ */
40148
+ export declare class UserNotificationPreferenceEntity extends BaseEntity<UserNotificationPreferenceEntityType> {
40149
+ /**
40150
+ * Loads the MJ: User Notification Preferences record from the database
40151
+ * @param ID: string - primary key value to load the MJ: User Notification Preferences record.
40152
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
40153
+ * @returns {Promise<boolean>} - true if successful, false otherwise
40154
+ * @public
40155
+ * @async
40156
+ * @memberof UserNotificationPreferenceEntity
40157
+ * @method
40158
+ * @override
40159
+ */
40160
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
40161
+ /**
40162
+ * * Field Name: ID
40163
+ * * Display Name: ID
40164
+ * * SQL Data Type: uniqueidentifier
40165
+ * * Default Value: newsequentialid()
40166
+ */
40167
+ get ID(): string;
40168
+ set ID(value: string);
40169
+ /**
40170
+ * * Field Name: UserID
40171
+ * * Display Name: User
40172
+ * * SQL Data Type: uniqueidentifier
40173
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
40174
+ */
40175
+ get UserID(): string;
40176
+ set UserID(value: string);
40177
+ /**
40178
+ * * Field Name: NotificationTypeID
40179
+ * * Display Name: Notification Type
40180
+ * * SQL Data Type: uniqueidentifier
40181
+ * * Related Entity/Foreign Key: MJ: User Notification Types (vwUserNotificationTypes.ID)
40182
+ */
40183
+ get NotificationTypeID(): string;
40184
+ set NotificationTypeID(value: string);
40185
+ /**
40186
+ * * Field Name: InAppEnabled
40187
+ * * Display Name: In-App Enabled
40188
+ * * SQL Data Type: bit
40189
+ * * Description: User preference for in-app notifications (NULL = use default)
40190
+ */
40191
+ get InAppEnabled(): boolean | null;
40192
+ set InAppEnabled(value: boolean | null);
40193
+ /**
40194
+ * * Field Name: EmailEnabled
40195
+ * * Display Name: Email Enabled
40196
+ * * SQL Data Type: bit
40197
+ * * Description: User preference for email notifications (NULL = use default)
40198
+ */
40199
+ get EmailEnabled(): boolean | null;
40200
+ set EmailEnabled(value: boolean | null);
40201
+ /**
40202
+ * * Field Name: SMSEnabled
40203
+ * * Display Name: SMS Enabled
40204
+ * * SQL Data Type: bit
40205
+ * * Description: User preference for SMS notifications (NULL = use default)
40206
+ */
40207
+ get SMSEnabled(): boolean | null;
40208
+ set SMSEnabled(value: boolean | null);
40209
+ /**
40210
+ * * Field Name: Enabled
40211
+ * * Display Name: Overall Enabled
40212
+ * * SQL Data Type: bit
40213
+ * * Default Value: 1
40214
+ */
40215
+ get Enabled(): boolean | null;
40216
+ set Enabled(value: boolean | null);
40217
+ /**
40218
+ * * Field Name: __mj_CreatedAt
40219
+ * * Display Name: Created At
40220
+ * * SQL Data Type: datetimeoffset
40221
+ * * Default Value: getutcdate()
40222
+ */
40223
+ get __mj_CreatedAt(): Date;
40224
+ /**
40225
+ * * Field Name: __mj_UpdatedAt
40226
+ * * Display Name: Updated At
40227
+ * * SQL Data Type: datetimeoffset
40228
+ * * Default Value: getutcdate()
40229
+ */
40230
+ get __mj_UpdatedAt(): Date;
40231
+ /**
40232
+ * * Field Name: User
40233
+ * * Display Name: User Name
40234
+ * * SQL Data Type: nvarchar(100)
40235
+ */
40236
+ get User(): string;
40237
+ /**
40238
+ * * Field Name: NotificationType
40239
+ * * Display Name: Notification Type Name
40240
+ * * SQL Data Type: nvarchar(100)
40241
+ */
40242
+ get NotificationType(): string;
40243
+ }
40244
+ /**
40245
+ * MJ: User Notification Types - strongly typed entity sub-class
40246
+ * * Schema: __mj
40247
+ * * Base Table: UserNotificationType
40248
+ * * Base View: vwUserNotificationTypes
40249
+ * * @description Defines categories of notifications with delivery configuration and template associations
40250
+ * * Primary Key: ID
40251
+ * @extends {BaseEntity}
40252
+ * @class
40253
+ * @public
40254
+ */
40255
+ export declare class UserNotificationTypeEntity extends BaseEntity<UserNotificationTypeEntityType> {
40256
+ /**
40257
+ * Loads the MJ: User Notification Types record from the database
40258
+ * @param ID: string - primary key value to load the MJ: User Notification Types record.
40259
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
40260
+ * @returns {Promise<boolean>} - true if successful, false otherwise
40261
+ * @public
40262
+ * @async
40263
+ * @memberof UserNotificationTypeEntity
40264
+ * @method
40265
+ * @override
40266
+ */
40267
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
40268
+ /**
40269
+ * * Field Name: ID
40270
+ * * Display Name: ID
40271
+ * * SQL Data Type: uniqueidentifier
40272
+ * * Default Value: newsequentialid()
40273
+ */
40274
+ get ID(): string;
40275
+ set ID(value: string);
40276
+ /**
40277
+ * * Field Name: Name
40278
+ * * Display Name: Name
40279
+ * * SQL Data Type: nvarchar(100)
40280
+ * * Description: Unique name for the notification type (e.g., 'Agent Completion')
40281
+ */
40282
+ get Name(): string;
40283
+ set Name(value: string);
40284
+ /**
40285
+ * * Field Name: Description
40286
+ * * Display Name: Description
40287
+ * * SQL Data Type: nvarchar(500)
40288
+ */
40289
+ get Description(): string | null;
40290
+ set Description(value: string | null);
40291
+ /**
40292
+ * * Field Name: DefaultInApp
40293
+ * * Display Name: Default In-App
40294
+ * * SQL Data Type: bit
40295
+ * * Default Value: 1
40296
+ * * Description: Whether in-app notifications are enabled by default for this type
40297
+ */
40298
+ get DefaultInApp(): boolean;
40299
+ set DefaultInApp(value: boolean);
40300
+ /**
40301
+ * * Field Name: DefaultEmail
40302
+ * * Display Name: Default Email
40303
+ * * SQL Data Type: bit
40304
+ * * Default Value: 0
40305
+ * * Description: Whether email notifications are enabled by default for this type
40306
+ */
40307
+ get DefaultEmail(): boolean;
40308
+ set DefaultEmail(value: boolean);
40309
+ /**
40310
+ * * Field Name: DefaultSMS
40311
+ * * Display Name: Default SMS
40312
+ * * SQL Data Type: bit
40313
+ * * Default Value: 0
40314
+ * * Description: Whether SMS notifications are enabled by default for this type
40315
+ */
40316
+ get DefaultSMS(): boolean;
40317
+ set DefaultSMS(value: boolean);
40318
+ /**
40319
+ * * Field Name: AllowUserPreference
40320
+ * * Display Name: Allow User Preference
40321
+ * * SQL Data Type: bit
40322
+ * * Default Value: 1
40323
+ * * Description: Whether users can override the default delivery method
40324
+ */
40325
+ get AllowUserPreference(): boolean | null;
40326
+ set AllowUserPreference(value: boolean | null);
40327
+ /**
40328
+ * * Field Name: EmailTemplateID
40329
+ * * Display Name: Email Template
40330
+ * * SQL Data Type: uniqueidentifier
40331
+ * * Related Entity/Foreign Key: Templates (vwTemplates.ID)
40332
+ */
40333
+ get EmailTemplateID(): string | null;
40334
+ set EmailTemplateID(value: string | null);
40335
+ /**
40336
+ * * Field Name: SMSTemplateID
40337
+ * * Display Name: SMS Template
40338
+ * * SQL Data Type: uniqueidentifier
40339
+ * * Related Entity/Foreign Key: Templates (vwTemplates.ID)
40340
+ */
40341
+ get SMSTemplateID(): string | null;
40342
+ set SMSTemplateID(value: string | null);
40343
+ /**
40344
+ * * Field Name: Icon
40345
+ * * Display Name: Icon
40346
+ * * SQL Data Type: nvarchar(100)
40347
+ */
40348
+ get Icon(): string | null;
40349
+ set Icon(value: string | null);
40350
+ /**
40351
+ * * Field Name: Color
40352
+ * * Display Name: Color
40353
+ * * SQL Data Type: nvarchar(50)
40354
+ */
40355
+ get Color(): string | null;
40356
+ set Color(value: string | null);
40357
+ /**
40358
+ * * Field Name: AutoExpireDays
40359
+ * * Display Name: Auto Expire Days
40360
+ * * SQL Data Type: int
40361
+ */
40362
+ get AutoExpireDays(): number | null;
40363
+ set AutoExpireDays(value: number | null);
40364
+ /**
40365
+ * * Field Name: Priority
40366
+ * * Display Name: Priority
40367
+ * * SQL Data Type: int
40368
+ * * Default Value: 0
40369
+ */
40370
+ get Priority(): number | null;
40371
+ set Priority(value: number | null);
40372
+ /**
40373
+ * * Field Name: __mj_CreatedAt
40374
+ * * Display Name: Created At
40375
+ * * SQL Data Type: datetimeoffset
40376
+ * * Default Value: getutcdate()
40377
+ */
40378
+ get __mj_CreatedAt(): Date;
40379
+ /**
40380
+ * * Field Name: __mj_UpdatedAt
40381
+ * * Display Name: Updated At
40382
+ * * SQL Data Type: datetimeoffset
40383
+ * * Default Value: getutcdate()
40384
+ */
40385
+ get __mj_UpdatedAt(): Date;
40386
+ /**
40387
+ * * Field Name: EmailTemplate
40388
+ * * Display Name: Email Template Name
40389
+ * * SQL Data Type: nvarchar(255)
40390
+ */
40391
+ get EmailTemplate(): string | null;
40392
+ /**
40393
+ * * Field Name: SMSTemplate
40394
+ * * Display Name: SMS Template Name
40395
+ * * SQL Data Type: nvarchar(255)
40396
+ */
40397
+ get SMSTemplate(): string | null;
40398
+ }
39495
40399
  /**
39496
40400
  * MJ: User Settings - strongly typed entity sub-class
39497
40401
  * * Schema: __mj
@@ -44313,6 +45217,15 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
44313
45217
  get ResourceRecordID(): string | null;
44314
45218
  set ResourceRecordID(value: string | null);
44315
45219
  /**
45220
+ * * Field Name: NotificationTypeID
45221
+ * * Display Name: Notification Type
45222
+ * * SQL Data Type: uniqueidentifier
45223
+ * * Related Entity/Foreign Key: MJ: User Notification Types (vwUserNotificationTypes.ID)
45224
+ * * Description: Optional reference to notification type for categorization and delivery preferences
45225
+ */
45226
+ get NotificationTypeID(): string | null;
45227
+ set NotificationTypeID(value: string | null);
45228
+ /**
44316
45229
  * * Field Name: User
44317
45230
  * * Display Name: User
44318
45231
  * * SQL Data Type: nvarchar(100)
@@ -44324,6 +45237,12 @@ export declare class UserNotificationEntity extends BaseEntity<UserNotificationE
44324
45237
  * * SQL Data Type: nvarchar(255)
44325
45238
  */
44326
45239
  get ResourceType(): string | null;
45240
+ /**
45241
+ * * Field Name: NotificationType
45242
+ * * Display Name: Notification Type
45243
+ * * SQL Data Type: nvarchar(100)
45244
+ */
45245
+ get NotificationType(): string | null;
44327
45246
  }
44328
45247
  /**
44329
45248
  * User Record Logs - strongly typed entity sub-class