samva 0.16.0 → 0.18.0

package/dist/effect/generated/organizations.js

@@ -0,0 +1,231 @@
+import { ApiKeySecurityMiddleware, BillingProviderError, ConflictError, ForbiddenError, GatewayTimeoutError, IanaTimezone, InternalError, JsonValue, OperationAccepted, PaymentRequiredError, ResourceNotFoundError, UnauthorizedError, ValidationError } from "./shared.js";
+import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/http-api";
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/organizations.ts
+const Organization = /* @__PURE__ */ Schema.Struct({
+	id: Schema.String,
+	billingAccountId: Schema.String,
+	name: Schema.String,
+	slug: Schema.String,
+	countryCode: Schema.String,
+	timezone: Schema.String,
+	plan: Schema.String,
+	isActive: Schema.Boolean,
+	createdAt: Schema.String,
+	updatedAt: Schema.String,
+	metadata: Schema.Union([Schema.Record(Schema.String, JsonValue), Schema.Null]),
+	replyToDefault: Schema.Union([Schema.Array(Schema.String), Schema.Null]),
+	emailFooterEnabledDefault: Schema.Union([Schema.Boolean, Schema.Null]),
+	messagesUsed: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	messagesUsedThisMonth: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	emailUsed: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	emailUsedThisMonth: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	contactsUsed: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	conversationsUsed: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	teamMembersUsed: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+	messagesResetAt: Schema.Union([Schema.String, Schema.Null])
+}).annotate({ identifier: "Organization" });
+const OrganizationsCreateRequestJson = /* @__PURE__ */ Schema.Struct({ name: Schema.String });
+const OrganizationsCreate200 = Organization;
+const OrganizationsCreate401 = UnauthorizedError;
+const OrganizationsCreate402 = PaymentRequiredError;
+const OrganizationsCreate403 = ForbiddenError;
+const OrganizationsCreate422 = ValidationError;
+const OrganizationsCreate500 = InternalError;
+const OrganizationsCreate502 = BillingProviderError;
+const OrganizationsCreate504 = GatewayTimeoutError;
+const OrganizationsGet200 = Organization;
+const OrganizationsGet401 = UnauthorizedError;
+const OrganizationsGet403 = ForbiddenError;
+const OrganizationsGet404 = ResourceNotFoundError;
+const OrganizationsGet422 = ValidationError;
+const OrganizationsGet500 = InternalError;
+const OrganizationsGet504 = GatewayTimeoutError;
+const OrganizationsUpdateRequestJson = /* @__PURE__ */ Schema.Struct({
+	name: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	slug: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	countryCode: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	timezone: Schema.optionalKey(Schema.Union([IanaTimezone, Schema.Null])),
+	isActive: Schema.optionalKey(Schema.Union([Schema.Boolean, Schema.Null])),
+	metadata: Schema.optionalKey(Schema.Union([Schema.Record(Schema.String, JsonValue), Schema.Null])),
+	replyToDefault: Schema.optionalKey(Schema.Union([Schema.Union([Schema.Array(Schema.String), Schema.Null]), Schema.Null])),
+	emailFooterEnabledDefault: Schema.optionalKey(Schema.Union([Schema.Union([Schema.Boolean, Schema.Null]), Schema.Null]))
+});
+const OrganizationsUpdate200 = Organization;
+const OrganizationsUpdate401 = UnauthorizedError;
+const OrganizationsUpdate403 = ForbiddenError;
+const OrganizationsUpdate404 = ResourceNotFoundError;
+const OrganizationsUpdate422 = ValidationError;
+const OrganizationsUpdate500 = InternalError;
+const OrganizationsUpdate504 = GatewayTimeoutError;
+const OrganizationsGetProfile200 = /* @__PURE__ */ Schema.Struct({
+	id: Schema.String.annotate({ description: "Opaque identity for your organization membership" }),
+	name: Schema.String.annotate({ description: "Your display name" }),
+	nickname: Schema.String.annotate({ description: "Your display name and organization name" })
+});
+const OrganizationsGetProfile401 = UnauthorizedError;
+const OrganizationsGetProfile403 = ForbiddenError;
+const OrganizationsGetProfile422 = ValidationError;
+const OrganizationsGetProfile500 = InternalError;
+const OrganizationsGetProfile504 = GatewayTimeoutError;
+const OrganizationsDeleteHeaders = /* @__PURE__ */ Schema.Struct({ "idempotency-key": Schema.String.check(Schema.isMinLength(1).annotate({ expected: "a value with a length of at least 1" })).check(Schema.isMaxCodePoints(255).annotate({ expected: "a string with at most 255 code points" })).check(Schema.isMaxLength(255).annotate({ expected: "a value with a length of at most 255" })) });
+const OrganizationsDeleteRequestJson = /* @__PURE__ */ Schema.Struct({ confirmationName: Schema.String });
+const OrganizationsDelete202 = OperationAccepted;
+const OrganizationsDelete401 = UnauthorizedError;
+const OrganizationsDelete403 = ForbiddenError;
+const OrganizationsDelete409 = ConflictError;
+const OrganizationsDelete422 = ValidationError;
+const OrganizationsDelete500 = InternalError;
+const OrganizationsDelete504 = GatewayTimeoutError;
+const OrganizationsGetTrustTier200 = /* @__PURE__ */ Schema.Struct({
+	tier: Schema.Union([
+		Schema.Literal("screened"),
+		Schema.Literal("probation"),
+		Schema.Literal("established")
+	]),
+	changedAt: Schema.String,
+	sendingLimits: Schema.Struct({
+		sendsPerSecond: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		dailySends: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		probation: Schema.Union([Schema.Struct({
+			hourlyRecipients: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+			dailyRecipients: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+			domainShare: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+			domainShareFloor: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" }))
+		}), Schema.Null])
+	}),
+	graduation: Schema.Union([Schema.Struct({
+		firstSentAt: Schema.Union([Schema.String, Schema.Null]),
+		elapsedDays: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		sent: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		delivered: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		hardBounces: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		hardBounceRate: Schema.Union([Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })), Schema.Null]),
+		complaints: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		holds: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		requirements: Schema.Struct({
+			minimumDays: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+			delivered: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+			maximumHardBounceRate: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" }))
+		}),
+		blockers: Schema.Array(Schema.Union([
+			Schema.Literal("too_recent"),
+			Schema.Literal("too_few_delivered"),
+			Schema.Literal("held"),
+			Schema.Literal("complaints"),
+			Schema.Literal("bounce_rate")
+		]))
+	}), Schema.Null])
+});
+const OrganizationsGetTrustTier401 = UnauthorizedError;
+const OrganizationsGetTrustTier403 = ForbiddenError;
+const OrganizationsGetTrustTier404 = ResourceNotFoundError;
+const OrganizationsGetTrustTier422 = ValidationError;
+const OrganizationsGetTrustTier500 = InternalError;
+const OrganizationsGetTrustTier502 = BillingProviderError;
+const OrganizationsGetTrustTier504 = GatewayTimeoutError;
+const OrganizationsGetUsageQuery = /* @__PURE__ */ Schema.Struct({
+	after: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	before: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]))
+});
+const OrganizationsGetUsage200 = /* @__PURE__ */ Schema.Struct({
+	usage: Schema.Struct({
+		periodStart: Schema.String,
+		periodEnd: Schema.String,
+		emailCount: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })),
+		totalMessages: Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" }))
+	}),
+	billing: Schema.Struct({
+		currency: Schema.String,
+		planName: Schema.Union([Schema.String, Schema.Null]),
+		includedEmails: Schema.Union([Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })), Schema.Null]),
+		usedEmails: Schema.Union([Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })), Schema.Null]),
+		overageEmails: Schema.Union([Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })), Schema.Null]),
+		overageCost: Schema.Union([Schema.Finite.check(Schema.isFinite().annotate({ expected: "a finite number" })), Schema.Null])
+	})
+});
+const OrganizationsGetUsage401 = UnauthorizedError;
+const OrganizationsGetUsage403 = ForbiddenError;
+const OrganizationsGetUsage422 = ValidationError;
+const OrganizationsGetUsage500 = InternalError;
+const OrganizationsGetUsage504 = GatewayTimeoutError;
+var OrganizationsGroup = class extends HttpApiGroup.make("Organizations").add(HttpApiEndpoint.post("organizationsCreate", "/v1/organizations", {
+	payload: OrganizationsCreateRequestJson,
+	success: OrganizationsCreate200,
+	error: [
+		OrganizationsCreate401.pipe(HttpApiSchema.status(401)),
+		OrganizationsCreate402.pipe(HttpApiSchema.status(402)),
+		OrganizationsCreate403.pipe(HttpApiSchema.status(403)),
+		OrganizationsCreate422.pipe(HttpApiSchema.status(422)),
+		OrganizationsCreate500,
+		OrganizationsCreate502.pipe(HttpApiSchema.status(502)),
+		OrganizationsCreate504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "organizations.create").annotate(OpenApi.Summary, "Create an organization").annotate(OpenApi.Description, "Creates a new organization under the current billing account and returns it."), HttpApiEndpoint.get("organizationsGet", "/v1/organizations/current", {
+	success: OrganizationsGet200,
+	error: [
+		OrganizationsGet401.pipe(HttpApiSchema.status(401)),
+		OrganizationsGet403.pipe(HttpApiSchema.status(403)),
+		OrganizationsGet404.pipe(HttpApiSchema.status(404)),
+		OrganizationsGet422.pipe(HttpApiSchema.status(422)),
+		OrganizationsGet500,
+		OrganizationsGet504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "organizations.get").annotate(OpenApi.Summary, "Get the current organization").annotate(OpenApi.Description, "Returns the organization for the current billing account."), HttpApiEndpoint.patch("organizationsUpdate", "/v1/organizations/current", {
+	payload: OrganizationsUpdateRequestJson,
+	success: OrganizationsUpdate200,
+	error: [
+		OrganizationsUpdate401.pipe(HttpApiSchema.status(401)),
+		OrganizationsUpdate403.pipe(HttpApiSchema.status(403)),
+		OrganizationsUpdate404.pipe(HttpApiSchema.status(404)),
+		OrganizationsUpdate422.pipe(HttpApiSchema.status(422)),
+		OrganizationsUpdate500,
+		OrganizationsUpdate504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "organizations.update").annotate(OpenApi.Summary, "Update the current organization").annotate(OpenApi.Description, "Updates the current organization's profile, regional defaults, and reply-to default and returns the saved organization. `metadata` is merged into the stored value; every other field is replaced."), HttpApiEndpoint.get("organizationsGetProfile", "/v1/organizations/current/profile", {
+	success: OrganizationsGetProfile200,
+	error: [
+		OrganizationsGetProfile401.pipe(HttpApiSchema.status(401)),
+		OrganizationsGetProfile403.pipe(HttpApiSchema.status(403)),
+		OrganizationsGetProfile422.pipe(HttpApiSchema.status(422)),
+		OrganizationsGetProfile500,
+		OrganizationsGetProfile504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "organizations.getProfile").annotate(OpenApi.Summary, "Get the current account profile").annotate(OpenApi.Description, "Returns your identity in the organization authorized by your credential. The ID remains stable across reconnects and display-name changes. Removing and re-adding your membership creates a new ID."), HttpApiEndpoint.post("organizationsDelete", "/v1/organizations/deletion-operations", {
+	headers: OrganizationsDeleteHeaders,
+	payload: OrganizationsDeleteRequestJson,
+	success: OrganizationsDelete202.pipe(HttpApiSchema.status(202)),
+	error: [
+		OrganizationsDelete401.pipe(HttpApiSchema.status(401)),
+		OrganizationsDelete403.pipe(HttpApiSchema.status(403)),
+		OrganizationsDelete409.pipe(HttpApiSchema.status(409)),
+		OrganizationsDelete422.pipe(HttpApiSchema.status(422)),
+		OrganizationsDelete500,
+		OrganizationsDelete504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "organizations.delete").annotate(OpenApi.Summary, "Delete the current organization").annotate(OpenApi.Description, "Starts an owner-authorized organization deletion operation, confirming the organization name in the request. Repeating the same request with the same Idempotency-Key returns the existing organization-scoped operation."), HttpApiEndpoint.get("organizationsGetTrustTier", "/v1/organizations/trust-tier", {
+	success: OrganizationsGetTrustTier200,
+	error: [
+		OrganizationsGetTrustTier401.pipe(HttpApiSchema.status(401)),
+		OrganizationsGetTrustTier403.pipe(HttpApiSchema.status(403)),
+		OrganizationsGetTrustTier404.pipe(HttpApiSchema.status(404)),
+		OrganizationsGetTrustTier422.pipe(HttpApiSchema.status(422)),
+		OrganizationsGetTrustTier500,
+		OrganizationsGetTrustTier502.pipe(HttpApiSchema.status(502)),
+		OrganizationsGetTrustTier504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "organizations.getTrustTier").annotate(OpenApi.Summary, "Get organization trust tier and sending limits").annotate(OpenApi.Description, "Returns the current trust tier, plan and probation sending limits, and measured probation graduation progress. Limits are additional to billing allowance, domain readiness, and enforcement. Graduation is evaluated on delivery events."), HttpApiEndpoint.get("organizationsGetUsage", "/v1/organizations/usage", {
+	query: OrganizationsGetUsageQuery,
+	success: OrganizationsGetUsage200,
+	error: [
+		OrganizationsGetUsage401.pipe(HttpApiSchema.status(401)),
+		OrganizationsGetUsage403.pipe(HttpApiSchema.status(403)),
+		OrganizationsGetUsage422.pipe(HttpApiSchema.status(422)),
+		OrganizationsGetUsage500,
+		OrganizationsGetUsage504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "organizations.getUsage").annotate(OpenApi.Summary, "Get organization usage").annotate(OpenApi.Description, "Returns usage statistics for the current organization between `after` and `before`, which default to the current calendar month so far. `usage.periodStart` and `usage.periodEnd` echo the window counted.")).annotate(OpenApi.Description, "Organization management and usage statistics") {};
+//#endregion
+export { Organization, OrganizationsCreate200, OrganizationsCreate401, OrganizationsCreate402, OrganizationsCreate403, OrganizationsCreate422, OrganizationsCreate500, OrganizationsCreate502, OrganizationsCreate504, OrganizationsCreateRequestJson, OrganizationsDelete202, OrganizationsDelete401, OrganizationsDelete403, OrganizationsDelete409, OrganizationsDelete422, OrganizationsDelete500, OrganizationsDelete504, OrganizationsDeleteHeaders, OrganizationsDeleteRequestJson, OrganizationsGet200, OrganizationsGet401, OrganizationsGet403, OrganizationsGet404, OrganizationsGet422, OrganizationsGet500, OrganizationsGet504, OrganizationsGetProfile200, OrganizationsGetProfile401, OrganizationsGetProfile403, OrganizationsGetProfile422, OrganizationsGetProfile500, OrganizationsGetProfile504, OrganizationsGetTrustTier200, OrganizationsGetTrustTier401, OrganizationsGetTrustTier403, OrganizationsGetTrustTier404, OrganizationsGetTrustTier422, OrganizationsGetTrustTier500, OrganizationsGetTrustTier502, OrganizationsGetTrustTier504, OrganizationsGetUsage200, OrganizationsGetUsage401, OrganizationsGetUsage403, OrganizationsGetUsage422, OrganizationsGetUsage500, OrganizationsGetUsage504, OrganizationsGetUsageQuery, OrganizationsGroup, OrganizationsUpdate200, OrganizationsUpdate401, OrganizationsUpdate403, OrganizationsUpdate404, OrganizationsUpdate422, OrganizationsUpdate500, OrganizationsUpdate504, OrganizationsUpdateRequestJson };
+
+//# sourceMappingURL=organizations.js.map