@memberjunction/core-entities 5.8.0 → 5.10.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.
@@ -1461,6 +1461,7 @@ export declare const MJAIAgentRunSchema: z.ZodObject<{
1461
1461
  PrimaryScopeEntityID: z.ZodNullable<z.ZodString>;
1462
1462
  PrimaryScopeRecordID: z.ZodNullable<z.ZodString>;
1463
1463
  SecondaryScopes: z.ZodNullable<z.ZodString>;
1464
+ ExternalReferenceID: z.ZodNullable<z.ZodString>;
1464
1465
  Agent: z.ZodNullable<z.ZodString>;
1465
1466
  ParentRun: z.ZodNullable<z.ZodString>;
1466
1467
  Conversation: z.ZodNullable<z.ZodString>;
@@ -1524,6 +1525,7 @@ export declare const MJAIAgentRunSchema: z.ZodObject<{
1524
1525
  RunName?: string;
1525
1526
  ScheduledJobRunID?: string;
1526
1527
  TestRunID?: string;
1528
+ ExternalReferenceID?: string;
1527
1529
  ParentRun?: string;
1528
1530
  Conversation?: string;
1529
1531
  ConversationDetail?: string;
@@ -1583,6 +1585,7 @@ export declare const MJAIAgentRunSchema: z.ZodObject<{
1583
1585
  RunName?: string;
1584
1586
  ScheduledJobRunID?: string;
1585
1587
  TestRunID?: string;
1588
+ ExternalReferenceID?: string;
1586
1589
  ParentRun?: string;
1587
1590
  Conversation?: string;
1588
1591
  ConversationDetail?: string;
@@ -5022,6 +5025,16 @@ export declare const MJCompanyIntegrationSchema: z.ZodObject<{
5022
5025
  SourceTypeID: z.ZodNullable<z.ZodString>;
5023
5026
  Configuration: z.ZodNullable<z.ZodString>;
5024
5027
  CredentialID: z.ZodNullable<z.ZodString>;
5028
+ ScheduleEnabled: z.ZodBoolean;
5029
+ ScheduleType: z.ZodUnion<[z.ZodLiteral<"Cron">, z.ZodLiteral<"Interval">, z.ZodLiteral<"Manual">]>;
5030
+ ScheduleIntervalMinutes: z.ZodNullable<z.ZodNumber>;
5031
+ CronExpression: z.ZodNullable<z.ZodString>;
5032
+ NextScheduledRunAt: z.ZodNullable<z.ZodDate>;
5033
+ LastScheduledRunAt: z.ZodNullable<z.ZodDate>;
5034
+ IsLocked: z.ZodBoolean;
5035
+ LockedAt: z.ZodNullable<z.ZodDate>;
5036
+ LockedByInstance: z.ZodNullable<z.ZodString>;
5037
+ LockExpiresAt: z.ZodNullable<z.ZodDate>;
5025
5038
  Company: z.ZodString;
5026
5039
  Integration: z.ZodString;
5027
5040
  DriverClassName: z.ZodNullable<z.ZodString>;
@@ -5053,6 +5066,16 @@ export declare const MJCompanyIntegrationSchema: z.ZodObject<{
5053
5066
  ClientSecret?: string;
5054
5067
  CustomAttribute1?: string;
5055
5068
  SourceTypeID?: string;
5069
+ ScheduleEnabled?: boolean;
5070
+ ScheduleType?: "Manual" | "Cron" | "Interval";
5071
+ ScheduleIntervalMinutes?: number;
5072
+ CronExpression?: string;
5073
+ NextScheduledRunAt?: Date;
5074
+ LastScheduledRunAt?: Date;
5075
+ IsLocked?: boolean;
5076
+ LockedAt?: Date;
5077
+ LockedByInstance?: string;
5078
+ LockExpiresAt?: Date;
5056
5079
  DriverClassName?: string;
5057
5080
  LastRunStartedAt?: Date;
5058
5081
  LastRunEndedAt?: Date;
@@ -5080,6 +5103,16 @@ export declare const MJCompanyIntegrationSchema: z.ZodObject<{
5080
5103
  ClientSecret?: string;
5081
5104
  CustomAttribute1?: string;
5082
5105
  SourceTypeID?: string;
5106
+ ScheduleEnabled?: boolean;
5107
+ ScheduleType?: "Manual" | "Cron" | "Interval";
5108
+ ScheduleIntervalMinutes?: number;
5109
+ CronExpression?: string;
5110
+ NextScheduledRunAt?: Date;
5111
+ LastScheduledRunAt?: Date;
5112
+ IsLocked?: boolean;
5113
+ LockedAt?: Date;
5114
+ LockedByInstance?: string;
5115
+ LockExpiresAt?: Date;
5083
5116
  DriverClassName?: string;
5084
5117
  LastRunStartedAt?: Date;
5085
5118
  LastRunEndedAt?: Date;
@@ -8774,6 +8807,157 @@ export declare const MJGeneratedCodeSchema: z.ZodObject<{
8774
8807
  GeneratedByModel?: string;
8775
8808
  }>;
8776
8809
  export type MJGeneratedCodeEntityType = z.infer<typeof MJGeneratedCodeSchema>;
8810
+ /**
8811
+ * zod schema definition for the entity MJ: Integration Object Fields
8812
+ */
8813
+ export declare const MJIntegrationObjectFieldSchema: z.ZodObject<{
8814
+ ID: z.ZodString;
8815
+ IntegrationObjectID: z.ZodString;
8816
+ Name: z.ZodString;
8817
+ DisplayName: z.ZodNullable<z.ZodString>;
8818
+ Description: z.ZodNullable<z.ZodString>;
8819
+ Category: z.ZodNullable<z.ZodString>;
8820
+ Type: z.ZodString;
8821
+ Length: z.ZodNullable<z.ZodNumber>;
8822
+ Precision: z.ZodNullable<z.ZodNumber>;
8823
+ Scale: z.ZodNullable<z.ZodNumber>;
8824
+ AllowsNull: z.ZodBoolean;
8825
+ DefaultValue: z.ZodNullable<z.ZodString>;
8826
+ IsPrimaryKey: z.ZodBoolean;
8827
+ IsUniqueKey: z.ZodBoolean;
8828
+ IsReadOnly: z.ZodBoolean;
8829
+ IsRequired: z.ZodBoolean;
8830
+ RelatedIntegrationObjectID: z.ZodNullable<z.ZodString>;
8831
+ RelatedIntegrationObjectFieldName: z.ZodNullable<z.ZodString>;
8832
+ Sequence: z.ZodNumber;
8833
+ Configuration: z.ZodNullable<z.ZodString>;
8834
+ Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Deprecated">, z.ZodLiteral<"Disabled">]>;
8835
+ __mj_CreatedAt: z.ZodDate;
8836
+ __mj_UpdatedAt: z.ZodDate;
8837
+ IntegrationObject: z.ZodString;
8838
+ RelatedIntegrationObject: z.ZodNullable<z.ZodString>;
8839
+ }, "strip", z.ZodTypeAny, {
8840
+ ID?: string;
8841
+ __mj_CreatedAt?: Date;
8842
+ __mj_UpdatedAt?: Date;
8843
+ Name?: string;
8844
+ Description?: string;
8845
+ Status?: "Active" | "Disabled" | "Deprecated";
8846
+ DefaultValue?: string;
8847
+ Type?: string;
8848
+ IsRequired?: boolean;
8849
+ Category?: string;
8850
+ Sequence?: number;
8851
+ DisplayName?: string;
8852
+ Configuration?: string;
8853
+ IsPrimaryKey?: boolean;
8854
+ Length?: number;
8855
+ Precision?: number;
8856
+ Scale?: number;
8857
+ AllowsNull?: boolean;
8858
+ IntegrationObjectID?: string;
8859
+ IsUniqueKey?: boolean;
8860
+ IsReadOnly?: boolean;
8861
+ RelatedIntegrationObjectID?: string;
8862
+ RelatedIntegrationObjectFieldName?: string;
8863
+ IntegrationObject?: string;
8864
+ RelatedIntegrationObject?: string;
8865
+ }, {
8866
+ ID?: string;
8867
+ __mj_CreatedAt?: Date;
8868
+ __mj_UpdatedAt?: Date;
8869
+ Name?: string;
8870
+ Description?: string;
8871
+ Status?: "Active" | "Disabled" | "Deprecated";
8872
+ DefaultValue?: string;
8873
+ Type?: string;
8874
+ IsRequired?: boolean;
8875
+ Category?: string;
8876
+ Sequence?: number;
8877
+ DisplayName?: string;
8878
+ Configuration?: string;
8879
+ IsPrimaryKey?: boolean;
8880
+ Length?: number;
8881
+ Precision?: number;
8882
+ Scale?: number;
8883
+ AllowsNull?: boolean;
8884
+ IntegrationObjectID?: string;
8885
+ IsUniqueKey?: boolean;
8886
+ IsReadOnly?: boolean;
8887
+ RelatedIntegrationObjectID?: string;
8888
+ RelatedIntegrationObjectFieldName?: string;
8889
+ IntegrationObject?: string;
8890
+ RelatedIntegrationObject?: string;
8891
+ }>;
8892
+ export type MJIntegrationObjectFieldEntityType = z.infer<typeof MJIntegrationObjectFieldSchema>;
8893
+ /**
8894
+ * zod schema definition for the entity MJ: Integration Objects
8895
+ */
8896
+ export declare const MJIntegrationObjectSchema: z.ZodObject<{
8897
+ ID: z.ZodString;
8898
+ IntegrationID: z.ZodString;
8899
+ Name: z.ZodString;
8900
+ DisplayName: z.ZodNullable<z.ZodString>;
8901
+ Description: z.ZodNullable<z.ZodString>;
8902
+ Category: z.ZodNullable<z.ZodString>;
8903
+ APIPath: z.ZodString;
8904
+ ResponseDataKey: z.ZodNullable<z.ZodString>;
8905
+ DefaultPageSize: z.ZodNumber;
8906
+ SupportsPagination: z.ZodBoolean;
8907
+ PaginationType: z.ZodUnion<[z.ZodLiteral<"Cursor">, z.ZodLiteral<"None">, z.ZodLiteral<"Offset">, z.ZodLiteral<"PageNumber">]>;
8908
+ SupportsIncrementalSync: z.ZodBoolean;
8909
+ SupportsWrite: z.ZodBoolean;
8910
+ DefaultQueryParams: z.ZodNullable<z.ZodString>;
8911
+ Configuration: z.ZodNullable<z.ZodString>;
8912
+ Sequence: z.ZodNumber;
8913
+ Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Deprecated">, z.ZodLiteral<"Disabled">]>;
8914
+ __mj_CreatedAt: z.ZodDate;
8915
+ __mj_UpdatedAt: z.ZodDate;
8916
+ Integration: z.ZodString;
8917
+ }, "strip", z.ZodTypeAny, {
8918
+ ID?: string;
8919
+ __mj_CreatedAt?: Date;
8920
+ __mj_UpdatedAt?: Date;
8921
+ Name?: string;
8922
+ Description?: string;
8923
+ Status?: "Active" | "Disabled" | "Deprecated";
8924
+ Category?: string;
8925
+ Sequence?: number;
8926
+ DisplayName?: string;
8927
+ Configuration?: string;
8928
+ Integration?: string;
8929
+ IntegrationID?: string;
8930
+ APIPath?: string;
8931
+ ResponseDataKey?: string;
8932
+ DefaultPageSize?: number;
8933
+ SupportsPagination?: boolean;
8934
+ PaginationType?: "None" | "Cursor" | "Offset" | "PageNumber";
8935
+ SupportsIncrementalSync?: boolean;
8936
+ SupportsWrite?: boolean;
8937
+ DefaultQueryParams?: string;
8938
+ }, {
8939
+ ID?: string;
8940
+ __mj_CreatedAt?: Date;
8941
+ __mj_UpdatedAt?: Date;
8942
+ Name?: string;
8943
+ Description?: string;
8944
+ Status?: "Active" | "Disabled" | "Deprecated";
8945
+ Category?: string;
8946
+ Sequence?: number;
8947
+ DisplayName?: string;
8948
+ Configuration?: string;
8949
+ Integration?: string;
8950
+ IntegrationID?: string;
8951
+ APIPath?: string;
8952
+ ResponseDataKey?: string;
8953
+ DefaultPageSize?: number;
8954
+ SupportsPagination?: boolean;
8955
+ PaginationType?: "None" | "Cursor" | "Offset" | "PageNumber";
8956
+ SupportsIncrementalSync?: boolean;
8957
+ SupportsWrite?: boolean;
8958
+ DefaultQueryParams?: string;
8959
+ }>;
8960
+ export type MJIntegrationObjectEntityType = z.infer<typeof MJIntegrationObjectSchema>;
8777
8961
  /**
8778
8962
  * zod schema definition for the entity MJ: Integration Source Types
8779
8963
  */
@@ -11615,6 +11799,8 @@ export declare const MJScheduledJobSchema: z.ZodObject<{
11615
11799
  OwnerUserID?: string;
11616
11800
  OwnerUser?: string;
11617
11801
  CronExpression?: string;
11802
+ LockedAt?: Date;
11803
+ LockedByInstance?: string;
11618
11804
  Timezone?: string;
11619
11805
  JobTypeID?: string;
11620
11806
  StartAt?: Date;
@@ -11630,8 +11816,6 @@ export declare const MJScheduledJobSchema: z.ZodObject<{
11630
11816
  NotifyViaEmail?: boolean;
11631
11817
  NotifyViaInApp?: boolean;
11632
11818
  LockToken?: string;
11633
- LockedAt?: Date;
11634
- LockedByInstance?: string;
11635
11819
  ExpectedCompletionAt?: Date;
11636
11820
  ConcurrencyMode?: "Queue" | "Concurrent" | "Skip";
11637
11821
  JobType?: string;
@@ -11647,6 +11831,8 @@ export declare const MJScheduledJobSchema: z.ZodObject<{
11647
11831
  OwnerUserID?: string;
11648
11832
  OwnerUser?: string;
11649
11833
  CronExpression?: string;
11834
+ LockedAt?: Date;
11835
+ LockedByInstance?: string;
11650
11836
  Timezone?: string;
11651
11837
  JobTypeID?: string;
11652
11838
  StartAt?: Date;
@@ -11662,8 +11848,6 @@ export declare const MJScheduledJobSchema: z.ZodObject<{
11662
11848
  NotifyViaEmail?: boolean;
11663
11849
  NotifyViaInApp?: boolean;
11664
11850
  LockToken?: string;
11665
- LockedAt?: Date;
11666
- LockedByInstance?: string;
11667
11851
  ExpectedCompletionAt?: Date;
11668
11852
  ConcurrencyMode?: "Queue" | "Concurrent" | "Skip";
11669
11853
  JobType?: string;
@@ -17761,7 +17945,7 @@ export declare class MJAIAgentRunStepEntity extends BaseEntity<MJAIAgentRunStepE
17761
17945
  Delete(options?: EntityDeleteOptions): Promise<boolean>;
17762
17946
  /**
17763
17947
  * Validate() method override for MJ: AI Agent Run Steps entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
17764
- * * FinalPayloadValidationResult: The FinalPayloadValidationResult field can be empty, but if a value is set it must be one of the allowed outcomes: Warn, Fail, Retry, or Pass. This ensures that only valid validation results are stored.
17948
+ * * FinalPayloadValidationResult: The final payload validation result must be one of the approved statuses: Warn, Fail, Retry, or Pass, to ensure consistent reporting of validation outcomes.
17765
17949
  * * StepNumber: This rule ensures that the step number must be greater than zero.
17766
17950
  * @public
17767
17951
  * @method
@@ -17769,12 +17953,12 @@ export declare class MJAIAgentRunStepEntity extends BaseEntity<MJAIAgentRunStepE
17769
17953
  */
17770
17954
  Validate(): ValidationResult;
17771
17955
  /**
17772
- * The FinalPayloadValidationResult field can be empty, but if a value is set it must be one of the allowed outcomes: Warn, Fail, Retry, or Pass. This ensures that only valid validation results are stored.
17956
+ * The final payload validation result must be one of the approved statuses: Warn, Fail, Retry, or Pass, to ensure consistent reporting of validation outcomes.
17773
17957
  * @param result - the ValidationResult object to add any errors or warnings to
17774
17958
  * @public
17775
17959
  * @method
17776
17960
  */
17777
- ValidateFinalPayloadValidationResultAllowedValues(result: ValidationResult): void;
17961
+ ValidateFinalPayloadValidationResultStatus(result: ValidationResult): void;
17778
17962
  /**
17779
17963
  * This rule ensures that the step number must be greater than zero.
17780
17964
  * @param result - the ValidationResult object to add any errors or warnings to
@@ -18087,7 +18271,7 @@ export declare class MJAIAgentRunEntity extends BaseEntity<MJAIAgentRunEntityTyp
18087
18271
  set AgentID(value: string);
18088
18272
  /**
18089
18273
  * * Field Name: ParentRunID
18090
- * * Display Name: Parent Run ID
18274
+ * * Display Name: Parent Run
18091
18275
  * * SQL Data Type: uniqueidentifier
18092
18276
  * * Related Entity/Foreign Key: MJ: AI Agent Runs (vwAIAgentRuns.ID)
18093
18277
  * * Description: Reference to the parent agent run if this is a sub-agent execution. NULL for root-level agent runs. Enables hierarchical execution tracking.
@@ -18228,7 +18412,7 @@ export declare class MJAIAgentRunEntity extends BaseEntity<MJAIAgentRunEntityTyp
18228
18412
  set TotalCompletionTokensUsed(value: number | null);
18229
18413
  /**
18230
18414
  * * Field Name: TotalTokensUsedRollup
18231
- * * Display Name: Total Tokens Used Rollup
18415
+ * * Display Name: Total Tokens Used (Rollup)
18232
18416
  * * SQL Data Type: int
18233
18417
  * * Description: Total tokens used including this agent run and all sub-agent runs. For leaf agents (no sub-agents), this equals TotalTokensUsed. For parent agents, this includes the sum of all descendant agent tokens. Calculated as TotalPromptTokensUsedRollup + TotalCompletionTokensUsedRollup.
18234
18418
  */
@@ -18236,7 +18420,7 @@ export declare class MJAIAgentRunEntity extends BaseEntity<MJAIAgentRunEntityTyp
18236
18420
  set TotalTokensUsedRollup(value: number | null);
18237
18421
  /**
18238
18422
  * * Field Name: TotalPromptTokensUsedRollup
18239
- * * Display Name: Total Prompt Tokens Used Rollup
18423
+ * * Display Name: Total Prompt Tokens Used (Rollup)
18240
18424
  * * SQL Data Type: int
18241
18425
  * * Description: Total prompt/input tokens including this agent run and all sub-agent runs. For leaf agents (no sub-agents), this equals TotalPromptTokensUsed. For parent agents, this includes the sum of all descendant agent prompt tokens.
18242
18426
  */
@@ -18244,7 +18428,7 @@ export declare class MJAIAgentRunEntity extends BaseEntity<MJAIAgentRunEntityTyp
18244
18428
  set TotalPromptTokensUsedRollup(value: number | null);
18245
18429
  /**
18246
18430
  * * Field Name: TotalCompletionTokensUsedRollup
18247
- * * Display Name: Total Completion Tokens Used Rollup
18431
+ * * Display Name: Total Completion Tokens Used (Rollup)
18248
18432
  * * SQL Data Type: int
18249
18433
  * * Description: Total completion/output tokens including this agent run and all sub-agent runs. For leaf agents (no sub-agents), this equals TotalCompletionTokensUsed. For parent agents, this includes the sum of all descendant agent completion tokens.
18250
18434
  */
@@ -18252,7 +18436,7 @@ export declare class MJAIAgentRunEntity extends BaseEntity<MJAIAgentRunEntityTyp
18252
18436
  set TotalCompletionTokensUsedRollup(value: number | null);
18253
18437
  /**
18254
18438
  * * Field Name: TotalCostRollup
18255
- * * Display Name: Total Cost Rollup
18439
+ * * Display Name: Total Cost (Rollup)
18256
18440
  * * SQL Data Type: decimal(19, 8)
18257
18441
  * * Description: Total cost including this agent run and all sub-agent runs. For leaf agents (no sub-agents), this equals TotalCost. For parent agents, this includes the sum of all descendant agent costs. Note: This assumes all costs are in the same currency for accurate rollup.
18258
18442
  */
@@ -18260,7 +18444,7 @@ export declare class MJAIAgentRunEntity extends BaseEntity<MJAIAgentRunEntityTyp
18260
18444
  set TotalCostRollup(value: number | null);
18261
18445
  /**
18262
18446
  * * Field Name: ConversationDetailID
18263
- * * Display Name: Conversation Detail ID
18447
+ * * Display Name: Conversation Detail
18264
18448
  * * SQL Data Type: uniqueidentifier
18265
18449
  * * Related Entity/Foreign Key: MJ: Conversation Details (vwConversationDetails.ID)
18266
18450
  * * Description: Optional tracking of a specific conversation detail (e.g. a specific message) that spawned this agent run
@@ -18324,7 +18508,7 @@ export declare class MJAIAgentRunEntity extends BaseEntity<MJAIAgentRunEntityTyp
18324
18508
  set Message(value: string | null);
18325
18509
  /**
18326
18510
  * * Field Name: LastRunID
18327
- * * Display Name: Last Run ID
18511
+ * * Display Name: Last Run
18328
18512
  * * SQL Data Type: uniqueidentifier
18329
18513
  * * Related Entity/Foreign Key: MJ: AI Agent Runs (vwAIAgentRuns.ID)
18330
18514
  * * Description: Links to the previous run in a chain. Different from ParentRunID which is for sub-agent hierarchy.
@@ -18351,7 +18535,7 @@ each time the agent processes a prompt step.
18351
18535
  set TotalPromptIterations(value: number);
18352
18536
  /**
18353
18537
  * * Field Name: ConfigurationID
18354
- * * Display Name: Configuration ID
18538
+ * * Display Name: Configuration
18355
18539
  * * SQL Data Type: uniqueidentifier
18356
18540
  * * Related Entity/Foreign Key: MJ: AI Configurations (vwAIConfigurations.ID)
18357
18541
  * * Description: The AI Configuration used for this agent execution. When set, this configuration was used for all prompts executed by this agent and its sub-agents.
@@ -18360,7 +18544,7 @@ each time the agent processes a prompt step.
18360
18544
  set ConfigurationID(value: string | null);
18361
18545
  /**
18362
18546
  * * Field Name: OverrideModelID
18363
- * * Display Name: Override Model ID
18547
+ * * Display Name: Override Model
18364
18548
  * * SQL Data Type: uniqueidentifier
18365
18549
  * * Related Entity/Foreign Key: MJ: AI Models (vwAIModels.ID)
18366
18550
  * * Description: Runtime model override that was used for this execution. When set, this model took precedence over all other model selection methods.
@@ -18369,7 +18553,7 @@ each time the agent processes a prompt step.
18369
18553
  set OverrideModelID(value: string | null);
18370
18554
  /**
18371
18555
  * * Field Name: OverrideVendorID
18372
- * * Display Name: Override Vendor ID
18556
+ * * Display Name: Override Vendor
18373
18557
  * * SQL Data Type: uniqueidentifier
18374
18558
  * * Related Entity/Foreign Key: MJ: AI Vendors (vwAIVendors.ID)
18375
18559
  * * Description: Runtime vendor override that was used for this execution. When set along with OverrideModelID, this vendor was used to provide the model.
@@ -18386,7 +18570,7 @@ each time the agent processes a prompt step.
18386
18570
  set Data(value: string | null);
18387
18571
  /**
18388
18572
  * * Field Name: Verbose
18389
- * * Display Name: Verbose
18573
+ * * Display Name: Verbose Logging
18390
18574
  * * SQL Data Type: bit
18391
18575
  * * Default Value: 0
18392
18576
  * * Description: Indicates whether verbose logging was enabled during this agent execution. When true, detailed decision-making and execution flow was logged.
@@ -18419,7 +18603,7 @@ each time the agent processes a prompt step.
18419
18603
  set Comments(value: string | null);
18420
18604
  /**
18421
18605
  * * Field Name: ScheduledJobRunID
18422
- * * Display Name: Scheduled Job Run ID
18606
+ * * Display Name: Scheduled Job Run
18423
18607
  * * SQL Data Type: uniqueidentifier
18424
18608
  * * Related Entity/Foreign Key: MJ: Scheduled Job Runs (vwScheduledJobRuns.ID)
18425
18609
  * * Description: Links to the scheduled job run that triggered this agent execution. NULL for manually-triggered agent runs. Enables tracking which scheduled jobs spawned which agent executions.
@@ -18428,7 +18612,7 @@ each time the agent processes a prompt step.
18428
18612
  set ScheduledJobRunID(value: string | null);
18429
18613
  /**
18430
18614
  * * Field Name: TestRunID
18431
- * * Display Name: Test Run ID
18615
+ * * Display Name: Test Run
18432
18616
  * * SQL Data Type: uniqueidentifier
18433
18617
  * * Related Entity/Foreign Key: MJ: Test Runs (vwTestRuns.ID)
18434
18618
  * * Description: Optional Foreign Key - Links this agent run to a test run if this execution was part of a test. Allows navigation from agent execution to test context.
@@ -18437,7 +18621,7 @@ each time the agent processes a prompt step.
18437
18621
  set TestRunID(value: string | null);
18438
18622
  /**
18439
18623
  * * Field Name: PrimaryScopeEntityID
18440
- * * Display Name: Primary Scope Entity ID
18624
+ * * Display Name: Primary Scope Entity
18441
18625
  * * SQL Data Type: uniqueidentifier
18442
18626
  * * Related Entity/Foreign Key: MJ: Entities (vwEntities.ID)
18443
18627
  * * Description: Foreign key to Entity table identifying which entity type is used for primary scoping (e.g., Organizations, Tenants)
@@ -18446,7 +18630,7 @@ each time the agent processes a prompt step.
18446
18630
  set PrimaryScopeEntityID(value: string | null);
18447
18631
  /**
18448
18632
  * * Field Name: PrimaryScopeRecordID
18449
- * * Display Name: Primary Scope Record ID
18633
+ * * Display Name: Primary Scope Record
18450
18634
  * * SQL Data Type: nvarchar(100)
18451
18635
  * * Description: The record ID within the primary scope entity (e.g., the specific OrganizationID). Indexed for fast multi-tenant filtering.
18452
18636
  */
@@ -18461,86 +18645,94 @@ each time the agent processes a prompt step.
18461
18645
  get SecondaryScopes(): string | null;
18462
18646
  set SecondaryScopes(value: string | null);
18463
18647
  /**
18648
+ * * Field Name: ExternalReferenceID
18649
+ * * Display Name: External Reference ID
18650
+ * * SQL Data Type: nvarchar(200)
18651
+ * * Description: Optional reference ID from an external system that initiated this agent run. Enables correlation between the caller's agent run and this execution. For example, when Skip SaaS is called via SkipProxyAgent, this stores the MJ-side Agent Run ID.
18652
+ */
18653
+ get ExternalReferenceID(): string | null;
18654
+ set ExternalReferenceID(value: string | null);
18655
+ /**
18464
18656
  * * Field Name: Agent
18465
- * * Display Name: Agent
18657
+ * * Display Name: Agent Name
18466
18658
  * * SQL Data Type: nvarchar(255)
18467
18659
  */
18468
18660
  get Agent(): string | null;
18469
18661
  /**
18470
18662
  * * Field Name: ParentRun
18471
- * * Display Name: Parent Run
18663
+ * * Display Name: Parent Run Name
18472
18664
  * * SQL Data Type: nvarchar(255)
18473
18665
  */
18474
18666
  get ParentRun(): string | null;
18475
18667
  /**
18476
18668
  * * Field Name: Conversation
18477
- * * Display Name: Conversation
18669
+ * * Display Name: Conversation Name
18478
18670
  * * SQL Data Type: nvarchar(255)
18479
18671
  */
18480
18672
  get Conversation(): string | null;
18481
18673
  /**
18482
18674
  * * Field Name: User
18483
- * * Display Name: User
18675
+ * * Display Name: User Name
18484
18676
  * * SQL Data Type: nvarchar(100)
18485
18677
  */
18486
18678
  get User(): string | null;
18487
18679
  /**
18488
18680
  * * Field Name: ConversationDetail
18489
- * * Display Name: Conversation Detail
18681
+ * * Display Name: Conversation Detail Name
18490
18682
  * * SQL Data Type: nvarchar(MAX)
18491
18683
  */
18492
18684
  get ConversationDetail(): string | null;
18493
18685
  /**
18494
18686
  * * Field Name: LastRun
18495
- * * Display Name: Last Run
18687
+ * * Display Name: Last Run Name
18496
18688
  * * SQL Data Type: nvarchar(255)
18497
18689
  */
18498
18690
  get LastRun(): string | null;
18499
18691
  /**
18500
18692
  * * Field Name: Configuration
18501
- * * Display Name: Configuration
18693
+ * * Display Name: Configuration Name
18502
18694
  * * SQL Data Type: nvarchar(100)
18503
18695
  */
18504
18696
  get Configuration(): string | null;
18505
18697
  /**
18506
18698
  * * Field Name: OverrideModel
18507
- * * Display Name: Override Model
18699
+ * * Display Name: Override Model Name
18508
18700
  * * SQL Data Type: nvarchar(50)
18509
18701
  */
18510
18702
  get OverrideModel(): string | null;
18511
18703
  /**
18512
18704
  * * Field Name: OverrideVendor
18513
- * * Display Name: Override Vendor
18705
+ * * Display Name: Override Vendor Name
18514
18706
  * * SQL Data Type: nvarchar(50)
18515
18707
  */
18516
18708
  get OverrideVendor(): string | null;
18517
18709
  /**
18518
18710
  * * Field Name: ScheduledJobRun
18519
- * * Display Name: Scheduled Job Run
18711
+ * * Display Name: Scheduled Job Run Name
18520
18712
  * * SQL Data Type: nvarchar(200)
18521
18713
  */
18522
18714
  get ScheduledJobRun(): string | null;
18523
18715
  /**
18524
18716
  * * Field Name: TestRun
18525
- * * Display Name: Test Run
18717
+ * * Display Name: Test Run Name
18526
18718
  * * SQL Data Type: nvarchar(255)
18527
18719
  */
18528
18720
  get TestRun(): string | null;
18529
18721
  /**
18530
18722
  * * Field Name: PrimaryScopeEntity
18531
- * * Display Name: Primary Scope Entity
18723
+ * * Display Name: Primary Scope Entity Name
18532
18724
  * * SQL Data Type: nvarchar(255)
18533
18725
  */
18534
18726
  get PrimaryScopeEntity(): string | null;
18535
18727
  /**
18536
18728
  * * Field Name: RootParentRunID
18537
- * * Display Name: Root Parent Run ID
18729
+ * * Display Name: Root Parent Run
18538
18730
  * * SQL Data Type: uniqueidentifier
18539
18731
  */
18540
18732
  get RootParentRunID(): string | null;
18541
18733
  /**
18542
18734
  * * Field Name: RootLastRunID
18543
- * * Display Name: Root Last Run ID
18735
+ * * Display Name: Root Last Run
18544
18736
  * * SQL Data Type: uniqueidentifier
18545
18737
  */
18546
18738
  get RootLastRunID(): string | null;
@@ -28540,7 +28732,7 @@ export declare class MJCompanyIntegrationEntity extends BaseEntity<MJCompanyInte
28540
28732
  set IntegrationID(value: string);
28541
28733
  /**
28542
28734
  * * Field Name: IsActive
28543
- * * Display Name: Active
28735
+ * * Display Name: Is Active
28544
28736
  * * SQL Data Type: bit
28545
28737
  * * Description: Controls whether this integration is currently active for the company.
28546
28738
  */
@@ -28668,14 +28860,102 @@ export declare class MJCompanyIntegrationEntity extends BaseEntity<MJCompanyInte
28668
28860
  get CredentialID(): string | null;
28669
28861
  set CredentialID(value: string | null);
28670
28862
  /**
28863
+ * * Field Name: ScheduleEnabled
28864
+ * * Display Name: Schedule Enabled
28865
+ * * SQL Data Type: bit
28866
+ * * Default Value: 0
28867
+ * * Description: Whether automatic sync scheduling is enabled for this integration
28868
+ */
28869
+ get ScheduleEnabled(): boolean;
28870
+ set ScheduleEnabled(value: boolean);
28871
+ /**
28872
+ * * Field Name: ScheduleType
28873
+ * * Display Name: Schedule Type
28874
+ * * SQL Data Type: nvarchar(20)
28875
+ * * Default Value: Manual
28876
+ * * Value List Type: List
28877
+ * * Possible Values
28878
+ * * Cron
28879
+ * * Interval
28880
+ * * Manual
28881
+ * * Description: Type of schedule: Manual (no auto-sync), Interval (every N minutes), Cron (cron expression)
28882
+ */
28883
+ get ScheduleType(): 'Cron' | 'Interval' | 'Manual';
28884
+ set ScheduleType(value: 'Cron' | 'Interval' | 'Manual');
28885
+ /**
28886
+ * * Field Name: ScheduleIntervalMinutes
28887
+ * * Display Name: Schedule Interval (Minutes)
28888
+ * * SQL Data Type: int
28889
+ * * Description: Interval in minutes for Interval schedule type
28890
+ */
28891
+ get ScheduleIntervalMinutes(): number | null;
28892
+ set ScheduleIntervalMinutes(value: number | null);
28893
+ /**
28894
+ * * Field Name: CronExpression
28895
+ * * Display Name: Cron Expression
28896
+ * * SQL Data Type: nvarchar(200)
28897
+ * * Description: Cron expression for Cron schedule type (e.g., "0 *\/6 * * *" for every 6 hours)
28898
+ */
28899
+ get CronExpression(): string | null;
28900
+ set CronExpression(value: string | null);
28901
+ /**
28902
+ * * Field Name: NextScheduledRunAt
28903
+ * * Display Name: Next Scheduled Run
28904
+ * * SQL Data Type: datetimeoffset
28905
+ * * Description: When the next scheduled sync should run. Updated after each run based on schedule config.
28906
+ */
28907
+ get NextScheduledRunAt(): Date | null;
28908
+ set NextScheduledRunAt(value: Date | null);
28909
+ /**
28910
+ * * Field Name: LastScheduledRunAt
28911
+ * * Display Name: Last Scheduled Run
28912
+ * * SQL Data Type: datetimeoffset
28913
+ * * Description: When the last scheduled sync was initiated
28914
+ */
28915
+ get LastScheduledRunAt(): Date | null;
28916
+ set LastScheduledRunAt(value: Date | null);
28917
+ /**
28918
+ * * Field Name: IsLocked
28919
+ * * Display Name: Is Locked
28920
+ * * SQL Data Type: bit
28921
+ * * Default Value: 0
28922
+ * * Description: Whether a sync is currently locked/running for this integration
28923
+ */
28924
+ get IsLocked(): boolean;
28925
+ set IsLocked(value: boolean);
28926
+ /**
28927
+ * * Field Name: LockedAt
28928
+ * * Display Name: Locked At
28929
+ * * SQL Data Type: datetimeoffset
28930
+ * * Description: When the lock was acquired
28931
+ */
28932
+ get LockedAt(): Date | null;
28933
+ set LockedAt(value: Date | null);
28934
+ /**
28935
+ * * Field Name: LockedByInstance
28936
+ * * Display Name: Locked By Instance
28937
+ * * SQL Data Type: nvarchar(200)
28938
+ * * Description: Server instance identifier that holds the lock (hostname-pid)
28939
+ */
28940
+ get LockedByInstance(): string | null;
28941
+ set LockedByInstance(value: string | null);
28942
+ /**
28943
+ * * Field Name: LockExpiresAt
28944
+ * * Display Name: Lock Expires At
28945
+ * * SQL Data Type: datetimeoffset
28946
+ * * Description: When the lock should be considered stale and eligible for cleanup
28947
+ */
28948
+ get LockExpiresAt(): Date | null;
28949
+ set LockExpiresAt(value: Date | null);
28950
+ /**
28671
28951
  * * Field Name: Company
28672
- * * Display Name: Company Name
28952
+ * * Display Name: Company
28673
28953
  * * SQL Data Type: nvarchar(50)
28674
28954
  */
28675
28955
  get Company(): string;
28676
28956
  /**
28677
28957
  * * Field Name: Integration
28678
- * * Display Name: Integration Name
28958
+ * * Display Name: Integration
28679
28959
  * * SQL Data Type: nvarchar(100)
28680
28960
  */
28681
28961
  get Integration(): string;
@@ -28693,7 +28973,7 @@ export declare class MJCompanyIntegrationEntity extends BaseEntity<MJCompanyInte
28693
28973
  get DriverImportPath(): string | null;
28694
28974
  /**
28695
28975
  * * Field Name: LastRunID
28696
- * * Display Name: Last Run
28976
+ * * Display Name: Last Run ID
28697
28977
  * * SQL Data Type: uniqueidentifier
28698
28978
  */
28699
28979
  get LastRunID(): string | null;
@@ -38924,6 +39204,441 @@ export declare class MJGeneratedCodeEntity extends BaseEntity<MJGeneratedCodeEnt
38924
39204
  */
38925
39205
  get LinkedEntity(): string | null;
38926
39206
  }
39207
+ /**
39208
+ * MJ: Integration Object Fields - strongly typed entity sub-class
39209
+ * * Schema: __mj
39210
+ * * Base Table: IntegrationObjectField
39211
+ * * Base View: vwIntegrationObjectFields
39212
+ * * @description Describes a field on an integration object, mirroring EntityField column patterns for type compatibility
39213
+ * * Primary Key: ID
39214
+ * @extends {BaseEntity}
39215
+ * @class
39216
+ * @public
39217
+ */
39218
+ export declare class MJIntegrationObjectFieldEntity extends BaseEntity<MJIntegrationObjectFieldEntityType> {
39219
+ /**
39220
+ * Loads the MJ: Integration Object Fields record from the database
39221
+ * @param ID: string - primary key value to load the MJ: Integration Object Fields record.
39222
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
39223
+ * @returns {Promise<boolean>} - true if successful, false otherwise
39224
+ * @public
39225
+ * @async
39226
+ * @memberof MJIntegrationObjectFieldEntity
39227
+ * @method
39228
+ * @override
39229
+ */
39230
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
39231
+ /**
39232
+ * * Field Name: ID
39233
+ * * Display Name: ID
39234
+ * * SQL Data Type: uniqueidentifier
39235
+ * * Default Value: newsequentialid()
39236
+ * * Description: Primary key
39237
+ */
39238
+ get ID(): string;
39239
+ set ID(value: string);
39240
+ /**
39241
+ * * Field Name: IntegrationObjectID
39242
+ * * Display Name: Integration Object
39243
+ * * SQL Data Type: uniqueidentifier
39244
+ * * Related Entity/Foreign Key: MJ: Integration Objects (vwIntegrationObjects.ID)
39245
+ * * Description: Foreign key to the IntegrationObject this field belongs to
39246
+ */
39247
+ get IntegrationObjectID(): string;
39248
+ set IntegrationObjectID(value: string);
39249
+ /**
39250
+ * * Field Name: Name
39251
+ * * Display Name: Name
39252
+ * * SQL Data Type: nvarchar(255)
39253
+ * * Description: Field name as returned by the external API
39254
+ */
39255
+ get Name(): string;
39256
+ set Name(value: string);
39257
+ /**
39258
+ * * Field Name: DisplayName
39259
+ * * Display Name: Display Name
39260
+ * * SQL Data Type: nvarchar(255)
39261
+ * * Description: Human-friendly display label for the field
39262
+ */
39263
+ get DisplayName(): string | null;
39264
+ set DisplayName(value: string | null);
39265
+ /**
39266
+ * * Field Name: Description
39267
+ * * Display Name: Description
39268
+ * * SQL Data Type: nvarchar(MAX)
39269
+ * * Description: Description of what this field represents
39270
+ */
39271
+ get Description(): string | null;
39272
+ set Description(value: string | null);
39273
+ /**
39274
+ * * Field Name: Category
39275
+ * * Display Name: Category
39276
+ * * SQL Data Type: nvarchar(100)
39277
+ * * Description: UI grouping category within the object
39278
+ */
39279
+ get Category(): string | null;
39280
+ set Category(value: string | null);
39281
+ /**
39282
+ * * Field Name: Type
39283
+ * * Display Name: Type
39284
+ * * SQL Data Type: nvarchar(100)
39285
+ * * Description: Data type of the field (e.g., nvarchar, int, datetime, decimal, bit). Uses same type vocabulary as EntityField.
39286
+ */
39287
+ get Type(): string;
39288
+ set Type(value: string);
39289
+ /**
39290
+ * * Field Name: Length
39291
+ * * Display Name: Length
39292
+ * * SQL Data Type: int
39293
+ * * Description: Maximum length for string types
39294
+ */
39295
+ get Length(): number | null;
39296
+ set Length(value: number | null);
39297
+ /**
39298
+ * * Field Name: Precision
39299
+ * * Display Name: Precision
39300
+ * * SQL Data Type: int
39301
+ * * Description: Numeric precision
39302
+ */
39303
+ get Precision(): number | null;
39304
+ set Precision(value: number | null);
39305
+ /**
39306
+ * * Field Name: Scale
39307
+ * * Display Name: Scale
39308
+ * * SQL Data Type: int
39309
+ * * Description: Numeric scale
39310
+ */
39311
+ get Scale(): number | null;
39312
+ set Scale(value: number | null);
39313
+ /**
39314
+ * * Field Name: AllowsNull
39315
+ * * Display Name: Allows Null
39316
+ * * SQL Data Type: bit
39317
+ * * Default Value: 1
39318
+ * * Description: Whether the field can contain NULL values
39319
+ */
39320
+ get AllowsNull(): boolean;
39321
+ set AllowsNull(value: boolean);
39322
+ /**
39323
+ * * Field Name: DefaultValue
39324
+ * * Display Name: Default Value
39325
+ * * SQL Data Type: nvarchar(255)
39326
+ * * Description: Default value from the source system
39327
+ */
39328
+ get DefaultValue(): string | null;
39329
+ set DefaultValue(value: string | null);
39330
+ /**
39331
+ * * Field Name: IsPrimaryKey
39332
+ * * Display Name: Primary Key
39333
+ * * SQL Data Type: bit
39334
+ * * Default Value: 0
39335
+ * * Description: Whether this field is part of the object primary key
39336
+ */
39337
+ get IsPrimaryKey(): boolean;
39338
+ set IsPrimaryKey(value: boolean);
39339
+ /**
39340
+ * * Field Name: IsUniqueKey
39341
+ * * Display Name: Unique Key
39342
+ * * SQL Data Type: bit
39343
+ * * Default Value: 0
39344
+ * * Description: Whether values must be unique across all records
39345
+ */
39346
+ get IsUniqueKey(): boolean;
39347
+ set IsUniqueKey(value: boolean);
39348
+ /**
39349
+ * * Field Name: IsReadOnly
39350
+ * * Display Name: Read Only
39351
+ * * SQL Data Type: bit
39352
+ * * Default Value: 0
39353
+ * * Description: Whether this field cannot be written back to the source system
39354
+ */
39355
+ get IsReadOnly(): boolean;
39356
+ set IsReadOnly(value: boolean);
39357
+ /**
39358
+ * * Field Name: IsRequired
39359
+ * * Display Name: Required
39360
+ * * SQL Data Type: bit
39361
+ * * Default Value: 0
39362
+ * * Description: Whether this field is required for create/update operations
39363
+ */
39364
+ get IsRequired(): boolean;
39365
+ set IsRequired(value: boolean);
39366
+ /**
39367
+ * * Field Name: RelatedIntegrationObjectID
39368
+ * * Display Name: Related Integration Object
39369
+ * * SQL Data Type: uniqueidentifier
39370
+ * * Related Entity/Foreign Key: MJ: Integration Objects (vwIntegrationObjects.ID)
39371
+ * * Description: Foreign key to another IntegrationObject, establishing a relationship. Used for DAG-based dependency ordering and template variable resolution in parent APIPath patterns.
39372
+ */
39373
+ get RelatedIntegrationObjectID(): string | null;
39374
+ set RelatedIntegrationObjectID(value: string | null);
39375
+ /**
39376
+ * * Field Name: RelatedIntegrationObjectFieldName
39377
+ * * Display Name: Related Field Name
39378
+ * * SQL Data Type: nvarchar(255)
39379
+ * * Description: The field name on the related IntegrationObject that this FK points to (typically the PK field)
39380
+ */
39381
+ get RelatedIntegrationObjectFieldName(): string | null;
39382
+ set RelatedIntegrationObjectFieldName(value: string | null);
39383
+ /**
39384
+ * * Field Name: Sequence
39385
+ * * Display Name: Sequence
39386
+ * * SQL Data Type: int
39387
+ * * Default Value: 0
39388
+ * * Description: Display and processing order within the object. Lower numbers appear first.
39389
+ */
39390
+ get Sequence(): number;
39391
+ set Sequence(value: number);
39392
+ /**
39393
+ * * Field Name: Configuration
39394
+ * * Display Name: Configuration
39395
+ * * SQL Data Type: nvarchar(MAX)
39396
+ * * Description: Freeform JSON for connector-specific field configuration
39397
+ */
39398
+ get Configuration(): string | null;
39399
+ set Configuration(value: string | null);
39400
+ /**
39401
+ * * Field Name: Status
39402
+ * * Display Name: Status
39403
+ * * SQL Data Type: nvarchar(25)
39404
+ * * Default Value: Active
39405
+ * * Value List Type: List
39406
+ * * Possible Values
39407
+ * * Active
39408
+ * * Deprecated
39409
+ * * Disabled
39410
+ * * Description: Active, Deprecated, or Disabled. Mirrors EntityField status values.
39411
+ */
39412
+ get Status(): 'Active' | 'Deprecated' | 'Disabled';
39413
+ set Status(value: 'Active' | 'Deprecated' | 'Disabled');
39414
+ /**
39415
+ * * Field Name: __mj_CreatedAt
39416
+ * * Display Name: Created At
39417
+ * * SQL Data Type: datetimeoffset
39418
+ * * Default Value: getutcdate()
39419
+ */
39420
+ get __mj_CreatedAt(): Date;
39421
+ /**
39422
+ * * Field Name: __mj_UpdatedAt
39423
+ * * Display Name: Updated At
39424
+ * * SQL Data Type: datetimeoffset
39425
+ * * Default Value: getutcdate()
39426
+ */
39427
+ get __mj_UpdatedAt(): Date;
39428
+ /**
39429
+ * * Field Name: IntegrationObject
39430
+ * * Display Name: Integration Object Name
39431
+ * * SQL Data Type: nvarchar(255)
39432
+ */
39433
+ get IntegrationObject(): string;
39434
+ /**
39435
+ * * Field Name: RelatedIntegrationObject
39436
+ * * Display Name: Related Object Name
39437
+ * * SQL Data Type: nvarchar(255)
39438
+ */
39439
+ get RelatedIntegrationObject(): string | null;
39440
+ }
39441
+ /**
39442
+ * MJ: Integration Objects - strongly typed entity sub-class
39443
+ * * Schema: __mj
39444
+ * * Base Table: IntegrationObject
39445
+ * * Base View: vwIntegrationObjects
39446
+ * * @description Describes an external object or endpoint exposed by an integration (e.g., Members, Events, Invoices)
39447
+ * * Primary Key: ID
39448
+ * @extends {BaseEntity}
39449
+ * @class
39450
+ * @public
39451
+ */
39452
+ export declare class MJIntegrationObjectEntity extends BaseEntity<MJIntegrationObjectEntityType> {
39453
+ /**
39454
+ * Loads the MJ: Integration Objects record from the database
39455
+ * @param ID: string - primary key value to load the MJ: Integration Objects record.
39456
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
39457
+ * @returns {Promise<boolean>} - true if successful, false otherwise
39458
+ * @public
39459
+ * @async
39460
+ * @memberof MJIntegrationObjectEntity
39461
+ * @method
39462
+ * @override
39463
+ */
39464
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
39465
+ /**
39466
+ * * Field Name: ID
39467
+ * * Display Name: ID
39468
+ * * SQL Data Type: uniqueidentifier
39469
+ * * Default Value: newsequentialid()
39470
+ * * Description: Primary key
39471
+ */
39472
+ get ID(): string;
39473
+ set ID(value: string);
39474
+ /**
39475
+ * * Field Name: IntegrationID
39476
+ * * Display Name: Integration
39477
+ * * SQL Data Type: uniqueidentifier
39478
+ * * Related Entity/Foreign Key: MJ: Integrations (vwIntegrations.ID)
39479
+ * * Description: Foreign key to the Integration that owns this object
39480
+ */
39481
+ get IntegrationID(): string;
39482
+ set IntegrationID(value: string);
39483
+ /**
39484
+ * * Field Name: Name
39485
+ * * Display Name: Internal Name
39486
+ * * SQL Data Type: nvarchar(255)
39487
+ * * Description: Internal/programmatic name of the external object (e.g., Members, Events)
39488
+ */
39489
+ get Name(): string;
39490
+ set Name(value: string);
39491
+ /**
39492
+ * * Field Name: DisplayName
39493
+ * * Display Name: Display Name
39494
+ * * SQL Data Type: nvarchar(255)
39495
+ * * Description: Human-friendly display label
39496
+ */
39497
+ get DisplayName(): string | null;
39498
+ set DisplayName(value: string | null);
39499
+ /**
39500
+ * * Field Name: Description
39501
+ * * Display Name: Description
39502
+ * * SQL Data Type: nvarchar(MAX)
39503
+ * * Description: Description of what this external object represents
39504
+ */
39505
+ get Description(): string | null;
39506
+ set Description(value: string | null);
39507
+ /**
39508
+ * * Field Name: Category
39509
+ * * Display Name: Category
39510
+ * * SQL Data Type: nvarchar(100)
39511
+ * * Description: UI grouping category (e.g., Membership, Events, Finance)
39512
+ */
39513
+ get Category(): string | null;
39514
+ set Category(value: string | null);
39515
+ /**
39516
+ * * Field Name: APIPath
39517
+ * * Display Name: API Path
39518
+ * * SQL Data Type: nvarchar(500)
39519
+ * * Description: API endpoint path, may include template variables like {ProfileID} that are resolved at runtime from parent object records
39520
+ */
39521
+ get APIPath(): string;
39522
+ set APIPath(value: string);
39523
+ /**
39524
+ * * Field Name: ResponseDataKey
39525
+ * * Display Name: Response Data Key
39526
+ * * SQL Data Type: nvarchar(255)
39527
+ * * Description: JSON key used to extract the data array from the API response envelope. NULL means the response is a root-level array.
39528
+ */
39529
+ get ResponseDataKey(): string | null;
39530
+ set ResponseDataKey(value: string | null);
39531
+ /**
39532
+ * * Field Name: DefaultPageSize
39533
+ * * Display Name: Default Page Size
39534
+ * * SQL Data Type: int
39535
+ * * Default Value: 100
39536
+ * * Description: Number of records to request per page from the API
39537
+ */
39538
+ get DefaultPageSize(): number;
39539
+ set DefaultPageSize(value: number);
39540
+ /**
39541
+ * * Field Name: SupportsPagination
39542
+ * * Display Name: Supports Pagination
39543
+ * * SQL Data Type: bit
39544
+ * * Default Value: 1
39545
+ * * Description: Whether this endpoint supports paginated fetching
39546
+ */
39547
+ get SupportsPagination(): boolean;
39548
+ set SupportsPagination(value: boolean);
39549
+ /**
39550
+ * * Field Name: PaginationType
39551
+ * * Display Name: Pagination Type
39552
+ * * SQL Data Type: nvarchar(20)
39553
+ * * Default Value: PageNumber
39554
+ * * Value List Type: List
39555
+ * * Possible Values
39556
+ * * Cursor
39557
+ * * None
39558
+ * * Offset
39559
+ * * PageNumber
39560
+ * * Description: Pagination strategy: PageNumber (page index), Offset (record offset), Cursor (opaque token), or None
39561
+ */
39562
+ get PaginationType(): 'Cursor' | 'None' | 'Offset' | 'PageNumber';
39563
+ set PaginationType(value: 'Cursor' | 'None' | 'Offset' | 'PageNumber');
39564
+ /**
39565
+ * * Field Name: SupportsIncrementalSync
39566
+ * * Display Name: Supports Incremental Sync
39567
+ * * SQL Data Type: bit
39568
+ * * Default Value: 0
39569
+ * * Description: Whether this object supports watermark-based incremental sync
39570
+ */
39571
+ get SupportsIncrementalSync(): boolean;
39572
+ set SupportsIncrementalSync(value: boolean);
39573
+ /**
39574
+ * * Field Name: SupportsWrite
39575
+ * * Display Name: Supports Write
39576
+ * * SQL Data Type: bit
39577
+ * * Default Value: 0
39578
+ * * Description: Whether data can be pushed back to this object via the API
39579
+ */
39580
+ get SupportsWrite(): boolean;
39581
+ set SupportsWrite(value: boolean);
39582
+ /**
39583
+ * * Field Name: DefaultQueryParams
39584
+ * * Display Name: Default Query Parameters
39585
+ * * SQL Data Type: nvarchar(MAX)
39586
+ * * Description: JSON object of default query parameters to include with every API request for this object
39587
+ */
39588
+ get DefaultQueryParams(): string | null;
39589
+ set DefaultQueryParams(value: string | null);
39590
+ /**
39591
+ * * Field Name: Configuration
39592
+ * * Display Name: Configuration
39593
+ * * SQL Data Type: nvarchar(MAX)
39594
+ * * Description: Freeform JSON for connector-specific configuration not covered by standard columns
39595
+ */
39596
+ get Configuration(): string | null;
39597
+ set Configuration(value: string | null);
39598
+ /**
39599
+ * * Field Name: Sequence
39600
+ * * Display Name: Sequence
39601
+ * * SQL Data Type: int
39602
+ * * Default Value: 0
39603
+ * * Description: Processing and display order. Lower numbers are processed first.
39604
+ */
39605
+ get Sequence(): number;
39606
+ set Sequence(value: number);
39607
+ /**
39608
+ * * Field Name: Status
39609
+ * * Display Name: Status
39610
+ * * SQL Data Type: nvarchar(25)
39611
+ * * Default Value: Active
39612
+ * * Value List Type: List
39613
+ * * Possible Values
39614
+ * * Active
39615
+ * * Deprecated
39616
+ * * Disabled
39617
+ * * Description: Active, Deprecated, or Disabled. Mirrors EntityField status values.
39618
+ */
39619
+ get Status(): 'Active' | 'Deprecated' | 'Disabled';
39620
+ set Status(value: 'Active' | 'Deprecated' | 'Disabled');
39621
+ /**
39622
+ * * Field Name: __mj_CreatedAt
39623
+ * * Display Name: Created At
39624
+ * * SQL Data Type: datetimeoffset
39625
+ * * Default Value: getutcdate()
39626
+ */
39627
+ get __mj_CreatedAt(): Date;
39628
+ /**
39629
+ * * Field Name: __mj_UpdatedAt
39630
+ * * Display Name: Updated At
39631
+ * * SQL Data Type: datetimeoffset
39632
+ * * Default Value: getutcdate()
39633
+ */
39634
+ get __mj_UpdatedAt(): Date;
39635
+ /**
39636
+ * * Field Name: Integration
39637
+ * * Display Name: Integration Name
39638
+ * * SQL Data Type: nvarchar(100)
39639
+ */
39640
+ get Integration(): string;
39641
+ }
38927
39642
  /**
38928
39643
  * MJ: Integration Source Types - strongly typed entity sub-class
38929
39644
  * * Schema: __mj