@memberjunction/server 0.9.243 → 0.9.245

package/dist/generated/generated.js

@@ -103,7 +103,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Company_.prototype, "WorkflowsArray", void 0);
 exports.Company_ = Company_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'A list of organizational units within your business. These can be subsidiaries or divisions or other units. Companies are used to organizae employee records and also for separating integrations if you have multiple integrations of the same type of system.' })
 ], Company_);
 let CreateCompanyInput = class CreateCompanyInput {
 };
@@ -504,7 +504,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Employee_.prototype, "EmployeeSkillsArray", void 0);
 exports.Employee_ = Employee_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'A list of employees across all units of your organization' })
 ], Employee_);
 let CreateEmployeeInput = class CreateEmployeeInput {
 };
@@ -889,7 +889,7 @@ __decorate([
     __metadata("design:type", String)
 ], UserFavorite_.prototype, "EntityBaseView", void 0);
 exports.UserFavorite_ = UserFavorite_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Records that each user can mark as a favorite for easy access' })
 ], UserFavorite_);
 let CreateUserFavoriteInput = class CreateUserFavoriteInput {
 };
@@ -1659,18 +1659,17 @@ __decorate([
     __metadata("design:type", String)
 ], Role_.prototype, "Name", void 0);
 __decorate([
-    (0, server_1.Field)({ nullable: true }),
-    (0, class_validator_1.MaxLength)(1000),
+    (0, server_1.Field)({ nullable: true, description: 'Description of the role' }),
     __metadata("design:type", String)
 ], Role_.prototype, "Description", void 0);
 __decorate([
-    (0, server_1.Field)({ nullable: true }),
-    (0, class_validator_1.MaxLength)(100),
+    (0, server_1.Field)({ nullable: true, description: 'The unique ID of the role in the directory being used for authentication, for example an ID in Azure.' }),
+    (0, class_validator_1.MaxLength)(500),
     __metadata("design:type", String)
-], Role_.prototype, "AzureID", void 0);
+], Role_.prototype, "DirectoryID", void 0);
 __decorate([
-    (0, server_1.Field)(),
-    (0, class_validator_1.MaxLength)(100),
+    (0, server_1.Field)({ nullable: true, description: 'The name of the role in the database, this is used for auto-generating permission statements by CodeGen' }),
+    (0, class_validator_1.MaxLength)(500),
     __metadata("design:type", String)
 ], Role_.prototype, "SQLName", void 0);
 __decorate([
@@ -1704,7 +1703,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Role_.prototype, "QueryPermissionsArray", void 0);
 exports.Role_ = Role_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Roles are used for security administration and can have zero to many Users as members' })
 ], Role_);
 let UpdateRoleInput = class UpdateRoleInput {
 };
@@ -1724,9 +1723,9 @@ __decorate([
 __decorate([
     (0, server_1.Field)({ nullable: true }),
     __metadata("design:type", String)
-], UpdateRoleInput.prototype, "AzureID", void 0);
+], UpdateRoleInput.prototype, "DirectoryID", void 0);
 __decorate([
-    (0, server_1.Field)(),
+    (0, server_1.Field)({ nullable: true }),
     __metadata("design:type", String)
 ], UpdateRoleInput.prototype, "SQLName", void 0);
 exports.UpdateRoleInput = UpdateRoleInput = __decorate([
@@ -1983,7 +1982,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Skill_.prototype, "SkillsArray", void 0);
 exports.Skill_ = Skill_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'A hierarchical list of possible skills that are linked to Employees and can also be linked to any other entity' })
 ], Skill_);
 let RunSkillViewResult = class RunSkillViewResult {
 };
@@ -2162,7 +2161,7 @@ __decorate([
     __metadata("design:type", String)
 ], IntegrationURLFormat_.prototype, "FullURLFormat", void 0);
 exports.IntegrationURLFormat_ = IntegrationURLFormat_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Used to generate web links for end users to easily access resources in a source system. URL Formats support templating to inject various field values at run-time to take a user directly to a resource in a source system.' })
 ], IntegrationURLFormat_);
 let UpdateIntegrationURLFormatInput = class UpdateIntegrationURLFormatInput {
 };
