@dereekb/zoho 13.38.0 → 13.40.0

package/src/lib/analytics/analytics.api.import.d.ts

@@ -0,0 +1,252 @@
+import { type Maybe } from '@dereekb/util';
+import { type ZohoAnalyticsJobId, type ZohoAnalyticsResponse, type ZohoAnalyticsRow, type ZohoAnalyticsViewId, type ZohoAnalyticsWorkspaceId } from './analytics';
+import { type ZohoAnalyticsContext } from './analytics.config';
+import { type ZohoAnalyticsImportConfig, type ZohoAnalyticsImportFileType, type ZohoAnalyticsImportJobConfig, type ZohoAnalyticsImportJobNewTableConfig, type ZohoAnalyticsImportNewTableConfig, type ZohoAnalyticsImportResult } from './analytics.import';
+import { type ZohoAnalyticsJobStatus, type PollZohoAnalyticsJobConfig } from './analytics.job';
+/**
+ * The data to import, given either as a file, as raw text, or as rows to serialize as JSON.
+ *
+ * Exactly one of these must be provided: Zoho Analytics accepts a `FILE` or a `DATA` field, never
+ * both.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/import-data/existing-table.html
+ */
+export interface ZohoAnalyticsImportDataInput {
+    /**
+     * The file to import. Capped at 100MB by Zoho Analytics.
+     */
+    readonly file?: Maybe<File>;
+    /**
+     * Raw CSV or JSON text to import.
+     */
+    readonly data?: Maybe<string>;
+    /**
+     * Rows to import, serialized to JSON automatically.
+     *
+     * A convenience over `data` for the common case of pushing records out of application code. When
+     * used, the import config's `fileType` defaults to `'json'`.
+     */
+    readonly rows?: Maybe<ZohoAnalyticsRow[]>;
+}
+/**
+ * Options controlling how {@link zohoAnalyticsImportFormData} encodes the data.
+ */
+export interface ZohoAnalyticsImportFormDataOptions {
+    /**
+     * Sends `data`/`rows` as a `FILE` part rather than a `DATA` field.
+     *
+     * Required by the Bulk (async job) endpoints, which reject a `DATA` field with
+     * "The imported file is empty" — verified against the live API. The synchronous endpoints accept
+     * `DATA`, so this defaults to false.
+     */
+    readonly asFile?: Maybe<boolean>;
+    /**
+     * File type, used only to name the generated file part.
+     */
+    readonly fileType?: Maybe<ZohoAnalyticsImportFileType>;
+}
+/**
+ * Builds the multipart body carrying the data of an import.
+ *
+ * @param input - The file, raw text, or rows to import.
+ * @param options - How to encode the data; see {@link ZohoAnalyticsImportFormDataOptions}.
+ * @returns The multipart form body to send.
+ * @throws {Error} When none of `file`, `data`, or `rows` is provided.
+ */
+export declare function zohoAnalyticsImportFormData(input: ZohoAnalyticsImportDataInput, options?: Maybe<ZohoAnalyticsImportFormDataOptions>): FormData;
+/**
+ * Input for importing data into an existing table.
+ */
+export interface ZohoAnalyticsImportDataInTableInput extends ZohoAnalyticsImportDataInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly viewId: ZohoAnalyticsViewId;
+    readonly config: ZohoAnalyticsImportConfig;
+}
+/**
+ * Response for a synchronous import.
+ */
+export type ZohoAnalyticsImportDataResponse = ZohoAnalyticsResponse<ZohoAnalyticsImportResult>;
+/**
+ * Imports data into an existing table and waits for the result.
+ */
+export type ZohoAnalyticsImportDataInTableFunction = (input: ZohoAnalyticsImportDataInTableInput) => Promise<ZohoAnalyticsImportDataResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsImportDataInTableFunction} bound to the given context.
+ *
+ * Imports synchronously, returning once Zoho has processed the data. Use
+ * {@link zohoAnalyticsCreateImportJobInTable} instead for large payloads, since a synchronous
+ * import must finish inside the request timeout.
+ *
+ * What a bad row does depends on `config.onError`. Under `skiprow` or `setcolumnempty` the import
+ * resolves and describes the loss in `data.importSummary` and `data.importErrors`, so a resolved
+ * import does not mean every row landed. Under `abort` it throws error 7232 instead and nothing is
+ * written, not even the valid rows of the same request. Verified against the live API.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that imports data into an existing table.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/import-data/existing-table.html
+ *
+ * @example
+ * ```ts
+ * const importData = zohoAnalyticsImportDataInTable(context);
+ * const { data } = await importData({
+ *   workspaceId,
+ *   viewId,
+ *   rows: [{ Region: 'East', Sales: 100 }],
+ *   config: { importType: 'truncateadd' }
+ * });
+ * ```
+ */
+export declare function zohoAnalyticsImportDataInTable(context: ZohoAnalyticsContext): ZohoAnalyticsImportDataInTableFunction;
+/**
+ * Input for importing data into a newly created table.
+ */
+export interface ZohoAnalyticsImportDataInNewTableInput extends ZohoAnalyticsImportDataInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly config: ZohoAnalyticsImportNewTableConfig;
+}
+/**
+ * Creates a table from the imported data and waits for the result.
+ */
+export type ZohoAnalyticsImportDataInNewTableFunction = (input: ZohoAnalyticsImportDataInNewTableInput) => Promise<ZohoAnalyticsImportDataResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsImportDataInNewTableFunction} bound to the given context.
+ *
+ * The new table's id comes back on the result as `viewId`, so it does not have to be found by
+ * listing the workspace afterwards. Drop the table again with `zohoAnalyticsDeleteView()`, which is
+ * the only way to remove one through the API.
+ *
+ * A name already taken in the workspace is rejected rather than reused, so a caller that reruns this
+ * has to delete the previous table first.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that creates a table in a workspace and imports data into it.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/import-data/new-table.html
+ */
+export declare function zohoAnalyticsImportDataInNewTable(context: ZohoAnalyticsContext): ZohoAnalyticsImportDataInNewTableFunction;
+/**
+ * Payload returned when an asynchronous job is created.
+ */
+export interface ZohoAnalyticsJobCreationResult {
+    readonly jobId: ZohoAnalyticsJobId;
+}
+/**
+ * Response returned when an asynchronous import job is created.
+ */
+export type ZohoAnalyticsCreateImportJobResponse = ZohoAnalyticsResponse<ZohoAnalyticsJobCreationResult>;
+/**
+ * Input for queueing an asynchronous import into an existing table.
+ */
+export interface ZohoAnalyticsCreateImportJobInTableInput extends ZohoAnalyticsImportDataInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly viewId: ZohoAnalyticsViewId;
+    readonly config: ZohoAnalyticsImportJobConfig;
+}
+/**
+ * Queues an asynchronous import into an existing table.
+ */
+export type ZohoAnalyticsCreateImportJobInTableFunction = (input: ZohoAnalyticsCreateImportJobInTableInput) => Promise<ZohoAnalyticsCreateImportJobResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsCreateImportJobInTableFunction} bound to the given context.
+ *
+ * Returns as soon as the job is queued. Poll it with {@link zohoAnalyticsGetImportJob}, or use
+ * {@link zohoAnalyticsImportDataInTableAndAwaitJob} to queue and wait in one call.
+ *
+ * Zoho Analytics allows at most 5 concurrent import jobs per organization and caps each payload at
+ * 100MB.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that queues an asynchronous import.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/import-data-async/create-import-job/existing-table.html
+ */
+export declare function zohoAnalyticsCreateImportJobInTable(context: ZohoAnalyticsContext): ZohoAnalyticsCreateImportJobInTableFunction;
+/**
+ * Input for queueing an asynchronous import that creates a new table.
+ */
+export interface ZohoAnalyticsCreateImportJobInNewTableInput extends ZohoAnalyticsImportDataInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly config: ZohoAnalyticsImportJobNewTableConfig;
+}
+/**
+ * Queues an asynchronous import that creates a new table.
+ */
+export type ZohoAnalyticsCreateImportJobInNewTableFunction = (input: ZohoAnalyticsCreateImportJobInNewTableInput) => Promise<ZohoAnalyticsCreateImportJobResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsCreateImportJobInNewTableFunction} bound to the given context.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that queues an asynchronous import into a new table.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/import-data-async/create-import-job/new-table.html
+ */
+export declare function zohoAnalyticsCreateImportJobInNewTable(context: ZohoAnalyticsContext): ZohoAnalyticsCreateImportJobInNewTableFunction;
+/**
+ * Status of an asynchronous import job.
+ */
+export interface ZohoAnalyticsImportJobStatus extends ZohoAnalyticsJobStatus {
+    /**
+     * Present once the job has completed.
+     */
+    readonly jobInfo?: ZohoAnalyticsImportResult;
+}
+/**
+ * Response for `GET /bulk/workspaces/{workspaceId}/importjobs/{jobId}`.
+ */
+export type ZohoAnalyticsGetImportJobResponse = ZohoAnalyticsResponse<ZohoAnalyticsImportJobStatus>;
+/**
+ * Input for retrieving an import job's status.
+ */
+export interface ZohoAnalyticsGetImportJobInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly jobId: ZohoAnalyticsJobId;
+}
+/**
+ * Retrieves the status of an asynchronous import job.
+ */
+export type ZohoAnalyticsGetImportJobFunction = (input: ZohoAnalyticsGetImportJobInput) => Promise<ZohoAnalyticsGetImportJobResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsGetImportJobFunction} bound to the given context.
+ *
+ * Checking job status costs zero API units, so it can be polled freely within the request
+ * frequency limit.
+ *
+ * A job id that does not exist is a thrown 404 (error 8137), not a resolved status carrying
+ * `ZOHO_ANALYTICS_JOB_CODE_NOT_FOUND` — so a mistyped id rejects rather than reporting itself.
+ * Verified against the live API.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that retrieves an import job's status.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/import-data-async/get-import-job.html
+ */
+export declare function zohoAnalyticsGetImportJob(context: ZohoAnalyticsContext): ZohoAnalyticsGetImportJobFunction;
+/**
+ * Input for queueing an asynchronous import and waiting for it to finish.
+ */
+export interface ZohoAnalyticsImportDataInTableAndAwaitJobInput extends ZohoAnalyticsCreateImportJobInTableInput {
+    /**
+     * Overrides for how the job is polled.
+     */
+    readonly poll?: Omit<PollZohoAnalyticsJobConfig<ZohoAnalyticsGetImportJobResponse>, 'loadJob' | 'readJobCode'>;
+}
+/**
+ * Queues an asynchronous import into an existing table and resolves once it reaches a terminal
+ * state.
+ */
+export type ZohoAnalyticsImportDataInTableAndAwaitJobFunction = (input: ZohoAnalyticsImportDataInTableAndAwaitJobInput) => Promise<ZohoAnalyticsGetImportJobResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsImportDataInTableAndAwaitJobFunction} bound to the given context.
+ *
+ * Queues the import, then polls until the job completes, fails, or the poll budget is exhausted.
+ * The returned job is the last one observed — check it with `isZohoAnalyticsJobComplete()` and
+ * `isZohoAnalyticsJobError()` rather than assuming success.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that imports asynchronously and waits for the job.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/import-data-async/create-import-job/existing-table.html
+ */
+export declare function zohoAnalyticsImportDataInTableAndAwaitJob(context: ZohoAnalyticsContext): ZohoAnalyticsImportDataInTableAndAwaitJobFunction;

