@hookdeck/outpost-sdk 0.9.1 → 0.9.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.
- package/README.md +14 -7
- package/bin/mcp-server.js +1024 -407
- package/bin/mcp-server.js.map +47 -40
- package/dist/commonjs/funcs/attemptsGet.js.map +1 -1
- package/dist/commonjs/funcs/destinationsCreate.js.map +1 -1
- package/dist/commonjs/funcs/destinationsDelete.js.map +1 -1
- package/dist/commonjs/funcs/destinationsDisable.js.map +1 -1
- package/dist/commonjs/funcs/destinationsEnable.js.map +1 -1
- package/dist/commonjs/funcs/destinationsGet.js.map +1 -1
- package/dist/commonjs/funcs/destinationsGetAttempt.js.map +1 -1
- package/dist/commonjs/funcs/destinationsList.js.map +1 -1
- package/dist/commonjs/funcs/destinationsListAttempts.js.map +1 -1
- package/dist/commonjs/funcs/destinationsUpdate.js.map +1 -1
- package/dist/commonjs/funcs/eventsGet.js.map +1 -1
- package/dist/commonjs/funcs/metricsGetAttemptMetrics.d.ts +28 -0
- package/dist/commonjs/funcs/metricsGetAttemptMetrics.d.ts.map +1 -0
- package/dist/commonjs/funcs/metricsGetAttemptMetrics.js +142 -0
- package/dist/commonjs/funcs/metricsGetAttemptMetrics.js.map +1 -0
- package/dist/commonjs/funcs/metricsGetEventMetrics.d.ts +26 -0
- package/dist/commonjs/funcs/metricsGetEventMetrics.d.ts.map +1 -0
- package/dist/commonjs/funcs/metricsGetEventMetrics.js +136 -0
- package/dist/commonjs/funcs/metricsGetEventMetrics.js.map +1 -0
- package/dist/commonjs/funcs/schemasGetDestinationType.js.map +1 -1
- package/dist/commonjs/funcs/tenantsDelete.js.map +1 -1
- package/dist/commonjs/funcs/tenantsGet.js.map +1 -1
- package/dist/commonjs/funcs/tenantsGetPortalUrl.js.map +1 -1
- package/dist/commonjs/funcs/tenantsGetToken.js.map +1 -1
- package/dist/commonjs/funcs/tenantsUpsert.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/lib/files.d.ts +13 -0
- package/dist/commonjs/lib/files.d.ts.map +1 -1
- package/dist/commonjs/lib/files.js +19 -0
- package/dist/commonjs/lib/files.js.map +1 -1
- package/dist/commonjs/lib/sdks.d.ts.map +1 -1
- package/dist/commonjs/lib/sdks.js +8 -4
- package/dist/commonjs/lib/sdks.js.map +1 -1
- package/dist/commonjs/lib/url.d.ts.map +1 -1
- package/dist/commonjs/lib/url.js +4 -2
- package/dist/commonjs/lib/url.js.map +1 -1
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/server.js +5 -1
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/metricsGetAttemptMetrics.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/metricsGetAttemptMetrics.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/metricsGetAttemptMetrics.js +74 -0
- package/dist/commonjs/mcp-server/tools/metricsGetAttemptMetrics.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/metricsGetEventMetrics.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/metricsGetEventMetrics.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/metricsGetEventMetrics.js +72 -0
- package/dist/commonjs/mcp-server/tools/metricsGetEventMetrics.js.map +1 -0
- package/dist/commonjs/models/components/attempt.d.ts +104 -6
- package/dist/commonjs/models/components/attempt.d.ts.map +1 -1
- package/dist/commonjs/models/components/attempt.js +106 -11
- package/dist/commonjs/models/components/attempt.js.map +1 -1
- package/dist/commonjs/models/components/index.d.ts +3 -2
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +3 -2
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/metricsdatapoint.d.ts +38 -0
- package/dist/commonjs/models/components/metricsdatapoint.d.ts.map +1 -0
- package/dist/commonjs/models/components/{eventsummary.js → metricsdatapoint.js} +18 -31
- package/dist/commonjs/models/components/metricsdatapoint.js.map +1 -0
- package/dist/commonjs/models/components/metricsmetadata.d.ts +40 -0
- package/dist/commonjs/models/components/metricsmetadata.d.ts.map +1 -0
- package/dist/commonjs/models/components/{eventfull.js → metricsmetadata.js} +26 -33
- package/dist/commonjs/models/components/metricsmetadata.js.map +1 -0
- package/dist/commonjs/models/components/metricsresponse.d.ts +24 -0
- package/dist/commonjs/models/components/metricsresponse.d.ts.map +1 -0
- package/dist/commonjs/models/components/metricsresponse.js +62 -0
- package/dist/commonjs/models/components/metricsresponse.js.map +1 -0
- package/dist/commonjs/models/operations/getattempt.d.ts +2 -0
- package/dist/commonjs/models/operations/getattempt.d.ts.map +1 -1
- package/dist/commonjs/models/operations/getattempt.js.map +1 -1
- package/dist/commonjs/models/operations/getattemptmetrics.d.ts +273 -0
- package/dist/commonjs/models/operations/getattemptmetrics.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getattemptmetrics.js +326 -0
- package/dist/commonjs/models/operations/getattemptmetrics.js.map +1 -0
- package/dist/commonjs/models/operations/geteventmetrics.d.ts +158 -0
- package/dist/commonjs/models/operations/geteventmetrics.d.ts.map +1 -0
- package/dist/commonjs/models/operations/geteventmetrics.js +208 -0
- package/dist/commonjs/models/operations/geteventmetrics.js.map +1 -0
- package/dist/commonjs/models/operations/gettenantdestinationattempt.d.ts +2 -0
- package/dist/commonjs/models/operations/gettenantdestinationattempt.d.ts.map +1 -1
- package/dist/commonjs/models/operations/gettenantdestinationattempt.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +2 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +2 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/listattempts.d.ts +2 -0
- package/dist/commonjs/models/operations/listattempts.d.ts.map +1 -1
- package/dist/commonjs/models/operations/listattempts.js.map +1 -1
- package/dist/commonjs/models/operations/listtenantdestinationattempts.d.ts +2 -0
- package/dist/commonjs/models/operations/listtenantdestinationattempts.d.ts.map +1 -1
- package/dist/commonjs/models/operations/listtenantdestinationattempts.js.map +1 -1
- package/dist/commonjs/sdk/metrics.d.ts +36 -0
- package/dist/commonjs/sdk/metrics.d.ts.map +1 -0
- package/dist/commonjs/sdk/metrics.js +48 -0
- package/dist/commonjs/sdk/metrics.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +3 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +4 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/esm/funcs/attemptsGet.js.map +1 -1
- package/dist/esm/funcs/destinationsCreate.js.map +1 -1
- package/dist/esm/funcs/destinationsDelete.js.map +1 -1
- package/dist/esm/funcs/destinationsDisable.js.map +1 -1
- package/dist/esm/funcs/destinationsEnable.js.map +1 -1
- package/dist/esm/funcs/destinationsGet.js.map +1 -1
- package/dist/esm/funcs/destinationsGetAttempt.js.map +1 -1
- package/dist/esm/funcs/destinationsList.js.map +1 -1
- package/dist/esm/funcs/destinationsListAttempts.js.map +1 -1
- package/dist/esm/funcs/destinationsUpdate.js.map +1 -1
- package/dist/esm/funcs/eventsGet.js.map +1 -1
- package/dist/esm/funcs/metricsGetAttemptMetrics.d.ts +28 -0
- package/dist/esm/funcs/metricsGetAttemptMetrics.d.ts.map +1 -0
- package/dist/esm/funcs/metricsGetAttemptMetrics.js +106 -0
- package/dist/esm/funcs/metricsGetAttemptMetrics.js.map +1 -0
- package/dist/esm/funcs/metricsGetEventMetrics.d.ts +26 -0
- package/dist/esm/funcs/metricsGetEventMetrics.d.ts.map +1 -0
- package/dist/esm/funcs/metricsGetEventMetrics.js +100 -0
- package/dist/esm/funcs/metricsGetEventMetrics.js.map +1 -0
- package/dist/esm/funcs/schemasGetDestinationType.js.map +1 -1
- package/dist/esm/funcs/tenantsDelete.js.map +1 -1
- package/dist/esm/funcs/tenantsGet.js.map +1 -1
- package/dist/esm/funcs/tenantsGetPortalUrl.js.map +1 -1
- package/dist/esm/funcs/tenantsGetToken.js.map +1 -1
- package/dist/esm/funcs/tenantsUpsert.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/lib/files.d.ts +13 -0
- package/dist/esm/lib/files.d.ts.map +1 -1
- package/dist/esm/lib/files.js +18 -0
- package/dist/esm/lib/files.js.map +1 -1
- package/dist/esm/lib/sdks.d.ts.map +1 -1
- package/dist/esm/lib/sdks.js +8 -4
- package/dist/esm/lib/sdks.js.map +1 -1
- package/dist/esm/lib/url.d.ts.map +1 -1
- package/dist/esm/lib/url.js +4 -2
- package/dist/esm/lib/url.js.map +1 -1
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.d.ts.map +1 -1
- package/dist/esm/mcp-server/server.js +5 -1
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/mcp-server/tools/metricsGetAttemptMetrics.d.ts +8 -0
- package/dist/esm/mcp-server/tools/metricsGetAttemptMetrics.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/metricsGetAttemptMetrics.js +38 -0
- package/dist/esm/mcp-server/tools/metricsGetAttemptMetrics.js.map +1 -0
- package/dist/esm/mcp-server/tools/metricsGetEventMetrics.d.ts +8 -0
- package/dist/esm/mcp-server/tools/metricsGetEventMetrics.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/metricsGetEventMetrics.js +36 -0
- package/dist/esm/mcp-server/tools/metricsGetEventMetrics.js.map +1 -0
- package/dist/esm/models/components/attempt.d.ts +104 -6
- package/dist/esm/models/components/attempt.d.ts.map +1 -1
- package/dist/esm/models/components/attempt.js +101 -10
- package/dist/esm/models/components/attempt.js.map +1 -1
- package/dist/esm/models/components/index.d.ts +3 -2
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +3 -2
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/metricsdatapoint.d.ts +38 -0
- package/dist/esm/models/components/metricsdatapoint.d.ts.map +1 -0
- package/dist/esm/models/components/metricsdatapoint.js +33 -0
- package/dist/esm/models/components/metricsdatapoint.js.map +1 -0
- package/dist/esm/models/components/metricsmetadata.d.ts +40 -0
- package/dist/esm/models/components/metricsmetadata.d.ts.map +1 -0
- package/dist/esm/models/components/metricsmetadata.js +41 -0
- package/dist/esm/models/components/metricsmetadata.js.map +1 -0
- package/dist/esm/models/components/metricsresponse.d.ts +24 -0
- package/dist/esm/models/components/metricsresponse.d.ts.map +1 -0
- package/dist/esm/models/components/metricsresponse.js +24 -0
- package/dist/esm/models/components/metricsresponse.js.map +1 -0
- package/dist/esm/models/operations/getattempt.d.ts +2 -0
- package/dist/esm/models/operations/getattempt.d.ts.map +1 -1
- package/dist/esm/models/operations/getattempt.js.map +1 -1
- package/dist/esm/models/operations/getattemptmetrics.d.ts +273 -0
- package/dist/esm/models/operations/getattemptmetrics.d.ts.map +1 -0
- package/dist/esm/models/operations/getattemptmetrics.js +272 -0
- package/dist/esm/models/operations/getattemptmetrics.js.map +1 -0
- package/dist/esm/models/operations/geteventmetrics.d.ts +158 -0
- package/dist/esm/models/operations/geteventmetrics.d.ts.map +1 -0
- package/dist/esm/models/operations/geteventmetrics.js +160 -0
- package/dist/esm/models/operations/geteventmetrics.js.map +1 -0
- package/dist/esm/models/operations/gettenantdestinationattempt.d.ts +2 -0
- package/dist/esm/models/operations/gettenantdestinationattempt.d.ts.map +1 -1
- package/dist/esm/models/operations/gettenantdestinationattempt.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +2 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +2 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/listattempts.d.ts +2 -0
- package/dist/esm/models/operations/listattempts.d.ts.map +1 -1
- package/dist/esm/models/operations/listattempts.js.map +1 -1
- package/dist/esm/models/operations/listtenantdestinationattempts.d.ts +2 -0
- package/dist/esm/models/operations/listtenantdestinationattempts.d.ts.map +1 -1
- package/dist/esm/models/operations/listtenantdestinationattempts.js.map +1 -1
- package/dist/esm/sdk/metrics.d.ts +36 -0
- package/dist/esm/sdk/metrics.d.ts.map +1 -0
- package/dist/esm/sdk/metrics.js +44 -0
- package/dist/esm/sdk/metrics.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +3 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +4 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/attemptsGet.ts +0 -1
- package/src/funcs/destinationsCreate.ts +0 -1
- package/src/funcs/destinationsDelete.ts +0 -1
- package/src/funcs/destinationsDisable.ts +0 -1
- package/src/funcs/destinationsEnable.ts +0 -1
- package/src/funcs/destinationsGet.ts +0 -1
- package/src/funcs/destinationsGetAttempt.ts +0 -1
- package/src/funcs/destinationsList.ts +0 -1
- package/src/funcs/destinationsListAttempts.ts +0 -1
- package/src/funcs/destinationsUpdate.ts +0 -1
- package/src/funcs/eventsGet.ts +0 -1
- package/src/funcs/metricsGetAttemptMetrics.ts +206 -0
- package/src/funcs/metricsGetEventMetrics.ts +200 -0
- package/src/funcs/schemasGetDestinationType.ts +0 -1
- package/src/funcs/tenantsDelete.ts +0 -1
- package/src/funcs/tenantsGet.ts +0 -1
- package/src/funcs/tenantsGetPortalUrl.ts +0 -1
- package/src/funcs/tenantsGetToken.ts +0 -1
- package/src/funcs/tenantsUpsert.ts +0 -1
- package/src/lib/config.ts +3 -3
- package/src/lib/files.ts +22 -0
- package/src/lib/sdks.ts +7 -5
- package/src/lib/url.ts +16 -14
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +5 -1
- package/src/mcp-server/tools/metricsGetAttemptMetrics.ts +47 -0
- package/src/mcp-server/tools/metricsGetEventMetrics.ts +45 -0
- package/src/models/components/attempt.ts +224 -23
- package/src/models/components/index.ts +3 -2
- package/src/models/components/metricsdatapoint.ts +79 -0
- package/src/models/components/metricsmetadata.ts +93 -0
- package/src/models/components/metricsresponse.ts +68 -0
- package/src/models/operations/getattempt.ts +2 -0
- package/src/models/operations/getattemptmetrics.ts +668 -0
- package/src/models/operations/geteventmetrics.ts +434 -0
- package/src/models/operations/gettenantdestinationattempt.ts +2 -0
- package/src/models/operations/index.ts +2 -0
- package/src/models/operations/listattempts.ts +2 -0
- package/src/models/operations/listtenantdestinationattempts.ts +2 -0
- package/src/sdk/metrics.ts +62 -0
- package/src/sdk/sdk.ts +6 -0
- package/dist/commonjs/models/components/eventfull.d.ts +0 -57
- package/dist/commonjs/models/components/eventfull.d.ts.map +0 -1
- package/dist/commonjs/models/components/eventfull.js.map +0 -1
- package/dist/commonjs/models/components/eventsummary.d.ts +0 -48
- package/dist/commonjs/models/components/eventsummary.d.ts.map +0 -1
- package/dist/commonjs/models/components/eventsummary.js.map +0 -1
- package/dist/esm/models/components/eventfull.d.ts +0 -57
- package/dist/esm/models/components/eventfull.d.ts.map +0 -1
- package/dist/esm/models/components/eventfull.js +0 -48
- package/dist/esm/models/components/eventfull.js.map +0 -1
- package/dist/esm/models/components/eventsummary.d.ts +0 -48
- package/dist/esm/models/components/eventsummary.d.ts.map +0 -1
- package/dist/esm/models/components/eventsummary.js +0 -46
- package/dist/esm/models/components/eventsummary.js.map +0 -1
- package/src/models/components/eventfull.ts +0 -107
- package/src/models/components/eventsummary.ts +0 -100
|
@@ -0,0 +1,434 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { remap as remap$ } from "../../lib/primitives.js";
|
|
7
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
8
|
+
import { ClosedEnum } from "../../types/enums.js";
|
|
9
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
10
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
11
|
+
|
|
12
|
+
export const GetEventMetricsMeasuresEnum2 = {
|
|
13
|
+
Count: "count",
|
|
14
|
+
Rate: "rate",
|
|
15
|
+
} as const;
|
|
16
|
+
export type GetEventMetricsMeasuresEnum2 = ClosedEnum<
|
|
17
|
+
typeof GetEventMetricsMeasuresEnum2
|
|
18
|
+
>;
|
|
19
|
+
|
|
20
|
+
export const GetEventMetricsMeasuresEnum1 = {
|
|
21
|
+
Count: "count",
|
|
22
|
+
Rate: "rate",
|
|
23
|
+
} as const;
|
|
24
|
+
export type GetEventMetricsMeasuresEnum1 = ClosedEnum<
|
|
25
|
+
typeof GetEventMetricsMeasuresEnum1
|
|
26
|
+
>;
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Measures to compute. At least one required. `rate` is events/second throughput. Use bracket notation for multiple values (e.g., `measures[0]=count`).
|
|
30
|
+
*/
|
|
31
|
+
export type GetEventMetricsMeasuresUnion =
|
|
32
|
+
| GetEventMetricsMeasuresEnum1
|
|
33
|
+
| Array<GetEventMetricsMeasuresEnum2>;
|
|
34
|
+
|
|
35
|
+
export const GetEventMetricsDimensionsEnum2 = {
|
|
36
|
+
TenantId: "tenant_id",
|
|
37
|
+
Topic: "topic",
|
|
38
|
+
DestinationId: "destination_id",
|
|
39
|
+
} as const;
|
|
40
|
+
export type GetEventMetricsDimensionsEnum2 = ClosedEnum<
|
|
41
|
+
typeof GetEventMetricsDimensionsEnum2
|
|
42
|
+
>;
|
|
43
|
+
|
|
44
|
+
export const GetEventMetricsDimensionsEnum1 = {
|
|
45
|
+
TenantId: "tenant_id",
|
|
46
|
+
Topic: "topic",
|
|
47
|
+
DestinationId: "destination_id",
|
|
48
|
+
} as const;
|
|
49
|
+
export type GetEventMetricsDimensionsEnum1 = ClosedEnum<
|
|
50
|
+
typeof GetEventMetricsDimensionsEnum1
|
|
51
|
+
>;
|
|
52
|
+
|
|
53
|
+
/**
|
|
54
|
+
* Dimensions to group results by. Use bracket notation for multiple values (e.g., `dimensions[0]=topic&dimensions[1]=destination_id`).
|
|
55
|
+
*/
|
|
56
|
+
export type GetEventMetricsDimensionsUnion =
|
|
57
|
+
| GetEventMetricsDimensionsEnum1
|
|
58
|
+
| Array<GetEventMetricsDimensionsEnum2>;
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Filter by topic name(s). Use bracket notation for multiple values (e.g., `filters[topic][0]=user.created&filters[topic][1]=user.updated`).
|
|
62
|
+
*/
|
|
63
|
+
export type GetEventMetricsFiltersTopic = string | Array<string>;
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Filter by destination ID(s). Use bracket notation for multiple values (e.g., `filters[destination_id][0]=d1&filters[destination_id][1]=d2`).
|
|
67
|
+
*/
|
|
68
|
+
export type GetEventMetricsFiltersDestinationId = string | Array<string>;
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* Filter by tenant ID(s). Admin-only — rejected with 403 for JWT callers. Use bracket notation for multiple values (e.g., `filters[tenant_id][0]=t1&filters[tenant_id][1]=t2`).
|
|
72
|
+
*/
|
|
73
|
+
export type GetEventMetricsFiltersTenantId = string | Array<string>;
|
|
74
|
+
|
|
75
|
+
export type GetEventMetricsRequest = {
|
|
76
|
+
/**
|
|
77
|
+
* Start of the time range (inclusive). ISO 8601 timestamp.
|
|
78
|
+
*/
|
|
79
|
+
timeStart: Date;
|
|
80
|
+
/**
|
|
81
|
+
* End of the time range (exclusive). ISO 8601 timestamp.
|
|
82
|
+
*/
|
|
83
|
+
timeEnd: Date;
|
|
84
|
+
/**
|
|
85
|
+
* Time bucketing granularity. Pattern: `<number><unit>`.
|
|
86
|
+
*
|
|
87
|
+
* @remarks
|
|
88
|
+
* Units: `s` (1-60), `m` (1-60), `h` (1-24), `d` (1-31), `w` (1-4), `M` (1-12).
|
|
89
|
+
* When omitted, returns a single aggregate row per dimension combination.
|
|
90
|
+
*/
|
|
91
|
+
granularity?: string | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* Measures to compute. At least one required. `rate` is events/second throughput. Use bracket notation for multiple values (e.g., `measures[0]=count`).
|
|
94
|
+
*/
|
|
95
|
+
measures: GetEventMetricsMeasuresEnum1 | Array<GetEventMetricsMeasuresEnum2>;
|
|
96
|
+
/**
|
|
97
|
+
* Dimensions to group results by. Use bracket notation for multiple values (e.g., `dimensions[0]=topic&dimensions[1]=destination_id`).
|
|
98
|
+
*/
|
|
99
|
+
dimensions?:
|
|
100
|
+
| GetEventMetricsDimensionsEnum1
|
|
101
|
+
| Array<GetEventMetricsDimensionsEnum2>
|
|
102
|
+
| undefined;
|
|
103
|
+
/**
|
|
104
|
+
* Filter by topic name(s). Use bracket notation for multiple values (e.g., `filters[topic][0]=user.created&filters[topic][1]=user.updated`).
|
|
105
|
+
*/
|
|
106
|
+
filtersTopic?: string | Array<string> | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* Filter by destination ID(s). Use bracket notation for multiple values (e.g., `filters[destination_id][0]=d1&filters[destination_id][1]=d2`).
|
|
109
|
+
*/
|
|
110
|
+
filtersDestinationId?: string | Array<string> | undefined;
|
|
111
|
+
/**
|
|
112
|
+
* Filter by tenant ID(s). Admin-only — rejected with 403 for JWT callers. Use bracket notation for multiple values (e.g., `filters[tenant_id][0]=t1&filters[tenant_id][1]=t2`).
|
|
113
|
+
*/
|
|
114
|
+
filtersTenantId?: string | Array<string> | undefined;
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
/** @internal */
|
|
118
|
+
export const GetEventMetricsMeasuresEnum2$inboundSchema: z.ZodNativeEnum<
|
|
119
|
+
typeof GetEventMetricsMeasuresEnum2
|
|
120
|
+
> = z.nativeEnum(GetEventMetricsMeasuresEnum2);
|
|
121
|
+
/** @internal */
|
|
122
|
+
export const GetEventMetricsMeasuresEnum2$outboundSchema: z.ZodNativeEnum<
|
|
123
|
+
typeof GetEventMetricsMeasuresEnum2
|
|
124
|
+
> = GetEventMetricsMeasuresEnum2$inboundSchema;
|
|
125
|
+
|
|
126
|
+
/** @internal */
|
|
127
|
+
export const GetEventMetricsMeasuresEnum1$inboundSchema: z.ZodNativeEnum<
|
|
128
|
+
typeof GetEventMetricsMeasuresEnum1
|
|
129
|
+
> = z.nativeEnum(GetEventMetricsMeasuresEnum1);
|
|
130
|
+
/** @internal */
|
|
131
|
+
export const GetEventMetricsMeasuresEnum1$outboundSchema: z.ZodNativeEnum<
|
|
132
|
+
typeof GetEventMetricsMeasuresEnum1
|
|
133
|
+
> = GetEventMetricsMeasuresEnum1$inboundSchema;
|
|
134
|
+
|
|
135
|
+
/** @internal */
|
|
136
|
+
export const GetEventMetricsMeasuresUnion$inboundSchema: z.ZodType<
|
|
137
|
+
GetEventMetricsMeasuresUnion,
|
|
138
|
+
z.ZodTypeDef,
|
|
139
|
+
unknown
|
|
140
|
+
> = z.union([
|
|
141
|
+
GetEventMetricsMeasuresEnum1$inboundSchema,
|
|
142
|
+
z.array(GetEventMetricsMeasuresEnum2$inboundSchema),
|
|
143
|
+
]);
|
|
144
|
+
/** @internal */
|
|
145
|
+
export type GetEventMetricsMeasuresUnion$Outbound = string | Array<string>;
|
|
146
|
+
|
|
147
|
+
/** @internal */
|
|
148
|
+
export const GetEventMetricsMeasuresUnion$outboundSchema: z.ZodType<
|
|
149
|
+
GetEventMetricsMeasuresUnion$Outbound,
|
|
150
|
+
z.ZodTypeDef,
|
|
151
|
+
GetEventMetricsMeasuresUnion
|
|
152
|
+
> = z.union([
|
|
153
|
+
GetEventMetricsMeasuresEnum1$outboundSchema,
|
|
154
|
+
z.array(GetEventMetricsMeasuresEnum2$outboundSchema),
|
|
155
|
+
]);
|
|
156
|
+
|
|
157
|
+
export function getEventMetricsMeasuresUnionToJSON(
|
|
158
|
+
getEventMetricsMeasuresUnion: GetEventMetricsMeasuresUnion,
|
|
159
|
+
): string {
|
|
160
|
+
return JSON.stringify(
|
|
161
|
+
GetEventMetricsMeasuresUnion$outboundSchema.parse(
|
|
162
|
+
getEventMetricsMeasuresUnion,
|
|
163
|
+
),
|
|
164
|
+
);
|
|
165
|
+
}
|
|
166
|
+
export function getEventMetricsMeasuresUnionFromJSON(
|
|
167
|
+
jsonString: string,
|
|
168
|
+
): SafeParseResult<GetEventMetricsMeasuresUnion, SDKValidationError> {
|
|
169
|
+
return safeParse(
|
|
170
|
+
jsonString,
|
|
171
|
+
(x) => GetEventMetricsMeasuresUnion$inboundSchema.parse(JSON.parse(x)),
|
|
172
|
+
`Failed to parse 'GetEventMetricsMeasuresUnion' from JSON`,
|
|
173
|
+
);
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
/** @internal */
|
|
177
|
+
export const GetEventMetricsDimensionsEnum2$inboundSchema: z.ZodNativeEnum<
|
|
178
|
+
typeof GetEventMetricsDimensionsEnum2
|
|
179
|
+
> = z.nativeEnum(GetEventMetricsDimensionsEnum2);
|
|
180
|
+
/** @internal */
|
|
181
|
+
export const GetEventMetricsDimensionsEnum2$outboundSchema: z.ZodNativeEnum<
|
|
182
|
+
typeof GetEventMetricsDimensionsEnum2
|
|
183
|
+
> = GetEventMetricsDimensionsEnum2$inboundSchema;
|
|
184
|
+
|
|
185
|
+
/** @internal */
|
|
186
|
+
export const GetEventMetricsDimensionsEnum1$inboundSchema: z.ZodNativeEnum<
|
|
187
|
+
typeof GetEventMetricsDimensionsEnum1
|
|
188
|
+
> = z.nativeEnum(GetEventMetricsDimensionsEnum1);
|
|
189
|
+
/** @internal */
|
|
190
|
+
export const GetEventMetricsDimensionsEnum1$outboundSchema: z.ZodNativeEnum<
|
|
191
|
+
typeof GetEventMetricsDimensionsEnum1
|
|
192
|
+
> = GetEventMetricsDimensionsEnum1$inboundSchema;
|
|
193
|
+
|
|
194
|
+
/** @internal */
|
|
195
|
+
export const GetEventMetricsDimensionsUnion$inboundSchema: z.ZodType<
|
|
196
|
+
GetEventMetricsDimensionsUnion,
|
|
197
|
+
z.ZodTypeDef,
|
|
198
|
+
unknown
|
|
199
|
+
> = z.union([
|
|
200
|
+
GetEventMetricsDimensionsEnum1$inboundSchema,
|
|
201
|
+
z.array(GetEventMetricsDimensionsEnum2$inboundSchema),
|
|
202
|
+
]);
|
|
203
|
+
/** @internal */
|
|
204
|
+
export type GetEventMetricsDimensionsUnion$Outbound = string | Array<string>;
|
|
205
|
+
|
|
206
|
+
/** @internal */
|
|
207
|
+
export const GetEventMetricsDimensionsUnion$outboundSchema: z.ZodType<
|
|
208
|
+
GetEventMetricsDimensionsUnion$Outbound,
|
|
209
|
+
z.ZodTypeDef,
|
|
210
|
+
GetEventMetricsDimensionsUnion
|
|
211
|
+
> = z.union([
|
|
212
|
+
GetEventMetricsDimensionsEnum1$outboundSchema,
|
|
213
|
+
z.array(GetEventMetricsDimensionsEnum2$outboundSchema),
|
|
214
|
+
]);
|
|
215
|
+
|
|
216
|
+
export function getEventMetricsDimensionsUnionToJSON(
|
|
217
|
+
getEventMetricsDimensionsUnion: GetEventMetricsDimensionsUnion,
|
|
218
|
+
): string {
|
|
219
|
+
return JSON.stringify(
|
|
220
|
+
GetEventMetricsDimensionsUnion$outboundSchema.parse(
|
|
221
|
+
getEventMetricsDimensionsUnion,
|
|
222
|
+
),
|
|
223
|
+
);
|
|
224
|
+
}
|
|
225
|
+
export function getEventMetricsDimensionsUnionFromJSON(
|
|
226
|
+
jsonString: string,
|
|
227
|
+
): SafeParseResult<GetEventMetricsDimensionsUnion, SDKValidationError> {
|
|
228
|
+
return safeParse(
|
|
229
|
+
jsonString,
|
|
230
|
+
(x) => GetEventMetricsDimensionsUnion$inboundSchema.parse(JSON.parse(x)),
|
|
231
|
+
`Failed to parse 'GetEventMetricsDimensionsUnion' from JSON`,
|
|
232
|
+
);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
/** @internal */
|
|
236
|
+
export const GetEventMetricsFiltersTopic$inboundSchema: z.ZodType<
|
|
237
|
+
GetEventMetricsFiltersTopic,
|
|
238
|
+
z.ZodTypeDef,
|
|
239
|
+
unknown
|
|
240
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
241
|
+
/** @internal */
|
|
242
|
+
export type GetEventMetricsFiltersTopic$Outbound = string | Array<string>;
|
|
243
|
+
|
|
244
|
+
/** @internal */
|
|
245
|
+
export const GetEventMetricsFiltersTopic$outboundSchema: z.ZodType<
|
|
246
|
+
GetEventMetricsFiltersTopic$Outbound,
|
|
247
|
+
z.ZodTypeDef,
|
|
248
|
+
GetEventMetricsFiltersTopic
|
|
249
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
250
|
+
|
|
251
|
+
export function getEventMetricsFiltersTopicToJSON(
|
|
252
|
+
getEventMetricsFiltersTopic: GetEventMetricsFiltersTopic,
|
|
253
|
+
): string {
|
|
254
|
+
return JSON.stringify(
|
|
255
|
+
GetEventMetricsFiltersTopic$outboundSchema.parse(
|
|
256
|
+
getEventMetricsFiltersTopic,
|
|
257
|
+
),
|
|
258
|
+
);
|
|
259
|
+
}
|
|
260
|
+
export function getEventMetricsFiltersTopicFromJSON(
|
|
261
|
+
jsonString: string,
|
|
262
|
+
): SafeParseResult<GetEventMetricsFiltersTopic, SDKValidationError> {
|
|
263
|
+
return safeParse(
|
|
264
|
+
jsonString,
|
|
265
|
+
(x) => GetEventMetricsFiltersTopic$inboundSchema.parse(JSON.parse(x)),
|
|
266
|
+
`Failed to parse 'GetEventMetricsFiltersTopic' from JSON`,
|
|
267
|
+
);
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
/** @internal */
|
|
271
|
+
export const GetEventMetricsFiltersDestinationId$inboundSchema: z.ZodType<
|
|
272
|
+
GetEventMetricsFiltersDestinationId,
|
|
273
|
+
z.ZodTypeDef,
|
|
274
|
+
unknown
|
|
275
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
276
|
+
/** @internal */
|
|
277
|
+
export type GetEventMetricsFiltersDestinationId$Outbound =
|
|
278
|
+
| string
|
|
279
|
+
| Array<string>;
|
|
280
|
+
|
|
281
|
+
/** @internal */
|
|
282
|
+
export const GetEventMetricsFiltersDestinationId$outboundSchema: z.ZodType<
|
|
283
|
+
GetEventMetricsFiltersDestinationId$Outbound,
|
|
284
|
+
z.ZodTypeDef,
|
|
285
|
+
GetEventMetricsFiltersDestinationId
|
|
286
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
287
|
+
|
|
288
|
+
export function getEventMetricsFiltersDestinationIdToJSON(
|
|
289
|
+
getEventMetricsFiltersDestinationId: GetEventMetricsFiltersDestinationId,
|
|
290
|
+
): string {
|
|
291
|
+
return JSON.stringify(
|
|
292
|
+
GetEventMetricsFiltersDestinationId$outboundSchema.parse(
|
|
293
|
+
getEventMetricsFiltersDestinationId,
|
|
294
|
+
),
|
|
295
|
+
);
|
|
296
|
+
}
|
|
297
|
+
export function getEventMetricsFiltersDestinationIdFromJSON(
|
|
298
|
+
jsonString: string,
|
|
299
|
+
): SafeParseResult<GetEventMetricsFiltersDestinationId, SDKValidationError> {
|
|
300
|
+
return safeParse(
|
|
301
|
+
jsonString,
|
|
302
|
+
(x) =>
|
|
303
|
+
GetEventMetricsFiltersDestinationId$inboundSchema.parse(JSON.parse(x)),
|
|
304
|
+
`Failed to parse 'GetEventMetricsFiltersDestinationId' from JSON`,
|
|
305
|
+
);
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
/** @internal */
|
|
309
|
+
export const GetEventMetricsFiltersTenantId$inboundSchema: z.ZodType<
|
|
310
|
+
GetEventMetricsFiltersTenantId,
|
|
311
|
+
z.ZodTypeDef,
|
|
312
|
+
unknown
|
|
313
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
314
|
+
/** @internal */
|
|
315
|
+
export type GetEventMetricsFiltersTenantId$Outbound = string | Array<string>;
|
|
316
|
+
|
|
317
|
+
/** @internal */
|
|
318
|
+
export const GetEventMetricsFiltersTenantId$outboundSchema: z.ZodType<
|
|
319
|
+
GetEventMetricsFiltersTenantId$Outbound,
|
|
320
|
+
z.ZodTypeDef,
|
|
321
|
+
GetEventMetricsFiltersTenantId
|
|
322
|
+
> = z.union([z.string(), z.array(z.string())]);
|
|
323
|
+
|
|
324
|
+
export function getEventMetricsFiltersTenantIdToJSON(
|
|
325
|
+
getEventMetricsFiltersTenantId: GetEventMetricsFiltersTenantId,
|
|
326
|
+
): string {
|
|
327
|
+
return JSON.stringify(
|
|
328
|
+
GetEventMetricsFiltersTenantId$outboundSchema.parse(
|
|
329
|
+
getEventMetricsFiltersTenantId,
|
|
330
|
+
),
|
|
331
|
+
);
|
|
332
|
+
}
|
|
333
|
+
export function getEventMetricsFiltersTenantIdFromJSON(
|
|
334
|
+
jsonString: string,
|
|
335
|
+
): SafeParseResult<GetEventMetricsFiltersTenantId, SDKValidationError> {
|
|
336
|
+
return safeParse(
|
|
337
|
+
jsonString,
|
|
338
|
+
(x) => GetEventMetricsFiltersTenantId$inboundSchema.parse(JSON.parse(x)),
|
|
339
|
+
`Failed to parse 'GetEventMetricsFiltersTenantId' from JSON`,
|
|
340
|
+
);
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
/** @internal */
|
|
344
|
+
export const GetEventMetricsRequest$inboundSchema: z.ZodType<
|
|
345
|
+
GetEventMetricsRequest,
|
|
346
|
+
z.ZodTypeDef,
|
|
347
|
+
unknown
|
|
348
|
+
> = z.object({
|
|
349
|
+
"time[start]": z.string().datetime({ offset: true }).transform(v =>
|
|
350
|
+
new Date(v)
|
|
351
|
+
),
|
|
352
|
+
"time[end]": z.string().datetime({ offset: true }).transform(v =>
|
|
353
|
+
new Date(v)
|
|
354
|
+
),
|
|
355
|
+
granularity: z.string().optional(),
|
|
356
|
+
measures: z.union([
|
|
357
|
+
GetEventMetricsMeasuresEnum1$inboundSchema,
|
|
358
|
+
z.array(GetEventMetricsMeasuresEnum2$inboundSchema),
|
|
359
|
+
]),
|
|
360
|
+
dimensions: z.union([
|
|
361
|
+
GetEventMetricsDimensionsEnum1$inboundSchema,
|
|
362
|
+
z.array(GetEventMetricsDimensionsEnum2$inboundSchema),
|
|
363
|
+
]).optional(),
|
|
364
|
+
"filters[topic]": z.union([z.string(), z.array(z.string())]).optional(),
|
|
365
|
+
"filters[destination_id]": z.union([z.string(), z.array(z.string())])
|
|
366
|
+
.optional(),
|
|
367
|
+
"filters[tenant_id]": z.union([z.string(), z.array(z.string())]).optional(),
|
|
368
|
+
}).transform((v) => {
|
|
369
|
+
return remap$(v, {
|
|
370
|
+
"time[start]": "timeStart",
|
|
371
|
+
"time[end]": "timeEnd",
|
|
372
|
+
"filters[topic]": "filtersTopic",
|
|
373
|
+
"filters[destination_id]": "filtersDestinationId",
|
|
374
|
+
"filters[tenant_id]": "filtersTenantId",
|
|
375
|
+
});
|
|
376
|
+
});
|
|
377
|
+
/** @internal */
|
|
378
|
+
export type GetEventMetricsRequest$Outbound = {
|
|
379
|
+
"time[start]": string;
|
|
380
|
+
"time[end]": string;
|
|
381
|
+
granularity?: string | undefined;
|
|
382
|
+
measures: string | Array<string>;
|
|
383
|
+
dimensions?: string | Array<string> | undefined;
|
|
384
|
+
"filters[topic]"?: string | Array<string> | undefined;
|
|
385
|
+
"filters[destination_id]"?: string | Array<string> | undefined;
|
|
386
|
+
"filters[tenant_id]"?: string | Array<string> | undefined;
|
|
387
|
+
};
|
|
388
|
+
|
|
389
|
+
/** @internal */
|
|
390
|
+
export const GetEventMetricsRequest$outboundSchema: z.ZodType<
|
|
391
|
+
GetEventMetricsRequest$Outbound,
|
|
392
|
+
z.ZodTypeDef,
|
|
393
|
+
GetEventMetricsRequest
|
|
394
|
+
> = z.object({
|
|
395
|
+
timeStart: z.date().transform(v => v.toISOString()),
|
|
396
|
+
timeEnd: z.date().transform(v => v.toISOString()),
|
|
397
|
+
granularity: z.string().optional(),
|
|
398
|
+
measures: z.union([
|
|
399
|
+
GetEventMetricsMeasuresEnum1$outboundSchema,
|
|
400
|
+
z.array(GetEventMetricsMeasuresEnum2$outboundSchema),
|
|
401
|
+
]),
|
|
402
|
+
dimensions: z.union([
|
|
403
|
+
GetEventMetricsDimensionsEnum1$outboundSchema,
|
|
404
|
+
z.array(GetEventMetricsDimensionsEnum2$outboundSchema),
|
|
405
|
+
]).optional(),
|
|
406
|
+
filtersTopic: z.union([z.string(), z.array(z.string())]).optional(),
|
|
407
|
+
filtersDestinationId: z.union([z.string(), z.array(z.string())]).optional(),
|
|
408
|
+
filtersTenantId: z.union([z.string(), z.array(z.string())]).optional(),
|
|
409
|
+
}).transform((v) => {
|
|
410
|
+
return remap$(v, {
|
|
411
|
+
timeStart: "time[start]",
|
|
412
|
+
timeEnd: "time[end]",
|
|
413
|
+
filtersTopic: "filters[topic]",
|
|
414
|
+
filtersDestinationId: "filters[destination_id]",
|
|
415
|
+
filtersTenantId: "filters[tenant_id]",
|
|
416
|
+
});
|
|
417
|
+
});
|
|
418
|
+
|
|
419
|
+
export function getEventMetricsRequestToJSON(
|
|
420
|
+
getEventMetricsRequest: GetEventMetricsRequest,
|
|
421
|
+
): string {
|
|
422
|
+
return JSON.stringify(
|
|
423
|
+
GetEventMetricsRequest$outboundSchema.parse(getEventMetricsRequest),
|
|
424
|
+
);
|
|
425
|
+
}
|
|
426
|
+
export function getEventMetricsRequestFromJSON(
|
|
427
|
+
jsonString: string,
|
|
428
|
+
): SafeParseResult<GetEventMetricsRequest, SDKValidationError> {
|
|
429
|
+
return safeParse(
|
|
430
|
+
jsonString,
|
|
431
|
+
(x) => GetEventMetricsRequest$inboundSchema.parse(JSON.parse(x)),
|
|
432
|
+
`Failed to parse 'GetEventMetricsRequest' from JSON`,
|
|
433
|
+
);
|
|
434
|
+
}
|
|
@@ -15,6 +15,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
|
15
15
|
* - `event`: Include event summary
|
|
16
16
|
* - `event.data`: Include full event with payload data
|
|
17
17
|
* - `response_data`: Include response body and headers
|
|
18
|
+
* - `destination`: Include the full destination object
|
|
18
19
|
*/
|
|
19
20
|
export type GetTenantDestinationAttemptInclude = string | Array<string>;
|
|
20
21
|
|
|
@@ -38,6 +39,7 @@ export type GetTenantDestinationAttemptRequest = {
|
|
|
38
39
|
* - `event`: Include event summary
|
|
39
40
|
* - `event.data`: Include full event with payload data
|
|
40
41
|
* - `response_data`: Include response body and headers
|
|
42
|
+
* - `destination`: Include the full destination object
|
|
41
43
|
*/
|
|
42
44
|
include?: string | Array<string> | undefined;
|
|
43
45
|
};
|
|
@@ -8,8 +8,10 @@ export * from "./deletetenantdestination.js";
|
|
|
8
8
|
export * from "./disabletenantdestination.js";
|
|
9
9
|
export * from "./enabletenantdestination.js";
|
|
10
10
|
export * from "./getattempt.js";
|
|
11
|
+
export * from "./getattemptmetrics.js";
|
|
11
12
|
export * from "./getdestinationtypeschema.js";
|
|
12
13
|
export * from "./getevent.js";
|
|
14
|
+
export * from "./geteventmetrics.js";
|
|
13
15
|
export * from "./gettenant.js";
|
|
14
16
|
export * from "./gettenantdestination.js";
|
|
15
17
|
export * from "./gettenantdestinationattempt.js";
|
|
@@ -53,6 +53,7 @@ export type ListAttemptsTopic = string | Array<string>;
|
|
|
53
53
|
* - `event`: Include event summary (id, topic, time, eligible_for_retry, metadata)
|
|
54
54
|
* - `event.data`: Include full event with payload data
|
|
55
55
|
* - `response_data`: Include response body and headers
|
|
56
|
+
* - `destination`: Include the full destination object
|
|
56
57
|
*/
|
|
57
58
|
export type ListAttemptsInclude = string | Array<string>;
|
|
58
59
|
|
|
@@ -139,6 +140,7 @@ export type ListAttemptsRequest = {
|
|
|
139
140
|
* - `event`: Include event summary (id, topic, time, eligible_for_retry, metadata)
|
|
140
141
|
* - `event.data`: Include full event with payload data
|
|
141
142
|
* - `response_data`: Include response body and headers
|
|
143
|
+
* - `destination`: Include the full destination object
|
|
142
144
|
*/
|
|
143
145
|
include?: string | Array<string> | undefined;
|
|
144
146
|
/**
|
|
@@ -41,6 +41,7 @@ export type ListTenantDestinationAttemptsTopic = string | Array<string>;
|
|
|
41
41
|
* - `event`: Include event summary (id, topic, time, eligible_for_retry, metadata)
|
|
42
42
|
* - `event.data`: Include full event with payload data
|
|
43
43
|
* - `response_data`: Include response body and headers
|
|
44
|
+
* - `destination`: Include the full destination object
|
|
44
45
|
*/
|
|
45
46
|
export type ListTenantDestinationAttemptsInclude = string | Array<string>;
|
|
46
47
|
|
|
@@ -127,6 +128,7 @@ export type ListTenantDestinationAttemptsRequest = {
|
|
|
127
128
|
* - `event`: Include event summary (id, topic, time, eligible_for_retry, metadata)
|
|
128
129
|
* - `event.data`: Include full event with payload data
|
|
129
130
|
* - `response_data`: Include response body and headers
|
|
131
|
+
* - `destination`: Include the full destination object
|
|
130
132
|
*/
|
|
131
133
|
include?: string | Array<string> | undefined;
|
|
132
134
|
/**
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { metricsGetAttemptMetrics } from "../funcs/metricsGetAttemptMetrics.js";
|
|
6
|
+
import { metricsGetEventMetrics } from "../funcs/metricsGetEventMetrics.js";
|
|
7
|
+
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
8
|
+
import * as components from "../models/components/index.js";
|
|
9
|
+
import * as operations from "../models/operations/index.js";
|
|
10
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
11
|
+
|
|
12
|
+
export class Metrics extends ClientSDK {
|
|
13
|
+
/**
|
|
14
|
+
* Get Event Metrics
|
|
15
|
+
*
|
|
16
|
+
* @remarks
|
|
17
|
+
* Returns aggregated event publish metrics. Supports time bucketing via granularity,
|
|
18
|
+
* dimensional grouping, and filtering.
|
|
19
|
+
*
|
|
20
|
+
* **Measures:** `count`, `rate`
|
|
21
|
+
*
|
|
22
|
+
* **Dimensions:** `tenant_id` (admin-only), `topic`, `destination_id`
|
|
23
|
+
*
|
|
24
|
+
* **Filters:** `tenant_id` (admin-only), `topic`, `destination_id`
|
|
25
|
+
*/
|
|
26
|
+
async getEventMetrics(
|
|
27
|
+
request: operations.GetEventMetricsRequest,
|
|
28
|
+
options?: RequestOptions,
|
|
29
|
+
): Promise<components.MetricsResponse> {
|
|
30
|
+
return unwrapAsync(metricsGetEventMetrics(
|
|
31
|
+
this,
|
|
32
|
+
request,
|
|
33
|
+
options,
|
|
34
|
+
));
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Get Attempt Metrics
|
|
39
|
+
*
|
|
40
|
+
* @remarks
|
|
41
|
+
* Returns aggregated delivery attempt metrics. Supports time bucketing via granularity,
|
|
42
|
+
* dimensional grouping, and filtering.
|
|
43
|
+
*
|
|
44
|
+
* **Measures:** `count`, `successful_count`, `failed_count`, `error_rate`,
|
|
45
|
+
* `first_attempt_count`, `retry_count`, `manual_retry_count`, `avg_attempt_number`,
|
|
46
|
+
* `rate`, `successful_rate`, `failed_rate`
|
|
47
|
+
*
|
|
48
|
+
* **Dimensions:** `tenant_id` (admin-only), `destination_id`, `topic`, `status`, `code`, `manual`, `attempt_number`
|
|
49
|
+
*
|
|
50
|
+
* **Filters:** `tenant_id` (admin-only), `destination_id`, `topic`, `status`, `code`, `manual`, `attempt_number`
|
|
51
|
+
*/
|
|
52
|
+
async getAttemptMetrics(
|
|
53
|
+
request: operations.GetAttemptMetricsRequest,
|
|
54
|
+
options?: RequestOptions,
|
|
55
|
+
): Promise<components.MetricsResponse> {
|
|
56
|
+
return unwrapAsync(metricsGetAttemptMetrics(
|
|
57
|
+
this,
|
|
58
|
+
request,
|
|
59
|
+
options,
|
|
60
|
+
));
|
|
61
|
+
}
|
|
62
|
+
}
|
package/src/sdk/sdk.ts
CHANGED
|
@@ -7,6 +7,7 @@ import { Attempts } from "./attempts.js";
|
|
|
7
7
|
import { Destinations } from "./destinations.js";
|
|
8
8
|
import { Events } from "./events.js";
|
|
9
9
|
import { Health } from "./health.js";
|
|
10
|
+
import { Metrics } from "./metrics.js";
|
|
10
11
|
import { Publish } from "./publish.js";
|
|
11
12
|
import { Schemas } from "./schemas.js";
|
|
12
13
|
import { Tenants } from "./tenants.js";
|
|
@@ -52,4 +53,9 @@ export class Outpost extends ClientSDK {
|
|
|
52
53
|
get topics(): Topics {
|
|
53
54
|
return (this._topics ??= new Topics(this._options));
|
|
54
55
|
}
|
|
56
|
+
|
|
57
|
+
private _metrics?: Metrics;
|
|
58
|
+
get metrics(): Metrics {
|
|
59
|
+
return (this._metrics ??= new Metrics(this._options));
|
|
60
|
+
}
|
|
55
61
|
}
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
import * as z from "zod/v3";
|
|
2
|
-
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
3
|
-
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
4
|
-
/**
|
|
5
|
-
* Full event object with data (returned when include=event.data).
|
|
6
|
-
*/
|
|
7
|
-
export type EventFull = {
|
|
8
|
-
id?: string | undefined;
|
|
9
|
-
/**
|
|
10
|
-
* The tenant this event belongs to.
|
|
11
|
-
*/
|
|
12
|
-
tenantId?: string | undefined;
|
|
13
|
-
/**
|
|
14
|
-
* The destination this event was delivered to.
|
|
15
|
-
*/
|
|
16
|
-
destinationId?: string | undefined;
|
|
17
|
-
topic?: string | undefined;
|
|
18
|
-
/**
|
|
19
|
-
* Time the event was received.
|
|
20
|
-
*/
|
|
21
|
-
time?: Date | undefined;
|
|
22
|
-
/**
|
|
23
|
-
* Whether this event can be retried.
|
|
24
|
-
*/
|
|
25
|
-
eligibleForRetry?: boolean | undefined;
|
|
26
|
-
metadata?: {
|
|
27
|
-
[k: string]: string;
|
|
28
|
-
} | null | undefined;
|
|
29
|
-
/**
|
|
30
|
-
* The event payload data.
|
|
31
|
-
*/
|
|
32
|
-
data?: {
|
|
33
|
-
[k: string]: any;
|
|
34
|
-
} | undefined;
|
|
35
|
-
};
|
|
36
|
-
/** @internal */
|
|
37
|
-
export declare const EventFull$inboundSchema: z.ZodType<EventFull, z.ZodTypeDef, unknown>;
|
|
38
|
-
/** @internal */
|
|
39
|
-
export type EventFull$Outbound = {
|
|
40
|
-
id?: string | undefined;
|
|
41
|
-
tenant_id?: string | undefined;
|
|
42
|
-
destination_id?: string | undefined;
|
|
43
|
-
topic?: string | undefined;
|
|
44
|
-
time?: string | undefined;
|
|
45
|
-
eligible_for_retry?: boolean | undefined;
|
|
46
|
-
metadata?: {
|
|
47
|
-
[k: string]: string;
|
|
48
|
-
} | null | undefined;
|
|
49
|
-
data?: {
|
|
50
|
-
[k: string]: any;
|
|
51
|
-
} | undefined;
|
|
52
|
-
};
|
|
53
|
-
/** @internal */
|
|
54
|
-
export declare const EventFull$outboundSchema: z.ZodType<EventFull$Outbound, z.ZodTypeDef, EventFull>;
|
|
55
|
-
export declare function eventFullToJSON(eventFull: EventFull): string;
|
|
56
|
-
export declare function eventFullFromJSON(jsonString: string): SafeParseResult<EventFull, SDKValidationError>;
|
|
57
|
-
//# sourceMappingURL=eventfull.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"eventfull.d.ts","sourceRoot":"","sources":["../../../../src/models/components/eventfull.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,GAAG,SAAS,CAAC;IACtD;;OAEG;IACH,IAAI,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,OAAO,CAC7C,SAAS,EACT,CAAC,CAAC,UAAU,EACZ,OAAO,CAiBP,CAAC;AACH,gBAAgB;AAChB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACzC,QAAQ,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,GAAG,SAAS,CAAC;IACtD,IAAI,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,SAAS,CAgBT,CAAC;AAEH,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE5D;AACD,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"eventfull.js","sourceRoot":"","sources":["../../../../src/models/components/eventfull.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FH,0CAEC;AACD,8CAQC;AAtGD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAiCjD,gBAAgB;AACH,QAAA,uBAAuB,GAIhC,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;SACpE,QAAQ,EAAE;IACb,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC1C,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrD,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,WAAW,EAAE,UAAU;QACvB,gBAAgB,EAAE,eAAe;QACjC,oBAAoB,EAAE,kBAAkB;KACzC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAaH,gBAAgB;AACH,QAAA,wBAAwB,GAIjC,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE;IACzD,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACxC,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrD,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,QAAQ,EAAE,WAAW;QACrB,aAAa,EAAE,gBAAgB;QAC/B,gBAAgB,EAAE,oBAAoB;KACvC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,eAAe,CAAC,SAAoB;IAClD,OAAO,IAAI,CAAC,SAAS,CAAC,gCAAwB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;AACnE,CAAC;AACD,SAAgB,iBAAiB,CAC/B,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+BAAuB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,uCAAuC,CACxC,CAAC;AACJ,CAAC"}
|