@uniformdev/canvas 19.62.0 → 19.63.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -409,15 +409,8 @@ interface components$5 {
409
409
  allowedOnComponents?: string[];
410
410
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
411
411
  path: string;
412
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
412
+ /** @description Time-to-live (in seconds) for the resource data cache. */
413
413
  ttl?: number;
414
- /** @description Long term data resource cache configuration. */
415
- longTermCache?: {
416
- /** @description A flag to turn the long term cache on. */
417
- enabled: boolean;
418
- /** @description Time-to-live (in hours) for the long term resource data cache. */
419
- ttlInHours?: number;
420
- };
421
414
  /** @description A key for the resource data cache purging. */
422
415
  purgeKey?: string;
423
416
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -527,6 +520,26 @@ interface components$5 {
527
520
  */
528
521
  projectMapId: string;
529
522
  };
523
+ /** @description AI Prompt definition. */
524
+ Prompt: {
525
+ /**
526
+ * Format: uuid
527
+ * @description Unique identifier for the prompt
528
+ */
529
+ id: string;
530
+ /** @description Unique identifier for the integration that this prompt belongs to. */
531
+ integrationType: string;
532
+ /** @description Name for the prompt */
533
+ promptName?: string | null;
534
+ /** @description Text for the prompt */
535
+ promptText?: string | null;
536
+ /** @description Data for the prompt */
537
+ promptData?: string | null;
538
+ /** @description Turn off/on prompt */
539
+ enabled?: boolean | null;
540
+ /** @description Integration default prompt */
541
+ builtIn?: boolean | null;
542
+ };
530
543
  };
531
544
  }
532
545
 