@@ -2381,7 +2380,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Integration_.prototype, "CompanyIntegrationsArray", void 0);
 exports.Integration_ = Integration_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Catalog of all integrations that have been configured in the system.' })
 ], Integration_);
 let UpdateIntegrationInput = class UpdateIntegrationInput {
 };
@@ -2721,7 +2720,7 @@ __decorate([
     __metadata("design:type", Array)
 ], CompanyIntegration_.prototype, "CompanyIntegrationRecordMapsArray", void 0);
 exports.CompanyIntegration_ = CompanyIntegration_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Links individual company records to specific integrations' })
 ], CompanyIntegration_);
 let UpdateCompanyIntegrationInput = class UpdateCompanyIntegrationInput {
 };
@@ -3192,7 +3191,7 @@ __decorate([
     __metadata("design:type", Array)
 ], EntityField_.prototype, "EntityFieldValuesArray", void 0);
 exports.EntityField_ = EntityField_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'List of all fields within each entity with metadata about each field' })
 ], EntityField_);
 let CreateEntityFieldInput = class CreateEntityFieldInput {
 };
@@ -3926,7 +3925,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Entity_.prototype, "FileEntityRecordLinksArray", void 0);
 exports.Entity_ = Entity_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Catalog of all entities across all schemas' })
 ], Entity_);
 let CreateEntityInput = class CreateEntityInput {
 };
@@ -5008,7 +5007,7 @@ __decorate([
     __metadata("design:type", Array)
 ], User_.prototype, "DataContextsArray", void 0);
 exports.User_ = User_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'A list of all users who have or had access to the system' })
 ], User_);
 let CreateUserInput = class CreateUserInput {
 };
@@ -5717,7 +5716,7 @@ __decorate([
     __metadata("design:type", Number)
 ], EntityRelationship_.prototype, "DisplayUserViewID", void 0);
 exports.EntityRelationship_ = EntityRelationship_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Metadata about relationships between entities including display preferences for the UI' })
 ], EntityRelationship_);
 let CreateEntityRelationshipInput = class CreateEntityRelationshipInput {
 };
@@ -6392,7 +6391,7 @@ __decorate([
     __metadata("design:type", Array)
 ], UserView_.prototype, "DataContextItemsArray", void 0);
 exports.UserView_ = UserView_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Views are sets of records within a given entity defined by filtering rules. Views can be used programatically to retrieve dynamic sets of data and in user interfaces like MJ Explorer for end-user consumption.' })
 ], UserView_);
 let CreateUserViewInput = class CreateUserViewInput {
 };
@@ -7520,7 +7519,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Application_.prototype, "UserApplicationsArray", void 0);
 exports.Application_ = Application_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Applications are used to group entities in the user interface for ease of user access' })
 ], Application_);
 let UpdateApplicationInput = class UpdateApplicationInput {
 };
@@ -7771,7 +7770,7 @@ __decorate([
     __metadata("design:type", String)
 ], ApplicationEntity_.prototype, "EntityBaseTableCodeName", void 0);
 exports.ApplicationEntity_ = ApplicationEntity_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'List of entities within each application. An application can have any number of entities and an entity can be part of any number of applications.' })
 ], ApplicationEntity_);
 let CreateApplicationEntityInput = class CreateApplicationEntityInput {
 };
@@ -8067,8 +8066,8 @@ __decorate([
     __metadata("design:type", String)
 ], EntityPermission_.prototype, "Entity", void 0);
 __decorate([
-    (0, server_1.Field)(),
-    (0, class_validator_1.MaxLength)(100),
+    (0, server_1.Field)({ nullable: true }),
+    (0, class_validator_1.MaxLength)(500),
     __metadata("design:type", String)
 ], EntityPermission_.prototype, "RoleSQLName", void 0);
 __decorate([
@@ -8092,7 +8091,7 @@ __decorate([
     __metadata("design:type", String)
 ], EntityPermission_.prototype, "DeleteRLSFilter", void 0);
 exports.EntityPermission_ = EntityPermission_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Security settings for each entity' })
 ], EntityPermission_);
 let CreateEntityPermissionInput = class CreateEntityPermissionInput {
 };
