samva 0.16.0 → 0.18.0

package/dist/effect/generated/api-keys.js

@@ -0,0 +1,249 @@
+import { SensitiveString } from "../runtime.js";
+import { ApiKeyAccess, ApiKeyId, ApiKeySecurityMiddleware, BillingProviderError, Cursor, ForbiddenError, GatewayTimeoutError, InternalError, MailboxSendMode, PaymentRequiredError, RateLimitedError, ResourceNotFoundError, SuccessResponse, UnauthorizedError, ValidationError } from "./shared.js";
+import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/http-api";
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/api-keys.ts
+const ApiKeyOwner = /* @__PURE__ */ Schema.Struct({
+	id: Schema.String,
+	name: Schema.String,
+	email: Schema.String
+}).annotate({ identifier: "ApiKeyOwner" });
+const ApiKeyActivityPage = /* @__PURE__ */ Schema.Struct({
+	items: Schema.Array(Schema.Struct({
+		id: Schema.String,
+		timestamp: Schema.String,
+		method: Schema.String,
+		endpoint: Schema.String,
+		statusCode: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(100).annotate({ expected: "a value greater than or equal to 100" })).check(Schema.isLessThanOrEqualTo(599).annotate({ expected: "a value less than or equal to 599" })),
+		latency: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" }))
+	})),
+	nextCursor: Schema.Union([Schema.String, Schema.Null])
+}).annotate({ identifier: "ApiKeyActivityPage" });
+const ApiKeyMailboxAccessUpdate = /* @__PURE__ */ Schema.Struct({ sendMode: MailboxSendMode }).annotate({ identifier: "ApiKeyMailboxAccessUpdate" });
+const ApiKey = /* @__PURE__ */ Schema.Struct({
+	id: Schema.String,
+	name: Schema.String,
+	key: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	start: Schema.Union([Schema.String, Schema.Null]),
+	description: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	createdAt: Schema.String,
+	expiresAt: Schema.Union([Schema.String, Schema.Null]),
+	lastUsedAt: Schema.Union([Schema.String, Schema.Null]),
+	isActive: Schema.Boolean,
+	access: ApiKeyAccess,
+	owner: Schema.Union([ApiKeyOwner, Schema.Null])
+}).annotate({ identifier: "ApiKey" });
+const ApiKeyWithSecret = /* @__PURE__ */ Schema.Struct({
+	id: Schema.String,
+	name: Schema.String,
+	key: SensitiveString,
+	start: Schema.Union([Schema.String, Schema.Null]),
+	description: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	createdAt: Schema.String,
+	expiresAt: Schema.Union([Schema.String, Schema.Null]),
+	lastUsedAt: Schema.Union([Schema.String, Schema.Null]),
+	isActive: Schema.Boolean,
+	access: ApiKeyAccess,
+	owner: Schema.Union([ApiKeyOwner, Schema.Null])
+}).annotate({ identifier: "ApiKeyWithSecret" });
+const ApiKeyPage = /* @__PURE__ */ Schema.Struct({
+	items: Schema.Array(ApiKey),
+	nextCursor: Schema.Union([Schema.String, Schema.Null])
+}).annotate({ identifier: "ApiKeyPage" });
+const ApiKeysListQuery = /* @__PURE__ */ Schema.Struct({
+	limit: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	cursor: Schema.optionalKey(Schema.Union([Cursor, Schema.Null])),
+	status: Schema.optionalKey(Schema.Union([Schema.Union([Schema.Literal("active"), Schema.Literal("revoked")]), Schema.Null])),
+	search: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]))
+});
+const ApiKeysList200 = ApiKeyPage;
+const ApiKeysList401 = UnauthorizedError;
+const ApiKeysList403 = ForbiddenError;
+const ApiKeysList422 = ValidationError;
+const ApiKeysList500 = InternalError;
+const ApiKeysList504 = GatewayTimeoutError;
+const ApiKeysCreateRequestJson = /* @__PURE__ */ Schema.Struct({
+	name: Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(32).annotate({ expected: "a string with at most 32 code points" })).check(Schema.isMaxLength(32).annotate({ expected: "a value with a length of at most 32" })),
+	description: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	expiresAt: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	access: Schema.optionalKey(Schema.Union([ApiKeyAccess, Schema.Null]).annotate({ description: "Defaults to full access. A restricted API key creating a key defaults to its own grants and cannot issue full access." }))
+});
+const ApiKeysCreate201 = ApiKeyWithSecret;
+const ApiKeysCreate401 = UnauthorizedError;
+const ApiKeysCreate402 = PaymentRequiredError;
+const ApiKeysCreate403 = ForbiddenError;
+const ApiKeysCreate404 = ResourceNotFoundError;
+const ApiKeysCreate422 = ValidationError;
+const ApiKeysCreate429 = RateLimitedError;
+const ApiKeysCreate500 = InternalError;
+const ApiKeysCreate502 = BillingProviderError;
+const ApiKeysCreate504 = GatewayTimeoutError;
+const ApiKeysGetPathParams = /* @__PURE__ */ Schema.Struct({ id: ApiKeyId });
+const ApiKeysGet200 = ApiKey;
+const ApiKeysGet401 = UnauthorizedError;
+const ApiKeysGet403 = ForbiddenError;
+const ApiKeysGet404 = ResourceNotFoundError;
+const ApiKeysGet422 = ValidationError;
+const ApiKeysGet500 = InternalError;
+const ApiKeysGet504 = GatewayTimeoutError;
+const ApiKeysUpdatePathParams = /* @__PURE__ */ Schema.Struct({ id: ApiKeyId });
+const ApiKeysUpdateRequestJson = /* @__PURE__ */ Schema.Struct({
+	name: Schema.optionalKey(Schema.Union([Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(32).annotate({ expected: "a string with at most 32 code points" })).check(Schema.isMaxLength(32).annotate({ expected: "a value with a length of at most 32" })), Schema.Null])),
+	description: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	mailboxes: Schema.optionalKey(Schema.Union([ApiKeyMailboxAccessUpdate, Schema.Null]).annotate({ description: "Changes the mailbox send mode of a key that holds mailbox access. Only a person can change it; the change applies to the key's next request." }))
+});
+const ApiKeysUpdate200 = ApiKey;
+const ApiKeysUpdate401 = UnauthorizedError;
+const ApiKeysUpdate403 = ForbiddenError;
+const ApiKeysUpdate404 = ResourceNotFoundError;
+const ApiKeysUpdate422 = ValidationError;
+const ApiKeysUpdate500 = InternalError;
+const ApiKeysUpdate504 = GatewayTimeoutError;
+const ApiKeysGetActivityPathParams = /* @__PURE__ */ Schema.Struct({ id: ApiKeyId });
+const ApiKeysGetActivityQuery = /* @__PURE__ */ Schema.Struct({
+	limit: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	cursor: Schema.optionalKey(Schema.Union([Cursor, Schema.Null]))
+});
+const ApiKeysGetActivity200 = ApiKeyActivityPage;
+const ApiKeysGetActivity401 = UnauthorizedError;
+const ApiKeysGetActivity403 = ForbiddenError;
+const ApiKeysGetActivity404 = ResourceNotFoundError;
+const ApiKeysGetActivity422 = ValidationError;
+const ApiKeysGetActivity500 = InternalError;
+const ApiKeysGetActivity504 = GatewayTimeoutError;
+const ApiKeysRevokePathParams = /* @__PURE__ */ Schema.Struct({ id: ApiKeyId });
+const ApiKeysRevoke200 = SuccessResponse;
+const ApiKeysRevoke401 = UnauthorizedError;
+const ApiKeysRevoke403 = ForbiddenError;
+const ApiKeysRevoke404 = ResourceNotFoundError;
+const ApiKeysRevoke422 = ValidationError;
+const ApiKeysRevoke500 = InternalError;
+const ApiKeysRevoke502 = BillingProviderError;
+const ApiKeysRevoke504 = GatewayTimeoutError;
+const ApiKeysRotatePathParams = /* @__PURE__ */ Schema.Struct({ id: ApiKeyId });
+const ApiKeysRotate200 = ApiKeyWithSecret;
+const ApiKeysRotate401 = UnauthorizedError;
+const ApiKeysRotate403 = ForbiddenError;
+const ApiKeysRotate404 = ResourceNotFoundError;
+const ApiKeysRotate422 = ValidationError;
+const ApiKeysRotate500 = InternalError;
+const ApiKeysRotate504 = GatewayTimeoutError;
+const ApiKeysGetStatsPathParams = /* @__PURE__ */ Schema.Struct({ id: ApiKeyId });
+const ApiKeysGetStatsQuery = /* @__PURE__ */ Schema.Struct({
+	after: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	before: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]))
+});
+const ApiKeysGetStats200 = /* @__PURE__ */ Schema.Struct({
+	totalRequests: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	successfulRequests: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	failedRequests: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" })),
+	dailyVolume: Schema.Array(Schema.Struct({
+		date: Schema.String,
+		requests: Schema.Finite.check(Schema.isInt().annotate({ expected: "an integer" })).check(Schema.isGreaterThanOrEqualTo(0).annotate({ expected: "a value greater than or equal to 0" }))
+	}))
+});
+const ApiKeysGetStats401 = UnauthorizedError;
+const ApiKeysGetStats403 = ForbiddenError;
+const ApiKeysGetStats404 = ResourceNotFoundError;
+const ApiKeysGetStats422 = ValidationError;
+const ApiKeysGetStats500 = InternalError;
+const ApiKeysGetStats504 = GatewayTimeoutError;
+var APIKeysGroup = class extends HttpApiGroup.make("API Keys").add(HttpApiEndpoint.get("apiKeysList", "/v1/api-keys", {
+	query: ApiKeysListQuery,
+	success: ApiKeysList200,
+	error: [
+		ApiKeysList401.pipe(HttpApiSchema.status(401)),
+		ApiKeysList403.pipe(HttpApiSchema.status(403)),
+		ApiKeysList422.pipe(HttpApiSchema.status(422)),
+		ApiKeysList500,
+		ApiKeysList504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "apiKeys.list").annotate(OpenApi.Summary, "List API keys").annotate(OpenApi.Description, "Returns the organization's API keys, newest first, filterable by status and a search term matched against name and description. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page."), HttpApiEndpoint.post("apiKeysCreate", "/v1/api-keys", {
+	payload: ApiKeysCreateRequestJson,
+	success: ApiKeysCreate201.pipe(HttpApiSchema.status(201)),
+	error: [
+		ApiKeysCreate401.pipe(HttpApiSchema.status(401)),
+		ApiKeysCreate402.pipe(HttpApiSchema.status(402)),
+		ApiKeysCreate403.pipe(HttpApiSchema.status(403)),
+		ApiKeysCreate404.pipe(HttpApiSchema.status(404)),
+		ApiKeysCreate422.pipe(HttpApiSchema.status(422)),
+		ApiKeysCreate429.pipe(HttpApiSchema.status(429)),
+		ApiKeysCreate500,
+		ApiKeysCreate502.pipe(HttpApiSchema.status(502)),
+		ApiKeysCreate504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "apiKeys.create").annotate(OpenApi.Summary, "Create an API key").annotate(OpenApi.Description, "Creates a new API key for the organization and returns the created key, including the plaintext secret, with a 201 response."), HttpApiEndpoint.get("apiKeysGet", "/v1/api-keys/:id", {
+	params: ApiKeysGetPathParams,
+	success: ApiKeysGet200,
+	error: [
+		ApiKeysGet401.pipe(HttpApiSchema.status(401)),
+		ApiKeysGet403.pipe(HttpApiSchema.status(403)),
+		ApiKeysGet404.pipe(HttpApiSchema.status(404)),
+		ApiKeysGet422.pipe(HttpApiSchema.status(422)),
+		ApiKeysGet500,
+		ApiKeysGet504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "apiKeys.get").annotate(OpenApi.Summary, "Get an API key").annotate(OpenApi.Description, "Returns the API key with the given ID, including its metadata and access."), HttpApiEndpoint.patch("apiKeysUpdate", "/v1/api-keys/:id", {
+	params: ApiKeysUpdatePathParams,
+	payload: ApiKeysUpdateRequestJson,
+	success: ApiKeysUpdate200,
+	error: [
+		ApiKeysUpdate401.pipe(HttpApiSchema.status(401)),
+		ApiKeysUpdate403.pipe(HttpApiSchema.status(403)),
+		ApiKeysUpdate404.pipe(HttpApiSchema.status(404)),
+		ApiKeysUpdate422.pipe(HttpApiSchema.status(422)),
+		ApiKeysUpdate500,
+		ApiKeysUpdate504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "apiKeys.update").annotate(OpenApi.Summary, "Update an API key").annotate(OpenApi.Description, "Updates an API key's settings and returns the updated key. A field left out keeps its value."), HttpApiEndpoint.get("apiKeysGetActivity", "/v1/api-keys/:id/activity", {
+	params: ApiKeysGetActivityPathParams,
+	query: ApiKeysGetActivityQuery,
+	success: ApiKeysGetActivity200,
+	error: [
+		ApiKeysGetActivity401.pipe(HttpApiSchema.status(401)),
+		ApiKeysGetActivity403.pipe(HttpApiSchema.status(403)),
+		ApiKeysGetActivity404.pipe(HttpApiSchema.status(404)),
+		ApiKeysGetActivity422.pipe(HttpApiSchema.status(422)),
+		ApiKeysGetActivity500,
+		ApiKeysGetActivity504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "apiKeys.getActivity").annotate(OpenApi.Summary, "List API key activity").annotate(OpenApi.Description, "Returns the sends attributed to an API key, newest first. Pass `nextCursor` back as `cursor` for the next page; it is null on the last page."), HttpApiEndpoint.post("apiKeysRevoke", "/v1/api-keys/:id/revoke", {
+	params: ApiKeysRevokePathParams,
+	success: ApiKeysRevoke200,
+	error: [
+		ApiKeysRevoke401.pipe(HttpApiSchema.status(401)),
+		ApiKeysRevoke403.pipe(HttpApiSchema.status(403)),
+		ApiKeysRevoke404.pipe(HttpApiSchema.status(404)),
+		ApiKeysRevoke422.pipe(HttpApiSchema.status(422)),
+		ApiKeysRevoke500,
+		ApiKeysRevoke502.pipe(HttpApiSchema.status(502)),
+		ApiKeysRevoke504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "apiKeys.revoke").annotate(OpenApi.Summary, "Revoke an API key").annotate(OpenApi.Description, "Deactivates an API key so it can no longer authenticate requests. Revocation is final: a revoked key never authenticates again. Its record stays listable, so the messages it sent stay attributed to it."), HttpApiEndpoint.post("apiKeysRotate", "/v1/api-keys/:id/rotate", {
+	params: ApiKeysRotatePathParams,
+	success: ApiKeysRotate200,
+	error: [
+		ApiKeysRotate401.pipe(HttpApiSchema.status(401)),
+		ApiKeysRotate403.pipe(HttpApiSchema.status(403)),
+		ApiKeysRotate404.pipe(HttpApiSchema.status(404)),
+		ApiKeysRotate422.pipe(HttpApiSchema.status(422)),
+		ApiKeysRotate500,
+		ApiKeysRotate504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "apiKeys.rotate").annotate(OpenApi.Summary, "Rotate an API key").annotate(OpenApi.Description, "Issues a replacement with the same owner, name, and access, then deactivates the existing key. Returns the new key, including the plaintext secret."), HttpApiEndpoint.get("apiKeysGetStats", "/v1/api-keys/:id/stats", {
+	params: ApiKeysGetStatsPathParams,
+	query: ApiKeysGetStatsQuery,
+	success: ApiKeysGetStats200,
+	error: [
+		ApiKeysGetStats401.pipe(HttpApiSchema.status(401)),
+		ApiKeysGetStats403.pipe(HttpApiSchema.status(403)),
+		ApiKeysGetStats404.pipe(HttpApiSchema.status(404)),
+		ApiKeysGetStats422.pipe(HttpApiSchema.status(422)),
+		ApiKeysGetStats500,
+		ApiKeysGetStats504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "apiKeys.getStats").annotate(OpenApi.Summary, "Get API key send statistics").annotate(OpenApi.Description, "Returns aggregate send counts and daily volume attributed to an API key between `after` and `before`, a window of at most 90 days that defaults to the last 30 days.")).annotate(OpenApi.Description, "API key management, rotation, and usage statistics") {};
+//#endregion
+export { APIKeysGroup, ApiKey, ApiKeyActivityPage, ApiKeyMailboxAccessUpdate, ApiKeyOwner, ApiKeyPage, ApiKeyWithSecret, ApiKeysCreate201, ApiKeysCreate401, ApiKeysCreate402, ApiKeysCreate403, ApiKeysCreate404, ApiKeysCreate422, ApiKeysCreate429, ApiKeysCreate500, ApiKeysCreate502, ApiKeysCreate504, ApiKeysCreateRequestJson, ApiKeysGet200, ApiKeysGet401, ApiKeysGet403, ApiKeysGet404, ApiKeysGet422, ApiKeysGet500, ApiKeysGet504, ApiKeysGetActivity200, ApiKeysGetActivity401, ApiKeysGetActivity403, ApiKeysGetActivity404, ApiKeysGetActivity422, ApiKeysGetActivity500, ApiKeysGetActivity504, ApiKeysGetActivityPathParams, ApiKeysGetActivityQuery, ApiKeysGetPathParams, ApiKeysGetStats200, ApiKeysGetStats401, ApiKeysGetStats403, ApiKeysGetStats404, ApiKeysGetStats422, ApiKeysGetStats500, ApiKeysGetStats504, ApiKeysGetStatsPathParams, ApiKeysGetStatsQuery, ApiKeysList200, ApiKeysList401, ApiKeysList403, ApiKeysList422, ApiKeysList500, ApiKeysList504, ApiKeysListQuery, ApiKeysRevoke200, ApiKeysRevoke401, ApiKeysRevoke403, ApiKeysRevoke404, ApiKeysRevoke422, ApiKeysRevoke500, ApiKeysRevoke502, ApiKeysRevoke504, ApiKeysRevokePathParams, ApiKeysRotate200, ApiKeysRotate401, ApiKeysRotate403, ApiKeysRotate404, ApiKeysRotate422, ApiKeysRotate500, ApiKeysRotate504, ApiKeysRotatePathParams, ApiKeysUpdate200, ApiKeysUpdate401, ApiKeysUpdate403, ApiKeysUpdate404, ApiKeysUpdate422, ApiKeysUpdate500, ApiKeysUpdate504, ApiKeysUpdatePathParams, ApiKeysUpdateRequestJson };
+
+//# sourceMappingURL=api-keys.js.map