@@ -534,7 +547,7 @@ interface components$5 {
534
547
  * This file was auto-generated by openapi-typescript.
535
548
  * Do not make direct changes to the file.
536
549
  */
537
- interface paths$b {
550
+ interface paths$d {
538
551
  "/api/v1/canvas-definitions": {
539
552
  get: {
540
553
  parameters: {
@@ -559,15 +572,15 @@ interface paths$b {
559
572
  content: {
560
573
  "application/json": {
561
574
  /** @description Component definitions that match the query */
562
- componentDefinitions: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
575
+ componentDefinitions: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
563
576
  };
564
577
  };
565
578
  };
566
- 400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
567
- 401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
568
- 403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
569
- 429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
570
- 500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
579
+ 400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
580
+ 401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
581
+ 403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
582
+ 429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
583
+ 500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
571
584
  };
572
585
  };
573
586
  /** Upserts a component definition */
@@ -575,11 +588,11 @@ interface paths$b {
575
588
  responses: {
576
589
  /** OK */
577
590
  204: never;
578
- 400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
579
- 401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
580
- 403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
581
- 429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
582
- 500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
591
+ 400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
592
+ 401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
593
+ 403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
594
+ 429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
595
+ 500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
583
596
  };
584
597
  requestBody: {
585
598
  content: {
@@ -589,7 +602,7 @@ interface paths$b {
589
602
  * @description The project ID to upsert the component definition to
590
603
  */
591
604
  projectId: string;
592
- componentDefinition: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
605
+ componentDefinition: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
593
606
  };
594
607
  };
595
608
  };
@@ -599,11 +612,11 @@ interface paths$b {
599
612
  responses: {
600
613
  /** OK */
601
614
  204: never;
602
- 400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
603
- 401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
604
- 403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
605
- 429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
606
- 500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
615
+ 400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
616
+ 401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
617
+ 403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
618
+ 429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
619
+ 500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
607
620
  };
608
621
  requestBody: {
609
622
  content: {
@@ -628,7 +641,7 @@ interface paths$b {
628
641
  };
629
642
  };
630
643
  }
631
- interface external$c {
644
+ interface external$e {
632
645
  "swagger.yml": {
633
646
  paths: {};
634
647
  components: {
@@ -642,25 +655,25 @@ interface external$c {
642
655
  /** Request input validation failed */
643
656
  BadRequestError: {
644
657
  content: {
645
- "application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
658
+ "application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
646
659
  };
647
660
  };
648
661
  /** API key or token was not valid */
649
662
  UnauthorizedError: {
650
663
  content: {
651
- "application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
664
+ "application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
652
665
  };
653
666
  };
654
667
  /** Permission was denied */
655
668
  ForbiddenError: {
656
669
  content: {
657
- "application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
670
+ "application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
658
671
  };
659
672
  };
660
673
  /** Resource not found */
661
674
  NotFoundError: {
662
675
  content: {
663
- "application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
676
+ "application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
664
677
  };
665
678
  };
666
679
  /** Too many requests in allowed time period */
@@ -679,7 +692,7 @@ interface external$c {
679
692
  PublicIdProperty: string;
680
693
  /** @description The definition of a component parameter */
681
694
  ComponentDefinitionParameter: {
682
- id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
695
+ id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
683
696
  /** @description Friendly name of the parameter */
684
697
  name: string;
685
698
  /** @description Appears next to the parameter in the Composition editor */
@@ -691,7 +704,7 @@ interface external$c {
691
704
  };
692
705
  /** @description The definition of a named component slot that can contain other components */
693
706
  ComponentDefinitionSlot: {
694
- id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
707
+ id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
695
708
  /** @description Friendly name of the slot */
696
709
  name: string;
697
710
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -749,13 +762,13 @@ interface external$c {
749
762
  };
750
763
  /** @description The definition of a component variant */
751
764
  ComponentDefinitionVariant: {
752
- id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
765
+ id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
753
766
  /** @description Friendly name of the variant */
754
767
  name: string;
755
768
  };
756
769
  /** @description Permission set for a component defintion */
757
770
  ComponentDefinitionPermission: {
758
- roleId: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
771
+ roleId: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
759
772
  /**
760
773
  * @description Permission type for this permission ComponentDefinition:
761
774
  * read | write | create | delete
@@ -768,7 +781,7 @@ interface external$c {
768
781
  };
769
782
  /** @description Defines a component type that can live on a Composition */
770
783
  ComponentDefinition: {
771
- id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
784
+ id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
772
785
  /** @description Friendly name of the component definition */
773
786
  name: string;
774
787
  /**
@@ -789,7 +802,7 @@ interface external$c {
789
802
  */
790
803
  canBeComposition?: boolean;
791
804
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
792
- parameters?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
805
+ parameters?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
793
806
  /**
794
807
  * Format: uuid
795
808
  * @description Reference to the category this component definition belongs to
@@ -812,14 +825,14 @@ interface external$c {
812
825
  */
813
826
  useTeamPermissions?: boolean;
814
827
  /** @description Custom role permissions for this component definition */
815
- permissions?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
828
+ permissions?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
816
829
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
817
- slots?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
818
- slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
830
+ slots?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
831
+ slugSettings?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
819
832
  /** @description Default component instance value */
820
- defaults?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
833
+ defaults?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
821
834
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
822
- variants?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
835
+ variants?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
823
836
  /** @description Created date string for this definition (ignored for writes) */
824
837
  created?: string;
825
838
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -827,7 +840,7 @@ interface external$c {
827
840
  };
828
841
  /** @description Defines a content type */
829
842
  ContentType: {
830
- id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
843
+ id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
831
844
  /** @description Friendly name of the content type */
832
845
  name: string;
833
846
  /**
@@ -836,7 +849,7 @@ interface external$c {
836
849
  */
837
850
  entryName?: string | null;
838
851
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
839
- fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
852
+ fields?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
840
853
  /**
841
854
  * @description Description of the content type
842
855
  * @default null
@@ -851,7 +864,7 @@ interface external$c {
851
864
  created?: string;
852
865
  /** @description Last modified date string for this content type (ignored for writes) */
853
866
  updated?: string;
854
- slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
867
+ slugSettings?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
855
868
  /**
856
869
  * @description The definition type of this content type (block or content type)
857
870
  * @default contentType
@@ -866,7 +879,7 @@ interface external$c {
866
879
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
867
880
  type: string;
868
881
  /** @deprecated */
869
- connectedData?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
882
+ connectedData?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
870
883
  };
871
884
  /** @description Defines a connection to a dynamic token on a data resource. */
872
885
  DataElementConnectionDefinition: {
@@ -884,13 +897,13 @@ interface external$c {
884
897
  type: string;
885
898
  /** @description Component parameter values for the component instance */
886
899
  parameters?: {
887
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
900
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
888
901
  };
889
902
  /** @description Public ID of alternate visual appearance for this component, if any selected */
890
903
  variant?: string;
891
904
  /** @description Slots containing any child components */
892
905
  slots?: {
893
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
906
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
894
907
  };
895
908
  /**
896
909
  * @description Unique identifier of the component within the composition.
@@ -901,13 +914,13 @@ interface external$c {
901
914
  _id?: string;
902
915
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
903
916
  _pattern?: string;
904
- _dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
917
+ _dataResources?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
905
918
  /**
906
919
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
907
920
  * Means nothing for PUTs; it will be ignored.
908
921
  */
909
922
  _patternDataResources?: {
910
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
923
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
911
924
  };
912
925
  /**
913
926
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -931,7 +944,7 @@ interface external$c {
931
944
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
932
945
  */
933
946
  _overrides?: {
934
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
947
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
935
948
  };
936
949
  /**
937
950
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -940,7 +953,7 @@ interface external$c {
940
953
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
941
954
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
942
955
  */
943
- _overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
956
+ _overridability?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
944
957
  };
945
958
  /** @description Defines the shape of the root component in a composition */
946
959
  RootComponentInstance: {
@@ -948,15 +961,15 @@ interface external$c {
948
961
  type: string;
949
962
  /** @description Component parameter values for the component instance */
950
963
  parameters?: {
951
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
964
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
952
965
  };
953
966
  /** @description Public ID of alternate visual appearance for this component, if any selected */
954
967
  variant?: string;
955
968
  /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
956
- projectMapNodes?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
969
+ projectMapNodes?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
957
970
  /** @description Slots containing any child components */
958
971
  slots?: {
959
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
972
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
960
973
  };
961
974
  /** @description The public UUID of the composition. */
962
975
  _id: string;
@@ -964,7 +977,7 @@ interface external$c {
964
977
  _slug?: string | null;
965
978
  /** @description Friendly name of this component. */
966
979
  _name: string;
967
- _dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
980
+ _dataResources?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
968
981
  /**
969
982
  * @description Defines patch overrides to component IDs that live in the composition.
970
983
  * This can be used to override parameters that are defined on patterns,
@@ -978,7 +991,7 @@ interface external$c {
978
991
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
979
992
  */
980
993
  _overrides?: {
981
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
994
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
982
995
  };
983
996
  /**
984
997
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -987,7 +1000,7 @@ interface external$c {
987
1000
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
988
1001
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
989
1002
  */
990
- _overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1003
+ _overridability?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
991
1004
  };
992
1005
  /**
993
1006
  * @description Defines how to override a specific component.
@@ -997,7 +1010,7 @@ interface external$c {
997
1010
  */
998
1011
  ComponentOverride: {
999
1012
  parameters?: {
1000
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1013
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1001
1014
  };
1002
1015
  variant?: string;
1003
1016
  };
@@ -1011,7 +1024,7 @@ interface external$c {
1011
1024
  ComponentOverridability: {
1012
1025
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
1013
1026
  parameters?: {
1014
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
1027
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
1015
1028
  };
1016
1029
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
1017
1030
  variants?: boolean;
@@ -1052,7 +1065,7 @@ interface external$c {
1052
1065
  }[];
1053
1066
  /** @description Variables needed to make calls to the data source */
1054
1067
  variables?: {
1055
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1068
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1056
1069
  };
1057
1070
  /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
1058
1071
  custom?: {
@@ -1076,15 +1089,8 @@ interface external$c {
1076
1089
  allowedOnComponents?: string[];
1077
1090
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
1078
1091
  path: string;
1079
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
1092
+ /** @description Time-to-live (in seconds) for the resource data cache. */
1080
1093
  ttl?: number;
1081
- /** @description Long term data resource cache configuration. */
1082
- longTermCache?: {
1083
- /** @description A flag to turn the long term cache on. */
1084
- enabled: boolean;
1085
- /** @description Time-to-live (in hours) for the long term resource data cache. */
1086
- ttlInHours?: number;
1087
- };
1088
1094
  /** @description A key for the resource data cache purging. */
1089
1095
  purgeKey?: string;
1090
1096
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -1111,7 +1117,7 @@ interface external$c {
1111
1117
  method: "GET" | "POST" | "HEAD";
1112
1118
  /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
1113
1119
  variables?: {
1114
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1120
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1115
1121
  };
1116
1122
  /** @description Custom configuration specific to the data source being defined */
1117
1123
  custom?: {
@@ -1144,7 +1150,7 @@ interface external$c {
1144
1150
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
1145
1151
  */
1146
1152
  DataResourceDefinitions: {
1147
- [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1153
+ [key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1148
1154
  };
1149
1155
  /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
1150
1156
  DataResourceDefinition: {
@@ -1158,7 +1164,7 @@ interface external$c {
1158
1164
  * If isPatternParameter is false or undefined, this has no meaning.
1159
1165
  */
1160
1166
  ignorePatternParameterDefault?: boolean;
1161
- variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1167
+ variables?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1162
1168
  };
1163
1169
  /** @description Variable values for a data resource. */
1164
1170
  DataResourceVariables: {
@@ -1194,6 +1200,26 @@ interface external$c {
1194
1200
  */
1195
1201
  projectMapId: string;
1196
1202
  };
1203
+ /** @description AI Prompt definition. */
1204
+ Prompt: {
1205
+ /**
1206
+ * Format: uuid
1207
+ * @description Unique identifier for the prompt
1208
+ */
1209
+ id: string;
1210
+ /** @description Unique identifier for the integration that this prompt belongs to. */
1211
+ integrationType: string;
1212
+ /** @description Name for the prompt */
1213
+ promptName?: string | null;
1214
+ /** @description Text for the prompt */
1215
+ promptText?: string | null;
1216
+ /** @description Data for the prompt */
1217
+ promptData?: string | null;
1218
+ /** @description Turn off/on prompt */
1219
+ enabled?: boolean | null;
1220
+ /** @description Integration default prompt */
1221
+ builtIn?: boolean | null;
1222
+ };
1197
1223
  };
1198
1224
  };
1199
1225
  operations: {};
@@ -1201,7 +1227,7 @@ interface external$c {
1201
1227
  }
1202
1228
 
1203
1229
  type SharedComponents$2 = components$5['schemas'];
1204
- type Api$2 = paths$b['/api/v1/canvas-definitions'];
1230
+ type Api$2 = paths$d['/api/v1/canvas-definitions'];
1205
1231
  /** Shape of the GET response from /api/v1/canvas-definitions */
1206
1232
  type ComponentDefinitionGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
1207
1233
  /** Shape of the PUT request body for /api/v1/canvas-definitions */
@@ -1286,25 +1312,19 @@ declare const EMPTY_COMPOSITION: {
1286
1312
  type: string;
1287
1313
  };
1288
1314
  /** Minimal value for Edgehancers Cache TTL (in seconds) */
1289
- declare const EDGE_MIN_CACHE_TTL = 15;
1315
+ declare const EDGE_MIN_CACHE_TTL = 10;
1290
1316
  /** Maximal value for Edgehancers Cache TTL (in seconds) */
1291
- declare const EDGE_MAX_CACHE_TTL = 600;
1317
+ declare const EDGE_MAX_CACHE_TTL: number;
1292
1318
  /** Default value for Edgehancers Cache TTL (in seconds) */
1293
1319
  declare const EDGE_DEFAULT_CACHE_TTL = 30;
1294
1320
  /** A value that indicates that Edgehancers caching is disabled */
1295
1321
  declare const EDGE_CACHE_DISABLED = -1;
1296
- /** Minimal value for Edgehancers Long Term Cache TTL (in hours) */
1297
- declare const EDGE_MIN_L2_CACHE_TTL_IN_HOURS = 1;
1298
- /** Maximal value for Edgehancers Long Term Cache TTL (in hours) */
1299
- declare const EDGE_MAX_L2_CACHE_TTL_IN_HOURS: number;
1300
- /** Default value for Edgehancers Long Term Cache TTL (in hours) */
1301
- declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
1302
1322
 
1303
1323
  /**
1304
1324
  * This file was auto-generated by openapi-typescript.
1305
1325
  * Do not make direct changes to the file.
1306
1326
  */
1307
- interface paths$a {
1327
+ interface paths$c {
1308
1328
  "/api/v1/categories": {
1309
1329
  get: {
1310
1330
  parameters: {
@@ -1317,33 +1337,33 @@ interface paths$a {
1317
1337
  200: {
1318
1338
  content: {
1319
1339
  "application/json": {
1320
- categories: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
1340
+ categories: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
1321
1341
  };
1322
1342
  };
1323
1343
  };
1324
- 400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
1325
- 401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1326
- 403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1327
- 429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
1328
- 500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
1344
+ 400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
1345
+ 401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1346
+ 403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1347
+ 429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
1348
+ 500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
1329
1349
  };
1330
1350
  };
1331
1351
  put: {
1332
1352
  responses: {
1333
1353
  /** OK */
1334
1354
  204: never;
1335
- 400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
1336
- 401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1337
- 403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1338
- 429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
1339
- 500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
1355
+ 400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
1356
+ 401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1357
+ 403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1358
+ 429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
1359
+ 500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
1340
1360
  };
1341
1361
  requestBody: {
1342
1362
  content: {
1343
1363
  "application/json": {
1344
1364
  /** Format: uuid */
1345
1365
  projectId: string;
1346
- categories: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
1366
+ categories: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
1347
1367
  };
1348
1368
  };
1349
1369
  };
@@ -1352,11 +1372,11 @@ interface paths$a {
1352
1372
  responses: {
1353
1373
  /** OK */
1354
1374
  204: never;
1355
- 400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
1356
- 401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1357
- 403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1358
- 429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
1359
- 500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
1375
+ 400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
1376
+ 401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1377
+ 403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1378
+ 429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
1379
+ 500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
1360
1380
  };
1361
1381
  requestBody: {
1362
1382
  content: {
@@ -1371,7 +1391,7 @@ interface paths$a {
1371
1391
  };
1372
1392
  };
1373
1393
  }
1374
- interface external$b {
1394
+ interface external$d {
1375
1395
  "swagger.yml": {
1376
1396
  paths: {};
1377
1397
  components: {
@@ -1385,25 +1405,25 @@ interface external$b {
1385
1405
  /** Request input validation failed */
1386
1406
  BadRequestError: {
1387
1407
  content: {
1388
- "application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
1408
+ "application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
1389
1409
  };
1390
1410
  };
1391
1411
  /** API key or token was not valid */
1392
1412
  UnauthorizedError: {
1393
1413
  content: {
1394
- "application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
1414
+ "application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
1395
1415
  };
1396
1416
  };
1397
1417
  /** Permission was denied */
1398
1418
  ForbiddenError: {
1399
1419
  content: {
1400
- "application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
1420
+ "application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
1401
1421
  };
1402
1422
  };
1403
1423
  /** Resource not found */
1404
1424
  NotFoundError: {
1405
1425
  content: {
1406
- "application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
1426
+ "application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
1407
1427
  };
1408
1428
  };
1409
1429
  /** Too many requests in allowed time period */
@@ -1422,7 +1442,7 @@ interface external$b {
1422
1442
  PublicIdProperty: string;
1423
1443
  /** @description The definition of a component parameter */
1424
1444
  ComponentDefinitionParameter: {
1425
- id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1445
+ id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1426
1446
  /** @description Friendly name of the parameter */
1427
1447
  name: string;
1428
1448
  /** @description Appears next to the parameter in the Composition editor */
@@ -1434,7 +1454,7 @@ interface external$b {
1434
1454
  };
1435
1455
  /** @description The definition of a named component slot that can contain other components */
1436
1456
  ComponentDefinitionSlot: {
1437
- id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1457
+ id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1438
1458
  /** @description Friendly name of the slot */
1439
1459
  name: string;
1440
1460
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -1492,13 +1512,13 @@ interface external$b {
1492
1512
  };
1493
1513
  /** @description The definition of a component variant */
1494
1514
  ComponentDefinitionVariant: {
1495
- id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1515
+ id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1496
1516
  /** @description Friendly name of the variant */
1497
1517
  name: string;
1498
1518
  };
1499
1519
  /** @description Permission set for a component defintion */
1500
1520
  ComponentDefinitionPermission: {
1501
- roleId: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1521
+ roleId: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1502
1522
  /**
1503
1523
  * @description Permission type for this permission ComponentDefinition:
1504
1524
  * read | write | create | delete
@@ -1511,7 +1531,7 @@ interface external$b {
1511
1531
  };
1512
1532
  /** @description Defines a component type that can live on a Composition */
1513
1533
  ComponentDefinition: {
1514
- id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1534
+ id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1515
1535
  /** @description Friendly name of the component definition */
1516
1536
  name: string;
1517
1537
  /**
@@ -1532,7 +1552,7 @@ interface external$b {
1532
1552
  */
1533
1553
  canBeComposition?: boolean;
1534
1554
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
1535
- parameters?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1555
+ parameters?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1536
1556
  /**
1537
1557
  * Format: uuid
1538
1558
  * @description Reference to the category this component definition belongs to
@@ -1555,14 +1575,14 @@ interface external$b {
1555
1575
  */
1556
1576
  useTeamPermissions?: boolean;
1557
1577
  /** @description Custom role permissions for this component definition */
1558
- permissions?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1578
+ permissions?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1559
1579
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
1560
- slots?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1561
- slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1580
+ slots?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
1581
+ slugSettings?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1562
1582
  /** @description Default component instance value */
1563
- defaults?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1583
+ defaults?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
1564
1584
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
1565
- variants?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1585
+ variants?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
1566
1586
  /** @description Created date string for this definition (ignored for writes) */
1567
1587
  created?: string;
1568
1588
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -1570,7 +1590,7 @@ interface external$b {
1570
1590
  };
1571
1591
  /** @description Defines a content type */
1572
1592
  ContentType: {
1573
- id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1593
+ id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
1574
1594
  /** @description Friendly name of the content type */
1575
1595
  name: string;
1576
1596
  /**
@@ -1579,7 +1599,7 @@ interface external$b {
1579
1599
  */
1580
1600
  entryName?: string | null;
1581
1601
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
1582
- fields?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1602
+ fields?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1583
1603
  /**
1584
1604
  * @description Description of the content type
1585
1605
  * @default null
@@ -1594,7 +1614,7 @@ interface external$b {
1594
1614
  created?: string;
1595
1615
  /** @description Last modified date string for this content type (ignored for writes) */
1596
1616
  updated?: string;
1597
- slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1617
+ slugSettings?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1598
1618
  /**
1599
1619
  * @description The definition type of this content type (block or content type)
1600
1620
  * @default contentType
@@ -1609,7 +1629,7 @@ interface external$b {
1609
1629
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
1610
1630
  type: string;
1611
1631
  /** @deprecated */
1612
- connectedData?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
1632
+ connectedData?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
1613
1633
  };
1614
1634
  /** @description Defines a connection to a dynamic token on a data resource. */
1615
1635
  DataElementConnectionDefinition: {
@@ -1627,13 +1647,13 @@ interface external$b {
1627
1647
  type: string;
1628
1648
  /** @description Component parameter values for the component instance */
1629
1649
  parameters?: {
1630
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1650
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1631
1651
  };
1632
1652
  /** @description Public ID of alternate visual appearance for this component, if any selected */
1633
1653
  variant?: string;
1634
1654
  /** @description Slots containing any child components */
1635
1655
  slots?: {
1636
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1656
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1637
1657
  };
1638
1658
  /**
1639
1659
  * @description Unique identifier of the component within the composition.
@@ -1644,13 +1664,13 @@ interface external$b {
1644
1664
  _id?: string;
1645
1665
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
1646
1666
  _pattern?: string;
1647
- _dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1667
+ _dataResources?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1648
1668
  /**
1649
1669
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
1650
1670
  * Means nothing for PUTs; it will be ignored.
1651
1671
  */
1652
1672
  _patternDataResources?: {
1653
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1673
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1654
1674
  };
1655
1675
  /**
1656
1676
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -1674,7 +1694,7 @@ interface external$b {
1674
1694
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1675
1695
  */
1676
1696
  _overrides?: {
1677
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1697
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1678
1698
  };
1679
1699
  /**
1680
1700
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -1683,7 +1703,7 @@ interface external$b {
1683
1703
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1684
1704
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1685
1705
  */
1686
- _overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1706
+ _overridability?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1687
1707
  };
1688
1708
  /** @description Defines the shape of the root component in a composition */
1689
1709
  RootComponentInstance: {
@@ -1691,15 +1711,15 @@ interface external$b {
1691
1711
  type: string;
1692
1712
  /** @description Component parameter values for the component instance */
1693
1713
  parameters?: {
1694
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1714
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1695
1715
  };
1696
1716
  /** @description Public ID of alternate visual appearance for this component, if any selected */
1697
1717
  variant?: string;
1698
1718
  /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
1699
- projectMapNodes?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
1719
+ projectMapNodes?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
1700
1720
  /** @description Slots containing any child components */
1701
1721
  slots?: {
1702
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1722
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
1703
1723
  };
1704
1724
  /** @description The public UUID of the composition. */
1705
1725
  _id: string;
@@ -1707,7 +1727,7 @@ interface external$b {
1707
1727
  _slug?: string | null;
1708
1728
  /** @description Friendly name of this component. */
1709
1729
  _name: string;
1710
- _dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1730
+ _dataResources?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
1711
1731
  /**
1712
1732
  * @description Defines patch overrides to component IDs that live in the composition.
1713
1733
  * This can be used to override parameters that are defined on patterns,
@@ -1721,7 +1741,7 @@ interface external$b {
1721
1741
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1722
1742
  */
1723
1743
  _overrides?: {
1724
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1744
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
1725
1745
  };
1726
1746
  /**
1727
1747
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -1730,7 +1750,7 @@ interface external$b {
1730
1750
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1731
1751
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
1732
1752
  */
1733
- _overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1753
+ _overridability?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
1734
1754
  };
1735
1755
  /**
1736
1756
  * @description Defines how to override a specific component.
@@ -1740,7 +1760,7 @@ interface external$b {
1740
1760
  */
1741
1761
  ComponentOverride: {
1742
1762
  parameters?: {
1743
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1763
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
1744
1764
  };
1745
1765
  variant?: string;
1746
1766
  };
@@ -1754,7 +1774,7 @@ interface external$b {
1754
1774
  ComponentOverridability: {
1755
1775
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
1756
1776
  parameters?: {
1757
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
1777
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
1758
1778
  };
1759
1779
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
1760
1780
  variants?: boolean;
@@ -1795,7 +1815,7 @@ interface external$b {
1795
1815
  }[];
1796
1816
  /** @description Variables needed to make calls to the data source */
1797
1817
  variables?: {
1798
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1818
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1799
1819
  };
1800
1820
  /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
1801
1821
  custom?: {
@@ -1819,15 +1839,8 @@ interface external$b {
1819
1839
  allowedOnComponents?: string[];
1820
1840
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
1821
1841
  path: string;
1822
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
1842
+ /** @description Time-to-live (in seconds) for the resource data cache. */
1823
1843
  ttl?: number;
1824
- /** @description Long term data resource cache configuration. */
1825
- longTermCache?: {
1826
- /** @description A flag to turn the long term cache on. */
1827
- enabled: boolean;
1828
- /** @description Time-to-live (in hours) for the long term resource data cache. */
1829
- ttlInHours?: number;
1830
- };
1831
1844
  /** @description A key for the resource data cache purging. */
1832
1845
  purgeKey?: string;
1833
1846
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -1854,7 +1867,7 @@ interface external$b {
1854
1867
  method: "GET" | "POST" | "HEAD";
1855
1868
  /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
1856
1869
  variables?: {
1857
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1870
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
1858
1871
  };
1859
1872
  /** @description Custom configuration specific to the data source being defined */
1860
1873
  custom?: {
@@ -1887,7 +1900,7 @@ interface external$b {
1887
1900
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
1888
1901
  */
1889
1902
  DataResourceDefinitions: {
1890
- [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1903
+ [key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
1891
1904
  };
1892
1905
  /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
1893
1906
  DataResourceDefinition: {
@@ -1901,7 +1914,7 @@ interface external$b {
1901
1914
  * If isPatternParameter is false or undefined, this has no meaning.
1902
1915
  */
1903
1916
  ignorePatternParameterDefault?: boolean;
1904
- variables?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1917
+ variables?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1905
1918
  };
1906
1919
  /** @description Variable values for a data resource. */
1907
1920
  DataResourceVariables: {
@@ -1937,6 +1950,26 @@ interface external$b {
1937
1950
  */
1938
1951
  projectMapId: string;
1939
1952
  };
1953
+ /** @description AI Prompt definition. */
1954
+ Prompt: {
1955
+ /**
1956
+ * Format: uuid
1957
+ * @description Unique identifier for the prompt
1958
+ */
1959
+ id: string;
1960
+ /** @description Unique identifier for the integration that this prompt belongs to. */
1961
+ integrationType: string;
1962
+ /** @description Name for the prompt */
1963
+ promptName?: string | null;
1964
+ /** @description Text for the prompt */
1965
+ promptText?: string | null;
1966
+ /** @description Data for the prompt */
1967
+ promptData?: string | null;
1968
+ /** @description Turn off/on prompt */
1969
+ enabled?: boolean | null;
1970
+ /** @description Integration default prompt */
1971
+ builtIn?: boolean | null;
1972
+ };
1940
1973
  };
1941
1974
  };
1942
1975
  operations: {};
@@ -1944,7 +1977,7 @@ interface external$b {
1944
1977
  }
1945
1978
 
1946
1979
  type SharedComponents$1 = components$5['schemas'];
1947
- type Api$1 = paths$a['/api/v1/categories'];
1980
+ type Api$1 = paths$c['/api/v1/categories'];
1948
1981
  /** Shape of the GET response from /api/v1/category */
1949
1982
  type CategoriesGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
1950
1983
  /** Shape of the PUT request body for /api/v1/category */
@@ -1960,7 +1993,7 @@ type Category = SharedComponents$1['Category'];
1960
1993
  * This file was auto-generated by openapi-typescript.
1961
1994
  * Do not make direct changes to the file.
1962
1995
  */
1963
- interface paths$9 {
1996
+ interface paths$b {
1964
1997
  "/api/v1/content-types": {
1965
1998
  get: {
1966
1999
  parameters: {
@@ -1981,15 +2014,15 @@ interface paths$9 {
1981
2014
  content: {
1982
2015
  "application/json": {
1983
2016
  /** @description Content types that match the query */
1984
- contentTypes: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"][];
2017
+ contentTypes: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"][];
1985
2018
  };
1986
2019
  };
1987
2020
  };
1988
- 400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
1989
- 401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1990
- 403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1991
- 429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
1992
- 500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
2021
+ 400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
2022
+ 401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2023
+ 403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2024
+ 429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
2025
+ 500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
1993
2026
  };
1994
2027
  };
1995
2028
  /** Upserts a content type */
@@ -1997,11 +2030,11 @@ interface paths$9 {
1997
2030
  responses: {
1998
2031
  /** OK */
1999
2032
  204: never;
2000
- 400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
2001
- 401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2002
- 403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2003
- 429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
2004
- 500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
2033
+ 400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
2034
+ 401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2035
+ 403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2036
+ 429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
2037
+ 500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
2005
2038
  };
2006
2039
  requestBody: {
2007
2040
  content: {
@@ -2011,7 +2044,7 @@ interface paths$9 {
2011
2044
  * @description The project ID to upsert the content type to
2012
2045
  */
2013
2046
  projectId: string;
2014
- contentType: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"];
2047
+ contentType: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"];
2015
2048
  };
2016
2049
  };
2017
2050
  };
@@ -2021,11 +2054,11 @@ interface paths$9 {
2021
2054
  responses: {
2022
2055
  /** OK */
2023
2056
  204: never;
2024
- 400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
2025
- 401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2026
- 403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2027
- 429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
2028
- 500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
2057
+ 400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
2058
+ 401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2059
+ 403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2060
+ 429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
2061
+ 500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
2029
2062
  };
2030
2063
  requestBody: {
2031
2064
  content: {
@@ -2050,7 +2083,7 @@ interface paths$9 {
2050
2083
  };
2051
2084
  };
2052
2085
  }
2053
- interface external$a {
2086
+ interface external$c {
2054
2087
  "swagger.yml": {
2055
2088
  paths: {};
2056
2089
  components: {
@@ -2064,25 +2097,25 @@ interface external$a {
2064
2097
  /** Request input validation failed */
2065
2098
  BadRequestError: {
2066
2099
  content: {
2067
- "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
2100
+ "application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
2068
2101
  };
2069
2102
  };
2070
2103
  /** API key or token was not valid */
2071
2104
  UnauthorizedError: {
2072
2105
  content: {
2073
- "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
2106
+ "application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
2074
2107
  };
2075
2108
  };
2076
2109
  /** Permission was denied */
2077
2110
  ForbiddenError: {
2078
2111
  content: {
2079
- "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
2112
+ "application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
2080
2113
  };
2081
2114
  };
2082
2115
  /** Resource not found */
2083
2116
  NotFoundError: {
2084
2117
  content: {
2085
- "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
2118
+ "application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
2086
2119
  };
2087
2120
  };
2088
2121
  /** Too many requests in allowed time period */
@@ -2101,7 +2134,7 @@ interface external$a {
2101
2134
  PublicIdProperty: string;
2102
2135
  /** @description The definition of a component parameter */
2103
2136
  ComponentDefinitionParameter: {
2104
- id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2137
+ id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2105
2138
  /** @description Friendly name of the parameter */
2106
2139
  name: string;
2107
2140
  /** @description Appears next to the parameter in the Composition editor */
@@ -2113,7 +2146,7 @@ interface external$a {
2113
2146
  };
2114
2147
  /** @description The definition of a named component slot that can contain other components */
2115
2148
  ComponentDefinitionSlot: {
2116
- id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2149
+ id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2117
2150
  /** @description Friendly name of the slot */
2118
2151
  name: string;
2119
2152
  /** @description A list of component definition public IDs that are allowed in this named slot */
@@ -2171,13 +2204,13 @@ interface external$a {
2171
2204
  };
2172
2205
  /** @description The definition of a component variant */
2173
2206
  ComponentDefinitionVariant: {
2174
- id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2207
+ id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2175
2208
  /** @description Friendly name of the variant */
2176
2209
  name: string;
2177
2210
  };
2178
2211
  /** @description Permission set for a component defintion */
2179
2212
  ComponentDefinitionPermission: {
2180
- roleId: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2213
+ roleId: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2181
2214
  /**
2182
2215
  * @description Permission type for this permission ComponentDefinition:
2183
2216
  * read | write | create | delete
@@ -2190,7 +2223,7 @@ interface external$a {
2190
2223
  };
2191
2224
  /** @description Defines a component type that can live on a Composition */
2192
2225
  ComponentDefinition: {
2193
- id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2226
+ id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2194
2227
  /** @description Friendly name of the component definition */
2195
2228
  name: string;
2196
2229
  /**
@@ -2211,7 +2244,7 @@ interface external$a {
2211
2244
  */
2212
2245
  canBeComposition?: boolean;
2213
2246
  /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
2214
- parameters?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2247
+ parameters?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2215
2248
  /**
2216
2249
  * Format: uuid
2217
2250
  * @description Reference to the category this component definition belongs to
@@ -2234,14 +2267,14 @@ interface external$a {
2234
2267
  */
2235
2268
  useTeamPermissions?: boolean;
2236
2269
  /** @description Custom role permissions for this component definition */
2237
- permissions?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
2270
+ permissions?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
2238
2271
  /** @description The named slots for this component; placement areas where arrays of other components can be added. */
2239
- slots?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
2240
- slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2272
+ slots?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
2273
+ slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2241
2274
  /** @description Default component instance value */
2242
- defaults?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
2275
+ defaults?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
2243
2276
  /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
2244
- variants?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
2277
+ variants?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
2245
2278
  /** @description Created date string for this definition (ignored for writes) */
2246
2279
  created?: string;
2247
2280
  /** @description Last modified date string for this definition (ignored for writes) */
@@ -2249,7 +2282,7 @@ interface external$a {
2249
2282
  };
2250
2283
  /** @description Defines a content type */
2251
2284
  ContentType: {
2252
- id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2285
+ id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2253
2286
  /** @description Friendly name of the content type */
2254
2287
  name: string;
2255
2288
  /**
@@ -2258,7 +2291,7 @@ interface external$a {
2258
2291
  */
2259
2292
  entryName?: string | null;
2260
2293
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
2261
- fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2294
+ fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2262
2295
  /**
2263
2296
  * @description Description of the content type
2264
2297
  * @default null
@@ -2273,7 +2306,7 @@ interface external$a {
2273
2306
  created?: string;
2274
2307
  /** @description Last modified date string for this content type (ignored for writes) */
2275
2308
  updated?: string;
2276
- slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2309
+ slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2277
2310
  /**
2278
2311
  * @description The definition type of this content type (block or content type)
2279
2312
  * @default contentType
@@ -2288,7 +2321,7 @@ interface external$a {
2288
2321
  /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
2289
2322
  type: string;
2290
2323
  /** @deprecated */
2291
- connectedData?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
2324
+ connectedData?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
2292
2325
  };
2293
2326
  /** @description Defines a connection to a dynamic token on a data resource. */
2294
2327
  DataElementConnectionDefinition: {
@@ -2306,13 +2339,13 @@ interface external$a {
2306
2339
  type: string;
2307
2340
  /** @description Component parameter values for the component instance */
2308
2341
  parameters?: {
2309
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2342
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2310
2343
  };
2311
2344
  /** @description Public ID of alternate visual appearance for this component, if any selected */
2312
2345
  variant?: string;
2313
2346
  /** @description Slots containing any child components */
2314
2347
  slots?: {
2315
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2348
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2316
2349
  };
2317
2350
  /**
2318
2351
  * @description Unique identifier of the component within the composition.
@@ -2323,13 +2356,13 @@ interface external$a {
2323
2356
  _id?: string;
2324
2357
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
2325
2358
  _pattern?: string;
2326
- _dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2359
+ _dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2327
2360
  /**
2328
2361
  * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
2329
2362
  * Means nothing for PUTs; it will be ignored.
2330
2363
  */
2331
2364
  _patternDataResources?: {
2332
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2365
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2333
2366
  };
2334
2367
  /**
2335
2368
  * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -2353,7 +2386,7 @@ interface external$a {
2353
2386
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2354
2387
  */
2355
2388
  _overrides?: {
2356
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2389
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2357
2390
  };
2358
2391
  /**
2359
2392
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -2362,7 +2395,7 @@ interface external$a {
2362
2395
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2363
2396
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2364
2397
  */
2365
- _overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2398
+ _overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2366
2399
  };
2367
2400
  /** @description Defines the shape of the root component in a composition */
2368
2401
  RootComponentInstance: {
@@ -2370,15 +2403,15 @@ interface external$a {
2370
2403
  type: string;
2371
2404
  /** @description Component parameter values for the component instance */
2372
2405
  parameters?: {
2373
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2406
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2374
2407
  };
2375
2408
  /** @description Public ID of alternate visual appearance for this component, if any selected */
2376
2409
  variant?: string;
2377
2410
  /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
2378
- projectMapNodes?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
2411
+ projectMapNodes?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
2379
2412
  /** @description Slots containing any child components */
2380
2413
  slots?: {
2381
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2414
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
2382
2415
  };
2383
2416
  /** @description The public UUID of the composition. */
2384
2417
  _id: string;
@@ -2386,7 +2419,7 @@ interface external$a {
2386
2419
  _slug?: string | null;
2387
2420
  /** @description Friendly name of this component. */
2388
2421
  _name: string;
2389
- _dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2422
+ _dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2390
2423
  /**
2391
2424
  * @description Defines patch overrides to component IDs that live in the composition.
2392
2425
  * This can be used to override parameters that are defined on patterns,
@@ -2400,7 +2433,7 @@ interface external$a {
2400
2433
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2401
2434
  */
2402
2435
  _overrides?: {
2403
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2436
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
2404
2437
  };
2405
2438
  /**
2406
2439
  * @description When used on a pattern, defines how the pattern's parameters may be overridden
@@ -2409,7 +2442,7 @@ interface external$a {
2409
2442
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2410
2443
  * Future updates that do not break the overrides-applied state of a composition may be made without notice.
2411
2444
  */
2412
- _overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2445
+ _overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
2413
2446
  };
2414
2447
  /**
2415
2448
  * @description Defines how to override a specific component.
@@ -2419,7 +2452,7 @@ interface external$a {
2419
2452
  */
2420
2453
  ComponentOverride: {
2421
2454
  parameters?: {
2422
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2455
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2423
2456
  };
2424
2457
  variant?: string;
2425
2458
  };
@@ -2433,7 +2466,7 @@ interface external$a {
2433
2466
  ComponentOverridability: {
2434
2467
  /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
2435
2468
  parameters?: {
2436
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
2469
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
2437
2470
  };
2438
2471
  /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
2439
2472
  variants?: boolean;
@@ -2474,7 +2507,7 @@ interface external$a {
2474
2507
  }[];
2475
2508
  /** @description Variables needed to make calls to the data source */
2476
2509
  variables?: {
2477
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2510
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2478
2511
  };
2479
2512
  /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
2480
2513
  custom?: {
@@ -2498,15 +2531,8 @@ interface external$a {
2498
2531
  allowedOnComponents?: string[];
2499
2532
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
2500
2533
  path: string;
2501
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
2534
+ /** @description Time-to-live (in seconds) for the resource data cache. */
2502
2535
  ttl?: number;
2503
- /** @description Long term data resource cache configuration. */
2504
- longTermCache?: {
2505
- /** @description A flag to turn the long term cache on. */
2506
- enabled: boolean;
2507
- /** @description Time-to-live (in hours) for the long term resource data cache. */
2508
- ttlInHours?: number;
2509
- };
2510
2536
  /** @description A key for the resource data cache purging. */
2511
2537
  purgeKey?: string;
2512
2538
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -2533,7 +2559,7 @@ interface external$a {
2533
2559
  method: "GET" | "POST" | "HEAD";
2534
2560
  /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
2535
2561
  variables?: {
2536
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2562
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
2537
2563
  };
2538
2564
  /** @description Custom configuration specific to the data source being defined */
2539
2565
  custom?: {
@@ -2566,7 +2592,7 @@ interface external$a {
2566
2592
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
2567
2593
  */
2568
2594
  DataResourceDefinitions: {
2569
- [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2595
+ [key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
2570
2596
  };
2571
2597
  /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
2572
2598
  DataResourceDefinition: {
@@ -2580,7 +2606,7 @@ interface external$a {
2580
2606
  * If isPatternParameter is false or undefined, this has no meaning.
2581
2607
  */
2582
2608
  ignorePatternParameterDefault?: boolean;
2583
- variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
2609
+ variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
2584
2610
  };
2585
2611
  /** @description Variable values for a data resource. */
2586
2612
  DataResourceVariables: {
@@ -2616,6 +2642,26 @@ interface external$a {
2616
2642
  */
2617
2643
  projectMapId: string;
2618
2644
  };
2645
+ /** @description AI Prompt definition. */
2646
+ Prompt: {
2647
+ /**
2648
+ * Format: uuid
2649
+ * @description Unique identifier for the prompt
2650
+ */
2651
+ id: string;
2652
+ /** @description Unique identifier for the integration that this prompt belongs to. */
2653
+ integrationType: string;
2654
+ /** @description Name for the prompt */
2655
+ promptName?: string | null;
2656
+ /** @description Text for the prompt */
2657
+ promptText?: string | null;
2658
+ /** @description Data for the prompt */
2659
+ promptData?: string | null;
2660
+ /** @description Turn off/on prompt */
2661
+ enabled?: boolean | null;
2662
+ /** @description Integration default prompt */
2663
+ builtIn?: boolean | null;
2664
+ };
2619
2665
  };
2620
2666
  };
2621
2667
  operations: {};
@@ -2626,7 +2672,7 @@ interface external$a {
2626
2672
  * This file was auto-generated by openapi-typescript.
2627
2673
  * Do not make direct changes to the file.
2628
2674
  */
2629
- interface paths$8 {
2675
+ interface paths$a {
2630
2676
  "/api/v1/entries": {
2631
2677
  get: {
2632
2678
  parameters: {
@@ -2682,17 +2728,17 @@ interface paths$8 {
2682
2728
  "application/json": components$4["schemas"]["EntryListResponse"];
2683
2729
  };
2684
2730
  };
2685
- 400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
2686
- 401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2687
- 403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2731
+ 400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
2732
+ 401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2733
+ 403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2688
2734
  /** Entry not found */
2689
2735
  404: {
2690
2736
  content: {
2691
2737
  "text/plain": string;
2692
2738
  };
2693
2739
  };
2694
- 429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
2695
- 500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
2740
+ 429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
2741
+ 500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
2696
2742
  };
2697
2743
  };
2698
2744
  /** Upserts an entry */
@@ -2700,11 +2746,11 @@ interface paths$8 {
2700
2746
  responses: {
2701
2747
  /** OK */
2702
2748
  204: never;
2703
- 400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
2704
- 401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2705
- 403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2706
- 429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
2707
- 500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
2749
+ 400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
2750
+ 401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2751
+ 403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2752
+ 429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
2753
+ 500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
2708
2754
  };
2709
2755
  requestBody: {
2710
2756
  content: {
@@ -2730,11 +2776,11 @@ interface paths$8 {
2730
2776
  responses: {
2731
2777
  /** OK */
2732
2778
  204: never;
2733
- 400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
2734
- 401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2735
- 403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2736
- 429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
2737
- 500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
2779
+ 400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
2780
+ 401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
2781
+ 403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
2782
+ 429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
2783
+ 500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
2738
2784
  };
2739
2785
  requestBody: {
2740
2786
  content: {
@@ -2783,9 +2829,9 @@ interface components$4 {
2783
2829
  _author?: string;
2784
2830
  /** @description Entry field values. */
2785
2831
  fields?: {
2786
- [key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2832
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2787
2833
  };
2788
- _dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2834
+ _dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2789
2835
  };
2790
2836
  /** @description Defines the shape of the entry input */
2791
2837
  EntryInput: {
@@ -2802,9 +2848,9 @@ interface components$4 {
2802
2848
  _slug?: string;
2803
2849
  /** @description Entry field values. */
2804
2850
  fields?: {
2805
- [key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2851
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
2806
2852
  };
2807
- _dataResources?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2853
+ _dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
2808
2854
  };
2809
2855
  EntryApiResponse: {
2810
2856
  /** @description Publishing state to fetch. 0 = draft, 64 = published. */
@@ -2838,51 +2884,1348 @@ interface components$4 {
2838
2884
  totalCount?: number;
2839
2885
  };
2840
2886
  };
2841
- parameters: {
2842
- /** @description The project the entry/entries are on. */
2843
- projectId: string;
2844
- /** @description Specify multiple entry IDs to fetch. */
2845
- entryIDs: string[];
2846
- /** @description Specify a single entry to fetch by slug. */
2847
- slug: string;
2848
- /** @description The content type ID to filter by. */
2849
- type: string[];
2850
- /** @description Publishing state to fetch. 0 = draft, 64 = published. */
2851
- state: number;
2852
- /** @description Number of records to skip */
2853
- offset: number;
2854
- /** @description Max number of records to return */
2855
- limit: number;
2856
- /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
2857
- orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
2858
- /**
2859
- * @deprecated
2860
- * @description Returns the UI status string of the entry.
2861
- * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2862
- */
2863
- withUIStatus: boolean;
2864
- /**
2865
- * @description If true the `_id` unique identifier of blocks will be part of the response data.
2866
- * If false, the `_id` will not be present in the API response.
2867
- */
2868
- withComponentIDs: boolean;
2869
- /**
2870
- * @deprecated
2871
- * @description Filters entries lists by the UI status of the entry.
2872
- * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2873
- */
2874
- uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
2875
- /** @description Filters entry lists by the user who created them. The user is specified by their identity subject. */
2876
- createdBy: string;
2877
- /** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
2878
- updatedBy: string;
2879
- /**
2880
- * @description Controls whether the total count of results will be returned along with the current results page in a list.
2881
- * Has no effect when not fetching a list. This does impact performance when enabled.
2882
- */
2883
- withTotalCount: boolean;
2884
- /** @description Performs keyword search on the entries. */
2885
- keyword: string;
2887
+ parameters: {
2888
+ /** @description The project the entry/entries are on. */
2889
+ projectId: string;
2890
+ /** @description Specify multiple entry IDs to fetch. */
2891
+ entryIDs: string[];
2892
+ /** @description Specify a single entry to fetch by slug. */
2893
+ slug: string;
2894
+ /** @description The content type ID to filter by. */
2895
+ type: string[];
2896
+ /** @description Publishing state to fetch. 0 = draft, 64 = published. */
2897
+ state: number;
2898
+ /** @description Number of records to skip */
2899
+ offset: number;
2900
+ /** @description Max number of records to return */
2901
+ limit: number;
2902
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
2903
+ orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
2904
+ /**
2905
+ * @deprecated
2906
+ * @description Returns the UI status string of the entry.
2907
+ * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2908
+ */
2909
+ withUIStatus: boolean;
2910
+ /**
2911
+ * @description If true the `_id` unique identifier of blocks will be part of the response data.
2912
+ * If false, the `_id` will not be present in the API response.
2913
+ */
2914
+ withComponentIDs: boolean;
2915
+ /**
2916
+ * @deprecated
2917
+ * @description Filters entries lists by the UI status of the entry.
2918
+ * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
2919
+ */
2920
+ uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
2921
+ /** @description Filters entry lists by the user who created them. The user is specified by their identity subject. */
2922
+ createdBy: string;
2923
+ /** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
2924
+ updatedBy: string;
2925
+ /**
2926
+ * @description Controls whether the total count of results will be returned along with the current results page in a list.
2927
+ * Has no effect when not fetching a list. This does impact performance when enabled.
2928
+ */
2929
+ withTotalCount: boolean;
2930
+ /** @description Performs keyword search on the entries. */
2931
+ keyword: string;
2932
+ };
2933
+ }
2934
+ interface external$b {
2935
+ "swagger.yml": {
2936
+ paths: {};
2937
+ components: {
2938
+ schemas: {
2939
+ Error: {
2940
+ /** @description Error message(s) that occurred while processing the request */
2941
+ errorMessage?: string[] | string;
2942
+ };
2943
+ };
2944
+ responses: {
2945
+ /** Request input validation failed */
2946
+ BadRequestError: {
2947
+ content: {
2948
+ "application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
2949
+ };
2950
+ };
2951
+ /** API key or token was not valid */
2952
+ UnauthorizedError: {
2953
+ content: {
2954
+ "application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
2955
+ };
2956
+ };
2957
+ /** Permission was denied */
2958
+ ForbiddenError: {
2959
+ content: {
2960
+ "application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
2961
+ };
2962
+ };
2963
+ /** Resource not found */
2964
+ NotFoundError: {
2965
+ content: {
2966
+ "application/json": external$b["swagger.yml"]["components"]["schemas"]["Error"];
2967
+ };
2968
+ };
2969
+ /** Too many requests in allowed time period */
2970
+ RateLimitError: unknown;
2971
+ /** Execution error occurred */
2972
+ InternalServerError: unknown;
2973
+ };
2974
+ };
2975
+ operations: {};
2976
+ };
2977
+ "uniform-canvas-types.swagger.yml": {
2978
+ paths: {};
2979
+ components: {
2980
+ schemas: {
2981
+ /** @description Public ID (used in code). Do not change after creation. */
2982
+ PublicIdProperty: string;
2983
+ /** @description The definition of a component parameter */
2984
+ ComponentDefinitionParameter: {
2985
+ id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2986
+ /** @description Friendly name of the parameter */
2987
+ name: string;
2988
+ /** @description Appears next to the parameter in the Composition editor */
2989
+ helpText?: string;
2990
+ /** @description Type name of the parameter (provided by a Uniform integration) */
2991
+ type: string;
2992
+ /** @description The configuration object for the type (type-specific) */
2993
+ typeConfig?: unknown;
2994
+ };
2995
+ /** @description The definition of a named component slot that can contain other components */
2996
+ ComponentDefinitionSlot: {
2997
+ id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
2998
+ /** @description Friendly name of the slot */
2999
+ name: string;
3000
+ /** @description A list of component definition public IDs that are allowed in this named slot */
3001
+ allowedComponents: string[];
3002
+ /**
3003
+ * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
3004
+ * If allowAllComponents is true, this value is ignored.
3005
+ *
3006
+ * @default false
3007
+ */
3008
+ inheritAllowedComponents: boolean;
3009
+ /**
3010
+ * @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
3011
+ * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
3012
+ */
3013
+ allowAllComponents?: boolean;
3014
+ /**
3015
+ * @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
3016
+ * When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
3017
+ */
3018
+ patternsInAllowedComponents?: boolean;
3019
+ /** @description Minimum valid number of components in this slot */
3020
+ minComponents?: number;
3021
+ /** @description Maximum valid number of components in this slot */
3022
+ maxComponents?: number;
3023
+ };
3024
+ /** @description The definition of a composition's slug settings */
3025
+ ComponentDefinitionSlugSettings: {
3026
+ /**
3027
+ * @description Whether the slug is required
3028
+ * no: slug is optional
3029
+ * yes: slug is required
3030
+ * disabled: slug is disabled and will not be shown in the editor
3031
+ *
3032
+ * @default no
3033
+ * @enum {string}
3034
+ */
3035
+ required?: "no" | "yes" | "disabled";
3036
+ /**
3037
+ * @description Slug uniqueness configuration.
3038
+ * no = no unique constraint
3039
+ * local = must be unique within this component type
3040
+ * global = must be unique across all component types
3041
+ *
3042
+ * @enum {string}
3043
+ */
3044
+ unique?: "no" | "local" | "global";
3045
+ /** @description Regular expression slugs must match */
3046
+ regularExpression?: string;
3047
+ /**
3048
+ * @description Custom error message when regular expression validation fails.
3049
+ * Has no effect if `regularExpression` is not set.
3050
+ */
3051
+ regularExpressionMessage?: string;
3052
+ };
3053
+ /** @description The definition of a component variant */
3054
+ ComponentDefinitionVariant: {
3055
+ id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3056
+ /** @description Friendly name of the variant */
3057
+ name: string;
3058
+ };
3059
+ /** @description Permission set for a component defintion */
3060
+ ComponentDefinitionPermission: {
3061
+ roleId: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3062
+ /**
3063
+ * @description Permission type for this permission ComponentDefinition:
3064
+ * read | write | create | delete
3065
+ *
3066
+ * @enum {string}
3067
+ */
3068
+ permission: "read" | "write" | "create" | "delete";
3069
+ /** @description State of the component that this permission applies to */
3070
+ state: number;
3071
+ };
3072
+ /** @description Defines a component type that can live on a Composition */
3073
+ ComponentDefinition: {
3074
+ id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3075
+ /** @description Friendly name of the component definition */
3076
+ name: string;
3077
+ /**
3078
+ * @description Icon name for the component definition (e.g. 'screen')
3079
+ * @default screen
3080
+ */
3081
+ icon?: string;
3082
+ /**
3083
+ * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
3084
+ * The parameter type must support being used as a title parameter for this to work.
3085
+ *
3086
+ * @default null
3087
+ */
3088
+ titleParameter?: string | null;
3089
+ /**
3090
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
3091
+ * @default false
3092
+ */
3093
+ canBeComposition?: boolean;
3094
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
3095
+ parameters?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
3096
+ /**
3097
+ * Format: uuid
3098
+ * @description Reference to the category this component definition belongs to
3099
+ * @default null
3100
+ */
3101
+ categoryId?: string | null;
3102
+ /**
3103
+ * @description Description of the component definition
3104
+ * @default null
3105
+ */
3106
+ description?: string;
3107
+ /**
3108
+ * @description Description of the component definition
3109
+ * @default null
3110
+ */
3111
+ previewImageUrl?: string;
3112
+ /**
3113
+ * @description if this component uses team permissions or custom permissions
3114
+ * @default true
3115
+ */
3116
+ useTeamPermissions?: boolean;
3117
+ /** @description Custom role permissions for this component definition */
3118
+ permissions?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
3119
+ /** @description The named slots for this component; placement areas where arrays of other components can be added. */
3120
+ slots?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
3121
+ slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
3122
+ /** @description Default component instance value */
3123
+ defaults?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
3124
+ /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
3125
+ variants?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
3126
+ /** @description Created date string for this definition (ignored for writes) */
3127
+ created?: string;
3128
+ /** @description Last modified date string for this definition (ignored for writes) */
3129
+ updated?: string;
3130
+ };
3131
+ /** @description Defines a content type */
3132
+ ContentType: {
3133
+ id: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3134
+ /** @description Friendly name of the content type */
3135
+ name: string;
3136
+ /**
3137
+ * @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
3138
+ * The field type must support being used as an entry name for this to work.
3139
+ */
3140
+ entryName?: string | null;
3141
+ /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
3142
+ fields?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
3143
+ /**
3144
+ * @description Description of the content type
3145
+ * @default null
3146
+ */
3147
+ description?: string;
3148
+ /**
3149
+ * @description Icon name for the content type (e.g. 'screen')
3150
+ * @default file-document
3151
+ */
3152
+ icon?: string;
3153
+ /** @description Created date string for this content type (ignored for writes) */
3154
+ created?: string;
3155
+ /** @description Last modified date string for this content type (ignored for writes) */
3156
+ updated?: string;
3157
+ slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
3158
+ /**
3159
+ * @description The definition type of this content type (block or content type)
3160
+ * @default contentType
3161
+ * @enum {string}
3162
+ */
3163
+ type?: "contentType" | "block";
3164
+ };
3165
+ /** @description Defines an editable parameter on a component. */
3166
+ ComponentParameter: {
3167
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
3168
+ value: unknown;
3169
+ /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
3170
+ type: string;
3171
+ /** @deprecated */
3172
+ connectedData?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
3173
+ };
3174
+ /** @description Defines a connection to a dynamic token on a data resource. */
3175
+ DataElementConnectionDefinition: {
3176
+ /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
3177
+ pointer: string;
3178
+ /**
3179
+ * @description The syntax used to select the dynamic token to bind to
3180
+ * @enum {string}
3181
+ */
3182
+ syntax: "jptr";
3183
+ };
3184
+ /** @description Defines the shape of a component instance served by the composition API. */
3185
+ ComponentInstance: {
3186
+ /** @description Type of the component instance (public_id of its definition) */
3187
+ type: string;
3188
+ /** @description Component parameter values for the component instance */
3189
+ parameters?: {
3190
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
3191
+ };
3192
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
3193
+ variant?: string;
3194
+ /** @description Slots containing any child components */
3195
+ slots?: {
3196
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
3197
+ };
3198
+ /**
3199
+ * @description Unique identifier of the component within the composition.
3200
+ * No assumptions should be made about the format of this value other than "it will be unique."
3201
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
3202
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
3203
+ */
3204
+ _id?: string;
3205
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
3206
+ _pattern?: string;
3207
+ _dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3208
+ /**
3209
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
3210
+ * Means nothing for PUTs; it will be ignored.
3211
+ */
3212
+ _patternDataResources?: {
3213
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
3214
+ };
3215
+ /**
3216
+ * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
3217
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
3218
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
3219
+ * Means nothing for PUTs; it will be ignored.
3220
+ *
3221
+ * @enum {string}
3222
+ */
3223
+ _patternError?: "NOTFOUND" | "CYCLIC";
3224
+ /**
3225
+ * @description Defines patch overrides to component IDs that live in the composition.
3226
+ * This can be used to override parameters that are defined on patterns,
3227
+ * including nested patterns, with values that are specific to this composition.
3228
+ * The keys in this object are component IDs.
3229
+ * Overrides are applied from the top down, so for example if both the composition
3230
+ * and a pattern on the composition define an override on a nested pattern,
3231
+ * the composition's override replaces the pattern's.
3232
+ *
3233
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3234
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3235
+ */
3236
+ _overrides?: {
3237
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3238
+ };
3239
+ /**
3240
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
3241
+ * by consumers of the pattern.
3242
+ *
3243
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3244
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3245
+ */
3246
+ _overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3247
+ };
3248
+ /** @description Defines the shape of the root component in a composition */
3249
+ RootComponentInstance: {
3250
+ /** @description Type of the component instance (public_id of its definition) */
3251
+ type: string;
3252
+ /** @description Component parameter values for the component instance */
3253
+ parameters?: {
3254
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
3255
+ };
3256
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
3257
+ variant?: string;
3258
+ /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
3259
+ projectMapNodes?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
3260
+ /** @description Slots containing any child components */
3261
+ slots?: {
3262
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
3263
+ };
3264
+ /** @description The public UUID of the composition. */
3265
+ _id: string;
3266
+ /** @description Slug pattern of this component. */
3267
+ _slug?: string | null;
3268
+ /** @description Friendly name of this component. */
3269
+ _name: string;
3270
+ _dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3271
+ /**
3272
+ * @description Defines patch overrides to component IDs that live in the composition.
3273
+ * This can be used to override parameters that are defined on patterns,
3274
+ * including nested patterns, with values that are specific to this composition.
3275
+ * The keys in this object are component IDs.
3276
+ * Overrides are applied from the top down, so for example if both the composition
3277
+ * and a pattern on the composition define an override on a nested pattern,
3278
+ * the composition's override replaces the pattern's.
3279
+ *
3280
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3281
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3282
+ */
3283
+ _overrides?: {
3284
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3285
+ };
3286
+ /**
3287
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
3288
+ * by consumers of the pattern.
3289
+ *
3290
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3291
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3292
+ */
3293
+ _overridability?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3294
+ };
3295
+ /**
3296
+ * @description Defines how to override a specific component.
3297
+ *
3298
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3299
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3300
+ */
3301
+ ComponentOverride: {
3302
+ parameters?: {
3303
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
3304
+ };
3305
+ variant?: string;
3306
+ };
3307
+ /**
3308
+ * @description Defines how a component on a pattern may have its values overridden.
3309
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
3310
+ *
3311
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3312
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3313
+ */
3314
+ ComponentOverridability: {
3315
+ /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
3316
+ parameters?: {
3317
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
3318
+ };
3319
+ /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
3320
+ variants?: boolean;
3321
+ };
3322
+ /**
3323
+ * @description Whether a parameter is overridable
3324
+ *
3325
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3326
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3327
+ *
3328
+ * @enum {string}
3329
+ */
3330
+ OverrideOptions: "yes" | "no";
3331
+ /**
3332
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
3333
+ * These are created in the UI and shared across a whole project.
3334
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
3335
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
3336
+ */
3337
+ DataSource: {
3338
+ /** @description Public ID of the data source */
3339
+ id: string;
3340
+ /** @description Display name of the data source */
3341
+ displayName: string;
3342
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
3343
+ connectorType: string;
3344
+ /** @description Base resource URL of the data source. No trailing slash. */
3345
+ baseUrl: string;
3346
+ /** @description HTTP headers to pass with requests to the data source */
3347
+ headers?: {
3348
+ key: string;
3349
+ value: string;
3350
+ }[];
3351
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
3352
+ parameters?: {
3353
+ key: string;
3354
+ value: string;
3355
+ }[];
3356
+ /** @description Variables needed to make calls to the data source */
3357
+ variables?: {
3358
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
3359
+ };
3360
+ /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
3361
+ custom?: {
3362
+ [key: string]: unknown;
3363
+ };
3364
+ };
3365
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
3366
+ DataType: {
3367
+ /** @description Public ID of the data type */
3368
+ id: string;
3369
+ /** @description Display name of the data type */
3370
+ displayName: string;
3371
+ /** @description Public ID of the associated data source */
3372
+ dataSourceId: string;
3373
+ /**
3374
+ * @description A connector-specific archetype for this data type; used to select UI as well as perform any
3375
+ * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
3376
+ * no special UI or processing is required.
3377
+ */
3378
+ archetype?: string;
3379
+ allowedOnComponents?: string[];
3380
+ /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
3381
+ path: string;
3382
+ /** @description Time-to-live (in seconds) for the resource data cache. */
3383
+ ttl?: number;
3384
+ /** @description A key for the resource data cache purging. */
3385
+ purgeKey?: string;
3386
+ /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
3387
+ badgeIconUrl?: string;
3388
+ /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
3389
+ headers?: {
3390
+ key: string;
3391
+ value: string;
3392
+ omitIfEmpty?: boolean;
3393
+ }[];
3394
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
3395
+ parameters?: {
3396
+ key: string;
3397
+ value: string;
3398
+ omitIfEmpty?: boolean;
3399
+ }[];
3400
+ /** @description Body to pass with requests to the data type (ignored unless method is POST) */
3401
+ body?: string;
3402
+ /**
3403
+ * @description HTTP method to use with requests to the data type.
3404
+ * @default GET
3405
+ * @enum {string}
3406
+ */
3407
+ method: "GET" | "POST" | "HEAD";
3408
+ /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
3409
+ variables?: {
3410
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
3411
+ };
3412
+ /** @description Custom configuration specific to the data source being defined */
3413
+ custom?: {
3414
+ [key: string]: unknown;
3415
+ };
3416
+ };
3417
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
3418
+ DataVariableDefinition: {
3419
+ /** @description Display name of the data variable */
3420
+ displayName?: string;
3421
+ /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
3422
+ helpText?: string;
3423
+ /**
3424
+ * @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
3425
+ * @default text
3426
+ */
3427
+ type?: string;
3428
+ /** @description Default value of the data variable */
3429
+ default: string;
3430
+ /** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
3431
+ order?: number;
3432
+ /**
3433
+ * @description An optional arbitrary human readable source identifier to describe where this variable is from.
3434
+ * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
3435
+ */
3436
+ source?: string;
3437
+ };
3438
+ /**
3439
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
3440
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
3441
+ */
3442
+ DataResourceDefinitions: {
3443
+ [key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
3444
+ };
3445
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
3446
+ DataResourceDefinition: {
3447
+ /** @description Public ID of the data type that provides this data */
3448
+ type: string;
3449
+ /** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
3450
+ isPatternParameter?: boolean;
3451
+ /**
3452
+ * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
3453
+ * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
3454
+ * If isPatternParameter is false or undefined, this has no meaning.
3455
+ */
3456
+ ignorePatternParameterDefault?: boolean;
3457
+ variables?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
3458
+ };
3459
+ /** @description Variable values for a data resource. */
3460
+ DataResourceVariables: {
3461
+ [key: string]: string;
3462
+ };
3463
+ /** @description Category for tagging canvas entities */
3464
+ Category: {
3465
+ /**
3466
+ * Format: uuid
3467
+ * @description Unique identifier for the category
3468
+ */
3469
+ id: string;
3470
+ /** @description Display name of the category */
3471
+ name: string;
3472
+ /**
3473
+ * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
3474
+ * @default 0
3475
+ */
3476
+ order?: number;
3477
+ };
3478
+ /** @description Project map node information related to a component. */
3479
+ CompositionProjectMapNodeInfo: {
3480
+ /**
3481
+ * Format: uuid
3482
+ * @description Unique identifier for the project map node
3483
+ */
3484
+ id: string;
3485
+ /** @description Path of the project map node */
3486
+ path: string;
3487
+ /**
3488
+ * Format: uuid
3489
+ * @description Unique identifier for the project map that this node belongs to.
3490
+ */
3491
+ projectMapId: string;
3492
+ };
3493
+ /** @description AI Prompt definition. */
3494
+ Prompt: {
3495
+ /**
3496
+ * Format: uuid
3497
+ * @description Unique identifier for the prompt
3498
+ */
3499
+ id: string;
3500
+ /** @description Unique identifier for the integration that this prompt belongs to. */
3501
+ integrationType: string;
3502
+ /** @description Name for the prompt */
3503
+ promptName?: string | null;
3504
+ /** @description Text for the prompt */
3505
+ promptText?: string | null;
3506
+ /** @description Data for the prompt */
3507
+ promptData?: string | null;
3508
+ /** @description Turn off/on prompt */
3509
+ enabled?: boolean | null;
3510
+ /** @description Integration default prompt */
3511
+ builtIn?: boolean | null;
3512
+ };
3513
+ };
3514
+ };
3515
+ operations: {};
3516
+ };
3517
+ }
3518
+
3519
+ type ContentType = components$5['schemas']['ContentType'];
3520
+ type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
3521
+ type GetContentTypesOptions = paths$b['/api/v1/content-types']['get']['parameters']['query'];
3522
+ type DeleteContentTypeOptions = paths$b['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
3523
+ type PutContentTypeBody = paths$b['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
3524
+ type GetContentTypesResponse = paths$b['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
3525
+ type Entry = components$4['schemas']['EntryApiResponse'];
3526
+ type EntryData = Entry['entry'];
3527
+ type GetEntriesOptions = paths$a['/api/v1/entries']['get']['parameters']['query'];
3528
+ type GetEntriesResponse = paths$a['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
3529
+ type DeleteEntryOptions = paths$a['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
3530
+ type PutEntryBody = paths$a['/api/v1/entries']['put']['requestBody']['content']['application/json'];
3531
+
3532
+ /**
3533
+ * This file was auto-generated by openapi-typescript.
3534
+ * Do not make direct changes to the file.
3535
+ */
3536
+ interface paths$9 {
3537
+ "/api/v1/data-source": {
3538
+ get: {
3539
+ parameters: {
3540
+ query: {
3541
+ dataSourceId: string;
3542
+ projectId: string;
3543
+ };
3544
+ };
3545
+ responses: {
3546
+ /** OK */
3547
+ 200: {
3548
+ content: {
3549
+ "application/json": {
3550
+ result: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
3551
+ };
3552
+ };
3553
+ };
3554
+ 400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
3555
+ 401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3556
+ 403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3557
+ 429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
3558
+ 500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
3559
+ };
3560
+ };
3561
+ put: {
3562
+ responses: {
3563
+ /** OK */
3564
+ 204: never;
3565
+ 400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
3566
+ 401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3567
+ 403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3568
+ 429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
3569
+ 500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
3570
+ };
3571
+ requestBody: {
3572
+ content: {
3573
+ "application/json": {
3574
+ data: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
3575
+ /** Format: uuid */
3576
+ projectId: string;
3577
+ /**
3578
+ * Format: uuid
3579
+ * @deprecated
3580
+ * @description Do not use. May be removed in future.
3581
+ */
3582
+ integrationId?: string;
3583
+ /** @description The integration type that the data source is attached to. Must be installed in the project. */
3584
+ integrationType?: string;
3585
+ };
3586
+ };
3587
+ };
3588
+ };
3589
+ delete: {
3590
+ responses: {
3591
+ /** OK */
3592
+ 204: never;
3593
+ 400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
3594
+ 401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
3595
+ 403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
3596
+ 429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
3597
+ 500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
3598
+ };
3599
+ requestBody: {
3600
+ content: {
3601
+ "application/json": {
3602
+ dataSourceId: string;
3603
+ /** Format: uuid */
3604
+ projectId: string;
3605
+ };
3606
+ };
3607
+ };
3608
+ };
3609
+ };
3610
+ }
3611
+ interface external$a {
3612
+ "swagger.yml": {
3613
+ paths: {};
3614
+ components: {
3615
+ schemas: {
3616
+ Error: {
3617
+ /** @description Error message(s) that occurred while processing the request */
3618
+ errorMessage?: string[] | string;
3619
+ };
3620
+ };
3621
+ responses: {
3622
+ /** Request input validation failed */
3623
+ BadRequestError: {
3624
+ content: {
3625
+ "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
3626
+ };
3627
+ };
3628
+ /** API key or token was not valid */
3629
+ UnauthorizedError: {
3630
+ content: {
3631
+ "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
3632
+ };
3633
+ };
3634
+ /** Permission was denied */
3635
+ ForbiddenError: {
3636
+ content: {
3637
+ "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
3638
+ };
3639
+ };
3640
+ /** Resource not found */
3641
+ NotFoundError: {
3642
+ content: {
3643
+ "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
3644
+ };
3645
+ };
3646
+ /** Too many requests in allowed time period */
3647
+ RateLimitError: unknown;
3648
+ /** Execution error occurred */
3649
+ InternalServerError: unknown;
3650
+ };
3651
+ };
3652
+ operations: {};
3653
+ };
3654
+ "uniform-canvas-types.swagger.yml": {
3655
+ paths: {};
3656
+ components: {
3657
+ schemas: {
3658
+ /** @description Public ID (used in code). Do not change after creation. */
3659
+ PublicIdProperty: string;
3660
+ /** @description The definition of a component parameter */
3661
+ ComponentDefinitionParameter: {
3662
+ id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3663
+ /** @description Friendly name of the parameter */
3664
+ name: string;
3665
+ /** @description Appears next to the parameter in the Composition editor */
3666
+ helpText?: string;
3667
+ /** @description Type name of the parameter (provided by a Uniform integration) */
3668
+ type: string;
3669
+ /** @description The configuration object for the type (type-specific) */
3670
+ typeConfig?: unknown;
3671
+ };
3672
+ /** @description The definition of a named component slot that can contain other components */
3673
+ ComponentDefinitionSlot: {
3674
+ id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3675
+ /** @description Friendly name of the slot */
3676
+ name: string;
3677
+ /** @description A list of component definition public IDs that are allowed in this named slot */
3678
+ allowedComponents: string[];
3679
+ /**
3680
+ * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
3681
+ * If allowAllComponents is true, this value is ignored.
3682
+ *
3683
+ * @default false
3684
+ */
3685
+ inheritAllowedComponents: boolean;
3686
+ /**
3687
+ * @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
3688
+ * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
3689
+ */
3690
+ allowAllComponents?: boolean;
3691
+ /**
3692
+ * @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
3693
+ * When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
3694
+ */
3695
+ patternsInAllowedComponents?: boolean;
3696
+ /** @description Minimum valid number of components in this slot */
3697
+ minComponents?: number;
3698
+ /** @description Maximum valid number of components in this slot */
3699
+ maxComponents?: number;
3700
+ };
3701
+ /** @description The definition of a composition's slug settings */
3702
+ ComponentDefinitionSlugSettings: {
3703
+ /**
3704
+ * @description Whether the slug is required
3705
+ * no: slug is optional
3706
+ * yes: slug is required
3707
+ * disabled: slug is disabled and will not be shown in the editor
3708
+ *
3709
+ * @default no
3710
+ * @enum {string}
3711
+ */
3712
+ required?: "no" | "yes" | "disabled";
3713
+ /**
3714
+ * @description Slug uniqueness configuration.
3715
+ * no = no unique constraint
3716
+ * local = must be unique within this component type
3717
+ * global = must be unique across all component types
3718
+ *
3719
+ * @enum {string}
3720
+ */
3721
+ unique?: "no" | "local" | "global";
3722
+ /** @description Regular expression slugs must match */
3723
+ regularExpression?: string;
3724
+ /**
3725
+ * @description Custom error message when regular expression validation fails.
3726
+ * Has no effect if `regularExpression` is not set.
3727
+ */
3728
+ regularExpressionMessage?: string;
3729
+ };
3730
+ /** @description The definition of a component variant */
3731
+ ComponentDefinitionVariant: {
3732
+ id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3733
+ /** @description Friendly name of the variant */
3734
+ name: string;
3735
+ };
3736
+ /** @description Permission set for a component defintion */
3737
+ ComponentDefinitionPermission: {
3738
+ roleId: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3739
+ /**
3740
+ * @description Permission type for this permission ComponentDefinition:
3741
+ * read | write | create | delete
3742
+ *
3743
+ * @enum {string}
3744
+ */
3745
+ permission: "read" | "write" | "create" | "delete";
3746
+ /** @description State of the component that this permission applies to */
3747
+ state: number;
3748
+ };
3749
+ /** @description Defines a component type that can live on a Composition */
3750
+ ComponentDefinition: {
3751
+ id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3752
+ /** @description Friendly name of the component definition */
3753
+ name: string;
3754
+ /**
3755
+ * @description Icon name for the component definition (e.g. 'screen')
3756
+ * @default screen
3757
+ */
3758
+ icon?: string;
3759
+ /**
3760
+ * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
3761
+ * The parameter type must support being used as a title parameter for this to work.
3762
+ *
3763
+ * @default null
3764
+ */
3765
+ titleParameter?: string | null;
3766
+ /**
3767
+ * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
3768
+ * @default false
3769
+ */
3770
+ canBeComposition?: boolean;
3771
+ /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
3772
+ parameters?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
3773
+ /**
3774
+ * Format: uuid
3775
+ * @description Reference to the category this component definition belongs to
3776
+ * @default null
3777
+ */
3778
+ categoryId?: string | null;
3779
+ /**
3780
+ * @description Description of the component definition
3781
+ * @default null
3782
+ */
3783
+ description?: string;
3784
+ /**
3785
+ * @description Description of the component definition
3786
+ * @default null
3787
+ */
3788
+ previewImageUrl?: string;
3789
+ /**
3790
+ * @description if this component uses team permissions or custom permissions
3791
+ * @default true
3792
+ */
3793
+ useTeamPermissions?: boolean;
3794
+ /** @description Custom role permissions for this component definition */
3795
+ permissions?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
3796
+ /** @description The named slots for this component; placement areas where arrays of other components can be added. */
3797
+ slots?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
3798
+ slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
3799
+ /** @description Default component instance value */
3800
+ defaults?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
3801
+ /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
3802
+ variants?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
3803
+ /** @description Created date string for this definition (ignored for writes) */
3804
+ created?: string;
3805
+ /** @description Last modified date string for this definition (ignored for writes) */
3806
+ updated?: string;
3807
+ };
3808
+ /** @description Defines a content type */
3809
+ ContentType: {
3810
+ id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
3811
+ /** @description Friendly name of the content type */
3812
+ name: string;
3813
+ /**
3814
+ * @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
3815
+ * The field type must support being used as an entry name for this to work.
3816
+ */
3817
+ entryName?: string | null;
3818
+ /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
3819
+ fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
3820
+ /**
3821
+ * @description Description of the content type
3822
+ * @default null
3823
+ */
3824
+ description?: string;
3825
+ /**
3826
+ * @description Icon name for the content type (e.g. 'screen')
3827
+ * @default file-document
3828
+ */
3829
+ icon?: string;
3830
+ /** @description Created date string for this content type (ignored for writes) */
3831
+ created?: string;
3832
+ /** @description Last modified date string for this content type (ignored for writes) */
3833
+ updated?: string;
3834
+ slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
3835
+ /**
3836
+ * @description The definition type of this content type (block or content type)
3837
+ * @default contentType
3838
+ * @enum {string}
3839
+ */
3840
+ type?: "contentType" | "block";
3841
+ };
3842
+ /** @description Defines an editable parameter on a component. */
3843
+ ComponentParameter: {
3844
+ /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
3845
+ value: unknown;
3846
+ /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
3847
+ type: string;
3848
+ /** @deprecated */
3849
+ connectedData?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
3850
+ };
3851
+ /** @description Defines a connection to a dynamic token on a data resource. */
3852
+ DataElementConnectionDefinition: {
3853
+ /** @description A JSON Pointer expression that defines the data resource dynamic token value. */
3854
+ pointer: string;
3855
+ /**
3856
+ * @description The syntax used to select the dynamic token to bind to
3857
+ * @enum {string}
3858
+ */
3859
+ syntax: "jptr";
3860
+ };
3861
+ /** @description Defines the shape of a component instance served by the composition API. */
3862
+ ComponentInstance: {
3863
+ /** @description Type of the component instance (public_id of its definition) */
3864
+ type: string;
3865
+ /** @description Component parameter values for the component instance */
3866
+ parameters?: {
3867
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
3868
+ };
3869
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
3870
+ variant?: string;
3871
+ /** @description Slots containing any child components */
3872
+ slots?: {
3873
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
3874
+ };
3875
+ /**
3876
+ * @description Unique identifier of the component within the composition.
3877
+ * No assumptions should be made about the format of this value other than "it will be unique."
3878
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
3879
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
3880
+ */
3881
+ _id?: string;
3882
+ /** @description Indicates this component instance should be sourced from a pattern library pattern. */
3883
+ _pattern?: string;
3884
+ _dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3885
+ /**
3886
+ * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
3887
+ * Means nothing for PUTs; it will be ignored.
3888
+ */
3889
+ _patternDataResources?: {
3890
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
3891
+ };
3892
+ /**
3893
+ * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
3894
+ * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
3895
+ * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
3896
+ * Means nothing for PUTs; it will be ignored.
3897
+ *
3898
+ * @enum {string}
3899
+ */
3900
+ _patternError?: "NOTFOUND" | "CYCLIC";
3901
+ /**
3902
+ * @description Defines patch overrides to component IDs that live in the composition.
3903
+ * This can be used to override parameters that are defined on patterns,
3904
+ * including nested patterns, with values that are specific to this composition.
3905
+ * The keys in this object are component IDs.
3906
+ * Overrides are applied from the top down, so for example if both the composition
3907
+ * and a pattern on the composition define an override on a nested pattern,
3908
+ * the composition's override replaces the pattern's.
3909
+ *
3910
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3911
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3912
+ */
3913
+ _overrides?: {
3914
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3915
+ };
3916
+ /**
3917
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
3918
+ * by consumers of the pattern.
3919
+ *
3920
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3921
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3922
+ */
3923
+ _overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3924
+ };
3925
+ /** @description Defines the shape of the root component in a composition */
3926
+ RootComponentInstance: {
3927
+ /** @description Type of the component instance (public_id of its definition) */
3928
+ type: string;
3929
+ /** @description Component parameter values for the component instance */
3930
+ parameters?: {
3931
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
3932
+ };
3933
+ /** @description Public ID of alternate visual appearance for this component, if any selected */
3934
+ variant?: string;
3935
+ /** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
3936
+ projectMapNodes?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
3937
+ /** @description Slots containing any child components */
3938
+ slots?: {
3939
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
3940
+ };
3941
+ /** @description The public UUID of the composition. */
3942
+ _id: string;
3943
+ /** @description Slug pattern of this component. */
3944
+ _slug?: string | null;
3945
+ /** @description Friendly name of this component. */
3946
+ _name: string;
3947
+ _dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
3948
+ /**
3949
+ * @description Defines patch overrides to component IDs that live in the composition.
3950
+ * This can be used to override parameters that are defined on patterns,
3951
+ * including nested patterns, with values that are specific to this composition.
3952
+ * The keys in this object are component IDs.
3953
+ * Overrides are applied from the top down, so for example if both the composition
3954
+ * and a pattern on the composition define an override on a nested pattern,
3955
+ * the composition's override replaces the pattern's.
3956
+ *
3957
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3958
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3959
+ */
3960
+ _overrides?: {
3961
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
3962
+ };
3963
+ /**
3964
+ * @description When used on a pattern, defines how the pattern's parameters may be overridden
3965
+ * by consumers of the pattern.
3966
+ *
3967
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3968
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3969
+ */
3970
+ _overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
3971
+ };
3972
+ /**
3973
+ * @description Defines how to override a specific component.
3974
+ *
3975
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3976
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3977
+ */
3978
+ ComponentOverride: {
3979
+ parameters?: {
3980
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
3981
+ };
3982
+ variant?: string;
3983
+ };
3984
+ /**
3985
+ * @description Defines how a component on a pattern may have its values overridden.
3986
+ * NOTE: Data resources' overridability is defined in the data resource definition, not here.
3987
+ *
3988
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3989
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
3990
+ */
3991
+ ComponentOverridability: {
3992
+ /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
3993
+ parameters?: {
3994
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
3995
+ };
3996
+ /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
3997
+ variants?: boolean;
3998
+ };
3999
+ /**
4000
+ * @description Whether a parameter is overridable
4001
+ *
4002
+ * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4003
+ * Future updates that do not break the overrides-applied state of a composition may be made without notice.
4004
+ *
4005
+ * @enum {string}
4006
+ */
4007
+ OverrideOptions: "yes" | "no";
4008
+ /**
4009
+ * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
4010
+ * These are created in the UI and shared across a whole project.
4011
+ * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
4012
+ * for all header, parameter, and variable values to obscure the actual encrypted secret value.
4013
+ */
4014
+ DataSource: {
4015
+ /** @description Public ID of the data source */
4016
+ id: string;
4017
+ /** @description Display name of the data source */
4018
+ displayName: string;
4019
+ /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
4020
+ connectorType: string;
4021
+ /** @description Base resource URL of the data source. No trailing slash. */
4022
+ baseUrl: string;
4023
+ /** @description HTTP headers to pass with requests to the data source */
4024
+ headers?: {
4025
+ key: string;
4026
+ value: string;
4027
+ }[];
4028
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
4029
+ parameters?: {
4030
+ key: string;
4031
+ value: string;
4032
+ }[];
4033
+ /** @description Variables needed to make calls to the data source */
4034
+ variables?: {
4035
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
4036
+ };
4037
+ /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
4038
+ custom?: {
4039
+ [key: string]: unknown;
4040
+ };
4041
+ };
4042
+ /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
4043
+ DataType: {
4044
+ /** @description Public ID of the data type */
4045
+ id: string;
4046
+ /** @description Display name of the data type */
4047
+ displayName: string;
4048
+ /** @description Public ID of the associated data source */
4049
+ dataSourceId: string;
4050
+ /**
4051
+ * @description A connector-specific archetype for this data type; used to select UI as well as perform any
4052
+ * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
4053
+ * no special UI or processing is required.
4054
+ */
4055
+ archetype?: string;
4056
+ allowedOnComponents?: string[];
4057
+ /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
4058
+ path: string;
4059
+ /** @description Time-to-live (in seconds) for the resource data cache. */
4060
+ ttl?: number;
4061
+ /** @description A key for the resource data cache purging. */
4062
+ purgeKey?: string;
4063
+ /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
4064
+ badgeIconUrl?: string;
4065
+ /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
4066
+ headers?: {
4067
+ key: string;
4068
+ value: string;
4069
+ omitIfEmpty?: boolean;
4070
+ }[];
4071
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
4072
+ parameters?: {
4073
+ key: string;
4074
+ value: string;
4075
+ omitIfEmpty?: boolean;
4076
+ }[];
4077
+ /** @description Body to pass with requests to the data type (ignored unless method is POST) */
4078
+ body?: string;
4079
+ /**
4080
+ * @description HTTP method to use with requests to the data type.
4081
+ * @default GET
4082
+ * @enum {string}
4083
+ */
4084
+ method: "GET" | "POST" | "HEAD";
4085
+ /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
4086
+ variables?: {
4087
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
4088
+ };
4089
+ /** @description Custom configuration specific to the data source being defined */
4090
+ custom?: {
4091
+ [key: string]: unknown;
4092
+ };
4093
+ };
4094
+ /** @description Defines the shape of a data variable on a Data Source or Data Type */
4095
+ DataVariableDefinition: {
4096
+ /** @description Display name of the data variable */
4097
+ displayName?: string;
4098
+ /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
4099
+ helpText?: string;
4100
+ /**
4101
+ * @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
4102
+ * @default text
4103
+ */
4104
+ type?: string;
4105
+ /** @description Default value of the data variable */
4106
+ default: string;
4107
+ /** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
4108
+ order?: number;
4109
+ /**
4110
+ * @description An optional arbitrary human readable source identifier to describe where this variable is from.
4111
+ * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
4112
+ */
4113
+ source?: string;
4114
+ };
4115
+ /**
4116
+ * @description Data definitions attached to this component. The property name is the key of the data in the data document.
4117
+ * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
4118
+ */
4119
+ DataResourceDefinitions: {
4120
+ [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
4121
+ };
4122
+ /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
4123
+ DataResourceDefinition: {
4124
+ /** @description Public ID of the data type that provides this data */
4125
+ type: string;
4126
+ /** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
4127
+ isPatternParameter?: boolean;
4128
+ /**
4129
+ * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
4130
+ * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
4131
+ * If isPatternParameter is false or undefined, this has no meaning.
4132
+ */
4133
+ ignorePatternParameterDefault?: boolean;
4134
+ variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
4135
+ };
4136
+ /** @description Variable values for a data resource. */
4137
+ DataResourceVariables: {
4138
+ [key: string]: string;
4139
+ };
4140
+ /** @description Category for tagging canvas entities */
4141
+ Category: {
4142
+ /**
4143
+ * Format: uuid
4144
+ * @description Unique identifier for the category
4145
+ */
4146
+ id: string;
4147
+ /** @description Display name of the category */
4148
+ name: string;
4149
+ /**
4150
+ * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
4151
+ * @default 0
4152
+ */
4153
+ order?: number;
4154
+ };
4155
+ /** @description Project map node information related to a component. */
4156
+ CompositionProjectMapNodeInfo: {
4157
+ /**
4158
+ * Format: uuid
4159
+ * @description Unique identifier for the project map node
4160
+ */
4161
+ id: string;
4162
+ /** @description Path of the project map node */
4163
+ path: string;
4164
+ /**
4165
+ * Format: uuid
4166
+ * @description Unique identifier for the project map that this node belongs to.
4167
+ */
4168
+ projectMapId: string;
4169
+ };
4170
+ /** @description AI Prompt definition. */
4171
+ Prompt: {
4172
+ /**
4173
+ * Format: uuid
4174
+ * @description Unique identifier for the prompt
4175
+ */
4176
+ id: string;
4177
+ /** @description Unique identifier for the integration that this prompt belongs to. */
4178
+ integrationType: string;
4179
+ /** @description Name for the prompt */
4180
+ promptName?: string | null;
4181
+ /** @description Text for the prompt */
4182
+ promptText?: string | null;
4183
+ /** @description Data for the prompt */
4184
+ promptData?: string | null;
4185
+ /** @description Turn off/on prompt */
4186
+ enabled?: boolean | null;
4187
+ /** @description Integration default prompt */
4188
+ builtIn?: boolean | null;
4189
+ };
4190
+ };
4191
+ };
4192
+ operations: {};
4193
+ };
4194
+ }
4195
+
4196
+ /**
4197
+ * This file was auto-generated by openapi-typescript.
4198
+ * Do not make direct changes to the file.
4199
+ */
4200
+ interface paths$8 {
4201
+ "/api/v1/data-sources": {
4202
+ get: {
4203
+ parameters: {
4204
+ query: {
4205
+ projectId: string;
4206
+ };
4207
+ };
4208
+ responses: {
4209
+ /**
4210
+ * Gets a list of data sources.
4211
+ * Note that all parameters, headers, and variables will have the value 'SECRET', as this endpoint
4212
+ * requires minimal permissions. To decrypt secrets, you must be an admin or manage-data-sources privileged
4213
+ * user, and fetch using the `data-source` endpoint for each data source.
4214
+ */
4215
+ 200: {
4216
+ content: {
4217
+ "application/json": {
4218
+ results: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"][];
4219
+ };
4220
+ };
4221
+ };
4222
+ 400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
4223
+ 401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
4224
+ 403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
4225
+ 429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
4226
+ 500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
4227
+ };
4228
+ };
2886
4229
  };
2887
4230
  }
2888
4231
  interface external$9 {
@@ -3333,15 +4676,8 @@ interface external$9 {
3333
4676
  allowedOnComponents?: string[];
3334
4677
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
3335
4678
  path: string;
3336
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
4679
+ /** @description Time-to-live (in seconds) for the resource data cache. */
3337
4680
  ttl?: number;
3338
- /** @description Long term data resource cache configuration. */
3339
- longTermCache?: {
3340
- /** @description A flag to turn the long term cache on. */
3341
- enabled: boolean;
3342
- /** @description Time-to-live (in hours) for the long term resource data cache. */
3343
- ttlInHours?: number;
3344
- };
3345
4681
  /** @description A key for the resource data cache purging. */
3346
4682
  purgeKey?: string;
3347
4683
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -3451,35 +4787,41 @@ interface external$9 {
3451
4787
  */
3452
4788
  projectMapId: string;
3453
4789
  };
4790
+ /** @description AI Prompt definition. */
4791
+ Prompt: {
4792
+ /**
4793
+ * Format: uuid
4794
+ * @description Unique identifier for the prompt
4795
+ */
4796
+ id: string;
4797
+ /** @description Unique identifier for the integration that this prompt belongs to. */
4798
+ integrationType: string;
4799
+ /** @description Name for the prompt */
4800
+ promptName?: string | null;
4801
+ /** @description Text for the prompt */
4802
+ promptText?: string | null;
4803
+ /** @description Data for the prompt */
4804
+ promptData?: string | null;
4805
+ /** @description Turn off/on prompt */
4806
+ enabled?: boolean | null;
4807
+ /** @description Integration default prompt */
4808
+ builtIn?: boolean | null;
4809
+ };
3454
4810
  };
3455
4811
  };
3456
4812
  operations: {};
3457
4813
  };
3458
4814
  }
3459
4815
 
3460
- type ContentType = components$5['schemas']['ContentType'];
3461
- type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
3462
- type GetContentTypesOptions = paths$9['/api/v1/content-types']['get']['parameters']['query'];
3463
- type DeleteContentTypeOptions = paths$9['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
3464
- type PutContentTypeBody = paths$9['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
3465
- type GetContentTypesResponse = paths$9['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
3466
- type Entry = components$4['schemas']['EntryApiResponse'];
3467
- type EntryData = Entry['entry'];
3468
- type GetEntriesOptions = paths$8['/api/v1/entries']['get']['parameters']['query'];
3469
- type GetEntriesResponse = paths$8['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
3470
- type DeleteEntryOptions = paths$8['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
3471
- type PutEntryBody = paths$8['/api/v1/entries']['put']['requestBody']['content']['application/json'];
3472
-
3473
4816
  /**
3474
4817
  * This file was auto-generated by openapi-typescript.
3475
4818
  * Do not make direct changes to the file.
3476
4819
  */
3477
4820
  interface paths$7 {
3478
- "/api/v1/data-source": {
4821
+ "/api/v1/data-types": {
3479
4822
  get: {
3480
4823
  parameters: {
3481
4824
  query: {
3482
- dataSourceId: string;
3483
4825
  projectId: string;
3484
4826
  };
3485
4827
  };
@@ -3488,7 +4830,7 @@ interface paths$7 {
3488
4830
  200: {
3489
4831
  content: {
3490
4832
  "application/json": {
3491
- result: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
4833
+ results: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
3492
4834
  };
3493
4835
  };
3494
4836
  };
@@ -3512,17 +4854,9 @@ interface paths$7 {
3512
4854
  requestBody: {
3513
4855
  content: {
3514
4856
  "application/json": {
3515
- data: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
4857
+ data: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
3516
4858
  /** Format: uuid */
3517
4859
  projectId: string;
3518
- /**
3519
- * Format: uuid
3520
- * @deprecated
3521
- * @description Do not use. May be removed in future.
3522
- */
3523
- integrationId?: string;
3524
- /** @description The integration type that the data source is attached to. Must be installed in the project. */
3525
- integrationType?: string;
3526
4860
  };
3527
4861
  };
3528
4862
  };
@@ -3540,7 +4874,7 @@ interface paths$7 {
3540
4874
  requestBody: {
3541
4875
  content: {
3542
4876
  "application/json": {
3543
- dataSourceId: string;
4877
+ typeId: string;
3544
4878
  /** Format: uuid */
3545
4879
  projectId: string;
3546
4880
  };
@@ -3997,15 +5331,8 @@ interface external$8 {
3997
5331
  allowedOnComponents?: string[];
3998
5332
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
3999
5333
  path: string;
4000
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
5334
+ /** @description Time-to-live (in seconds) for the resource data cache. */
4001
5335
  ttl?: number;
4002
- /** @description Long term data resource cache configuration. */
4003
- longTermCache?: {
4004
- /** @description A flag to turn the long term cache on. */
4005
- enabled: boolean;
4006
- /** @description Time-to-live (in hours) for the long term resource data cache. */
4007
- ttlInHours?: number;
4008
- };
4009
5336
  /** @description A key for the resource data cache purging. */
4010
5337
  purgeKey?: string;
4011
5338
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -4115,6 +5442,26 @@ interface external$8 {
4115
5442
  */
4116
5443
  projectMapId: string;
4117
5444
  };
5445
+ /** @description AI Prompt definition. */
5446
+ Prompt: {
5447
+ /**
5448
+ * Format: uuid
5449
+ * @description Unique identifier for the prompt
5450
+ */
5451
+ id: string;
5452
+ /** @description Unique identifier for the integration that this prompt belongs to. */
5453
+ integrationType: string;
5454
+ /** @description Name for the prompt */
5455
+ promptName?: string | null;
5456
+ /** @description Text for the prompt */
5457
+ promptText?: string | null;
5458
+ /** @description Data for the prompt */
5459
+ promptData?: string | null;
5460
+ /** @description Turn off/on prompt */
5461
+ enabled?: boolean | null;
5462
+ /** @description Integration default prompt */
5463
+ builtIn?: boolean | null;
5464
+ };
4118
5465
  };
4119
5466
  };
4120
5467
  operations: {};
@@ -4126,24 +5473,20 @@ interface external$8 {
4126
5473
  * Do not make direct changes to the file.
4127
5474
  */
4128
5475
  interface paths$6 {
4129
- "/api/v1/data-sources": {
5476
+ "/api/v1/prompt": {
4130
5477
  get: {
4131
5478
  parameters: {
4132
5479
  query: {
5480
+ promptId: string;
4133
5481
  projectId: string;
4134
5482
  };
4135
5483
  };
4136
5484
  responses: {
4137
- /**
4138
- * Gets a list of data sources.
4139
- * Note that all parameters, headers, and variables will have the value 'SECRET', as this endpoint
4140
- * requires minimal permissions. To decrypt secrets, you must be an admin or manage-data-sources privileged
4141
- * user, and fetch using the `data-source` endpoint for each data source.
4142
- */
5485
+ /** OK */
4143
5486
  200: {
4144
5487
  content: {
4145
5488
  "application/json": {
4146
- results: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"][];
5489
+ result: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"];
4147
5490
  };
4148
5491
  };
4149
5492
  };
@@ -4154,6 +5497,47 @@ interface paths$6 {
4154
5497
  500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
4155
5498
  };
4156
5499
  };
5500
+ put: {
5501
+ responses: {
5502
+ /** OK */
5503
+ 204: never;
5504
+ 400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
5505
+ 401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
5506
+ 403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
5507
+ 429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
5508
+ 500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
5509
+ };
5510
+ requestBody: {
5511
+ content: {
5512
+ "application/json": {
5513
+ data: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"];
5514
+ /** Format: uuid */
5515
+ projectId: string;
5516
+ };
5517
+ };
5518
+ };
5519
+ };
5520
+ delete: {
5521
+ responses: {
5522
+ /** OK */
5523
+ 204: never;
5524
+ 400: external$7["swagger.yml"]["components"]["responses"]["BadRequestError"];
5525
+ 401: external$7["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
5526
+ 403: external$7["swagger.yml"]["components"]["responses"]["ForbiddenError"];
5527
+ 429: external$7["swagger.yml"]["components"]["responses"]["RateLimitError"];
5528
+ 500: external$7["swagger.yml"]["components"]["responses"]["InternalServerError"];
5529
+ };
5530
+ requestBody: {
5531
+ content: {
5532
+ "application/json": {
5533
+ /** Format: uuid */
5534
+ projectId: string;
5535
+ /** Format: uuid */
5536
+ promptId: string;
5537
+ };
5538
+ };
5539
+ };
5540
+ };
4157
5541
  };
4158
5542
  }
4159
5543
  interface external$7 {
@@ -4604,15 +5988,8 @@ interface external$7 {
4604
5988
  allowedOnComponents?: string[];
4605
5989
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
4606
5990
  path: string;
4607
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
5991
+ /** @description Time-to-live (in seconds) for the resource data cache. */
4608
5992
  ttl?: number;
4609
- /** @description Long term data resource cache configuration. */
4610
- longTermCache?: {
4611
- /** @description A flag to turn the long term cache on. */
4612
- enabled: boolean;
4613
- /** @description Time-to-live (in hours) for the long term resource data cache. */
4614
- ttlInHours?: number;
4615
- };
4616
5993
  /** @description A key for the resource data cache purging. */
4617
5994
  purgeKey?: string;
4618
5995
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -4722,6 +6099,26 @@ interface external$7 {
4722
6099
  */
4723
6100
  projectMapId: string;
4724
6101
  };
6102
+ /** @description AI Prompt definition. */
6103
+ Prompt: {
6104
+ /**
6105
+ * Format: uuid
6106
+ * @description Unique identifier for the prompt
6107
+ */
6108
+ id: string;
6109
+ /** @description Unique identifier for the integration that this prompt belongs to. */
6110
+ integrationType: string;
6111
+ /** @description Name for the prompt */
6112
+ promptName?: string | null;
6113
+ /** @description Text for the prompt */
6114
+ promptText?: string | null;
6115
+ /** @description Data for the prompt */
6116
+ promptData?: string | null;
6117
+ /** @description Turn off/on prompt */
6118
+ enabled?: boolean | null;
6119
+ /** @description Integration default prompt */
6120
+ builtIn?: boolean | null;
6121
+ };
4725
6122
  };
4726
6123
  };
4727
6124
  operations: {};
@@ -4733,7 +6130,7 @@ interface external$7 {
4733
6130
  * Do not make direct changes to the file.
4734
6131
  */
4735
6132
  interface paths$5 {
4736
- "/api/v1/data-types": {
6133
+ "/api/v1/prompts": {
4737
6134
  get: {
4738
6135
  parameters: {
4739
6136
  query: {
@@ -4741,11 +6138,11 @@ interface paths$5 {
4741
6138
  };
4742
6139
  };
4743
6140
  responses: {
4744
- /** OK */
6141
+ /** Gets a list of prompts. */
4745
6142
  200: {
4746
6143
  content: {
4747
6144
  "application/json": {
4748
- results: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
6145
+ results: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"][];
4749
6146
  };
4750
6147
  };
4751
6148
  };
@@ -4756,46 +6153,6 @@ interface paths$5 {
4756
6153
  500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
4757
6154
  };
4758
6155
  };
4759
- put: {
4760
- responses: {
4761
- /** OK */
4762
- 204: never;
4763
- 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
4764
- 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
4765
- 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
4766
- 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
4767
- 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
4768
- };
4769
- requestBody: {
4770
- content: {
4771
- "application/json": {
4772
- data: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
4773
- /** Format: uuid */
4774
- projectId: string;
4775
- };
4776
- };
4777
- };
4778
- };
4779
- delete: {
4780
- responses: {
4781
- /** OK */
4782
- 204: never;
4783
- 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
4784
- 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
4785
- 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
4786
- 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
4787
- 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
4788
- };
4789
- requestBody: {
4790
- content: {
4791
- "application/json": {
4792
- typeId: string;
4793
- /** Format: uuid */
4794
- projectId: string;
4795
- };
4796
- };
4797
- };
4798
- };
4799
6156
  };
4800
6157
  }
4801
6158
  interface external$6 {
@@ -5246,15 +6603,8 @@ interface external$6 {
5246
6603
  allowedOnComponents?: string[];
5247
6604
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
5248
6605
  path: string;
5249
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
6606
+ /** @description Time-to-live (in seconds) for the resource data cache. */
5250
6607
  ttl?: number;
5251
- /** @description Long term data resource cache configuration. */
5252
- longTermCache?: {
5253
- /** @description A flag to turn the long term cache on. */
5254
- enabled: boolean;
5255
- /** @description Time-to-live (in hours) for the long term resource data cache. */
5256
- ttlInHours?: number;
5257
- };
5258
6608
  /** @description A key for the resource data cache purging. */
5259
6609
  purgeKey?: string;
5260
6610
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -5364,15 +6714,37 @@ interface external$6 {
5364
6714
  */
5365
6715
  projectMapId: string;
5366
6716
  };
6717
+ /** @description AI Prompt definition. */
6718
+ Prompt: {
6719
+ /**
6720
+ * Format: uuid
6721
+ * @description Unique identifier for the prompt
6722
+ */
6723
+ id: string;
6724
+ /** @description Unique identifier for the integration that this prompt belongs to. */
6725
+ integrationType: string;
6726
+ /** @description Name for the prompt */
6727
+ promptName?: string | null;
6728
+ /** @description Text for the prompt */
6729
+ promptText?: string | null;
6730
+ /** @description Data for the prompt */
6731
+ promptData?: string | null;
6732
+ /** @description Turn off/on prompt */
6733
+ enabled?: boolean | null;
6734
+ /** @description Integration default prompt */
6735
+ builtIn?: boolean | null;
6736
+ };
5367
6737
  };
5368
6738
  };
5369
6739
  operations: {};
5370
6740
  };
5371
6741
  }
5372
6742
 
5373
- type DataTypeApi = paths$5['/api/v1/data-types'];
5374
- type DataSourcesApi = paths$6['/api/v1/data-sources'];
5375
- type DataSourceApi = paths$7['/api/v1/data-source'];
6743
+ type PromptApi = paths$6['/api/v1/prompt'];
6744
+ type PromptsApi = paths$5['/api/v1/prompts'];
6745
+ type DataTypeApi = paths$7['/api/v1/data-types'];
6746
+ type DataSourcesApi = paths$8['/api/v1/data-sources'];
6747
+ type DataSourceApi = paths$9['/api/v1/data-source'];
5376
6748
  /** Query parameter options for GET /api/v1/data-types */
5377
6749
  type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
5378
6750
  /** The GET response from /api/v1/data-types */
@@ -5393,9 +6765,22 @@ type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content
5393
6765
  type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
5394
6766
  /** Shape of the DELETE request body for /api/v1/data-source */
5395
6767
  type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
6768
+ /** Query parameter options for GET /api/v1/prompt */
6769
+ type PromptGetParameters = PromptApi['get']['parameters']['query'];
6770
+ /** The GET response from /api/v1/prompt */
6771
+ type PromptGetResponse = PromptApi['get']['responses']['200']['content']['application/json'];
6772
+ /** The PUT request body for /api/v1/prompt */
6773
+ type PromptPutParameters = PromptApi['put']['requestBody']['content']['application/json'];
6774
+ /** Shape of the DELETE request body for /api/v1/prompt */
6775
+ type PromptDeleteParameters = PromptApi['delete']['requestBody']['content']['application/json'];
6776
+ /** Query parameter options for GET /api/v1/prompts */
6777
+ type PromptsGetParameters = PromptsApi['get']['parameters']['query'];
6778
+ /** The GET response from /api/v1/prompts */
6779
+ type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['application/json'];
5396
6780
  type DataType = components$5['schemas']['DataType'];
5397
6781
  type DataSource = components$5['schemas']['DataSource'];
5398
6782
  type DataVariableDefinition = components$5['schemas']['DataVariableDefinition'];
6783
+ type Prompt = components$5['schemas']['Prompt'];
5399
6784
 
5400
6785
  /**
5401
6786
  * This file was auto-generated by openapi-typescript.
@@ -6317,15 +7702,8 @@ interface external$5 {
6317
7702
  allowedOnComponents?: string[];
6318
7703
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
6319
7704
  path: string;
6320
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
7705
+ /** @description Time-to-live (in seconds) for the resource data cache. */
6321
7706
  ttl?: number;
6322
- /** @description Long term data resource cache configuration. */
6323
- longTermCache?: {
6324
- /** @description A flag to turn the long term cache on. */
6325
- enabled: boolean;
6326
- /** @description Time-to-live (in hours) for the long term resource data cache. */
6327
- ttlInHours?: number;
6328
- };
6329
7707
  /** @description A key for the resource data cache purging. */
6330
7708
  purgeKey?: string;
6331
7709
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -6435,6 +7813,26 @@ interface external$5 {
6435
7813
  */
6436
7814
  projectMapId: string;
6437
7815
  };
7816
+ /** @description AI Prompt definition. */
7817
+ Prompt: {
7818
+ /**
7819
+ * Format: uuid
7820
+ * @description Unique identifier for the prompt
7821
+ */
7822
+ id: string;
7823
+ /** @description Unique identifier for the integration that this prompt belongs to. */
7824
+ integrationType: string;
7825
+ /** @description Name for the prompt */
7826
+ promptName?: string | null;
7827
+ /** @description Text for the prompt */
7828
+ promptText?: string | null;
7829
+ /** @description Data for the prompt */
7830
+ promptData?: string | null;
7831
+ /** @description Turn off/on prompt */
7832
+ enabled?: boolean | null;
7833
+ /** @description Integration default prompt */
7834
+ builtIn?: boolean | null;
7835
+ };
6438
7836
  };
6439
7837
  };
6440
7838
  operations: {};
@@ -7165,15 +8563,8 @@ interface external$3 {
7165
8563
  allowedOnComponents?: string[];
7166
8564
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
7167
8565
  path: string;
7168
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
8566
+ /** @description Time-to-live (in seconds) for the resource data cache. */
7169
8567
  ttl?: number;
7170
- /** @description Long term data resource cache configuration. */
7171
- longTermCache?: {
7172
- /** @description A flag to turn the long term cache on. */
7173
- enabled: boolean;
7174
- /** @description Time-to-live (in hours) for the long term resource data cache. */
7175
- ttlInHours?: number;
7176
- };
7177
8568
  /** @description A key for the resource data cache purging. */
7178
8569
  purgeKey?: string;
7179
8570
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -7283,6 +8674,26 @@ interface external$3 {
7283
8674
  */
7284
8675
  projectMapId: string;
7285
8676
  };
8677
+ /** @description AI Prompt definition. */
8678
+ Prompt: {
8679
+ /**
8680
+ * Format: uuid
8681
+ * @description Unique identifier for the prompt
8682
+ */
8683
+ id: string;
8684
+ /** @description Unique identifier for the integration that this prompt belongs to. */
8685
+ integrationType: string;
8686
+ /** @description Name for the prompt */
8687
+ promptName?: string | null;
8688
+ /** @description Text for the prompt */
8689
+ promptText?: string | null;
8690
+ /** @description Data for the prompt */
8691
+ promptData?: string | null;
8692
+ /** @description Turn off/on prompt */
8693
+ enabled?: boolean | null;
8694
+ /** @description Integration default prompt */
8695
+ builtIn?: boolean | null;
8696
+ };
7286
8697
  };
7287
8698
  };
7288
8699
  operations: {};
@@ -8955,15 +10366,8 @@ interface external$2 {
8955
10366
  allowedOnComponents?: string[];
8956
10367
  /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
8957
10368
  path: string;
8958
- /** @description Time-to-live (in seconds) for the primary resource data cache. */
10369
+ /** @description Time-to-live (in seconds) for the resource data cache. */
8959
10370
  ttl?: number;
8960
- /** @description Long term data resource cache configuration. */
8961
- longTermCache?: {
8962
- /** @description A flag to turn the long term cache on. */
8963
- enabled: boolean;
8964
- /** @description Time-to-live (in hours) for the long term resource data cache. */
8965
- ttlInHours?: number;
8966
- };
8967
10371
  /** @description A key for the resource data cache purging. */
8968
10372
  purgeKey?: string;
8969
10373
  /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
@@ -9073,6 +10477,26 @@ interface external$2 {
9073
10477
  */
9074
10478
  projectMapId: string;
9075
10479
  };
10480
+ /** @description AI Prompt definition. */
10481
+ Prompt: {
10482
+ /**
10483
+ * Format: uuid
10484
+ * @description Unique identifier for the prompt
10485
+ */
10486
+ id: string;
10487
+ /** @description Unique identifier for the integration that this prompt belongs to. */
10488
+ integrationType: string;
10489
+ /** @description Name for the prompt */
10490
+ promptName?: string | null;
10491
+ /** @description Text for the prompt */
10492
+ promptText?: string | null;
10493
+ /** @description Data for the prompt */
10494
+ promptData?: string | null;
10495
+ /** @description Turn off/on prompt */
10496
+ enabled?: boolean | null;
10497
+ /** @description Integration default prompt */
10498
+ builtIn?: boolean | null;
10499
+ };
9076
10500
  };
9077
10501
  };
9078
10502
  operations: {};
@@ -9841,6 +11265,7 @@ type CanvasDefinitions = {
9841
11265
  categories?: Array<Category>;
9842
11266
  contentTypes?: Array<ContentType>;
9843
11267
  entries?: Array<Entry>;
11268
+ prompts?: Array<Prompt>;
9844
11269
  };
9845
11270
  /** Defines shared parameters for requests getting a single composition */
9846
11271
  type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
@@ -9928,7 +11353,7 @@ type RouteGetResponseRedirect = components['schemas']['RouteResponseRedirect'];
9928
11353
  type RouteGetResponseNotFound = components['schemas']['RouteResponseNotFound'];
9929
11354
  type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
9930
11355
  /** The GET response from /api/v1/entries */
9931
- type EntriesGetParameters = paths$8['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
11356
+ type EntriesGetParameters = paths$a['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
9932
11357
  type EntriesGetResponse = components$4['schemas']['EntryListResponse'];
9933
11358
  type EntriesResolvedListResponse = components$1['schemas']['EntryResolvedListResponse'];
9934
11359
  /** GET response from uniform.global/api/v1/route when result is a composition */
@@ -11206,6 +12631,39 @@ type UnsubscribeCallback = () => void;
11206
12631
  /** Subscribes to a composition event */
11207
12632
  declare function subscribeToComposition({ projectId, compositionId, compositionState, eventBus: { subscribe }, callback, event, }: SubscribeToCompositionOptions): UnsubscribeCallback;
11208
12633
 
12634
+ /** API client to make comms with the Next Gen Mesh Data Source API simpler */
12635
+ declare class PromptClient extends ApiClient {
12636
+ constructor(options: ClientOptions);
12637
+ /** Fetches all Prompts for a project */
12638
+ get(options?: ExceptProject<PromptGetParameters>): Promise<{
12639
+ result: {
12640
+ id: string;
12641
+ integrationType: string;
12642
+ promptName?: string | null | undefined;
12643
+ promptText?: string | null | undefined;
12644
+ promptData?: string | null | undefined;
12645
+ enabled?: boolean | null | undefined;
12646
+ builtIn?: boolean | null | undefined;
12647
+ };
12648
+ }>;
12649
+ /** Fetches all Prompts for a project */
12650
+ getList(options?: ExceptProject<PromptsGetParameters>): Promise<{
12651
+ results: {
12652
+ id: string;
12653
+ integrationType: string;
12654
+ promptName?: string | null | undefined;
12655
+ promptText?: string | null | undefined;
12656
+ promptData?: string | null | undefined;
12657
+ enabled?: boolean | null | undefined;
12658
+ builtIn?: boolean | null | undefined;
12659
+ }[];
12660
+ }>;
12661
+ /** Updates or creates (based on id) a Prompt */
12662
+ upsert(body: ExceptProject<PromptPutParameters>): Promise<void>;
12663
+ /** Deletes a Prompt */
12664
+ remove(body: ExceptProject<PromptDeleteParameters>): Promise<void>;
12665
+ }
12666
+
11209
12667
  type RouteClientOptions = Omit<ClientOptions, 'apiHost'> & {
11210
12668
  edgeApiHost?: string;
11211
12669
  };
@@ -11479,4 +12937,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
11479
12937
 
11480
12938
  declare const CanvasClientError: typeof ApiClientError;
11481
12939
 
11482
- export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, BlockLocationReference, BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentLocationReferenceV2, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterBlock, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesResolvedListResponse, Entry, EntryData, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NodeLocationReference, NonProjectMapLinkParamValue, OpenParameterEditorMessage, OverrideOptions, PLACEHOLDER_ID, PatternIssue, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RootLocationReference, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TreeNodeInfoTypes, TriggerComponentActionMessage, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateComponentReferencesMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdateFeatureFlagsMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, WalkNodeTreeActions, WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, getPropertiesValue, isAddComponentMessage, isAllowedReferrer, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };
12940
+ export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, BlockLocationReference, BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentLocationReferenceV2, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterBlock, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesResolvedListResponse, Entry, EntryData, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NodeLocationReference, NonProjectMapLinkParamValue, OpenParameterEditorMessage, OverrideOptions, PLACEHOLDER_ID, PatternIssue, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, Prompt, PromptClient, PromptDeleteParameters, PromptGetParameters, PromptGetResponse, PromptPutParameters, PromptsGetParameters, PromptsGetResponse, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RootLocationReference, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TreeNodeInfoTypes, TriggerComponentActionMessage, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateComponentReferencesMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdateFeatureFlagsMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, WalkNodeTreeActions, WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, getPropertiesValue, isAddComponentMessage, isAllowedReferrer, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree, walkNodeTree };