package/src/lib/analytics/analytics.api.modeling.d.ts

@@ -0,0 +1,106 @@
+import { type Maybe } from '@dereekb/util';
+import { type ZohoAnalyticsResponse, type ZohoAnalyticsViewId, type ZohoAnalyticsWorkspaceId } from './analytics';
+import { type ZohoAnalyticsContext } from './analytics.config';
+/**
+ * Response returned by a Modeling API delete.
+ *
+ * Zoho answers a successful delete with `204 No Content`, so there is no envelope to read and the
+ * client resolves `null` rather than a {@link ZohoAnalyticsResponse}. The type stays a `Maybe` of the
+ * envelope rather than `void` so a caller is not lied to if Zoho ever starts returning one, and so
+ * the failure envelope Analytics sometimes returns with a 200 still flows through the interceptor.
+ *
+ * A resolved delete is therefore the whole result: there is no count, no id, and nothing to inspect.
+ * Confirm a delete landed by listing the views again, not by reading this.
+ */
+export type ZohoAnalyticsModelingDeleteResponse = Maybe<ZohoAnalyticsResponse<unknown>>;
+/**
+ * Options for deleting a view.
+ *
+ * The one option widens the blast radius, so it follows the same rule as
+ * `ZohoAnalyticsDeleteRowsConfig`'s `deleteAllRows`: it is never inferred. Left unset, a table that
+ * other views are built on is refused rather than silently taking them with it.
+ */
+export interface ZohoAnalyticsDeleteViewConfig {
+    /**
+     * Also deletes every view derived from this one — the reports, dashboards and query tables built
+     * on the table being deleted.
+     *
+     * Without it a table carrying dependents is rejected instead of deleted.
+     */
+    readonly deleteDependentViews?: boolean;
+}
+/**
+ * Input for deleting a view.
+ */
+export interface ZohoAnalyticsDeleteViewInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly viewId: ZohoAnalyticsViewId;
+    readonly config?: Maybe<ZohoAnalyticsDeleteViewConfig>;
+}
+/**
+ * Response for `DELETE /workspaces/{workspaceId}/views/{viewId}`.
+ */
+export type ZohoAnalyticsDeleteViewResponse = ZohoAnalyticsModelingDeleteResponse;
+/**
+ * Deletes a view — a table, query table, report or dashboard.
+ */
+export type ZohoAnalyticsDeleteViewFunction = (input: ZohoAnalyticsDeleteViewInput) => Promise<ZohoAnalyticsDeleteViewResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsDeleteViewFunction} bound to the given context.
+ *
+ * This is the inverse of `zohoAnalyticsImportDataInNewTable()`, and the only way to remove a table
+ * the client created — without it a table can only be dropped by hand in the Analytics UI.
+ *
+ * **The deletion is irreversible.** Zoho has no undo and no recycle bin for a deleted view, so the
+ * only recovery is recreating the table and re-importing its data. To empty a table while keeping
+ * it, use `zohoAnalyticsDeleteRows()` or a `truncateadd` import instead.
+ *
+ * Unlike the other Modeling writes, the `CONFIG` goes in the QUERY STRING rather than a form body —
+ * Zoho documents this endpoint under "query parameters", and the live API agrees.
+ *
+ * Requires the `ZohoAnalytics.modeling.delete` OAuth scope, which the broader
+ * `ZohoAnalytics.modeling.create` grant does NOT imply: a token without it fails every delete with
+ * error 8540 rather than with a permission error naming the view.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that deletes a view.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/modeling-api/delete-view.html
+ */
+export declare function zohoAnalyticsDeleteView(context: ZohoAnalyticsContext): ZohoAnalyticsDeleteViewFunction;
+/**
+ * Input for deleting a workspace.
+ */
+export interface ZohoAnalyticsDeleteWorkspaceInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+}
+/**
+ * Response for `DELETE /workspaces/{workspaceId}`.
+ */
+export type ZohoAnalyticsDeleteWorkspaceResponse = ZohoAnalyticsModelingDeleteResponse;
+/**
+ * Deletes a workspace and everything in it.
+ */
+export type ZohoAnalyticsDeleteWorkspaceFunction = (input: ZohoAnalyticsDeleteWorkspaceInput) => Promise<ZohoAnalyticsDeleteWorkspaceResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsDeleteWorkspaceFunction} bound to the given context.
+ *
+ * **This is the most destructive call in the client, and it is irreversible.** It removes the
+ * workspace along with every table, report and dashboard inside it. The endpoint takes no `CONFIG`
+ * at all, so there is no cascade flag to withhold — passing the id IS the whole request.
+ *
+ * That is also why this carries no `deleteAllRows`-style confirmation flag: unlike a row delete,
+ * nothing here can be under-specified into a wider blast radius, so a required literal would be
+ * ceremony rather than a guard. The real hazard is that the input is shaped exactly like
+ * `zohoAnalyticsGetWorkspaceDetails()`'s, so a mistyped call site reads as a lookup — guard it at
+ * the boundary that has no code review, which is why the `zoho-cli` command demands the workspace
+ * id a second time via `--confirm`.
+ *
+ * Requires the `ZohoAnalytics.modeling.delete` OAuth scope; see {@link zohoAnalyticsDeleteView}.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that deletes a workspace.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/modeling-api/delete-workspace.html
+ */
+export declare function zohoAnalyticsDeleteWorkspace(context: ZohoAnalyticsContext): ZohoAnalyticsDeleteWorkspaceFunction;

