samva 0.15.0 → 0.17.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 {};