@operato/scene-scichart 7.3.8 → 7.3.10

package/schema.graphql

@@ -201,6 +201,7 @@ type Attachment {
   refBy: String
   refType: String
   size: String!
+  tags: Object
   updatedAt: DateTimeISO!
   updater: User
 }
@@ -219,6 +220,7 @@ input AttachmentPatch {
   name: String
   refBy: String
   refType: String
+  tags: Object
 }
 
 """Entity for AttributeSet"""
@@ -747,7 +749,7 @@ scalar EmailAddress @specifiedBy(url: "https://html.spec.whatwg.org/multipage/in
 """Entity for Employee"""
 type Employee {
   active: Boolean
-  address: String!
+  address: String
   alias: String
   approvalLines: [ApprovalLine!]!
   contact: Contact
@@ -787,9 +789,10 @@ type EmployeeList {
 input EmployeePatch {
   active: Boolean
   alias: String
+  contact: ObjectRefForContact
   controlNo: String
   cuFlag: String
-  department: ObjectRef
+  department: ObjectRefForDepartment
   hiredOn: String
   id: ID
   jobPosition: String
@@ -1502,7 +1505,9 @@ type Mutation {
   """To activate user"""
   activateUser(userId: String!): Boolean!
 
-  """To attach a contact on Employee"""
+  """
+  Attaches an existing contact to an employee. The contact is identified by its ID and the employee is identified by their ID.
+  """
   attachContact(contactId: String!, id: String!): Employee!
   cancelInvitation(email: EmailAddress!, reference: String!, type: String!): Boolean!
 
@@ -1559,7 +1564,9 @@ type Mutation {
   """To create domain (Only superuser is granted this privilege.)"""
   createDomain(domainInput: DomainPatch!): Domain!
 
-  """To create new Employee"""
+  """
+  Creates a new employee record with the provided details. Optionally associates the employee with a supervisor, department, and system user. If a photo is provided, it will be attached to the employee record.
+  """
   createEmployee(employee: NewEmployee!): Employee!
 
   """To create new Entity"""
@@ -1598,6 +1605,9 @@ type Mutation {
   """To create new ApprovalLine for current user"""
   createMyApprovalLine(approvalLine: NewApprovalLine!): ApprovalLine!
 
+  """To create my new PagePreference"""
+  createMyPagePreference(pagePreference: NewPagePreference!): PagePreference!
+
   """To create new Notification"""
   createNotification(notification: NewNotification!): Notification!
 
@@ -1607,6 +1617,12 @@ type Mutation {
   """To create new Oauth2Client"""
   createOauth2Client(oauth2Client: NewOauth2Client!): Oauth2Client!
 
+  """To create new PDFRelease"""
+  createPDFRelease(pdfRelease: NewPDFRelease!): PDFRelease!
+
+  """To create new PDFTemplate"""
+  createPDFTemplate(pdfTemplate: NewPDFTemplate!): PDFTemplate!
+
   """To create new PayloadLog"""
   createPayloadLog(payloadLog: NewPayloadLog!): PayloadLog!
 
@@ -1639,6 +1655,9 @@ type Mutation {
 
   """To create new user"""
   createUser(user: NewUser!): User!
+
+  """To create new UserPreference"""
+  createUserPreference(preference: NewUserPreference!): UserPreference!
   deleteAppBinding(id: String!): Boolean!
 
   """To delete appliance"""
@@ -1710,10 +1729,14 @@ type Mutation {
   """To delete multiple domains (Only superuser is granted this privilege.)"""
   deleteDomains(names: [String!]!): Boolean!
 
-  """To delete Employee"""
+  """
+  Deletes an employee record identified by the given ID. Also deletes any attachments associated with the employee.
+  """
   deleteEmployee(id: String!): Boolean!
 
-  """To delete multiple Employees"""
+  """
+  Deletes multiple employee records identified by the given IDs. Also deletes any attachments associated with each employee.
+  """
   deleteEmployees(ids: [String!]!): Boolean!
 
   """To delete multiple Entities"""
@@ -1779,6 +1802,12 @@ type Mutation {
   """To delete multiple ApprovalLines for current user"""
   deleteMyApprovalLines(ids: [String!]!): Boolean!
 
+  """To delete my PagePreference"""
+  deleteMyPagePreference(element: String!, page: String!): Boolean!
+
+  """To delete my preference"""
+  deleteMyUserPreference(element: String!, key: String!): Boolean!
+
   """To delete Notification"""
   deleteNotification(id: String!): Boolean!
 
@@ -1797,6 +1826,24 @@ type Mutation {
   """To delete multiple Oauth2Clients"""
   deleteOauth2Clients(ids: [String!]!): Boolean!
 
+  """To delete PDFRelease"""
+  deletePDFRelease(id: String!): Boolean!
+
+  """To delete multiple PDFReleases"""
+  deletePDFReleases(ids: [String!]!): Boolean!
+
+  """To delete PDFTemplate"""
+  deletePDFTemplate(id: String!): Boolean!
+
+  """To delete multiple PDFTemplates"""
+  deletePDFTemplates(ids: [String!]!): Boolean!
+
+  """To delete PagePreference"""
+  deletePagePreference(id: String!): Boolean!
+
+  """To delete multiple PagePreferences"""
+  deletePagePreferences(ids: [String!]!): Boolean!
+
   """To delete multiple partnerSettings"""
   deletePartnerSettings(ids: [String!]!): Boolean!
 
@@ -1860,10 +1907,18 @@ type Mutation {
   """To delete a user"""
   deleteUser(email: EmailAddress!): Boolean!
 
+  """To delete UserPreference"""
+  deleteUserPreference(id: String!): Boolean!
+
+  """To delete multiple UserPreferences"""
+  deleteUserPreferences(ids: [String!]!): Boolean!
+
   """To delete some users"""
   deleteUsers(emails: [String!]!): Boolean!
 
-  """To detach a contact from Employee"""
+  """
+  Detaches an existing contact from an employee. The employee is identified by their ID.
+  """
   detachContact(id: String!): Employee!
 
   """To disconnect a connection"""
@@ -1905,7 +1960,9 @@ type Mutation {
   """To import multiple Departments"""
   importDepartments(departments: [DepartmentPatch!]!): Boolean!
 
-  """To import multiple Employees"""
+  """
+  Imports multiple employee records into the system. Each employee record must be provided in the EmployeePatch format.
+  """
   importEmployees(employees: [EmployeePatch!]!): Boolean!
 
   """To import multiple MenuButtons"""
@@ -1932,6 +1989,12 @@ type Mutation {
   """To import multiple Oauth2Clients"""
   importOauth2Clients(oauth2Clients: [Oauth2ClientPatch!]!): Boolean!
 
+  """To import multiple PDFReleases"""
+  importPDFReleases(pdfReleases: [PDFReleasePatch!]!): Boolean!
+
+  """To import multiple PDFTemplates"""
+  importPDFTemplates(pdfTemplates: [PDFTemplatePatch!]!): Boolean!
+
   """To import multiple scenarios"""
   importScenarios(scenarios: [ScenarioPatch!]!): Boolean!
 
@@ -1979,6 +2042,14 @@ type Mutation {
     visibility: String!
   ): BoardTemplate!
 
+  """
+  Registers an existing employee as a system user, granting them access to the system. The employee is identified by their ID.
+  """
+  registerEmployeeAsSystemUser(
+    """Employee Id"""
+    employeeId: String!
+  ): Boolean!
+
   """To release a Board"""
   releaseBoard(id: String!): Board!
   renewApplicationAccessToken(id: String!, scope: String!): AccessToken!
@@ -2068,7 +2139,9 @@ type Mutation {
   """To update multiple domains (Only superuser is granted this privilege.)"""
   updateDomains(patches: [DomainPatch!]!): Boolean!
 
-  """To modify Employee information"""
+  """
+  Updates the details of an existing employee identified by the given ID. Optionally updates the supervisor, department, system user, and photo associated with the employee.
+  """
   updateEmployee(id: String!, patch: EmployeePatch!): Employee!
 
   """To modify Entity' information"""
@@ -2123,7 +2196,9 @@ type Mutation {
   """To modify multiple Departments' information"""
   updateMultipleDepartment(patches: [DepartmentPatch!]!): [Department!]!
 
-  """To modify multiple Employees' information"""
+  """
+  Updates or creates multiple employee records based on the provided patches. New employees are created if the "cuFlag" is "+", and existing employees are updated if the "cuFlag" is "M".
+  """
   updateMultipleEmployee(patches: [EmployeePatch!]!): [Employee!]!
 
   """To modify multiple Entitys' information"""
@@ -2144,6 +2219,12 @@ type Mutation {
   """To modify multiple NotificationRules' information"""
   updateMultipleNotificationRule(patches: [NotificationRulePatch!]!): [NotificationRule!]!
 
+  """To modify multiple PDFReleases' information"""
+  updateMultiplePDFRelease(patches: [PDFReleasePatch!]!): [PDFRelease!]!
+
+  """To modify multiple PDFTemplates' information"""
+  updateMultiplePDFTemplate(patches: [PDFTemplatePatch!]!): [PDFTemplate!]!
+
   """To modify multiple PartnerSettings' information"""
   updateMultiplePartnerSetting(patches: [PartnerSettingPatch!]!): [PartnerSetting!]!
 
@@ -2177,6 +2258,12 @@ type Mutation {
   """To modify ApprovalLine information for current user"""
   updateMyApprovalLine(id: String!, patch: ApprovalLinePatch!): ApprovalLine!
 
+  """To create or update my PagePreference"""
+  updateMyPagePreference(element: String!, page: String!, preference: Object!): PagePreference!
+
+  """To create or update my preference"""
+  updateMyUserPreference(key: String!, preference: Object!): UserPreference!
+
   """To modify Notification information"""
   updateNotification(id: String!, patch: NotificationPatch!): Notification!
 
@@ -2186,6 +2273,12 @@ type Mutation {
   """To modify Oauth2Client information"""
   updateOauth2Client(id: String!, patch: Oauth2ClientPatch!): Oauth2Client!
 
+  """To modify PDFRelease information"""
+  updatePDFRelease(id: String!, patch: PDFReleasePatch!): PDFRelease!
+
+  """To modify PDFTemplate information"""
+  updatePDFTemplate(id: String!, patch: PDFTemplatePatch!): PDFTemplate!
+
   """To modify PayloadLog information"""
   updatePayloadLog(id: String!, patch: PayloadLogPatch!): PayloadLog!
 
@@ -2231,6 +2324,9 @@ type Mutation {
   """To modify user information"""
   updateUser(email: EmailAddress!, patch: UserPatch!): User!
 
+  """To modify UserPreference information"""
+  updateUserPreference(id: String!, patch: UserPreferencePatch!): UserPreference!
+
   """To update roles for a user"""
   updateUserRoles(availableRoles: [ObjectRef!]!, selectedRoles: [ObjectRef!]!, userId: String!): User!
 }
@@ -2269,6 +2365,7 @@ input NewAttachment {
   file: Upload!
   refBy: String
   refType: String
+  tags: Object
 }
 
 input NewAttributeSet {
@@ -2353,8 +2450,9 @@ input NewDepartment {
 input NewEmployee {
   active: Boolean
   alias: String
+  contact: ObjectRefForContact
   controlNo: String!
-  department: ObjectRef
+  department: ObjectRefForDepartment
   extension: String
   hiredOn: String
   jobPosition: String
@@ -2630,6 +2728,35 @@ input NewOauth2Client {
   webhook: String
 }
 
+input NewPDFRelease {
+  active: Boolean
+  description: String
+  name: String!
+  params: String
+  state: PDFReleaseStatus
+}
+
+input NewPDFTemplate {
+  active: Boolean
+  content_template: String
+  cover_template: String
+  description: String
+  footer_template: String
+  header_template: String
+  last_template: String
+  name: String!
+  page_size: String = "A4"
+  state: PDFTemplateStatus
+  watermark: String
+}
+
+input NewPagePreference {
+  element: String
+  page: String
+  preference: Object!
+  user: ObjectRef!
+}
+
 input NewPayloadLog {
   description: String
   name: String!
@@ -2755,6 +2882,12 @@ input NewUserByDomainWizardInput {
   roles: [NewRole!]!
 }
 
+input NewUserPreference {
+  key: String!
+  preference: Object!
+  user: ObjectRef!
+}
+
 """Entity for Notification"""
 type Notification {
   body: String
@@ -2922,6 +3055,34 @@ input ObjectRefApprovalLineOwnerType {
   name: String
 }
 
+input ObjectRefForContact {
+  address: String
+
+  """Field description"""
+  description: String
+  email: EmailAddress
+
+  """Field id"""
+  id: ID!
+
+  """Field name"""
+  name: String
+  phone: String
+}
+
+input ObjectRefForDepartment {
+  controlNo: String
+
+  """Field description"""
+  description: String
+
+  """Field id"""
+  id: ID!
+
+  """Field name"""
+  name: String
+}
+
 input ObjectRefForEmployee {
   active: Boolean
   alias: String
@@ -2978,6 +3139,111 @@ enum OrgMemberTargetType {
   Role
 }
 
+"""Entity for PDFRelease"""
+type PDFRelease {
+  active: Boolean
+  createdAt: DateTimeISO
+  creator: User
+  deletedAt: DateTimeISO
+  description: String
+  domain: Domain
+  filePath: String
+  fileUrl: String
+  id: ID!
+  name: String
+  state: String
+  template: PDFTemplate!
+  templateId: String!
+  updatedAt: DateTimeISO
+  updater: User
+}
+
+type PDFReleaseList {
+  items: [PDFRelease!]!
+  total: Int!
+}
+
+input PDFReleasePatch {
+  active: Boolean
+  cuFlag: String
+  description: String
+  id: ID
+  name: String
+  state: PDFReleaseStatus
+}
+
+"""state enumeration of a PDFRelease"""
+enum PDFReleaseStatus {
+  failed
+  published
+}
+
+"""Entity for PDFTemplate"""
+type PDFTemplate {
+  active: Boolean
+  content_template: String
+  cover_template: String
+  createdAt: DateTimeISO
+  creator: User
+  description: String
+  domain: Domain
+  footer_template: String
+  header_template: String
+  id: ID!
+  last_template: String
+  name: String
+  page_size: String
+  state: String
+  updatedAt: DateTimeISO
+  updater: User
+  watermark: String
+}
+
+type PDFTemplateList {
+  items: [PDFTemplate!]!
+  total: Int!
+}
+
+input PDFTemplatePatch {
+  active: Boolean
+  content_template: String
+  cover_template: String
+  cuFlag: String
+  description: String
+  footer_template: String
+  header_template: String
+  id: ID
+  last_template: String
+  name: String
+  page_size: String = "A4"
+  state: PDFTemplateStatus
+}
+
+"""state enumeration of a PDF Template"""
+enum PDFTemplateStatus {
+  draft
+  released
+}
+
+"""Entity for PagePreference"""
+type PagePreference {
+  createdAt: DateTimeISO
+  creator: User
+  domain: Domain!
+  element: String
+  id: ID!
+  page: String
+  preference: Object
+  updatedAt: DateTimeISO
+  updater: User
+  user: User!
+}
+
+type PagePreferenceList {
+  items: [PagePreference!]!
+  total: Int!
+}
+
 input Pagination {
   limit: Int
   page: Int
@@ -3029,6 +3295,18 @@ input PartnerSettingPatch {
   value: String
 }
 
+type PasswordRule {
+  allowRepeat: Boolean
+  digit: Boolean
+  looseCharacterLength: Float
+  lowerCase: Boolean
+  specialCharacter: Boolean
+  tightCharacterLength: Float
+  upperCase: Boolean
+  useLoosePattern: Boolean
+  useTightPattern: Boolean
+}
+
 """Entity for PayloadLog"""
 type PayloadLog {
   createdAt: DateTimeISO
@@ -3205,6 +3483,12 @@ type PropertySpec {
 
 type Query {
   APIDocCompletion(input: APIDocCompletionInput!): APIDocCompletionOutput!
+
+  """To fetch a PDFTemplate"""
+  PDFTemplate(id: String!): PDFTemplate
+
+  """To fetch multiple PDFTemplates"""
+  PDFTemplates(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PDFTemplateList!
   appBinding(id: String!): AppBinding!
   appBindings(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AppBindingList!
 
@@ -3277,19 +3561,25 @@ type Query {
   boardsCreatedByMe(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardList!
   chatCompletion(input: ChatCompletionInput!): ChatCompletionOutput!
 
-  """To check if system would provide default password to create new user"""
+  """
+  Checks if the system is configured to provide a default password for new users.
+  """
   checkDefaultPassword: Boolean!
 
-  """To check if system would provide default password to create new user"""
+  """
+  Determines whether the system provides a default password when creating a new user.
+  """
   checkResettablePasswordToDefault: Boolean!
 
   """To fetch the preset of role for new user"""
   checkRolePreset: [Role!]!
 
-  """To check if current user is belongs to current domain"""
+  """
+  Checks if the current authenticated user belongs to the current domain.
+  """
   checkUserBelongsDomain: Boolean!
 
-  """..."""
+  """Checks if a user with the given email address exists in the system."""
   checkUserExistence(email: EmailAddress!): Boolean!
 
   """To fetch common approval lines"""
@@ -3349,10 +3639,14 @@ type Query {
   """To fetch multiple appliance"""
   edges(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApplianceList!
 
-  """To fetch a Employee"""
+  """
+  Fetches a specific employee by their unique ID. Returns the employee object if found, or null if not found.
+  """
   employee(id: String!): Employee
 
-  """To fetch multiple Employees"""
+  """
+  Fetches a list of employees based on provided query parameters. Supports searching by name, control number, and alias.
+  """
   employees(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): EmployeeList!
 
   """To fetch multiple Entities"""
@@ -3461,9 +3755,24 @@ type Query {
   """To fetch my notifications"""
   myNotifications(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): NotificationList!
 
+  """To fetch a User's own PagePreference"""
+  myPageAllPreferences(page: String!): [PagePreference!]
+
+  """To fetch a User's own PagePreference"""
+  myPagePreference(element: String!, page: String!): PagePreference
+
+  """To fetch multiple PagePreferences"""
+  myPagePreferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PagePreferenceList!
+
   """To fetch roles of current user"""
   myRoles: [Role!]!
 
+  """To fetch a User's own UserPreference"""
+  myUserPreference(element: String!, key: String!): UserPreference
+
+  """To fetch multiple UserPreferences"""
+  myUserPreferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): UserPreferenceList!
+
   """To fetch a Notification"""
   notification(id: String!): Notification
 
@@ -3482,6 +3791,9 @@ type Query {
   """To fetch multiple Oauth2Clients"""
   oauth2Clients(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): Oauth2ClientList!
 
+  """To fetch a PagePreference"""
+  pagePreference(id: String!): PagePreference
+
   """To fetch specific domain's CommonCodes by given name"""
   partnerCommonCode(name: String!, partnerDomainId: String!): CommonCode!
 
@@ -3492,12 +3804,23 @@ type Query {
   partnerSettings(filters: [Filter!]!, pagination: Pagination!, partnerDomain: ObjectRef!, sortings: [Sorting!]!): PartnerSettingList!
   partners(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PartnerList!
 
+  """
+  Retrieves the current password rule configuration for the system, such as required character types and minimum length.
+  """
+  passwordRule: PasswordRule!
+
   """To fetch a PayloadLog"""
   payloadLog(id: String!): PayloadLog!
 
   """To fetch multiple PayloadLogs"""
   payloadLogs(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PayloadLogList!
 
+  """To fetch a PDFRelease"""
+  pdfRelease(id: String!): PDFRelease
+
+  """To fetch multiple PDFReleases"""
+  pdfReleases(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PDFReleaseList!
+
   """To fetch a PlayGroup"""
   playGroup(id: String!): PlayGroup
 
@@ -3507,6 +3830,9 @@ type Query {
   """To fetch multiple PlayGroups"""
   playGroups(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PlayGroupList!
 
+  """To fetch a UserPreference"""
+  preference(id: String!): UserPreference
+
   """To fetch a PrinterDevice"""
   printerDevice(id: String!): PrinterDevice!
 
@@ -3586,7 +3912,7 @@ type Query {
   """To fetch multiple Themes"""
   themes(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ThemeList!
 
-  """To fetch user"""
+  """Fetches a user by their email address within the current domain."""
   user(email: EmailAddress!): User!
 
   """To fetch Menus by role"""
@@ -3595,7 +3921,9 @@ type Query {
   """To fetch roles of a user"""
   userRoles(userId: String!): [UserRole!]!
 
-  """To fetch multiple users"""
+  """
+  Fetches a list of users based on provided search parameters within the current domain.
+  """
   users(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): UserList!
   vendors: [Domain!]!
 }
@@ -4074,6 +4402,32 @@ input UserPatch {
   userType: String
 }
 
+"""Entity for UserPreference"""
+type UserPreference {
+  createdAt: DateTimeISO
+  creator: User
+  domain: Domain
+  id: ID!
+  key: String
+  preference: Object
+  updatedAt: DateTimeISO
+  updater: User
+  user: User!
+}
+
+type UserPreferenceList {
+  items: [UserPreference!]!
+  total: Int!
+}
+
+input UserPreferencePatch {
+  cuFlag: String
+  id: ID
+  key: String!
+  preference: Object!
+  user: ObjectRef!
+}
+
 type UserRole {
   assigned: Boolean
   description: String