@dereekb/zoho 13.38.0 → 13.40.0

package/nestjs/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "13.38.0",
+  "version": "13.40.0",
+  "type": "module",
   "peerDependencies": {
-    "@dereekb/nestjs": "13.38.0",
-    "@dereekb/rxjs": "13.38.0",
-    "@dereekb/util": "13.38.0",
-    "@dereekb/zoho": "13.38.0",
+    "@dereekb/nestjs": "13.40.0",
+    "@dereekb/rxjs": "13.40.0",
+    "@dereekb/util": "13.40.0",
+    "@dereekb/zoho": "13.40.0",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "express": "^5.2.1"
@@ -17,13 +18,12 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "module": "./index.esm.js",
       "types": "./index.d.ts",
-      "import": "./index.cjs.mjs",
-      "default": "./index.cjs.js"
+      "import": "./index.esm.js",
+      "default": "./index.esm.js"
     }
   },
   "module": "./index.esm.js",
-  "main": "./index.cjs.js",
+  "main": "./index.esm.js",
   "types": "./index.d.ts"
-}
+}

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

@@ -0,0 +1,236 @@
+import { type ZohoAnalytics, type ZohoAnalyticsContext } from '@dereekb/zoho';
+import { ZohoAnalyticsServiceConfig } from './analytics.config';
+import { ZohoAccountsApi } from '../accounts/accounts.api';
+/**
+ * Injectable wrapper around the Zoho Analytics API.
+ *
+ * Each accessor is a configured pass-through to the corresponding `@dereekb/zoho` function, bound
+ * to this instance's authenticated {@link ZohoAnalyticsContext}.
+ */
+export declare class ZohoAnalyticsApi {
+    readonly config: ZohoAnalyticsServiceConfig;
+    readonly zohoAccountsApi: ZohoAccountsApi;
+    readonly zohoAnalytics: ZohoAnalytics;
+    /**
+     * The authenticated context used by every Analytics operation.
+     *
+     * @returns The context carrying the configured fetch, config, and rate limiter.
+     */
+    get analyticsContext(): ZohoAnalyticsContext;
+    /**
+     * The shared rate limiter instance.
+     *
+     * @returns The rate limiter pacing requests against the Analytics frequency limit.
+     */
+    get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
+    /**
+     * Initializes the Analytics client by combining the service config with the accounts context for
+     * OAuth token management.
+     *
+     * @param config - Zoho Analytics service configuration.
+     * @param zohoAccountsApi - Accounts API used for OAuth token management.
+     */
+    constructor(config: ZohoAnalyticsServiceConfig, zohoAccountsApi: ZohoAccountsApi);
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetOrgs}.
+     *
+     * Lists the organizations available to the authenticated user. The only operation that works without a configured
+     * `orgId`.
+     *
+     * @returns Bound get orgs function.
+     */
+    get getOrgs(): import("@dereekb/zoho").ZohoAnalyticsGetOrgsFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetAllWorkspaces}.
+     *
+     * Lists every accessible workspace, grouped into owned and shared.
+     *
+     * @returns Bound get all workspaces function.
+     */
+    get getAllWorkspaces(): import("@dereekb/zoho").ZohoAnalyticsGetAllWorkspacesFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetOwnedWorkspaces}.
+     *
+     * Lists the workspaces owned by the authenticated user.
+     *
+     * @returns Bound get owned workspaces function.
+     */
+    get getOwnedWorkspaces(): import("@dereekb/zoho").ZohoAnalyticsGetWorkspacesFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetSharedWorkspaces}.
+     *
+     * Lists the workspaces shared with the authenticated user.
+     *
+     * @returns Bound get shared workspaces function.
+     */
+    get getSharedWorkspaces(): import("@dereekb/zoho").ZohoAnalyticsGetWorkspacesFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetWorkspaceDetails}.
+     *
+     * Retrieves a single workspace by id.
+     *
+     * @returns Bound get workspace details function.
+     */
+    get getWorkspaceDetails(): import("@dereekb/zoho").ZohoAnalyticsGetWorkspaceDetailsFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetViews}.
+     *
+     * Lists every view in a workspace.
+     *
+     * @returns Bound get views function.
+     */
+    get getViews(): import("@dereekb/zoho").ZohoAnalyticsGetViewsFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetViewDetails}.
+     *
+     * Retrieves a single view by its globally unique id.
+     *
+     * @returns Bound get view details function.
+     */
+    get getViewDetails(): import("@dereekb/zoho").ZohoAnalyticsGetViewDetailsFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetTableMetadata}.
+     *
+     * Retrieves a table's column metadata.
+     *
+     * @returns Bound get table metadata function.
+     */
+    get getTableMetadata(): import("@dereekb/zoho").ZohoAnalyticsGetTableMetadataFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsImportDataInTable}.
+     *
+     * Imports data into an existing table and waits for the result.
+     *
+     * @returns Bound import data in table function.
+     */
+    get importDataInTable(): import("@dereekb/zoho").ZohoAnalyticsImportDataInTableFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsImportDataInNewTable}.
+     *
+     * Creates a table from the imported data.
+     *
+     * @returns Bound import data in new table function.
+     */
+    get importDataInNewTable(): import("@dereekb/zoho").ZohoAnalyticsImportDataInNewTableFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsCreateImportJobInTable}.
+     *
+     * Queues an asynchronous import into an existing table.
+     *
+     * @returns Bound create import job in table function.
+     */
+    get createImportJobInTable(): import("@dereekb/zoho").ZohoAnalyticsCreateImportJobInTableFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsCreateImportJobInNewTable}.
+     *
+     * Queues an asynchronous import that creates a new table.
+     *
+     * @returns Bound create import job in new table function.
+     */
+    get createImportJobInNewTable(): import("@dereekb/zoho").ZohoAnalyticsCreateImportJobInNewTableFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetImportJob}.
+     *
+     * Retrieves an import job's status.
+     *
+     * @returns Bound get import job function.
+     */
+    get getImportJob(): import("@dereekb/zoho").ZohoAnalyticsGetImportJobFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsImportDataInTableAndAwaitJob}.
+     *
+     * Queues an asynchronous import and polls until the job reaches a terminal state.
+     *
+     * @returns Bound import data in table and await job function.
+     */
+    get importDataInTableAndAwaitJob(): import("@dereekb/zoho").ZohoAnalyticsImportDataInTableAndAwaitJobFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsExportData}.
+     *
+     * Exports a view's data, resolving with the raw response.
+     *
+     * @returns Bound export data function.
+     */
+    get exportData(): import("@dereekb/zoho").ZohoAnalyticsExportDataFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsCreateExportJob}.
+     *
+     * Queues an asynchronous export of a view.
+     *
+     * @returns Bound create export job function.
+     */
+    get createExportJob(): import("@dereekb/zoho").ZohoAnalyticsCreateExportJobFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsCreateExportJobForSqlQuery}.
+     *
+     * Queues an asynchronous export of a SQL query's results.
+     *
+     * @returns Bound create export job for SQL query function.
+     */
+    get createExportJobForSqlQuery(): import("@dereekb/zoho").ZohoAnalyticsCreateExportJobForSqlQueryFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsGetExportJob}.
+     *
+     * Retrieves an export job's status.
+     *
+     * @returns Bound get export job function.
+     */
+    get getExportJob(): import("@dereekb/zoho").ZohoAnalyticsGetExportJobFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsDownloadExport}.
+     *
+     * Downloads the file produced by a completed export job.
+     *
+     * @returns Bound download export function.
+     */
+    get downloadExport(): import("@dereekb/zoho").ZohoAnalyticsDownloadExportFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsExportDataAndAwaitJob}.
+     *
+     * Queues an asynchronous export and polls until the job reaches a terminal state.
+     *
+     * @returns Bound export data and await job function.
+     */
+    get exportDataAndAwaitJob(): import("@dereekb/zoho").ZohoAnalyticsExportDataAndAwaitJobFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsAddRow}.
+     *
+     * Adds a single row to a table. Prefer an import for bulk data.
+     *
+     * @returns Bound add row function.
+     */
+    get addRow(): import("@dereekb/zoho").ZohoAnalyticsAddRowFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsUpdateRows}.
+     *
+     * Updates rows matching a criteria expression.
+     *
+     * @returns Bound update rows function.
+     */
+    get updateRows(): import("@dereekb/zoho").ZohoAnalyticsUpdateRowsFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsDeleteRows}.
+     *
+     * Deletes rows matching a criteria expression.
+     *
+     * @returns Bound delete rows function.
+     */
+    get deleteRows(): import("@dereekb/zoho").ZohoAnalyticsDeleteRowsFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsDeleteView}.
+     *
+     * Irreversibly deletes a table, query table, report or dashboard. Needs the
+     * `ZohoAnalytics.modeling.delete` scope, which `modeling.create` does not imply.
+     *
+     * @returns Bound delete view function.
+     */
+    get deleteView(): import("@dereekb/zoho").ZohoAnalyticsDeleteViewFunction;
+    /**
+     * Configured pass-through for {@link zohoAnalyticsDeleteWorkspace}.
+     *
+     * Irreversibly deletes a workspace and every view inside it.
+     *
+     * @returns Bound delete workspace function.
+     */
+    get deleteWorkspace(): import("@dereekb/zoho").ZohoAnalyticsDeleteWorkspaceFunction;
+}