package/src/lib/analytics/analytics.api.orgs.d.ts

@@ -0,0 +1,36 @@
+import { type ZohoAnalyticsResponse } from './analytics';
+import { type ZohoAnalyticsContext } from './analytics.config';
+import { type ZohoAnalyticsOrg } from './analytics.org';
+/**
+ * Payload of a {@link ZohoAnalyticsGetOrgsResponse}.
+ */
+export interface ZohoAnalyticsGetOrgsResponseData {
+    readonly orgs: ZohoAnalyticsOrg[];
+}
+/**
+ * Response for `GET /orgs`.
+ */
+export type ZohoAnalyticsGetOrgsResponse = ZohoAnalyticsResponse<ZohoAnalyticsGetOrgsResponseData>;
+/**
+ * Lists the organizations the authenticated user belongs to.
+ */
+export type ZohoAnalyticsGetOrgsFunction = () => Promise<ZohoAnalyticsGetOrgsResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsGetOrgsFunction} bound to the given context.
+ *
+ * This is the only Zoho Analytics endpoint that does not require the `ZANALYTICS-ORGID` header,
+ * which makes it the bootstrap call used to discover the org id that every other endpoint needs.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that lists the organizations available to the authenticated user.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/metadata-api/get-org.html
+ *
+ * @example
+ * ```ts
+ * const getOrgs = zohoAnalyticsGetOrgs(context);
+ * const { data } = await getOrgs();
+ * const orgId = data.orgs.find((x) => x.isDefault)?.orgId;
+ * ```
+ */
+export declare function zohoAnalyticsGetOrgs(context: ZohoAnalyticsContext): ZohoAnalyticsGetOrgsFunction;

