@salsita-ai/contracts 0.0.0-stage → 0.49.0-develop.2a2e8d75e7

package/dist/clerk/clerk-backend-api-types.d.ts

@@ -0,0 +1,740 @@
+import { z } from 'zod';
+export declare enum ClerkRole {
+    Admin = "admin",
+    SuperAdmin = "superadmin",
+    User = "user"
+}
+export declare enum ClerkUserStatus {
+    Active = "active",
+    Banned = "banned",
+    Locked = "locked"
+}
+export declare enum ClerkInvitationStatus {
+    Accepted = "accepted",
+    Pending = "pending",
+    Revoked = "revoked",
+    Expired = "expired"
+}
+export declare const UserTag: z.ZodObject<{
+    id: z.ZodString;
+    label: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    label: string;
+}, {
+    id: string;
+    label: string;
+}>;
+export type UserTag = z.infer<typeof UserTag>;
+/**
+ * ERRORS
+ */
+export declare enum ClerkErrorCode {
+    /**
+     * This error is returned when inviting a user with an email address that already exists.
+     */
+    FormIdentifierExists = "form_identifier_exists"
+}
+export declare const ClerkErrorDescription: z.ZodObject<{
+    message: z.ZodString;
+    long_message: z.ZodString;
+    code: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    long_message: string;
+    code: string;
+}, {
+    message: string;
+    long_message: string;
+    code: string;
+}>;
+export declare const ClerkErrorResponse: z.ZodObject<{
+    errors: z.ZodArray<z.ZodObject<{
+        message: z.ZodString;
+        long_message: z.ZodString;
+        code: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        long_message: string;
+        code: string;
+    }, {
+        message: string;
+        long_message: string;
+        code: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    errors: {
+        message: string;
+        long_message: string;
+        code: string;
+    }[];
+}, {
+    errors: {
+        message: string;
+        long_message: string;
+        code: string;
+    }[];
+}>;
+export type ClerkErrorDescription = z.infer<typeof ClerkErrorDescription>;
+export type ClerkErrorResponse = z.infer<typeof ClerkErrorResponse>;
+export declare class ClerkError extends Error {
+    readonly clerkError: ClerkErrorDescription;
+    constructor(clerkError: ClerkErrorDescription);
+}
+/**
+ * AUTHENTICATION
+ */
+export declare const IdTokenData: z.ZodObject<{
+    exp: z.ZodNumber;
+    iss: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    exp: number;
+    iss: string;
+}, {
+    exp: number;
+    iss: string;
+}>;
+export type IdTokenData = z.infer<typeof IdTokenData>;
+export declare const RefreshTokenData: z.ZodObject<{
+    clerkRefreshToken: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    clerkRefreshToken: string;
+}, {
+    clerkRefreshToken: string;
+}>;
+export type RefreshTokenData = z.infer<typeof RefreshTokenData>;
+export declare const OAuthRefreshTokenResult: z.ZodObject<{
+    access_token: z.ZodString;
+    expires_in: z.ZodNumber;
+    refresh_token: z.ZodString;
+    scope: z.ZodString;
+    token_type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    access_token: string;
+    expires_in: number;
+    refresh_token: string;
+    scope: string;
+    token_type: string;
+}, {
+    access_token: string;
+    expires_in: number;
+    refresh_token: string;
+    scope: string;
+    token_type: string;
+}>;
+export type OAuthRefreshTokenResult = z.infer<typeof OAuthRefreshTokenResult>;
+export declare const OAuthUserInfo: z.ZodObject<{
+    object: z.ZodLiteral<"oauth_user_info">;
+    instance_id: z.ZodString;
+    user_id: z.ZodString;
+    email: z.ZodString;
+    email_verified: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    object: "oauth_user_info";
+    instance_id: string;
+    user_id: string;
+    email: string;
+    email_verified: boolean;
+}, {
+    object: "oauth_user_info";
+    instance_id: string;
+    user_id: string;
+    email: string;
+    email_verified: boolean;
+}>;
+export type OAuthUserInfo = z.infer<typeof OAuthUserInfo>;
+export declare const User: z.ZodEffects<z.ZodObject<{
+    object: z.ZodLiteral<"user">;
+    id: z.ZodString;
+    primary_email_address_id: z.ZodString;
+    email_addresses: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        email_address: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        email_address: string;
+    }, {
+        id: string;
+        email_address: string;
+    }>, "many">;
+    first_name: z.ZodNullable<z.ZodString>;
+    last_name: z.ZodNullable<z.ZodString>;
+    public_metadata: z.ZodObject<{
+        role: z.ZodOptional<z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }>;
+    private_metadata: z.ZodObject<{
+        role: z.ZodOptional<z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }>;
+    locked: z.ZodBoolean;
+    banned: z.ZodBoolean;
+    last_sign_in_at: z.ZodNullable<z.ZodNumber>;
+    created_at: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    object: "user";
+    id: string;
+    primary_email_address_id: string;
+    email_addresses: {
+        id: string;
+        email_address: string;
+    }[];
+    first_name: string | null;
+    last_name: string | null;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    private_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    locked: boolean;
+    banned: boolean;
+    last_sign_in_at: number | null;
+    created_at: number;
+}, {
+    object: "user";
+    id: string;
+    primary_email_address_id: string;
+    email_addresses: {
+        id: string;
+        email_address: string;
+    }[];
+    first_name: string | null;
+    last_name: string | null;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    private_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    locked: boolean;
+    banned: boolean;
+    last_sign_in_at: number | null;
+    created_at: number;
+}>, {
+    id: string;
+    emailAddress: string;
+    fullName: string | null;
+    role: ClerkRole;
+    tags: string[];
+    status: ClerkUserStatus;
+    createdAt: number;
+    lastSignInAt: number | null;
+}, {
+    object: "user";
+    id: string;
+    primary_email_address_id: string;
+    email_addresses: {
+        id: string;
+        email_address: string;
+    }[];
+    first_name: string | null;
+    last_name: string | null;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    private_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    locked: boolean;
+    banned: boolean;
+    last_sign_in_at: number | null;
+    created_at: number;
+}>;
+export declare const UserResponse: z.ZodArray<z.ZodEffects<z.ZodObject<{
+    object: z.ZodLiteral<"user">;
+    id: z.ZodString;
+    primary_email_address_id: z.ZodString;
+    email_addresses: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        email_address: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        email_address: string;
+    }, {
+        id: string;
+        email_address: string;
+    }>, "many">;
+    first_name: z.ZodNullable<z.ZodString>;
+    last_name: z.ZodNullable<z.ZodString>;
+    public_metadata: z.ZodObject<{
+        role: z.ZodOptional<z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }>;
+    private_metadata: z.ZodObject<{
+        role: z.ZodOptional<z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }>;
+    locked: z.ZodBoolean;
+    banned: z.ZodBoolean;
+    last_sign_in_at: z.ZodNullable<z.ZodNumber>;
+    created_at: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    object: "user";
+    id: string;
+    primary_email_address_id: string;
+    email_addresses: {
+        id: string;
+        email_address: string;
+    }[];
+    first_name: string | null;
+    last_name: string | null;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    private_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    locked: boolean;
+    banned: boolean;
+    last_sign_in_at: number | null;
+    created_at: number;
+}, {
+    object: "user";
+    id: string;
+    primary_email_address_id: string;
+    email_addresses: {
+        id: string;
+        email_address: string;
+    }[];
+    first_name: string | null;
+    last_name: string | null;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    private_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    locked: boolean;
+    banned: boolean;
+    last_sign_in_at: number | null;
+    created_at: number;
+}>, {
+    id: string;
+    emailAddress: string;
+    fullName: string | null;
+    role: ClerkRole;
+    tags: string[];
+    status: ClerkUserStatus;
+    createdAt: number;
+    lastSignInAt: number | null;
+}, {
+    object: "user";
+    id: string;
+    primary_email_address_id: string;
+    email_addresses: {
+        id: string;
+        email_address: string;
+    }[];
+    first_name: string | null;
+    last_name: string | null;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    private_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    locked: boolean;
+    banned: boolean;
+    last_sign_in_at: number | null;
+    created_at: number;
+}>, "many">;
+export declare const UserUpdate: z.ZodObject<{
+    id: z.ZodString;
+    tags: z.ZodArray<z.ZodString, "many">;
+    role: z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    tags: string[];
+    role: ClerkRole;
+}, {
+    id: string;
+    tags: string[];
+    role: ClerkRole;
+}>;
+export declare const UserDelete: z.ZodObject<{
+    deleted: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    deleted: boolean;
+}, {
+    deleted: boolean;
+}>;
+export declare const UserInvite: z.ZodObject<{
+    emailAddress: z.ZodString;
+    role: z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>;
+    tags: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    emailAddress: string;
+    role: ClerkRole;
+    tags: string[];
+}, {
+    emailAddress: string;
+    role: ClerkRole;
+    tags: string[];
+}>;
+export type User = z.infer<typeof User>;
+export type UserResponse = z.infer<typeof UserResponse>;
+export type UserUpdate = z.infer<typeof UserUpdate>;
+export type UserDelete = z.infer<typeof UserDelete>;
+export type UserInvite = z.infer<typeof UserInvite>;
+/**
+ * INVITATIONS
+ */
+export declare const InvitationPublicMetadata: z.ZodObject<{
+    role: z.ZodOptional<z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    role?: ClerkRole | undefined;
+    tags?: string[] | undefined;
+}, {
+    role?: ClerkRole | undefined;
+    tags?: string[] | undefined;
+}>;
+export declare const Invitation: z.ZodEffects<z.ZodObject<{
+    object: z.ZodLiteral<"invitation">;
+    id: z.ZodString;
+    email_address: z.ZodString;
+    status: z.ZodEnum<[ClerkInvitationStatus.Pending, ClerkInvitationStatus.Accepted, ClerkInvitationStatus.Revoked, ClerkInvitationStatus.Expired]>;
+    public_metadata: z.ZodObject<{
+        role: z.ZodOptional<z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }>;
+    expires_at: z.ZodNumber;
+    created_at: z.ZodNumber;
+    updated_at: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    object: "invitation";
+    id: string;
+    email_address: string;
+    status: ClerkInvitationStatus;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    expires_at: number;
+    created_at: number;
+    updated_at: number;
+}, {
+    object: "invitation";
+    id: string;
+    email_address: string;
+    status: ClerkInvitationStatus;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    expires_at: number;
+    created_at: number;
+    updated_at: number;
+}>, {
+    id: string;
+    emailAddress: string;
+    status: ClerkInvitationStatus;
+    role: ClerkRole;
+    tags: string[];
+    expiresAt: number;
+    createdAt: number;
+    updatedAt: number;
+}, {
+    object: "invitation";
+    id: string;
+    email_address: string;
+    status: ClerkInvitationStatus;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    expires_at: number;
+    created_at: number;
+    updated_at: number;
+}>;
+export declare const InvitationsResponse: z.ZodArray<z.ZodEffects<z.ZodObject<{
+    object: z.ZodLiteral<"invitation">;
+    id: z.ZodString;
+    email_address: z.ZodString;
+    status: z.ZodEnum<[ClerkInvitationStatus.Pending, ClerkInvitationStatus.Accepted, ClerkInvitationStatus.Revoked, ClerkInvitationStatus.Expired]>;
+    public_metadata: z.ZodObject<{
+        role: z.ZodOptional<z.ZodEnum<[ClerkRole.Admin, ClerkRole.User, ClerkRole.SuperAdmin]>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }, {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    }>;
+    expires_at: z.ZodNumber;
+    created_at: z.ZodNumber;
+    updated_at: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    object: "invitation";
+    id: string;
+    email_address: string;
+    status: ClerkInvitationStatus;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    expires_at: number;
+    created_at: number;
+    updated_at: number;
+}, {
+    object: "invitation";
+    id: string;
+    email_address: string;
+    status: ClerkInvitationStatus;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    expires_at: number;
+    created_at: number;
+    updated_at: number;
+}>, {
+    id: string;
+    emailAddress: string;
+    status: ClerkInvitationStatus;
+    role: ClerkRole;
+    tags: string[];
+    expiresAt: number;
+    createdAt: number;
+    updatedAt: number;
+}, {
+    object: "invitation";
+    id: string;
+    email_address: string;
+    status: ClerkInvitationStatus;
+    public_metadata: {
+        role?: ClerkRole | undefined;
+        tags?: string[] | undefined;
+    };
+    expires_at: number;
+    created_at: number;
+    updated_at: number;
+}>, "many">;
+export type InvitationPublicMetadata = z.infer<typeof InvitationPublicMetadata>;
+export type Invitation = z.infer<typeof Invitation>;
+export type InvitationsResponse = z.infer<typeof InvitationsResponse>;
+/**
+ * ORGANIZATIONS
+ */
+export declare const OranizationPrivateMetadata: z.ZodObject<{
+    userTags: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        label: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        label: string;
+    }, {
+        id: string;
+        label: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    userTags: {
+        id: string;
+        label: string;
+    }[];
+}, {
+    userTags?: {
+        id: string;
+        label: string;
+    }[] | undefined;
+}>;
+export declare const Organization: z.ZodEffects<z.ZodObject<{
+    object: z.ZodLiteral<"organization">;
+    id: z.ZodString;
+    name: z.ZodString;
+    private_metadata: z.ZodObject<{
+        userTags: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            label: string;
+        }, {
+            id: string;
+            label: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        userTags: {
+            id: string;
+            label: string;
+        }[];
+    }, {
+        userTags?: {
+            id: string;
+            label: string;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    object: "organization";
+    id: string;
+    name: string;
+    private_metadata: {
+        userTags: {
+            id: string;
+            label: string;
+        }[];
+    };
+}, {
+    object: "organization";
+    id: string;
+    name: string;
+    private_metadata: {
+        userTags?: {
+            id: string;
+            label: string;
+        }[] | undefined;
+    };
+}>, {
+    id: string;
+    name: string;
+    userTags: {
+        id: string;
+        label: string;
+    }[];
+}, {
+    object: "organization";
+    id: string;
+    name: string;
+    private_metadata: {
+        userTags?: {
+            id: string;
+            label: string;
+        }[] | undefined;
+    };
+}>;
+export declare const OrganizationsResponse: z.ZodObject<{
+    total_count: z.ZodNumber;
+    data: z.ZodArray<z.ZodEffects<z.ZodObject<{
+        object: z.ZodLiteral<"organization">;
+        id: z.ZodString;
+        name: z.ZodString;
+        private_metadata: z.ZodObject<{
+            userTags: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                label: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                label: string;
+            }, {
+                id: string;
+                label: string;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            userTags: {
+                id: string;
+                label: string;
+            }[];
+        }, {
+            userTags?: {
+                id: string;
+                label: string;
+            }[] | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        object: "organization";
+        id: string;
+        name: string;
+        private_metadata: {
+            userTags: {
+                id: string;
+                label: string;
+            }[];
+        };
+    }, {
+        object: "organization";
+        id: string;
+        name: string;
+        private_metadata: {
+            userTags?: {
+                id: string;
+                label: string;
+            }[] | undefined;
+        };
+    }>, {
+        id: string;
+        name: string;
+        userTags: {
+            id: string;
+            label: string;
+        }[];
+    }, {
+        object: "organization";
+        id: string;
+        name: string;
+        private_metadata: {
+            userTags?: {
+                id: string;
+                label: string;
+            }[] | undefined;
+        };
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    total_count: number;
+    data: {
+        id: string;
+        name: string;
+        userTags: {
+            id: string;
+            label: string;
+        }[];
+    }[];
+}, {
+    total_count: number;
+    data: {
+        object: "organization";
+        id: string;
+        name: string;
+        private_metadata: {
+            userTags?: {
+                id: string;
+                label: string;
+            }[] | undefined;
+        };
+    }[];
+}>;
+export type Organization = z.infer<typeof Organization>;
+export type OrganizationResponse = z.infer<typeof OrganizationsResponse>;