@things-factory/operato-board 9.0.0-beta.80 → 9.0.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.
package/schema.graphql CHANGED
@@ -12,114 +12,267 @@ type APIDocCompletionOutput {
12
12
  message: String
13
13
  }
14
14
 
15
+ """Represents a pair of access and refresh tokens."""
15
16
  type AccessToken {
17
+ """The access token for API authentication."""
16
18
  accesToken: String!
19
+
20
+ """The refresh token to obtain a new access token."""
17
21
  refreshToken: String!
18
22
  }
19
23
 
20
- """Any Scalar type (String, Boolean, Int, Float, Object, List)"""
24
+ """
25
+ A flexible scalar type that can represent any GraphQL value, including String, Boolean, Int, Float, Object, or List. Use this type for fields or arguments that may accept or return various data types.
26
+ """
21
27
  scalar Any
22
28
 
29
+ """
30
+ Represents a user that is bound to a specific application, with an associated scope and refresh token.
31
+ """
23
32
  type AppBinding {
33
+ """The application to which the user is bound."""
24
34
  application: Application
35
+
36
+ """Timestamp when the user account was created."""
25
37
  createdAt: DateTimeISO
26
38
  creator: User!
39
+
40
+ """Optional description or note about the user."""
27
41
  description: String
42
+
43
+ """Domains (organizations, companies, etc.) the user belongs to."""
28
44
  domains: [Domain!]!
45
+
46
+ """Email address of the user."""
29
47
  email: EmailAddress!
48
+
49
+ """Unique identifier for the user."""
30
50
  id: ID!
51
+
52
+ """Locale or language preference for the user."""
31
53
  locale: String
54
+
55
+ """Full name of the user."""
32
56
  name: String
57
+
58
+ """Whether the user is the owner of the domain (not persisted in DB)."""
33
59
  owner: Boolean
60
+
61
+ """Reference information for the user (external system, etc.)."""
34
62
  reference: String
63
+
64
+ """The refresh token for the application."""
35
65
  refreshToken: String
66
+
67
+ """Roles assigned to the user."""
36
68
  roles: [Role!]!
69
+
70
+ """The scope of access granted to the application."""
37
71
  scope: String
72
+
73
+ """Single sign-on (SSO) identifier for federated authentication."""
38
74
  ssoId: String
75
+
76
+ """Current status of the user account."""
39
77
  status: String!
78
+
79
+ """Timestamp when the user account was last updated."""
40
80
  updatedAt: DateTimeISO
41
81
  updater: User!
82
+
83
+ """Type or category of the user (e.g., user, application, appliance)."""
42
84
  userType: String
85
+
86
+ """Unique username for the user."""
43
87
  username: String
88
+
89
+ """External authentication providers linked to the user."""
44
90
  usersAuthProviders: [UsersAuthProviders!]
45
91
  }
46
92
 
93
+ """A paginated list of application bindings."""
47
94
  type AppBindingList {
95
+ """The list of application binding items."""
48
96
  items: [AppBinding!]
97
+
98
+ """The total number of application bindings."""
49
99
  total: Int
50
100
  }
51
101
 
102
+ """
103
+ Represents a physical or virtual appliance that can be managed by the system.
104
+ """
52
105
  type Appliance {
106
+ """The access token for the appliance."""
53
107
  accessToken: String
108
+
109
+ """The brand or manufacturer of the appliance."""
54
110
  brand: String
111
+
112
+ """The timestamp when the appliance was created."""
55
113
  createdAt: DateTimeISO
114
+
115
+ """The user who created the appliance."""
56
116
  creator: User
117
+
118
+ """A description of the appliance."""
57
119
  description: String
120
+
121
+ """The domain to which the appliance belongs."""
58
122
  domain: Domain!
123
+
124
+ """Unique identifier for the appliance."""
59
125
  id: ID!
126
+
127
+ """The model of the appliance."""
60
128
  model: String
129
+
130
+ """The name of the appliance."""
61
131
  name: String!
132
+
133
+ """The network mask of the appliance."""
62
134
  netmask: String
135
+
136
+ """The serial number of the appliance."""
63
137
  serialNo: String
138
+
139
+ """The timestamp when the appliance was last updated."""
64
140
  updatedAt: DateTimeISO
141
+
142
+ """The user who last updated the appliance."""
65
143
  updater: User
66
144
  }
67
145
 
146
+ """A paginated list of appliances."""
68
147
  type ApplianceList {
148
+ """The list of appliance items."""
69
149
  items: [Appliance!]
150
+
151
+ """The total number of appliances."""
70
152
  total: Int
71
153
  }
72
154
 
155
+ """Input for updating (patching) an existing appliance."""
73
156
  input AppliancePatch {
157
+ """The new brand for the appliance."""
74
158
  brand: String
159
+
160
+ """The new description for the appliance."""
75
161
  description: String
162
+
163
+ """The unique identifier of the appliance to update."""
76
164
  id: ID
165
+
166
+ """The new model for the appliance."""
77
167
  model: String
168
+
169
+ """The new name for the appliance."""
78
170
  name: String
171
+
172
+ """The new network mask for the appliance."""
79
173
  netmask: String
174
+
175
+ """The new serial number for the appliance."""
80
176
  serialNo: String
81
177
  }
82
178
 
179
+ """
180
+ Represents a third-party application that can be integrated with the system.
181
+ """
83
182
  type Application {
84
183
  accessTokenUrl: String!
184
+
185
+ """The unique key for the application (client ID)."""
85
186
  appKey: String
187
+
188
+ """The secret key for the application (client secret)."""
86
189
  appSecret: String
87
190
  authUrl: String!
88
191
  availableScopes: String!
192
+
193
+ """The timestamp when the application was created."""
89
194
  createdAt: DateTimeISO
195
+
196
+ """The user who created the application."""
90
197
  creator: User
198
+
199
+ """A description of the application."""
91
200
  description: String
201
+
202
+ """The domain to which the application belongs."""
92
203
  domain: Domain!
204
+
205
+ """The contact email for the application."""
93
206
  email: EmailAddress!
207
+
208
+ """A URL to the icon for the application."""
94
209
  icon: String
210
+
211
+ """Unique identifier for the application."""
95
212
  id: ID!
213
+
214
+ """The name of the application."""
96
215
  name: String!
216
+
217
+ """The redirect URL for OAuth2 flows."""
97
218
  redirectUrl: String!
219
+
220
+ """The status of the application (e.g., DRAFT, ACTIVATED)."""
98
221
  status: String!
222
+
223
+ """The type of the application."""
99
224
  type: String!
225
+
226
+ """The timestamp when the application was last updated."""
100
227
  updatedAt: DateTimeISO
228
+
229
+ """The user who last updated the application."""
101
230
  updater: User
231
+
232
+ """The URL of the application."""
102
233
  url: String!
234
+
235
+ """The webhook URL for the application to receive events."""
103
236
  webhook: String
104
237
  }
105
238
 
239
+ """A paginated list of applications."""
106
240
  type ApplicationList {
241
+ """The list of application items."""
107
242
  items: [Application!]
243
+
244
+ """The total number of applications."""
108
245
  total: Int
109
246
  }
110
247
 
248
+ """Input for updating (patching) an existing application."""
111
249
  input ApplicationPatch {
250
+ """The new description for the application."""
112
251
  description: String
252
+
253
+ """The new contact email for the application."""
113
254
  email: EmailAddress
255
+
256
+ """The new icon URL for the application."""
114
257
  icon: String
258
+
259
+ """The new name for the application."""
115
260
  name: String
261
+
262
+ """The new redirect URL for the application."""
116
263
  redirectUrl: String
264
+
265
+ """The new type for the application."""
117
266
  type: ApplicationType
267
+
268
+ """The new URL for the application."""
118
269
  url: String
270
+
271
+ """The new webhook URL for the application."""
119
272
  webhook: String
120
273
  }
121
274
 