package/nestjs/src/lib/analytics/analytics.config.d.ts

@@ -0,0 +1,24 @@
+import { type ZohoAnalyticsConfig, type ZohoAnalyticsFactoryConfig } from '@dereekb/zoho';
+/**
+ * Zoho Analytics API configuration for the `ZohoAnalyticsApi`.
+ */
+export type ZohoAnalyticsServiceApiConfig = ZohoAnalyticsConfig;
+/**
+ * Configuration for the Zoho Analytics service, used as the injection token for the
+ * `ZohoAnalyticsApi`.
+ */
+export declare abstract class ZohoAnalyticsServiceConfig {
+    readonly zohoAnalytics: ZohoAnalyticsServiceApiConfig;
+    readonly factoryConfig?: ZohoAnalyticsFactoryConfig;
+    /**
+     * Asserts the config carries everything needed to reach the Zoho Analytics API.
+     *
+     * Unlike Zoho Desk, the organization id is not required here: `GET /orgs` is the bootstrap call
+     * that discovers it, and is the one endpoint that works without it. Every other endpoint fails
+     * with error code 8083 when `orgId` is absent.
+     *
+     * @param config - The config to validate.
+     * @throws {Error} When the API URL is missing.
+     */
+    static assertValidConfig(config: ZohoAnalyticsServiceConfig): void;
+}

