samva 0.16.0 → 0.18.0

package/dist/effect/generated/subscriptions.d.ts

@@ -0,0 +1,188 @@
+import { HttpApiEndpoint, HttpApiGroup } from "effect/http-api";
+import * as Schema from "effect/Schema";
+import { ApiKeySecurityMiddleware, BillingProviderError, BrandAddressRequiredError, CampaignFooterRequiredError, ConflictError, ContactGroupId, DeliveryUnavailableError, ExternalServiceError, FlagDisabledError, ForbiddenError, GatewayTimeoutError, InternalError, OnboardingReviewRequiredError, PaymentRequiredError, RateLimitedError, ResourceNotFoundError, SenderNotReadyError, UnauthorizedError, UnsubscribeId, ValidationError } from "./shared";
+export type SubscribeResult = {
+    readonly success: boolean;
+    readonly expiresAt: string;
+};
+export declare const SubscribeResult: Schema.Struct<{
+    readonly success: Schema.Boolean;
+    readonly expiresAt: Schema.String;
+}>;
+export type SubscriptionsSubscribeRequestJson = {
+    readonly email: string;
+    readonly contactGroupId: ContactGroupId;
+    readonly from: {
+        readonly email: string;
+        readonly name?: string | null;
+    };
+    readonly unsubscribeGroupId?: UnsubscribeId | null;
+    readonly templateSlug?: string | null;
+    readonly consentIp?: string | null;
+    readonly consentSource?: string | null;
+};
+export declare const SubscriptionsSubscribeRequestJson: Schema.Struct<{
+    readonly email: Schema.String;
+    readonly contactGroupId: Schema.brand<Schema.String, "ContactGroupId">;
+    readonly from: Schema.Struct<{
+        readonly email: Schema.String;
+        readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    }>;
+    readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>>;
+    readonly templateSlug: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    readonly consentIp: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    readonly consentSource: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+}>;
+export type SubscriptionsSubscribe200 = SubscribeResult;
+export declare const SubscriptionsSubscribe200: Schema.Struct<{
+    readonly success: Schema.Boolean;
+    readonly expiresAt: Schema.String;
+}>;
+export type SubscriptionsSubscribe401 = UnauthorizedError;
+export declare const SubscriptionsSubscribe401: typeof UnauthorizedError;
+export type SubscriptionsSubscribe402 = PaymentRequiredError;
+export declare const SubscriptionsSubscribe402: typeof PaymentRequiredError;
+export type SubscriptionsSubscribe403 = ForbiddenError | OnboardingReviewRequiredError | FlagDisabledError;
+export declare const SubscriptionsSubscribe403: Schema.Union<readonly [typeof ForbiddenError, typeof OnboardingReviewRequiredError, typeof FlagDisabledError]>;
+export type SubscriptionsSubscribe404 = ResourceNotFoundError;
+export declare const SubscriptionsSubscribe404: typeof ResourceNotFoundError;
+export type SubscriptionsSubscribe409 = ConflictError;
+export declare const SubscriptionsSubscribe409: typeof ConflictError;
+export type SubscriptionsSubscribe422 = ValidationError | BrandAddressRequiredError | CampaignFooterRequiredError;
+export declare const SubscriptionsSubscribe422: Schema.Union<readonly [typeof ValidationError, typeof BrandAddressRequiredError, typeof CampaignFooterRequiredError]>;
+export type SubscriptionsSubscribe429 = RateLimitedError;
+export declare const SubscriptionsSubscribe429: typeof RateLimitedError;
+export type SubscriptionsSubscribe500 = InternalError;
+export declare const SubscriptionsSubscribe500: typeof InternalError;
+export type SubscriptionsSubscribe502 = BillingProviderError | ExternalServiceError;
+export declare const SubscriptionsSubscribe502: Schema.Union<readonly [typeof BillingProviderError, typeof ExternalServiceError]>;
+export type SubscriptionsSubscribe503 = SenderNotReadyError | DeliveryUnavailableError;
+export declare const SubscriptionsSubscribe503: Schema.Union<readonly [typeof SenderNotReadyError, typeof DeliveryUnavailableError]>;
+export type SubscriptionsSubscribe504 = GatewayTimeoutError;
+export declare const SubscriptionsSubscribe504: typeof GatewayTimeoutError;
+declare const SubscriptionsGroup_base: HttpApiGroup.HttpApiGroup<"Subscriptions", HttpApiEndpoint.HttpApiEndpoint<"subscriptionsSubscribe", "POST", "/v1/subscriptions", never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly email: Schema.String;
+    readonly contactGroupId: Schema.brand<Schema.String, "ContactGroupId">;
+    readonly from: Schema.Struct<{
+        readonly email: Schema.String;
+        readonly name: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    }>;
+    readonly unsubscribeGroupId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "UnsubscribeId">, Schema.Null]>>;
+    readonly templateSlug: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    readonly consentIp: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    readonly consentSource: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+}>>, never, Schema.toCodecJson<Schema.Struct<{
+    readonly success: Schema.Boolean;
+    readonly expiresAt: Schema.String;
+}>>, Schema.toCodecJson<Schema.Union<readonly [typeof BillingProviderError, typeof ExternalServiceError]> | Schema.Union<readonly [typeof SenderNotReadyError, typeof DeliveryUnavailableError]> | Schema.Union<readonly [typeof ForbiddenError, typeof OnboardingReviewRequiredError, typeof FlagDisabledError]> | Schema.Union<readonly [typeof ValidationError, typeof BrandAddressRequiredError, typeof CampaignFooterRequiredError]> | Schema.decodeTo<Schema.declareConstructor<ConflictError, {
+    readonly _tag: "ConflictError";
+    readonly message: string;
+    readonly resource: string;
+    readonly id?: string | null;
+}, readonly [Schema.Struct<{
+    readonly _tag: Schema.tag<"ConflictError">;
+    readonly message: Schema.String;
+    readonly resource: Schema.String;
+    readonly id: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+}>], {
+    readonly _tag: "ConflictError";
+    readonly message: string;
+    readonly resource: string;
+    readonly id?: string | null;
+}>, Schema.Struct<{
+    readonly _tag: Schema.tag<"ConflictError">;
+    readonly message: Schema.String;
+    readonly resource: Schema.String;
+    readonly id: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+}>, never, never> | Schema.decodeTo<Schema.declareConstructor<GatewayTimeoutError, {
+    readonly _tag: "GatewayTimeoutError";
+    readonly message: string;
+    readonly retryAfterSeconds: number;
+}, readonly [Schema.Struct<{
+    readonly _tag: Schema.tag<"GatewayTimeoutError">;
+    readonly message: Schema.String;
+    readonly retryAfterSeconds: Schema.Finite;
+}>], {
+    readonly _tag: "GatewayTimeoutError";
+    readonly message: string;
+    readonly retryAfterSeconds: number;
+}>, Schema.Struct<{
+    readonly _tag: Schema.tag<"GatewayTimeoutError">;
+    readonly message: Schema.String;
+    readonly retryAfterSeconds: Schema.Finite;
+}>, never, never> | Schema.decodeTo<Schema.declareConstructor<PaymentRequiredError, {
+    readonly _tag: "PaymentRequiredError";
+    readonly message: string;
+    readonly resource: string;
+    readonly currentUsage: number;
+    readonly limit: number;
+}, readonly [Schema.Struct<{
+    readonly _tag: Schema.tag<"PaymentRequiredError">;
+    readonly message: Schema.String;
+    readonly resource: Schema.String;
+    readonly currentUsage: Schema.Finite;
+    readonly limit: Schema.Finite;
+}>], {
+    readonly _tag: "PaymentRequiredError";
+    readonly message: string;
+    readonly resource: string;
+    readonly currentUsage: number;
+    readonly limit: number;
+}>, Schema.Struct<{
+    readonly _tag: Schema.tag<"PaymentRequiredError">;
+    readonly message: Schema.String;
+    readonly resource: Schema.String;
+    readonly currentUsage: Schema.Finite;
+    readonly limit: Schema.Finite;
+}>, never, never> | Schema.decodeTo<Schema.declareConstructor<RateLimitedError, {
+    readonly _tag: "RateLimitedError";
+    readonly message: string;
+    readonly retryAfterSeconds: number;
+}, readonly [Schema.Struct<{
+    readonly _tag: Schema.tag<"RateLimitedError">;
+    readonly message: Schema.String;
+    readonly retryAfterSeconds: Schema.Finite;
+}>], {
+    readonly _tag: "RateLimitedError";
+    readonly message: string;
+    readonly retryAfterSeconds: number;
+}>, Schema.Struct<{
+    readonly _tag: Schema.tag<"RateLimitedError">;
+    readonly message: Schema.String;
+    readonly retryAfterSeconds: Schema.Finite;
+}>, never, never> | Schema.decodeTo<Schema.declareConstructor<ResourceNotFoundError, {
+    readonly _tag: "ResourceNotFoundError";
+    readonly resource: string;
+    readonly id: string;
+    readonly message: string;
+}, readonly [Schema.Struct<{
+    readonly _tag: Schema.tag<"ResourceNotFoundError">;
+    readonly resource: Schema.String;
+    readonly id: Schema.String;
+    readonly message: Schema.String;
+}>], {
+    readonly _tag: "ResourceNotFoundError";
+    readonly resource: string;
+    readonly id: string;
+    readonly message: string;
+}>, Schema.Struct<{
+    readonly _tag: Schema.tag<"ResourceNotFoundError">;
+    readonly resource: Schema.String;
+    readonly id: Schema.String;
+    readonly message: Schema.String;
+}>, never, never> | Schema.decodeTo<Schema.declareConstructor<UnauthorizedError, {
+    readonly _tag: "UnauthorizedError";
+    readonly message: string;
+}, readonly [Schema.Struct<{
+    readonly _tag: Schema.tag<"UnauthorizedError">;
+    readonly message: Schema.String;
+}>], {
+    readonly _tag: "UnauthorizedError";
+    readonly message: string;
+}>, Schema.Struct<{
+    readonly _tag: Schema.tag<"UnauthorizedError">;
+    readonly message: Schema.String;
+}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never>, false>;
+export declare class SubscriptionsGroup extends SubscriptionsGroup_base {
+}
+export {};

