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

package/build/data-streams/types.d.ts

@@ -20,7 +20,7 @@ export interface DataStream {
 export interface DataStreamContent {
     description: string;
     icon?: string;
-    sections?: string[];
+    sections?: Record<string, unknown>[];
 }
 export type SalesChannel = "data_streams_market" | "data_shop";
 export interface Offer {
@@ -33,7 +33,7 @@ export interface Offer {
 export interface OfferLicensing {
     period: string;
     license: {
-        id: string;
+        name: string;
     };
 }
 export interface OfferPricing {
@@ -41,10 +41,12 @@ export interface OfferPricing {
     type: "per_record" | "max_price_per_record";
 }
 export interface AuthRules {
-    company_contstraint: CompanyConstraint;
+    company_constraint?: CompanyConstraint;
 }
+export type CompanyConstraintType = "inclusion" | "exclusion";
 export interface CompanyConstraint {
-    type: InclusionType;
+    type: CompanyConstraintType;
+    company_ids: number[];
 }
 export interface DataRules {
     column_sets?: ColumnSet[];
@@ -55,7 +57,7 @@ export interface DataRules {
     ingestion_timestamp_filter?: TimestampFilter;
 }
 export interface ColumnSet {
-    dataset_id: string;
+    dataset_id: number;
     fields: ColumnWithFilterAndExport[];
 }
 export interface AttributeSet {
@@ -71,19 +73,19 @@ export interface Deduplication {
 export interface FrequencyFilter {
     column_references?: ColumnReferences[];
     attribute_references?: AttributeReferences[];
-    minInclusive?: number;
-    maxInclusive?: number;
+    min_inclusive?: number;
+    max_inclusive?: number;
 }
 export interface AttributeReferences {
     attribute_id: number;
-    columnNames: string[];
+    column_names: string[];
 }
 export interface ColumnReferences {
     dataset_id: number;
-    columnNames: string[];
+    column_names: string[];
 }
 export interface DatasetFilter {
-    dataset_id: string;
+    dataset_id: number;
     attribute: AttributeField;
 }
 export interface DatasetFilterEquality extends DatasetFilter {
@@ -91,7 +93,7 @@ export interface DatasetFilterEquality extends DatasetFilter {
     inclusion: InclusionType;
 }
 export interface AttributeField {
-    attribute_id: string;
+    attribute_id: number;
     field: string;
 }
 export interface DatasetFilterSpatial extends DatasetFilter {

package/build/datasets/index.d.ts

@@ -3,8 +3,18 @@ import type { UnknownJob } from "../jobs/types";
 import type { ApiRecords } from "../types";
 import type { DatasetStatisticsConfiguration, StatisticsConfigurationResponse } from "./statistics-types";
 import type { AdvancedStatistics, AdvancedStatisticsMetadata, BasicStatistics, ColumnStatistics, ColumnSummary, Columns, Configuration, CreateDatasetRefreshScheduleRequest, CreateDatasetRequest, Dataset, DatasetInterfaceError, DatasetInterfaceRef, DatasetInterfaceValidation, DatasetStatus, DatasetTableSummary, DatasetTableSummaryAPIResponse, DatasetWriteMode, FilePerSnapshotResponse, Histogram, IngestDatasetFileRequest, JsonSchemaValidationNode, RecalculationInfo, RetentionPolicy, RetentionScheduleConfig, RowClock, RowTTLPolicy, Schema, SchemaArrayItems, SchemaArrayItemsArray, SchemaArrayItemsObject, SchemaArrayItemsPrimitive, SchemaArrayProperty, SchemaFileConfig, SchemaFileConfigType, SchemaObjectProperty, SchemaPrimitiveProperty, SchemaProperties, SchemaPropertiesType, SchemaProperty, SnapshotAgeExpression, SnapshotRange, SnapshotTTLPolicy, TableClock, TableClockKind, TableTTLPolicy, TTLPolicy, TTLPolicyKind, UpdateDatasetRefreshScheduleRequest, UpdateDatasetRequest, UpsertRetentionPoliciesRequest, Value } from "./types";
+interface GetDatasetsParameters extends Record<string, string | number | boolean | string[] | undefined> {
+    /** Page number, starting from 1. */
+    page?: number;
+    per_page?: number;
+    /** Free-text keyword query matched against dataset name. */
+    q?: string;
+    data_plane_id?: string;
+    /** Filter to datasets carrying this tag. Repeat to require every supplied tag (all-of semantics). */
+    tag?: string | string[];
+}
 export type { CronRefresh, DatasetFieldConfig, DatasetFieldNamespace, DatasetStatisticsConfiguration, HistogramOptions, HistogramOverflow, ManualRefresh, NestedNodeConfig, NestedPropertyConfig, NonPrimitiveNodeConfig, OnUpdateRefresh, PrimitiveNodeConfig, RefreshTrigger, RosettaStoneFieldConfig, RosettaStoneFieldNamespace, StatConfig, StatisticsConfigurationResponse, StatName, StatOptions, } from "./statistics-types";
-export type { AdvancedStatistics, AdvancedStatisticsMetadata, BasicStatistics, ColumnStatistics, ColumnSummary, Columns, Configuration, CreateDatasetRefreshScheduleRequest, CreateDatasetRequest, Dataset, DatasetInterfaceError, DatasetInterfaceRef, DatasetInterfaceValidation, DatasetStatus, DatasetTableSummaryAPIResponse, DatasetWriteMode, FilePerSnapshotResponse, Histogram, JsonSchemaValidationNode, RetentionPolicy, RetentionScheduleConfig, RowClock, RowTTLPolicy, Schema, SchemaArrayItems, SchemaArrayItemsArray, SchemaArrayItemsObject, SchemaArrayItemsPrimitive, SchemaArrayProperty, SchemaFileConfig, SchemaFileConfigType, SchemaObjectProperty, SchemaPrimitiveProperty, SchemaProperties, SchemaPropertiesType, SchemaProperty, SnapshotAgeExpression, SnapshotRange, SnapshotTTLPolicy, TableClock, TableClockKind, TableTTLPolicy, TTLPolicy, TTLPolicyKind, UpdateDatasetRefreshScheduleRequest, UpdateDatasetRequest, UpsertRetentionPoliciesRequest, Value, };
+export type { AdvancedStatistics, AdvancedStatisticsMetadata, BasicStatistics, ColumnStatistics, ColumnSummary, Columns, Configuration, CreateDatasetRefreshScheduleRequest, CreateDatasetRequest, Dataset, DatasetInterfaceError, DatasetInterfaceRef, DatasetInterfaceValidation, DatasetStatus, DatasetTableSummaryAPIResponse, DatasetWriteMode, FilePerSnapshotResponse, GetDatasetsParameters, Histogram, JsonSchemaValidationNode, RetentionPolicy, RetentionScheduleConfig, RowClock, RowTTLPolicy, Schema, SchemaArrayItems, SchemaArrayItemsArray, SchemaArrayItemsObject, SchemaArrayItemsPrimitive, SchemaArrayProperty, SchemaFileConfig, SchemaFileConfigType, SchemaObjectProperty, SchemaPrimitiveProperty, SchemaProperties, SchemaPropertiesType, SchemaProperty, SnapshotAgeExpression, SnapshotRange, SnapshotTTLPolicy, TableClock, TableClockKind, TableTTLPolicy, TTLPolicy, TTLPolicyKind, UpdateDatasetRefreshScheduleRequest, UpdateDatasetRequest, UpsertRetentionPoliciesRequest, Value, };
 /**
  * @module DatasetApi
  * @description This module provides methods for fetching datasets.
@@ -19,9 +29,10 @@ export declare class DatasetApi extends BaseApi {
     getDataset(datasetId: number): Promise<Dataset>;
     /**
      * Get a list of all datasets
+     * @param {GetDatasetsParameters} [parameters] - Optional filtering/pagination parameters.
      * @returns {Promise<ApiRecords<Dataset>>} - Promise resolving to an array of datasets
      */
-    getDatasets(): Promise<ApiRecords<Dataset>>;
+    getDatasets(parameters?: GetDatasetsParameters): Promise<ApiRecords<Dataset>>;
     /**
      * Deletes a specific dataset from the system.
      * This method sends a DELETE request to the specified endpoint to remove the dataset.
@@ -74,7 +85,7 @@ export declare class DatasetApi extends BaseApi {
      * Activates a dataset with the specified dataset ID.
      *
      * @param {number} datasetId - The ID of the dataset to activate.
-     * @returns {Promise<Dataset>} A promise that resolves with the activated dataset.
+     * @returns {Promise<void>} A promise that resolves when the dataset has been activated.
      */
     activateDataset(datasetId: number): Promise<void>;
     /**
@@ -134,7 +145,7 @@ export declare class DatasetApi extends BaseApi {
      * @memberof DatasetApi
      * @public
      */
-    getDatasetFileDownloadUrl(datasetId: number, snapshotId: number, fileId: string): Promise<{
+    getDatasetFileDownloadUrl(datasetId: number, snapshotId: string, fileId: string): Promise<{
         download_url: string;
     }>;
     /**

package/build/datasets/index.js

@@ -16,10 +16,12 @@ export class DatasetApi extends BaseApi {
     }
     /**
      * Get a list of all datasets
+     * @param {GetDatasetsParameters} [parameters] - Optional filtering/pagination parameters.
      * @returns {Promise<ApiRecords<Dataset>>} - Promise resolving to an array of datasets
      */
-    async getDatasets() {
-        return await this.get(`${resourceName}`);
+    async getDatasets(parameters) {
+        const queryString = this.constructQueryString(parameters);
+        return await this.get(`${resourceName}${queryString}`);
     }
     /**
      * Deletes a specific dataset from the system.
@@ -102,7 +104,7 @@ export class DatasetApi extends BaseApi {
      * Activates a dataset with the specified dataset ID.
      *
      * @param {number} datasetId - The ID of the dataset to activate.
-     * @returns {Promise<Dataset>} A promise that resolves with the activated dataset.
+     * @returns {Promise<void>} A promise that resolves when the dataset has been activated.
      */
     async activateDataset(datasetId) {
         await this.put(`${resourceName}/${datasetId}/activate`, null);

package/build/datasets/types.d.ts

@@ -4,23 +4,23 @@ export interface Dataset {
     id: number;
     company_id: number;
     created_at: string;
-    description: string;
+    description?: string;
     name: string;
     display_name: string;
     retention_policy: RetentionPolicy;
     schema: Schema;
     status: DatasetStatus;
-    tags?: string[];
+    tags: string[];
     updated_at: string;
     write_mode: DatasetWriteMode;
     last_snapshot_created_at?: string;
     active_dataset_stored_bytes?: number;
-    mappings?: Mapping[];
+    mappings: Mapping[];
     subscription_id?: string;
     stats?: DatasetStats;
     is_narrative_managed: boolean;
     external_id?: string;
-    data_plane?: DataPlane;
+    data_plane: DataPlane;
     materialized_view_config?: {
         nql: string;
         refresh_schedule_config?: {
@@ -55,10 +55,10 @@ export interface DatasetSummaryStatistics {
     est_total_dataset_stored_records: number;
 }
 export interface RecalculationInfo {
-    recalculation_id: string;
+    recalculation_id?: string;
     snapshots: string[];
-    from_snapshot_timestamp: string;
-    until_snapshot_timestamp: string;
+    from_snapshot_timestamp?: string;
+    until_snapshot_timestamp?: string;
 }
 export interface DatasetColumnSummary {
     id: number;
@@ -82,7 +82,6 @@ export interface DatasetTableSummary extends DatasetSummaryStatistics {
     snapshot_added_delete_files: number;
     snapshot_removed_delete_files: number;
     snapshot_removed_bytes: number;
-    column_summary: DatasetColumnSummary[];
 }
 export interface DatasetTableSummaryAPIResponse {
     dataset_id: number;
@@ -220,13 +219,14 @@ interface File {
 }
 interface Snapshot {
     files: File[];
-    snapshot_id: number;
+    snapshot_id: string;
     timestamp: string;
+    is_downloadable: boolean;
 }
 export interface FilePerSnapshotResponse {
     files_per_snapshot: Snapshot[];
     has_next: boolean;
-    next_snapshot: number | null;
+    next_snapshot: string | null;
 }
 export interface ColumnStatistics {
     advanced_statistics_metadata: AdvancedStatisticsMetadata | null;
@@ -296,7 +296,9 @@ export interface UpdateDatasetRequest {
 export interface CreateDatasetRequest {
     name: string;
     schema: Schema;
-    write_mode: DatasetWriteMode;
+    /** Defaults to `"append"` server-side when omitted. */
+    write_mode?: DatasetWriteMode;
+    display_name?: string;
     description?: string;
     tags?: string[];
     derive_metrics_config?: boolean;
@@ -305,6 +307,10 @@ export interface CreateDatasetRequest {
      * falls back to the company's default data plane. Validated server-side.
      */
     data_plane_id?: string;
+    /** Optional external identifier; must be excluded when registering a dataset in an external data plane. */
+    external_id?: string;
+    /** Whether the dataset is managed by Narrative. Optional for backwards compatibility. */
+    is_narrative_managed?: boolean;
 }
 export interface IngestDatasetFileRequest {
     source_file: string;

package/build/encryption-materials/index.d.ts

@@ -1,15 +1,17 @@
 import { BaseApi } from "../base-api";
 import type { ApiRecords } from "../types";
-import type { CreateEncryptionMaterialRequest, DataEncryptionMaterial, UpdateEncryptionMaterialRequest } from "./types";
+import type { CreateEncryptionMaterialRequest, DataEncryptionMaterial, DecryptedDataEncryptionMaterial, UpdateEncryptionMaterialRequest } from "./types";
 export declare class EncryptionMaterialApi extends BaseApi {
     /**
      * Get all accessible encryption materials
      */
     getEncryptionMaterials(): Promise<ApiRecords<DataEncryptionMaterial>>;
     /**
-     * Get decrypted encryption materials
+     * Get decrypted encryption materials. Unlike the other endpoints on this
+     * API, the response carries the raw (base64-encoded) key material rather
+     * than the display/tagging metadata.
      */
-    getDecryptedEncryptionMaterials(): Promise<ApiRecords<DataEncryptionMaterial>>;
+    getDecryptedEncryptionMaterials(): Promise<ApiRecords<DecryptedDataEncryptionMaterial>>;
     /**
      * Get an encryption material by ID
      */

package/build/encryption-materials/index.js

@@ -8,7 +8,9 @@ export class EncryptionMaterialApi extends BaseApi {
         return await this.get(`${resourceName}`);
     }
     /**
-     * Get decrypted encryption materials
+     * Get decrypted encryption materials. Unlike the other endpoints on this
+     * API, the response carries the raw (base64-encoded) key material rather
+     * than the display/tagging metadata.
      */
     async getDecryptedEncryptionMaterials() {
         return await this.get(`${resourceName}/decrypted`);

package/build/encryption-materials/types.d.ts

@@ -3,7 +3,7 @@ export interface BaseDataEncryptionMaterial {
     id: string;
     company_id: number;
     created_at: string;
-    description: string;
+    description: string | null;
     display_name: string;
     tags: string[];
     updated_at: string;
@@ -17,15 +17,27 @@ export interface SharedDataEncryptionMaterial extends BaseDataEncryptionMaterial
     type: "shared";
 }
 export type DataEncryptionMaterial = OwnedDataEncryptionMaterial | SharedDataEncryptionMaterial;
+/**
+ * Shape returned by `GET /encryption-materials/decrypted`. Unlike the other
+ * encryption material responses, this exposes the raw (base64-encoded) key
+ * material and does not carry any of the display/tagging metadata.
+ */
+export interface DecryptedDataEncryptionMaterial {
+    id: string;
+    company_id: number;
+    /** Base64-encoded decrypted encryption key. */
+    key: string;
+    /** Base64-encoded encryption salt. */
+    salt: string;
+}
 export interface CreateEncryptionMaterialRequest {
     display_name: string;
     description?: string;
-    tags: string[];
-    status: EncryptionMaterialStatus;
+    tags?: string[];
 }
 export interface UpdateEncryptionMaterialRequest {
-    display_name?: string;
+    display_name: string;
     description?: string;
+    /** If provided, must contain at least one tag. */
     tags?: string[];
-    status?: EncryptionMaterialStatus;
 }

package/build/forecast/types.d.ts

@@ -4,14 +4,16 @@ export interface CostForecastRequest {
     details: ForecastDetails;
 }
 export interface ForecastRequest extends CostForecastRequest {
+    /** Additional dimensions to compute alongside the forecast. */
+    dimensions?: ForecastDimensions;
     fingerprint?: string;
     skip_cache?: boolean;
+    /** When true, schedules an unsampled forecast run in addition to the sampled one. */
+    schedule_unsampled_forecast?: boolean;
 }
-export type ForecastType = "marketplace" | "data_stream";
-export interface ForecastDetails {
-    type: ForecastType;
-}
-export interface MarketplaceForecastDetails extends ForecastDetails {
+export type ForecastType = "marketplace" | "data_stream" | "data_stream_creation";
+export type ForecastDetails = DataStreamPurchaseDetails | DataStreamCreationDetails | MarketplaceForecastDetails;
+export interface MarketplaceForecastDetails {
     type: "marketplace";
     company_constraint?: CompanyConstraint;
     dataset_constraint?: DatasetConstraint;
@@ -22,7 +24,12 @@ export interface DataStreamPurchaseDetails {
     type: "data_stream";
     data_stream_id: string;
     offer_id: string;
-    data_shop_id?: number;
+    data_shop_id?: string;
+}
+/** Details for forecasting the creation of a new data stream directly from a set of data rules. */
+export interface DataStreamCreationDetails {
+    type: "data_stream_creation";
+    data_rules: DataRules;
 }
 export type CompanyConstraintType = "inclusion" | "exclusion";
 export interface CompanyConstraint {
@@ -32,27 +39,28 @@ export interface CompanyConstraint {
 export type DatasetConstraintType = "inclusion" | "exclusion" | "all";
 export interface DatasetConstraint {
     type: DatasetConstraintType;
-    dataset_ids: number[];
+    /** Required when `type` is `inclusion` or `exclusion`; unused for `all`. */
+    dataset_ids?: number[];
 }
 export interface ForecastPricing {
     micro_cents_usd: number;
 }
-export interface ForecastGenericResponse {
+export interface ForecastGenericResponse<TInput = ForecastInput> {
     id: string;
     company_id: number;
     completed_at?: Date;
     created_at: Date;
     failures: JobFailure[];
     idempotency_key: string;
-    input: ForecastInput;
+    input: TInput;
     request_source: RequestSource;
     state: JobState;
     updated_at: Date;
 }
-export interface ForecastResponse extends ForecastGenericResponse {
-    result?: ForecastResult | ForecastResultFailure;
+export interface ForecastResponse extends ForecastGenericResponse<ForecastInput> {
+    result?: ForecastResult | ForecastOverBudgetResult | ForecastResultFailure;
 }
-export interface CostForecastResponse extends ForecastGenericResponse {
+export interface CostForecastResponse extends ForecastGenericResponse<CostForecastInput> {
     result?: CostForecastResult | ForecastResultFailure;
 }
 export interface CostForecastInput {
@@ -64,9 +72,9 @@ export interface ForecastInput {
     fingerprint?: string;
 }
 export interface RequestSource {
-    company_id: number;
     type: string;
-    user_id: number;
+    company_id?: number;
+    user_id?: number;
 }
 export interface ForecastDimensions {
     distinct_counts: string[];
@@ -74,11 +82,17 @@ export interface ForecastDimensions {
 }
 export type JobState = "pending" | "scheduled" | "running" | "completed" | "pending_cancellation" | "cancelled" | "failed";
 export interface ForecastResult {
+    type: "success";
     cost: number;
     datasets: DatasetForecastResponse[];
     rows: number;
     scan_cost: ScanCostEstimate;
 }
+/** Returned instead of {@link ForecastResult} when the forecast exceeds the subscription's budget. */
+export interface ForecastOverBudgetResult {
+    type: "over_budget";
+    cost: ScanCostEstimate;
+}
 export interface CostForecastResult {
     cost: ScanCostEstimate;
 }
@@ -100,12 +114,22 @@ export interface ScanCostEstimate {
     sources: DataSourceCost[];
 }
 export interface DataSourceCost {
-    source: string | number;
+    source: DataSource;
     rows: number;
     size: number;
 }
+export type DataSource = DatasetSource | TableSource;
+export interface DatasetSource {
+    type: "dataset";
+    dataset_id: number;
+}
+export interface TableSource {
+    type: "table";
+    name: string;
+}
 export interface JobFailure {
-    message: string;
-    timestamp: Date;
-    value: string;
+    message?: string;
+    timestamp?: Date;
+    /** Free-form diagnostic information, e.g. an Apache Spark stacktrace. */
+    value?: Record<string, unknown>;
 }

package/build/health/index.d.ts

@@ -8,6 +8,11 @@ export declare class HealthCheckApi extends BaseApi {
     /**
      * Gets the result of a health check from the API.
      *
+     * The backend reports success/failure via the HTTP status code (200 healthy, 500 unhealthy) as
+     * well as the body's `success` field, so an unhealthy response may surface as a rejected promise
+     * rather than a resolved one with `success: false`, depending on how the underlying HTTP client
+     * handles non-2xx responses.
+     *
      * @returns {Promise<HealthCheckResult>} A promise that resolves with the result of the health check.
      */
     getHealthCheck(): Promise<HealthCheckResult>;

package/build/health/index.js

@@ -14,6 +14,11 @@ export class HealthCheckApi extends BaseApi {
     /**
      * Gets the result of a health check from the API.
      *
+     * The backend reports success/failure via the HTTP status code (200 healthy, 500 unhealthy) as
+     * well as the body's `success` field, so an unhealthy response may surface as a rejected promise
+     * rather than a resolved one with `success: false`, depending on how the underlying HTTP client
+     * handles non-2xx responses.
+     *
      * @returns {Promise<HealthCheckResult>} A promise that resolves with the result of the health check.
      */
     async getHealthCheck() {

package/build/health/types.d.ts

@@ -1,6 +1,12 @@
 export interface HealthCheckResult {
     success: boolean;
-    checks: CheckResult[];
+    /**
+     * Per-dependency check detail. The backend only includes this for callers that present a valid
+     * `X-Narrative-Health-Check-Secret` header (an internal, stage-specific secret) — this SDK does
+     * not send that header, so in normal use the response is summary-only (`checks` absent) and only
+     * `success` is populated.
+     */
+    checks?: CheckResult[];
 }
 export interface CheckResult {
     name: string;
@@ -8,4 +14,4 @@ export interface CheckResult {
     success: boolean;
     error_message?: string | null;
 }
-export type HealthCheckResultType = "postgresql" | "s3";
+export type HealthCheckResultType = "postgresql" | "s3" | "stytch-api" | "product-skus";

package/build/installations/index.d.ts

@@ -3,6 +3,12 @@ import type { ApiRecords, ApiRecordsV2 } from "../types";
 import type { AppCategory, CreateInstallationRequest, Installation, InstallationAccessToken, InstallationInfo, Profile } from "./types";
 export interface ListInstallationsOptions {
     appCategory?: AppCategory | AppCategory[];
+    /**
+     * Narrow the results to a single company. Only meaningful with an app
+     * client-credentials token; with a company-scoped token the value must
+     * match the authenticated company.
+     */
+    companyId?: number;
     page?: number;
     perPage?: number;
 }

package/build/installations/index.js

@@ -10,9 +10,10 @@ class InstallationsApi extends BaseApi {
      * List installations for the authenticated company.
      */
     async getInstallations(options = {}) {
-        const { appCategory, page, perPage } = options;
+        const { appCategory, companyId, page, perPage } = options;
         return await this.get(resourceName, {
             app_category: appCategory,
+            company_id: companyId,
             page,
             per_page: perPage,
         });

package/build/installations/types.d.ts

@@ -23,8 +23,14 @@ export type ProfileStatus = "enabled" | "disabled" | "archived";
 export interface Profile {
     id: string;
     name: string;
-    description: string;
+    description: string | null;
     status: ProfileStatus;
+    /** The unique identifier of the app. */
+    app_id: string | null;
+    /** The name of the app. */
+    app_name: string | null;
+    /** Tags associated with the profile. */
+    tags: string[];
 }
 export interface InstallationAccessToken {
     access_token: string;

package/build/jobs/index.d.ts

@@ -4,12 +4,14 @@ import type { CalculateAffectedRowsInput, CalculateAffectedRowsJob, CollectAcces
 import { isKnownJob, KNOWN_JOB_TYPES } from "./types";
 type JobStateFilter = "cancelled" | "completed" | "failed" | "pending" | "pending_cancellation" | "running" | "scheduled";
 interface GetJobsParameters extends Record<string, string | number | boolean | string[] | undefined> {
+    data_plane_id?: string;
     dataset_id?: number;
     per_page?: number;
     offset?: number;
     order_by?: "created_at_asc" | "created_at_desc" | "updated_at_asc" | "updated_at_desc";
     state?: JobStateFilter | JobStateFilter[];
     type?: string | string[];
+    tag?: string | string[];
 }
 /**
  * @module JobsApi
@@ -29,9 +31,11 @@ declare class JobsApi extends BaseApi {
      */
     getJob(jobId: string): Promise<Job>;
     /**
-     * Cancel a job by id
-     * @returns {Promise<void>} - Promise resolving with void.
+     * Requests cancellation of a job by id, moving a `pending`/`running` job to
+     * `pending_cancellation` so the data plane can stop the work. Use the `jobs/{id}/cancel`
+     * endpoint (not yet exposed by this SDK) to finalize cancellation afterwards.
+     * @returns {Promise<Job>} - Promise resolving with the job's state after the request.
      */
-    cancelJob(jobId: string): Promise<void>;
+    cancelJob(jobId: string): Promise<Job>;
 }
 export { type CalculateAffectedRowsInput, type CalculateAffectedRowsJob, type CollectAccessRulesBillingDataInput, type CollectAccessRulesBillingDataJob, type CollectAccessRulesBillingDataResult, type ColumnDetails, type ColumnStatDataType, type CostsInput, type CostsJob, type CreateTableInput, type DatasetsCalculateColumnStatsJob, type DatasetsCreateTableJob, type DatasetsDeleteTableJob, type DatasetsDeliverDataJob, type DatasetsEnforceRowTtlRetentionPolicyJob, type DatasetsEnforceTableTtlRetentionPolicyJob, type DatasetsExecuteDmlJob, type DatasetsExecuteSelectJob, type DatasetsSampleJob, type DatasetsSuggestMappingsJob, type DatasetsTruncateTableJob, type DeleteInput, type DeliverInput, type EnabledColumnStatFlags, type EnforceRowTtlRetentionPolicyInput, type EnforceTableTtlRetentionPolicyInput, type ExecuteDmlInput, type ExecuteDmlResult, type ExecuteSelectInput, type ExecuteSelectResult, type ExplainInput, type ExplainJob, type ExplainOutput, type ForecastInput, type ForecastInternalJob, type ForecastJob, type GetJobsParameters, type HealthCheckJob, isKnownJob, type Job, type JobExecutionCluster, type JobRequestSource, type JobRequestSourceApiUser, type JobRequestSourceProcess, type JobStateFilter, JobsApi, type JobType, KNOWN_JOB_TYPES, type KnownJob, type MaterializedViewInput, type MaterializedViewJob, type MaterializedViewOutput, type MaterializedViewRowStats, type ModelInferenceRunInput, type ModelInferenceRunJob, type ModelInferenceRunJobResult, type ModelsDeliverModelInput, type ModelsDeliverModelJob, type ModelsTrainClassifierJob, type ModelTrainingRunInput, type ModelTrainingRunJob, type RefreshMaterializedViewResult, type SampleInput, type StatsInput, type StatsInputV2, type SuggestMappingsInput, type SuggestMappingsResult, type TruncateTableInput, };

package/build/jobs/index.js

@@ -24,11 +24,13 @@ class JobsApi extends BaseApi {
         return await this.get(`${resourceName}/${jobId}`);
     }
     /**
-     * Cancel a job by id
-     * @returns {Promise<void>} - Promise resolving with void.
+     * Requests cancellation of a job by id, moving a `pending`/`running` job to
+     * `pending_cancellation` so the data plane can stop the work. Use the `jobs/{id}/cancel`
+     * endpoint (not yet exposed by this SDK) to finalize cancellation afterwards.
+     * @returns {Promise<Job>} - Promise resolving with the job's state after the request.
      */
     async cancelJob(jobId) {
-        await this.post(`${resourceName}/${jobId}/request-cancellation`);
+        return await this.post(`${resourceName}/${jobId}/request-cancellation`);
     }
 }
 export { isKnownJob, JobsApi, KNOWN_JOB_TYPES, };

package/build/jobs/types.d.ts

@@ -265,23 +265,23 @@ export interface DatasetsSuggestMappingsJob extends BaseJob {
 }
 export type ColumnStatDataType = "boolean" | "double" | "long" | "string" | "timestamp_tz" | "array" | "object";
 export interface EnabledColumnStatFlags {
-    nan_value_count?: boolean;
-    null_value_count?: boolean;
-    value_count?: boolean;
-    lower_bound?: boolean;
-    upper_bound?: boolean;
-    column_stored_bytes?: boolean;
-    approx_count_distinct?: boolean;
-    count_distinct?: boolean;
-    histogram?: boolean;
-    mean?: boolean;
-    standard_deviation?: boolean;
-    completeness?: boolean;
-    observed_types?: boolean;
+    nan_value_count: boolean;
+    null_value_count: boolean;
+    value_count: boolean;
+    lower_bound: boolean;
+    upper_bound: boolean;
+    column_stored_bytes: boolean;
+    approx_count_distinct: boolean;
+    count_distinct: boolean;
+    histogram: boolean;
+    mean: boolean;
+    standard_deviation: boolean;
+    completeness: boolean;
+    observed_types: boolean;
 }
 export interface ColumnDetails {
     data_type: ColumnStatDataType;
-    enabled_column_stats?: EnabledColumnStatFlags;
+    enabled_column_stats: EnabledColumnStatFlags;
 }
 export interface StatsInput {
     dataset_id: number;