@complyforce/api 1.11.0 → 1.12.0

package/cjs/sdk.gen.js

@@ -33,36 +33,37 @@ class ComplyforceApi extends HeyApiClient {
     /**
      * Cancel order
      *
-     * Gracefully cancels an in-flight order before it reaches a final status.
+     * Stops a scan order that has not finished yet.
      *
-     * Authentication accepts **one of**: vendor API key, vendor-dashboard JWT (Bearer), or `x-authentication-super-admin`.
-     * A single `orderCancelAuth` guard implements this OR semantics — do not register multiple guards, as the controller requires every guard to succeed.
-     * The processor stops pending work, lets in-flight URL scans finish, and emits a final `canceled` status.
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * The order status moves to **`canceling`** right away while remaining page scans are stopped, then to **`canceled`** once cleanup is done.
      *
-     * Returns `204` when the cancel request is accepted, including when the order is already `canceled` (idempotent).
-     * Returns `422` when the order has already reached a non-cancelable final status (`completed`, `completedPartially`, or `error`).
+     * Returns `204` when the cancel is accepted, including when the order is already `canceled` (idempotent).
+     * Returns `422` when the order cannot be canceled because it is already **`canceling`**, or has finished (`completed`, `completedPartially`, or `error`).
      */
     postOrderCancel(options) {
         var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).post(Object.assign(Object.assign({ security: [{ name: 'x-authentication-super-admin', type: 'apiKey' }], url: '/order/cancel' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options.headers) }));
+        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).post(Object.assign(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/order/cancel' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options.headers) }));
     }
     /**
      * Get order
      *
-     * Retrieve order data, current status and status updates, as well as report link and summary for completed orders.
+     * Returns one order: current status, optional status history, and — when available — the report link and summary.
+     *
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * You can only read orders that belong to a vendor you have access to.
      */
     getOrder(options) {
         var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ url: '/order' }, options));
+        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/order' }, options));
     }
     /**
      * Create order
      *
-     * Accepting an order for a website scan with one, several, all, or the most relevant subpages.
+     * Creates a website scan for one page, several pages, the most relevant pages, or all pages of a site.
      *
-     * Authentication accepts **one of**: vendor API key or vendor-dashboard JWT (Bearer).
-     * A single `orderCreateAuth` guard implements this OR semantics — do not register multiple guards, as the controller requires every guard to succeed.
-     * The vendor API key remains the primary integration path for external integrators.
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * For automated integrations, prefer a vendor API key.
      *
      * #### Scan types (with examples)
      * <details>
@@ -273,17 +274,10 @@ class ComplyforceApi extends HeyApiClient {
         var _a;
         return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).post(Object.assign(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/order' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options.headers) }));
     }
-    /**
-     * Get order progress
-     *
-     * Current order workflow status and URL processing counters.
-     */
-    getOrderProgress(options) {
-        var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ url: '/order/progress' }, options));
-    }
     /**
      * Delete order report
+     *
+     * Deletes the stored compliance report for an order. Authenticate with a vendor API key (`x-api-key`).
      */
     deleteOrderReport(options) {
         var _a;
@@ -292,30 +286,18 @@ class ComplyforceApi extends HeyApiClient {
     /**
      * Get order report
      *
-     * Retrieve full report data and report link for completed orders.
+     * Returns the full compliance report and report link for a completed order. Authenticate with a vendor API key (`x-api-key`).
      */
     getOrderReport(options) {
         var _a;
         return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ security: [{ name: 'x-api-key', type: 'apiKey' }], url: '/order/report' }, options));
     }
