@memberjunction/core-entities 5.8.0 → 5.9.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.
@@ -5022,6 +5022,16 @@ export declare const MJCompanyIntegrationSchema: z.ZodObject<{
5022
5022
  SourceTypeID: z.ZodNullable<z.ZodString>;
5023
5023
  Configuration: z.ZodNullable<z.ZodString>;
5024
5024
  CredentialID: z.ZodNullable<z.ZodString>;
5025
+ ScheduleEnabled: z.ZodBoolean;
5026
+ ScheduleType: z.ZodUnion<[z.ZodLiteral<"Cron">, z.ZodLiteral<"Interval">, z.ZodLiteral<"Manual">]>;
5027
+ ScheduleIntervalMinutes: z.ZodNullable<z.ZodNumber>;
5028
+ CronExpression: z.ZodNullable<z.ZodString>;
5029
+ NextScheduledRunAt: z.ZodNullable<z.ZodDate>;
5030
+ LastScheduledRunAt: z.ZodNullable<z.ZodDate>;
5031
+ IsLocked: z.ZodBoolean;
5032
+ LockedAt: z.ZodNullable<z.ZodDate>;
5033
+ LockedByInstance: z.ZodNullable<z.ZodString>;
5034
+ LockExpiresAt: z.ZodNullable<z.ZodDate>;
5025
5035
  Company: z.ZodString;
5026
5036
  Integration: z.ZodString;
5027
5037
  DriverClassName: z.ZodNullable<z.ZodString>;
@@ -5053,6 +5063,16 @@ export declare const MJCompanyIntegrationSchema: z.ZodObject<{
5053
5063
  ClientSecret?: string;
5054
5064
  CustomAttribute1?: string;
5055
5065
  SourceTypeID?: string;
5066
+ ScheduleEnabled?: boolean;
5067
+ ScheduleType?: "Manual" | "Cron" | "Interval";
5068
+ ScheduleIntervalMinutes?: number;
5069
+ CronExpression?: string;
5070
+ NextScheduledRunAt?: Date;
5071
+ LastScheduledRunAt?: Date;
5072
+ IsLocked?: boolean;
5073
+ LockedAt?: Date;
5074
+ LockedByInstance?: string;
5075
+ LockExpiresAt?: Date;
5056
5076
  DriverClassName?: string;
5057
5077
  LastRunStartedAt?: Date;
5058
5078
  LastRunEndedAt?: Date;
@@ -5080,6 +5100,16 @@ export declare const MJCompanyIntegrationSchema: z.ZodObject<{
5080
5100
  ClientSecret?: string;
5081
5101
  CustomAttribute1?: string;
5082
5102
  SourceTypeID?: string;
5103
+ ScheduleEnabled?: boolean;
5104
+ ScheduleType?: "Manual" | "Cron" | "Interval";
5105
+ ScheduleIntervalMinutes?: number;
5106
+ CronExpression?: string;
5107
+ NextScheduledRunAt?: Date;
5108
+ LastScheduledRunAt?: Date;
5109
+ IsLocked?: boolean;
5110
+ LockedAt?: Date;
5111
+ LockedByInstance?: string;
5112
+ LockExpiresAt?: Date;
5083
5113
  DriverClassName?: string;
5084
5114
  LastRunStartedAt?: Date;
5085
5115
  LastRunEndedAt?: Date;
@@ -8774,6 +8804,157 @@ export declare const MJGeneratedCodeSchema: z.ZodObject<{
8774
8804
  GeneratedByModel?: string;
8775
8805
  }>;
8776
8806
  export type MJGeneratedCodeEntityType = z.infer<typeof MJGeneratedCodeSchema>;
8807
+ /**
8808
+ * zod schema definition for the entity MJ: Integration Object Fields
8809
+ */
8810
+ export declare const MJIntegrationObjectFieldSchema: z.ZodObject<{
8811
+ ID: z.ZodString;
8812
+ IntegrationObjectID: z.ZodString;
8813
+ Name: z.ZodString;
8814
+ DisplayName: z.ZodNullable<z.ZodString>;
8815
+ Description: z.ZodNullable<z.ZodString>;
8816
+ Category: z.ZodNullable<z.ZodString>;
8817
+ Type: z.ZodString;
8818
+ Length: z.ZodNullable<z.ZodNumber>;
8819
+ Precision: z.ZodNullable<z.ZodNumber>;
8820
+ Scale: z.ZodNullable<z.ZodNumber>;
8821
+ AllowsNull: z.ZodBoolean;
8822
+ DefaultValue: z.ZodNullable<z.ZodString>;
8823
+ IsPrimaryKey: z.ZodBoolean;
8824
+ IsUniqueKey: z.ZodBoolean;
8825
+ IsReadOnly: z.ZodBoolean;
8826
+ IsRequired: z.ZodBoolean;
8827
+ RelatedIntegrationObjectID: z.ZodNullable<z.ZodString>;
8828
+ RelatedIntegrationObjectFieldName: z.ZodNullable<z.ZodString>;
8829
+ Sequence: z.ZodNumber;
8830
+ Configuration: z.ZodNullable<z.ZodString>;
8831
+ Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Deprecated">, z.ZodLiteral<"Disabled">]>;
8832
+ __mj_CreatedAt: z.ZodDate;
8833
+ __mj_UpdatedAt: z.ZodDate;
8834
+ IntegrationObject: z.ZodString;
8835
+ RelatedIntegrationObject: z.ZodNullable<z.ZodString>;
8836
+ }, "strip", z.ZodTypeAny, {
8837
+ ID?: string;
8838
+ __mj_CreatedAt?: Date;
8839
+ __mj_UpdatedAt?: Date;
8840
+ Name?: string;
8841
+ Description?: string;
8842
+ Status?: "Active" | "Disabled" | "Deprecated";
8843
+ DefaultValue?: string;
8844
+ Type?: string;
8845
+ IsRequired?: boolean;
8846
+ Category?: string;
8847
+ Sequence?: number;
8848
+ DisplayName?: string;
8849
+ Configuration?: string;
8850
+ IsPrimaryKey?: boolean;
8851
+ Length?: number;
8852
+ Precision?: number;
8853
+ Scale?: number;
8854
+ AllowsNull?: boolean;
8855
+ IntegrationObjectID?: string;
8856
+ IsUniqueKey?: boolean;
8857
+ IsReadOnly?: boolean;
8858
+ RelatedIntegrationObjectID?: string;
8859
+ RelatedIntegrationObjectFieldName?: string;
8860
+ IntegrationObject?: string;
8861
+ RelatedIntegrationObject?: string;
8862
+ }, {
8863
+ ID?: string;
8864
+ __mj_CreatedAt?: Date;
8865
+ __mj_UpdatedAt?: Date;
8866
+ Name?: string;
8867
+ Description?: string;
8868
+ Status?: "Active" | "Disabled" | "Deprecated";
8869
+ DefaultValue?: string;
8870
+ Type?: string;
8871
+ IsRequired?: boolean;
8872
+ Category?: string;
8873
+ Sequence?: number;
8874
+ DisplayName?: string;
8875
+ Configuration?: string;
8876
+ IsPrimaryKey?: boolean;
8877
+ Length?: number;
8878
+ Precision?: number;
8879
+ Scale?: number;
8880
+ AllowsNull?: boolean;
8881
+ IntegrationObjectID?: string;
8882
+ IsUniqueKey?: boolean;
8883
+ IsReadOnly?: boolean;
8884
+ RelatedIntegrationObjectID?: string;
8885
+ RelatedIntegrationObjectFieldName?: string;
8886
+ IntegrationObject?: string;
8887
+ RelatedIntegrationObject?: string;
8888
+ }>;
8889
+ export type MJIntegrationObjectFieldEntityType = z.infer<typeof MJIntegrationObjectFieldSchema>;
8890
+ /**
8891
+ * zod schema definition for the entity MJ: Integration Objects
8892
+ */
8893
+ export declare const MJIntegrationObjectSchema: z.ZodObject<{
8894
+ ID: z.ZodString;
8895
+ IntegrationID: z.ZodString;
8896
+ Name: z.ZodString;
8897
+ DisplayName: z.ZodNullable<z.ZodString>;
8898
+ Description: z.ZodNullable<z.ZodString>;
8899
+ Category: z.ZodNullable<z.ZodString>;
8900
+ APIPath: z.ZodString;
8901
+ ResponseDataKey: z.ZodNullable<z.ZodString>;
8902
+ DefaultPageSize: z.ZodNumber;
8903
+ SupportsPagination: z.ZodBoolean;
8904
+ PaginationType: z.ZodUnion<[z.ZodLiteral<"Cursor">, z.ZodLiteral<"None">, z.ZodLiteral<"Offset">, z.ZodLiteral<"PageNumber">]>;
8905
+ SupportsIncrementalSync: z.ZodBoolean;
8906
+ SupportsWrite: z.ZodBoolean;
8907
+ DefaultQueryParams: z.ZodNullable<z.ZodString>;
8908
+ Configuration: z.ZodNullable<z.ZodString>;
8909
+ Sequence: z.ZodNumber;
8910
+ Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Deprecated">, z.ZodLiteral<"Disabled">]>;
8911
+ __mj_CreatedAt: z.ZodDate;
8912
+ __mj_UpdatedAt: z.ZodDate;
8913
+ Integration: z.ZodString;
8914
+ }, "strip", z.ZodTypeAny, {
8915
+ ID?: string;
8916
+ __mj_CreatedAt?: Date;
8917
+ __mj_UpdatedAt?: Date;
8918
+ Name?: string;
8919
+ Description?: string;
8920
+ Status?: "Active" | "Disabled" | "Deprecated";
8921
+ Category?: string;
8922
+ Sequence?: number;
8923
+ DisplayName?: string;
8924
+ Configuration?: string;
8925
+ Integration?: string;
8926
+ IntegrationID?: string;
8927
+ APIPath?: string;
8928
+ ResponseDataKey?: string;
8929
+ DefaultPageSize?: number;
8930
+ SupportsPagination?: boolean;
8931
+ PaginationType?: "None" | "Cursor" | "Offset" | "PageNumber";
8932
+ SupportsIncrementalSync?: boolean;
8933
+ SupportsWrite?: boolean;
8934
+ DefaultQueryParams?: string;
8935
+ }, {
8936
+ ID?: string;
8937
+ __mj_CreatedAt?: Date;
8938
+ __mj_UpdatedAt?: Date;
8939
+ Name?: string;
8940
+ Description?: string;
8941
+ Status?: "Active" | "Disabled" | "Deprecated";
8942
+ Category?: string;
8943
+ Sequence?: number;
8944
+ DisplayName?: string;
8945
+ Configuration?: string;
8946
+ Integration?: string;
8947
+ IntegrationID?: string;
8948
+ APIPath?: string;
8949
+ ResponseDataKey?: string;
8950
+ DefaultPageSize?: number;
8951
+ SupportsPagination?: boolean;
8952
+ PaginationType?: "None" | "Cursor" | "Offset" | "PageNumber";
8953
+ SupportsIncrementalSync?: boolean;
8954
+ SupportsWrite?: boolean;
8955
+ DefaultQueryParams?: string;
8956
+ }>;
8957
+ export type MJIntegrationObjectEntityType = z.infer<typeof MJIntegrationObjectSchema>;
8777
8958
  /**
8778
8959
  * zod schema definition for the entity MJ: Integration Source Types
8779
8960
  */
@@ -11615,6 +11796,8 @@ export declare const MJScheduledJobSchema: z.ZodObject<{
11615
11796
  OwnerUserID?: string;
11616
11797
  OwnerUser?: string;
11617
11798
  CronExpression?: string;
11799
+ LockedAt?: Date;
11800
+ LockedByInstance?: string;
11618
11801
  Timezone?: string;
11619
11802
  JobTypeID?: string;
11620
11803
  StartAt?: Date;
@@ -11630,8 +11813,6 @@ export declare const MJScheduledJobSchema: z.ZodObject<{
11630
11813
  NotifyViaEmail?: boolean;
11631
11814
  NotifyViaInApp?: boolean;
11632
11815
  LockToken?: string;
11633
- LockedAt?: Date;
11634
- LockedByInstance?: string;
11635
11816
  ExpectedCompletionAt?: Date;
11636
11817
  ConcurrencyMode?: "Queue" | "Concurrent" | "Skip";
11637
11818
  JobType?: string;
@@ -11647,6 +11828,8 @@ export declare const MJScheduledJobSchema: z.ZodObject<{
11647
11828
  OwnerUserID?: string;
11648
11829
  OwnerUser?: string;
11649
11830
  CronExpression?: string;
11831
+ LockedAt?: Date;
11832
+ LockedByInstance?: string;
11650
11833
  Timezone?: string;
11651
11834
  JobTypeID?: string;
11652
11835
  StartAt?: Date;
@@ -11662,8 +11845,6 @@ export declare const MJScheduledJobSchema: z.ZodObject<{
11662
11845
  NotifyViaEmail?: boolean;
11663
11846
  NotifyViaInApp?: boolean;
11664
11847
  LockToken?: string;
11665
- LockedAt?: Date;
11666
- LockedByInstance?: string;
11667
11848
  ExpectedCompletionAt?: Date;
11668
11849
  ConcurrencyMode?: "Queue" | "Concurrent" | "Skip";
11669
11850
  JobType?: string;
@@ -28540,7 +28721,7 @@ export declare class MJCompanyIntegrationEntity extends BaseEntity<MJCompanyInte
28540
28721
  set IntegrationID(value: string);
28541
28722
  /**
28542
28723
  * * Field Name: IsActive
28543
- * * Display Name: Active
28724
+ * * Display Name: Is Active
28544
28725
  * * SQL Data Type: bit
28545
28726
  * * Description: Controls whether this integration is currently active for the company.
28546
28727
  */
@@ -28668,14 +28849,102 @@ export declare class MJCompanyIntegrationEntity extends BaseEntity<MJCompanyInte
28668
28849
  get CredentialID(): string | null;
28669
28850
  set CredentialID(value: string | null);
28670
28851
  /**
28852
+ * * Field Name: ScheduleEnabled
28853
+ * * Display Name: Schedule Enabled
28854
+ * * SQL Data Type: bit
28855
+ * * Default Value: 0
28856
+ * * Description: Whether automatic sync scheduling is enabled for this integration
28857
+ */
28858
+ get ScheduleEnabled(): boolean;
28859
+ set ScheduleEnabled(value: boolean);
28860
+ /**
28861
+ * * Field Name: ScheduleType
28862
+ * * Display Name: Schedule Type
28863
+ * * SQL Data Type: nvarchar(20)
28864
+ * * Default Value: Manual
28865
+ * * Value List Type: List
28866
+ * * Possible Values
28867
+ * * Cron
28868
+ * * Interval
28869
+ * * Manual
28870
+ * * Description: Type of schedule: Manual (no auto-sync), Interval (every N minutes), Cron (cron expression)
28871
+ */
28872
+ get ScheduleType(): 'Cron' | 'Interval' | 'Manual';
28873
+ set ScheduleType(value: 'Cron' | 'Interval' | 'Manual');
28874
+ /**
28875
+ * * Field Name: ScheduleIntervalMinutes
28876
+ * * Display Name: Schedule Interval (Minutes)
28877
+ * * SQL Data Type: int
28878
+ * * Description: Interval in minutes for Interval schedule type
28879
+ */
28880
+ get ScheduleIntervalMinutes(): number | null;
28881
+ set ScheduleIntervalMinutes(value: number | null);
28882
+ /**
28883
+ * * Field Name: CronExpression
28884
+ * * Display Name: Cron Expression
28885
+ * * SQL Data Type: nvarchar(200)
28886
+ * * Description: Cron expression for Cron schedule type (e.g., "0 *\/6 * * *" for every 6 hours)
28887
+ */
28888
+ get CronExpression(): string | null;
28889
+ set CronExpression(value: string | null);
28890
+ /**
28891
+ * * Field Name: NextScheduledRunAt
28892
+ * * Display Name: Next Scheduled Run
28893
+ * * SQL Data Type: datetimeoffset
28894
+ * * Description: When the next scheduled sync should run. Updated after each run based on schedule config.
28895
+ */
28896
+ get NextScheduledRunAt(): Date | null;
28897
+ set NextScheduledRunAt(value: Date | null);
28898
+ /**
28899
+ * * Field Name: LastScheduledRunAt
28900
+ * * Display Name: Last Scheduled Run
28901
+ * * SQL Data Type: datetimeoffset
28902
+ * * Description: When the last scheduled sync was initiated
28903
+ */
28904
+ get LastScheduledRunAt(): Date | null;
28905
+ set LastScheduledRunAt(value: Date | null);
28906
+ /**
28907
+ * * Field Name: IsLocked
28908
+ * * Display Name: Is Locked
28909
+ * * SQL Data Type: bit
28910
+ * * Default Value: 0
28911
+ * * Description: Whether a sync is currently locked/running for this integration
28912
+ */
28913
+ get IsLocked(): boolean;
28914
+ set IsLocked(value: boolean);
28915
+ /**
28916
+ * * Field Name: LockedAt
28917
+ * * Display Name: Locked At
28918
+ * * SQL Data Type: datetimeoffset
28919
+ * * Description: When the lock was acquired
28920
+ */
28921
+ get LockedAt(): Date | null;
28922
+ set LockedAt(value: Date | null);
28923
+ /**
28924
+ * * Field Name: LockedByInstance
28925
+ * * Display Name: Locked By Instance
28926
+ * * SQL Data Type: nvarchar(200)
28927
+ * * Description: Server instance identifier that holds the lock (hostname-pid)
28928
+ */
28929
+ get LockedByInstance(): string | null;
28930
+ set LockedByInstance(value: string | null);
28931
+ /**
28932
+ * * Field Name: LockExpiresAt
28933
+ * * Display Name: Lock Expires At
28934
+ * * SQL Data Type: datetimeoffset
28935
+ * * Description: When the lock should be considered stale and eligible for cleanup
28936
+ */
28937
+ get LockExpiresAt(): Date | null;
28938
+ set LockExpiresAt(value: Date | null);
28939
+ /**
28671
28940
  * * Field Name: Company
28672
- * * Display Name: Company Name
28941
+ * * Display Name: Company
28673
28942
  * * SQL Data Type: nvarchar(50)
28674
28943
  */
28675
28944
  get Company(): string;
28676
28945
  /**
28677
28946
  * * Field Name: Integration
28678
- * * Display Name: Integration Name
28947
+ * * Display Name: Integration
28679
28948
  * * SQL Data Type: nvarchar(100)
28680
28949
  */
28681
28950
  get Integration(): string;
@@ -28693,7 +28962,7 @@ export declare class MJCompanyIntegrationEntity extends BaseEntity<MJCompanyInte
28693
28962
  get DriverImportPath(): string | null;
28694
28963
  /**
28695
28964
  * * Field Name: LastRunID
28696
- * * Display Name: Last Run
28965
+ * * Display Name: Last Run ID
28697
28966
  * * SQL Data Type: uniqueidentifier
28698
28967
  */
28699
28968
  get LastRunID(): string | null;
@@ -38924,6 +39193,441 @@ export declare class MJGeneratedCodeEntity extends BaseEntity<MJGeneratedCodeEnt
38924
39193
  */
38925
39194
  get LinkedEntity(): string | null;
38926
39195
  }
39196
+ /**
39197
+ * MJ: Integration Object Fields - strongly typed entity sub-class
39198
+ * * Schema: __mj
39199
+ * * Base Table: IntegrationObjectField
39200
+ * * Base View: vwIntegrationObjectFields
39201
+ * * @description Describes a field on an integration object, mirroring EntityField column patterns for type compatibility
39202
+ * * Primary Key: ID
39203
+ * @extends {BaseEntity}
39204
+ * @class
39205
+ * @public
39206
+ */
39207
+ export declare class MJIntegrationObjectFieldEntity extends BaseEntity<MJIntegrationObjectFieldEntityType> {
39208
+ /**
39209
+ * Loads the MJ: Integration Object Fields record from the database
39210
+ * @param ID: string - primary key value to load the MJ: Integration Object Fields record.
39211
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
39212
+ * @returns {Promise<boolean>} - true if successful, false otherwise
39213
+ * @public
39214
+ * @async
39215
+ * @memberof MJIntegrationObjectFieldEntity
39216
+ * @method
39217
+ * @override
39218
+ */
39219
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
39220
+ /**
39221
+ * * Field Name: ID
39222
+ * * Display Name: ID
39223
+ * * SQL Data Type: uniqueidentifier
39224
+ * * Default Value: newsequentialid()
39225
+ * * Description: Primary key
39226
+ */
39227
+ get ID(): string;
39228
+ set ID(value: string);
39229
+ /**
39230
+ * * Field Name: IntegrationObjectID
39231
+ * * Display Name: Integration Object
39232
+ * * SQL Data Type: uniqueidentifier
39233
+ * * Related Entity/Foreign Key: MJ: Integration Objects (vwIntegrationObjects.ID)
39234
+ * * Description: Foreign key to the IntegrationObject this field belongs to
39235
+ */
39236
+ get IntegrationObjectID(): string;
39237
+ set IntegrationObjectID(value: string);
39238
+ /**
39239
+ * * Field Name: Name
39240
+ * * Display Name: Name
39241
+ * * SQL Data Type: nvarchar(255)
39242
+ * * Description: Field name as returned by the external API
39243
+ */
39244
+ get Name(): string;
39245
+ set Name(value: string);
39246
+ /**
39247
+ * * Field Name: DisplayName
39248
+ * * Display Name: Display Name
39249
+ * * SQL Data Type: nvarchar(255)
39250
+ * * Description: Human-friendly display label for the field
39251
+ */
39252
+ get DisplayName(): string | null;
39253
+ set DisplayName(value: string | null);
39254
+ /**
39255
+ * * Field Name: Description
39256
+ * * Display Name: Description
39257
+ * * SQL Data Type: nvarchar(MAX)
39258
+ * * Description: Description of what this field represents
39259
+ */
39260
+ get Description(): string | null;
39261
+ set Description(value: string | null);
39262
+ /**
39263
+ * * Field Name: Category
39264
+ * * Display Name: Category
39265
+ * * SQL Data Type: nvarchar(100)
39266
+ * * Description: UI grouping category within the object
39267
+ */
39268
+ get Category(): string | null;
39269
+ set Category(value: string | null);
39270
+ /**
39271
+ * * Field Name: Type
39272
+ * * Display Name: Type
39273
+ * * SQL Data Type: nvarchar(100)
39274
+ * * Description: Data type of the field (e.g., nvarchar, int, datetime, decimal, bit). Uses same type vocabulary as EntityField.
39275
+ */
39276
+ get Type(): string;
39277
+ set Type(value: string);
39278
+ /**
39279
+ * * Field Name: Length
39280
+ * * Display Name: Length
39281
+ * * SQL Data Type: int
39282
+ * * Description: Maximum length for string types
39283
+ */
39284
+ get Length(): number | null;
39285
+ set Length(value: number | null);
39286
+ /**
39287
+ * * Field Name: Precision
39288
+ * * Display Name: Precision
39289
+ * * SQL Data Type: int
39290
+ * * Description: Numeric precision
39291
+ */
39292
+ get Precision(): number | null;
39293
+ set Precision(value: number | null);
39294
+ /**
39295
+ * * Field Name: Scale
39296
+ * * Display Name: Scale
39297
+ * * SQL Data Type: int
39298
+ * * Description: Numeric scale
39299
+ */
39300
+ get Scale(): number | null;
39301
+ set Scale(value: number | null);
39302
+ /**
39303
+ * * Field Name: AllowsNull
39304
+ * * Display Name: Allows Null
39305
+ * * SQL Data Type: bit
39306
+ * * Default Value: 1
39307
+ * * Description: Whether the field can contain NULL values
39308
+ */
39309
+ get AllowsNull(): boolean;
39310
+ set AllowsNull(value: boolean);
39311
+ /**
39312
+ * * Field Name: DefaultValue
39313
+ * * Display Name: Default Value
39314
+ * * SQL Data Type: nvarchar(255)
39315
+ * * Description: Default value from the source system
39316
+ */
39317
+ get DefaultValue(): string | null;
39318
+ set DefaultValue(value: string | null);
39319
+ /**
39320
+ * * Field Name: IsPrimaryKey
39321
+ * * Display Name: Primary Key
39322
+ * * SQL Data Type: bit
39323
+ * * Default Value: 0
39324
+ * * Description: Whether this field is part of the object primary key
39325
+ */
39326
+ get IsPrimaryKey(): boolean;
39327
+ set IsPrimaryKey(value: boolean);
39328
+ /**
39329
+ * * Field Name: IsUniqueKey
39330
+ * * Display Name: Unique Key
39331
+ * * SQL Data Type: bit
39332
+ * * Default Value: 0
39333
+ * * Description: Whether values must be unique across all records
39334
+ */
39335
+ get IsUniqueKey(): boolean;
39336
+ set IsUniqueKey(value: boolean);
39337
+ /**
39338
+ * * Field Name: IsReadOnly
39339
+ * * Display Name: Read Only
39340
+ * * SQL Data Type: bit
39341
+ * * Default Value: 0
39342
+ * * Description: Whether this field cannot be written back to the source system
39343
+ */
39344
+ get IsReadOnly(): boolean;
39345
+ set IsReadOnly(value: boolean);
39346
+ /**
39347
+ * * Field Name: IsRequired
39348
+ * * Display Name: Required
39349
+ * * SQL Data Type: bit
39350
+ * * Default Value: 0
39351
+ * * Description: Whether this field is required for create/update operations
39352
+ */
39353
+ get IsRequired(): boolean;
39354
+ set IsRequired(value: boolean);
39355
+ /**
39356
+ * * Field Name: RelatedIntegrationObjectID
39357
+ * * Display Name: Related Integration Object
39358
+ * * SQL Data Type: uniqueidentifier
39359
+ * * Related Entity/Foreign Key: MJ: Integration Objects (vwIntegrationObjects.ID)
39360
+ * * Description: Foreign key to another IntegrationObject, establishing a relationship. Used for DAG-based dependency ordering and template variable resolution in parent APIPath patterns.
39361
+ */
39362
+ get RelatedIntegrationObjectID(): string | null;
39363
+ set RelatedIntegrationObjectID(value: string | null);
39364
+ /**
39365
+ * * Field Name: RelatedIntegrationObjectFieldName
39366
+ * * Display Name: Related Field Name
39367
+ * * SQL Data Type: nvarchar(255)
39368
+ * * Description: The field name on the related IntegrationObject that this FK points to (typically the PK field)
39369
+ */
39370
+ get RelatedIntegrationObjectFieldName(): string | null;
39371
+ set RelatedIntegrationObjectFieldName(value: string | null);
39372
+ /**
39373
+ * * Field Name: Sequence
39374
+ * * Display Name: Sequence
39375
+ * * SQL Data Type: int
39376
+ * * Default Value: 0
39377
+ * * Description: Display and processing order within the object. Lower numbers appear first.
39378
+ */
39379
+ get Sequence(): number;
39380
+ set Sequence(value: number);
39381
+ /**
39382
+ * * Field Name: Configuration
39383
+ * * Display Name: Configuration
39384
+ * * SQL Data Type: nvarchar(MAX)
39385
+ * * Description: Freeform JSON for connector-specific field configuration
39386
+ */
39387
+ get Configuration(): string | null;
39388
+ set Configuration(value: string | null);
39389
+ /**
39390
+ * * Field Name: Status
39391
+ * * Display Name: Status
39392
+ * * SQL Data Type: nvarchar(25)
39393
+ * * Default Value: Active
39394
+ * * Value List Type: List
39395
+ * * Possible Values
39396
+ * * Active
39397
+ * * Deprecated
39398
+ * * Disabled
39399
+ * * Description: Active, Deprecated, or Disabled. Mirrors EntityField status values.
39400
+ */
39401
+ get Status(): 'Active' | 'Deprecated' | 'Disabled';
39402
+ set Status(value: 'Active' | 'Deprecated' | 'Disabled');
39403
+ /**
39404
+ * * Field Name: __mj_CreatedAt
39405
+ * * Display Name: Created At
39406
+ * * SQL Data Type: datetimeoffset
39407
+ * * Default Value: getutcdate()
39408
+ */
39409
+ get __mj_CreatedAt(): Date;
39410
+ /**
39411
+ * * Field Name: __mj_UpdatedAt
39412
+ * * Display Name: Updated At
39413
+ * * SQL Data Type: datetimeoffset
39414
+ * * Default Value: getutcdate()
39415
+ */
39416
+ get __mj_UpdatedAt(): Date;
39417
+ /**
39418
+ * * Field Name: IntegrationObject
39419
+ * * Display Name: Integration Object Name
39420
+ * * SQL Data Type: nvarchar(255)
39421
+ */
39422
+ get IntegrationObject(): string;
39423
+ /**
39424
+ * * Field Name: RelatedIntegrationObject
39425
+ * * Display Name: Related Object Name
39426
+ * * SQL Data Type: nvarchar(255)
39427
+ */
39428
+ get RelatedIntegrationObject(): string | null;
39429
+ }
39430
+ /**
39431
+ * MJ: Integration Objects - strongly typed entity sub-class
39432
+ * * Schema: __mj
39433
+ * * Base Table: IntegrationObject
39434
+ * * Base View: vwIntegrationObjects
39435
+ * * @description Describes an external object or endpoint exposed by an integration (e.g., Members, Events, Invoices)
39436
+ * * Primary Key: ID
39437
+ * @extends {BaseEntity}
39438
+ * @class
39439
+ * @public
39440
+ */
39441
+ export declare class MJIntegrationObjectEntity extends BaseEntity<MJIntegrationObjectEntityType> {
39442
+ /**
39443
+ * Loads the MJ: Integration Objects record from the database
39444
+ * @param ID: string - primary key value to load the MJ: Integration Objects record.
39445
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
39446
+ * @returns {Promise<boolean>} - true if successful, false otherwise
39447
+ * @public
39448
+ * @async
39449
+ * @memberof MJIntegrationObjectEntity
39450
+ * @method
39451
+ * @override
39452
+ */
39453
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
39454
+ /**
39455
+ * * Field Name: ID
39456
+ * * Display Name: ID
39457
+ * * SQL Data Type: uniqueidentifier
39458
+ * * Default Value: newsequentialid()
39459
+ * * Description: Primary key
39460
+ */
39461
+ get ID(): string;
39462
+ set ID(value: string);
39463
+ /**
39464
+ * * Field Name: IntegrationID
39465
+ * * Display Name: Integration
39466
+ * * SQL Data Type: uniqueidentifier
39467
+ * * Related Entity/Foreign Key: MJ: Integrations (vwIntegrations.ID)
39468
+ * * Description: Foreign key to the Integration that owns this object
39469
+ */
39470
+ get IntegrationID(): string;
39471
+ set IntegrationID(value: string);
39472
+ /**
39473
+ * * Field Name: Name
39474
+ * * Display Name: Internal Name
39475
+ * * SQL Data Type: nvarchar(255)
39476
+ * * Description: Internal/programmatic name of the external object (e.g., Members, Events)
39477
+ */
39478
+ get Name(): string;
39479
+ set Name(value: string);
39480
+ /**
39481
+ * * Field Name: DisplayName
39482
+ * * Display Name: Display Name
39483
+ * * SQL Data Type: nvarchar(255)
39484
+ * * Description: Human-friendly display label
39485
+ */
39486
+ get DisplayName(): string | null;
39487
+ set DisplayName(value: string | null);
39488
+ /**
39489
+ * * Field Name: Description
39490
+ * * Display Name: Description
39491
+ * * SQL Data Type: nvarchar(MAX)
39492
+ * * Description: Description of what this external object represents
39493
+ */
39494
+ get Description(): string | null;
39495
+ set Description(value: string | null);
39496
+ /**
39497
+ * * Field Name: Category
39498
+ * * Display Name: Category
39499
+ * * SQL Data Type: nvarchar(100)
39500
+ * * Description: UI grouping category (e.g., Membership, Events, Finance)
39501
+ */
39502
+ get Category(): string | null;
39503
+ set Category(value: string | null);
39504
+ /**
39505
+ * * Field Name: APIPath
39506
+ * * Display Name: API Path
39507
+ * * SQL Data Type: nvarchar(500)
39508
+ * * Description: API endpoint path, may include template variables like {ProfileID} that are resolved at runtime from parent object records
39509
+ */
39510
+ get APIPath(): string;
39511
+ set APIPath(value: string);
39512
+ /**
39513
+ * * Field Name: ResponseDataKey
39514
+ * * Display Name: Response Data Key
39515
+ * * SQL Data Type: nvarchar(255)
39516
+ * * Description: JSON key used to extract the data array from the API response envelope. NULL means the response is a root-level array.
39517
+ */
39518
+ get ResponseDataKey(): string | null;
39519
+ set ResponseDataKey(value: string | null);
39520
+ /**
39521
+ * * Field Name: DefaultPageSize
39522
+ * * Display Name: Default Page Size
39523
+ * * SQL Data Type: int
39524
+ * * Default Value: 100
39525
+ * * Description: Number of records to request per page from the API
39526
+ */
39527
+ get DefaultPageSize(): number;
39528
+ set DefaultPageSize(value: number);
39529
+ /**
39530
+ * * Field Name: SupportsPagination
39531
+ * * Display Name: Supports Pagination
39532
+ * * SQL Data Type: bit
39533
+ * * Default Value: 1
39534
+ * * Description: Whether this endpoint supports paginated fetching
39535
+ */
39536
+ get SupportsPagination(): boolean;
39537
+ set SupportsPagination(value: boolean);
39538
+ /**
39539
+ * * Field Name: PaginationType
39540
+ * * Display Name: Pagination Type
39541
+ * * SQL Data Type: nvarchar(20)
39542
+ * * Default Value: PageNumber
39543
+ * * Value List Type: List
39544
+ * * Possible Values
39545
+ * * Cursor
39546
+ * * None
39547
+ * * Offset
39548
+ * * PageNumber
39549
+ * * Description: Pagination strategy: PageNumber (page index), Offset (record offset), Cursor (opaque token), or None
39550
+ */
39551
+ get PaginationType(): 'Cursor' | 'None' | 'Offset' | 'PageNumber';
39552
+ set PaginationType(value: 'Cursor' | 'None' | 'Offset' | 'PageNumber');
39553
+ /**
39554
+ * * Field Name: SupportsIncrementalSync
39555
+ * * Display Name: Supports Incremental Sync
39556
+ * * SQL Data Type: bit
39557
+ * * Default Value: 0
39558
+ * * Description: Whether this object supports watermark-based incremental sync
39559
+ */
39560
+ get SupportsIncrementalSync(): boolean;
39561
+ set SupportsIncrementalSync(value: boolean);
39562
+ /**
39563
+ * * Field Name: SupportsWrite
39564
+ * * Display Name: Supports Write
39565
+ * * SQL Data Type: bit
39566
+ * * Default Value: 0
39567
+ * * Description: Whether data can be pushed back to this object via the API
39568
+ */
39569
+ get SupportsWrite(): boolean;
39570
+ set SupportsWrite(value: boolean);
39571
+ /**
39572
+ * * Field Name: DefaultQueryParams
39573
+ * * Display Name: Default Query Parameters
39574
+ * * SQL Data Type: nvarchar(MAX)
39575
+ * * Description: JSON object of default query parameters to include with every API request for this object
39576
+ */
39577
+ get DefaultQueryParams(): string | null;
39578
+ set DefaultQueryParams(value: string | null);
39579
+ /**
39580
+ * * Field Name: Configuration
39581
+ * * Display Name: Configuration
39582
+ * * SQL Data Type: nvarchar(MAX)
39583
+ * * Description: Freeform JSON for connector-specific configuration not covered by standard columns
39584
+ */
39585
+ get Configuration(): string | null;
39586
+ set Configuration(value: string | null);
39587
+ /**
39588
+ * * Field Name: Sequence
39589
+ * * Display Name: Sequence
39590
+ * * SQL Data Type: int
39591
+ * * Default Value: 0
39592
+ * * Description: Processing and display order. Lower numbers are processed first.
39593
+ */
39594
+ get Sequence(): number;
39595
+ set Sequence(value: number);
39596
+ /**
39597
+ * * Field Name: Status
39598
+ * * Display Name: Status
39599
+ * * SQL Data Type: nvarchar(25)
39600
+ * * Default Value: Active
39601
+ * * Value List Type: List
39602
+ * * Possible Values
39603
+ * * Active
39604
+ * * Deprecated
39605
+ * * Disabled
39606
+ * * Description: Active, Deprecated, or Disabled. Mirrors EntityField status values.
39607
+ */
39608
+ get Status(): 'Active' | 'Deprecated' | 'Disabled';
39609
+ set Status(value: 'Active' | 'Deprecated' | 'Disabled');
39610
+ /**
39611
+ * * Field Name: __mj_CreatedAt
39612
+ * * Display Name: Created At
39613
+ * * SQL Data Type: datetimeoffset
39614
+ * * Default Value: getutcdate()
39615
+ */
39616
+ get __mj_CreatedAt(): Date;
39617
+ /**
39618
+ * * Field Name: __mj_UpdatedAt
39619
+ * * Display Name: Updated At
39620
+ * * SQL Data Type: datetimeoffset
39621
+ * * Default Value: getutcdate()
39622
+ */
39623
+ get __mj_UpdatedAt(): Date;
39624
+ /**
39625
+ * * Field Name: Integration
39626
+ * * Display Name: Integration Name
39627
+ * * SQL Data Type: nvarchar(100)
39628
+ */
39629
+ get Integration(): string;
39630
+ }
38927
39631
  /**
38928
39632
  * MJ: Integration Source Types - strongly typed entity sub-class
38929
39633
  * * Schema: __mj