@things-factory/operato-ecs 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,147 +463,376 @@ 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
838
  type BoardSetting {
@@ -416,35 +842,78 @@ type BoardSetting {
416
842
  value: String!
417
843
  }
418
844
 
419
- """Entity for BoardTemplate"""
845
+ """A reusable template for creating new boards."""
420
846
  type BoardTemplate {
847
+ """The timestamp when the template was created."""
421
848
  createdAt: DateTimeISO
849
+
850
+ """The user who created the template."""
422
851
  creator: User
852
+
853
+ """A detailed description of the board template."""
423
854
  description: String
855
+
856
+ """The domain to which this template belongs."""
424
857
  domain: Domain!
858
+
859
+ """Unique identifier for the board template."""
425
860
  id: ID!
426
861
  mine: Boolean!
862
+
863
+ """The JSON model that defines the layout and components of the template."""
427
864
  model: String
865
+
866
+ """The name of the board template."""
428
867
  name: String
429
- tags: Object
868
+
869
+ """A list of tags for categorizing the template."""
870
+ tags: [String!]
871
+
872
+ """A base64 encoded thumbnail image of the template."""
430
873
  thumbnail: String
874
+
875
+ """The timestamp when the template was last updated."""
431
876
  updatedAt: DateTimeISO
877
+
878
+ """The user who last updated the template."""
432
879
  updater: User
880
+
881
+ """The visibility of the template: 'private', 'public', or 'domain'."""
433
882
  visibility: String
434
883
  }
435
884
 
885
+ """A paginated list of board templates."""
436
886
  type BoardTemplateList {
887
+ """The list of board template items."""
437
888
  items: [BoardTemplate!]!
889
+
890
+ """The total number of board templates."""
438
891
  total: Int!
439
892
  }
440
893
 
894
+ """Input for updating (patching) an existing board template."""
441
895
  input BoardTemplatePatch {
896
+ """
897
+ A flag indicating whether the template is being created, updated, or deleted.
898
+ """
442
899
  cuFlag: String
900
+
901
+ """The new description for the board template."""
443
902
  description: String
903
+
904
+ """The unique identifier of the board template to update."""
444
905
  id: ID
906
+
907
+ """The new JSON model for the board template."""
445
908
  model: String
909
+
910
+ """The new name for the board template."""
446
911
  name: String
912
+
913
+ """The new base64 encoded thumbnail image for the board template."""
447
914
  thumbnail: String
915
+
916
+ """The new visibility for the board template: 'private' or 'public'."""
448
917
  visibility: String
449
918
  }
450
919
 
@@ -522,61 +991,147 @@ input CommonCodePatch {
522
991
  name: String
523
992
  }
524
993
 
994
+ """Represents a configured connection to an external system or service."""
525
995
  type Connection {
996
+ """
997
+ Indicates whether the connection is currently active and should be maintained.
998
+ """
526
999
  active: Boolean
1000
+
1001
+ """The timestamp when the connection was created."""
527
1002
  createdAt: DateTimeISO
1003
+
1004
+ """The user who created the connection."""
528
1005
  creator: User
1006
+
1007
+ """A detailed description of the connection."""
529
1008
  description: String
1009
+
1010
+ """The domain to which this connection belongs."""
530
1011
  domain: Domain
1012
+
1013
+ """The edge appliance that delegates this connection, if any."""
531
1014
  edge: Appliance
1015
+
1016
+ """The endpoint URL or address for the connection."""
532
1017
  endpoint: String
1018
+
1019
+ """Unique identifier for the connection."""
533
1020
  id: ID!
1021
+
1022
+ """The name of the connection."""
534
1023
  name: String!
1024
+
1025
+ """A key-value map of parameters for the connection."""
535
1026
  params: Object
1027
+
1028
+ """The current status of the connection (e.g., CONNECTED, DISCONNECTED)."""
536
1029
  state: String
1030
+
1031
+ """The type of the connection (e.g., tcp, http, mqtt)."""
537
1032
  type: String
1033
+
1034
+ """The timestamp when the connection was last updated."""
538
1035
  updatedAt: DateTimeISO
1036
+
1037
+ """The user who last updated the connection."""
539
1038
  updater: User
540
1039
  }
541
1040
 
1041
+ """A paginated list of connections."""
542
1042
  type ConnectionList {
1043
+ """The list of connection items."""
543
1044
  items: [Connection!]!
1045
+
1046
+ """The total number of connections."""
544
1047
  total: Int!
545
1048
  }
546
1049
 
1050
+ """Input for updating (patching) an existing connection."""
547
1051
  input ConnectionPatch {
1052
+ """The new active status for the connection."""
548
1053
  active: Boolean
1054
+
1055
+ """
1056
+ A flag indicating whether the connection is being created, updated, or deleted.
1057
+ """
549
1058
  cuFlag: String
1059
+
1060
+ """The new description for the connection."""
550
1061
  description: String
1062
+
1063
+ """The new edge appliance for the connection."""
551
1064
  edge: ObjectRef
1065
+
1066
+ """The new endpoint for the connection."""
552
1067
  endpoint: String
1068
+
1069
+ """The unique identifier of the connection to update."""
553
1070
  id: ID
1071
+
1072
+ """The new name for the connection."""
554
1073
  name: String
1074
+
1075
+ """The new parameters for the connection."""
555
1076
  params: Object
1077
+
1078
+ """The new type for the connection."""
556
1079
  type: String
557
1080
  }
558
1081
 
1082
+ """Represents the state of a connection at a point in time."""
559
1083
  type ConnectionState {
1084
+ """The description of the connection."""
560
1085
  description: String
1086
+
1087
+ """The domain of the connection."""
561
1088
  domain: Domain!
1089
+
1090
+ """The edge appliance associated with the connection."""
562
1091
  edge: Appliance
1092
+
1093
+ """The unique identifier of the connection."""
563
1094
  id: String
1095
+
1096
+ """The name of the connection."""
564
1097
  name: String
1098
+
1099
+ """The current status of the connection."""
565
1100
  state: String
1101
+
1102
+ """The timestamp when this state was recorded."""
566
1103
  timestamp: DateTimeISO
1104
+
1105
+ """The type of the connection."""
567
1106
  type: String
568
1107
  }
569
1108
 
1109
+ """A paginated list of connector types."""
570
1110
  type ConnectorList {
1111
+ """The list of connector type items."""
571
1112
  items: [ConnectorType!]!
1113
+
1114
+ """The total number of connector types."""
572
1115
  total: Int!
573
1116
  }
574
1117
 
1118
+ """
1119
+ Describes a type of connector, which handles communication for a specific protocol.
1120
+ """
575
1121
  type ConnectorType {
1122
+ """A brief description of the connector."""
576
1123
  description: String
1124
+
1125
+ """A URL or text providing more detailed help information."""
577
1126
  help: String
1127
+
1128
+ """The unique name of the connector type."""
578
1129
  name: String!
1130
+
1131
+ """A list of parameters required to configure this connector type."""
579
1132
  parameterSpec: [PropertySpec!]
1133
+
1134
+ """A list of task prefixes that this connector can handle."""
580
1135
  taskPrefixes: [String!]
581
1136
  }
582
1137
 
@@ -631,18 +1186,25 @@ input ContactPatch {
631
1186
  profile: ProfileInput
632
1187
  }
633
1188
 
1189
+ """
1190
+ Represents a data payload delivered via subscription, including its domain, tag, and content.
1191
+ """
634
1192
  type Data {
635
- """Data delivered by subscription"""
1193
+ """The actual data content delivered by the subscription."""
636
1194
  data: Object
637
1195
 
638
- """The domain where the data originated"""
1196
+ """The domain where the data originated."""
639
1197
  domain: Domain
640
1198
 
641
- """Tag name attached to data"""
1199
+ """
1200
+ The tag name attached to the data, used for filtering and identification.
1201
+ """
642
1202
  tag: String!
643
1203
  }
644
1204
 
645
- """Date custom scalar type"""
1205
+ """
1206
+ 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.
1207
+ """
646
1208
  scalar Date
647
1209
 
648
1210
  """
@@ -653,7 +1215,19 @@ scalar DateTimeISO
653
1215
  """Entity for Department"""
654
1216
  type Department {
655
1217
  active: Boolean
656
- children(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): [Department!]!
1218
+ children(
1219
+ """An array of filter conditions to apply to the list query."""
1220
+ filters: [Filter!]
1221
+
1222
+ """Inherited value type for the list query."""
1223
+ inherited: InheritedValueType
1224
+
1225
+ """Pagination options for the list query."""
1226
+ pagination: Pagination
1227
+
1228
+ """Sorting options for the list query."""
1229
+ sortings: [Sorting!]
1230
+ ): [Department!]!
657
1231
  controlNo: String!
658
1232
  createdAt: DateTimeISO
659
1233
  creator: User
@@ -689,62 +1263,149 @@ input DepartmentPatch {
689
1263
  picture: Upload
690
1264
  }
691
1265
 
1266
+ """
1267
+ Represents a domain entity, which is a logical grouping of users, roles, and resources within the system.
1268
+ """
692
1269
  type Domain {
1270
+ """Additional attributes associated with the domain."""
693
1271
  attributes: Object
1272
+
1273
+ """The brand image URL associated with the domain, if any."""
694
1274
  brandImage: String
1275
+
1276
+ """The brand name associated with the domain, if any."""
695
1277
  brandName: String
1278
+
1279
+ """The child domains, if any, under this domain."""
696
1280
  children: Domain
1281
+
1282
+ """The content image URL associated with the domain, if any."""
697
1283
  contentImage: String
1284
+
1285
+ """The date and time when the domain was created."""
698
1286
  createdAt: DateTimeISO
1287
+
1288
+ """The date and time when the domain was deleted, if applicable."""
699
1289
  deletedAt: DateTimeISO
1290
+
1291
+ """A description of the domain."""
700
1292
  description: String
1293
+
1294
+ """The external type of the domain, if applicable."""
701
1295
  extType: String
1296
+
1297
+ """The unique identifier of the domain."""
702
1298
  id: ID!
1299
+
1300
+ """A list of IPs and their associated access levels for the domain."""
703
1301
  iplist: Object
1302
+
1303
+ """The name of the domain."""
704
1304
  name: String!
1305
+
1306
+ """The owner of the domain, if applicable."""
705
1307
  owner: String
706
1308
  ownerUser: User
1309
+
1310
+ """The parent domain, if this domain is a subdomain."""
707
1311
  parent: Domain
1312
+
1313
+ """The subdomain of the domain, if applicable."""
708
1314
  subdomain: String
1315
+
1316
+ """
1317
+ A flag indicating if the domain is a system domain. Deprecated, use `parent` instead.
1318
+ """
709
1319
  systemFlag: Boolean
1320
+
1321
+ """The theme associated with the domain, if any."""
710
1322
  theme: String
1323
+
1324
+ """The timezone of the domain, if applicable."""
711
1325
  timezone: String
1326
+
1327
+ """The date and time when the domain was last updated."""
712
1328
  updatedAt: DateTimeISO
713
1329
  }
714
1330
 
1331
+ """Input for generating a new domain."""
715
1332
  input DomainGeneratorInput {
1333
+ """A description for the new domain."""
716
1334
  description: String
1335
+
1336
+ """The name of the new domain."""
717
1337
  name: String!
718
1338
  }
719
1339
 
1340
+ """
1341
+ Input type for creating a new domain entity, including name, description, and extended entity type.
1342
+ """
720
1343
  input DomainInput {
1344
+ """A description of the domain."""
721
1345
  description: String
1346
+
1347
+ """
1348
+ 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.
1349
+ """
722
1350
  extType: String
1351
+
1352
+ """The name of the domain."""
723
1353
  name: String!
724
1354
  }
725
1355
 
726
- """Entity for DomainLink representing a connection between two domains"""
1356
+ """Represents a typed relationship between two domains."""
727
1357
  type DomainLink {
1358
+ """The timestamp when the domain link was created."""
728
1359
  createdAt: DateTimeISO!
1360
+
1361
+ """The user who created the domain link."""
729
1362
  creator: User
1363
+
1364
+ """Unique identifier for the domain link."""
730
1365
  id: ID!
1366
+
1367
+ """The source domain in the relationship."""
731
1368
  sourceDomain: Domain!
1369
+
1370
+ """The target domain in the relationship."""
732
1371
  targetDomain: Domain!
1372
+
1373
+ """The type of the relationship (e.g., has, maintains, owns)."""
733
1374
  type: String!
1375
+
1376
+ """The timestamp when the domain link was last updated."""
734
1377
  updatedAt: DateTimeISO!
1378
+
1379
+ """The user who last updated the domain link."""
735
1380
  updater: User
736
1381
  }
737
1382
 
1383
+ """A paginated list of domain links."""
738
1384
  type DomainLinkList {
1385
+ """The list of domain link items."""
739
1386
  items: [DomainLink!]!
1387
+
1388
+ """The total number of domain links."""
740
1389
  total: Int!
741
1390
  }
742
1391
 
1392
+ """Input for updating (patching) an existing domain link."""
743
1393
  input DomainLinkPatch {
1394
+ """
1395
+ A flag indicating whether the link is being created, updated, or deleted.
1396
+ """
744
1397
  cuFlag: String
1398
+
1399
+ """The unique identifier of the domain link to update."""
745
1400
  id: ID!
1401
+
1402
+ """The new source domain for the relationship."""
746
1403
  sourceDomain: ObjectRef
1404
+
1405
+ """The new target domain for the relationship."""
747
1406
  targetDomain: ObjectRef
1407
+
1408
+ """The new type for the relationship."""
748
1409
  type: String
749
1410
  }
750
1411
 
@@ -753,26 +1414,64 @@ type DomainList {
753
1414
  total: Int
754
1415
  }
755
1416
 
1417
+ """Input type for updating an existing domain entity."""
756
1418
  input DomainPatch {
1419
+ """Additional attributes for the domain in key-value pairs."""
757
1420
  attributes: Object
1421
+
1422
+ """The brand image URL for the domain."""
758
1423
  brandImage: String
1424
+
1425
+ """The brand name associated with the domain."""
759
1426
  brandName: String
1427
+
1428
+ """The content image URL for the domain."""
760
1429
  contentImage: String
1430
+
1431
+ """A description of the domain."""
761
1432
  description: String
1433
+
1434
+ """
1435
+ 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.
1436
+ """
762
1437
  extType: String
1438
+
1439
+ """The unique identifier of the domain."""
763
1440
  id: String
1441
+
1442
+ """The name of the domain."""
764
1443
  name: String
1444
+
1445
+ """The unique identifier of the domain owner."""
765
1446
  owner: String
1447
+
1448
+ """A reference to the parent domain, if any."""
766
1449
  parent: ObjectRef
1450
+
1451
+ """The subdomain associated with the domain."""
767
1452
  subdomain: String
1453
+
1454
+ """A flag indicating if the domain is a system domain."""
768
1455
  systemFlag: Boolean
1456
+
1457
+ """The theme associated with the domain."""
769
1458
  theme: String
1459
+
1460
+ """The timezone setting for the domain."""
770
1461
  timezone: String
771
1462
  }
772
1463
 
1464
+ """
1465
+ Input for the domain creation wizard, including domain, users, and roles.
1466
+ """
773
1467
  input DomainUserRoleInput {
1468
+ """The details of the new domain to be created."""
774
1469
  domain: DomainInput!
1470
+
1471
+ """A list of new roles to be created within the domain."""
775
1472
  roles: [NewRole!]!
1473
+
1474
+ """A list of new users to be created within the domain."""
776
1475
  users: [NewUserByDomainWizardInput!]!
777
1476
  }
778
1477
 
@@ -1054,10 +1753,18 @@ type FavoriteList {
1054
1753
  total: Int!
1055
1754
  }
1056
1755
 
1756
+ """Input type for specifying a filter condition in a list query."""
1057
1757
  input Filter {
1758
+ """The field name to apply the filter on."""
1058
1759
  name: String!
1760
+
1761
+ """The operator to use for filtering (e.g., eq, ne, gt, lt, in, etc.)."""
1059
1762
  operator: String!
1763
+
1764
+ """Set to true if the filter applies to a relation field."""
1060
1765
  relation: Boolean
1766
+
1767
+ """The value to compare the field against."""
1061
1768
  value: Any
1062
1769
  }
1063
1770
 
@@ -1091,32 +1798,63 @@ input FontPatch {
1091
1798
  uri: String
1092
1799
  }
1093
1800
 
1801
+ """Represents a role that is granted to a specific domain."""
1094
1802
  type GrantedRole {
1803
+ """The domain to which the role is granted."""
1095
1804
  domain: Domain!
1805
+
1806
+ """Unique identifier for the granted role."""
1096
1807
  id: ID!
1808
+
1809
+ """The role being granted."""
1097
1810
  role: Role!
1098
1811
  }
1099
1812
 
1100
- """Entity for Board Management Group"""
1813
+ """A group used to organize and manage boards."""
1101
1814
  type Group {
1815
+ """The list of boards belonging to this group."""
1102
1816
  boards: [Board!]
1817
+
1818
+ """The timestamp when the group was created."""
1103
1819
  createdAt: DateTimeISO
1820
+
1821
+ """The user who created the group."""
1104
1822
  creator: User
1823
+
1824
+ """A detailed description of the group."""
1105
1825
  description: String
1826
+
1827
+ """The domain to which this group belongs."""
1106
1828
  domain: Domain
1829
+
1830
+ """Unique identifier for the group."""
1107
1831
  id: ID!
1832
+
1833
+ """The name of the group."""
1108
1834
  name: String!
1835
+
1836
+ """The timestamp when the group was last updated."""
1109
1837
  updatedAt: DateTimeISO
1838
+
1839
+ """The user who last updated the group."""
1110
1840
  updater: User
1111
1841
  }
1112
1842
 
1843
+ """A paginated list of board groups."""
1113
1844
  type GroupList {
1845
+ """The list of group items."""
1114
1846
  items: [Group!]!
1847
+
1848
+ """The total number of groups."""
1115
1849
  total: Int!
1116
1850
  }
1117
1851
 
1852
+ """Input for updating (patching) an existing board group."""
1118
1853
  input GroupPatch {
1854
+ """The new description for the group."""
1119
1855
  description: String
1856
+
1857
+ """The new name for the group."""
1120
1858
  name: String
1121
1859
  }
1122
1860
 
@@ -1130,26 +1868,55 @@ type ImageCompletionOutput {
1130
1868
  images: String
1131
1869
  }
1132
1870
 
1871
+ """
1872
+ Enumeration for inherited value types: None, Only, or Include. Used to specify how values are inherited in queries or filters.
1873
+ """
1133
1874
  enum InheritedValueType {
1134
1875
  Include
1135
1876
  None
1136
1877
  Only
1137
1878
  }
1138
1879
 
1880
+ """
1881
+ Represents an invitation for a user to join a system or a specific resource.
1882
+ """
1139
1883
  type Invitation {
1884
+ """The timestamp when the invitation was created."""
1140
1885
  createdAt: DateTimeISO
1886
+
1887
+ """The user who created the invitation."""
1141
1888
  creator: User
1889
+
1890
+ """The email address to which the invitation is sent."""
1142
1891
  email: EmailAddress!
1892
+
1893
+ """Unique identifier for the invitation."""
1143
1894
  id: ID!
1895
+
1896
+ """
1897
+ A reference to the resource the user is invited to (e.g., company ID, bizplace ID).
1898
+ """
1144
1899
  reference: String!
1900
+
1901
+ """The unique token used to accept the invitation."""
1145
1902
  token: String!
1903
+
1904
+ """The type of resource the invitation is for (e.g., company, bizplace)."""
1146
1905
  type: String!
1906
+
1907
+ """The timestamp when the invitation was last updated."""
1147
1908
  updatedAt: DateTimeISO
1909
+
1910
+ """The user who last updated the invitation."""
1148
1911
  updater: User
1149
1912
  }
1150
1913
 
1914
+ """A paginated list of invitations."""
1151
1915
  type InvitationList {
1916
+ """The list of invitation items."""
1152
1917
  items: [Invitation!]
1918
+
1919
+ """The total number of invitations."""
1153
1920
  total: Int
1154
1921
  }
1155
1922
 
@@ -1206,30 +1973,47 @@ input LiteMenuPatch {
1206
1973
  value: String
1207
1974
  }
1208
1975
 
1976
+ """
1977
+ Represents a log entry, including its source, level, message, and timestamp.
1978
+ """
1209
1979
  type Log {
1210
- """log level (error, warning, info, ..)"""
1980
+ """The severity level of the log entry (e.g., error, warning, info)."""
1211
1981
  level: String!
1212
1982
 
1213
- """log body message"""
1983
+ """The main message or content of the log entry."""
1214
1984
  message: String!
1215
1985
 
1216
- """the source of the log"""
1986
+ """The source object or context from which the log originated."""
1217
1987
  source: Object!
1218
1988
 
1219
- """timestamp the log occurred"""
1989
+ """The timestamp indicating when the log entry was created."""
1220
1990
  timestamp: String!
1221
1991
  }
1222
1992
 
1993
+ """Records user login attempts."""
1223
1994
  type LoginHistory {
1995
+ """The domain the user logged into."""
1224
1996
  accessDomain: Domain!
1997
+
1998
+ """The user who logged in."""
1225
1999
  accessUser: User!
2000
+
2001
+ """The timestamp of the login attempt."""
1226
2002
  accessedAt: DateTimeISO
2003
+
2004
+ """The IP address from which the login attempt was made."""
1227
2005
  accessorIp: String
2006
+
2007
+ """Unique identifier for the login history record."""
1228
2008
  id: ID!
1229
2009
  }
1230
2010
 
2011
+ """A paginated list of login history records."""
1231
2012
  type LoginHistoryList {
2013
+ """The list of login history items."""
1232
2014
  items: [LoginHistory!]!
2015
+
2016
+ """The total number of login history records."""
1233
2017
  total: Int!
1234
2018
  }
1235
2019
 
@@ -1591,8 +2375,13 @@ input MenuPatch {
1591
2375
  }
1592
2376
 
1593
2377
  type Mutation {
1594
- """To activate user"""
1595
- activateUser(username: String!): Boolean!
2378
+ """
2379
+ Activates a user account in the current domain. Use this mutation to enable a user who was previously inactive.
2380
+ """
2381
+ activateUser(
2382
+ """The username or email of the user to activate."""
2383
+ username: String!
2384
+ ): Boolean!
1596
2385
 
1597
2386
  """
1598
2387
  Attaches an existing contact to an employee. The contact is identified by its ID and the employee is identified by their ID.
@@ -1603,13 +2392,17 @@ type Mutation {
1603
2392
  """To clear translations cache"""
1604
2393
  clearTranslationsCache: Boolean!
1605
2394
 
1606
- """To clone a Board from existing Board"""
2395
+ """
2396
+ Clones a board from an existing one, potentially into a different domain.
2397
+ """
1607
2398
  cloneBoard(id: String!, patch: BoardPatch!, targetGroupId: String, targetSubdomain: String!): Board!
1608
2399
 
1609
- """To connect a connection"""
2400
+ """Establishes a live connection to a configured endpoint."""
1610
2401
  connectConnection(name: String!): Connection!
1611
2402
 
1612
- """To import multiple scenarios"""
2403
+ """
2404
+ Copies multiple existing scenarios within the same domain, creating new scenarios with new IDs.
2405
+ """
1613
2406
  copyScenarios(ids: [String!]!): [Scenario!]!
1614
2407
 
1615
2408
  """To create new appliance"""
@@ -1623,13 +2416,18 @@ type Mutation {
1623
2416
  createAttachment(attachment: NewAttachment!): Attachment!
1624
2417
  createAttachments(attachments: [NewAttachment!]!): [Attachment!]!
1625
2418
 
1626
- """To create new AttributeSet"""
1627
- createAttributeSet(attribute: NewAttributeSet!): AttributeSet!
2419
+ """
2420
+ Creates a new AttributeSet entity. Use this mutation to define a new set of attributes for a specific entity type.
2421
+ """
2422
+ createAttributeSet(
2423
+ """The input object containing the new AttributeSet details."""
2424
+ attribute: NewAttributeSet!
2425
+ ): AttributeSet!
1628
2426
 
1629
2427
  """To create new AuthProvider"""
1630
2428
  createAuthProvider(authProvider: NewAuthProvider!): AuthProvider!
1631
2429
 
1632
- """To create new Board"""
2430
+ """Creates a new board."""
1633
2431
  createBoard(board: NewBoard!): Board!
1634
2432
 
1635
2433
  """To create new BoardTemplate"""
@@ -1641,7 +2439,7 @@ type Mutation {
1641
2439
  """To create new CommonCodeDetail"""
1642
2440
  createCommonCodeDetail(commonCodeDetail: NewCommonCodeDetail!): CommonCodeDetail!
1643
2441
 
1644
- """To create new connection"""
2442
+ """Creates a new connection."""
1645
2443
  createConnection(connection: NewConnection!): Connection!
1646
2444
 
1647
2445
  """To create new Contact"""
@@ -1650,8 +2448,13 @@ type Mutation {
1650
2448
  """To create new Department"""
1651
2449
  createDepartment(department: NewDepartment!): Department!
1652
2450
 
1653
- """To create domain (Only superuser is granted this privilege.)"""
1654
- createDomain(domainInput: DomainPatch!): Domain!
2451
+ """
2452
+ Creates a new domain entity. Only superusers are granted this privilege. Use this mutation to register a new domain with a unique subdomain.
2453
+ """
2454
+ createDomain(
2455
+ """The input object containing the new domain details."""
2456
+ domainInput: DomainPatch!
2457
+ ): Domain!
1655
2458
 
1656
2459
  """To create new DomainLink"""
1657
2460
  createDomainLink(domainLink: NewDomainLink!): DomainLink!
@@ -1673,7 +2476,7 @@ type Mutation {
1673
2476
  """To create new Font"""
1674
2477
  createFont(font: NewFont!): Font!
1675
2478
 
1676
- """To create new Group"""
2479
+ """Creates a new board group."""
1677
2480
  createGroup(group: NewGroup!): Group
1678
2481
 
1679
2482
  """To create new LiteMenu"""
@@ -1712,10 +2515,10 @@ type Mutation {
1712
2515
  """To create new Oauth2Client"""
1713
2516
  createOauth2Client(oauth2Client: NewOauth2Client!): Oauth2Client!
1714
2517
 
1715
- """To create new PayloadLog"""
2518
+ """Creates a new payload log."""
1716
2519
  createPayloadLog(payloadLog: NewPayloadLog!): PayloadLog!
1717
2520
 
1718
- """To create new PlayGroup"""
2521
+ """Creates a new play group."""
1719
2522
  createPlayGroup(playGroup: NewPlayGroup!): PlayGroup!
1720
2523
 
1721
2524
  """To create new PrinterDevice"""
@@ -1727,23 +2530,28 @@ type Mutation {
1727
2530
  """To create new user"""
1728
2531
  createRole(role: NewRole!): User!
1729
2532
 
1730
- """To create new scenario"""
2533
+ """Creates a new scenario."""
1731
2534
  createScenario(scenario: NewScenario!): Scenario!
1732
2535
 
1733
2536
  """To create new Setting"""
1734
2537
  createSetting(setting: NewSetting!): Setting!
1735
2538
 
1736
- """To create new StateRegister"""
2539
+ """Creates a new state register."""
1737
2540
  createStateRegister(stateRegister: NewStateRegister!): StateRegister!
1738
2541
 
1739
2542
  """To create new Terminology"""
1740
2543
  createTerminology(terminology: NewTerminology!): Terminology!
1741
2544
 
1742
- """To create new Theme"""
2545
+ """Creates a new theme."""
1743
2546
  createTheme(theme: NewTheme!): Theme!
1744
2547
 
1745
- """To create new user"""
1746
- createUser(user: NewUser!): User!
2548
+ """
2549
+ Creates a new user in the system. Use this mutation to register a user with the specified credentials and domain information.
2550
+ """
2551
+ createUser(
2552
+ """The input object containing new user information."""
2553
+ user: NewUser!
2554
+ ): User!
1747
2555
 
1748
2556
  """To create new UserPreference"""
1749
2557
  createUserPreference(preference: NewUserPreference!): UserPreference!
@@ -1763,17 +2571,27 @@ type Mutation {
1763
2571
  deleteAttachment(id: String!): Boolean!
1764
2572
  deleteAttachmentsByRef(refBys: [String!]!, refType: String): Boolean!
1765
2573
 
1766
- """To delete AttributeSet"""
1767
- deleteAttributeSet(id: String!): Boolean!
2574
+ """
2575
+ Deletes an AttributeSet entity by its unique identifier. Use this mutation to permanently remove an attribute set.
2576
+ """
2577
+ deleteAttributeSet(
2578
+ """The unique identifier of the AttributeSet to delete."""
2579
+ id: String!
2580
+ ): Boolean!
1768
2581
 
1769
- """To delete multiple AttributeSets"""
1770
- deleteAttributeSets(ids: [String!]!): Boolean!
2582
+ """
2583
+ Deletes multiple AttributeSet entities by their unique identifiers. Use this mutation to remove several attribute sets at once.
2584
+ """
2585
+ deleteAttributeSets(
2586
+ """An array of unique identifiers for the AttributeSets to delete."""
2587
+ ids: [String!]!
2588
+ ): Boolean!
1771
2589
 
1772
2590
  """To delete AuthProvider"""
1773
2591
  deleteAuthProvider(id: String!): Boolean!
1774
2592
  deleteAuthProviders(ids: [String!]!): Boolean!
1775
2593
 
1776
- """To delete Board"""
2594
+ """Deletes a board."""
1777
2595
  deleteBoard(id: String!): Boolean!
1778
2596
 
1779
2597
  """To delete BoardTemplate"""
@@ -1791,10 +2609,10 @@ type Mutation {
1791
2609
  """To delete multiple CommonCodes"""
1792
2610
  deleteCommonCodes(ids: [String!]!): Boolean!
1793
2611
 
1794
- """To delete connection"""
2612
+ """Deletes a single connection by its name."""
1795
2613
  deleteConnection(name: String!): Boolean!
1796
2614
 
1797
- """To delete multiple connections"""
2615
+ """Deletes multiple connections by their names."""
1798
2616
  deleteConnections(names: [String!]!): Boolean!
1799
2617
 
1800
2618
  """To delete Contact"""
@@ -1809,8 +2627,13 @@ type Mutation {
1809
2627
  """To delete multiple Departments"""
1810
2628
  deleteDepartments(ids: [String!]!): Boolean!
1811
2629
 
1812
- """To delete domain (Only superuser is granted this privilege.)"""
1813
- deleteDomain(name: String!): Domain!
2630
+ """
2631
+ Deletes a domain entity by its name. Only superusers are granted this privilege. Use this mutation to permanently remove a domain.
2632
+ """
2633
+ deleteDomain(
2634
+ """The name of the domain to delete."""
2635
+ name: String!
2636
+ ): Domain!
1814
2637
 
1815
2638
  """To delete DomainLink"""
1816
2639
  deleteDomainLink(id: String!): Boolean!
@@ -1818,11 +2641,21 @@ type Mutation {
1818
2641
  """To delete multiple DomainLinks"""
1819
2642
  deleteDomainLinks(ids: [String!]!): Boolean!
1820
2643
 
1821
- """To delete domain user"""
1822
- deleteDomainUser(username: String!): Boolean!
2644
+ """
2645
+ Removes a user from the current domain. Use this mutation to revoke a user's access to a specific domain without deleting their account.
2646
+ """
2647
+ deleteDomainUser(
2648
+ """The username or email of the user to remove from the domain."""
2649
+ username: String!
2650
+ ): Boolean!
1823
2651
 
1824
- """To delete multiple domains (Only superuser is granted this privilege.)"""
1825
- deleteDomains(names: [String!]!): Boolean!
2652
+ """
2653
+ Deletes multiple domain entities by their names. Only superusers are granted this privilege. Use this mutation to remove several domains at once.
2654
+ """
2655
+ deleteDomains(
2656
+ """An array of domain names to delete."""
2657
+ names: [String!]!
2658
+ ): Boolean!
1826
2659
 
1827
2660
  """
1828
2661
  Deletes an employee record identified by the given ID. Also deletes any attachments associated with the employee.
@@ -1852,7 +2685,7 @@ type Mutation {
1852
2685
  """To delete Font"""
1853
2686
  deleteFont(id: String!): Boolean!
1854
2687
 
1855
- """To delete Group"""
2688
+ """Deletes a board group."""
1856
2689
  deleteGroup(id: String!): Boolean!
1857
2690
 
1858
2691
  """To delete LiteMenu"""
@@ -1933,13 +2766,13 @@ type Mutation {
1933
2766
  """To delete multiple partnerSettings"""
1934
2767
  deletePartnerSettings(ids: [String!]!): Boolean!
1935
2768
 
1936
- """To delete PayloadLog"""
2769
+ """Deletes a single payload log by its ID."""
1937
2770
  deletePayloadLog(id: String!): Boolean!
1938
2771
 
1939
- """To delete multiple payloadLogs"""
2772
+ """Deletes multiple payload logs by their IDs."""
1940
2773
  deletePayloadLogs(ids: [String!]!): Boolean!
1941
2774
 
1942
- """To delete PlayGroup"""
2775
+ """Deletes a play group."""
1943
2776
  deletePlayGroup(id: String!): Boolean!
1944
2777
 
1945
2778
  """To delete PrinterDevice"""
@@ -1957,10 +2790,10 @@ type Mutation {
1957
2790
  """To delete multiple roles"""
1958
2791
  deleteRoles(ids: [String!]!): Boolean!
1959
2792
 
1960
- """To delete scenario"""
2793
+ """Deletes a single scenario by its name."""
1961
2794
  deleteScenario(name: String!): Boolean!
1962
2795
 
1963
- """To delete multiple scenarios"""
2796
+ """Deletes multiple scenarios by their IDs."""
1964
2797
  deleteScenarios(ids: [String!]!): Boolean!
1965
2798
 
1966
2799
  """To delete Setting"""
@@ -1969,13 +2802,13 @@ type Mutation {
1969
2802
  """To delete multiple settings"""
1970
2803
  deleteSettings(names: [String!]!): Boolean!
1971
2804
 
1972
- """To delete StateRegister"""
2805
+ """Deletes a single state register by its ID."""
1973
2806
  deleteStateRegister(id: String!): Boolean!
1974
2807
 
1975
- """To delete multiple StateRegisters"""
2808
+ """Deletes multiple state registers by their IDs."""
1976
2809
  deleteStateRegisters(ids: [String!]!): Boolean!
1977
2810
 
1978
- """To delete multiple steps"""
2811
+ """Deletes multiple scenario steps by their IDs."""
1979
2812
  deleteSteps(ids: [String!]!): Boolean!
1980
2813
 
1981
2814
  """To delete multiple Terminologies"""
@@ -1984,14 +2817,19 @@ type Mutation {
1984
2817
  """To delete Terminology"""
1985
2818
  deleteTerminology(id: String!): Boolean!
1986
2819
 
1987
- """To delete Theme"""
2820
+ """Deletes a single theme by its ID."""
1988
2821
  deleteTheme(id: String!): Boolean!
1989
2822
 
1990
- """To delete multiple Themes"""
2823
+ """Deletes multiple themes by their IDs."""
1991
2824
  deleteThemes(ids: [String!]!): Boolean!
1992
2825
 
1993
- """To delete a user"""
1994
- deleteUser(username: String!): Boolean!
2826
+ """
2827
+ Deletes a user from the system by their username. Use this mutation to permanently remove a user account and revoke their access.
2828
+ """
2829
+ deleteUser(
2830
+ """The username of the user to delete."""
2831
+ username: String!
2832
+ ): Boolean!
1995
2833
 
1996
2834
  """To delete UserPreference"""
1997
2835
  deleteUserPreference(id: String!): Boolean!
@@ -1999,15 +2837,20 @@ type Mutation {
1999
2837
  """To delete multiple UserPreferences"""
2000
2838
  deleteUserPreferences(ids: [String!]!): Boolean!
2001
2839
 
2002
- """To delete some users"""
2003
- deleteUsers(usernames: [String!]!): Boolean!
2840
+ """
2841
+ Deletes multiple users from the system by their usernames. Use this mutation to remove several user accounts at once.
2842
+ """
2843
+ deleteUsers(
2844
+ """An array of usernames to delete."""
2845
+ usernames: [String!]!
2846
+ ): Boolean!
2004
2847
 
2005
2848
  """
2006
2849
  Detaches an existing contact from an employee. The employee is identified by their ID.
2007
2850
  """
2008
2851
  detachContact(id: String!): Employee!
2009
2852
 
2010
- """To disconnect a connection"""
2853
+ """Terminates a live connection."""
2011
2854
  disconnectConnection(name: String!): Connection!
2012
2855
  domainRegister(domainInput: DomainGeneratorInput!): Domain!
2013
2856
  domainUserRoleRegister(newDomainInfo: DomainUserRoleInput!): Domain!
@@ -2025,10 +2868,15 @@ type Mutation {
2025
2868
  """To import some Attachments"""
2026
2869
  importAttachments(file: Upload!): [Attachment!]!
2027
2870
 
2028
- """To import multiple AttributeSets"""
2029
- importAttributeSets(attributes: [AttributeSetPatch!]!): Boolean!
2871
+ """
2872
+ Imports multiple AttributeSet entities into the system. Use this mutation to bulk import attribute sets from external sources.
2873
+ """
2874
+ importAttributeSets(
2875
+ """An array of AttributeSetPatch objects to import."""
2876
+ attributes: [AttributeSetPatch!]!
2877
+ ): Boolean!
2030
2878
 
2031
- """To import some Boards"""
2879
+ """Imports multiple boards from JSON files."""
2032
2880
  importBoards(files: [Upload!]!, groupId: String!, overwrite: Boolean!): [Board!]!
2033
2881
 
2034
2882
  """To import multiple CommonCodeDetails"""
@@ -2037,7 +2885,9 @@ type Mutation {
2037
2885
  """To import multiple CommonCodes"""
2038
2886
  importCommonCodes(commonCodes: [CommonCodePatch!]!): Boolean!
2039
2887
 
2040
- """To import multiple connections"""
2888
+ """
2889
+ Imports multiple connections. Can overwrite existing connections if IDs or names match.
2890
+ """
2041
2891
  importConnections(connections: [ConnectionPatch!]!): Boolean!
2042
2892
 
2043
2893
  """To import multiple Contacts"""
@@ -2075,32 +2925,44 @@ type Mutation {
2075
2925
  """To import multiple Oauth2Clients"""
2076
2926
  importOauth2Clients(oauth2Clients: [Oauth2ClientPatch!]!): Boolean!
2077
2927
 
2078
- """To import multiple scenarios"""
2928
+ """
2929
+ Imports multiple scenarios, including their steps. This can overwrite existing scenarios if IDs match.
2930
+ """
2079
2931
  importScenarios(scenarios: [ScenarioPatch!]!): Boolean!
2080
2932
 
2081
- """To import multiple StateRegisters"""
2933
+ """Imports multiple state registers from a provided list."""
2082
2934
  importStateRegisters(stateRegisters: [StateRegisterPatch!]!): Boolean!
2083
2935
 
2084
2936
  """To import multiple Terminologies"""
2085
2937
  importTerminologies(terminologies: [TerminologyPatch!]!): Boolean!
2086
2938
 
2087
- """To import multiple Themes"""
2939
+ """Imports multiple themes."""
2088
2940
  importThemes(themes: [ThemePatch!]!): Boolean!
2089
2941
 
2090
- """To inactivate user"""
2091
- inactivateUser(username: String!): Boolean!
2942
+ """
2943
+ Inactivates a user account in the current domain. Use this mutation to disable a user, making them unable to log in.
2944
+ """
2945
+ inactivateUser(
2946
+ """The username or email of the user to inactivate."""
2947
+ username: String!
2948
+ ): Boolean!
2092
2949
  inviteCustomer(customerDomainName: String!): Boolean!
2093
2950
 
2094
- """To invite new user"""
2095
- inviteUser(username: String!): Boolean!
2951
+ """
2952
+ 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.
2953
+ """
2954
+ inviteUser(
2955
+ """The username or email of the user to invite."""
2956
+ username: String!
2957
+ ): Boolean!
2096
2958
 
2097
- """To make the board to join the group"""
2959
+ """Assigns one or more boards to a group."""
2098
2960
  joinGroup(boardIds: [String!]!, id: String!): Group!
2099
2961
 
2100
- """To make the board to join the play group"""
2962
+ """Adds one or more boards to a play group."""
2101
2963
  joinPlayGroup(boardIds: [String!]!, id: String!): PlayGroup!
2102
2964
 
2103
- """To make the board to leave from the play group"""
2965
+ """Removes one or more boards from a play group."""
2104
2966
  leavePlayGroup(boardIds: [String!]!, id: String!): PlayGroup!
2105
2967
  multipleUpload(files: [Upload!]!): [Attachment!]!
2106
2968
 
@@ -2131,37 +2993,42 @@ type Mutation {
2131
2993
  ): Boolean!
2132
2994
  registerSchedule(schedule: NewSchedule!): ID!
2133
2995
 
2134
- """To release a Board"""
2996
+ """Releases a board, making it public and creating a version history."""
2135
2997
  releaseBoard(id: String!): Board!
2136
2998
  renewApplicationAccessToken(id: String!, scope: String!): AccessToken!
2137
2999
 
2138
- """To modify board order of a PlayGroup"""
3000
+ """Sets the custom playback order for boards in a play group."""
2139
3001
  reorderPlayGroup(boardIds: [String!]!, id: String!): PlayGroup!
2140
3002
 
2141
- """To reset password to default"""
2142
- resetPasswordToDefault(username: String!): Boolean!
3003
+ """
3004
+ Resets a user's password to the default value. Use this mutation to restore access to a user who has forgotten their password.
3005
+ """
3006
+ resetPasswordToDefault(
3007
+ """The username or email of the user whose password to reset."""
3008
+ username: String!
3009
+ ): Boolean!
2143
3010
 
2144
- """To revert Board version"""
3011
+ """Reverts a board to a specific historical version."""
2145
3012
  revertBoardVersion(id: String!, version: Float!): Board!
2146
3013
 
2147
3014
  """
2148
- To run new scenario instance and will return the result after the scenario stop.
3015
+ Runs a new scenario instance once and returns the result after it finishes.
2149
3016
  """
2150
3017
  runScenario(instanceName: String, scenarioName: String!, variables: Object): ScenarioInstanceRunResult!
2151
3018
  sendInvitation(email: EmailAddress!, reference: String!, type: String!): Invitation!
2152
3019
  singleUpload(file: Upload!): Attachment!
2153
3020
 
2154
- """To start new scenario instance"""
3021
+ """Starts a new scenario instance, which will run in the background."""
2155
3022
  startScenario(instanceName: String, scenarioName: String!, variables: Object): ScenarioInstance!
2156
3023
 
2157
- """To start posting scenario based on the schedule of the given scenario"""
3024
+ """Starts the schedule for a specific scenario, if one is defined."""
2158
3025
  startScenarioSchedule(scenarioId: String!): Scenario!
2159
3026
 
2160
- """To start new scenario instance"""
3027
+ """Stops a running scenario instance by its name."""
2161
3028
  stopScenario(instanceName: String): ScenarioInstance
2162
3029
 
2163
- """To stop posting scenario based on the schedule of the given scenario"""
2164
- stopScenarioSchedule(scenarioId: String!): Scenario
3030
+ """Stops the schedule for a specific scenario."""
3031
+ stopScenarioSchedule(scenarioId: String!): Scenario!
2165
3032
 
2166
3033
  """To synchronize auth-providers users"""
2167
3034
  synchronizeAuthProviderUsers(id: String!): Boolean!
@@ -2172,8 +3039,13 @@ type Mutation {
2172
3039
  synchronizePrivilegeMaster(privilege: NewPrivilege!): Boolean!
2173
3040
  terminateContract(partnerName: String!): Boolean!
2174
3041
 
2175
- """To transfer owner of domain"""
2176
- transferOwner(username: String!): Boolean!
3042
+ """
3043
+ Transfers domain ownership to another user. Use this mutation to assign the owner role to a different user within the domain.
3044
+ """
3045
+ transferOwner(
3046
+ """The username or email of the user to transfer ownership to."""
3047
+ username: String!
3048
+ ): Boolean!
2177
3049
  unregisterSchedule(handle: ID!): Boolean!
2178
3050
  updateAppliance(id: String!, patch: AppliancePatch!): Appliance!
2179
3051
  updateApplication(id: String!, patch: ApplicationPatch!): Application!
@@ -2182,13 +3054,23 @@ type Mutation {
2182
3054
  updateApprovalLine(id: String!, patch: ApprovalLinePatch!): ApprovalLine!
2183
3055
  updateAttachment(id: String!, patch: AttachmentPatch!): Attachment!
2184
3056
 
2185
- """To modify AttributeSet information"""
2186
- updateAttributeSet(id: String!, patch: AttributeSetPatch!): AttributeSet!
3057
+ """
3058
+ Updates an existing AttributeSet entity. Use this mutation to modify the properties or items of an AttributeSet.
3059
+ """
3060
+ updateAttributeSet(
3061
+ """The unique identifier of the AttributeSet to update."""
3062
+ id: String!
3063
+
3064
+ """The patch object containing updated fields for the AttributeSet."""
3065
+ patch: AttributeSetPatch!
3066
+ ): AttributeSet!
2187
3067
 
2188
3068
  """To modify AuthProvider information"""
2189
3069
  updateAuthProvider(id: String!, patch: AuthProviderPatch!): AuthProvider!
2190
3070
 
2191
- """To modify Board information"""
3071
+ """
3072
+ Updates a board. If a model is provided, it also generates a new thumbnail.
3073
+ """
2192
3074
  updateBoard(id: String!, patch: BoardPatch!): Board!
2193
3075
 
2194
3076
  """To modify BoardTemplate information"""
@@ -2200,7 +3082,7 @@ type Mutation {
2200
3082
  """To modify CommonCodeDetail information"""
2201
3083
  updateCommonCodeDetail(id: String!, patch: CommonCodeDetailPatch!): CommonCodeDetail!
2202
3084
 
2203
- """To modify connection information"""
3085
+ """Updates an existing connection."""
2204
3086
  updateConnection(name: String!, patch: ConnectionPatch!): Connection!
2205
3087
 
2206
3088
  """To modify Contact information"""
@@ -2232,7 +3114,7 @@ type Mutation {
2232
3114
  """To modify Font information"""
2233
3115
  updateFont(id: String!, patch: FontPatch!): Font!
2234
3116
 
2235
- """To modify Group information"""
3117
+ """Updates an existing board group."""
2236
3118
  updateGroup(id: String!, patch: GroupPatch!): Group!
2237
3119
 
2238
3120
  """To modify LiteMenu information"""
@@ -2259,8 +3141,13 @@ type Mutation {
2259
3141
  """To modify multiple ApprovalLines' information"""
2260
3142
  updateMultipleApprovalLine(patches: [ApprovalLinePatch!]!): [ApprovalLine!]!
2261
3143
 
2262
- """To modify multiple AttributeSets' information"""
2263
- updateMultipleAttributeSet(patches: [AttributeSetPatch!]!): [AttributeSet!]!
3144
+ """
3145
+ Updates or creates multiple AttributeSet entities in a single operation. Use this mutation for batch processing of attribute sets.
3146
+ """
3147
+ updateMultipleAttributeSet(
3148
+ """An array of patch objects for batch update or creation."""
3149
+ patches: [AttributeSetPatch!]!
3150
+ ): [AttributeSet!]!
2264
3151
  updateMultipleAuthProvider(patches: [AuthProviderPatch!]!): [AuthProvider!]!
2265
3152
 
2266
3153
  """To modify multiple CommonCodes' information"""
@@ -2269,7 +3156,7 @@ type Mutation {
2269
3156
  """To modify multiple CommonCodeDetails' information"""
2270
3157
  updateMultipleCommonCodeDetail(patches: [CommonCodeDetailPatch!]!): [CommonCodeDetail!]!
2271
3158
 
2272
- """To modify multiple connections' information"""
3159
+ """Updates multiple connections at once."""
2273
3160
  updateMultipleConnection(patches: [ConnectionPatch!]!): [Connection!]!
2274
3161
 
2275
3162
  """To modify multiple Contacts' information"""
@@ -2307,32 +3194,43 @@ type Mutation {
2307
3194
  """To modify multiple PartnerSettings' information"""
2308
3195
  updateMultiplePartnerSetting(patches: [PartnerSettingPatch!]!): [PartnerSetting!]!
2309
3196
 
2310
- """To modify multiple PayloadLogs' information"""
3197
+ """Updates multiple payload logs at once."""
2311
3198
  updateMultiplePayloadLog(patches: [PayloadLogPatch!]!): [PayloadLog!]!
2312
3199
 
2313
3200
  """To modify multiple PrinterDevices' information"""
2314
3201
  updateMultiplePrinterDevice(patches: [PrinterDevicePatch!]!): [PrinterDevice!]!
2315
3202
 
2316
- """To modify multiple scenarios' information"""
3203
+ """
3204
+ Updates multiple scenarios at once. Can be used to create or update records.
3205
+ """
2317
3206
  updateMultipleScenario(patches: [ScenarioPatch!]!): [Scenario!]!
2318
3207
 
2319
3208
  """To modify multiple Settings' information"""
2320
3209
  updateMultipleSetting(patches: [SettingPatch!]!): [Setting!]!
2321
3210
 
2322
- """To modify multiple StateRegisters' information"""
3211
+ """Updates multiple state registers at once."""
2323
3212
  updateMultipleStateRegister(patches: [StateRegisterPatch!]!): [StateRegister!]!
2324
3213
 
2325
- """To modify multiple steps' in a scenario"""
3214
+ """
3215
+ Updates multiple steps within a specific scenario. This operation replaces all existing steps for the scenario.
3216
+ """
2326
3217
  updateMultipleStep(patches: [StepPatch!]!, scenarioId: String!): [Step!]!
2327
3218
 
2328
3219
  """To modify multiple Terminologies' information"""
2329
3220
  updateMultipleTerminologies(patches: [TerminologyPatch!]!): [Terminology!]!
2330
3221
 
2331
- """To modify multiple Themes' information"""
3222
+ """
3223
+ Updates multiple themes at once. Can create or update themes based on the cuFlag.
3224
+ """
2332
3225
  updateMultipleTheme(patches: [ThemePatch!]!): [Theme!]!
2333
3226
 
2334
- """To modify multiple users information"""
2335
- updateMultipleUser(patches: [UserPatch!]!): [User!]!
3227
+ """
3228
+ Updates or creates multiple users in a single operation. Use this mutation for batch processing of user records.
3229
+ """
3230
+ updateMultipleUser(
3231
+ """An array of patch objects for batch update or creation."""
3232
+ patches: [UserPatch!]!
3233
+ ): [User!]!
2336
3234
 
2337
3235
  """To modify ApprovalLine information for current user"""
2338
3236
  updateMyApprovalLine(id: String!, patch: ApprovalLinePatch!): ApprovalLine!
@@ -2352,10 +3250,10 @@ type Mutation {
2352
3250
  """To modify Oauth2Client information"""
2353
3251
  updateOauth2Client(id: String!, patch: Oauth2ClientPatch!): Oauth2Client!
2354
3252
 
2355
- """To modify PayloadLog information"""
3253
+ """Updates an existing payload log."""
2356
3254
  updatePayloadLog(id: String!, patch: PayloadLogPatch!): PayloadLog!
2357
3255
 
2358
- """To modify PlayGroup information"""
3256
+ """Updates an existing play group."""
2359
3257
  updatePlayGroup(id: String!, patch: PlayGroupPatch!): PlayGroup!
2360
3258
 
2361
3259
  """To modify PrinterDevice information"""
@@ -2373,7 +3271,7 @@ type Mutation {
2373
3271
  """To update role Menu"""
2374
3272
  updateRoleMenus(isCheckedAll: Boolean!, parentMenuId: String!, roleId: String!): [Menu!]!
2375
3273
 
2376
- """To modify scenario information"""
3274
+ """Updates an existing scenario."""
2377
3275
  updateScenario(name: String!, patch: ScenarioPatch!): Scenario!
2378
3276
  updateSchedule(schedule: SchedulePatch!): ID!
2379
3277
 
@@ -2383,45 +3281,94 @@ type Mutation {
2383
3281
  """To modify Setting information"""
2384
3282
  updateSetting(name: String!, patch: SettingPatch!): Setting!
2385
3283
 
2386
- """To modify StateRegister information"""
3284
+ """Updates an existing state register."""
2387
3285
  updateStateRegister(id: String!, patch: StateRegisterPatch!): StateRegister!
2388
3286
 
2389
- """To update state of StateRegister by name"""
3287
+ """
3288
+ Updates the state of a specific state register, identified by its name.
3289
+ """
2390
3290
  updateStateRegisterByName(name: String!, state: Object!): StateRegister!
2391
3291
 
2392
3292
  """To modify Terminology information"""
2393
3293
  updateTerminology(id: String!, patch: TerminologyPatch!): Terminology!
2394
3294
 
2395
- """To modify Theme information"""
3295
+ """Updates an existing theme."""
2396
3296
  updateTheme(id: String!, patch: ThemePatch!): Theme!
2397
3297
 
2398
- """To modify user information"""
2399
- updateUser(email: EmailAddress!, patch: UserPatch!): User!
3298
+ """
3299
+ Updates the information of an existing user. Use this mutation to modify user profile details, such as name, email, or roles.
3300
+ """
3301
+ updateUser(
3302
+ """The email address of the user to update."""
3303
+ email: EmailAddress!
3304
+
3305
+ """The patch object containing updated user fields."""
3306
+ patch: UserPatch!
3307
+ ): User!
2400
3308
 
2401
3309
  """To modify UserPreference information"""
2402
3310
  updateUserPreference(id: String!, patch: UserPreferencePatch!): UserPreference!
2403
3311
 
2404
- """To update roles for a user"""
2405
- updateUserRoles(availableRoles: [ObjectRef!]!, selectedRoles: [ObjectRef!]!, username: String!): User!
3312
+ """
3313
+ Updates the roles assigned to a user. Use this mutation to change a user's permissions within the domain.
3314
+ """
3315
+ updateUserRoles(
3316
+ """The list of roles that can be assigned to the user."""
3317
+ availableRoles: [ObjectRef!]!
3318
+
3319
+ """The list of roles to be assigned to the user."""
3320
+ selectedRoles: [ObjectRef!]!
3321
+
3322
+ """The username or email of the user whose roles to update."""
3323
+ username: String!
3324
+ ): User!
2406
3325
  }
2407
3326
 
3327
+ """Input for creating a new appliance."""
2408
3328
  input NewAppliance {
3329
+ """The brand of the new appliance."""
2409
3330
  brand: String!
3331
+
3332
+ """A description for the new appliance."""
2410
3333
  description: String
3334
+
3335
+ """The model of the new appliance."""
2411
3336
  model: String!
3337
+
3338
+ """The name of the new appliance."""
2412
3339
  name: String!
3340
+
3341
+ """The network mask for the new appliance."""
2413
3342
  netmask: String
3343
+
3344
+ """The serial number of the new appliance."""
2414
3345
  serialNo: String!
2415
3346
  }
2416
3347
 
3348
+ """Input for creating a new application."""
2417
3349
  input NewApplication {
3350
+ """A description for the new application."""
2418
3351
  description: String
3352
+
3353
+ """The contact email for the new application."""
2419
3354
  email: EmailAddress
3355
+
3356
+ """A URL to the icon for the new application."""
2420
3357
  icon: String
3358
+
3359
+ """The name of the new application."""
2421
3360
  name: String!
3361
+
3362
+ """The redirect URL for the new application."""
2422
3363
  redirectUrl: String
3364
+
3365
+ """The type of the new application."""
2423
3366
  type: ApplicationType
3367
+
3368
+ """The URL of the new application."""
2424
3369
  url: String
3370
+
3371
+ """The webhook URL for the new application."""
2425
3372
  webhook: String
2426
3373
  }
2427
3374
 
@@ -2442,36 +3389,83 @@ input NewAttachment {
2442
3389
  tags: Object
2443
3390
  }
2444
3391
 
3392
+ """
3393
+ Input type for creating a new AttributeSet entity, including entity name, description, and items.
3394
+ """
2445
3395
  input NewAttributeSet {
3396
+ """Whether this AttributeSet is active."""
2446
3397
  active: Boolean
3398
+
3399
+ """A description of the AttributeSet."""
2447
3400
  description: String
3401
+
3402
+ """The name of the entity this AttributeSet is associated with."""
2448
3403
  entity: String!
3404
+
3405
+ """A list of items (attributes) included in this AttributeSet."""
2449
3406
  items: [AttributeSetItemPatch!]
2450
3407
  }
2451
3408
 
3409
+ """Input for creating a new authentication provider instance."""
2452
3410
  input NewAuthProvider {
3411
+ """Whether the new provider instance should be active."""
2453
3412
  active: Boolean
3413
+
3414
+ """Client ID for OAuth/OIDC providers."""
2454
3415
  clientId: String
3416
+
3417
+ """Client secret for OAuth/OIDC providers."""
2455
3418
  clientSecret: String
3419
+
3420
+ """Provider-specific parameters."""
2456
3421
  params: Object
3422
+
3423
+ """Private key, for certain types of providers."""
2457
3424
  privateKey: String
3425
+
3426
+ """Tenant ID, for multi-tenant providers."""
2458
3427
  tenantId: String
3428
+
3429
+ """The type of the authentication provider (e.g., keycloak, google)."""
2459
3430
  type: String!
2460
3431
  }
2461
3432
 
3433
+ """Input for creating a new board."""
2462
3434
  input NewBoard {
3435
+ """A detailed description for the new board."""
2463
3436
  description: String
3437
+
3438
+ """The ID of the group to associate the new board with."""
2464
3439
  groupId: String
3440
+
3441
+ """The JSON model for the new board."""
2465
3442
  model: String!
3443
+
3444
+ """The name of the new board."""
2466
3445
  name: String!
3446
+
3447
+ """A base64 encoded thumbnail image for the new board."""
2467
3448
  thumbnail: String
3449
+
3450
+ """The type for the new board, can be 'main', 'sub', or 'popup'."""
3451
+ type: String
2468
3452
  }
2469
3453
 
3454
+ """Input for creating a new board template."""
2470
3455
  input NewBoardTemplate {
3456
+ """A detailed description for the new board template."""
2471
3457
  description: String!
3458
+
3459
+ """The JSON model for the new board template."""
2472
3460
  model: String!
3461
+
3462
+ """The name of the new board template."""
2473
3463
  name: String!
3464
+
3465
+ """A base64 encoded thumbnail image for the new board template."""
2474
3466
  thumbnail: String
3467
+
3468
+ """The visibility for the new board template: 'private' or 'public'."""
2475
3469
  visibility: String!
2476
3470
  }
2477
3471
 
@@ -2489,12 +3483,24 @@ input NewCommonCodeDetail {
2489
3483
  rank: Float!
2490
3484
  }
2491
3485
 
3486
+ """Input for creating a new connection."""
2492
3487
  input NewConnection {
3488
+ """A detailed description for the new connection."""
2493
3489
  description: String
3490
+
3491
+ """Reference to the edge appliance for the new connection."""
2494
3492
  edge: ObjectRef
3493
+
3494
+ """The endpoint URL or address for the new connection."""
2495
3495
  endpoint: String
3496
+
3497
+ """The name for the new connection."""
2496
3498
  name: String!
3499
+
3500
+ """A key-value map of parameters for the new connection."""
2497
3501
  params: Object
3502
+
3503
+ """The type of the new connection (e.g., tcp, http, mqtt)."""
2498
3504
  type: String
2499
3505
  }
2500
3506
 
@@ -2521,9 +3527,15 @@ input NewDepartment {
2521
3527
  picture: Upload
2522
3528
  }
2523
3529
 
3530
+ """Input for creating a new domain link."""
2524
3531
  input NewDomainLink {
3532
+ """The source domain in the relationship."""
2525
3533
  sourceDomain: ObjectRef!
3534
+
3535
+ """The target domain in the relationship."""
2526
3536
  targetDomain: ObjectRef!
3537
+
3538
+ """The type of the relationship."""
2527
3539
  type: String!
2528
3540
  }
2529
3541
 
@@ -2621,8 +3633,12 @@ input NewFont {
2621
3633
  uri: String
2622
3634
  }
2623
3635
 
3636
+ """Input for creating a new board group."""
2624
3637
  input NewGroup {
3638
+ """A detailed description for the new group."""
2625
3639
  description: String
3640
+
3641
+ """The name of the new group."""
2626
3642
  name: String!
2627
3643
  }
2628
3644
 
@@ -2833,13 +3849,21 @@ input NewPagePreference {
2833
3849
  user: ObjectRef!
2834
3850
  }
2835
3851
 
3852
+ """Input for creating a new payload log."""
2836
3853
  input NewPayloadLog {
3854
+ """A description for the new payload log entry."""
2837
3855
  description: String
3856
+
3857
+ """The name for the new payload log entry."""
2838
3858
  name: String!
2839
3859
  }
2840
3860
 
3861
+ """Input for creating a new play group."""
2841
3862
  input NewPlayGroup {
3863
+ """A detailed description for the new play group."""
2842
3864
  description: String
3865
+
3866
+ """The name of the new play group."""
2843
3867
  name: String!
2844
3868
  }
2845
3869
 
@@ -2861,28 +3885,60 @@ input NewPrinterDevice {
2861
3885
  type: String
2862
3886
  }
2863
3887
 
3888
+ """Input for creating a new privilege."""
2864
3889
  input NewPrivilege {
3890
+ """The category of the new privilege."""
2865
3891
  category: String!
3892
+
3893
+ """A description for the new privilege."""
2866
3894
  description: String
3895
+
3896
+ """The name of the new privilege."""
2867
3897
  name: String!
3898
+
3899
+ """Roles to which the new privilege will be assigned."""
2868
3900
  roles: [ObjectRef!]
2869
3901
  }
2870
3902
 
3903
+ """Input for creating a new role."""
2871
3904
  input NewRole {
3905
+ """A description for the new role."""
2872
3906
  description: String
3907
+
3908
+ """The name of the new role."""
2873
3909
  name: String!
3910
+
3911
+ """Privileges to be granted by the new role."""
2874
3912
  privileges: [ObjectRef!]
3913
+
3914
+ """Users to be assigned to the new role."""
2875
3915
  users: [ObjectRef!]
2876
3916
  }
2877
3917
 
3918
+ """Input for creating a new scenario."""
2878
3919
  input NewScenario {
3920
+ """Indicates if the new scenario should be active upon creation."""
2879
3921
  active: Boolean
3922
+
3923
+ """A detailed description for the new scenario."""
2880
3924
  description: String
3925
+
3926
+ """The name of the new scenario."""
2881
3927
  name: String!
3928
+
3929
+ """The role required to execute the new scenario."""
2882
3930
  role: ObjectRef
3931
+
3932
+ """A cron-style schedule for the new scenario."""
2883
3933
  schedule: String
3934
+
3935
+ """The timezone for the schedule."""
2884
3936
  timezone: String
3937
+
3938
+ """Time-to-live in seconds for new scenario instances."""
2885
3939
  ttl: Float
3940
+
3941
+ """The type of the new scenario, for categorization."""
2886
3942
  type: String
2887
3943
  }
2888
3944
 
@@ -2902,6 +3958,7 @@ input NewSetting {
2902
3958
  value: String
2903
3959
  }
2904
3960
 
3961
+ """Input for creating a new state register."""
2905
3962
  input NewStateRegister {
2906
3963
  """Description of the state register"""
2907
3964
  description: String
@@ -2941,30 +3998,70 @@ input NewTerminology {
2941
3998
  name: String!
2942
3999
  }
2943
4000
 
4001
+ """Input for creating a new theme."""
2944
4002
  input NewTheme {
4003
+ """Whether the new theme should be active upon creation."""
2945
4004
  active: Boolean
4005
+
4006
+ """A detailed description for the new theme."""
2946
4007
  description: String
4008
+
4009
+ """The name for the new theme."""
2947
4010
  name: String!
4011
+
4012
+ """The type of the new theme."""
2948
4013
  type: String
4014
+
4015
+ """A JSON object of style values for the new theme."""
2949
4016
  value: Object
2950
4017
  }
2951
4018
 
4019
+ """Input type for creating a new user account."""
2952
4020
  input NewUser {
4021
+ """Optional description or note about the user."""
2953
4022
  description: String
4023
+
4024
+ """Email address of the user."""
2954
4025
  email: EmailAddress!
4026
+
4027
+ """Full name of the user."""
2955
4028
  name: String!
4029
+
4030
+ """Password for the user account."""
2956
4031
  password: String
4032
+
4033
+ """Roles assigned to the user."""
2957
4034
  roles: [ObjectRef!]
4035
+
4036
+ """Type or category of the user (e.g., admin, operator, guest)."""
2958
4037
  userType: String
4038
+
4039
+ """Unique username for the user."""
2959
4040
  username: String!
2960
4041
  }
2961
4042
 
4043
+ """Input for creating a new user as part of the domain creation wizard."""
2962
4044
  input NewUserByDomainWizardInput {
4045
+ """The email address of the new user."""
2963
4046
  email: EmailAddress!
4047
+
4048
+ """
4049
+ Indicates whether the user should be invited via email instead of created directly.
4050
+ """
2964
4051
  isInvitee: Boolean
4052
+
4053
+ """The full name of the new user."""
2965
4054
  name: String!
4055
+
4056
+ """Indicates whether this user is an owner of the domain."""
2966
4057
  owner: Boolean!
4058
+
4059
+ """
4060
+ The password for the new user. If not provided, an invitation will be sent.
4061
+ """
2967
4062
  password: String
4063
+
4064
+ """A list of roles to be assigned to the new user."""
2968
4065
  roles: [NewRole!]!
2969
4066
  }
2970
4067
 
@@ -3114,44 +4211,49 @@ input Oauth2ClientPatch {
3114
4211
  webhook: String
3115
4212
  }
3116
4213
 
3117
- """Can be anything"""
4214
+ """
4215
+ 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.
4216
+ """
3118
4217
  scalar Object
3119
4218
 
4219
+ """
4220
+ Input type for referencing another object by its unique identifier, with optional name and description.
4221
+ """
3120
4222
  input ObjectRef {
3121
- """Field description"""
4223
+ """A description of the referenced object."""
3122
4224
  description: String
3123
4225
 
3124
- """Field id"""
4226
+ """The unique identifier of the referenced object."""
3125
4227
  id: ID!
3126
4228
 
3127
- """Field name"""
4229
+ """The name of the referenced object."""
3128
4230
  name: String
3129
4231
  }
3130
4232
 
3131
4233
  input ObjectRefApprovalLineOwnerType {
3132
4234
  controlNo: String
3133
4235
 
3134
- """Field description"""
4236
+ """A description of the referenced object."""
3135
4237
  description: String
3136
4238
 
3137
- """Field id"""
4239
+ """The unique identifier of the referenced object."""
3138
4240
  id: ID!
3139
4241
 
3140
- """Field name"""
4242
+ """The name of the referenced object."""
3141
4243
  name: String
3142
4244
  }
3143
4245
 
3144
4246
  input ObjectRefForContact {
3145
4247
  address: String
3146
4248
 
3147
- """Field description"""
4249
+ """A description of the referenced object."""
3148
4250
  description: String
3149
4251
  email: EmailAddress
3150
4252
 
3151
- """Field id"""
4253
+ """The unique identifier of the referenced object."""
3152
4254
  id: ID!
3153
4255
 
3154
- """Field name"""
4256
+ """The name of the referenced object."""
3155
4257
  name: String
3156
4258
  phone: String
3157
4259
  }
@@ -3159,13 +4261,13 @@ input ObjectRefForContact {
3159
4261
  input ObjectRefForDepartment {
3160
4262
  controlNo: String
3161
4263
 
3162
- """Field description"""
4264
+ """A description of the referenced object."""
3163
4265
  description: String
3164
4266
 
3165
- """Field id"""
4267
+ """The unique identifier of the referenced object."""
3166
4268
  id: ID!
3167
4269
 
3168
- """Field name"""
4270
+ """The name of the referenced object."""
3169
4271
  name: String
3170
4272
  }
3171
4273
 
@@ -3174,31 +4276,31 @@ input ObjectRefForEmployee {
3174
4276
  alias: String
3175
4277
  controlNo: String
3176
4278
 
3177
- """Field description"""
4279
+ """A description of the referenced object."""
3178
4280
  description: String
3179
4281
  email: EmailAddress
3180
4282
  hiredOn: DateTimeISO
3181
4283
 
3182
- """Field id"""
4284
+ """The unique identifier of the referenced object."""
3183
4285
  id: ID!
3184
4286
  jobPosition: String
3185
4287
  jobResponsibility: String
3186
4288
 
3187
- """Field name"""
4289
+ """The name of the referenced object."""
3188
4290
  name: String
3189
4291
  photo: String
3190
4292
  type: EmployeeType
3191
4293
  }
3192
4294
 
3193
4295
  input ObjectRefForUser {
3194
- """Field description"""
4296
+ """A description of the referenced object."""
3195
4297
  description: String
3196
4298
  email: EmailAddress
3197
4299
 
3198
- """Field id"""
4300
+ """The unique identifier of the referenced object."""
3199
4301
  id: ID!
3200
4302
 
3201
- """Field name"""
4303
+ """The name of the referenced object."""
3202
4304
  name: String
3203
4305
  }
3204
4306
 
@@ -3244,23 +4346,45 @@ type PagePreferenceList {
3244
4346
  total: Int!
3245
4347
  }
3246
4348
 
4349
+ """Input type for specifying pagination options in a list query."""
3247
4350
  input Pagination {
4351
+ """The maximum number of items per page."""
3248
4352
  limit: Int
4353
+
4354
+ """The page number to retrieve."""
3249
4355
  page: Int
3250
4356
  }
3251
4357
 
4358
+ """Represents a partnership between two domains."""
3252
4359
  type Partner {
4360
+ """The timestamp when the partnership was approved."""
3253
4361
  approvedAt: DateTimeISO
4362
+
4363
+ """The user who approved the partnership."""
3254
4364
  approver: User
4365
+
4366
+ """The domain initiating the partnership."""
3255
4367
  domain: Domain!
4368
+
4369
+ """Unique identifier for the partnership."""
3256
4370
  id: ID!
4371
+
4372
+ """The domain being partnered with."""
3257
4373
  partnerDomain: Domain!
4374
+
4375
+ """The timestamp when the partnership was requested."""
3258
4376
  requestedAt: DateTimeISO
4377
+
4378
+ """The user who requested the partnership."""
3259
4379
  requester: User
3260
4380
  }
3261
4381
 
4382
+ """A paginated list of partnerships."""
3262
4383
  type PartnerList {
4384
+ """The list of partnership items."""
3263
4385
  items: [Partner!]
4386
+
4387
+ """The total number of partnerships."""
3264
4388
  total: Int
3265
4389
  }
3266
4390
 
@@ -3295,73 +4419,168 @@ input PartnerSettingPatch {
3295
4419
  value: String
3296
4420
  }
3297
4421
 
4422
+ """
4423
+ Password rule configuration for user accounts, specifying required character types and patterns.
4424
+ """
3298
4425
  type PasswordRule {
4426
+ """Whether repeated characters are allowed in the password."""
3299
4427
  allowRepeat: Boolean
4428
+
4429
+ """Whether at least one digit is required."""
3300
4430
  digit: Boolean
4431
+
4432
+ """Minimum length required for a loose password pattern."""
3301
4433
  looseCharacterLength: Float
4434
+
4435
+ """Whether at least one lowercase letter is required."""
3302
4436
  lowerCase: Boolean
4437
+
4438
+ """Whether at least one special character is required."""
3303
4439
  specialCharacter: Boolean
4440
+
4441
+ """Minimum length required for a strict password pattern."""
3304
4442
  tightCharacterLength: Float
4443
+
4444
+ """Whether at least one uppercase letter is required."""
3305
4445
  upperCase: Boolean
4446
+
4447
+ """Whether to allow a loose password pattern."""
3306
4448
  useLoosePattern: Boolean
4449
+
4450
+ """Whether to enforce a strict password pattern."""
3307
4451
  useTightPattern: Boolean
3308
4452
  }
3309
4453
 
3310
- """Entity for PayloadLog"""
4454
+ """Logs the request and response payloads for API interactions."""
3311
4455
  type PayloadLog {
4456
+ """The timestamp when the log entry was created."""
3312
4457
  createdAt: DateTimeISO
4458
+
4459
+ """The user who created the log entry."""
3313
4460
  creator: User
4461
+
4462
+ """The domain in which the transaction occurred."""
3314
4463
  domain: Domain!
4464
+
4465
+ """The API endpoint that was called."""
3315
4466
  endpoint: String!
4467
+
4468
+ """Unique identifier for the payload log entry."""
3316
4469
  id: ID!
4470
+
4471
+ """A descriptive name for the transaction being logged."""
3317
4472
  name: String!
4473
+
4474
+ """The full request payload, usually in JSON format."""
3318
4475
  request: String!
4476
+
4477
+ """The full response payload, usually in JSON format."""
3319
4478
  response: String!
4479
+
4480
+ """The source of the request."""
3320
4481
  src: String
4482
+
4483
+ """The direction of the data flow (ingestion or egestion)."""
3321
4484
  type: String!
4485
+
4486
+ """The timestamp when the log entry was last updated."""
3322
4487
  updatedAt: DateTimeISO
4488
+
4489
+ """The user who last updated the log entry."""
3323
4490
  updater: User
3324
4491
  }
3325
4492
 
4493
+ """A paginated list of payload logs."""
3326
4494
  type PayloadLogList {
4495
+ """The list of payload log items."""
3327
4496
  items: [PayloadLog!]!
4497
+
4498
+ """The total number of payload logs."""
3328
4499
  total: Int!
3329
4500
  }
3330
4501
 
4502
+ """Input for updating (patching) an existing payload log."""
3331
4503
  input PayloadLogPatch {
4504
+ """
4505
+ A flag indicating whether the log is being created, updated, or deleted.
4506
+ """
3332
4507
  cuFlag: String!
4508
+
4509
+ """The new description for the payload log entry."""
3333
4510
  description: String
4511
+
4512
+ """The unique identifier of the payload log to update."""
3334
4513
  id: ID
4514
+
4515
+ """The new name for the payload log entry."""
3335
4516
  name: String
3336
4517
  }
3337
4518
 
4519
+ """Represents an item pending in a scenario queue."""
3338
4520
  type PendingObject {
4521
+ """The timestamp indicating when the item is due for processing."""
3339
4522
  due: String!
4523
+
4524
+ """The priority level of the item in the queue."""
3340
4525
  priority: Int!
4526
+
4527
+ """The actual data or task object in the queue."""
3341
4528
  stuff: Object!
4529
+
4530
+ """A tag for categorizing or filtering queue items."""
3342
4531
  tag: String
3343
4532
  }
3344
4533
 
3345
- """Entity for Board PlayGroup"""
4534
+ """A group of boards that can be played in a sequence or collection."""
3346
4535
  type PlayGroup {
4536
+ """The list of boards included in this play group."""
3347
4537
  boards: [Board!]
4538
+
4539
+ """The timestamp when the play group was created."""
3348
4540
  createdAt: DateTimeISO
4541
+
4542
+ """The user who created the play group."""
3349
4543
  creator: User
4544
+
4545
+ """A detailed description of the play group."""
3350
4546
  description: String
4547
+
4548
+ """The domain to which this play group belongs."""
3351
4549
  domain: Domain
4550
+
4551
+ """Unique identifier for the play group."""
3352
4552
  id: ID!
4553
+
4554
+ """The name of the play group."""
3353
4555
  name: String!
4556
+
4557
+ """
4558
+ An array of board IDs, defining the specific playback order of boards within the group.
4559
+ """
4560
+ order: [String!]
4561
+
4562
+ """The timestamp when the play group was last updated."""
3354
4563
  updatedAt: DateTimeISO
4564
+
4565
+ """The user who last updated the play group."""
3355
4566
  updater: User
3356
4567
  }
3357
4568
 
4569
+ """A paginated list of play groups."""
3358
4570
  type PlayGroupList {
4571
+ """The list of play group items."""
3359
4572
  items: [PlayGroup!]!
4573
+
4574
+ """The total number of play groups."""
3360
4575
  total: Int!
3361
4576
  }
3362
4577
 
4578
+ """Input for updating (patching) an existing play group."""
3363
4579
  input PlayGroupPatch {
4580
+ """The new description for the play group."""
3364
4581
  description: String
4582
+
4583
+ """The new name for the play group."""
3365
4584
  name: String
3366
4585
  }
3367
4586
 
@@ -3415,36 +4634,78 @@ input PrinterDevicePatch {
3415
4634
  type: String
3416
4635
  }
3417
4636
 
4637
+ """
4638
+ A privilege that can be granted to roles to control access to resources.
4639
+ """
3418
4640
  type Privilege {
4641
+ """The category of the privilege (e.g., security, resource)."""
3419
4642
  category: String
4643
+
4644
+ """The timestamp when the privilege was created."""
3420
4645
  createdAt: DateTimeISO
4646
+
4647
+ """The user who created the privilege."""
3421
4648
  creator: User
4649
+
4650
+ """A detailed description of what the privilege allows."""
3422
4651
  description: String
4652
+
4653
+ """Unique identifier for the privilege."""
3423
4654
  id: ID!
4655
+
4656
+ """The name of the privilege."""
3424
4657
  name: String!
3425
4658
  privilege: String!
4659
+
4660
+ """Roles that include this privilege."""
3426
4661
  roles: [Role!]
4662
+
4663
+ """The timestamp when the privilege was last updated."""
3427
4664
  updatedAt: DateTimeISO
4665
+
4666
+ """The user who last updated the privilege."""
3428
4667
  updater: User
3429
4668
  }
3430
4669
 
4670
+ """A paginated list of privileges."""
3431
4671
  type PrivilegeList {
4672
+ """The list of privilege items."""
3432
4673
  items: [Privilege!]
4674
+
4675
+ """The total number of privileges."""
3433
4676
  total: Int
3434
4677
  }
3435
4678
 
4679
+ """Represents a privilege object with its properties."""
3436
4680
  type PrivilegeObject {
4681
+ """The category of the privilege."""
3437
4682
  category: String
4683
+
4684
+ """Indicates if the privilege is for an owner."""
3438
4685
  owner: Boolean
4686
+
4687
+ """The name of the privilege."""
3439
4688
  privilege: String
4689
+
4690
+ """Indicates if the privilege is for a superuser."""
3440
4691
  super: Boolean
3441
4692
  }
3442
4693
 
4694
+ """Input for updating (patching) an existing privilege."""
3443
4695
  input PrivilegePatch {
4696
+ """The new category for the privilege."""
3444
4697
  category: String
4698
+
4699
+ """The new description for the privilege."""
3445
4700
  description: String
4701
+
4702
+ """The unique identifier of the privilege to update."""
3446
4703
  id: String
4704
+
4705
+ """The new name for the privilege."""
3447
4706
  name: String
4707
+
4708
+ """A new list of roles to be assigned to the privilege."""
3448
4709
  roles: [ObjectRef!]
3449
4710
  }
3450
4711
 
@@ -3465,51 +4726,163 @@ input ProfileInput {
3465
4726
  zoom: Float
3466
4727
  }
3467
4728
 
4729
+ """
4730
+ Describes a single property for a component or a step, used for UI rendering and configuration.
4731
+ """
3468
4732
  type PropertySpec {
4733
+ """The human-readable label for the property, shown in UI."""
3469
4734
  label: String!
4735
+
4736
+ """The name of the property, used as the key in configuration objects."""
3470
4737
  name: String!
4738
+
4739
+ """Placeholder text for the input field."""
3471
4740
  placeholder: String
4741
+
4742
+ """
4743
+ Additional properties specific to the type (e.g., options for a select).
4744
+ """
3472
4745
  property: Object
4746
+
4747
+ """CSS styles to be applied to the input field."""
3473
4748
  styles: Object
4749
+
4750
+ """The data type of the property (e.g., text, number, boolean, select)."""
3474
4751
  type: String!
3475
4752
  }
3476
4753
 
3477
4754
  type Query {
3478
4755
  APIDocCompletion(input: APIDocCompletionInput!): APIDocCompletionOutput!
3479
4756
  appBinding(id: String!): AppBinding!
3480
- appBindings(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AppBindingList!
4757
+ appBindings(
4758
+ """An array of filter conditions to apply to the list query."""
4759
+ filters: [Filter!]
4760
+
4761
+ """Inherited value type for the list query."""
4762
+ inherited: InheritedValueType
4763
+
4764
+ """Pagination options for the list query."""
4765
+ pagination: Pagination
4766
+
4767
+ """Sorting options for the list query."""
4768
+ sortings: [Sorting!]
4769
+ ): AppBindingList!
3481
4770
 
3482
4771
  """ To fetch appliance"""
3483
4772
  appliance(id: String!): Appliance!
3484
4773
 
3485
4774
  """To fetch multiple appliance"""
3486
- appliances(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApplianceList!
4775
+ appliances(
4776
+ """An array of filter conditions to apply to the list query."""
4777
+ filters: [Filter!]
4778
+
4779
+ """Inherited value type for the list query."""
4780
+ inherited: InheritedValueType
4781
+
4782
+ """Pagination options for the list query."""
4783
+ pagination: Pagination
4784
+
4785
+ """Sorting options for the list query."""
4786
+ sortings: [Sorting!]
4787
+ ): ApplianceList!
3487
4788
 
3488
4789
  """To fetch application"""
3489
4790
  application(id: String!): Application!
3490
4791
 
3491
4792
  """To fetch multiple application"""
3492
- applications(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApplicationList!
4793
+ applications(
4794
+ """An array of filter conditions to apply to the list query."""
4795
+ filters: [Filter!]
4796
+
4797
+ """Inherited value type for the list query."""
4798
+ inherited: InheritedValueType
4799
+
4800
+ """Pagination options for the list query."""
4801
+ pagination: Pagination
4802
+
4803
+ """Sorting options for the list query."""
4804
+ sortings: [Sorting!]
4805
+ ): ApplicationList!
3493
4806
 
3494
4807
  """To fetch a approval line"""
3495
4808
  approvalLine(id: String!): ApprovalLine
3496
4809
 
3497
4810
  """To fetch referable approval lines for the user"""
3498
- approvalLineReferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApprovalLineList!
4811
+ approvalLineReferences(
4812
+ """An array of filter conditions to apply to the list query."""
4813
+ filters: [Filter!]
4814
+
4815
+ """Inherited value type for the list query."""
4816
+ inherited: InheritedValueType
4817
+
4818
+ """Pagination options for the list query."""
4819
+ pagination: Pagination
4820
+
4821
+ """Sorting options for the list query."""
4822
+ sortings: [Sorting!]
4823
+ ): ApprovalLineList!
3499
4824
 
3500
4825
  """To fetch multiple approval lines"""
3501
- approvalLines(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApprovalLineList!
4826
+ approvalLines(
4827
+ """An array of filter conditions to apply to the list query."""
4828
+ filters: [Filter!]
4829
+
4830
+ """Inherited value type for the list query."""
4831
+ inherited: InheritedValueType
4832
+
4833
+ """Pagination options for the list query."""
4834
+ pagination: Pagination
4835
+
4836
+ """Sorting options for the list query."""
4837
+ sortings: [Sorting!]
4838
+ ): ApprovalLineList!
3502
4839
  attachment(id: String!): Attachment!
3503
- attachments(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AttachmentList!
4840
+ attachments(
4841
+ """An array of filter conditions to apply to the list query."""
4842
+ filters: [Filter!]
4843
+
4844
+ """Inherited value type for the list query."""
4845
+ inherited: InheritedValueType
4846
+
4847
+ """Pagination options for the list query."""
4848
+ pagination: Pagination
4849
+
4850
+ """Sorting options for the list query."""
4851
+ sortings: [Sorting!]
4852
+ ): AttachmentList!
4853
+
4854
+ """
4855
+ Fetches a single AttributeSet entity by its unique identifier. Use this query to retrieve the details of a specific attribute set.
4856
+ """
4857
+ attributeSet(
4858
+ """The unique identifier of the AttributeSet to fetch."""
4859
+ id: String!
4860
+ ): AttributeSet
4861
+
4862
+ """
4863
+ Fetches a single AttributeSet entity by the associated entity name. Use this query to retrieve the attribute set for a specific entity type.
4864
+ """
4865
+ attributeSetByEntity(
4866
+ """The entity name associated with the AttributeSet."""
4867
+ entity: String!
4868
+ ): AttributeSet
3504
4869
 
3505
- """To fetch a AttributeSet"""
3506
- attributeSet(id: String!): AttributeSet
4870
+ """
4871
+ Fetches a list of AttributeSet entities with pagination and filtering options. Use this query to retrieve multiple attribute sets.
4872
+ """
4873
+ attributeSets(
4874
+ """An array of filter conditions to apply to the list query."""
4875
+ filters: [Filter!]
3507
4876
 
3508
- """To fetch a AttributeSet by Entity name"""
3509
- attributeSetByEntity(entity: String!): AttributeSet
4877
+ """Inherited value type for the list query."""
4878
+ inherited: InheritedValueType
3510
4879
 
3511
- """To fetch multiple AttributeSets"""
3512
- attributeSets(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AttributeSetList!
4880
+ """Pagination options for the list query."""
4881
+ pagination: Pagination
4882
+
4883
+ """Sorting options for the list query."""
4884
+ sortings: [Sorting!]
4885
+ ): AttributeSetList!
3513
4886
 
3514
4887
  """To fetch a AuthProvider"""
3515
4888
  authProvider(id: String!): AuthProvider
@@ -3518,15 +4891,27 @@ type Query {
3518
4891
  authProviderTypes: AuthProviderTypeList
3519
4892
 
3520
4893
  """To fetch multiple AuthProviders"""
3521
- authProviders(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): AuthProviderList!
4894
+ authProviders(
4895
+ """An array of filter conditions to apply to the list query."""
4896
+ filters: [Filter!]
4897
+
4898
+ """Inherited value type for the list query."""
4899
+ inherited: InheritedValueType
3522
4900
 
3523
- """To fetch a board"""
4901
+ """Pagination options for the list query."""
4902
+ pagination: Pagination
4903
+
4904
+ """Sorting options for the list query."""
4905
+ sortings: [Sorting!]
4906
+ ): AuthProviderList!
4907
+
4908
+ """Finds a single board by its ID."""
3524
4909
  board(id: String!): Board!
3525
4910
 
3526
- """To fetch a Board Model by name"""
4911
+ """Finds a single board by its name."""
3527
4912
  boardByName(name: String!): Board
3528
4913
 
3529
- """To fetch the latest Board published"""
4914
+ """Retrieves the most recently published version of a board."""
3530
4915
  boardPublished(id: String!): BoardHistory!
3531
4916
 
3532
4917
  """To fetch a BoardSettings"""
@@ -3536,19 +4921,67 @@ type Query {
3536
4921
  boardTemplate(id: String!): BoardTemplate
3537
4922
 
3538
4923
  """To fetch multiple BoardTemplates"""
3539
- boardTemplates(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardTemplateList!
4924
+ boardTemplates(
4925
+ """An array of filter conditions to apply to the list query."""
4926
+ filters: [Filter!]
4927
+
4928
+ """Inherited value type for the list query."""
4929
+ inherited: InheritedValueType
4930
+
4931
+ """Pagination options for the list query."""
4932
+ pagination: Pagination
4933
+
4934
+ """Sorting options for the list query."""
4935
+ sortings: [Sorting!]
4936
+ ): BoardTemplateList!
3540
4937
 
3541
4938
  """To fetch BoardTemplates created by me"""
3542
- boardTemplatesCreatedByMe(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardTemplateList!
4939
+ boardTemplatesCreatedByMe(
4940
+ """An array of filter conditions to apply to the list query."""
4941
+ filters: [Filter!]
4942
+
4943
+ """Inherited value type for the list query."""
4944
+ inherited: InheritedValueType
4945
+
4946
+ """Pagination options for the list query."""
4947
+ pagination: Pagination
4948
+
4949
+ """Sorting options for the list query."""
4950
+ sortings: [Sorting!]
4951
+ ): BoardTemplateList!
3543
4952
 
3544
- """To fetch a Board Versions"""
4953
+ """Retrieves up to 10 historical versions of a specific board."""
3545
4954
  boardVersions(id: String!): [BoardHistory!]!
3546
4955
 
3547
- """To fetch multiple Boards"""
3548
- boards(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardList!
4956
+ """Retrieves a paginated list of all boards."""
4957
+ boards(
4958
+ """An array of filter conditions to apply to the list query."""
4959
+ filters: [Filter!]
3549
4960
 
3550
- """To fetch Boards created by me"""
3551
- boardsCreatedByMe(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardList!
4961
+ """Inherited value type for the list query."""
4962
+ inherited: InheritedValueType
4963
+
4964
+ """Pagination options for the list query."""
4965
+ pagination: Pagination
4966
+
4967
+ """Sorting options for the list query."""
4968
+ sortings: [Sorting!]
4969
+ ): BoardList!
4970
+
4971
+ """Retrieves a paginated list of boards created by the current user."""
4972
+ boardsCreatedByMe(
4973
+ """An array of filter conditions to apply to the list query."""
4974
+ filters: [Filter!]
4975
+
4976
+ """Inherited value type for the list query."""
4977
+ inherited: InheritedValueType
4978
+
4979
+ """Pagination options for the list query."""
4980
+ pagination: Pagination
4981
+
4982
+ """Sorting options for the list query."""
4983
+ sortings: [Sorting!]
4984
+ ): BoardList!
3552
4985
  chatCompletion(input: ChatCompletionInput!): ChatCompletionOutput!
3553
4986
 
3554
4987
  """
@@ -3570,10 +5003,25 @@ type Query {
3570
5003
  checkUserBelongsDomain: Boolean!
3571
5004
 
3572
5005
  """Checks if a user with the given email address exists in the system."""
3573
- checkUserExistence(email: EmailAddress!): Boolean!
5006
+ checkUserExistence(
5007
+ """The email address to check for existence."""
5008
+ email: EmailAddress!
5009
+ ): Boolean!
3574
5010
 
3575
5011
  """To fetch common approval lines"""
3576
- commonApprovalLines(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApprovalLineList!
5012
+ commonApprovalLines(
5013
+ """An array of filter conditions to apply to the list query."""
5014
+ filters: [Filter!]
5015
+
5016
+ """Inherited value type for the list query."""
5017
+ inherited: InheritedValueType
5018
+
5019
+ """Pagination options for the list query."""
5020
+ pagination: Pagination
5021
+
5022
+ """Sorting options for the list query."""
5023
+ sortings: [Sorting!]
5024
+ ): ApprovalLineList!
3577
5025
 
3578
5026
  """To fetch a CommonCode"""
3579
5027
  commonCode(name: String!): CommonCode
@@ -3582,28 +5030,81 @@ type Query {
3582
5030
  commonCodeDetail(id: String!): CommonCodeDetail!
3583
5031
 
3584
5032
  """To fetch multiple CommonCodeDetails"""
3585
- commonCodeDetails(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): CommonCodeDetailList!
5033
+ commonCodeDetails(
5034
+ """An array of filter conditions to apply to the list query."""
5035
+ filters: [Filter!]
5036
+
5037
+ """Inherited value type for the list query."""
5038
+ inherited: InheritedValueType
5039
+
5040
+ """Pagination options for the list query."""
5041
+ pagination: Pagination
5042
+
5043
+ """Sorting options for the list query."""
5044
+ sortings: [Sorting!]
5045
+ ): CommonCodeDetailList!
3586
5046
 
3587
5047
  """To fetch multiple CommonCodes"""
3588
- commonCodes(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): CommonCodeList!
5048
+ commonCodes(
5049
+ """An array of filter conditions to apply to the list query."""
5050
+ filters: [Filter!]
5051
+
5052
+ """Inherited value type for the list query."""
5053
+ inherited: InheritedValueType
5054
+
5055
+ """Pagination options for the list query."""
5056
+ pagination: Pagination
5057
+
5058
+ """Sorting options for the list query."""
5059
+ sortings: [Sorting!]
5060
+ ): CommonCodeList!
3589
5061
 
3590
- """To fetch a connector"""
3591
- connection(name: String!): ConnectorType!
5062
+ """Fetches a single connection by its name, including its current state."""
5063
+ connection(name: String!): Connection!
3592
5064
 
3593
- """To fetch multiple connections"""
3594
- connections(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ConnectionList!
5065
+ """
5066
+ Fetches a paginated list of connections, including their current states.
5067
+ """
5068
+ connections(
5069
+ """An array of filter conditions to apply to the list query."""
5070
+ filters: [Filter!]
5071
+
5072
+ """Inherited value type for the list query."""
5073
+ inherited: InheritedValueType
5074
+
5075
+ """Pagination options for the list query."""
5076
+ pagination: Pagination
3595
5077
 
3596
- """To fetch the connector from a connection"""
5078
+ """Sorting options for the list query."""
5079
+ sortings: [Sorting!]
5080
+ ): ConnectionList!
5081
+
5082
+ """Fetches a single connector type by its name."""
5083
+ connector(name: String!): ConnectorType!
5084
+
5085
+ """Fetches the connector type associated with a specific connection."""
3597
5086
  connectorByConnection(connectionName: String!): ConnectorType!
3598
5087
 
3599
- """To fetch multiple connector"""
5088
+ """Fetches a list of all available connector types."""
3600
5089
  connectors: ConnectorList!
3601
5090
 
3602
5091
  """To fetch a Contact"""
3603
5092
  contact(id: String!): Contact
3604
5093
 
3605
5094
  """To fetch multiple Contacts"""
3606
- contacts(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ContactList!
5095
+ contacts(
5096
+ """An array of filter conditions to apply to the list query."""
5097
+ filters: [Filter!]
5098
+
5099
+ """Inherited value type for the list query."""
5100
+ inherited: InheritedValueType
5101
+
5102
+ """Pagination options for the list query."""
5103
+ pagination: Pagination
5104
+
5105
+ """Sorting options for the list query."""
5106
+ sortings: [Sorting!]
5107
+ ): ContactList!
3607
5108
  customers: [Domain!]!
3608
5109
  decipherCode(input: CodeDecipherInput!): CodeDecipherOutput!
3609
5110
  decipherErrorCode(input: CodeDecipherInput!): CodeDecipherOutput!
@@ -3612,28 +5113,97 @@ type Query {
3612
5113
  department(id: String!): Department
3613
5114
 
3614
5115
  """To fetch a Root Departments"""
3615
- departmentRoots(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DepartmentList
5116
+ departmentRoots(
5117
+ """An array of filter conditions to apply to the list query."""
5118
+ filters: [Filter!]
5119
+
5120
+ """Inherited value type for the list query."""
5121
+ inherited: InheritedValueType
5122
+
5123
+ """Pagination options for the list query."""
5124
+ pagination: Pagination
5125
+
5126
+ """Sorting options for the list query."""
5127
+ sortings: [Sorting!]
5128
+ ): DepartmentList
3616
5129
 
3617
5130
  """To fetch multiple Departments"""
3618
- departments(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DepartmentList!
5131
+ departments(
5132
+ """An array of filter conditions to apply to the list query."""
5133
+ filters: [Filter!]
3619
5134
 
3620
- """To fetch domain"""
3621
- domain(id: String!): Domain!
5135
+ """Inherited value type for the list query."""
5136
+ inherited: InheritedValueType
5137
+
5138
+ """Pagination options for the list query."""
5139
+ pagination: Pagination
5140
+
5141
+ """Sorting options for the list query."""
5142
+ sortings: [Sorting!]
5143
+ ): DepartmentList!
5144
+
5145
+ """
5146
+ Fetches a single domain entity by its unique identifier. Only superusers are granted this privilege.
5147
+ """
5148
+ domain(
5149
+ """The unique identifier of the domain to fetch."""
5150
+ id: String!
5151
+ ): Domain!
3622
5152
 
3623
5153
  """To fetch multiple DomainLinks"""
3624
- domainLinks(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DomainLinkList!
5154
+ domainLinks(
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
5160
+
5161
+ """Pagination options for the list query."""
5162
+ pagination: Pagination
3625
5163
 
3626
- """To fetch domain"""
5164
+ """Sorting options for the list query."""
5165
+ sortings: [Sorting!]
5166
+ ): DomainLinkList!
5167
+
5168
+ """
5169
+ Fetches the list of available domain types from configuration. Only superusers are granted this privilege.
5170
+ """
3627
5171
  domainTypes: [String!]!
3628
5172
 
3629
- """To fetch all domains (Only superuser is granted this privilege.)"""
3630
- domains(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DomainList!
5173
+ """
5174
+ Fetches all domain entities with pagination and filtering options. Only superusers are granted this privilege.
5175
+ """
5176
+ domains(
5177
+ """An array of filter conditions to apply to the list query."""
5178
+ filters: [Filter!]
5179
+
5180
+ """Inherited value type for the list query."""
5181
+ inherited: InheritedValueType
5182
+
5183
+ """Pagination options for the list query."""
5184
+ pagination: Pagination
5185
+
5186
+ """Sorting options for the list query."""
5187
+ sortings: [Sorting!]
5188
+ ): DomainList!
3631
5189
 
3632
5190
  """To fetch domains with given privilege for user"""
3633
5191
  domainsWithPrivilege(category: String!, privilege: String!): [Domain!]!
3634
5192
 
3635
5193
  """To fetch multiple appliance"""
3636
- edges(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApplianceList!
5194
+ edges(
5195
+ """An array of filter conditions to apply to the list query."""
5196
+ filters: [Filter!]
5197
+
5198
+ """Inherited value type for the list query."""
5199
+ inherited: InheritedValueType
5200
+
5201
+ """Pagination options for the list query."""
5202
+ pagination: Pagination
5203
+
5204
+ """Sorting options for the list query."""
5205
+ sortings: [Sorting!]
5206
+ ): ApplianceList!
3637
5207
 
3638
5208
  """
3639
5209
  Fetches a specific employee by their unique ID. Returns the employee object if found, or null if not found.
@@ -3643,10 +5213,34 @@ type Query {
3643
5213
  """
3644
5214
  Fetches a list of employees based on provided query parameters. Supports searching by name, control number, and alias.
3645
5215
  """
3646
- employees(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): EmployeeList!
5216
+ employees(
5217
+ """An array of filter conditions to apply to the list query."""
5218
+ filters: [Filter!]
5219
+
5220
+ """Inherited value type for the list query."""
5221
+ inherited: InheritedValueType
5222
+
5223
+ """Pagination options for the list query."""
5224
+ pagination: Pagination
5225
+
5226
+ """Sorting options for the list query."""
5227
+ sortings: [Sorting!]
5228
+ ): EmployeeList!
3647
5229
 
3648
5230
  """To fetch multiple Entities"""
3649
- entities(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): EntityList!
5231
+ entities(
5232
+ """An array of filter conditions to apply to the list query."""
5233
+ filters: [Filter!]
5234
+
5235
+ """Inherited value type for the list query."""
5236
+ inherited: InheritedValueType
5237
+
5238
+ """Pagination options for the list query."""
5239
+ pagination: Pagination
5240
+
5241
+ """Sorting options for the list query."""
5242
+ sortings: [Sorting!]
5243
+ ): EntityList!
3650
5244
 
3651
5245
  """To fetch a Entity"""
3652
5246
  entity(id: String!): Entity!
@@ -3655,7 +5249,19 @@ type Query {
3655
5249
  entityColumn(id: String!): EntityColumn!
3656
5250
 
3657
5251
  """To fetch multiple EntityColumns"""
3658
- entityColumns(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): EntityColumnList!
5252
+ entityColumns(
5253
+ """An array of filter conditions to apply to the list query."""
5254
+ filters: [Filter!]
5255
+
5256
+ """Inherited value type for the list query."""
5257
+ inherited: InheritedValueType
5258
+
5259
+ """Pagination options for the list query."""
5260
+ pagination: Pagination
5261
+
5262
+ """Sorting options for the list query."""
5263
+ sortings: [Sorting!]
5264
+ ): EntityColumnList!
3659
5265
 
3660
5266
  """To fetch a EntityMetadata"""
3661
5267
  entityMetadata(name: String!): EntityMetadata!
@@ -3664,27 +5270,75 @@ type Query {
3664
5270
  favorite(id: String!): Favorite!
3665
5271
 
3666
5272
  """To fetch multiple BoardFavorites"""
3667
- favoriteBoards(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): BoardFavoriteList!
5273
+ favoriteBoards(
5274
+ """An array of filter conditions to apply to the list query."""
5275
+ filters: [Filter!]
5276
+
5277
+ """Inherited value type for the list query."""
5278
+ inherited: InheritedValueType
5279
+
5280
+ """Pagination options for the list query."""
5281
+ pagination: Pagination
5282
+
5283
+ """Sorting options for the list query."""
5284
+ sortings: [Sorting!]
5285
+ ): BoardFavoriteList!
3668
5286
 
3669
5287
  """To fetch multiple Favorites"""
3670
- favorites(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): FavoriteList!
5288
+ favorites(
5289
+ """An array of filter conditions to apply to the list query."""
5290
+ filters: [Filter!]
5291
+
5292
+ """Inherited value type for the list query."""
5293
+ inherited: InheritedValueType
3671
5294
 
3672
- """To fetch the state of a connection"""
5295
+ """Pagination options for the list query."""
5296
+ pagination: Pagination
5297
+
5298
+ """Sorting options for the list query."""
5299
+ sortings: [Sorting!]
5300
+ ): FavoriteList!
5301
+
5302
+ """Fetches the current state of a single connection by its name."""
3673
5303
  fetchConnectionState(name: String!): ConnectionState!
3674
5304
 
3675
5305
  """To fetch a Font"""
3676
5306
  font(id: String!): Font!
3677
5307
 
3678
5308
  """To fetch multiple Fonts"""
3679
- fonts(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): FontList!
5309
+ fonts(
5310
+ """An array of filter conditions to apply to the list query."""
5311
+ filters: [Filter!]
5312
+
5313
+ """Inherited value type for the list query."""
5314
+ inherited: InheritedValueType
5315
+
5316
+ """Pagination options for the list query."""
5317
+ pagination: Pagination
5318
+
5319
+ """Sorting options for the list query."""
5320
+ sortings: [Sorting!]
5321
+ ): FontList!
3680
5322
  grantedRoles: [GrantedRole!]!
3681
5323
  grantingRoles(customerId: String!): [GrantedRole!]!
3682
5324
 
3683
- """To fetch a Group"""
5325
+ """Finds a single board group by its ID."""
3684
5326
  group(id: String!): Group
3685
5327
 
3686
- """To fetch multiple Groups"""
3687
- groups(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): GroupList!
5328
+ """Retrieves a paginated list of board groups."""
5329
+ groups(
5330
+ """An array of filter conditions to apply to the list query."""
5331
+ filters: [Filter!]
5332
+
5333
+ """Inherited value type for the list query."""
5334
+ inherited: InheritedValueType
5335
+
5336
+ """Pagination options for the list query."""
5337
+ pagination: Pagination
5338
+
5339
+ """Sorting options for the list query."""
5340
+ sortings: [Sorting!]
5341
+ ): GroupList!
3688
5342
 
3689
5343
  """To query whether I have the given permission"""
3690
5344
  hasPrivilege(category: String!, privilege: String!): Boolean!
@@ -3700,10 +5354,34 @@ type Query {
3700
5354
  liteMenu(id: String!): LiteMenu!
3701
5355
 
3702
5356
  """To fetch multiple LiteMenus"""
3703
- liteMenus(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): LiteMenuList!
5357
+ liteMenus(
5358
+ """An array of filter conditions to apply to the list query."""
5359
+ filters: [Filter!]
5360
+
5361
+ """Inherited value type for the list query."""
5362
+ inherited: InheritedValueType
5363
+
5364
+ """Pagination options for the list query."""
5365
+ pagination: Pagination
5366
+
5367
+ """Sorting options for the list query."""
5368
+ sortings: [Sorting!]
5369
+ ): LiteMenuList!
3704
5370
 
3705
5371
  """To fetch multiple LoginHistories"""
3706
- loginHistories(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): LoginHistoryList!
5372
+ loginHistories(
5373
+ """An array of filter conditions to apply to the list query."""
5374
+ filters: [Filter!]
5375
+
5376
+ """Inherited value type for the list query."""
5377
+ inherited: InheritedValueType
5378
+
5379
+ """Pagination options for the list query."""
5380
+ pagination: Pagination
5381
+
5382
+ """Sorting options for the list query."""
5383
+ sortings: [Sorting!]
5384
+ ): LoginHistoryList!
3707
5385
 
3708
5386
  """To fetch a Menu"""
3709
5387
  menu(id: String!): Menu!
@@ -3712,7 +5390,19 @@ type Query {
3712
5390
  menuButton(id: String!): MenuButton!
3713
5391
 
3714
5392
  """To fetch multiple MenuButtons"""
3715
- menuButtons(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuButtonList!
5393
+ menuButtons(
5394
+ """An array of filter conditions to apply to the list query."""
5395
+ filters: [Filter!]
5396
+
5397
+ """Inherited value type for the list query."""
5398
+ inherited: InheritedValueType
5399
+
5400
+ """Pagination options for the list query."""
5401
+ pagination: Pagination
5402
+
5403
+ """Sorting options for the list query."""
5404
+ sortings: [Sorting!]
5405
+ ): MenuButtonList!
3716
5406
 
3717
5407
  """To fetch a Menu by routing"""
3718
5408
  menuByRouting(routing: String!): Menu!
@@ -3721,7 +5411,19 @@ type Query {
3721
5411
  menuColumn(id: String!): MenuColumn!
3722
5412
 
3723
5413
  """To fetch multiple MenuColumns"""
3724
- menuColumns(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuColumnList!
5414
+ menuColumns(
5415
+ """An array of filter conditions to apply to the list query."""
5416
+ filters: [Filter!]
5417
+
5418
+ """Inherited value type for the list query."""
5419
+ inherited: InheritedValueType
5420
+
5421
+ """Pagination options for the list query."""
5422
+ pagination: Pagination
5423
+
5424
+ """Sorting options for the list query."""
5425
+ sortings: [Sorting!]
5426
+ ): MenuColumnList!
3725
5427
 
3726
5428
  """To fetch a MenuDetail"""
3727
5429
  menuDetail(id: String!): MenuDetail!
@@ -3730,35 +5432,131 @@ type Query {
3730
5432
  menuDetailButton(id: String!): MenuDetailButton!
3731
5433
 
3732
5434
  """To fetch multiple MenuDetailButtons"""
3733
- menuDetailButtons(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuDetailButtonList!
5435
+ menuDetailButtons(
5436
+ """An array of filter conditions to apply to the list query."""
5437
+ filters: [Filter!]
5438
+
5439
+ """Inherited value type for the list query."""
5440
+ inherited: InheritedValueType
5441
+
5442
+ """Pagination options for the list query."""
5443
+ pagination: Pagination
5444
+
5445
+ """Sorting options for the list query."""
5446
+ sortings: [Sorting!]
5447
+ ): MenuDetailButtonList!
3734
5448
 
3735
5449
  """To fetch a MenuDetailColumn"""
3736
5450
  menuDetailColumn(id: String!): MenuDetailColumn!
3737
5451
 
3738
5452
  """To fetch multiple MenuDetailColumns"""
3739
- menuDetailColumns(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuDetailColumnList!
5453
+ menuDetailColumns(
5454
+ """An array of filter conditions to apply to the list query."""
5455
+ filters: [Filter!]
5456
+
5457
+ """Inherited value type for the list query."""
5458
+ inherited: InheritedValueType
5459
+
5460
+ """Pagination options for the list query."""
5461
+ pagination: Pagination
5462
+
5463
+ """Sorting options for the list query."""
5464
+ sortings: [Sorting!]
5465
+ ): MenuDetailColumnList!
3740
5466
 
3741
5467
  """To fetch multiple MenuDetails"""
3742
- menuDetails(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuDetailList!
5468
+ menuDetails(
5469
+ """An array of filter conditions to apply to the list query."""
5470
+ filters: [Filter!]
5471
+
5472
+ """Inherited value type for the list query."""
5473
+ inherited: InheritedValueType
5474
+
5475
+ """Pagination options for the list query."""
5476
+ pagination: Pagination
5477
+
5478
+ """Sorting options for the list query."""
5479
+ sortings: [Sorting!]
5480
+ ): MenuDetailList!
3743
5481
 
3744
5482
  """To fetch multiple Menus"""
3745
- menus(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuList!
5483
+ menus(
5484
+ """An array of filter conditions to apply to the list query."""
5485
+ filters: [Filter!]
5486
+
5487
+ """Inherited value type for the list query."""
5488
+ inherited: InheritedValueType
5489
+
5490
+ """Pagination options for the list query."""
5491
+ pagination: Pagination
5492
+
5493
+ """Sorting options for the list query."""
5494
+ sortings: [Sorting!]
5495
+ ): MenuList!
3746
5496
 
3747
5497
  """To fetch approval lines only for to the user"""
3748
- myApprovalLines(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ApprovalLineList!
5498
+ myApprovalLines(
5499
+ """An array of filter conditions to apply to the list query."""
5500
+ filters: [Filter!]
5501
+
5502
+ """Inherited value type for the list query."""
5503
+ inherited: InheritedValueType
5504
+
5505
+ """Pagination options for the list query."""
5506
+ pagination: Pagination
5507
+
5508
+ """Sorting options for the list query."""
5509
+ sortings: [Sorting!]
5510
+ ): ApprovalLineList!
3749
5511
 
3750
5512
  """To fetch current user's Favorites"""
3751
5513
  myFavorites: [Favorite!]!
3752
5514
 
3753
5515
  """To fetch my own LiteMenus"""
3754
- myLiteMenus(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): LiteMenuList!
5516
+ myLiteMenus(
5517
+ """An array of filter conditions to apply to the list query."""
5518
+ filters: [Filter!]
5519
+
5520
+ """Inherited value type for the list query."""
5521
+ inherited: InheritedValueType
5522
+
5523
+ """Pagination options for the list query."""
5524
+ pagination: Pagination
5525
+
5526
+ """Sorting options for the list query."""
5527
+ sortings: [Sorting!]
5528
+ ): LiteMenuList!
3755
5529
  myLoginHistories(limit: Float!): [LoginHistory!]!
3756
5530
 
3757
5531
  """To fetch my own Menus"""
3758
- myMenus(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuList!
5532
+ myMenus(
5533
+ """An array of filter conditions to apply to the list query."""
5534
+ filters: [Filter!]
5535
+
5536
+ """Inherited value type for the list query."""
5537
+ inherited: InheritedValueType
5538
+
5539
+ """Pagination options for the list query."""
5540
+ pagination: Pagination
5541
+
5542
+ """Sorting options for the list query."""
5543
+ sortings: [Sorting!]
5544
+ ): MenuList!
3759
5545
 
3760
5546
  """To fetch my notifications"""
3761
- myNotifications(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): NotificationList!
5547
+ myNotifications(
5548
+ """An array of filter conditions to apply to the list query."""
5549
+ filters: [Filter!]
5550
+
5551
+ """Inherited value type for the list query."""
5552
+ inherited: InheritedValueType
5553
+
5554
+ """Pagination options for the list query."""
5555
+ pagination: Pagination
5556
+
5557
+ """Sorting options for the list query."""
5558
+ sortings: [Sorting!]
5559
+ ): NotificationList!
3762
5560
 
3763
5561
  """To fetch a User's own PagePreference"""
3764
5562
  myPageAllPreferences(page: String!): [PagePreference!]
@@ -3767,16 +5565,40 @@ type Query {
3767
5565
  myPagePreference(element: String!, page: String!): PagePreference
3768
5566
 
3769
5567
  """To fetch multiple PagePreferences"""
3770
- myPagePreferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PagePreferenceList!
5568
+ myPagePreferences(
5569
+ """An array of filter conditions to apply to the list query."""
5570
+ filters: [Filter!]
3771
5571
 
3772
- """To fetch roles of current user"""
3773
- myRoles: [Role!]!
5572
+ """Inherited value type for the list query."""
5573
+ inherited: InheritedValueType
5574
+
5575
+ """Pagination options for the list query."""
5576
+ pagination: Pagination
5577
+
5578
+ """Sorting options for the list query."""
5579
+ sortings: [Sorting!]
5580
+ ): PagePreferenceList!
5581
+
5582
+ """To fetch roles of current user (id, name only)"""
5583
+ myRoles: [RoleBrief!]!
3774
5584
 
3775
5585
  """To fetch a User's own UserPreference"""
3776
5586
  myUserPreference(element: String!, key: String!): UserPreference
3777
5587
 
3778
5588
  """To fetch multiple UserPreferences"""
3779
- myUserPreferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): UserPreferenceList!
5589
+ myUserPreferences(
5590
+ """An array of filter conditions to apply to the list query."""
5591
+ filters: [Filter!]
5592
+
5593
+ """Inherited value type for the list query."""
5594
+ inherited: InheritedValueType
5595
+
5596
+ """Pagination options for the list query."""
5597
+ pagination: Pagination
5598
+
5599
+ """Sorting options for the list query."""
5600
+ sortings: [Sorting!]
5601
+ ): UserPreferenceList!
3780
5602
 
3781
5603
  """To fetch a Notification"""
3782
5604
  notification(id: String!): Notification
@@ -3785,16 +5607,52 @@ type Query {
3785
5607
  notificationRule(id: String!): NotificationRule
3786
5608
 
3787
5609
  """To fetch multiple NotificationRules"""
3788
- notificationRules(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): NotificationRuleList!
5610
+ notificationRules(
5611
+ """An array of filter conditions to apply to the list query."""
5612
+ filters: [Filter!]
5613
+
5614
+ """Inherited value type for the list query."""
5615
+ inherited: InheritedValueType
5616
+
5617
+ """Pagination options for the list query."""
5618
+ pagination: Pagination
5619
+
5620
+ """Sorting options for the list query."""
5621
+ sortings: [Sorting!]
5622
+ ): NotificationRuleList!
3789
5623
 
3790
5624
  """To fetch multiple Notificationes"""
3791
- notificationes(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): NotificationList!
5625
+ notificationes(
5626
+ """An array of filter conditions to apply to the list query."""
5627
+ filters: [Filter!]
5628
+
5629
+ """Inherited value type for the list query."""
5630
+ inherited: InheritedValueType
5631
+
5632
+ """Pagination options for the list query."""
5633
+ pagination: Pagination
5634
+
5635
+ """Sorting options for the list query."""
5636
+ sortings: [Sorting!]
5637
+ ): NotificationList!
3792
5638
 
3793
5639
  """To fetch a Oauth2Client"""
3794
5640
  oauth2Client(id: String!): Oauth2Client
3795
5641
 
3796
- """To fetch multiple Oauth2Clients"""
3797
- oauth2Clients(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): Oauth2ClientList!
5642
+ """To fetch multiple Oauth2Clients"""
5643
+ oauth2Clients(
5644
+ """An array of filter conditions to apply to the list query."""
5645
+ filters: [Filter!]
5646
+
5647
+ """Inherited value type for the list query."""
5648
+ inherited: InheritedValueType
5649
+
5650
+ """Pagination options for the list query."""
5651
+ pagination: Pagination
5652
+
5653
+ """Sorting options for the list query."""
5654
+ sortings: [Sorting!]
5655
+ ): Oauth2ClientList!
3798
5656
 
3799
5657
  """To fetch a PagePreference"""
3800
5658
  pagePreference(id: String!): PagePreference
@@ -3807,27 +5665,63 @@ type Query {
3807
5665
 
3808
5666
  """To fetch multiple PartnerSettings"""
3809
5667
  partnerSettings(filters: [Filter!]!, pagination: Pagination!, partnerDomain: ObjectRef!, sortings: [Sorting!]!): PartnerSettingList!
3810
- partners(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PartnerList!
5668
+ partners(
5669
+ """An array of filter conditions to apply to the list query."""
5670
+ filters: [Filter!]
5671
+
5672
+ """Inherited value type for the list query."""
5673
+ inherited: InheritedValueType
5674
+
5675
+ """Pagination options for the list query."""
5676
+ pagination: Pagination
5677
+
5678
+ """Sorting options for the list query."""
5679
+ sortings: [Sorting!]
5680
+ ): PartnerList!
3811
5681
 
3812
5682
  """
3813
5683
  Retrieves the current password rule configuration for the system, such as required character types and minimum length.
3814
5684
  """
3815
5685
  passwordRule: PasswordRule!
3816
5686
 
3817
- """To fetch a PayloadLog"""
5687
+ """Fetches a single payload log by its ID."""
3818
5688
  payloadLog(id: String!): PayloadLog!
3819
5689
 
3820
- """To fetch multiple PayloadLogs"""
3821
- payloadLogs(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PayloadLogList!
5690
+ """Fetches a paginated list of payload logs."""
5691
+ payloadLogs(
5692
+ """An array of filter conditions to apply to the list query."""
5693
+ filters: [Filter!]
3822
5694
 
3823
- """To fetch a PlayGroup"""
5695
+ """Inherited value type for the list query."""
5696
+ inherited: InheritedValueType
5697
+
5698
+ """Pagination options for the list query."""
5699
+ pagination: Pagination
5700
+
5701
+ """Sorting options for the list query."""
5702
+ sortings: [Sorting!]
5703
+ ): PayloadLogList!
5704
+
5705
+ """Finds a single play group by its ID."""
3824
5706
  playGroup(id: String!): PlayGroup
3825
5707
 
3826
- """To fetch a PlayGroup by name"""
5708
+ """Finds a single play group by its name."""
3827
5709
  playGroupByName(name: String!): PlayGroup
3828
5710
 
3829
- """To fetch multiple PlayGroups"""
3830
- playGroups(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PlayGroupList!
5711
+ """Retrieves a paginated list of play groups."""
5712
+ playGroups(
5713
+ """An array of filter conditions to apply to the list query."""
5714
+ filters: [Filter!]
5715
+
5716
+ """Inherited value type for the list query."""
5717
+ inherited: InheritedValueType
5718
+
5719
+ """Pagination options for the list query."""
5720
+ pagination: Pagination
5721
+
5722
+ """Sorting options for the list query."""
5723
+ sortings: [Sorting!]
5724
+ ): PlayGroupList!
3831
5725
 
3832
5726
  """To fetch a UserPreference"""
3833
5727
  preference(id: String!): UserPreference
@@ -3836,10 +5730,34 @@ type Query {
3836
5730
  printerDevice(id: String!): PrinterDevice!
3837
5731
 
3838
5732
  """To fetch multiple PrinterDevices"""
3839
- printerDevices(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PrinterDeviceList!
5733
+ printerDevices(
5734
+ """An array of filter conditions to apply to the list query."""
5735
+ filters: [Filter!]
5736
+
5737
+ """Inherited value type for the list query."""
5738
+ inherited: InheritedValueType
5739
+
5740
+ """Pagination options for the list query."""
5741
+ pagination: Pagination
5742
+
5743
+ """Sorting options for the list query."""
5744
+ sortings: [Sorting!]
5745
+ ): PrinterDeviceList!
3840
5746
 
3841
5747
  """To fetch multiple privileges"""
3842
- privileges(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PrivilegeList!
5748
+ privileges(
5749
+ """An array of filter conditions to apply to the list query."""
5750
+ filters: [Filter!]
5751
+
5752
+ """Inherited value type for the list query."""
5753
+ inherited: InheritedValueType
5754
+
5755
+ """Pagination options for the list query."""
5756
+ pagination: Pagination
5757
+
5758
+ """Sorting options for the list query."""
5759
+ sortings: [Sorting!]
5760
+ ): PrivilegeList!
3843
5761
 
3844
5762
  """To fetch role"""
3845
5763
  role(name: String!): Role!
@@ -3851,72 +5769,199 @@ type Query {
3851
5769
  rolePrivileges(roleId: String!): [RolePrivilege!]!
3852
5770
 
3853
5771
  """To fetch multiple users"""
3854
- roles(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): RoleList!
5772
+ roles(
5773
+ """An array of filter conditions to apply to the list query."""
5774
+ filters: [Filter!]
3855
5775
 
3856
- """To fetch a scenario"""
5776
+ """Inherited value type for the list query."""
5777
+ inherited: InheritedValueType
5778
+
5779
+ """Pagination options for the list query."""
5780
+ pagination: Pagination
5781
+
5782
+ """Sorting options for the list query."""
5783
+ sortings: [Sorting!]
5784
+ ): RoleList!
5785
+
5786
+ """Fetches a single scenario by its ID."""
3857
5787
  scenario(id: String!): Scenario!
3858
5788
 
3859
- """To fetch a scenario instance"""
5789
+ """Fetches a single scenario instance by its name."""
3860
5790
  scenarioInstance(instanceName: String!): ScenarioInstance!
3861
5791
 
3862
- """To fetch multiple scenario instances"""
3863
- scenarioInstances(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ScenarioInstanceList!
5792
+ """Fetches a list of all active scenario instances."""
5793
+ scenarioInstances(
5794
+ """An array of filter conditions to apply to the list query."""
5795
+ filters: [Filter!]
5796
+
5797
+ """Inherited value type for the list query."""
5798
+ inherited: InheritedValueType
5799
+
5800
+ """Pagination options for the list query."""
5801
+ pagination: Pagination
5802
+
5803
+ """Sorting options for the list query."""
5804
+ sortings: [Sorting!]
5805
+ ): ScenarioInstanceList!
5806
+
5807
+ """Fetches a paginated list of scenarios."""
5808
+ scenarios(
5809
+ """An array of filter conditions to apply to the list query."""
5810
+ filters: [Filter!]
5811
+
5812
+ """Inherited value type for the list query."""
5813
+ inherited: InheritedValueType
3864
5814
 
3865
- """To fetch multiple scenarios"""
3866
- scenarios(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ScenarioList!
5815
+ """Pagination options for the list query."""
5816
+ pagination: Pagination
5817
+
5818
+ """Sorting options for the list query."""
5819
+ sortings: [Sorting!]
5820
+ ): ScenarioList!
3867
5821
  schedule(id: ID!): Schedule
3868
5822
 
3869
5823
  """To fetch multiple Schedules"""
3870
- schedules(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ScheduleList!
3871
- searchCustomers(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): DomainList!
5824
+ schedules(
5825
+ """An array of filter conditions to apply to the list query."""
5826
+ filters: [Filter!]
5827
+
5828
+ """Inherited value type for the list query."""
5829
+ inherited: InheritedValueType
5830
+
5831
+ """Pagination options for the list query."""
5832
+ pagination: Pagination
5833
+
5834
+ """Sorting options for the list query."""
5835
+ sortings: [Sorting!]
5836
+ ): ScheduleList!
5837
+ searchCustomers(
5838
+ """An array of filter conditions to apply to the list query."""
5839
+ filters: [Filter!]
3872
5840
 
3873
- """To fetch domain"""
5841
+ """Inherited value type for the list query."""
5842
+ inherited: InheritedValueType
5843
+
5844
+ """Pagination options for the list query."""
5845
+ pagination: Pagination
5846
+
5847
+ """Sorting options for the list query."""
5848
+ sortings: [Sorting!]
5849
+ ): DomainList!
5850
+
5851
+ """
5852
+ Fetches the secure IP list (whitelist, blacklist, etc.) for the current domain. Only domain owners and superusers are granted this privilege.
5853
+ """
3874
5854
  secureIPList: Object
3875
5855
 
3876
5856
  """To fetch a Setting"""
3877
5857
  setting(name: String!, partnerDomainId: String): Setting!
3878
5858
 
3879
5859
  """To fetch multiple Settings"""
3880
- settings(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): SettingList!
5860
+ settings(
5861
+ """An array of filter conditions to apply to the list query."""
5862
+ filters: [Filter!]
5863
+
5864
+ """Inherited value type for the list query."""
5865
+ inherited: InheritedValueType
5866
+
5867
+ """Pagination options for the list query."""
5868
+ pagination: Pagination
5869
+
5870
+ """Sorting options for the list query."""
5871
+ sortings: [Sorting!]
5872
+ ): SettingList!
3881
5873
 
3882
- """To fetch a StateRegister"""
5874
+ """Fetches a single state register by its ID."""
3883
5875
  stateRegister(id: String!): StateRegister
3884
5876
 
3885
- """To fetch a StateRegister by name"""
5877
+ """Fetches a single state register by its name."""
3886
5878
  stateRegisterByName(name: String!): StateRegister
3887
5879
 
3888
- """To fetch multiple StateRegisters"""
3889
- stateRegisters(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): StateRegisterList!
5880
+ """Fetches a paginated list of state registers."""
5881
+ stateRegisters(
5882
+ """An array of filter conditions to apply to the list query."""
5883
+ filters: [Filter!]
3890
5884
 
3891
- """To fetch a step"""
5885
+ """Inherited value type for the list query."""
5886
+ inherited: InheritedValueType
5887
+
5888
+ """Pagination options for the list query."""
5889
+ pagination: Pagination
5890
+
5891
+ """Sorting options for the list query."""
5892
+ sortings: [Sorting!]
5893
+ ): StateRegisterList!
5894
+
5895
+ """Fetches a single scenario step by its name."""
3892
5896
  step(name: String!): Step!
3893
5897
 
3894
- """To fetch multiple steps"""
3895
- steps(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): StepList!
5898
+ """Fetches a paginated list of scenario steps."""
5899
+ steps(
5900
+ """An array of filter conditions to apply to the list query."""
5901
+ filters: [Filter!]
5902
+
5903
+ """Inherited value type for the list query."""
5904
+ inherited: InheritedValueType
3896
5905
 
3897
- """To fetch a task-type"""
5906
+ """Pagination options for the list query."""
5907
+ pagination: Pagination
5908
+
5909
+ """Sorting options for the list query."""
5910
+ sortings: [Sorting!]
5911
+ ): StepList!
5912
+
5913
+ """Fetches a single task type by its name."""
3898
5914
  taskType(name: String!): TaskType!
3899
5915
 
3900
- """To fetch multiple task-type"""
5916
+ """Fetches a list of all available task types."""
3901
5917
  taskTypes: TaskTypeList!
3902
5918
 
3903
- """To fetch the connector from a task-type"""
5919
+ """
5920
+ Fetches a list of task types that are compatible with a specific connection.
5921
+ """
3904
5922
  taskTypesByConnection(connectionName: String!): TaskTypeList!
3905
5923
 
3906
5924
  """To fetch multiple Terminologies"""
3907
- terminologies(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): TerminologyList!
5925
+ terminologies(
5926
+ """An array of filter conditions to apply to the list query."""
5927
+ filters: [Filter!]
5928
+
5929
+ """Inherited value type for the list query."""
5930
+ inherited: InheritedValueType
5931
+
5932
+ """Pagination options for the list query."""
5933
+ pagination: Pagination
5934
+
5935
+ """Sorting options for the list query."""
5936
+ sortings: [Sorting!]
5937
+ ): TerminologyList!
3908
5938
 
3909
5939
  """To fetch a Terminology"""
3910
5940
  terminology(id: String!): Terminology!
3911
5941
 
3912
- """To fetch a Theme"""
5942
+ """Finds a single theme by its ID."""
3913
5943
  theme(id: String!): Theme
3914
5944
 
3915
- """To fetch multiple Themes"""
3916
- themes(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): ThemeList!
5945
+ """Retrieves a paginated list of themes."""
5946
+ themes(
5947
+ """An array of filter conditions to apply to the list query."""
5948
+ filters: [Filter!]
5949
+
5950
+ """Inherited value type for the list query."""
5951
+ inherited: InheritedValueType
5952
+
5953
+ """Pagination options for the list query."""
5954
+ pagination: Pagination
5955
+
5956
+ """Sorting options for the list query."""
5957
+ sortings: [Sorting!]
5958
+ ): ThemeList!
3917
5959
 
3918
5960
  """Fetches a user by their email address within the current domain."""
3919
- user(email: EmailAddress!): User!
5961
+ user(
5962
+ """The email address of the user to fetch."""
5963
+ email: EmailAddress!
5964
+ ): User!
3920
5965
 
3921
5966
  """To fetch Menus by role"""
3922
5967
  userMenus: [Menu!]!
@@ -3927,7 +5972,19 @@ type Query {
3927
5972
  """
3928
5973
  Fetches a list of users based on provided search parameters within the current domain.
3929
5974
  """
3930
- users(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): UserList!
5975
+ users(
5976
+ """An array of filter conditions to apply to the list query."""
5977
+ filters: [Filter!]
5978
+
5979
+ """Inherited value type for the list query."""
5980
+ inherited: InheritedValueType
5981
+
5982
+ """Pagination options for the list query."""
5983
+ pagination: Pagination
5984
+
5985
+ """Sorting options for the list query."""
5986
+ sortings: [Sorting!]
5987
+ ): UserList!
3931
5988
  vendors: [Domain!]!
3932
5989
  }
3933
5990
 
@@ -3937,120 +5994,286 @@ type RecipientItem {
3937
5994
  value: String
3938
5995
  }
3939
5996
 
5997
+ """
5998
+ A role that groups a set of privileges, which can be assigned to users.
5999
+ """
3940
6000
  type Role {
6001
+ """The timestamp when the role was created."""
3941
6002
  createdAt: DateTimeISO
6003
+
6004
+ """The user who created the role."""
3942
6005
  creator: User
6006
+
6007
+ """A description of the role."""
3943
6008
  description: String
6009
+
6010
+ """The domain to which the role belongs."""
3944
6011
  domain: Domain!
6012
+
6013
+ """Unique identifier for the role."""
3945
6014
  id: ID!
6015
+
6016
+ """The name of the role."""
3946
6017
  name: String
6018
+
6019
+ """Privileges granted by this role."""
3947
6020
  privileges: [Privilege!]
6021
+
6022
+ """The timestamp when the role was last updated."""
3948
6023
  updatedAt: DateTimeISO
6024
+
6025
+ """The user who last updated the role."""
3949
6026
  updater: User
6027
+
6028
+ """Users who are assigned this role."""
3950
6029
  users: [User!]
3951
6030
  }
3952
6031
 
6032
+ """A brief summary of a role, containing only the ID and name."""
6033
+ type RoleBrief {
6034
+ """The unique identifier of the role."""
6035
+ id: String
6036
+
6037
+ """The name of the role."""
6038
+ name: String
6039
+ }
6040
+
6041
+ """A paginated list of roles."""
3953
6042
  type RoleList {
6043
+ """The list of role items."""
3954
6044
  items: [Role!]
6045
+
6046
+ """The total number of roles."""
3955
6047
  total: Int
3956
6048
  }
3957
6049
 
6050
+ """Input for updating (patching) an existing role."""
3958
6051
  input RolePatch {
6052
+ """
6053
+ A flag indicating whether the role is being created, updated, or deleted.
6054
+ """
3959
6055
  cuFlag: String
6056
+
6057
+ """The new description for the role."""
3960
6058
  description: String
6059
+
6060
+ """The unique identifier of the role to update."""
3961
6061
  id: String
6062
+
6063
+ """The new name for the role."""
3962
6064
  name: String
6065
+
6066
+ """A new list of privileges to be granted by the role."""
3963
6067
  privileges: [ObjectRef!]
6068
+
6069
+ """A new list of users to be assigned to the role."""
3964
6070
  users: [ObjectRef!]
3965
6071
  }
3966
6072
 
6073
+ """Represents a privilege and whether it is assigned to a specific role."""
3967
6074
  type RolePrivilege {
6075
+ """Indicates whether the privilege is assigned to the role."""
3968
6076
  assigned: Boolean
6077
+
6078
+ """The category of the privilege."""
3969
6079
  category: String
6080
+
6081
+ """A description of the privilege."""
3970
6082
  description: String
6083
+
6084
+ """The unique identifier of the privilege."""
3971
6085
  id: String
6086
+
6087
+ """The name of the privilege."""
3972
6088
  name: String
3973
6089
  }
3974
6090
 
6091
+ """Represents a sequence of steps designed to automate a task or process."""
3975
6092
  type Scenario {
3976
- """[will be deprecated] automatically be started when this server start"""
6093
+ """
6094
+ Indicates if the scenario should be automatically started when the server starts. [will be deprecated]
6095
+ """
3977
6096
  active: Boolean
3978
6097
  connectionNames: [Connection!]!
6098
+
6099
+ """The timestamp when the scenario was created."""
3979
6100
  createdAt: DateTimeISO
6101
+
6102
+ """The user who created the scenario."""
3980
6103
  creator: User
6104
+
6105
+ """A detailed description of the scenario."""
3981
6106
  description: String
6107
+
6108
+ """The domain to which this scenario belongs."""
3982
6109
  domain: Domain!
6110
+
6111
+ """Unique identifier for the scenario."""
3983
6112
  id: ID!
3984
6113
  instances: [ScenarioInstance!]
6114
+
6115
+ """The name of the scenario."""
3985
6116
  name: String!
6117
+
6118
+ """Privilege required to execute the scenario."""
3986
6119
  privilege: PrivilegeObject
3987
6120
 
3988
- """accessible and executable system-wide"""
6121
+ """Indicates if the scenario is accessible and executable system-wide."""
3989
6122
  public: Boolean
3990
6123
  publishTags: [Connection!]!
6124
+
6125
+ """Role required to execute the scenario."""
3991
6126
  role: Role
6127
+
6128
+ """A cron-style schedule for running the scenario automatically."""
3992
6129
  schedule: String
6130
+
6131
+ """The ID of the scheduled job, if any."""
3993
6132
  scheduleId: String
3994
6133
  state: String
6134
+
6135
+ """The sequence of steps that make up the scenario."""
3995
6136
  steps: [Step!]
6137
+
6138
+ """The timezone for the schedule."""
3996
6139
  timezone: String
6140
+
6141
+ """Time-to-live in seconds for scenario instances."""
3997
6142
  ttl: Float
6143
+
6144
+ """The type of the scenario, used for categorization."""
3998
6145
  type: String
6146
+
6147
+ """The timestamp when the scenario was last updated."""
3999
6148
  updatedAt: DateTimeISO
6149
+
6150
+ """The user who last updated the scenario."""
4000
6151
  updater: User
4001
6152
  }
4002
6153
 
6154
+ """Represents a running or completed instance of a scenario."""
4003
6155
  type ScenarioInstance {
6156
+ """A key-value map of data generated and used by the instance."""
4004
6157
  data: Object
6158
+
6159
+ """The domain in which the instance is running."""
4005
6160
  domain: Domain
6161
+
6162
+ """The unique name for this specific instance of the scenario."""
4006
6163
  instanceName: String
6164
+
6165
+ """A message associated with the current state (e.g., an error message)."""
4007
6166
  message: String
6167
+
6168
+ """The current progress of the instance."""
4008
6169
  progress: ScenarioInstanceProgress
6170
+
6171
+ """The final result of the scenario run."""
4009
6172
  result: Object
6173
+
6174
+ """The root scenario instance if this is a sub-scenario."""
4010
6175
  root: ScenarioInstance
6176
+
6177
+ """The name of the scenario being executed."""
4011
6178
  scenarioName: String
6179
+
6180
+ """The current execution state of the instance."""
4012
6181
  state: String
6182
+
6183
+ """The timestamp of the last update."""
4013
6184
  timestamp: DateTimeISO
6185
+
6186
+ """The user who initiated the instance."""
4014
6187
  user: User
6188
+
6189
+ """A key-value map of variables used in the instance."""
4015
6190
  variables: Object
4016
6191
  }
4017
6192
 
6193
+ """A paginated list of scenario instances."""
4018
6194
  type ScenarioInstanceList {
6195
+ """The list of scenario instance items."""
4019
6196
  items: [ScenarioInstance!]!
6197
+
6198
+ """The total number of scenario instances."""
4020
6199
  total: Int!
4021
6200
  }
4022
6201
 
6202
+ """Provides progress information for a running scenario instance."""
4023
6203
  type ScenarioInstanceProgress {
6204
+ """The completion rate of the scenario as a percentage."""
4024
6205
  rate: Int!
6206
+
6207
+ """The number of rounds the scenario has completed."""
4025
6208
  rounds: Int!
6209
+
6210
+ """The current step number being executed."""
4026
6211
  step: Int!
6212
+
6213
+ """The total number of steps in the scenario."""
4027
6214
  steps: Int!
4028
6215
  }
4029
6216
 
6217
+ """Contains the final result of a completed scenario instance run."""
4030
6218
  type ScenarioInstanceRunResult {
6219
+ """The final set of data after the run."""
4031
6220
  data: Object
6221
+
6222
+ """The unique name of the instance that was run."""
4032
6223
  instanceName: String
6224
+
6225
+ """A final message from the run (e.g., success or failure reason)."""
4033
6226
  message: String
6227
+
6228
+ """The final result returned by the scenario."""
4034
6229
  result: Object
6230
+
6231
+ """The name of the scenario that was executed."""
4035
6232
  scenarioName: String
6233
+
6234
+ """The final state of the instance after the run."""
4036
6235
  state: String
6236
+
6237
+ """The timestamp when the run completed."""
4037
6238
  timestamp: DateTimeISO
6239
+
6240
+ """The final set of variables after the run."""
4038
6241
  variables: Object
4039
6242
  }
4040
6243
 
6244
+ """
6245
+ Represents the complete state of a scenario instance at a point in time.
6246
+ """
4041
6247
  type ScenarioInstanceState {
6248
+ """A key-value map of data generated and used by the instance."""
4042
6249
  data: Object
6250
+
6251
+ """The domain in which the instance is running."""
4043
6252
  domain: Domain
6253
+
6254
+ """The unique name of this specific instance."""
4044
6255
  instanceName: String
6256
+
6257
+ """A message associated with the current state (e.g., an error message)."""
4045
6258
  message: String
6259
+
6260
+ """The progress of the running instance."""
4046
6261
  progress: ScenarioInstanceProgress
6262
+
6263
+ """The name of the scenario being executed."""
4047
6264
  scenarioName: String
6265
+
6266
+ """The current execution state of the instance."""
4048
6267
  state: ScenarioInstanceStatus
6268
+
6269
+ """The timestamp when this state was recorded."""
4049
6270
  timestamp: DateTimeISO
6271
+
6272
+ """A key-value map of variables used in the instance."""
4050
6273
  variables: Object
4051
6274
  }
4052
6275
 
4053
- """state enumeration of a scenario-instance"""
6276
+ """Enumeration of possible states for a scenario instance."""
4054
6277
  enum ScenarioInstanceStatus {
4055
6278
  HALTED
4056
6279
  READY
@@ -4059,27 +6282,59 @@ enum ScenarioInstanceStatus {
4059
6282
  UNLOADED
4060
6283
  }
4061
6284
 
6285
+ """A paginated list of scenarios."""
4062
6286
  type ScenarioList {
6287
+ """The list of scenario items."""
4063
6288
  items: [Scenario!]!
6289
+
6290
+ """The total number of scenarios."""
4064
6291
  total: Int!
4065
6292
  }
4066
6293
 
6294
+ """Input for updating (patching) an existing scenario."""
4067
6295
  input ScenarioPatch {
6296
+ """The new active status for the scenario."""
4068
6297
  active: Boolean
6298
+
6299
+ """
6300
+ A flag indicating whether the scenario is being created, updated, or deleted.
6301
+ """
4069
6302
  cuFlag: String
6303
+
6304
+ """The new description for the scenario."""
4070
6305
  description: String
6306
+
6307
+ """The unique identifier of the scenario to update."""
4071
6308
  id: ID
6309
+
6310
+ """The new name for the scenario."""
4072
6311
  name: String
6312
+
6313
+ """The new role for the scenario."""
4073
6314
  role: ObjectRef
6315
+
6316
+ """The new schedule for the scenario."""
4074
6317
  schedule: String
6318
+
6319
+ """A list of steps to be updated within the scenario."""
4075
6320
  steps: [StepPatch!]
6321
+
6322
+ """The new timezone for the scenario."""
4076
6323
  timezone: String
6324
+
6325
+ """The new time-to-live for scenario instances."""
4077
6326
  ttl: Float
6327
+
6328
+ """The new type for the scenario."""
4078
6329
  type: String
4079
6330
  }
4080
6331
 
6332
+ """Represents the state of a scenario queue for a specific domain."""
4081
6333
  type ScenarioQueueState {
6334
+ """The domain to which this queue state belongs."""
4082
6335
  domain: Domain!
6336
+
6337
+ """The list of pending items in the queue."""
4083
6338
  queue: [PendingObject!]!
4084
6339
  }
4085
6340
 
@@ -4186,17 +6441,18 @@ input SettingPatch {
4186
6441
  value: String
4187
6442
  }
4188
6443
 
6444
+ """Input type for specifying sorting options in a list query."""
4189
6445
  input Sorting {
4190
- """
4191
- Set to true if descending sort. Default is "false"
4192
- """
6446
+ """Set to true for descending order. Default is false (ascending)."""
4193
6447
  desc: Boolean
4194
6448
 
4195
- """Field name to sort by"""
6449
+ """The field name to sort the results by."""
4196
6450
  name: String!
4197
6451
  }
4198
6452
 
4199
- """Entity for StateRegister"""
6453
+ """
6454
+ Represents a key-value store for maintaining the state of various entities within a domain.
6455
+ """
4200
6456
  type StateRegister {
4201
6457
  """Creation time of the state register"""
4202
6458
  createdAt: DateTimeISO
@@ -4218,6 +6474,8 @@ type StateRegister {
4218
6474
 
4219
6475
  """Group name for the state register"""
4220
6476
  group: String
6477
+
6478
+ """Unique identifier for the state register."""
4221
6479
  id: ID!
4222
6480
 
4223
6481
  """Name of the state register"""
@@ -4262,6 +6520,7 @@ type StateRegister {
4262
6520
  wroteAt: DateTimeISO
4263
6521
  }
4264
6522
 
6523
+ """A paginated list of state registers."""
4265
6524
  type StateRegisterList {
4266
6525
  """List of state registers"""
4267
6526
  items: [StateRegister!]!
@@ -4270,6 +6529,7 @@ type StateRegisterList {
4270
6529
  total: Int!
4271
6530
  }
4272
6531
 
6532
+ """Input for updating (patching) an existing state register."""
4273
6533
  input StateRegisterPatch {
4274
6534
  """Flag indicating create/update operations"""
4275
6535
  cuFlag: String
@@ -4307,70 +6567,157 @@ input StateRegisterPatch {
4307
6567
  unit: String
4308
6568
  }
4309
6569
 
6570
+ """
6571
+ Represents a single step within a scenario, defining a specific task to be executed.
6572
+ """
4310
6573
  type Step {
6574
+ """The name of the connection to be used for this step."""
4311
6575
  connection: String
6576
+
6577
+ """The timestamp when the step was created."""
4312
6578
  createdAt: DateTimeISO
6579
+
6580
+ """The user who created this step."""
4313
6581
  creator: User
6582
+
6583
+ """A detailed description of what the step involves."""
4314
6584
  description: String
6585
+
6586
+ """The domain to which this step belongs."""
4315
6587
  domain: Domain
6588
+
6589
+ """The unique identifier for the step."""
4316
6590
  id: ID!
6591
+
6592
+ """Indicates if the step execution should be logged."""
4317
6593
  log: Boolean
6594
+
6595
+ """The name of the step."""
4318
6596
  name: String!
6597
+
6598
+ """A key-value map of parameters for the step task."""
4319
6599
  params: Object
4320
6600
 
4321
6601
  """
4322
- A boolean attribute indicating the inclusion status of an element in the result
6602
+ A boolean attribute indicating whether the result of this step should be included in the final output.
4323
6603
  """
4324
6604
  result: Boolean
6605
+
6606
+ """The scenario that includes this step."""
4325
6607
  scenario: Scenario
6608
+
6609
+ """The sequence number of the step within its scenario."""
4326
6610
  sequence: Float
6611
+
6612
+ """Indicates if the step should be skipped during execution."""
4327
6613
  skip: Boolean
6614
+
6615
+ """The specific task type associated with this step."""
4328
6616
  task: String
6617
+
6618
+ """The timestamp when the step was last updated."""
4329
6619
  updatedAt: DateTimeISO
6620
+
6621
+ """The user who last updated this step."""
4330
6622
  updater: User
4331
6623
  }
4332
6624
 
6625
+ """A paginated list of steps."""
4333
6626
  type StepList {
6627
+ """The list of step items."""
4334
6628
  items: [Step!]!
6629
+
6630
+ """The total number of steps."""
4335
6631
  total: Int!
4336
6632
  }
4337
6633
 
6634
+ """Input for updating (patching) an existing step."""
4338
6635
  input StepPatch {
6636
+ """The new connection for the step."""
4339
6637
  connection: String
6638
+
6639
+ """
6640
+ A flag indicating whether the step is being created, updated, or deleted.
6641
+ """
4340
6642
  cuFlag: String
6643
+
6644
+ """The new description for the step."""
4341
6645
  description: String
6646
+
6647
+ """The unique identifier of the step to update."""
4342
6648
  id: ID
6649
+
6650
+ """The new log status for the step."""
4343
6651
  log: Boolean
6652
+
6653
+ """The new name for the step."""
4344
6654
  name: String
6655
+
6656
+ """The new parameters for the step."""
4345
6657
  params: Object
6658
+
6659
+ """The new result inclusion status for the step."""
4346
6660
  result: Boolean
6661
+
6662
+ """The new sequence number for the step."""
4347
6663
  sequence: Int
6664
+
6665
+ """The new skip status for the step."""
4348
6666
  skip: Boolean
6667
+
6668
+ """The new task type for the step."""
4349
6669
  task: String
4350
6670
  }
4351
6671
 
4352
6672
  type Subscription {
6673
+ """Subscribes to real-time updates for a specific board."""
4353
6674
  board(id: String!): Board!
6675
+
6676
+ """Subscribes to log messages from connections."""
4354
6677
  connectionLog(level: String): Log!
6678
+
6679
+ """Subscribes to the state changes of connections."""
4355
6680
  connectionState(name: String): ConnectionState!
4356
6681
  data(tag: String!): Data!
4357
6682
  notification(subjects: [String!]): Notification!
6683
+
6684
+ """Subscribes to real-time updates for a specific play group."""
4358
6685
  playGroup(id: String!): PlayGroup!
6686
+
6687
+ """Subscribes to log messages from scenario instances."""
4359
6688
  scenarioInstanceLog(instanceName: String, level: String, scenarioName: String): Log!
6689
+
6690
+ """Subscribes to state changes from scenario instances."""
4360
6691
  scenarioInstanceState(instanceName: String, scenarioName: String): ScenarioInstanceState!
6692
+
6693
+ """Subscribes to changes in the scenario queue."""
4361
6694
  scenarioQueueState: ScenarioQueueState!
4362
6695
  }
4363
6696
 
6697
+ """Describes a type of task that can be used in a scenario."""
4364
6698
  type TaskType {
6699
+ """Indicates whether this task type can be used without a connector."""
4365
6700
  connectorFree: Boolean
6701
+
6702
+ """A brief description of what the task does."""
4366
6703
  description: String
6704
+
6705
+ """A URL or text providing more detailed help information."""
4367
6706
  help: String
6707
+
6708
+ """The unique name of the task type."""
4368
6709
  name: String!
6710
+
6711
+ """A list of parameters that can be configured for this task type."""
4369
6712
  parameterSpec: [PropertySpec!]
4370
6713
  }
4371
6714
 
6715
+ """A paginated list of task types."""
4372
6716
  type TaskTypeList {
6717
+ """The list of task type items."""
4373
6718
  items: [TaskType!]!
6719
+
6720
+ """The total number of task types."""
4374
6721
  total: Int!
4375
6722
  }
4376
6723
 
@@ -4404,34 +6751,79 @@ input TerminologyPatch {
4404
6751
  name: String
4405
6752
  }
4406
6753
 
4407
- """Entity for Theme"""
6754
+ """
6755
+ Represents a visual theme or style that can be applied to dashboard components.
6756
+ """
4408
6757
  type Theme {
6758
+ """Indicates whether the theme is currently active and available for use."""
4409
6759
  active: Boolean
6760
+
6761
+ """The timestamp when the theme was created."""
4410
6762
  createdAt: DateTimeISO
6763
+
6764
+ """The user who created the theme."""
4411
6765
  creator: User
6766
+
6767
+ """The timestamp when the theme was soft-deleted."""
4412
6768
  deletedAt: DateTimeISO
6769
+
6770
+ """A detailed description of the theme."""
4413
6771
  description: String
6772
+
6773
+ """The domain to which this theme belongs."""
4414
6774
  domain: Domain!
6775
+
6776
+ """Unique identifier for the theme."""
4415
6777
  id: ID!
6778
+
6779
+ """The name of the theme."""
4416
6780
  name: String
6781
+
6782
+ """The type of the theme (e.g., Legend)."""
4417
6783
  type: String
6784
+
6785
+ """The timestamp when the theme was last updated."""
4418
6786
  updatedAt: DateTimeISO
6787
+
6788
+ """The user who last updated the theme."""
4419
6789
  updater: User
6790
+
6791
+ """A JSON object containing the theme-specific style values."""
4420
6792
  value: Object
4421
6793
  }
4422
6794
 
6795
+ """A paginated list of themes."""
4423
6796
  type ThemeList {
6797
+ """The list of theme items."""
4424
6798
  items: [Theme!]!
6799
+
6800
+ """The total number of themes."""
4425
6801
  total: Int!
4426
6802
  }
4427
6803
 
6804
+ """Input for updating (patching) an existing theme."""
4428
6805
  input ThemePatch {
6806
+ """The new active status for the theme."""
4429
6807
  active: Boolean
6808
+
6809
+ """
6810
+ A flag indicating whether the theme is being created, updated, or deleted.
6811
+ """
4430
6812
  cuFlag: String
6813
+
6814
+ """The new description for the theme."""
4431
6815
  description: String
6816
+
6817
+ """The unique identifier of the theme to update."""
4432
6818
  id: ID
6819
+
6820
+ """The new name for the theme."""
4433
6821
  name: String
6822
+
6823
+ """The new type for the theme."""
4434
6824
  type: String
6825
+
6826
+ """The new JSON object of style values for the theme."""
4435
6827
  value: Object
4436
6828
  }
4437
6829
 
@@ -4443,42 +6835,106 @@ type UploadURL {
4443
6835
  url: String!
4444
6836
  }
4445
6837
 
6838
+ """
6839
+ Represents a user account in the system, including authentication, roles, and domain associations.
6840
+ """
4446
6841
  type User {
6842
+ """Timestamp when the user account was created."""
4447
6843
  createdAt: DateTimeISO
6844
+
6845
+ """User who created this user account."""
4448
6846
  creator: User
6847
+
6848
+ """Optional description or note about the user."""
4449
6849
  description: String
6850
+
6851
+ """Domains (organizations, companies, etc.) the user belongs to."""
4450
6852
  domains: [Domain!]!
6853
+
6854
+ """Email address of the user."""
4451
6855
  email: EmailAddress!
6856
+
6857
+ """Unique identifier for the user."""
4452
6858
  id: ID!
6859
+
6860
+ """Locale or language preference for the user."""
4453
6861
  locale: String
6862
+
6863
+ """Full name of the user."""
4454
6864
  name: String
6865
+
6866
+ """Whether the user is the owner of the domain (not persisted in DB)."""
4455
6867
  owner: Boolean
6868
+
6869
+ """Reference information for the user (external system, etc.)."""
4456
6870
  reference: String
6871
+
6872
+ """Roles assigned to the user."""
4457
6873
  roles: [Role!]!
6874
+
6875
+ """Single sign-on (SSO) identifier for federated authentication."""
4458
6876
  ssoId: String
6877
+
6878
+ """Current status of the user account."""
4459
6879
  status: String!
6880
+
6881
+ """Timestamp when the user account was last updated."""
4460
6882
  updatedAt: DateTimeISO
6883
+
6884
+ """User who last updated this user account."""
4461
6885
  updater: User
6886
+
6887
+ """Type or category of the user (e.g., user, application, appliance)."""
4462
6888
  userType: String
6889
+
6890
+ """Unique username for the user."""
4463
6891
  username: String
6892
+
6893
+ """External authentication providers linked to the user."""
4464
6894
  usersAuthProviders: [UsersAuthProviders!]
4465
6895
  }
4466
6896
 
6897
+ """A paginated list of users and the total count."""
4467
6898
  type UserList {
6899
+ """List of user objects."""
4468
6900
  items: [User!]
6901
+
6902
+ """Total number of users matching the query."""
4469
6903
  total: Int
4470
6904
  }
4471
6905
 
6906
+ """Input type for updating (patching) an existing user account."""
4472
6907
  input UserPatch {
6908
+ """
6909
+ Change flag for tracking updates (e.g., C/U/D for create/update/delete).
6910
+ """
4473
6911
  cuFlag: String
6912
+
6913
+ """Optional description or note about the user."""
4474
6914
  description: String
6915
+
6916
+ """Domains associated with the user."""
4475
6917
  domains: [ObjectRef!]
6918
+
6919
+ """Email address of the user."""
4476
6920
  email: EmailAddress
6921
+
6922
+ """Unique identifier of the user to update."""
4477
6923
  id: ID
6924
+
6925
+ """Full name of the user."""
4478
6926
  name: String
6927
+
6928
+ """Password for the user account."""
4479
6929
  password: String
6930
+
6931
+ """Roles assigned to the user."""
4480
6932
  roles: [ObjectRef!]
6933
+
6934
+ """Status of the user account (e.g., active, inactive)."""
4481
6935
  status: String
6936
+
6937
+ """Type or category of the user (e.g., admin, operator, guest)."""
4482
6938
  userType: String
4483
6939
  }
4484
6940
 
@@ -4508,21 +6964,46 @@ input UserPreferencePatch {
4508
6964
  user: ObjectRef!
4509
6965
  }
4510
6966
 
6967
+ """Represents a role and whether it is assigned to a specific user."""
4511
6968
  type UserRole {
6969
+ """Indicates whether the role is assigned to the user."""
4512
6970
  assigned: Boolean
6971
+
6972
+ """A description of the role."""
4513
6973
  description: String
6974
+
6975
+ """The unique identifier of the role."""
4514
6976
  id: String
6977
+
6978
+ """The name of the role."""
4515
6979
  name: String
4516
6980
  }
4517
6981
 
4518
- """Entity for UsersAuthProviders"""
6982
+ """
6983
+ Represents the link between a user and an external authentication provider.
6984
+ """
4519
6985
  type UsersAuthProviders {
6986
+ """The authentication provider associated with this link."""
4520
6987
  authProvider: AuthProvider
6988
+
6989
+ """The timestamp when this link was created."""
4521
6990
  createdAt: DateTimeISO
6991
+
6992
+ """The domain to which this link belongs."""
4522
6993
  domain: Domain!
6994
+
6995
+ """Unique identifier for the user-provider link."""
4523
6996
  id: ID!
6997
+
6998
+ """
6999
+ The unique identifier for the user from the external provider (SSO ID).
7000
+ """
4524
7001
  ssoId: String
7002
+
7003
+ """The timestamp when this link was last updated."""
4525
7004
  updatedAt: DateTimeISO
7005
+
7006
+ """The user associated with this link."""
4526
7007
  user: User
4527
7008
  }
4528
7009