-    /**
-     * Get scan artefact URLs for an order
-     *
-     * Looks up signed S3 download URLs for crawler scan artefacts (before/after consent captures and traces) for a single order.
-     *
-     * Artefacts are only mirrored when the order was created with `traceEnabled`. Absent or expired mirrors yield an empty `artefacts` map.
-     * Signed URLs expire with the S3 object lifetime; callers must treat them as short-lived download links, not permanent storage references.
-     *
-     * Authentication requires a vendor-dashboard JWT (Bearer). When the caller may not read the order, the response is `200` with an empty `artefacts` map (no existence leak).
-     */
-    getOrderOrderUuidScanArtefacts(options) {
-        var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/order/:orderUuid/scan-artefacts' }, options));
-    }
     /**
      * Get orders overview
      *
-     * List orders for the authenticated vendor. Supports cursor-based pagination and optional filters by date range, billing, status, brand and channel.
+     * Lists scan orders for a vendor, with cursor pagination and optional filters (date range, billing, status, brand, channel).
+     *
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
      */
     getOrders(options) {
         var _a;

package/esm/sdk.gen.js

@@ -30,36 +30,37 @@ export class ComplyforceApi extends HeyApiClient {
     /**
      * Cancel order
      *
-     * Gracefully cancels an in-flight order before it reaches a final status.
+     * Stops a scan order that has not finished yet.
      *
-     * Authentication accepts **one of**: vendor API key, vendor-dashboard JWT (Bearer), or `x-authentication-super-admin`.
-     * A single `orderCancelAuth` guard implements this OR semantics — do not register multiple guards, as the controller requires every guard to succeed.
-     * The processor stops pending work, lets in-flight URL scans finish, and emits a final `canceled` status.
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * The order status moves to **`canceling`** right away while remaining page scans are stopped, then to **`canceled`** once cleanup is done.
      *
-     * Returns `204` when the cancel request is accepted, including when the order is already `canceled` (idempotent).
-     * Returns `422` when the order has already reached a non-cancelable final status (`completed`, `completedPartially`, or `error`).
+     * Returns `204` when the cancel is accepted, including when the order is already `canceled` (idempotent).
+     * Returns `422` when the order cannot be canceled because it is already **`canceling`**, or has finished (`completed`, `completedPartially`, or `error`).
      */
     postOrderCancel(options) {
         var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).post(Object.assign(Object.assign({ security: [{ name: 'x-authentication-super-admin', type: 'apiKey' }], url: '/order/cancel' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options.headers) }));
+        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).post(Object.assign(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/order/cancel' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options.headers) }));
     }
     /**
      * Get order
      *
-     * Retrieve order data, current status and status updates, as well as report link and summary for completed orders.
+     * Returns one order: current status, optional status history, and — when available — the report link and summary.
+     *
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * You can only read orders that belong to a vendor you have access to.
      */
     getOrder(options) {
         var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ url: '/order' }, options));
+        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/order' }, options));
     }
     /**
      * Create order
      *
-     * Accepting an order for a website scan with one, several, all, or the most relevant subpages.
+     * Creates a website scan for one page, several pages, the most relevant pages, or all pages of a site.
      *
-     * Authentication accepts **one of**: vendor API key or vendor-dashboard JWT (Bearer).
-     * A single `orderCreateAuth` guard implements this OR semantics — do not register multiple guards, as the controller requires every guard to succeed.
-     * The vendor API key remains the primary integration path for external integrators.
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * For automated integrations, prefer a vendor API key.
      *
      * #### Scan types (with examples)
      * <details>
@@ -270,17 +271,10 @@ export class ComplyforceApi extends HeyApiClient {
         var _a;
         return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).post(Object.assign(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/order' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options.headers) }));
     }
-    /**
-     * Get order progress
-     *
-     * Current order workflow status and URL processing counters.
-     */
-    getOrderProgress(options) {
-        var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ url: '/order/progress' }, options));
-    }
     /**
      * Delete order report
+     *
+     * Deletes the stored compliance report for an order. Authenticate with a vendor API key (`x-api-key`).
      */
     deleteOrderReport(options) {
         var _a;
@@ -289,30 +283,18 @@ export class ComplyforceApi extends HeyApiClient {
     /**
      * Get order report
      *
-     * Retrieve full report data and report link for completed orders.
+     * Returns the full compliance report and report link for a completed order. Authenticate with a vendor API key (`x-api-key`).
      */
     getOrderReport(options) {
         var _a;
         return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ security: [{ name: 'x-api-key', type: 'apiKey' }], url: '/order/report' }, options));
     }