package/nestjs/src/lib/analytics/analytics.module.d.ts

@@ -0,0 +1,65 @@
+import { type ModuleMetadata } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { ZohoAnalyticsServiceConfig } from './analytics.config';
+import { ZohoAccountsServiceConfig } from '../accounts/accounts.config';
+import { type Maybe } from '@dereekb/util';
+/**
+ * Config key suffix for the Zoho Analytics organization ID.
+ * Resolves to `ZOHO_ANALYTICS_ORG_ID` or `ZOHO_ORG_ID`.
+ */
+export declare const ZOHO_ANALYTICS_ORG_ID_CONFIG_KEY = "ORG_ID";
+/**
+ * Reads Zoho Analytics connection settings from the NestJS ConfigService
+ * and returns a validated service config.
+ *
+ * Resolves the API URL via environment variables following the naming convention
+ * `ZOHO_ANALYTICS_API_URL` (service-specific) or `ZOHO_API_URL` (shared fallback).
+ * The organization ID is read from `ZOHO_ANALYTICS_ORG_ID` or `ZOHO_ORG_ID`.
+ *
+ * The organization ID is optional: without it only `getOrgs()` succeeds, which is how the id is
+ * discovered in the first place.
+ *
+ * @param configService - NestJS config service populated with Zoho environment variables.
+ * @returns Validated Zoho Analytics service configuration.
+ * @throws {Error} If the API URL is missing.
+ */
+export declare function zohoAnalyticsServiceConfigFactory(configService: ConfigService): ZohoAnalyticsServiceConfig;
+/**
+ * Reads Zoho Accounts (OAuth) settings scoped to the Analytics service from
+ * the NestJS ConfigService and returns an accounts service config.
+ *
+ * @param configService - NestJS config service populated with Zoho OAuth environment variables.
+ * @returns Zoho Accounts service config scoped to the Analytics service access token.
+ */
+export declare function zohoAnalyticsAccountServiceConfigFactory(configService: ConfigService): ZohoAccountsServiceConfig;
+/**
+ * Configuration for generating the application-level Zoho Analytics NestJS module metadata.
+ *
+ * Extends standard NestJS {@link ModuleMetadata} fields (`imports`, `exports`, `providers`)
+ * so additional providers or modules can be merged into the generated metadata.
+ */
+export interface ProvideAppZohoAnalyticsMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
+    /**
+     * Module that exports the required dependencies for this module.
+     * When provided, this module is automatically included in the generated `imports` array.
+     */
+    readonly dependencyModule?: Maybe<Required<ModuleMetadata>['imports']['0']>;
+}
+/**
+ * Generates NestJS {@link ModuleMetadata} that wires up the full Zoho Analytics stack
+ * (config, accounts, and API service) so consuming modules only need a single import.
+ *
+ * The generated module requires the following dependencies in order to initialize properly:
+ * - `ZohoAccountsAccessTokenCacheService`
+ *
+ * Use the `dependencyModule` config option to import a module that exports those dependencies.
+ *
+ * The returned metadata registers {@link ZohoAnalyticsServiceConfig}, {@link ZohoAnalyticsApi},
+ * {@link ZohoAccountsServiceConfig}, and {@link ZohoAccountsApi} as providers, and
+ * exports {@link ZohoAnalyticsApi} by default. Additional imports, exports, and providers
+ * from the config are merged in.
+ *
+ * @param config - Module configuration with optional dependency module and extra metadata.
+ * @returns Complete NestJS module metadata ready to pass to `@Module()`
+ */
+export declare function appZohoAnalyticsModuleMetadata(config: ProvideAppZohoAnalyticsMetadataConfig): ModuleMetadata;

