@memberjunction/core-entities 2.7.1 → 2.8.0

package/dist/generated/entity_subclasses.d.ts

@@ -4798,6 +4798,94 @@ export declare const ReportSchema: z.ZodObject<{
     OutputWorkflow?: string;
 }>;
 export type ReportEntityType = z.infer<typeof ReportSchema>;
+/**
+ * zod schema definition for the entity Resource Links
+ */
+export declare const ResourceLinkSchema: z.ZodObject<{
+    ID: z.ZodString;
+    UserID: z.ZodString;
+    ResourceTypeID: z.ZodString;
+    ResourceRecordID: z.ZodString;
+    FolderID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    User: z.ZodString;
+    ResourceType: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    UserID?: string;
+    User?: string;
+    ResourceTypeID?: string;
+    ResourceRecordID?: string;
+    FolderID?: string;
+    ResourceType?: string;
+}, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    UserID?: string;
+    User?: string;
+    ResourceTypeID?: string;
+    ResourceRecordID?: string;
+    FolderID?: string;
+    ResourceType?: string;
+}>;
+export type ResourceLinkEntityType = z.infer<typeof ResourceLinkSchema>;
+/**
+ * zod schema definition for the entity Resource Permissions
+ */
+export declare const ResourcePermissionSchema: z.ZodObject<{
+    ID: z.ZodString;
+    ResourceTypeID: z.ZodString;
+    ResourceRecordID: z.ZodString;
+    Type: z.ZodUnion<[z.ZodLiteral<"Role">, z.ZodLiteral<"User">]>;
+    StartSharingAt: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    EndSharingAt: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
+    RoleID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    UserID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    PermissionLevel: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"View">, z.ZodLiteral<"Edit">, z.ZodLiteral<"Owner">]>>>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    Status: z.ZodUnion<[z.ZodLiteral<"Pending">, z.ZodLiteral<"Approved">, z.ZodLiteral<"Rejected">, z.ZodLiteral<"Revoked">, z.ZodLiteral<"Requested">]>;
+    ResourceType: z.ZodString;
+    Role: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    User: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Status?: "Pending" | "Approved" | "Rejected" | "Revoked" | "Requested";
+    UserID?: string;
+    User?: string;
+    Type?: "User" | "Role";
+    RoleID?: string;
+    Role?: string;
+    ResourceTypeID?: string;
+    ResourceRecordID?: string;
+    ResourceType?: string;
+    StartSharingAt?: Date;
+    EndSharingAt?: Date;
+    PermissionLevel?: "View" | "Edit" | "Owner";
+}, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Status?: "Pending" | "Approved" | "Rejected" | "Revoked" | "Requested";
+    UserID?: string;
+    User?: string;
+    Type?: "User" | "Role";
+    RoleID?: string;
+    Role?: string;
+    ResourceTypeID?: string;
+    ResourceRecordID?: string;
+    ResourceType?: string;
+    StartSharingAt?: Date;
+    EndSharingAt?: Date;
+    PermissionLevel?: "View" | "Edit" | "Owner";
+}>;
+export type ResourcePermissionEntityType = z.infer<typeof ResourcePermissionSchema>;
 /**
  * zod schema definition for the entity Resource Types
  */
