graphlit-client 1.0.20251217002 → 1.0.20251220002

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/dist/client.js CHANGED
@@ -406,12 +406,28 @@ class Graphlit {
406
406
  };
407
407
  this.token = jwt.sign(payload, this.jwtSecret, { algorithm: "HS256" });
408
408
  }
409
+ /**
410
+ * Fetch current project.
411
+ * @returns The project.
412
+ */
409
413
  async getProject() {
410
414
  return this.queryAndCheckError(Documents.GetProject, {});
411
415
  }
416
+ /**
417
+ * Updates a project.
418
+ * @param project - The project to update.
419
+ * @returns The updated project.
420
+ */
412
421
  async updateProject(project) {
413
422
  return this.mutateAndCheckError(Documents.UpdateProject, { project: project });
414
423
  }
424
+ /**
425
+ * Lookup usage records given tenant correlation identifier.
426
+ * @param correlationId - The tenant correlation identifier.
427
+ * @param startDate - The start date of records to be returned, optional. Defaults to last 30 days.
428
+ * @param duration - The duration of records to be returned, optional. Defaults to last 30 days.
429
+ * @returns The project usage records.
430
+ */
415
431
  async lookupProjectUsage(correlationId, startDate, duration) {
416
432
  return this.queryAndCheckError(Documents.LookupUsage, {
417
433
  correlationId: correlationId,
@@ -419,6 +435,13 @@ class Graphlit {
419
435
  duration: duration,
420
436
  });
421
437
  }
438
+ /**
439
+ * Lookup credit usage given tenant correlation identifier.
440
+ * @param correlationId - The tenant correlation identifier.
441
+ * @param startDate - The start date of records to be returned, optional. Defaults to last 30 days.
442
+ * @param duration - The duration of records to be returned, optional. Defaults to last 30 days.
443
+ * @returns The project credits.
444
+ */
422
445
  async lookupProjectCredits(correlationId, startDate, duration) {
423
446
  return this.queryAndCheckError(Documents.LookupCredits, {
424
447
  correlationId: correlationId,
@@ -426,9 +449,25 @@ class Graphlit {
426
449
  duration: duration,
427
450
  });
428
451
  }
452
+ /**
453
+ * Retrieves project tokens.
454
+ * @param startDate - The start date of tokens to be returned.
455
+ * @param duration - The duration of tokens to be returned.
456
+ * @returns The project tokens.
457
+ */
429
458
  async queryProjectTokens(startDate, duration) {
430
459
  return this.queryAndCheckError(Documents.QueryTokens, { startDate: startDate, duration: duration });
431
460
  }
461
+ /**
462
+ * Retrieves project usage.
463
+ * @param startDate - The start date of records to be returned.
464
+ * @param duration - The duration of records to be returned.
465
+ * @param names - Filter by allowed usage record names, defaults to 'GraphQL'.
466
+ * @param excludedNames - Filter by excluded usage record names.
467
+ * @param offset - The offset to the records to be returned, defaults to 0.
468
+ * @param limit - The number of records to be returned, defaults to 1000.
469
+ * @returns The project usage records.
470
+ */
432
471
  async queryProjectUsage(startDate, duration, names, excludedNames, offset, limit) {
433
472
  return this.queryAndCheckError(Documents.QueryUsage, {
434
473
  startDate: startDate,
@@ -439,9 +478,22 @@ class Graphlit {
439
478
  limit: limit,
440
479
  });
441
480
  }
481
+ /**
482
+ * Retrieves project credits.
483
+ * @param startDate - The start date of credits to be returned.
484
+ * @param duration - The duration of credits to be returned.
485
+ * @returns The project credits.
486
+ */
442
487
  async queryProjectCredits(startDate, duration) {
443
488
  return this.queryAndCheckError(Documents.QueryCredits, { startDate: startDate, duration: duration });
444
489
  }
490
+ /**
491
+ * Sends a notification.
492
+ * @param connector - The integration connector used to send the notification.
493
+ * @param text - The notification text.
494
+ * @param textType - The text type, optional.
495
+ * @returns The result of the notification.
496
+ */
445
497
  async sendNotification(connector, text, textType) {
446
498
  return this.mutateAndCheckError(Documents.SendNotification, {
447
499
  connector: connector,
@@ -449,6 +501,14 @@ class Graphlit {
449
501
  textType: textType,
450
502
  });
451
503
  }
504
+ /**
505
+ * Enumerates the web pages at or beneath the provided URL using web sitemap.
506
+ * @param uri - The URI of the web page to be mapped.
507
+ * @param allowedPaths - The list of regular expressions for URL paths to be crawled, i.e. "^\/public\/blogs\/.*".
508
+ * @param excludedPaths - The list of regular expressions for URL paths to not be crawled, i.e. "^\/internal\/private\/.*".
509
+ * @param correlationId - The tenant correlation identifier, optional.
510
+ * @returns The mapped URIs.
511
+ */
452
512
  async mapWeb(uri, allowedPaths, excludedPaths, correlationId) {
453
513
  return this.queryAndCheckError(Documents.MapWeb, {
454
514
  uri: uri,
@@ -457,6 +517,14 @@ class Graphlit {
457
517
  correlationId: correlationId,
458
518
  });
459
519
  }
520
+ /**
521
+ * Searches the web based on the provided properties.
522
+ * @param text - The web search text.
523
+ * @param service - The web search service type, defaults to Tavily.
524
+ * @param limit - The number of web search results to be returned, defaults to 10.
525
+ * @param correlationId - The tenant correlation identifier, optional.
526
+ * @returns The web search results.
527
+ */
460
528
  async searchWeb(text, service, limit, correlationId) {
461
529
  return this.queryAndCheckError(Documents.SearchWeb, {
462
530
  text: text,
@@ -465,21 +533,55 @@ class Graphlit {
465
533
  correlationId: correlationId,
466
534
  });
467
535
  }
536
+ /**
537
+ * Creates an alert.
538
+ * @param alert - The alert to create.
539
+ * @param correlationId - The tenant correlation identifier, optional.
540
+ * @returns The created alert.
541
+ */
468
542
  async createAlert(alert, correlationId) {
469
543
  return this.mutateAndCheckError(Documents.CreateAlert, { alert: alert, correlationId: correlationId });
470
544
  }
545
+ /**
546
+ * Updates an alert.
547
+ * @param alert - The alert to update.
548
+ * @returns The updated alert.
549
+ */
471
550
  async updateAlert(alert) {
472
551
  return this.mutateAndCheckError(Documents.UpdateAlert, { alert: alert });
473
552
  }
553
+ /**
554
+ * Creates or updates an alert.
555
+ * @param alert - The alert to create or update.
556
+ * @returns The created or updated alert.
557
+ */
474
558
  async upsertAlert(alert) {
475
559
  return this.mutateAndCheckError(Documents.UpsertAlert, { alert: alert });
476
560
  }
561
+ /**
562
+ * Deletes an alert.
563
+ * @param id - The ID of the alert to delete.
564
+ * @returns The deleted alert.
565
+ */
477
566
  async deleteAlert(id) {
478
567
  return this.mutateAndCheckError(Documents.DeleteAlert, { id: id });
479
568
  }
569
+ /**
570
+ * Deletes multiple alerts.
571
+ * @param ids - The IDs of the alerts to delete.
572
+ * @param isSynchronous - Whether this mutation is synchronous.
573
+ * @returns The deleted alerts.
574
+ */
480
575
  async deleteAlerts(ids, isSynchronous) {
481
576
  return this.mutateAndCheckError(Documents.DeleteAlerts, { ids: ids, isSynchronous: isSynchronous });
482
577
  }
578
+ /**
579
+ * Deletes all alerts based on the provided filter criteria.
580
+ * @param filter - The filter criteria to apply when deleting alerts.
581
+ * @param isSynchronous - Whether this mutation is synchronous.
582
+ * @param correlationId - The tenant correlation identifier, optional.
583
+ * @returns The result of the deletion.
584
+ */
483
585
  async deleteAllAlerts(filter, isSynchronous, correlationId) {
484
586
  return this.mutateAndCheckError(Documents.DeleteAllAlerts, {
485
587
  filter: filter,
@@ -487,33 +589,86 @@ class Graphlit {
487
589
  correlationId: correlationId,
488
590
  });
489
591
  }
592
+ /**
593
+ * Enables an alert.
594
+ * @param id - The ID of the alert to enable.
595
+ * @returns The enabled alert.
596
+ */
490
597
  async enableAlert(id) {
491
598
  return this.mutateAndCheckError(Documents.EnableAlert, { id: id });
492
599
  }
600
+ /**
601
+ * Disables an alert.
602
+ * @param id - The ID of the alert to disable.
603
+ * @returns The disabled alert.
604
+ */
493
605
  async disableAlert(id) {
494
606
  return this.mutateAndCheckError(Documents.DisableAlert, { id: id });
495
607
  }
608
+ /**
609
+ * Lookup an alert given its ID.
610
+ * @param id - ID of the alert.
611
+ * @returns The alert.
612
+ */
496
613
  async getAlert(id) {
497
614
  return this.queryAndCheckError(Documents.GetAlert, { id: id });
498
615
  }
616
+ /**
617
+ * Retrieves alerts based on the provided filter criteria.
618
+ * @param filter - The filter criteria to apply when retrieving alerts.
619
+ * @returns The alerts.
620
+ */
499
621
  async queryAlerts(filter) {
500
622
  return this.queryAndCheckError(Documents.QueryAlerts, { filter: filter });
501
623
  }
624
+ /**
625
+ * Counts alerts based on the provided filter criteria.
626
+ * @param filter - The filter criteria to apply when counting alerts.
627
+ * @returns The count of alerts.
628
+ */
502
629
  async countAlerts(filter) {
503
630
  return this.queryAndCheckError(Documents.CountAlerts, { filter: filter });
504
631
  }
632
+ /**
633
+ * Creates a collection.
634
+ * @param collection - The collection to create.
635
+ * @returns The created collection.
636
+ */
505
637
  async createCollection(collection) {
506
638
  return this.mutateAndCheckError(Documents.CreateCollection, { collection: collection });
507
639
  }
640
+ /**
641
+ * Updates a collection.
642
+ * @param collection - The collection to update.
643
+ * @returns The updated collection.
644
+ */
508
645
  async updateCollection(collection) {
509
646
  return this.mutateAndCheckError(Documents.UpdateCollection, { collection: collection });
510
647
  }
648
+ /**
649
+ * Deletes a collection.
650
+ * @param id - The ID of the collection to delete.
651
+ * @returns The deleted collection.
652
+ */
511
653
  async deleteCollection(id) {
512
654
  return this.mutateAndCheckError(Documents.DeleteCollection, { id: id });
513
655
  }
656
+ /**
657
+ * Deletes multiple collections.
658
+ * @param ids - The IDs of the collections to delete.
659
+ * @param isSynchronous - Whether this mutation is synchronous.
660
+ * @returns The deleted collections.
661
+ */
514
662
  async deleteCollections(ids, isSynchronous) {
515
663
  return this.mutateAndCheckError(Documents.DeleteCollections, { ids: ids, isSynchronous: isSynchronous });
516
664
  }
665
+ /**
666
+ * Deletes all collections based on the provided filter criteria.
667
+ * @param filter - The filter criteria to apply when deleting collections.
668
+ * @param isSynchronous - Whether this mutation is synchronous.
669
+ * @param correlationId - The tenant correlation identifier, optional.
670
+ * @returns The result of the deletion.
671
+ */
517
672
  async deleteAllCollections(filter, isSynchronous, correlationId) {
518
673
  return this.mutateAndCheckError(Documents.DeleteAllCollections, {
519
674
  filter: filter,
@@ -521,27 +676,62 @@ class Graphlit {
521
676
  correlationId: correlationId,
522
677
  });
523
678
  }
679
+ /**
680
+ * Adds contents to collections.
681
+ * @param contents - The contents to add.
682
+ * @param collections - The collections to add the contents to.
683
+ * @returns The result of the operation.
684
+ */
524
685
  async addContentsToCollections(contents, collections) {
525
686
  return this.mutateAndCheckError(Documents.AddContentsToCollections, {
526
687
  contents: contents,
527
688
  collections: collections,
528
689
  });
529
690
  }
691
+ /**
692
+ * Removes contents from a collection.
693
+ * @param contents - The contents to remove.
694
+ * @param collection - The collection to remove the contents from.
695
+ * @returns The result of the operation.
696
+ */
530
697
  async removeContentsFromCollection(contents, collection) {
531
698
  return this.mutateAndCheckError(Documents.RemoveContentsFromCollection, {
532
699
  contents: contents,
533
700
  collection: collection,
534
701
  });
535
702
  }
703
+ /**
704
+ * Lookup a collection given its ID.
705
+ * @param id - ID of the collection.
706
+ * @returns The collection.
707
+ */
536
708
  async getCollection(id) {
537
709
  return this.queryAndCheckError(Documents.GetCollection, { id: id });
538
710
  }
711
+ /**
712
+ * Retrieves collections based on the provided filter criteria.
713
+ * @param filter - The filter criteria to apply when retrieving collections.
714
+ * @returns The collections.
715
+ */
539
716
  async queryCollections(filter) {
540
717
  return this.queryAndCheckError(Documents.QueryCollections, { filter: filter });
541
718
  }
719
+ /**
720
+ * Counts collections based on the provided filter criteria.
721
+ * @param filter - The filter criteria to apply when counting collections.
722
+ * @returns The count of collections.
723
+ */
542
724
  async countCollections(filter) {
543
725
  return this.queryAndCheckError(Documents.CountCollections, { filter: filter });
544
726
  }
727
+ /**
728
+ * Describes an image using a multimodal LLM.
729
+ * @param prompt - The prompt to use for describing the image.
730
+ * @param uri - The URI of the image to describe.
731
+ * @param specification - The LLM specification to use, optional.
732
+ * @param correlationId - The tenant correlation identifier, optional.
733
+ * @returns The image description.
734
+ */
545
735
  async describeImage(prompt, uri, specification, correlationId) {
546
736
  return this.mutateAndCheckError(Documents.DescribeImage, {
547
737
  prompt: prompt,
@@ -550,6 +740,15 @@ class Graphlit {
550
740
  correlationId: correlationId,
551
741
  });
552
742
  }
743
+ /**
744
+ * Describes a base64-encoded image using a multimodal LLM.
745
+ * @param prompt - The prompt to use for describing the image.
746
+ * @param mimeType - The MIME type of the image.
747
+ * @param data - The base64-encoded image data.
748
+ * @param specification - The LLM specification to use, optional.
749
+ * @param correlationId - The tenant correlation identifier, optional.
750
+ * @returns The image description.
751
+ */
553
752
  async describeEncodedImage(prompt, mimeType, data, specification, correlationId) {
554
753
  return this.mutateAndCheckError(Documents.DescribeEncodedImage, {
555
754
  prompt: prompt,
@@ -559,6 +758,16 @@ class Graphlit {
559
758
  correlationId: correlationId,
560
759
  });
561
760
  }
761
+ /**
762
+ * Takes a screenshot of a web page.
763
+ * @param uri - The URI of the web page to screenshot.
764
+ * @param maximumHeight - The maximum height of the screenshot, optional.
765
+ * @param isSynchronous - Whether this mutation is synchronous.
766
+ * @param workflow - The workflow to use for processing, optional.
767
+ * @param collections - The collections to add the content to, optional.
768
+ * @param correlationId - The tenant correlation identifier, optional.
769
+ * @returns The screenshot content.
770
+ */
562
771
  async screenshotPage(uri, maximumHeight, isSynchronous, workflow, collections, correlationId) {
563
772
  return this.mutateAndCheckError(Documents.ScreenshotPage, {
564
773
  uri: uri,
@@ -569,6 +778,15 @@ class Graphlit {
569
778
  correlationId: correlationId,
570
779
  });
571
780
  }
781
+ /**
782
+ * Ingests a batch of text contents.
783
+ * @param batch - The batch of text contents to ingest.
784
+ * @param textType - The type of text (plain, markdown, HTML).
785
+ * @param collections - The collections to add the contents to, optional.
786
+ * @param observations - The observations to assign to the contents, optional.
787
+ * @param correlationId - The tenant correlation identifier, optional.
788
+ * @returns The ingested contents.
789
+ */
572
790
  async ingestTextBatch(batch, textType, collections, observations, correlationId) {
573
791
  return this.mutateAndCheckError(Documents.IngestTextBatch, {
574
792
  batch: batch,
@@ -578,6 +796,15 @@ class Graphlit {
578
796
  correlationId: correlationId,
579
797
  });
580
798
  }
799
+ /**
800
+ * Ingests a batch of URIs.
801
+ * @param uris - The URIs to ingest.
802
+ * @param workflow - The workflow to use for processing, optional.
803
+ * @param collections - The collections to add the contents to, optional.
804
+ * @param observations - The observations to assign to the contents, optional.
805
+ * @param correlationId - The tenant correlation identifier, optional.
806
+ * @returns The ingested contents.
807
+ */
581
808
  async ingestBatch(uris, workflow, collections, observations, correlationId) {
582
809
  return this.mutateAndCheckError(Documents.IngestBatch, {
583
810
  uris: uris,
@@ -587,6 +814,19 @@ class Graphlit {
587
814
  correlationId: correlationId,
588
815
  });
589
816
  }
817
+ /**
818
+ * Ingests content from a URI.
819
+ * @param uri - The URI of the content to ingest.
820
+ * @param name - The name of the content, optional.
821
+ * @param id - The ID to assign to the content, optional.
822
+ * @param identifier - The external identifier for the content, optional.
823
+ * @param isSynchronous - Whether this mutation is synchronous.
824
+ * @param workflow - The workflow to use for processing, optional.
825
+ * @param collections - The collections to add the content to, optional.
826
+ * @param observations - The observations to assign to the content, optional.
827
+ * @param correlationId - The tenant correlation identifier, optional.
828
+ * @returns The ingested content.
829
+ */
590
830
  async ingestUri(uri, name, id, identifier, isSynchronous, workflow, collections, observations, correlationId) {
591
831
  return this.mutateAndCheckError(Documents.IngestUri, {
592
832
  uri: uri,
@@ -600,6 +840,21 @@ class Graphlit {
600
840
  correlationId: correlationId,
601
841
  });
602
842
  }
843
+ /**
844
+ * Ingests text content.
845
+ * @param text - The text to ingest.
846
+ * @param name - The name of the content, optional.
847
+ * @param textType - The type of text (plain, markdown, HTML), optional.
848
+ * @param uri - The URI associated with the content, optional.
849
+ * @param id - The ID to assign to the content, optional.
850
+ * @param identifier - The external identifier for the content, optional.
851
+ * @param isSynchronous - Whether this mutation is synchronous.
852
+ * @param workflow - The workflow to use for processing, optional.
853
+ * @param collections - The collections to add the content to, optional.
854
+ * @param observations - The observations to assign to the content, optional.
855
+ * @param correlationId - The tenant correlation identifier, optional.
856
+ * @returns The ingested content.
857
+ */
603
858
  async ingestText(text, name, textType, uri, id, identifier, isSynchronous, workflow, collections, observations, correlationId) {
604
859
  return this.mutateAndCheckError(Documents.IngestText, {
605
860
  name: name,
@@ -615,6 +870,17 @@ class Graphlit {
615
870
  correlationId: correlationId,
616
871
  });
617
872
  }
873
+ /**
874
+ * Ingests a memory (ephemeral text content).
875
+ * @param text - The text to ingest as memory.
876
+ * @param name - The name of the memory, optional.
877
+ * @param textType - The type of text (plain, markdown, HTML), optional.
878
+ * @param id - The ID to assign to the memory, optional.
879
+ * @param identifier - The external identifier for the memory, optional.
880
+ * @param collections - The collections to add the memory to, optional.
881
+ * @param correlationId - The tenant correlation identifier, optional.
882
+ * @returns The ingested memory.
883
+ */
618
884
  async ingestMemory(text, name, textType, id, identifier, collections, correlationId) {
619
885
  return this.mutateAndCheckError(Documents.IngestMemory, {
620
886
  name: name,
@@ -626,6 +892,18 @@ class Graphlit {
626
892
  correlationId: correlationId,
627
893
  });
628
894
  }
895
+ /**
896
+ * Ingests an event.
897
+ * @param markdown - The markdown content of the event.
898
+ * @param name - The name of the event, optional.
899
+ * @param description - The description of the event, optional.
900
+ * @param eventDate - The date of the event, optional.
901
+ * @param id - The ID to assign to the event, optional.
902
+ * @param identifier - The external identifier for the event, optional.
903
+ * @param collections - The collections to add the event to, optional.
904
+ * @param correlationId - The tenant correlation identifier, optional.
905
+ * @returns The ingested event.
906
+ */
629
907
  async ingestEvent(markdown, name, description, eventDate, id, identifier, collections, correlationId) {
630
908
  return this.mutateAndCheckError(Documents.IngestEvent, {
631
909
  name: name,
@@ -638,6 +916,22 @@ class Graphlit {
638
916
  correlationId: correlationId,
639
917
  });
640
918
  }
919
+ /**
920
+ * Ingests a base64-encoded file.
921
+ * @param name - The name of the file.
922
+ * @param data - The base64-encoded file data.
923
+ * @param mimeType - The MIME type of the file.
924
+ * @param fileCreationDate - The file creation date, optional.
925
+ * @param fileModifiedDate - The file modified date, optional.
926
+ * @param id - The ID to assign to the content, optional.
927
+ * @param identifier - The external identifier for the content, optional.
928
+ * @param isSynchronous - Whether this mutation is synchronous.
929
+ * @param workflow - The workflow to use for processing, optional.
930
+ * @param collections - The collections to add the content to, optional.
931
+ * @param observations - The observations to assign to the content, optional.
932
+ * @param correlationId - The tenant correlation identifier, optional.
933
+ * @returns The ingested content.
934
+ */
641
935
  async ingestEncodedFile(name, data, mimeType, fileCreationDate, fileModifiedDate, id, identifier, isSynchronous, workflow, collections, observations, correlationId) {
642
936
  return this.mutateAndCheckError(Documents.IngestEncodedFile, {
643
937
  name: name,
@@ -654,15 +948,38 @@ class Graphlit {
654
948
  correlationId: correlationId,
655
949
  });
656
950
  }
951
+ /**
952
+ * Updates content.
953
+ * @param content - The content to update.
954
+ * @returns The updated content.
955
+ */
657
956
  async updateContent(content) {
658
957
  return this.mutateAndCheckError(Documents.UpdateContent, { content: content });
659
958
  }
959
+ /**
960
+ * Deletes content.
961
+ * @param id - The ID of the content to delete.
962
+ * @returns The deleted content.
963
+ */
660
964
  async deleteContent(id) {
661
965
  return this.mutateAndCheckError(Documents.DeleteContent, { id: id });
662
966
  }
967
+ /**
968
+ * Deletes multiple contents.
969
+ * @param ids - The IDs of the contents to delete.
970
+ * @param isSynchronous - Whether this mutation is synchronous.
971
+ * @returns The deleted contents.
972
+ */
663
973
  async deleteContents(ids, isSynchronous) {
664
974
  return this.mutateAndCheckError(Documents.DeleteContents, { ids: ids, isSynchronous: isSynchronous });
665
975
  }
976
+ /**
977
+ * Deletes all contents based on the provided filter criteria.
978
+ * @param filter - The filter criteria to apply when deleting contents.
979
+ * @param isSynchronous - Whether this mutation is synchronous.
980
+ * @param correlationId - The tenant correlation identifier, optional.
981
+ * @returns The result of the deletion.
982
+ */
666
983
  async deleteAllContents(filter, isSynchronous, correlationId) {
667
984
  return this.mutateAndCheckError(Documents.DeleteAllContents, {
668
985
  filter: filter,
@@ -670,6 +987,14 @@ class Graphlit {
670
987
  correlationId: correlationId,
671
988
  });
672
989
  }
990
+ /**
991
+ * Summarizes text using the specified summarization strategy.
992
+ * @param summarization - The summarization strategy to use.
993
+ * @param text - The text to summarize.
994
+ * @param textType - The type of text (plain, markdown, HTML), optional.
995
+ * @param correlationId - The tenant correlation identifier, optional.
996
+ * @returns The summarized text.
997
+ */
673
998
  async summarizeText(summarization, text, textType, correlationId) {
674
999
  return this.mutateAndCheckError(Documents.SummarizeText, {
675
1000
  summarization: summarization,
@@ -678,6 +1003,13 @@ class Graphlit {
678
1003
  correlationId: correlationId,
679
1004
  });
680
1005
  }
1006
+ /**
1007
+ * Summarizes contents using the specified summarization strategies.
1008
+ * @param summarizations - The summarization strategies to use.
1009
+ * @param filter - The filter criteria to apply when retrieving contents to summarize.
1010
+ * @param correlationId - The tenant correlation identifier, optional.
1011
+ * @returns The summarized contents.
1012
+ */
681
1013
  async summarizeContents(summarizations, filter, correlationId) {
682
1014
  return this.mutateAndCheckError(Documents.SummarizeContents, {
683
1015
  summarizations: summarizations,
@@ -685,6 +1017,16 @@ class Graphlit {
685
1017
  correlationId: correlationId,
686
1018
  });
687
1019
  }
1020
+ /**
1021
+ * Extracts structured data from text using tool definitions.
1022
+ * @param prompt - The prompt to guide extraction.
1023
+ * @param text - The text to extract from.
1024
+ * @param tools - The tool definitions for extraction.
1025
+ * @param specification - The LLM specification to use, optional.
1026
+ * @param textType - The type of text (plain, markdown, HTML), optional.
1027
+ * @param correlationId - The tenant correlation identifier, optional.
1028
+ * @returns The extracted data.
1029
+ */
688
1030
  async extractText(prompt, text, tools, specification, textType, correlationId) {
689
1031
  return this.mutateAndCheckError(Documents.ExtractText, {
690
1032
  prompt: prompt,
@@ -695,6 +1037,15 @@ class Graphlit {
695
1037
  correlationId: correlationId,
696
1038
  });
697
1039
  }
1040
+ /**
1041
+ * Extracts structured data from contents using tool definitions.
1042
+ * @param prompt - The prompt to guide extraction.
1043
+ * @param tools - The tool definitions for extraction.
1044
+ * @param specification - The LLM specification to use, optional.
1045
+ * @param filter - The filter criteria to apply when retrieving contents.
1046
+ * @param correlationId - The tenant correlation identifier, optional.
1047
+ * @returns The extracted data.
1048
+ */
698
1049
  async extractContents(prompt, tools, specification, filter, correlationId) {
699
1050
  return this.mutateAndCheckError(Documents.ExtractContents, {
700
1051
  prompt: prompt,
@@ -704,6 +1055,15 @@ class Graphlit {
704
1055
  correlationId: correlationId,
705
1056
  });
706
1057
  }
1058
+ /**
1059
+ * Extracts observables (entities) from text.
1060
+ * @param text - The text to extract observables from.
1061
+ * @param textType - The type of text (plain, markdown, HTML), optional.
1062
+ * @param specification - The LLM specification to use, optional.
1063
+ * @param observableTypes - The types of observables to extract, optional.
1064
+ * @param correlationId - The tenant correlation identifier, optional.
1065
+ * @returns The extracted observables.
1066
+ */
707
1067
  async extractObservables(text, textType, specification, observableTypes, correlationId) {
708
1068
  return this.mutateAndCheckError(Documents.ExtractObservables, {
709
1069
  text: text,
@@ -713,6 +1073,21 @@ class Graphlit {
713
1073
  correlationId: correlationId,
714
1074
  });
715
1075
  }
1076
+ /**
1077
+ * Publishes contents to an external connector.
1078
+ * @param publishPrompt - The prompt for publishing.
1079
+ * @param connector - The publishing connector to use.
1080
+ * @param summaryPrompt - The prompt for summarizing each content, optional.
1081
+ * @param summarySpecification - The LLM specification for summarization, optional.
1082
+ * @param publishSpecification - The LLM specification for publishing, optional.
1083
+ * @param name - The name of the published content, optional.
1084
+ * @param filter - The filter criteria for selecting contents, optional.
1085
+ * @param workflow - The workflow to use, optional.
1086
+ * @param isSynchronous - Whether this mutation is synchronous.
1087
+ * @param includeDetails - Whether to include details in publishing, optional.
1088
+ * @param correlationId - The tenant correlation identifier, optional.
1089
+ * @returns The published content.
1090
+ */
716
1091
  async publishContents(publishPrompt, connector, summaryPrompt, summarySpecification, publishSpecification, name, filter, workflow, isSynchronous, includeDetails, correlationId) {
717
1092
  return this.mutateAndCheckError(Documents.PublishContents, {
718
1093
  summaryPrompt: summaryPrompt,
@@ -728,6 +1103,17 @@ class Graphlit {
728
1103
  correlationId: correlationId,
729
1104
  });
730
1105
  }
1106
+ /**
1107
+ * Publishes text to an external connector.
1108
+ * @param text - The text to publish.
1109
+ * @param textType - The type of text (plain, markdown, HTML).
1110
+ * @param connector - The publishing connector to use.
1111
+ * @param name - The name of the published content, optional.
1112
+ * @param workflow - The workflow to use, optional.
1113
+ * @param isSynchronous - Whether this mutation is synchronous.
1114
+ * @param correlationId - The tenant correlation identifier, optional.
1115
+ * @returns The published content.
1116
+ */
731
1117
  async publishText(text, textType, connector, name, workflow, isSynchronous, correlationId) {
732
1118
  return this.mutateAndCheckError(Documents.PublishText, {
733
1119
  text: text,
@@ -739,6 +1125,17 @@ class Graphlit {
739
1125
  correlationId: correlationId,
740
1126
  });
741
1127
  }
1128
+ /**
1129
+ * Researches contents and publishes the results.
1130
+ * @param connector - The publishing connector to use.
1131
+ * @param filter - The filter criteria for selecting contents, optional.
1132
+ * @param name - The name of the research output, optional.
1133
+ * @param summarySpecification - The LLM specification for summarization, optional.
1134
+ * @param publishSpecification - The LLM specification for publishing, optional.
1135
+ * @param workflow - The workflow to use, optional.
1136
+ * @param correlationId - The tenant correlation identifier, optional.
1137
+ * @returns The research results.
1138
+ */
742
1139
  async researchContents(connector, filter, name, summarySpecification, publishSpecification, workflow, correlationId) {
743
1140
  return this.mutateAndCheckError(Documents.ResearchContents, {
744
1141
  connector: connector,
@@ -750,24 +1147,59 @@ class Graphlit {
750
1147
  correlationId: correlationId,
751
1148
  });
752
1149
  }
1150
+ /**
1151
+ * Lookup content given its ID.
1152
+ * @param id - ID of the content.
1153
+ * @returns The content.
1154
+ */
753
1155
  async getContent(id) {
754
1156
  return this.queryAndCheckError(Documents.GetContent, { id: id });
755
1157
  }
1158
+ /**
1159
+ * Lookup multiple contents given their IDs.
1160
+ * @param ids - IDs of the contents.
1161
+ * @returns The contents.
1162
+ */
756
1163
  async lookupContents(ids) {
757
1164
  return this.queryAndCheckError(Documents.LookupContents, { ids: ids });
758
1165
  }
1166
+ /**
1167
+ * Retrieves observables based on the provided filter criteria.
1168
+ * @param filter - The filter criteria to apply when retrieving observables.
1169
+ * @returns The observables.
1170
+ */
759
1171
  async queryObservables(filter) {
760
1172
  return this.queryAndCheckError(Documents.QueryObservables, { filter: filter });
761
1173
  }
1174
+ /**
1175
+ * Retrieves contents based on the provided filter criteria.
1176
+ * @param filter - The filter criteria to apply when retrieving contents.
1177
+ * @returns The contents.
1178
+ */
762
1179
  async queryContents(filter) {
763
1180
  return this.queryAndCheckError(Documents.QueryContents, { filter: filter });
764
1181
  }
1182
+ /**
1183
+ * Retrieves contents with their observations based on the provided filter criteria.
1184
+ * @param filter - The filter criteria to apply when retrieving contents.
1185
+ * @returns The contents with observations.
1186
+ */
765
1187
  async queryContentsObservations(filter) {
766
1188
  return this.queryAndCheckError(Documents.QueryContentsObservations, { filter: filter });
767
1189
  }
1190
+ /**
1191
+ * Retrieves content facets based on the provided filter criteria.
1192
+ * @param filter - The filter criteria to apply when retrieving facets.
1193
+ * @returns The content facets.
1194
+ */
768
1195
  async queryContentsFacets(filter) {
769
1196
  return this.queryAndCheckError(Documents.QueryContentsFacets, { filter: filter });
770
1197
  }
1198
+ /**
1199
+ * Retrieves the content knowledge graph based on the provided filter criteria.
1200
+ * @param filter - The filter criteria to apply when retrieving the graph.
1201
+ * @returns The content knowledge graph.
1202
+ */
771
1203
  async queryContentsGraph(filter) {
772
1204
  return this.queryAndCheckError(Documents.QueryContentsGraph, {
773
1205
  filter: filter,
@@ -776,6 +1208,13 @@ class Graphlit {
776
1208
  },
777
1209
  });
778
1210
  }
1211
+ /**
1212
+ * Retrieves the knowledge graph based on the provided filter criteria.
1213
+ * @param filter - The filter criteria to apply when retrieving the graph.
1214
+ * @param graph - The graph configuration, optional.
1215
+ * @param correlationId - The tenant correlation identifier, optional.
1216
+ * @returns The knowledge graph.
1217
+ */
779
1218
  async queryGraph(filter, graph, correlationId) {
780
1219
  return this.queryAndCheckError(Documents.QueryGraph, {
781
1220
  filter: filter,
@@ -783,36 +1222,81 @@ class Graphlit {
783
1222
  correlationId: correlationId,
784
1223
  });
785
1224
  }
1225
+ /**
1226
+ * Lookup an entity and its relationships.
1227
+ * @param filter - The filter criteria for entity relationships.
1228
+ * @param correlationId - The tenant correlation identifier, optional.
1229
+ * @returns The entity with relationships.
1230
+ */
786
1231
  async lookupEntity(filter, correlationId) {
787
1232
  return this.queryAndCheckError(Documents.LookupEntity, {
788
1233
  filter: filter,
789
1234
  correlationId: correlationId,
790
1235
  });
791
1236
  }
1237
+ /**
1238
+ * Counts contents based on the provided filter criteria.
1239
+ * @param filter - The filter criteria to apply when counting contents.
1240
+ * @returns The count of contents.
1241
+ */
792
1242
  async countContents(filter) {
793
1243
  return this.queryAndCheckError(Documents.CountContents, { filter: filter });
794
1244
  }
1245
+ /**
1246
+ * Checks if content processing is complete.
1247
+ * @param id - ID of the content.
1248
+ * @returns Whether the content is done processing.
1249
+ */
795
1250
  async isContentDone(id) {
796
1251
  return this.queryAndCheckError(Documents.IsContentDone, { id: id });
797
1252
  }
1253
+ /**
1254
+ * Creates a conversation.
1255
+ * @param conversation - The conversation to create.
1256
+ * @param correlationId - The tenant correlation identifier, optional.
1257
+ * @returns The created conversation.
1258
+ */
798
1259
  async createConversation(conversation, correlationId) {
799
1260
  return this.mutateAndCheckError(Documents.CreateConversation, {
800
1261
  conversation: conversation,
801
1262
  correlationId: correlationId,
802
1263
  });
803
1264
  }
1265
+ /**
1266
+ * Updates a conversation.
1267
+ * @param conversation - The conversation to update.
1268
+ * @returns The updated conversation.
1269
+ */
804
1270
  async updateConversation(conversation) {
805
1271
  return this.mutateAndCheckError(Documents.UpdateConversation, { conversation: conversation });
806
1272
  }
1273
+ /**
1274
+ * Deletes a conversation.
1275
+ * @param id - The ID of the conversation to delete.
1276
+ * @returns The deleted conversation.
1277
+ */
807
1278
  async deleteConversation(id) {
808
1279
  return this.mutateAndCheckError(Documents.DeleteConversation, { id: id });
809
1280
  }
1281
+ /**
1282
+ * Deletes multiple conversations.
1283
+ * @param ids - The IDs of the conversations to delete.
1284
+ * @param isSynchronous - Whether this mutation is synchronous.
1285
+ * @returns The deleted conversations.
1286
+ */
810
1287
  async deleteConversations(ids, isSynchronous) {
811
1288
  return this.mutateAndCheckError(Documents.DeleteConversations, {
812
1289
  ids: ids,
813
1290
  isSynchronous: isSynchronous,
814
1291
  });
815
1292
  }
1293
+ /**
1294
+ * Deletes all conversations based on the provided filter criteria.
1295
+ * @param filter - The filter criteria to apply when deleting conversations.
1296
+ * @param isSynchronous - Whether this mutation is synchronous.
1297
+ * @param correlationId - The tenant correlation identifier, optional.
1298
+ * @returns The result of the deletion.
1299
+ */
816
1300
  async deleteAllConversations(filter, isSynchronous, correlationId) {
817
1301
  return this.mutateAndCheckError(Documents.DeleteAllConversations, {
818
1302
  filter: filter,
@@ -820,21 +1304,55 @@ class Graphlit {
820
1304
  correlationId: correlationId,
821
1305
  });
822
1306
  }
1307
+ /**
1308
+ * Clears all messages from a conversation.
1309
+ * @param id - The ID of the conversation to clear.
1310
+ * @returns The cleared conversation.
1311
+ */
823
1312
  async clearConversation(id) {
824
1313
  return this.mutateAndCheckError(Documents.ClearConversation, { id: id });
825
1314
  }
1315
+ /**
1316
+ * Closes a conversation.
1317
+ * @param id - The ID of the conversation to close.
1318
+ * @returns The closed conversation.
1319
+ */
826
1320
  async closeConversation(id) {
827
1321
  return this.mutateAndCheckError(Documents.CloseConversation, { id: id });
828
1322
  }
1323
+ /**
1324
+ * Lookup a conversation given its ID.
1325
+ * @param id - ID of the conversation.
1326
+ * @returns The conversation.
1327
+ */
829
1328
  async getConversation(id) {
830
1329
  return this.queryAndCheckError(Documents.GetConversation, { id: id });
831
1330
  }
1331
+ /**
1332
+ * Retrieves conversations based on the provided filter criteria.
1333
+ * @param filter - The filter criteria to apply when retrieving conversations.
1334
+ * @returns The conversations.
1335
+ */
832
1336
  async queryConversations(filter) {
833
1337
  return this.queryAndCheckError(Documents.QueryConversations, { filter: filter });
834
1338
  }
1339
+ /**
1340
+ * Counts conversations based on the provided filter criteria.
1341
+ * @param filter - The filter criteria to apply when counting conversations.
1342
+ * @returns The count of conversations.
1343
+ */
835
1344
  async countConversations(filter) {
836
1345
  return this.queryAndCheckError(Documents.CountConversations, { filter: filter });
837
1346
  }
1347
+ /**
1348
+ * Revises an image in an existing conversation using a multimodal LLM.
1349
+ * @param prompt - The prompt to use for revision.
1350
+ * @param uri - The URI of the image to revise.
1351
+ * @param id - The conversation ID, optional.
1352
+ * @param specification - The LLM specification to use, optional.
1353
+ * @param correlationId - The tenant correlation identifier, optional.
1354
+ * @returns The revised conversation message.
1355
+ */
838
1356
  async reviseImage(prompt, uri, id, specification, correlationId) {
839
1357
  return this.mutateAndCheckError(Documents.ReviseImage, {
840
1358
  prompt: prompt,
@@ -844,6 +1362,16 @@ class Graphlit {
844
1362
  correlationId: correlationId,
845
1363
  });
846
1364
  }
1365
+ /**
1366
+ * Revises a base64-encoded image in an existing conversation using a multimodal LLM.
1367
+ * @param prompt - The prompt to use for revision.
1368
+ * @param mimeType - The MIME type of the image.
1369
+ * @param data - The base64-encoded image data.
1370
+ * @param id - The conversation ID, optional.
1371
+ * @param specification - The LLM specification to use, optional.
1372
+ * @param correlationId - The tenant correlation identifier, optional.
1373
+ * @returns The revised conversation message.
1374
+ */
847
1375
  async reviseEncodedImage(prompt, mimeType, data, id, specification, correlationId) {
848
1376
  return this.mutateAndCheckError(Documents.ReviseEncodedImage, {
849
1377
  prompt: prompt,
@@ -854,6 +1382,15 @@ class Graphlit {
854
1382
  correlationId: correlationId,
855
1383
  });
856
1384
  }
1385
+ /**
1386
+ * Revises text in an existing conversation.
1387
+ * @param prompt - The prompt to use for revision.
1388
+ * @param text - The text to revise.
1389
+ * @param id - The conversation ID, optional.
1390
+ * @param specification - The LLM specification to use, optional.
1391
+ * @param correlationId - The tenant correlation identifier, optional.
1392
+ * @returns The revised conversation message.
1393
+ */
857
1394
  async reviseText(prompt, text, id, specification, correlationId) {
858
1395
  return this.mutateAndCheckError(Documents.ReviseText, {
859
1396
  prompt: prompt,
@@ -863,6 +1400,15 @@ class Graphlit {
863
1400
  correlationId: correlationId,
864
1401
  });
865
1402
  }
1403
+ /**
1404
+ * Revises content in an existing conversation.
1405
+ * @param prompt - The prompt to use for revision.
1406
+ * @param content - The content to revise.
1407
+ * @param id - The conversation ID, optional.
1408
+ * @param specification - The LLM specification to use, optional.
1409
+ * @param correlationId - The tenant correlation identifier, optional.
1410
+ * @returns The revised conversation message.
1411
+ */
866
1412
  async reviseContent(prompt, content, id, specification, correlationId) {
867
1413
  return this.mutateAndCheckError(Documents.ReviseContent, {
868
1414
  prompt: prompt,
@@ -872,6 +1418,16 @@ class Graphlit {
872
1418
  correlationId: correlationId,
873
1419
  });
874
1420
  }
1421
+ /**
1422
+ * Prompts an LLM without a conversation context.
1423
+ * @param prompt - The prompt text, optional.
1424
+ * @param mimeType - The MIME type for multimodal input, optional.
1425
+ * @param data - The base64-encoded data for multimodal input, optional.
1426
+ * @param specification - The LLM specification to use, optional.
1427
+ * @param messages - Previous messages for context, optional.
1428
+ * @param correlationId - The tenant correlation identifier, optional.
1429
+ * @returns The LLM response.
1430
+ */
875
1431
  async prompt(prompt, mimeType, data, specification, messages, correlationId) {
876
1432
  return this.mutateAndCheckError(Documents.Prompt, {
877
1433
  prompt: prompt,
@@ -882,6 +1438,15 @@ class Graphlit {
882
1438
  correlationId: correlationId,
883
1439
  });
884
1440
  }
1441
+ /**
1442
+ * Retrieves relevant sources from a view for RAG.
1443
+ * @param prompt - The prompt to use for retrieval.
1444
+ * @param id - The view ID.
1445
+ * @param retrievalStrategy - The retrieval strategy, optional.
1446
+ * @param rerankingStrategy - The reranking strategy, optional.
1447
+ * @param correlationId - The tenant correlation identifier, optional.
1448
+ * @returns The retrieved sources.
1449
+ */
885
1450
  async retrieveView(prompt, id, retrievalStrategy, rerankingStrategy, correlationId) {
886
1451
  return this.mutateAndCheckError(Documents.RetrieveView, {
887
1452
  prompt: prompt,
@@ -891,6 +1456,16 @@ class Graphlit {
891
1456
  correlationId: correlationId,
892
1457
  });
893
1458
  }
1459
+ /**
1460
+ * Retrieves relevant sources for RAG.
1461
+ * @param prompt - The prompt to use for retrieval.
1462
+ * @param filter - The filter criteria for selecting contents, optional.
1463
+ * @param augmentedFilter - Additional filter for augmented retrieval, optional.
1464
+ * @param retrievalStrategy - The retrieval strategy, optional.
1465
+ * @param rerankingStrategy - The reranking strategy, optional.
1466
+ * @param correlationId - The tenant correlation identifier, optional.
1467
+ * @returns The retrieved sources.
1468
+ */
894
1469
  async retrieveSources(prompt, filter, augmentedFilter, retrievalStrategy, rerankingStrategy, correlationId) {
895
1470
  return this.mutateAndCheckError(Documents.RetrieveSources, {
896
1471
  prompt: prompt,
@@ -901,6 +1476,17 @@ class Graphlit {
901
1476
  correlationId: correlationId,
902
1477
  });
903
1478
  }
1479
+ /**
1480
+ * Formats a conversation for external LLM completion.
1481
+ * @param prompt - The prompt to format.
1482
+ * @param id - The conversation ID, optional.
1483
+ * @param specification - The LLM specification to use, optional.
1484
+ * @param tools - Tool definitions for function calling, optional.
1485
+ * @param systemPrompt - The system prompt, optional.
1486
+ * @param includeDetails - Whether to include details, optional.
1487
+ * @param correlationId - The tenant correlation identifier, optional.
1488
+ * @returns The formatted conversation.
1489
+ */
904
1490
  async formatConversation(prompt, id, specification, tools, systemPrompt, includeDetails, correlationId) {
905
1491
  return this.mutateAndCheckError(Documents.FormatConversation, {
906
1492
  prompt: prompt,
@@ -912,6 +1498,16 @@ class Graphlit {
912
1498
  correlationId: correlationId,
913
1499
  });
914
1500
  }
1501
+ /**
1502
+ * Completes a conversation with an external LLM response.
1503
+ * @param completion - The completion text from the external LLM.
1504
+ * @param id - The conversation ID.
1505
+ * @param completionTime - The time taken for completion, optional.
1506
+ * @param ttft - Time to first token, optional.
1507
+ * @param throughput - Tokens per second throughput, optional.
1508
+ * @param correlationId - The tenant correlation identifier, optional.
1509
+ * @returns The completed conversation.
1510
+ */
915
1511
  async completeConversation(completion, id, completionTime, ttft, throughput, correlationId) {
916
1512
  return this.mutateAndCheckError(Documents.CompleteConversation, {
917
1513
  completion: completion,
@@ -922,6 +1518,15 @@ class Graphlit {
922
1518
  correlationId: correlationId,
923
1519
  });
924
1520
  }
1521
+ /**
1522
+ * Asks a question about Graphlit SDK usage.
1523
+ * @param prompt - The question about Graphlit.
1524
+ * @param type - The SDK type (Node.js, Python, .NET), optional.
1525
+ * @param id - The conversation ID, optional.
1526
+ * @param specification - The LLM specification to use, optional.
1527
+ * @param correlationId - The tenant correlation identifier, optional.
1528
+ * @returns The Graphlit answer.
1529
+ */
925
1530
  async askGraphlit(prompt, type, id, specification, correlationId) {
926
1531
  return this.mutateAndCheckError(Documents.AskGraphlit, {
927
1532
  prompt: prompt,
@@ -931,11 +1536,30 @@ class Graphlit {
931
1536
  correlationId: correlationId,
932
1537
  });
933
1538
  }
1539
+ /**
1540
+ * Creates a branch of an existing conversation.
1541
+ * @param id - The conversation ID to branch from.
1542
+ * @returns The branched conversation.
1543
+ */
934
1544
  async branchConversation(id) {
935
1545
  return this.mutateAndCheckError(Documents.BranchConversation, {
936
1546
  id: id,
937
1547
  });
938
1548
  }
1549
+ /**
1550
+ * Prompts a conversation with an LLM.
1551
+ * @param prompt - The prompt text.
1552
+ * @param id - The conversation ID, optional. If not provided, creates a new conversation.
1553
+ * @param specification - The LLM specification to use, optional.
1554
+ * @param mimeType - The MIME type for multimodal input, optional.
1555
+ * @param data - The base64-encoded data for multimodal input, optional.
1556
+ * @param tools - Tool definitions for function calling, optional.
1557
+ * @param requireTool - Whether to require a tool call, optional.
1558
+ * @param systemPrompt - The system prompt, optional.
1559
+ * @param includeDetails - Whether to include details, optional.
1560
+ * @param correlationId - The tenant correlation identifier, optional.
1561
+ * @returns The conversation response.
1562
+ */
939
1563
  async promptConversation(prompt, id, specification, mimeType, data, tools, requireTool, systemPrompt, includeDetails, correlationId) {
940
1564
  return this.mutateAndCheckError(Documents.PromptConversation, {
941
1565
  prompt: prompt,
@@ -950,6 +1574,13 @@ class Graphlit {
950
1574
  correlationId: correlationId,
951
1575
  });
952
1576
  }
1577
+ /**
1578
+ * Continues a conversation with tool responses.
1579
+ * @param id - The conversation ID.
1580
+ * @param responses - The tool call responses.
1581
+ * @param correlationId - The tenant correlation identifier, optional.
1582
+ * @returns The continued conversation.
1583
+ */
953
1584
  async continueConversation(id, responses, correlationId) {
954
1585
  return this.mutateAndCheckError(Documents.ContinueConversation, {
955
1586
  id: id,
@@ -957,6 +1588,16 @@ class Graphlit {
957
1588
  correlationId: correlationId,
958
1589
  });
959
1590
  }
1591
+ /**
1592
+ * Publishes a conversation to an external connector.
1593
+ * @param id - The conversation ID.
1594
+ * @param connector - The publishing connector to use.
1595
+ * @param name - The name of the published conversation, optional.
1596
+ * @param workflow - The workflow to use, optional.
1597
+ * @param isSynchronous - Whether this mutation is synchronous.
1598
+ * @param correlationId - The tenant correlation identifier, optional.
1599
+ * @returns The published conversation.
1600
+ */
960
1601
  async publishConversation(id, connector, name, workflow, isSynchronous, correlationId) {
961
1602
  return this.mutateAndCheckError(Documents.PublishConversation, {
962
1603
  id: id,
@@ -967,6 +1608,13 @@ class Graphlit {
967
1608
  correlationId: correlationId,
968
1609
  });
969
1610
  }
1611
+ /**
1612
+ * Suggests follow-up prompts for a conversation.
1613
+ * @param id - The conversation ID.
1614
+ * @param count - The number of suggestions to generate, optional.
1615
+ * @param correlationId - The tenant correlation identifier, optional.
1616
+ * @returns The suggested prompts.
1617
+ */
970
1618
  async suggestConversation(id, count, correlationId) {
971
1619
  return this.mutateAndCheckError(Documents.SuggestConversation, {
972
1620
  id: id,
@@ -974,40 +1622,81 @@ class Graphlit {
974
1622
  correlationId: correlationId,
975
1623
  });
976
1624
  }
1625
+ /**
1626
+ * Queries Microsoft calendars.
1627
+ * @param properties - The Microsoft calendar query properties.
1628
+ * @returns The Microsoft calendars.
1629
+ */
977
1630
  async queryMicrosoftCalendars(properties) {
978
1631
  return this.queryAndCheckError(Documents.QueryMicrosoftCalendars, {
979
1632
  properties: properties,
980
1633
  });
981
1634
  }
1635
+ /**
1636
+ * Queries Google calendars.
1637
+ * @param properties - The Google calendar query properties.
1638
+ * @returns The Google calendars.
1639
+ */
982
1640
  async queryGoogleCalendars(properties) {
983
1641
  return this.queryAndCheckError(Documents.QueryGoogleCalendars, {
984
1642
  properties: properties,
985
1643
  });
986
1644
  }
1645
+ /**
1646
+ * Queries Box folders.
1647
+ * @param properties - The Box folder query properties.
1648
+ * @param folderId - The parent folder ID, optional.
1649
+ * @returns The Box folders.
1650
+ */
987
1651
  async queryBoxFolders(properties, folderId) {
988
1652
  return this.queryAndCheckError(Documents.QueryBoxFolders, {
989
1653
  properties: properties,
990
1654
  folderId: folderId,
991
1655
  });
992
1656
  }
1657
+ /**
1658
+ * Queries Dropbox folders.
1659
+ * @param properties - The Dropbox folder query properties.
1660
+ * @param folderPath - The folder path, optional.
1661
+ * @returns The Dropbox folders.
1662
+ */
993
1663
  async queryDropboxFolders(properties, folderPath) {
994
1664
  return this.queryAndCheckError(Documents.QueryDropboxFolders, {
995
1665
  properties: properties,
996
1666
  folderPath: folderPath,
997
1667
  });
998
1668
  }
1669
+ /**
1670
+ * Queries Google Drive folders.
1671
+ * @param properties - The Google Drive folder query properties.
1672
+ * @param folderId - The parent folder ID, optional.
1673
+ * @returns The Google Drive folders.
1674
+ */
999
1675
  async queryGoogleDriveFolders(properties, folderId) {
1000
1676
  return this.queryAndCheckError(Documents.QueryGoogleDriveFolders, {
1001
1677
  properties: properties,
1002
1678
  folderId: folderId,
1003
1679
  });
1004
1680
  }
1681
+ /**
1682
+ * Queries OneDrive folders.
1683
+ * @param properties - The OneDrive folder query properties.
1684
+ * @param folderId - The parent folder ID, optional.
1685
+ * @returns The OneDrive folders.
1686
+ */
1005
1687
  async queryOneDriveFolders(properties, folderId) {
1006
1688
  return this.queryAndCheckError(Documents.QueryOneDriveFolders, {
1007
1689
  properties: properties,
1008
1690
  folderId: folderId,
1009
1691
  });
1010
1692
  }
1693
+ /**
1694
+ * Queries SharePoint folders.
1695
+ * @param properties - The SharePoint folder query properties.
1696
+ * @param libraryId - The library ID.
1697
+ * @param folderId - The parent folder ID, optional.
1698
+ * @returns The SharePoint folders.
1699
+ */
1011
1700
  async querySharePointFolders(properties, libraryId, folderId) {
1012
1701
  return this.queryAndCheckError(Documents.QuerySharePointFolders, {
1013
1702
  properties: properties,
@@ -1015,57 +1704,139 @@ class Graphlit {
1015
1704
  folderId: folderId,
1016
1705
  });
1017
1706
  }
1707
+ /**
1708
+ * Queries SharePoint libraries.
1709
+ * @param properties - The SharePoint library query properties.
1710
+ * @returns The SharePoint libraries.
1711
+ */
1018
1712
  async querySharePointLibraries(properties) {
1019
1713
  return this.queryAndCheckError(Documents.QuerySharePointLibraries, { properties: properties });
1020
1714
  }
1715
+ /**
1716
+ * Queries Microsoft Teams teams.
1717
+ * @param properties - The Microsoft Teams query properties.
1718
+ * @returns The Microsoft Teams teams.
1719
+ */
1021
1720
  async queryMicrosoftTeamsTeams(properties) {
1022
1721
  return this.queryAndCheckError(Documents.QueryMicrosoftTeamsTeams, { properties: properties });
1023
1722
  }
1723
+ /**
1724
+ * Queries Microsoft Teams channels.
1725
+ * @param properties - The Microsoft Teams channel query properties.
1726
+ * @param teamId - The team ID.
1727
+ * @returns The Microsoft Teams channels.
1728
+ */
1024
1729
  async queryMicrosoftTeamsChannels(properties, teamId) {
1025
1730
  return this.queryAndCheckError(Documents.QueryMicrosoftTeamsChannels, {
1026
1731
  properties: properties,
1027
1732
  teamId: teamId,
1028
1733
  });
1029
1734
  }
1735
+ /**
1736
+ * Queries Discord guilds (servers).
1737
+ * @param properties - The Discord guild query properties.
1738
+ * @returns The Discord guilds.
1739
+ */
1030
1740
  async queryDiscordGuilds(properties) {
1031
1741
  return this.queryAndCheckError(Documents.QueryDiscordGuilds, { properties: properties });
1032
1742
  }
1743
+ /**
1744
+ * Queries Discord channels.
1745
+ * @param properties - The Discord channel query properties.
1746
+ * @returns The Discord channels.
1747
+ */
1033
1748
  async queryDiscordChannels(properties) {
1034
1749
  return this.queryAndCheckError(Documents.QueryDiscordChannels, { properties: properties });
1035
1750
  }
1751
+ /**
1752
+ * Queries Slack channels.
1753
+ * @param properties - The Slack channel query properties.
1754
+ * @returns The Slack channels.
1755
+ */
1036
1756
  async querySlackChannels(properties) {
1037
1757
  return this.queryAndCheckError(Documents.QuerySlackChannels, { properties: properties });
1038
1758
  }
1759
+ /**
1760
+ * Queries Linear projects.
1761
+ * @param properties - The Linear project query properties.
1762
+ * @returns The Linear projects.
1763
+ */
1039
1764
  async queryLinearProjects(properties) {
1040
1765
  return this.queryAndCheckError(Documents.QueryLinearProjects, { properties: properties });
1041
1766
  }
1767
+ /**
1768
+ * Queries GitHub repositories.
1769
+ * @param properties - The GitHub repository query properties.
1770
+ * @param sortBy - The sort order, optional.
1771
+ * @returns The GitHub repositories.
1772
+ */
1042
1773
  async queryGitHubRepositories(properties, sortBy) {
1043
1774
  return this.queryAndCheckError(Documents.QueryGitHubRepositories, {
1044
1775
  properties: properties,
1045
1776
  sortBy: sortBy,
1046
1777
  });
1047
1778
  }
1779
+ /**
1780
+ * Queries Notion databases.
1781
+ * @param properties - The Notion database query properties.
1782
+ * @returns The Notion databases.
1783
+ */
1048
1784
  async queryNotionDatabases(properties) {
1049
1785
  return this.queryAndCheckError(Documents.QueryNotionDatabases, { properties: properties });
1050
1786
  }
1787
+ /**
1788
+ * Queries Notion pages.
1789
+ * @param properties - The Notion page query properties.
1790
+ * @param identifier - The Notion database or page identifier.
1791
+ * @returns The Notion pages.
1792
+ */
1051
1793
  async queryNotionPages(properties, identifier) {
1052
1794
  return this.queryAndCheckError(Documents.QueryNotionPages, {
1053
1795
  properties: properties,
1054
1796
  identifier: identifier,
1055
1797
  });
1056
1798
  }
1799
+ /**
1800
+ * Creates a feed.
1801
+ * @param feed - The feed to create.
1802
+ * @param correlationId - The tenant correlation identifier, optional.
1803
+ * @returns The created feed.
1804
+ */
1057
1805
  async createFeed(feed, correlationId) {
1058
1806
  return this.mutateAndCheckError(Documents.CreateFeed, { feed: feed, correlationId: correlationId });
1059
1807
  }
1808
+ /**
1809
+ * Updates a feed.
1810
+ * @param feed - The feed to update.
1811
+ * @returns The updated feed.
1812
+ */
1060
1813
  async updateFeed(feed) {
1061
1814
  return this.mutateAndCheckError(Documents.UpdateFeed, { feed: feed });
1062
1815
  }
1816
+ /**
1817
+ * Deletes a feed.
1818
+ * @param id - The ID of the feed to delete.
1819
+ * @returns The deleted feed.
1820
+ */
1063
1821
  async deleteFeed(id) {
1064
1822
  return this.mutateAndCheckError(Documents.DeleteFeed, { id: id });
1065
1823
  }
1824
+ /**
1825
+ * Deletes multiple feeds.
1826
+ * @param ids - The IDs of the feeds to delete.
1827
+ * @param isSynchronous - Whether this mutation is synchronous.
1828
+ * @returns The deleted feeds.
1829
+ */
1066
1830
  async deleteFeeds(ids, isSynchronous) {
1067
1831
  return this.mutateAndCheckError(Documents.DeleteFeeds, { ids: ids, isSynchronous: isSynchronous });
1068
1832
  }
1833
+ /**
1834
+ * Deletes all feeds based on the provided filter criteria.
1835
+ * @param filter - The filter criteria to apply when deleting feeds.
1836
+ * @param isSynchronous - Whether this mutation is synchronous.
1837
+ * @param correlationId - The tenant correlation identifier, optional.
1838
+ * @returns The result of the deletion.
1839
+ */
1069
1840
  async deleteAllFeeds(filter, isSynchronous, correlationId) {
1070
1841
  return this.mutateAndCheckError(Documents.DeleteAllFeeds, {
1071
1842
  filter: filter,
@@ -1073,51 +1844,130 @@ class Graphlit {
1073
1844
  correlationId: correlationId,
1074
1845
  });
1075
1846
  }
1847
+ /**
1848
+ * Triggers a feed to run immediately.
1849
+ * @param id - The ID of the feed to trigger.
1850
+ * @returns The triggered feed.
1851
+ */
1076
1852
  async triggerFeed(id) {
1077
1853
  return this.mutateAndCheckError(Documents.TriggerFeed, { id: id });
1078
1854
  }
1855
+ /**
1856
+ * Enables a feed.
1857
+ * @param id - The ID of the feed to enable.
1858
+ * @returns The enabled feed.
1859
+ */
1079
1860
  async enableFeed(id) {
1080
1861
  return this.mutateAndCheckError(Documents.EnableFeed, { id: id });
1081
1862
  }
1863
+ /**
1864
+ * Disables a feed.
1865
+ * @param id - The ID of the feed to disable.
1866
+ * @returns The disabled feed.
1867
+ */
1082
1868
  async disableFeed(id) {
1083
1869
  return this.mutateAndCheckError(Documents.DisableFeed, { id: id });
1084
1870
  }
1871
+ /**
1872
+ * Lookup a feed given its ID.
1873
+ * @param id - ID of the feed.
1874
+ * @returns The feed.
1875
+ */
1085
1876
  async getFeed(id) {
1086
1877
  return this.queryAndCheckError(Documents.GetFeed, { id: id });
1087
1878
  }
1879
+ /**
1880
+ * Retrieves feeds based on the provided filter criteria.
1881
+ * @param filter - The filter criteria to apply when retrieving feeds.
1882
+ * @returns The feeds.
1883
+ */
1088
1884
  async queryFeeds(filter) {
1089
1885
  return this.queryAndCheckError(Documents.QueryFeeds, { filter: filter });
1090
1886
  }
1887
+ /**
1888
+ * Counts feeds based on the provided filter criteria.
1889
+ * @param filter - The filter criteria to apply when counting feeds.
1890
+ * @returns The count of feeds.
1891
+ */
1091
1892
  async countFeeds(filter) {
1092
1893
  return this.queryAndCheckError(Documents.CountFeeds, { filter: filter });
1093
1894
  }
1895
+ /**
1896
+ * Checks if a feed exists based on the provided filter criteria.
1897
+ * @param filter - The filter criteria to apply.
1898
+ * @returns Whether the feed exists.
1899
+ */
1094
1900
  async feedExists(filter) {
1095
1901
  return this.queryAndCheckError(Documents.FeedExists, { filter: filter });
1096
1902
  }
1903
+ /**
1904
+ * Checks if feed processing is complete.
1905
+ * @param id - ID of the feed.
1906
+ * @returns Whether the feed is done processing.
1907
+ */
1097
1908
  async isFeedDone(id) {
1098
1909
  return this.queryAndCheckError(Documents.IsFeedDone, { id: id });
1099
1910
  }
1911
+ /**
1912
+ * Prompts multiple specifications and returns the best response.
1913
+ * @param prompt - The prompt to send to each specification.
1914
+ * @param ids - The IDs of the specifications to prompt.
1915
+ * @returns The best response.
1916
+ */
1100
1917
  async promptSpecifications(prompt, ids) {
1101
1918
  return this.mutateAndCheckError(Documents.PromptSpecifications, { prompt: prompt, ids: ids });
1102
1919
  }
1920
+ /**
1921
+ * Creates a specification (LLM configuration).
1922
+ * @param specification - The specification to create.
1923
+ * @returns The created specification.
1924
+ */
1103
1925
  async createSpecification(specification) {
1104
1926
  return this.mutateAndCheckError(Documents.CreateSpecification, { specification: specification });
1105
1927
  }
1928
+ /**
1929
+ * Updates a specification.
1930
+ * @param specification - The specification to update.
1931
+ * @returns The updated specification.
1932
+ */
1106
1933
  async updateSpecification(specification) {
1107
1934
  return this.mutateAndCheckError(Documents.UpdateSpecification, { specification: specification });
1108
1935
  }
1936
+ /**
1937
+ * Creates or updates a specification.
1938
+ * @param specification - The specification to create or update.
1939
+ * @returns The created or updated specification.
1940
+ */
1109
1941
  async upsertSpecification(specification) {
1110
1942
  return this.mutateAndCheckError(Documents.UpsertSpecification, { specification: specification });
1111
1943
  }
1944
+ /**
1945
+ * Deletes a specification.
1946
+ * @param id - The ID of the specification to delete.
1947
+ * @returns The deleted specification.
1948
+ */
1112
1949
  async deleteSpecification(id) {
1113
1950
  return this.mutateAndCheckError(Documents.DeleteSpecification, { id: id });
1114
1951
  }
1952
+ /**
1953
+ * Deletes multiple specifications.
1954
+ * @param ids - The IDs of the specifications to delete.
1955
+ * @param isSynchronous - Whether this mutation is synchronous.
1956
+ * @returns The deleted specifications.
1957
+ */
1115
1958
  async deleteSpecifications(ids, isSynchronous) {
1116
1959
  return this.mutateAndCheckError(Documents.DeleteSpecifications, {
1117
1960
  ids: ids,
1118
1961
  isSynchronous: isSynchronous,
1119
1962
  });
1120
1963
  }
1964
+ /**
1965
+ * Deletes all specifications based on the provided filter criteria.
1966
+ * @param filter - The filter criteria to apply when deleting specifications.
1967
+ * @param isSynchronous - Whether this mutation is synchronous.
1968
+ * @param correlationId - The tenant correlation identifier, optional.
1969
+ * @returns The result of the deletion.
1970
+ */
1121
1971
  async deleteAllSpecifications(filter, isSynchronous, correlationId) {
1122
1972
  return this.mutateAndCheckError(Documents.DeleteAllSpecifications, {
1123
1973
  filter: filter,
@@ -1125,24 +1975,59 @@ class Graphlit {
1125
1975
  correlationId: correlationId,
1126
1976
  });
1127
1977
  }
1978
+ /**
1979
+ * Lookup a specification given its ID.
1980
+ * @param id - ID of the specification.
1981
+ * @returns The specification.
1982
+ */
1128
1983
  async getSpecification(id) {
1129
1984
  return this.queryAndCheckError(Documents.GetSpecification, { id: id });
1130
1985
  }
1986
+ /**
1987
+ * Retrieves specifications based on the provided filter criteria.
1988
+ * @param filter - The filter criteria to apply when retrieving specifications.
1989
+ * @returns The specifications.
1990
+ */
1131
1991
  async querySpecifications(filter) {
1132
1992
  return this.queryAndCheckError(Documents.QuerySpecifications, { filter: filter });
1133
1993
  }
1994
+ /**
1995
+ * Counts specifications based on the provided filter criteria.
1996
+ * @param filter - The filter criteria to apply when counting specifications.
1997
+ * @returns The count of specifications.
1998
+ */
1134
1999
  async countSpecifications(filter) {
1135
2000
  return this.queryAndCheckError(Documents.CountSpecifications, { filter: filter });
1136
2001
  }
2002
+ /**
2003
+ * Checks if a specification exists based on the provided filter criteria.
2004
+ * @param filter - The filter criteria to apply.
2005
+ * @returns Whether the specification exists.
2006
+ */
1137
2007
  async specificationExists(filter) {
1138
2008
  return this.queryAndCheckError(Documents.SpecificationExists, { filter: filter });
1139
2009
  }
2010
+ /**
2011
+ * Retrieves available LLM models based on the provided filter criteria.
2012
+ * @param filter - The filter criteria to apply when retrieving models.
2013
+ * @returns The available models.
2014
+ */
1140
2015
  async queryModels(filter) {
1141
2016
  return this.queryAndCheckError(Documents.QueryModels, { filter: filter });
1142
2017
  }
2018
+ /**
2019
+ * Creates a connector for external integrations.
2020
+ * @param connector - The connector to create.
2021
+ * @returns The created connector.
2022
+ */
1143
2023
  async createConnector(connector) {
1144
2024
  return this.mutateAndCheckError(Documents.CreateConnector, { connector: connector });
1145
2025
  }
2026
+ /**
2027
+ * Updates a connector.
2028
+ * @param connector - The connector to update.
2029
+ * @returns The updated connector.
2030
+ */
1146
2031
  async updateConnector(connector) {
1147
2032
  return this.mutateAndCheckError(Documents.UpdateConnector, { connector: connector });
1148
2033
  }
@@ -1156,6 +2041,11 @@ class Graphlit {
1156
2041
  >(Documents.UpsertConnector, { connector: connector });
1157
2042
  }
1158
2043
  */
2044
+ /**
2045
+ * Deletes a connector.
2046
+ * @param id - The ID of the connector to delete.
2047
+ * @returns The deleted connector.
2048
+ */
1159
2049
  async deleteConnector(id) {
1160
2050
  return this.mutateAndCheckError(Documents.DeleteConnector, { id: id });
1161
2051
  }
@@ -1189,12 +2079,27 @@ class Graphlit {
1189
2079
  });
1190
2080
  }
1191
2081
  */
2082
+ /**
2083
+ * Lookup a connector given its ID.
2084
+ * @param id - ID of the connector.
2085
+ * @returns The connector.
2086
+ */
1192
2087
  async getConnector(id) {
1193
2088
  return this.queryAndCheckError(Documents.GetConnector, { id: id });
1194
2089
  }
2090
+ /**
2091
+ * Retrieves connectors based on the provided filter criteria.
2092
+ * @param filter - The filter criteria to apply when retrieving connectors.
2093
+ * @returns The connectors.
2094
+ */
1195
2095
  async queryConnectors(filter) {
1196
2096
  return this.queryAndCheckError(Documents.QueryConnectors, { filter: filter });
1197
2097
  }
2098
+ /**
2099
+ * Counts connectors based on the provided filter criteria.
2100
+ * @param filter - The filter criteria to apply when counting connectors.
2101
+ * @returns The count of connectors.
2102
+ */
1198
2103
  async countConnectors(filter) {
1199
2104
  return this.queryAndCheckError(Documents.CountConnectors, { filter: filter });
1200
2105
  }
@@ -1205,21 +2110,54 @@ class Graphlit {
1205
2110
  return this.queryAndCheckError<Types.QueryConnectorsQuery, Types.QueryConnectorsQueryVariables>(Documents.ConnectorExists, { filter: filter });
1206
2111
  }
1207
2112
  */
2113
+ /**
2114
+ * Creates a view for content filtering.
2115
+ * @param view - The view to create.
2116
+ * @returns The created view.
2117
+ */
1208
2118
  async createView(view) {
1209
2119
  return this.mutateAndCheckError(Documents.CreateView, { view: view });
1210
2120
  }
2121
+ /**
2122
+ * Updates a view.
2123
+ * @param view - The view to update.
2124
+ * @returns The updated view.
2125
+ */
1211
2126
  async updateView(view) {
1212
2127
  return this.mutateAndCheckError(Documents.UpdateView, { view: view });
1213
2128
  }
2129
+ /**
2130
+ * Creates or updates a view.
2131
+ * @param view - The view to create or update.
2132
+ * @returns The created or updated view.
2133
+ */
1214
2134
  async upsertView(view) {
1215
2135
  return this.mutateAndCheckError(Documents.UpsertView, { view: view });
1216
2136
  }
2137
+ /**
2138
+ * Deletes a view.
2139
+ * @param id - The ID of the view to delete.
2140
+ * @returns The deleted view.
2141
+ */
1217
2142
  async deleteView(id) {
1218
2143
  return this.mutateAndCheckError(Documents.DeleteView, { id: id });
1219
2144
  }
2145
+ /**
2146
+ * Deletes multiple views.
2147
+ * @param ids - The IDs of the views to delete.
2148
+ * @param isSynchronous - Whether this mutation is synchronous.
2149
+ * @returns The deleted views.
2150
+ */
1220
2151
  async deleteViews(ids, isSynchronous) {
1221
2152
  return this.mutateAndCheckError(Documents.DeleteViews, { ids: ids, isSynchronous: isSynchronous });
1222
2153
  }
2154
+ /**
2155
+ * Deletes all views based on the provided filter criteria.
2156
+ * @param filter - The filter criteria to apply when deleting views.
2157
+ * @param isSynchronous - Whether this mutation is synchronous.
2158
+ * @param correlationId - The tenant correlation identifier, optional.
2159
+ * @returns The result of the deletion.
2160
+ */
1223
2161
  async deleteAllViews(filter, isSynchronous, correlationId) {
1224
2162
  return this.mutateAndCheckError(Documents.DeleteAllViews, {
1225
2163
  filter: filter,
@@ -1227,33 +2165,86 @@ class Graphlit {
1227
2165
  correlationId: correlationId,
1228
2166
  });
1229
2167
  }
2168
+ /**
2169
+ * Lookup a view given its ID.
2170
+ * @param id - ID of the view.
2171
+ * @returns The view.
2172
+ */
1230
2173
  async getView(id) {
1231
2174
  return this.queryAndCheckError(Documents.GetView, { id: id });
1232
2175
  }
2176
+ /**
2177
+ * Retrieves views based on the provided filter criteria.
2178
+ * @param filter - The filter criteria to apply when retrieving views.
2179
+ * @returns The views.
2180
+ */
1233
2181
  async queryViews(filter) {
1234
2182
  return this.queryAndCheckError(Documents.QueryViews, { filter: filter });
1235
2183
  }
2184
+ /**
2185
+ * Counts views based on the provided filter criteria.
2186
+ * @param filter - The filter criteria to apply when counting views.
2187
+ * @returns The count of views.
2188
+ */
1236
2189
  async countViews(filter) {
1237
2190
  return this.queryAndCheckError(Documents.CountViews, { filter: filter });
1238
2191
  }
2192
+ /**
2193
+ * Checks if a view exists based on the provided filter criteria.
2194
+ * @param filter - The filter criteria to apply.
2195
+ * @returns Whether the view exists.
2196
+ */
1239
2197
  async viewExists(filter) {
1240
2198
  return this.queryAndCheckError(Documents.ViewExists, { filter: filter });
1241
2199
  }
2200
+ /**
2201
+ * Creates a workflow for content processing.
2202
+ * @param workflow - The workflow to create.
2203
+ * @returns The created workflow.
2204
+ */
1242
2205
  async createWorkflow(workflow) {
1243
2206
  return this.mutateAndCheckError(Documents.CreateWorkflow, { workflow: workflow });
1244
2207
  }
2208
+ /**
2209
+ * Updates a workflow.
2210
+ * @param workflow - The workflow to update.
2211
+ * @returns The updated workflow.
2212
+ */
1245
2213
  async updateWorkflow(workflow) {
1246
2214
  return this.mutateAndCheckError(Documents.UpdateWorkflow, { workflow: workflow });
1247
2215
  }
2216
+ /**
2217
+ * Creates or updates a workflow.
2218
+ * @param workflow - The workflow to create or update.
2219
+ * @returns The created or updated workflow.
2220
+ */
1248
2221
  async upsertWorkflow(workflow) {
1249
2222
  return this.mutateAndCheckError(Documents.UpsertWorkflow, { workflow: workflow });
1250
2223
  }
2224
+ /**
2225
+ * Deletes a workflow.
2226
+ * @param id - The ID of the workflow to delete.
2227
+ * @returns The deleted workflow.
2228
+ */
1251
2229
  async deleteWorkflow(id) {
1252
2230
  return this.mutateAndCheckError(Documents.DeleteWorkflow, { id: id });
1253
2231
  }
2232
+ /**
2233
+ * Deletes multiple workflows.
2234
+ * @param ids - The IDs of the workflows to delete.
2235
+ * @param isSynchronous - Whether this mutation is synchronous.
2236
+ * @returns The deleted workflows.
2237
+ */
1254
2238
  async deleteWorkflows(ids, isSynchronous) {
1255
2239
  return this.mutateAndCheckError(Documents.DeleteWorkflows, { ids: ids, isSynchronous: isSynchronous });
1256
2240
  }
2241
+ /**
2242
+ * Deletes all workflows based on the provided filter criteria.
2243
+ * @param filter - The filter criteria to apply when deleting workflows.
2244
+ * @param isSynchronous - Whether this mutation is synchronous.
2245
+ * @param correlationId - The tenant correlation identifier, optional.
2246
+ * @returns The result of the deletion.
2247
+ */
1257
2248
  async deleteAllWorkflows(filter, isSynchronous, correlationId) {
1258
2249
  return this.mutateAndCheckError(Documents.DeleteAllWorkflows, {
1259
2250
  filter: filter,
@@ -1261,60 +2252,157 @@ class Graphlit {
1261
2252
  correlationId: correlationId,
1262
2253
  });
1263
2254
  }
2255
+ /**
2256
+ * Lookup a workflow given its ID.
2257
+ * @param id - ID of the workflow.
2258
+ * @returns The workflow.
2259
+ */
1264
2260
  async getWorkflow(id) {
1265
2261
  return this.queryAndCheckError(Documents.GetWorkflow, { id: id });
1266
2262
  }
2263
+ /**
2264
+ * Retrieves workflows based on the provided filter criteria.
2265
+ * @param filter - The filter criteria to apply when retrieving workflows.
2266
+ * @returns The workflows.
2267
+ */
1267
2268
  async queryWorkflows(filter) {
1268
2269
  return this.queryAndCheckError(Documents.QueryWorkflows, { filter: filter });
1269
2270
  }
2271
+ /**
2272
+ * Counts workflows based on the provided filter criteria.
2273
+ * @param filter - The filter criteria to apply when counting workflows.
2274
+ * @returns The count of workflows.
2275
+ */
1270
2276
  async countWorkflows(filter) {
1271
2277
  return this.queryAndCheckError(Documents.CountWorkflows, { filter: filter });
1272
2278
  }
2279
+ /**
2280
+ * Checks if a workflow exists based on the provided filter criteria.
2281
+ * @param filter - The filter criteria to apply.
2282
+ * @returns Whether the workflow exists.
2283
+ */
1273
2284
  async workflowExists(filter) {
1274
2285
  return this.queryAndCheckError(Documents.WorkflowExists, { filter: filter });
1275
2286
  }
2287
+ /**
2288
+ * Creates a user.
2289
+ * @param user - The user to create.
2290
+ * @returns The created user.
2291
+ */
1276
2292
  async createUser(user) {
1277
2293
  return this.mutateAndCheckError(Documents.CreateUser, { user: user });
1278
2294
  }
2295
+ /**
2296
+ * Updates a user.
2297
+ * @param user - The user to update.
2298
+ * @returns The updated user.
2299
+ */
1279
2300
  async updateUser(user) {
1280
2301
  return this.mutateAndCheckError(Documents.UpdateUser, { user: user });
1281
2302
  }
2303
+ /**
2304
+ * Deletes a user.
2305
+ * @param id - The ID of the user to delete.
2306
+ * @returns The deleted user.
2307
+ */
1282
2308
  async deleteUser(id) {
1283
2309
  return this.mutateAndCheckError(Documents.DeleteUser, { id: id });
1284
2310
  }
2311
+ /**
2312
+ * Lookup a user by their external identifier.
2313
+ * @param identifier - The external identifier.
2314
+ * @returns The user.
2315
+ */
1285
2316
  async getUserByIdentifier(identifier) {
1286
2317
  return this.queryAndCheckError(Documents.GetUserByIdentifier, { identifier: identifier });
1287
2318
  }
2319
+ /**
2320
+ * Gets the current authenticated user.
2321
+ * @returns The current user.
2322
+ */
1288
2323
  async getUser() {
1289
2324
  return this.queryAndCheckError(Documents.GetUser, {});
1290
2325
  }
2326
+ /**
2327
+ * Retrieves users based on the provided filter criteria.
2328
+ * @param filter - The filter criteria to apply when retrieving users.
2329
+ * @returns The users.
2330
+ */
1291
2331
  async queryUsers(filter) {
1292
2332
  return this.queryAndCheckError(Documents.QueryUsers, { filter: filter });
1293
2333
  }
2334
+ /**
2335
+ * Counts users based on the provided filter criteria.
2336
+ * @param filter - The filter criteria to apply when counting users.
2337
+ * @returns The count of users.
2338
+ */
1294
2339
  async countUsers(filter) {
1295
2340
  return this.queryAndCheckError(Documents.CountUsers, { filter: filter });
1296
2341
  }
2342
+ /**
2343
+ * Enables a user.
2344
+ * @param id - The ID of the user to enable.
2345
+ * @returns The enabled user.
2346
+ */
1297
2347
  async enableUser(id) {
1298
2348
  return this.mutateAndCheckError(Documents.EnableUser, { id: id });
1299
2349
  }
2350
+ /**
2351
+ * Disables a user.
2352
+ * @param id - The ID of the user to disable.
2353
+ * @returns The disabled user.
2354
+ */
1300
2355
  async disableUser(id) {
1301
2356
  return this.mutateAndCheckError(Documents.DisableUser, { id: id });
1302
2357
  }
2358
+ /**
2359
+ * Creates a category for content classification.
2360
+ * @param category - The category to create.
2361
+ * @returns The created category.
2362
+ */
1303
2363
  async createCategory(category) {
1304
2364
  return this.mutateAndCheckError(Documents.CreateCategory, { category: category });
1305
2365
  }
2366
+ /**
2367
+ * Updates a category.
2368
+ * @param category - The category to update.
2369
+ * @returns The updated category.
2370
+ */
1306
2371
  async updateCategory(category) {
1307
2372
  return this.mutateAndCheckError(Documents.UpdateCategory, { category: category });
1308
2373
  }
2374
+ /**
2375
+ * Creates or updates a category.
2376
+ * @param category - The category to create or update.
2377
+ * @returns The created or updated category.
2378
+ */
1309
2379
  async upsertCategory(category) {
1310
2380
  return this.mutateAndCheckError(Documents.UpsertCategory, { category: category });
1311
2381
  }
2382
+ /**
2383
+ * Deletes a category.
2384
+ * @param id - The ID of the category to delete.
2385
+ * @returns The deleted category.
2386
+ */
1312
2387
  async deleteCategory(id) {
1313
2388
  return this.mutateAndCheckError(Documents.DeleteCategory, { id: id });
1314
2389
  }
2390
+ /**
2391
+ * Deletes multiple categories.
2392
+ * @param ids - The IDs of the categories to delete.
2393
+ * @param isSynchronous - Whether this mutation is synchronous.
2394
+ * @returns The deleted categories.
2395
+ */
1315
2396
  async deleteCategories(ids, isSynchronous) {
1316
2397
  return this.mutateAndCheckError(Documents.DeleteCategories, { ids: ids, isSynchronous: isSynchronous });
1317
2398
  }
2399
+ /**
2400
+ * Deletes all categories based on the provided filter criteria.
2401
+ * @param filter - The filter criteria to apply when deleting categories.
2402
+ * @param isSynchronous - Whether this mutation is synchronous.
2403
+ * @param correlationId - The tenant correlation identifier, optional.
2404
+ * @returns The result of the deletion.
2405
+ */
1318
2406
  async deleteAllCategories(filter, isSynchronous, correlationId) {
1319
2407
  return this.mutateAndCheckError(Documents.DeleteAllCategories, {
1320
2408
  filter: filter,
@@ -1322,33 +2410,82 @@ class Graphlit {
1322
2410
  correlationId: correlationId,
1323
2411
  });
1324
2412
  }
2413
+ /**
2414
+ * Lookup a category given its ID.
2415
+ * @param id - ID of the category.
2416
+ * @returns The category.
2417
+ */
1325
2418
  async getCategory(id) {
1326
2419
  return this.queryAndCheckError(Documents.GetCategory, { id: id });
1327
2420
  }
2421
+ /**
2422
+ * Retrieves categories based on the provided filter criteria.
2423
+ * @param filter - The filter criteria to apply when retrieving categories.
2424
+ * @returns The categories.
2425
+ */
1328
2426
  async queryCategories(filter) {
1329
2427
  return this.queryAndCheckError(Documents.QueryCategories, { filter: filter });
1330
2428
  }
2429
+ /**
2430
+ * Counts categories based on the provided filter criteria.
2431
+ * @param filter - The filter criteria to apply when counting categories.
2432
+ * @param correlationId - The tenant correlation identifier, optional.
2433
+ * @returns The count of categories.
2434
+ */
1331
2435
  async countCategories(filter, correlationId) {
1332
2436
  return this.queryAndCheckError(Documents.CountCategories, {
1333
2437
  filter: filter,
1334
2438
  correlationId: correlationId,
1335
2439
  });
1336
2440
  }
2441
+ /**
2442
+ * Creates a label for content tagging.
2443
+ * @param label - The label to create.
2444
+ * @returns The created label.
2445
+ */
1337
2446
  async createLabel(label) {
1338
2447
  return this.mutateAndCheckError(Documents.CreateLabel, { label: label });
1339
2448
  }
2449
+ /**
2450
+ * Updates a label.
2451
+ * @param label - The label to update.
2452
+ * @returns The updated label.
2453
+ */
1340
2454
  async updateLabel(label) {
1341
2455
  return this.mutateAndCheckError(Documents.UpdateLabel, { label: label });
1342
2456
  }
2457
+ /**
2458
+ * Creates or updates a label.
2459
+ * @param label - The label to create or update.
2460
+ * @returns The created or updated label.
2461
+ */
1343
2462
  async upsertLabel(label) {
1344
2463
  return this.mutateAndCheckError(Documents.UpsertLabel, { label: label });
1345
2464
  }
2465
+ /**
2466
+ * Deletes a label.
2467
+ * @param id - The ID of the label to delete.
2468
+ * @returns The deleted label.
2469
+ */
1346
2470
  async deleteLabel(id) {
1347
2471
  return this.mutateAndCheckError(Documents.DeleteLabel, { id: id });
1348
2472
  }
2473
+ /**
2474
+ * Deletes multiple labels.
2475
+ * @param ids - The IDs of the labels to delete.
2476
+ * @param isSynchronous - Whether this mutation is synchronous.
2477
+ * @returns The deleted labels.
2478
+ */
1349
2479
  async deleteLabels(ids, isSynchronous) {
1350
2480
  return this.mutateAndCheckError(Documents.DeleteLabels, { ids: ids, isSynchronous: isSynchronous });
1351
2481
  }
2482
+ /**
2483
+ * Deletes all labels based on the provided filter criteria.
2484
+ * @param filter - The filter criteria to apply when deleting labels.
2485
+ * @param isSynchronous - Whether this mutation is synchronous.
2486
+ * @param correlationId - The tenant correlation identifier, optional.
2487
+ * @returns The result of the deletion.
2488
+ */
1352
2489
  async deleteAllLabels(filter, isSynchronous, correlationId) {
1353
2490
  return this.mutateAndCheckError(Documents.DeleteAllLabels, {
1354
2491
  filter: filter,
@@ -1356,30 +2493,74 @@ class Graphlit {
1356
2493
  correlationId: correlationId,
1357
2494
  });
1358
2495
  }
2496
+ /**
2497
+ * Lookup a label given its ID.
2498
+ * @param id - ID of the label.
2499
+ * @returns The label.
2500
+ */
1359
2501
  async getLabel(id) {
1360
2502
  return this.queryAndCheckError(Documents.GetLabel, { id: id });
1361
2503
  }
2504
+ /**
2505
+ * Retrieves labels based on the provided filter criteria.
2506
+ * @param filter - The filter criteria to apply when retrieving labels.
2507
+ * @returns The labels.
2508
+ */
1362
2509
  async queryLabels(filter) {
1363
2510
  return this.queryAndCheckError(Documents.QueryLabels, { filter: filter });
1364
2511
  }
2512
+ /**
2513
+ * Counts labels based on the provided filter criteria.
2514
+ * @param filter - The filter criteria to apply when counting labels.
2515
+ * @param correlationId - The tenant correlation identifier, optional.
2516
+ * @returns The count of labels.
2517
+ */
1365
2518
  async countLabels(filter, correlationId) {
1366
2519
  return this.queryAndCheckError(Documents.CountLabels, {
1367
2520
  filter: filter,
1368
2521
  correlationId: correlationId,
1369
2522
  });
1370
2523
  }
2524
+ /**
2525
+ * Creates a person entity.
2526
+ * @param person - The person to create.
2527
+ * @returns The created person.
2528
+ */
1371
2529
  async createPerson(person) {
1372
2530
  return this.mutateAndCheckError(Documents.CreatePerson, { person: person });
1373
2531
  }
2532
+ /**
2533
+ * Updates a person entity.
2534
+ * @param person - The person to update.
2535
+ * @returns The updated person.
2536
+ */
1374
2537
  async updatePerson(person) {
1375
2538
  return this.mutateAndCheckError(Documents.UpdatePerson, { person: person });
1376
2539
  }
2540
+ /**
2541
+ * Deletes a person entity.
2542
+ * @param id - The ID of the person to delete.
2543
+ * @returns The deleted person.
2544
+ */
1377
2545
  async deletePerson(id) {
1378
2546
  return this.mutateAndCheckError(Documents.DeletePerson, { id: id });
1379
2547
  }
2548
+ /**
2549
+ * Deletes multiple person entities.
2550
+ * @param ids - The IDs of the persons to delete.
2551
+ * @param isSynchronous - Whether this mutation is synchronous.
2552
+ * @returns The deleted persons.
2553
+ */
1380
2554
  async deletePersons(ids, isSynchronous) {
1381
2555
  return this.mutateAndCheckError(Documents.DeletePersons, { ids: ids, isSynchronous: isSynchronous });
1382
2556
  }
2557
+ /**
2558
+ * Deletes all persons based on the provided filter criteria.
2559
+ * @param filter - The filter criteria to apply when deleting persons.
2560
+ * @param isSynchronous - Whether this mutation is synchronous.
2561
+ * @param correlationId - The tenant correlation identifier, optional.
2562
+ * @returns The result of the deletion.
2563
+ */
1383
2564
  async deleteAllPersons(filter, isSynchronous, correlationId) {
1384
2565
  return this.mutateAndCheckError(Documents.DeleteAllPersons, {
1385
2566
  filter: filter,
@@ -1387,12 +2568,30 @@ class Graphlit {
1387
2568
  correlationId: correlationId,
1388
2569
  });
1389
2570
  }
2571
+ /**
2572
+ * Lookup a person given their ID.
2573
+ * @param id - ID of the person.
2574
+ * @returns The person.
2575
+ */
1390
2576
  async getPerson(id) {
1391
2577
  return this.queryAndCheckError(Documents.GetPerson, { id: id });
1392
2578
  }
2579
+ /**
2580
+ * Retrieves persons based on the provided filter criteria.
2581
+ * @param filter - The filter criteria to apply when retrieving persons.
2582
+ * @param correlationId - The tenant correlation identifier, optional.
2583
+ * @returns The persons.
2584
+ */
1393
2585
  async queryPersons(filter, correlationId) {
1394
2586
  return this.queryAndCheckError(Documents.QueryPersons, { filter: filter, correlationId: correlationId });
1395
2587
  }
2588
+ /**
2589
+ * Retrieves persons with clustering information.
2590
+ * @param filter - The filter criteria to apply when retrieving persons.
2591
+ * @param clusters - The clustering configuration.
2592
+ * @param correlationId - The tenant correlation identifier, optional.
2593
+ * @returns The persons with clusters.
2594
+ */
1396
2595
  async queryPersonsClusters(filter, clusters, correlationId) {
1397
2596
  return this.queryAndCheckError(Documents.QueryPersonsClusters, {
1398
2597
  filter: filter,
@@ -1400,18 +2599,37 @@ class Graphlit {
1400
2599
  correlationId: correlationId,
1401
2600
  });
1402
2601
  }
2602
+ /**
2603
+ * Retrieves persons with expanded details.
2604
+ * @param filter - The filter criteria to apply when retrieving persons.
2605
+ * @param correlationId - The tenant correlation identifier, optional.
2606
+ * @returns The persons with expanded details.
2607
+ */
1403
2608
  async queryPersonsExpanded(filter, correlationId) {
1404
2609
  return this.queryAndCheckError(Documents.QueryPersonsExpanded, {
1405
2610
  filter: filter,
1406
2611
  correlationId: correlationId,
1407
2612
  });
1408
2613
  }
2614
+ /**
2615
+ * Counts persons based on the provided filter criteria.
2616
+ * @param filter - The filter criteria to apply when counting persons.
2617
+ * @param correlationId - The tenant correlation identifier, optional.
2618
+ * @returns The count of persons.
2619
+ */
1409
2620
  async countPersons(filter, correlationId) {
1410
2621
  return this.queryAndCheckError(Documents.CountPersons, {
1411
2622
  filter: filter,
1412
2623
  correlationId: correlationId,
1413
2624
  });
1414
2625
  }
2626
+ /**
2627
+ * Enriches persons using an external connector.
2628
+ * @param connector - The enrichment connector configuration.
2629
+ * @param filter - The filter criteria to apply when selecting persons.
2630
+ * @param correlationId - The tenant correlation identifier, optional.
2631
+ * @returns The enrichment result.
2632
+ */
1415
2633
  async enrichPersons(connector, filter, correlationId) {
1416
2634
  return this.mutateAndCheckError(Documents.EnrichPersons, {
1417
2635
  connector: connector,
@@ -1419,21 +2637,49 @@ class Graphlit {
1419
2637
  correlationId: correlationId,
1420
2638
  });
1421
2639
  }
2640
+ /**
2641
+ * Creates an organization entity.
2642
+ * @param organization - The organization to create.
2643
+ * @returns The created organization.
2644
+ */
1422
2645
  async createOrganization(organization) {
1423
2646
  return this.mutateAndCheckError(Documents.CreateOrganization, { organization: organization });
1424
2647
  }
2648
+ /**
2649
+ * Updates an organization entity.
2650
+ * @param organization - The organization to update.
2651
+ * @returns The updated organization.
2652
+ */
1425
2653
  async updateOrganization(organization) {
1426
2654
  return this.mutateAndCheckError(Documents.UpdateOrganization, { organization: organization });
1427
2655
  }
2656
+ /**
2657
+ * Deletes an organization entity.
2658
+ * @param id - The ID of the organization to delete.
2659
+ * @returns The deleted organization.
2660
+ */
1428
2661
  async deleteOrganization(id) {
1429
2662
  return this.mutateAndCheckError(Documents.DeleteOrganization, { id: id });
1430
2663
  }
2664
+ /**
2665
+ * Deletes multiple organization entities.
2666
+ * @param ids - The IDs of the organizations to delete.
2667
+ * @param isSynchronous - Whether this mutation is synchronous.
2668
+ * @returns The deleted organizations.
2669
+ */
1431
2670
  async deleteOrganizations(ids, isSynchronous) {
1432
2671
  return this.mutateAndCheckError(Documents.DeleteOrganizations, {
1433
2672
  ids: ids,
1434
2673
  isSynchronous: isSynchronous,
1435
2674
  });
1436
2675
  }
2676
+ /**
2677
+ * Deletes all organizations based on the provided filter criteria.
2678
+ * @param filter - The filter criteria to apply when deleting organizations.
2679
+ * @param isSynchronous - Whether this mutation is synchronous.
2680
+ * @param correlationId - The tenant correlation identifier, optional.
2681
+ * @returns The result of the deletion.
2682
+ */
1437
2683
  async deleteAllOrganizations(filter, isSynchronous, correlationId) {
1438
2684
  return this.mutateAndCheckError(Documents.DeleteAllOrganizations, {
1439
2685
  filter: filter,
@@ -1441,12 +2687,30 @@ class Graphlit {
1441
2687
  correlationId: correlationId,
1442
2688
  });
1443
2689
  }
2690
+ /**
2691
+ * Lookup an organization given its ID.
2692
+ * @param id - ID of the organization.
2693
+ * @returns The organization.
2694
+ */
1444
2695
  async getOrganization(id) {
1445
2696
  return this.queryAndCheckError(Documents.GetOrganization, { id: id });
1446
2697
  }
2698
+ /**
2699
+ * Retrieves organizations based on the provided filter criteria.
2700
+ * @param filter - The filter criteria to apply when retrieving organizations.
2701
+ * @param correlationId - The tenant correlation identifier, optional.
2702
+ * @returns The organizations.
2703
+ */
1447
2704
  async queryOrganizations(filter, correlationId) {
1448
2705
  return this.queryAndCheckError(Documents.QueryOrganizations, { filter: filter, correlationId: correlationId });
1449
2706
  }
2707
+ /**
2708
+ * Retrieves organizations with clustering information.
2709
+ * @param filter - The filter criteria to apply when retrieving organizations.
2710
+ * @param clusters - The clustering configuration.
2711
+ * @param correlationId - The tenant correlation identifier, optional.
2712
+ * @returns The organizations with clusters.
2713
+ */
1450
2714
  async queryOrganizationsClusters(filter, clusters, correlationId) {
1451
2715
  return this.queryAndCheckError(Documents.QueryOrganizationsClusters, {
1452
2716
  filter: filter,
@@ -1454,18 +2718,37 @@ class Graphlit {
1454
2718
  correlationId: correlationId,
1455
2719
  });
1456
2720
  }
2721
+ /**
2722
+ * Retrieves organizations with expanded details.
2723
+ * @param filter - The filter criteria to apply when retrieving organizations.
2724
+ * @param correlationId - The tenant correlation identifier, optional.
2725
+ * @returns The organizations with expanded details.
2726
+ */
1457
2727
  async queryOrganizationsExpanded(filter, correlationId) {
1458
2728
  return this.queryAndCheckError(Documents.QueryOrganizationsExpanded, {
1459
2729
  filter: filter,
1460
2730
  correlationId: correlationId,
1461
2731
  });
1462
2732
  }
2733
+ /**
2734
+ * Counts organizations based on the provided filter criteria.
2735
+ * @param filter - The filter criteria to apply when counting organizations.
2736
+ * @param correlationId - The tenant correlation identifier, optional.
2737
+ * @returns The count of organizations.
2738
+ */
1463
2739
  async countOrganizations(filter, correlationId) {
1464
2740
  return this.queryAndCheckError(Documents.CountOrganizations, {
1465
2741
  filter: filter,
1466
2742
  correlationId: correlationId,
1467
2743
  });
1468
2744
  }
2745
+ /**
2746
+ * Enriches organizations using an external connector.
2747
+ * @param connector - The enrichment connector configuration.
2748
+ * @param filter - The filter criteria to apply when selecting organizations.
2749
+ * @param correlationId - The tenant correlation identifier, optional.
2750
+ * @returns The enrichment result.
2751
+ */
1469
2752
  async enrichOrganizations(connector, filter, correlationId) {
1470
2753
  return this.mutateAndCheckError(Documents.EnrichOrganizations, {
1471
2754
  connector: connector,
@@ -1473,18 +2756,46 @@ class Graphlit {
1473
2756
  correlationId: correlationId,
1474
2757
  });
1475
2758
  }
2759
+ /**
2760
+ * Creates a place entity.
2761
+ * @param place - The place to create.
2762
+ * @returns The created place.
2763
+ */
1476
2764
  async createPlace(place) {
1477
2765
  return this.mutateAndCheckError(Documents.CreatePlace, { place: place });
1478
2766
  }
2767
+ /**
2768
+ * Updates a place entity.
2769
+ * @param place - The place to update.
2770
+ * @returns The updated place.
2771
+ */
1479
2772
  async updatePlace(place) {
1480
2773
  return this.mutateAndCheckError(Documents.UpdatePlace, { place: place });
1481
2774
  }
2775
+ /**
2776
+ * Deletes a place entity.
2777
+ * @param id - The ID of the place to delete.
2778
+ * @returns The deleted place.
2779
+ */
1482
2780
  async deletePlace(id) {
1483
2781
  return this.mutateAndCheckError(Documents.DeletePlace, { id: id });
1484
2782
  }
2783
+ /**
2784
+ * Deletes multiple place entities.
2785
+ * @param ids - The IDs of the places to delete.
2786
+ * @param isSynchronous - Whether this mutation is synchronous.
2787
+ * @returns The deleted places.
2788
+ */
1485
2789
  async deletePlaces(ids, isSynchronous) {
1486
2790
  return this.mutateAndCheckError(Documents.DeletePlaces, { ids: ids, isSynchronous: isSynchronous });
1487
2791
  }
2792
+ /**
2793
+ * Deletes all places based on the provided filter criteria.
2794
+ * @param filter - The filter criteria to apply when deleting places.
2795
+ * @param isSynchronous - Whether this mutation is synchronous.
2796
+ * @param correlationId - The tenant correlation identifier, optional.
2797
+ * @returns The result of the deletion.
2798
+ */
1488
2799
  async deleteAllPlaces(filter, isSynchronous, correlationId) {
1489
2800
  return this.mutateAndCheckError(Documents.DeleteAllPlaces, {
1490
2801
  filter: filter,
@@ -1492,12 +2803,30 @@ class Graphlit {
1492
2803
  correlationId: correlationId,
1493
2804
  });
1494
2805
  }
2806
+ /**
2807
+ * Lookup a place given its ID.
2808
+ * @param id - ID of the place.
2809
+ * @returns The place.
2810
+ */
1495
2811
  async getPlace(id) {
1496
2812
  return this.queryAndCheckError(Documents.GetPlace, { id: id });
1497
2813
  }
2814
+ /**
2815
+ * Retrieves places based on the provided filter criteria.
2816
+ * @param filter - The filter criteria to apply when retrieving places.
2817
+ * @param correlationId - The tenant correlation identifier, optional.
2818
+ * @returns The places.
2819
+ */
1498
2820
  async queryPlaces(filter, correlationId) {
1499
2821
  return this.queryAndCheckError(Documents.QueryPlaces, { filter: filter, correlationId: correlationId });
1500
2822
  }
2823
+ /**
2824
+ * Retrieves places with clustering information.
2825
+ * @param filter - The filter criteria to apply when retrieving places.
2826
+ * @param clusters - The clustering configuration.
2827
+ * @param correlationId - The tenant correlation identifier, optional.
2828
+ * @returns The places with clusters.
2829
+ */
1501
2830
  async queryPlacesClusters(filter, clusters, correlationId) {
1502
2831
  return this.queryAndCheckError(Documents.QueryPlacesClusters, {
1503
2832
  filter: filter,
@@ -1505,12 +2834,25 @@ class Graphlit {
1505
2834
  correlationId: correlationId,
1506
2835
  });
1507
2836
  }
2837
+ /**
2838
+ * Counts places based on the provided filter criteria.
2839
+ * @param filter - The filter criteria to apply when counting places.
2840
+ * @param correlationId - The tenant correlation identifier, optional.
2841
+ * @returns The count of places.
2842
+ */
1508
2843
  async countPlaces(filter, correlationId) {
1509
2844
  return this.queryAndCheckError(Documents.CountPlaces, {
1510
2845
  filter: filter,
1511
2846
  correlationId: correlationId,
1512
2847
  });
1513
2848
  }
2849
+ /**
2850
+ * Enriches places using an external connector.
2851
+ * @param connector - The enrichment connector configuration.
2852
+ * @param filter - The filter criteria to apply when selecting places.
2853
+ * @param correlationId - The tenant correlation identifier, optional.
2854
+ * @returns The enrichment result.
2855
+ */
1514
2856
  async enrichPlaces(connector, filter, correlationId) {
1515
2857
  return this.mutateAndCheckError(Documents.EnrichPlaces, {
1516
2858
  connector: connector,
@@ -1518,18 +2860,46 @@ class Graphlit {
1518
2860
  correlationId: correlationId,
1519
2861
  });
1520
2862
  }
2863
+ /**
2864
+ * Creates an event entity.
2865
+ * @param event - The event to create.
2866
+ * @returns The created event.
2867
+ */
1521
2868
  async createEvent(event) {
1522
2869
  return this.mutateAndCheckError(Documents.CreateEvent, { event: event });
1523
2870
  }
2871
+ /**
2872
+ * Updates an event entity.
2873
+ * @param event - The event to update.
2874
+ * @returns The updated event.
2875
+ */
1524
2876
  async updateEvent(event) {
1525
2877
  return this.mutateAndCheckError(Documents.UpdateEvent, { event: event });
1526
2878
  }
2879
+ /**
2880
+ * Deletes an event entity.
2881
+ * @param id - The ID of the event to delete.
2882
+ * @returns The deleted event.
2883
+ */
1527
2884
  async deleteEvent(id) {
1528
2885
  return this.mutateAndCheckError(Documents.DeleteEvent, { id: id });
1529
2886
  }
2887
+ /**
2888
+ * Deletes multiple event entities.
2889
+ * @param ids - The IDs of the events to delete.
2890
+ * @param isSynchronous - Whether this mutation is synchronous.
2891
+ * @returns The deleted events.
2892
+ */
1530
2893
  async deleteEvents(ids, isSynchronous) {
1531
2894
  return this.mutateAndCheckError(Documents.DeleteEvents, { ids: ids, isSynchronous: isSynchronous });
1532
2895
  }
2896
+ /**
2897
+ * Deletes all events based on the provided filter criteria.
2898
+ * @param filter - The filter criteria to apply when deleting events.
2899
+ * @param isSynchronous - Whether this mutation is synchronous.
2900
+ * @param correlationId - The tenant correlation identifier, optional.
2901
+ * @returns The result of the deletion.
2902
+ */
1533
2903
  async deleteAllEvents(filter, isSynchronous, correlationId) {
1534
2904
  return this.mutateAndCheckError(Documents.DeleteAllEvents, {
1535
2905
  filter: filter,
@@ -1537,12 +2907,30 @@ class Graphlit {
1537
2907
  correlationId: correlationId,
1538
2908
  });
1539
2909
  }
2910
+ /**
2911
+ * Lookup an event given its ID.
2912
+ * @param id - ID of the event.
2913
+ * @returns The event.
2914
+ */
1540
2915
  async getEvent(id) {
1541
2916
  return this.queryAndCheckError(Documents.GetEvent, { id: id });
1542
2917
  }
2918
+ /**
2919
+ * Retrieves events based on the provided filter criteria.
2920
+ * @param filter - The filter criteria to apply when retrieving events.
2921
+ * @param correlationId - The tenant correlation identifier, optional.
2922
+ * @returns The events.
2923
+ */
1543
2924
  async queryEvents(filter, correlationId) {
1544
2925
  return this.queryAndCheckError(Documents.QueryEvents, { filter: filter, correlationId: correlationId });
1545
2926
  }
2927
+ /**
2928
+ * Retrieves events with clustering information.
2929
+ * @param filter - The filter criteria to apply when retrieving events.
2930
+ * @param clusters - The clustering configuration.
2931
+ * @param correlationId - The tenant correlation identifier, optional.
2932
+ * @returns The events with clusters.
2933
+ */
1546
2934
  async queryEventsClusters(filter, clusters, correlationId) {
1547
2935
  return this.queryAndCheckError(Documents.QueryEventsClusters, {
1548
2936
  filter: filter,
@@ -1550,24 +2938,58 @@ class Graphlit {
1550
2938
  correlationId: correlationId,
1551
2939
  });
1552
2940
  }
2941
+ /**
2942
+ * Counts events based on the provided filter criteria.
2943
+ * @param filter - The filter criteria to apply when counting events.
2944
+ * @param correlationId - The tenant correlation identifier, optional.
2945
+ * @returns The count of events.
2946
+ */
1553
2947
  async countEvents(filter, correlationId) {
1554
2948
  return this.queryAndCheckError(Documents.CountEvents, {
1555
2949
  filter: filter,
1556
2950
  correlationId: correlationId,
1557
2951
  });
1558
2952
  }
2953
+ /**
2954
+ * Creates a product entity.
2955
+ * @param product - The product to create.
2956
+ * @returns The created product.
2957
+ */
1559
2958
  async createProduct(product) {
1560
2959
  return this.mutateAndCheckError(Documents.CreateProduct, { product: product });
1561
2960
  }
2961
+ /**
2962
+ * Updates a product entity.
2963
+ * @param product - The product to update.
2964
+ * @returns The updated product.
2965
+ */
1562
2966
  async updateProduct(product) {
1563
2967
  return this.mutateAndCheckError(Documents.UpdateProduct, { product: product });
1564
2968
  }
2969
+ /**
2970
+ * Deletes a product entity.
2971
+ * @param id - The ID of the product to delete.
2972
+ * @returns The deleted product.
2973
+ */
1565
2974
  async deleteProduct(id) {
1566
2975
  return this.mutateAndCheckError(Documents.DeleteProduct, { id: id });
1567
2976
  }
2977
+ /**
2978
+ * Deletes multiple product entities.
2979
+ * @param ids - The IDs of the products to delete.
2980
+ * @param isSynchronous - Whether this mutation is synchronous.
2981
+ * @returns The deleted products.
2982
+ */
1568
2983
  async deleteProducts(ids, isSynchronous) {
1569
2984
  return this.mutateAndCheckError(Documents.DeleteProducts, { ids: ids, isSynchronous: isSynchronous });
1570
2985
  }
2986
+ /**
2987
+ * Deletes all products based on the provided filter criteria.
2988
+ * @param filter - The filter criteria to apply when deleting products.
2989
+ * @param isSynchronous - Whether this mutation is synchronous.
2990
+ * @param correlationId - The tenant correlation identifier, optional.
2991
+ * @returns The result of the deletion.
2992
+ */
1571
2993
  async deleteAllProducts(filter, isSynchronous, correlationId) {
1572
2994
  return this.mutateAndCheckError(Documents.DeleteAllProducts, {
1573
2995
  filter: filter,
@@ -1575,12 +2997,30 @@ class Graphlit {
1575
2997
  correlationId: correlationId,
1576
2998
  });
1577
2999
  }
3000
+ /**
3001
+ * Lookup a product given its ID.
3002
+ * @param id - ID of the product.
3003
+ * @returns The product.
3004
+ */
1578
3005
  async getProduct(id) {
1579
3006
  return this.queryAndCheckError(Documents.GetProduct, { id: id });
1580
3007
  }
3008
+ /**
3009
+ * Retrieves products based on the provided filter criteria.
3010
+ * @param filter - The filter criteria to apply when retrieving products.
3011
+ * @param correlationId - The tenant correlation identifier, optional.
3012
+ * @returns The products.
3013
+ */
1581
3014
  async queryProducts(filter, correlationId) {
1582
3015
  return this.queryAndCheckError(Documents.QueryProducts, { filter: filter, correlationId: correlationId });
1583
3016
  }
3017
+ /**
3018
+ * Retrieves products with clustering information.
3019
+ * @param filter - The filter criteria to apply when retrieving products.
3020
+ * @param clusters - The clustering configuration.
3021
+ * @param correlationId - The tenant correlation identifier, optional.
3022
+ * @returns The products with clusters.
3023
+ */
1584
3024
  async queryProductsClusters(filter, clusters, correlationId) {
1585
3025
  return this.queryAndCheckError(Documents.QueryProductsClusters, {
1586
3026
  filter: filter,
@@ -1588,12 +3028,25 @@ class Graphlit {
1588
3028
  correlationId: correlationId,
1589
3029
  });
1590
3030
  }
3031
+ /**
3032
+ * Counts products based on the provided filter criteria.
3033
+ * @param filter - The filter criteria to apply when counting products.
3034
+ * @param correlationId - The tenant correlation identifier, optional.
3035
+ * @returns The count of products.
3036
+ */
1591
3037
  async countProducts(filter, correlationId) {
1592
3038
  return this.queryAndCheckError(Documents.CountProducts, {
1593
3039
  filter: filter,
1594
3040
  correlationId: correlationId,
1595
3041
  });
1596
3042
  }
3043
+ /**
3044
+ * Enriches products using an external connector.
3045
+ * @param connector - The enrichment connector configuration.
3046
+ * @param filter - The filter criteria to apply when selecting products.
3047
+ * @param correlationId - The tenant correlation identifier, optional.
3048
+ * @returns The enrichment result.
3049
+ */
1597
3050
  async enrichProducts(connector, filter, correlationId) {
1598
3051
  return this.mutateAndCheckError(Documents.EnrichProducts, {
1599
3052
  connector: connector,
@@ -1601,18 +3054,46 @@ class Graphlit {
1601
3054
  correlationId: correlationId,
1602
3055
  });
1603
3056
  }
3057
+ /**
3058
+ * Creates a repo (code repository) entity.
3059
+ * @param repo - The repo to create.
3060
+ * @returns The created repo.
3061
+ */
1604
3062
  async createRepo(repo) {
1605
3063
  return this.mutateAndCheckError(Documents.CreateRepo, { repo: repo });
1606
3064
  }
3065
+ /**
3066
+ * Updates a repo entity.
3067
+ * @param repo - The repo to update.
3068
+ * @returns The updated repo.
3069
+ */
1607
3070
  async updateRepo(repo) {
1608
3071
  return this.mutateAndCheckError(Documents.UpdateRepo, { repo: repo });
1609
3072
  }
3073
+ /**
3074
+ * Deletes a repo entity.
3075
+ * @param id - The ID of the repo to delete.
3076
+ * @returns The deleted repo.
3077
+ */
1610
3078
  async deleteRepo(id) {
1611
3079
  return this.mutateAndCheckError(Documents.DeleteRepo, { id: id });
1612
3080
  }
3081
+ /**
3082
+ * Deletes multiple repo entities.
3083
+ * @param ids - The IDs of the repos to delete.
3084
+ * @param isSynchronous - Whether this mutation is synchronous.
3085
+ * @returns The deleted repos.
3086
+ */
1613
3087
  async deleteRepos(ids, isSynchronous) {
1614
3088
  return this.mutateAndCheckError(Documents.DeleteRepos, { ids: ids, isSynchronous: isSynchronous });
1615
3089
  }
3090
+ /**
3091
+ * Deletes all repos based on the provided filter criteria.
3092
+ * @param filter - The filter criteria to apply when deleting repos.
3093
+ * @param isSynchronous - Whether this mutation is synchronous.
3094
+ * @param correlationId - The tenant correlation identifier, optional.
3095
+ * @returns The result of the deletion.
3096
+ */
1616
3097
  async deleteAllRepos(filter, isSynchronous, correlationId) {
1617
3098
  return this.mutateAndCheckError(Documents.DeleteAllRepos, {
1618
3099
  filter: filter,
@@ -1620,12 +3101,30 @@ class Graphlit {
1620
3101
  correlationId: correlationId,
1621
3102
  });
1622
3103
  }
3104
+ /**
3105
+ * Lookup a repo given its ID.
3106
+ * @param id - ID of the repo.
3107
+ * @returns The repo.
3108
+ */
1623
3109
  async getRepo(id) {
1624
3110
  return this.queryAndCheckError(Documents.GetRepo, { id: id });
1625
3111
  }
3112
+ /**
3113
+ * Retrieves repos based on the provided filter criteria.
3114
+ * @param filter - The filter criteria to apply when retrieving repos.
3115
+ * @param correlationId - The tenant correlation identifier, optional.
3116
+ * @returns The repos.
3117
+ */
1626
3118
  async queryRepos(filter, correlationId) {
1627
3119
  return this.queryAndCheckError(Documents.QueryRepos, { filter: filter, correlationId: correlationId });
1628
3120
  }
3121
+ /**
3122
+ * Retrieves repos with clustering information.
3123
+ * @param filter - The filter criteria to apply when retrieving repos.
3124
+ * @param clusters - The clustering configuration.
3125
+ * @param correlationId - The tenant correlation identifier, optional.
3126
+ * @returns The repos with clusters.
3127
+ */
1629
3128
  async queryReposClusters(filter, clusters, correlationId) {
1630
3129
  return this.queryAndCheckError(Documents.QueryReposClusters, {
1631
3130
  filter: filter,
@@ -1633,24 +3132,58 @@ class Graphlit {
1633
3132
  correlationId: correlationId,
1634
3133
  });
1635
3134
  }
3135
+ /**
3136
+ * Counts repos based on the provided filter criteria.
3137
+ * @param filter - The filter criteria to apply when counting repos.
3138
+ * @param correlationId - The tenant correlation identifier, optional.
3139
+ * @returns The count of repos.
3140
+ */
1636
3141
  async countRepos(filter, correlationId) {
1637
3142
  return this.queryAndCheckError(Documents.CountRepos, {
1638
3143
  filter: filter,
1639
3144
  correlationId: correlationId,
1640
3145
  });
1641
3146
  }
3147
+ /**
3148
+ * Creates a software entity.
3149
+ * @param software - The software to create.
3150
+ * @returns The created software.
3151
+ */
1642
3152
  async createSoftware(software) {
1643
3153
  return this.mutateAndCheckError(Documents.CreateSoftware, { software: software });
1644
3154
  }
3155
+ /**
3156
+ * Updates a software entity.
3157
+ * @param software - The software to update.
3158
+ * @returns The updated software.
3159
+ */
1645
3160
  async updateSoftware(software) {
1646
3161
  return this.mutateAndCheckError(Documents.UpdateSoftware, { software: software });
1647
3162
  }
3163
+ /**
3164
+ * Deletes a software entity.
3165
+ * @param id - The ID of the software to delete.
3166
+ * @returns The deleted software.
3167
+ */
1648
3168
  async deleteSoftware(id) {
1649
3169
  return this.mutateAndCheckError(Documents.DeleteSoftware, { id: id });
1650
3170
  }
3171
+ /**
3172
+ * Deletes multiple software entities.
3173
+ * @param ids - The IDs of the software to delete.
3174
+ * @param isSynchronous - Whether this mutation is synchronous.
3175
+ * @returns The deleted software.
3176
+ */
1651
3177
  async deleteSoftwares(ids, isSynchronous) {
1652
3178
  return this.mutateAndCheckError(Documents.DeleteSoftwares, { ids: ids, isSynchronous: isSynchronous });
1653
3179
  }
3180
+ /**
3181
+ * Deletes all software based on the provided filter criteria.
3182
+ * @param filter - The filter criteria to apply when deleting software.
3183
+ * @param isSynchronous - Whether this mutation is synchronous.
3184
+ * @param correlationId - The tenant correlation identifier, optional.
3185
+ * @returns The result of the deletion.
3186
+ */
1654
3187
  async deleteAllSoftwares(filter, isSynchronous, correlationId) {
1655
3188
  return this.mutateAndCheckError(Documents.DeleteAllSoftwares, {
1656
3189
  filter: filter,
@@ -1658,12 +3191,30 @@ class Graphlit {
1658
3191
  correlationId: correlationId,
1659
3192
  });
1660
3193
  }
3194
+ /**
3195
+ * Lookup a software given its ID.
3196
+ * @param id - ID of the software.
3197
+ * @returns The software.
3198
+ */
1661
3199
  async getSoftware(id) {
1662
3200
  return this.queryAndCheckError(Documents.GetSoftware, { id: id });
1663
3201
  }
3202
+ /**
3203
+ * Retrieves software based on the provided filter criteria.
3204
+ * @param filter - The filter criteria to apply when retrieving software.
3205
+ * @param correlationId - The tenant correlation identifier, optional.
3206
+ * @returns The software.
3207
+ */
1664
3208
  async querySoftwares(filter, correlationId) {
1665
3209
  return this.queryAndCheckError(Documents.QuerySoftwares, { filter: filter, correlationId: correlationId });
1666
3210
  }
3211
+ /**
3212
+ * Retrieves software with clustering information.
3213
+ * @param filter - The filter criteria to apply when retrieving software.
3214
+ * @param clusters - The clustering configuration.
3215
+ * @param correlationId - The tenant correlation identifier, optional.
3216
+ * @returns The software with clusters.
3217
+ */
1667
3218
  async querySoftwaresClusters(filter, clusters, correlationId) {
1668
3219
  return this.queryAndCheckError(Documents.QuerySoftwaresClusters, {
1669
3220
  filter: filter,
@@ -1671,27 +3222,38 @@ class Graphlit {
1671
3222
  correlationId: correlationId,
1672
3223
  });
1673
3224
  }
3225
+ /**
3226
+ * Counts software based on the provided filter criteria.
3227
+ * @param filter - The filter criteria to apply when counting software.
3228
+ * @param correlationId - The tenant correlation identifier, optional.
3229
+ * @returns The count of software.
3230
+ */
1674
3231
  async countSoftwares(filter, correlationId) {
1675
3232
  return this.queryAndCheckError(Documents.CountSoftwares, {
1676
3233
  filter: filter,
1677
3234
  correlationId: correlationId,
1678
3235
  });
1679
3236
  }
3237
+ /** Creates a medical condition entity. */
1680
3238
  async createMedicalCondition(MedicalCondition) {
1681
3239
  return this.mutateAndCheckError(Documents.CreateMedicalCondition, { medicalCondition: MedicalCondition });
1682
3240
  }
3241
+ /** Updates a medical condition entity. */
1683
3242
  async updateMedicalCondition(MedicalCondition) {
1684
3243
  return this.mutateAndCheckError(Documents.UpdateMedicalCondition, { medicalCondition: MedicalCondition });
1685
3244
  }
3245
+ /** Deletes a medical condition entity. */
1686
3246
  async deleteMedicalCondition(id) {
1687
3247
  return this.mutateAndCheckError(Documents.DeleteMedicalCondition, { id: id });
1688
3248
  }
3249
+ /** Deletes multiple medical condition entities. */
1689
3250
  async deleteMedicalConditions(ids, isSynchronous) {
1690
3251
  return this.mutateAndCheckError(Documents.DeleteMedicalConditions, {
1691
3252
  ids: ids,
1692
3253
  isSynchronous: isSynchronous,
1693
3254
  });
1694
3255
  }
3256
+ /** Deletes all medical conditions based on filter criteria. */
1695
3257
  async deleteAllMedicalConditions(filter, isSynchronous, correlationId) {
1696
3258
  return this.mutateAndCheckError(Documents.DeleteAllMedicalConditions, {
1697
3259
  filter: filter,
@@ -1699,12 +3261,15 @@ class Graphlit {
1699
3261
  correlationId: correlationId,
1700
3262
  });
1701
3263
  }
3264
+ /** Lookup a medical condition given its ID. */
1702
3265
  async getMedicalCondition(id) {
1703
3266
  return this.queryAndCheckError(Documents.GetMedicalCondition, { id: id });
1704
3267
  }
3268
+ /** Retrieves medical conditions based on filter criteria. */
1705
3269
  async queryMedicalConditions(filter, correlationId) {
1706
3270
  return this.queryAndCheckError(Documents.QueryMedicalConditions, { filter: filter, correlationId: correlationId });
1707
3271
  }
3272
+ /** Retrieves medical conditions with clustering information. */
1708
3273
  async queryMedicalConditionsClusters(filter, clusters, correlationId) {
1709
3274
  return this.queryAndCheckError(Documents.QueryMedicalConditionsClusters, {
1710
3275
  filter: filter,
@@ -1712,27 +3277,33 @@ class Graphlit {
1712
3277
  correlationId: correlationId,
1713
3278
  });
1714
3279
  }
3280
+ /** Counts medical conditions based on filter criteria. */
1715
3281
  async countMedicalConditions(filter, correlationId) {
1716
3282
  return this.queryAndCheckError(Documents.CountMedicalConditions, {
1717
3283
  filter: filter,
1718
3284
  correlationId: correlationId,
1719
3285
  });
1720
3286
  }
3287
+ /** Creates a medical guideline entity. */
1721
3288
  async createMedicalGuideline(MedicalGuideline) {
1722
3289
  return this.mutateAndCheckError(Documents.CreateMedicalGuideline, { medicalGuideline: MedicalGuideline });
1723
3290
  }
3291
+ /** Updates a medical guideline entity. */
1724
3292
  async updateMedicalGuideline(MedicalGuideline) {
1725
3293
  return this.mutateAndCheckError(Documents.UpdateMedicalGuideline, { medicalGuideline: MedicalGuideline });
1726
3294
  }
3295
+ /** Deletes a medical guideline entity. */
1727
3296
  async deleteMedicalGuideline(id) {
1728
3297
  return this.mutateAndCheckError(Documents.DeleteMedicalGuideline, { id: id });
1729
3298
  }
3299
+ /** Deletes multiple medical guideline entities. */
1730
3300
  async deleteMedicalGuidelines(ids, isSynchronous) {
1731
3301
  return this.mutateAndCheckError(Documents.DeleteMedicalGuidelines, {
1732
3302
  ids: ids,
1733
3303
  isSynchronous: isSynchronous,
1734
3304
  });
1735
3305
  }
3306
+ /** Deletes all medical guidelines based on filter criteria. */
1736
3307
  async deleteAllMedicalGuidelines(filter, isSynchronous, correlationId) {
1737
3308
  return this.mutateAndCheckError(Documents.DeleteAllMedicalGuidelines, {
1738
3309
  filter: filter,
@@ -1740,12 +3311,15 @@ class Graphlit {
1740
3311
  correlationId: correlationId,
1741
3312
  });
1742
3313
  }
3314
+ /** Lookup a medical guideline given its ID. */
1743
3315
  async getMedicalGuideline(id) {
1744
3316
  return this.queryAndCheckError(Documents.GetMedicalGuideline, { id: id });
1745
3317
  }
3318
+ /** Retrieves medical guidelines based on filter criteria. */
1746
3319
  async queryMedicalGuidelines(filter, correlationId) {
1747
3320
  return this.queryAndCheckError(Documents.QueryMedicalGuidelines, { filter: filter, correlationId: correlationId });
1748
3321
  }
3322
+ /** Retrieves medical guidelines with clustering information. */
1749
3323
  async queryMedicalGuidelinesClusters(filter, clusters, correlationId) {
1750
3324
  return this.queryAndCheckError(Documents.QueryMedicalGuidelinesClusters, {
1751
3325
  filter: filter,
@@ -1759,18 +3333,23 @@ class Graphlit {
1759
3333
  correlationId: correlationId,
1760
3334
  });
1761
3335
  }
3336
+ /** Creates a medical drug entity. */
1762
3337
  async createMedicalDrug(MedicalDrug) {
1763
3338
  return this.mutateAndCheckError(Documents.CreateMedicalDrug, { medicalDrug: MedicalDrug });
1764
3339
  }
3340
+ /** Updates a medical drug entity. */
1765
3341
  async updateMedicalDrug(MedicalDrug) {
1766
3342
  return this.mutateAndCheckError(Documents.UpdateMedicalDrug, { medicalDrug: MedicalDrug });
1767
3343
  }
3344
+ /** Deletes a medical drug entity. */
1768
3345
  async deleteMedicalDrug(id) {
1769
3346
  return this.mutateAndCheckError(Documents.DeleteMedicalDrug, { id: id });
1770
3347
  }
3348
+ /** Deletes multiple medical drug entities. */
1771
3349
  async deleteMedicalDrugs(ids, isSynchronous) {
1772
3350
  return this.mutateAndCheckError(Documents.DeleteMedicalDrugs, { ids: ids, isSynchronous: isSynchronous });
1773
3351
  }
3352
+ /** Deletes all medical drugs based on filter criteria. */
1774
3353
  async deleteAllMedicalDrugs(filter, isSynchronous, correlationId) {
1775
3354
  return this.mutateAndCheckError(Documents.DeleteAllMedicalDrugs, {
1776
3355
  filter: filter,
@@ -1778,12 +3357,15 @@ class Graphlit {
1778
3357
  correlationId: correlationId,
1779
3358
  });
1780
3359
  }
3360
+ /** Lookup a medical drug given its ID. */
1781
3361
  async getMedicalDrug(id) {
1782
3362
  return this.queryAndCheckError(Documents.GetMedicalDrug, { id: id });
1783
3363
  }
3364
+ /** Retrieves medical drugs based on filter criteria. */
1784
3365
  async queryMedicalDrugs(filter, correlationId) {
1785
3366
  return this.queryAndCheckError(Documents.QueryMedicalDrugs, { filter: filter, correlationId: correlationId });
1786
3367
  }
3368
+ /** Retrieves medical drugs with clustering information. */
1787
3369
  async queryMedicalDrugsClusters(filter, clusters, correlationId) {
1788
3370
  return this.queryAndCheckError(Documents.QueryMedicalDrugsClusters, {
1789
3371
  filter: filter,
@@ -1791,31 +3373,37 @@ class Graphlit {
1791
3373
  correlationId: correlationId,
1792
3374
  });
1793
3375
  }
3376
+ /** Counts medical drugs based on filter criteria. */
1794
3377
  async countMedicalDrugs(filter, correlationId) {
1795
3378
  return this.queryAndCheckError(Documents.CountMedicalDrugs, {
1796
3379
  filter: filter,
1797
3380
  correlationId: correlationId,
1798
3381
  });
1799
3382
  }
3383
+ /** Creates a medical indication entity. */
1800
3384
  async createMedicalIndication(MedicalIndication) {
1801
3385
  return this.mutateAndCheckError(Documents.CreateMedicalIndication, {
1802
3386
  medicalIndication: MedicalIndication,
1803
3387
  });
1804
3388
  }
3389
+ /** Updates a medical indication entity. */
1805
3390
  async updateMedicalIndication(MedicalIndication) {
1806
3391
  return this.mutateAndCheckError(Documents.UpdateMedicalIndication, {
1807
3392
  medicalIndication: MedicalIndication,
1808
3393
  });
1809
3394
  }
3395
+ /** Deletes a medical indication entity. */
1810
3396
  async deleteMedicalIndication(id) {
1811
3397
  return this.mutateAndCheckError(Documents.DeleteMedicalIndication, { id: id });
1812
3398
  }
3399
+ /** Deletes multiple medical indication entities. */
1813
3400
  async deleteMedicalIndications(ids, isSynchronous) {
1814
3401
  return this.mutateAndCheckError(Documents.DeleteMedicalIndications, {
1815
3402
  ids: ids,
1816
3403
  isSynchronous: isSynchronous,
1817
3404
  });
1818
3405
  }
3406
+ /** Deletes all medical indications based on filter criteria. */
1819
3407
  async deleteAllMedicalIndications(filter, isSynchronous, correlationId) {
1820
3408
  return this.mutateAndCheckError(Documents.DeleteAllMedicalIndications, {
1821
3409
  filter: filter,
@@ -1823,12 +3411,15 @@ class Graphlit {
1823
3411
  correlationId: correlationId,
1824
3412
  });
1825
3413
  }
3414
+ /** Lookup a medical indication given its ID. */
1826
3415
  async getMedicalIndication(id) {
1827
3416
  return this.queryAndCheckError(Documents.GetMedicalIndication, { id: id });
1828
3417
  }
3418
+ /** Retrieves medical indications based on filter criteria. */
1829
3419
  async queryMedicalIndications(filter, correlationId) {
1830
3420
  return this.queryAndCheckError(Documents.QueryMedicalIndications, { filter: filter, correlationId: correlationId });
1831
3421
  }
3422
+ /** Retrieves medical indications with clustering information. */
1832
3423
  async queryMedicalIndicationsClusters(filter, clusters, correlationId) {
1833
3424
  return this.queryAndCheckError(Documents.QueryMedicalIndicationsClusters, {
1834
3425
  filter: filter,
@@ -1836,31 +3427,37 @@ class Graphlit {
1836
3427
  correlationId: correlationId,
1837
3428
  });
1838
3429
  }
3430
+ /** Counts medical indications based on filter criteria. */
1839
3431
  async countMedicalIndications(filter, correlationId) {
1840
3432
  return this.queryAndCheckError(Documents.CountMedicalIndications, {
1841
3433
  filter: filter,
1842
3434
  correlationId: correlationId,
1843
3435
  });
1844
3436
  }
3437
+ /** Creates a medical contraindication entity. */
1845
3438
  async createMedicalContraindication(MedicalContraindication) {
1846
3439
  return this.mutateAndCheckError(Documents.CreateMedicalContraindication, {
1847
3440
  medicalContraindication: MedicalContraindication,
1848
3441
  });
1849
3442
  }
3443
+ /** Updates a medical contraindication entity. */
1850
3444
  async updateMedicalContraindication(MedicalContraindication) {
1851
3445
  return this.mutateAndCheckError(Documents.UpdateMedicalContraindication, {
1852
3446
  medicalContraindication: MedicalContraindication,
1853
3447
  });
1854
3448
  }
3449
+ /** Deletes a medical contraindication entity. */
1855
3450
  async deleteMedicalContraindication(id) {
1856
3451
  return this.mutateAndCheckError(Documents.DeleteMedicalContraindication, { id: id });
1857
3452
  }
3453
+ /** Deletes multiple medical contraindication entities. */
1858
3454
  async deleteMedicalContraindications(ids, isSynchronous) {
1859
3455
  return this.mutateAndCheckError(Documents.DeleteMedicalContraindications, {
1860
3456
  ids: ids,
1861
3457
  isSynchronous: isSynchronous,
1862
3458
  });
1863
3459
  }
3460
+ /** Deletes all medical contraindications based on filter criteria. */
1864
3461
  async deleteAllMedicalContraindications(filter, isSynchronous, correlationId) {
1865
3462
  return this.mutateAndCheckError(Documents.DeleteAllMedicalContraindications, {
1866
3463
  filter: filter,
@@ -1868,12 +3465,15 @@ class Graphlit {
1868
3465
  correlationId: correlationId,
1869
3466
  });
1870
3467
  }
3468
+ /** Lookup a medical contraindication given its ID. */
1871
3469
  async getMedicalContraindication(id) {
1872
3470
  return this.queryAndCheckError(Documents.GetMedicalContraindication, { id: id });
1873
3471
  }
3472
+ /** Retrieves medical contraindications based on filter criteria. */
1874
3473
  async queryMedicalContraindications(filter, correlationId) {
1875
3474
  return this.queryAndCheckError(Documents.QueryMedicalContraindications, { filter: filter, correlationId: correlationId });
1876
3475
  }
3476
+ /** Retrieves medical contraindications with clustering information. */
1877
3477
  async queryMedicalContraindicationsClusters(filter, clusters, correlationId) {
1878
3478
  return this.queryAndCheckError(Documents.QueryMedicalContraindicationsClusters, {
1879
3479
  filter: filter,
@@ -1881,24 +3481,30 @@ class Graphlit {
1881
3481
  correlationId: correlationId,
1882
3482
  });
1883
3483
  }
3484
+ /** Counts medical contraindications based on filter criteria. */
1884
3485
  async countMedicalContraindications(filter, correlationId) {
1885
3486
  return this.queryAndCheckError(Documents.CountMedicalContraindications, {
1886
3487
  filter: filter,
1887
3488
  correlationId: correlationId,
1888
3489
  });
1889
3490
  }
3491
+ /** Creates a medical test entity. */
1890
3492
  async createMedicalTest(MedicalTest) {
1891
3493
  return this.mutateAndCheckError(Documents.CreateMedicalTest, { medicalTest: MedicalTest });
1892
3494
  }
3495
+ /** Updates a medical test entity. */
1893
3496
  async updateMedicalTest(MedicalTest) {
1894
3497
  return this.mutateAndCheckError(Documents.UpdateMedicalTest, { medicalTest: MedicalTest });
1895
3498
  }
3499
+ /** Deletes a medical test entity. */
1896
3500
  async deleteMedicalTest(id) {
1897
3501
  return this.mutateAndCheckError(Documents.DeleteMedicalTest, { id: id });
1898
3502
  }
3503
+ /** Deletes multiple medical test entities. */
1899
3504
  async deleteMedicalTests(ids, isSynchronous) {
1900
3505
  return this.mutateAndCheckError(Documents.DeleteMedicalTests, { ids: ids, isSynchronous: isSynchronous });
1901
3506
  }
3507
+ /** Deletes all medical tests based on filter criteria. */
1902
3508
  async deleteAllMedicalTests(filter, isSynchronous, correlationId) {
1903
3509
  return this.mutateAndCheckError(Documents.DeleteAllMedicalTests, {
1904
3510
  filter: filter,
@@ -1906,12 +3512,15 @@ class Graphlit {
1906
3512
  correlationId: correlationId,
1907
3513
  });
1908
3514
  }
3515
+ /** Lookup a medical test given its ID. */
1909
3516
  async getMedicalTest(id) {
1910
3517
  return this.queryAndCheckError(Documents.GetMedicalTest, { id: id });
1911
3518
  }
3519
+ /** Retrieves medical tests based on filter criteria. */
1912
3520
  async queryMedicalTests(filter, correlationId) {
1913
3521
  return this.queryAndCheckError(Documents.QueryMedicalTests, { filter: filter, correlationId: correlationId });
1914
3522
  }
3523
+ /** Retrieves medical tests with clustering information. */
1915
3524
  async queryMedicalTestsClusters(filter, clusters, correlationId) {
1916
3525
  return this.queryAndCheckError(Documents.QueryMedicalTestsClusters, {
1917
3526
  filter: filter,
@@ -1919,27 +3528,33 @@ class Graphlit {
1919
3528
  correlationId: correlationId,
1920
3529
  });
1921
3530
  }
3531
+ /** Counts medical tests based on filter criteria. */
1922
3532
  async countMedicalTests(filter, correlationId) {
1923
3533
  return this.queryAndCheckError(Documents.CountMedicalTests, {
1924
3534
  filter: filter,
1925
3535
  correlationId: correlationId,
1926
3536
  });
1927
3537
  }
3538
+ /** Creates a medical device entity. */
1928
3539
  async createMedicalDevice(MedicalDevice) {
1929
3540
  return this.mutateAndCheckError(Documents.CreateMedicalDevice, { medicalDevice: MedicalDevice });
1930
3541
  }
3542
+ /** Updates a medical device entity. */
1931
3543
  async updateMedicalDevice(MedicalDevice) {
1932
3544
  return this.mutateAndCheckError(Documents.UpdateMedicalDevice, { medicalDevice: MedicalDevice });
1933
3545
  }
3546
+ /** Deletes a medical device entity. */
1934
3547
  async deleteMedicalDevice(id) {
1935
3548
  return this.mutateAndCheckError(Documents.DeleteMedicalDevice, { id: id });
1936
3549
  }
3550
+ /** Deletes multiple medical device entities. */
1937
3551
  async deleteMedicalDevices(ids, isSynchronous) {
1938
3552
  return this.mutateAndCheckError(Documents.DeleteMedicalDevices, {
1939
3553
  ids: ids,
1940
3554
  isSynchronous: isSynchronous,
1941
3555
  });
1942
3556
  }
3557
+ /** Deletes all medical devices based on filter criteria. */
1943
3558
  async deleteAllMedicalDevices(filter, isSynchronous, correlationId) {
1944
3559
  return this.mutateAndCheckError(Documents.DeleteAllMedicalDevices, {
1945
3560
  filter: filter,
@@ -1947,12 +3562,15 @@ class Graphlit {
1947
3562
  correlationId: correlationId,
1948
3563
  });
1949
3564
  }
3565
+ /** Lookup a medical device given its ID. */
1950
3566
  async getMedicalDevice(id) {
1951
3567
  return this.queryAndCheckError(Documents.GetMedicalDevice, { id: id });
1952
3568
  }
3569
+ /** Retrieves medical devices based on filter criteria. */
1953
3570
  async queryMedicalDevices(filter, correlationId) {
1954
3571
  return this.queryAndCheckError(Documents.QueryMedicalDevices, { filter: filter, correlationId: correlationId });
1955
3572
  }
3573
+ /** Retrieves medical devices with clustering information. */
1956
3574
  async queryMedicalDevicesClusters(filter, clusters, correlationId) {
1957
3575
  return this.queryAndCheckError(Documents.QueryMedicalDevicesClusters, {
1958
3576
  filter: filter,
@@ -1960,27 +3578,33 @@ class Graphlit {
1960
3578
  correlationId: correlationId,
1961
3579
  });
1962
3580
  }
3581
+ /** Counts medical devices based on filter criteria. */
1963
3582
  async countMedicalDevices(filter, correlationId) {
1964
3583
  return this.queryAndCheckError(Documents.CountMedicalDevices, {
1965
3584
  filter: filter,
1966
3585
  correlationId: correlationId,
1967
3586
  });
1968
3587
  }
3588
+ /** Creates a medical procedure entity. */
1969
3589
  async createMedicalProcedure(MedicalProcedure) {
1970
3590
  return this.mutateAndCheckError(Documents.CreateMedicalProcedure, { medicalProcedure: MedicalProcedure });
1971
3591
  }
3592
+ /** Updates a medical procedure entity. */
1972
3593
  async updateMedicalProcedure(MedicalProcedure) {
1973
3594
  return this.mutateAndCheckError(Documents.UpdateMedicalProcedure, { medicalProcedure: MedicalProcedure });
1974
3595
  }
3596
+ /** Deletes a medical procedure entity. */
1975
3597
  async deleteMedicalProcedure(id) {
1976
3598
  return this.mutateAndCheckError(Documents.DeleteMedicalProcedure, { id: id });
1977
3599
  }
3600
+ /** Deletes multiple medical procedure entities. */
1978
3601
  async deleteMedicalProcedures(ids, isSynchronous) {
1979
3602
  return this.mutateAndCheckError(Documents.DeleteMedicalProcedures, {
1980
3603
  ids: ids,
1981
3604
  isSynchronous: isSynchronous,
1982
3605
  });
1983
3606
  }
3607
+ /** Deletes all medical procedures based on filter criteria. */
1984
3608
  async deleteAllMedicalProcedures(filter, isSynchronous, correlationId) {
1985
3609
  return this.mutateAndCheckError(Documents.DeleteAllMedicalProcedures, {
1986
3610
  filter: filter,
@@ -1988,12 +3612,15 @@ class Graphlit {
1988
3612
  correlationId: correlationId,
1989
3613
  });
1990
3614
  }
3615
+ /** Lookup a medical procedure given its ID. */
1991
3616
  async getMedicalProcedure(id) {
1992
3617
  return this.queryAndCheckError(Documents.GetMedicalProcedure, { id: id });
1993
3618
  }
3619
+ /** Retrieves medical procedures based on filter criteria. */
1994
3620
  async queryMedicalProcedures(filter, correlationId) {
1995
3621
  return this.queryAndCheckError(Documents.QueryMedicalProcedures, { filter: filter, correlationId: correlationId });
1996
3622
  }
3623
+ /** Retrieves medical procedures with clustering information. */
1997
3624
  async queryMedicalProceduresClusters(filter, clusters, correlationId) {
1998
3625
  return this.queryAndCheckError(Documents.QueryMedicalProceduresClusters, {
1999
3626
  filter: filter,
@@ -2001,27 +3628,33 @@ class Graphlit {
2001
3628
  correlationId: correlationId,
2002
3629
  });
2003
3630
  }
3631
+ /** Counts medical procedures based on filter criteria. */
2004
3632
  async countMedicalProcedures(filter, correlationId) {
2005
3633
  return this.queryAndCheckError(Documents.CountMedicalProcedures, {
2006
3634
  filter: filter,
2007
3635
  correlationId: correlationId,
2008
3636
  });
2009
3637
  }
3638
+ /** Creates a medical study entity. */
2010
3639
  async createMedicalStudy(MedicalStudy) {
2011
3640
  return this.mutateAndCheckError(Documents.CreateMedicalStudy, { medicalStudy: MedicalStudy });
2012
3641
  }
3642
+ /** Updates a medical study entity. */
2013
3643
  async updateMedicalStudy(MedicalStudy) {
2014
3644
  return this.mutateAndCheckError(Documents.UpdateMedicalStudy, { medicalStudy: MedicalStudy });
2015
3645
  }
3646
+ /** Deletes a medical study entity. */
2016
3647
  async deleteMedicalStudy(id) {
2017
3648
  return this.mutateAndCheckError(Documents.DeleteMedicalStudy, { id: id });
2018
3649
  }
3650
+ /** Deletes multiple medical study entities. */
2019
3651
  async deleteMedicalStudies(ids, isSynchronous) {
2020
3652
  return this.mutateAndCheckError(Documents.DeleteMedicalStudies, {
2021
3653
  ids: ids,
2022
3654
  isSynchronous: isSynchronous,
2023
3655
  });
2024
3656
  }
3657
+ /** Deletes all medical studies based on filter criteria. */
2025
3658
  async deleteAllMedicalStudies(filter, isSynchronous, correlationId) {
2026
3659
  return this.mutateAndCheckError(Documents.DeleteAllMedicalStudies, {
2027
3660
  filter: filter,
@@ -2029,12 +3662,15 @@ class Graphlit {
2029
3662
  correlationId: correlationId,
2030
3663
  });
2031
3664
  }
3665
+ /** Lookup a medical study given its ID. */
2032
3666
  async getMedicalStudy(id) {
2033
3667
  return this.queryAndCheckError(Documents.GetMedicalStudy, { id: id });
2034
3668
  }
3669
+ /** Retrieves medical studies based on filter criteria. */
2035
3670
  async queryMedicalStudies(filter, correlationId) {
2036
3671
  return this.queryAndCheckError(Documents.QueryMedicalStudies, { filter: filter, correlationId: correlationId });
2037
3672
  }
3673
+ /** Retrieves medical studies with clustering information. */
2038
3674
  async queryMedicalStudiesClusters(filter, clusters, correlationId) {
2039
3675
  return this.queryAndCheckError(Documents.QueryMedicalStudiesClusters, {
2040
3676
  filter: filter,
@@ -2042,27 +3678,33 @@ class Graphlit {
2042
3678
  correlationId: correlationId,
2043
3679
  });
2044
3680
  }
3681
+ /** Counts medical studies based on filter criteria. */
2045
3682
  async countMedicalStudies(filter, correlationId) {
2046
3683
  return this.queryAndCheckError(Documents.CountMedicalStudies, {
2047
3684
  filter: filter,
2048
3685
  correlationId: correlationId,
2049
3686
  });
2050
3687
  }
3688
+ /** Creates a medical drug class entity. */
2051
3689
  async createMedicalDrugClass(MedicalDrugClass) {
2052
3690
  return this.mutateAndCheckError(Documents.CreateMedicalDrugClass, { medicalDrugClass: MedicalDrugClass });
2053
3691
  }
3692
+ /** Updates a medical drug class entity. */
2054
3693
  async updateMedicalDrugClass(MedicalDrugClass) {
2055
3694
  return this.mutateAndCheckError(Documents.UpdateMedicalDrugClass, { medicalDrugClass: MedicalDrugClass });
2056
3695
  }
3696
+ /** Deletes a medical drug class entity. */
2057
3697
  async deleteMedicalDrugClass(id) {
2058
3698
  return this.mutateAndCheckError(Documents.DeleteMedicalDrugClass, { id: id });
2059
3699
  }
3700
+ /** Deletes multiple medical drug class entities. */
2060
3701
  async deleteMedicalDrugClasses(ids, isSynchronous) {
2061
3702
  return this.mutateAndCheckError(Documents.DeleteMedicalDrugClasses, {
2062
3703
  ids: ids,
2063
3704
  isSynchronous: isSynchronous,
2064
3705
  });
2065
3706
  }
3707
+ /** Deletes all medical drug classes based on filter criteria. */
2066
3708
  async deleteAllMedicalDrugClasses(filter, isSynchronous, correlationId) {
2067
3709
  return this.mutateAndCheckError(Documents.DeleteAllMedicalDrugClasses, {
2068
3710
  filter: filter,
@@ -2070,12 +3712,15 @@ class Graphlit {
2070
3712
  correlationId: correlationId,
2071
3713
  });
2072
3714
  }
3715
+ /** Lookup a medical drug class given its ID. */
2073
3716
  async getMedicalDrugClass(id) {
2074
3717
  return this.queryAndCheckError(Documents.GetMedicalDrugClass, { id: id });
2075
3718
  }
3719
+ /** Retrieves medical drug classes based on filter criteria. */
2076
3720
  async queryMedicalDrugClasses(filter, correlationId) {
2077
3721
  return this.queryAndCheckError(Documents.QueryMedicalDrugClasses, { filter: filter, correlationId: correlationId });
2078
3722
  }
3723
+ /** Retrieves medical drug classes with clustering information. */
2079
3724
  async queryMedicalDrugClassesClusters(filter, clusters, correlationId) {
2080
3725
  return this.queryAndCheckError(Documents.QueryMedicalDrugClassesClusters, {
2081
3726
  filter: filter,
@@ -2083,27 +3728,33 @@ class Graphlit {
2083
3728
  correlationId: correlationId,
2084
3729
  });
2085
3730
  }
3731
+ /** Counts medical drug classes based on filter criteria. */
2086
3732
  async countMedicalDrugClasses(filter, correlationId) {
2087
3733
  return this.queryAndCheckError(Documents.CountMedicalDrugClasses, {
2088
3734
  filter: filter,
2089
3735
  correlationId: correlationId,
2090
3736
  });
2091
3737
  }
3738
+ /** Creates a medical therapy entity. */
2092
3739
  async createMedicalTherapy(MedicalTherapy) {
2093
3740
  return this.mutateAndCheckError(Documents.CreateMedicalTherapy, { medicalTherapy: MedicalTherapy });
2094
3741
  }
3742
+ /** Updates a medical therapy entity. */
2095
3743
  async updateMedicalTherapy(MedicalTherapy) {
2096
3744
  return this.mutateAndCheckError(Documents.UpdateMedicalTherapy, { medicalTherapy: MedicalTherapy });
2097
3745
  }
3746
+ /** Deletes a medical therapy entity. */
2098
3747
  async deleteMedicalTherapy(id) {
2099
3748
  return this.mutateAndCheckError(Documents.DeleteMedicalTherapy, { id: id });
2100
3749
  }
3750
+ /** Deletes multiple medical therapy entities. */
2101
3751
  async deleteMedicalTherapies(ids, isSynchronous) {
2102
3752
  return this.mutateAndCheckError(Documents.DeleteMedicalTherapies, {
2103
3753
  ids: ids,
2104
3754
  isSynchronous: isSynchronous,
2105
3755
  });
2106
3756
  }
3757
+ /** Deletes all medical therapies based on filter criteria. */
2107
3758
  async deleteAllMedicalTherapies(filter, isSynchronous, correlationId) {
2108
3759
  return this.mutateAndCheckError(Documents.DeleteAllMedicalTherapies, {
2109
3760
  filter: filter,
@@ -2111,12 +3762,15 @@ class Graphlit {
2111
3762
  correlationId: correlationId,
2112
3763
  });
2113
3764
  }
3765
+ /** Lookup a medical therapy given its ID. */
2114
3766
  async getMedicalTherapy(id) {
2115
3767
  return this.queryAndCheckError(Documents.GetMedicalTherapy, { id: id });
2116
3768
  }
3769
+ /** Retrieves medical therapies based on filter criteria. */
2117
3770
  async queryMedicalTherapies(filter, correlationId) {
2118
3771
  return this.queryAndCheckError(Documents.QueryMedicalTherapies, { filter: filter, correlationId: correlationId });
2119
3772
  }
3773
+ /** Retrieves medical therapies with clustering information. */
2120
3774
  async queryMedicalTherapiesClusters(filter, clusters, correlationId) {
2121
3775
  return this.queryAndCheckError(Documents.QueryMedicalTherapiesClusters, {
2122
3776
  filter: filter,
@@ -2124,21 +3778,26 @@ class Graphlit {
2124
3778
  correlationId: correlationId,
2125
3779
  });
2126
3780
  }
3781
+ /** Counts medical therapies based on filter criteria. */
2127
3782
  async countMedicalTherapies(filter, correlationId) {
2128
3783
  return this.queryAndCheckError(Documents.CountMedicalTherapies, {
2129
3784
  filter: filter,
2130
3785
  correlationId: correlationId,
2131
3786
  });
2132
3787
  }
3788
+ /** Creates an observation entity. */
2133
3789
  async createObservation(observation) {
2134
3790
  return this.mutateAndCheckError(Documents.CreateObservation, { observation: observation });
2135
3791
  }
3792
+ /** Updates an observation entity. */
2136
3793
  async updateObservation(observation) {
2137
3794
  return this.mutateAndCheckError(Documents.UpdateObservation, { observation: observation });
2138
3795
  }
3796
+ /** Deletes an observation entity. */
2139
3797
  async deleteObservation(id) {
2140
3798
  return this.mutateAndCheckError(Documents.DeleteObservation, { id: id });
2141
3799
  }
3800
+ /** Matches an observable against candidate entities using AI. */
2142
3801
  async matchEntity(observable, candidates, specification, correlationId) {
2143
3802
  return this.mutateAndCheckError(Documents.MatchEntity, {
2144
3803
  observable: observable,
@@ -2147,6 +3806,7 @@ class Graphlit {
2147
3806
  correlationId: correlationId,
2148
3807
  });
2149
3808
  }
3809
+ /** Resolves multiple entities of a given type using AI similarity matching. */
2150
3810
  async resolveEntities(type, entities, threshold, specification, correlationId) {
2151
3811
  return this.mutateAndCheckError(Documents.ResolveEntities, {
2152
3812
  type: type,
@@ -2156,6 +3816,7 @@ class Graphlit {
2156
3816
  correlationId: correlationId,
2157
3817
  });
2158
3818
  }
3819
+ /** Resolves a source entity against a target entity using AI similarity matching. */
2159
3820
  async resolveEntity(type, source, target, specification, correlationId) {
2160
3821
  return this.mutateAndCheckError(Documents.ResolveEntity, {
2161
3822
  type: type,
@@ -2165,21 +3826,26 @@ class Graphlit {
2165
3826
  correlationId: correlationId,
2166
3827
  });
2167
3828
  }
3829
+ /** Creates an investment entity. */
2168
3830
  async createInvestment(investment) {
2169
3831
  return this.mutateAndCheckError(Documents.CreateInvestment, { investment: investment });
2170
3832
  }
3833
+ /** Updates an investment entity. */
2171
3834
  async updateInvestment(investment) {
2172
3835
  return this.mutateAndCheckError(Documents.UpdateInvestment, { investment: investment });
2173
3836
  }
3837
+ /** Deletes an investment entity. */
2174
3838
  async deleteInvestment(id) {
2175
3839
  return this.mutateAndCheckError(Documents.DeleteInvestment, { id: id });
2176
3840
  }
3841
+ /** Deletes multiple investment entities. */
2177
3842
  async deleteInvestments(ids, isSynchronous) {
2178
3843
  return this.mutateAndCheckError(Documents.DeleteInvestments, {
2179
3844
  ids: ids,
2180
3845
  isSynchronous: isSynchronous,
2181
3846
  });
2182
3847
  }
3848
+ /** Deletes all investments based on filter criteria. */
2183
3849
  async deleteAllInvestments(filter, isSynchronous, correlationId) {
2184
3850
  return this.mutateAndCheckError(Documents.DeleteAllInvestments, {
2185
3851
  filter: filter,
@@ -2187,21 +3853,26 @@ class Graphlit {
2187
3853
  correlationId: correlationId,
2188
3854
  });
2189
3855
  }
3856
+ /** Creates an investment fund entity. */
2190
3857
  async createInvestmentFund(investmentFund) {
2191
3858
  return this.mutateAndCheckError(Documents.CreateInvestmentFund, { investmentFund: investmentFund });
2192
3859
  }
3860
+ /** Updates an investment fund entity. */
2193
3861
  async updateInvestmentFund(investmentFund) {
2194
3862
  return this.mutateAndCheckError(Documents.UpdateInvestmentFund, { investmentFund: investmentFund });
2195
3863
  }
3864
+ /** Deletes an investment fund entity. */
2196
3865
  async deleteInvestmentFund(id) {
2197
3866
  return this.mutateAndCheckError(Documents.DeleteInvestmentFund, { id: id });
2198
3867
  }
3868
+ /** Deletes multiple investment fund entities. */
2199
3869
  async deleteInvestmentFunds(ids, isSynchronous) {
2200
3870
  return this.mutateAndCheckError(Documents.DeleteInvestmentFunds, {
2201
3871
  ids: ids,
2202
3872
  isSynchronous: isSynchronous,
2203
3873
  });
2204
3874
  }
3875
+ /** Deletes all investment funds based on filter criteria. */
2205
3876
  async deleteAllInvestmentFunds(filter, isSynchronous, correlationId) {
2206
3877
  return this.mutateAndCheckError(Documents.DeleteAllInvestmentFunds, {
2207
3878
  filter: filter,
@@ -2209,15 +3880,18 @@ class Graphlit {
2209
3880
  correlationId: correlationId,
2210
3881
  });
2211
3882
  }
3883
+ /** Lookup an investment given its ID. */
2212
3884
  async getInvestment(id, correlationId) {
2213
3885
  return this.queryAndCheckError(Documents.GetInvestment, { id: id, correlationId: correlationId });
2214
3886
  }
3887
+ /** Retrieves investments based on filter criteria. */
2215
3888
  async queryInvestments(filter, correlationId) {
2216
3889
  return this.queryAndCheckError(Documents.QueryInvestments, {
2217
3890
  filter: filter,
2218
3891
  correlationId: correlationId,
2219
3892
  });
2220
3893
  }
3894
+ /** Retrieves investments with clustering information. */
2221
3895
  async queryInvestmentsClusters(filter, clusters, correlationId) {
2222
3896
  return this.queryAndCheckError(Documents.QueryInvestmentsClusters, {
2223
3897
  filter: filter,
@@ -2225,27 +3899,32 @@ class Graphlit {
2225
3899
  correlationId: correlationId,
2226
3900
  });
2227
3901
  }
3902
+ /** Retrieves investments with expanded relationship data. */
2228
3903
  async queryInvestmentsExpanded(filter, correlationId) {
2229
3904
  return this.queryAndCheckError(Documents.QueryInvestmentsExpanded, {
2230
3905
  filter: filter,
2231
3906
  correlationId: correlationId,
2232
3907
  });
2233
3908
  }
3909
+ /** Counts investments based on filter criteria. */
2234
3910
  async countInvestments(filter, correlationId) {
2235
3911
  return this.queryAndCheckError(Documents.CountInvestments, {
2236
3912
  filter: filter,
2237
3913
  correlationId: correlationId,
2238
3914
  });
2239
3915
  }
3916
+ /** Lookup an investment fund given its ID. */
2240
3917
  async getInvestmentFund(id, correlationId) {
2241
3918
  return this.queryAndCheckError(Documents.GetInvestmentFund, { id: id, correlationId: correlationId });
2242
3919
  }
3920
+ /** Retrieves investment funds based on filter criteria. */
2243
3921
  async queryInvestmentFunds(filter, correlationId) {
2244
3922
  return this.queryAndCheckError(Documents.QueryInvestmentFunds, {
2245
3923
  filter: filter,
2246
3924
  correlationId: correlationId,
2247
3925
  });
2248
3926
  }
3927
+ /** Retrieves investment funds with clustering information. */
2249
3928
  async queryInvestmentFundsClusters(filter, clusters, correlationId) {
2250
3929
  return this.queryAndCheckError(Documents.QueryInvestmentFundsClusters, {
2251
3930
  filter: filter,
@@ -2253,12 +3932,14 @@ class Graphlit {
2253
3932
  correlationId: correlationId,
2254
3933
  });
2255
3934
  }
3935
+ /** Retrieves investment funds with expanded relationship data. */
2256
3936
  async queryInvestmentFundsExpanded(filter, correlationId) {
2257
3937
  return this.queryAndCheckError(Documents.QueryInvestmentFundsExpanded, {
2258
3938
  filter: filter,
2259
3939
  correlationId: correlationId,
2260
3940
  });
2261
3941
  }
3942
+ /** Counts investment funds based on filter criteria. */
2262
3943
  async countInvestmentFunds(filter, correlationId) {
2263
3944
  return this.queryAndCheckError(Documents.CountInvestmentFunds, {
2264
3945
  filter: filter,