@uniformdev/mesh-sdk 20.75.1-alpha.16 → 20.76.2

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.
Files changed (7) hide show
  1. package/dist/index.d.mts +165 -156
  2. package/dist/index.d.ts +165 -156
  3. package/dist/index.esm.js +2 -2
  4. package/dist/index.js +2 -2
  5. package/dist/index.mjs +2 -2
  6. package/dist/server/index.d.mts +1 -1
  7. package/package.json +6 -6
package/dist/index.d.mts CHANGED
@@ -15,7 +15,7 @@ interface paths$2 {
15
15
  };
16
16
  get?: never;
17
17
  put?: never;
18
- /** @description Mints or rotates the credential for an integration definition. Atomic: a successful response invalidates any previously-issued secret of the same kind. The plaintext secret is returned in the response body and cannot be retrieved later. */
18
+ /** Mints or rotates the credential for an integration definition. Atomic: a successful response invalidates any previously-issued secret of the same kind. The plaintext secret is returned in the response body and cannot be retrieved later. */
19
19
  post: {
20
20
  parameters: {
21
21
  query?: never;
@@ -28,24 +28,24 @@ interface paths$2 {
28
28
  "application/json": {
29
29
  /**
30
30
  * Format: uuid
31
- * @description The team ID that owns the integration
31
+ * The team ID that owns the integration
32
32
  */
33
33
  teamId: string;
34
34
  /**
35
35
  * Format: uuid
36
- * @description The integration definition ID to mint or revoke credentials for
36
+ * The integration definition ID to mint or revoke credentials for
37
37
  */
38
38
  integrationDefinitionId: string;
39
39
  /**
40
- * @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
41
- * @enum {string}
40
+ * Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
41
+
42
42
  */
43
43
  kind: "app_secret";
44
44
  };
45
45
  };
46
46
  };
47
47
  responses: {
48
- /** @description Credential minted or rotated. */
48
+ /** Credential minted or rotated. */
49
49
  200: {
50
50
  headers: {
51
51
  [name: string]: unknown;
@@ -53,15 +53,15 @@ interface paths$2 {
53
53
  content: {
54
54
  "application/json": {
55
55
  /**
56
- * @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
57
- * @enum {string}
56
+ * Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
57
+
58
58
  */
59
59
  kind: "app_secret";
60
60
  /** Format: uuid */
61
61
  integrationDefinitionId: string;
62
- /** @description Plaintext app secret. Only returned on this response; cannot be retrieved later. */
62
+ /** Plaintext app secret. Only returned on this response; cannot be retrieved later. */
63
63
  appSecret: string;
64
- /** @description ISO timestamp when the secret became effective. */
64
+ /** ISO timestamp when the secret became effective. */
65
65
  createdAt: string;
66
66
  };
67
67
  };
@@ -69,7 +69,7 @@ interface paths$2 {
69
69
  400: components$2["responses"]["BadRequestError"];
70
70
  401: components$2["responses"]["UnauthorizedError"];
71
71
  403: components$2["responses"]["ForbiddenError"];
72
- /** @description Integration definition not found in this team */
72
+ /** Integration definition not found in this team */
73
73
  404: {
74
74
  headers: {
75
75
  [name: string]: unknown;
@@ -80,7 +80,7 @@ interface paths$2 {
80
80
  500: components$2["responses"]["InternalServerError"];
81
81
  };
82
82
  };
83
- /** @description Revokes the credential for an integration definition. Future grants and refreshes will fail until a new credential is minted. In-flight delegation tokens remain valid until natural expiry. */
83
+ /** Revokes the credential for an integration definition. Future grants and refreshes will fail until a new credential is minted. In-flight delegation tokens remain valid until natural expiry. */
84
84
  delete: {
85
85
  parameters: {
86
86
  query?: never;
@@ -93,24 +93,24 @@ interface paths$2 {
93
93
  "application/json": {
94
94
  /**
95
95
  * Format: uuid
96
- * @description The team ID that owns the integration
96
+ * The team ID that owns the integration
97
97
  */
98
98
  teamId: string;
99
99
  /**
100
100
  * Format: uuid
101
- * @description The integration definition ID to mint or revoke credentials for
101
+ * The integration definition ID to mint or revoke credentials for
102
102
  */
103
103
  integrationDefinitionId: string;
104
104
  /**
105
- * @description Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
106
- * @enum {string}
105
+ * Kind of credential to rotate or revoke. Currently only `app_secret` is supported.
106
+
107
107
  */
108
108
  kind: "app_secret";
109
109
  };
110
110
  };
111
111
  };
112
112
  responses: {
113
- /** @description Credential revoked */
113
+ /** Credential revoked */
114
114
  204: {
115
115
  headers: {
116
116
  [name: string]: unknown;
@@ -120,7 +120,7 @@ interface paths$2 {
120
120
  400: components$2["responses"]["BadRequestError"];
121
121
  401: components$2["responses"]["UnauthorizedError"];
122
122
  403: components$2["responses"]["ForbiddenError"];
123
- /** @description Integration definition not found in this team, or no credential of the given kind is configured */
123
+ /** Integration definition not found in this team, or no credential of the given kind is configured */
124
124
  404: {
125
125
  headers: {
126
126
  [name: string]: unknown;
@@ -131,7 +131,7 @@ interface paths$2 {
131
131
  500: components$2["responses"]["InternalServerError"];
132
132
  };
133
133
  };
134
- /** @description Handles preflight requests. This endpoint allows CORS. */
134
+ /** Handles preflight requests. This endpoint allows CORS. */
135
135
  options: {
136
136
  parameters: {
137
137
  query?: never;
@@ -141,7 +141,7 @@ interface paths$2 {
141
141
  };
142
142
  requestBody?: never;
143
143
  responses: {
144
- /** @description ok */
144
+ /** ok */
145
145
  204: {
146
146
  headers: {
147
147
  [name: string]: unknown;
@@ -158,12 +158,12 @@ interface paths$2 {
158
158
  interface components$2 {
159
159
  schemas: {
160
160
  Error: {
161
- /** @description Error message(s) that occurred while processing the request */
161
+ /** Error message(s) that occurred while processing the request */
162
162
  errorMessage?: string[] | string;
163
163
  };
164
164
  };
165
165
  responses: {
166
- /** @description Request input validation failed */
166
+ /** Request input validation failed */
167
167
  BadRequestError: {
168
168
  headers: {
169
169
  [name: string]: unknown;
@@ -172,7 +172,7 @@ interface components$2 {
172
172
  "application/json": components$2["schemas"]["Error"];
173
173
  };
174
174
  };
175
- /** @description API key or token was not valid */
175
+ /** API key or token was not valid */
176
176
  UnauthorizedError: {
177
177
  headers: {
178
178
  [name: string]: unknown;
@@ -181,7 +181,7 @@ interface components$2 {
181
181
  "application/json": components$2["schemas"]["Error"];
182
182
  };
183
183
  };
184
- /** @description Permission was denied */
184
+ /** Permission was denied */
185
185
  ForbiddenError: {
186
186
  headers: {
187
187
  [name: string]: unknown;
@@ -190,14 +190,14 @@ interface components$2 {
190
190
  "application/json": components$2["schemas"]["Error"];
191
191
  };
192
192
  };
193
- /** @description Too many requests in allowed time period */
193
+ /** Too many requests in allowed time period */
194
194
  RateLimitError: {
195
195
  headers: {
196
196
  [name: string]: unknown;
197
197
  };
198
198
  content?: never;
199
199
  };
200
- /** @description Execution error occurred */
200
+ /** Execution error occurred */
201
201
  InternalServerError: {
202
202
  headers: {
203
203
  [name: string]: unknown;
@@ -219,15 +219,15 @@ interface paths$1 {
219
219
  path?: never;
220
220
  cookie?: never;
221
221
  };
222
- /** @description Gets a list of Mesh apps that are available for a Uniform team */
222
+ /** Gets a list of Mesh apps that are available for a Uniform team */
223
223
  get: {
224
224
  parameters: {
225
225
  query: {
226
- /** @description The team ID */
226
+ /** The team ID */
227
227
  teamId: string;
228
- /** @description Whether to include Mesh apps that are shared publicly to all teams, or only custom apps registered on this team. */
228
+ /** Whether to include Mesh apps that are shared publicly to all teams, or only custom apps registered on this team. */
229
229
  includePublic?: boolean | null;
230
- /** @description Whether to use team-specific integration types or team-agnostic types (for serialization across projects) */
230
+ /** Whether to use team-specific integration types or team-agnostic types (for serialization across projects) */
231
231
  teamSpecificType?: boolean | null;
232
232
  };
233
233
  header?: never;
@@ -236,7 +236,7 @@ interface paths$1 {
236
236
  };
237
237
  requestBody?: never;
238
238
  responses: {
239
- /** @description 200 response */
239
+ /** 200 response */
240
240
  200: {
241
241
  headers: {
242
242
  [name: string]: unknown;
@@ -244,40 +244,40 @@ interface paths$1 {
244
244
  content: {
245
245
  "application/json": {
246
246
  results: {
247
- /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
247
+ /** Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
248
248
  $schema?: string;
249
- /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
249
+ /** Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
250
250
  type: string;
251
- /** @description Display name used in the UI for the integration. */
251
+ /** Display name used in the UI for the integration. */
252
252
  displayName: string;
253
- /** @description URL to the integration's logo icon (larger, used on listing). */
253
+ /** URL to the integration's logo icon (larger, used on listing). */
254
254
  logoIconUrl?: string;
255
- /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
255
+ /** URL to the integration's badge icon (small, round, used as a badge in the UI). */
256
256
  badgeIconUrl?: string;
257
257
  /**
258
- * @description Category of the integration.
259
- * @enum {string}
258
+ * Category of the integration.
259
+
260
260
  */
261
261
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
262
262
  public?: boolean;
263
- /** @description List of permissions to access sensitive data or perform certain actions. */
263
+ /** List of permissions to access sensitive data or perform certain actions. */
264
264
  scopes?: string[];
265
- /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
265
+ /** When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
266
266
  identityDelegation?: boolean;
267
267
  /** Format: uuid */
268
268
  integrationId?: string;
269
269
  hasAppSecret?: boolean;
270
- /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
270
+ /** Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
271
271
  baseLocationUrl?: string;
272
- /** @description Locations where the integration is exposed within the Uniform application. */
272
+ /** Locations where the integration is exposed within the Uniform application. */
273
273
  locations: {
274
- /** @description Locations used during installation of the integration. */
274
+ /** Locations used during installation of the integration. */
275
275
  install?: {
276
276
  description?: string[];
277
277
  informationUrl?: string;
278
278
  canvasPackageUrl?: string;
279
279
  };
280
- /** @description Settings location for configuring the integration. */
280
+ /** Settings location for configuring the integration. */
281
281
  settings?: {
282
282
  url: string;
283
283
  locations?: {
@@ -292,7 +292,7 @@ interface paths$1 {
292
292
  };
293
293
  };
294
294
  };
295
- /** @description Locations within Uniform Canvas for the integration to extend. */
295
+ /** Locations within Uniform Canvas for the integration to extend. */
296
296
  canvas?: {
297
297
  parameterTypes?: {
298
298
  type: string;
@@ -363,7 +363,7 @@ interface paths$1 {
363
363
  };
364
364
  };
365
365
  };
366
- /** @description Data Connector(s) provided by the integration. */
366
+ /** Data Connector(s) provided by the integration. */
367
367
  dataConnectors?: {
368
368
  type: string;
369
369
  displayName: string;
@@ -424,7 +424,7 @@ interface paths$1 {
424
424
  };
425
425
  badgeIconUrl?: string;
426
426
  }[];
427
- /** @description Asset Library provided by the integration. */
427
+ /** Asset Library provided by the integration. */
428
428
  assetLibrary?: {
429
429
  assetLibraryUrl: string;
430
430
  assetParameterUrl: string;
@@ -445,7 +445,7 @@ interface paths$1 {
445
445
  singleAssetArchetypeId: string;
446
446
  };
447
447
  };
448
- /** @description Deprecated. Use `assetLibrary` instead. */
448
+ /** Deprecated. Use `assetLibrary` instead. */
449
449
  unstable_assetLibrary?: {
450
450
  url: string;
451
451
  dynamicAssets?: {
@@ -454,7 +454,7 @@ interface paths$1 {
454
454
  singleAssetArchetypeId: string;
455
455
  };
456
456
  };
457
- /** @description AI configuration for the integration. */
457
+ /** AI configuration for the integration. */
458
458
  ai?: {
459
459
  generateUrl: string;
460
460
  metadataUrl?: string;
@@ -476,12 +476,12 @@ interface paths$1 {
476
476
  parameterTypes: string[];
477
477
  }[];
478
478
  };
479
- /** @description Deprecated. Use `ai` instead. */
479
+ /** Deprecated. Use `ai` instead. */
480
480
  unstable_ai?: {
481
481
  generateUrl: string;
482
482
  metadataUrl?: string;
483
483
  };
484
- /** @description Deprecated/experimental. AI agents function-calling configuration. */
484
+ /** Deprecated/experimental. AI agents function-calling configuration. */
485
485
  aiAgents?: {
486
486
  functionCalling?: {
487
487
  handlerUrl: string;
@@ -499,7 +499,7 @@ interface paths$1 {
499
499
  }[];
500
500
  };
501
501
  };
502
- /** @description Deprecated. Will be removed shortly. */
502
+ /** Deprecated. Will be removed shortly. */
503
503
  tools?: {
504
504
  id: string;
505
505
  name: string;
@@ -510,7 +510,7 @@ interface paths$1 {
510
510
  teamAdminRequired?: true;
511
511
  };
512
512
  }[];
513
- /** @description Project-level tools provided by the integration. */
513
+ /** Project-level tools provided by the integration. */
514
514
  projectTools?: {
515
515
  id: string;
516
516
  name: string;
@@ -521,7 +521,7 @@ interface paths$1 {
521
521
  teamAdminRequired?: true;
522
522
  };
523
523
  }[];
524
- /** @description Dashboard-level tools provided by the integration. */
524
+ /** Dashboard-level tools provided by the integration. */
525
525
  dashboardTools?: {
526
526
  id: string;
527
527
  name: string;
@@ -533,7 +533,7 @@ interface paths$1 {
533
533
  };
534
534
  }[];
535
535
  };
536
- /** @description Deprecated. Use `locations.ai.prompts` instead. */
536
+ /** Deprecated. Use `locations.ai.prompts` instead. */
537
537
  unstable_prompts?: {
538
538
  id: string;
539
539
  name: string;
@@ -562,7 +562,7 @@ interface paths$1 {
562
562
  500: components$1["responses"]["InternalServerError"];
563
563
  };
564
564
  };
565
- /** @description Creates or updates a Mesh app definition on a team. */
565
+ /** Creates or updates a Mesh app definition on a team. */
566
566
  put: {
567
567
  parameters: {
568
568
  query?: never;
@@ -573,39 +573,39 @@ interface paths$1 {
573
573
  requestBody: {
574
574
  content: {
575
575
  "application/json": {
576
- /** @description The team ID */
576
+ /** The team ID */
577
577
  teamId: string;
578
578
  data: {
579
- /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
579
+ /** Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
580
580
  $schema?: string;
581
- /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
581
+ /** Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
582
582
  type: string;
583
- /** @description Display name used in the UI for the integration. */
583
+ /** Display name used in the UI for the integration. */
584
584
  displayName: string;
585
- /** @description URL to the integration's logo icon (larger, used on listing). */
585
+ /** URL to the integration's logo icon (larger, used on listing). */
586
586
  logoIconUrl?: string;
587
- /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
587
+ /** URL to the integration's badge icon (small, round, used as a badge in the UI). */
588
588
  badgeIconUrl?: string;
589
589
  /**
590
- * @description Category of the integration.
591
- * @enum {string}
590
+ * Category of the integration.
591
+
592
592
  */
593
593
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
594
- /** @description List of permissions to access sensitive data or perform certain actions. */
594
+ /** List of permissions to access sensitive data or perform certain actions. */
595
595
  scopes?: string[];
596
- /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
596
+ /** When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
597
597
  identityDelegation?: boolean;
598
- /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
598
+ /** Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
599
599
  baseLocationUrl?: string;
600
- /** @description Locations where the integration is exposed within the Uniform application. */
600
+ /** Locations where the integration is exposed within the Uniform application. */
601
601
  locations: {
602
- /** @description Locations used during installation of the integration. */
602
+ /** Locations used during installation of the integration. */
603
603
  install?: {
604
604
  description?: string[];
605
605
  informationUrl?: string;
606
606
  canvasPackageUrl?: string;
607
607
  };
608
- /** @description Settings location for configuring the integration. */
608
+ /** Settings location for configuring the integration. */
609
609
  settings?: {
610
610
  url: string;
611
611
  locations?: {
@@ -620,7 +620,7 @@ interface paths$1 {
620
620
  };
621
621
  };
622
622
  };
623
- /** @description Locations within Uniform Canvas for the integration to extend. */
623
+ /** Locations within Uniform Canvas for the integration to extend. */
624
624
  canvas?: {
625
625
  parameterTypes?: {
626
626
  type: string;
@@ -691,7 +691,7 @@ interface paths$1 {
691
691
  };
692
692
  };
693
693
  };
694
- /** @description Data Connector(s) provided by the integration. */
694
+ /** Data Connector(s) provided by the integration. */
695
695
  dataConnectors?: {
696
696
  type: string;
697
697
  displayName: string;
@@ -752,7 +752,7 @@ interface paths$1 {
752
752
  };
753
753
  badgeIconUrl?: string;
754
754
  }[];
755
- /** @description Asset Library provided by the integration. */
755
+ /** Asset Library provided by the integration. */
756
756
  assetLibrary?: {
757
757
  assetLibraryUrl: string;
758
758
  assetParameterUrl: string;
@@ -773,7 +773,7 @@ interface paths$1 {
773
773
  singleAssetArchetypeId: string;
774
774
  };
775
775
  };
776
- /** @description Deprecated. Use `assetLibrary` instead. */
776
+ /** Deprecated. Use `assetLibrary` instead. */
777
777
  unstable_assetLibrary?: {
778
778
  url: string;
779
779
  dynamicAssets?: {
@@ -782,7 +782,7 @@ interface paths$1 {
782
782
  singleAssetArchetypeId: string;
783
783
  };
784
784
  };
785
- /** @description AI configuration for the integration. */
785
+ /** AI configuration for the integration. */
786
786
  ai?: {
787
787
  generateUrl: string;
788
788
  metadataUrl?: string;
@@ -804,12 +804,12 @@ interface paths$1 {
804
804
  parameterTypes: string[];
805
805
  }[];
806
806
  };
807
- /** @description Deprecated. Use `ai` instead. */
807
+ /** Deprecated. Use `ai` instead. */
808
808
  unstable_ai?: {
809
809
  generateUrl: string;
810
810
  metadataUrl?: string;
811
811
  };
812
- /** @description Deprecated/experimental. AI agents function-calling configuration. */
812
+ /** Deprecated/experimental. AI agents function-calling configuration. */
813
813
  aiAgents?: {
814
814
  functionCalling?: {
815
815
  handlerUrl: string;
@@ -827,7 +827,7 @@ interface paths$1 {
827
827
  }[];
828
828
  };
829
829
  };
830
- /** @description Deprecated. Will be removed shortly. */
830
+ /** Deprecated. Will be removed shortly. */
831
831
  tools?: {
832
832
  id: string;
833
833
  name: string;
@@ -838,7 +838,7 @@ interface paths$1 {
838
838
  teamAdminRequired?: true;
839
839
  };
840
840
  }[];
841
- /** @description Project-level tools provided by the integration. */
841
+ /** Project-level tools provided by the integration. */
842
842
  projectTools?: {
843
843
  id: string;
844
844
  name: string;
@@ -849,7 +849,7 @@ interface paths$1 {
849
849
  teamAdminRequired?: true;
850
850
  };
851
851
  }[];
852
- /** @description Dashboard-level tools provided by the integration. */
852
+ /** Dashboard-level tools provided by the integration. */
853
853
  dashboardTools?: {
854
854
  id: string;
855
855
  name: string;
@@ -861,7 +861,7 @@ interface paths$1 {
861
861
  };
862
862
  }[];
863
863
  };
864
- /** @description Deprecated. Use `locations.ai.prompts` instead. */
864
+ /** Deprecated. Use `locations.ai.prompts` instead. */
865
865
  unstable_prompts?: {
866
866
  id: string;
867
867
  name: string;
@@ -884,50 +884,50 @@ interface paths$1 {
884
884
  };
885
885
  };
886
886
  responses: {
887
- /** @description Update success */
887
+ /** Update success */
888
888
  200: {
889
889
  headers: {
890
890
  [name: string]: unknown;
891
891
  };
892
892
  content: {
893
893
  "application/json": {
894
- /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
894
+ /** Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
895
895
  $schema?: string;
896
- /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
896
+ /** Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
897
897
  type: string;
898
- /** @description Display name used in the UI for the integration. */
898
+ /** Display name used in the UI for the integration. */
899
899
  displayName: string;
900
- /** @description URL to the integration's logo icon (larger, used on listing). */
900
+ /** URL to the integration's logo icon (larger, used on listing). */
901
901
  logoIconUrl?: string;
902
- /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
902
+ /** URL to the integration's badge icon (small, round, used as a badge in the UI). */
903
903
  badgeIconUrl?: string;
904
904
  /**
905
- * @description Category of the integration.
906
- * @enum {string}
905
+ * Category of the integration.
906
+
907
907
  */
908
908
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
909
909
  public?: boolean;
910
- /** @description List of permissions to access sensitive data or perform certain actions. */
910
+ /** List of permissions to access sensitive data or perform certain actions. */
911
911
  scopes?: string[];
912
- /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
912
+ /** When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
913
913
  identityDelegation?: boolean;
914
914
  /**
915
915
  * Format: uuid
916
- * @description Stable id for this integration definition. Required for identity delegation token exchange.
916
+ * Stable id for this integration definition. Required for identity delegation token exchange.
917
917
  */
918
918
  integrationId: string;
919
919
  hasAppSecret?: boolean;
920
- /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
920
+ /** Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
921
921
  baseLocationUrl?: string;
922
- /** @description Locations where the integration is exposed within the Uniform application. */
922
+ /** Locations where the integration is exposed within the Uniform application. */
923
923
  locations: {
924
- /** @description Locations used during installation of the integration. */
924
+ /** Locations used during installation of the integration. */
925
925
  install?: {
926
926
  description?: string[];
927
927
  informationUrl?: string;
928
928
  canvasPackageUrl?: string;
929
929
  };
930
- /** @description Settings location for configuring the integration. */
930
+ /** Settings location for configuring the integration. */
931
931
  settings?: {
932
932
  url: string;
933
933
  locations?: {
@@ -942,7 +942,7 @@ interface paths$1 {
942
942
  };
943
943
  };
944
944
  };
945
- /** @description Locations within Uniform Canvas for the integration to extend. */
945
+ /** Locations within Uniform Canvas for the integration to extend. */
946
946
  canvas?: {
947
947
  parameterTypes?: {
948
948
  type: string;
@@ -1013,7 +1013,7 @@ interface paths$1 {
1013
1013
  };
1014
1014
  };
1015
1015
  };
1016
- /** @description Data Connector(s) provided by the integration. */
1016
+ /** Data Connector(s) provided by the integration. */
1017
1017
  dataConnectors?: {
1018
1018
  type: string;
1019
1019
  displayName: string;
@@ -1074,7 +1074,7 @@ interface paths$1 {
1074
1074
  };
1075
1075
  badgeIconUrl?: string;
1076
1076
  }[];
1077
- /** @description Asset Library provided by the integration. */
1077
+ /** Asset Library provided by the integration. */
1078
1078
  assetLibrary?: {
1079
1079
  assetLibraryUrl: string;
1080
1080
  assetParameterUrl: string;
@@ -1095,7 +1095,7 @@ interface paths$1 {
1095
1095
  singleAssetArchetypeId: string;
1096
1096
  };
1097
1097
  };
1098
- /** @description Deprecated. Use `assetLibrary` instead. */
1098
+ /** Deprecated. Use `assetLibrary` instead. */
1099
1099
  unstable_assetLibrary?: {
1100
1100
  url: string;
1101
1101
  dynamicAssets?: {
@@ -1104,7 +1104,7 @@ interface paths$1 {
1104
1104
  singleAssetArchetypeId: string;
1105
1105
  };
1106
1106
  };
1107
- /** @description AI configuration for the integration. */
1107
+ /** AI configuration for the integration. */
1108
1108
  ai?: {
1109
1109
  generateUrl: string;
1110
1110
  metadataUrl?: string;
@@ -1126,12 +1126,12 @@ interface paths$1 {
1126
1126
  parameterTypes: string[];
1127
1127
  }[];
1128
1128
  };
1129
- /** @description Deprecated. Use `ai` instead. */
1129
+ /** Deprecated. Use `ai` instead. */
1130
1130
  unstable_ai?: {
1131
1131
  generateUrl: string;
1132
1132
  metadataUrl?: string;
1133
1133
  };
1134
- /** @description Deprecated/experimental. AI agents function-calling configuration. */
1134
+ /** Deprecated/experimental. AI agents function-calling configuration. */
1135
1135
  aiAgents?: {
1136
1136
  functionCalling?: {
1137
1137
  handlerUrl: string;
@@ -1149,7 +1149,7 @@ interface paths$1 {
1149
1149
  }[];
1150
1150
  };
1151
1151
  };
1152
- /** @description Deprecated. Will be removed shortly. */
1152
+ /** Deprecated. Will be removed shortly. */
1153
1153
  tools?: {
1154
1154
  id: string;
1155
1155
  name: string;
@@ -1160,7 +1160,7 @@ interface paths$1 {
1160
1160
  teamAdminRequired?: true;
1161
1161
  };
1162
1162
  }[];
1163
- /** @description Project-level tools provided by the integration. */
1163
+ /** Project-level tools provided by the integration. */
1164
1164
  projectTools?: {
1165
1165
  id: string;
1166
1166
  name: string;
@@ -1171,7 +1171,7 @@ interface paths$1 {
1171
1171
  teamAdminRequired?: true;
1172
1172
  };
1173
1173
  }[];
1174
- /** @description Dashboard-level tools provided by the integration. */
1174
+ /** Dashboard-level tools provided by the integration. */
1175
1175
  dashboardTools?: {
1176
1176
  id: string;
1177
1177
  name: string;
@@ -1183,7 +1183,7 @@ interface paths$1 {
1183
1183
  };
1184
1184
  }[];
1185
1185
  };
1186
- /** @description Deprecated. Use `locations.ai.prompts` instead. */
1186
+ /** Deprecated. Use `locations.ai.prompts` instead. */
1187
1187
  unstable_prompts?: {
1188
1188
  id: string;
1189
1189
  name: string;
@@ -1212,7 +1212,7 @@ interface paths$1 {
1212
1212
  };
1213
1213
  };
1214
1214
  post?: never;
1215
- /** @description Removes a Mesh app definition from a team. Note that public integrations may not be deleted without contacting Uniform. */
1215
+ /** Removes a Mesh app definition from a team. Note that public integrations may not be deleted without contacting Uniform. */
1216
1216
  delete: {
1217
1217
  parameters: {
1218
1218
  query?: never;
@@ -1223,15 +1223,15 @@ interface paths$1 {
1223
1223
  requestBody: {
1224
1224
  content: {
1225
1225
  "application/json": {
1226
- /** @description The team ID */
1226
+ /** The team ID */
1227
1227
  teamId: string;
1228
- /** @description The integration type to remove */
1228
+ /** The integration type to remove */
1229
1229
  type: string;
1230
1230
  };
1231
1231
  };
1232
1232
  };
1233
1233
  responses: {
1234
- /** @description Delete successful */
1234
+ /** Delete successful */
1235
1235
  204: {
1236
1236
  headers: {
1237
1237
  [name: string]: unknown;
@@ -1241,7 +1241,7 @@ interface paths$1 {
1241
1241
  400: components$1["responses"]["BadRequestError"];
1242
1242
  401: components$1["responses"]["UnauthorizedError"];
1243
1243
  403: components$1["responses"]["ForbiddenError"];
1244
- /** @description Integration to delete was not found */
1244
+ /** Integration to delete was not found */
1245
1245
  404: {
1246
1246
  headers: {
1247
1247
  [name: string]: unknown;
@@ -1252,7 +1252,7 @@ interface paths$1 {
1252
1252
  500: components$1["responses"]["InternalServerError"];
1253
1253
  };
1254
1254
  };
1255
- /** @description Handles preflight requests. This endpoint allows CORS. */
1255
+ /** Handles preflight requests. This endpoint allows CORS. */
1256
1256
  options: {
1257
1257
  parameters: {
1258
1258
  query?: never;
@@ -1262,7 +1262,7 @@ interface paths$1 {
1262
1262
  };
1263
1263
  requestBody?: never;
1264
1264
  responses: {
1265
- /** @description ok */
1265
+ /** ok */
1266
1266
  204: {
1267
1267
  headers: {
1268
1268
  [name: string]: unknown;
@@ -1279,12 +1279,12 @@ interface paths$1 {
1279
1279
  interface components$1 {
1280
1280
  schemas: {
1281
1281
  Error: {
1282
- /** @description Error message(s) that occurred while processing the request */
1282
+ /** Error message(s) that occurred while processing the request */
1283
1283
  errorMessage?: string[] | string;
1284
1284
  };
1285
1285
  };
1286
1286
  responses: {
1287
- /** @description Request input validation failed */
1287
+ /** Request input validation failed */
1288
1288
  BadRequestError: {
1289
1289
  headers: {
1290
1290
  [name: string]: unknown;
@@ -1293,7 +1293,7 @@ interface components$1 {
1293
1293
  "application/json": components$1["schemas"]["Error"];
1294
1294
  };
1295
1295
  };
1296
- /** @description API key or token was not valid */
1296
+ /** API key or token was not valid */
1297
1297
  UnauthorizedError: {
1298
1298
  headers: {
1299
1299
  [name: string]: unknown;
@@ -1302,7 +1302,7 @@ interface components$1 {
1302
1302
  "application/json": components$1["schemas"]["Error"];
1303
1303
  };
1304
1304
  };
1305
- /** @description Permission was denied */
1305
+ /** Permission was denied */
1306
1306
  ForbiddenError: {
1307
1307
  headers: {
1308
1308
  [name: string]: unknown;
@@ -1311,14 +1311,14 @@ interface components$1 {
1311
1311
  "application/json": components$1["schemas"]["Error"];
1312
1312
  };
1313
1313
  };
1314
- /** @description Too many requests in allowed time period */
1314
+ /** Too many requests in allowed time period */
1315
1315
  RateLimitError: {
1316
1316
  headers: {
1317
1317
  [name: string]: unknown;
1318
1318
  };
1319
1319
  content?: never;
1320
1320
  };
1321
- /** @description Execution error occurred */
1321
+ /** Execution error occurred */
1322
1322
  InternalServerError: {
1323
1323
  headers: {
1324
1324
  [name: string]: unknown;
@@ -1340,17 +1340,17 @@ interface paths {
1340
1340
  path?: never;
1341
1341
  cookie?: never;
1342
1342
  };
1343
- /** @description Gets a list of installed integrations for a Uniform Project */
1343
+ /** Gets a list of installed integrations for a Uniform Project */
1344
1344
  get: {
1345
1345
  parameters: {
1346
1346
  query: {
1347
- /** @description The project ID */
1347
+ /** The project ID */
1348
1348
  projectId: string;
1349
- /** @description Limit results to a single integration type */
1349
+ /** Limit results to a single integration type */
1350
1350
  type?: string;
1351
- /** @description Whether to match the passed type exactly or to treat the type as a prefix */
1351
+ /** Whether to match the passed type exactly or to treat the type as a prefix */
1352
1352
  exactType?: boolean | null;
1353
- /** @description Whether to use team-specific integration types or team-agnostic types (for serialization across projects) */
1353
+ /** Whether to use team-specific integration types or team-agnostic types (for serialization across projects) */
1354
1354
  teamSpecificType?: boolean | null;
1355
1355
  };
1356
1356
  header?: never;
@@ -1359,7 +1359,7 @@ interface paths {
1359
1359
  };
1360
1360
  requestBody?: never;
1361
1361
  responses: {
1362
- /** @description 200 response */
1362
+ /** 200 response */
1363
1363
  200: {
1364
1364
  headers: {
1365
1365
  [name: string]: unknown;
@@ -1382,7 +1382,7 @@ interface paths {
1382
1382
  500: components["responses"]["InternalServerError"];
1383
1383
  };
1384
1384
  };
1385
- /** @description Installs or updates an integration on a Uniform Project. If data is not provided, it will remain unmodified from any existing value. */
1385
+ /** Installs or updates an integration on a Uniform Project. If data is not provided, it will remain unmodified from any existing value. */
1386
1386
  put: {
1387
1387
  parameters: {
1388
1388
  query?: never;
@@ -1393,9 +1393,9 @@ interface paths {
1393
1393
  requestBody: {
1394
1394
  content: {
1395
1395
  "application/json": {
1396
- /** @description The project ID */
1396
+ /** The project ID */
1397
1397
  projectId: string;
1398
- /** @description Whether to match the passed type exactly or to treat the type as a prefix */
1398
+ /** Whether to match the passed type exactly or to treat the type as a prefix */
1399
1399
  exactType?: boolean | null;
1400
1400
  type: string;
1401
1401
  data?: {
@@ -1405,7 +1405,7 @@ interface paths {
1405
1405
  };
1406
1406
  };
1407
1407
  responses: {
1408
- /** @description Install or update success */
1408
+ /** Install or update success */
1409
1409
  204: {
1410
1410
  headers: {
1411
1411
  [name: string]: unknown;
@@ -1420,7 +1420,7 @@ interface paths {
1420
1420
  };
1421
1421
  };
1422
1422
  post?: never;
1423
- /** @description Removes an integration from a project. */
1423
+ /** Removes an integration from a project. */
1424
1424
  delete: {
1425
1425
  parameters: {
1426
1426
  query?: never;
@@ -1431,17 +1431,17 @@ interface paths {
1431
1431
  requestBody: {
1432
1432
  content: {
1433
1433
  "application/json": {
1434
- /** @description The project ID */
1434
+ /** The project ID */
1435
1435
  projectId: string;
1436
- /** @description The integration type to remove */
1436
+ /** The integration type to remove */
1437
1437
  type: string;
1438
- /** @description Whether to match the passed type exactly or to treat the type as a prefix */
1438
+ /** Whether to match the passed type exactly or to treat the type as a prefix */
1439
1439
  exactType?: boolean | null;
1440
1440
  };
1441
1441
  };
1442
1442
  };
1443
1443
  responses: {
1444
- /** @description Delete successful */
1444
+ /** Delete successful */
1445
1445
  204: {
1446
1446
  headers: {
1447
1447
  [name: string]: unknown;
@@ -1451,7 +1451,7 @@ interface paths {
1451
1451
  400: components["responses"]["BadRequestError"];
1452
1452
  401: components["responses"]["UnauthorizedError"];
1453
1453
  403: components["responses"]["ForbiddenError"];
1454
- /** @description Integration to delete was not found */
1454
+ /** Integration to delete was not found */
1455
1455
  404: {
1456
1456
  headers: {
1457
1457
  [name: string]: unknown;
@@ -1462,7 +1462,7 @@ interface paths {
1462
1462
  500: components["responses"]["InternalServerError"];
1463
1463
  };
1464
1464
  };
1465
- /** @description Handles preflight requests. This endpoint allows CORS. */
1465
+ /** Handles preflight requests. This endpoint allows CORS. */
1466
1466
  options: {
1467
1467
  parameters: {
1468
1468
  query?: never;
@@ -1472,7 +1472,7 @@ interface paths {
1472
1472
  };
1473
1473
  requestBody?: never;
1474
1474
  responses: {
1475
- /** @description ok */
1475
+ /** ok */
1476
1476
  204: {
1477
1477
  headers: {
1478
1478
  [name: string]: unknown;
@@ -1489,12 +1489,12 @@ interface paths {
1489
1489
  interface components {
1490
1490
  schemas: {
1491
1491
  Error: {
1492
- /** @description Error message(s) that occurred while processing the request */
1492
+ /** Error message(s) that occurred while processing the request */
1493
1493
  errorMessage?: string[] | string;
1494
1494
  };
1495
1495
  };
1496
1496
  responses: {
1497
- /** @description Request input validation failed */
1497
+ /** Request input validation failed */
1498
1498
  BadRequestError: {
1499
1499
  headers: {
1500
1500
  [name: string]: unknown;
@@ -1503,7 +1503,7 @@ interface components {
1503
1503
  "application/json": components["schemas"]["Error"];
1504
1504
  };
1505
1505
  };
1506
- /** @description API key or token was not valid */
1506
+ /** API key or token was not valid */
1507
1507
  UnauthorizedError: {
1508
1508
  headers: {
1509
1509
  [name: string]: unknown;
@@ -1512,7 +1512,7 @@ interface components {
1512
1512
  "application/json": components["schemas"]["Error"];
1513
1513
  };
1514
1514
  };
1515
- /** @description Permission was denied */
1515
+ /** Permission was denied */
1516
1516
  ForbiddenError: {
1517
1517
  headers: {
1518
1518
  [name: string]: unknown;
@@ -1521,14 +1521,14 @@ interface components {
1521
1521
  "application/json": components["schemas"]["Error"];
1522
1522
  };
1523
1523
  };
1524
- /** @description Too many requests in allowed time period */
1524
+ /** Too many requests in allowed time period */
1525
1525
  RateLimitError: {
1526
1526
  headers: {
1527
1527
  [name: string]: unknown;
1528
1528
  };
1529
1529
  content?: never;
1530
1530
  };
1531
- /** @description Execution error occurred */
1531
+ /** Execution error occurred */
1532
1532
  InternalServerError: {
1533
1533
  headers: {
1534
1534
  [name: string]: unknown;
@@ -1579,7 +1579,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
1579
1579
  constructor(options: DefClientOptions);
1580
1580
  /** Fetches all mesh apps for a team (and optionally also those shared across teams) */
1581
1581
  get(options?: Omit<IntegrationDefinitionGetParameters, 'teamId'>): Promise<IntegrationDefinitionGetResponse>;
1582
- /** Creates or updates a mesh app definition on a team. Identity-delegation credentials must be minted separately via {@link rotateCredential}. */
1582
+ /** Creates or updates a mesh app definition on a team. Identity-delegation credentials must be minted separately via {@link IntegrationDefinitionClient.rotateCredential}. */
1583
1583
  upsert(body: Omit<IntegrationDefinitionPutParameters, 'teamId'>): Promise<{
1584
1584
  $schema?: string;
1585
1585
  type: string;
@@ -2059,11 +2059,14 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
2059
2059
  parameterDefinition: ComponentDefinitionParameter;
2060
2060
  /**
2061
2061
  * The connected data for the current component. Connected data is provided as a map
2062
- * of the binding expression text to the value of that binding expression. For example,
2062
+ * of the binding expression text to the value of that binding expression. For example:
2063
+ * @example
2064
+ * ```
2063
2065
  * if the value is "Hello ${#jptr:/MyData/fields/name}" then this value would be:
2064
2066
  * { "#jptr:/MyData/fields/name": "value-of-connected-data" }
2067
+ * ```
2065
2068
  *
2066
- * Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
2069
+ * Use the `ParamTypeDynamicDataProvider` to wire up dynamic data in your parameter.
2067
2070
  */
2068
2071
  connectedData: Record<string, unknown>;
2069
2072
  /**
@@ -2354,13 +2357,11 @@ type MeshRouter = {
2354
2357
  /**
2355
2358
  * Navigate parent frame (Uniform App) to a new path within current project.
2356
2359
  *
2357
- * So router.navigate('/canvas/edit/{compositionId}') will navigate will open the composition editor for the given composition ID in the parent frame.
2360
+ * So `router.navigate('/canvas/edit/{compositionId}')` will navigate will open the composition editor for the given composition ID in the parent frame.
2358
2361
  * Be aware that most of the time it will close your mesh app, so you should use it with caution.
2359
2362
  *
2360
- * @param path - The path to navigate to. You don't need to specify /projects/${projectId} as it is prepended automatically with the current project ID.
2361
- * @param options - The options for the navigation.
2362
- * @param options.projectId - You can specify project ID to navigate to. By default the current project ID is used.
2363
- * @param options.target - Allows to open a new tab instead of navigating the current one.
2363
+ * @param path - The path to navigate to. You don't need to specify `/projects/\${projectId}` as it is prepended automatically with the current project ID.
2364
+ * @param options - Navigation options. Use `projectId` to override the current project; use `target` to open a new tab.
2364
2365
  */
2365
2366
  navigatePlatform: (path: string, options?: {
2366
2367
  projectId?: string;
@@ -2483,6 +2484,10 @@ type MeshLocationUserPermissions =
2483
2484
  | 'AUTOMATIONS_MANAGE'
2484
2485
  /** Uniform Canvas:Workflows:Manage|Create, update, and delete workflow definitions. */
2485
2486
  | 'WORKFLOWS_MANAGE'
2487
+ /** Uniform Insights:View|View Insights dashboards and the Insights tab on components. */
2488
+ | 'INSIGHTS_VIEW'
2489
+ /** Uniform Insights:Manage|Configure the Insights connection and set conversion goals on signals. */
2490
+ | 'INSIGHTS_MANAGE'
2486
2491
  /** UTM Mapper:Read|Read UTM mapper configuration */
2487
2492
  | 'UTM_MAPPER_READ'
2488
2493
  /** UTM Mapper:Read|Create, update and delete UTM mapper configuration */
@@ -2529,8 +2534,12 @@ type GetEditorStateLocationMaybe = {
2529
2534
  };
2530
2535
  /**
2531
2536
  * Dynamic inputs come from project map and represent path or query based dynamic values
2532
- * These can be connected to from within a Mesh location by setting a data resource variable to contain ex:
2533
- * ${inputName} expression(s).
2537
+ * These can be connected to from within a Mesh location by setting a data resource variable to contain
2538
+ * @example
2539
+ * ```
2540
+ * ${inputName}
2541
+ * ```
2542
+ * expression(s).
2534
2543
  *
2535
2544
  * Dynamic inputs only work at runtime when using the route endpoint to fetch data.
2536
2545
  */
@@ -2609,9 +2618,9 @@ type UpdateNodePropertyOptions = {
2609
2618
  type?: string;
2610
2619
  /** Target locale, or undefined for invariant value */
2611
2620
  locale: string | undefined;
2612
- /** Condition index (-1 for base value, >= 0 for conditional) */
2621
+ /** Condition index (-1 for base value, `>= 0` for conditional) */
2613
2622
  conditionIndex: number;
2614
- /** Condition definition (required when conditionIndex >= 0) */
2623
+ /** Condition definition (required when `conditionIndex >= 0`) */
2615
2624
  conditionDefinition?: VisibilityCriteriaGroup | null;
2616
2625
  };
2617
2626
  /** Options for insertNode */