package/nestjs/src/lib/analytics/index.d.ts

@@ -0,0 +1,3 @@
+export * from './analytics.api';
+export * from './analytics.config';
+export * from './analytics.module';

package/nestjs/src/lib/index.d.ts

@@ -3,4 +3,5 @@ export * from './crm';
 export * from './recruit';
 export * from './sign';
 export * from './desk';
+export * from './analytics';
 export * from './zoho.config';

package/package.json

@@ -1,35 +1,34 @@
 {
   "name": "@dereekb/zoho",
-  "version": "13.38.0",
+  "version": "13.40.0",
+  "type": "module",
   "bin": {
     "zoho-cli": "cli/index.js"
   },
   "exports": {
     "./nestjs": {
-      "module": "./nestjs/index.esm.js",
       "types": "./nestjs/index.d.ts",
-      "import": "./nestjs/index.cjs.mjs",
-      "default": "./nestjs/index.cjs.js"
+      "import": "./nestjs/index.esm.js",
+      "default": "./nestjs/index.esm.js"
     },
     "./cli": {
       "default": "./cli/index.js"
     },
     "./package.json": "./package.json",
     ".": {
-      "module": "./index.esm.js",
       "types": "./index.d.ts",
-      "import": "./index.cjs.mjs",
-      "default": "./index.cjs.js"
+      "import": "./index.esm.js",
+      "default": "./index.esm.js"
     }
   },
   "peerDependencies": {
-    "@dereekb/date": "13.38.0",
-    "@dereekb/dbx-cli": "13.38.0",
-    "@dereekb/firebase": "13.38.0",
-    "@dereekb/model": "13.38.0",
-    "@dereekb/nestjs": "13.38.0",
-    "@dereekb/rxjs": "13.38.0",
-    "@dereekb/util": "13.38.0",
+    "@dereekb/date": "13.40.0",
+    "@dereekb/dbx-cli": "13.40.0",
+    "@dereekb/firebase": "13.40.0",
+    "@dereekb/model": "13.40.0",
+    "@dereekb/nestjs": "13.40.0",
+    "@dereekb/rxjs": "13.40.0",
+    "@dereekb/util": "13.40.0",
     "@nestjs/common": "^11.1.19",
     "@nestjs/config": "^4.0.4",
     "express": "^5.2.1",
@@ -41,6 +40,6 @@
     "date-fns": "^4.1.0"
   },
   "module": "./index.esm.js",
-  "main": "./index.cjs.js",
+  "main": "./index.esm.js",
   "types": "./index.d.ts"
-}
+}

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

