cloudflare/resources/zaraz/zaraz.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.mjs";
import * as ConfigAPI from "./config.mjs";
import { BaseConfig, Config, ConfigGetParams, ConfigUpdateParams, Configuration } from "./config.mjs";
import * as DefaultAPI from "./default.mjs";
import { BaseDefault, Default, DefaultGetParams } from "./default.mjs";
import * as ExportAPI from "./export.mjs";
import { BaseExport, Export, ExportGetParams } from "./export.mjs";
import * as PublishAPI from "./publish.mjs";
import { BasePublish, Publish, PublishCreateParams, PublishCreateResponse } from "./publish.mjs";
import * as WorkflowAPI from "./workflow.mjs";
import { BaseWorkflowResource, Workflow, WorkflowGetParams, WorkflowResource } from "./workflow.mjs";
import * as HistoryAPI from "./history/history.mjs";
import { BaseHistory, History, HistoryListParams, HistoryListResponse, HistoryListResponsesSinglePage, HistoryUpdateParams } from "./history/history.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseZaraz extends APIResource {
    static readonly _key: readonly ['zaraz'];
    /**
     * Updates Zaraz workflow for a zone.
     *
     * @example
     * ```ts
     * const workflow = await client.zaraz.update({
     *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   workflow: 'realtime',
     * });
     * ```
     */
    update(params: ZarazUpdateParams, options?: RequestOptions): APIPromise<WorkflowAPI.Workflow>;
}
export declare class Zaraz extends BaseZaraz {
    config: ConfigAPI.Config;
    default: DefaultAPI.Default;
    export: ExportAPI.Export;
    history: HistoryAPI.History;
    publish: PublishAPI.Publish;
    workflow: WorkflowAPI.WorkflowResource;
}
export interface ButtonTextTranslation {
    /**
     * Object where keys are language codes.
     */
    accept_all: {
        [key: string]: string;
    };
    /**
     * Object where keys are language codes.
     */
    confirm_my_choices: {
        [key: string]: string;
    };
    /**
     * Object where keys are language codes.
     */
    reject_all: {
        [key: string]: string;
    };
}
export interface ButtonTextTranslationParam {
    /**
     * Object where keys are language codes.
     */
    accept_all: {
        [key: string]: string;
    };
    /**
     * Object where keys are language codes.
     */
    confirm_my_choices: {
        [key: string]: string;
    };
    /**
     * Object where keys are language codes.
     */
    reject_all: {
        [key: string]: string;
    };
}
export interface NeoEvent {
    /**
     * Tool event type.
     */
    actionType: string;
    /**
     * List of blocking triggers IDs.
     */
    blockingTriggers: Array<string>;
    /**
     * Event payload.
     */
    data: unknown;
    /**
     * List of firing triggers IDs.
     */
    firingTriggers: Array<string>;
}
export interface NeoEventParam {
    /**
     * Tool event type.
     */
    actionType: string;
    /**
     * List of blocking triggers IDs.
     */
    blockingTriggers: Array<string>;
    /**
     * Event payload.
     */
    data: unknown;
    /**
     * List of firing triggers IDs.
     */
    firingTriggers: Array<string>;
}
export interface ZarazUpdateParams {
    /**
     * Path param: Identifier.
     */
    zone_id: string;
    /**
     * Body param: Zaraz workflow.
     */
    workflow: WorkflowAPI.WorkflowParam;
}
export declare namespace Zaraz {
    export { type ButtonTextTranslation as ButtonTextTranslation, type NeoEvent as NeoEvent, type ZarazUpdateParams as ZarazUpdateParams, };
    export { Config as Config, BaseConfig as BaseConfig, type Configuration as Configuration, type ConfigUpdateParams as ConfigUpdateParams, type ConfigGetParams as ConfigGetParams, };
    export { Default as Default, BaseDefault as BaseDefault, type DefaultGetParams as DefaultGetParams };
    export { Export as Export, BaseExport as BaseExport, type ExportGetParams as ExportGetParams };
    export { History as History, BaseHistory as BaseHistory, type HistoryListResponse as HistoryListResponse, type HistoryListResponsesSinglePage as HistoryListResponsesSinglePage, type HistoryUpdateParams as HistoryUpdateParams, type HistoryListParams as HistoryListParams, };
    export { Publish as Publish, BasePublish as BasePublish, type PublishCreateResponse as PublishCreateResponse, type PublishCreateParams as PublishCreateParams, };
    export { WorkflowResource as WorkflowResource, BaseWorkflowResource as BaseWorkflowResource, type Workflow as Workflow, type WorkflowGetParams as WorkflowGetParams, };
}
//# sourceMappingURL=zaraz.d.mts.map