package/dist/effect/generated/subscriptions.js

@@ -0,0 +1,61 @@
+import { ApiKeySecurityMiddleware, BillingProviderError, BrandAddressRequiredError, CampaignFooterRequiredError, ConflictError, ContactGroupId, DeliveryUnavailableError, ExternalServiceError, FlagDisabledError, ForbiddenError, GatewayTimeoutError, InternalError, OnboardingReviewRequiredError, PaymentRequiredError, RateLimitedError, ResourceNotFoundError, SenderNotReadyError, UnauthorizedError, UnsubscribeId, ValidationError } from "./shared.js";
+import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/http-api";
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/subscriptions.ts
+const SubscribeResult = /* @__PURE__ */ Schema.Struct({
+	success: Schema.Boolean,
+	expiresAt: Schema.String
+}).annotate({ identifier: "SubscribeResult" });
+const SubscriptionsSubscribeRequestJson = /* @__PURE__ */ Schema.Struct({
+	email: Schema.String.annotate({ description: "The recipient email address; confirmation proves consent for this address." }).check(Schema.isMaxCodePoints(320).annotate({ expected: "a string with at most 320 code points" })).check(Schema.isPattern(/* @__PURE__ */ new RegExp("^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "u")).annotate({ expected: "a string matching the RegExp ^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" })).check(Schema.isMaxLength(320).annotate({ expected: "a value with a length of at most 320" })),
+	contactGroupId: ContactGroupId,
+	from: Schema.Struct({
+		email: Schema.String,
+		name: Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]))
+	}).annotate({ description: "Your verified email sender. The ordinary send pipeline selects its domain and customer brand." }),
+	unsubscribeGroupId: Schema.optionalKey(Schema.Union([UnsubscribeId, Schema.Null]).annotate({ description: "Clear this unsubscribe group after confirmation; all other opt-outs remain." })),
+	templateSlug: Schema.optionalKey(Schema.Union([Schema.String.annotate({ description: "A published email template slug receiving confirmUrl. Omit it to send the default confirmation email." }).check(Schema.isPattern(/* @__PURE__ */ new RegExp("^(?=.{1,100}$)[a-z0-9]+(?:-[a-z0-9]+)*$", "u")).annotate({ expected: "a string matching the RegExp ^(?=.{1,100}$)[a-z0-9]+(?:-[a-z0-9]+)*$" })), Schema.Null])),
+	consentIp: Schema.optionalKey(Schema.Union([Schema.String.annotate({ description: "The recipient IP recorded by your server when they requested subscription." }).check(Schema.isMaxCodePoints(128).annotate({ expected: "a string with at most 128 code points" })).check(Schema.isMaxLength(128).annotate({ expected: "a value with a length of at most 128" })), Schema.Null])),
+	consentSource: Schema.optionalKey(Schema.Union([Schema.String.annotate({ description: "The signup page or source recorded by your server when consent was requested." }).check(Schema.isMaxCodePoints(512).annotate({ expected: "a string with at most 512 code points" })).check(Schema.isMaxLength(512).annotate({ expected: "a value with a length of at most 512" })), Schema.Null]))
+});
+const SubscriptionsSubscribe200 = SubscribeResult;
+const SubscriptionsSubscribe401 = UnauthorizedError;
+const SubscriptionsSubscribe402 = PaymentRequiredError;
+const SubscriptionsSubscribe403 = /* @__PURE__ */ Schema.Union([
+	ForbiddenError,
+	OnboardingReviewRequiredError,
+	FlagDisabledError
+]);
+const SubscriptionsSubscribe404 = ResourceNotFoundError;
+const SubscriptionsSubscribe409 = ConflictError;
+const SubscriptionsSubscribe422 = /* @__PURE__ */ Schema.Union([
+	ValidationError,
+	BrandAddressRequiredError,
+	CampaignFooterRequiredError
+]);
+const SubscriptionsSubscribe429 = RateLimitedError;
+const SubscriptionsSubscribe500 = InternalError;
+const SubscriptionsSubscribe502 = /* @__PURE__ */ Schema.Union([BillingProviderError, ExternalServiceError]);
+const SubscriptionsSubscribe503 = /* @__PURE__ */ Schema.Union([SenderNotReadyError, DeliveryUnavailableError]);
+const SubscriptionsSubscribe504 = GatewayTimeoutError;
+var SubscriptionsGroup = class extends HttpApiGroup.make("Subscriptions").add(HttpApiEndpoint.post("subscriptionsSubscribe", "/v1/subscriptions", {
+	payload: SubscriptionsSubscribeRequestJson,
+	success: SubscriptionsSubscribe200,
+	error: [
+		SubscriptionsSubscribe401.pipe(HttpApiSchema.status(401)),
+		SubscriptionsSubscribe402.pipe(HttpApiSchema.status(402)),
+		SubscriptionsSubscribe403.pipe(HttpApiSchema.status(403)),
+		SubscriptionsSubscribe404.pipe(HttpApiSchema.status(404)),
+		SubscriptionsSubscribe409.pipe(HttpApiSchema.status(409)),
+		SubscriptionsSubscribe422.pipe(HttpApiSchema.status(422)),
+		SubscriptionsSubscribe429.pipe(HttpApiSchema.status(429)),
+		SubscriptionsSubscribe500,
+		SubscriptionsSubscribe502.pipe(HttpApiSchema.status(502)),
+		SubscriptionsSubscribe503.pipe(HttpApiSchema.status(503)),
+		SubscriptionsSubscribe504.pipe(HttpApiSchema.status(504))
+	]
+}).middleware(ApiKeySecurityMiddleware).annotate(OpenApi.Identifier, "subscriptions.subscribe").annotate(OpenApi.Summary, "Request subscription confirmation").annotate(OpenApi.Description, "Sends a confirmation email from your sender. Only the recipient's explicit confirmation adds them to the active static contact group and clears the optional unsubscribe group. The link expires after seven days and can be used once. A custom published email template receives confirmUrl. Sending follows ordinary sender, admission, billing, and brand-footer settings. Requires email send authority in addition to the declared contact grants, including the optional unsubscribe preference change.")).annotate(OpenApi.Description, "Recipient-confirmed contact list subscriptions") {};
+//#endregion
+export { SubscribeResult, SubscriptionsGroup, SubscriptionsSubscribe200, SubscriptionsSubscribe401, SubscriptionsSubscribe402, SubscriptionsSubscribe403, SubscriptionsSubscribe404, SubscriptionsSubscribe409, SubscriptionsSubscribe422, SubscriptionsSubscribe429, SubscriptionsSubscribe500, SubscriptionsSubscribe502, SubscriptionsSubscribe503, SubscriptionsSubscribe504, SubscriptionsSubscribeRequestJson };
+
+//# sourceMappingURL=subscriptions.js.map