122
- """state enumeration of a application"""
275
+ """The type of an application."""
123
276
  enum ApplicationType {
124
277
  MMS
125
278
  OTHERS
@@ -224,38 +377,82 @@ input AttachmentPatch {
224
377
  tags: Object
225
378
  }
226
379
 
227
- """Entity for AttributeSet"""
380
+ """
381
+ Represents an AttributeSet entity, which defines a set of attributes for a specific entity type.
382
+ """
228
383
  type AttributeSet {
384
+ """The date and time when this AttributeSet was created."""
229
385
  createdAt: DateTimeISO
386
+
387
+ """A description of the AttributeSet."""
230
388
  description: String
389
+
390
+ """The name of the entity this AttributeSet is associated with."""
231
391
  entity: String
392
+
393
+ """The unique identifier of the AttributeSet."""
232
394
  id: ID!
395
+
396
+ """A list of items (attributes) included in this AttributeSet."""
233
397
  items: [AttributeSetItem!]
398
+
399
+ """The date and time when this AttributeSet was last updated."""
234
400
  updatedAt: DateTimeISO
235
401
  }
236
402
 
237
- """Entity for AttributeSetItem"""
403
+ """
404
+ Represents an item (attribute) within an AttributeSet, including its type, options, and metadata.
405
+ """
238
406
  type AttributeSetItem {
407
+ """Whether the attribute item is active."""
239
408
  active: Boolean
409
+
410
+ """A description of the attribute item."""
240
411
  description: String
412
+
413
+ """Whether the attribute item is hidden."""
241
414
  hidden: Boolean
415
+
416
+ """The name of the attribute item."""
242
417
  name: String!
418
+
419
+ """Options or additional settings for the attribute item."""
243
420
  options: Object
421
+
422
+ """A tag for categorizing or identifying the attribute item."""
244
423
  tag: String
245
- type: String
424
+
425
+ """The type of the attribute item (e.g., number, text, boolean)."""
426
+ type: AttributeSetItemType
246
427
  }
247
428
 
429
+ """Input type for creating or updating an AttributeSetItem."""
248
430
  input AttributeSetItemPatch {
431
+ """Whether the attribute item is active."""
249
432
  active: Boolean
433
+
434
+ """A description of the attribute item."""
250
435
  description: String
436
+
437
+ """Whether the attribute item is hidden."""
251
438
  hidden: Boolean
439
+
440
+ """The name of the attribute item."""
252
441
  name: String
442
+
443
+ """Options or additional settings for the attribute item."""
253
444
  options: Object
445
+
446
+ """A tag for categorizing or identifying the attribute item."""
254
447
  tag: String
448
+
449
+ """The type of the attribute item (e.g., number, text, boolean)."""
255
450
  type: AttributeSetItemType
256
451
  }
257
452
 
258
- """type enumeration of a attribute-set-item"""
453
+ """
454
+ Enumeration of possible types for an attribute set item, such as number, text, boolean, select, date, datetime, or file.
455
+ """
259
456
  enum AttributeSetItemType {
260
457
  boolean
261
458
  date
@@ -266,178 +463,450 @@ enum AttributeSetItemType {
266
463
  text
267
464
  }
268
465
 
466
+ """A paginated list of AttributeSet entities."""
269
467
  type AttributeSetList {
468
+ """The list of AttributeSet entities."""
270
469
  items: [AttributeSet!]!
470
+
471
+ """The total number of AttributeSet entities."""
271
472
  total: Int!
272
473
  }
273
474
 
475
+ """Input type for updating an existing AttributeSet entity."""
274
476
  input AttributeSetPatch {
477
+ """A flag indicating create/update operation."""
275
478
  cuFlag: String
479
+
480
+ """A description of the AttributeSet."""
276
481
  description: String
482
+
483
+ """The name of the entity this AttributeSet is associated with."""
277
484
  entity: String
485
+
486
+ """The unique identifier of the AttributeSet."""
278
487
  id: ID
488
+
489
+ """A list of items (attributes) to update in this AttributeSet."""
279
490
  items: [AttributeSetItemPatch!]
280
491
  }
281
492
 
282
- """Entity for AuthProvider"""
493
+ """
494
+ Represents a configured instance of an authentication provider for a specific domain.
495
+ """
283
496
  type AuthProvider {
497
+ """Indicates whether this authentication provider is currently active."""
284
498
  active: Boolean
499
+
500
+ """Client ID for OAuth/OIDC providers."""
285
501
  clientId: String
502
+
503
+ """Client secret for OAuth/OIDC providers (stored encrypted)."""
286
504
  clientSecret: String
505
+
506
+ """The timestamp when this provider instance was created."""
287
507
  createdAt: DateTimeISO
508
+
509
+ """The user who created this provider instance."""
288
510
  creator: User
511
+
512
+ """The domain to which this authentication provider belongs."""
289
513
  domain: Domain!
514
+
515
+ """Unique identifier for the configured authentication provider."""
290
516
  id: ID!
517
+
518
+ """A key-value map for additional provider-specific parameters."""
291
519
  params: Object
520
+
521
+ """Private key, used by some authentication providers (stored encrypted)."""
292
522
  privateKey: String
523
+
524
+ """Tenant ID, used by some multi-tenant authentication providers."""
293
525
  tenantId: String
526
+
527
+ """The type of the authentication provider (e.g., keycloak, google)."""
294
528
  type: String
529
+
530
+ """The timestamp when this provider instance was last updated."""
295
531
  updatedAt: DateTimeISO
532
+
533
+ """The user who last updated this provider instance."""
296
534
  updater: User
535
+
536
+ """A list of user-provider associations for this provider."""
297
537
  usersAuthProviders: [UsersAuthProviders!]
298
538
  }
299
539
 
540
+ """A paginated list of configured authentication provider instances."""
300
541
  type AuthProviderList {
542
+ """The list of authentication provider items."""
301
543
  items: [AuthProvider!]!
544
+
545
+ """The total number of authentication providers."""
302
546
  total: Int!
303
547
  }
304
548
 
549
+ """
550
+ Describes a single configuration parameter for an authentication provider.
551
+ """
305
552
  type AuthProviderParameterSpec {
553
+ """The human-readable label for the parameter, shown in UI."""
306
554
  label: String!
555
+
556
+ """The name of the parameter, used as the key in the params object."""
307
557
  name: String!
558
+
559
+ """Placeholder text for the input field."""
308
560
  placeholder: String
561
+
562
+ """Additional properties for the parameter (e.g., min, max)."""
309
563
  property: Object
564
+
565
+ """CSS styles for the input field."""
310
566
  styles: Object
567
+
568
+ """The data type of the parameter (e.g., text, number, boolean)."""
311
569
  type: String!
312
570
  }
313
571
 
572
+ """
573
+ Input for updating (patching) an existing authentication provider instance.
574
+ """
314
575
  input AuthProviderPatch {
576
+ """The new active status for the provider."""
315
577
  active: Boolean
578
+
579
+ """The new client ID for the provider."""
316
580
  clientId: String
581
+
582
+ """The new client secret for the provider."""
317
583
  clientSecret: String
584
+
585
+ """
586
+ A flag indicating whether the provider is being created, updated, or deleted.
587
+ """
318
588
  cuFlag: String
589
+
590
+ """The unique identifier of the provider instance to update."""
319
591
  id: ID
592
+
593
+ """The new provider-specific parameters."""
320
594
  params: Object
595
+
596
+ """The new private key for the provider."""
321
597
  privateKey: String
598
+
599
+ """The new tenant ID for the provider."""
322
600
  tenantId: String
601
+
602
+ """The new type for the provider."""
323
603
  type: String
324
604
  }
325
605
 
606
+ """Describes a type of authentication provider available in the system."""
326
607
  type AuthProviderType {
608
+ """A brief description of the authentication provider."""
327
609
  description: String
610
+
611
+ """Helpful information or a link to documentation for the provider."""
328
612
  help: String
613
+
614
+ """
615
+ A list of parameters required to configure this authentication provider.
616
+ """
329
617
  parameterSpec: [AuthProviderParameterSpec!]
618
+
619
+ """
620
+ The unique type name of the authentication provider (e.g., keycloak, google).
621
+ """
330
622
  type: String!
331
623
  }
332
624
 
625
+ """A list of available authentication provider types."""
333
626
  type AuthProviderTypeList {
627
+ """The list of authentication provider type items."""
334
628
  items: [AuthProviderType!]!
629
+
630
+ """The total number of authentication provider types."""
335
631
  total: Int!
336
632
  }
337
633
 
338
- """Entity for Visualization Board"""
634
+ """Represents a visual dashboard or display board."""
339
635
  type Board {
636
+ """The timestamp when the board was created."""
340
637
  createdAt: DateTimeISO
638
+
639
+ """The user who created the board."""
341
640
  creator: User
641
+
642
+ """The timestamp when the board was soft-deleted."""
342
643
  deletedAt: DateTimeISO
644
+
645
+ """A detailed description of the board."""
343
646
  description: String
647
+
648
+ """The domain to which this board belongs."""
344
649
  domain: Domain
650
+
651
+ """The group to which this board belongs."""
345
652
  group: Group
653
+
654
+ """Unique identifier for the board."""
346
655
  id: ID
656
+
657
+ """The JSON model defining the layout and components of the board."""
347
658
  model: String
659
+
660
+ """The name of the board."""
348
661
  name: String!
662
+
663
+ """A list of play groups that this board is a part of."""
349
664
  playGroups: [PlayGroup!]
665
+
666
+ """The state of the board, can be 'draft' or 'released'."""
350
667
  state: String
668
+
669
+ """A base64 encoded thumbnail image of the board."""
351
670
  thumbnail: String
671
+
672
+ """The type of the board, can be 'main', 'sub', or 'popup'."""
673
+ type: String
674
+
675
+ """The timestamp when the board was last updated."""
352
676
  updatedAt: DateTimeISO
677
+
678
+ """The user who last updated the board."""
353
679
  updater: User
680
+
681
+ """The version of the board model."""
354
682
  version: Float
355
683
  }
356
684
 
685
+ """Represents a board that a user has marked as a favorite."""
357
686
  type BoardFavorite {
687
+ """The timestamp when the board was created."""
358
688
  createdAt: DateTimeISO
689
+
690
+ """The user who created the board."""
359
691
  creator: User
692
+
693
+ """The timestamp when the board was soft-deleted."""
360
694
  deletedAt: DateTimeISO
695
+
696
+ """A detailed description of the board."""
361
697
  description: String
698
+
699
+ """The domain to which this board belongs."""
362
700
  domain: Domain
701
+
702
+ """The unique identifier for the favorite marking itself."""
363
703
  favoriteId: String
704
+
705
+ """The group to which this board belongs."""
364
706
  group: Group
707
+
708
+ """Unique identifier for the board."""
365
709
  id: ID
710
+
711
+ """The JSON model defining the layout and components of the board."""
366
712
  model: String
713
+
714
+ """The name of the board."""
367
715
  name: String!
716
+
717
+ """A list of play groups that this board is a part of."""
368
718
  playGroups: [PlayGroup!]
719
+
720
+ """The state of the board, can be 'draft' or 'released'."""
369
721
  state: String
722
+
723
+ """A base64 encoded thumbnail image of the board."""
370
724
  thumbnail: String
725
+
726
+ """The type of the board, can be 'main', 'sub', or 'popup'."""
727
+ type: String
728
+
729
+ """The timestamp when the board was last updated."""
371
730
  updatedAt: DateTimeISO
731
+
732
+ """The user who last updated the board."""
372
733
  updater: User
734
+
735
+ """The version of the board model."""
373
736
  version: Float
374
737
  }
375
738
 
739
+ """A paginated list of favorite boards."""
376
740
  type BoardFavoriteList {
741
+ """The list of favorite board items."""
377
742
  items: [BoardFavorite!]!
743
+
744
+ """The total number of favorite boards."""
378
745
  total: Int!
379
746
  }
380
747
 
381
- """History Entity of Board"""
748
+ """Stores historical versions of board entities."""
382
749
  type BoardHistory {
750
+ """
751
+ The action that created this history record (e.g., created, updated, deleted).
752
+ """
753
+ action: String!
754
+
755
+ """The creation timestamp of the original board."""
383
756
  createdAt: DateTimeISO
757
+
758
+ """The user who created the original board."""
384
759
  creator: User
760
+
761
+ """The deletion timestamp of the board, if applicable."""
385
762
  deletedAt: DateTimeISO
763
+
764
+ """The description of the board at this point in history."""
386
765
  description: String
766
+
767
+ """The domain this board belonged to."""
387
768
  domain: Domain
769
+
770
+ """The group the board belonged to at this point in history."""
388
771
  group: Group
772
+
773
+ """Unique identifier for the board history record."""
389
774
  id: ID!
775
+
776
+ """The JSON model of the board at this point in history."""
390
777
  model: String
778
+
779
+ """The name of the board at this point in history."""
391
780
  name: String!
781
+
782
+ """The ID of the original board entity this history record belongs to."""
783
+ originalId: String!
784
+
785
+ """The play groups the board was part of at this point in history."""
392
786
  playGroups: [PlayGroup!]
787
+
788
+ """
789
+ The base64 encoded thumbnail image of the board at this point in history.
790
+ """
393
791
  thumbnail: String
792
+
793
+ """
794
+ The type of the board at this point in history, can be 'main', 'sub', or 'popup'.
795
+ """
796
+ type: String
797
+
798
+ """The last update timestamp of the board at this point in history."""
394
799
  updatedAt: DateTimeISO
800
+
801
+ """The user who made the changes recorded in this history entry."""
395
802
  updater: User
803
+
804
+ """The version number of this board history record."""
396
805
  version: Float
397
806
  }
398
807
 
808
+ """A paginated list of boards."""
399
809
  type BoardList {
810
+ """The list of board items."""
400
811
  items: [Board!]!
812
+
813
+ """The total number of boards."""
401
814
  total: Int!
402
815
  }
403
816
 
817
+ """Input for updating (patching) an existing board."""
404
818
  input BoardPatch {
819
+ """The new description for the board."""
405
820
  description: String
821
+
822
+ """The new group ID for the board."""
406
823
  groupId: String
824
+
825
+ """The new JSON model for the board."""
407
826
  model: String
827
+
828
+ """The new name for the board."""
408
829
  name: String
830
+
831
+ """The new base64 encoded thumbnail image for the board."""
409
832
  thumbnail: String
833
+
834
+ """The new type for the board, can be 'main', 'sub', or 'popup'."""
835
+ type: String
410
836
  }
411
837
 
412
- """Entity for BoardTemplate"""
838
+ """A reusable template for creating new boards."""
413
839
  type BoardTemplate {
840
+ """The timestamp when the template was created."""
414
841
  createdAt: DateTimeISO
842
+
843
+ """The user who created the template."""
415
844
  creator: User
845
+
846
+ """A detailed description of the board template."""
416
847
  description: String
848
+
849
+ """The domain to which this template belongs."""
417
850
  domain: Domain!
851
+
852
+ """Unique identifier for the board template."""
418
853
  id: ID!
419
854
  mine: Boolean!
855
+
856
+ """The JSON model that defines the layout and components of the template."""
420
857
  model: String
858
+
859
+ """The name of the board template."""
421
860
  name: String
422
- tags: Object
861
+
862
+ """A list of tags for categorizing the template."""
863
+ tags: [String!]
864
+
865
+ """A base64 encoded thumbnail image of the template."""
423
866
  thumbnail: String
867
+
868
+ """The timestamp when the template was last updated."""
424
869
  updatedAt: DateTimeISO
870
+
871
+ """The user who last updated the template."""
425
872
  updater: User
873
+
874
+ """The visibility of the template: 'private', 'public', or 'domain'."""
426
875
  visibility: String
427
876
  }
428
877
 
878
+ """A paginated list of board templates."""
429
879
  type BoardTemplateList {
880
+ """The list of board template items."""
430
881
  items: [BoardTemplate!]!
882
+
883
+ """The total number of board templates."""
431
884
  total: Int!
432
885
  }
433
886
 
887
+ """Input for updating (patching) an existing board template."""
434
888
  input BoardTemplatePatch {
889
+ """
890
+ A flag indicating whether the template is being created, updated, or deleted.
891
+ """
435
892
  cuFlag: String
893
+
894
+ """The new description for the board template."""
436
895
  description: String
896
+
897
+ """The unique identifier of the board template to update."""
437
898
  id: ID
899
+
900
+ """The new JSON model for the board template."""
438
901
  model: String
902
+
903
+ """The new name for the board template."""
439
904
  name: String
905
+
906
+ """The new base64 encoded thumbnail image for the board template."""
440
907
  thumbnail: String
908
+
909
+ """The new visibility for the board template: 'private' or 'public'."""
441
910
  visibility: String
442
911
  }
443
912
 
@@ -515,61 +984,147 @@ input CommonCodePatch {
515
984
  name: String
516
985
  }
517
986
 
987
+ """Represents a configured connection to an external system or service."""
518
988
  type Connection {
989
+ """
990
+ Indicates whether the connection is currently active and should be maintained.
991
+ """
519
992
  active: Boolean
993
+
994
+ """The timestamp when the connection was created."""
520
995
  createdAt: DateTimeISO
996
+
997
+ """The user who created the connection."""
521
998
  creator: User
999
+
1000
+ """A detailed description of the connection."""
522
1001
  description: String
1002
+
1003
+ """The domain to which this connection belongs."""
523
1004
  domain: Domain
1005
+
1006
+ """The edge appliance that delegates this connection, if any."""
524
1007
  edge: Appliance
1008
+
1009
+ """The endpoint URL or address for the connection."""
525
1010
  endpoint: String
1011
+
1012
+ """Unique identifier for the connection."""
526
1013
  id: ID!
1014
+
1015
+ """The name of the connection."""
527
1016
  name: String!
1017
+
1018
+ """A key-value map of parameters for the connection."""
528
1019
  params: Object
1020
+
1021
+ """The current status of the connection (e.g., CONNECTED, DISCONNECTED)."""
529
1022
  state: String
1023
+
1024
+ """The type of the connection (e.g., tcp, http, mqtt)."""
530
1025
  type: String
1026
+
1027
+ """The timestamp when the connection was last updated."""
531
1028
  updatedAt: DateTimeISO
1029
+
1030
+ """The user who last updated the connection."""
532
1031
  updater: User
533
1032
  }
534
1033
 
1034
+ """A paginated list of connections."""
535
1035
  type ConnectionList {
1036
+ """The list of connection items."""
536
1037
  items: [Connection!]!
1038
+
1039
+ """The total number of connections."""
537
1040
  total: Int!
538
1041
  }
539
1042
 
1043
+ """Input for updating (patching) an existing connection."""
540
1044
  input ConnectionPatch {
1045
+ """The new active status for the connection."""
541
1046
  active: Boolean
1047
+
1048
+ """
1049
+ A flag indicating whether the connection is being created, updated, or deleted.
1050
+ """
542
1051
  cuFlag: String
1052
+
1053
+ """The new description for the connection."""
543
1054
  description: String
1055
+
1056
+ """The new edge appliance for the connection."""
544
1057
  edge: ObjectRef
1058
+
1059
+ """The new endpoint for the connection."""
545
1060
  endpoint: String
1061
+
1062
+ """The unique identifier of the connection to update."""
546
1063
  id: ID
1064
+
1065
+ """The new name for the connection."""
547
1066
  name: String
1067
+
1068
+ """The new parameters for the connection."""
548
1069
  params: Object
1070
+
1071
+ """The new type for the connection."""
549
1072
  type: String
550
1073
  }
551
1074
 
1075
+ """Represents the state of a connection at a point in time."""
552
1076
  type ConnectionState {
1077
+ """The description of the connection."""
553
1078
  description: String
1079
+
1080
+ """The domain of the connection."""
554
1081
  domain: Domain!
1082
+
1083
+ """The edge appliance associated with the connection."""
555
1084
  edge: Appliance
1085
+
1086
+ """The unique identifier of the connection."""
556
1087
  id: String
1088
+
1089
+ """The name of the connection."""
557
1090
  name: String
1091
+
1092
+ """The current status of the connection."""
558
1093
  state: String
1094
+
1095
+ """The timestamp when this state was recorded."""
559
1096
  timestamp: DateTimeISO
1097
+
1098
+ """The type of the connection."""
560
1099
  type: String
561
1100
  }
562
1101
 
1102
+ """A paginated list of connector types."""
563
1103
  type ConnectorList {
1104
+ """The list of connector type items."""
564
1105
  items: [ConnectorType!]!
1106
+
1107
+ """The total number of connector types."""
565
1108
  total: Int!
566
1109
  }
567
1110
 
1111
+ """
1112
+ Describes a type of connector, which handles communication for a specific protocol.
1113
+ """
568
1114
  type ConnectorType {
1115
+ """A brief description of the connector."""
569
1116
  description: String
1117
+
1118
+ """A URL or text providing more detailed help information."""
570
1119
  help: String
1120
+
1121
+ """The unique name of the connector type."""
571
1122
  name: String!
1123
+
1124
+ """A list of parameters required to configure this connector type."""
572
1125
  parameterSpec: [PropertySpec!]
1126
+
1127
+ """A list of task prefixes that this connector can handle."""
573
1128
  taskPrefixes: [String!]
574
1129
  }
575
1130
 
@@ -624,18 +1179,25 @@ input ContactPatch {
624
1179
  profile: ProfileInput
625
1180
  }
626
1181
 
1182
+ """
1183
+ Represents a data payload delivered via subscription, including its domain, tag, and content.
1184
+ """
627
1185
  type Data {
628
- """Data delivered by subscription"""
1186
+ """The actual data content delivered by the subscription."""
629
1187
  data: Object
630
1188
 
631
- """The domain where the data originated"""
1189
+ """The domain where the data originated."""
632
1190
  domain: Domain
633
1191
 
634
- """Tag name attached to data"""
1192
+ """
1193
+ The tag name attached to the data, used for filtering and identification.
1194
+ """
635
1195
  tag: String!
636
1196
  }
637
1197
 
638
- """Date custom scalar type"""
1198
+ """
1199
+ A custom scalar type for representing date values. Accepts and serializes dates as either timestamps (milliseconds since epoch) or ISO date strings. Use this type for fields or arguments that require date-only values without time components.
1200
+ """
639
1201
  scalar Date
640
1202
 
641
1203
  """
@@ -646,7 +1208,19 @@ scalar DateTimeISO
646
1208
  """Entity for Department"""
647
1209
  type Department {
648
1210
  active: Boolean
649
- children(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): [Department!]!
1211
+ children(
1212
+ """An array of filter conditions to apply to the list query."""
1213
+ filters: [Filter!]
1214
+
1215
+ """Inherited value type for the list query."""
1216
+ inherited: InheritedValueType
1217
+
1218
+ """Pagination options for the list query."""
1219
+ pagination: Pagination
1220
+
1221
+ """Sorting options for the list query."""
1222
+ sortings: [Sorting!]
1223
+ ): [Department!]!
650
1224
  controlNo: String!
651
1225
  createdAt: DateTimeISO
652
1226
  creator: User
@@ -682,62 +1256,149 @@ input DepartmentPatch {
682
1256
  picture: Upload
683
1257
  }
684
1258
 
1259
+ """
1260
+ Represents a domain entity, which is a logical grouping of users, roles, and resources within the system.
1261
+ """
685
1262
  type Domain {
1263
+ """Additional attributes associated with the domain."""
686
1264
  attributes: Object
1265
+
1266
+ """The brand image URL associated with the domain, if any."""
687
1267
  brandImage: String
1268
+
1269
+ """The brand name associated with the domain, if any."""
688
1270
  brandName: String
1271
+
1272
+ """The child domains, if any, under this domain."""
689
1273
  children: Domain
1274
+
1275
+ """The content image URL associated with the domain, if any."""
690
1276
  contentImage: String
1277
+
1278
+ """The date and time when the domain was created."""
691
1279
  createdAt: DateTimeISO
1280
+
1281
+ """The date and time when the domain was deleted, if applicable."""
692
1282
  deletedAt: DateTimeISO
1283
+
1284
+ """A description of the domain."""
693
1285
  description: String
1286
+
1287
+ """The external type of the domain, if applicable."""
694
1288
  extType: String
1289
+
1290
+ """The unique identifier of the domain."""
695
1291
  id: ID!
1292
+
1293
+ """A list of IPs and their associated access levels for the domain."""
696
1294
  iplist: Object
1295
+
1296
+ """The name of the domain."""
697
1297
  name: String!
1298
+
1299
+ """The owner of the domain, if applicable."""
698
1300
  owner: String
699
1301
  ownerUser: User
1302
+
1303
+ """The parent domain, if this domain is a subdomain."""
700
1304
  parent: Domain
1305
+
1306
+ """The subdomain of the domain, if applicable."""
701
1307
  subdomain: String
1308
+
1309
+ """
1310
+ A flag indicating if the domain is a system domain. Deprecated, use `parent` instead.
1311
+ """
702
1312
  systemFlag: Boolean
1313
+
1314
+ """The theme associated with the domain, if any."""
703
1315
  theme: String
1316
+
1317
+ """The timezone of the domain, if applicable."""
704
1318
  timezone: String
1319
+
1320
+ """The date and time when the domain was last updated."""
705
1321
  updatedAt: DateTimeISO
706
1322
  }
707
1323
 
1324
+ """Input for generating a new domain."""
708
1325
  input DomainGeneratorInput {
1326
+ """A description for the new domain."""
709
1327
  description: String
1328
+
1329
+ """The name of the new domain."""
710
1330
  name: String!
711
1331
  }
712
1332
 
1333
+ """
1334
+ Input type for creating a new domain entity, including name, description, and extended entity type.
1335
+ """
713
1336
  input DomainInput {
1337
+ """A description of the domain."""
714
1338
  description: String
1339
+
1340
+ """
1341
+ The 'extType' field stands for 'extended entity type' and specifies the business or organizational category this domain represents, such as company, department, factory, or project.
1342
+ """
715
1343
  extType: String
1344
+
1345
+ """The name of the domain."""
716
1346
  name: String!
717
1347
  }
718
1348
 
719
- """Entity for DomainLink representing a connection between two domains"""
1349
+ """Represents a typed relationship between two domains."""
720
1350
  type DomainLink {
1351
+ """The timestamp when the domain link was created."""
721
1352
  createdAt: DateTimeISO!
1353
+
1354
+ """The user who created the domain link."""
722
1355
  creator: User
1356
+
1357
+ """Unique identifier for the domain link."""
723
1358
  id: ID!
1359
+
1360
+ """The source domain in the relationship."""
724
1361
  sourceDomain: Domain!
1362
+
1363
+ """The target domain in the relationship."""
725
1364
  targetDomain: Domain!
1365
+
1366
+ """The type of the relationship (e.g., has, maintains, owns)."""
726
1367
  type: String!
1368
+
1369
+ """The timestamp when the domain link was last updated."""
727
1370
  updatedAt: DateTimeISO!
1371
+
1372
+ """The user who last updated the domain link."""
728
1373
  updater: User
729
1374
  }
730
1375
 
1376
+ """A paginated list of domain links."""
731
1377
  type DomainLinkList {
1378
+ """The list of domain link items."""
732
1379
  items: [DomainLink!]!
1380
+
1381
+ """The total number of domain links."""
733
1382
  total: Int!
734
1383
  }
735
1384
 
1385
+ """Input for updating (patching) an existing domain link."""
736
1386
  input DomainLinkPatch {
1387
+ """
1388
+ A flag indicating whether the link is being created, updated, or deleted.
1389
+ """
737
1390
  cuFlag: String
1391
+
1392
+ """The unique identifier of the domain link to update."""
738
1393
  id: ID!
1394
+
1395
+ """The new source domain for the relationship."""
739
1396
  sourceDomain: ObjectRef
1397
+
1398
+ """The new target domain for the relationship."""
740
1399
  targetDomain: ObjectRef
1400
+
1401
+ """The new type for the relationship."""
741
1402
  type: String
742
1403
  }
743
1404
 
@@ -746,26 +1407,64 @@ type DomainList {
746
1407
  total: Int
747
1408
  }
748
1409
 
1410
+ """Input type for updating an existing domain entity."""
749
1411
  input DomainPatch {
1412
+ """Additional attributes for the domain in key-value pairs."""
750
1413
  attributes: Object
1414
+
1415
+ """The brand image URL for the domain."""
751
1416
  brandImage: String
1417
+
1418
+ """The brand name associated with the domain."""
752
1419
  brandName: String
1420
+
1421
+ """The content image URL for the domain."""
753
1422
  contentImage: String
1423
+
1424
+ """A description of the domain."""
754
1425
  description: String
1426
+
1427
+ """
1428
+ The 'extType' field stands for 'extended entity type' and specifies the business or organizational category this domain represents, such as company, department, factory, or project.
1429
+ """
755
1430
  extType: String
1431
+
1432
+ """The unique identifier of the domain."""
756
1433
  id: String
1434
+
1435
+ """The name of the domain."""
757
1436
  name: String
1437
+
1438
+ """The unique identifier of the domain owner."""
758
1439
  owner: String
1440
+
1441
+ """A reference to the parent domain, if any."""
759
1442
  parent: ObjectRef
1443
+
1444
+ """The subdomain associated with the domain."""
760
1445
  subdomain: String
1446
+
1447
+ """A flag indicating if the domain is a system domain."""
761
1448
  systemFlag: Boolean
1449
+
1450
+ """The theme associated with the domain."""
762
1451
  theme: String
1452
+
1453
+ """The timezone setting for the domain."""
763
1454
  timezone: String
764
1455
  }
765
1456
 
1457
+ """
1458
+ Input for the domain creation wizard, including domain, users, and roles.
1459
+ """
766
1460
  input DomainUserRoleInput {
1461
+ """The details of the new domain to be created."""
767
1462
  domain: DomainInput!
1463
+
1464
+ """A list of new roles to be created within the domain."""
768
1465
  roles: [NewRole!]!
1466
+
1467
+ """A list of new users to be created within the domain."""
769
1468
  users: [NewUserByDomainWizardInput!]!
770
1469
  }
771
1470
 
@@ -1047,10 +1746,18 @@ type FavoriteList {
1047
1746
  total: Int!
1048
1747
  }
1049
1748
 
1749
+ """Input type for specifying a filter condition in a list query."""
1050
1750
  input Filter {
1751
+ """The field name to apply the filter on."""
1051
1752
  name: String!
1753
+
1754
+ """The operator to use for filtering (e.g., eq, ne, gt, lt, in, etc.)."""
1052
1755
  operator: String!
1756
+
1757
+ """Set to true if the filter applies to a relation field."""
1053
1758
  relation: Boolean
1759
+
1760
+ """The value to compare the field against."""
1054
1761
  value: Any
1055
1762
  }
1056
1763
 
@@ -1084,32 +1791,63 @@ input FontPatch {
1084
1791
  uri: String
1085
1792
  }
1086
1793
 
1794
+ """Represents a role that is granted to a specific domain."""
1087
1795
  type GrantedRole {
1796
+ """The domain to which the role is granted."""
1088
1797
  domain: Domain!
1798
+
1799
+ """Unique identifier for the granted role."""
1089
1800
  id: ID!
1801
+
1802
+ """The role being granted."""
1090
1803
  role: Role!
1091
1804
  }
1092
1805
 
1093
- """Entity for Board Management Group"""
1806
+ """A group used to organize and manage boards."""
1094
1807
  type Group {
1808
+ """The list of boards belonging to this group."""
1095
1809
  boards: [Board!]
1810
+
1811
+ """The timestamp when the group was created."""
1096
1812
  createdAt: DateTimeISO
1813
+
1814
+ """The user who created the group."""
1097
1815
  creator: User
1816
+
1817
+ """A detailed description of the group."""
1098
1818
  description: String
1819
+
1820
+ """The domain to which this group belongs."""
1099
1821
  domain: Domain
1822
+
1823
+ """Unique identifier for the group."""
1100
1824
  id: ID!
1825
+
1826
+ """The name of the group."""
1101
1827
  name: String!
1828
+
1829
+ """The timestamp when the group was last updated."""
1102
1830
  updatedAt: DateTimeISO
1831
+
1832
+ """The user who last updated the group."""
1103
1833
  updater: User
1104
1834
  }
1105
1835
 
1836
+ """A paginated list of board groups."""
1106
1837
  type GroupList {
1838
+ """The list of group items."""
1107
1839
  items: [Group!]!
1840
+
1841
+ """The total number of groups."""
1108
1842
  total: Int!
1109
1843
  }
1110
1844
 
1845
+ """Input for updating (patching) an existing board group."""
1111
1846
  input GroupPatch {
1847
+ """The new description for the group."""
1112
1848
  description: String
1849
+
1850
+ """The new name for the group."""
1113
1851
  name: String
1114
1852
  }
1115
1853
 
@@ -1123,26 +1861,55 @@ type ImageCompletionOutput {
1123
1861
  images: String
1124
1862
  }
1125
1863
 
1864
+ """
1865
+ Enumeration for inherited value types: None, Only, or Include. Used to specify how values are inherited in queries or filters.
1866
+ """
1126
1867
  enum InheritedValueType {
1127
1868
  Include
1128
1869
  None
1129
1870
  Only
1130
1871
  }
1131
1872
 
1873
+ """
1874
+ Represents an invitation for a user to join a system or a specific resource.
1875
+ """
1132
1876
  type Invitation {
1877
+ """The timestamp when the invitation was created."""
1133
1878
  createdAt: DateTimeISO
1879
+
1880
+ """The user who created the invitation."""
1134
1881
  creator: User
1882
+
1883
+ """The email address to which the invitation is sent."""
1135
1884
  email: EmailAddress!
1885
+
1886
+ """Unique identifier for the invitation."""
1136
1887
  id: ID!
1888
+
1889
+ """
1890
+ A reference to the resource the user is invited to (e.g., company ID, bizplace ID).
1891
+ """
1137
1892
  reference: String!
1893
+
1894
+ """The unique token used to accept the invitation."""
1138
1895
  token: String!
1896
+
1897
+ """The type of resource the invitation is for (e.g., company, bizplace)."""
1139
1898
  type: String!
1899
+
1900
+ """The timestamp when the invitation was last updated."""
1140
1901
  updatedAt: DateTimeISO
1902
+
1903
+ """The user who last updated the invitation."""
1141
1904
  updater: User
1142
1905
  }
1143
1906
 
1907
+ """A paginated list of invitations."""
1144
1908
  type InvitationList {
1909
+ """The list of invitation items."""
1145
1910
  items: [Invitation!]
1911
+
1912
+ """The total number of invitations."""
1146
1913
  total: Int
1147
1914
  }
1148
1915
 
@@ -1151,30 +1918,47 @@ A field whose value is a JSON Web Token (JWT): https://jwt.io/introduction.
1151
1918
  """
1152
1919
  scalar JWT
1153
1920
 
1921
+ """
1922
+ Represents a log entry, including its source, level, message, and timestamp.
1923
+ """
1154
1924
  type Log {
1155
- """log level (error, warning, info, ..)"""
1925
+ """The severity level of the log entry (e.g., error, warning, info)."""
1156
1926
  level: String!
1157
1927
 
1158
- """log body message"""
1928
+ """The main message or content of the log entry."""
1159
1929
  message: String!
1160
1930
 
1161
- """the source of the log"""
1931
+ """The source object or context from which the log originated."""
1162
1932
  source: Object!
1163
1933
 
1164
- """timestamp the log occurred"""
1934
+ """The timestamp indicating when the log entry was created."""
1165
1935
  timestamp: String!
1166
1936
  }
1167
1937
 
1938
+ """Records user login attempts."""
1168
1939
  type LoginHistory {
1940
+ """The domain the user logged into."""
1169
1941
  accessDomain: Domain!
1942
+
1943
+ """The user who logged in."""
1170
1944
  accessUser: User!
1945
+
1946
+ """The timestamp of the login attempt."""
1171
1947
  accessedAt: DateTimeISO
1948
+
1949
+ """The IP address from which the login attempt was made."""
1172
1950
  accessorIp: String
1951
+
1952
+ """Unique identifier for the login history record."""
1173
1953
  id: ID!
1174
1954
  }
1175
1955
 
1956
+ """A paginated list of login history records."""
1176
1957
  type LoginHistoryList {
1958
+ """The list of login history items."""
1177
1959
  items: [LoginHistory!]!
1960
+
1961
+ """The total number of login history records."""
1178
1962
  total: Int!
1179
1963
  }
1180
1964
 
@@ -1536,8 +2320,13 @@ input MenuPatch {
1536
2320
  }
1537
2321
 
1538
2322
  type Mutation {
1539
- """To activate user"""
1540
- activateUser(username: String!): Boolean!
2323
+ """
2324
+ Activates a user account in the current domain. Use this mutation to enable a user who was previously inactive.
2325
+ """
2326
+ activateUser(
2327
+ """The username or email of the user to activate."""
2328
+ username: String!
2329
+ ): Boolean!
1541
2330
 
1542
2331
  """
1543
2332
  Attaches an existing contact to an employee. The contact is identified by its ID and the employee is identified by their ID.
@@ -1548,13 +2337,17 @@ type Mutation {
1548
2337
  """To clear translations cache"""
1549
2338
  clearTranslationsCache: Boolean!
1550
2339
 
1551
- """To clone a Board from existing Board"""
2340
+ """
2341
+ Clones a board from an existing one, potentially into a different domain.
2342
+ """
1552
2343
  cloneBoard(id: String!, patch: BoardPatch!, targetGroupId: String, targetSubdomain: String!): Board!
1553
2344
 
1554
- """To connect a connection"""
2345
+ """Establishes a live connection to a configured endpoint."""
1555
2346
  connectConnection(name: String!): Connection!
1556
2347
 
1557
- """To import multiple scenarios"""
2348
+ """
2349
+ Copies multiple existing scenarios within the same domain, creating new scenarios with new IDs.
2350
+ """
1558
2351
  copyScenarios(ids: [String!]!): [Scenario!]!
1559
2352
 
1560
2353
  """To create new appliance"""
@@ -1568,13 +2361,18 @@ type Mutation {
1568
2361
  createAttachment(attachment: NewAttachment!): Attachment!
1569
2362
  createAttachments(attachments: [NewAttachment!]!): [Attachment!]!
1570
2363
 
1571
- """To create new AttributeSet"""
1572
- createAttributeSet(attribute: NewAttributeSet!): AttributeSet!
2364
+ """
2365
+ Creates a new AttributeSet entity. Use this mutation to define a new set of attributes for a specific entity type.
2366
+ """
2367
+ createAttributeSet(
2368
+ """The input object containing the new AttributeSet details."""
2369
+ attribute: NewAttributeSet!
2370
+ ): AttributeSet!
1573
2371
 
1574
2372
  """To create new AuthProvider"""
1575
2373
  createAuthProvider(authProvider: NewAuthProvider!): AuthProvider!
1576
2374
 
1577
- """To create new Board"""
2375
+ """Creates a new board."""
1578
2376
  createBoard(board: NewBoard!): Board!
1579
2377
 
1580
2378
  """To create new BoardTemplate"""
@@ -1586,7 +2384,7 @@ type Mutation {
1586
2384
  """To create new CommonCodeDetail"""
1587
2385
  createCommonCodeDetail(commonCodeDetail: NewCommonCodeDetail!): CommonCodeDetail!
1588
2386
 
1589
- """To create new connection"""
2387
+ """Creates a new connection."""
1590
2388
  createConnection(connection: NewConnection!): Connection!
1591
2389
 
1592
2390
  """To create new Contact"""
@@ -1595,8 +2393,13 @@ type Mutation {
1595
2393
  """To create new Department"""
1596
2394
  createDepartment(department: NewDepartment!): Department!
1597
2395
 
1598
- """To create domain (Only superuser is granted this privilege.)"""
1599
- createDomain(domainInput: DomainPatch!): Domain!
2396
+ """
2397
+ Creates a new domain entity. Only superusers are granted this privilege. Use this mutation to register a new domain with a unique subdomain.
2398
+ """
2399
+ createDomain(
2400
+ """The input object containing the new domain details."""
2401
+ domainInput: DomainPatch!
2402
+ ): Domain!
1600
2403
 
1601
2404
  """To create new DomainLink"""
1602
2405
  createDomainLink(domainLink: NewDomainLink!): DomainLink!
@@ -1618,7 +2421,7 @@ type Mutation {
1618
2421
  """To create new Font"""
1619
2422
  createFont(font: NewFont!): Font!
1620
2423
 
1621
- """To create new Group"""
2424
+ """Creates a new board group."""
1622
2425
  createGroup(group: NewGroup!): Group
1623
2426
 
1624
2427
  """To create new Menu"""
@@ -1660,10 +2463,10 @@ type Mutation {
1660
2463
  """To create new PDFTemplate"""
1661
2464
  createPDFTemplate(pdfTemplate: NewPDFTemplate!): PDFTemplate!
1662
2465
 
1663
- """To create new PayloadLog"""
2466
+ """Creates a new payload log."""
1664
2467
  createPayloadLog(payloadLog: NewPayloadLog!): PayloadLog!
1665
2468
 
1666
- """To create new PlayGroup"""
2469
+ """Creates a new play group."""
1667
2470
  createPlayGroup(playGroup: NewPlayGroup!): PlayGroup!
1668
2471
 
1669
2472
  """To create new PrinterDevice"""
@@ -1675,23 +2478,28 @@ type Mutation {
1675
2478
  """To create new user"""
1676
2479
  createRole(role: NewRole!): User!
1677
2480
 
1678
- """To create new scenario"""
2481
+ """Creates a new scenario."""
1679
2482
  createScenario(scenario: NewScenario!): Scenario!
1680
2483
 
1681
2484
  """To create new Setting"""
1682
2485
  createSetting(setting: NewSetting!): Setting!
1683
2486
 
1684
- """To create new StateRegister"""
2487
+ """Creates a new state register."""
1685
2488
  createStateRegister(stateRegister: NewStateRegister!): StateRegister!
1686
2489
 
1687
2490
  """To create new Terminology"""
1688
2491
  createTerminology(terminology: NewTerminology!): Terminology!
1689
2492
 
1690
- """To create new Theme"""
2493
+ """Creates a new theme."""
1691
2494
  createTheme(theme: NewTheme!): Theme!
1692
2495
 
1693
- """To create new user"""
1694
- createUser(user: NewUser!): User!
2496
+ """
2497
+ Creates a new user in the system. Use this mutation to register a user with the specified credentials and domain information.
2498
+ """
2499
+ createUser(
2500
+ """The input object containing new user information."""
2501
+ user: NewUser!
2502
+ ): User!
1695
2503
 
1696
2504
  """To create new UserPreference"""
1697
2505
  createUserPreference(preference: NewUserPreference!): UserPreference!
@@ -1711,17 +2519,27 @@ type Mutation {
1711
2519
  deleteAttachment(id: String!): Boolean!
1712
2520
  deleteAttachmentsByRef(refBys: [String!]!, refType: String): Boolean!
1713
2521
 
1714
- """To delete AttributeSet"""
1715
- deleteAttributeSet(id: String!): Boolean!
2522
+ """
2523
+ Deletes an AttributeSet entity by its unique identifier. Use this mutation to permanently remove an attribute set.
2524
+ """
2525
+ deleteAttributeSet(
2526
+ """The unique identifier of the AttributeSet to delete."""
2527
+ id: String!
2528
+ ): Boolean!
1716
2529
 
1717
- """To delete multiple AttributeSets"""
1718
- deleteAttributeSets(ids: [String!]!): Boolean!
2530
+ """
2531
+ Deletes multiple AttributeSet entities by their unique identifiers. Use this mutation to remove several attribute sets at once.
2532
+ """
2533
+ deleteAttributeSets(
2534
+ """An array of unique identifiers for the AttributeSets to delete."""
2535
+ ids: [String!]!
2536
+ ): Boolean!
1719
2537
 
1720
2538
  """To delete AuthProvider"""
1721
2539
  deleteAuthProvider(id: String!): Boolean!
1722
2540
  deleteAuthProviders(ids: [String!]!): Boolean!
1723
2541
 
1724
- """To delete Board"""
2542
+ """Deletes a board."""
1725
2543
  deleteBoard(id: String!): Boolean!
1726
2544
 
1727
2545
  """To delete BoardTemplate"""
@@ -1739,10 +2557,10 @@ type Mutation {
1739
2557
  """To delete multiple CommonCodes"""
1740
2558
  deleteCommonCodes(ids: [String!]!): Boolean!
1741
2559
 
1742
- """To delete connection"""
2560
+ """Deletes a single connection by its name."""
1743
2561
  deleteConnection(name: String!): Boolean!
1744
2562
 
1745
- """To delete multiple connections"""
2563
+ """Deletes multiple connections by their names."""
1746
2564
  deleteConnections(names: [String!]!): Boolean!
1747
2565
 
1748
2566
  """To delete Contact"""
@@ -1757,8 +2575,13 @@ type Mutation {
1757
2575
  """To delete multiple Departments"""
1758
2576
  deleteDepartments(ids: [String!]!): Boolean!
1759
2577
 
1760
- """To delete domain (Only superuser is granted this privilege.)"""
1761
- deleteDomain(name: String!): Domain!
2578
+ """
2579
+ Deletes a domain entity by its name. Only superusers are granted this privilege. Use this mutation to permanently remove a domain.
2580
+ """
2581
+ deleteDomain(
2582
+ """The name of the domain to delete."""
2583
+ name: String!
2584
+ ): Domain!
1762
2585
 
1763
2586
  """To delete DomainLink"""
1764
2587
  deleteDomainLink(id: String!): Boolean!
@@ -1766,11 +2589,21 @@ type Mutation {
1766
2589
  """To delete multiple DomainLinks"""
1767
2590
  deleteDomainLinks(ids: [String!]!): Boolean!
1768
2591
 
1769
- """To delete domain user"""
1770
- deleteDomainUser(username: String!): Boolean!
2592
+ """
2593
+ Removes a user from the current domain. Use this mutation to revoke a user's access to a specific domain without deleting their account.
2594
+ """
2595
+ deleteDomainUser(
2596
+ """The username or email of the user to remove from the domain."""
2597
+ username: String!
2598
+ ): Boolean!
1771
2599
 
1772
- """To delete multiple domains (Only superuser is granted this privilege.)"""
1773
- deleteDomains(names: [String!]!): Boolean!
2600
+ """
2601
+ Deletes multiple domain entities by their names. Only superusers are granted this privilege. Use this mutation to remove several domains at once.
2602
+ """
2603
+ deleteDomains(
2604
+ """An array of domain names to delete."""
2605
+ names: [String!]!
2606
+ ): Boolean!
1774
2607
 
1775
2608
  """
1776
2609
  Deletes an employee record identified by the given ID. Also deletes any attachments associated with the employee.
@@ -1800,7 +2633,7 @@ type Mutation {
1800
2633
  """To delete Font"""
1801
2634
  deleteFont(id: String!): Boolean!
1802
2635
 
1803
- """To delete Group"""
2636
+ """Deletes a board group."""
1804
2637
  deleteGroup(id: String!): Boolean!
1805
2638
 
1806
2639
  """To delete Menu"""
@@ -1890,13 +2723,13 @@ type Mutation {
1890
2723
  """To delete multiple partnerSettings"""
1891
2724
  deletePartnerSettings(ids: [String!]!): Boolean!
1892
2725
 
1893
- """To delete PayloadLog"""
2726
+ """Deletes a single payload log by its ID."""
1894
2727
  deletePayloadLog(id: String!): Boolean!
1895
2728
 
1896
- """To delete multiple payloadLogs"""
2729
+ """Deletes multiple payload logs by their IDs."""
1897
2730
  deletePayloadLogs(ids: [String!]!): Boolean!
1898
2731
 
1899
- """To delete PlayGroup"""
2732
+ """Deletes a play group."""
1900
2733
  deletePlayGroup(id: String!): Boolean!
1901
2734
 
1902
2735
  """To delete PrinterDevice"""
@@ -1914,10 +2747,10 @@ type Mutation {
1914
2747
  """To delete multiple roles"""
1915
2748
  deleteRoles(ids: [String!]!): Boolean!
1916
2749
 
1917
- """To delete scenario"""
2750
+ """Deletes a single scenario by its name."""
1918
2751
  deleteScenario(name: String!): Boolean!
1919
2752
 
1920
- """To delete multiple scenarios"""
2753
+ """Deletes multiple scenarios by their IDs."""
1921
2754
  deleteScenarios(ids: [String!]!): Boolean!
1922
2755
 
1923
2756
  """To delete Setting"""
@@ -1926,13 +2759,13 @@ type Mutation {
1926
2759
  """To delete multiple settings"""
1927
2760
  deleteSettings(names: [String!]!): Boolean!
1928
2761
 
1929
- """To delete StateRegister"""
2762
+ """Deletes a single state register by its ID."""
1930
2763
  deleteStateRegister(id: String!): Boolean!
1931
2764
 
1932
- """To delete multiple StateRegisters"""
2765
+ """Deletes multiple state registers by their IDs."""
1933
2766
  deleteStateRegisters(ids: [String!]!): Boolean!
1934
2767
 
1935
- """To delete multiple steps"""
2768
+ """Deletes multiple scenario steps by their IDs."""
1936
2769
  deleteSteps(ids: [String!]!): Boolean!
1937
2770
 
1938
2771
  """To delete multiple Terminologies"""
@@ -1941,14 +2774,19 @@ type Mutation {
1941
2774
  """To delete Terminology"""
1942
2775
  deleteTerminology(id: String!): Boolean!
1943
2776
 
1944
- """To delete Theme"""
2777
+ """Deletes a single theme by its ID."""
1945
2778
  deleteTheme(id: String!): Boolean!
1946
2779
 
1947
- """To delete multiple Themes"""
2780
+ """Deletes multiple themes by their IDs."""
1948
2781
  deleteThemes(ids: [String!]!): Boolean!
1949
2782
 
1950
- """To delete a user"""
1951
- deleteUser(username: String!): Boolean!
2783
+ """
2784
+ Deletes a user from the system by their username. Use this mutation to permanently remove a user account and revoke their access.
2785
+ """
2786
+ deleteUser(
2787
+ """The username of the user to delete."""
2788
+ username: String!
2789
+ ): Boolean!
1952
2790
 
1953
2791
  """To delete UserPreference"""
1954
2792
  deleteUserPreference(id: String!): Boolean!
@@ -1956,15 +2794,20 @@ type Mutation {
1956
2794
  """To delete multiple UserPreferences"""
1957
2795
  deleteUserPreferences(ids: [String!]!): Boolean!
1958
2796
 
1959
- """To delete some users"""
1960
- deleteUsers(usernames: [String!]!): Boolean!
2797
+ """
2798
+ Deletes multiple users from the system by their usernames. Use this mutation to remove several user accounts at once.
2799
+ """
2800
+ deleteUsers(
2801
+ """An array of usernames to delete."""
2802
+ usernames: [String!]!
2803
+ ): Boolean!
1961
2804
 
1962
2805
  """
1963
2806
  Detaches an existing contact from an employee. The employee is identified by their ID.
1964
2807
  """
1965
2808
  detachContact(id: String!): Employee!
1966
2809
 
1967
- """To disconnect a connection"""
2810
+ """Terminates a live connection."""
1968
2811
  disconnectConnection(name: String!): Connection!
1969
2812
  domainRegister(domainInput: DomainGeneratorInput!): Domain!
1970
2813
  domainUserRoleRegister(newDomainInfo: DomainUserRoleInput!): Domain!
@@ -1982,10 +2825,15 @@ type Mutation {
1982
2825
  """To import some Attachments"""
1983
2826
  importAttachments(file: Upload!): [Attachment!]!
1984
2827
 
1985
- """To import multiple AttributeSets"""
1986
- importAttributeSets(attributes: [AttributeSetPatch!]!): Boolean!
2828
+ """
2829
+ Imports multiple AttributeSet entities into the system. Use this mutation to bulk import attribute sets from external sources.
2830
+ """
2831
+ importAttributeSets(
2832
+ """An array of AttributeSetPatch objects to import."""
2833
+ attributes: [AttributeSetPatch!]!
2834
+ ): Boolean!
1987
2835
 
1988
- """To import some Boards"""
2836
+ """Imports multiple boards from JSON files."""
1989
2837
  importBoards(files: [Upload!]!, groupId: String!, overwrite: Boolean!): [Board!]!
1990
2838
 
1991
2839
  """To import multiple CommonCodeDetails"""
@@ -1994,7 +2842,9 @@ type Mutation {
1994
2842
  """To import multiple CommonCodes"""
1995
2843
  importCommonCodes(commonCodes: [CommonCodePatch!]!): Boolean!
1996
2844
 
1997
- """To import multiple connections"""
2845
+ """
2846
+ Imports multiple connections. Can overwrite existing connections if IDs or names match.
2847
+ """
1998
2848
  importConnections(connections: [ConnectionPatch!]!): Boolean!
1999
2849
 
2000
2850
  """To import multiple Contacts"""
@@ -2038,32 +2888,44 @@ type Mutation {
2038
2888
  """To import multiple PDFTemplates"""
2039
2889
  importPDFTemplates(pdfTemplates: [PDFTemplatePatch!]!): Boolean!
2040
2890
 
2041
- """To import multiple scenarios"""
2891
+ """
2892
+ Imports multiple scenarios, including their steps. This can overwrite existing scenarios if IDs match.
2893
+ """
2042
2894
  importScenarios(scenarios: [ScenarioPatch!]!): Boolean!
2043
2895
 
2044
- """To import multiple StateRegisters"""
2896
+ """Imports multiple state registers from a provided list."""
2045
2897
  importStateRegisters(stateRegisters: [StateRegisterPatch!]!): Boolean!
2046
2898
 
2047
2899
  """To import multiple Terminologies"""
2048
2900
  importTerminologies(terminologies: [TerminologyPatch!]!): Boolean!
2049
2901
 
2050
- """To import multiple Themes"""
2902
+ """Imports multiple themes."""
2051
2903
  importThemes(themes: [ThemePatch!]!): Boolean!
2052
2904
 
2053
- """To inactivate user"""
2054
- inactivateUser(username: String!): Boolean!
2905
+ """
2906
+ Inactivates a user account in the current domain. Use this mutation to disable a user, making them unable to log in.
2907
+ """
2908
+ inactivateUser(
2909
+ """The username or email of the user to inactivate."""
2910
+ username: String!
2911
+ ): Boolean!
2055
2912
  inviteCustomer(customerDomainName: String!): Boolean!
2056
2913
 
2057
- """To invite new user"""
2058
- inviteUser(username: String!): Boolean!
2914
+ """
2915
+ Invites an existing user to join the current domain. Use this mutation to add a user to a domain if they already exist in the system.
2916
+ """
2917
+ inviteUser(
2918
+ """The username or email of the user to invite."""
2919
+ username: String!
2920
+ ): Boolean!
2059
2921
 
2060
- """To make the board to join the group"""
2922
+ """Assigns one or more boards to a group."""
2061
2923
  joinGroup(boardIds: [String!]!, id: String!): Group!
2062
2924
 
2063
- """To make the board to join the play group"""
2925
+ """Adds one or more boards to a play group."""
2064
2926
  joinPlayGroup(boardIds: [String!]!, id: String!): PlayGroup!
2065
2927
 
2066
- """To make the board to leave from the play group"""
2928
+ """Removes one or more boards from a play group."""
2067
2929
  leavePlayGroup(boardIds: [String!]!, id: String!): PlayGroup!
2068
2930
  multipleUpload(files: [Upload!]!): [Attachment!]!
2069
2931
 
@@ -2094,37 +2956,42 @@ type Mutation {
2094
2956
  ): Boolean!
2095
2957
  registerSchedule(schedule: NewSchedule!): ID!
2096
2958
 
2097
- """To release a Board"""
2959
+ """Releases a board, making it public and creating a version history."""
2098
2960
  releaseBoard(id: String!): Board!
2099
2961
  renewApplicationAccessToken(id: String!, scope: String!): AccessToken!
2100
2962
 
2101
- """To modify board order of a PlayGroup"""
2963
+ """Sets the custom playback order for boards in a play group."""
2102
2964
  reorderPlayGroup(boardIds: [String!]!, id: String!): PlayGroup!
2103
2965
 
2104
- """To reset password to default"""
2105
- resetPasswordToDefault(username: String!): Boolean!
2966
+ """
2967
+ Resets a user's password to the default value. Use this mutation to restore access to a user who has forgotten their password.
2968
+ """
2969
+ resetPasswordToDefault(
2970
+ """The username or email of the user whose password to reset."""
2971
+ username: String!
2972
+ ): Boolean!
2106
2973
 
2107
- """To revert Board version"""
2974
+ """Reverts a board to a specific historical version."""
2108
2975
  revertBoardVersion(id: String!, version: Float!): Board!
2109
2976
 
2110
2977
  """
2111
- To run new scenario instance and will return the result after the scenario stop.
2978
+ Runs a new scenario instance once and returns the result after it finishes.
2112
2979
  """
2113
2980
  runScenario(instanceName: String, scenarioName: String!, variables: Object): ScenarioInstanceRunResult!
2114
2981
  sendInvitation(email: EmailAddress!, reference: String!, type: String!): Invitation!
2115
2982
  singleUpload(file: Upload!): Attachment!
2116
2983
 
2117
- """To start new scenario instance"""
2984
+ """Starts a new scenario instance, which will run in the background."""
2118
2985
  startScenario(instanceName: String, scenarioName: String!, variables: Object): ScenarioInstance!
2119
2986
 
2120
- """To start posting scenario based on the schedule of the given scenario"""
2987
+ """Starts the schedule for a specific scenario, if one is defined."""
2121
2988
  startScenarioSchedule(scenarioId: String!): Scenario!
2122
2989
 
2123
- """To start new scenario instance"""
2990
+ """Stops a running scenario instance by its name."""
2124
2991
  stopScenario(instanceName: String): ScenarioInstance
2125
2992
 
2126
- """To stop posting scenario based on the schedule of the given scenario"""
2127
- stopScenarioSchedule(scenarioId: String!): Scenario
2993
+ """Stops the schedule for a specific scenario."""
2994
+ stopScenarioSchedule(scenarioId: String!): Scenario!
2128
2995
 
2129
2996
  """To subscribe azure active directory users"""
2130
2997
  subscribeAzureADUsers: Boolean!
@@ -2141,8 +3008,13 @@ type Mutation {
2141
3008
  synchronizePrivilegeMaster(privilege: NewPrivilege!): Boolean!
2142
3009
  terminateContract(partnerName: String!): Boolean!
2143
3010
 
2144
- """To transfer owner of domain"""
2145
- transferOwner(username: String!): Boolean!
3011
+ """
3012
+ Transfers domain ownership to another user. Use this mutation to assign the owner role to a different user within the domain.
3013
+ """
3014
+ transferOwner(
3015
+ """The username or email of the user to transfer ownership to."""
3016
+ username: String!
3017
+ ): Boolean!
2146
3018
  unregisterSchedule(handle: ID!): Boolean!
2147
3019
  updateAppliance(id: String!, patch: AppliancePatch!): Appliance!
2148
3020
  updateApplication(id: String!, patch: ApplicationPatch!): Application!
@@ -2151,13 +3023,23 @@ type Mutation {
2151
3023
  updateApprovalLine(id: String!, patch: ApprovalLinePatch!): ApprovalLine!
2152
3024
  updateAttachment(id: String!, patch: AttachmentPatch!): Attachment!
2153
3025
 
2154
- """To modify AttributeSet information"""
2155
- updateAttributeSet(id: String!, patch: AttributeSetPatch!): AttributeSet!
3026
+ """
3027
+ Updates an existing AttributeSet entity. Use this mutation to modify the properties or items of an AttributeSet.
3028
+ """
3029
+ updateAttributeSet(
3030
+ """The unique identifier of the AttributeSet to update."""
3031
+ id: String!
3032
+
3033
+ """The patch object containing updated fields for the AttributeSet."""
3034
+ patch: AttributeSetPatch!
3035
+ ): AttributeSet!
2156
3036
 
2157
3037
  """To modify AuthProvider information"""
2158
3038
  updateAuthProvider(id: String!, patch: AuthProviderPatch!): AuthProvider!
2159
3039
 
2160
- """To modify Board information"""
3040
+ """
3041
+ Updates a board. If a model is provided, it also generates a new thumbnail.
3042
+ """
2161
3043
  updateBoard(id: String!, patch: BoardPatch!): Board!
2162
3044
 
2163
3045
  """To modify BoardTemplate information"""
@@ -2169,7 +3051,7 @@ type Mutation {
2169
3051
  """To modify CommonCodeDetail information"""
2170
3052
  updateCommonCodeDetail(id: String!, patch: CommonCodeDetailPatch!): CommonCodeDetail!
2171
3053
 
2172
- """To modify connection information"""
3054
+ """Updates an existing connection."""
2173
3055
  updateConnection(name: String!, patch: ConnectionPatch!): Connection!
2174
3056
 
2175
3057
  """To modify Contact information"""
@@ -2201,7 +3083,7 @@ type Mutation {
2201
3083
  """To modify Font information"""
2202
3084
  updateFont(id: String!, patch: FontPatch!): Font!
2203
3085
 
2204
- """To modify Group information"""
3086
+ """Updates an existing board group."""
2205
3087
  updateGroup(id: String!, patch: GroupPatch!): Group!
2206
3088
 
2207
3089
  """To modify Menu information"""
@@ -2225,8 +3107,13 @@ type Mutation {
2225
3107
  """To modify multiple ApprovalLines' information"""
2226
3108
  updateMultipleApprovalLine(patches: [ApprovalLinePatch!]!): [ApprovalLine!]!
2227
3109
 
2228
- """To modify multiple AttributeSets' information"""
2229
- updateMultipleAttributeSet(patches: [AttributeSetPatch!]!): [AttributeSet!]!
3110
+ """
3111
+ Updates or creates multiple AttributeSet entities in a single operation. Use this mutation for batch processing of attribute sets.
3112
+ """
3113
+ updateMultipleAttributeSet(
3114
+ """An array of patch objects for batch update or creation."""
3115
+ patches: [AttributeSetPatch!]!
3116
+ ): [AttributeSet!]!
2230
3117
  updateMultipleAuthProvider(patches: [AuthProviderPatch!]!): [AuthProvider!]!
2231
3118
 
2232
3119
  """To modify multiple CommonCodes' information"""
@@ -2235,7 +3122,7 @@ type Mutation {
2235
3122
  """To modify multiple CommonCodeDetails' information"""
2236
3123
  updateMultipleCommonCodeDetail(patches: [CommonCodeDetailPatch!]!): [CommonCodeDetail!]!
2237
3124
 
2238
- """To modify multiple connections' information"""
3125
+ """Updates multiple connections at once."""
2239
3126
  updateMultipleConnection(patches: [ConnectionPatch!]!): [Connection!]!
2240
3127
 
2241
3128
  """To modify multiple Contacts' information"""
@@ -2279,32 +3166,43 @@ type Mutation {
2279
3166
  """To modify multiple PartnerSettings' information"""
2280
3167
  updateMultiplePartnerSetting(patches: [PartnerSettingPatch!]!): [PartnerSetting!]!
2281
3168
 
2282
- """To modify multiple PayloadLogs' information"""
3169
+ """Updates multiple payload logs at once."""
2283
3170
  updateMultiplePayloadLog(patches: [PayloadLogPatch!]!): [PayloadLog!]!
2284
3171
 
2285
3172
  """To modify multiple PrinterDevices' information"""
2286
3173
  updateMultiplePrinterDevice(patches: [PrinterDevicePatch!]!): [PrinterDevice!]!
2287
3174
 
2288
- """To modify multiple scenarios' information"""
3175
+ """
3176
+ Updates multiple scenarios at once. Can be used to create or update records.
3177
+ """
2289
3178
  updateMultipleScenario(patches: [ScenarioPatch!]!): [Scenario!]!
2290
3179
 
2291
3180
  """To modify multiple Settings' information"""
2292
3181
  updateMultipleSetting(patches: [SettingPatch!]!): [Setting!]!
2293
3182
 
2294
- """To modify multiple StateRegisters' information"""
3183
+ """Updates multiple state registers at once."""
2295
3184
  updateMultipleStateRegister(patches: [StateRegisterPatch!]!): [StateRegister!]!
2296
3185
 
2297
- """To modify multiple steps' in a scenario"""
3186
+ """
3187
+ Updates multiple steps within a specific scenario. This operation replaces all existing steps for the scenario.
3188
+ """
2298
3189
  updateMultipleStep(patches: [StepPatch!]!, scenarioId: String!): [Step!]!
2299
3190
 
2300
3191
  """To modify multiple Terminologies' information"""
2301
3192
  updateMultipleTerminologies(patches: [TerminologyPatch!]!): [Terminology!]!
2302
3193
 
2303
- """To modify multiple Themes' information"""
3194
+ """
3195
+ Updates multiple themes at once. Can create or update themes based on the cuFlag.
3196
+ """
2304
3197
  updateMultipleTheme(patches: [ThemePatch!]!): [Theme!]!
2305
3198
 
2306
- """To modify multiple users information"""
2307
- updateMultipleUser(patches: [UserPatch!]!): [User!]!
3199
+ """
3200
+ Updates or creates multiple users in a single operation. Use this mutation for batch processing of user records.
3201
+ """
3202
+ updateMultipleUser(
3203
+ """An array of patch objects for batch update or creation."""
3204
+ patches: [UserPatch!]!
3205
+ ): [User!]!
2308
3206
 
2309
3207
  """To modify ApprovalLine information for current user"""
2310
3208
  updateMyApprovalLine(id: String!, patch: ApprovalLinePatch!): ApprovalLine!
@@ -2330,10 +3228,10 @@ type Mutation {
2330
3228
  """To modify PDFTemplate information"""
2331
3229
  updatePDFTemplate(id: String!, patch: PDFTemplatePatch!): PDFTemplate!
2332
3230
 
2333
- """To modify PayloadLog information"""
3231
+ """Updates an existing payload log."""
2334
3232
  updatePayloadLog(id: String!, patch: PayloadLogPatch!): PayloadLog!
2335
3233
 
2336
- """To modify PlayGroup information"""
3234
+ """Updates an existing play group."""
2337
3235
  updatePlayGroup(id: String!, patch: PlayGroupPatch!): PlayGroup!
2338
3236
 
2339
3237
  """To modify PrinterDevice information"""
@@ -2351,7 +3249,7 @@ type Mutation {
2351
3249
  """To update role Menu"""
2352
3250
  updateRoleMenus(isCheckedAll: Boolean!, parentMenuId: String!, roleId: String!): [Menu!]!
2353
3251
 
2354
- """To modify scenario information"""
3252
+ """Updates an existing scenario."""
2355
3253
  updateScenario(name: String!, patch: ScenarioPatch!): Scenario!
2356
3254
  updateSchedule(schedule: SchedulePatch!): ID!
2357
3255
 
@@ -2361,45 +3259,94 @@ type Mutation {
2361
3259
  """To modify Setting information"""
2362
3260
  updateSetting(name: String!, patch: SettingPatch!): Setting!
2363
3261
 
2364
- """To modify StateRegister information"""
3262
+ """Updates an existing state register."""
2365
3263
  updateStateRegister(id: String!, patch: StateRegisterPatch!): StateRegister!
2366
3264
 
2367
- """To update state of StateRegister by name"""
3265
+ """
3266
+ Updates the state of a specific state register, identified by its name.
3267
+ """
2368
3268
  updateStateRegisterByName(name: String!, state: Object!): StateRegister!
2369
3269
 
2370
3270
  """To modify Terminology information"""
2371
3271
  updateTerminology(id: String!, patch: TerminologyPatch!): Terminology!
2372
3272
 
2373
- """To modify Theme information"""
3273
+ """Updates an existing theme."""
2374
3274
  updateTheme(id: String!, patch: ThemePatch!): Theme!
2375
3275
 
2376
- """To modify user information"""
2377
- updateUser(email: EmailAddress!, patch: UserPatch!): User!
3276
+ """
3277
+ Updates the information of an existing user. Use this mutation to modify user profile details, such as name, email, or roles.
3278
+ """
3279
+ updateUser(
3280
+ """The email address of the user to update."""
3281
+ email: EmailAddress!
3282
+
3283
+ """The patch object containing updated user fields."""
3284
+ patch: UserPatch!
3285
+ ): User!
2378
3286
 
2379
3287
  """To modify UserPreference information"""
2380
3288
  updateUserPreference(id: String!, patch: UserPreferencePatch!): UserPreference!
2381
3289
 
2382
- """To update roles for a user"""
2383
- updateUserRoles(availableRoles: [ObjectRef!]!, selectedRoles: [ObjectRef!]!, username: String!): User!
3290
+ """
3291
+ Updates the roles assigned to a user. Use this mutation to change a user's permissions within the domain.
3292
+ """
3293
+ updateUserRoles(
3294
+ """The list of roles that can be assigned to the user."""
3295
+ availableRoles: [ObjectRef!]!
3296
+
3297
+ """The list of roles to be assigned to the user."""
3298
+ selectedRoles: [ObjectRef!]!
3299
+
3300
+ """The username or email of the user whose roles to update."""
3301
+ username: String!
3302
+ ): User!
2384
3303
  }
2385
3304
 
3305
+ """Input for creating a new appliance."""
2386
3306
  input NewAppliance {
3307
+ """The brand of the new appliance."""
2387
3308
  brand: String!
3309
+
3310
+ """A description for the new appliance."""
2388
3311
  description: String
3312
+
3313
+ """The model of the new appliance."""
2389
3314
  model: String!
3315
+
3316
+ """The name of the new appliance."""
2390
3317
  name: String!
3318
+
3319
+ """The network mask for the new appliance."""
2391
3320
  netmask: String
3321
+
3322
+ """The serial number of the new appliance."""
2392
3323
  serialNo: String!
2393
3324
  }
2394
3325
 
3326
+ """Input for creating a new application."""
2395
3327
  input NewApplication {
3328
+ """A description for the new application."""
2396
3329
  description: String
3330
+
3331
+ """The contact email for the new application."""
2397
3332
  email: EmailAddress
3333
+
3334
+ """A URL to the icon for the new application."""
2398
3335
  icon: String
3336
+
3337
+ """The name of the new application."""
2399
3338
  name: String!
3339
+
3340
+ """The redirect URL for the new application."""
2400
3341
  redirectUrl: String
3342
+
3343
+ """The type of the new application."""
2401
3344
  type: ApplicationType
3345
+
3346
+ """The URL of the new application."""
2402
3347
  url: String
3348
+
3349
+ """The webhook URL for the new application."""
2403
3350
  webhook: String
2404
3351
  }
2405
3352
 
@@ -2420,36 +3367,83 @@ input NewAttachment {
2420
3367
  tags: Object
2421
3368
  }
2422
3369
 
3370
+ """
3371
+ Input type for creating a new AttributeSet entity, including entity name, description, and items.
3372
+ """
2423
3373
  input NewAttributeSet {
3374
+ """Whether this AttributeSet is active."""
2424
3375
  active: Boolean
3376
+
3377
+ """A description of the AttributeSet."""
2425
3378
  description: String
3379
+
3380
+ """The name of the entity this AttributeSet is associated with."""
2426
3381
  entity: String!
3382
+
3383
+ """A list of items (attributes) included in this AttributeSet."""
2427
3384
  items: [AttributeSetItemPatch!]
2428
3385
  }
2429
3386
 
3387
+ """Input for creating a new authentication provider instance."""
2430
3388
  input NewAuthProvider {
3389
+ """Whether the new provider instance should be active."""
2431
3390
  active: Boolean
3391
+
3392
+ """Client ID for OAuth/OIDC providers."""
2432
3393
  clientId: String
3394
+
3395
+ """Client secret for OAuth/OIDC providers."""
2433
3396
  clientSecret: String
3397
+
3398
+ """Provider-specific parameters."""
2434
3399
  params: Object
3400
+
3401
+ """Private key, for certain types of providers."""
2435
3402
  privateKey: String
3403
+
3404
+ """Tenant ID, for multi-tenant providers."""
2436
3405
  tenantId: String
3406
+
3407
+ """The type of the authentication provider (e.g., keycloak, google)."""
2437
3408
  type: String!
2438
3409
  }
2439
3410
 
3411
+ """Input for creating a new board."""
2440
3412
  input NewBoard {
3413
+ """A detailed description for the new board."""
2441
3414
  description: String
3415
+
3416
+ """The ID of the group to associate the new board with."""
2442
3417
  groupId: String
3418
+
3419
+ """The JSON model for the new board."""
2443
3420
  model: String!
3421
+
3422
+ """The name of the new board."""
2444
3423
  name: String!
3424
+
3425
+ """A base64 encoded thumbnail image for the new board."""
2445
3426
  thumbnail: String
3427
+
3428
+ """The type for the new board, can be 'main', 'sub', or 'popup'."""
3429
+ type: String
2446
3430
  }
2447
3431
 
3432
+ """Input for creating a new board template."""
2448
3433
  input NewBoardTemplate {
3434
+ """A detailed description for the new board template."""
2449
3435
  description: String!
3436
+
3437
+ """The JSON model for the new board template."""
2450
3438
  model: String!
3439
+
3440
+ """The name of the new board template."""
2451
3441
  name: String!
3442
+
3443
+ """A base64 encoded thumbnail image for the new board template."""
2452
3444
  thumbnail: String
3445
+
3446
+ """The visibility for the new board template: 'private' or 'public'."""
2453
3447
  visibility: String!
2454
3448
  }
2455
3449
 
@@ -2467,12 +3461,24 @@ input NewCommonCodeDetail {
2467
3461
  rank: Float!
2468
3462
  }
2469
3463
 
3464
+ """Input for creating a new connection."""
2470
3465
  input NewConnection {
3466
+ """A detailed description for the new connection."""
2471
3467
  description: String
3468
+
3469
+ """Reference to the edge appliance for the new connection."""
2472
3470
  edge: ObjectRef
3471
+
3472
+ """The endpoint URL or address for the new connection."""
2473
3473
  endpoint: String
3474
+
3475
+ """The name for the new connection."""
2474
3476
  name: String!
3477
+
3478
+ """A key-value map of parameters for the new connection."""
2475
3479
  params: Object
3480
+
3481
+ """The type of the new connection (e.g., tcp, http, mqtt)."""
2476
3482
  type: String
2477
3483
  }
2478
3484
 
@@ -2499,9 +3505,15 @@ input NewDepartment {
2499
3505
  picture: Upload
2500
3506
  }
2501
3507
 
3508
+ """Input for creating a new domain link."""
2502
3509
  input NewDomainLink {
3510
+ """The source domain in the relationship."""
2503
3511
  sourceDomain: ObjectRef!
3512
+
3513
+ """The target domain in the relationship."""
2504
3514
  targetDomain: ObjectRef!
3515
+
3516
+ """The type of the relationship."""
2505
3517
  type: String!
2506
3518
  }
2507
3519
 
@@ -2599,8 +3611,12 @@ input NewFont {
2599
3611
  uri: String
2600
3612
  }
2601
3613
 
3614
+ """Input for creating a new board group."""
2602
3615
  input NewGroup {
3616
+ """A detailed description for the new group."""
2603
3617
  description: String
3618
+
3619
+ """The name of the new group."""
2604
3620
  name: String!
2605
3621
  }
2606
3622
 
@@ -2818,13 +3834,21 @@ input NewPagePreference {
2818
3834
  user: ObjectRef!
2819
3835
  }
2820
3836
 
3837
+ """Input for creating a new payload log."""
2821
3838
  input NewPayloadLog {
3839
+ """A description for the new payload log entry."""
2822
3840
  description: String
3841
+
3842
+ """The name for the new payload log entry."""
2823
3843
  name: String!
2824
3844
  }
2825
3845
 
3846
+ """Input for creating a new play group."""
2826
3847
  input NewPlayGroup {
3848
+ """A detailed description for the new play group."""
2827
3849
  description: String
3850
+
3851
+ """The name of the new play group."""
2828
3852
  name: String!
2829
3853
  }
2830
3854
 
@@ -2846,28 +3870,60 @@ input NewPrinterDevice {
2846
3870
  type: String
2847
3871
  }
2848
3872
 
3873
+ """Input for creating a new privilege."""
2849
3874
  input NewPrivilege {
3875
+ """The category of the new privilege."""
2850
3876
  category: String!
3877
+
3878
+ """A description for the new privilege."""
2851
3879
  description: String
3880
+
3881
+ """The name of the new privilege."""
2852
3882
  name: String!
3883
+
3884
+ """Roles to which the new privilege will be assigned."""
2853
3885
  roles: [ObjectRef!]
2854
3886
  }
2855
3887
 
3888
+ """Input for creating a new role."""
2856
3889
  input NewRole {
3890
+ """A description for the new role."""
2857
3891
  description: String
3892
+
3893
+ """The name of the new role."""
2858
3894
  name: String!
3895
+
3896
+ """Privileges to be granted by the new role."""
2859
3897
  privileges: [ObjectRef!]
3898
+
3899
+ """Users to be assigned to the new role."""
2860
3900
  users: [ObjectRef!]
2861
3901
  }
2862
3902
 
3903
+ """Input for creating a new scenario."""
2863
3904
  input NewScenario {
3905
+ """Indicates if the new scenario should be active upon creation."""
2864
3906
  active: Boolean
3907
+
3908
+ """A detailed description for the new scenario."""
2865
3909
  description: String
3910
+
3911
+ """The name of the new scenario."""
2866
3912
  name: String!
3913
+
3914
+ """The role required to execute the new scenario."""
2867
3915
  role: ObjectRef
3916
+
3917
+ """A cron-style schedule for the new scenario."""
2868
3918
  schedule: String
3919
+
3920
+ """The timezone for the schedule."""
2869
3921
  timezone: String
3922
+
3923
+ """Time-to-live in seconds for new scenario instances."""
2870
3924
  ttl: Float
3925
+
3926
+ """The type of the new scenario, for categorization."""
2871
3927
  type: String
2872
3928
  }
2873
3929
 
@@ -2887,6 +3943,7 @@ input NewSetting {
2887
3943
  value: String
2888
3944
  }
2889
3945
 
3946
+ """Input for creating a new state register."""
2890
3947
  input NewStateRegister {
2891
3948
  """Description of the state register"""
2892
3949
  description: String
@@ -2926,30 +3983,70 @@ input NewTerminology {
2926
3983
  name: String!
2927
3984
  }
2928
3985
 
3986
+ """Input for creating a new theme."""
2929
3987
  input NewTheme {
3988
+ """Whether the new theme should be active upon creation."""
2930
3989
  active: Boolean
3990
+
3991
+ """A detailed description for the new theme."""
2931
3992
  description: String
3993
+
3994
+ """The name for the new theme."""
2932
3995
  name: String!
3996
+
3997
+ """The type of the new theme."""
2933
3998
  type: String
3999
+
4000
+ """A JSON object of style values for the new theme."""
2934
4001
  value: Object
2935
4002
  }
2936
4003
 
4004
+ """Input type for creating a new user account."""
2937
4005
  input NewUser {
4006
+ """Optional description or note about the user."""
2938
4007
  description: String
4008
+
4009
+ """Email address of the user."""
2939
4010
  email: EmailAddress!
4011
+
4012
+ """Full name of the user."""
2940
4013
  name: String!
4014
+
4015
+ """Password for the user account."""
2941
4016
  password: String
4017
+
4018
+ """Roles assigned to the user."""
2942
4019
  roles: [ObjectRef!]
4020
+
4021
+ """Type or category of the user (e.g., admin, operator, guest)."""
2943
4022
  userType: String
4023
+
4024
+ """Unique username for the user."""
2944
4025
  username: String!
2945
4026
  }
2946
4027
 
4028
+ """Input for creating a new user as part of the domain creation wizard."""
2947
4029
  input NewUserByDomainWizardInput {
4030
+ """The email address of the new user."""
2948
4031
  email: EmailAddress!
4032
+
4033
+ """
4034
+ Indicates whether the user should be invited via email instead of created directly.
4035
+ """
2949
4036
  isInvitee: Boolean
4037
+
4038
+ """The full name of the new user."""
2950
4039
  name: String!
4040
+
4041
+ """Indicates whether this user is an owner of the domain."""
2951
4042
  owner: Boolean!
4043
+
4044
+ """
4045
+ The password for the new user. If not provided, an invitation will be sent.
4046
+ """
2952
4047
  password: String
4048
+
4049
+ """A list of roles to be assigned to the new user."""
2953
4050
  roles: [NewRole!]!
2954
4051
  }
2955
4052
 
@@ -3099,44 +4196,49 @@ input Oauth2ClientPatch {
3099
4196
  webhook: String
3100
4197
  }
3101
4198
 
3102
- """Can be anything"""
4199
+ """
4200
+ A custom scalar type for representing arbitrary JSON objects. Use this type for fields or arguments that require flexible, structured data beyond standard GraphQL scalar types.
4201
+ """
3103
4202
  scalar Object
3104
4203
 
4204
+ """
4205
+ Input type for referencing another object by its unique identifier, with optional name and description.
4206
+ """
3105
4207
  input ObjectRef {
3106
- """Field description"""
4208
+ """A description of the referenced object."""
3107
4209
  description: String
3108
4210
 
3109
- """Field id"""
4211
+ """The unique identifier of the referenced object."""
3110
4212
  id: ID!
3111
4213
 
3112
- """Field name"""
4214
+ """The name of the referenced object."""
3113
4215
  name: String
3114
4216
  }
3115
4217
 
3116
4218
  input ObjectRefApprovalLineOwnerType {
3117
4219
  controlNo: String
3118
4220
 
3119
- """Field description"""
4221
+ """A description of the referenced object."""
3120
4222
  description: String
3121
4223
 
3122
- """Field id"""
4224
+ """The unique identifier of the referenced object."""
3123
4225
  id: ID!
3124
4226
 
3125
- """Field name"""
4227
+ """The name of the referenced object."""
3126
4228
  name: String
3127
4229
  }
3128
4230
 
3129
4231
  input ObjectRefForContact {
3130
4232
  address: String
3131
4233
 
3132
- """Field description"""
4234
+ """A description of the referenced object."""
3133
4235
  description: String
3134
4236
  email: EmailAddress
3135
4237
 
3136
- """Field id"""
4238
+ """The unique identifier of the referenced object."""
3137
4239
  id: ID!
3138
4240
 
3139
- """Field name"""
4241
+ """The name of the referenced object."""
3140
4242
  name: String
3141
4243
  phone: String
3142
4244
  }
@@ -3144,13 +4246,13 @@ input ObjectRefForContact {
3144
4246
  input ObjectRefForDepartment {
3145
4247
  controlNo: String
3146
4248
 
3147
- """Field description"""
4249
+ """A description of the referenced object."""
3148
4250
  description: String
3149
4251
 
3150
- """Field id"""
4252
+ """The unique identifier of the referenced object."""
3151
4253
  id: ID!
3152
4254
 
3153
- """Field name"""
4255
+ """The name of the referenced object."""
3154
4256
  name: String
3155
4257
  }
3156
4258
 
@@ -3159,31 +4261,31 @@ input ObjectRefForEmployee {
3159
4261
  alias: String
3160
4262
  controlNo: String
3161
4263
 
3162
- """Field description"""
4264
+ """A description of the referenced object."""
3163
4265
  description: String
3164
4266
  email: EmailAddress
3165
4267
  hiredOn: DateTimeISO
3166
4268
 
3167
- """Field id"""
4269
+ """The unique identifier of the referenced object."""
3168
4270
  id: ID!
3169
4271
  jobPosition: String
3170
4272
  jobResponsibility: String
3171
4273
 
3172
- """Field name"""
4274
+ """The name of the referenced object."""
3173
4275
  name: String
3174
4276
  photo: String
3175
4277
  type: EmployeeType
3176
4278
  }
3177
4279
 
3178
4280
  input ObjectRefForUser {
3179
- """Field description"""
4281
+ """A description of the referenced object."""
3180
4282
  description: String
3181
4283
  email: EmailAddress
3182
4284
 
3183
- """Field id"""
4285
+ """The unique identifier of the referenced object."""
3184
4286
  id: ID!
3185
4287
 
3186
- """Field name"""
4288
+ """The name of the referenced object."""
3187
4289
  name: String
3188
4290
  }
3189
4291
 
@@ -3315,23 +4417,45 @@ type PagePreferenceList {
3315
4417
  total: Int!
3316
4418
  }
3317
4419
 
4420
+ """Input type for specifying pagination options in a list query."""
3318
4421
  input Pagination {
4422
+ """The maximum number of items per page."""
3319
4423
  limit: Int
4424
+
4425
+ """The page number to retrieve."""
3320
4426
  page: Int
3321
4427
  }
3322
4428
 
4429
+ """Represents a partnership between two domains."""
3323
4430
  type Partner {
4431
+ """The timestamp when the partnership was approved."""
3324
4432
  approvedAt: DateTimeISO
4433
+
4434
+ """The user who approved the partnership."""
3325
4435
  approver: User
4436
+
4437
+ """The domain initiating the partnership."""
3326
4438
  domain: Domain!
4439
+
4440
+ """Unique identifier for the partnership."""
3327
4441
  id: ID!
4442
+
4443
+ """The domain being partnered with."""
3328
4444
  partnerDomain: Domain!
4445
+
4446
+ """The timestamp when the partnership was requested."""
3329
4447
  requestedAt: DateTimeISO
4448
+
4449
+ """The user who requested the partnership."""
3330
4450
  requester: User
3331
4451
  }
3332
4452
 
4453
+ """A paginated list of partnerships."""
3333
4454
  type PartnerList {
4455
+ """The list of partnership items."""
3334
4456
  items: [Partner!]
4457
+
4458
+ """The total number of partnerships."""
3335
4459
  total: Int
3336
4460
  }
3337
4461
 
@@ -3366,73 +4490,168 @@ input PartnerSettingPatch {
3366
4490
  value: String
3367
4491
  }
3368
4492
 
4493
+ """
4494
+ Password rule configuration for user accounts, specifying required character types and patterns.
4495
+ """
3369
4496
  type PasswordRule {
4497
+ """Whether repeated characters are allowed in the password."""
3370
4498
  allowRepeat: Boolean
4499
+
4500
+ """Whether at least one digit is required."""
3371
4501
  digit: Boolean
4502
+
4503
+ """Minimum length required for a loose password pattern."""
3372
4504
  looseCharacterLength: Float
4505
+
4506
+ """Whether at least one lowercase letter is required."""
3373
4507
  lowerCase: Boolean
4508
+
4509
+ """Whether at least one special character is required."""
3374
4510
  specialCharacter: Boolean
4511
+
4512
+ """Minimum length required for a strict password pattern."""
3375
4513
  tightCharacterLength: Float
4514
+
4515
+ """Whether at least one uppercase letter is required."""
3376
4516
  upperCase: Boolean
4517
+
4518
+ """Whether to allow a loose password pattern."""
3377
4519
  useLoosePattern: Boolean
4520
+
4521
+ """Whether to enforce a strict password pattern."""
3378
4522
  useTightPattern: Boolean
3379
4523
  }
3380
4524
 
3381
- """Entity for PayloadLog"""
4525
+ """Logs the request and response payloads for API interactions."""
3382
4526
  type PayloadLog {
4527
+ """The timestamp when the log entry was created."""
3383
4528
  createdAt: DateTimeISO
4529
+
4530
+ """The user who created the log entry."""
3384
4531
  creator: User
4532
+
4533
+ """The domain in which the transaction occurred."""
3385
4534
  domain: Domain!
4535
+
4536
+ """The API endpoint that was called."""
3386
4537
  endpoint: String!
4538
+
4539
+ """Unique identifier for the payload log entry."""
3387
4540
  id: ID!
4541
+
4542
+ """A descriptive name for the transaction being logged."""
3388
4543
  name: String!
4544
+
4545
+ """The full request payload, usually in JSON format."""
3389
4546
  request: String!
4547
+
4548
+ """The full response payload, usually in JSON format."""
3390
4549
  response: String!
4550
+
4551
+ """The source of the request."""
3391
4552
  src: String
4553
+
4554
+ """The direction of the data flow (ingestion or egestion)."""
3392
4555
  type: String!
4556
+
4557
+ """The timestamp when the log entry was last updated."""
3393
4558
  updatedAt: DateTimeISO
4559
+
4560
+ """The user who last updated the log entry."""
3394
4561
  updater: User
3395
4562
  }
3396
4563
 
4564
+ """A paginated list of payload logs."""
3397
4565
  type PayloadLogList {
4566
+ """The list of payload log items."""
3398
4567
  items: [PayloadLog!]!
4568
+
4569
+ """The total number of payload logs."""
3399
4570
  total: Int!
3400
4571
  }
3401
4572
 
4573
+ """Input for updating (patching) an existing payload log."""
3402
4574
  input PayloadLogPatch {
4575
+ """
4576
+ A flag indicating whether the log is being created, updated, or deleted.
4577
+ """
3403
4578
  cuFlag: String!
4579
+
4580
+ """The new description for the payload log entry."""
3404
4581
  description: String
4582
+
4583
+ """The unique identifier of the payload log to update."""
3405
4584
  id: ID
4585
+
4586
+ """The new name for the payload log entry."""
3406
4587
  name: String
3407
4588
  }
3408
4589
 
4590
+ """Represents an item pending in a scenario queue."""
3409
4591
  type PendingObject {
4592
+ """The timestamp indicating when the item is due for processing."""
3410
4593
  due: String!
4594
+
4595
+ """The priority level of the item in the queue."""
3411
4596
  priority: Int!
4597
+
4598
+ """The actual data or task object in the queue."""
3412
4599
  stuff: Object!
4600
+
4601
+ """A tag for categorizing or filtering queue items."""
3413
4602
  tag: String
3414
4603
  }
3415
4604
 
3416
- """Entity for Board PlayGroup"""
4605
+ """A group of boards that can be played in a sequence or collection."""
3417
4606
  type PlayGroup {
4607
+ """The list of boards included in this play group."""
3418
4608
  boards: [Board!]
4609
+
4610
+ """The timestamp when the play group was created."""
3419
4611
  createdAt: DateTimeISO
4612
+
4613
+ """The user who created the play group."""
3420
4614
  creator: User
4615
+
4616
+ """A detailed description of the play group."""
3421
4617
  description: String
4618
+
4619
+ """The domain to which this play group belongs."""
3422
4620
  domain: Domain
4621
+
4622
+ """Unique identifier for the play group."""
3423
4623
  id: ID!
4624
+
4625
+ """The name of the play group."""
3424
4626
  name: String!
4627
+
4628
+ """
4629
+ An array of board IDs, defining the specific playback order of boards within the group.
4630
+ """
4631
+ order: [String!]
4632
+
4633
+ """The timestamp when the play group was last updated."""
3425
4634
  updatedAt: DateTimeISO
4635
+
4636
+ """The user who last updated the play group."""
3426
4637
  updater: User
3427
4638
  }
3428
4639
 
4640
+ """A paginated list of play groups."""
3429
4641
  type PlayGroupList {
4642
+ """The list of play group items."""
3430
4643
  items: [PlayGroup!]!
4644
+
4645
+ """The total number of play groups."""
3431
4646
  total: Int!
3432
4647
  }
3433
4648
 
4649
+ """Input for updating (patching) an existing play group."""
3434
4650
  input PlayGroupPatch {
4651
+ """The new description for the play group."""
3435
4652
  description: String
4653
+
4654
+ """The new name for the play group."""
3436
4655
  name: String
3437
4656
  }
3438
4657
 
@@ -3486,36 +4705,78 @@ input PrinterDevicePatch {
3486
4705
  type: String
3487
4706
  }
3488
4707
 
4708
+ """
4709
+ A privilege that can be granted to roles to control access to resources.
4710
+ """
3489
4711
  type Privilege {
4712
+ """The category of the privilege (e.g., security, resource)."""
3490
4713
  category: String
4714
+
4715
+ """The timestamp when the privilege was created."""
3491
4716
  createdAt: DateTimeISO
4717
+
4718
+ """The user who created the privilege."""
3492
4719
  creator: User
4720
+
4721
+ """A detailed description of what the privilege allows."""
3493
4722
  description: String
4723
+
4724
+ """Unique identifier for the privilege."""
3494
4725
  id: ID!
4726
+
4727
+ """The name of the privilege."""
3495
4728
  name: String!
3496
4729
  privilege: String!
4730
+
4731
+ """Roles that include this privilege."""
3497
4732
  roles: [Role!]
4733
+
4734
+ """The timestamp when the privilege was last updated."""
3498
4735
  updatedAt: DateTimeISO
4736
+
4737
+ """The user who last updated the privilege."""
3499
4738
  updater: User
3500
4739
  }
3501
4740
 
4741
+ """A paginated list of privileges."""
3502
4742
  type PrivilegeList {
4743
+ """The list of privilege items."""
3503
4744
  items: [Privilege!]
4745
+
4746
+ """The total number of privileges."""
3504
4747
  total: Int
3505
4748
  }
3506
4749
 
4750
+ """Represents a privilege object with its properties."""
3507
4751
  type PrivilegeObject {
4752
+ """The category of the privilege."""
3508
4753
  category: String
4754
+
4755
+ """Indicates if the privilege is for an owner."""
3509
4756
  owner: Boolean
4757
+
4758
+ """The name of the privilege."""
3510
4759
  privilege: String
4760
+
4761
+ """Indicates if the privilege is for a superuser."""
3511
4762
  super: Boolean
3512
4763
  }
3513
4764
 
4765
+ """Input for updating (patching) an existing privilege."""
3514
4766
  input PrivilegePatch {
4767
+ """The new category for the privilege."""
3515
4768
  category: String
4769
+
4770
+ """The new description for the privilege."""
3516
4771
  description: String
4772
+
4773
+ """The unique identifier of the privilege to update."""
3517
4774
  id: String
4775
+
4776
+ """The new name for the privilege."""
3518
4777
  name: String
4778
+
4779
+ """A new list of roles to be assigned to the privilege."""
3519
4780
  roles: [ObjectRef!]
3520
4781
  }
3521
4782
 
@@ -3536,12 +4797,28 @@ input ProfileInput {
3536
4797
  zoom: Float
3537
4798
  }
3538
4799
 
4800
+ """
4801
+ Describes a single property for a component or a step, used for UI rendering and configuration.
4802
+ """
3539
4803
  type PropertySpec {
4804
+ """The human-readable label for the property, shown in UI."""
3540
4805
  label: String!
4806
+
4807
+ """The name of the property, used as the key in configuration objects."""
3541
4808
  name: String!
4809
+
4810
+ """Placeholder text for the input field."""
3542
4811
  placeholder: String
4812
+
4813
+ """
4814
+ Additional properties specific to the type (e.g., options for a select).
4815
+ """
3543
4816
  property: Object
4817
+
4818
+ """CSS styles to be applied to the input field."""
3544
4819
  styles: Object
4820
+
4821
+ """The data type of the property (e.g., text, number, boolean, select)."""
3545
4822
  type: String!
3546
4823
  }
3547
4824
 
@@ -3552,41 +4829,149 @@ type Query {
3552
4829
  PDFTemplate(id: String!): PDFTemplate
3553
4830
 
3554
4831
  """To fetch multiple PDFTemplates"""
3555
- PDFTemplates(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PDFTemplateList!
4832
+ PDFTemplates(
4833
+ """An array of filter conditions to apply to the list query."""
4834
+ filters: [Filter!]
4835
+
4836
+ """Inherited value type for the list query."""
4837
+ inherited: InheritedValueType
4838
+
4839
+ """Pagination options for the list query."""
4840
+ pagination: Pagination
4841
+
4842
+ """Sorting options for the list query."""
4843
+ sortings: [Sorting!]
4844
+ ): PDFTemplateList!
3556
4845
  appBinding(id: String!): AppBinding!
3557
- appBindings(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AppBindingList!
4846
+ appBindings(
4847
+ """An array of filter conditions to apply to the list query."""
4848
+ filters: [Filter!]
4849
+
4850
+ """Inherited value type for the list query."""
4851
+ inherited: InheritedValueType
4852
+
4853
+ """Pagination options for the list query."""
4854
+ pagination: Pagination
4855
+
4856
+ """Sorting options for the list query."""
4857
+ sortings: [Sorting!]
4858
+ ): AppBindingList!
3558
4859
 
3559
4860
  """ To fetch appliance"""
3560
4861
  appliance(id: String!): Appliance!
3561
4862
 
3562
4863
  """To fetch multiple appliance"""
3563
- appliances(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApplianceList!
4864
+ appliances(
4865
+ """An array of filter conditions to apply to the list query."""
4866
+ filters: [Filter!]
4867
+
4868
+ """Inherited value type for the list query."""
4869
+ inherited: InheritedValueType
4870
+
4871
+ """Pagination options for the list query."""
4872
+ pagination: Pagination
4873
+
4874
+ """Sorting options for the list query."""
4875
+ sortings: [Sorting!]
4876
+ ): ApplianceList!
3564
4877
 
3565
4878
  """To fetch application"""
3566
4879
  application(id: String!): Application!
3567
4880
 
3568
4881
  """To fetch multiple application"""
3569
- applications(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApplicationList!
4882
+ applications(
4883
+ """An array of filter conditions to apply to the list query."""
4884
+ filters: [Filter!]
4885
+
4886
+ """Inherited value type for the list query."""
4887
+ inherited: InheritedValueType
4888
+
4889
+ """Pagination options for the list query."""
4890
+ pagination: Pagination
4891
+
4892
+ """Sorting options for the list query."""
4893
+ sortings: [Sorting!]
4894
+ ): ApplicationList!
3570
4895
 
3571
4896
  """To fetch a approval line"""
3572
4897
  approvalLine(id: String!): ApprovalLine
3573
4898
 
3574
4899
  """To fetch referable approval lines for the user"""
3575
- approvalLineReferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApprovalLineList!
4900
+ approvalLineReferences(
4901
+ """An array of filter conditions to apply to the list query."""
4902
+ filters: [Filter!]
4903
+
4904
+ """Inherited value type for the list query."""
4905
+ inherited: InheritedValueType
4906
+
4907
+ """Pagination options for the list query."""
4908
+ pagination: Pagination
4909
+
4910
+ """Sorting options for the list query."""
4911
+ sortings: [Sorting!]
4912
+ ): ApprovalLineList!
3576
4913
 
3577
4914
  """To fetch multiple approval lines"""
3578
- approvalLines(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApprovalLineList!
4915
+ approvalLines(
4916
+ """An array of filter conditions to apply to the list query."""
4917
+ filters: [Filter!]
4918
+
4919
+ """Inherited value type for the list query."""
4920
+ inherited: InheritedValueType
4921
+
4922
+ """Pagination options for the list query."""
4923
+ pagination: Pagination
4924
+
4925
+ """Sorting options for the list query."""
4926
+ sortings: [Sorting!]
4927
+ ): ApprovalLineList!
3579
4928
  attachment(id: String!): Attachment!
3580
- attachments(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AttachmentList!
4929
+ attachments(
4930
+ """An array of filter conditions to apply to the list query."""
4931
+ filters: [Filter!]
4932
+
4933
+ """Inherited value type for the list query."""
4934
+ inherited: InheritedValueType
4935
+
4936
+ """Pagination options for the list query."""
4937
+ pagination: Pagination
4938
+
4939
+ """Sorting options for the list query."""
4940
+ sortings: [Sorting!]
4941
+ ): AttachmentList!
4942
+
4943
+ """
4944
+ Fetches a single AttributeSet entity by its unique identifier. Use this query to retrieve the details of a specific attribute set.
4945
+ """
4946
+ attributeSet(
4947
+ """The unique identifier of the AttributeSet to fetch."""
4948
+ id: String!
4949
+ ): AttributeSet
4950
+
4951
+ """
4952
+ Fetches a single AttributeSet entity by the associated entity name. Use this query to retrieve the attribute set for a specific entity type.
4953
+ """
4954
+ attributeSetByEntity(
4955
+ """The entity name associated with the AttributeSet."""
4956
+ entity: String!
4957
+ ): AttributeSet
4958
+
4959
+ """
4960
+ Fetches a list of AttributeSet entities with pagination and filtering options. Use this query to retrieve multiple attribute sets.
4961
+ """
4962
+ attributeSets(
4963
+ """An array of filter conditions to apply to the list query."""
4964
+ filters: [Filter!]
3581
4965
 
3582
- """To fetch a AttributeSet"""
3583
- attributeSet(id: String!): AttributeSet
4966
+ """Inherited value type for the list query."""
4967
+ inherited: InheritedValueType
3584
4968
 
3585
- """To fetch a AttributeSet by Entity name"""
3586
- attributeSetByEntity(entity: String!): AttributeSet
4969
+ """Pagination options for the list query."""
4970
+ pagination: Pagination
3587
4971
 
3588
- """To fetch multiple AttributeSets"""
3589
- attributeSets(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AttributeSetList!
4972
+ """Sorting options for the list query."""
4973
+ sortings: [Sorting!]
4974
+ ): AttributeSetList!
3590
4975
 
3591
4976
  """To fetch a AuthProvider"""
3592
4977
  authProvider(id: String!): AuthProvider
@@ -3595,34 +4980,94 @@ type Query {
3595
4980
  authProviderTypes: AuthProviderTypeList
3596
4981
 
3597
4982
  """To fetch multiple AuthProviders"""
3598
- authProviders(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AuthProviderList!
4983
+ authProviders(
4984
+ """An array of filter conditions to apply to the list query."""
4985
+ filters: [Filter!]
3599
4986
 
3600
- """To fetch a board"""
4987
+ """Inherited value type for the list query."""
4988
+ inherited: InheritedValueType
4989
+
4990
+ """Pagination options for the list query."""
4991
+ pagination: Pagination
4992
+
4993
+ """Sorting options for the list query."""
4994
+ sortings: [Sorting!]
4995
+ ): AuthProviderList!
4996
+
4997
+ """Finds a single board by its ID."""
3601
4998
  board(id: String!): Board!
3602
4999
 
3603
- """To fetch a Board Model by name"""
5000
+ """Finds a single board by its name."""
3604
5001
  boardByName(name: String!): Board
3605
5002
 
3606
- """To fetch the latest Board published"""
5003
+ """Retrieves the most recently published version of a board."""
3607
5004
  boardPublished(id: String!): BoardHistory!
3608
5005
 
3609
5006
  """To fetch a BoardTemplate"""
3610
5007
  boardTemplate(id: String!): BoardTemplate
3611
5008
 
3612
5009
  """To fetch multiple BoardTemplates"""
3613
- boardTemplates(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardTemplateList!
5010
+ boardTemplates(
5011
+ """An array of filter conditions to apply to the list query."""
5012
+ filters: [Filter!]
5013
+
5014
+ """Inherited value type for the list query."""
5015
+ inherited: InheritedValueType
5016
+
5017
+ """Pagination options for the list query."""
5018
+ pagination: Pagination
5019
+
5020
+ """Sorting options for the list query."""
5021
+ sortings: [Sorting!]
5022
+ ): BoardTemplateList!
3614
5023
 
3615
5024
  """To fetch BoardTemplates created by me"""
3616
- boardTemplatesCreatedByMe(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardTemplateList!
5025
+ boardTemplatesCreatedByMe(
5026
+ """An array of filter conditions to apply to the list query."""
5027
+ filters: [Filter!]
5028
+
5029
+ """Inherited value type for the list query."""
5030
+ inherited: InheritedValueType
5031
+
5032
+ """Pagination options for the list query."""
5033
+ pagination: Pagination
3617
5034
 
3618
- """To fetch a Board Versions"""
5035
+ """Sorting options for the list query."""
5036
+ sortings: [Sorting!]
5037
+ ): BoardTemplateList!
5038
+
5039
+ """Retrieves up to 10 historical versions of a specific board."""
3619
5040
  boardVersions(id: String!): [BoardHistory!]!
3620
5041
 
3621
- """To fetch multiple Boards"""
3622
- boards(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardList!
5042
+ """Retrieves a paginated list of all boards."""
5043
+ boards(
5044
+ """An array of filter conditions to apply to the list query."""
5045
+ filters: [Filter!]
5046
+
5047
+ """Inherited value type for the list query."""
5048
+ inherited: InheritedValueType
5049
+
5050
+ """Pagination options for the list query."""
5051
+ pagination: Pagination
5052
+
5053
+ """Sorting options for the list query."""
5054
+ sortings: [Sorting!]
5055
+ ): BoardList!
3623
5056
 
3624
- """To fetch Boards created by me"""
3625
- boardsCreatedByMe(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardList!
5057
+ """Retrieves a paginated list of boards created by the current user."""
5058
+ boardsCreatedByMe(
5059
+ """An array of filter conditions to apply to the list query."""
5060
+ filters: [Filter!]
5061
+
5062
+ """Inherited value type for the list query."""
5063
+ inherited: InheritedValueType
5064
+
5065
+ """Pagination options for the list query."""
5066
+ pagination: Pagination
5067
+
5068
+ """Sorting options for the list query."""
5069
+ sortings: [Sorting!]
5070
+ ): BoardList!
3626
5071
  chatCompletion(input: ChatCompletionInput!): ChatCompletionOutput!
3627
5072
 
3628
5073
  """
@@ -3644,10 +5089,25 @@ type Query {
3644
5089
  checkUserBelongsDomain: Boolean!
3645
5090
 
3646
5091
  """Checks if a user with the given email address exists in the system."""
3647
- checkUserExistence(email: EmailAddress!): Boolean!
5092
+ checkUserExistence(
5093
+ """The email address to check for existence."""
5094
+ email: EmailAddress!
5095
+ ): Boolean!
3648
5096
 
3649
5097
  """To fetch common approval lines"""
3650
- commonApprovalLines(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApprovalLineList!
5098
+ commonApprovalLines(
5099
+ """An array of filter conditions to apply to the list query."""
5100
+ filters: [Filter!]
5101
+
5102
+ """Inherited value type for the list query."""
5103
+ inherited: InheritedValueType
5104
+
5105
+ """Pagination options for the list query."""
5106
+ pagination: Pagination
5107
+
5108
+ """Sorting options for the list query."""
5109
+ sortings: [Sorting!]
5110
+ ): ApprovalLineList!
3651
5111
 
3652
5112
  """To fetch a CommonCode"""
3653
5113
  commonCode(name: String!): CommonCode
@@ -3656,28 +5116,81 @@ type Query {
3656
5116
  commonCodeDetail(id: String!): CommonCodeDetail!
3657
5117
 
3658
5118
  """To fetch multiple CommonCodeDetails"""
3659
- commonCodeDetails(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): CommonCodeDetailList!
5119
+ commonCodeDetails(
5120
+ """An array of filter conditions to apply to the list query."""
5121
+ filters: [Filter!]
5122
+
5123
+ """Inherited value type for the list query."""
5124
+ inherited: InheritedValueType
5125
+
5126
+ """Pagination options for the list query."""
5127
+ pagination: Pagination
5128
+
5129
+ """Sorting options for the list query."""
5130
+ sortings: [Sorting!]
5131
+ ): CommonCodeDetailList!
3660
5132
 
3661
5133
  """To fetch multiple CommonCodes"""
3662
- commonCodes(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): CommonCodeList!
5134
+ commonCodes(
5135
+ """An array of filter conditions to apply to the list query."""
5136
+ filters: [Filter!]
5137
+
5138
+ """Inherited value type for the list query."""
5139
+ inherited: InheritedValueType
5140
+
5141
+ """Pagination options for the list query."""
5142
+ pagination: Pagination
5143
+
5144
+ """Sorting options for the list query."""
5145
+ sortings: [Sorting!]
5146
+ ): CommonCodeList!
5147
+
5148
+ """Fetches a single connection by its name, including its current state."""
5149
+ connection(name: String!): Connection!
5150
+
5151
+ """
5152
+ Fetches a paginated list of connections, including their current states.
5153
+ """
5154
+ connections(
5155
+ """An array of filter conditions to apply to the list query."""
5156
+ filters: [Filter!]
5157
+
5158
+ """Inherited value type for the list query."""
5159
+ inherited: InheritedValueType
3663
5160
 
3664
- """To fetch a connector"""
3665
- connection(name: String!): ConnectorType!
5161
+ """Pagination options for the list query."""
5162
+ pagination: Pagination
3666
5163
 
3667
- """To fetch multiple connections"""
3668
- connections(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ConnectionList!
5164
+ """Sorting options for the list query."""
5165
+ sortings: [Sorting!]
5166
+ ): ConnectionList!
3669
5167
 
3670
- """To fetch the connector from a connection"""
5168
+ """Fetches a single connector type by its name."""
5169
+ connector(name: String!): ConnectorType!
5170
+
5171
+ """Fetches the connector type associated with a specific connection."""
3671
5172
  connectorByConnection(connectionName: String!): ConnectorType!
3672
5173
 
3673
- """To fetch multiple connector"""
5174
+ """Fetches a list of all available connector types."""
3674
5175
  connectors: ConnectorList!
3675
5176
 
3676
5177
  """To fetch a Contact"""
3677
5178
  contact(id: String!): Contact
3678
5179
 
3679
5180
  """To fetch multiple Contacts"""
3680
- contacts(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ContactList!
5181
+ contacts(
5182
+ """An array of filter conditions to apply to the list query."""
5183
+ filters: [Filter!]
5184
+
5185
+ """Inherited value type for the list query."""
5186
+ inherited: InheritedValueType
5187
+
5188
+ """Pagination options for the list query."""
5189
+ pagination: Pagination
5190
+
5191
+ """Sorting options for the list query."""
5192
+ sortings: [Sorting!]
5193
+ ): ContactList!
3681
5194
  customers: [Domain!]!
3682
5195
  decipherCode(input: CodeDecipherInput!): CodeDecipherOutput!
3683
5196
  decipherErrorCode(input: CodeDecipherInput!): CodeDecipherOutput!
@@ -3686,28 +5199,97 @@ type Query {
3686
5199
  department(id: String!): Department
3687
5200
 
3688
5201
  """To fetch a Root Departments"""
3689
- departmentRoots(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DepartmentList
5202
+ departmentRoots(
5203
+ """An array of filter conditions to apply to the list query."""
5204
+ filters: [Filter!]
5205
+
5206
+ """Inherited value type for the list query."""
5207
+ inherited: InheritedValueType
5208
+
5209
+ """Pagination options for the list query."""
5210
+ pagination: Pagination
5211
+
5212
+ """Sorting options for the list query."""
5213
+ sortings: [Sorting!]
5214
+ ): DepartmentList
3690
5215
 
3691
5216
  """To fetch multiple Departments"""
3692
- departments(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DepartmentList!
5217
+ departments(
5218
+ """An array of filter conditions to apply to the list query."""
5219
+ filters: [Filter!]
5220
+
5221
+ """Inherited value type for the list query."""
5222
+ inherited: InheritedValueType
5223
+
5224
+ """Pagination options for the list query."""
5225
+ pagination: Pagination
5226
+
5227
+ """Sorting options for the list query."""
5228
+ sortings: [Sorting!]
5229
+ ): DepartmentList!
3693
5230
 
3694
- """To fetch domain"""
3695
- domain(id: String!): Domain!
5231
+ """
5232
+ Fetches a single domain entity by its unique identifier. Only superusers are granted this privilege.
5233
+ """
5234
+ domain(
5235
+ """The unique identifier of the domain to fetch."""
5236
+ id: String!
5237
+ ): Domain!
3696
5238
 
3697
5239
  """To fetch multiple DomainLinks"""
3698
- domainLinks(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DomainLinkList!
5240
+ domainLinks(
5241
+ """An array of filter conditions to apply to the list query."""
5242
+ filters: [Filter!]
5243
+
5244
+ """Inherited value type for the list query."""
5245
+ inherited: InheritedValueType
3699
5246
 
3700
- """To fetch domain"""
5247
+ """Pagination options for the list query."""
5248
+ pagination: Pagination
5249
+
5250
+ """Sorting options for the list query."""
5251
+ sortings: [Sorting!]
5252
+ ): DomainLinkList!
5253
+
5254
+ """
5255
+ Fetches the list of available domain types from configuration. Only superusers are granted this privilege.
5256
+ """
3701
5257
  domainTypes: [String!]!
3702
5258
 
3703
- """To fetch all domains (Only superuser is granted this privilege.)"""
3704
- domains(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DomainList!
5259
+ """
5260
+ Fetches all domain entities with pagination and filtering options. Only superusers are granted this privilege.
5261
+ """
5262
+ domains(
5263
+ """An array of filter conditions to apply to the list query."""
5264
+ filters: [Filter!]
5265
+
5266
+ """Inherited value type for the list query."""
5267
+ inherited: InheritedValueType
5268
+
5269
+ """Pagination options for the list query."""
5270
+ pagination: Pagination
5271
+
5272
+ """Sorting options for the list query."""
5273
+ sortings: [Sorting!]
5274
+ ): DomainList!
3705
5275
 
3706
5276
  """To fetch domains with given privilege for user"""
3707
5277
  domainsWithPrivilege(category: String!, privilege: String!): [Domain!]!
3708
5278
 
3709
5279
  """To fetch multiple appliance"""
3710
- edges(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApplianceList!
5280
+ edges(
5281
+ """An array of filter conditions to apply to the list query."""
5282
+ filters: [Filter!]
5283
+
5284
+ """Inherited value type for the list query."""
5285
+ inherited: InheritedValueType
5286
+
5287
+ """Pagination options for the list query."""
5288
+ pagination: Pagination
5289
+
5290
+ """Sorting options for the list query."""
5291
+ sortings: [Sorting!]
5292
+ ): ApplianceList!
3711
5293
 
3712
5294
  """
3713
5295
  Fetches a specific employee by their unique ID. Returns the employee object if found, or null if not found.
@@ -3717,10 +5299,34 @@ type Query {
3717
5299
  """
3718
5300
  Fetches a list of employees based on provided query parameters. Supports searching by name, control number, and alias.
3719
5301
  """
3720
- employees(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): EmployeeList!
5302
+ employees(
5303
+ """An array of filter conditions to apply to the list query."""
5304
+ filters: [Filter!]
5305
+
5306
+ """Inherited value type for the list query."""
5307
+ inherited: InheritedValueType
5308
+
5309
+ """Pagination options for the list query."""
5310
+ pagination: Pagination
5311
+
5312
+ """Sorting options for the list query."""
5313
+ sortings: [Sorting!]
5314
+ ): EmployeeList!
3721
5315
 
3722
5316
  """To fetch multiple Entities"""
3723
- entities(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): EntityList!
5317
+ entities(
5318
+ """An array of filter conditions to apply to the list query."""
5319
+ filters: [Filter!]
5320
+
5321
+ """Inherited value type for the list query."""
5322
+ inherited: InheritedValueType
5323
+
5324
+ """Pagination options for the list query."""
5325
+ pagination: Pagination
5326
+
5327
+ """Sorting options for the list query."""
5328
+ sortings: [Sorting!]
5329
+ ): EntityList!
3724
5330
 
3725
5331
  """To fetch a Entity"""
3726
5332
  entity(id: String!): Entity!
@@ -3729,7 +5335,19 @@ type Query {
3729
5335
  entityColumn(id: String!): EntityColumn!
3730
5336
 
3731
5337
  """To fetch multiple EntityColumns"""
3732
- entityColumns(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): EntityColumnList!
5338
+ entityColumns(
5339
+ """An array of filter conditions to apply to the list query."""
5340
+ filters: [Filter!]
5341
+
5342
+ """Inherited value type for the list query."""
5343
+ inherited: InheritedValueType
5344
+
5345
+ """Pagination options for the list query."""
5346
+ pagination: Pagination
5347
+
5348
+ """Sorting options for the list query."""
5349
+ sortings: [Sorting!]
5350
+ ): EntityColumnList!
3733
5351
 
3734
5352
  """To fetch a EntityMetadata"""
3735
5353
  entityMetadata(name: String!): EntityMetadata!
@@ -3738,27 +5356,75 @@ type Query {
3738
5356
  favorite(id: String!): Favorite!
3739
5357
 
3740
5358
  """To fetch multiple BoardFavorites"""
3741
- favoriteBoards(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardFavoriteList!
5359
+ favoriteBoards(
5360
+ """An array of filter conditions to apply to the list query."""
5361
+ filters: [Filter!]
5362
+
5363
+ """Inherited value type for the list query."""
5364
+ inherited: InheritedValueType
5365
+
5366
+ """Pagination options for the list query."""
5367
+ pagination: Pagination
5368
+
5369
+ """Sorting options for the list query."""
5370
+ sortings: [Sorting!]
5371
+ ): BoardFavoriteList!
3742
5372
 
3743
5373
  """To fetch multiple Favorites"""
3744
- favorites(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): FavoriteList!
5374
+ favorites(
5375
+ """An array of filter conditions to apply to the list query."""
5376
+ filters: [Filter!]
3745
5377
 
3746
- """To fetch the state of a connection"""
5378
+ """Inherited value type for the list query."""
5379
+ inherited: InheritedValueType
5380
+
5381
+ """Pagination options for the list query."""
5382
+ pagination: Pagination
5383
+
5384
+ """Sorting options for the list query."""
5385
+ sortings: [Sorting!]
5386
+ ): FavoriteList!
5387
+
5388
+ """Fetches the current state of a single connection by its name."""
3747
5389
  fetchConnectionState(name: String!): ConnectionState!
3748
5390
 
3749
5391
  """To fetch a Font"""
3750
5392
  font(id: String!): Font!
3751
5393
 
3752
5394
  """To fetch multiple Fonts"""
3753
- fonts(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): FontList!
5395
+ fonts(
5396
+ """An array of filter conditions to apply to the list query."""
5397
+ filters: [Filter!]
5398
+
5399
+ """Inherited value type for the list query."""
5400
+ inherited: InheritedValueType
5401
+
5402
+ """Pagination options for the list query."""
5403
+ pagination: Pagination
5404
+
5405
+ """Sorting options for the list query."""
5406
+ sortings: [Sorting!]
5407
+ ): FontList!
3754
5408
  grantedRoles: [GrantedRole!]!
3755
5409
  grantingRoles(customerId: String!): [GrantedRole!]!
3756
5410
 
3757
- """To fetch a Group"""
5411
+ """Finds a single board group by its ID."""
3758
5412
  group(id: String!): Group
3759
5413
 
3760
- """To fetch multiple Groups"""
3761
- groups(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): GroupList!
5414
+ """Retrieves a paginated list of board groups."""
5415
+ groups(
5416
+ """An array of filter conditions to apply to the list query."""
5417
+ filters: [Filter!]
5418
+
5419
+ """Inherited value type for the list query."""
5420
+ inherited: InheritedValueType
5421
+
5422
+ """Pagination options for the list query."""
5423
+ pagination: Pagination
5424
+
5425
+ """Sorting options for the list query."""
5426
+ sortings: [Sorting!]
5427
+ ): GroupList!
3762
5428
 
3763
5429
  """To query whether I have the given permission"""
3764
5430
  hasPrivilege(category: String!, privilege: String!): Boolean!
@@ -3771,7 +5437,19 @@ type Query {
3771
5437
  invitations(reference: String!, type: String!): InvitationList!
3772
5438
 
3773
5439
  """To fetch multiple LoginHistories"""
3774
- loginHistories(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): LoginHistoryList!
5440
+ loginHistories(
5441
+ """An array of filter conditions to apply to the list query."""
5442
+ filters: [Filter!]
5443
+
5444
+ """Inherited value type for the list query."""
5445
+ inherited: InheritedValueType
5446
+
5447
+ """Pagination options for the list query."""
5448
+ pagination: Pagination
5449
+
5450
+ """Sorting options for the list query."""
5451
+ sortings: [Sorting!]
5452
+ ): LoginHistoryList!
3775
5453
 
3776
5454
  """To fetch a Menu"""
3777
5455
  menu(id: String!): Menu!
@@ -3780,7 +5458,19 @@ type Query {
3780
5458
  menuButton(id: String!): MenuButton!
3781
5459
 
3782
5460
  """To fetch multiple MenuButtons"""
3783
- menuButtons(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuButtonList!
5461
+ menuButtons(
5462
+ """An array of filter conditions to apply to the list query."""
5463
+ filters: [Filter!]
5464
+
5465
+ """Inherited value type for the list query."""
5466
+ inherited: InheritedValueType
5467
+
5468
+ """Pagination options for the list query."""
5469
+ pagination: Pagination
5470
+
5471
+ """Sorting options for the list query."""
5472
+ sortings: [Sorting!]
5473
+ ): MenuButtonList!
3784
5474
 
3785
5475
  """To fetch a Menu by routing"""
3786
5476
  menuByRouting(routing: String!): Menu!
@@ -3789,7 +5479,19 @@ type Query {
3789
5479
  menuColumn(id: String!): MenuColumn!
3790
5480
 
3791
5481
  """To fetch multiple MenuColumns"""
3792
- menuColumns(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuColumnList!
5482
+ menuColumns(
5483
+ """An array of filter conditions to apply to the list query."""
5484
+ filters: [Filter!]
5485
+
5486
+ """Inherited value type for the list query."""
5487
+ inherited: InheritedValueType
5488
+
5489
+ """Pagination options for the list query."""
5490
+ pagination: Pagination
5491
+
5492
+ """Sorting options for the list query."""
5493
+ sortings: [Sorting!]
5494
+ ): MenuColumnList!
3793
5495
 
3794
5496
  """To fetch a MenuDetail"""
3795
5497
  menuDetail(id: String!): MenuDetail!
@@ -3798,32 +5500,116 @@ type Query {
3798
5500
  menuDetailButton(id: String!): MenuDetailButton!
3799
5501
 
3800
5502
  """To fetch multiple MenuDetailButtons"""
3801
- menuDetailButtons(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuDetailButtonList!
5503
+ menuDetailButtons(
5504
+ """An array of filter conditions to apply to the list query."""
5505
+ filters: [Filter!]
5506
+
5507
+ """Inherited value type for the list query."""
5508
+ inherited: InheritedValueType
5509
+
5510
+ """Pagination options for the list query."""
5511
+ pagination: Pagination
5512
+
5513
+ """Sorting options for the list query."""
5514
+ sortings: [Sorting!]
5515
+ ): MenuDetailButtonList!
3802
5516
 
3803
5517
  """To fetch a MenuDetailColumn"""
3804
5518
  menuDetailColumn(id: String!): MenuDetailColumn!
3805
5519
 
3806
5520
  """To fetch multiple MenuDetailColumns"""
3807
- menuDetailColumns(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuDetailColumnList!
5521
+ menuDetailColumns(
5522
+ """An array of filter conditions to apply to the list query."""
5523
+ filters: [Filter!]
5524
+
5525
+ """Inherited value type for the list query."""
5526
+ inherited: InheritedValueType
5527
+
5528
+ """Pagination options for the list query."""
5529
+ pagination: Pagination
5530
+
5531
+ """Sorting options for the list query."""
5532
+ sortings: [Sorting!]
5533
+ ): MenuDetailColumnList!
3808
5534
 
3809
5535
  """To fetch multiple MenuDetails"""
3810
- menuDetails(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuDetailList!
5536
+ menuDetails(
5537
+ """An array of filter conditions to apply to the list query."""
5538
+ filters: [Filter!]
5539
+
5540
+ """Inherited value type for the list query."""
5541
+ inherited: InheritedValueType
5542
+
5543
+ """Pagination options for the list query."""
5544
+ pagination: Pagination
5545
+
5546
+ """Sorting options for the list query."""
5547
+ sortings: [Sorting!]
5548
+ ): MenuDetailList!
3811
5549
 
3812
5550
  """To fetch multiple Menus"""
3813
- menus(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuList!
5551
+ menus(
5552
+ """An array of filter conditions to apply to the list query."""
5553
+ filters: [Filter!]
5554
+
5555
+ """Inherited value type for the list query."""
5556
+ inherited: InheritedValueType
5557
+
5558
+ """Pagination options for the list query."""
5559
+ pagination: Pagination
5560
+
5561
+ """Sorting options for the list query."""
5562
+ sortings: [Sorting!]
5563
+ ): MenuList!
3814
5564
 
3815
5565
  """To fetch approval lines only for to the user"""
3816
- myApprovalLines(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApprovalLineList!
5566
+ myApprovalLines(
5567
+ """An array of filter conditions to apply to the list query."""
5568
+ filters: [Filter!]
5569
+
5570
+ """Inherited value type for the list query."""
5571
+ inherited: InheritedValueType
5572
+
5573
+ """Pagination options for the list query."""
5574
+ pagination: Pagination
5575
+
5576
+ """Sorting options for the list query."""
5577
+ sortings: [Sorting!]
5578
+ ): ApprovalLineList!
3817
5579
 
3818
5580
  """To fetch current user's Favorites"""
3819
5581
  myFavorites: [Favorite!]!
3820
5582
  myLoginHistories(limit: Float!): [LoginHistory!]!
3821
5583
 
3822
5584
  """To fetch my own Menus"""
3823
- myMenus(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuList!
5585
+ myMenus(
5586
+ """An array of filter conditions to apply to the list query."""
5587
+ filters: [Filter!]
5588
+
5589
+ """Inherited value type for the list query."""
5590
+ inherited: InheritedValueType
5591
+
5592
+ """Pagination options for the list query."""
5593
+ pagination: Pagination
5594
+
5595
+ """Sorting options for the list query."""
5596
+ sortings: [Sorting!]
5597
+ ): MenuList!
3824
5598
 
3825
5599
  """To fetch my notifications"""
3826
- myNotifications(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): NotificationList!
5600
+ myNotifications(
5601
+ """An array of filter conditions to apply to the list query."""
5602
+ filters: [Filter!]
5603
+
5604
+ """Inherited value type for the list query."""
5605
+ inherited: InheritedValueType
5606
+
5607
+ """Pagination options for the list query."""
5608
+ pagination: Pagination
5609
+
5610
+ """Sorting options for the list query."""
5611
+ sortings: [Sorting!]
5612
+ ): NotificationList!
3827
5613
 
3828
5614
  """To fetch a User's own PagePreference"""
3829
5615
  myPageAllPreferences(page: String!): [PagePreference!]
@@ -3832,16 +5618,40 @@ type Query {
3832
5618
  myPagePreference(element: String!, page: String!): PagePreference
3833
5619
 
3834
5620
  """To fetch multiple PagePreferences"""
3835
- myPagePreferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PagePreferenceList!
5621
+ myPagePreferences(
5622
+ """An array of filter conditions to apply to the list query."""
5623
+ filters: [Filter!]
5624
+
5625
+ """Inherited value type for the list query."""
5626
+ inherited: InheritedValueType
3836
5627
 
3837
- """To fetch roles of current user"""
3838
- myRoles: [Role!]!
5628
+ """Pagination options for the list query."""
5629
+ pagination: Pagination
5630
+
5631
+ """Sorting options for the list query."""
5632
+ sortings: [Sorting!]
5633
+ ): PagePreferenceList!
5634
+
5635
+ """To fetch roles of current user (id, name only)"""
5636
+ myRoles: [RoleBrief!]!
3839
5637
 
3840
5638
  """To fetch a User's own UserPreference"""
3841
5639
  myUserPreference(element: String!, key: String!): UserPreference
3842
5640
 
3843
5641
  """To fetch multiple UserPreferences"""
3844
- myUserPreferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): UserPreferenceList!
5642
+ myUserPreferences(
5643
+ """An array of filter conditions to apply to the list query."""
5644
+ filters: [Filter!]
5645
+
5646
+ """Inherited value type for the list query."""
5647
+ inherited: InheritedValueType
5648
+
5649
+ """Pagination options for the list query."""
5650
+ pagination: Pagination
5651
+
5652
+ """Sorting options for the list query."""
5653
+ sortings: [Sorting!]
5654
+ ): UserPreferenceList!
3845
5655
 
3846
5656
  """To fetch a Notification"""
3847
5657
  notification(id: String!): Notification
@@ -3850,16 +5660,52 @@ type Query {
3850
5660
  notificationRule(id: String!): NotificationRule
3851
5661
 
3852
5662
  """To fetch multiple NotificationRules"""
3853
- notificationRules(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): NotificationRuleList!
5663
+ notificationRules(
5664
+ """An array of filter conditions to apply to the list query."""
5665
+ filters: [Filter!]
5666
+
5667
+ """Inherited value type for the list query."""
5668
+ inherited: InheritedValueType
5669
+
5670
+ """Pagination options for the list query."""
5671
+ pagination: Pagination
5672
+
5673
+ """Sorting options for the list query."""
5674
+ sortings: [Sorting!]
5675
+ ): NotificationRuleList!
3854
5676
 
3855
5677
  """To fetch multiple Notificationes"""
3856
- notificationes(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): NotificationList!
5678
+ notificationes(
5679
+ """An array of filter conditions to apply to the list query."""
5680
+ filters: [Filter!]
5681
+
5682
+ """Inherited value type for the list query."""
5683
+ inherited: InheritedValueType
5684
+
5685
+ """Pagination options for the list query."""
5686
+ pagination: Pagination
5687
+
5688
+ """Sorting options for the list query."""
5689
+ sortings: [Sorting!]
5690
+ ): NotificationList!
3857
5691
 
3858
5692
  """To fetch a Oauth2Client"""
3859
5693
  oauth2Client(id: String!): Oauth2Client
3860
5694
 
3861
5695
  """To fetch multiple Oauth2Clients"""
3862
- oauth2Clients(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): Oauth2ClientList!
5696
+ oauth2Clients(
5697
+ """An array of filter conditions to apply to the list query."""
5698
+ filters: [Filter!]
5699
+
5700
+ """Inherited value type for the list query."""
5701
+ inherited: InheritedValueType
5702
+
5703
+ """Pagination options for the list query."""
5704
+ pagination: Pagination
5705
+
5706
+ """Sorting options for the list query."""
5707
+ sortings: [Sorting!]
5708
+ ): Oauth2ClientList!
3863
5709
 
3864
5710
  """To fetch a PagePreference"""
3865
5711
  pagePreference(id: String!): PagePreference
@@ -3872,33 +5718,81 @@ type Query {
3872
5718
 
3873
5719
  """To fetch multiple PartnerSettings"""
3874
5720
  partnerSettings(filters: [Filter!]!, pagination: Pagination!, partnerDomain: ObjectRef!, sortings: [Sorting!]!): PartnerSettingList!
3875
- partners(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PartnerList!
5721
+ partners(
5722
+ """An array of filter conditions to apply to the list query."""
5723
+ filters: [Filter!]
5724
+
5725
+ """Inherited value type for the list query."""
5726
+ inherited: InheritedValueType
5727
+
5728
+ """Pagination options for the list query."""
5729
+ pagination: Pagination
5730
+
5731
+ """Sorting options for the list query."""
5732
+ sortings: [Sorting!]
5733
+ ): PartnerList!
3876
5734
 
3877
5735
  """
3878
5736
  Retrieves the current password rule configuration for the system, such as required character types and minimum length.
3879
5737
  """
3880
5738
  passwordRule: PasswordRule!
3881
5739
 
3882
- """To fetch a PayloadLog"""
5740
+ """Fetches a single payload log by its ID."""
3883
5741
  payloadLog(id: String!): PayloadLog!
3884
5742
 
3885
- """To fetch multiple PayloadLogs"""
3886
- payloadLogs(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PayloadLogList!
5743
+ """Fetches a paginated list of payload logs."""
5744
+ payloadLogs(
5745
+ """An array of filter conditions to apply to the list query."""
5746
+ filters: [Filter!]
5747
+
5748
+ """Inherited value type for the list query."""
5749
+ inherited: InheritedValueType
5750
+
5751
+ """Pagination options for the list query."""
5752
+ pagination: Pagination
5753
+
5754
+ """Sorting options for the list query."""
5755
+ sortings: [Sorting!]
5756
+ ): PayloadLogList!
3887
5757
 
3888
5758
  """To fetch a PDFRelease"""
3889
5759
  pdfRelease(id: String!): PDFRelease
3890
5760
 
3891
5761
  """To fetch multiple PDFReleases"""
3892
- pdfReleases(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PDFReleaseList!
5762
+ pdfReleases(
5763
+ """An array of filter conditions to apply to the list query."""
5764
+ filters: [Filter!]
3893
5765
 
3894
- """To fetch a PlayGroup"""
5766
+ """Inherited value type for the list query."""
5767
+ inherited: InheritedValueType
5768
+
5769
+ """Pagination options for the list query."""
5770
+ pagination: Pagination
5771
+
5772
+ """Sorting options for the list query."""
5773
+ sortings: [Sorting!]
5774
+ ): PDFReleaseList!
5775
+
5776
+ """Finds a single play group by its ID."""
3895
5777
  playGroup(id: String!): PlayGroup
3896
5778
 
3897
- """To fetch a PlayGroup by name"""
5779
+ """Finds a single play group by its name."""
3898
5780
  playGroupByName(name: String!): PlayGroup
3899
5781
 
3900
- """To fetch multiple PlayGroups"""
3901
- playGroups(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PlayGroupList!
5782
+ """Retrieves a paginated list of play groups."""
5783
+ playGroups(
5784
+ """An array of filter conditions to apply to the list query."""
5785
+ filters: [Filter!]
5786
+
5787
+ """Inherited value type for the list query."""
5788
+ inherited: InheritedValueType
5789
+
5790
+ """Pagination options for the list query."""
5791
+ pagination: Pagination
5792
+
5793
+ """Sorting options for the list query."""
5794
+ sortings: [Sorting!]
5795
+ ): PlayGroupList!
3902
5796
 
3903
5797
  """To fetch a UserPreference"""
3904
5798
  preference(id: String!): UserPreference
@@ -3907,10 +5801,34 @@ type Query {
3907
5801
  printerDevice(id: String!): PrinterDevice!
3908
5802
 
3909
5803
  """To fetch multiple PrinterDevices"""
3910
- printerDevices(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PrinterDeviceList!
5804
+ printerDevices(
5805
+ """An array of filter conditions to apply to the list query."""
5806
+ filters: [Filter!]
5807
+
5808
+ """Inherited value type for the list query."""
5809
+ inherited: InheritedValueType
5810
+
5811
+ """Pagination options for the list query."""
5812
+ pagination: Pagination
5813
+
5814
+ """Sorting options for the list query."""
5815
+ sortings: [Sorting!]
5816
+ ): PrinterDeviceList!
3911
5817
 
3912
5818
  """To fetch multiple privileges"""
3913
- privileges(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PrivilegeList!
5819
+ privileges(
5820
+ """An array of filter conditions to apply to the list query."""
5821
+ filters: [Filter!]
5822
+
5823
+ """Inherited value type for the list query."""
5824
+ inherited: InheritedValueType
5825
+
5826
+ """Pagination options for the list query."""
5827
+ pagination: Pagination
5828
+
5829
+ """Sorting options for the list query."""
5830
+ sortings: [Sorting!]
5831
+ ): PrivilegeList!
3914
5832
 
3915
5833
  """To fetch role"""
3916
5834
  role(name: String!): Role!
@@ -3922,72 +5840,199 @@ type Query {
3922
5840
  rolePrivileges(roleId: String!): [RolePrivilege!]!
3923
5841
 
3924
5842
  """To fetch multiple users"""
3925
- roles(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): RoleList!
5843
+ roles(
5844
+ """An array of filter conditions to apply to the list query."""
5845
+ filters: [Filter!]
3926
5846
 
3927
- """To fetch a scenario"""
5847
+ """Inherited value type for the list query."""
5848
+ inherited: InheritedValueType
5849
+
5850
+ """Pagination options for the list query."""
5851
+ pagination: Pagination
5852
+
5853
+ """Sorting options for the list query."""
5854
+ sortings: [Sorting!]
5855
+ ): RoleList!
5856
+
5857
+ """Fetches a single scenario by its ID."""
3928
5858
  scenario(id: String!): Scenario!
3929
5859
 
3930
- """To fetch a scenario instance"""
5860
+ """Fetches a single scenario instance by its name."""
3931
5861
  scenarioInstance(instanceName: String!): ScenarioInstance!
3932
5862
 
3933
- """To fetch multiple scenario instances"""
3934
- scenarioInstances(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ScenarioInstanceList!
5863
+ """Fetches a list of all active scenario instances."""
5864
+ scenarioInstances(
5865
+ """An array of filter conditions to apply to the list query."""
5866
+ filters: [Filter!]
5867
+
5868
+ """Inherited value type for the list query."""
5869
+ inherited: InheritedValueType
5870
+
5871
+ """Pagination options for the list query."""
5872
+ pagination: Pagination
5873
+
5874
+ """Sorting options for the list query."""
5875
+ sortings: [Sorting!]
5876
+ ): ScenarioInstanceList!
5877
+
5878
+ """Fetches a paginated list of scenarios."""
5879
+ scenarios(
5880
+ """An array of filter conditions to apply to the list query."""
5881
+ filters: [Filter!]
5882
+
5883
+ """Inherited value type for the list query."""
5884
+ inherited: InheritedValueType
3935
5885
 
3936
- """To fetch multiple scenarios"""
3937
- scenarios(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ScenarioList!
5886
+ """Pagination options for the list query."""
5887
+ pagination: Pagination
5888
+
5889
+ """Sorting options for the list query."""
5890
+ sortings: [Sorting!]
5891
+ ): ScenarioList!
3938
5892
  schedule(id: ID!): Schedule
3939
5893
 
3940
5894
  """To fetch multiple Schedules"""
3941
- schedules(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ScheduleList!
3942
- searchCustomers(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DomainList!
5895
+ schedules(
5896
+ """An array of filter conditions to apply to the list query."""
5897
+ filters: [Filter!]
5898
+
5899
+ """Inherited value type for the list query."""
5900
+ inherited: InheritedValueType
5901
+
5902
+ """Pagination options for the list query."""
5903
+ pagination: Pagination
5904
+
5905
+ """Sorting options for the list query."""
5906
+ sortings: [Sorting!]
5907
+ ): ScheduleList!
5908
+ searchCustomers(
5909
+ """An array of filter conditions to apply to the list query."""
5910
+ filters: [Filter!]
3943
5911
 
3944
- """To fetch domain"""
5912
+ """Inherited value type for the list query."""
5913
+ inherited: InheritedValueType
5914
+
5915
+ """Pagination options for the list query."""
5916
+ pagination: Pagination
5917
+
5918
+ """Sorting options for the list query."""
5919
+ sortings: [Sorting!]
5920
+ ): DomainList!
5921
+
5922
+ """
5923
+ Fetches the secure IP list (whitelist, blacklist, etc.) for the current domain. Only domain owners and superusers are granted this privilege.
5924
+ """
3945
5925
  secureIPList: Object
3946
5926
 
3947
5927
  """To fetch a Setting"""
3948
5928
  setting(name: String!, partnerDomainId: String): Setting!
3949
5929
 
3950
5930
  """To fetch multiple Settings"""
3951
- settings(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): SettingList!
5931
+ settings(
5932
+ """An array of filter conditions to apply to the list query."""
5933
+ filters: [Filter!]
5934
+
5935
+ """Inherited value type for the list query."""
5936
+ inherited: InheritedValueType
5937
+
5938
+ """Pagination options for the list query."""
5939
+ pagination: Pagination
5940
+
5941
+ """Sorting options for the list query."""
5942
+ sortings: [Sorting!]
5943
+ ): SettingList!
3952
5944
 
3953
- """To fetch a StateRegister"""
5945
+ """Fetches a single state register by its ID."""
3954
5946
  stateRegister(id: String!): StateRegister
3955
5947
 
3956
- """To fetch a StateRegister by name"""
5948
+ """Fetches a single state register by its name."""
3957
5949
  stateRegisterByName(name: String!): StateRegister
3958
5950
 
3959
- """To fetch multiple StateRegisters"""
3960
- stateRegisters(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): StateRegisterList!
5951
+ """Fetches a paginated list of state registers."""
5952
+ stateRegisters(
5953
+ """An array of filter conditions to apply to the list query."""
5954
+ filters: [Filter!]
3961
5955
 
3962
- """To fetch a step"""
5956
+ """Inherited value type for the list query."""
5957
+ inherited: InheritedValueType
5958
+
5959
+ """Pagination options for the list query."""
5960
+ pagination: Pagination
5961
+
5962
+ """Sorting options for the list query."""
5963
+ sortings: [Sorting!]
5964
+ ): StateRegisterList!
5965
+
5966
+ """Fetches a single scenario step by its name."""
3963
5967
  step(name: String!): Step!
3964
5968
 
3965
- """To fetch multiple steps"""
3966
- steps(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): StepList!
5969
+ """Fetches a paginated list of scenario steps."""
5970
+ steps(
5971
+ """An array of filter conditions to apply to the list query."""
5972
+ filters: [Filter!]
5973
+
5974
+ """Inherited value type for the list query."""
5975
+ inherited: InheritedValueType
3967
5976
 
3968
- """To fetch a task-type"""
5977
+ """Pagination options for the list query."""
5978
+ pagination: Pagination
5979
+
5980
+ """Sorting options for the list query."""
5981
+ sortings: [Sorting!]
5982
+ ): StepList!
5983
+
5984
+ """Fetches a single task type by its name."""
3969
5985
  taskType(name: String!): TaskType!
3970
5986
 
3971
- """To fetch multiple task-type"""
5987
+ """Fetches a list of all available task types."""
3972
5988
  taskTypes: TaskTypeList!
3973
5989
 
3974
- """To fetch the connector from a task-type"""
5990
+ """
5991
+ Fetches a list of task types that are compatible with a specific connection.
5992
+ """
3975
5993
  taskTypesByConnection(connectionName: String!): TaskTypeList!
3976
5994
 
3977
5995
  """To fetch multiple Terminologies"""
3978
- terminologies(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): TerminologyList!
5996
+ terminologies(
5997
+ """An array of filter conditions to apply to the list query."""
5998
+ filters: [Filter!]
5999
+
6000
+ """Inherited value type for the list query."""
6001
+ inherited: InheritedValueType
6002
+
6003
+ """Pagination options for the list query."""
6004
+ pagination: Pagination
6005
+
6006
+ """Sorting options for the list query."""
6007
+ sortings: [Sorting!]
6008
+ ): TerminologyList!
3979
6009
 
3980
6010
  """To fetch a Terminology"""
3981
6011
  terminology(id: String!): Terminology!
3982
6012
 
3983
- """To fetch a Theme"""
6013
+ """Finds a single theme by its ID."""
3984
6014
  theme(id: String!): Theme
3985
6015
 
3986
- """To fetch multiple Themes"""
3987
- themes(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ThemeList!
6016
+ """Retrieves a paginated list of themes."""
6017
+ themes(
6018
+ """An array of filter conditions to apply to the list query."""
6019
+ filters: [Filter!]
6020
+
6021
+ """Inherited value type for the list query."""
6022
+ inherited: InheritedValueType
6023
+
6024
+ """Pagination options for the list query."""
6025
+ pagination: Pagination
6026
+
6027
+ """Sorting options for the list query."""
6028
+ sortings: [Sorting!]
6029
+ ): ThemeList!
3988
6030
 
3989
6031
  """Fetches a user by their email address within the current domain."""
3990
- user(email: EmailAddress!): User!
6032
+ user(
6033
+ """The email address of the user to fetch."""
6034
+ email: EmailAddress!
6035
+ ): User!
3991
6036
 
3992
6037
  """To fetch Menus by role"""
3993
6038
  userMenus: [Menu!]!
@@ -3998,7 +6043,19 @@ type Query {
3998
6043
  """
3999
6044
  Fetches a list of users based on provided search parameters within the current domain.
4000
6045
  """
4001
- users(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): UserList!
6046
+ users(
6047
+ """An array of filter conditions to apply to the list query."""
6048
+ filters: [Filter!]
6049
+
6050
+ """Inherited value type for the list query."""
6051
+ inherited: InheritedValueType
6052
+
6053
+ """Pagination options for the list query."""
6054
+ pagination: Pagination
6055
+
6056
+ """Sorting options for the list query."""
6057
+ sortings: [Sorting!]
6058
+ ): UserList!
4002
6059
  vendors: [Domain!]!
4003
6060
  }
4004
6061
 
@@ -4008,120 +6065,286 @@ type RecipientItem {
4008
6065
  value: String
4009
6066
  }
4010
6067
 
6068
+ """
6069
+ A role that groups a set of privileges, which can be assigned to users.
6070
+ """
4011
6071
  type Role {
6072
+ """The timestamp when the role was created."""
4012
6073
  createdAt: DateTimeISO
6074
+
6075
+ """The user who created the role."""
4013
6076
  creator: User
6077
+
6078
+ """A description of the role."""
4014
6079
  description: String
6080
+
6081
+ """The domain to which the role belongs."""
4015
6082
  domain: Domain!
6083
+
6084
+ """Unique identifier for the role."""
4016
6085
  id: ID!
6086
+
6087
+ """The name of the role."""
4017
6088
  name: String
6089
+
6090
+ """Privileges granted by this role."""
4018
6091
  privileges: [Privilege!]
6092
+
6093
+ """The timestamp when the role was last updated."""
4019
6094
  updatedAt: DateTimeISO
6095
+
6096
+ """The user who last updated the role."""
4020
6097
  updater: User
6098
+
6099
+ """Users who are assigned this role."""
4021
6100
  users: [User!]
4022
6101
  }
4023
6102
 
6103
+ """A brief summary of a role, containing only the ID and name."""
6104
+ type RoleBrief {
6105
+ """The unique identifier of the role."""
6106
+ id: String
6107
+
6108
+ """The name of the role."""
6109
+ name: String
6110
+ }
6111
+
6112
+ """A paginated list of roles."""
4024
6113
  type RoleList {
6114
+ """The list of role items."""
4025
6115
  items: [Role!]
6116
+
6117
+ """The total number of roles."""
4026
6118
  total: Int
4027
6119
  }
4028
6120
 
6121
+ """Input for updating (patching) an existing role."""
4029
6122
  input RolePatch {
6123
+ """
6124
+ A flag indicating whether the role is being created, updated, or deleted.
6125
+ """
4030
6126
  cuFlag: String
6127
+
6128
+ """The new description for the role."""
4031
6129
  description: String
6130
+
6131
+ """The unique identifier of the role to update."""
4032
6132
  id: String
6133
+
6134
+ """The new name for the role."""
4033
6135
  name: String
6136
+
6137
+ """A new list of privileges to be granted by the role."""
4034
6138
  privileges: [ObjectRef!]
6139
+
6140
+ """A new list of users to be assigned to the role."""
4035
6141
  users: [ObjectRef!]
4036
6142
  }
4037
6143
 
6144
+ """Represents a privilege and whether it is assigned to a specific role."""
4038
6145
  type RolePrivilege {
6146
+ """Indicates whether the privilege is assigned to the role."""
4039
6147
  assigned: Boolean
6148
+
6149
+ """The category of the privilege."""
4040
6150
  category: String
6151
+
6152
+ """A description of the privilege."""
4041
6153
  description: String
6154
+
6155
+ """The unique identifier of the privilege."""
4042
6156
  id: String
6157
+
6158
+ """The name of the privilege."""
4043
6159
  name: String
4044
6160
  }
4045
6161
 
6162
+ """Represents a sequence of steps designed to automate a task or process."""
4046
6163
  type Scenario {
4047
- """[will be deprecated] automatically be started when this server start"""
6164
+ """
6165
+ Indicates if the scenario should be automatically started when the server starts. [will be deprecated]
6166
+ """
4048
6167
  active: Boolean
4049
6168
  connectionNames: [Connection!]!
6169
+
6170
+ """The timestamp when the scenario was created."""
4050
6171
  createdAt: DateTimeISO
6172
+
6173
+ """The user who created the scenario."""
4051
6174
  creator: User
6175
+
6176
+ """A detailed description of the scenario."""
4052
6177
  description: String
6178
+
6179
+ """The domain to which this scenario belongs."""
4053
6180
  domain: Domain!
6181
+
6182
+ """Unique identifier for the scenario."""
4054
6183
  id: ID!
4055
6184
  instances: [ScenarioInstance!]
6185
+
6186
+ """The name of the scenario."""
4056
6187
  name: String!
6188
+
6189
+ """Privilege required to execute the scenario."""
4057
6190
  privilege: PrivilegeObject
4058
6191
 
4059
- """accessible and executable system-wide"""
6192
+ """Indicates if the scenario is accessible and executable system-wide."""
4060
6193
  public: Boolean
4061
6194
  publishTags: [Connection!]!
6195
+
6196
+ """Role required to execute the scenario."""
4062
6197
  role: Role
6198
+
6199
+ """A cron-style schedule for running the scenario automatically."""
4063
6200
  schedule: String
6201
+
6202
+ """The ID of the scheduled job, if any."""
4064
6203
  scheduleId: String
4065
6204
  state: String
6205
+
6206
+ """The sequence of steps that make up the scenario."""
4066
6207
  steps: [Step!]
6208
+
6209
+ """The timezone for the schedule."""
4067
6210
  timezone: String
6211
+
6212
+ """Time-to-live in seconds for scenario instances."""
4068
6213
  ttl: Float
6214
+
6215
+ """The type of the scenario, used for categorization."""
4069
6216
  type: String
6217
+
6218
+ """The timestamp when the scenario was last updated."""
4070
6219
  updatedAt: DateTimeISO
6220
+
6221
+ """The user who last updated the scenario."""
4071
6222
  updater: User
4072
6223
  }
4073
6224
 
6225
+ """Represents a running or completed instance of a scenario."""
4074
6226
  type ScenarioInstance {
6227
+ """A key-value map of data generated and used by the instance."""
4075
6228
  data: Object
6229
+
6230
+ """The domain in which the instance is running."""
4076
6231
  domain: Domain
6232
+
6233
+ """The unique name for this specific instance of the scenario."""
4077
6234
  instanceName: String
6235
+
6236
+ """A message associated with the current state (e.g., an error message)."""
4078
6237
  message: String
6238
+
6239
+ """The current progress of the instance."""
4079
6240
  progress: ScenarioInstanceProgress
6241
+
6242
+ """The final result of the scenario run."""
4080
6243
  result: Object
6244
+
6245
+ """The root scenario instance if this is a sub-scenario."""
4081
6246
  root: ScenarioInstance
6247
+
6248
+ """The name of the scenario being executed."""
4082
6249
  scenarioName: String
6250
+
6251
+ """The current execution state of the instance."""
4083
6252
  state: String
6253
+
6254
+ """The timestamp of the last update."""
4084
6255
  timestamp: DateTimeISO
6256
+
6257
+ """The user who initiated the instance."""
4085
6258
  user: User
6259
+
6260
+ """A key-value map of variables used in the instance."""
4086
6261
  variables: Object
4087
6262
  }
4088
6263
 
6264
+ """A paginated list of scenario instances."""
4089
6265
  type ScenarioInstanceList {
6266
+ """The list of scenario instance items."""
4090
6267
  items: [ScenarioInstance!]!
6268
+
6269
+ """The total number of scenario instances."""
4091
6270
  total: Int!
4092
6271
  }
4093
6272
 
6273
+ """Provides progress information for a running scenario instance."""
4094
6274
  type ScenarioInstanceProgress {
6275
+ """The completion rate of the scenario as a percentage."""
4095
6276
  rate: Int!
6277
+
6278
+ """The number of rounds the scenario has completed."""
4096
6279
  rounds: Int!
6280
+
6281
+ """The current step number being executed."""
4097
6282
  step: Int!
6283
+
6284
+ """The total number of steps in the scenario."""
4098
6285
  steps: Int!
4099
6286
  }
4100
6287
 
6288
+ """Contains the final result of a completed scenario instance run."""
4101
6289
  type ScenarioInstanceRunResult {
6290
+ """The final set of data after the run."""
4102
6291
  data: Object
6292
+
6293
+ """The unique name of the instance that was run."""
4103
6294
  instanceName: String
6295
+
6296
+ """A final message from the run (e.g., success or failure reason)."""
4104
6297
  message: String
6298
+
6299
+ """The final result returned by the scenario."""
4105
6300
  result: Object
6301
+
6302
+ """The name of the scenario that was executed."""
4106
6303
  scenarioName: String
6304
+
6305
+ """The final state of the instance after the run."""
4107
6306
  state: String
6307
+
6308
+ """The timestamp when the run completed."""
4108
6309
  timestamp: DateTimeISO
6310
+
6311
+ """The final set of variables after the run."""
4109
6312
  variables: Object
4110
6313
  }
4111
6314
 
6315
+ """
6316
+ Represents the complete state of a scenario instance at a point in time.
6317
+ """
4112
6318
  type ScenarioInstanceState {
6319
+ """A key-value map of data generated and used by the instance."""
4113
6320
  data: Object
6321
+
6322
+ """The domain in which the instance is running."""
4114
6323
  domain: Domain
6324
+
6325
+ """The unique name of this specific instance."""
4115
6326
  instanceName: String
6327
+
6328
+ """A message associated with the current state (e.g., an error message)."""
4116
6329
  message: String
6330
+
6331
+ """The progress of the running instance."""
4117
6332
  progress: ScenarioInstanceProgress
6333
+
6334
+ """The name of the scenario being executed."""
4118
6335
  scenarioName: String
6336
+
6337
+ """The current execution state of the instance."""
4119
6338
  state: ScenarioInstanceStatus
6339
+
6340
+ """The timestamp when this state was recorded."""
4120
6341
  timestamp: DateTimeISO
6342
+
6343
+ """A key-value map of variables used in the instance."""
4121
6344
  variables: Object
4122
6345
  }
4123
6346
 
4124
- """state enumeration of a scenario-instance"""
6347
+ """Enumeration of possible states for a scenario instance."""
4125
6348
  enum ScenarioInstanceStatus {
4126
6349
  HALTED
4127
6350
  READY
@@ -4130,27 +6353,59 @@ enum ScenarioInstanceStatus {
4130
6353
  UNLOADED
4131
6354
  }
4132
6355
 
6356
+ """A paginated list of scenarios."""
4133
6357
  type ScenarioList {
6358
+ """The list of scenario items."""
4134
6359
  items: [Scenario!]!
6360
+
6361
+ """The total number of scenarios."""
4135
6362
  total: Int!
4136
6363
  }
4137
6364
 
6365
+ """Input for updating (patching) an existing scenario."""
4138
6366
  input ScenarioPatch {
6367
+ """The new active status for the scenario."""
4139
6368
  active: Boolean
6369
+
6370
+ """
6371
+ A flag indicating whether the scenario is being created, updated, or deleted.
6372
+ """
4140
6373
  cuFlag: String
6374
+
6375
+ """The new description for the scenario."""
4141
6376
  description: String
6377
+
6378
+ """The unique identifier of the scenario to update."""
4142
6379
  id: ID
6380
+
6381
+ """The new name for the scenario."""
4143
6382
  name: String
6383
+
6384
+ """The new role for the scenario."""
4144
6385
  role: ObjectRef
6386
+
6387
+ """The new schedule for the scenario."""
4145
6388
  schedule: String
6389
+
6390
+ """A list of steps to be updated within the scenario."""
4146
6391
  steps: [StepPatch!]
6392
+
6393
+ """The new timezone for the scenario."""
4147
6394
  timezone: String
6395
+
6396
+ """The new time-to-live for scenario instances."""
4148
6397
  ttl: Float
6398
+
6399
+ """The new type for the scenario."""
4149
6400
  type: String
4150
6401
  }
4151
6402
 
6403
+ """Represents the state of a scenario queue for a specific domain."""
4152
6404
  type ScenarioQueueState {
6405
+ """The domain to which this queue state belongs."""
4153
6406
  domain: Domain!
6407
+
6408
+ """The list of pending items in the queue."""
4154
6409
  queue: [PendingObject!]!
4155
6410
  }
4156
6411
 
@@ -4257,17 +6512,18 @@ input SettingPatch {
4257
6512
  value: String
4258
6513
  }
4259
6514
 
6515
+ """Input type for specifying sorting options in a list query."""
4260
6516
  input Sorting {
4261
- """
4262
- Set to true if descending sort. Default is "false"
4263
- """
6517
+ """Set to true for descending order. Default is false (ascending)."""
4264
6518
  desc: Boolean
4265
6519
 
4266
- """Field name to sort by"""
6520
+ """The field name to sort the results by."""
4267
6521
  name: String!
4268
6522
  }
4269
6523
 
4270
- """Entity for StateRegister"""
6524
+ """
6525
+ Represents a key-value store for maintaining the state of various entities within a domain.
6526
+ """
4271
6527
  type StateRegister {
4272
6528
  """Creation time of the state register"""
4273
6529
  createdAt: DateTimeISO
@@ -4289,6 +6545,8 @@ type StateRegister {
4289
6545
 
4290
6546
  """Group name for the state register"""
4291
6547
  group: String
6548
+
6549
+ """Unique identifier for the state register."""
4292
6550
  id: ID!
4293
6551
 
4294
6552
  """Name of the state register"""
@@ -4333,6 +6591,7 @@ type StateRegister {
4333
6591
  wroteAt: DateTimeISO
4334
6592
  }
4335
6593
 
6594
+ """A paginated list of state registers."""
4336
6595
  type StateRegisterList {
4337
6596
  """List of state registers"""
4338
6597
  items: [StateRegister!]!
@@ -4341,6 +6600,7 @@ type StateRegisterList {
4341
6600
  total: Int!
4342
6601
  }
4343
6602
 
6603
+ """Input for updating (patching) an existing state register."""
4344
6604
  input StateRegisterPatch {
4345
6605
  """Flag indicating create/update operations"""
4346
6606
  cuFlag: String
@@ -4378,70 +6638,157 @@ input StateRegisterPatch {
4378
6638
  unit: String
4379
6639
  }
4380
6640
 
6641
+ """
6642
+ Represents a single step within a scenario, defining a specific task to be executed.
6643
+ """
4381
6644
  type Step {
6645
+ """The name of the connection to be used for this step."""
4382
6646
  connection: String
6647
+
6648
+ """The timestamp when the step was created."""
4383
6649
  createdAt: DateTimeISO
6650
+
6651
+ """The user who created this step."""
4384
6652
  creator: User
6653
+
6654
+ """A detailed description of what the step involves."""
4385
6655
  description: String
6656
+
6657
+ """The domain to which this step belongs."""
4386
6658
  domain: Domain
6659
+
6660
+ """The unique identifier for the step."""
4387
6661
  id: ID!
6662
+
6663
+ """Indicates if the step execution should be logged."""
4388
6664
  log: Boolean
6665
+
6666
+ """The name of the step."""
4389
6667
  name: String!
6668
+
6669
+ """A key-value map of parameters for the step task."""
4390
6670
  params: Object
4391
6671
 
4392
6672
  """
4393
- A boolean attribute indicating the inclusion status of an element in the result
6673
+ A boolean attribute indicating whether the result of this step should be included in the final output.
4394
6674
  """
4395
6675
  result: Boolean
6676
+
6677
+ """The scenario that includes this step."""
4396
6678
  scenario: Scenario
6679
+
6680
+ """The sequence number of the step within its scenario."""
4397
6681
  sequence: Float
6682
+
6683
+ """Indicates if the step should be skipped during execution."""
4398
6684
  skip: Boolean
6685
+
6686
+ """The specific task type associated with this step."""
4399
6687
  task: String
6688
+
6689
+ """The timestamp when the step was last updated."""
4400
6690
  updatedAt: DateTimeISO
6691
+
6692
+ """The user who last updated this step."""
4401
6693
  updater: User
4402
6694
  }
4403
6695
 
6696
+ """A paginated list of steps."""
4404
6697
  type StepList {
6698
+ """The list of step items."""
4405
6699
  items: [Step!]!
6700
+
6701
+ """The total number of steps."""
4406
6702
  total: Int!
4407
6703
  }
4408
6704
 
6705
+ """Input for updating (patching) an existing step."""
4409
6706
  input StepPatch {
6707
+ """The new connection for the step."""
4410
6708
  connection: String
6709
+
6710
+ """
6711
+ A flag indicating whether the step is being created, updated, or deleted.
6712
+ """
4411
6713
  cuFlag: String
6714
+
6715
+ """The new description for the step."""
4412
6716
  description: String
6717
+
6718
+ """The unique identifier of the step to update."""
4413
6719
  id: ID
6720
+
6721
+ """The new log status for the step."""
4414
6722
  log: Boolean
6723
+
6724
+ """The new name for the step."""
4415
6725
  name: String
6726
+
6727
+ """The new parameters for the step."""
4416
6728
  params: Object
6729
+
6730
+ """The new result inclusion status for the step."""
4417
6731
  result: Boolean
6732
+
6733
+ """The new sequence number for the step."""
4418
6734
  sequence: Int
6735
+
6736
+ """The new skip status for the step."""
4419
6737
  skip: Boolean
6738
+
6739
+ """The new task type for the step."""
4420
6740
  task: String
4421
6741
  }
4422
6742
 
4423
6743
  type Subscription {
6744
+ """Subscribes to real-time updates for a specific board."""
4424
6745
  board(id: String!): Board!
6746
+
6747
+ """Subscribes to log messages from connections."""
4425
6748
  connectionLog(level: String): Log!
6749
+
6750
+ """Subscribes to the state changes of connections."""
4426
6751
  connectionState(name: String): ConnectionState!
4427
6752
  data(tag: String!): Data!
4428
6753
  notification(subjects: [String!]): Notification!
6754
+
6755
+ """Subscribes to real-time updates for a specific play group."""
4429
6756
  playGroup(id: String!): PlayGroup!
6757
+
6758
+ """Subscribes to log messages from scenario instances."""
4430
6759
  scenarioInstanceLog(instanceName: String, level: String, scenarioName: String): Log!
6760
+
6761
+ """Subscribes to state changes from scenario instances."""
4431
6762
  scenarioInstanceState(instanceName: String, scenarioName: String): ScenarioInstanceState!
6763
+
6764
+ """Subscribes to changes in the scenario queue."""
4432
6765
  scenarioQueueState: ScenarioQueueState!
4433
6766
  }
4434
6767
 
6768
+ """Describes a type of task that can be used in a scenario."""
4435
6769
  type TaskType {
6770
+ """Indicates whether this task type can be used without a connector."""
4436
6771
  connectorFree: Boolean
6772
+
6773
+ """A brief description of what the task does."""
4437
6774
  description: String
6775
+
6776
+ """A URL or text providing more detailed help information."""
4438
6777
  help: String
6778
+
6779
+ """The unique name of the task type."""
4439
6780
  name: String!
6781
+
6782
+ """A list of parameters that can be configured for this task type."""
4440
6783
  parameterSpec: [PropertySpec!]
4441
6784
  }
4442
6785
 
6786
+ """A paginated list of task types."""
4443
6787
  type TaskTypeList {
6788
+ """The list of task type items."""
4444
6789
  items: [TaskType!]!
6790
+
6791
+ """The total number of task types."""
4445
6792
  total: Int!
4446
6793
  }
4447
6794
 
@@ -4475,34 +6822,79 @@ input TerminologyPatch {
4475
6822
  name: String
4476
6823
  }
4477
6824
 
4478
- """Entity for Theme"""
6825
+ """
6826
+ Represents a visual theme or style that can be applied to dashboard components.
6827
+ """
4479
6828
  type Theme {
6829
+ """Indicates whether the theme is currently active and available for use."""
4480
6830
  active: Boolean
6831
+
6832
+ """The timestamp when the theme was created."""
4481
6833
  createdAt: DateTimeISO
6834
+
6835
+ """The user who created the theme."""
4482
6836
  creator: User
6837
+
6838
+ """The timestamp when the theme was soft-deleted."""
4483
6839
  deletedAt: DateTimeISO
6840
+
6841
+ """A detailed description of the theme."""
4484
6842
  description: String
6843
+
6844
+ """The domain to which this theme belongs."""
4485
6845
  domain: Domain!
6846
+
6847
+ """Unique identifier for the theme."""
4486
6848
  id: ID!
6849
+
6850
+ """The name of the theme."""
4487
6851
  name: String
6852
+
6853
+ """The type of the theme (e.g., Legend)."""
4488
6854
  type: String
6855
+
6856
+ """The timestamp when the theme was last updated."""
4489
6857
  updatedAt: DateTimeISO
6858
+
6859
+ """The user who last updated the theme."""
4490
6860
  updater: User
6861
+
6862
+ """A JSON object containing the theme-specific style values."""
4491
6863
  value: Object
4492
6864
  }
4493
6865
 
6866
+ """A paginated list of themes."""
4494
6867
  type ThemeList {
6868
+ """The list of theme items."""
4495
6869
  items: [Theme!]!
6870
+
6871
+ """The total number of themes."""
4496
6872
  total: Int!
4497
6873
  }
4498
6874
 
6875
+ """Input for updating (patching) an existing theme."""
4499
6876
  input ThemePatch {
6877
+ """The new active status for the theme."""
4500
6878
  active: Boolean
6879
+
6880
+ """
6881
+ A flag indicating whether the theme is being created, updated, or deleted.
6882
+ """
4501
6883
  cuFlag: String
6884
+
6885
+ """The new description for the theme."""
4502
6886
  description: String
6887
+
6888
+ """The unique identifier of the theme to update."""
4503
6889
  id: ID
6890
+
6891
+ """The new name for the theme."""
4504
6892
  name: String
6893
+
6894
+ """The new type for the theme."""
4505
6895
  type: String
6896
+
6897
+ """The new JSON object of style values for the theme."""
4506
6898
  value: Object
4507
6899
  }
4508
6900
 
@@ -4514,42 +6906,106 @@ type UploadURL {
4514
6906
  url: String!
4515
6907
  }
4516
6908
 
6909
+ """
6910
+ Represents a user account in the system, including authentication, roles, and domain associations.
6911
+ """
4517
6912
  type User {
6913
+ """Timestamp when the user account was created."""
4518
6914
  createdAt: DateTimeISO
6915
+
6916
+ """User who created this user account."""
4519
6917
  creator: User
6918
+
6919
+ """Optional description or note about the user."""
4520
6920
  description: String
6921
+
6922
+ """Domains (organizations, companies, etc.) the user belongs to."""
4521
6923
  domains: [Domain!]!
6924
+
6925
+ """Email address of the user."""
4522
6926
  email: EmailAddress!
6927
+
6928
+ """Unique identifier for the user."""
4523
6929
  id: ID!
6930
+
6931
+ """Locale or language preference for the user."""
4524
6932
  locale: String
6933
+
6934
+ """Full name of the user."""
4525
6935
  name: String
6936
+
6937
+ """Whether the user is the owner of the domain (not persisted in DB)."""
4526
6938
  owner: Boolean
6939
+
6940
+ """Reference information for the user (external system, etc.)."""
4527
6941
  reference: String
6942
+
6943
+ """Roles assigned to the user."""
4528
6944
  roles: [Role!]!
6945
+
6946
+ """Single sign-on (SSO) identifier for federated authentication."""
4529
6947
  ssoId: String
6948
+
6949
+ """Current status of the user account."""
4530
6950
  status: String!
6951
+
6952
+ """Timestamp when the user account was last updated."""
4531
6953
  updatedAt: DateTimeISO
6954
+
6955
+ """User who last updated this user account."""
4532
6956
  updater: User
6957
+
6958
+ """Type or category of the user (e.g., user, application, appliance)."""
4533
6959
  userType: String
6960
+
6961
+ """Unique username for the user."""
4534
6962
  username: String
6963
+
6964
+ """External authentication providers linked to the user."""
4535
6965
  usersAuthProviders: [UsersAuthProviders!]
4536
6966
  }
4537
6967
 
6968
+ """A paginated list of users and the total count."""
4538
6969
  type UserList {
6970
+ """List of user objects."""
4539
6971
  items: [User!]
6972
+
6973
+ """Total number of users matching the query."""
4540
6974
  total: Int
4541
6975
  }
4542
6976
 
6977
+ """Input type for updating (patching) an existing user account."""
4543
6978
  input UserPatch {
6979
+ """
6980
+ Change flag for tracking updates (e.g., C/U/D for create/update/delete).
6981
+ """
4544
6982
  cuFlag: String
6983
+
6984
+ """Optional description or note about the user."""
4545
6985
  description: String
6986
+
6987
+ """Domains associated with the user."""
4546
6988
  domains: [ObjectRef!]
6989
+
6990
+ """Email address of the user."""
4547
6991
  email: EmailAddress
6992
+
6993
+ """Unique identifier of the user to update."""
4548
6994
  id: ID
6995
+
6996
+ """Full name of the user."""
4549
6997
  name: String
6998
+
6999
+ """Password for the user account."""
4550
7000
  password: String
7001
+
7002
+ """Roles assigned to the user."""
4551
7003
  roles: [ObjectRef!]
7004
+
7005
+ """Status of the user account (e.g., active, inactive)."""
4552
7006
  status: String
7007
+
7008
+ """Type or category of the user (e.g., admin, operator, guest)."""
4553
7009
  userType: String
4554
7010
  }
4555
7011
 
@@ -4579,21 +7035,46 @@ input UserPreferencePatch {
4579
7035
  user: ObjectRef!
4580
7036
  }
4581
7037
 
7038
+ """Represents a role and whether it is assigned to a specific user."""
4582
7039
  type UserRole {
7040
+ """Indicates whether the role is assigned to the user."""
4583
7041
  assigned: Boolean
7042
+
7043
+ """A description of the role."""
4584
7044
  description: String
7045
+
7046
+ """The unique identifier of the role."""
4585
7047
  id: String
7048
+
7049
+ """The name of the role."""
4586
7050
  name: String
4587
7051
  }
4588
7052
 
4589
- """Entity for UsersAuthProviders"""
7053
+ """
7054
+ Represents the link between a user and an external authentication provider.
7055
+ """
4590
7056
  type UsersAuthProviders {
7057
+ """The authentication provider associated with this link."""
4591
7058
  authProvider: AuthProvider
7059
+
7060
+ """The timestamp when this link was created."""
4592
7061
  createdAt: DateTimeISO
7062
+
7063
+ """The domain to which this link belongs."""
4593
7064
  domain: Domain!
7065
+
7066
+ """Unique identifier for the user-provider link."""
4594
7067
  id: ID!
7068
+
7069
+ """
7070
+ The unique identifier for the user from the external provider (SSO ID).
7071
+ """
4595
7072
  ssoId: String
7073
+
7074
+ """The timestamp when this link was last updated."""
4596
7075
  updatedAt: DateTimeISO
7076
+
7077
+ """The user associated with this link."""
4597
7078
  user: User
4598
7079
  }
4599
7080