@@ -0,0 +1,167 @@
+import { type ZohoAnalyticsJobId, type ZohoAnalyticsResponse, type ZohoAnalyticsViewId, type ZohoAnalyticsWorkspaceId } from './analytics';
+import { type ZohoAnalyticsContext } from './analytics.config';
+import { type ZohoAnalyticsExportConfig, type ZohoAnalyticsExportJobConfig, type ZohoAnalyticsExportJobSqlQueryConfig, type ZohoAnalyticsExportJobStatus } from './analytics.export';
+import { type ZohoAnalyticsJobCreationResult } from './analytics.api.import';
+import { type PollZohoAnalyticsJobConfig } from './analytics.job';
+/**
+ * Input for exporting the data of a view.
+ */
+export interface ZohoAnalyticsExportDataInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly viewId: ZohoAnalyticsViewId;
+    readonly config: ZohoAnalyticsExportConfig;
+}
+/**
+ * Exports a view's data, resolving with the raw response.
+ */
+export type ZohoAnalyticsExportDataFunction = (input: ZohoAnalyticsExportDataInput) => Promise<Response>;
+/**
+ * Creates a {@link ZohoAnalyticsExportDataFunction} bound to the given context.
+ *
+ * Resolves with the raw {@link Response} rather than a parsed body, because the payload's type is
+ * chosen by the caller through `config.responseFormat` — read it with `.json()` for the `json`
+ * format and `.text()` for `csv`, `xml` and `html`.
+ *
+ * Zoho rejects a synchronous export for tables over 1,000,000 rows, for live-connect workspaces,
+ * and for dashboard and query-table views. Use {@link zohoAnalyticsCreateExportJob} for those.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that exports a view's data.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/export-data.html
+ *
+ * @example
+ * ```ts
+ * const exportData = zohoAnalyticsExportData(context);
+ * const response = await exportData({ workspaceId, viewId, config: { responseFormat: 'csv' } });
+ * const csv = await response.text();
+ * ```
+ */
+export declare function zohoAnalyticsExportData(context: ZohoAnalyticsContext): ZohoAnalyticsExportDataFunction;
+/**
+ * Response returned when an asynchronous export job is created.
+ */
+export type ZohoAnalyticsCreateExportJobResponse = ZohoAnalyticsResponse<ZohoAnalyticsJobCreationResult>;
+/**
+ * Input for queueing an asynchronous export of a view.
+ */
+export interface ZohoAnalyticsCreateExportJobInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly viewId: ZohoAnalyticsViewId;
+    readonly config: ZohoAnalyticsExportJobConfig;
+}
+/**
+ * Queues an asynchronous export of a view.
+ */
+export type ZohoAnalyticsCreateExportJobFunction = (input: ZohoAnalyticsCreateExportJobInput) => Promise<ZohoAnalyticsCreateExportJobResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsCreateExportJobFunction} bound to the given context.
+ *
+ * Zoho Analytics allows at most 5 concurrent export jobs per organization, and the resulting file
+ * remains downloadable for roughly one hour.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that queues an asynchronous view export.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/export-data-async/create-export/view-id.html
+ */
+export declare function zohoAnalyticsCreateExportJob(context: ZohoAnalyticsContext): ZohoAnalyticsCreateExportJobFunction;
+/**
+ * Input for queueing an asynchronous export driven by a SQL query.
+ */
+export interface ZohoAnalyticsCreateExportJobForSqlQueryInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly config: ZohoAnalyticsExportJobSqlQueryConfig;
+}
+/**
+ * Queues an asynchronous export of a SQL query's results.
+ */
+export type ZohoAnalyticsCreateExportJobForSqlQueryFunction = (input: ZohoAnalyticsCreateExportJobForSqlQueryInput) => Promise<ZohoAnalyticsCreateExportJobResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsCreateExportJobForSqlQueryFunction} bound to the given context.
+ *
+ * This is the only way to run ad-hoc SQL against a workspace: Zoho Analytics has no synchronous
+ * query endpoint. The query result is exported as a file and nothing is persisted — to keep a query
+ * as a reusable view, create a query table through the Modeling API instead.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that queues an asynchronous SQL query export.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/export-data-async/create-export/sql-query.html
+ */
+export declare function zohoAnalyticsCreateExportJobForSqlQuery(context: ZohoAnalyticsContext): ZohoAnalyticsCreateExportJobForSqlQueryFunction;
+/**
+ * Response for `GET /bulk/workspaces/{workspaceId}/exportjobs/{jobId}`.
+ */
+export type ZohoAnalyticsGetExportJobResponse = ZohoAnalyticsResponse<ZohoAnalyticsExportJobStatus>;
+/**
+ * Input for retrieving an export job's status.
+ */
+export interface ZohoAnalyticsGetExportJobInput {
+    readonly workspaceId: ZohoAnalyticsWorkspaceId;
+    readonly jobId: ZohoAnalyticsJobId;
+}
+/**
+ * Retrieves the status of an asynchronous export job.
+ */
+export type ZohoAnalyticsGetExportJobFunction = (input: ZohoAnalyticsGetExportJobInput) => Promise<ZohoAnalyticsGetExportJobResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsGetExportJobFunction} bound to the given context.
+ *
+ * Checking job status costs zero API units.
+ *
+ * A job id that does not exist is a thrown 404 (error 8120), not a resolved status carrying
+ * `ZOHO_ANALYTICS_JOB_CODE_NOT_FOUND`. Verified against the live API.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that retrieves an export job's status.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/export-data-async/get-export.html
+ */
+export declare function zohoAnalyticsGetExportJob(context: ZohoAnalyticsContext): ZohoAnalyticsGetExportJobFunction;
+/**
+ * Input for downloading a completed export.
+ */
+export type ZohoAnalyticsDownloadExportInput = ZohoAnalyticsGetExportJobInput;
+/**
+ * Downloads the file produced by a completed export job.
+ */
+export type ZohoAnalyticsDownloadExportFunction = (input: ZohoAnalyticsDownloadExportInput) => Promise<Response>;
+/**
+ * Creates a {@link ZohoAnalyticsDownloadExportFunction} bound to the given context.
+ *
+ * Resolves with the raw {@link Response} carrying the exported file. Downloading costs zero API
+ * units, but the file is only available for roughly an hour after the job completes.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that downloads a completed export.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/export-data-async/download-export.html
+ */
+export declare function zohoAnalyticsDownloadExport(context: ZohoAnalyticsContext): ZohoAnalyticsDownloadExportFunction;
+/**
+ * Input for queueing an asynchronous export and waiting for it to finish.
+ */
+export interface ZohoAnalyticsExportDataAndAwaitJobInput extends ZohoAnalyticsCreateExportJobInput {
+    /**
+     * Overrides for how the job is polled.
+     */
+    readonly poll?: Omit<PollZohoAnalyticsJobConfig<ZohoAnalyticsGetExportJobResponse>, 'loadJob' | 'readJobCode'>;
+}
+/**
+ * Queues an asynchronous export of a view and resolves once it reaches a terminal state.
+ */
+export type ZohoAnalyticsExportDataAndAwaitJobFunction = (input: ZohoAnalyticsExportDataAndAwaitJobInput) => Promise<ZohoAnalyticsGetExportJobResponse>;
+/**
+ * Creates a {@link ZohoAnalyticsExportDataAndAwaitJobFunction} bound to the given context.
+ *
+ * Queues the export, 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()` before
+ * reading `downloadUrl`.
+ *
+ * @param context - Authenticated Zoho Analytics context providing fetch and rate limiting.
+ * @returns Function that exports asynchronously and waits for the job.
+ *
+ * @see https://www.zoho.com/analytics/api/v2/bulk-api/export-data-async/get-export.html
+ */
+export declare function zohoAnalyticsExportDataAndAwaitJob(context: ZohoAnalyticsContext): ZohoAnalyticsExportDataAndAwaitJobFunction;