-    /**
-     * Get scan artefact URLs for an order
-     *
-     * Looks up signed S3 download URLs for crawler scan artefacts (before/after consent captures and traces) for a single order.
-     *
-     * Artefacts are only mirrored when the order was created with `traceEnabled`. Absent or expired mirrors yield an empty `artefacts` map.
-     * Signed URLs expire with the S3 object lifetime; callers must treat them as short-lived download links, not permanent storage references.
-     *
-     * Authentication requires a vendor-dashboard JWT (Bearer). When the caller may not read the order, the response is `200` with an empty `artefacts` map (no existence leak).
-     */
-    getOrderOrderUuidScanArtefacts(options) {
-        var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/order/:orderUuid/scan-artefacts' }, options));
-    }
     /**
      * Get orders overview
      *
-     * List orders for the authenticated vendor. Supports cursor-based pagination and optional filters by date range, billing, status, brand and channel.
+     * Lists scan orders for a vendor, with cursor pagination and optional filters (date range, billing, status, brand, channel).
+     *
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
      */
     getOrders(options) {
         var _a;

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@complyforce/api",
-    "version": "1.11.0",
+    "version": "1.12.0",
     "description": "TypeScript client for the Complyforce API",
-    "digestMd5": "d76450af7f92f83236477855a34e2540",
+    "digestMd5": "f79c3f41429b00e9bf76cdd19dc90e6e",
     "type": "module",
     "main": "cjs/index.cjs.js",
     "module": "esm/index.js",

package/types/index.d.ts

@@ -1,4 +1,4 @@
 export { ComplyforceApi, type Options } from './sdk.gen.js';
-export type { ClientOptions, CursorPaginationResponseMetadata, DeleteOrderReportData, DeleteOrderReportError, DeleteOrderReportErrors, DeleteOrderReportResponse, DeleteOrderReportResponses, GetOrderData, GetOrderError, GetOrderErrors, GetOrderOrderUuidScanArtefactsData, GetOrderOrderUuidScanArtefactsError, GetOrderOrderUuidScanArtefactsErrors, GetOrderOrderUuidScanArtefactsResponse, GetOrderOrderUuidScanArtefactsResponses, GetOrderProgressData, GetOrderProgressError, GetOrderProgressErrors, GetOrderProgressResponse, GetOrderProgressResponses, GetOrderReportData, GetOrderReportError, GetOrderReportErrors, GetOrderReportResponse, GetOrderReportResponses, GetOrderResponse, GetOrderResponses, GetOrdersData, GetOrdersError, GetOrdersErrors, GetOrdersResponse, GetOrdersResponses, GetVendorApiKeyValidateData, GetVendorApiKeyValidateError, GetVendorApiKeyValidateErrors, GetVendorApiKeyValidateResponse, GetVendorApiKeyValidateResponses, OrderCancelRequest, OrderCreate, OrderGetResponse, OrderListItem, OrderPosted, OrderProgressResponse, OrderReportDeleteRequest, OrderReportGetResponse, OrderScanArtefactsGot, PostOrderCancelData, PostOrderCancelError, PostOrderCancelErrors, PostOrderCancelResponse, PostOrderCancelResponses, PostOrderData, PostOrderError, PostOrderErrors, PostOrderResponse, PostOrderResponses, ScanUrlResult, ScanUrlResults } from './types.gen.js';
+export type { ClientOptions, CursorPaginationResponseMetadata, DeleteOrderReportData, DeleteOrderReportError, DeleteOrderReportErrors, DeleteOrderReportResponse, DeleteOrderReportResponses, GetOrderData, GetOrderError, GetOrderErrors, GetOrderReportData, GetOrderReportError, GetOrderReportErrors, GetOrderReportResponse, GetOrderReportResponses, GetOrderResponse, GetOrderResponses, GetOrdersData, GetOrdersError, GetOrdersErrors, GetOrdersResponse, GetOrdersResponses, GetVendorApiKeyValidateData, GetVendorApiKeyValidateError, GetVendorApiKeyValidateErrors, GetVendorApiKeyValidateResponse, GetVendorApiKeyValidateResponses, OrderCancelRequest, OrderCreate, OrderGetResponse, OrderListItem, OrderPosted, OrderReportDeleteRequest, OrderReportGetResponse, PostOrderCancelData, PostOrderCancelError, PostOrderCancelErrors, PostOrderCancelResponse, PostOrderCancelResponses, PostOrderData, PostOrderError, PostOrderErrors, PostOrderResponse, PostOrderResponses } from './types.gen.js';
 export { createClient, createConfig } from "./client/index.js";
 export { client } from "./client.gen.js";

package/types/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client/index.js';
-import type { DeleteOrderReportData, DeleteOrderReportErrors, DeleteOrderReportResponses, GetOrderData, GetOrderErrors, GetOrderOrderUuidScanArtefactsData, GetOrderOrderUuidScanArtefactsErrors, GetOrderOrderUuidScanArtefactsResponses, GetOrderProgressData, GetOrderProgressErrors, GetOrderProgressResponses, GetOrderReportData, GetOrderReportErrors, GetOrderReportResponses, GetOrderResponses, GetOrdersData, GetOrdersErrors, GetOrdersResponses, GetVendorApiKeyValidateData, GetVendorApiKeyValidateErrors, GetVendorApiKeyValidateResponses, PostOrderCancelData, PostOrderCancelErrors, PostOrderCancelResponses, PostOrderData, PostOrderErrors, PostOrderResponses } from './types.gen.js';
+import type { DeleteOrderReportData, DeleteOrderReportErrors, DeleteOrderReportResponses, GetOrderData, GetOrderErrors, GetOrderReportData, GetOrderReportErrors, GetOrderReportResponses, GetOrderResponses, GetOrdersData, GetOrdersErrors, GetOrdersResponses, GetVendorApiKeyValidateData, GetVendorApiKeyValidateErrors, GetVendorApiKeyValidateResponses, PostOrderCancelData, PostOrderCancelErrors, PostOrderCancelResponses, PostOrderData, PostOrderErrors, PostOrderResponses } from './types.gen.js';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -34,30 +34,31 @@ export declare class ComplyforceApi extends HeyApiClient {
     /**
      * Cancel order
      *
-     * Gracefully cancels an in-flight order before it reaches a final status.
+     * Stops a scan order that has not finished yet.
      *
-     * Authentication accepts **one of**: vendor API key, vendor-dashboard JWT (Bearer), or `x-authentication-super-admin`.
-     * A single `orderCancelAuth` guard implements this OR semantics — do not register multiple guards, as the controller requires every guard to succeed.
-     * The processor stops pending work, lets in-flight URL scans finish, and emits a final `canceled` status.
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * The order status moves to **`canceling`** right away while remaining page scans are stopped, then to **`canceled`** once cleanup is done.
      *
-     * Returns `204` when the cancel request is accepted, including when the order is already `canceled` (idempotent).
-     * Returns `422` when the order has already reached a non-cancelable final status (`completed`, `completedPartially`, or `error`).
+     * Returns `204` when the cancel is accepted, including when the order is already `canceled` (idempotent).
+     * Returns `422` when the order cannot be canceled because it is already **`canceling`**, or has finished (`completed`, `completedPartially`, or `error`).
      */
     postOrderCancel<ThrowOnError extends boolean = false>(options: Options<PostOrderCancelData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostOrderCancelResponses, PostOrderCancelErrors, ThrowOnError, "fields">;
     /**
      * Get order
      *
-     * Retrieve order data, current status and status updates, as well as report link and summary for completed orders.
+     * Returns one order: current status, optional status history, and — when available — the report link and summary.
+     *
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * You can only read orders that belong to a vendor you have access to.
      */
     getOrder<ThrowOnError extends boolean = false>(options: Options<GetOrderData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetOrderResponses, GetOrderErrors, ThrowOnError, "fields">;
     /**
      * Create order
      *
-     * Accepting an order for a website scan with one, several, all, or the most relevant subpages.
+     * Creates a website scan for one page, several pages, the most relevant pages, or all pages of a site.
      *
-     * Authentication accepts **one of**: vendor API key or vendor-dashboard JWT (Bearer).
-     * A single `orderCreateAuth` guard implements this OR semantics — do not register multiple guards, as the controller requires every guard to succeed.
-     * The vendor API key remains the primary integration path for external integrators.
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
+     * For automated integrations, prefer a vendor API key.
      *
      * #### Scan types (with examples)
      * <details>
@@ -265,37 +266,24 @@ export declare class ComplyforceApi extends HeyApiClient {
      * </details>
      */
     postOrder<ThrowOnError extends boolean = false>(options: Options<PostOrderData, ThrowOnError>): import("./client/types.gen.js").RequestResult<PostOrderResponses, PostOrderErrors, ThrowOnError, "fields">;
-    /**
-     * Get order progress
-     *
-     * Current order workflow status and URL processing counters.
-     */
-    getOrderProgress<ThrowOnError extends boolean = false>(options: Options<GetOrderProgressData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetOrderProgressResponses, GetOrderProgressErrors, ThrowOnError, "fields">;
     /**
      * Delete order report
+     *
+     * Deletes the stored compliance report for an order. Authenticate with a vendor API key (`x-api-key`).
      */
     deleteOrderReport<ThrowOnError extends boolean = false>(options: Options<DeleteOrderReportData, ThrowOnError>): import("./client/types.gen.js").RequestResult<DeleteOrderReportResponses, DeleteOrderReportErrors, ThrowOnError, "fields">;
     /**
      * Get order report
      *
-     * Retrieve full report data and report link for completed orders.
+     * Returns the full compliance report and report link for a completed order. Authenticate with a vendor API key (`x-api-key`).
      */
     getOrderReport<ThrowOnError extends boolean = false>(options: Options<GetOrderReportData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetOrderReportResponses, GetOrderReportErrors, ThrowOnError, "fields">;
-    /**
-     * Get scan artefact URLs for an order
-     *
-     * Looks up signed S3 download URLs for crawler scan artefacts (before/after consent captures and traces) for a single order.
-     *
-     * Artefacts are only mirrored when the order was created with `traceEnabled`. Absent or expired mirrors yield an empty `artefacts` map.
-     * Signed URLs expire with the S3 object lifetime; callers must treat them as short-lived download links, not permanent storage references.
-     *
-     * Authentication requires a vendor-dashboard JWT (Bearer). When the caller may not read the order, the response is `200` with an empty `artefacts` map (no existence leak).
-     */
-    getOrderOrderUuidScanArtefacts<ThrowOnError extends boolean = false>(options: Options<GetOrderOrderUuidScanArtefactsData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetOrderOrderUuidScanArtefactsResponses, GetOrderOrderUuidScanArtefactsErrors, ThrowOnError, "fields">;
     /**
      * Get orders overview
      *
-     * List orders for the authenticated vendor. Supports cursor-based pagination and optional filters by date range, billing, status, brand and channel.
+     * Lists scan orders for a vendor, with cursor pagination and optional filters (date range, billing, status, brand, channel).
+     *
+     * Authenticate with a vendor API key (`x-api-key`) or a vendor dashboard Bearer token.
      */
     getOrders<ThrowOnError extends boolean = false>(options: Options<GetOrdersData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetOrdersResponses, GetOrdersErrors, ThrowOnError, "fields">;
     /**

package/types/types.gen.d.ts

@@ -2,14 +2,14 @@ export type ClientOptions = {
     baseUrl: 'https://api.complyforce.com/v1' | (string & {});
 };
 /**
- * Cancel order request with order UUID and optional cancel reason.
+ * Order to cancel and optional cancel reason.
  */
 export type OrderCancelRequest = {
     order: {
         uuid: string;
     };
     /**
-     * Optional reason for cancellation (vendor dashboard may require a selection).
+     * Optional reason why the order is being canceled.
      */
     cancelReason?: 'wrongTarget' | 'duplicateOrder' | 'noLongerNeeded' | 'takingTooLong' | 'other';
 };
@@ -31,7 +31,7 @@ export type OrderGetResponse = {
     scanUrlsLimit?: number;
     scanPriority: number;
     scanFeaturesExecuted?: Array<'orderPreparationUrlsEnrichment' | 'browseAgentVisionAi' | 'informationObligationAgentLlmAi' | 'consentComplianceAgent' | 'archivingAgent'>;
-    status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
+    status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'canceling' | 'completed' | 'completedPartially' | 'canceled' | 'error';
     reportAvailability: 'pending' | 'available' | 'canceled' | 'deleted';
     reportDeletionReason?: 'expired' | 'websiteOperatorRequest' | 'vendorRequest' | 'unknown';
     reportAvailableUntil?: string;
@@ -67,7 +67,7 @@ export type OrderGetResponse = {
     statusUpdates: Array<{
         id: string;
         uuid: string;
-        status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
+        status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'canceling' | 'completed' | 'completedPartially' | 'canceled' | 'error';
         errorType?: 'domainNotReachable' | 'invalidUrl' | 'domainBlacklisted' | 'scanTypeNotAllowed' | 'channelInactive' | 'brandInactive' | 'tooManyUrls' | 'mixedDomains' | 'crawlingTimeout' | 'processingError' | 'reportGenerationError' | 'webhookDeliveryError';
         updatedAt?: string;
         createdAt?: string;
@@ -95,12 +95,12 @@ export type OrderPosted = {
      */
     scanUrlsLimit?: number;
     scanPriority: number;
-    status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
+    status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'canceling' | 'completed' | 'completedPartially' | 'canceled' | 'error';
     createdAt?: string;
     statusUpdates: Array<{
         id: string;
         uuid: string;
-        status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
+        status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'canceling' | 'completed' | 'completedPartially' | 'canceled' | 'error';
         errorType?: 'domainNotReachable' | 'invalidUrl' | 'domainBlacklisted' | 'scanTypeNotAllowed' | 'channelInactive' | 'brandInactive' | 'tooManyUrls' | 'mixedDomains' | 'crawlingTimeout' | 'processingError' | 'reportGenerationError' | 'webhookDeliveryError';
         updatedAt?: string;
         createdAt?: string;
@@ -120,27 +120,13 @@ export type OrderCreate = {
      */
     scanUrlsLimit?: number;
     /**
-     * When set by an admin user, overrides the API config default for per-order crawler tracing and scan-artefact mirror writes.
+     * Admin only. When true, keeps detailed diagnostic captures for this order after the scan finishes.
      */
     traceEnabled?: boolean;
     channel: {
         uuid: string;
     };
 };
-/**
- * Order progress response
- */
-export type OrderProgressResponse = {
-    orderUuid: string;
-    status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
-    sitemapDiscoveredUrls?: number;
-    processedUrls: number;
-    totalUrls: number;
-    error?: {
-        type?: 'domainNotReachable' | 'invalidUrl' | 'domainBlacklisted' | 'scanTypeNotAllowed' | 'channelInactive' | 'brandInactive' | 'tooManyUrls' | 'mixedDomains' | 'crawlingTimeout' | 'processingError' | 'reportGenerationError' | 'webhookDeliveryError';
-        message?: string;
-    };
-};
 /**
  * Order report delete request
  */
@@ -203,57 +189,12 @@ export type OrderReportGetResponse = {
         riskScore: number;
     };
     latestStatusUpdate: {
-        status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
+        status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'canceling' | 'completed' | 'completedPartially' | 'canceled' | 'error';
         errorType?: 'domainNotReachable' | 'invalidUrl' | 'domainBlacklisted' | 'scanTypeNotAllowed' | 'channelInactive' | 'brandInactive' | 'tooManyUrls' | 'mixedDomains' | 'crawlingTimeout' | 'processingError' | 'reportGenerationError' | 'webhookDeliveryError';
         updatedAt?: string;
         createdAt?: string;
     };
 };
-/**
- * Scan artefact lookup result for one order
- */
-export type OrderScanArtefactsGot = {
-    artefacts: ScanUrlResults;
-};
-/**
- * Map of scanned page URL to artefact fields. Empty when no artefacts are available or the caller may not read the order.
- */
-export type ScanUrlResults = {
-    [key: string]: ScanUrlResult;
-};
-/**
- * Scan artefact fields for one scanned page URL.
- */
-export type ScanUrlResult = {
-    /**
-     * Signed S3 URL for the before-consent (accept-all) capture.
-     */
-    beforeConsentAcceptAll?: string;
-    /**
-     * Signed S3 URL for the after-consent (accept-all) capture.
-     */
-    afterConsentAcceptAll?: string;
-    /**
-     * Signed S3 URL for the crawl trace artefact.
-     */
-    trace?: string;
-    /**
-     * Error name when the URL scan failed.
-     */
-    errorName?: string;
-    /**
-     * Error message when the URL scan failed.
-     */
-    errorMessage?: string;
-    /**
-     * Error stack when the URL scan failed.
-     */
-    errorStack?: string;
-    /**
-     * ISO timestamp when this URL was processed.
-     */
-    processedAt?: string;
-};
 /**
  * Order summary for list view
  */
@@ -270,13 +211,13 @@ export type OrderListItem = {
         dataProtectionViolationsFound: boolean;
         riskScore: number;
     };
-    status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
+    status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'canceling' | 'completed' | 'completedPartially' | 'canceled' | 'error';
     errorType?: 'domainNotReachable' | 'invalidUrl' | 'domainBlacklisted' | 'scanTypeNotAllowed' | 'channelInactive' | 'brandInactive' | 'tooManyUrls' | 'mixedDomains' | 'crawlingTimeout' | 'processingError' | 'reportGenerationError' | 'webhookDeliveryError';
     createdAt: string;
     lastStatusUpdate?: {
         id: string;
         uuid: string;
-        status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
+        status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'canceling' | 'completed' | 'completedPartially' | 'canceled' | 'error';
         errorType?: 'domainNotReachable' | 'invalidUrl' | 'domainBlacklisted' | 'scanTypeNotAllowed' | 'channelInactive' | 'brandInactive' | 'tooManyUrls' | 'mixedDomains' | 'crawlingTimeout' | 'processingError' | 'reportGenerationError' | 'webhookDeliveryError';
         log?: string;
         updatedAt?: string;
@@ -333,7 +274,20 @@ export type PostOrderCancelErrors = {
     /**
      * No valid authentication credentials provided
      */
-    401: null;
+    401: Array<{
+        code: string;
+        message: string;
+        description?: string;
+        entityName?: string;
+        fieldName?: string;
+        index?: number;
+        data?: {
+            [key: string]: unknown;
+        };
+    } | {
+        code: 'InvalidApiKey';
+        message: string;
+    }>;
     422: Array<{
         code: string;
         message: string;
@@ -363,7 +317,7 @@ export type PostOrderCancelErrors = {
 export type PostOrderCancelError = PostOrderCancelErrors[keyof PostOrderCancelErrors];
 export type PostOrderCancelResponses = {
     /**
-     * Cancel request accepted or order already canceled
+     * Cancel accepted, or the order was already canceled
      */
     204: null;
 };
@@ -379,6 +333,23 @@ export type GetOrderData = {
     url: '/order';
 };
 export type GetOrderErrors = {
+    /**
+     * No valid authentication credentials provided
+     */
+    401: Array<{
+        code: string;
+        message: string;
+        description?: string;
+        entityName?: string;
+        fieldName?: string;
+        index?: number;
+        data?: {
+            [key: string]: unknown;
+        };
+    } | {
+        code: 'InvalidApiKey';
+        message: string;
+    }>;
     default: Array<{
         code: string;
         message: string;
@@ -449,35 +420,6 @@ export type PostOrderResponses = {
     };
 };
 export type PostOrderResponse = PostOrderResponses[keyof PostOrderResponses];
-export type GetOrderProgressData = {
-    body?: never;
-    path?: never;
-    query: {
-        orderUuid: string;
-    };
-    url: '/order/progress';
-};
-export type GetOrderProgressErrors = {
-    default: Array<{
-        code: string;
-        message: string;
-        description?: string;
-        entityName?: string;
-        fieldName?: string;
-        index?: number;
-        data?: {
-            [key: string]: unknown;
-        };
-    }>;
-};
-export type GetOrderProgressError = GetOrderProgressErrors[keyof GetOrderProgressErrors];
-export type GetOrderProgressResponses = {
-    /**
-     * Order progress retrieved
-     */
-    200: OrderProgressResponse;
-};
-export type GetOrderProgressResponse = GetOrderProgressResponses[keyof GetOrderProgressResponses];
 export type DeleteOrderReportData = {
     body: OrderReportDeleteRequest;
     path?: never;
@@ -564,52 +506,12 @@ export type GetOrderReportResponses = {
     };
 };
 export type GetOrderReportResponse = GetOrderReportResponses[keyof GetOrderReportResponses];
-export type GetOrderOrderUuidScanArtefactsData = {
-    body?: never;
-    path?: never;
-    query: {
-        /**
-         * Order UUID to look up.
-         */
-        orderUuid: string;
-    };
-    url: '/order/:orderUuid/scan-artefacts';
-};
-export type GetOrderOrderUuidScanArtefactsErrors = {
-    /**
-     * JWT is invalid
-     */
-    401: null;
-    /**
-     * JWT valid, but insufficient permissions
-     */
-    403: null;
-    default: Array<{
-        code: string;
-        message: string;
-        description?: string;
-        entityName?: string;
-        fieldName?: string;
-        index?: number;
-        data?: {
-            [key: string]: unknown;
-        };
-    }>;
-};
-export type GetOrderOrderUuidScanArtefactsError = GetOrderOrderUuidScanArtefactsErrors[keyof GetOrderOrderUuidScanArtefactsErrors];
-export type GetOrderOrderUuidScanArtefactsResponses = {
-    /**
-     * Signed scan artefact URLs for the requested order
-     */
-    200: OrderScanArtefactsGot;
-};
-export type GetOrderOrderUuidScanArtefactsResponse = GetOrderOrderUuidScanArtefactsResponses[keyof GetOrderOrderUuidScanArtefactsResponses];
 export type GetOrdersData = {
     body?: never;
     path?: never;
     query: {
         /**
-         * Vendor UUID. User must be assigned to this vendor.
+         * Vendor UUID. The authenticated API key or JWT user must have access to this vendor.
          */
         vendorUuid: string;
         /**
@@ -629,13 +531,13 @@ export type GetOrdersData = {
          */
         dateTo?: string;
         /**
-         * Filter by vendor billing ID (numeric primary key).
+         * Filter by vendor billing ID.
          */
         billingId?: string;
         /**
          * Filter by order status.
          */
-        status?: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'completed' | 'completedPartially' | 'canceled' | 'error';
+        status?: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebhookQueued' | 'canceling' | 'completed' | 'completedPartially' | 'canceled' | 'error';
         /**
          * Filter by vendor brand UUID.
          */
@@ -649,13 +551,22 @@ export type GetOrdersData = {
 };
 export type GetOrdersErrors = {
     /**
-     * JWT is invalid
-     */
-    401: null;
-    /**
-     * JWT valid, but insufficient permissions
+     * No valid authentication credentials provided
      */
-    403: null;
+    401: Array<{
+        code: string;
+        message: string;
+        description?: string;
+        entityName?: string;
+        fieldName?: string;
+        index?: number;
+        data?: {
+            [key: string]: unknown;
+        };
+    } | {
+        code: 'InvalidApiKey';
+        message: string;
+    }>;
     default: Array<{
         code: string;
         message: string;