@narrative.io/data-collaboration-sdk-ts 3.8.0 → 4.0.0-beta.0

package/build/products/types.d.ts

@@ -1,34 +1,37 @@
 type ProductId = string;
-type ProductSkuType = "processing" | "storage" | "transfer";
-type ProductCloudType = "aws" | "gcp" | "azure";
-type ProductUnitType = "bytes" | "average-bytes-per-month";
-type ProductStatus = "active" | "archived";
-interface ProductRate {
-    type: string;
-    unitPrice: {
-        type: string;
-        currency: string;
-        priceInMicroCents: number;
-    };
+export type ProductSkuTypeCategory = "processing" | "storage" | "transfer" | "marketplace-data-transaction";
+export interface ProductSkuType {
+    category: ProductSkuTypeCategory;
+}
+export interface ProductCloudPlatform {
+    region?: string;
+    platform?: string;
+}
+export type ProductStatus = "active" | "archived";
+export type ProductRateType = "per_unit" | "percent_of_gmv";
+export interface ProductRate {
+    type: ProductRateType;
+    unit_price: ProductUnitPrice;
 }
 export interface ProductUnitPrice {
-    type: string;
-    currency: string;
-    priceInMicroCents: number;
+    value: number;
+    expressed_in: string;
+    currency?: string;
 }
 export interface Product {
     id: ProductId;
     sku: string;
-    skuType: ProductSkuType;
-    payableCompanyId: number;
+    sku_type: ProductSkuType;
+    payable_company_id: number;
     name: string;
-    description?: string | null;
-    cloud?: ProductCloudType | null;
-    region?: string | null;
-    unit: ProductUnitType;
-    defaultRate: ProductRate;
+    description?: string;
+    cloud_platform?: ProductCloudPlatform;
+    unit: string;
+    default_rate: ProductRate;
     status: ProductStatus;
-    createdAt: string;
-    updatedAt: string;
+    created_at: string;
+    created_by_user_id?: number;
+    updated_at: string;
+    updated_by_user_id?: number;
 }
 export {};

package/build/queries/index.d.ts

@@ -1,17 +1,18 @@
 import { BaseApi } from "../base-api";
-import type { ApiRecords } from "../types";
-import type { CreateNqlQueryRequest, NqlOwnedQueryResponse, NqlQueryAst, NqlQueryCollaborators, NqlQueryMetadata, NqlQueryOwner, NqlQueryResponse, NqlSharedQueryResponse, UpdateNqlQueryRequest } from "./types";
+import type { ApiRecordsV2 } from "../types";
+import type { CreateNqlQueryRequest, GetQueriesParams, NqlOwnedQueryResponse, NqlQueryAst, NqlQueryCollaborators, NqlQueryMetadata, NqlQueryOwner, NqlQueryResponse, NqlSharedQueryResponse, UpdateNqlQueryRequest } from "./types";
 /**
  * A class for accessing the Queries API.
  * @extends BaseApi
  */
 declare class QueriesApi extends BaseApi {
     /**
-     * Gets a list of accessable queries from the API.
+     * Gets a paginated list of accessible queries from the API.
      *
-     * @returns {Promise<ApiRecords<NqlQuery>>} A promise that resolves with the list of queries.
+     * @param {GetQueriesParams} [params] - Optional pagination, ownership, tag, owner, and keyword filters.
+     * @returns {Promise<ApiRecordsV2<NqlQueryResponse>>} A promise that resolves with the paginated list of queries.
      */
-    getQueries(): Promise<ApiRecords<NqlQueryResponse>>;
+    getQueries(params?: GetQueriesParams): Promise<ApiRecordsV2<NqlQueryResponse>>;
     /**
      * Gets a single query from the API by its ID.
      *
@@ -42,4 +43,4 @@ declare class QueriesApi extends BaseApi {
      */
     updateQuery(queryId: string, data: UpdateNqlQueryRequest): Promise<NqlQueryResponse>;
 }
-export { type CreateNqlQueryRequest, type NqlOwnedQueryResponse, type NqlQueryAst, type NqlQueryCollaborators, type NqlQueryMetadata, type NqlQueryOwner, type NqlQueryResponse, type NqlSharedQueryResponse, QueriesApi, type UpdateNqlQueryRequest, };
+export { type CreateNqlQueryRequest, type GetQueriesParams, type NqlOwnedQueryResponse, type NqlQueryAst, type NqlQueryCollaborators, type NqlQueryMetadata, type NqlQueryOwner, type NqlQueryResponse, type NqlSharedQueryResponse, QueriesApi, type UpdateNqlQueryRequest, };

package/build/queries/index.js

@@ -12,12 +12,42 @@ const resourceName = "v2/queries";
  */
 class QueriesApi extends BaseApi {
     /**
-     * Gets a list of accessable queries from the API.
+     * Gets a paginated list of accessible queries from the API.
      *
-     * @returns {Promise<ApiRecords<NqlQuery>>} A promise that resolves with the list of queries.
+     * @param {GetQueriesParams} [params] - Optional pagination, ownership, tag, owner, and keyword filters.
+     * @returns {Promise<ApiRecordsV2<NqlQueryResponse>>} A promise that resolves with the paginated list of queries.
      */
-    async getQueries() {
-        return await this.get(resourceName);
+    async getQueries(params) {
+        const queryParams = new URLSearchParams();
+        if (params?.page) {
+            queryParams.append("page", params.page.toString());
+        }
+        if (params?.per_page) {
+            queryParams.append("per_page", params.per_page.toString());
+        }
+        if (params?.is_owned !== undefined) {
+            queryParams.append("is_owned", params.is_owned.toString());
+        }
+        if (params?.q) {
+            queryParams.append("q", params.q);
+        }
+        if (params?.tag) {
+            const tags = Array.isArray(params.tag) ? params.tag : [params.tag];
+            for (const tag of tags) {
+                queryParams.append("tag", tag);
+            }
+        }
+        if (params?.company_id) {
+            const companyIds = Array.isArray(params.company_id)
+                ? params.company_id
+                : [params.company_id];
+            for (const companyId of companyIds) {
+                queryParams.append("company_id", companyId.toString());
+            }
+        }
+        const queryString = queryParams.toString();
+        const url = queryString ? `${resourceName}?${queryString}` : resourceName;
+        return await this.get(url);
     }
     /**
      * Gets a single query from the API by its ID.

package/build/queries/types.d.ts

@@ -64,3 +64,18 @@ export interface NqlQueryMetadata {
     updated_by_user_id?: number;
     updated_at: string;
 }
+/**
+ * Query parameters accepted by `GET /v2/queries`.
+ */
+export interface GetQueriesParams {
+    page?: number;
+    per_page?: number;
+    /** `true` returns only owned queries; `false` only shared-with-you queries. */
+    is_owned?: boolean;
+    /** Filters by tag. OR-d together when multiple are given. */
+    tag?: string | string[];
+    /** Filters by owning company id. OR-d together when multiple are given. */
+    company_id?: number | number[];
+    /** Free-text keyword search. */
+    q?: string;
+}

package/build/resources/index.d.ts

@@ -4,8 +4,8 @@
  */
 import { BaseApi } from "../base-api";
 import type { ApiRecords } from "../types";
-import type { BucketCreationRequest, Resource, UpdateAccessTypeRequest } from "./types";
-export type { BucketCreationRequest, Resource, UpdateAccessTypeRequest };
+import type { BucketCreationRequest, BucketPolicyAuth, Resource, ResourceAuth, RoleAuth, UpdateAccessTypeRequest } from "./types";
+export type { BucketCreationRequest, BucketPolicyAuth, Resource, ResourceAuth, RoleAuth, UpdateAccessTypeRequest, };
 /**
  * @class ResourceApi
  * @extends {BaseApi}

package/build/resources/index.js

@@ -37,6 +37,6 @@ export class ResourceApi extends BaseApi {
      * @returns {Promise<Resource>} A promise that resolves to the updated resource.
      */
     async updateAccessType(request) {
-        return await this.post(`${resourceName}/buckets/access`, request);
+        return await this.post(`${resourceName}/update-access`, request);
     }
 }

package/build/resources/types.d.ts

@@ -1,12 +1,19 @@
+export interface BucketPolicyAuth {
+    type: "bucket_policy";
+    account_id: string;
+}
+export interface RoleAuth {
+    type: "role";
+    account_id: string;
+    external_id?: string;
+    /** The ARN of the role to assume to perform bucket management operations. */
+    role?: string;
+}
+export type ResourceAuth = BucketPolicyAuth | RoleAuth;
 export interface Resource {
     id: string;
     company_id: number;
-    auth: {
-        type: "bucket_policy" | "role";
-        account_id: string;
-        external_id?: string;
-        role?: string;
-    };
+    auth: ResourceAuth;
     name: string;
     created_at: string;
     updated_at: string;
@@ -14,7 +21,7 @@ export interface Resource {
 }
 export interface RoleBasedBucketAccess {
     type: "role";
-    external_id: string;
+    external_id?: string;
 }
 export interface PolicyBasedBucketAccess {
     type: "bucket_policy";
@@ -27,5 +34,6 @@ export type BucketAccess = RoleBasedBucketAccess | PolicyBasedBucketAccess;
 export interface BucketCreationRequest {
     account_id: string;
     resource_id: string;
-    access: BucketAccess;
+    /** Defaults server-side to role-based access (with no external id) when omitted. */
+    access?: BucketAccess;
 }

package/build/rosetta-stone/index.d.ts

@@ -1,17 +1,17 @@
 import { BaseApi } from "../base-api";
-import type { Dataset } from "../datasets";
-import type { Mapping } from "../mappings/types";
 import type { RosettaStoneResponse, SampleRecord, SampleRecords } from "./types";
 declare class RosettaStoneApi extends BaseApi {
     /**
-     * Fetches suggested mappings generated from sample records.
+     * Fetches suggested attribute label mappings for a set of sample records.
      *
-     * @param sample
-     * @returns {Promise<Mapping[]>} - A promise that resolves to the created mapping.
+     * Posts the sample to `POST /rosetta-stone/labels/sample` using the
+     * authenticated base client. The backend flattens each record and returns a
+     * scored label suggestion per detected key.
+     *
+     * @param sample - The sample records to derive label suggestions from.
+     * @returns A promise that resolves to the scored label suggestions.
      * @experimental
      */
-    getMappingRecommendationsFromSample(dataset: Partial<Dataset>, sample: SampleRecords, remap_existing_mappings?: boolean): Promise<{
-        response: Mapping[];
-    }>;
+    getMappingRecommendationsFromSample(sample: SampleRecord[]): Promise<RosettaStoneResponse[]>;
 }
 export { RosettaStoneApi, type RosettaStoneResponse, type SampleRecord, type SampleRecords, };

package/build/rosetta-stone/index.js

@@ -1,41 +1,25 @@
 import { BaseApi } from "../base-api";
+/**
+ * The name of the resource to be used in API requests.
+ * @constant
+ * @private
+ * @type {string}
+ */
+const resourceName = "rosetta-stone";
 class RosettaStoneApi extends BaseApi {
     /**
-     * Fetches suggested mappings generated from sample records.
+     * Fetches suggested attribute label mappings for a set of sample records.
      *
-     * @param sample
-     * @returns {Promise<Mapping[]>} - A promise that resolves to the created mapping.
+     * Posts the sample to `POST /rosetta-stone/labels/sample` using the
+     * authenticated base client. The backend flattens each record and returns a
+     * scored label suggestion per detected key.
+     *
+     * @param sample - The sample records to derive label suggestions from.
+     * @returns A promise that resolves to the scored label suggestions.
      * @experimental
      */
-    async getMappingRecommendationsFromSample(dataset, sample, remap_existing_mappings = false) {
-        try {
-            const resp = await fetch("https://rosetta-stone-api.narrative.io/v1/rosetta_stone/suggest_mappings ", {
-                method: "POST",
-                body: JSON.stringify({
-                    dataset,
-                    sample: {
-                        records: sample.sample,
-                    },
-                    remap_existing_mappings,
-                }),
-                headers: {
-                    "Content-Type": "application/json",
-                },
-            });
-            const mappings = (await resp.json());
-            return {
-                response: mappings.response.map((mapping) => {
-                    return {
-                        ...mapping,
-                        dataset_id: dataset.id ?? 0,
-                    };
-                }),
-            };
-        }
-        catch (e) {
-            console.error(e);
-            return { response: [] };
-        }
+    async getMappingRecommendationsFromSample(sample) {
+        return await this.post(`${resourceName}/labels/sample`, { sample });
     }
 }
 export { RosettaStoneApi, };

package/build/subscriptions/types.d.ts

@@ -12,7 +12,7 @@ export interface Subscription {
     output?: SubscriptionOutput;
     cadence?: SubscriptionCadence;
     status: SubscriptionStatus;
-    update_at: string;
+    updated_at: string;
 }
 export interface SubscriptionBudget {
     amount: {
@@ -23,7 +23,7 @@ export interface SubscriptionBudget {
         type: SubscriptionBudgetPeriod;
     };
 }
-export type SubscriptionBudgetPeriod = "calendar_daily" | "calendar_monthly";
+export type SubscriptionBudgetPeriod = "calendar_daily" | "calendar_monthly" | "calendar_weekly";
 export interface SubscriptionDetails {
     type: SubscriptionType;
     data_rules: DataRules;
@@ -40,7 +40,7 @@ export type DataStreamSubscriptionDetails = SubscriptionDetails & {
 };
 export type MarketplaceSubscriptionDetails = SubscriptionDetails & {
     type: "marketplace";
-    company_contraint?: CompanyConstraint;
+    company_constraint?: CompanyConstraint;
     dataset_constraint?: DatasetConstraint;
     pricing: {
         micro_cents_usd: number;

package/build/uploads/index.d.ts

@@ -14,9 +14,12 @@ declare class UploadsApi extends BaseApi {
      */
     getUploadUrl(uploadPath: string): Promise<UploadsResponse>;
     /**
-     * Confirms the completion of an upload process.
+     * Confirms the completion of an upload process by ingesting the uploaded file into a dataset.
      * This method should be called after a file has been uploaded to the provided URL to finalize the upload.
      *
+     * Note: this calls `POST /datasets/{dataset_id}/upload` — there is no `uploads/{id}` confirmation
+     * endpoint; `/uploads/{upload_path}` (see {@link getUploadUrl}) only supports issuing upload URLs.
+     *
      * @async
      * @param {number} datasetId - The unique identifier of the dataset being uploaded.
      * @param {string} uploadPath - The path where the file was uploaded.

package/build/uploads/index.js

@@ -22,16 +22,19 @@ class UploadsApi extends BaseApi {
         return await this.post(`${resourceName}/${uploadPath}`);
     }
     /**
-     * Confirms the completion of an upload process.
+     * Confirms the completion of an upload process by ingesting the uploaded file into a dataset.
      * This method should be called after a file has been uploaded to the provided URL to finalize the upload.
      *
+     * Note: this calls `POST /datasets/{dataset_id}/upload` — there is no `uploads/{id}` confirmation
+     * endpoint; `/uploads/{upload_path}` (see {@link getUploadUrl}) only supports issuing upload URLs.
+     *
      * @async
      * @param {number} datasetId - The unique identifier of the dataset being uploaded.
      * @param {string} uploadPath - The path where the file was uploaded.
      * @returns {Promise<void>} A promise resolving when the upload confirmation is complete.
      */
     async confirmUpload(datasetId, uploadInfo) {
-        await this.put(`${resourceName}/${datasetId}`, {
+        await this.post(`datasets/${datasetId}/upload`, {
             source_file: uploadInfo.path,
         });
     }

package/build/views/index.d.ts

@@ -1,28 +1,29 @@
 import { BaseApi } from "../base-api";
-import type { ApiRecords } from "../types";
-import type { CreateViewRequest, OwnedView, SharedView, UpdateViewRequest, View, ViewOwner } from "./types";
+import type { ApiRecordsV2 } from "../types";
+import type { CreateViewRequest, GetViewsParams, OwnedView, SharedView, UpdateViewRequest, View, ViewOwner } from "./types";
 /**
  * A class for accessing the Views API.
  * @extends BaseApi
  */
 declare class ViewsApi extends BaseApi {
     /**
-     * Gets a list of accessable viees from the API.
+     * Gets a paginated list of accessible views from the API.
      *
-     * @returns {Promise<ApiRecords<View>>} A promise that resolves with the list of views.
+     * @param {GetViewsParams} [params] - Optional pagination, ownership, tag, owner, status, and keyword filters.
+     * @returns {Promise<ApiRecordsV2<View>>} A promise that resolves with the paginated list of views.
      */
-    getViews(): Promise<ApiRecords<View>>;
+    getViews(params?: GetViewsParams): Promise<ApiRecordsV2<View>>;
     /**
      * Gets a single view from the API by its ID.
      *
-     * @param {number} viewId - The ID of the view to retrieve.
+     * @param {string} viewId - The ID (UUID) of the view to retrieve.
      * @returns {Promise<View>} A promise that resolves with the view.
      */
-    getView(viewId: number): Promise<View>;
+    getView(viewId: string): Promise<View>;
     /**
-     * Deletes a single view from the API by its ID.
+     * Deletes (archives) a single view from the API by its ID.
      *
-     * @param {number} viewId - The ID of the view to delete.
+     * @param {string} viewId - The ID (UUID) of the view to delete.
      * @returns {Promise<void>} A promise that resolves when the delete operation is complete.
      */
     deleteView(viewId: string): Promise<void>;
@@ -42,4 +43,4 @@ declare class ViewsApi extends BaseApi {
      */
     updateView(viewId: string, data: UpdateViewRequest): Promise<View>;
 }
-export { type CreateViewRequest, type OwnedView, type SharedView, type UpdateViewRequest, type View, type ViewOwner, ViewsApi, };
+export { type CreateViewRequest, type GetViewsParams, type OwnedView, type SharedView, type UpdateViewRequest, type View, type ViewOwner, ViewsApi, };

package/build/views/index.js

@@ -12,26 +12,59 @@ const resourceName = "v2/views";
  */
 class ViewsApi extends BaseApi {
     /**
-     * Gets a list of accessable viees from the API.
+     * Gets a paginated list of accessible views from the API.
      *
-     * @returns {Promise<ApiRecords<View>>} A promise that resolves with the list of views.
+     * @param {GetViewsParams} [params] - Optional pagination, ownership, tag, owner, status, and keyword filters.
+     * @returns {Promise<ApiRecordsV2<View>>} A promise that resolves with the paginated list of views.
      */
-    async getViews() {
-        return await this.get(resourceName);
+    async getViews(params) {
+        const queryParams = new URLSearchParams();
+        if (params?.page) {
+            queryParams.append("page", params.page.toString());
+        }
+        if (params?.per_page) {
+            queryParams.append("per_page", params.per_page.toString());
+        }
+        if (params?.is_owned !== undefined) {
+            queryParams.append("is_owned", params.is_owned.toString());
+        }
+        if (params?.status) {
+            queryParams.append("status", params.status);
+        }
+        if (params?.q) {
+            queryParams.append("q", params.q);
+        }
+        if (params?.tag) {
+            const tags = Array.isArray(params.tag) ? params.tag : [params.tag];
+            for (const tag of tags) {
+                queryParams.append("tag", tag);
+            }
+        }
+        if (params?.company_id) {
+            const companyIds = Array.isArray(params.company_id)
+                ? params.company_id
+                : [params.company_id];
+            for (const companyId of companyIds) {
+                queryParams.append("company_id", companyId.toString());
+            }
+        }
+        const queryString = queryParams.toString();
+        const url = queryString ? `${resourceName}?${queryString}` : resourceName;
+        return await this.get(url);
     }
     /**
      * Gets a single view from the API by its ID.
      *
-     * @param {number} viewId - The ID of the view to retrieve.
+     * @param {string} viewId - The ID (UUID) of the view to retrieve.
      * @returns {Promise<View>} A promise that resolves with the view.
      */
     async getView(viewId) {
         return await this.get(`${resourceName}/${viewId}`);
     }
     /**
-     * Deletes a single view from the API by its ID.
+     * Deletes (archives) a single view from the API by its ID.
      *
-     * @param {number} viewId - The ID of the view to delete.
+     * @param {string} viewId - The ID (UUID) of the view to delete.
      * @returns {Promise<void>} A promise that resolves when the delete operation is complete.
      */
     async deleteView(viewId) {

package/build/views/types.d.ts

@@ -1,20 +1,26 @@
 import type { NqlQueryMetadata, NqlQueryOwner } from "../queries";
 import type { CollaboratorsConfig } from "../types";
 export interface SharedView {
-    id: number;
+    /** UUID. */
+    id: string;
     name: string;
     owner: NqlQueryOwner;
     nql: string;
+    /** Whether the view is active or archived. */
+    status?: string;
     display_name?: string;
     tags?: string[];
     schema?: unknown;
     is_owned?: boolean;
 }
 export interface OwnedView {
-    id: number;
+    /** UUID. */
+    id: string;
     name: string;
     owner: NqlQueryOwner;
     nql: string;
+    /** Whether the view is active or archived. */
+    status?: string;
     collaborators: CollaboratorsConfig;
     metadata: NqlQueryMetadata;
     display_name?: string;
@@ -35,10 +41,25 @@ export interface CreateViewRequest {
     tags?: string[];
 }
 export interface UpdateViewRequest {
-    name?: string;
-    nql?: string;
     collaborators?: CollaboratorsConfig;
     display_name?: string;
     tags?: string[];
 }
 export type View = OwnedView | SharedView;
+/**
+ * Query parameters accepted by `GET /v2/views`.
+ */
+export interface GetViewsParams {
+    page?: number;
+    per_page?: number;
+    /** `true` returns only owned views; `false` only shared-with-you views. */
+    is_owned?: boolean;
+    /** Filters by tag. OR-d together when multiple are given. */
+    tag?: string | string[];
+    /** Filters by owning company id. OR-d together when multiple are given. */
+    company_id?: number | number[];
+    /** Filters by view status. */
+    status?: string;
+    /** Free-text keyword search. */
+    q?: string;
+}

package/build/whoami/types.d.ts

@@ -1,18 +1,23 @@
 import type { UserRole } from "../authentication";
 export interface User {
     user_id: number;
+    access_token: WhoamiAccessTokenInfo;
     name: string;
     email: string;
     role: UserRole;
     company_access_list: number[];
-    accessible_companies?: CompanyScope[];
+    accessible_companies: CompanyScope[];
     current_company_scope: CompanyScope;
-    permissions: Permission[];
+    permissions: WhoamiPermission[];
     created_at: string;
     created_by: null | string;
-    last_updated_at: string;
+    last_updated_at: string | null;
     last_updated_by: null | string;
 }
+/** Metadata about the bearer token used to make the `/whoami` request. */
+export interface WhoamiAccessTokenInfo {
+    expires_at: string;
+}
 export interface CompanyScope {
     company_id: number;
     slug: null | string;
@@ -24,11 +29,35 @@ export interface CompanyScope {
     data_shop_url: null | string;
     twitter_link: null | string;
     linkedin_link: null | string;
-    image_url: string;
-    status: string;
-    visibility: string;
+    image_url: string | null;
+    status: CompanyScopeStatus;
+    visibility: CompanyScopeVisibility;
 }
-export interface Permission {
-    resource: string;
-    access: string;
+/**
+ * Lifecycle status of a company. The wire literals come from the shared
+ * `CompanyCommonCodecs` (authoritative over the public schema, which lists a
+ * stale `deleted` value).
+ */
+export type CompanyScopeStatus = "active" | "archived" | "pending";
+/**
+ * Discovery visibility of a company. The wire literals come from the shared
+ * `CompanyCommonCodecs` (note the hyphenated `invisible-in-discover`, not the
+ * schema's underscored spelling).
+ */
+export type CompanyScopeVisibility = "invisible" | "invisible-in-discover" | "visible";
+/**
+ * Access levels a permission may grant. Scoped to this module (`Whoami*`) to
+ * avoid colliding with similarly-named types exported by other modules (e.g.
+ * `Resource` from `../resources`) via the package's `export *` barrel.
+ */
+export type WhoamiAccess = "read" | "write" | "admin";
+/**
+ * Resources a permission may apply to. Scoped to this module (`Whoami*`) to
+ * avoid colliding with similarly-named types exported by other modules (e.g.
+ * `Resource` from `../resources`) via the package's `export *` barrel.
+ */
+export type WhoamiResource = "api_info" | "attributes" | "apps" | "app_profiles" | "resources" | "charges" | "datasets" | "data_streams" | "deliveries" | "destinations" | "forecasts" | "installations" | "lists" | "mappings" | "internal_reports" | "subscriptions" | "payment_methods" | "uploads" | "company_info" | "schema_preset";
+export interface WhoamiPermission {
+    resource: WhoamiResource;
+    access: WhoamiAccess[];
 }

package/build/workflows/index.d.ts

@@ -1,7 +1,5 @@
 import { BaseApi } from "../base-api";
-import type { PaginationOptions } from "../types";
-type WorkflowPaginationOptions = PaginationOptions & Record<string, unknown>;
-import type { CreateWorkflowRequest, CreateWorkflowResponse, ListRunsParams, ListRunsResponse, ListWorkflowsResponse, ScheduleWorkflowRequest, ScheduleWorkflowResponse, TriggerWorkflowResponse, WorkflowResponse, WorkflowRun, WorkflowRunStatus, WorkflowStatus } from "./types";
+import type { CreateWorkflowRequest, CreateWorkflowResponse, ListRunsParams, ListRunsResponse, ListWorkflowsParams, ListWorkflowsResponse, ScheduleWorkflowRequest, ScheduleWorkflowResponse, TriggerWorkflowResponse, WorkflowResponse, WorkflowRun, WorkflowRunStatus, WorkflowStatus } from "./types";
 /**
  * @module WorkflowsApi
  * @description This module provides methods for creating, scheduling, triggering, and archiving workflows.
@@ -11,10 +9,11 @@ declare class WorkflowsApi extends BaseApi {
     /**
      * List all active workflows for the authenticated company.
      *
-     * @param {PaginationOptions} [params] - Optional pagination parameters.
+     * @param {ListWorkflowsParams} [params] - Optional pagination parameters, plus
+     * `data_plane_id` to return only the workflows on that data plane.
      * @returns {Promise<ListWorkflowsResponse>} A promise that resolves to a paginated list of workflows.
      */
-    listWorkflows(params?: WorkflowPaginationOptions): Promise<ListWorkflowsResponse>;
+    listWorkflows(params?: ListWorkflowsParams): Promise<ListWorkflowsResponse>;
     /**
      * Create a new workflow from a YAML specification.
      * The specification is parsed and validated before the workflow is persisted.
@@ -58,9 +57,9 @@ declare class WorkflowsApi extends BaseApi {
      * List execution runs for a workflow. Results are ordered by start time descending.
      *
      * @param {string} workflowId - The unique identifier for the workflow.
-     * @param {ListRunsParams} [params] - Optional pagination parameters (pageSize, pageToken).
+     * @param {ListRunsParams} [params] - Optional pagination parameters (per_page, page_token).
      * @returns {Promise<ListRunsResponse>} A promise that resolves to a paginated list of workflow runs.
      */
     listWorkflowRuns(workflowId: string, params?: ListRunsParams): Promise<ListRunsResponse>;
 }
-export { type CreateWorkflowRequest, type CreateWorkflowResponse, type ListRunsParams, type ListRunsResponse, type ListWorkflowsResponse, type ScheduleWorkflowRequest, type ScheduleWorkflowResponse, type TriggerWorkflowResponse, type WorkflowResponse, type WorkflowRun, type WorkflowRunStatus, type WorkflowStatus, WorkflowsApi, };
+export { type CreateWorkflowRequest, type CreateWorkflowResponse, type ListRunsParams, type ListRunsResponse, type ListWorkflowsParams, type ListWorkflowsResponse, type ScheduleWorkflowRequest, type ScheduleWorkflowResponse, type TriggerWorkflowResponse, type WorkflowResponse, type WorkflowRun, type WorkflowRunStatus, type WorkflowStatus, WorkflowsApi, };