@complyforce/api 1.7.1-21451 → 1.8.0-21475

package/cjs/sdk.gen.js

@@ -281,7 +281,16 @@ class ComplyforceApi extends HeyApiClient {
      */
     getOrderReport(options) {
         var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ url: '/order/report' }, options));
+        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 orders overview
+     *
+     * List orders for the authenticated vendor. Supports cursor-based pagination and optional filters by date range, billing, status, brand and channel.
+     */
+    getOrders(options) {
+        var _a;
+        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/orders' }, options));
     }
     /**
      * Validate API key authorization

package/esm/sdk.gen.js

@@ -278,7 +278,16 @@ export class ComplyforceApi extends HeyApiClient {
      */
     getOrderReport(options) {
         var _a;
-        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ url: '/order/report' }, options));
+        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 orders overview
+     *
+     * List orders for the authenticated vendor. Supports cursor-based pagination and optional filters by date range, billing, status, brand and channel.
+     */
+    getOrders(options) {
+        var _a;
+        return ((_a = options.client) !== null && _a !== void 0 ? _a : this.client).get(Object.assign({ security: [{ name: 'authorization', type: 'apiKey' }], url: '/orders' }, options));
     }
     /**
      * Validate API key authorization

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@complyforce/api",
-  "version": "1.7.1-21451",
+  "version": "1.8.0-21475",
   "description": "TypeScript client for the Complyforce API",
-  "digestMd5": "de8b1fba5edb3256b3e5a788306b1155",
+  "digestMd5": "d6ac88e36427471e5d121b90e6ae2bdb",
   "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, DeleteOrderReportData, DeleteOrderReportError, DeleteOrderReportErrors, DeleteOrderReportResponse, DeleteOrderReportResponses, GetOrderData, GetOrderError, GetOrderErrors, GetOrderProgressData, GetOrderProgressError, GetOrderProgressErrors, GetOrderProgressResponse, GetOrderProgressResponses, GetOrderReportData, GetOrderReportError, GetOrderReportErrors, GetOrderReportResponse, GetOrderReportResponses, GetOrderResponse, GetOrderResponses, GetVendorApiKeyValidateData, GetVendorApiKeyValidateError, GetVendorApiKeyValidateErrors, GetVendorApiKeyValidateResponse, GetVendorApiKeyValidateResponses, OrderCreate, OrderGetResponse, OrderPosted, OrderProgressResponse, OrderReportDeleteRequest, OrderReportGetResponse, PostOrderData, PostOrderError, PostOrderErrors, PostOrderResponse, PostOrderResponses } from './types.gen.js';
+export type { ClientOptions, CursorPaginationResponseMetadata, DeleteOrderReportData, DeleteOrderReportError, DeleteOrderReportErrors, DeleteOrderReportResponse, DeleteOrderReportResponses, GetOrderData, GetOrderError, GetOrderErrors, GetOrderProgressData, GetOrderProgressError, GetOrderProgressErrors, GetOrderProgressResponse, GetOrderProgressResponses, GetOrderReportData, GetOrderReportError, GetOrderReportErrors, GetOrderReportResponse, GetOrderReportResponses, GetOrderResponse, GetOrderResponses, GetOrdersData, GetOrdersError, GetOrdersErrors, GetOrdersResponse, GetOrdersResponses, GetVendorApiKeyValidateData, GetVendorApiKeyValidateError, GetVendorApiKeyValidateErrors, GetVendorApiKeyValidateResponse, GetVendorApiKeyValidateResponses, OrderCreate, OrderGetResponse, OrderListItem, OrderPosted, OrderProgressResponse, OrderReportDeleteRequest, OrderReportGetResponse, 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, GetOrderProgressData, GetOrderProgressErrors, GetOrderProgressResponses, GetOrderReportData, GetOrderReportErrors, GetOrderReportResponses, GetOrderResponses, GetVendorApiKeyValidateData, GetVendorApiKeyValidateErrors, GetVendorApiKeyValidateResponses, PostOrderData, PostOrderErrors, PostOrderResponses } from './types.gen.js';
+import type { DeleteOrderReportData, DeleteOrderReportErrors, DeleteOrderReportResponses, GetOrderData, GetOrderErrors, GetOrderProgressData, GetOrderProgressErrors, GetOrderProgressResponses, GetOrderReportData, GetOrderReportErrors, GetOrderReportResponses, GetOrderResponses, GetOrdersData, GetOrdersErrors, GetOrdersResponses, GetVendorApiKeyValidateData, GetVendorApiKeyValidateErrors, GetVendorApiKeyValidateResponses, 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
@@ -269,6 +269,12 @@ export declare class ComplyforceApi extends HeyApiClient {
      * Retrieve full report data and report link for completed orders.
      */
     getOrderReport<ThrowOnError extends boolean = false>(options: Options<GetOrderReportData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetOrderReportResponses, GetOrderReportErrors, 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.
+     */
+    getOrders<ThrowOnError extends boolean = false>(options: Options<GetOrdersData, ThrowOnError>): import("./client/types.gen.js").RequestResult<GetOrdersResponses, GetOrdersErrors, ThrowOnError, "fields">;
     /**
      * Validate API key authorization
      *

package/types/types.gen.d.ts

@@ -6,6 +6,7 @@ export type ClientOptions = {
  */
 export type OrderGetResponse = {
     uuid: string;
+    id?: string;
     scanType: 'single' | 'multiple' | 'mostRelevant' | 'all';
     scanFeaturesRequested: Array<'orderPreparationUrlsEnrichment' | 'browseAgentVisionAi' | 'informationObligationAgentLlmAi' | 'consentComplianceAgent' | 'archivingAgent'>;
     scanDomain: string;
@@ -155,10 +156,26 @@ export type OrderReportGetResponse = {
             downloadUrl?: string;
             deleted: boolean;
         };
-        properties: Array<{
-            key: 'brandName' | 'colorPrimary' | 'whiteLabel' | 'realCookieBannerAds';
-            value: string;
-        }>;
+        properties: {
+            id: string;
+            language?: string;
+            brandName?: string;
+            colorPrimary?: string;
+            whiteLabel?: boolean | null;
+            realCookieBannerAds?: boolean | null;
+            legalNoticeUrl?: string;
+            legalPrivacyPolicyUrl?: string;
+            legalDisclaimerLegalAdviceOverwrite?: string;
+            translations?: Array<{
+                createdAt?: string;
+                legalNoticeUrl?: string;
+                legalPrivacyPolicyUrl?: string;
+                legalDisclaimerLegalAdviceOverwrite?: string;
+                language: string;
+            }>;
+            revision?: number;
+            createdAt?: string;
+        };
     };
     report: {
         reportUrl?: string;
@@ -173,6 +190,64 @@ export type OrderReportGetResponse = {
         createdAt?: string;
     };
 };
+/**
+ * Order summary for list view
+ */
+export type OrderListItem = {
+    uuid: string;
+    id: string;
+    scanType: 'single' | 'multiple' | 'mostRelevant' | 'all';
+    scanDomain: string;
+    scanUrlsRequestedCount: number;
+    reportScanUrlsExecutedCount: number;
+    report?: {
+        uuid: string;
+        reportUrl?: string;
+        dataProtectionViolationsFound: boolean;
+        riskScore: number;
+    };
+    status: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebookQueued' | 'completed' | 'completedPartially' | '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' | 'reportDeliveryToWebookQueued' | 'completed' | 'completedPartially' | 'error';
+        errorType?: 'domainNotReachable' | 'invalidUrl' | 'domainBlacklisted' | 'scanTypeNotAllowed' | 'channelInactive' | 'brandInactive' | 'tooManyUrls' | 'mixedDomains' | 'crawlingTimeout' | 'processingError' | 'reportGenerationError' | 'webhookDeliveryError';
+        progressInPercent: number;
+        updatedAt?: string;
+        createdAt?: string;
+    };
+    reportAvailability: 'pending' | 'available' | 'deleted';
+    reportAvailableUntil?: string;
+    vendorBrand: {
+        id: string;
+        uuid: string;
+        name: string;
+    };
+    vendorBrandChannel: {
+        id: string;
+        uuid: string;
+        name: string;
+    };
+};
+/**
+ * Cursor-based pagination metadata for list responses.
+ */
+export type CursorPaginationResponseMetadata = {
+    /**
+     * Cursor used for this page (echoed back).
+     */
+    cursor?: string;
+    /**
+     * Cursor for the next page. Omit when there is no next page.
+     */
+    nextCursor?: string;
+    /**
+     * Number of items in this response.
+     */
+    dataCount: number;
+};
 export type GetOrderData = {
     body?: never;
     path?: never;
@@ -350,6 +425,20 @@ export type GetOrderReportData = {
     url: '/order/report';
 };
 export type GetOrderReportErrors = {
+    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;
@@ -372,6 +461,81 @@ export type GetOrderReportResponses = {
     };
 };
 export type GetOrderReportResponse = GetOrderReportResponses[keyof GetOrderReportResponses];
+export type GetOrdersData = {
+    body?: never;
+    path?: never;
+    query: {
+        /**
+         * Vendor UUID. User must be assigned to this vendor.
+         */
+        vendorUuid: string;
+        /**
+         * Cursor for pagination. Omit for first page.
+         */
+        cursor?: string;
+        /**
+         * Max number of orders per page (default and max: 100).
+         */
+        limit?: number;
+        /**
+         * Filter orders created on or after the start of this calendar day (YYYY-MM-DD), interpreted in UTC.
+         */
+        dateFrom?: string;
+        /**
+         * Filter orders created on or before the end of this calendar day (YYYY-MM-DD), interpreted in UTC.
+         */
+        dateTo?: string;
+        /**
+         * Filter by vendor billing ID (numeric primary key).
+         */
+        billingId?: string;
+        /**
+         * Filter by order status.
+         */
+        status?: 'created' | 'preparing' | 'prepared' | 'queued' | 'crawling' | 'crawled' | 'processing' | 'processed' | 'reportGenerating' | 'reportGenerated' | 'reportDeliveryToWebookQueued' | 'completed' | 'completedPartially' | 'error';
+        /**
+         * Filter by vendor brand UUID.
+         */
+        brandUuid?: string;
+        /**
+         * Filter by vendor brand channel UUID.
+         */
+        channelUuid?: string;
+    };
+    url: '/orders';
+};
+export type GetOrdersErrors = {
+    /**
+     * 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 GetOrdersError = GetOrdersErrors[keyof GetOrdersErrors];
+export type GetOrdersResponses = {
+    /**
+     * Orders list with pagination metadata
+     */
+    200: {
+        data: Array<OrderListItem>;
+        responseMetadata: CursorPaginationResponseMetadata;
+    };
+};
+export type GetOrdersResponse = GetOrdersResponses[keyof GetOrdersResponses];
 export type GetVendorApiKeyValidateData = {
     body?: never;
     path?: never;