package/src/lib/analytics/analytics.api.rows.d.ts

@@ -0,0 +1,214 @@
+import { type ZohoAnalyticsCriteria, type ZohoAnalyticsName, type ZohoAnalyticsResponse, type ZohoAnalyticsRow, type ZohoAnalyticsViewId, type ZohoAnalyticsWorkspaceId } from './analytics';
+import { type ZohoAnalyticsContext } from './analytics.config';
+/**
+ * Date-format options shared by the row write operations.
+ */
+export interface ZohoAnalyticsRowDateFormatOptions {
+    /**
+     * Format of any date value whose format cannot be auto-detected, e.g. `'dd-MMM-YYYY'`.
+     */
+    readonly dateFormat?: string;
+    /**
+     * Per-column date formats, keyed by column name.
+     */
+    readonly columnDateFormat?: Record<ZohoAnalyticsName, string>;
+}
+/**
+ * Columns rejected by a row write, keyed by column name.
+ */
+export type ZohoAnalyticsInvalidColumns = Record<ZohoAnalyticsName, string>;
+/**
+ * Options for adding a single row.
+ */
+export interface ZohoAnalyticsAddRowConfig extends ZohoAnalyticsRowDateFormatOptions {
+    /**
+     * The row to add, keyed by column name.
+     */
+    readonly columns: ZohoAnalyticsRow;
+}
+/**
+ * Input for adding a single row to a table.
+ */
+export interface ZohoAnalyticsAddRowInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly viewId: ZohoAnalyticsViewId;
+    readonly config: ZohoAnalyticsAddRowConfig;
+}
+/**
+ * Payload returned when a row is added.
+ */
+export interface ZohoAnalyticsAddRowResult {
+    /**
+     * The column values that were accepted.
+     *
+     * Echoed back as strings regardless of the column's type — a numeric `2` comes back as `'2'`.
+     */
+    readonly addedColumns?: ZohoAnalyticsRow;
+    /**
+     * The column values that were rejected.
+     *
+     * Always present, as an empty object when nothing was rejected — test it for emptiness rather
+     * than for presence. Verified against the live API.
+     */
+    readonly invalidColumns?: ZohoAnalyticsInvalidColumns;
+}
+/**
+ * Response for `POST /workspaces/{workspaceId}/views/{viewId}/rows`.
+ */
+export type ZohoAnalyticsAddRowResponse = ZohoAnalyticsResponse<ZohoAnalyticsAddRowResult>;
+/**
+ * Adds a single row to a table.
+ */
+export type ZohoAnalyticsAddRowFunction = (input: ZohoAnalyticsAddRowInput) => Promise<ZohoAnalyticsAddRowResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsAddRowFunction} bound to the given context.
+ *
+ * Intended for single rows. Use the import operations for bulk data — a row-at-a-time loop burns
+ * through the request frequency limit and costs far more API units than one import.
+ *
+ * A successful response can still report rejected values in `invalidColumns`: an unrecognized
+ * column does not fail the call, the row is written without it, and the response is the only record
+ * of the loss. The write is rejected outright only when NO column is recognized, as error 8016.
+ * {@link zohoAnalyticsUpdateRows} behaves identically. Verified against the live API.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that adds a row to a table.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/data-api/add-row.html
+ */
+export declare function zohoAnalyticsAddRow(context: ZohoAnalyticsContext): ZohoAnalyticsAddRowFunction;
+/**
+ * Options for updating rows.
+ *
+ * Either `criteria` or `updateAllRows` must be set, so that an update cannot silently rewrite an
+ * entire table.
+ */
+export interface ZohoAnalyticsUpdateRowsConfig extends ZohoAnalyticsRowDateFormatOptions {
+    /**
+     * The new column values, keyed by column name.
+     */
+    readonly columns: ZohoAnalyticsRow;
+    /**
+     * Restricts the update to rows matching this filter expression.
+     */
+    readonly criteria?: ZohoAnalyticsCriteria;
+    /**
+     * Updates every row in the table.
+     */
+    readonly updateAllRows?: boolean;
+    /**
+     * Inserts a row when `criteria` matches nothing. Defaults to false.
+     */
+    readonly addIfNotExist?: boolean;
+}
+/**
+ * Input for updating rows of a table.
+ */
+export interface ZohoAnalyticsUpdateRowsInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly viewId: ZohoAnalyticsViewId;
+    readonly config: ZohoAnalyticsUpdateRowsConfig;
+}
+/**
+ * Payload returned when rows are updated.
+ */
+export interface ZohoAnalyticsUpdateRowsResult {
+    readonly updatedColumns?: ZohoAnalyticsRow;
+    /**
+     * Number of rows the criteria matched and updated.
+     *
+     * Zero when the criteria matched nothing, which is a success rather than a failure — a resolved
+     * update says nothing about whether any row changed.
+     */
+    readonly updatedRows?: number;
+    /**
+     * The column values that were rejected, as an empty object when none were.
+     *
+     * Populated for the same reason as on {@link ZohoAnalyticsAddRowResult}: an unrecognized column is
+     * dropped and reported here rather than failing the update. Verified against the live API.
+     */
+    readonly invalidColumns?: ZohoAnalyticsInvalidColumns;
+}
+/**
+ * Response for `PUT /workspaces/{workspaceId}/views/{viewId}/rows`.
+ */
+export type ZohoAnalyticsUpdateRowsResponse = ZohoAnalyticsResponse<ZohoAnalyticsUpdateRowsResult>;
+/**
+ * Updates the rows of a table.
+ */
+export type ZohoAnalyticsUpdateRowsFunction = (input: ZohoAnalyticsUpdateRowsInput) => Promise<ZohoAnalyticsUpdateRowsResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsUpdateRowsFunction} bound to the given context.
+ *
+ * Requires either `criteria` or `updateAllRows`: an update with neither would target every row,
+ * which is too destructive to infer.
+ *
+ * Two things a resolved call does NOT tell the caller, both verified against the live API: a
+ * criteria matching no row succeeds with `updatedRows: 0`, and an unrecognized column is dropped
+ * and reported in `invalidColumns` rather than failing. An update left with no recognized column at
+ * all is rejected as error 8016.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that updates rows of a table.
+ * @throws {Error} When neither `criteria` nor `updateAllRows` is set.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/data-api/update-row.html
+ */
+export declare function zohoAnalyticsUpdateRows(context: ZohoAnalyticsContext): ZohoAnalyticsUpdateRowsFunction;
+/**
+ * Options for deleting rows.
+ *
+ * Either `criteria` or `deleteAllRows` must be set, so that a delete cannot silently empty an
+ * entire table.
+ */
+export interface ZohoAnalyticsDeleteRowsConfig {
+    /**
+     * Restricts the delete to rows matching this filter expression.
+     */
+    readonly criteria?: ZohoAnalyticsCriteria;
+    /**
+     * Deletes every row in the table.
+     */
+    readonly deleteAllRows?: boolean;
+}
+/**
+ * Input for deleting rows of a table.
+ */
+export interface ZohoAnalyticsDeleteRowsInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly viewId: ZohoAnalyticsViewId;
+    readonly config: ZohoAnalyticsDeleteRowsConfig;
+}
+/**
+ * Payload returned when rows are deleted.
+ */
+export interface ZohoAnalyticsDeleteRowsResult {
+    /**
+     * Number of rows the criteria matched and deleted.
+     *
+     * Zero when the criteria matched nothing, which is a success rather than a failure.
+     */
+    readonly deletedRows?: number;
+}
+/**
+ * Response for `DELETE /workspaces/{workspaceId}/views/{viewId}/rows`.
+ */
+export type ZohoAnalyticsDeleteRowsResponse = ZohoAnalyticsResponse<ZohoAnalyticsDeleteRowsResult>;
+/**
+ * Deletes rows of a table.
+ */
+export type ZohoAnalyticsDeleteRowsFunction = (input: ZohoAnalyticsDeleteRowsInput) => Promise<ZohoAnalyticsDeleteRowsResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsDeleteRowsFunction} bound to the given context.
+ *
+ * Requires either `criteria` or `deleteAllRows`: a delete with neither would empty the table, which
+ * is too destructive to infer. To replace a table's contents wholesale, prefer a `truncateadd`
+ * import, which does it in one operation.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that deletes rows of a table.
+ * @throws {Error} When neither `criteria` nor `deleteAllRows` is set.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/data-api/delete-row.html
+ */
+export declare function zohoAnalyticsDeleteRows(context: ZohoAnalyticsContext): ZohoAnalyticsDeleteRowsFunction;