@augstash/sdk 0.2.0 → 0.3.0

package/dist/generated/src/apis/ZohoBooksApi.js

@@ -0,0 +1,281 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZohoBooksApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class ZohoBooksApi extends runtime.BaseAPI {
+    /**
+     * As the Zoho CRM authorize URL, with the Books scope set (read-only: customers, invoices, payments, settings). The first organisation the grant can see becomes the connection\'s account; choose another on /settings. Makes no Zoho call. Writes < 300ms. Requires API-key scope: integrations:write.
+     * Build the Zoho consent URL that starts a Zoho Books connect
+     */
+    async authorizeUrlIntegrationsZohobooksRaw(requestParameters, initOverrides) {
+        const queryParameters = {};
+        if (requestParameters['dataCenter'] != null) {
+            queryParameters['dataCenter'] = requestParameters['dataCenter'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/zoho-books/authorize-url`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ZohoAuthorizeUrlResponseFromJSON)(jsonValue));
+    }
+    /**
+     * As the Zoho CRM authorize URL, with the Books scope set (read-only: customers, invoices, payments, settings). The first organisation the grant can see becomes the connection\'s account; choose another on /settings. Makes no Zoho call. Writes < 300ms. Requires API-key scope: integrations:write.
+     * Build the Zoho consent URL that starts a Zoho Books connect
+     */
+    async authorizeUrlIntegrationsZohobooks(requestParameters = {}, initOverrides) {
+        const response = await this.authorizeUrlIntegrationsZohobooksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * A read model of the chosen organisation\'s invoices. The three *AnnouncedAt fields say which accounting moments (invoice.issued, invoice.paid, invoice.overdue) have reached automations — the honest answer to \"why did nobody get a reminder\": a customer with no phone and no email in the books is never announced. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
+     * The invoices this tenant\'s syncs have observed, newest first
+     */
+    async invoicesIntegrationsRaw(requestParameters, initOverrides) {
+        if (requestParameters['pageable'] == null) {
+            throw new runtime.RequiredError('pageable', 'Required parameter "pageable" was null or undefined when calling invoicesIntegrations().');
+        }
+        const queryParameters = {};
+        if (requestParameters['pageable'] != null) {
+            queryParameters['pageable'] = requestParameters['pageable'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/zoho-books/invoices`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PageResponseZohoBooksInvoiceResponseFromJSON)(jsonValue));
+    }
+    /**
+     * A read model of the chosen organisation\'s invoices. The three *AnnouncedAt fields say which accounting moments (invoice.issued, invoice.paid, invoice.overdue) have reached automations — the honest answer to \"why did nobody get a reminder\": a customer with no phone and no email in the books is never announced. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
+     * The invoices this tenant\'s syncs have observed, newest first
+     */
+    async invoicesIntegrations(requestParameters, initOverrides) {
+        const response = await this.invoicesIntegrationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Live from Zoho, with selected on the one being synced. A grant that can see several organisations syncs exactly one; this is the list to choose from on /settings. Vendor round trip < 2s. Requires API-key scope: integrations:read.
+     * The Zoho Books organisations this tenant\'s grant can see
+     */
+    async organizationsRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/zoho-books/organizations`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.ZohoBooksOrganizationResponseFromJSON));
+    }
+    /**
+     * Live from Zoho, with selected on the one being synced. A grant that can see several organisations syncs exactly one; this is the list to choose from on /settings. Vendor round trip < 2s. Requires API-key scope: integrations:read.
+     * The Zoho Books organisations this tenant\'s grant can see
+     */
+    async organizations(initOverrides) {
+        const response = await this.organizationsRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Health comes from the shared connection substrate. organizationId is the ONE Books organisation being synced — a grant may see several; change it on /settings. documentsUnresolved counts invoices and payments whose customer has no phone and no email in the books, so nobody can be messaged about them. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Whether this tenant has connected Zoho Books, and what the last sync did
+     */
+    async statusIntegrationsZohobooksRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/zoho-books`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ZohoBooksStatusResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Health comes from the shared connection substrate. organizationId is the ONE Books organisation being synced — a grant may see several; change it on /settings. documentsUnresolved counts invoices and payments whose customer has no phone and no email in the books, so nobody can be messaged about them. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Whether this tenant has connected Zoho Books, and what the last sync did
+     */
+    async statusIntegrationsZohobooks(initOverrides) {
+        const response = await this.statusIntegrationsZohobooksRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Three phases in order: customers (into the directory, by phone then email, tagged zoho-books, NO consent recorded), invoices, payments. Each invoice moment — invoice.issued, invoice.overdue, invoice.paid — and each new payment is announced ONCE to automations waiting on ACCOUNTING_EVENT; eventsAnnounced counts them. Each phase is independently fallible; a spent daily allowance yields PARTIAL — do not prompt a reconnect for it. Bounded per run. Runs synchronously: < 60s. Requires API-key scope: integrations:write.
+     * Run this tenant\'s Zoho Books sync now
+     */
+    async syncNowIntegrationsZohobooksRaw(requestParameters, initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/zoho-books/sync`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ZohoBooksRunResponseFromJSON)(jsonValue));
+    }
+    /**
+     * Three phases in order: customers (into the directory, by phone then email, tagged zoho-books, NO consent recorded), invoices, payments. Each invoice moment — invoice.issued, invoice.overdue, invoice.paid — and each new payment is announced ONCE to automations waiting on ACCOUNTING_EVENT; eventsAnnounced counts them. Each phase is independently fallible; a spent daily allowance yields PARTIAL — do not prompt a reconnect for it. Bounded per run. Runs synchronously: < 60s. Requires API-key scope: integrations:write.
+     * Run this tenant\'s Zoho Books sync now
+     */
+    async syncNowIntegrationsZohobooks(requestParameters = {}, initOverrides) {
+        const response = await this.syncNowIntegrationsZohobooksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * organizationId must be one GET /organizations lists. Switching resets the sync watermarks — they described a different set of books — and re-points the connection\'s account. Vendor round trip < 2s. Requires API-key scope: integrations:write.
+     * Point the Zoho Books sync at another organisation
+     */
+    async updateSettingsIntegrationsZohobooksRaw(requestParameters, initOverrides) {
+        if (requestParameters['updateZohoBooksSettingsRequest'] == null) {
+            throw new runtime.RequiredError('updateZohoBooksSettingsRequest', 'Required parameter "updateZohoBooksSettingsRequest" was null or undefined when calling updateSettingsIntegrationsZohobooks().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (requestParameters['xIdempotencyKey'] != null) {
+            headerParameters['X-Idempotency-Key'] = String(requestParameters['xIdempotencyKey']);
+        }
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKeyAuth authentication
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/api/v1/integrations/zoho-books/settings`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: (0, index_1.UpdateZohoBooksSettingsRequestToJSON)(requestParameters['updateZohoBooksSettingsRequest']),
+        }, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ZohoBooksStatusResponseFromJSON)(jsonValue));
+    }
+    /**
+     * organizationId must be one GET /organizations lists. Switching resets the sync watermarks — they described a different set of books — and re-points the connection\'s account. Vendor round trip < 2s. Requires API-key scope: integrations:write.
+     * Point the Zoho Books sync at another organisation
+     */
+    async updateSettingsIntegrationsZohobooks(requestParameters, initOverrides) {
+        const response = await this.updateSettingsIntegrationsZohobooksRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}
+exports.ZohoBooksApi = ZohoBooksApi;

