@workwae/sdk 0.0.0-stage → 0.1.0-alpha.1

package/contract/connect/models.d.ts

@@ -0,0 +1,272 @@
+import * as z from "zod";
+/** How an OAuth-connected mailbox is read: the provider's API, or IMAP and SMTP with XOAUTH2. */
+export declare const MailAccess: z.ZodEnum<{
+    imap: "imap";
+    api: "api";
+}>;
+export type MailAccess = z.infer<typeof MailAccess>;
+export declare const ConnectOptions: z.ZodObject<{
+    calendarEnabled: z.ZodOptional<z.ZodBoolean>;
+    contactsEnabled: z.ZodOptional<z.ZodBoolean>;
+    bodyStorage: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        cache: "cache";
+        full: "full";
+    }>>;
+    mailAccess: z.ZodOptional<z.ZodEnum<{
+        imap: "imap";
+        api: "api";
+    }>>;
+    sharedMailboxesEnabled: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type ConnectOptions = z.infer<typeof ConnectOptions>;
+/** What a hosted connect page offers: an OAuth sign-in, or the IMAP/SMTP form. */
+export declare const ConnectProvider: z.ZodEnum<{
+    google: "google";
+    microsoft: "microsoft";
+    imap: "imap";
+}>;
+export type ConnectProvider = z.infer<typeof ConnectProvider>;
+/** Where a hosted session (account or meeting connect) stands. */
+export declare const ConnectSessionStatus: z.ZodEnum<{
+    pending: "pending";
+    completed: "completed";
+    failed: "failed";
+}>;
+export type ConnectSessionStatus = z.infer<typeof ConnectSessionStatus>;
+/**
+ * Why a connect flow failed: the `error` a connect redirect carries (status=error, OAuth and
+ * meeting sign-ins, administrator consent, the hosted IMAP form's plan and billing failures) and
+ * a failed session's `error`. Not an API reason: these travel in redirect URLs. Every code an
+ * OAuth failure carries is one (the API checks this where they flow into a redirect).
+ */
+export declare const ConnectErrorCode: z.ZodEnum<{
+    session_used: "session_used";
+    session_expired: "session_expired";
+    provider_not_allowed: "provider_not_allowed";
+    access_denied: "access_denied";
+    access_token_rejected: "access_token_rejected";
+    provider_error: "provider_error";
+    provider_unavailable: "provider_unavailable";
+    provider_not_configured: "provider_not_configured";
+    unsupported_provider: "unsupported_provider";
+    token_exchange_failed: "token_exchange_failed";
+    invalid_client: "invalid_client";
+    invalid_grant: "invalid_grant";
+    missing_refresh_token: "missing_refresh_token";
+    scope_denied: "scope_denied";
+    identity_failed: "identity_failed";
+    identity_unavailable: "identity_unavailable";
+    credential_conflict: "credential_conflict";
+    credential_missing: "credential_missing";
+    delegate_missing: "delegate_missing";
+    account_exists: "account_exists";
+    account_mismatch: "account_mismatch";
+    account_not_found: "account_not_found";
+    unknown_oauth_app: "unknown_oauth_app";
+    oauth_app_mismatch: "oauth_app_mismatch";
+    oauth_app_secret_unreadable: "oauth_app_secret_unreadable";
+    google_imap_requires_own_app: "google_imap_requires_own_app";
+    unknown_meeting_app: "unknown_meeting_app";
+    meeting_app_mismatch: "meeting_app_mismatch";
+    meeting_app_secret_unreadable: "meeting_app_secret_unreadable";
+    consent_failed: "consent_failed";
+    consent_required: "consent_required";
+    consent_revoked: "consent_revoked";
+    consent_unverified: "consent_unverified";
+    directory_already_connected: "directory_already_connected";
+    directory_mismatch: "directory_mismatch";
+    directory_unavailable: "directory_unavailable";
+    invalid_certificate: "invalid_certificate";
+    invalid_service_account_key: "invalid_service_account_key";
+    org_connection_not_found: "org_connection_not_found";
+    org_connection_secret_unreadable: "org_connection_secret_unreadable";
+    plan_limit_accounts: "plan_limit_accounts";
+    plan_module_unavailable: "plan_module_unavailable";
+    billing_past_due: "billing_past_due";
+    internal_error: "internal_error";
+}>;
+export type ConnectErrorCode = z.infer<typeof ConnectErrorCode>;
+export declare const ConnectSessionPublic: z.ZodObject<{
+    tenantName: z.ZodString;
+    providers: z.ZodArray<z.ZodEnum<{
+        google: "google";
+        microsoft: "microsoft";
+        imap: "imap";
+    }>>;
+    microsoftCloud: z.ZodEnum<{
+        global: "global";
+        "gcc-high": "gcc-high";
+        dod: "dod";
+        china: "china";
+    }>;
+    status: z.ZodEnum<{
+        pending: "pending";
+        completed: "completed";
+        failed: "failed";
+    }>;
+    reauthEmail: z.ZodNullable<z.ZodString>;
+    loginHint: z.ZodNullable<z.ZodString>;
+    expiresAt: z.ZodPreprocess<z.ZodDate, Date>;
+}, z.core.$strip>;
+export type ConnectSessionPublic = z.infer<typeof ConnectSessionPublic>;
+/** A hosted connect session as its creator sees it: where it stands, and what it connected. */
+export declare const ConnectSession: z.ZodObject<{
+    id: z.ZodUUID;
+    status: z.ZodEnum<{
+        pending: "pending";
+        completed: "completed";
+        failed: "failed";
+    }>;
+    error: z.ZodNullable<z.ZodEnum<{
+        session_used: "session_used";
+        session_expired: "session_expired";
+        provider_not_allowed: "provider_not_allowed";
+        access_denied: "access_denied";
+        access_token_rejected: "access_token_rejected";
+        provider_error: "provider_error";
+        provider_unavailable: "provider_unavailable";
+        provider_not_configured: "provider_not_configured";
+        unsupported_provider: "unsupported_provider";
+        token_exchange_failed: "token_exchange_failed";
+        invalid_client: "invalid_client";
+        invalid_grant: "invalid_grant";
+        missing_refresh_token: "missing_refresh_token";
+        scope_denied: "scope_denied";
+        identity_failed: "identity_failed";
+        identity_unavailable: "identity_unavailable";
+        credential_conflict: "credential_conflict";
+        credential_missing: "credential_missing";
+        delegate_missing: "delegate_missing";
+        account_exists: "account_exists";
+        account_mismatch: "account_mismatch";
+        account_not_found: "account_not_found";
+        unknown_oauth_app: "unknown_oauth_app";
+        oauth_app_mismatch: "oauth_app_mismatch";
+        oauth_app_secret_unreadable: "oauth_app_secret_unreadable";
+        google_imap_requires_own_app: "google_imap_requires_own_app";
+        unknown_meeting_app: "unknown_meeting_app";
+        meeting_app_mismatch: "meeting_app_mismatch";
+        meeting_app_secret_unreadable: "meeting_app_secret_unreadable";
+        consent_failed: "consent_failed";
+        consent_required: "consent_required";
+        consent_revoked: "consent_revoked";
+        consent_unverified: "consent_unverified";
+        directory_already_connected: "directory_already_connected";
+        directory_mismatch: "directory_mismatch";
+        directory_unavailable: "directory_unavailable";
+        invalid_certificate: "invalid_certificate";
+        invalid_service_account_key: "invalid_service_account_key";
+        org_connection_not_found: "org_connection_not_found";
+        org_connection_secret_unreadable: "org_connection_secret_unreadable";
+        plan_limit_accounts: "plan_limit_accounts";
+        plan_module_unavailable: "plan_module_unavailable";
+        billing_past_due: "billing_past_due";
+        internal_error: "internal_error";
+    }>>;
+    accountId: z.ZodNullable<z.ZodUUID>;
+    email: z.ZodNullable<z.ZodString>;
+    expiresAt: z.ZodPreprocess<z.ZodDate, Date>;
+    createdAt: z.ZodPreprocess<z.ZodDate, Date>;
+}, z.core.$strip>;
+export type ConnectSession = z.infer<typeof ConnectSession>;
+/** The `state` a redirect flow echoes back. */
+export declare const RedirectState: z.ZodString;
+/** How long a hosted session stays usable. */
+export declare const SessionTtlSeconds: z.ZodDefault<z.ZodNumber>;
+export declare const CreateConnectSession: z.ZodObject<{
+    redirectUri: z.ZodOptional<z.ZodURL>;
+    providers: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        google: "google";
+        microsoft: "microsoft";
+        imap: "imap";
+    }>>>;
+    microsoftCloud: z.ZodDefault<z.ZodEnum<{
+        global: "global";
+        "gcc-high": "gcc-high";
+        dod: "dod";
+        china: "china";
+    }>>;
+    oauthAppIds: z.ZodOptional<z.ZodObject<{
+        google: z.ZodOptional<z.ZodUUID>;
+        microsoft: z.ZodOptional<z.ZodUUID>;
+    }, z.core.$strip>>;
+    externalRef: z.ZodOptional<z.ZodString>;
+    loginHint: z.ZodOptional<z.ZodEmail>;
+    state: z.ZodOptional<z.ZodString>;
+    accountId: z.ZodOptional<z.ZodUUID>;
+    options: z.ZodOptional<z.ZodObject<{
+        calendarEnabled: z.ZodOptional<z.ZodBoolean>;
+        contactsEnabled: z.ZodOptional<z.ZodBoolean>;
+        bodyStorage: z.ZodOptional<z.ZodEnum<{
+            none: "none";
+            cache: "cache";
+            full: "full";
+        }>>;
+        mailAccess: z.ZodOptional<z.ZodEnum<{
+            imap: "imap";
+            api: "api";
+        }>>;
+        sharedMailboxesEnabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    ttlSeconds: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+export type CreateConnectSession = z.infer<typeof CreateConnectSession>;
+/** A hosted session's page, to send its owner to. */
+export declare const SessionLink: z.ZodObject<{
+    id: z.ZodUUID;
+    url: z.ZodURL;
+    expiresAt: z.ZodPreprocess<z.ZodDate, Date>;
+}, z.core.$strip>;
+export type SessionLink = z.infer<typeof SessionLink>;
+export declare const ConnectSessionIdInput: z.ZodObject<{
+    sessionId: z.ZodUUID;
+}, z.core.$strip>;
+export type ConnectSessionIdInput = z.infer<typeof ConnectSessionIdInput>;
+export declare const StartOAuthRequest: z.ZodObject<{
+    provider: z.ZodEnum<{
+        google: "google";
+        microsoft: "microsoft";
+    }>;
+    redirectUri: z.ZodURL;
+    microsoftCloud: z.ZodDefault<z.ZodEnum<{
+        global: "global";
+        "gcc-high": "gcc-high";
+        dod: "dod";
+        china: "china";
+    }>>;
+    oauthAppId: z.ZodOptional<z.ZodUUID>;
+    externalRef: z.ZodOptional<z.ZodString>;
+    state: z.ZodOptional<z.ZodString>;
+    accountId: z.ZodOptional<z.ZodUUID>;
+    options: z.ZodOptional<z.ZodObject<{
+        calendarEnabled: z.ZodOptional<z.ZodBoolean>;
+        contactsEnabled: z.ZodOptional<z.ZodBoolean>;
+        bodyStorage: z.ZodOptional<z.ZodEnum<{
+            none: "none";
+            cache: "cache";
+            full: "full";
+        }>>;
+        mailAccess: z.ZodOptional<z.ZodEnum<{
+            imap: "imap";
+            api: "api";
+        }>>;
+        sharedMailboxesEnabled: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type StartOAuthRequest = z.infer<typeof StartOAuthRequest>;
+/** Where to send the user to start the headless OAuth flow. */
+export declare const OAuthAuthorization: z.ZodObject<{
+    authorizeUrl: z.ZodURL;
+}, z.core.$strip>;
+export type OAuthAuthorization = z.infer<typeof OAuthAuthorization>;
+/** A hosted page's session, by the token in its URL. */
+export declare const SessionTokenInput: z.ZodObject<{
+    token: z.ZodString;
+}, z.core.$strip>;
+export type SessionTokenInput = z.infer<typeof SessionTokenInput>;
+/** Where the hosted page sends the browser next (the tenant's redirectUri). */
+export declare const HostedImapResult: z.ZodObject<{
+    redirectUrl: z.ZodURL;
+}, z.core.$strip>;
+export type HostedImapResult = z.infer<typeof HostedImapResult>;