@@ -9129,7 +9128,7 @@ __decorate([
     __metadata("design:type", Array)
 ], List_.prototype, "ListDetailsArray", void 0);
 exports.List_ = List_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Static lists are useful for controlling a set of data for a given entity. These can be used programatically for applications like logging and tracking long-running tasks and also by end users for tracking any particular list of records they want to directly control the set.' })
 ], List_);
 let CreateListInput = class CreateListInput {
 };
@@ -9413,7 +9412,7 @@ __decorate([
     __metadata("design:type", Number)
 ], ListDetail_.prototype, "Sequence", void 0);
 exports.ListDetail_ = ListDetail_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Tracks the records within each list.' })
 ], ListDetail_);
 let CreateListDetailInput = class CreateListDetailInput {
 };
@@ -9672,7 +9671,7 @@ __decorate([
     __metadata("design:type", Array)
 ], UserViewRun_.prototype, "UserViewRunDetailsArray", void 0);
 exports.UserViewRun_ = UserViewRun_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'User Views can be logged when run to capture the date and user that ran the view as well as the output results.' })
 ], UserViewRun_);
 let CreateUserViewRunInput = class CreateUserViewRunInput {
 };
@@ -9905,7 +9904,7 @@ __decorate([
     __metadata("design:type", Number)
 ], UserViewRunDetail_.prototype, "EntityID", void 0);
 exports.UserViewRunDetail_ = UserViewRunDetail_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Tracks the set of records that were included in each run of a given user view.' })
 ], UserViewRunDetail_);
 let CreateUserViewRunDetailInput = class CreateUserViewRunDetailInput {
 };
@@ -10792,7 +10791,7 @@ __decorate([
     __metadata("design:type", String)
 ], RecordChange_.prototype, "User", void 0);
 exports.RecordChange_ = RecordChange_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'For entities that have TrackRecordChanges=1, Record Changes will store the history of all changes made within the system. For integrations you can directly add values here if you have inbound signals indicating records were changed in a source system. This entity only automatically captures Record Changes if they were made within the system.' })
 ], RecordChange_);
 let CreateRecordChangeInput = class CreateRecordChangeInput {
 };
@@ -12401,7 +12400,7 @@ __decorate([
     __metadata("design:type", Array)
 ], AIModel_.prototype, "VectorIndexesArray", void 0);
 exports.AIModel_ = AIModel_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Catalog of all AI Models configured in the system.' })
 ], AIModel_);
 let UpdateAIModelInput = class UpdateAIModelInput {
 };
@@ -12689,7 +12688,7 @@ __decorate([
     __metadata("design:type", Array)
 ], AIAction_.prototype, "EntityAIActionsArray", void 0);
 exports.AIAction_ = AIAction_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'List of all actions that are possible across all AI Models' })
 ], AIAction_);
 let UpdateAIActionInput = class UpdateAIActionInput {
 };
@@ -12927,7 +12926,7 @@ __decorate([
     __metadata("design:type", String)
 ], AIModelAction_.prototype, "AIAction", void 0);
 exports.AIModelAction_ = AIModelAction_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Tracks the actions supported by each AI Model' })
 ], AIModelAction_);
 let UpdateAIModelActionInput = class UpdateAIModelActionInput {
 };
@@ -13167,7 +13166,7 @@ __decorate([
     __metadata("design:type", String)
 ], EntityAIAction_.prototype, "OutputEntity", void 0);
 exports.EntityAIAction_ = EntityAIAction_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Tracks the AI actions that should be invoked based on changes to records within a given entity.' })
 ], EntityAIAction_);
 let UpdateEntityAIActionInput = class UpdateEntityAIActionInput {
 };