@@ -4810,7 +4898,9 @@ export declare const ResourceTypeSchema: z.ZodObject<{
     EntityID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     __mj_CreatedAt: z.ZodDate;
     __mj_UpdatedAt: z.ZodDate;
+    CategoryEntityID: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     Entity: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    CategoryEntity: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -4821,6 +4911,8 @@ export declare const ResourceTypeSchema: z.ZodObject<{
     Entity?: string;
     Icon?: string;
     DisplayName?: string;
+    CategoryEntityID?: string;
+    CategoryEntity?: string;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -4831,6 +4923,8 @@ export declare const ResourceTypeSchema: z.ZodObject<{
     Entity?: string;
     Icon?: string;
     DisplayName?: string;
+    CategoryEntityID?: string;
+    CategoryEntity?: string;
 }>;
 export type ResourceTypeEntityType = z.infer<typeof ResourceTypeSchema>;
 /**
@@ -5443,11 +5537,11 @@ export declare const UserNotificationSchema: z.ZodObject<{
     Message?: string;
     Title?: string;
     ResourceTypeID?: string;
+    ResourceRecordID?: string;
+    ResourceType?: string;
     ResourceConfiguration?: string;
     Unread?: boolean;
     ReadAt?: Date;
-    ResourceRecordID?: string;
-    ResourceType?: string;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -5457,11 +5551,11 @@ export declare const UserNotificationSchema: z.ZodObject<{
     Message?: string;
     Title?: string;
     ResourceTypeID?: string;
+    ResourceRecordID?: string;
+    ResourceType?: string;
     ResourceConfiguration?: string;
     Unread?: boolean;
     ReadAt?: Date;
-    ResourceRecordID?: string;
-    ResourceType?: string;
 }>;
 export type UserNotificationEntityType = z.infer<typeof UserNotificationSchema>;
 /**
@@ -19122,6 +19216,252 @@ export declare class ReportEntity extends BaseEntity<ReportEntityType> {
     */
     get OutputWorkflow(): string | null;
 }
+/**
+ * Resource Links - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: ResourceLink
+ * * Base View: vwResourceLinks
+ * * @description Table to track user links to shared resources such as views, dashboards, etc.
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class ResourceLinkEntity extends BaseEntity<ResourceLinkEntityType> {
+    /**
+    * Loads the Resource Links record from the database
+    * @param ID: string - primary key value to load the Resource Links record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof ResourceLinkEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    * * Description: Unique identifier for each resource link
+    */
+    get ID(): string;
+    /**
+    * * Field Name: UserID
+    * * Display Name: User ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Users (vwUsers.ID)
+    * * Description: Foreign key to the user linking the resource
+    */
+    get UserID(): string;
+    set UserID(value: string);
+    /**
+    * * Field Name: ResourceTypeID
+    * * Display Name: Resource Type ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Resource Types (vwResourceTypes.ID)
+    * * Description: Foreign key to the resource type (view, dashboard, etc.)
+    */
+    get ResourceTypeID(): string;
+    set ResourceTypeID(value: string);
+    /**
+    * * Field Name: ResourceRecordID
+    * * Display Name: Resource Record ID
+    * * SQL Data Type: nvarchar(255)
+    * * Description: ID of the specific resource being linked
+    */
+    get ResourceRecordID(): string;
+    set ResourceRecordID(value: string);
+    /**
+    * * Field Name: FolderID
+    * * Display Name: Folder ID
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Optional folder where the user organizes the linked resource
+    */
+    get FolderID(): string | null;
+    set FolderID(value: string | null);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: User
+    * * Display Name: User
+    * * SQL Data Type: nvarchar(100)
+    */
+    get User(): string;
+    /**
+    * * Field Name: ResourceType
+    * * Display Name: Resource Type
+    * * SQL Data Type: nvarchar(255)
+    */
+    get ResourceType(): string;
+}
+/**
+ * Resource Permissions - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: ResourcePermission
+ * * Base View: vwResourcePermissions
+ * * @description Table for managing sharing of resources to users or roles with time constraints and permission levels
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class ResourcePermissionEntity extends BaseEntity<ResourcePermissionEntityType> {
+    /**
+    * Loads the Resource Permissions record from the database
+    * @param ID: string - primary key value to load the Resource Permissions record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof ResourcePermissionEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    /**
+    * * Field Name: ResourceTypeID
+    * * Display Name: Resource Type ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Resource Types (vwResourceTypes.ID)
+    * * Description: Reference to the type of resource being shared (View, Dashboard, Report, etc.)
+    */
+    get ResourceTypeID(): string;
+    set ResourceTypeID(value: string);
+    /**
+    * * Field Name: ResourceRecordID
+    * * Display Name: Resource Record ID
+    * * SQL Data Type: nvarchar(255)
+    * * Description: ID of the specific resource being shared
+    */
+    get ResourceRecordID(): string;
+    set ResourceRecordID(value: string);
+    /**
+    * * Field Name: Type
+    * * Display Name: Type
+    * * SQL Data Type: nvarchar(10)
+    * * Value List Type: List
+    * * Possible Values
+    *   * Role
+    *   * User
+    * * Description: The level of sharing either Role or User
+    */
+    get Type(): 'Role' | 'User';
+    set Type(value: 'Role' | 'User');
+    /**
+    * * Field Name: StartSharingAt
+    * * Display Name: Start Sharing At
+    * * SQL Data Type: datetimeoffset
+    * * Description: Optional: Date when sharing starts
+    */
+    get StartSharingAt(): Date | null;
+    set StartSharingAt(value: Date | null);
+    /**
+    * * Field Name: EndSharingAt
+    * * Display Name: End Sharing At
+    * * SQL Data Type: datetimeoffset
+    * * Description: Optional: Date when sharing ends
+    */
+    get EndSharingAt(): Date | null;
+    set EndSharingAt(value: Date | null);
+    /**
+    * * Field Name: RoleID
+    * * Display Name: Role ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Roles (vwRoles.ID)
+    */
+    get RoleID(): string | null;
+    set RoleID(value: string | null);
+    /**
+    * * Field Name: UserID
+    * * Display Name: User ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Users (vwUsers.ID)
+    */
+    get UserID(): string | null;
+    set UserID(value: string | null);
+    /**
+    * * Field Name: PermissionLevel
+    * * Display Name: Permission Level
+    * * SQL Data Type: nvarchar(20)
+    * * Value List Type: List
+    * * Possible Values
+    *   * View
+    *   * Edit
+    *   * Owner
+    * * Description: Permission level defining the type of access (View, Edit, Owner)
+    */
+    get PermissionLevel(): 'View' | 'Edit' | 'Owner' | null;
+    set PermissionLevel(value: 'View' | 'Edit' | 'Owner' | null);
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Requested
+    * * Value List Type: List
+    * * Possible Values
+    *   * Requested
+    *   * Approved
+    *   * Rejected
+    *   * Revoked
+    * * Description: Status of the resource permission request. Possible values are Requested, Approved, Rejected, or Revoked.
+    */
+    get Status(): 'Requested' | 'Approved' | 'Rejected' | 'Revoked';
+    set Status(value: 'Requested' | 'Approved' | 'Rejected' | 'Revoked');
+    /**
+    * * Field Name: ResourceType
+    * * Display Name: Resource Type
+    * * SQL Data Type: nvarchar(255)
+    */
+    get ResourceType(): string;
+    /**
+    * * Field Name: Role
+    * * Display Name: Role
+    * * SQL Data Type: nvarchar(50)
+    */
+    get Role(): string | null;
+    /**
+    * * Field Name: User
+    * * Display Name: User
+    * * SQL Data Type: nvarchar(100)
+    */
+    get User(): string | null;
+}
 /**
  * Resource Types - strongly typed entity sub-class
  * * Schema: __mj
@@ -19221,11 +19561,26 @@ export declare class ResourceTypeEntity extends BaseEntity<ResourceTypeEntityTyp
     */
     get __mj_UpdatedAt(): Date;
     /**
+    * * Field Name: CategoryEntityID
+    * * Display Name: Category Entity ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Entities (vwEntities.ID)
+    * * Description: Nullable foreign key to the ID column in Entities entity, representing the category entity. ASSUMPTION: If provided, the assumption is there is a self-referencing/recursive foreign key establishing a hierarchy within the Category Entity, commonly called ParentID, but it can be named anything.
+    */
+    get CategoryEntityID(): string | null;
+    set CategoryEntityID(value: string | null);
+    /**
     * * Field Name: Entity
     * * Display Name: Entity
     * * SQL Data Type: nvarchar(255)
     */
     get Entity(): string | null;
+    /**
+    * * Field Name: CategoryEntity
+    * * Display Name: Category Entity
+    * * SQL Data Type: nvarchar(255)
+    */
+    get CategoryEntity(): string | null;
 }
 /**
  * Roles - strongly typed entity sub-class