samva 0.16.0 → 0.17.0

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

@@ -0,0 +1,291 @@
+import { HttpApiEndpoint, HttpApiGroup } from "effect/http-api";
+import * as Schema from "effect/Schema";
+import { ApiKeyAccess, ApiKeySecurityMiddleware, ForbiddenError, GatewayTimeoutError, InternalError, OrganizationId, UnauthorizedError, ValidationError } from "./shared";
+export type WhoamiUser = {
+    readonly id: string;
+    readonly name: string;
+    readonly email: string;
+};
+export declare const WhoamiUser: Schema.Struct<{
+    readonly id: Schema.String;
+    readonly name: Schema.String;
+    readonly email: Schema.String;
+}>;
+export type WhoamiOrganization = {
+    readonly id: OrganizationId;
+    readonly slug: string;
+    readonly name: string;
+};
+export declare const WhoamiOrganization: Schema.Struct<{
+    readonly id: Schema.brand<Schema.String, "OrganizationId">;
+    readonly slug: Schema.String;
+    readonly name: Schema.String;
+}>;
+export type WhoamiUserCredential = {
+    readonly type: "user";
+    readonly user: WhoamiUser;
+    readonly role: "member" | "admin" | "owner";
+};
+export declare const WhoamiUserCredential: Schema.Struct<{
+    readonly type: Schema.Literal<"user">;
+    readonly user: Schema.Struct<{
+        readonly id: Schema.String;
+        readonly name: Schema.String;
+        readonly email: Schema.String;
+    }>;
+    readonly role: Schema.Union<readonly [Schema.Literal<"member">, Schema.Literal<"admin">, Schema.Literal<"owner">]>;
+}>;
+export type WhoamiApiKeyCredential = {
+    readonly type: "apiKey";
+    readonly id: string;
+    readonly name: string;
+    readonly start: string | null;
+    readonly access: ApiKeyAccess;
+};
+export declare const WhoamiApiKeyCredential: Schema.Struct<{
+    readonly type: Schema.Literal<"apiKey">;
+    readonly id: Schema.String;
+    readonly name: Schema.String;
+    readonly start: Schema.Union<readonly [Schema.String, Schema.Null]>;
+    readonly access: Schema.Union<readonly [Schema.Struct<{
+        readonly mode: Schema.Literal<"full">;
+    }>, Schema.Struct<{
+        readonly mode: Schema.Literal<"restricted">;
+        readonly resources: Schema.Struct<{
+            readonly messages: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly email: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly domains: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly phoneNumbers: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly contacts: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly conversations: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly templates: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly webhooks: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly apiKeys: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly organization: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly billing: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            readonly analytics: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+        }>;
+        readonly mailboxes: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
+            readonly permissions: Schema.TupleWithRest<Schema.Tuple<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"update">, Schema.Literal<"send">, Schema.Literal<"quarantine.read">]>]>, readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"update">, Schema.Literal<"send">, Schema.Literal<"quarantine.read">]>]>;
+            readonly mailboxIds: Schema.optionalKey<Schema.Union<readonly [Schema.TupleWithRest<Schema.Tuple<readonly [Schema.brand<Schema.String, "MailboxId">]>, readonly [Schema.brand<Schema.String, "MailboxId">]>, Schema.Null]>>;
+            readonly sendMode: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"send">, Schema.Literal<"approval">]>, Schema.Null]>>;
+        }>, Schema.Null]>>;
+        readonly namespaceId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>>;
+    }>]>;
+}>;
+export type Whoami = {
+    readonly organization: WhoamiOrganization;
+    readonly credential: WhoamiApiKeyCredential | WhoamiUserCredential;
+};
+export declare const Whoami: Schema.Struct<{
+    readonly organization: Schema.Struct<{
+        readonly id: Schema.brand<Schema.String, "OrganizationId">;
+        readonly slug: Schema.String;
+        readonly name: Schema.String;
+    }>;
+    readonly credential: Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.Literal<"apiKey">;
+        readonly id: Schema.String;
+        readonly name: Schema.String;
+        readonly start: Schema.Union<readonly [Schema.String, Schema.Null]>;
+        readonly access: Schema.Union<readonly [Schema.Struct<{
+            readonly mode: Schema.Literal<"full">;
+        }>, Schema.Struct<{
+            readonly mode: Schema.Literal<"restricted">;
+            readonly resources: Schema.Struct<{
+                readonly messages: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly email: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly domains: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly phoneNumbers: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly contacts: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly conversations: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly templates: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly webhooks: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly apiKeys: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly organization: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly billing: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly analytics: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            }>;
+            readonly mailboxes: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
+                readonly permissions: Schema.TupleWithRest<Schema.Tuple<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"update">, Schema.Literal<"send">, Schema.Literal<"quarantine.read">]>]>, readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"update">, Schema.Literal<"send">, Schema.Literal<"quarantine.read">]>]>;
+                readonly mailboxIds: Schema.optionalKey<Schema.Union<readonly [Schema.TupleWithRest<Schema.Tuple<readonly [Schema.brand<Schema.String, "MailboxId">]>, readonly [Schema.brand<Schema.String, "MailboxId">]>, Schema.Null]>>;
+                readonly sendMode: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"send">, Schema.Literal<"approval">]>, Schema.Null]>>;
+            }>, Schema.Null]>>;
+            readonly namespaceId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>>;
+        }>]>;
+    }>, Schema.Struct<{
+        readonly type: Schema.Literal<"user">;
+        readonly user: Schema.Struct<{
+            readonly id: Schema.String;
+            readonly name: Schema.String;
+            readonly email: Schema.String;
+        }>;
+        readonly role: Schema.Union<readonly [Schema.Literal<"member">, Schema.Literal<"admin">, Schema.Literal<"owner">]>;
+    }>]>;
+}>;
+export type WhoamiGet200 = Whoami;
+export declare const WhoamiGet200: Schema.Struct<{
+    readonly organization: Schema.Struct<{
+        readonly id: Schema.brand<Schema.String, "OrganizationId">;
+        readonly slug: Schema.String;
+        readonly name: Schema.String;
+    }>;
+    readonly credential: Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.Literal<"apiKey">;
+        readonly id: Schema.String;
+        readonly name: Schema.String;
+        readonly start: Schema.Union<readonly [Schema.String, Schema.Null]>;
+        readonly access: Schema.Union<readonly [Schema.Struct<{
+            readonly mode: Schema.Literal<"full">;
+        }>, Schema.Struct<{
+            readonly mode: Schema.Literal<"restricted">;
+            readonly resources: Schema.Struct<{
+                readonly messages: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly email: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly domains: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly phoneNumbers: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly contacts: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly conversations: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly templates: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly webhooks: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly apiKeys: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly organization: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly billing: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly analytics: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            }>;
+            readonly mailboxes: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
+                readonly permissions: Schema.TupleWithRest<Schema.Tuple<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"update">, Schema.Literal<"send">, Schema.Literal<"quarantine.read">]>]>, readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"update">, Schema.Literal<"send">, Schema.Literal<"quarantine.read">]>]>;
+                readonly mailboxIds: Schema.optionalKey<Schema.Union<readonly [Schema.TupleWithRest<Schema.Tuple<readonly [Schema.brand<Schema.String, "MailboxId">]>, readonly [Schema.brand<Schema.String, "MailboxId">]>, Schema.Null]>>;
+                readonly sendMode: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"send">, Schema.Literal<"approval">]>, Schema.Null]>>;
+            }>, Schema.Null]>>;
+            readonly namespaceId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>>;
+        }>]>;
+    }>, Schema.Struct<{
+        readonly type: Schema.Literal<"user">;
+        readonly user: Schema.Struct<{
+            readonly id: Schema.String;
+            readonly name: Schema.String;
+            readonly email: Schema.String;
+        }>;
+        readonly role: Schema.Union<readonly [Schema.Literal<"member">, Schema.Literal<"admin">, Schema.Literal<"owner">]>;
+    }>]>;
+}>;
+export type WhoamiGet401 = UnauthorizedError;
+export declare const WhoamiGet401: typeof UnauthorizedError;
+export type WhoamiGet403 = ForbiddenError;
+export declare const WhoamiGet403: typeof ForbiddenError;
+export type WhoamiGet422 = ValidationError;
+export declare const WhoamiGet422: typeof ValidationError;
+export type WhoamiGet500 = InternalError;
+export declare const WhoamiGet500: typeof InternalError;
+export type WhoamiGet504 = GatewayTimeoutError;
+export declare const WhoamiGet504: typeof GatewayTimeoutError;
+declare const WhoamiGroup_base: HttpApiGroup.HttpApiGroup<"Whoami", HttpApiEndpoint.HttpApiEndpoint<"whoamiGet", "GET", "/v1/whoami", never, never, never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly organization: Schema.Struct<{
+        readonly id: Schema.brand<Schema.String, "OrganizationId">;
+        readonly slug: Schema.String;
+        readonly name: Schema.String;
+    }>;
+    readonly credential: Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.Literal<"apiKey">;
+        readonly id: Schema.String;
+        readonly name: Schema.String;
+        readonly start: Schema.Union<readonly [Schema.String, Schema.Null]>;
+        readonly access: Schema.Union<readonly [Schema.Struct<{
+            readonly mode: Schema.Literal<"full">;
+        }>, Schema.Struct<{
+            readonly mode: Schema.Literal<"restricted">;
+            readonly resources: Schema.Struct<{
+                readonly messages: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly email: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly domains: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly phoneNumbers: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly contacts: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly conversations: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly templates: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly webhooks: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly apiKeys: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly organization: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly billing: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+                readonly analytics: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"write">]>, Schema.Null]>>;
+            }>;
+            readonly mailboxes: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
+                readonly permissions: Schema.TupleWithRest<Schema.Tuple<readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"update">, Schema.Literal<"send">, Schema.Literal<"quarantine.read">]>]>, readonly [Schema.Union<readonly [Schema.Literal<"read">, Schema.Literal<"update">, Schema.Literal<"send">, Schema.Literal<"quarantine.read">]>]>;
+                readonly mailboxIds: Schema.optionalKey<Schema.Union<readonly [Schema.TupleWithRest<Schema.Tuple<readonly [Schema.brand<Schema.String, "MailboxId">]>, readonly [Schema.brand<Schema.String, "MailboxId">]>, Schema.Null]>>;
+                readonly sendMode: Schema.optionalKey<Schema.Union<readonly [Schema.Union<readonly [Schema.Literal<"send">, Schema.Literal<"approval">]>, Schema.Null]>>;
+            }>, Schema.Null]>>;
+            readonly namespaceId: Schema.optionalKey<Schema.Union<readonly [Schema.brand<Schema.String, "NamespaceId">, Schema.Null]>>;
+        }>]>;
+    }>, Schema.Struct<{
+        readonly type: Schema.Literal<"user">;
+        readonly user: Schema.Struct<{
+            readonly id: Schema.String;
+            readonly name: Schema.String;
+            readonly email: Schema.String;
+        }>;
+        readonly role: Schema.Union<readonly [Schema.Literal<"member">, Schema.Literal<"admin">, Schema.Literal<"owner">]>;
+    }>]>;
+}>>, Schema.toCodecJson<Schema.decodeTo<Schema.declareConstructor<ForbiddenError, {
+    readonly _tag: "ForbiddenError";
+    readonly message: string;
+}, readonly [Schema.Struct<{
+    readonly _tag: Schema.tag<"ForbiddenError">;
+    readonly message: Schema.String;
+}>], {
+    readonly _tag: "ForbiddenError";
+    readonly message: string;
+}>, Schema.Struct<{
+    readonly _tag: Schema.tag<"ForbiddenError">;
+    readonly message: Schema.String;
+}>, 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<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> | Schema.decodeTo<Schema.declareConstructor<ValidationError, {
+    readonly _tag: "ValidationError";
+    readonly message: string;
+    readonly fields?: {
+        readonly [x: string]: readonly string[];
+    } | null;
+}, readonly [Schema.Struct<{
+    readonly _tag: Schema.tag<"ValidationError">;
+    readonly message: Schema.String;
+    readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
+}>], {
+    readonly _tag: "ValidationError";
+    readonly message: string;
+    readonly fields?: {
+        readonly [x: string]: readonly string[];
+    } | null;
+}>, Schema.Struct<{
+    readonly _tag: Schema.tag<"ValidationError">;
+    readonly message: Schema.String;
+    readonly fields: Schema.optionalKey<Schema.Union<readonly [Schema.$Record<Schema.String, Schema.$Array<Schema.String>>, Schema.Null]>>;
+}>, never, never> | typeof InternalError>, ApiKeySecurityMiddleware, never>, false>;
+export declare class WhoamiGroup extends WhoamiGroup_base {
+}
+export {};