@uniformdev/canvas 19.55.2-alpha.57 → 19.55.2-alpha.60
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.mts +467 -1055
- package/dist/index.d.ts +467 -1055
- package/dist/index.esm.js +3 -10
- package/dist/index.js +3 -10
- package/dist/index.mjs +3 -10
- package/package.json +4 -4
package/dist/index.d.ts
CHANGED
@@ -553,15 +553,19 @@ interface components$4 {
|
|
553
553
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
554
554
|
integrationType: string;
|
555
555
|
/** @description Name for the prompt */
|
556
|
-
|
556
|
+
name?: string | null;
|
557
557
|
/** @description Text for the prompt */
|
558
|
-
|
558
|
+
text?: string | null;
|
559
559
|
/** @description Data for the prompt */
|
560
|
-
|
560
|
+
data?: {
|
561
|
+
[key: string]: unknown;
|
562
|
+
} | null;
|
561
563
|
/** @description Turn off/on prompt */
|
562
564
|
enabled?: boolean | null;
|
563
565
|
/** @description Integration default prompt */
|
564
566
|
builtIn?: boolean | null;
|
567
|
+
/** @description Supported parameter types */
|
568
|
+
parameterTypes?: string[] | null;
|
565
569
|
};
|
566
570
|
};
|
567
571
|
}
|
@@ -570,7 +574,7 @@ interface components$4 {
|
|
570
574
|
* This file was auto-generated by openapi-typescript.
|
571
575
|
* Do not make direct changes to the file.
|
572
576
|
*/
|
573
|
-
interface paths$
|
577
|
+
interface paths$d {
|
574
578
|
"/api/v1/canvas-definitions": {
|
575
579
|
get: {
|
576
580
|
parameters: {
|
@@ -595,15 +599,15 @@ interface paths$e {
|
|
595
599
|
content: {
|
596
600
|
"application/json": {
|
597
601
|
/** @description Component definitions that match the query */
|
598
|
-
componentDefinitions: external$
|
602
|
+
componentDefinitions: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
|
599
603
|
};
|
600
604
|
};
|
601
605
|
};
|
602
|
-
400: external$
|
603
|
-
401: external$
|
604
|
-
403: external$
|
605
|
-
429: external$
|
606
|
-
500: external$
|
606
|
+
400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
607
|
+
401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
608
|
+
403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
609
|
+
429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
610
|
+
500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
607
611
|
};
|
608
612
|
};
|
609
613
|
/** Upserts a component definition */
|
@@ -611,11 +615,11 @@ interface paths$e {
|
|
611
615
|
responses: {
|
612
616
|
/** OK */
|
613
617
|
204: never;
|
614
|
-
400: external$
|
615
|
-
401: external$
|
616
|
-
403: external$
|
617
|
-
429: external$
|
618
|
-
500: external$
|
618
|
+
400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
619
|
+
401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
620
|
+
403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
621
|
+
429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
622
|
+
500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
619
623
|
};
|
620
624
|
requestBody: {
|
621
625
|
content: {
|
@@ -625,7 +629,7 @@ interface paths$e {
|
|
625
629
|
* @description The project ID to upsert the component definition to
|
626
630
|
*/
|
627
631
|
projectId: string;
|
628
|
-
componentDefinition: external$
|
632
|
+
componentDefinition: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
|
629
633
|
};
|
630
634
|
};
|
631
635
|
};
|
@@ -635,11 +639,11 @@ interface paths$e {
|
|
635
639
|
responses: {
|
636
640
|
/** OK */
|
637
641
|
204: never;
|
638
|
-
400: external$
|
639
|
-
401: external$
|
640
|
-
403: external$
|
641
|
-
429: external$
|
642
|
-
500: external$
|
642
|
+
400: external$e["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
643
|
+
401: external$e["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
644
|
+
403: external$e["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
645
|
+
429: external$e["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
646
|
+
500: external$e["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
643
647
|
};
|
644
648
|
requestBody: {
|
645
649
|
content: {
|
@@ -664,7 +668,7 @@ interface paths$e {
|
|
664
668
|
};
|
665
669
|
};
|
666
670
|
}
|
667
|
-
interface external$
|
671
|
+
interface external$e {
|
668
672
|
"swagger.yml": {
|
669
673
|
paths: {};
|
670
674
|
components: {
|
@@ -678,25 +682,25 @@ interface external$f {
|
|
678
682
|
/** Request input validation failed */
|
679
683
|
BadRequestError: {
|
680
684
|
content: {
|
681
|
-
"application/json": external$
|
685
|
+
"application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
|
682
686
|
};
|
683
687
|
};
|
684
688
|
/** API key or token was not valid */
|
685
689
|
UnauthorizedError: {
|
686
690
|
content: {
|
687
|
-
"application/json": external$
|
691
|
+
"application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
|
688
692
|
};
|
689
693
|
};
|
690
694
|
/** Permission was denied */
|
691
695
|
ForbiddenError: {
|
692
696
|
content: {
|
693
|
-
"application/json": external$
|
697
|
+
"application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
|
694
698
|
};
|
695
699
|
};
|
696
700
|
/** Resource not found */
|
697
701
|
NotFoundError: {
|
698
702
|
content: {
|
699
|
-
"application/json": external$
|
703
|
+
"application/json": external$e["swagger.yml"]["components"]["schemas"]["Error"];
|
700
704
|
};
|
701
705
|
};
|
702
706
|
/** Too many requests in allowed time period */
|
@@ -715,7 +719,7 @@ interface external$f {
|
|
715
719
|
PublicIdProperty: string;
|
716
720
|
/** @description The definition of a component parameter */
|
717
721
|
ComponentDefinitionParameter: {
|
718
|
-
id: external$
|
722
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
719
723
|
/** @description Friendly name of the parameter */
|
720
724
|
name: string;
|
721
725
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -727,7 +731,7 @@ interface external$f {
|
|
727
731
|
};
|
728
732
|
/** @description The definition of a named component slot that can contain other components */
|
729
733
|
ComponentDefinitionSlot: {
|
730
|
-
id: external$
|
734
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
731
735
|
/** @description Friendly name of the slot */
|
732
736
|
name: string;
|
733
737
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -785,13 +789,13 @@ interface external$f {
|
|
785
789
|
};
|
786
790
|
/** @description The definition of a component variant */
|
787
791
|
ComponentDefinitionVariant: {
|
788
|
-
id: external$
|
792
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
789
793
|
/** @description Friendly name of the variant */
|
790
794
|
name: string;
|
791
795
|
};
|
792
796
|
/** @description Permission set for a component defintion */
|
793
797
|
ComponentDefinitionPermission: {
|
794
|
-
roleId: external$
|
798
|
+
roleId: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
795
799
|
/**
|
796
800
|
* @description Permission type for this permission ComponentDefinition:
|
797
801
|
* read | write | create | delete
|
@@ -804,7 +808,7 @@ interface external$f {
|
|
804
808
|
};
|
805
809
|
/** @description Defines a component type that can live on a Composition */
|
806
810
|
ComponentDefinition: {
|
807
|
-
id: external$
|
811
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
808
812
|
/** @description Friendly name of the component definition */
|
809
813
|
name: string;
|
810
814
|
/**
|
@@ -825,7 +829,7 @@ interface external$f {
|
|
825
829
|
*/
|
826
830
|
canBeComposition?: boolean;
|
827
831
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
828
|
-
parameters?: external$
|
832
|
+
parameters?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
829
833
|
/**
|
830
834
|
* Format: uuid
|
831
835
|
* @description Reference to the category this component definition belongs to
|
@@ -848,14 +852,14 @@ interface external$f {
|
|
848
852
|
*/
|
849
853
|
useTeamPermissions?: boolean;
|
850
854
|
/** @description Custom role permissions for this component definition */
|
851
|
-
permissions?: external$
|
855
|
+
permissions?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
852
856
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
853
|
-
slots?: external$
|
854
|
-
slugSettings?: external$
|
857
|
+
slots?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
858
|
+
slugSettings?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
855
859
|
/** @description Default component instance value */
|
856
|
-
defaults?: external$
|
860
|
+
defaults?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
857
861
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
858
|
-
variants?: external$
|
862
|
+
variants?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
859
863
|
/** @description Created date string for this definition (ignored for writes) */
|
860
864
|
created?: string;
|
861
865
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -863,7 +867,7 @@ interface external$f {
|
|
863
867
|
};
|
864
868
|
/** @description Defines a content type */
|
865
869
|
ContentType: {
|
866
|
-
id: external$
|
870
|
+
id: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
867
871
|
/** @description Friendly name of the content type */
|
868
872
|
name: string;
|
869
873
|
/**
|
@@ -872,7 +876,7 @@ interface external$f {
|
|
872
876
|
*/
|
873
877
|
entryName?: string | null;
|
874
878
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
875
|
-
fields?: external$
|
879
|
+
fields?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
876
880
|
/**
|
877
881
|
* @description Description of the content type
|
878
882
|
* @default null
|
@@ -887,7 +891,7 @@ interface external$f {
|
|
887
891
|
created?: string;
|
888
892
|
/** @description Last modified date string for this content type (ignored for writes) */
|
889
893
|
updated?: string;
|
890
|
-
slugSettings?: external$
|
894
|
+
slugSettings?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
891
895
|
/**
|
892
896
|
* @description The definition type of this content type (block or content type)
|
893
897
|
* @default contentType
|
@@ -902,7 +906,7 @@ interface external$f {
|
|
902
906
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
903
907
|
type: string;
|
904
908
|
/** @deprecated */
|
905
|
-
connectedData?: external$
|
909
|
+
connectedData?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
906
910
|
};
|
907
911
|
/** @description Defines a connection to a dynamic token on a data resource. */
|
908
912
|
DataElementConnectionDefinition: {
|
@@ -920,13 +924,13 @@ interface external$f {
|
|
920
924
|
type: string;
|
921
925
|
/** @description Component parameter values for the component instance */
|
922
926
|
parameters?: {
|
923
|
-
[key: string]: external$
|
927
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
924
928
|
};
|
925
929
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
926
930
|
variant?: string;
|
927
931
|
/** @description Slots containing any child components */
|
928
932
|
slots?: {
|
929
|
-
[key: string]: external$
|
933
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
930
934
|
};
|
931
935
|
/**
|
932
936
|
* @description Unique identifier of the component within the composition.
|
@@ -937,13 +941,13 @@ interface external$f {
|
|
937
941
|
_id?: string;
|
938
942
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
939
943
|
_pattern?: string;
|
940
|
-
_dataResources?: external$
|
944
|
+
_dataResources?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
941
945
|
/**
|
942
946
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
943
947
|
* Means nothing for PUTs; it will be ignored.
|
944
948
|
*/
|
945
949
|
_patternDataResources?: {
|
946
|
-
[key: string]: external$
|
950
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
947
951
|
};
|
948
952
|
/**
|
949
953
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -967,7 +971,7 @@ interface external$f {
|
|
967
971
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
968
972
|
*/
|
969
973
|
_overrides?: {
|
970
|
-
[key: string]: external$
|
974
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
971
975
|
};
|
972
976
|
/**
|
973
977
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -976,7 +980,7 @@ interface external$f {
|
|
976
980
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
977
981
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
978
982
|
*/
|
979
|
-
_overridability?: external$
|
983
|
+
_overridability?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
980
984
|
};
|
981
985
|
/** @description Defines the shape of the root component in a composition */
|
982
986
|
RootComponentInstance: {
|
@@ -984,15 +988,15 @@ interface external$f {
|
|
984
988
|
type: string;
|
985
989
|
/** @description Component parameter values for the component instance */
|
986
990
|
parameters?: {
|
987
|
-
[key: string]: external$
|
991
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
988
992
|
};
|
989
993
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
990
994
|
variant?: string;
|
991
995
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
992
|
-
projectMapNodes?: external$
|
996
|
+
projectMapNodes?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
993
997
|
/** @description Slots containing any child components */
|
994
998
|
slots?: {
|
995
|
-
[key: string]: external$
|
999
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
996
1000
|
};
|
997
1001
|
/** @description The public UUID of the composition. */
|
998
1002
|
_id: string;
|
@@ -1000,7 +1004,7 @@ interface external$f {
|
|
1000
1004
|
_slug?: string | null;
|
1001
1005
|
/** @description Friendly name of this component. */
|
1002
1006
|
_name: string;
|
1003
|
-
_dataResources?: external$
|
1007
|
+
_dataResources?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1004
1008
|
/**
|
1005
1009
|
* @description Defines patch overrides to component IDs that live in the composition.
|
1006
1010
|
* This can be used to override parameters that are defined on patterns,
|
@@ -1014,7 +1018,7 @@ interface external$f {
|
|
1014
1018
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1015
1019
|
*/
|
1016
1020
|
_overrides?: {
|
1017
|
-
[key: string]: external$
|
1021
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1018
1022
|
};
|
1019
1023
|
/**
|
1020
1024
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1023,7 +1027,7 @@ interface external$f {
|
|
1023
1027
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1024
1028
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1025
1029
|
*/
|
1026
|
-
_overridability?: external$
|
1030
|
+
_overridability?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1027
1031
|
};
|
1028
1032
|
/**
|
1029
1033
|
* @description Defines how to override a specific component.
|
@@ -1033,7 +1037,7 @@ interface external$f {
|
|
1033
1037
|
*/
|
1034
1038
|
ComponentOverride: {
|
1035
1039
|
parameters?: {
|
1036
|
-
[key: string]: external$
|
1040
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1037
1041
|
};
|
1038
1042
|
variant?: string;
|
1039
1043
|
};
|
@@ -1047,7 +1051,7 @@ interface external$f {
|
|
1047
1051
|
ComponentOverridability: {
|
1048
1052
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1049
1053
|
parameters?: {
|
1050
|
-
[key: string]: external$
|
1054
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1051
1055
|
};
|
1052
1056
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1053
1057
|
variants?: boolean;
|
@@ -1088,7 +1092,7 @@ interface external$f {
|
|
1088
1092
|
}[];
|
1089
1093
|
/** @description Variables needed to make calls to the data source */
|
1090
1094
|
variables?: {
|
1091
|
-
[key: string]: external$
|
1095
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1092
1096
|
};
|
1093
1097
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1094
1098
|
custom?: {
|
@@ -1140,7 +1144,7 @@ interface external$f {
|
|
1140
1144
|
method: "GET" | "POST" | "HEAD";
|
1141
1145
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1142
1146
|
variables?: {
|
1143
|
-
[key: string]: external$
|
1147
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1144
1148
|
};
|
1145
1149
|
/** @description Custom configuration specific to the data source being defined */
|
1146
1150
|
custom?: {
|
@@ -1173,7 +1177,7 @@ interface external$f {
|
|
1173
1177
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1174
1178
|
*/
|
1175
1179
|
DataResourceDefinitions: {
|
1176
|
-
[key: string]: external$
|
1180
|
+
[key: string]: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1177
1181
|
};
|
1178
1182
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1179
1183
|
DataResourceDefinition: {
|
@@ -1187,7 +1191,7 @@ interface external$f {
|
|
1187
1191
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1188
1192
|
*/
|
1189
1193
|
ignorePatternParameterDefault?: boolean;
|
1190
|
-
variables?: external$
|
1194
|
+
variables?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1191
1195
|
};
|
1192
1196
|
/** @description Variable values for a data resource. */
|
1193
1197
|
DataResourceVariables: {
|
@@ -1202,7 +1206,7 @@ interface external$f {
|
|
1202
1206
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
1203
1207
|
truncated?: boolean;
|
1204
1208
|
/** @description Version history entries. */
|
1205
|
-
results?: external$
|
1209
|
+
results?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
|
1206
1210
|
};
|
1207
1211
|
HistoryEntry: {
|
1208
1212
|
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
|
@@ -1255,15 +1259,19 @@ interface external$f {
|
|
1255
1259
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
1256
1260
|
integrationType: string;
|
1257
1261
|
/** @description Name for the prompt */
|
1258
|
-
|
1262
|
+
name?: string | null;
|
1259
1263
|
/** @description Text for the prompt */
|
1260
|
-
|
1264
|
+
text?: string | null;
|
1261
1265
|
/** @description Data for the prompt */
|
1262
|
-
|
1266
|
+
data?: {
|
1267
|
+
[key: string]: unknown;
|
1268
|
+
} | null;
|
1263
1269
|
/** @description Turn off/on prompt */
|
1264
1270
|
enabled?: boolean | null;
|
1265
1271
|
/** @description Integration default prompt */
|
1266
1272
|
builtIn?: boolean | null;
|
1273
|
+
/** @description Supported parameter types */
|
1274
|
+
parameterTypes?: string[] | null;
|
1267
1275
|
};
|
1268
1276
|
};
|
1269
1277
|
};
|
@@ -1272,7 +1280,7 @@ interface external$f {
|
|
1272
1280
|
}
|
1273
1281
|
|
1274
1282
|
type SharedComponents$2 = components$4['schemas'];
|
1275
|
-
type Api$2 = paths$
|
1283
|
+
type Api$2 = paths$d['/api/v1/canvas-definitions'];
|
1276
1284
|
/** Shape of the GET response from /api/v1/canvas-definitions */
|
1277
1285
|
type ComponentDefinitionGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
|
1278
1286
|
/** Shape of the PUT request body for /api/v1/canvas-definitions */
|
@@ -1369,7 +1377,7 @@ declare const EDGE_CACHE_DISABLED = -1;
|
|
1369
1377
|
* This file was auto-generated by openapi-typescript.
|
1370
1378
|
* Do not make direct changes to the file.
|
1371
1379
|
*/
|
1372
|
-
interface paths$
|
1380
|
+
interface paths$c {
|
1373
1381
|
"/api/v1/categories": {
|
1374
1382
|
get: {
|
1375
1383
|
parameters: {
|
@@ -1382,33 +1390,33 @@ interface paths$d {
|
|
1382
1390
|
200: {
|
1383
1391
|
content: {
|
1384
1392
|
"application/json": {
|
1385
|
-
categories: external$
|
1393
|
+
categories: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
|
1386
1394
|
};
|
1387
1395
|
};
|
1388
1396
|
};
|
1389
|
-
400: external$
|
1390
|
-
401: external$
|
1391
|
-
403: external$
|
1392
|
-
429: external$
|
1393
|
-
500: external$
|
1397
|
+
400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1398
|
+
401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1399
|
+
403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1400
|
+
429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1401
|
+
500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1394
1402
|
};
|
1395
1403
|
};
|
1396
1404
|
put: {
|
1397
1405
|
responses: {
|
1398
1406
|
/** OK */
|
1399
1407
|
204: never;
|
1400
|
-
400: external$
|
1401
|
-
401: external$
|
1402
|
-
403: external$
|
1403
|
-
429: external$
|
1404
|
-
500: external$
|
1408
|
+
400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1409
|
+
401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1410
|
+
403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1411
|
+
429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1412
|
+
500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1405
1413
|
};
|
1406
1414
|
requestBody: {
|
1407
1415
|
content: {
|
1408
1416
|
"application/json": {
|
1409
1417
|
/** Format: uuid */
|
1410
1418
|
projectId: string;
|
1411
|
-
categories: external$
|
1419
|
+
categories: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
|
1412
1420
|
};
|
1413
1421
|
};
|
1414
1422
|
};
|
@@ -1417,11 +1425,11 @@ interface paths$d {
|
|
1417
1425
|
responses: {
|
1418
1426
|
/** OK */
|
1419
1427
|
204: never;
|
1420
|
-
400: external$
|
1421
|
-
401: external$
|
1422
|
-
403: external$
|
1423
|
-
429: external$
|
1424
|
-
500: external$
|
1428
|
+
400: external$d["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
1429
|
+
401: external$d["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
1430
|
+
403: external$d["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
1431
|
+
429: external$d["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
1432
|
+
500: external$d["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
1425
1433
|
};
|
1426
1434
|
requestBody: {
|
1427
1435
|
content: {
|
@@ -1436,7 +1444,7 @@ interface paths$d {
|
|
1436
1444
|
};
|
1437
1445
|
};
|
1438
1446
|
}
|
1439
|
-
interface external$
|
1447
|
+
interface external$d {
|
1440
1448
|
"swagger.yml": {
|
1441
1449
|
paths: {};
|
1442
1450
|
components: {
|
@@ -1450,25 +1458,25 @@ interface external$e {
|
|
1450
1458
|
/** Request input validation failed */
|
1451
1459
|
BadRequestError: {
|
1452
1460
|
content: {
|
1453
|
-
"application/json": external$
|
1461
|
+
"application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
|
1454
1462
|
};
|
1455
1463
|
};
|
1456
1464
|
/** API key or token was not valid */
|
1457
1465
|
UnauthorizedError: {
|
1458
1466
|
content: {
|
1459
|
-
"application/json": external$
|
1467
|
+
"application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
|
1460
1468
|
};
|
1461
1469
|
};
|
1462
1470
|
/** Permission was denied */
|
1463
1471
|
ForbiddenError: {
|
1464
1472
|
content: {
|
1465
|
-
"application/json": external$
|
1473
|
+
"application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
|
1466
1474
|
};
|
1467
1475
|
};
|
1468
1476
|
/** Resource not found */
|
1469
1477
|
NotFoundError: {
|
1470
1478
|
content: {
|
1471
|
-
"application/json": external$
|
1479
|
+
"application/json": external$d["swagger.yml"]["components"]["schemas"]["Error"];
|
1472
1480
|
};
|
1473
1481
|
};
|
1474
1482
|
/** Too many requests in allowed time period */
|
@@ -1487,7 +1495,7 @@ interface external$e {
|
|
1487
1495
|
PublicIdProperty: string;
|
1488
1496
|
/** @description The definition of a component parameter */
|
1489
1497
|
ComponentDefinitionParameter: {
|
1490
|
-
id: external$
|
1498
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1491
1499
|
/** @description Friendly name of the parameter */
|
1492
1500
|
name: string;
|
1493
1501
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -1499,7 +1507,7 @@ interface external$e {
|
|
1499
1507
|
};
|
1500
1508
|
/** @description The definition of a named component slot that can contain other components */
|
1501
1509
|
ComponentDefinitionSlot: {
|
1502
|
-
id: external$
|
1510
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1503
1511
|
/** @description Friendly name of the slot */
|
1504
1512
|
name: string;
|
1505
1513
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -1557,13 +1565,13 @@ interface external$e {
|
|
1557
1565
|
};
|
1558
1566
|
/** @description The definition of a component variant */
|
1559
1567
|
ComponentDefinitionVariant: {
|
1560
|
-
id: external$
|
1568
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1561
1569
|
/** @description Friendly name of the variant */
|
1562
1570
|
name: string;
|
1563
1571
|
};
|
1564
1572
|
/** @description Permission set for a component defintion */
|
1565
1573
|
ComponentDefinitionPermission: {
|
1566
|
-
roleId: external$
|
1574
|
+
roleId: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1567
1575
|
/**
|
1568
1576
|
* @description Permission type for this permission ComponentDefinition:
|
1569
1577
|
* read | write | create | delete
|
@@ -1576,7 +1584,7 @@ interface external$e {
|
|
1576
1584
|
};
|
1577
1585
|
/** @description Defines a component type that can live on a Composition */
|
1578
1586
|
ComponentDefinition: {
|
1579
|
-
id: external$
|
1587
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1580
1588
|
/** @description Friendly name of the component definition */
|
1581
1589
|
name: string;
|
1582
1590
|
/**
|
@@ -1597,7 +1605,7 @@ interface external$e {
|
|
1597
1605
|
*/
|
1598
1606
|
canBeComposition?: boolean;
|
1599
1607
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
1600
|
-
parameters?: external$
|
1608
|
+
parameters?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1601
1609
|
/**
|
1602
1610
|
* Format: uuid
|
1603
1611
|
* @description Reference to the category this component definition belongs to
|
@@ -1620,14 +1628,14 @@ interface external$e {
|
|
1620
1628
|
*/
|
1621
1629
|
useTeamPermissions?: boolean;
|
1622
1630
|
/** @description Custom role permissions for this component definition */
|
1623
|
-
permissions?: external$
|
1631
|
+
permissions?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
1624
1632
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
1625
|
-
slots?: external$
|
1626
|
-
slugSettings?: external$
|
1633
|
+
slots?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
1634
|
+
slugSettings?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1627
1635
|
/** @description Default component instance value */
|
1628
|
-
defaults?: external$
|
1636
|
+
defaults?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
1629
1637
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
1630
|
-
variants?: external$
|
1638
|
+
variants?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
1631
1639
|
/** @description Created date string for this definition (ignored for writes) */
|
1632
1640
|
created?: string;
|
1633
1641
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -1635,7 +1643,7 @@ interface external$e {
|
|
1635
1643
|
};
|
1636
1644
|
/** @description Defines a content type */
|
1637
1645
|
ContentType: {
|
1638
|
-
id: external$
|
1646
|
+
id: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
1639
1647
|
/** @description Friendly name of the content type */
|
1640
1648
|
name: string;
|
1641
1649
|
/**
|
@@ -1644,7 +1652,7 @@ interface external$e {
|
|
1644
1652
|
*/
|
1645
1653
|
entryName?: string | null;
|
1646
1654
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
1647
|
-
fields?: external$
|
1655
|
+
fields?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
1648
1656
|
/**
|
1649
1657
|
* @description Description of the content type
|
1650
1658
|
* @default null
|
@@ -1659,7 +1667,7 @@ interface external$e {
|
|
1659
1667
|
created?: string;
|
1660
1668
|
/** @description Last modified date string for this content type (ignored for writes) */
|
1661
1669
|
updated?: string;
|
1662
|
-
slugSettings?: external$
|
1670
|
+
slugSettings?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
1663
1671
|
/**
|
1664
1672
|
* @description The definition type of this content type (block or content type)
|
1665
1673
|
* @default contentType
|
@@ -1674,7 +1682,7 @@ interface external$e {
|
|
1674
1682
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
1675
1683
|
type: string;
|
1676
1684
|
/** @deprecated */
|
1677
|
-
connectedData?: external$
|
1685
|
+
connectedData?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
1678
1686
|
};
|
1679
1687
|
/** @description Defines a connection to a dynamic token on a data resource. */
|
1680
1688
|
DataElementConnectionDefinition: {
|
@@ -1692,13 +1700,13 @@ interface external$e {
|
|
1692
1700
|
type: string;
|
1693
1701
|
/** @description Component parameter values for the component instance */
|
1694
1702
|
parameters?: {
|
1695
|
-
[key: string]: external$
|
1703
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1696
1704
|
};
|
1697
1705
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1698
1706
|
variant?: string;
|
1699
1707
|
/** @description Slots containing any child components */
|
1700
1708
|
slots?: {
|
1701
|
-
[key: string]: external$
|
1709
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1702
1710
|
};
|
1703
1711
|
/**
|
1704
1712
|
* @description Unique identifier of the component within the composition.
|
@@ -1709,13 +1717,13 @@ interface external$e {
|
|
1709
1717
|
_id?: string;
|
1710
1718
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
1711
1719
|
_pattern?: string;
|
1712
|
-
_dataResources?: external$
|
1720
|
+
_dataResources?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1713
1721
|
/**
|
1714
1722
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
1715
1723
|
* Means nothing for PUTs; it will be ignored.
|
1716
1724
|
*/
|
1717
1725
|
_patternDataResources?: {
|
1718
|
-
[key: string]: external$
|
1726
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1719
1727
|
};
|
1720
1728
|
/**
|
1721
1729
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -1739,7 +1747,7 @@ interface external$e {
|
|
1739
1747
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1740
1748
|
*/
|
1741
1749
|
_overrides?: {
|
1742
|
-
[key: string]: external$
|
1750
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1743
1751
|
};
|
1744
1752
|
/**
|
1745
1753
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1748,7 +1756,7 @@ interface external$e {
|
|
1748
1756
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1749
1757
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1750
1758
|
*/
|
1751
|
-
_overridability?: external$
|
1759
|
+
_overridability?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1752
1760
|
};
|
1753
1761
|
/** @description Defines the shape of the root component in a composition */
|
1754
1762
|
RootComponentInstance: {
|
@@ -1756,15 +1764,15 @@ interface external$e {
|
|
1756
1764
|
type: string;
|
1757
1765
|
/** @description Component parameter values for the component instance */
|
1758
1766
|
parameters?: {
|
1759
|
-
[key: string]: external$
|
1767
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1760
1768
|
};
|
1761
1769
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
1762
1770
|
variant?: string;
|
1763
1771
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
1764
|
-
projectMapNodes?: external$
|
1772
|
+
projectMapNodes?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
1765
1773
|
/** @description Slots containing any child components */
|
1766
1774
|
slots?: {
|
1767
|
-
[key: string]: external$
|
1775
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
1768
1776
|
};
|
1769
1777
|
/** @description The public UUID of the composition. */
|
1770
1778
|
_id: string;
|
@@ -1772,7 +1780,7 @@ interface external$e {
|
|
1772
1780
|
_slug?: string | null;
|
1773
1781
|
/** @description Friendly name of this component. */
|
1774
1782
|
_name: string;
|
1775
|
-
_dataResources?: external$
|
1783
|
+
_dataResources?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
1776
1784
|
/**
|
1777
1785
|
* @description Defines patch overrides to component IDs that live in the composition.
|
1778
1786
|
* This can be used to override parameters that are defined on patterns,
|
@@ -1786,7 +1794,7 @@ interface external$e {
|
|
1786
1794
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1787
1795
|
*/
|
1788
1796
|
_overrides?: {
|
1789
|
-
[key: string]: external$
|
1797
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
1790
1798
|
};
|
1791
1799
|
/**
|
1792
1800
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -1795,7 +1803,7 @@ interface external$e {
|
|
1795
1803
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
1796
1804
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
1797
1805
|
*/
|
1798
|
-
_overridability?: external$
|
1806
|
+
_overridability?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
1799
1807
|
};
|
1800
1808
|
/**
|
1801
1809
|
* @description Defines how to override a specific component.
|
@@ -1805,7 +1813,7 @@ interface external$e {
|
|
1805
1813
|
*/
|
1806
1814
|
ComponentOverride: {
|
1807
1815
|
parameters?: {
|
1808
|
-
[key: string]: external$
|
1816
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
1809
1817
|
};
|
1810
1818
|
variant?: string;
|
1811
1819
|
};
|
@@ -1819,7 +1827,7 @@ interface external$e {
|
|
1819
1827
|
ComponentOverridability: {
|
1820
1828
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
1821
1829
|
parameters?: {
|
1822
|
-
[key: string]: external$
|
1830
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
1823
1831
|
};
|
1824
1832
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
1825
1833
|
variants?: boolean;
|
@@ -1860,7 +1868,7 @@ interface external$e {
|
|
1860
1868
|
}[];
|
1861
1869
|
/** @description Variables needed to make calls to the data source */
|
1862
1870
|
variables?: {
|
1863
|
-
[key: string]: external$
|
1871
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1864
1872
|
};
|
1865
1873
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
1866
1874
|
custom?: {
|
@@ -1912,7 +1920,7 @@ interface external$e {
|
|
1912
1920
|
method: "GET" | "POST" | "HEAD";
|
1913
1921
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
1914
1922
|
variables?: {
|
1915
|
-
[key: string]: external$
|
1923
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
1916
1924
|
};
|
1917
1925
|
/** @description Custom configuration specific to the data source being defined */
|
1918
1926
|
custom?: {
|
@@ -1945,7 +1953,7 @@ interface external$e {
|
|
1945
1953
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
1946
1954
|
*/
|
1947
1955
|
DataResourceDefinitions: {
|
1948
|
-
[key: string]: external$
|
1956
|
+
[key: string]: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
1949
1957
|
};
|
1950
1958
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
1951
1959
|
DataResourceDefinition: {
|
@@ -1959,7 +1967,7 @@ interface external$e {
|
|
1959
1967
|
* If isPatternParameter is false or undefined, this has no meaning.
|
1960
1968
|
*/
|
1961
1969
|
ignorePatternParameterDefault?: boolean;
|
1962
|
-
variables?: external$
|
1970
|
+
variables?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
1963
1971
|
};
|
1964
1972
|
/** @description Variable values for a data resource. */
|
1965
1973
|
DataResourceVariables: {
|
@@ -1974,7 +1982,7 @@ interface external$e {
|
|
1974
1982
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
1975
1983
|
truncated?: boolean;
|
1976
1984
|
/** @description Version history entries. */
|
1977
|
-
results?: external$
|
1985
|
+
results?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
|
1978
1986
|
};
|
1979
1987
|
HistoryEntry: {
|
1980
1988
|
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
|
@@ -2027,15 +2035,19 @@ interface external$e {
|
|
2027
2035
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
2028
2036
|
integrationType: string;
|
2029
2037
|
/** @description Name for the prompt */
|
2030
|
-
|
2038
|
+
name?: string | null;
|
2031
2039
|
/** @description Text for the prompt */
|
2032
|
-
|
2040
|
+
text?: string | null;
|
2033
2041
|
/** @description Data for the prompt */
|
2034
|
-
|
2042
|
+
data?: {
|
2043
|
+
[key: string]: unknown;
|
2044
|
+
} | null;
|
2035
2045
|
/** @description Turn off/on prompt */
|
2036
2046
|
enabled?: boolean | null;
|
2037
2047
|
/** @description Integration default prompt */
|
2038
2048
|
builtIn?: boolean | null;
|
2049
|
+
/** @description Supported parameter types */
|
2050
|
+
parameterTypes?: string[] | null;
|
2039
2051
|
};
|
2040
2052
|
};
|
2041
2053
|
};
|
@@ -2044,7 +2056,7 @@ interface external$e {
|
|
2044
2056
|
}
|
2045
2057
|
|
2046
2058
|
type SharedComponents$1 = components$4['schemas'];
|
2047
|
-
type Api$1 = paths$
|
2059
|
+
type Api$1 = paths$c['/api/v1/categories'];
|
2048
2060
|
/** Shape of the GET response from /api/v1/category */
|
2049
2061
|
type CategoriesGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
|
2050
2062
|
/** Shape of the PUT request body for /api/v1/category */
|
@@ -2060,7 +2072,7 @@ type Category = SharedComponents$1['Category'];
|
|
2060
2072
|
* This file was auto-generated by openapi-typescript.
|
2061
2073
|
* Do not make direct changes to the file.
|
2062
2074
|
*/
|
2063
|
-
interface paths$
|
2075
|
+
interface paths$b {
|
2064
2076
|
"/api/v1/content-types": {
|
2065
2077
|
get: {
|
2066
2078
|
parameters: {
|
@@ -2081,15 +2093,15 @@ interface paths$c {
|
|
2081
2093
|
content: {
|
2082
2094
|
"application/json": {
|
2083
2095
|
/** @description Content types that match the query */
|
2084
|
-
contentTypes: external$
|
2096
|
+
contentTypes: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"][];
|
2085
2097
|
};
|
2086
2098
|
};
|
2087
2099
|
};
|
2088
|
-
400: external$
|
2089
|
-
401: external$
|
2090
|
-
403: external$
|
2091
|
-
429: external$
|
2092
|
-
500: external$
|
2100
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2101
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2102
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2103
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2104
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2093
2105
|
};
|
2094
2106
|
};
|
2095
2107
|
/** Upserts a content type */
|
@@ -2097,11 +2109,11 @@ interface paths$c {
|
|
2097
2109
|
responses: {
|
2098
2110
|
/** OK */
|
2099
2111
|
204: never;
|
2100
|
-
400: external$
|
2101
|
-
401: external$
|
2102
|
-
403: external$
|
2103
|
-
429: external$
|
2104
|
-
500: external$
|
2112
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2113
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2114
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2115
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2116
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2105
2117
|
};
|
2106
2118
|
requestBody: {
|
2107
2119
|
content: {
|
@@ -2111,7 +2123,7 @@ interface paths$c {
|
|
2111
2123
|
* @description The project ID to upsert the content type to
|
2112
2124
|
*/
|
2113
2125
|
projectId: string;
|
2114
|
-
contentType: external$
|
2126
|
+
contentType: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ContentType"];
|
2115
2127
|
};
|
2116
2128
|
};
|
2117
2129
|
};
|
@@ -2121,11 +2133,11 @@ interface paths$c {
|
|
2121
2133
|
responses: {
|
2122
2134
|
/** OK */
|
2123
2135
|
204: never;
|
2124
|
-
400: external$
|
2125
|
-
401: external$
|
2126
|
-
403: external$
|
2127
|
-
429: external$
|
2128
|
-
500: external$
|
2136
|
+
400: external$c["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2137
|
+
401: external$c["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2138
|
+
403: external$c["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2139
|
+
429: external$c["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2140
|
+
500: external$c["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2129
2141
|
};
|
2130
2142
|
requestBody: {
|
2131
2143
|
content: {
|
@@ -2150,7 +2162,7 @@ interface paths$c {
|
|
2150
2162
|
};
|
2151
2163
|
};
|
2152
2164
|
}
|
2153
|
-
interface external$
|
2165
|
+
interface external$c {
|
2154
2166
|
"swagger.yml": {
|
2155
2167
|
paths: {};
|
2156
2168
|
components: {
|
@@ -2164,25 +2176,25 @@ interface external$d {
|
|
2164
2176
|
/** Request input validation failed */
|
2165
2177
|
BadRequestError: {
|
2166
2178
|
content: {
|
2167
|
-
"application/json": external$
|
2179
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
2168
2180
|
};
|
2169
2181
|
};
|
2170
2182
|
/** API key or token was not valid */
|
2171
2183
|
UnauthorizedError: {
|
2172
2184
|
content: {
|
2173
|
-
"application/json": external$
|
2185
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
2174
2186
|
};
|
2175
2187
|
};
|
2176
2188
|
/** Permission was denied */
|
2177
2189
|
ForbiddenError: {
|
2178
2190
|
content: {
|
2179
|
-
"application/json": external$
|
2191
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
2180
2192
|
};
|
2181
2193
|
};
|
2182
2194
|
/** Resource not found */
|
2183
2195
|
NotFoundError: {
|
2184
2196
|
content: {
|
2185
|
-
"application/json": external$
|
2197
|
+
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
2186
2198
|
};
|
2187
2199
|
};
|
2188
2200
|
/** Too many requests in allowed time period */
|
@@ -2201,7 +2213,7 @@ interface external$d {
|
|
2201
2213
|
PublicIdProperty: string;
|
2202
2214
|
/** @description The definition of a component parameter */
|
2203
2215
|
ComponentDefinitionParameter: {
|
2204
|
-
id: external$
|
2216
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2205
2217
|
/** @description Friendly name of the parameter */
|
2206
2218
|
name: string;
|
2207
2219
|
/** @description Appears next to the parameter in the Composition editor */
|
@@ -2213,7 +2225,7 @@ interface external$d {
|
|
2213
2225
|
};
|
2214
2226
|
/** @description The definition of a named component slot that can contain other components */
|
2215
2227
|
ComponentDefinitionSlot: {
|
2216
|
-
id: external$
|
2228
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2217
2229
|
/** @description Friendly name of the slot */
|
2218
2230
|
name: string;
|
2219
2231
|
/** @description A list of component definition public IDs that are allowed in this named slot */
|
@@ -2271,13 +2283,13 @@ interface external$d {
|
|
2271
2283
|
};
|
2272
2284
|
/** @description The definition of a component variant */
|
2273
2285
|
ComponentDefinitionVariant: {
|
2274
|
-
id: external$
|
2286
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2275
2287
|
/** @description Friendly name of the variant */
|
2276
2288
|
name: string;
|
2277
2289
|
};
|
2278
2290
|
/** @description Permission set for a component defintion */
|
2279
2291
|
ComponentDefinitionPermission: {
|
2280
|
-
roleId: external$
|
2292
|
+
roleId: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2281
2293
|
/**
|
2282
2294
|
* @description Permission type for this permission ComponentDefinition:
|
2283
2295
|
* read | write | create | delete
|
@@ -2290,7 +2302,7 @@ interface external$d {
|
|
2290
2302
|
};
|
2291
2303
|
/** @description Defines a component type that can live on a Composition */
|
2292
2304
|
ComponentDefinition: {
|
2293
|
-
id: external$
|
2305
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2294
2306
|
/** @description Friendly name of the component definition */
|
2295
2307
|
name: string;
|
2296
2308
|
/**
|
@@ -2311,7 +2323,7 @@ interface external$d {
|
|
2311
2323
|
*/
|
2312
2324
|
canBeComposition?: boolean;
|
2313
2325
|
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
2314
|
-
parameters?: external$
|
2326
|
+
parameters?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2315
2327
|
/**
|
2316
2328
|
* Format: uuid
|
2317
2329
|
* @description Reference to the category this component definition belongs to
|
@@ -2334,14 +2346,14 @@ interface external$d {
|
|
2334
2346
|
*/
|
2335
2347
|
useTeamPermissions?: boolean;
|
2336
2348
|
/** @description Custom role permissions for this component definition */
|
2337
|
-
permissions?: external$
|
2349
|
+
permissions?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
2338
2350
|
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
2339
|
-
slots?: external$
|
2340
|
-
slugSettings?: external$
|
2351
|
+
slots?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
2352
|
+
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2341
2353
|
/** @description Default component instance value */
|
2342
|
-
defaults?: external$
|
2354
|
+
defaults?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
2343
2355
|
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
2344
|
-
variants?: external$
|
2356
|
+
variants?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
2345
2357
|
/** @description Created date string for this definition (ignored for writes) */
|
2346
2358
|
created?: string;
|
2347
2359
|
/** @description Last modified date string for this definition (ignored for writes) */
|
@@ -2349,7 +2361,7 @@ interface external$d {
|
|
2349
2361
|
};
|
2350
2362
|
/** @description Defines a content type */
|
2351
2363
|
ContentType: {
|
2352
|
-
id: external$
|
2364
|
+
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
2353
2365
|
/** @description Friendly name of the content type */
|
2354
2366
|
name: string;
|
2355
2367
|
/**
|
@@ -2358,7 +2370,7 @@ interface external$d {
|
|
2358
2370
|
*/
|
2359
2371
|
entryName?: string | null;
|
2360
2372
|
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
2361
|
-
fields?: external$
|
2373
|
+
fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
2362
2374
|
/**
|
2363
2375
|
* @description Description of the content type
|
2364
2376
|
* @default null
|
@@ -2373,7 +2385,7 @@ interface external$d {
|
|
2373
2385
|
created?: string;
|
2374
2386
|
/** @description Last modified date string for this content type (ignored for writes) */
|
2375
2387
|
updated?: string;
|
2376
|
-
slugSettings?: external$
|
2388
|
+
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
2377
2389
|
/**
|
2378
2390
|
* @description The definition type of this content type (block or content type)
|
2379
2391
|
* @default contentType
|
@@ -2388,7 +2400,7 @@ interface external$d {
|
|
2388
2400
|
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
2389
2401
|
type: string;
|
2390
2402
|
/** @deprecated */
|
2391
|
-
connectedData?: external$
|
2403
|
+
connectedData?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
2392
2404
|
};
|
2393
2405
|
/** @description Defines a connection to a dynamic token on a data resource. */
|
2394
2406
|
DataElementConnectionDefinition: {
|
@@ -2406,13 +2418,13 @@ interface external$d {
|
|
2406
2418
|
type: string;
|
2407
2419
|
/** @description Component parameter values for the component instance */
|
2408
2420
|
parameters?: {
|
2409
|
-
[key: string]: external$
|
2421
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2410
2422
|
};
|
2411
2423
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2412
2424
|
variant?: string;
|
2413
2425
|
/** @description Slots containing any child components */
|
2414
2426
|
slots?: {
|
2415
|
-
[key: string]: external$
|
2427
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2416
2428
|
};
|
2417
2429
|
/**
|
2418
2430
|
* @description Unique identifier of the component within the composition.
|
@@ -2423,13 +2435,13 @@ interface external$d {
|
|
2423
2435
|
_id?: string;
|
2424
2436
|
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
2425
2437
|
_pattern?: string;
|
2426
|
-
_dataResources?: external$
|
2438
|
+
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2427
2439
|
/**
|
2428
2440
|
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
2429
2441
|
* Means nothing for PUTs; it will be ignored.
|
2430
2442
|
*/
|
2431
2443
|
_patternDataResources?: {
|
2432
|
-
[key: string]: external$
|
2444
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2433
2445
|
};
|
2434
2446
|
/**
|
2435
2447
|
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
@@ -2453,7 +2465,7 @@ interface external$d {
|
|
2453
2465
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2454
2466
|
*/
|
2455
2467
|
_overrides?: {
|
2456
|
-
[key: string]: external$
|
2468
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2457
2469
|
};
|
2458
2470
|
/**
|
2459
2471
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2462,7 +2474,7 @@ interface external$d {
|
|
2462
2474
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2463
2475
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2464
2476
|
*/
|
2465
|
-
_overridability?: external$
|
2477
|
+
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2466
2478
|
};
|
2467
2479
|
/** @description Defines the shape of the root component in a composition */
|
2468
2480
|
RootComponentInstance: {
|
@@ -2470,15 +2482,15 @@ interface external$d {
|
|
2470
2482
|
type: string;
|
2471
2483
|
/** @description Component parameter values for the component instance */
|
2472
2484
|
parameters?: {
|
2473
|
-
[key: string]: external$
|
2485
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2474
2486
|
};
|
2475
2487
|
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
2476
2488
|
variant?: string;
|
2477
2489
|
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
2478
|
-
projectMapNodes?: external$
|
2490
|
+
projectMapNodes?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
2479
2491
|
/** @description Slots containing any child components */
|
2480
2492
|
slots?: {
|
2481
|
-
[key: string]: external$
|
2493
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
2482
2494
|
};
|
2483
2495
|
/** @description The public UUID of the composition. */
|
2484
2496
|
_id: string;
|
@@ -2486,7 +2498,7 @@ interface external$d {
|
|
2486
2498
|
_slug?: string | null;
|
2487
2499
|
/** @description Friendly name of this component. */
|
2488
2500
|
_name: string;
|
2489
|
-
_dataResources?: external$
|
2501
|
+
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2490
2502
|
/**
|
2491
2503
|
* @description Defines patch overrides to component IDs that live in the composition.
|
2492
2504
|
* This can be used to override parameters that are defined on patterns,
|
@@ -2500,7 +2512,7 @@ interface external$d {
|
|
2500
2512
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2501
2513
|
*/
|
2502
2514
|
_overrides?: {
|
2503
|
-
[key: string]: external$
|
2515
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
2504
2516
|
};
|
2505
2517
|
/**
|
2506
2518
|
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
@@ -2509,7 +2521,7 @@ interface external$d {
|
|
2509
2521
|
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
2510
2522
|
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
2511
2523
|
*/
|
2512
|
-
_overridability?: external$
|
2524
|
+
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
2513
2525
|
};
|
2514
2526
|
/**
|
2515
2527
|
* @description Defines how to override a specific component.
|
@@ -2519,7 +2531,7 @@ interface external$d {
|
|
2519
2531
|
*/
|
2520
2532
|
ComponentOverride: {
|
2521
2533
|
parameters?: {
|
2522
|
-
[key: string]: external$
|
2534
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2523
2535
|
};
|
2524
2536
|
variant?: string;
|
2525
2537
|
};
|
@@ -2533,7 +2545,7 @@ interface external$d {
|
|
2533
2545
|
ComponentOverridability: {
|
2534
2546
|
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
2535
2547
|
parameters?: {
|
2536
|
-
[key: string]: external$
|
2548
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
2537
2549
|
};
|
2538
2550
|
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
2539
2551
|
variants?: boolean;
|
@@ -2574,7 +2586,7 @@ interface external$d {
|
|
2574
2586
|
}[];
|
2575
2587
|
/** @description Variables needed to make calls to the data source */
|
2576
2588
|
variables?: {
|
2577
|
-
[key: string]: external$
|
2589
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2578
2590
|
};
|
2579
2591
|
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
2580
2592
|
custom?: {
|
@@ -2626,7 +2638,7 @@ interface external$d {
|
|
2626
2638
|
method: "GET" | "POST" | "HEAD";
|
2627
2639
|
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
2628
2640
|
variables?: {
|
2629
|
-
[key: string]: external$
|
2641
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
2630
2642
|
};
|
2631
2643
|
/** @description Custom configuration specific to the data source being defined */
|
2632
2644
|
custom?: {
|
@@ -2659,7 +2671,7 @@ interface external$d {
|
|
2659
2671
|
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
2660
2672
|
*/
|
2661
2673
|
DataResourceDefinitions: {
|
2662
|
-
[key: string]: external$
|
2674
|
+
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
2663
2675
|
};
|
2664
2676
|
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
2665
2677
|
DataResourceDefinition: {
|
@@ -2673,7 +2685,7 @@ interface external$d {
|
|
2673
2685
|
* If isPatternParameter is false or undefined, this has no meaning.
|
2674
2686
|
*/
|
2675
2687
|
ignorePatternParameterDefault?: boolean;
|
2676
|
-
variables?: external$
|
2688
|
+
variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
2677
2689
|
};
|
2678
2690
|
/** @description Variable values for a data resource. */
|
2679
2691
|
DataResourceVariables: {
|
@@ -2688,7 +2700,7 @@ interface external$d {
|
|
2688
2700
|
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
2689
2701
|
truncated?: boolean;
|
2690
2702
|
/** @description Version history entries. */
|
2691
|
-
results?: external$
|
2703
|
+
results?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
|
2692
2704
|
};
|
2693
2705
|
HistoryEntry: {
|
2694
2706
|
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
|
@@ -2741,15 +2753,19 @@ interface external$d {
|
|
2741
2753
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
2742
2754
|
integrationType: string;
|
2743
2755
|
/** @description Name for the prompt */
|
2744
|
-
|
2756
|
+
name?: string | null;
|
2745
2757
|
/** @description Text for the prompt */
|
2746
|
-
|
2758
|
+
text?: string | null;
|
2747
2759
|
/** @description Data for the prompt */
|
2748
|
-
|
2760
|
+
data?: {
|
2761
|
+
[key: string]: unknown;
|
2762
|
+
} | null;
|
2749
2763
|
/** @description Turn off/on prompt */
|
2750
2764
|
enabled?: boolean | null;
|
2751
2765
|
/** @description Integration default prompt */
|
2752
2766
|
builtIn?: boolean | null;
|
2767
|
+
/** @description Supported parameter types */
|
2768
|
+
parameterTypes?: string[] | null;
|
2753
2769
|
};
|
2754
2770
|
};
|
2755
2771
|
};
|
@@ -2761,7 +2777,7 @@ interface external$d {
|
|
2761
2777
|
* This file was auto-generated by openapi-typescript.
|
2762
2778
|
* Do not make direct changes to the file.
|
2763
2779
|
*/
|
2764
|
-
interface paths$
|
2780
|
+
interface paths$a {
|
2765
2781
|
"/api/v1/entries": {
|
2766
2782
|
get: {
|
2767
2783
|
parameters: {
|
@@ -2822,17 +2838,17 @@ interface paths$b {
|
|
2822
2838
|
"application/json": components$3["schemas"]["EntryListResponse"];
|
2823
2839
|
};
|
2824
2840
|
};
|
2825
|
-
400: external$
|
2826
|
-
401: external$
|
2827
|
-
403: external$
|
2841
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2842
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2843
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2828
2844
|
/** Entry not found */
|
2829
2845
|
404: {
|
2830
2846
|
content: {
|
2831
2847
|
"text/plain": string;
|
2832
2848
|
};
|
2833
2849
|
};
|
2834
|
-
429: external$
|
2835
|
-
500: external$
|
2850
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2851
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2836
2852
|
};
|
2837
2853
|
};
|
2838
2854
|
/** Upserts an entry */
|
@@ -2840,11 +2856,11 @@ interface paths$b {
|
|
2840
2856
|
responses: {
|
2841
2857
|
/** OK */
|
2842
2858
|
204: never;
|
2843
|
-
400: external$
|
2844
|
-
401: external$
|
2845
|
-
403: external$
|
2846
|
-
429: external$
|
2847
|
-
500: external$
|
2859
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2860
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2861
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2862
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2863
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2848
2864
|
};
|
2849
2865
|
requestBody: {
|
2850
2866
|
content: {
|
@@ -2870,11 +2886,11 @@ interface paths$b {
|
|
2870
2886
|
responses: {
|
2871
2887
|
/** OK */
|
2872
2888
|
204: never;
|
2873
|
-
400: external$
|
2874
|
-
401: external$
|
2875
|
-
403: external$
|
2876
|
-
429: external$
|
2877
|
-
500: external$
|
2889
|
+
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
2890
|
+
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
2891
|
+
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
2892
|
+
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
2893
|
+
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
2878
2894
|
};
|
2879
2895
|
requestBody: {
|
2880
2896
|
content: {
|
@@ -2923,9 +2939,9 @@ interface components$3 {
|
|
2923
2939
|
_author?: string;
|
2924
2940
|
/** @description Entry field values. */
|
2925
2941
|
fields?: {
|
2926
|
-
[key: string]: external$
|
2942
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2927
2943
|
};
|
2928
|
-
_dataResources?: external$
|
2944
|
+
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2929
2945
|
};
|
2930
2946
|
/** @description Defines the shape of the entry input */
|
2931
2947
|
EntryInput: {
|
@@ -2942,9 +2958,9 @@ interface components$3 {
|
|
2942
2958
|
_slug?: string;
|
2943
2959
|
/** @description Entry field values. */
|
2944
2960
|
fields?: {
|
2945
|
-
[key: string]: external$
|
2961
|
+
[key: string]: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
2946
2962
|
};
|
2947
|
-
_dataResources?: external$
|
2963
|
+
_dataResources?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
2948
2964
|
};
|
2949
2965
|
EntryApiResponse: {
|
2950
2966
|
/** @description Publishing state to fetch. 0 = draft, 64 = published. */
|
@@ -3024,656 +3040,10 @@ interface components$3 {
|
|
3024
3040
|
/**
|
3025
3041
|
* @description Controls whether the total count of results will be returned along with the current results page in a list.
|
3026
3042
|
* Has no effect when not fetching a list. This does impact performance when enabled.
|
3027
|
-
*/
|
3028
|
-
withTotalCount: boolean;
|
3029
|
-
/** @description Performs keyword search on the entries. */
|
3030
|
-
keyword: string;
|
3031
|
-
};
|
3032
|
-
}
|
3033
|
-
interface external$c {
|
3034
|
-
"swagger.yml": {
|
3035
|
-
paths: {};
|
3036
|
-
components: {
|
3037
|
-
schemas: {
|
3038
|
-
Error: {
|
3039
|
-
/** @description Error message(s) that occurred while processing the request */
|
3040
|
-
errorMessage?: string[] | string;
|
3041
|
-
};
|
3042
|
-
};
|
3043
|
-
responses: {
|
3044
|
-
/** Request input validation failed */
|
3045
|
-
BadRequestError: {
|
3046
|
-
content: {
|
3047
|
-
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
3048
|
-
};
|
3049
|
-
};
|
3050
|
-
/** API key or token was not valid */
|
3051
|
-
UnauthorizedError: {
|
3052
|
-
content: {
|
3053
|
-
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
3054
|
-
};
|
3055
|
-
};
|
3056
|
-
/** Permission was denied */
|
3057
|
-
ForbiddenError: {
|
3058
|
-
content: {
|
3059
|
-
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
3060
|
-
};
|
3061
|
-
};
|
3062
|
-
/** Resource not found */
|
3063
|
-
NotFoundError: {
|
3064
|
-
content: {
|
3065
|
-
"application/json": external$c["swagger.yml"]["components"]["schemas"]["Error"];
|
3066
|
-
};
|
3067
|
-
};
|
3068
|
-
/** Too many requests in allowed time period */
|
3069
|
-
RateLimitError: unknown;
|
3070
|
-
/** Execution error occurred */
|
3071
|
-
InternalServerError: unknown;
|
3072
|
-
};
|
3073
|
-
};
|
3074
|
-
operations: {};
|
3075
|
-
};
|
3076
|
-
"uniform-canvas-types.swagger.yml": {
|
3077
|
-
paths: {};
|
3078
|
-
components: {
|
3079
|
-
schemas: {
|
3080
|
-
/** @description Public ID (used in code). Do not change after creation. */
|
3081
|
-
PublicIdProperty: string;
|
3082
|
-
/** @description The definition of a component parameter */
|
3083
|
-
ComponentDefinitionParameter: {
|
3084
|
-
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3085
|
-
/** @description Friendly name of the parameter */
|
3086
|
-
name: string;
|
3087
|
-
/** @description Appears next to the parameter in the Composition editor */
|
3088
|
-
helpText?: string;
|
3089
|
-
/** @description Type name of the parameter (provided by a Uniform integration) */
|
3090
|
-
type: string;
|
3091
|
-
/** @description The configuration object for the type (type-specific) */
|
3092
|
-
typeConfig?: unknown;
|
3093
|
-
};
|
3094
|
-
/** @description The definition of a named component slot that can contain other components */
|
3095
|
-
ComponentDefinitionSlot: {
|
3096
|
-
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3097
|
-
/** @description Friendly name of the slot */
|
3098
|
-
name: string;
|
3099
|
-
/** @description A list of component definition public IDs that are allowed in this named slot */
|
3100
|
-
allowedComponents: string[];
|
3101
|
-
/**
|
3102
|
-
* @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
|
3103
|
-
* If allowAllComponents is true, this value is ignored.
|
3104
|
-
*
|
3105
|
-
* @default false
|
3106
|
-
*/
|
3107
|
-
inheritAllowedComponents: boolean;
|
3108
|
-
/**
|
3109
|
-
* @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.
|
3110
|
-
* When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
|
3111
|
-
*/
|
3112
|
-
allowAllComponents?: boolean;
|
3113
|
-
/**
|
3114
|
-
* @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
|
3115
|
-
* When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
|
3116
|
-
*/
|
3117
|
-
patternsInAllowedComponents?: boolean;
|
3118
|
-
/** @description Minimum valid number of components in this slot */
|
3119
|
-
minComponents?: number;
|
3120
|
-
/** @description Maximum valid number of components in this slot */
|
3121
|
-
maxComponents?: number;
|
3122
|
-
};
|
3123
|
-
/** @description The definition of a composition's slug settings */
|
3124
|
-
ComponentDefinitionSlugSettings: {
|
3125
|
-
/**
|
3126
|
-
* @description Whether the slug is required
|
3127
|
-
* no: slug is optional
|
3128
|
-
* yes: slug is required
|
3129
|
-
* disabled: slug is disabled and will not be shown in the editor
|
3130
|
-
*
|
3131
|
-
* @default no
|
3132
|
-
* @enum {string}
|
3133
|
-
*/
|
3134
|
-
required?: "no" | "yes" | "disabled";
|
3135
|
-
/**
|
3136
|
-
* @description Slug uniqueness configuration.
|
3137
|
-
* no = no unique constraint
|
3138
|
-
* local = must be unique within this component type
|
3139
|
-
* global = must be unique across all component types
|
3140
|
-
*
|
3141
|
-
* @enum {string}
|
3142
|
-
*/
|
3143
|
-
unique?: "no" | "local" | "global";
|
3144
|
-
/** @description Regular expression slugs must match */
|
3145
|
-
regularExpression?: string;
|
3146
|
-
/**
|
3147
|
-
* @description Custom error message when regular expression validation fails.
|
3148
|
-
* Has no effect if `regularExpression` is not set.
|
3149
|
-
*/
|
3150
|
-
regularExpressionMessage?: string;
|
3151
|
-
};
|
3152
|
-
/** @description The definition of a component variant */
|
3153
|
-
ComponentDefinitionVariant: {
|
3154
|
-
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3155
|
-
/** @description Friendly name of the variant */
|
3156
|
-
name: string;
|
3157
|
-
};
|
3158
|
-
/** @description Permission set for a component defintion */
|
3159
|
-
ComponentDefinitionPermission: {
|
3160
|
-
roleId: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3161
|
-
/**
|
3162
|
-
* @description Permission type for this permission ComponentDefinition:
|
3163
|
-
* read | write | create | delete
|
3164
|
-
*
|
3165
|
-
* @enum {string}
|
3166
|
-
*/
|
3167
|
-
permission: "read" | "write" | "create" | "delete";
|
3168
|
-
/** @description State of the component that this permission applies to */
|
3169
|
-
state: number;
|
3170
|
-
};
|
3171
|
-
/** @description Defines a component type that can live on a Composition */
|
3172
|
-
ComponentDefinition: {
|
3173
|
-
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3174
|
-
/** @description Friendly name of the component definition */
|
3175
|
-
name: string;
|
3176
|
-
/**
|
3177
|
-
* @description Icon name for the component definition (e.g. 'screen')
|
3178
|
-
* @default screen
|
3179
|
-
*/
|
3180
|
-
icon?: string;
|
3181
|
-
/**
|
3182
|
-
* @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
|
3183
|
-
* The parameter type must support being used as a title parameter for this to work.
|
3184
|
-
*
|
3185
|
-
* @default null
|
3186
|
-
*/
|
3187
|
-
titleParameter?: string | null;
|
3188
|
-
/**
|
3189
|
-
* @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
|
3190
|
-
* @default false
|
3191
|
-
*/
|
3192
|
-
canBeComposition?: boolean;
|
3193
|
-
/** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
|
3194
|
-
parameters?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3195
|
-
/**
|
3196
|
-
* Format: uuid
|
3197
|
-
* @description Reference to the category this component definition belongs to
|
3198
|
-
* @default null
|
3199
|
-
*/
|
3200
|
-
categoryId?: string | null;
|
3201
|
-
/**
|
3202
|
-
* @description Description of the component definition
|
3203
|
-
* @default null
|
3204
|
-
*/
|
3205
|
-
description?: string;
|
3206
|
-
/**
|
3207
|
-
* @description Description of the component definition
|
3208
|
-
* @default null
|
3209
|
-
*/
|
3210
|
-
previewImageUrl?: string;
|
3211
|
-
/**
|
3212
|
-
* @description if this component uses team permissions or custom permissions
|
3213
|
-
* @default true
|
3214
|
-
*/
|
3215
|
-
useTeamPermissions?: boolean;
|
3216
|
-
/** @description Custom role permissions for this component definition */
|
3217
|
-
permissions?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
|
3218
|
-
/** @description The named slots for this component; placement areas where arrays of other components can be added. */
|
3219
|
-
slots?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
|
3220
|
-
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3221
|
-
/** @description Default component instance value */
|
3222
|
-
defaults?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
|
3223
|
-
/** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
|
3224
|
-
variants?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
|
3225
|
-
/** @description Created date string for this definition (ignored for writes) */
|
3226
|
-
created?: string;
|
3227
|
-
/** @description Last modified date string for this definition (ignored for writes) */
|
3228
|
-
updated?: string;
|
3229
|
-
};
|
3230
|
-
/** @description Defines a content type */
|
3231
|
-
ContentType: {
|
3232
|
-
id: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
|
3233
|
-
/** @description Friendly name of the content type */
|
3234
|
-
name: string;
|
3235
|
-
/**
|
3236
|
-
* @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.
|
3237
|
-
* The field type must support being used as an entry name for this to work.
|
3238
|
-
*/
|
3239
|
-
entryName?: string | null;
|
3240
|
-
/** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
|
3241
|
-
fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
|
3242
|
-
/**
|
3243
|
-
* @description Description of the content type
|
3244
|
-
* @default null
|
3245
|
-
*/
|
3246
|
-
description?: string;
|
3247
|
-
/**
|
3248
|
-
* @description Icon name for the content type (e.g. 'screen')
|
3249
|
-
* @default file-document
|
3250
|
-
*/
|
3251
|
-
icon?: string;
|
3252
|
-
/** @description Created date string for this content type (ignored for writes) */
|
3253
|
-
created?: string;
|
3254
|
-
/** @description Last modified date string for this content type (ignored for writes) */
|
3255
|
-
updated?: string;
|
3256
|
-
slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
|
3257
|
-
/**
|
3258
|
-
* @description The definition type of this content type (block or content type)
|
3259
|
-
* @default contentType
|
3260
|
-
* @enum {string}
|
3261
|
-
*/
|
3262
|
-
type?: "contentType" | "block";
|
3263
|
-
};
|
3264
|
-
/** @description Defines an editable parameter on a component. */
|
3265
|
-
ComponentParameter: {
|
3266
|
-
/** @description The value of the parameter. Any JSON-serializable value is acceptable. */
|
3267
|
-
value: unknown;
|
3268
|
-
/** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
|
3269
|
-
type: string;
|
3270
|
-
/** @deprecated */
|
3271
|
-
connectedData?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
|
3272
|
-
};
|
3273
|
-
/** @description Defines a connection to a dynamic token on a data resource. */
|
3274
|
-
DataElementConnectionDefinition: {
|
3275
|
-
/** @description A JSON Pointer expression that defines the data resource dynamic token value. */
|
3276
|
-
pointer: string;
|
3277
|
-
/**
|
3278
|
-
* @description The syntax used to select the dynamic token to bind to
|
3279
|
-
* @enum {string}
|
3280
|
-
*/
|
3281
|
-
syntax: "jptr";
|
3282
|
-
};
|
3283
|
-
/** @description Defines the shape of a component instance served by the composition API. */
|
3284
|
-
ComponentInstance: {
|
3285
|
-
/** @description Type of the component instance (public_id of its definition) */
|
3286
|
-
type: string;
|
3287
|
-
/** @description Component parameter values for the component instance */
|
3288
|
-
parameters?: {
|
3289
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3290
|
-
};
|
3291
|
-
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3292
|
-
variant?: string;
|
3293
|
-
/** @description Slots containing any child components */
|
3294
|
-
slots?: {
|
3295
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3296
|
-
};
|
3297
|
-
/**
|
3298
|
-
* @description Unique identifier of the component within the composition.
|
3299
|
-
* No assumptions should be made about the format of this value other than "it will be unique."
|
3300
|
-
* This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
|
3301
|
-
* When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
|
3302
|
-
*/
|
3303
|
-
_id?: string;
|
3304
|
-
/** @description Indicates this component instance should be sourced from a pattern library pattern. */
|
3305
|
-
_pattern?: string;
|
3306
|
-
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3307
|
-
/**
|
3308
|
-
* @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
|
3309
|
-
* Means nothing for PUTs; it will be ignored.
|
3310
|
-
*/
|
3311
|
-
_patternDataResources?: {
|
3312
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3313
|
-
};
|
3314
|
-
/**
|
3315
|
-
* @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
|
3316
|
-
* CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
|
3317
|
-
* NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
|
3318
|
-
* Means nothing for PUTs; it will be ignored.
|
3319
|
-
*
|
3320
|
-
* @enum {string}
|
3321
|
-
*/
|
3322
|
-
_patternError?: "NOTFOUND" | "CYCLIC";
|
3323
|
-
/**
|
3324
|
-
* @description Defines patch overrides to component IDs that live in the composition.
|
3325
|
-
* This can be used to override parameters that are defined on patterns,
|
3326
|
-
* including nested patterns, with values that are specific to this composition.
|
3327
|
-
* The keys in this object are component IDs.
|
3328
|
-
* Overrides are applied from the top down, so for example if both the composition
|
3329
|
-
* and a pattern on the composition define an override on a nested pattern,
|
3330
|
-
* the composition's override replaces the pattern's.
|
3331
|
-
*
|
3332
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3333
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3334
|
-
*/
|
3335
|
-
_overrides?: {
|
3336
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3337
|
-
};
|
3338
|
-
/**
|
3339
|
-
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3340
|
-
* by consumers of the pattern.
|
3341
|
-
*
|
3342
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3343
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3344
|
-
*/
|
3345
|
-
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3346
|
-
};
|
3347
|
-
/** @description Defines the shape of the root component in a composition */
|
3348
|
-
RootComponentInstance: {
|
3349
|
-
/** @description Type of the component instance (public_id of its definition) */
|
3350
|
-
type: string;
|
3351
|
-
/** @description Component parameter values for the component instance */
|
3352
|
-
parameters?: {
|
3353
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3354
|
-
};
|
3355
|
-
/** @description Public ID of alternate visual appearance for this component, if any selected */
|
3356
|
-
variant?: string;
|
3357
|
-
/** @description Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated. */
|
3358
|
-
projectMapNodes?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
|
3359
|
-
/** @description Slots containing any child components */
|
3360
|
-
slots?: {
|
3361
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
|
3362
|
-
};
|
3363
|
-
/** @description The public UUID of the composition. */
|
3364
|
-
_id: string;
|
3365
|
-
/** @description Slug pattern of this component. */
|
3366
|
-
_slug?: string | null;
|
3367
|
-
/** @description Friendly name of this component. */
|
3368
|
-
_name: string;
|
3369
|
-
_dataResources?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
|
3370
|
-
/**
|
3371
|
-
* @description Defines patch overrides to component IDs that live in the composition.
|
3372
|
-
* This can be used to override parameters that are defined on patterns,
|
3373
|
-
* including nested patterns, with values that are specific to this composition.
|
3374
|
-
* The keys in this object are component IDs.
|
3375
|
-
* Overrides are applied from the top down, so for example if both the composition
|
3376
|
-
* and a pattern on the composition define an override on a nested pattern,
|
3377
|
-
* the composition's override replaces the pattern's.
|
3378
|
-
*
|
3379
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3380
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3381
|
-
*/
|
3382
|
-
_overrides?: {
|
3383
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
|
3384
|
-
};
|
3385
|
-
/**
|
3386
|
-
* @description When used on a pattern, defines how the pattern's parameters may be overridden
|
3387
|
-
* by consumers of the pattern.
|
3388
|
-
*
|
3389
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3390
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3391
|
-
*/
|
3392
|
-
_overridability?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
|
3393
|
-
};
|
3394
|
-
/**
|
3395
|
-
* @description Defines how to override a specific component.
|
3396
|
-
*
|
3397
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3398
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3399
|
-
*/
|
3400
|
-
ComponentOverride: {
|
3401
|
-
parameters?: {
|
3402
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
|
3403
|
-
};
|
3404
|
-
variant?: string;
|
3405
|
-
};
|
3406
|
-
/**
|
3407
|
-
* @description Defines how a component on a pattern may have its values overridden.
|
3408
|
-
* NOTE: Data resources' overridability is defined in the data resource definition, not here.
|
3409
|
-
*
|
3410
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3411
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3412
|
-
*/
|
3413
|
-
ComponentOverridability: {
|
3414
|
-
/** @description Defines component parameter value overrides. Keys are the parameter public ID. */
|
3415
|
-
parameters?: {
|
3416
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
|
3417
|
-
};
|
3418
|
-
/** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
|
3419
|
-
variants?: boolean;
|
3420
|
-
};
|
3421
|
-
/**
|
3422
|
-
* @description Whether a parameter is overridable
|
3423
|
-
*
|
3424
|
-
* NOTE: This is considered an internal data structure and is not guaranteed to be stable.
|
3425
|
-
* Future updates that do not break the overrides-applied state of a composition may be made without notice.
|
3426
|
-
*
|
3427
|
-
* @enum {string}
|
3428
|
-
*/
|
3429
|
-
OverrideOptions: "yes" | "no";
|
3430
|
-
/**
|
3431
|
-
* @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
|
3432
|
-
* These are created in the UI and shared across a whole project.
|
3433
|
-
* NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
|
3434
|
-
* for all header, parameter, and variable values to obscure the actual encrypted secret value.
|
3435
|
-
*/
|
3436
|
-
DataSource: {
|
3437
|
-
/** @description Public ID of the data source */
|
3438
|
-
id: string;
|
3439
|
-
/** @description Display name of the data source */
|
3440
|
-
displayName: string;
|
3441
|
-
/** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
|
3442
|
-
connectorType: string;
|
3443
|
-
/** @description Base resource URL of the data source. No trailing slash. */
|
3444
|
-
baseUrl: string;
|
3445
|
-
/** @description HTTP headers to pass with requests to the data source */
|
3446
|
-
headers?: {
|
3447
|
-
key: string;
|
3448
|
-
value: string;
|
3449
|
-
}[];
|
3450
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3451
|
-
parameters?: {
|
3452
|
-
key: string;
|
3453
|
-
value: string;
|
3454
|
-
}[];
|
3455
|
-
/** @description Variables needed to make calls to the data source */
|
3456
|
-
variables?: {
|
3457
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
3458
|
-
};
|
3459
|
-
/** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
|
3460
|
-
custom?: {
|
3461
|
-
[key: string]: unknown;
|
3462
|
-
};
|
3463
|
-
};
|
3464
|
-
/** @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. */
|
3465
|
-
DataType: {
|
3466
|
-
/** @description Public ID of the data type */
|
3467
|
-
id: string;
|
3468
|
-
/** @description Display name of the data type */
|
3469
|
-
displayName: string;
|
3470
|
-
/** @description Public ID of the associated data source */
|
3471
|
-
dataSourceId: string;
|
3472
|
-
/**
|
3473
|
-
* @description A connector-specific archetype for this data type; used to select UI as well as perform any
|
3474
|
-
* necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
|
3475
|
-
* no special UI or processing is required.
|
3476
|
-
*/
|
3477
|
-
archetype?: string;
|
3478
|
-
allowedOnComponents?: string[];
|
3479
|
-
/** @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. */
|
3480
|
-
path: string;
|
3481
|
-
/** @description Time-to-live (in seconds) for the resource data cache. */
|
3482
|
-
ttl?: number;
|
3483
|
-
/** @description A key for the resource data cache purging. */
|
3484
|
-
purgeKey?: string;
|
3485
|
-
/** @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. */
|
3486
|
-
badgeIconUrl?: string;
|
3487
|
-
/** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
|
3488
|
-
headers?: {
|
3489
|
-
key: string;
|
3490
|
-
value: string;
|
3491
|
-
omitIfEmpty?: boolean;
|
3492
|
-
}[];
|
3493
|
-
/** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
|
3494
|
-
parameters?: {
|
3495
|
-
key: string;
|
3496
|
-
value: string;
|
3497
|
-
omitIfEmpty?: boolean;
|
3498
|
-
}[];
|
3499
|
-
/** @description Body to pass with requests to the data type (ignored unless method is POST) */
|
3500
|
-
body?: string;
|
3501
|
-
/**
|
3502
|
-
* @description HTTP method to use with requests to the data type.
|
3503
|
-
* @default GET
|
3504
|
-
* @enum {string}
|
3505
|
-
*/
|
3506
|
-
method: "GET" | "POST" | "HEAD";
|
3507
|
-
/** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
|
3508
|
-
variables?: {
|
3509
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
|
3510
|
-
};
|
3511
|
-
/** @description Custom configuration specific to the data source being defined */
|
3512
|
-
custom?: {
|
3513
|
-
[key: string]: unknown;
|
3514
|
-
};
|
3515
|
-
};
|
3516
|
-
/** @description Defines the shape of a data variable on a Data Source or Data Type */
|
3517
|
-
DataVariableDefinition: {
|
3518
|
-
/** @description Display name of the data variable */
|
3519
|
-
displayName?: string;
|
3520
|
-
/** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
|
3521
|
-
helpText?: string;
|
3522
|
-
/**
|
3523
|
-
* @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.
|
3524
|
-
* @default text
|
3525
|
-
*/
|
3526
|
-
type?: string;
|
3527
|
-
/** @description Default value of the data variable */
|
3528
|
-
default: string;
|
3529
|
-
/** @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. */
|
3530
|
-
order?: number;
|
3531
|
-
/**
|
3532
|
-
* @description An optional arbitrary human readable source identifier to describe where this variable is from.
|
3533
|
-
* Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
|
3534
|
-
*/
|
3535
|
-
source?: string;
|
3536
|
-
};
|
3537
|
-
/**
|
3538
|
-
* @description Data definitions attached to this component. The property name is the key of the data in the data document.
|
3539
|
-
* Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
|
3540
|
-
*/
|
3541
|
-
DataResourceDefinitions: {
|
3542
|
-
[key: string]: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
|
3543
|
-
};
|
3544
|
-
/** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
|
3545
|
-
DataResourceDefinition: {
|
3546
|
-
/** @description Public ID of the data type that provides this data */
|
3547
|
-
type: string;
|
3548
|
-
/** @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. */
|
3549
|
-
isPatternParameter?: boolean;
|
3550
|
-
/**
|
3551
|
-
* @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
|
3552
|
-
* Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
|
3553
|
-
* If isPatternParameter is false or undefined, this has no meaning.
|
3554
|
-
*/
|
3555
|
-
ignorePatternParameterDefault?: boolean;
|
3556
|
-
variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
|
3557
|
-
};
|
3558
|
-
/** @description Variable values for a data resource. */
|
3559
|
-
DataResourceVariables: {
|
3560
|
-
[key: string]: string;
|
3561
|
-
};
|
3562
|
-
HistoryApiResponse: {
|
3563
|
-
/**
|
3564
|
-
* @description If there are more results, this will be populated with a token to pass in the next request to get the next page of results.
|
3565
|
-
* If this is undefined then no more results are available.
|
3566
|
-
*/
|
3567
|
-
cursor?: string;
|
3568
|
-
/** @description If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
|
3569
|
-
truncated?: boolean;
|
3570
|
-
/** @description Version history entries. */
|
3571
|
-
results?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryEntry"][];
|
3572
|
-
};
|
3573
|
-
HistoryEntry: {
|
3574
|
-
/** @description The version ID of the entity. This can be used to fetch the version's data via the entity API. */
|
3575
|
-
versionId: string;
|
3576
|
-
/** @description The timestamp when the version was created in epoch milliseconds. */
|
3577
|
-
timestamp: number;
|
3578
|
-
/** @description The name (full name) of the user who created the version. */
|
3579
|
-
authorName: string;
|
3580
|
-
authorIsApiKey: boolean;
|
3581
|
-
/** @description The state of the entity when the history entry was made. */
|
3582
|
-
state: number;
|
3583
|
-
};
|
3584
|
-
/** @description Category for tagging canvas entities */
|
3585
|
-
Category: {
|
3586
|
-
/**
|
3587
|
-
* Format: uuid
|
3588
|
-
* @description Unique identifier for the category
|
3589
|
-
*/
|
3590
|
-
id: string;
|
3591
|
-
/** @description Display name of the category */
|
3592
|
-
name: string;
|
3593
|
-
/**
|
3594
|
-
* @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.
|
3595
|
-
* @default 0
|
3596
|
-
*/
|
3597
|
-
order?: number;
|
3598
|
-
};
|
3599
|
-
/** @description Project map node information related to a component. */
|
3600
|
-
CompositionProjectMapNodeInfo: {
|
3601
|
-
/**
|
3602
|
-
* Format: uuid
|
3603
|
-
* @description Unique identifier for the project map node
|
3604
|
-
*/
|
3605
|
-
id: string;
|
3606
|
-
/** @description Path of the project map node */
|
3607
|
-
path: string;
|
3608
|
-
/**
|
3609
|
-
* Format: uuid
|
3610
|
-
* @description Unique identifier for the project map that this node belongs to.
|
3611
|
-
*/
|
3612
|
-
projectMapId: string;
|
3613
|
-
};
|
3614
|
-
/** @description AI Prompt definition. */
|
3615
|
-
Prompt: {
|
3616
|
-
/**
|
3617
|
-
* Format: uuid
|
3618
|
-
* @description Unique identifier for the prompt
|
3619
|
-
*/
|
3620
|
-
id: string;
|
3621
|
-
/** @description Unique identifier for the integration that this prompt belongs to. */
|
3622
|
-
integrationType: string;
|
3623
|
-
/** @description Name for the prompt */
|
3624
|
-
promptName?: string | null;
|
3625
|
-
/** @description Text for the prompt */
|
3626
|
-
promptText?: string | null;
|
3627
|
-
/** @description Data for the prompt */
|
3628
|
-
promptData?: string | null;
|
3629
|
-
/** @description Turn off/on prompt */
|
3630
|
-
enabled?: boolean | null;
|
3631
|
-
/** @description Integration default prompt */
|
3632
|
-
builtIn?: boolean | null;
|
3633
|
-
};
|
3634
|
-
};
|
3635
|
-
};
|
3636
|
-
operations: {};
|
3637
|
-
};
|
3638
|
-
}
|
3639
|
-
|
3640
|
-
/**
|
3641
|
-
* This file was auto-generated by openapi-typescript.
|
3642
|
-
* Do not make direct changes to the file.
|
3643
|
-
*/
|
3644
|
-
interface paths$a {
|
3645
|
-
"/api/v1/entries-history": {
|
3646
|
-
get: {
|
3647
|
-
parameters: {
|
3648
|
-
query: {
|
3649
|
-
/** Specify the entry ID to get history for */
|
3650
|
-
entryId: string;
|
3651
|
-
/** The project the entries(s) are on. */
|
3652
|
-
projectId: string;
|
3653
|
-
/** If a request returns a cursor, pass it in this query parameter to get the next page of results. */
|
3654
|
-
cursor?: string;
|
3655
|
-
};
|
3656
|
-
};
|
3657
|
-
responses: {
|
3658
|
-
/** OK */
|
3659
|
-
200: {
|
3660
|
-
content: {
|
3661
|
-
"application/json": external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryApiResponse"];
|
3662
|
-
};
|
3663
|
-
};
|
3664
|
-
400: external$b["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
3665
|
-
401: external$b["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
3666
|
-
403: external$b["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
3667
|
-
/** Entry not found */
|
3668
|
-
404: {
|
3669
|
-
content: {
|
3670
|
-
"text/plain": string;
|
3671
|
-
};
|
3672
|
-
};
|
3673
|
-
429: external$b["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
3674
|
-
500: external$b["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
3675
|
-
};
|
3676
|
-
};
|
3043
|
+
*/
|
3044
|
+
withTotalCount: boolean;
|
3045
|
+
/** @description Performs keyword search on the entries. */
|
3046
|
+
keyword: string;
|
3677
3047
|
};
|
3678
3048
|
}
|
3679
3049
|
interface external$b {
|
@@ -4267,15 +3637,19 @@ interface external$b {
|
|
4267
3637
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
4268
3638
|
integrationType: string;
|
4269
3639
|
/** @description Name for the prompt */
|
4270
|
-
|
3640
|
+
name?: string | null;
|
4271
3641
|
/** @description Text for the prompt */
|
4272
|
-
|
3642
|
+
text?: string | null;
|
4273
3643
|
/** @description Data for the prompt */
|
4274
|
-
|
3644
|
+
data?: {
|
3645
|
+
[key: string]: unknown;
|
3646
|
+
} | null;
|
4275
3647
|
/** @description Turn off/on prompt */
|
4276
3648
|
enabled?: boolean | null;
|
4277
3649
|
/** @description Integration default prompt */
|
4278
3650
|
builtIn?: boolean | null;
|
3651
|
+
/** @description Supported parameter types */
|
3652
|
+
parameterTypes?: string[] | null;
|
4279
3653
|
};
|
4280
3654
|
};
|
4281
3655
|
};
|
@@ -4283,100 +3657,42 @@ interface external$b {
|
|
4283
3657
|
};
|
4284
3658
|
}
|
4285
3659
|
|
4286
|
-
type HistoryApi$1 = paths$a['/api/v1/entries-history'];
|
4287
|
-
type ContentType = components$4['schemas']['ContentType'];
|
4288
|
-
type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
|
4289
|
-
type GetContentTypesOptions = paths$c['/api/v1/content-types']['get']['parameters']['query'];
|
4290
|
-
type DeleteContentTypeOptions = paths$c['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
|
4291
|
-
type PutContentTypeBody = paths$c['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
4292
|
-
type GetContentTypesResponse = paths$c['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
4293
|
-
type Entry = components$3['schemas']['EntryApiResponse'];
|
4294
|
-
type EntryData = Entry['entry'];
|
4295
|
-
type GetEntriesOptions = paths$b['/api/v1/entries']['get']['parameters']['query'];
|
4296
|
-
type GetEntriesResponse = paths$b['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
4297
|
-
type DeleteEntryOptions = paths$b['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
4298
|
-
type PutEntryBody = paths$b['/api/v1/entries']['put']['requestBody']['content']['application/json'];
|
4299
|
-
/** The GET response from /api/v1/entries-history (history for one entry) */
|
4300
|
-
type EntriesHistoryGetParameters = HistoryApi$1['get']['parameters']['query'];
|
4301
|
-
/** The GET response from /api/v1/entries-history */
|
4302
|
-
type EntriesHistoryGetResponse = components$4['schemas']['HistoryApiResponse'];
|
4303
|
-
|
4304
3660
|
/**
|
4305
3661
|
* This file was auto-generated by openapi-typescript.
|
4306
3662
|
* Do not make direct changes to the file.
|
4307
3663
|
*/
|
4308
3664
|
interface paths$9 {
|
4309
|
-
"/api/v1/
|
3665
|
+
"/api/v1/entries-history": {
|
4310
3666
|
get: {
|
4311
3667
|
parameters: {
|
4312
3668
|
query: {
|
4313
|
-
|
3669
|
+
/** Specify the entry ID to get history for */
|
3670
|
+
entryId: string;
|
3671
|
+
/** The project the entries(s) are on. */
|
4314
3672
|
projectId: string;
|
3673
|
+
/** If a request returns a cursor, pass it in this query parameter to get the next page of results. */
|
3674
|
+
cursor?: string;
|
4315
3675
|
};
|
4316
3676
|
};
|
4317
3677
|
responses: {
|
4318
3678
|
/** OK */
|
4319
3679
|
200: {
|
4320
3680
|
content: {
|
4321
|
-
"application/json":
|
4322
|
-
result: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
4323
|
-
};
|
3681
|
+
"application/json": external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["HistoryApiResponse"];
|
4324
3682
|
};
|
4325
3683
|
};
|
4326
3684
|
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
4327
3685
|
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
4328
3686
|
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
4329
|
-
|
4330
|
-
|
4331
|
-
|
4332
|
-
|
4333
|
-
put: {
|
4334
|
-
responses: {
|
4335
|
-
/** OK */
|
4336
|
-
204: never;
|
4337
|
-
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
4338
|
-
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
4339
|
-
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
4340
|
-
429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
4341
|
-
500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4342
|
-
};
|
4343
|
-
requestBody: {
|
4344
|
-
content: {
|
4345
|
-
"application/json": {
|
4346
|
-
data: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
4347
|
-
/** Format: uuid */
|
4348
|
-
projectId: string;
|
4349
|
-
/**
|
4350
|
-
* Format: uuid
|
4351
|
-
* @deprecated
|
4352
|
-
* @description Do not use. May be removed in future.
|
4353
|
-
*/
|
4354
|
-
integrationId?: string;
|
4355
|
-
/** @description The integration type that the data source is attached to. Must be installed in the project. */
|
4356
|
-
integrationType?: string;
|
3687
|
+
/** Entry not found */
|
3688
|
+
404: {
|
3689
|
+
content: {
|
3690
|
+
"text/plain": string;
|
4357
3691
|
};
|
4358
3692
|
};
|
4359
|
-
};
|
4360
|
-
};
|
4361
|
-
delete: {
|
4362
|
-
responses: {
|
4363
|
-
/** OK */
|
4364
|
-
204: never;
|
4365
|
-
400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
4366
|
-
401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
4367
|
-
403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
4368
3693
|
429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
4369
3694
|
500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4370
3695
|
};
|
4371
|
-
requestBody: {
|
4372
|
-
content: {
|
4373
|
-
"application/json": {
|
4374
|
-
dataSourceId: string;
|
4375
|
-
/** Format: uuid */
|
4376
|
-
projectId: string;
|
4377
|
-
};
|
4378
|
-
};
|
4379
|
-
};
|
4380
3696
|
};
|
4381
3697
|
};
|
4382
3698
|
}
|
@@ -4971,15 +4287,19 @@ interface external$a {
|
|
4971
4287
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
4972
4288
|
integrationType: string;
|
4973
4289
|
/** @description Name for the prompt */
|
4974
|
-
|
4290
|
+
name?: string | null;
|
4975
4291
|
/** @description Text for the prompt */
|
4976
|
-
|
4292
|
+
text?: string | null;
|
4977
4293
|
/** @description Data for the prompt */
|
4978
|
-
|
4294
|
+
data?: {
|
4295
|
+
[key: string]: unknown;
|
4296
|
+
} | null;
|
4979
4297
|
/** @description Turn off/on prompt */
|
4980
4298
|
enabled?: boolean | null;
|
4981
4299
|
/** @description Integration default prompt */
|
4982
4300
|
builtIn?: boolean | null;
|
4301
|
+
/** @description Supported parameter types */
|
4302
|
+
parameterTypes?: string[] | null;
|
4983
4303
|
};
|
4984
4304
|
};
|
4985
4305
|
};
|
@@ -4987,29 +4307,43 @@ interface external$a {
|
|
4987
4307
|
};
|
4988
4308
|
}
|
4989
4309
|
|
4310
|
+
type HistoryApi$1 = paths$9['/api/v1/entries-history'];
|
4311
|
+
type ContentType = components$4['schemas']['ContentType'];
|
4312
|
+
type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
|
4313
|
+
type GetContentTypesOptions = paths$b['/api/v1/content-types']['get']['parameters']['query'];
|
4314
|
+
type DeleteContentTypeOptions = paths$b['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
|
4315
|
+
type PutContentTypeBody = paths$b['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
|
4316
|
+
type GetContentTypesResponse = paths$b['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
|
4317
|
+
type Entry = components$3['schemas']['EntryApiResponse'];
|
4318
|
+
type EntryData = Entry['entry'];
|
4319
|
+
type GetEntriesOptions = paths$a['/api/v1/entries']['get']['parameters']['query'];
|
4320
|
+
type GetEntriesResponse = paths$a['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
|
4321
|
+
type DeleteEntryOptions = paths$a['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
|
4322
|
+
type PutEntryBody = paths$a['/api/v1/entries']['put']['requestBody']['content']['application/json'];
|
4323
|
+
/** The GET response from /api/v1/entries-history (history for one entry) */
|
4324
|
+
type EntriesHistoryGetParameters = HistoryApi$1['get']['parameters']['query'];
|
4325
|
+
/** The GET response from /api/v1/entries-history */
|
4326
|
+
type EntriesHistoryGetResponse = components$4['schemas']['HistoryApiResponse'];
|
4327
|
+
|
4990
4328
|
/**
|
4991
4329
|
* This file was auto-generated by openapi-typescript.
|
4992
4330
|
* Do not make direct changes to the file.
|
4993
4331
|
*/
|
4994
4332
|
interface paths$8 {
|
4995
|
-
"/api/v1/data-
|
4333
|
+
"/api/v1/data-source": {
|
4996
4334
|
get: {
|
4997
4335
|
parameters: {
|
4998
4336
|
query: {
|
4337
|
+
dataSourceId: string;
|
4999
4338
|
projectId: string;
|
5000
4339
|
};
|
5001
4340
|
};
|
5002
4341
|
responses: {
|
5003
|
-
/**
|
5004
|
-
* Gets a list of data sources.
|
5005
|
-
* Note that all parameters, headers, and variables will have the value 'SECRET', as this endpoint
|
5006
|
-
* requires minimal permissions. To decrypt secrets, you must be an admin or manage-data-sources privileged
|
5007
|
-
* user, and fetch using the `data-source` endpoint for each data source.
|
5008
|
-
*/
|
4342
|
+
/** OK */
|
5009
4343
|
200: {
|
5010
4344
|
content: {
|
5011
4345
|
"application/json": {
|
5012
|
-
|
4346
|
+
result: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
5013
4347
|
};
|
5014
4348
|
};
|
5015
4349
|
};
|
@@ -5020,6 +4354,54 @@ interface paths$8 {
|
|
5020
4354
|
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
5021
4355
|
};
|
5022
4356
|
};
|
4357
|
+
put: {
|
4358
|
+
responses: {
|
4359
|
+
/** OK */
|
4360
|
+
204: never;
|
4361
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
4362
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
4363
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
4364
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
4365
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4366
|
+
};
|
4367
|
+
requestBody: {
|
4368
|
+
content: {
|
4369
|
+
"application/json": {
|
4370
|
+
data: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
|
4371
|
+
/** Format: uuid */
|
4372
|
+
projectId: string;
|
4373
|
+
/**
|
4374
|
+
* Format: uuid
|
4375
|
+
* @deprecated
|
4376
|
+
* @description Do not use. May be removed in future.
|
4377
|
+
*/
|
4378
|
+
integrationId?: string;
|
4379
|
+
/** @description The integration type that the data source is attached to. Must be installed in the project. */
|
4380
|
+
integrationType?: string;
|
4381
|
+
};
|
4382
|
+
};
|
4383
|
+
};
|
4384
|
+
};
|
4385
|
+
delete: {
|
4386
|
+
responses: {
|
4387
|
+
/** OK */
|
4388
|
+
204: never;
|
4389
|
+
400: external$9["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
4390
|
+
401: external$9["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
4391
|
+
403: external$9["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
4392
|
+
429: external$9["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
4393
|
+
500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
4394
|
+
};
|
4395
|
+
requestBody: {
|
4396
|
+
content: {
|
4397
|
+
"application/json": {
|
4398
|
+
dataSourceId: string;
|
4399
|
+
/** Format: uuid */
|
4400
|
+
projectId: string;
|
4401
|
+
};
|
4402
|
+
};
|
4403
|
+
};
|
4404
|
+
};
|
5023
4405
|
};
|
5024
4406
|
}
|
5025
4407
|
interface external$9 {
|
@@ -5613,15 +4995,19 @@ interface external$9 {
|
|
5613
4995
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
5614
4996
|
integrationType: string;
|
5615
4997
|
/** @description Name for the prompt */
|
5616
|
-
|
4998
|
+
name?: string | null;
|
5617
4999
|
/** @description Text for the prompt */
|
5618
|
-
|
5000
|
+
text?: string | null;
|
5619
5001
|
/** @description Data for the prompt */
|
5620
|
-
|
5002
|
+
data?: {
|
5003
|
+
[key: string]: unknown;
|
5004
|
+
} | null;
|
5621
5005
|
/** @description Turn off/on prompt */
|
5622
5006
|
enabled?: boolean | null;
|
5623
5007
|
/** @description Integration default prompt */
|
5624
5008
|
builtIn?: boolean | null;
|
5009
|
+
/** @description Supported parameter types */
|
5010
|
+
parameterTypes?: string[] | null;
|
5625
5011
|
};
|
5626
5012
|
};
|
5627
5013
|
};
|
@@ -5634,7 +5020,7 @@ interface external$9 {
|
|
5634
5020
|
* Do not make direct changes to the file.
|
5635
5021
|
*/
|
5636
5022
|
interface paths$7 {
|
5637
|
-
"/api/v1/data-
|
5023
|
+
"/api/v1/data-sources": {
|
5638
5024
|
get: {
|
5639
5025
|
parameters: {
|
5640
5026
|
query: {
|
@@ -5642,11 +5028,16 @@ interface paths$7 {
|
|
5642
5028
|
};
|
5643
5029
|
};
|
5644
5030
|
responses: {
|
5645
|
-
/**
|
5031
|
+
/**
|
5032
|
+
* Gets a list of data sources.
|
5033
|
+
* Note that all parameters, headers, and variables will have the value 'SECRET', as this endpoint
|
5034
|
+
* requires minimal permissions. To decrypt secrets, you must be an admin or manage-data-sources privileged
|
5035
|
+
* user, and fetch using the `data-source` endpoint for each data source.
|
5036
|
+
*/
|
5646
5037
|
200: {
|
5647
5038
|
content: {
|
5648
5039
|
"application/json": {
|
5649
|
-
results: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
5040
|
+
results: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"][];
|
5650
5041
|
};
|
5651
5042
|
};
|
5652
5043
|
};
|
@@ -5657,46 +5048,6 @@ interface paths$7 {
|
|
5657
5048
|
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
5658
5049
|
};
|
5659
5050
|
};
|
5660
|
-
put: {
|
5661
|
-
responses: {
|
5662
|
-
/** OK */
|
5663
|
-
204: never;
|
5664
|
-
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
5665
|
-
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
5666
|
-
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
5667
|
-
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
5668
|
-
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
5669
|
-
};
|
5670
|
-
requestBody: {
|
5671
|
-
content: {
|
5672
|
-
"application/json": {
|
5673
|
-
data: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
|
5674
|
-
/** Format: uuid */
|
5675
|
-
projectId: string;
|
5676
|
-
};
|
5677
|
-
};
|
5678
|
-
};
|
5679
|
-
};
|
5680
|
-
delete: {
|
5681
|
-
responses: {
|
5682
|
-
/** OK */
|
5683
|
-
204: never;
|
5684
|
-
400: external$8["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
5685
|
-
401: external$8["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
5686
|
-
403: external$8["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
5687
|
-
429: external$8["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
5688
|
-
500: external$8["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
5689
|
-
};
|
5690
|
-
requestBody: {
|
5691
|
-
content: {
|
5692
|
-
"application/json": {
|
5693
|
-
typeId: string;
|
5694
|
-
/** Format: uuid */
|
5695
|
-
projectId: string;
|
5696
|
-
};
|
5697
|
-
};
|
5698
|
-
};
|
5699
|
-
};
|
5700
5051
|
};
|
5701
5052
|
}
|
5702
5053
|
interface external$8 {
|
@@ -6290,15 +5641,19 @@ interface external$8 {
|
|
6290
5641
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
6291
5642
|
integrationType: string;
|
6292
5643
|
/** @description Name for the prompt */
|
6293
|
-
|
5644
|
+
name?: string | null;
|
6294
5645
|
/** @description Text for the prompt */
|
6295
|
-
|
5646
|
+
text?: string | null;
|
6296
5647
|
/** @description Data for the prompt */
|
6297
|
-
|
5648
|
+
data?: {
|
5649
|
+
[key: string]: unknown;
|
5650
|
+
} | null;
|
6298
5651
|
/** @description Turn off/on prompt */
|
6299
5652
|
enabled?: boolean | null;
|
6300
5653
|
/** @description Integration default prompt */
|
6301
5654
|
builtIn?: boolean | null;
|
5655
|
+
/** @description Supported parameter types */
|
5656
|
+
parameterTypes?: string[] | null;
|
6302
5657
|
};
|
6303
5658
|
};
|
6304
5659
|
};
|
@@ -6311,11 +5666,10 @@ interface external$8 {
|
|
6311
5666
|
* Do not make direct changes to the file.
|
6312
5667
|
*/
|
6313
5668
|
interface paths$6 {
|
6314
|
-
"/api/v1/
|
5669
|
+
"/api/v1/data-types": {
|
6315
5670
|
get: {
|
6316
5671
|
parameters: {
|
6317
5672
|
query: {
|
6318
|
-
promptId: string;
|
6319
5673
|
projectId: string;
|
6320
5674
|
};
|
6321
5675
|
};
|
@@ -6324,7 +5678,7 @@ interface paths$6 {
|
|
6324
5678
|
200: {
|
6325
5679
|
content: {
|
6326
5680
|
"application/json": {
|
6327
|
-
|
5681
|
+
results: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"][];
|
6328
5682
|
};
|
6329
5683
|
};
|
6330
5684
|
};
|
@@ -6348,7 +5702,7 @@ interface paths$6 {
|
|
6348
5702
|
requestBody: {
|
6349
5703
|
content: {
|
6350
5704
|
"application/json": {
|
6351
|
-
data: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["
|
5705
|
+
data: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataType"];
|
6352
5706
|
/** Format: uuid */
|
6353
5707
|
projectId: string;
|
6354
5708
|
};
|
@@ -6368,10 +5722,9 @@ interface paths$6 {
|
|
6368
5722
|
requestBody: {
|
6369
5723
|
content: {
|
6370
5724
|
"application/json": {
|
5725
|
+
typeId: string;
|
6371
5726
|
/** Format: uuid */
|
6372
5727
|
projectId: string;
|
6373
|
-
/** Format: uuid */
|
6374
|
-
promptId: string;
|
6375
5728
|
};
|
6376
5729
|
};
|
6377
5730
|
};
|
@@ -6969,15 +6322,19 @@ interface external$7 {
|
|
6969
6322
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
6970
6323
|
integrationType: string;
|
6971
6324
|
/** @description Name for the prompt */
|
6972
|
-
|
6325
|
+
name?: string | null;
|
6973
6326
|
/** @description Text for the prompt */
|
6974
|
-
|
6327
|
+
text?: string | null;
|
6975
6328
|
/** @description Data for the prompt */
|
6976
|
-
|
6329
|
+
data?: {
|
6330
|
+
[key: string]: unknown;
|
6331
|
+
} | null;
|
6977
6332
|
/** @description Turn off/on prompt */
|
6978
6333
|
enabled?: boolean | null;
|
6979
6334
|
/** @description Integration default prompt */
|
6980
6335
|
builtIn?: boolean | null;
|
6336
|
+
/** @description Supported parameter types */
|
6337
|
+
parameterTypes?: string[] | null;
|
6981
6338
|
};
|
6982
6339
|
};
|
6983
6340
|
};
|
@@ -6994,24 +6351,64 @@ interface paths$5 {
|
|
6994
6351
|
get: {
|
6995
6352
|
parameters: {
|
6996
6353
|
query: {
|
6354
|
+
promptId?: string;
|
6997
6355
|
projectId: string;
|
6998
6356
|
};
|
6999
6357
|
};
|
7000
6358
|
responses: {
|
7001
|
-
/**
|
6359
|
+
/** OK */
|
7002
6360
|
200: {
|
7003
6361
|
content: {
|
7004
|
-
"application/json":
|
7005
|
-
|
7006
|
-
|
6362
|
+
"application/json": external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"] | external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"][];
|
6363
|
+
};
|
6364
|
+
};
|
6365
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
6366
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
6367
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
6368
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
6369
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
6370
|
+
};
|
6371
|
+
};
|
6372
|
+
put: {
|
6373
|
+
responses: {
|
6374
|
+
/** OK */
|
6375
|
+
204: never;
|
6376
|
+
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
6377
|
+
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
6378
|
+
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
6379
|
+
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
6380
|
+
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
6381
|
+
};
|
6382
|
+
requestBody: {
|
6383
|
+
content: {
|
6384
|
+
"application/json": {
|
6385
|
+
data: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Prompt"];
|
6386
|
+
/** Format: uuid */
|
6387
|
+
projectId: string;
|
7007
6388
|
};
|
7008
6389
|
};
|
6390
|
+
};
|
6391
|
+
};
|
6392
|
+
delete: {
|
6393
|
+
responses: {
|
6394
|
+
/** OK */
|
6395
|
+
204: never;
|
7009
6396
|
400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
|
7010
6397
|
401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
|
7011
6398
|
403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
|
7012
6399
|
429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
|
7013
6400
|
500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
|
7014
6401
|
};
|
6402
|
+
requestBody: {
|
6403
|
+
content: {
|
6404
|
+
"application/json": {
|
6405
|
+
/** Format: uuid */
|
6406
|
+
projectId: string;
|
6407
|
+
/** Format: uuid */
|
6408
|
+
promptId: string;
|
6409
|
+
};
|
6410
|
+
};
|
6411
|
+
};
|
7015
6412
|
};
|
7016
6413
|
};
|
7017
6414
|
}
|
@@ -7606,15 +7003,19 @@ interface external$6 {
|
|
7606
7003
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
7607
7004
|
integrationType: string;
|
7608
7005
|
/** @description Name for the prompt */
|
7609
|
-
|
7006
|
+
name?: string | null;
|
7610
7007
|
/** @description Text for the prompt */
|
7611
|
-
|
7008
|
+
text?: string | null;
|
7612
7009
|
/** @description Data for the prompt */
|
7613
|
-
|
7010
|
+
data?: {
|
7011
|
+
[key: string]: unknown;
|
7012
|
+
} | null;
|
7614
7013
|
/** @description Turn off/on prompt */
|
7615
7014
|
enabled?: boolean | null;
|
7616
7015
|
/** @description Integration default prompt */
|
7617
7016
|
builtIn?: boolean | null;
|
7017
|
+
/** @description Supported parameter types */
|
7018
|
+
parameterTypes?: string[] | null;
|
7618
7019
|
};
|
7619
7020
|
};
|
7620
7021
|
};
|
@@ -7622,11 +7023,10 @@ interface external$6 {
|
|
7622
7023
|
};
|
7623
7024
|
}
|
7624
7025
|
|
7625
|
-
type PromptApi = paths$6['/api/v1/prompt'];
|
7626
7026
|
type PromptsApi = paths$5['/api/v1/prompts'];
|
7627
|
-
type DataTypeApi = paths$
|
7628
|
-
type DataSourcesApi = paths$
|
7629
|
-
type DataSourceApi = paths$
|
7027
|
+
type DataTypeApi = paths$6['/api/v1/data-types'];
|
7028
|
+
type DataSourcesApi = paths$7['/api/v1/data-sources'];
|
7029
|
+
type DataSourceApi = paths$8['/api/v1/data-source'];
|
7630
7030
|
/** Query parameter options for GET /api/v1/data-types */
|
7631
7031
|
type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
|
7632
7032
|
/** The GET response from /api/v1/data-types */
|
@@ -7647,18 +7047,14 @@ type DataSourcesGetResponse = DataSourcesApi['get']['responses']['200']['content
|
|
7647
7047
|
type DataSourcePutParameters = DataSourceApi['put']['requestBody']['content']['application/json'];
|
7648
7048
|
/** Shape of the DELETE request body for /api/v1/data-source */
|
7649
7049
|
type DataSourceDeleteParameters = DataSourceApi['delete']['requestBody']['content']['application/json'];
|
7650
|
-
/** Query parameter options for GET /api/v1/prompt */
|
7651
|
-
type PromptGetParameters = PromptApi['get']['parameters']['query'];
|
7652
|
-
/** The GET response from /api/v1/prompt */
|
7653
|
-
type PromptGetResponse = PromptApi['get']['responses']['200']['content']['application/json'];
|
7654
|
-
/** The PUT request body for /api/v1/prompt */
|
7655
|
-
type PromptPutParameters = PromptApi['put']['requestBody']['content']['application/json'];
|
7656
|
-
/** Shape of the DELETE request body for /api/v1/prompt */
|
7657
|
-
type PromptDeleteParameters = PromptApi['delete']['requestBody']['content']['application/json'];
|
7658
7050
|
/** Query parameter options for GET /api/v1/prompts */
|
7659
7051
|
type PromptsGetParameters = PromptsApi['get']['parameters']['query'];
|
7660
7052
|
/** The GET response from /api/v1/prompts */
|
7661
7053
|
type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['application/json'];
|
7054
|
+
/** The PUT request body for /api/v1/prompts */
|
7055
|
+
type PromptsPutParameters = PromptsApi['put']['requestBody']['content']['application/json'];
|
7056
|
+
/** Shape of the DELETE request body for /api/v1/prompts */
|
7057
|
+
type PromptsDeleteParameters = PromptsApi['delete']['requestBody']['content']['application/json'];
|
7662
7058
|
type DataType = components$4['schemas']['DataType'];
|
7663
7059
|
type DataSource = components$4['schemas']['DataSource'];
|
7664
7060
|
type DataVariableDefinition = components$4['schemas']['DataVariableDefinition'];
|
@@ -8727,15 +8123,19 @@ interface external$5 {
|
|
8727
8123
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
8728
8124
|
integrationType: string;
|
8729
8125
|
/** @description Name for the prompt */
|
8730
|
-
|
8126
|
+
name?: string | null;
|
8731
8127
|
/** @description Text for the prompt */
|
8732
|
-
|
8128
|
+
text?: string | null;
|
8733
8129
|
/** @description Data for the prompt */
|
8734
|
-
|
8130
|
+
data?: {
|
8131
|
+
[key: string]: unknown;
|
8132
|
+
} | null;
|
8735
8133
|
/** @description Turn off/on prompt */
|
8736
8134
|
enabled?: boolean | null;
|
8737
8135
|
/** @description Integration default prompt */
|
8738
8136
|
builtIn?: boolean | null;
|
8137
|
+
/** @description Supported parameter types */
|
8138
|
+
parameterTypes?: string[] | null;
|
8739
8139
|
};
|
8740
8140
|
};
|
8741
8141
|
};
|
@@ -9373,15 +8773,19 @@ interface external$4 {
|
|
9373
8773
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
9374
8774
|
integrationType: string;
|
9375
8775
|
/** @description Name for the prompt */
|
9376
|
-
|
8776
|
+
name?: string | null;
|
9377
8777
|
/** @description Text for the prompt */
|
9378
|
-
|
8778
|
+
text?: string | null;
|
9379
8779
|
/** @description Data for the prompt */
|
9380
|
-
|
8780
|
+
data?: {
|
8781
|
+
[key: string]: unknown;
|
8782
|
+
} | null;
|
9381
8783
|
/** @description Turn off/on prompt */
|
9382
8784
|
enabled?: boolean | null;
|
9383
8785
|
/** @description Integration default prompt */
|
9384
8786
|
builtIn?: boolean | null;
|
8787
|
+
/** @description Supported parameter types */
|
8788
|
+
parameterTypes?: string[] | null;
|
9385
8789
|
};
|
9386
8790
|
};
|
9387
8791
|
};
|
@@ -10146,15 +9550,19 @@ interface external$3 {
|
|
10146
9550
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
10147
9551
|
integrationType: string;
|
10148
9552
|
/** @description Name for the prompt */
|
10149
|
-
|
9553
|
+
name?: string | null;
|
10150
9554
|
/** @description Text for the prompt */
|
10151
|
-
|
9555
|
+
text?: string | null;
|
10152
9556
|
/** @description Data for the prompt */
|
10153
|
-
|
9557
|
+
data?: {
|
9558
|
+
[key: string]: unknown;
|
9559
|
+
} | null;
|
10154
9560
|
/** @description Turn off/on prompt */
|
10155
9561
|
enabled?: boolean | null;
|
10156
9562
|
/** @description Integration default prompt */
|
10157
9563
|
builtIn?: boolean | null;
|
9564
|
+
/** @description Supported parameter types */
|
9565
|
+
parameterTypes?: string[] | null;
|
10158
9566
|
};
|
10159
9567
|
};
|
10160
9568
|
};
|
@@ -11981,15 +11389,19 @@ interface external$2 {
|
|
11981
11389
|
/** @description Unique identifier for the integration that this prompt belongs to. */
|
11982
11390
|
integrationType: string;
|
11983
11391
|
/** @description Name for the prompt */
|
11984
|
-
|
11392
|
+
name?: string | null;
|
11985
11393
|
/** @description Text for the prompt */
|
11986
|
-
|
11394
|
+
text?: string | null;
|
11987
11395
|
/** @description Data for the prompt */
|
11988
|
-
|
11396
|
+
data?: {
|
11397
|
+
[key: string]: unknown;
|
11398
|
+
} | null;
|
11989
11399
|
/** @description Turn off/on prompt */
|
11990
11400
|
enabled?: boolean | null;
|
11991
11401
|
/** @description Integration default prompt */
|
11992
11402
|
builtIn?: boolean | null;
|
11403
|
+
/** @description Supported parameter types */
|
11404
|
+
parameterTypes?: string[] | null;
|
11993
11405
|
};
|
11994
11406
|
};
|
11995
11407
|
};
|
@@ -12847,7 +12259,7 @@ type RouteGetResponseRedirect = components['schemas']['RouteResponseRedirect'];
|
|
12847
12259
|
type RouteGetResponseNotFound = components['schemas']['RouteResponseNotFound'];
|
12848
12260
|
type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
|
12849
12261
|
/** The GET response from /api/v1/entries */
|
12850
|
-
type EntriesGetParameters = paths$
|
12262
|
+
type EntriesGetParameters = paths$a['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
|
12851
12263
|
type EntriesGetResponse = components$3['schemas']['EntryListResponse'];
|
12852
12264
|
type EntriesResolvedListResponse = components$1['schemas']['EntryResolvedListResponse'];
|
12853
12265
|
/** GET response from uniform.global/api/v1/route when result is a composition */
|
@@ -14028,34 +13440,34 @@ declare function subscribeToComposition({ projectId, compositionId, compositionS
|
|
14028
13440
|
/** API client to make comms with the Next Gen Mesh Data Source API simpler */
|
14029
13441
|
declare class PromptClient extends ApiClient {
|
14030
13442
|
constructor(options: ClientOptions);
|
14031
|
-
/** Fetches
|
14032
|
-
get(options?: ExceptProject<
|
14033
|
-
|
14034
|
-
|
14035
|
-
|
14036
|
-
|
14037
|
-
|
14038
|
-
|
14039
|
-
|
14040
|
-
|
14041
|
-
|
14042
|
-
|
14043
|
-
|
14044
|
-
|
14045
|
-
|
14046
|
-
|
14047
|
-
|
14048
|
-
|
14049
|
-
|
14050
|
-
|
14051
|
-
|
14052
|
-
|
14053
|
-
|
14054
|
-
}>;
|
13443
|
+
/** Fetches Prompts for a project */
|
13444
|
+
get(options?: ExceptProject<PromptsGetParameters>): Promise<{
|
13445
|
+
id: string;
|
13446
|
+
integrationType: string;
|
13447
|
+
name?: string | null | undefined;
|
13448
|
+
text?: string | null | undefined;
|
13449
|
+
data?: {
|
13450
|
+
[key: string]: unknown;
|
13451
|
+
} | null | undefined;
|
13452
|
+
enabled?: boolean | null | undefined;
|
13453
|
+
builtIn?: boolean | null | undefined;
|
13454
|
+
parameterTypes?: string[] | null | undefined;
|
13455
|
+
} | {
|
13456
|
+
id: string;
|
13457
|
+
integrationType: string;
|
13458
|
+
name?: string | null | undefined;
|
13459
|
+
text?: string | null | undefined;
|
13460
|
+
data?: {
|
13461
|
+
[key: string]: unknown;
|
13462
|
+
} | null | undefined;
|
13463
|
+
enabled?: boolean | null | undefined;
|
13464
|
+
builtIn?: boolean | null | undefined;
|
13465
|
+
parameterTypes?: string[] | null | undefined;
|
13466
|
+
}[]>;
|
14055
13467
|
/** Updates or creates (based on id) a Prompt */
|
14056
|
-
upsert(body: ExceptProject<
|
13468
|
+
upsert(body: ExceptProject<PromptsPutParameters>): Promise<void>;
|
14057
13469
|
/** Deletes a Prompt */
|
14058
|
-
remove(body: ExceptProject<
|
13470
|
+
remove(body: ExceptProject<PromptsDeleteParameters>): Promise<void>;
|
14059
13471
|
}
|
14060
13472
|
|
14061
13473
|
type RouteClientOptions = Omit<ClientOptions, 'apiHost'> & {
|
@@ -14331,4 +13743,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
|
|
14331
13743
|
|
14332
13744
|
declare const CanvasClientError: typeof ApiClientError;
|
14333
13745
|
|
14334
|
-
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, EntriesHistoryGetParameters, EntriesHistoryGetResponse, 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,
|
13746
|
+
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, EntriesHistoryGetParameters, EntriesHistoryGetResponse, 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, PromptsDeleteParameters, PromptsGetParameters, PromptsGetResponse, PromptsPutParameters, 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 };
|