samva 0.16.0 → 0.18.0

package/dist/effect/generated/analytics.js

@@ -0,0 +1,188 @@
+import { AbsoluteInstant } from "../runtime.js";
+import { AnalyticsQueryError, ApiKeySecurityMiddleware, ForbiddenError, GatewayTimeoutError, InternalError, UnauthorizedError, ValidationError } from "./shared.js";
+import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/http-api";
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/analytics.ts
+const AnalyticsGetChannelStatsQuery = /* @__PURE__ */ Schema.Struct({
+	after: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null])),
+	before: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null]))
+});
+const AnalyticsGetChannelStats200 = /* @__PURE__ */ Schema.Struct({ email: Schema.Struct({
+	sent: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	deliveryRate: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	uniqueOpenedMessages: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	openTrackingEligibleDeliveredMessages: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	uniqueMessageOpenRate: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	uniqueClickedMessages: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	clickTrackingEligibleDeliveredMessages: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	uniqueMessageClickRate: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	bounceRate: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" }))
+}) });
+const AnalyticsGetChannelStats400 = AnalyticsQueryError;
+const AnalyticsGetChannelStats401 = UnauthorizedError;
+const AnalyticsGetChannelStats403 = ForbiddenError;
+const AnalyticsGetChannelStats422 = ValidationError;
+const AnalyticsGetChannelStats500 = InternalError;
+const AnalyticsGetChannelStats504 = GatewayTimeoutError;
+const AnalyticsGetDeliveryMetricsQuery = /* @__PURE__ */ Schema.Struct({
+	after: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null])),
+	before: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null])),
+	channel: Schema.optionalKey(Schema.Union([Schema.Literal("email"), Schema.Null]))
+});
+const AnalyticsGetDeliveryMetrics200 = /* @__PURE__ */ Schema.Struct({
+	deliveredRate: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	failedRate: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	pendingRate: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	avgDeliveryTimeMs: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" }))
+});
+const AnalyticsGetDeliveryMetrics400 = AnalyticsQueryError;
+const AnalyticsGetDeliveryMetrics401 = UnauthorizedError;
+const AnalyticsGetDeliveryMetrics403 = ForbiddenError;
+const AnalyticsGetDeliveryMetrics422 = ValidationError;
+const AnalyticsGetDeliveryMetrics500 = InternalError;
+const AnalyticsGetDeliveryMetrics504 = GatewayTimeoutError;
+const AnalyticsExportDataRequestJson = /* @__PURE__ */ Schema.Struct({
+	after: AbsoluteInstant,
+	before: AbsoluteInstant,
+	format: Schema.optionalKey(Schema.Union([Schema.Union([Schema.Literal("csv"), Schema.Literal("json")]), Schema.Null])),
+	includeChannels: Schema.optionalKey(Schema.Union([Schema.Array(Schema.Literal("email")), Schema.Null]))
+});
+const AnalyticsExportData200 = /* @__PURE__ */ Schema.Struct({
+	content: Schema.String,
+	mimeType: Schema.String,
+	filename: Schema.String
+});
+const AnalyticsExportData400 = AnalyticsQueryError;
+const AnalyticsExportData401 = UnauthorizedError;
+const AnalyticsExportData403 = ForbiddenError;
+const AnalyticsExportData422 = ValidationError;
+const AnalyticsExportData500 = InternalError;
+const AnalyticsExportData504 = GatewayTimeoutError;
+const AnalyticsGetHourlyDistributionQuery = /* @__PURE__ */ Schema.Struct({
+	after: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null])),
+	before: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null]))
+});
+const AnalyticsGetHourlyDistribution200 = /* @__PURE__ */ Schema.Array(Schema.Struct({
+	hour: Schema.String,
+	count: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" }))
+}));
+const AnalyticsGetHourlyDistribution400 = AnalyticsQueryError;
+const AnalyticsGetHourlyDistribution401 = UnauthorizedError;
+const AnalyticsGetHourlyDistribution403 = ForbiddenError;
+const AnalyticsGetHourlyDistribution422 = ValidationError;
+const AnalyticsGetHourlyDistribution500 = InternalError;
+const AnalyticsGetHourlyDistribution504 = GatewayTimeoutError;
+const AnalyticsGetStatsQuery = /* @__PURE__ */ Schema.Struct({
+	after: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null])),
+	before: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null])),
+	groupBy: Schema.optionalKey(Schema.Union([Schema.Union([
+		Schema.Literal("day"),
+		Schema.Literal("week"),
+		Schema.Literal("month")
+	]), Schema.Null])),
+	channel: Schema.optionalKey(Schema.Union([Schema.Literal("email"), Schema.Null]))
+});
+const AnalyticsGetStats200 = /* @__PURE__ */ Schema.Struct({ volumeHistory: Schema.Array(Schema.Struct({
+	date: Schema.String,
+	email: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" }))
+})) });
+const AnalyticsGetStats400 = AnalyticsQueryError;
+const AnalyticsGetStats401 = UnauthorizedError;
+const AnalyticsGetStats403 = ForbiddenError;
+const AnalyticsGetStats422 = ValidationError;
+const AnalyticsGetStats500 = InternalError;
+const AnalyticsGetStats504 = GatewayTimeoutError;
+const AnalyticsGetTopContactsQuery = /* @__PURE__ */ Schema.Struct({
+	after: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null])),
+	before: Schema.optionalKey(Schema.Union([AbsoluteInstant, Schema.Null])),
+	limit: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	sortBy: Schema.optionalKey(Schema.Union([Schema.Union([
+		Schema.Literal("sent"),
+		Schema.Literal("received"),
+		Schema.Literal("total")
+	]), Schema.Null]))
+});
+const AnalyticsGetTopContacts200 = /* @__PURE__ */ Schema.Array(Schema.Struct({
+	id: Schema.String,
+	name: Schema.Union([Schema.String, Schema.Null]),
+	email: Schema.Union([Schema.String, Schema.Null]),
+	phone: Schema.Union([Schema.String, Schema.Null]),
+	messageCount: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" }))
+}));
+const AnalyticsGetTopContacts400 = AnalyticsQueryError;
+const AnalyticsGetTopContacts401 = UnauthorizedError;
+const AnalyticsGetTopContacts403 = ForbiddenError;
+const AnalyticsGetTopContacts422 = ValidationError;
+const AnalyticsGetTopContacts500 = InternalError;
+const AnalyticsGetTopContacts504 = GatewayTimeoutError;
+var AnalyticsGroup = class extends HttpApiGroup.make("Analytics").add(HttpApiEndpoint.get("analyticsGetChannelStats", "/v1/analytics/channel-stats", {
+	query: AnalyticsGetChannelStatsQuery,
+	success: AnalyticsGetChannelStats200,
+	error: [
+		AnalyticsGetChannelStats400.pipe(HttpApiSchema.status(400)),
+		AnalyticsGetChannelStats401.pipe(HttpApiSchema.status(401)),
+		AnalyticsGetChannelStats403.pipe(HttpApiSchema.status(403)),
+		AnalyticsGetChannelStats422.pipe(HttpApiSchema.status(422)),
+		AnalyticsGetChannelStats500,
+		AnalyticsGetChannelStats504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "analytics.getChannelStats").annotate(OpenApi.Summary, "Get channel performance analytics").annotate(OpenApi.Description, "Returns aggregate delivery metrics plus unique-message email Open and Click rates over the selected date range. `sent` counts every outbound message accepted in the range; each rate is taken over the messages the channel actually attempted, so one still waiting to be sent neither helps nor hurts it. Each engagement rate uses the corresponding tracking-eligible delivered-message cohort; repeated provider observations do not inflate the numerator."), HttpApiEndpoint.get("analyticsGetDeliveryMetrics", "/v1/analytics/delivery-metrics", {
+	query: AnalyticsGetDeliveryMetricsQuery,
+	success: AnalyticsGetDeliveryMetrics200,
+	error: [
+		AnalyticsGetDeliveryMetrics400.pipe(HttpApiSchema.status(400)),
+		AnalyticsGetDeliveryMetrics401.pipe(HttpApiSchema.status(401)),
+		AnalyticsGetDeliveryMetrics403.pipe(HttpApiSchema.status(403)),
+		AnalyticsGetDeliveryMetrics422.pipe(HttpApiSchema.status(422)),
+		AnalyticsGetDeliveryMetrics500,
+		AnalyticsGetDeliveryMetrics504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "analytics.getDeliveryMetrics").annotate(OpenApi.Summary, "Get message delivery metrics").annotate(OpenApi.Description, "Returns delivered, failed, and pending rates plus average delivery time for the outbound messages accepted in the selected date range, optionally filtered by channel. Every accepted message falls into exactly one of the three, so they always sum to 100%: a complaint counts as delivered because the message arrived, a bounce counts as failed, and anything the provider has not resolved yet counts as pending. Mail your organization received is not rated here."), HttpApiEndpoint.post("analyticsExportData", "/v1/analytics/export", {
+	payload: AnalyticsExportDataRequestJson,
+	success: AnalyticsExportData200,
+	error: [
+		AnalyticsExportData400.pipe(HttpApiSchema.status(400)),
+		AnalyticsExportData401.pipe(HttpApiSchema.status(401)),
+		AnalyticsExportData403.pipe(HttpApiSchema.status(403)),
+		AnalyticsExportData422.pipe(HttpApiSchema.status(422)),
+		AnalyticsExportData500,
+		AnalyticsExportData504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "analytics.exportData").annotate(OpenApi.Summary, "Export messaging analytics data").annotate(OpenApi.Description, "Exports one record per outbound message accepted in the given date range as CSV or JSON and returns the file content inline. CSV follows RFC 4180: fields containing a quote, comma, or line break are quoted with embedded quotes doubled, and records are separated by CRLF. At most 10,000 records are returned, newest first."), HttpApiEndpoint.get("analyticsGetHourlyDistribution", "/v1/analytics/hourly-distribution", {
+	query: AnalyticsGetHourlyDistributionQuery,
+	success: AnalyticsGetHourlyDistribution200,
+	error: [
+		AnalyticsGetHourlyDistribution400.pipe(HttpApiSchema.status(400)),
+		AnalyticsGetHourlyDistribution401.pipe(HttpApiSchema.status(401)),
+		AnalyticsGetHourlyDistribution403.pipe(HttpApiSchema.status(403)),
+		AnalyticsGetHourlyDistribution422.pipe(HttpApiSchema.status(422)),
+		AnalyticsGetHourlyDistribution500,
+		AnalyticsGetHourlyDistribution504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "analytics.getHourlyDistribution").annotate(OpenApi.Summary, "Get hourly message distribution").annotate(OpenApi.Description, "Returns outbound message counts over the half-open selected instant range, bucketed by organization-local hour. Empty ranges return no rows; non-empty ranges include all 24 hours."), HttpApiEndpoint.get("analyticsGetStats", "/v1/analytics/stats", {
+	query: AnalyticsGetStatsQuery,
+	success: AnalyticsGetStats200,
+	error: [
+		AnalyticsGetStats400.pipe(HttpApiSchema.status(400)),
+		AnalyticsGetStats401.pipe(HttpApiSchema.status(401)),
+		AnalyticsGetStats403.pipe(HttpApiSchema.status(403)),
+		AnalyticsGetStats422.pipe(HttpApiSchema.status(422)),
+		AnalyticsGetStats500,
+		AnalyticsGetStats504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "analytics.getStats").annotate(OpenApi.Summary, "Get message volume analytics").annotate(OpenApi.Description, "Returns outbound message counts over the half-open selected instant range, grouped by organization-local calendar day, week, or month. A range with traffic returns every bucket in it, including the ones that saw none; a range with no outbound traffic at all returns no buckets. A range with no `before` runs through the current instant, so its quiet trailing buckets are reported as zero."), HttpApiEndpoint.get("analyticsGetTopContacts", "/v1/analytics/top-contacts", {
+	query: AnalyticsGetTopContactsQuery,
+	success: AnalyticsGetTopContacts200,
+	error: [
+		AnalyticsGetTopContacts400.pipe(HttpApiSchema.status(400)),
+		AnalyticsGetTopContacts401.pipe(HttpApiSchema.status(401)),
+		AnalyticsGetTopContacts403.pipe(HttpApiSchema.status(403)),
+		AnalyticsGetTopContacts422.pipe(HttpApiSchema.status(422)),
+		AnalyticsGetTopContacts500,
+		AnalyticsGetTopContacts504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "analytics.getTopContacts").annotate(OpenApi.Summary, "List top contacts by message volume").annotate(OpenApi.Description, "Returns the contacts your organization exchanged the most messages with over the selected date range. `sortBy` chooses the traffic `messageCount` reports and ranks by: `sent` counts outbound messages addressed to the contact, `received` counts inbound messages the contact sent you, and `total` (the default) counts both. Contacts with no traffic in the range are omitted, and at most 100 are returned.")).annotate(OpenApi.Description, "Messaging analytics, channel stats, and data export. Every date range is half-open — `after` inclusive, `before` exclusive — and may span at most 366 days. Both bounds are absolute ISO-8601 instants carrying `Z` or a numeric offset; a bare calendar date is rejected, because reading it as UTC midnight would shift every bucket for an organization outside UTC. `AnalyticsQueryError` refuses a longer span and a `before` sent without an `after`, which bounds nothing. Omitting both bounds reports the organization's whole history. Calendar buckets follow the organization's timezone.") {};
+//#endregion
+export { AnalyticsExportData200, AnalyticsExportData400, AnalyticsExportData401, AnalyticsExportData403, AnalyticsExportData422, AnalyticsExportData500, AnalyticsExportData504, AnalyticsExportDataRequestJson, AnalyticsGetChannelStats200, AnalyticsGetChannelStats400, AnalyticsGetChannelStats401, AnalyticsGetChannelStats403, AnalyticsGetChannelStats422, AnalyticsGetChannelStats500, AnalyticsGetChannelStats504, AnalyticsGetChannelStatsQuery, AnalyticsGetDeliveryMetrics200, AnalyticsGetDeliveryMetrics400, AnalyticsGetDeliveryMetrics401, AnalyticsGetDeliveryMetrics403, AnalyticsGetDeliveryMetrics422, AnalyticsGetDeliveryMetrics500, AnalyticsGetDeliveryMetrics504, AnalyticsGetDeliveryMetricsQuery, AnalyticsGetHourlyDistribution200, AnalyticsGetHourlyDistribution400, AnalyticsGetHourlyDistribution401, AnalyticsGetHourlyDistribution403, AnalyticsGetHourlyDistribution422, AnalyticsGetHourlyDistribution500, AnalyticsGetHourlyDistribution504, AnalyticsGetHourlyDistributionQuery, AnalyticsGetStats200, AnalyticsGetStats400, AnalyticsGetStats401, AnalyticsGetStats403, AnalyticsGetStats422, AnalyticsGetStats500, AnalyticsGetStats504, AnalyticsGetStatsQuery, AnalyticsGetTopContacts200, AnalyticsGetTopContacts400, AnalyticsGetTopContacts401, AnalyticsGetTopContacts403, AnalyticsGetTopContacts422, AnalyticsGetTopContacts500, AnalyticsGetTopContacts504, AnalyticsGetTopContactsQuery, AnalyticsGroup };
+
+//# sourceMappingURL=analytics.js.map