@alpic-ai/api 0.0.0-dev.ge7fc794 → 0.0.0-dev.ge80d5b2
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 +647 -85
- package/dist/index.mjs +540 -95
- package/package.json +5 -5
package/dist/index.mjs
CHANGED
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -256,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -402,12 +422,13 @@ z.object({
|
|
|
402
422
|
collectUserData: z.boolean(),
|
|
403
423
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
424
|
});
|
|
405
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
406
426
|
id: z.string(),
|
|
407
427
|
createdAt: z.coerce.date(),
|
|
408
428
|
environmentId: z.string(),
|
|
409
429
|
content: z.string(),
|
|
410
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
411
432
|
});
|
|
412
433
|
z.object({
|
|
413
434
|
content: z.string(),
|
|
@@ -423,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
423
444
|
"pink",
|
|
424
445
|
"gray"
|
|
425
446
|
]);
|
|
426
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
427
448
|
const intentCategorySchema = z.object({
|
|
428
449
|
id: z.string(),
|
|
429
450
|
createdAt: z.coerce.date(),
|
|
@@ -431,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
431
452
|
name: z.string(),
|
|
432
453
|
color: intentCategoryColorSchema
|
|
433
454
|
});
|
|
434
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
435
456
|
id: z.string(),
|
|
436
457
|
name: z.string(),
|
|
437
458
|
color: intentCategoryColorSchema,
|
|
@@ -443,6 +464,7 @@ z.object({
|
|
|
443
464
|
environmentId: z.string(),
|
|
444
465
|
toolName: z.string(),
|
|
445
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
446
468
|
categories: z.array(intentCategorySchema)
|
|
447
469
|
});
|
|
448
470
|
const signalCategorySchema = z.object({
|
|
@@ -501,12 +523,262 @@ z.object({
|
|
|
501
523
|
createdAt: z.coerce.date(),
|
|
502
524
|
updatedAt: z.coerce.date()
|
|
503
525
|
});
|
|
526
|
+
const alpicMcpRequestLogSchema = z.object({
|
|
527
|
+
type: z.literal("mcp_request"),
|
|
528
|
+
method: z.string()
|
|
529
|
+
});
|
|
530
|
+
const alpicMcpErrorLogSchema = z.object({
|
|
531
|
+
type: z.literal("mcp_error"),
|
|
532
|
+
method: z.string(),
|
|
533
|
+
error: z.string()
|
|
534
|
+
});
|
|
535
|
+
z.union([alpicMcpRequestLogSchema, alpicMcpErrorLogSchema]);
|
|
504
536
|
z.enum([
|
|
505
537
|
"INFO",
|
|
506
538
|
"WARNING",
|
|
507
539
|
"DEBUG",
|
|
508
540
|
"ERROR"
|
|
509
541
|
]);
|
|
542
|
+
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
|
+
const MCP_CLIENT_GROUPS = [
|
|
544
|
+
{
|
|
545
|
+
id: "claude_code",
|
|
546
|
+
label: "Claude Code",
|
|
547
|
+
vendor: "anthropic",
|
|
548
|
+
rawNames: ["claude-code", "Anthropic/ClaudeCodeDesktop"]
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
id: "claude",
|
|
552
|
+
label: "Claude",
|
|
553
|
+
vendor: "anthropic",
|
|
554
|
+
rawNames: [
|
|
555
|
+
"Anthropic/ClaudeAI",
|
|
556
|
+
"claude-ai",
|
|
557
|
+
"claude",
|
|
558
|
+
"Claude",
|
|
559
|
+
"claude-desktop",
|
|
560
|
+
"claude-desktop-3p"
|
|
561
|
+
]
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
id: "claude_mobile",
|
|
565
|
+
label: "Claude mobile",
|
|
566
|
+
vendor: "anthropic",
|
|
567
|
+
rawNames: ["claude-ios", "ClaudeAndroid"]
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
id: "claude_cowork",
|
|
571
|
+
label: "Claude Cowork",
|
|
572
|
+
vendor: "anthropic",
|
|
573
|
+
rawNames: ["Anthropic/Cowork"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
id: "claude_toolbox",
|
|
577
|
+
label: "Claude Toolbox",
|
|
578
|
+
vendor: "anthropic",
|
|
579
|
+
rawNames: ["Anthropic/Toolbox", "Anthropic/toolbox-bootstrap"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
id: "anthropic_api",
|
|
583
|
+
label: "Anthropic API",
|
|
584
|
+
vendor: "anthropic",
|
|
585
|
+
rawNames: ["Anthropic/API"]
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
id: "anthropic_connector_refresh",
|
|
589
|
+
label: "Anthropic (connector refresh)",
|
|
590
|
+
vendor: "anthropic",
|
|
591
|
+
rawNames: ["Anthropic"]
|
|
592
|
+
},
|
|
593
|
+
{
|
|
594
|
+
id: "codex",
|
|
595
|
+
label: "Codex",
|
|
596
|
+
vendor: "openai",
|
|
597
|
+
rawNames: [
|
|
598
|
+
"codex-mcp-client",
|
|
599
|
+
"codex",
|
|
600
|
+
"Codex",
|
|
601
|
+
"codex-cli",
|
|
602
|
+
"openai-mcp (Codex)"
|
|
603
|
+
]
|
|
604
|
+
},
|
|
605
|
+
{
|
|
606
|
+
id: "chatgpt",
|
|
607
|
+
label: "ChatGPT",
|
|
608
|
+
vendor: "openai",
|
|
609
|
+
rawNames: ["openai-mcp (ChatGPT)"]
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
id: "openai_responses_api",
|
|
613
|
+
label: "OpenAI Responses API",
|
|
614
|
+
vendor: "openai",
|
|
615
|
+
rawNames: ["openai-mcp (Responses API)"]
|
|
616
|
+
},
|
|
617
|
+
{
|
|
618
|
+
id: "openai_agent_builder",
|
|
619
|
+
label: "OpenAI Agent Builder",
|
|
620
|
+
vendor: "openai",
|
|
621
|
+
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
id: "openai_other",
|
|
625
|
+
label: "OpenAI Other",
|
|
626
|
+
vendor: "openai",
|
|
627
|
+
rawNames: ["openai-mcp"]
|
|
628
|
+
},
|
|
629
|
+
{
|
|
630
|
+
id: "cursor",
|
|
631
|
+
label: "Cursor",
|
|
632
|
+
vendor: "cursor",
|
|
633
|
+
rawNames: [
|
|
634
|
+
"cursor-vscode",
|
|
635
|
+
"Cursor",
|
|
636
|
+
"cursor"
|
|
637
|
+
]
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
id: "cline",
|
|
641
|
+
label: "Cline",
|
|
642
|
+
vendor: "cline",
|
|
643
|
+
rawNames: [
|
|
644
|
+
"Cline",
|
|
645
|
+
"cline",
|
|
646
|
+
"@cline/core"
|
|
647
|
+
]
|
|
648
|
+
},
|
|
649
|
+
{
|
|
650
|
+
id: "github_copilot",
|
|
651
|
+
label: "GitHub Copilot",
|
|
652
|
+
vendor: "githubCopilot",
|
|
653
|
+
rawNames: [
|
|
654
|
+
"Copilot",
|
|
655
|
+
"github-copilot-developer",
|
|
656
|
+
"Copilot MCP Gateway",
|
|
657
|
+
"Xcode/copilot-xcode"
|
|
658
|
+
]
|
|
659
|
+
},
|
|
660
|
+
{
|
|
661
|
+
id: "gemini_cli",
|
|
662
|
+
label: "Gemini CLI",
|
|
663
|
+
vendor: "google",
|
|
664
|
+
rawNames: ["gemini-cli-mcp-client", "gemini-cli"]
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
id: "antigravity",
|
|
668
|
+
label: "Antigravity",
|
|
669
|
+
vendor: "google",
|
|
670
|
+
rawNames: ["antigravity-client"]
|
|
671
|
+
},
|
|
672
|
+
{
|
|
673
|
+
id: "gemini",
|
|
674
|
+
label: "Gemini",
|
|
675
|
+
vendor: "google",
|
|
676
|
+
rawNames: ["Gemini", "google-ai-edge-gallery"]
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
id: "windsurf",
|
|
680
|
+
label: "Windsurf",
|
|
681
|
+
vendor: "windsurf",
|
|
682
|
+
rawNames: ["Windsurf", "windsurf-client"]
|
|
683
|
+
},
|
|
684
|
+
{
|
|
685
|
+
id: "mistral",
|
|
686
|
+
label: "Mistral / Le Chat",
|
|
687
|
+
vendor: "mistral",
|
|
688
|
+
rawNames: ["Mistral"],
|
|
689
|
+
rawNamePrefixes: ["connector:custom-mcp:"]
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
id: "n8n",
|
|
693
|
+
label: "n8n",
|
|
694
|
+
vendor: "n8n",
|
|
695
|
+
rawNames: [
|
|
696
|
+
"@n8n/n8n-nodes-langchain.mcpClient",
|
|
697
|
+
"@n8n/n8n-nodes-langchain.mcpClientTool",
|
|
698
|
+
"n8n"
|
|
699
|
+
]
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
id: "alpic_playground",
|
|
703
|
+
label: "Alpic Playground",
|
|
704
|
+
vendor: "alpic",
|
|
705
|
+
rawNames: ["alpic-playground", "playground"]
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
id: "opencode",
|
|
709
|
+
label: "opencode",
|
|
710
|
+
vendor: "opencode",
|
|
711
|
+
rawNames: ["opencode"]
|
|
712
|
+
},
|
|
713
|
+
{
|
|
714
|
+
id: "zed",
|
|
715
|
+
label: "Zed",
|
|
716
|
+
vendor: "zed",
|
|
717
|
+
rawNames: ["Zed", "zed"]
|
|
718
|
+
},
|
|
719
|
+
{
|
|
720
|
+
id: "zapier",
|
|
721
|
+
label: "Zapier",
|
|
722
|
+
vendor: "zapier",
|
|
723
|
+
rawNames: ["Zapier", "zapier"]
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
id: "make",
|
|
727
|
+
label: "Make",
|
|
728
|
+
vendor: "make",
|
|
729
|
+
rawNames: ["Make", "make"]
|
|
730
|
+
},
|
|
731
|
+
{
|
|
732
|
+
id: "librechat",
|
|
733
|
+
label: "LibreChat",
|
|
734
|
+
vendor: "mcp",
|
|
735
|
+
rawNames: ["LibreChat", "librechat"]
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
id: "jan",
|
|
739
|
+
label: "Jan",
|
|
740
|
+
vendor: "mcp",
|
|
741
|
+
rawNames: ["Jan", "jan"]
|
|
742
|
+
},
|
|
743
|
+
{
|
|
744
|
+
id: "goose",
|
|
745
|
+
label: "goose",
|
|
746
|
+
vendor: "mcp",
|
|
747
|
+
rawNames: ["goose", "Goose"]
|
|
748
|
+
},
|
|
749
|
+
{
|
|
750
|
+
id: "mcphost",
|
|
751
|
+
label: "mcphost",
|
|
752
|
+
vendor: "mcp",
|
|
753
|
+
rawNames: ["mcphost"]
|
|
754
|
+
},
|
|
755
|
+
{
|
|
756
|
+
id: "mcporter",
|
|
757
|
+
label: "mcporter",
|
|
758
|
+
vendor: "mcp",
|
|
759
|
+
rawNames: ["mcporter"]
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
id: "rmcp",
|
|
763
|
+
label: "rmcp",
|
|
764
|
+
vendor: "mcp",
|
|
765
|
+
rawNames: ["rmcp"]
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
id: "unnamed_client",
|
|
769
|
+
label: "Unnamed client",
|
|
770
|
+
vendor: "mcp",
|
|
771
|
+
rawNames: [
|
|
772
|
+
"mcp",
|
|
773
|
+
"unknown",
|
|
774
|
+
""
|
|
775
|
+
]
|
|
776
|
+
}
|
|
777
|
+
];
|
|
778
|
+
/** A source pattern, not a RegExp, because analytics renders the same rule into ClickHouse RE2, which shares this syntax. */
|
|
779
|
+
const MCP_REMOTE_WRAPPER_SUFFIX = String.raw` \(via mcp-remote [^\n]+?\)$`;
|
|
780
|
+
new RegExp(MCP_REMOTE_WRAPPER_SUFFIX);
|
|
781
|
+
new Map(MCP_CLIENT_GROUPS.map((group) => [group.id, group]));
|
|
510
782
|
const runtimeSchema = z.enum([
|
|
511
783
|
"python3.13",
|
|
512
784
|
"python3.14",
|
|
@@ -1156,6 +1428,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1156
1428
|
});
|
|
1157
1429
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1158
1430
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1431
|
+
z.literal([
|
|
1432
|
+
100,
|
|
1433
|
+
75,
|
|
1434
|
+
50
|
|
1435
|
+
]);
|
|
1159
1436
|
const subscriptionPlanSchema = z.enum([
|
|
1160
1437
|
"pro",
|
|
1161
1438
|
"business",
|
|
@@ -1167,17 +1444,70 @@ const customerCreditsSchema = z.object({
|
|
|
1167
1444
|
expiresAt: z.number().nullable(),
|
|
1168
1445
|
currency: z.string()
|
|
1169
1446
|
});
|
|
1170
|
-
const customerUsageSchema = z.object({
|
|
1171
|
-
amountInCents: z.number(),
|
|
1172
|
-
currency: z.string(),
|
|
1173
|
-
periodEnd: z.number()
|
|
1174
|
-
});
|
|
1175
1447
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1176
1448
|
z.object({
|
|
1177
1449
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1178
|
-
customerUsage: customerUsageSchema.nullable(),
|
|
1179
1450
|
partnerDiscount: partnerDiscountSchema.nullable()
|
|
1180
1451
|
});
|
|
1452
|
+
const metricsQueueEventSchema = z.object({
|
|
1453
|
+
ts: z.number().int(),
|
|
1454
|
+
method: z.string(),
|
|
1455
|
+
tool: z.string().nullable(),
|
|
1456
|
+
client: z.string(),
|
|
1457
|
+
sessionId: z.string().nullable(),
|
|
1458
|
+
durationMs: z.number().int(),
|
|
1459
|
+
outputTokens: z.number().int().nullable(),
|
|
1460
|
+
errorType: z.enum([
|
|
1461
|
+
"mcp_error",
|
|
1462
|
+
"tool_error",
|
|
1463
|
+
"timeout"
|
|
1464
|
+
]).nullable(),
|
|
1465
|
+
errorCode: z.number().int().nullable()
|
|
1466
|
+
});
|
|
1467
|
+
z.object({
|
|
1468
|
+
v: z.literal(1),
|
|
1469
|
+
envId: z.string(),
|
|
1470
|
+
events: z.array(metricsQueueEventSchema)
|
|
1471
|
+
});
|
|
1472
|
+
z.object({ v: z.number() });
|
|
1473
|
+
const telemetrySignalSchema = z.enum([
|
|
1474
|
+
"logs",
|
|
1475
|
+
"metrics",
|
|
1476
|
+
"traces"
|
|
1477
|
+
]);
|
|
1478
|
+
const otlpProtocolSchema = z.enum(["http/protobuf", "http/json"]);
|
|
1479
|
+
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1480
|
+
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1481
|
+
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
1482
|
+
const otlpHeaderValueSchema = z.string().trim().max(OTLP_HEADER_VALUE_MAX_LENGTH).refine((value) => !/[\r\n]/.test(value), "Line breaks are not allowed in a header value");
|
|
1483
|
+
const telemetryDestinationHeaderSchema = z.object({
|
|
1484
|
+
id: z.string(),
|
|
1485
|
+
name: otlpHeaderNameSchema,
|
|
1486
|
+
value: otlpHeaderValueSchema,
|
|
1487
|
+
isSecret: z.boolean()
|
|
1488
|
+
});
|
|
1489
|
+
const otlpPushFailureReasonSchema = z.enum([
|
|
1490
|
+
"credentials",
|
|
1491
|
+
"wrong-path",
|
|
1492
|
+
"wrong-protocol",
|
|
1493
|
+
"invalid-payload",
|
|
1494
|
+
"partial-rejection",
|
|
1495
|
+
"blocked-target",
|
|
1496
|
+
"timeout",
|
|
1497
|
+
"unreachable",
|
|
1498
|
+
"receiver-error",
|
|
1499
|
+
"unexpected-status"
|
|
1500
|
+
]);
|
|
1501
|
+
const telemetryDestinationStatusSchema = z.enum(["active", "suspended"]);
|
|
1502
|
+
z.object({
|
|
1503
|
+
id: z.string(),
|
|
1504
|
+
signal: telemetrySignalSchema,
|
|
1505
|
+
endpoint: otlpEndpointSchema,
|
|
1506
|
+
protocol: otlpProtocolSchema,
|
|
1507
|
+
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1508
|
+
status: telemetryDestinationStatusSchema,
|
|
1509
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1510
|
+
});
|
|
1181
1511
|
//#endregion
|
|
1182
1512
|
//#region src/auth-scope.ts
|
|
1183
1513
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1304,21 +1634,20 @@ const deploymentSchema = z.object({
|
|
|
1304
1634
|
isCurrent: z.boolean(),
|
|
1305
1635
|
deploymentPageUrl: z.url().nullable()
|
|
1306
1636
|
});
|
|
1307
|
-
const
|
|
1637
|
+
const isValidTimeInput = (value) => {
|
|
1308
1638
|
if (ms(value) !== void 0) return true;
|
|
1309
1639
|
return !Number.isNaN(new Date(value).getTime());
|
|
1310
1640
|
};
|
|
1311
|
-
const
|
|
1641
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1642
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1643
|
+
const createEnvironmentContractV1 = base.route({
|
|
1312
1644
|
path: "/v1/environments",
|
|
1313
1645
|
method: "POST",
|
|
1314
1646
|
summary: "Create an environment",
|
|
1315
1647
|
description: "Create an environment for a project",
|
|
1316
1648
|
tags: ["environments"],
|
|
1317
1649
|
successDescription: "The environment has been created successfully"
|
|
1318
|
-
}).errors({
|
|
1319
|
-
NOT_FOUND: {},
|
|
1320
|
-
BAD_REQUEST: {}
|
|
1321
|
-
}).input(z.object({
|
|
1650
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1322
1651
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1323
1652
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1324
1653
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1331,7 +1660,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1331
1660
|
createdAt: z.coerce.date(),
|
|
1332
1661
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1333
1662
|
}));
|
|
1334
|
-
const getEnvironmentContractV1 =
|
|
1663
|
+
const getEnvironmentContractV1 = base.route({
|
|
1335
1664
|
path: "/v1/environments/{environmentId}",
|
|
1336
1665
|
method: "GET",
|
|
1337
1666
|
summary: "Get an environment",
|
|
@@ -1388,7 +1717,7 @@ const projectOutputSchema = z.object({
|
|
|
1388
1717
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1389
1718
|
environments: z.array(environmentSchema)
|
|
1390
1719
|
});
|
|
1391
|
-
const getProjectContractV1 =
|
|
1720
|
+
const getProjectContractV1 = base.route({
|
|
1392
1721
|
path: "/v1/projects/{projectId}",
|
|
1393
1722
|
method: "GET",
|
|
1394
1723
|
summary: "Get a project",
|
|
@@ -1396,18 +1725,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1396
1725
|
tags: ["projects"],
|
|
1397
1726
|
successDescription: "The project details"
|
|
1398
1727
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1399
|
-
const listProjectsContractV1 =
|
|
1728
|
+
const listProjectsContractV1 = base.route({
|
|
1400
1729
|
path: "/v1/projects",
|
|
1401
1730
|
method: "GET",
|
|
1402
1731
|
summary: "List projects",
|
|
1403
1732
|
description: "List all projects for a team",
|
|
1404
1733
|
tags: ["projects"],
|
|
1405
1734
|
successDescription: "The list of projects"
|
|
1406
|
-
}).errors({
|
|
1407
|
-
|
|
1408
|
-
BAD_REQUEST: {}
|
|
1409
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1410
|
-
const createProjectContractV1 = oc.route({
|
|
1735
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1736
|
+
const createProjectContractV1 = base.route({
|
|
1411
1737
|
path: "/v1/projects",
|
|
1412
1738
|
method: "POST",
|
|
1413
1739
|
summary: "Create a project",
|
|
@@ -1416,7 +1742,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1416
1742
|
successDescription: "The project has been created successfully"
|
|
1417
1743
|
}).errors({
|
|
1418
1744
|
NOT_FOUND: {},
|
|
1419
|
-
BAD_REQUEST: {},
|
|
1420
1745
|
FORBIDDEN: {}
|
|
1421
1746
|
}).input(z.object({
|
|
1422
1747
|
teamId: z.string().optional(),
|
|
@@ -1457,7 +1782,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1457
1782
|
isSecret: z.boolean(),
|
|
1458
1783
|
createdAt: z.coerce.date()
|
|
1459
1784
|
});
|
|
1460
|
-
const listEnvironmentVariablesContractV1 =
|
|
1785
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1461
1786
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1462
1787
|
method: "GET",
|
|
1463
1788
|
summary: "List environment variables",
|
|
@@ -1465,48 +1790,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1465
1790
|
tags: ["environments"],
|
|
1466
1791
|
successDescription: "The list of environment variables"
|
|
1467
1792
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1468
|
-
const createEnvironmentVariablesContractV1 =
|
|
1793
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1469
1794
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1470
1795
|
method: "POST",
|
|
1471
1796
|
summary: "Add environment variables",
|
|
1472
1797
|
description: "Add one or more environment variables to an environment",
|
|
1473
1798
|
tags: ["environments"],
|
|
1474
1799
|
successDescription: "The environment variables have been added successfully"
|
|
1475
|
-
}).errors({
|
|
1476
|
-
NOT_FOUND: {},
|
|
1477
|
-
BAD_REQUEST: {}
|
|
1478
|
-
}).input(z.object({
|
|
1800
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1479
1801
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1480
1802
|
environmentVariables: environmentVariablesSchema
|
|
1481
1803
|
})).output(z.object({ success: z.literal(true) }));
|
|
1482
|
-
const updateEnvironmentVariableContractV1 =
|
|
1804
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1483
1805
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1484
1806
|
method: "PATCH",
|
|
1485
1807
|
summary: "Update an environment variable",
|
|
1486
1808
|
description: "Update an environment variable by ID",
|
|
1487
1809
|
tags: ["environments"],
|
|
1488
1810
|
successDescription: "The environment variable has been updated successfully"
|
|
1489
|
-
}).errors({
|
|
1490
|
-
NOT_FOUND: {},
|
|
1491
|
-
BAD_REQUEST: {}
|
|
1492
|
-
}).input(z.object({
|
|
1811
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1493
1812
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1494
1813
|
key: environmentVariableSchema.shape.key,
|
|
1495
1814
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1496
1815
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1497
1816
|
})).output(z.object({ success: z.literal(true) }));
|
|
1498
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1817
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1499
1818
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1500
1819
|
method: "DELETE",
|
|
1501
1820
|
summary: "Delete an environment variable",
|
|
1502
1821
|
description: "Delete an environment variable by ID",
|
|
1503
1822
|
tags: ["environments"],
|
|
1504
1823
|
successDescription: "The environment variable has been deleted successfully"
|
|
1505
|
-
}).errors({
|
|
1506
|
-
|
|
1507
|
-
BAD_REQUEST: {}
|
|
1508
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1509
|
-
const deleteProjectContractV1 = oc.route({
|
|
1824
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1825
|
+
const deleteProjectContractV1 = base.route({
|
|
1510
1826
|
path: "/v1/projects/{projectId}",
|
|
1511
1827
|
method: "DELETE",
|
|
1512
1828
|
summary: "Delete a project",
|
|
@@ -1514,7 +1830,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1514
1830
|
tags: ["projects"],
|
|
1515
1831
|
successDescription: "The project has been deleted successfully"
|
|
1516
1832
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1517
|
-
const updateProjectContractV1 =
|
|
1833
|
+
const updateProjectContractV1 = base.route({
|
|
1518
1834
|
path: "/v1/projects/{projectId}",
|
|
1519
1835
|
method: "PATCH",
|
|
1520
1836
|
summary: "Update a project",
|
|
@@ -1523,14 +1839,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1523
1839
|
successDescription: "The project has been updated successfully"
|
|
1524
1840
|
}).errors({
|
|
1525
1841
|
NOT_FOUND: {},
|
|
1526
|
-
BAD_REQUEST: {},
|
|
1527
1842
|
FORBIDDEN: {}
|
|
1528
1843
|
}).input(z.object({
|
|
1529
1844
|
projectId: z.string().describe("The ID of the project"),
|
|
1530
1845
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1531
1846
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1532
1847
|
})).output(projectOutputSchema);
|
|
1533
|
-
const deployEnvironmentContractV1 =
|
|
1848
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1534
1849
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1535
1850
|
method: "POST",
|
|
1536
1851
|
summary: "Deploy an environment",
|
|
@@ -1539,29 +1854,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1539
1854
|
successDescription: "The environment has been deployed successfully"
|
|
1540
1855
|
}).errors({
|
|
1541
1856
|
NOT_FOUND: {},
|
|
1542
|
-
BAD_REQUEST: {},
|
|
1543
1857
|
CONFLICT: {}
|
|
1544
1858
|
}).input(z.object({
|
|
1545
1859
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1546
1860
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1547
1861
|
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1548
1862
|
})).output(deploymentSchema);
|
|
1549
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1863
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1550
1864
|
path: "/v1/deployments/upload",
|
|
1551
1865
|
method: "POST",
|
|
1552
1866
|
summary: "Upload deployment artifacts",
|
|
1553
1867
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1554
1868
|
tags: ["deployments"],
|
|
1555
1869
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1556
|
-
}).errors({
|
|
1557
|
-
NOT_FOUND: {},
|
|
1558
|
-
BAD_REQUEST: {}
|
|
1559
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1870
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1560
1871
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1561
1872
|
token: z.string().describe("Token to identify the source archive"),
|
|
1562
1873
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1563
1874
|
}));
|
|
1564
|
-
const listDeploymentsContractV1 =
|
|
1875
|
+
const listDeploymentsContractV1 = base.route({
|
|
1565
1876
|
path: "/v1/projects/{projectId}/deployments",
|
|
1566
1877
|
method: "GET",
|
|
1567
1878
|
summary: "List project deployments",
|
|
@@ -1573,7 +1884,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1573
1884
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1574
1885
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1575
1886
|
})).output(z.array(deploymentSchema));
|
|
1576
|
-
const getDeploymentContractV1 =
|
|
1887
|
+
const getDeploymentContractV1 = base.route({
|
|
1577
1888
|
path: "/v1/deployments/{deploymentId}",
|
|
1578
1889
|
method: "GET",
|
|
1579
1890
|
summary: "Get a deployment",
|
|
@@ -1596,20 +1907,17 @@ const logEntrySchema = z.object({
|
|
|
1596
1907
|
method: z.string().optional(),
|
|
1597
1908
|
durationInMs: z.number().optional()
|
|
1598
1909
|
});
|
|
1599
|
-
const getLogsContractV1 =
|
|
1910
|
+
const getLogsContractV1 = base.route({
|
|
1600
1911
|
path: "/v1/environments/{environmentId}/logs",
|
|
1601
1912
|
method: "GET",
|
|
1602
1913
|
summary: "Get logs",
|
|
1603
1914
|
description: "Get logs for an environment",
|
|
1604
1915
|
tags: ["environments"],
|
|
1605
1916
|
successDescription: "The logs"
|
|
1606
|
-
}).errors({
|
|
1607
|
-
NOT_FOUND: {},
|
|
1608
|
-
BAD_REQUEST: {}
|
|
1609
|
-
}).input(z.object({
|
|
1917
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1610
1918
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1611
|
-
since:
|
|
1612
|
-
until:
|
|
1919
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1920
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1613
1921
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1614
1922
|
level: z.array(z.enum([
|
|
1615
1923
|
"INFO",
|
|
@@ -1623,17 +1931,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1623
1931
|
logs: z.array(logEntrySchema),
|
|
1624
1932
|
nextToken: z.string().nullable()
|
|
1625
1933
|
}));
|
|
1626
|
-
const getLatestLogsContractV1 =
|
|
1934
|
+
const getLatestLogsContractV1 = base.route({
|
|
1627
1935
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1628
1936
|
method: "GET",
|
|
1629
1937
|
summary: "Get latest logs",
|
|
1630
1938
|
description: "Get the N most recent logs for an environment",
|
|
1631
1939
|
tags: ["environments"],
|
|
1632
1940
|
successDescription: "The latest logs"
|
|
1633
|
-
}).errors({
|
|
1634
|
-
NOT_FOUND: {},
|
|
1635
|
-
BAD_REQUEST: {}
|
|
1636
|
-
}).input(z.object({
|
|
1941
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1637
1942
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1638
1943
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1639
1944
|
level: z.array(z.enum([
|
|
@@ -1644,7 +1949,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1644
1949
|
])).optional().describe("Filter by log level"),
|
|
1645
1950
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1646
1951
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1647
|
-
const getDeploymentLogsContractV1 =
|
|
1952
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1648
1953
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1649
1954
|
method: "GET",
|
|
1650
1955
|
summary: "Get deployment logs",
|
|
@@ -1671,22 +1976,19 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1671
1976
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1672
1977
|
task_count: z.array(analyticsDataPointSchema)
|
|
1673
1978
|
});
|
|
1674
|
-
const getProjectAnalyticsContractV1 =
|
|
1979
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1675
1980
|
path: "/v1/analytics/{projectId}",
|
|
1676
1981
|
method: "GET",
|
|
1677
1982
|
summary: "Get project analytics",
|
|
1678
1983
|
description: "Get analytics data for a project over a time range",
|
|
1679
1984
|
tags: ["analytics"],
|
|
1680
1985
|
successDescription: "The project analytics data"
|
|
1681
|
-
}).errors({
|
|
1682
|
-
NOT_FOUND: {},
|
|
1683
|
-
BAD_REQUEST: {}
|
|
1684
|
-
}).input(z.object({
|
|
1986
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1685
1987
|
projectId: z.string().describe("The ID of the project"),
|
|
1686
1988
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1687
1989
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
1688
1990
|
timeZone: z.string().describe("IANA timezone (e.g. Europe/Paris)")
|
|
1689
|
-
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <=
|
|
1991
|
+
}).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp > 0, { message: "End date must be after start date" }).refine(({ startTimestamp, endTimestamp }) => endTimestamp - startTimestamp <= 26784e5, { message: "Date range must be less than 1 month" }).refine(({ timeZone }) => Intl.supportedValuesOf("timeZone").includes(timeZone), { message: "Time zone must be a valid IANA timezone" })).output(z.object({
|
|
1690
1992
|
metadata: z.object({
|
|
1691
1993
|
startTimestamp: z.number(),
|
|
1692
1994
|
endTimestamp: z.number(),
|
|
@@ -1696,7 +1998,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1696
1998
|
}),
|
|
1697
1999
|
timeSeries: analyticsTimeSeriesSchema
|
|
1698
2000
|
}));
|
|
1699
|
-
const
|
|
2001
|
+
const paginatedInsightsInputShape = {
|
|
2002
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2003
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
2004
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
2005
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
2006
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
2007
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
2008
|
+
};
|
|
2009
|
+
const listIntentsContractV1 = base.route({
|
|
2010
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
2011
|
+
method: "GET",
|
|
2012
|
+
summary: "List intents",
|
|
2013
|
+
description: "List grouped user intents for an environment over a time range",
|
|
2014
|
+
tags: ["insights"],
|
|
2015
|
+
successDescription: "The grouped user intents"
|
|
2016
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2017
|
+
...paginatedInsightsInputShape,
|
|
2018
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2019
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
2020
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
2021
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
2022
|
+
})).output(z.object({
|
|
2023
|
+
intents: z.array(z.object({
|
|
2024
|
+
id: z.string(),
|
|
2025
|
+
intentIds: z.array(z.string()).min(1),
|
|
2026
|
+
environmentId: z.string(),
|
|
2027
|
+
message: z.string(),
|
|
2028
|
+
toolName: z.string(),
|
|
2029
|
+
createdAt: z.coerce.date(),
|
|
2030
|
+
occurrenceCount: z.number().int().positive(),
|
|
2031
|
+
clientName: z.string().nullable(),
|
|
2032
|
+
clientId: z.string().nullable(),
|
|
2033
|
+
categories: z.array(z.object({
|
|
2034
|
+
id: z.string(),
|
|
2035
|
+
name: z.string(),
|
|
2036
|
+
color: intentCategoryColorSchema
|
|
2037
|
+
}))
|
|
2038
|
+
})),
|
|
2039
|
+
totalCount: z.number().int().nonnegative()
|
|
2040
|
+
}));
|
|
2041
|
+
const listFeedbacksContractV1 = base.route({
|
|
2042
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
2043
|
+
method: "GET",
|
|
2044
|
+
summary: "List feedbacks",
|
|
2045
|
+
description: "List user feedback for an environment over a time range",
|
|
2046
|
+
tags: ["insights"],
|
|
2047
|
+
successDescription: "The user feedback"
|
|
2048
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2049
|
+
...paginatedInsightsInputShape,
|
|
2050
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
2051
|
+
})).output(z.object({
|
|
2052
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
2053
|
+
totalCount: z.number().int().nonnegative()
|
|
2054
|
+
}));
|
|
2055
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
2056
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
2057
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
2058
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2059
|
+
method: "GET",
|
|
2060
|
+
summary: "List intent categories",
|
|
2061
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
2062
|
+
tags: ["insights"],
|
|
2063
|
+
successDescription: "The intent categories"
|
|
2064
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2065
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2066
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2067
|
+
method: "POST",
|
|
2068
|
+
summary: "Create an intent category",
|
|
2069
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2070
|
+
tags: ["insights"],
|
|
2071
|
+
successDescription: "The created intent category"
|
|
2072
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2073
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2074
|
+
name: intentCategoryNameSchema,
|
|
2075
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2076
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2077
|
+
})).output(intentCategorySchema);
|
|
2078
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2079
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2080
|
+
method: "PATCH",
|
|
2081
|
+
summary: "Update an intent category",
|
|
2082
|
+
description: "Rename or recolor an intent category",
|
|
2083
|
+
tags: ["insights"],
|
|
2084
|
+
successDescription: "The updated intent category"
|
|
2085
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2086
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2087
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2088
|
+
name: intentCategoryNameSchema.optional(),
|
|
2089
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2090
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2091
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2092
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2093
|
+
method: "DELETE",
|
|
2094
|
+
summary: "Delete an intent category",
|
|
2095
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2096
|
+
tags: ["insights"],
|
|
2097
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2098
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2099
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2100
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2101
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2102
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2103
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2104
|
+
method: "POST",
|
|
2105
|
+
summary: "Link an intent category",
|
|
2106
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2107
|
+
tags: ["insights"],
|
|
2108
|
+
successDescription: "The intents have been linked successfully"
|
|
2109
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2110
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2111
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2112
|
+
intentIds: categorizableIntentIdsSchema
|
|
2113
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2114
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2115
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2116
|
+
method: "POST",
|
|
2117
|
+
summary: "Unlink an intent category",
|
|
2118
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2119
|
+
tags: ["insights"],
|
|
2120
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2121
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2122
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2123
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2124
|
+
intentIds: categorizableIntentIdsSchema
|
|
2125
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2126
|
+
const listTeamsContractV1 = base.route({
|
|
1700
2127
|
path: "/v1/teams",
|
|
1701
2128
|
method: "GET",
|
|
1702
2129
|
summary: "List teams",
|
|
@@ -1709,7 +2136,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1709
2136
|
createdAt: z.coerce.date(),
|
|
1710
2137
|
hasStripeAccount: z.boolean()
|
|
1711
2138
|
})));
|
|
1712
|
-
const
|
|
2139
|
+
const getTeamUsageContractV1 = base.route({
|
|
2140
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2141
|
+
method: "GET",
|
|
2142
|
+
summary: "Get team usage",
|
|
2143
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2144
|
+
tags: ["teams"],
|
|
2145
|
+
successDescription: "The current billing window usage"
|
|
2146
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2147
|
+
teamId: z.string(),
|
|
2148
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2149
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2150
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2151
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2152
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2153
|
+
}));
|
|
2154
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1713
2155
|
path: "/v1/tunnels/ticket",
|
|
1714
2156
|
method: "GET",
|
|
1715
2157
|
summary: "Get a tunnel ticket",
|
|
@@ -1721,16 +2163,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1721
2163
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1722
2164
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1723
2165
|
}));
|
|
1724
|
-
const publishServerContractV1 =
|
|
2166
|
+
const publishServerContractV1 = base.route({
|
|
1725
2167
|
path: "/v1/distribution/publish",
|
|
1726
2168
|
method: "POST",
|
|
1727
2169
|
summary: "Publish a server to the MCP registry",
|
|
1728
2170
|
tags: ["distribution"],
|
|
1729
2171
|
successDescription: "The server has been published successfully"
|
|
1730
|
-
}).errors({
|
|
1731
|
-
NOT_FOUND: {},
|
|
1732
|
-
BAD_REQUEST: {}
|
|
1733
|
-
}).input(z.object({
|
|
2172
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1734
2173
|
projectId: z.string(),
|
|
1735
2174
|
domain: z.string(),
|
|
1736
2175
|
title: z.string().min(1).max(100),
|
|
@@ -1739,17 +2178,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1739
2178
|
iconSrc: z.url().max(255).optional(),
|
|
1740
2179
|
dryRun: z.boolean().optional()
|
|
1741
2180
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1742
|
-
const getServerInfoContractV1 =
|
|
2181
|
+
const getServerInfoContractV1 = base.route({
|
|
1743
2182
|
path: "/v1/distribution/get",
|
|
1744
2183
|
method: "GET",
|
|
1745
2184
|
summary: "Get server info",
|
|
1746
2185
|
description: "Get info about a server",
|
|
1747
2186
|
tags: ["distribution"],
|
|
1748
2187
|
successDescription: "The server info"
|
|
1749
|
-
}).errors({
|
|
1750
|
-
NOT_FOUND: {},
|
|
1751
|
-
BAD_REQUEST: {}
|
|
1752
|
-
}).input(z.object({
|
|
2188
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1753
2189
|
projectId: z.string(),
|
|
1754
2190
|
domain: z.string()
|
|
1755
2191
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -1768,7 +2204,7 @@ const playgroundOutputSchema = z.object({
|
|
|
1768
2204
|
isPlaygroundEnabled: z.boolean(),
|
|
1769
2205
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
1770
2206
|
});
|
|
1771
|
-
const getPlaygroundContractV1 =
|
|
2207
|
+
const getPlaygroundContractV1 = base.route({
|
|
1772
2208
|
path: "/v1/environments/{environmentId}/playground",
|
|
1773
2209
|
method: "GET",
|
|
1774
2210
|
summary: "Get playground configuration",
|
|
@@ -1776,17 +2212,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
1776
2212
|
tags: ["environments"],
|
|
1777
2213
|
successDescription: "The playground configuration"
|
|
1778
2214
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
1779
|
-
const upsertPlaygroundContractV1 =
|
|
2215
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
1780
2216
|
path: "/v1/environments/{environmentId}/playground",
|
|
1781
2217
|
method: "PUT",
|
|
1782
2218
|
summary: "Update playground configuration",
|
|
1783
2219
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
1784
2220
|
tags: ["environments"],
|
|
1785
2221
|
successDescription: "The updated playground configuration"
|
|
1786
|
-
}).errors({
|
|
1787
|
-
NOT_FOUND: {},
|
|
1788
|
-
BAD_REQUEST: {}
|
|
1789
|
-
}).input(z.object({
|
|
2222
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1790
2223
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1791
2224
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
1792
2225
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -1794,7 +2227,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
1794
2227
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
1795
2228
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
1796
2229
|
})).output(playgroundOutputSchema);
|
|
1797
|
-
const createBeaconContractV1 =
|
|
2230
|
+
const createBeaconContractV1 = base.route({
|
|
1798
2231
|
path: "/v1/beacon/audits",
|
|
1799
2232
|
method: "POST",
|
|
1800
2233
|
summary: "Create a beacon audit",
|
|
@@ -1803,7 +2236,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
1803
2236
|
successDescription: "The audit has been created"
|
|
1804
2237
|
}).errors({
|
|
1805
2238
|
NOT_FOUND: {},
|
|
1806
|
-
BAD_REQUEST: {},
|
|
1807
2239
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
1808
2240
|
}).input(z.object({
|
|
1809
2241
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -1811,7 +2243,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
1811
2243
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
1812
2244
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
1813
2245
|
})).output(z.object({ id: z.string() }));
|
|
1814
|
-
const getBeaconContractV1 =
|
|
2246
|
+
const getBeaconContractV1 = base.route({
|
|
1815
2247
|
path: "/v1/beacon/audits/{auditId}",
|
|
1816
2248
|
method: "GET",
|
|
1817
2249
|
summary: "Get a beacon audit",
|
|
@@ -1827,8 +2259,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
1827
2259
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
1828
2260
|
}));
|
|
1829
2261
|
const contract = {
|
|
1830
|
-
teams: {
|
|
2262
|
+
teams: {
|
|
2263
|
+
list: { v1: listTeamsContractV1 },
|
|
2264
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2265
|
+
},
|
|
1831
2266
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2267
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2268
|
+
intentCategories: {
|
|
2269
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2270
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2271
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2272
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2273
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2274
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2275
|
+
},
|
|
2276
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
1832
2277
|
deployments: {
|
|
1833
2278
|
list: { v1: listDeploymentsContractV1 },
|
|
1834
2279
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -1875,4 +2320,4 @@ const contractForDocs = {
|
|
|
1875
2320
|
deployments: deploymentsForDocs
|
|
1876
2321
|
};
|
|
1877
2322
|
//#endregion
|
|
1878
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2323
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|