@rippling/rippling-sdk 0.2.0-alpha.29 → 0.2.0-alpha.31

package/resources/workflow-action-executions.d.ts

@@ -0,0 +1,986 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export declare class WorkflowActionExecutions extends APIResource {
+    /**
+     * Execute a workflow action
+     */
+    create(body: WorkflowActionExecutionCreateParams, options?: RequestOptions): APIPromise<WorkflowActionExecutionCreateResponse>;
+}
+export interface WorkflowActionExecutionCreateResponse {
+    /**
+     * Result of the workflow action execution
+     */
+    result: unknown;
+}
+export interface WorkflowActionExecutionCreateParams {
+    action_type: 'send_email' | 'send_slack' | 'create_app_notification' | 'send_sms' | 'send_push_notification' | 'send_http_request' | 'delete_custom_object_record' | 'send_survey' | 'evaluate_rql' | 'upsert_custom_object' | 'update_custom_object_record' | 'create_gcal_event' | 'send_teams' | 'assign_review' | 'send_report_sftp' | 'run_query';
+    /**
+     * An action that sends an email.
+     * <helpdocslink href='https://help.rippling.com/article?articleId=69745350310'>Help
+     * docs</helpdocslink>
+     */
+    payload: WorkflowActionExecutionCreateParams.SendEmailPayload | WorkflowActionExecutionCreateParams.SendSlackSingleDirectMessagePayload | WorkflowActionExecutionCreateParams.SendSlackGroupDirectMessagePayload | WorkflowActionExecutionCreateParams.SendSlackPublicChannelMessagePayload | WorkflowActionExecutionCreateParams.SendSlackPrivateChannelMessagePayload | WorkflowActionExecutionCreateParams.CreateAppNotificationPayload | WorkflowActionExecutionCreateParams.SendSMSPayload | WorkflowActionExecutionCreateParams.SendPushNotificationPayload | WorkflowActionExecutionCreateParams.SendHTTPRequestPayload | WorkflowActionExecutionCreateParams.DeleteCustomObjectRecordPayload | WorkflowActionExecutionCreateParams.SendSurveyPayload | WorkflowActionExecutionCreateParams.EvaluateRqlSelectionPayload | WorkflowActionExecutionCreateParams.EvaluateRqlQueryPayload | WorkflowActionExecutionCreateParams.UpsertCustomObjectPayload | WorkflowActionExecutionCreateParams.UpdateCustomObjectRecordPayload | WorkflowActionExecutionCreateParams.CreateGcalEventWorkflowOwnerNullPayload | WorkflowActionExecutionCreateParams.CreateGcalEventWorkflowOwnerDailyPayload | WorkflowActionExecutionCreateParams.CreateGcalEventWorkflowOwnerWeeklyPayload | WorkflowActionExecutionCreateParams.CreateGcalEventWorkflowOwnerMonthlyPayload | WorkflowActionExecutionCreateParams.CreateGcalEventWorkflowOwnerYearlyPayload | WorkflowActionExecutionCreateParams.CreateGcalEventSupergroupNullPayload | WorkflowActionExecutionCreateParams.CreateGcalEventSupergroupDailyPayload | WorkflowActionExecutionCreateParams.CreateGcalEventSupergroupWeeklyPayload | WorkflowActionExecutionCreateParams.CreateGcalEventSupergroupMonthlyPayload | WorkflowActionExecutionCreateParams.CreateGcalEventSupergroupYearlyPayload | WorkflowActionExecutionCreateParams.SendTeamsPublicChannelMessagePayload | WorkflowActionExecutionCreateParams.SendTeamsSingleDirectMessagePayload | WorkflowActionExecutionCreateParams.AssignReviewReviewerRelativeToRevieweePayload | WorkflowActionExecutionCreateParams.AssignReviewReviewerRelativeToTriggerPayload | WorkflowActionExecutionCreateParams.SendReportSftpPasswordExcelPayload | WorkflowActionExecutionCreateParams.SendReportSftpPasswordCsvPayload | WorkflowActionExecutionCreateParams.SendReportSftpSSHKeyExcelPayload | WorkflowActionExecutionCreateParams.SendReportSftpSSHKeyCsvPayload | WorkflowActionExecutionCreateParams.RunQueryPayload;
+    workflow_definition_id?: string;
+}
+export declare namespace WorkflowActionExecutionCreateParams {
+    /**
+     * An action that sends an email.
+     * <helpdocslink href='https://help.rippling.com/article?articleId=69745350310'>Help
+     * docs</helpdocslink>
+     */
+    interface SendEmailPayload {
+        /**
+         * Email mode
+         */
+        action_type: 'INDIVIDUAL_EMAILS' | 'GROUP_EMAIL';
+        body: string;
+        send_to: SendEmailPayload.SendTo;
+        subject: string;
+        /**
+         * Maximum total attachment size: 20MB
+         */
+        attachments?: Array<SendEmailPayload.Attachment> | null;
+    }
+    namespace SendEmailPayload {
+        interface SendTo {
+            bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
+            cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
+            to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
+        }
+        namespace SendTo {
+            interface Recipient1 {
+                supergroup: Array<string>;
+                /**
+                 * Email type
+                 */
+                emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
+                externalEmails?: Array<string> | null;
+            }
+            interface Recipient2 {
+                externalEmails: Array<string>;
+                /**
+                 * Email type
+                 */
+                emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
+                supergroup?: Array<string> | null;
+            }
+            interface Recipient1 {
+                supergroup: Array<string>;
+                /**
+                 * Email type
+                 */
+                emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
+                externalEmails?: Array<string> | null;
+            }
+            interface Recipient2 {
+                externalEmails: Array<string>;
+                /**
+                 * Email type
+                 */
+                emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
+                supergroup?: Array<string> | null;
+            }
+            interface Recipient1 {
+                supergroup: Array<string>;
+                /**
+                 * Email type
+                 */
+                emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
+                externalEmails?: Array<string> | null;
+            }
+            interface Recipient2 {
+                externalEmails: Array<string>;
+                /**
+                 * Email type
+                 */
+                emailType?: 'work_or_personal_email' | 'work_email_only' | 'personal_email_only' | 'work_and_personal_email' | null;
+                supergroup?: Array<string> | null;
+            }
+        }
+        interface Attachment {
+            fileName: string;
+        }
+    }
+    /**
+     * An action that sends a slack message
+     * <helpdocslink href='https://help.rippling.com/article?articleId=921068789043'>Help
+     * docs</helpdocslink>
+     */
+    interface SendSlackSingleDirectMessagePayload {
+        action_type: 'SINGLE_DIRECT_MESSAGE';
+        /**
+         * Advanced formatting (Slack mentions, links, and channels) is supported through
+         * <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
+         * markup options</a>
+         */
+        body: string;
+        recipients: Array<string>;
+    }
+    /**
+     * An action that sends a slack message
+     * <helpdocslink href='https://help.rippling.com/article?articleId=921068789043'>Help
+     * docs</helpdocslink>
+     */
+    interface SendSlackGroupDirectMessagePayload {
+        action_type: 'GROUP_DIRECT_MESSAGE';
+        /**
+         * Advanced formatting (Slack mentions, links, and channels) is supported through
+         * <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
+         * markup options</a>
+         */
+        body: string;
+        recipients: Array<string>;
+    }
+    /**
+     * An action that sends a slack message
+     * <helpdocslink href='https://help.rippling.com/article?articleId=921068789043'>Help
+     * docs</helpdocslink>
+     */
+    interface SendSlackPublicChannelMessagePayload {
+        action_type: 'PUBLIC_CHANNEL_MESSAGE';
+        /**
+         * Advanced formatting (Slack mentions, links, and channels) is supported through
+         * <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
+         * markup options</a>
+         */
+        body: string;
+        channel: string;
+    }
+    /**
+     * An action that sends a slack message
+     * <helpdocslink href='https://help.rippling.com/article?articleId=921068789043'>Help
+     * docs</helpdocslink>
+     */
+    interface SendSlackPrivateChannelMessagePayload {
+        action_type: 'PRIVATE_CHANNEL_MESSAGE';
+        /**
+         * Advanced formatting (Slack mentions, links, and channels) is supported through
+         * <a href="https://help.rippling.com/article?articleId=921068789043#add-a-step-to-send-a-slack-message">Slack
+         * markup options</a>
+         */
+        body: string;
+        channel: string;
+    }
+    /**
+     * Assign tasks to configurable recipients
+     * <helpdocslink href='https://help.rippling.com/article?articleId=31954759021'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateAppNotificationPayload {
+        description: string;
+        recipients: Array<string>;
+        subject: string;
+        dueDate?: CreateAppNotificationPayload.DueDate | CreateAppNotificationPayload.DueDate1 | null;
+    }
+    namespace CreateAppNotificationPayload {
+        interface DueDate {
+            date: string;
+        }
+        interface DueDate1 {
+            daysFromNow: number;
+        }
+    }
+    /**
+     * An action that sends a text message.
+     * <helpdocslink href='https://help.rippling.com/article?articleId=750790843425'>Help
+     * docs</helpdocslink>
+     */
+    interface SendSMSPayload {
+        /**
+         * Maximum characters: 500
+         */
+        message: string;
+        recipients: Array<string>;
+    }
+    /**
+     * Sends a push notification to mobile devices. Recipients require the Rippling
+     * mobile app to receive this notification.
+     * <helpdocslink href='https://help.rippling.com/article?articleId=778925762874'>Help
+     * docs</helpdocslink>
+     */
+    interface SendPushNotificationPayload {
+        /**
+         * Maximum character count: 65
+         */
+        header: string;
+        /**
+         * In many devices, your description will be truncated after 178 characters.
+         */
+        message: string;
+        recipients: Array<string>;
+    }
+    /**
+     * An action that sends an HTTP request with a JSON payload. The following keys -
+     * Authorization, Api-Key, and Token - in URL query parameters and custom headers
+     * are masked due to their sensitive nature
+     * <helpdocslink href='https://help.rippling.com/article?articleId=441988386018'>Help
+     * docs</helpdocslink>
+     */
+    interface SendHTTPRequestPayload {
+        url: string;
+        customHTTPHeaders?: {
+            [key: string]: string;
+        } | null;
+        expectedResponseSchema?: unknown | null;
+        /**
+         * HTTP method
+         */
+        method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | null;
+        payload?: unknown | null;
+        queryParams?: {
+            [key: string]: string;
+        } | null;
+    }
+    /**
+     * An action that deletes a custom object record.
+     * <helpdocslink href='https://help.rippling.com/article?articleId=226426887042'>Help
+     * docs</helpdocslink>
+     */
+    interface DeleteCustomObjectRecordPayload {
+        customObjectAPIName: string;
+        recordID: string;
+    }
+    /**
+     * An action that sends a survey.
+     * <helpdocslink href='https://help.rippling.com/article?articleId=942946267690'>Help
+     * docs</helpdocslink>
+     */
+    interface SendSurveyPayload {
+        body: string;
+        recipients: Array<string>;
+        subject: string;
+        surveyID: string;
+        expiryDays?: number | null;
+    }
+    /**
+     * Query and retrieve specific records from Rippling
+     * <helpdocslink href='https://help.rippling.com/article?articleId=104232871210'>Help
+     * docs</helpdocslink>
+     */
+    interface EvaluateRqlSelectionPayload {
+        queryType: 'SELECTION';
+        rqlModelName?: string | null;
+    }
+    /**
+     * Query and retrieve specific records from Rippling
+     * <helpdocslink href='https://help.rippling.com/article?articleId=104232871210'>Help
+     * docs</helpdocslink>
+     */
+    interface EvaluateRqlQueryPayload {
+        queryType: 'QUERY';
+        /**
+         * Data type
+         */
+        dataType?: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'OBJECT_ID' | 'DATE' | 'DATETIME' | null;
+        isAList?: boolean | null;
+        rqlFormula?: EvaluateRqlQueryPayload.RqlFormula | null;
+    }
+    namespace EvaluateRqlQueryPayload {
+        interface RqlFormula {
+            rqlFormula?: string | null;
+        }
+    }
+    /**
+     * An action that creates a custom object record.
+     * <helpdocslink href='https://help.rippling.com/article?articleId=226426887042'>Help
+     * docs</helpdocslink>
+     */
+    interface UpsertCustomObjectPayload {
+        customObjectAPIName: string;
+    }
+    /**
+     * An action that updates a custom object record.
+     * <helpdocslink href='https://help.rippling.com/article?articleId=226426887042'>Help
+     * docs</helpdocslink>
+     */
+    interface UpdateCustomObjectRecordPayload {
+        customObjectAPIName: string;
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventWorkflowOwnerNullPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventWorkflowOwnerNullPayload.End;
+        organizer_type: 'WORKFLOW_OWNER';
+        recurrence_frequency: 'null';
+        spoke_owner: string;
+        start: CreateGcalEventWorkflowOwnerNullPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventWorkflowOwnerNullPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventWorkflowOwnerDailyPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventWorkflowOwnerDailyPayload.End;
+        organizer_type: 'WORKFLOW_OWNER';
+        recurrence_frequency: 'DAILY';
+        spoke_owner: string;
+        start: CreateGcalEventWorkflowOwnerDailyPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        recurrence_has_end?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventWorkflowOwnerDailyPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventWorkflowOwnerWeeklyPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventWorkflowOwnerWeeklyPayload.End;
+        organizer_type: 'WORKFLOW_OWNER';
+        recurrence_frequency: 'WEEKLY';
+        spoke_owner: string;
+        start: CreateGcalEventWorkflowOwnerWeeklyPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        recurrence_has_end?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventWorkflowOwnerWeeklyPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventWorkflowOwnerMonthlyPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventWorkflowOwnerMonthlyPayload.End;
+        organizer_type: 'WORKFLOW_OWNER';
+        recurrence_frequency: 'MONTHLY';
+        spoke_owner: string;
+        start: CreateGcalEventWorkflowOwnerMonthlyPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        recurrence_has_end?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventWorkflowOwnerMonthlyPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventWorkflowOwnerYearlyPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventWorkflowOwnerYearlyPayload.End;
+        organizer_type: 'WORKFLOW_OWNER';
+        recurrence_frequency: 'YEARLY';
+        spoke_owner: string;
+        start: CreateGcalEventWorkflowOwnerYearlyPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        recurrence_has_end?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventWorkflowOwnerYearlyPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventSupergroupNullPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventSupergroupNullPayload.End;
+        organizer: Array<string>;
+        organizer_type: 'SUPERGROUP';
+        recurrence_frequency: 'null';
+        spoke_owner: string;
+        start: CreateGcalEventSupergroupNullPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventSupergroupNullPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventSupergroupDailyPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventSupergroupDailyPayload.End;
+        organizer: Array<string>;
+        organizer_type: 'SUPERGROUP';
+        recurrence_frequency: 'DAILY';
+        spoke_owner: string;
+        start: CreateGcalEventSupergroupDailyPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        recurrence_has_end?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventSupergroupDailyPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventSupergroupWeeklyPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventSupergroupWeeklyPayload.End;
+        organizer: Array<string>;
+        organizer_type: 'SUPERGROUP';
+        recurrence_frequency: 'WEEKLY';
+        spoke_owner: string;
+        start: CreateGcalEventSupergroupWeeklyPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        recurrence_has_end?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventSupergroupWeeklyPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventSupergroupMonthlyPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventSupergroupMonthlyPayload.End;
+        organizer: Array<string>;
+        organizer_type: 'SUPERGROUP';
+        recurrence_frequency: 'MONTHLY';
+        spoke_owner: string;
+        start: CreateGcalEventSupergroupMonthlyPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        recurrence_has_end?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventSupergroupMonthlyPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * This action will create a Google Calendar event with the specified organizer and
+     * attendees
+     * <helpdocslink href='https://help.rippling.com/article?articleId=838646138324'>Help
+     * docs</helpdocslink>
+     */
+    interface CreateGcalEventSupergroupYearlyPayload {
+        attendees: Array<string>;
+        description: string;
+        end: CreateGcalEventSupergroupYearlyPayload.End;
+        organizer: Array<string>;
+        organizer_type: 'SUPERGROUP';
+        recurrence_frequency: 'YEARLY';
+        spoke_owner: string;
+        start: CreateGcalEventSupergroupYearlyPayload.Start;
+        timezone: string;
+        title: string;
+        all_day_event?: boolean | null;
+        guestsCanInviteOthers?: boolean | null;
+        guestsCanModify?: boolean | null;
+        guestsCanSeeOtherGuests?: boolean | null;
+        recurrence_has_end?: boolean | null;
+        /**
+         * Show me as
+         */
+        transparency?: 'opaque' | 'transparent' | null;
+        /**
+         * Calendar Visibility
+         */
+        visibility?: 'default' | 'public' | 'private' | null;
+    }
+    namespace CreateGcalEventSupergroupYearlyPayload {
+        interface End {
+            date: string;
+            time: string;
+        }
+        interface Start {
+            date: string;
+            time: string;
+        }
+    }
+    /**
+     * An action that sends a teams message
+     * <helpdocslink href='https://help.rippling.com/article?articleId=558988438231'>Help
+     * docs</helpdocslink>
+     */
+    interface SendTeamsPublicChannelMessagePayload {
+        action_type: 'PUBLIC_CHANNEL_MESSAGE';
+        message: string;
+        team_id?: string | null;
+    }
+    /**
+     * An action that sends a teams message
+     * <helpdocslink href='https://help.rippling.com/article?articleId=558988438231'>Help
+     * docs</helpdocslink>
+     */
+    interface SendTeamsSingleDirectMessagePayload {
+        action_type: 'SINGLE_DIRECT_MESSAGE';
+        message: string;
+        recipients?: Array<string> | null;
+    }
+    /**
+     * Select a cycle and reviewers for the employee that triggered the workflow
+     * <helpdocslink href='https://help.rippling.com/article?articleId=3VFYAFaak1JPA70SmmvUiI'>Help
+     * docs</helpdocslink>
+     */
+    interface AssignReviewReviewerRelativeToRevieweePayload {
+        cycle_id: string;
+        is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_REVIEWEE';
+        reviewees: Array<string>;
+        /**
+         * Maximum reviewees: 500
+         */
+        reviewers: Array<string>;
+    }
+    /**
+     * Select a cycle and reviewers for the employee that triggered the workflow
+     * <helpdocslink href='https://help.rippling.com/article?articleId=3VFYAFaak1JPA70SmmvUiI'>Help
+     * docs</helpdocslink>
+     */
+    interface AssignReviewReviewerRelativeToTriggerPayload {
+        cycle_id: string;
+        is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_TRIGGER';
+        reviewees: Array<string>;
+        /**
+         * Maximum reviewees: 500
+         */
+        reviewers: Array<string>;
+    }
+    /**
+     * Automatically generates a scheduled report and transfers it securely to a
+     * specified SFTP server
+     * <helpdocslink href='https://help.rippling.com/article?articleId=770718269869'>Help
+     * docs</helpdocslink>
+     */
+    interface SendReportSftpPasswordExcelPayload {
+        authentication_type: 'PASSWORD';
+        /**
+         * Specify the full path where the file should be stored on the remote server,
+         * starting from the root directory. Example: /rippling-workflows
+         */
+        file_path: string;
+        file_type: 'EXCEL';
+        /**
+         * sftp://username@[hostname]
+         */
+        host_name: string;
+        /**
+         * Not all report types are supported in workflows, like change and trend reports
+         */
+        report_id: string;
+        /**
+         * sftp://[username]@hostname
+         */
+        user_name: string;
+        add_role_referenced_id_column?: boolean | null;
+        /**
+         * CSV quoting
+         */
+        csv_quoting?: 1 | 0 | 2 | 3 | null;
+        /**
+         * Currency field formatting
+         */
+        currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+        /**
+         * Date & time formatting
+         */
+        date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+        /**
+         * Files will be automatically named if the file name is empty
+         */
+        file_name?: string | null;
+        /**
+         * File name suffix
+         */
+        file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
+        port?: number | null;
+        show_sub_totals?: boolean | null;
+        /**
+         * Time zones
+         */
+        time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
+    }
+    /**
+     * Automatically generates a scheduled report and transfers it securely to a
+     * specified SFTP server
+     * <helpdocslink href='https://help.rippling.com/article?articleId=770718269869'>Help
+     * docs</helpdocslink>
+     */
+    interface SendReportSftpPasswordCsvPayload {
+        authentication_type: 'PASSWORD';
+        /**
+         * Specify the full path where the file should be stored on the remote server,
+         * starting from the root directory. Example: /rippling-workflows
+         */
+        file_path: string;
+        file_type: 'CSV';
+        /**
+         * sftp://username@[hostname]
+         */
+        host_name: string;
+        /**
+         * Not all report types are supported in workflows, like change and trend reports
+         */
+        report_id: string;
+        /**
+         * sftp://[username]@hostname
+         */
+        user_name: string;
+        add_role_referenced_id_column?: boolean | null;
+        /**
+         * CSV quoting
+         */
+        csv_quoting?: 1 | 0 | 2 | 3 | null;
+        /**
+         * Custom separator
+         */
+        csv_separator?: ',' | ';' | '\t' | '|' | null;
+        /**
+         * Currency field formatting
+         */
+        currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+        /**
+         * Date & time formatting
+         */
+        date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+        /**
+         * Files will be automatically named if the file name is empty
+         */
+        file_name?: string | null;
+        /**
+         * File name suffix
+         */
+        file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
+        port?: number | null;
+        show_sub_totals?: boolean | null;
+        /**
+         * Time zones
+         */
+        time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
+    }
+    /**
+     * Automatically generates a scheduled report and transfers it securely to a
+     * specified SFTP server
+     * <helpdocslink href='https://help.rippling.com/article?articleId=770718269869'>Help
+     * docs</helpdocslink>
+     */
+    interface SendReportSftpSSHKeyExcelPayload {
+        authentication_type: 'SSH_KEY';
+        /**
+         * Specify the full path where the file should be stored on the remote server,
+         * starting from the root directory. Example: /rippling-workflows
+         */
+        file_path: string;
+        file_type: 'EXCEL';
+        /**
+         * sftp://username@[hostname]
+         */
+        host_name: string;
+        /**
+         * Not all report types are supported in workflows, like change and trend reports
+         */
+        report_id: string;
+        /**
+         * sftp://[username]@hostname
+         */
+        user_name: string;
+        add_role_referenced_id_column?: boolean | null;
+        /**
+         * CSV quoting
+         */
+        csv_quoting?: 1 | 0 | 2 | 3 | null;
+        /**
+         * Currency field formatting
+         */
+        currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+        /**
+         * Date & time formatting
+         */
+        date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+        /**
+         * Files will be automatically named if the file name is empty
+         */
+        file_name?: string | null;
+        /**
+         * File name suffix
+         */
+        file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
+        port?: number | null;
+        show_sub_totals?: boolean | null;
+        /**
+         * Time zones
+         */
+        time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
+    }
+    /**
+     * Automatically generates a scheduled report and transfers it securely to a
+     * specified SFTP server
+     * <helpdocslink href='https://help.rippling.com/article?articleId=770718269869'>Help
+     * docs</helpdocslink>
+     */
+    interface SendReportSftpSSHKeyCsvPayload {
+        authentication_type: 'SSH_KEY';
+        /**
+         * Specify the full path where the file should be stored on the remote server,
+         * starting from the root directory. Example: /rippling-workflows
+         */
+        file_path: string;
+        file_type: 'CSV';
+        /**
+         * sftp://username@[hostname]
+         */
+        host_name: string;
+        /**
+         * Not all report types are supported in workflows, like change and trend reports
+         */
+        report_id: string;
+        /**
+         * sftp://[username]@hostname
+         */
+        user_name: string;
+        add_role_referenced_id_column?: boolean | null;
+        /**
+         * CSV quoting
+         */
+        csv_quoting?: 1 | 0 | 2 | 3 | null;
+        /**
+         * Custom separator
+         */
+        csv_separator?: ',' | ';' | '\t' | '|' | null;
+        /**
+         * Currency field formatting
+         */
+        currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+        /**
+         * Date & time formatting
+         */
+        date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+        /**
+         * Files will be automatically named if the file name is empty
+         */
+        file_name?: string | null;
+        /**
+         * File name suffix
+         */
+        file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
+        port?: number | null;
+        show_sub_totals?: boolean | null;
+        /**
+         * Time zones
+         */
+        time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
+    }
+    interface RunQueryPayload {
+        query: string;
+        product_name?: string | null;
+    }
+}
+export declare namespace WorkflowActionExecutions {
+    export { type WorkflowActionExecutionCreateResponse as WorkflowActionExecutionCreateResponse, type WorkflowActionExecutionCreateParams as WorkflowActionExecutionCreateParams, };
+}
+//# sourceMappingURL=workflow-action-executions.d.ts.map