@complyforce/api 1.5.0 → 1.6.0

package/cjs/sdk.gen.js

@@ -71,7 +71,8 @@ class ComplyforceApi extends HeyApiClient {
      * "uuid": "d5c0c97f-4f80-4a27-8c1c-0e5a4d4ad00",
      * "scanType": "single",
      * "scanFeaturesRequested": [
-     * "browseAgentVisionAi"
+     * "browseAgentVisionAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "shop.example.com",
      * "scanUrlsRequested": [
@@ -123,7 +124,8 @@ class ComplyforceApi extends HeyApiClient {
      * "scanType": "multiple",
      * "scanFeaturesRequested": [
      * "browseAgentVisionAi",
-     * "informationObligationAgentLlmAi"
+     * "informationObligationAgentLlmAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "shop.example.com",
      * "scanUrlsRequested": [
@@ -174,7 +176,8 @@ class ComplyforceApi extends HeyApiClient {
      * "uuid": "d5c0c97f-4f82-4a27-8c1c-0e5a4d4ad02",
      * "scanType": "mostRelevant",
      * "scanFeaturesRequested": [
-     * "informationObligationAgentLlmAi"
+     * "informationObligationAgentLlmAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "newsroom.example.com",
      * "scanUrlsRequested": [],
@@ -198,7 +201,9 @@ class ComplyforceApi extends HeyApiClient {
      *
      * <details>
      * <summary>All pages scan</summary>
-     * <p>Finds all pages of one website based on the website's sitemap and scans them. Provides a complete view of the website.</p>
+     * <p>Finds all pages of one website based on the website's sitemap and scans them. Provides a complete view of the website. Fallbacks to home page menu extraction and search index data (if additional feature is allowed to use), if no sitemap exists.
+     *
+     * `scanUrlsLimit` define the maximum pages to scan (default: `500`). You can overwrite the limit to up to `10000`. If the number of pages found is exceeded, the order will be canceled and scanning will not be billed (costs for additional features may still apply).</p>
      *
      * **Request**
      * ```json
@@ -208,6 +213,7 @@ class ComplyforceApi extends HeyApiClient {
      * "scanUrlsRequested": [
      * "careers.example.com"
      * ],
+     * "scanUrlsLimit": 1000,
      * "channel": {
      * "uuid": "b5c03f6a-8fa8-4c24-8ec8-2d0f3388f4f1"
      * }
@@ -224,10 +230,12 @@ class ComplyforceApi extends HeyApiClient {
      * "scanFeaturesRequested": [
      * "browseAgentVisionAi",
      * "consentComplianceAgent",
-     * "archivingAgent"
+     * "archivingAgent",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "careers.example.com",
      * "scanUrlsRequested": [],
+     * "scanUrlsLimit": 1000,
      * "scanPriority": 50,
      * "status": "created",
      * "createdAt": "2025-01-01T12:03:00.000Z",
@@ -248,7 +256,7 @@ class ComplyforceApi extends HeyApiClient {
      */
     postOrder(options) {
         var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).post(Object.assign(Object.assign({ security: [{ name: 'x-api-key', type: 'apiKey' }], url: '/order' }, 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: 'x-api-key', type: 'apiKey' }, { name: 'x-api-key', type: 'apiKey' }], url: '/order' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options.headers) }));
     }
     /**
      * Get order progress

package/esm/sdk.gen.js

@@ -68,7 +68,8 @@ export class ComplyforceApi extends HeyApiClient {
      * "uuid": "d5c0c97f-4f80-4a27-8c1c-0e5a4d4ad00",
      * "scanType": "single",
      * "scanFeaturesRequested": [
-     * "browseAgentVisionAi"
+     * "browseAgentVisionAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "shop.example.com",
      * "scanUrlsRequested": [
@@ -120,7 +121,8 @@ export class ComplyforceApi extends HeyApiClient {
      * "scanType": "multiple",
      * "scanFeaturesRequested": [
      * "browseAgentVisionAi",
-     * "informationObligationAgentLlmAi"
+     * "informationObligationAgentLlmAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "shop.example.com",
      * "scanUrlsRequested": [
@@ -171,7 +173,8 @@ export class ComplyforceApi extends HeyApiClient {
      * "uuid": "d5c0c97f-4f82-4a27-8c1c-0e5a4d4ad02",
      * "scanType": "mostRelevant",
      * "scanFeaturesRequested": [
-     * "informationObligationAgentLlmAi"
+     * "informationObligationAgentLlmAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "newsroom.example.com",
      * "scanUrlsRequested": [],
@@ -195,7 +198,9 @@ export class ComplyforceApi extends HeyApiClient {
      *
      * <details>
      * <summary>All pages scan</summary>
-     * <p>Finds all pages of one website based on the website's sitemap and scans them. Provides a complete view of the website.</p>
+     * <p>Finds all pages of one website based on the website's sitemap and scans them. Provides a complete view of the website. Fallbacks to home page menu extraction and search index data (if additional feature is allowed to use), if no sitemap exists.
+     *
+     * `scanUrlsLimit` define the maximum pages to scan (default: `500`). You can overwrite the limit to up to `10000`. If the number of pages found is exceeded, the order will be canceled and scanning will not be billed (costs for additional features may still apply).</p>
      *
      * **Request**
      * ```json
@@ -205,6 +210,7 @@ export class ComplyforceApi extends HeyApiClient {
      * "scanUrlsRequested": [
      * "careers.example.com"
      * ],
+     * "scanUrlsLimit": 1000,
      * "channel": {
      * "uuid": "b5c03f6a-8fa8-4c24-8ec8-2d0f3388f4f1"
      * }
@@ -221,10 +227,12 @@ export class ComplyforceApi extends HeyApiClient {
      * "scanFeaturesRequested": [
      * "browseAgentVisionAi",
      * "consentComplianceAgent",
-     * "archivingAgent"
+     * "archivingAgent",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "careers.example.com",
      * "scanUrlsRequested": [],
+     * "scanUrlsLimit": 1000,
      * "scanPriority": 50,
      * "status": "created",
      * "createdAt": "2025-01-01T12:03:00.000Z",
@@ -245,7 +253,7 @@ export class ComplyforceApi extends HeyApiClient {
      */
     postOrder(options) {
         var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).post(Object.assign(Object.assign({ security: [{ name: 'x-api-key', type: 'apiKey' }], url: '/order' }, 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: 'x-api-key', type: 'apiKey' }, { name: 'x-api-key', type: 'apiKey' }], url: '/order' }, options), { headers: Object.assign({ 'Content-Type': 'application/json' }, options.headers) }));
     }
     /**
      * Get order progress

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@complyforce/api",
-    "version": "1.5.0",
+    "version": "1.6.0",
     "description": "TypeScript client for the Complyforce API",
-    "digestMd5": "8efa162e0743b59282437e38e5dba3c5",
+    "digestMd5": "3365fcce1c1cd9a13ed02d345612f8f3",
     "type": "module",
     "main": "cjs/index.cjs.js",
     "module": "esm/index.js",

package/types/sdk.gen.d.ts

@@ -69,7 +69,8 @@ export declare class ComplyforceApi extends HeyApiClient {
      * "uuid": "d5c0c97f-4f80-4a27-8c1c-0e5a4d4ad00",
      * "scanType": "single",
      * "scanFeaturesRequested": [
-     * "browseAgentVisionAi"
+     * "browseAgentVisionAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "shop.example.com",
      * "scanUrlsRequested": [
@@ -121,7 +122,8 @@ export declare class ComplyforceApi extends HeyApiClient {
      * "scanType": "multiple",
      * "scanFeaturesRequested": [
      * "browseAgentVisionAi",
-     * "informationObligationAgentLlmAi"
+     * "informationObligationAgentLlmAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "shop.example.com",
      * "scanUrlsRequested": [
@@ -172,7 +174,8 @@ export declare class ComplyforceApi extends HeyApiClient {
      * "uuid": "d5c0c97f-4f82-4a27-8c1c-0e5a4d4ad02",
      * "scanType": "mostRelevant",
      * "scanFeaturesRequested": [
-     * "informationObligationAgentLlmAi"
+     * "informationObligationAgentLlmAi",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "newsroom.example.com",
      * "scanUrlsRequested": [],
@@ -196,7 +199,9 @@ export declare class ComplyforceApi extends HeyApiClient {
      *
      * <details>
      * <summary>All pages scan</summary>
-     * <p>Finds all pages of one website based on the website's sitemap and scans them. Provides a complete view of the website.</p>
+     * <p>Finds all pages of one website based on the website's sitemap and scans them. Provides a complete view of the website. Fallbacks to home page menu extraction and search index data (if additional feature is allowed to use), if no sitemap exists.
+     *
+     * `scanUrlsLimit` define the maximum pages to scan (default: `500`). You can overwrite the limit to up to `10000`. If the number of pages found is exceeded, the order will be canceled and scanning will not be billed (costs for additional features may still apply).</p>
      *
      * **Request**
      * ```json
@@ -206,6 +211,7 @@ export declare class ComplyforceApi extends HeyApiClient {
      * "scanUrlsRequested": [
      * "careers.example.com"
      * ],
+     * "scanUrlsLimit": 1000,
      * "channel": {
      * "uuid": "b5c03f6a-8fa8-4c24-8ec8-2d0f3388f4f1"
      * }
@@ -222,10 +228,12 @@ export declare class ComplyforceApi extends HeyApiClient {
      * "scanFeaturesRequested": [
      * "browseAgentVisionAi",
      * "consentComplianceAgent",
-     * "archivingAgent"
+     * "archivingAgent",
+     * "orderPreparationUrlsEnrichment"
      * ],
      * "scanDomain": "careers.example.com",
      * "scanUrlsRequested": [],
+     * "scanUrlsLimit": 1000,
      * "scanPriority": 50,
      * "status": "created",
      * "createdAt": "2025-01-01T12:03:00.000Z",

package/types/types.gen.d.ts

@@ -7,14 +7,18 @@ export type ClientOptions = {
 export type OrderGetResponse = {
     uuid: string;
     scanType: 'single' | 'multiple' | 'mostRelevant' | 'all';
-    scanFeaturesRequested: Array<'browseAgentVisionAi' | 'informationObligationAgentLlmAi' | 'consentComplianceAgent' | 'archivingAgent'>;
+    scanFeaturesRequested: Array<'orderPreparationUrlsEnrichment' | 'browseAgentVisionAi' | 'informationObligationAgentLlmAi' | 'consentComplianceAgent' | 'archivingAgent'>;
     scanDomain: string;
     /**
      * Array of URLs to scan. Duplicate URLs are automatically removed when multiple URLs are provided.
      */
     scanUrlsRequested: Array<string>;
+    /**
+     * Maximum number of URLs/pages to scan for all-pages scans (default: 500, max: 10000).
+     */
+    scanUrlsLimit?: number;
     scanPriority: number;
-    scanFeaturesExecuted?: Array<'browseAgentVisionAi' | 'informationObligationAgentLlmAi' | 'consentComplianceAgent' | 'archivingAgent'>;
+    scanFeaturesExecuted?: Array<'orderPreparationUrlsEnrichment' | 'browseAgentVisionAi' | 'informationObligationAgentLlmAi' | 'consentComplianceAgent' | 'archivingAgent'>;
     scanUrlsExecuted?: Array<string>;
     status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebookQueued' | 'completed' | 'completedPartially' | 'error';
     reportAvailability: 'pending' | 'available' | 'deleted';
@@ -71,12 +75,16 @@ export type OrderGetResponse = {
 export type OrderPosted = {
     uuid: string;
     scanType: 'single' | 'multiple' | 'mostRelevant' | 'all';
-    scanFeaturesRequested: Array<'browseAgentVisionAi' | 'informationObligationAgentLlmAi' | 'consentComplianceAgent' | 'archivingAgent'>;
+    scanFeaturesRequested: Array<'orderPreparationUrlsEnrichment' | 'browseAgentVisionAi' | 'informationObligationAgentLlmAi' | 'consentComplianceAgent' | 'archivingAgent'>;
     scanDomain: string;
     /**
      * Array of URLs to scan. Duplicate URLs are automatically removed when multiple URLs are provided.
      */
     scanUrlsRequested: Array<string>;
+    /**
+     * Maximum number of URLs/pages to scan for all-pages scans (default: 500, max: 10000).
+     */
+    scanUrlsLimit?: number;
     scanPriority: number;
     status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebookQueued' | 'completed' | 'completedPartially' | 'error';
     createdAt?: string;
@@ -99,6 +107,10 @@ export type OrderCreate = {
      * Array of URLs to scan. Duplicate URLs are automatically removed when multiple URLs are provided.
      */
     scanUrlsRequested: Array<string>;
+    /**
+     * Maximum number of URLs/pages to scan for all-pages scans (default: 500, max: 10000).
+     */
+    scanUrlsLimit?: number;
     channel: {
         uuid: string;
     };
@@ -203,8 +215,40 @@ export type PostOrderData = {
     url: '/order';
 };
 export type PostOrderErrors = {
-    401: null;
-    403: null;
+    /**
+     * API key is invalid
+     */
+    401: Array<{
+        code: string;
+        message: string;
+        description?: string;
+        entityName?: string;
+        fieldName?: string;
+        index?: number;
+        data?: {
+            [key: string]: unknown;
+        };
+    } | {
+        code: 'InvalidApiKey';
+        message: string;
+    }>;
+    /**
+     * Vendor has no signed main contract
+     */
+    403: Array<{
+        code: string;
+        message: string;
+        description?: string;
+        entityName?: string;
+        fieldName?: string;
+        index?: number;
+        data?: {
+            [key: string]: unknown;
+        };
+    } | {
+        code: 'VendorMainContractNotSigned';
+        message: string;
+    }>;
     default: Array<{
         code: string;
         message: string;
@@ -263,8 +307,20 @@ export type DeleteOrderReportData = {
     url: '/order/report';
 };
 export type DeleteOrderReportErrors = {
-    401: null;
-    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;
@@ -323,8 +379,20 @@ export type GetVendorApiKeyValidateData = {
     url: '/vendor/api-key/validate';
 };
 export type GetVendorApiKeyValidateErrors = {
-    401: null;
-    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;