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

package/contract/reasons.d.ts

@@ -0,0 +1,711 @@
+import * as z from "zod";
+/** The HTTP statuses API errors answer with. */
+export type ErrorStatus = 400 | 401 | 402 | 403 | 404 | 409 | 410 | 413 | 422 | 429 | 500 | 502 | 503 | 507;
+export interface ReasonDefinition {
+    readonly status: ErrorStatus;
+    /** The schema of the error's `data`, for a reason that carries structured extras. */
+    readonly data?: z.ZodType;
+}
+export type ReasonTable = Record<string, ReasonDefinition>;
+/** One input problem: where in the input (`path`, empty for the input as a whole) and what. */
+export declare const InputIssue: z.ZodObject<{
+    path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    message: z.ZodString;
+}, z.core.$strip>;
+export type InputIssue = z.infer<typeof InputIssue>;
+export declare const InvalidInputData: z.ZodObject<{
+    issues: z.ZodArray<z.ZodObject<{
+        path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type InvalidInputData = z.infer<typeof InvalidInputData>;
+/** The ids a request named that the tenant does not have. */
+export declare const UnknownIdsData: z.ZodObject<{
+    ids: z.ZodArray<z.ZodUUID>;
+}, z.core.$strip>;
+export type UnknownIdsData = z.infer<typeof UnknownIdsData>;
+/** The template content field that did not compile or render. */
+export declare const TemplateFieldData: z.ZodObject<{
+    field: z.ZodEnum<{
+        text: "text";
+        subject: "subject";
+        html: "html";
+        previewText: "previewText";
+    }>;
+}, z.core.$strip>;
+export type TemplateFieldData = z.infer<typeof TemplateFieldData>;
+export declare const REASONS: {
+    readonly invalid_input: {
+        readonly status: 400;
+        readonly data: z.ZodObject<{
+            issues: z.ZodArray<z.ZodObject<{
+                path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+                message: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    };
+    readonly invalid_cursor: {
+        readonly status: 400;
+    };
+    readonly invalid_range: {
+        readonly status: 400;
+    };
+    readonly payload_too_large: {
+        readonly status: 413;
+    };
+    readonly invalid_payload: {
+        readonly status: 400;
+    };
+    readonly invalid_signature: {
+        readonly status: 400;
+    };
+    readonly route_not_found: {
+        readonly status: 404;
+    };
+    readonly internal_error: {
+        readonly status: 500;
+    };
+    readonly invalid_idempotency_key: {
+        readonly status: 400;
+    };
+    readonly idempotency_key_reused: {
+        readonly status: 422;
+    };
+    readonly idempotency_key_in_progress: {
+        readonly status: 409;
+    };
+    readonly rate_limited: {
+        readonly status: 429;
+    };
+    readonly too_many_requests: {
+        readonly status: 429;
+    };
+    readonly overloaded: {
+        readonly status: 503;
+    };
+    readonly unauthenticated: {
+        readonly status: 401;
+    };
+    readonly api_key_expired: {
+        readonly status: 401;
+    };
+    readonly missing_scope: {
+        readonly status: 403;
+    };
+    readonly role_forbidden: {
+        readonly status: 403;
+    };
+    readonly account_token_forbidden: {
+        readonly status: 403;
+    };
+    readonly session_required: {
+        readonly status: 403;
+    };
+    readonly owner_required: {
+        readonly status: 403;
+    };
+    readonly platform_admin_required: {
+        readonly status: 403;
+    };
+    readonly email_verification_required: {
+        readonly status: 403;
+    };
+    readonly console_only: {
+        readonly status: 403;
+    };
+    readonly plan_limit_accounts: {
+        readonly status: 403;
+    };
+    readonly plan_limit_sends: {
+        readonly status: 403;
+    };
+    readonly plan_limit_webhooks: {
+        readonly status: 403;
+    };
+    readonly plan_limit_storage: {
+        readonly status: 403;
+    };
+    readonly plan_module_unavailable: {
+        readonly status: 403;
+    };
+    readonly storage_unavailable: {
+        readonly status: 400;
+    };
+    readonly tenant_not_found: {
+        readonly status: 404;
+    };
+    readonly billing_past_due: {
+        readonly status: 402;
+    };
+    readonly billing_disabled: {
+        readonly status: 404;
+    };
+    readonly billing_unavailable: {
+        readonly status: 502;
+    };
+    readonly billing_subscription_exists: {
+        readonly status: 409;
+    };
+    readonly billing_customer_missing: {
+        readonly status: 409;
+    };
+    readonly plan_not_billable: {
+        readonly status: 409;
+    };
+    readonly account_not_found: {
+        readonly status: 404;
+    };
+    readonly unknown_account: {
+        readonly status: 422;
+        readonly data: z.ZodObject<{
+            ids: z.ZodArray<z.ZodUUID>;
+        }, z.core.$strip>;
+    };
+    readonly account_paused: {
+        readonly status: 409;
+    };
+    readonly account_disabled: {
+        readonly status: 409;
+    };
+    readonly account_reauth_required: {
+        readonly status: 409;
+    };
+    readonly account_misconfigured: {
+        readonly status: 409;
+    };
+    readonly calendar_disabled: {
+        readonly status: 409;
+    };
+    readonly contacts_disabled: {
+        readonly status: 409;
+    };
+    readonly provider_not_found: {
+        readonly status: 404;
+    };
+    readonly provider_throttled: {
+        readonly status: 429;
+    };
+    readonly provider_unavailable: {
+        readonly status: 502;
+    };
+    readonly provider_forbidden: {
+        readonly status: 403;
+    };
+    readonly provider_conflict: {
+        readonly status: 409;
+    };
+    readonly provider_unsupported: {
+        readonly status: 400;
+    };
+    readonly provider_rejected: {
+        readonly status: 400;
+    };
+    readonly outcome_unknown: {
+        readonly status: 502;
+    };
+    readonly message_not_found: {
+        readonly status: 404;
+    };
+    readonly unknown_mailbox: {
+        readonly status: 422;
+        readonly data: z.ZodObject<{
+            ids: z.ZodArray<z.ZodUUID>;
+        }, z.core.$strip>;
+    };
+    readonly mailbox_not_label: {
+        readonly status: 400;
+    };
+    readonly thread_not_found: {
+        readonly status: 404;
+    };
+    readonly identity_not_found: {
+        readonly status: 404;
+    };
+    readonly identities_managed_by_provider: {
+        readonly status: 400;
+    };
+    readonly identity_exists: {
+        readonly status: 409;
+    };
+    readonly identity_not_custom: {
+        readonly status: 400;
+    };
+    readonly draft_not_found: {
+        readonly status: 404;
+    };
+    readonly draft_lost: {
+        readonly status: 502;
+    };
+    readonly send_not_found: {
+        readonly status: 404;
+    };
+    readonly attachments_too_large: {
+        readonly status: 400;
+    };
+    readonly not_a_draft: {
+        readonly status: 400;
+    };
+    readonly unknown_reply_target: {
+        readonly status: 422;
+    };
+    readonly from_not_allowed: {
+        readonly status: 400;
+    };
+    readonly tracking_unsupported: {
+        readonly status: 400;
+    };
+    readonly honeypot_needs_click_tracking: {
+        readonly status: 400;
+    };
+    readonly list_send_recipients: {
+        readonly status: 400;
+    };
+    readonly suppressed: {
+        readonly status: 400;
+    };
+    readonly no_recipients: {
+        readonly status: 400;
+    };
+    readonly list_unsubscribe_unavailable: {
+        readonly status: 400;
+    };
+    readonly send_not_reschedulable: {
+        readonly status: 409;
+    };
+    readonly send_not_cancellable: {
+        readonly status: 409;
+    };
+    readonly suppression_list_not_found: {
+        readonly status: 404;
+    };
+    readonly suppression_entry_not_found: {
+        readonly status: 404;
+    };
+    readonly suppression_review_not_found: {
+        readonly status: 404;
+    };
+    readonly suppression_list_exists: {
+        readonly status: 409;
+    };
+    readonly suppression_list_not_empty: {
+        readonly status: 409;
+    };
+    readonly template_not_found: {
+        readonly status: 404;
+    };
+    readonly unknown_template: {
+        readonly status: 422;
+    };
+    readonly template_and_inline_fields: {
+        readonly status: 400;
+    };
+    readonly invalid_template: {
+        readonly status: 400;
+        readonly data: z.ZodObject<{
+            field: z.ZodEnum<{
+                text: "text";
+                subject: "subject";
+                html: "html";
+                previewText: "previewText";
+            }>;
+        }, z.core.$strip>;
+    };
+    readonly template_account_mismatch: {
+        readonly status: 400;
+    };
+    readonly template_render_failed: {
+        readonly status: 400;
+        readonly data: z.ZodObject<{
+            field: z.ZodEnum<{
+                text: "text";
+                subject: "subject";
+                html: "html";
+                previewText: "previewText";
+            }>;
+        }, z.core.$strip>;
+    };
+    readonly params_too_large: {
+        readonly status: 400;
+    };
+    readonly template_name_taken: {
+        readonly status: 409;
+    };
+    readonly calendar_not_found: {
+        readonly status: 404;
+    };
+    readonly calendar_event_not_found: {
+        readonly status: 404;
+    };
+    readonly contact_not_found: {
+        readonly status: 404;
+    };
+    readonly photo_not_found: {
+        readonly status: 404;
+    };
+    readonly unknown_calendar: {
+        readonly status: 422;
+    };
+    readonly unknown_contact_folder: {
+        readonly status: 422;
+    };
+    readonly calendar_read_only: {
+        readonly status: 403;
+    };
+    readonly organizer_cannot_respond: {
+        readonly status: 409;
+    };
+    readonly invalid_time_zone: {
+        readonly status: 400;
+    };
+    readonly invalid_working_hours: {
+        readonly status: 400;
+    };
+    readonly mixed_event_times: {
+        readonly status: 400;
+    };
+    readonly invalid_recurrence: {
+        readonly status: 400;
+    };
+    readonly recurrence_on_instance: {
+        readonly status: 400;
+    };
+    readonly contact_unidentifiable: {
+        readonly status: 400;
+    };
+    readonly multiple_meeting_options: {
+        readonly status: 400;
+    };
+    readonly meeting_service_not_connected: {
+        readonly status: 409;
+    };
+    readonly meeting_service_reauth_required: {
+        readonly status: 409;
+    };
+    readonly meeting_host_missing: {
+        readonly status: 409;
+    };
+    readonly meeting_recurrence_unsupported: {
+        readonly status: 400;
+    };
+    readonly meeting_service_rejected: {
+        readonly status: 400;
+    };
+    readonly meeting_deleted: {
+        readonly status: 409;
+    };
+    readonly meeting_service_unavailable: {
+        readonly status: 502;
+    };
+    readonly meeting_app_not_found: {
+        readonly status: 404;
+    };
+    readonly unknown_meeting_app: {
+        readonly status: 422;
+    };
+    readonly meeting_connection_not_found: {
+        readonly status: 404;
+    };
+    readonly meeting_connect_session_not_found: {
+        readonly status: 404;
+    };
+    readonly meeting_app_exists: {
+        readonly status: 409;
+    };
+    readonly meeting_app_in_use: {
+        readonly status: 409;
+    };
+    readonly meeting_app_mismatch: {
+        readonly status: 400;
+    };
+    readonly meeting_app_secret_unreadable: {
+        readonly status: 400;
+    };
+    readonly not_testable: {
+        readonly status: 400;
+    };
+    readonly autodiscovery_failed: {
+        readonly status: 422;
+    };
+    readonly password_required: {
+        readonly status: 400;
+    };
+    readonly oauth_servers_fixed: {
+        readonly status: 400;
+    };
+    readonly dav_discovery_failed: {
+        readonly status: 400;
+    };
+    readonly dav_unsupported: {
+        readonly status: 400;
+    };
+    readonly login_failed: {
+        readonly status: 400;
+    };
+    readonly server_not_allowed: {
+        readonly status: 400;
+    };
+    readonly plaintext_not_allowed: {
+        readonly status: 400;
+    };
+    readonly not_dav_server: {
+        readonly status: 400;
+    };
+    readonly not_imap_account: {
+        readonly status: 400;
+    };
+    readonly password_not_stored: {
+        readonly status: 400;
+    };
+    readonly password_unsupported: {
+        readonly status: 400;
+    };
+    readonly connect_session_not_found: {
+        readonly status: 404;
+    };
+    readonly session_used: {
+        readonly status: 409;
+    };
+    readonly session_expired: {
+        readonly status: 400;
+    };
+    readonly provider_not_allowed: {
+        readonly status: 400;
+    };
+    readonly redirect_uri_not_allowed: {
+        readonly status: 400;
+    };
+    readonly access_denied: {
+        readonly status: 400;
+    };
+    readonly access_token_rejected: {
+        readonly status: 400;
+    };
+    readonly account_exists: {
+        readonly status: 409;
+    };
+    readonly account_mismatch: {
+        readonly status: 409;
+    };
+    readonly consent_failed: {
+        readonly status: 400;
+    };
+    readonly consent_revoked: {
+        readonly status: 400;
+    };
+    readonly consent_unverified: {
+        readonly status: 400;
+    };
+    readonly credential_conflict: {
+        readonly status: 400;
+    };
+    readonly credential_missing: {
+        readonly status: 400;
+    };
+    readonly identity_failed: {
+        readonly status: 400;
+    };
+    readonly identity_unavailable: {
+        readonly status: 400;
+    };
+    readonly invalid_client: {
+        readonly status: 400;
+    };
+    readonly invalid_grant: {
+        readonly status: 400;
+    };
+    readonly missing_refresh_token: {
+        readonly status: 400;
+    };
+    readonly unknown_oauth_app: {
+        readonly status: 422;
+    };
+    readonly oauth_app_not_found: {
+        readonly status: 404;
+    };
+    readonly oauth_app_mismatch: {
+        readonly status: 400;
+    };
+    readonly oauth_app_in_use: {
+        readonly status: 409;
+    };
+    readonly oauth_app_secret_unreadable: {
+        readonly status: 400;
+    };
+    readonly google_imap_requires_own_app: {
+        readonly status: 400;
+    };
+    readonly org_connection_account: {
+        readonly status: 400;
+    };
+    readonly shared_mailbox_account: {
+        readonly status: 400;
+    };
+    readonly gmail_push_unsupported: {
+        readonly status: 400;
+    };
+    readonly push_unavailable: {
+        readonly status: 400;
+    };
+    readonly cloud_required: {
+        readonly status: 400;
+    };
+    readonly provider_error: {
+        readonly status: 400;
+    };
+    readonly provider_not_configured: {
+        readonly status: 400;
+    };
+    readonly unsupported_provider: {
+        readonly status: 400;
+    };
+    readonly scope_denied: {
+        readonly status: 400;
+    };
+    readonly token_exchange_failed: {
+        readonly status: 400;
+    };
+    readonly org_connection_not_found: {
+        readonly status: 404;
+    };
+    readonly org_connection_secret_unreadable: {
+        readonly status: 400;
+    };
+    readonly consent_required: {
+        readonly status: 409;
+    };
+    readonly delegate_missing: {
+        readonly status: 400;
+    };
+    readonly directory_unavailable: {
+        readonly status: 409;
+    };
+    readonly directory_already_connected: {
+        readonly status: 409;
+    };
+    readonly directory_mismatch: {
+        readonly status: 400;
+    };
+    readonly directory_id_not_allowed: {
+        readonly status: 400;
+    };
+    readonly credential_mismatch: {
+        readonly status: 400;
+    };
+    readonly connection_in_use: {
+        readonly status: 409;
+    };
+    readonly invalid_certificate: {
+        readonly status: 400;
+    };
+    readonly invalid_service_account_key: {
+        readonly status: 400;
+    };
+    readonly not_microsoft: {
+        readonly status: 400;
+    };
+    readonly user_required: {
+        readonly status: 400;
+    };
+    readonly shared_mailbox_unsupported: {
+        readonly status: 400;
+    };
+    readonly scope_missing: {
+        readonly status: 400;
+    };
+    readonly shared_mailbox_inaccessible: {
+        readonly status: 422;
+    };
+    readonly webhook_endpoint_not_found: {
+        readonly status: 404;
+    };
+    readonly endpoint_disabled: {
+        readonly status: 409;
+    };
+    readonly event_not_found: {
+        readonly status: 404;
+    };
+    readonly replay_range_too_large: {
+        readonly status: 400;
+    };
+    readonly mailbox_outside_accounts: {
+        readonly status: 400;
+    };
+    readonly https_required: {
+        readonly status: 400;
+    };
+    readonly export_not_found: {
+        readonly status: 404;
+    };
+    readonly export_not_ready: {
+        readonly status: 409;
+    };
+    readonly export_failed: {
+        readonly status: 409;
+    };
+    readonly export_running: {
+        readonly status: 409;
+    };
+    readonly export_in_progress: {
+        readonly status: 409;
+    };
+    readonly export_expired: {
+        readonly status: 410;
+    };
+    readonly export_corrupt: {
+        readonly status: 500;
+    };
+    readonly confirmation_mismatch: {
+        readonly status: 400;
+    };
+    readonly erase_scheduled: {
+        readonly status: 409;
+    };
+    readonly erase_started: {
+        readonly status: 409;
+    };
+    readonly erase_not_found: {
+        readonly status: 404;
+    };
+    readonly ai_disabled: {
+        readonly status: 400;
+    };
+    readonly ai_unavailable: {
+        readonly status: 502;
+    };
+    readonly ai_suspended: {
+        readonly status: 502;
+    };
+    readonly ai_refused: {
+        readonly status: 400;
+    };
+    readonly unknown_message: {
+        readonly status: 422;
+    };
+};
+export type Reasons = typeof REASONS;
+/** A reason the /v1 API answers with. The workspace's ErrorReason (index.ts) adds the console's. */
+export type ErrorReason = keyof Reasons;
+/** The HTTP status `R` answers with. */
+export type ReasonStatus<R extends ErrorReason> = Reasons[R]["status"];
+/** The schema of `R`'s data, or undefined for a reason without data. */
+export type ReasonDataSchema<R extends ErrorReason> = Reasons[R] extends {
+    data: infer S extends z.ZodType;
+} ? S : undefined;
+/** The data an error with reason `R` carries (undefined for a reason without data). */
+export type ReasonData<R extends ErrorReason> = ReasonDataSchema<R> extends z.ZodType ? z.output<ReasonDataSchema<R>> : undefined;
+/** The reason checks over a table: the /v1 one below, the console's merged one in console/. */
+export declare function reasonGuards<T extends ReasonTable>(table: T): {
+    isReason: (code: unknown) => code is keyof T & string;
+    /**
+     * The reason of an API error: the `code` of an oRPC error (or any `{ code }` error body) when
+     * it is in the table, else null. The one way every app reads a refusal's reason.
+     */
+    reasonOf(error: unknown): (keyof T & string) | null;
+};
+export declare const isErrorReason: (code: unknown) => code is ErrorReason;
+/**
+ * The reason of an API error: the `code` of an oRPC error (or any `{ code }` error body) when it
+ * is one of REASONS, else null. The one way every app reads a refusal's reason.
+ */
+export declare const reasonOf: (error: unknown) => ErrorReason | null;