@rippling/rippling-sdk 0.2.0-alpha.106 → 0.2.0-alpha.108

package/resources/workflows/workflows.d.mts

@@ -0,0 +1,977 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as ExecutionsAPI from "./executions.mjs";
+import { ExecutionCreateResponse, ExecutionRetrieveResponse, Executions } from "./executions.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { PageCursorURL, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export declare class Workflows extends APIResource {
+    executions: ExecutionsAPI.Executions;
+    /**
+     * List workflows
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /workflows/?limit=50&cursor=cursor HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "version_id": "string",
+     *       "name": "string",
+     *       "description": "string",
+     *       "status": "draft",
+     *       "enabled": false,
+     *       "owner_id": "string",
+     *       "has_draft": false,
+     *       "created_at": "2025-01-01T00:00:00Z",
+     *       "updated_at": "2025-01-01T00:00:00Z"
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
+     */
+    list(query?: WorkflowListParams | null | undefined, options?: RequestOptions): PagePromise<WorkflowListResponsesPageCursorURL, WorkflowListResponse>;
+    /**
+     * Create a workflow
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /workflows/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "actions": [
+     *     {
+     *       "id": "x",
+     *       "implementation_config": "x",
+     *       "kind": "registered_callback",
+     *       "owner_id": "x",
+     *       "owner_type": "x"
+     *     }
+     *   ],
+     *   "name": "x",
+     *   "trigger": {
+     *     "hour": 0,
+     *     "kind": "daily_schedule",
+     *     "timezone": "timezone"
+     *   }
+     * }
+     *
+     * HTTP/1.1 201 Created
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "version_id": "string",
+     *   "name": "string",
+     *   "description": "string",
+     *   "status": "draft",
+     *   "enabled": false,
+     *   "owner_id": "string",
+     *   "has_draft": false,
+     *   "created_at": "2025-01-01T00:00:00Z",
+     *   "updated_at": "2025-01-01T00:00:00Z",
+     *   "definition": {
+     *     "kind": "editable",
+     *     "trigger": {},
+     *     "actions": [
+     *       {}
+     *     ]
+     *   },
+     *   "authoring": {
+     *     "mode": "full",
+     *     "patchable_fields": [
+     *       "name"
+     *     ],
+     *     "reason_codes": [
+     *       "unsupported_trigger"
+     *     ]
+     *   },
+     *   "deletable": false
+     * }
+     * ```
+     */
+    create(body: WorkflowCreateParams, options?: RequestOptions): APIPromise<WorkflowCreateResponse>;
+    /**
+     * Retrieve a workflow
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /workflows/{id}/?version_id=version_id HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "version_id": "string",
+     *   "name": "string",
+     *   "description": "string",
+     *   "status": "draft",
+     *   "enabled": false,
+     *   "owner_id": "string",
+     *   "has_draft": false,
+     *   "created_at": "2025-01-01T00:00:00Z",
+     *   "updated_at": "2025-01-01T00:00:00Z",
+     *   "definition": {
+     *     "kind": "editable",
+     *     "trigger": {},
+     *     "actions": [
+     *       {}
+     *     ]
+     *   },
+     *   "authoring": {
+     *     "mode": "full",
+     *     "patchable_fields": [
+     *       "name"
+     *     ],
+     *     "reason_codes": [
+     *       "unsupported_trigger"
+     *     ]
+     *   },
+     *   "deletable": false
+     * }
+     * ```
+     */
+    retrieve(id: string, query?: WorkflowRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<WorkflowRetrieveResponse>;
+    /**
+     * Update a workflow
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * PATCH /workflows/{id}/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "version_id": "x"
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "version_id": "string",
+     *   "name": "string",
+     *   "description": "string",
+     *   "status": "draft",
+     *   "enabled": false,
+     *   "owner_id": "string",
+     *   "has_draft": false,
+     *   "created_at": "2025-01-01T00:00:00Z",
+     *   "updated_at": "2025-01-01T00:00:00Z",
+     *   "definition": {
+     *     "kind": "editable",
+     *     "trigger": {},
+     *     "actions": [
+     *       {}
+     *     ]
+     *   },
+     *   "authoring": {
+     *     "mode": "full",
+     *     "patchable_fields": [
+     *       "name"
+     *     ],
+     *     "reason_codes": [
+     *       "unsupported_trigger"
+     *     ]
+     *   },
+     *   "deletable": false
+     * }
+     * ```
+     */
+    update(id: string, body: WorkflowUpdateParams, options?: RequestOptions): APIPromise<WorkflowUpdateResponse>;
+    /**
+     * Delete a workflow
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * DELETE /workflows/{id}/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 204 No Content
+     * ```
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<void>;
+}
+export type WorkflowListResponsesPageCursorURL = PageCursorURL<WorkflowListResponse>;
+export interface WorkflowListResponse {
+    id: string;
+    created_at: string;
+    description: string | null;
+    enabled: boolean;
+    has_draft: boolean;
+    name: string;
+    owner_id: string;
+    status: 'draft' | 'published' | 'unknown';
+    updated_at: string;
+    version_id: string;
+}
+export interface WorkflowCreateResponse {
+    id: string;
+    authoring: WorkflowCreateResponse.Authoring;
+    created_at: string;
+    definition: WorkflowCreateResponse.EditableWorkflowDefinition | WorkflowCreateResponse.ReadOnlyWorkflowDefinition;
+    deletable: boolean;
+    enabled: boolean;
+    has_draft: boolean;
+    name: string;
+    owner_id: string;
+    status: 'draft' | 'published' | 'unknown';
+    updated_at: string;
+    version_id: string;
+    description?: string | null;
+}
+export declare namespace WorkflowCreateResponse {
+    interface Authoring {
+        mode: 'full' | 'metadata_only' | 'read_only';
+        patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
+        reason_codes: Array<'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'>;
+    }
+    interface EditableWorkflowDefinition {
+        actions: Array<EditableWorkflowDefinition.Action>;
+        kind: 'editable';
+        trigger: EditableWorkflowDefinition.DailyScheduleTrigger | EditableWorkflowDefinition.BusinessEventTrigger | EditableWorkflowDefinition.WeekdayScheduleTrigger | EditableWorkflowDefinition.WeeklyScheduleTrigger | EditableWorkflowDefinition.BiweeklyScheduleTrigger | EditableWorkflowDefinition.MonthlyScheduleTrigger | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger | EditableWorkflowDefinition.QuarterlyScheduleTrigger | EditableWorkflowDefinition.AnnualScheduleTrigger | EditableWorkflowDefinition.OneTimeScheduleTrigger | EditableWorkflowDefinition.CustomScheduleTrigger | EditableWorkflowDefinition.CronScheduleTrigger | EditableWorkflowDefinition.ManualTrigger | EditableWorkflowDefinition.SlackTrigger | EditableWorkflowDefinition.InboundEmailTrigger;
+    }
+    namespace EditableWorkflowDefinition {
+        interface Action {
+            id: string;
+            implementation_config: string;
+            kind: 'registered_callback';
+            owner_id: string;
+            owner_type: string;
+        }
+        interface DailyScheduleTrigger {
+            hour: number;
+            kind: 'daily_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface BusinessEventTrigger {
+            event_name: string;
+            kind: 'business_event';
+        }
+        interface WeekdayScheduleTrigger {
+            hour: number;
+            kind: 'weekday_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface WeeklyScheduleTrigger {
+            days_of_week: Array<number>;
+            hour: number;
+            kind: 'weekly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface BiweeklyScheduleTrigger {
+            days_of_week: Array<number>;
+            hour: number;
+            kind: 'biweekly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface MonthlyScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'monthly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface MonthlyOnDayOfWeekScheduleTrigger {
+            day_of_week: number;
+            hour: number;
+            kind: 'monthly_on_day_of_week_schedule';
+            timezone: string;
+            week_of_month: number;
+            minute?: number;
+        }
+        interface QuarterlyScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'quarterly_schedule';
+            month_of_year: number;
+            timezone: string;
+            minute?: number;
+        }
+        interface AnnualScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'annual_schedule';
+            month_of_year: number;
+            timezone: string;
+            minute?: number;
+        }
+        interface OneTimeScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'one_time_schedule';
+            month_of_year: number;
+            timezone: string;
+            year: number;
+            minute?: number;
+        }
+        interface CustomScheduleTrigger {
+            interval: number;
+            kind: 'custom_schedule';
+            timezone: string;
+            unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
+            day_of_month?: number | null;
+            days_of_week?: Array<number> | null;
+            hour?: number;
+            minute?: number;
+            month_of_year?: number | null;
+            start_month?: number | null;
+        }
+        interface CronScheduleTrigger {
+            expression: string;
+            kind: 'cron_schedule';
+            timezone: string;
+        }
+        interface ManualTrigger {
+            kind: 'manual';
+        }
+        interface SlackTrigger {
+            channel_ids: Array<string>;
+            event_type: 'message_posted' | 'reaction_added';
+            kind: 'slack';
+            allowed_sender_group_id?: string | null;
+            include_thread_replies?: boolean;
+            message_text_regex?: string | null;
+            reaction_names?: Array<string>;
+        }
+        interface InboundEmailTrigger {
+            kind: 'inbound_email';
+            recipient_email: string;
+            body_contains?: string | null;
+            has_attachment?: boolean;
+            subject_contains?: string | null;
+        }
+    }
+    interface ReadOnlyWorkflowDefinition {
+        kind: 'read_only';
+        steps: Array<ReadOnlyWorkflowDefinition.Step>;
+        trigger: ReadOnlyWorkflowDefinition.Trigger;
+    }
+    namespace ReadOnlyWorkflowDefinition {
+        interface Step {
+            id: string;
+            kind: 'read_only';
+            name: string;
+            next_ids: Array<string>;
+            source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
+        }
+        interface Trigger {
+            kind: 'read_only';
+            source_type: 'business_event' | 'record_change' | 'scheduled' | 'manual' | 'webhook' | 'date_relative' | 'integration' | 'unknown';
+            summary: string;
+        }
+    }
+}
+export interface WorkflowRetrieveResponse {
+    id: string;
+    authoring: WorkflowRetrieveResponse.Authoring;
+    created_at: string;
+    definition: WorkflowRetrieveResponse.EditableWorkflowDefinition | WorkflowRetrieveResponse.ReadOnlyWorkflowDefinition;
+    deletable: boolean;
+    enabled: boolean;
+    has_draft: boolean;
+    name: string;
+    owner_id: string;
+    status: 'draft' | 'published' | 'unknown';
+    updated_at: string;
+    version_id: string;
+    description?: string | null;
+}
+export declare namespace WorkflowRetrieveResponse {
+    interface Authoring {
+        mode: 'full' | 'metadata_only' | 'read_only';
+        patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
+        reason_codes: Array<'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'>;
+    }
+    interface EditableWorkflowDefinition {
+        actions: Array<EditableWorkflowDefinition.Action>;
+        kind: 'editable';
+        trigger: EditableWorkflowDefinition.DailyScheduleTrigger | EditableWorkflowDefinition.BusinessEventTrigger | EditableWorkflowDefinition.WeekdayScheduleTrigger | EditableWorkflowDefinition.WeeklyScheduleTrigger | EditableWorkflowDefinition.BiweeklyScheduleTrigger | EditableWorkflowDefinition.MonthlyScheduleTrigger | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger | EditableWorkflowDefinition.QuarterlyScheduleTrigger | EditableWorkflowDefinition.AnnualScheduleTrigger | EditableWorkflowDefinition.OneTimeScheduleTrigger | EditableWorkflowDefinition.CustomScheduleTrigger | EditableWorkflowDefinition.CronScheduleTrigger | EditableWorkflowDefinition.ManualTrigger | EditableWorkflowDefinition.SlackTrigger | EditableWorkflowDefinition.InboundEmailTrigger;
+    }
+    namespace EditableWorkflowDefinition {
+        interface Action {
+            id: string;
+            implementation_config: string;
+            kind: 'registered_callback';
+            owner_id: string;
+            owner_type: string;
+        }
+        interface DailyScheduleTrigger {
+            hour: number;
+            kind: 'daily_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface BusinessEventTrigger {
+            event_name: string;
+            kind: 'business_event';
+        }
+        interface WeekdayScheduleTrigger {
+            hour: number;
+            kind: 'weekday_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface WeeklyScheduleTrigger {
+            days_of_week: Array<number>;
+            hour: number;
+            kind: 'weekly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface BiweeklyScheduleTrigger {
+            days_of_week: Array<number>;
+            hour: number;
+            kind: 'biweekly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface MonthlyScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'monthly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface MonthlyOnDayOfWeekScheduleTrigger {
+            day_of_week: number;
+            hour: number;
+            kind: 'monthly_on_day_of_week_schedule';
+            timezone: string;
+            week_of_month: number;
+            minute?: number;
+        }
+        interface QuarterlyScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'quarterly_schedule';
+            month_of_year: number;
+            timezone: string;
+            minute?: number;
+        }
+        interface AnnualScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'annual_schedule';
+            month_of_year: number;
+            timezone: string;
+            minute?: number;
+        }
+        interface OneTimeScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'one_time_schedule';
+            month_of_year: number;
+            timezone: string;
+            year: number;
+            minute?: number;
+        }
+        interface CustomScheduleTrigger {
+            interval: number;
+            kind: 'custom_schedule';
+            timezone: string;
+            unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
+            day_of_month?: number | null;
+            days_of_week?: Array<number> | null;
+            hour?: number;
+            minute?: number;
+            month_of_year?: number | null;
+            start_month?: number | null;
+        }
+        interface CronScheduleTrigger {
+            expression: string;
+            kind: 'cron_schedule';
+            timezone: string;
+        }
+        interface ManualTrigger {
+            kind: 'manual';
+        }
+        interface SlackTrigger {
+            channel_ids: Array<string>;
+            event_type: 'message_posted' | 'reaction_added';
+            kind: 'slack';
+            allowed_sender_group_id?: string | null;
+            include_thread_replies?: boolean;
+            message_text_regex?: string | null;
+            reaction_names?: Array<string>;
+        }
+        interface InboundEmailTrigger {
+            kind: 'inbound_email';
+            recipient_email: string;
+            body_contains?: string | null;
+            has_attachment?: boolean;
+            subject_contains?: string | null;
+        }
+    }
+    interface ReadOnlyWorkflowDefinition {
+        kind: 'read_only';
+        steps: Array<ReadOnlyWorkflowDefinition.Step>;
+        trigger: ReadOnlyWorkflowDefinition.Trigger;
+    }
+    namespace ReadOnlyWorkflowDefinition {
+        interface Step {
+            id: string;
+            kind: 'read_only';
+            name: string;
+            next_ids: Array<string>;
+            source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
+        }
+        interface Trigger {
+            kind: 'read_only';
+            source_type: 'business_event' | 'record_change' | 'scheduled' | 'manual' | 'webhook' | 'date_relative' | 'integration' | 'unknown';
+            summary: string;
+        }
+    }
+}
+export interface WorkflowUpdateResponse {
+    id: string;
+    authoring: WorkflowUpdateResponse.Authoring;
+    created_at: string;
+    definition: WorkflowUpdateResponse.EditableWorkflowDefinition | WorkflowUpdateResponse.ReadOnlyWorkflowDefinition;
+    deletable: boolean;
+    enabled: boolean;
+    has_draft: boolean;
+    name: string;
+    owner_id: string;
+    status: 'draft' | 'published' | 'unknown';
+    updated_at: string;
+    version_id: string;
+    description?: string | null;
+}
+export declare namespace WorkflowUpdateResponse {
+    interface Authoring {
+        mode: 'full' | 'metadata_only' | 'read_only';
+        patchable_fields: Array<'name' | 'description' | 'status' | 'enabled' | 'trigger' | 'actions'>;
+        reason_codes: Array<'unsupported_trigger' | 'unsupported_graph' | 'insufficient_permission' | 'missing_current_version'>;
+    }
+    interface EditableWorkflowDefinition {
+        actions: Array<EditableWorkflowDefinition.Action>;
+        kind: 'editable';
+        trigger: EditableWorkflowDefinition.DailyScheduleTrigger | EditableWorkflowDefinition.BusinessEventTrigger | EditableWorkflowDefinition.WeekdayScheduleTrigger | EditableWorkflowDefinition.WeeklyScheduleTrigger | EditableWorkflowDefinition.BiweeklyScheduleTrigger | EditableWorkflowDefinition.MonthlyScheduleTrigger | EditableWorkflowDefinition.MonthlyOnDayOfWeekScheduleTrigger | EditableWorkflowDefinition.QuarterlyScheduleTrigger | EditableWorkflowDefinition.AnnualScheduleTrigger | EditableWorkflowDefinition.OneTimeScheduleTrigger | EditableWorkflowDefinition.CustomScheduleTrigger | EditableWorkflowDefinition.CronScheduleTrigger | EditableWorkflowDefinition.ManualTrigger | EditableWorkflowDefinition.SlackTrigger | EditableWorkflowDefinition.InboundEmailTrigger;
+    }
+    namespace EditableWorkflowDefinition {
+        interface Action {
+            id: string;
+            implementation_config: string;
+            kind: 'registered_callback';
+            owner_id: string;
+            owner_type: string;
+        }
+        interface DailyScheduleTrigger {
+            hour: number;
+            kind: 'daily_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface BusinessEventTrigger {
+            event_name: string;
+            kind: 'business_event';
+        }
+        interface WeekdayScheduleTrigger {
+            hour: number;
+            kind: 'weekday_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface WeeklyScheduleTrigger {
+            days_of_week: Array<number>;
+            hour: number;
+            kind: 'weekly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface BiweeklyScheduleTrigger {
+            days_of_week: Array<number>;
+            hour: number;
+            kind: 'biweekly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface MonthlyScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'monthly_schedule';
+            timezone: string;
+            minute?: number;
+        }
+        interface MonthlyOnDayOfWeekScheduleTrigger {
+            day_of_week: number;
+            hour: number;
+            kind: 'monthly_on_day_of_week_schedule';
+            timezone: string;
+            week_of_month: number;
+            minute?: number;
+        }
+        interface QuarterlyScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'quarterly_schedule';
+            month_of_year: number;
+            timezone: string;
+            minute?: number;
+        }
+        interface AnnualScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'annual_schedule';
+            month_of_year: number;
+            timezone: string;
+            minute?: number;
+        }
+        interface OneTimeScheduleTrigger {
+            day_of_month: number;
+            hour: number;
+            kind: 'one_time_schedule';
+            month_of_year: number;
+            timezone: string;
+            year: number;
+            minute?: number;
+        }
+        interface CustomScheduleTrigger {
+            interval: number;
+            kind: 'custom_schedule';
+            timezone: string;
+            unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
+            day_of_month?: number | null;
+            days_of_week?: Array<number> | null;
+            hour?: number;
+            minute?: number;
+            month_of_year?: number | null;
+            start_month?: number | null;
+        }
+        interface CronScheduleTrigger {
+            expression: string;
+            kind: 'cron_schedule';
+            timezone: string;
+        }
+        interface ManualTrigger {
+            kind: 'manual';
+        }
+        interface SlackTrigger {
+            channel_ids: Array<string>;
+            event_type: 'message_posted' | 'reaction_added';
+            kind: 'slack';
+            allowed_sender_group_id?: string | null;
+            include_thread_replies?: boolean;
+            message_text_regex?: string | null;
+            reaction_names?: Array<string>;
+        }
+        interface InboundEmailTrigger {
+            kind: 'inbound_email';
+            recipient_email: string;
+            body_contains?: string | null;
+            has_attachment?: boolean;
+            subject_contains?: string | null;
+        }
+    }
+    interface ReadOnlyWorkflowDefinition {
+        kind: 'read_only';
+        steps: Array<ReadOnlyWorkflowDefinition.Step>;
+        trigger: ReadOnlyWorkflowDefinition.Trigger;
+    }
+    namespace ReadOnlyWorkflowDefinition {
+        interface Step {
+            id: string;
+            kind: 'read_only';
+            name: string;
+            next_ids: Array<string>;
+            source_type: 'action' | 'fork' | 'loop' | 'switch' | 'group' | 'unknown';
+        }
+        interface Trigger {
+            kind: 'read_only';
+            source_type: 'business_event' | 'record_change' | 'scheduled' | 'manual' | 'webhook' | 'date_relative' | 'integration' | 'unknown';
+            summary: string;
+        }
+    }
+}
+export interface WorkflowListParams {
+    cursor?: string;
+    limit?: number;
+}
+export interface WorkflowCreateParams {
+    actions: Array<WorkflowCreateParams.Action>;
+    name: string;
+    trigger: WorkflowCreateParams.DailyScheduleTrigger | WorkflowCreateParams.BusinessEventTrigger | WorkflowCreateParams.WeekdayScheduleTrigger | WorkflowCreateParams.WeeklyScheduleTrigger | WorkflowCreateParams.BiweeklyScheduleTrigger | WorkflowCreateParams.MonthlyScheduleTrigger | WorkflowCreateParams.MonthlyOnDayOfWeekScheduleTrigger | WorkflowCreateParams.QuarterlyScheduleTrigger | WorkflowCreateParams.AnnualScheduleTrigger | WorkflowCreateParams.OneTimeScheduleTrigger | WorkflowCreateParams.CustomScheduleTrigger | WorkflowCreateParams.CronScheduleTrigger | WorkflowCreateParams.ManualTrigger | WorkflowCreateParams.SlackTrigger | WorkflowCreateParams.InboundEmailTrigger;
+    description?: string | null;
+    enabled?: boolean;
+    status?: 'draft' | 'published';
+}
+export declare namespace WorkflowCreateParams {
+    interface Action {
+        id: string;
+        implementation_config: string;
+        kind: 'registered_callback';
+        owner_id: string;
+        owner_type: string;
+    }
+    interface DailyScheduleTrigger {
+        hour: number;
+        kind: 'daily_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface BusinessEventTrigger {
+        event_name: string;
+        kind: 'business_event';
+    }
+    interface WeekdayScheduleTrigger {
+        hour: number;
+        kind: 'weekday_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface WeeklyScheduleTrigger {
+        days_of_week: Array<number>;
+        hour: number;
+        kind: 'weekly_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface BiweeklyScheduleTrigger {
+        days_of_week: Array<number>;
+        hour: number;
+        kind: 'biweekly_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface MonthlyScheduleTrigger {
+        day_of_month: number;
+        hour: number;
+        kind: 'monthly_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface MonthlyOnDayOfWeekScheduleTrigger {
+        day_of_week: number;
+        hour: number;
+        kind: 'monthly_on_day_of_week_schedule';
+        timezone: string;
+        week_of_month: number;
+        minute?: number;
+    }
+    interface QuarterlyScheduleTrigger {
+        day_of_month: number;
+        hour: number;
+        kind: 'quarterly_schedule';
+        month_of_year: number;
+        timezone: string;
+        minute?: number;
+    }
+    interface AnnualScheduleTrigger {
+        day_of_month: number;
+        hour: number;
+        kind: 'annual_schedule';
+        month_of_year: number;
+        timezone: string;
+        minute?: number;
+    }
+    interface OneTimeScheduleTrigger {
+        day_of_month: number;
+        hour: number;
+        kind: 'one_time_schedule';
+        month_of_year: number;
+        timezone: string;
+        year: number;
+        minute?: number;
+    }
+    interface CustomScheduleTrigger {
+        interval: number;
+        kind: 'custom_schedule';
+        timezone: string;
+        unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
+        day_of_month?: number | null;
+        days_of_week?: Array<number> | null;
+        hour?: number;
+        minute?: number;
+        month_of_year?: number | null;
+        start_month?: number | null;
+    }
+    interface CronScheduleTrigger {
+        expression: string;
+        kind: 'cron_schedule';
+        timezone: string;
+    }
+    interface ManualTrigger {
+        kind: 'manual';
+    }
+    interface SlackTrigger {
+        channel_ids: Array<string>;
+        event_type: 'message_posted' | 'reaction_added';
+        kind: 'slack';
+        allowed_sender_group_id?: string | null;
+        include_thread_replies?: boolean;
+        message_text_regex?: string | null;
+        reaction_names?: Array<string>;
+    }
+    interface InboundEmailTrigger {
+        kind: 'inbound_email';
+        recipient_email: string;
+        body_contains?: string | null;
+        has_attachment?: boolean;
+        subject_contains?: string | null;
+    }
+}
+export interface WorkflowRetrieveParams {
+    version_id?: string;
+}
+export interface WorkflowUpdateParams {
+    version_id: string;
+    actions?: Array<WorkflowUpdateParams.Action>;
+    description?: string | null;
+    enabled?: boolean;
+    name?: string;
+    status?: 'draft' | 'published';
+    trigger?: WorkflowUpdateParams.DailyScheduleTrigger | WorkflowUpdateParams.BusinessEventTrigger | WorkflowUpdateParams.WeekdayScheduleTrigger | WorkflowUpdateParams.WeeklyScheduleTrigger | WorkflowUpdateParams.BiweeklyScheduleTrigger | WorkflowUpdateParams.MonthlyScheduleTrigger | WorkflowUpdateParams.MonthlyOnDayOfWeekScheduleTrigger | WorkflowUpdateParams.QuarterlyScheduleTrigger | WorkflowUpdateParams.AnnualScheduleTrigger | WorkflowUpdateParams.OneTimeScheduleTrigger | WorkflowUpdateParams.CustomScheduleTrigger | WorkflowUpdateParams.CronScheduleTrigger | WorkflowUpdateParams.ManualTrigger | WorkflowUpdateParams.SlackTrigger | WorkflowUpdateParams.InboundEmailTrigger;
+}
+export declare namespace WorkflowUpdateParams {
+    interface Action {
+        id: string;
+        implementation_config: string;
+        kind: 'registered_callback';
+        owner_id: string;
+        owner_type: string;
+    }
+    interface DailyScheduleTrigger {
+        hour: number;
+        kind: 'daily_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface BusinessEventTrigger {
+        event_name: string;
+        kind: 'business_event';
+    }
+    interface WeekdayScheduleTrigger {
+        hour: number;
+        kind: 'weekday_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface WeeklyScheduleTrigger {
+        days_of_week: Array<number>;
+        hour: number;
+        kind: 'weekly_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface BiweeklyScheduleTrigger {
+        days_of_week: Array<number>;
+        hour: number;
+        kind: 'biweekly_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface MonthlyScheduleTrigger {
+        day_of_month: number;
+        hour: number;
+        kind: 'monthly_schedule';
+        timezone: string;
+        minute?: number;
+    }
+    interface MonthlyOnDayOfWeekScheduleTrigger {
+        day_of_week: number;
+        hour: number;
+        kind: 'monthly_on_day_of_week_schedule';
+        timezone: string;
+        week_of_month: number;
+        minute?: number;
+    }
+    interface QuarterlyScheduleTrigger {
+        day_of_month: number;
+        hour: number;
+        kind: 'quarterly_schedule';
+        month_of_year: number;
+        timezone: string;
+        minute?: number;
+    }
+    interface AnnualScheduleTrigger {
+        day_of_month: number;
+        hour: number;
+        kind: 'annual_schedule';
+        month_of_year: number;
+        timezone: string;
+        minute?: number;
+    }
+    interface OneTimeScheduleTrigger {
+        day_of_month: number;
+        hour: number;
+        kind: 'one_time_schedule';
+        month_of_year: number;
+        timezone: string;
+        year: number;
+        minute?: number;
+    }
+    interface CustomScheduleTrigger {
+        interval: number;
+        kind: 'custom_schedule';
+        timezone: string;
+        unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
+        day_of_month?: number | null;
+        days_of_week?: Array<number> | null;
+        hour?: number;
+        minute?: number;
+        month_of_year?: number | null;
+        start_month?: number | null;
+    }
+    interface CronScheduleTrigger {
+        expression: string;
+        kind: 'cron_schedule';
+        timezone: string;
+    }
+    interface ManualTrigger {
+        kind: 'manual';
+    }
+    interface SlackTrigger {
+        channel_ids: Array<string>;
+        event_type: 'message_posted' | 'reaction_added';
+        kind: 'slack';
+        allowed_sender_group_id?: string | null;
+        include_thread_replies?: boolean;
+        message_text_regex?: string | null;
+        reaction_names?: Array<string>;
+    }
+    interface InboundEmailTrigger {
+        kind: 'inbound_email';
+        recipient_email: string;
+        body_contains?: string | null;
+        has_attachment?: boolean;
+        subject_contains?: string | null;
+    }
+}
+export declare namespace Workflows {
+    export { type WorkflowListResponse as WorkflowListResponse, type WorkflowCreateResponse as WorkflowCreateResponse, type WorkflowRetrieveResponse as WorkflowRetrieveResponse, type WorkflowUpdateResponse as WorkflowUpdateResponse, type WorkflowListResponsesPageCursorURL as WorkflowListResponsesPageCursorURL, type WorkflowListParams as WorkflowListParams, type WorkflowCreateParams as WorkflowCreateParams, type WorkflowRetrieveParams as WorkflowRetrieveParams, type WorkflowUpdateParams as WorkflowUpdateParams, };
+    export { Executions as Executions, type ExecutionCreateResponse as ExecutionCreateResponse, type ExecutionRetrieveResponse as ExecutionRetrieveResponse, };
+}
+//# sourceMappingURL=workflows.d.mts.map