@@ -13384,7 +13383,7 @@ __decorate([
     __metadata("design:type", Array)
 ], AIModelType_.prototype, "AIModelsArray", void 0);
 exports.AIModelType_ = AIModelType_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Types of AI Models' })
 ], AIModelType_);
 let UpdateAIModelTypeInput = class UpdateAIModelTypeInput {
 };
@@ -13802,7 +13801,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Queue_.prototype, "QueueTasksArray", void 0);
 exports.Queue_ = Queue_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Queues can be used to async execute long running tasks' })
 ], Queue_);
 let CreateQueueInput = class CreateQueueInput {
 };
@@ -14441,7 +14440,7 @@ __decorate([
     __metadata("design:type", String)
 ], Dashboard_.prototype, "User", void 0);
 exports.Dashboard_ = Dashboard_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Dashboards are used to group resources into a single display pane for an end-user' })
 ], Dashboard_);
 let CreateDashboardInput = class CreateDashboardInput {
 };
@@ -16010,7 +16009,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Tag_.prototype, "TaggedItemsArray", void 0);
 exports.Tag_ = Tag_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Tags are used to arbitrarily associate any record in any entity with addtional information.' })
 ], Tag_);
 let RunTagViewResult = class RunTagViewResult {
 };
@@ -16166,7 +16165,7 @@ __decorate([
     __metadata("design:type", String)
 ], TaggedItem_.prototype, "Entity", void 0);
 exports.TaggedItem_ = TaggedItem_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Tracks the links between any record in any entity with Tags' })
 ], TaggedItem_);
 let RunTaggedItemViewResult = class RunTaggedItemViewResult {
 };
@@ -16291,7 +16290,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Workspace_.prototype, "WorkspaceItemsArray", void 0);
 exports.Workspace_ = Workspace_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'A user can have one or more workspaces' })
 ], Workspace_);
 let CreateWorkspaceInput = class CreateWorkspaceInput {
 };
@@ -16579,7 +16578,7 @@ __decorate([
     __metadata("design:type", String)
 ], WorkspaceItem_.prototype, "ResourceType", void 0);
 exports.WorkspaceItem_ = WorkspaceItem_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Tracks the resources that are active within a given worksapce' })
 ], WorkspaceItem_);
 let CreateWorkspaceItemInput = class CreateWorkspaceItemInput {
 };
@@ -16867,7 +16866,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Dataset_.prototype, "DatasetItemsArray", void 0);
 exports.Dataset_ = Dataset_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Cacheable sets of data that can span one or more items' })
 ], Dataset_);
 let RunDatasetViewResult = class RunDatasetViewResult {
 };
@@ -17030,7 +17029,7 @@ __decorate([
     __metadata("design:type", String)
 ], DatasetItem_.prototype, "Entity", void 0);
 exports.DatasetItem_ = DatasetItem_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'A single item in a Dataset and can be sourced from multiple methods.' })
 ], DatasetItem_);
 let RunDatasetItemViewResult = class RunDatasetItemViewResult {
 };
@@ -18173,7 +18172,7 @@ __decorate([
     __metadata("design:type", Date)
 ], SchemaInfo_.prototype, "UpdatedAt", void 0);
 exports.SchemaInfo_ = SchemaInfo_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Tracks the schemas in the system and the ID ranges that are valid for entities within each schema.' })
 ], SchemaInfo_);
 let CreateSchemaInfoInput = class CreateSchemaInfoInput {
 };
@@ -19906,7 +19905,7 @@ __decorate([
     __metadata("design:type", Array)
 ], Query_.prototype, "DataContextItemsArray", void 0);
 exports.Query_ = Query_ = __decorate([
-    (0, server_1.ObjectType)()
+    (0, server_1.ObjectType)({ description: 'Catalog of stored queries. This is useful for any arbitrary query that is known to be performant and correct and can be reused. Queries can be viewed/run by a user, used programatically via RunQuery, and also used by AI systems for improved reliability instead of dynamically generated SQL. Queries can also improve security since they store the SQL instead of using dynamic SQL.' })
 ], Query_);
 let CreateQueryInput = class CreateQueryInput {
 };