package/dist/generated/src/apis/ZohoCrmApi.d.ts

@@ -0,0 +1,159 @@
+/**
+ * Augstash Public API
+ * Every /api/_** response is wrapped in {success, code, data, message, traceId, timestamp}; the schema shown for an operation is what arrives in `data`, and the SDKs unwrap it. Errors carry a stable `code` - branch on that, never on `message`. Authentication is an ask_live_* key on X-Api-Key, or a bearer token. Operations marked \'Not reachable with an ask_live_* API key\' need a user token.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { PageResponseZohoCrmDealResponse, Pageable, UpdateZohoCrmSettingsRequest, ZohoAuthorizeUrlResponse, ZohoCrmRunResponse, ZohoCrmStatusResponse } from '../models/index';
+export interface AuthorizeUrlIntegrationsRequest {
+    dataCenter?: string;
+}
+export interface DealsIntegrationsZohocrmRequest {
+    pageable: Pageable;
+}
+export interface SyncNowIntegrationsZohocrmRequest {
+    xIdempotencyKey?: string;
+}
+export interface UpdateSettingsIntegrationsZohocrmRequest {
+    updateZohoCrmSettingsRequest: UpdateZohoCrmSettingsRequest;
+    xIdempotencyKey?: string;
+}
+/**
+ * ZohoCrmApi - interface
+ *
+ * @export
+ * @interface ZohoCrmApiInterface
+ */
+export interface ZohoCrmApiInterface {
+    /**
+     * Returns the absolute Zoho OAuth URL to navigate the browser to, carrying a signed state that binds this tenant and the product for the unauthenticated callback. dataCenter selects which Zoho accounts host the consent screen STARTS at (us, eu, in, au, jp, ca, sa; default in). Zoho redirects a customer who lives elsewhere and the callback follows Zoho\'s own location, so a wrong choice here costs one extra redirect, not a failed connect. scopes is the comma-separated list the consent screen shows. state is diagnostics only. Makes no Zoho call. Writes < 300ms. Requires API-key scope: integrations:write.
+     * @summary Build the Zoho consent URL that starts a Zoho CRM connect
+     * @param {string} [dataCenter]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ZohoCrmApiInterface
+     */
+    authorizeUrlIntegrationsRaw(requestParameters: AuthorizeUrlIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZohoAuthorizeUrlResponse>>;
+    /**
+     * Returns the absolute Zoho OAuth URL to navigate the browser to, carrying a signed state that binds this tenant and the product for the unauthenticated callback. dataCenter selects which Zoho accounts host the consent screen STARTS at (us, eu, in, au, jp, ca, sa; default in). Zoho redirects a customer who lives elsewhere and the callback follows Zoho\'s own location, so a wrong choice here costs one extra redirect, not a failed connect. scopes is the comma-separated list the consent screen shows. state is diagnostics only. Makes no Zoho call. Writes < 300ms. Requires API-key scope: integrations:write.
+     * Build the Zoho consent URL that starts a Zoho CRM connect
+     */
+    authorizeUrlIntegrations(requestParameters: AuthorizeUrlIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZohoAuthorizeUrlResponse>;
+    /**
+     * Exists so somebody building an automation can see the Stage values their own org uses: Zoho has no separate stage id, so the value IS what a DEAL_STAGE_CHANGED flow\'s trigger config names, and a rename in the org is a new stage. stageChangedAt is when we observed the move. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary The Deals this tenant\'s syncs have observed, most recently moved first
+     * @param {Pageable} pageable
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ZohoCrmApiInterface
+     */
+    dealsIntegrationsZohocrmRaw(requestParameters: DealsIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseZohoCrmDealResponse>>;
+    /**
+     * Exists so somebody building an automation can see the Stage values their own org uses: Zoho has no separate stage id, so the value IS what a DEAL_STAGE_CHANGED flow\'s trigger config names, and a rename in the org is a new stage. stageChangedAt is when we observed the move. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
+     * The Deals this tenant\'s syncs have observed, most recently moved first
+     */
+    dealsIntegrationsZohocrm(requestParameters: DealsIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseZohoCrmDealResponse>;
+    /**
+     * Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/zoho-crm. Counters are from the last run and zero before the first. noteWatermark is how far conversation history has been written onto CRM records as Notes. apiDomain and dataCenter are returned so an operator can confirm which Zoho data centre the account lives in. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
+     * @summary Whether this tenant has connected Zoho CRM, and what the last sync did
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ZohoCrmApiInterface
+     */
+    statusIntegrationsZohocrmRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZohoCrmStatusResponse>>;
+    /**
+     * Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/zoho-crm. Counters are from the last run and zero before the first. noteWatermark is how far conversation history has been written onto CRM records as Notes. apiDomain and dataCenter are returned so an operator can confirm which Zoho data centre the account lives in. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Whether this tenant has connected Zoho CRM, and what the last sync did
+     */
+    statusIntegrationsZohocrm(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZohoCrmStatusResponse>;
+    /**
+     * Four phases in order: Contacts, Leads (when syncLeads), Deals (when syncDeals — each stage CHANGE is announced as a CRM deal-stage event with vendor zoho-crm), then the conversation Note write-back, which upserts missing people first when pushPeopleAs is set. Each phase is independently fallible: an org that spent its daily API credits yields PARTIAL — do not prompt a reconnect for it. Importing a record records NO consent; every imported person carries the zoho-crm tag. Bounded per run, resumes where it stopped. Runs synchronously: < 60s. Requires API-key scope: integrations:write.
+     * @summary Run this tenant\'s Zoho CRM sync now
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ZohoCrmApiInterface
+     */
+    syncNowIntegrationsZohocrmRaw(requestParameters: SyncNowIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZohoCrmRunResponse>>;
+    /**
+     * Four phases in order: Contacts, Leads (when syncLeads), Deals (when syncDeals — each stage CHANGE is announced as a CRM deal-stage event with vendor zoho-crm), then the conversation Note write-back, which upserts missing people first when pushPeopleAs is set. Each phase is independently fallible: an org that spent its daily API credits yields PARTIAL — do not prompt a reconnect for it. Importing a record records NO consent; every imported person carries the zoho-crm tag. Bounded per run, resumes where it stopped. Runs synchronously: < 60s. Requires API-key scope: integrations:write.
+     * Run this tenant\'s Zoho CRM sync now
+     */
+    syncNowIntegrationsZohocrm(requestParameters: SyncNowIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZohoCrmRunResponse>;
+    /**
+     * A genuine partial update: send only the fields to change. syncLeads and syncDeals default TRUE and only read — but syncDeals ANNOUNCES: a DEAL_STAGE_CHANGED flow left unnarrowed on vendor fires for any CRM, so narrow it to vendor=zoho-crm or turn this off. pushPeopleAs is none|lead|contact and defaults none; the other two UPSERT people into the customer\'s org keyed on email — only people a conversation exists with, only ones with an email, bounded per run. Importing or creating a record records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
+     * @summary Change how this tenant\'s Zoho CRM integration behaves
+     * @param {UpdateZohoCrmSettingsRequest} updateZohoCrmSettingsRequest
+     * @param {string} [xIdempotencyKey] Makes this call replayable instead of re-executed on retry (AS-TGT-001). The first 2xx response is cached per (tenant, key) for 24h and replayed verbatim, with &#x60;X-Idempotent-Replay&#x60; set. Reusing a key with a different body is refused with 409 IDEMPOTENCY_KEY_REUSED. The SDKs send one automatically on mutating calls.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ZohoCrmApiInterface
+     */
+    updateSettingsIntegrationsZohocrmRaw(requestParameters: UpdateSettingsIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZohoCrmStatusResponse>>;
+    /**
+     * A genuine partial update: send only the fields to change. syncLeads and syncDeals default TRUE and only read — but syncDeals ANNOUNCES: a DEAL_STAGE_CHANGED flow left unnarrowed on vendor fires for any CRM, so narrow it to vendor=zoho-crm or turn this off. pushPeopleAs is none|lead|contact and defaults none; the other two UPSERT people into the customer\'s org keyed on email — only people a conversation exists with, only ones with an email, bounded per run. Importing or creating a record records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Change how this tenant\'s Zoho CRM integration behaves
+     */
+    updateSettingsIntegrationsZohocrm(requestParameters: UpdateSettingsIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZohoCrmStatusResponse>;
+}
+/**
+ *
+ */
+export declare class ZohoCrmApi extends runtime.BaseAPI implements ZohoCrmApiInterface {
+    /**
+     * Returns the absolute Zoho OAuth URL to navigate the browser to, carrying a signed state that binds this tenant and the product for the unauthenticated callback. dataCenter selects which Zoho accounts host the consent screen STARTS at (us, eu, in, au, jp, ca, sa; default in). Zoho redirects a customer who lives elsewhere and the callback follows Zoho\'s own location, so a wrong choice here costs one extra redirect, not a failed connect. scopes is the comma-separated list the consent screen shows. state is diagnostics only. Makes no Zoho call. Writes < 300ms. Requires API-key scope: integrations:write.
+     * Build the Zoho consent URL that starts a Zoho CRM connect
+     */
+    authorizeUrlIntegrationsRaw(requestParameters: AuthorizeUrlIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZohoAuthorizeUrlResponse>>;
+    /**
+     * Returns the absolute Zoho OAuth URL to navigate the browser to, carrying a signed state that binds this tenant and the product for the unauthenticated callback. dataCenter selects which Zoho accounts host the consent screen STARTS at (us, eu, in, au, jp, ca, sa; default in). Zoho redirects a customer who lives elsewhere and the callback follows Zoho\'s own location, so a wrong choice here costs one extra redirect, not a failed connect. scopes is the comma-separated list the consent screen shows. state is diagnostics only. Makes no Zoho call. Writes < 300ms. Requires API-key scope: integrations:write.
+     * Build the Zoho consent URL that starts a Zoho CRM connect
+     */
+    authorizeUrlIntegrations(requestParameters?: AuthorizeUrlIntegrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZohoAuthorizeUrlResponse>;
+    /**
+     * Exists so somebody building an automation can see the Stage values their own org uses: Zoho has no separate stage id, so the value IS what a DEAL_STAGE_CHANGED flow\'s trigger config names, and a rename in the org is a new stage. stageChangedAt is when we observed the move. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
+     * The Deals this tenant\'s syncs have observed, most recently moved first
+     */
+    dealsIntegrationsZohocrmRaw(requestParameters: DealsIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PageResponseZohoCrmDealResponse>>;
+    /**
+     * Exists so somebody building an automation can see the Stage values their own org uses: Zoho has no separate stage id, so the value IS what a DEAL_STAGE_CHANGED flow\'s trigger config names, and a rename in the org is a new stage. stageChangedAt is when we observed the move. Paginated, default 20 and max 100. Reads < 300ms. Requires API-key scope: integrations:read.
+     * The Deals this tenant\'s syncs have observed, most recently moved first
+     */
+    dealsIntegrationsZohocrm(requestParameters: DealsIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PageResponseZohoCrmDealResponse>;
+    /**
+     * Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/zoho-crm. Counters are from the last run and zero before the first. noteWatermark is how far conversation history has been written onto CRM records as Notes. apiDomain and dataCenter are returned so an operator can confirm which Zoho data centre the account lives in. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Whether this tenant has connected Zoho CRM, and what the last sync did
+     */
+    statusIntegrationsZohocrmRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZohoCrmStatusResponse>>;
+    /**
+     * Health comes from the shared connection substrate, so status here always matches GET /api/v1/integrations/zoho-crm. Counters are from the last run and zero before the first. noteWatermark is how far conversation history has been written onto CRM records as Notes. apiDomain and dataCenter are returned so an operator can confirm which Zoho data centre the account lives in. Never returns a token. Reads < 300ms. Requires API-key scope: integrations:read.
+     * Whether this tenant has connected Zoho CRM, and what the last sync did
+     */
+    statusIntegrationsZohocrm(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZohoCrmStatusResponse>;
+    /**
+     * Four phases in order: Contacts, Leads (when syncLeads), Deals (when syncDeals — each stage CHANGE is announced as a CRM deal-stage event with vendor zoho-crm), then the conversation Note write-back, which upserts missing people first when pushPeopleAs is set. Each phase is independently fallible: an org that spent its daily API credits yields PARTIAL — do not prompt a reconnect for it. Importing a record records NO consent; every imported person carries the zoho-crm tag. Bounded per run, resumes where it stopped. Runs synchronously: < 60s. Requires API-key scope: integrations:write.
+     * Run this tenant\'s Zoho CRM sync now
+     */
+    syncNowIntegrationsZohocrmRaw(requestParameters: SyncNowIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZohoCrmRunResponse>>;
+    /**
+     * Four phases in order: Contacts, Leads (when syncLeads), Deals (when syncDeals — each stage CHANGE is announced as a CRM deal-stage event with vendor zoho-crm), then the conversation Note write-back, which upserts missing people first when pushPeopleAs is set. Each phase is independently fallible: an org that spent its daily API credits yields PARTIAL — do not prompt a reconnect for it. Importing a record records NO consent; every imported person carries the zoho-crm tag. Bounded per run, resumes where it stopped. Runs synchronously: < 60s. Requires API-key scope: integrations:write.
+     * Run this tenant\'s Zoho CRM sync now
+     */
+    syncNowIntegrationsZohocrm(requestParameters?: SyncNowIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZohoCrmRunResponse>;
+    /**
+     * A genuine partial update: send only the fields to change. syncLeads and syncDeals default TRUE and only read — but syncDeals ANNOUNCES: a DEAL_STAGE_CHANGED flow left unnarrowed on vendor fires for any CRM, so narrow it to vendor=zoho-crm or turn this off. pushPeopleAs is none|lead|contact and defaults none; the other two UPSERT people into the customer\'s org keyed on email — only people a conversation exists with, only ones with an email, bounded per run. Importing or creating a record records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Change how this tenant\'s Zoho CRM integration behaves
+     */
+    updateSettingsIntegrationsZohocrmRaw(requestParameters: UpdateSettingsIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZohoCrmStatusResponse>>;
+    /**
+     * A genuine partial update: send only the fields to change. syncLeads and syncDeals default TRUE and only read — but syncDeals ANNOUNCES: a DEAL_STAGE_CHANGED flow left unnarrowed on vendor fires for any CRM, so narrow it to vendor=zoho-crm or turn this off. pushPeopleAs is none|lead|contact and defaults none; the other two UPSERT people into the customer\'s org keyed on email — only people a conversation exists with, only ones with an email, bounded per run. Importing or creating a record records NO consent on any channel. Writes < 500ms. Requires API-key scope: integrations:write.
+     * Change how this tenant\'s Zoho CRM integration behaves
+     */
+    updateSettingsIntegrationsZohocrm(requestParameters: UpdateSettingsIntegrationsZohocrmRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZohoCrmStatusResponse>;
+}