@medalsocial/sdk 1.4.0 → 1.6.0

package/dist/src/openapi.generated.d.ts

@@ -610,6 +610,170 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/capability-confirmations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Issue a capability confirmation token
+         * @description Mints a short-lived `X-Capability-Confirmation` token for one pending write. Confirmable write routes require BOTH `Idempotency-Key` and `X-Capability-Confirmation` when the credential holds the capability scope directly; API keys with legacy scopes are exempt. The token is bound to the workspace, auth subject, method, path, required scopes and idempotency key, and expires within 15 minutes. `user_approved: true` asserts that a human on the caller's side approved this exact action.
+         */
+        post: operations["issueCapabilityConfirmation"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/channels/connect-links": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List connect links
+         * @description Link tokens are never returned. Newest first, cursor-paginated. The `channel_type` / `status` filters are applied within each page, so a page may hold fewer than `limit` items while `pagination.has_more` is still true — page off `has_more`, not the item count.
+         */
+        get: operations["listChannelConnectLinks"];
+        put?: never;
+        /**
+         * Mint a hosted connect link
+         * @description Mints a single-use hosted connect link that lets an external person (no Medal account required) attach a channel account (e.g. `telegram_inbox`) to the workspace's helpdesk. The response's `data.url` contains the one-time link token EXACTLY ONCE — an idempotent replay (same `Idempotency-Key`) returns the link WITHOUT `url`. Requires the `channel.connect.manage` scope; OAuth callers additionally need the workspace `admin` role.
+         */
+        post: operations["createChannelConnectLink"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/channels/connect-links/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["Id"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Revoke a connect link
+         * @description Revokes a pending connect link so it can no longer be consumed. OAuth callers need the workspace `admin` role.
+         */
+        delete: operations["revokeChannelConnectLink"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/channels/connections": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List channel connections
+         * @description The workspace's channel connections in a generic, channel-agnostic shape. Newest first, cursor-paginated. Rows that are not projectable as connections are dropped within the page, so a page may hold fewer than `limit` items while `pagination.has_more` is still true — page off `has_more`, not the item count.
+         */
+        get: operations["listChannelConnections"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/channels/connections/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["Id"];
+            };
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        /**
+         * Disconnect a channel connection
+         * @description Disconnects a connected channel account (best-effort platform logout, then local revoke). Emits a `helpdesk.channel_disconnected` webhook event with `reason: "api_disconnect"` if the account was previously connected. OAuth callers need the workspace `admin` role.
+         */
+        delete: operations["disconnectChannelConnection"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/scan": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Queue a company/site scan
+         * @description Queues an asynchronous scan. Provide exactly one of `url`, `orgnr`, or `name`; poll the returned id via `GET /api/v1/scan/{id}`.
+         */
+        post: operations["createScan"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/scan/companies": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Search the Norwegian company registry */
+        get: operations["searchScanCompanies"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/scan/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["Id"];
+            };
+            cookie?: never;
+        };
+        /** Get a scan job */
+        get: operations["getScan"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 type webhooks = Record<string, never>;
 interface components {
@@ -1127,9 +1291,15 @@ interface components {
             author_user_id: string | null;
             author_name: string | null;
             body: string;
+            /** @description Outbound delivery state, or `null` for inbound messages and internal notes. A `201` from `POST /api/v1/helpdesk/replies` means the reply was accepted, NOT delivered — the channel hand-off is asynchronous, so poll this field (or subscribe to `helpdesk.message_delivery_updated`) to learn the outcome. */
+            delivery_status: components["schemas"]["HelpdeskMessageDeliveryStatus"] | null;
+            /** @description Last send error for a `failed` outbound message, otherwise `null`. */
+            delivery_error: string | null;
             /** @description Unix timestamp in milliseconds. */
             created_at: number;
         };
+        /** @enum {string} */
+        HelpdeskMessageDeliveryStatus: "pending" | "sent" | "delivered" | "failed";
         /** @description At least one field is required. */
         UpdateHelpdeskConversationInput: {
             status?: components["schemas"]["HelpdeskConversationStatus"];
@@ -1221,9 +1391,17 @@ interface components {
             /** @constant */
             status: "deleted";
         };
+        /** @description A delivery attempt record. `id` is the same value sent as the `X-Medal-Delivery-Id` and `Idempotency-Key` headers on the outbound request. Deliveries never carry payload bodies (payloads can contain customer PII). The correlation fields are derived from the stored event and fail closed to `null` when no canonical event exists — e.g. `test.ping` deliveries or events that have aged out of retention. */
         WebhookDelivery: {
             id: string;
             event_type: string;
+            /** @description Primary subject id of the announced event, or `null`. */
+            resource_id: string | null;
+            conversation_id: string | null;
+            message_id: string | null;
+            connection_ref: string | null;
+            channel: string | null;
+            channel_connection_id: string | null;
             /** @enum {string} */
             status: "pending" | "delivered" | "dead_letter";
             attempt_count: number;
@@ -1242,6 +1420,68 @@ interface components {
             /** @constant */
             status: "queued";
         };
+        /** @enum {string} */
+        ConnectLinkStatus: "pending" | "consumed" | "expired" | "revoked";
+        /** @enum {string} */
+        ChannelConnectionState: "connecting" | "active" | "disconnected" | "disabled";
+        CreateConnectLinkInput: {
+            /** @description Channel type to connect (e.g. `telegram_inbox`). */
+            channel_type: string;
+            /** @description Display label shown on the hosted connect page. */
+            label?: string;
+            /**
+             * Format: uri
+             * @description URL the hosted page redirects to after a successful connect — must be https.
+             */
+            redirect_url?: string;
+        };
+        ConnectLinkCreateResult: {
+            id: string;
+            /**
+             * Format: uri
+             * @description Single-use hosted connect URL containing the one-time link token — present ONLY in the live create response. An idempotent replay of the create request omits it; the token can never be retrieved again.
+             */
+            url?: string;
+            channel_type: string;
+            label: string | null;
+            status: components["schemas"]["ConnectLinkStatus"];
+            /** @description Unix timestamp in milliseconds. */
+            expires_at: number;
+        };
+        ConnectLink: {
+            id: string;
+            channel_type: string;
+            label: string | null;
+            status: components["schemas"]["ConnectLinkStatus"];
+            /** @description Stable ref of the connection created by consuming this link, or `null`. */
+            consumed_connection_ref: string | null;
+            /** @description Unix timestamp in milliseconds. */
+            expires_at: number;
+            /** @description Unix timestamp in milliseconds. */
+            created_at: number;
+        };
+        ConnectLinkRevokeResult: {
+            id: string;
+            /** @constant */
+            status: "revoked";
+        };
+        ChannelConnection: {
+            id: string;
+            channel_type: string;
+            label: string | null;
+            state: components["schemas"]["ChannelConnectionState"];
+            /** @description Privacy-preserving identity handle (e.g. a masked phone number). */
+            masked_identity: string;
+            /** @description Unix timestamp in milliseconds, or `null` if never active. */
+            last_activity_at: number | null;
+            /** @description Linked helpdesk channel connection ID, or `null`. */
+            helpdesk_connection_id: string | null;
+        };
+        ChannelConnectionDisconnectResult: {
+            id: string;
+            /** @constant */
+            state: "disconnected";
+        };
         ApiResponse_PostCreateResult: components["schemas"]["Envelope_PostCreateResult"];
         ApiResponse_PostDetail: components["schemas"]["Envelope_PostDetail"];
         ApiResponse_Success: components["schemas"]["Envelope_Success"];
@@ -1266,6 +1506,9 @@ interface components {
         ApiResponse_GdprExportRequest: components["schemas"]["Envelope_GdprExportRequest"];
         ApiResponse_GdprExportArray: components["schemas"]["Envelope_GdprExportArray"];
         ApiResponse_GdprExport: components["schemas"]["Envelope_GdprExport"];
+        ApiResponse_ScanCreateResult: components["schemas"]["Envelope_ScanCreateResult"];
+        ApiResponse_ScanCompanyArray: components["schemas"]["Envelope_ScanCompanyArray"];
+        ApiResponse_ScanJob: components["schemas"]["Envelope_ScanJob"];
         ApiResponse_ConsentResult: components["schemas"]["Envelope_ConsentResult"];
         ApiResponse_ConsentRecordArray: components["schemas"]["Envelope_ConsentRecordArray"];
         ApiResponse_WorkspaceArray: components["schemas"]["Envelope_WorkspaceArray"];
@@ -1277,6 +1520,11 @@ interface components {
         ApiResponse_WebhookDeleteResult: components["schemas"]["Envelope_WebhookDeleteResult"];
         ApiResponse_WebhookDeliveryArray: components["schemas"]["Envelope_WebhookDeliveryArray"];
         ApiResponse_WebhookTestResult: components["schemas"]["Envelope_WebhookTestResult"];
+        ApiResponse_ConnectLinkCreateResult: components["schemas"]["Envelope_ConnectLinkCreateResult"];
+        ApiResponse_ConnectLinkArray: components["schemas"]["Envelope_ConnectLinkArray"];
+        ApiResponse_ConnectLinkRevokeResult: components["schemas"]["Envelope_ConnectLinkRevokeResult"];
+        ApiResponse_ChannelConnectionArray: components["schemas"]["Envelope_ChannelConnectionArray"];
+        ApiResponse_ChannelConnectionDisconnectResult: components["schemas"]["Envelope_ChannelConnectionDisconnectResult"];
         PaginatedResponse_Post: {
             data: components["schemas"]["Post"][];
             pagination: components["schemas"]["Pagination"];
@@ -1301,6 +1549,14 @@ interface components {
             data: components["schemas"]["HelpdeskMessage"][];
             pagination: components["schemas"]["Pagination"];
         };
+        PaginatedResponse_ConnectLink: {
+            data: components["schemas"]["ConnectLink"][];
+            pagination: components["schemas"]["Pagination"];
+        };
+        PaginatedResponse_ChannelConnection: {
+            data: components["schemas"]["ChannelConnection"][];
+            pagination: components["schemas"]["Pagination"];
+        };
         Envelope_PostCreateResult: {
             data: components["schemas"]["PostCreateResult"];
         };
@@ -1364,6 +1620,67 @@ interface components {
         Envelope_DealRemoveResult: {
             data: components["schemas"]["DealRemoveResult"];
         };
+        /** @description Provide exactly one of `url`, `orgnr`, or `name`. */
+        ScanCreateInput: {
+            url?: string;
+            orgnr?: string;
+            name?: string;
+        } & (unknown | unknown | unknown);
+        ScanCreateResult: {
+            id: string;
+            status: string;
+            message?: string;
+        };
+        ScanCompany: {
+            orgnr: string;
+            name: string;
+            org_form: string | null;
+            industry: string | null;
+            city: string | null;
+            website: string | null;
+        };
+        ScanJob: {
+            id: string;
+            /** @description pending | running | done | failed */
+            status: string;
+            input: components["schemas"]["ScanCreateInput"];
+            resolved: {
+                orgnr?: string;
+                companyName?: string;
+                websiteUrl?: string;
+            } | null;
+            /** @description Versioned findings payload (see the SDK `ScanResultPayload` type); additive per `version`. The stable core is documented below; further sections (registry, signals, pagespeed, seo, ai, gdpr, mailAuth, httpsOk) evolve additively. */
+            result: ({
+                version: number;
+                /** @description Weighted composite score (0-100); null when unmeasurable. */
+                nettskaar: number | null;
+                /** @description Per-axis 0-100 scores; null axes were unmeasurable. */
+                subScores: {
+                    fart: number | null;
+                    google: number | null;
+                    ai: number | null;
+                    trygghet: number | null;
+                    omdomme: number | null;
+                };
+            } & {
+                [key: string]: unknown;
+            }) | null;
+            /** @description Public-safe failure code (company_not_found, no_website, …). */
+            error: string | null;
+            /** Format: date-time */
+            created_at: string | null;
+            /** Format: date-time */
+            finished_at: string | null;
+        };
+        Envelope_ScanCreateResult: {
+            data: components["schemas"]["ScanCreateResult"];
+        };
+        Envelope_ScanCompanyArray: {
+            data: components["schemas"]["ScanCompany"][];
+        };
+        Envelope_ScanJob: {
+            data: components["schemas"]["ScanJob"];
+        };
         Envelope_GdprExportRequest: {
             data: components["schemas"]["GdprExportRequest"];
         };
@@ -1400,12 +1717,73 @@ interface components {
         Envelope_WebhookDeleteResult: {
             data: components["schemas"]["WebhookDeleteResult"];
         };
+        IssueCapabilityConfirmationInput: {
+            /** @description Confirmable capability to mint a token for. */
+            capability_id: string;
+            /** @description Concrete `/api/v1/...` path to bind the token to. Optional when the capability has exactly one API target; required when it has several. */
+            api_path?: string;
+            /** @description Values for the capability path template's parameters. */
+            path_params?: {
+                [key: string]: string | number | boolean;
+            };
+            /** @description The exact `Idempotency-Key` the confirmed write will send. The token is bound to it. */
+            idempotency_key?: string;
+            /** @description Human-readable description of the approved action, retained for audit. */
+            preview_summary: string;
+            /**
+             * @description Asserts that a human on the caller's side approved this specific action.
+             * @constant
+             */
+            user_approved: true;
+        };
+        CapabilityConfirmation: {
+            /** @description Send as the `X-Capability-Confirmation` header on the write. */
+            confirmation_token: string;
+            /** @constant */
+            token_type: "medal_capability_confirmation";
+            capability_id: string;
+            method: string;
+            path: string;
+            required_scopes: string[];
+            idempotency_key: string | null;
+            expires_in: number;
+            /** Format: date-time */
+            expires_at: string;
+            preview_summary: string;
+        };
+        ApiResponse_CapabilityConfirmation: components["schemas"]["Envelope_CapabilityConfirmation"];
+        Envelope_CapabilityConfirmation: {
+            data: components["schemas"]["CapabilityConfirmation"];
+        };
         Envelope_WebhookDeliveryArray: {
             data: components["schemas"]["WebhookDelivery"][];
         };
         Envelope_WebhookTestResult: {
             data: components["schemas"]["WebhookTestResult"];
         };
+        Envelope_ConnectLinkCreateResult: {
+            data: components["schemas"]["ConnectLinkCreateResult"];
+        };
+        /**
+         * @deprecated
+         * @description Deprecated — `listChannelConnectLinks` responds with `PaginatedResponse_ConnectLink`. Retained for backwards compatibility with consumers of the generated contract types.
+         */
+        Envelope_ConnectLinkArray: {
+            data: components["schemas"]["ConnectLink"][];
+        };
+        Envelope_ConnectLinkRevokeResult: {
+            data: components["schemas"]["ConnectLinkRevokeResult"];
+        };
+        /**
+         * @deprecated
+         * @description Deprecated — `listChannelConnections` responds with `PaginatedResponse_ChannelConnection`. Retained for backwards compatibility with consumers of the generated contract types.
+         */
+        Envelope_ChannelConnectionArray: {
+            data: components["schemas"]["ChannelConnection"][];
+        };
+        Envelope_ChannelConnectionDisconnectResult: {
+            data: components["schemas"]["ChannelConnectionDisconnectResult"];
+        };
     };
     responses: {
         /** @description API error. */
@@ -2545,6 +2923,225 @@ interface operations {
             default: components["responses"]["ApiError"];
         };
     };
+    issueCapabilityConfirmation: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["IssueCapabilityConfirmationInput"];
+            };
+        };
+        responses: {
+            /** @description Minted confirmation token. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_CapabilityConfirmation"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    listChannelConnectLinks: {
+        parameters: {
+            query?: {
+                /** @description Page size (default 50, capped at 100). */
+                limit?: number;
+                cursor?: components["parameters"]["Cursor"];
+                channel_type?: string;
+                status?: components["schemas"]["ConnectLinkStatus"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Connect links page. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedResponse_ConnectLink"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    createChannelConnectLink: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateConnectLinkInput"];
+            };
+        };
+        responses: {
+            /** @description Minted connect link, including the one-time `url`. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ConnectLinkCreateResult"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    revokeChannelConnectLink: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["Id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Revoke result. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ConnectLinkRevokeResult"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    listChannelConnections: {
+        parameters: {
+            query?: {
+                /** @description Page size (default 50, capped at 100). */
+                limit?: number;
+                cursor?: components["parameters"]["Cursor"];
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Channel connections page. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedResponse_ChannelConnection"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    disconnectChannelConnection: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["Id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Disconnect result. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ChannelConnectionDisconnectResult"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    createScan: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["ScanCreateInput"];
+            };
+        };
+        responses: {
+            /** @description Scan job queued. */
+            202: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ScanCreateResult"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    searchScanCompanies: {
+        parameters: {
+            query: {
+                q: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Registry matches (top 5, relevance-ranked). */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ScanCompanyArray"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
+    getScan: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["Id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Scan job status and, once done, the findings payload. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ApiResponse_ScanJob"];
+                };
+            };
+            default: components["responses"]["ApiError"];
+        };
+    };
 }
 
 export type { $defs, components, operations, paths, webhooks };