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

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

@@ -33,11 +33,77 @@ export declare namespace WorkflowActionExecutionCreateParams {
      * docs</helpdocslink>
      */
     interface SendEmailPayload {
+        /**
+         * Email mode
+         */
         action_type: 'INDIVIDUAL_EMAILS' | 'GROUP_EMAIL';
         body: string;
-        send_to: unknown;
+        send_to: SendEmailPayload.SendTo;
         subject: string;
-        attachments?: Array<unknown> | null;
+        /**
+         * 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
@@ -46,6 +112,11 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     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>;
     }
@@ -56,6 +127,11 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     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>;
     }
@@ -66,6 +142,11 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     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;
     }
@@ -76,6 +157,11 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     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;
     }
@@ -88,7 +174,15 @@ export declare namespace WorkflowActionExecutionCreateParams {
         description: string;
         recipients: Array<string>;
         subject: string;
-        dueDate?: unknown | null;
+        dueDate?: CreateAppNotificationPayload.DueDate | CreateAppNotificationPayload.DueDate1 | null;
+    }
+    namespace CreateAppNotificationPayload {
+        interface DueDate {
+            date: string;
+        }
+        interface DueDate1 {
+            daysFromNow: number;
+        }
     }
     /**
      * An action that sends a text message.
@@ -96,6 +190,9 @@ export declare namespace WorkflowActionExecutionCreateParams {
      * docs</helpdocslink>
      */
     interface SendSMSPayload {
+        /**
+         * Maximum characters: 500
+         */
         message: string;
         recipients: Array<string>;
     }
@@ -106,7 +203,13 @@ export declare namespace WorkflowActionExecutionCreateParams {
      * 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>;
     }
@@ -119,11 +222,18 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     interface SendHTTPRequestPayload {
         url: string;
-        customHTTPHeaders?: unknown | null;
+        customHTTPHeaders?: {
+            [key: string]: string;
+        } | null;
         expectedResponseSchema?: unknown | null;
+        /**
+         * HTTP method
+         */
         method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | null;
         payload?: unknown | null;
-        queryParams?: unknown | null;
+        queryParams?: {
+            [key: string]: string;
+        } | null;
     }
     /**
      * An action that deletes a custom object record.
@@ -162,9 +272,17 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     interface EvaluateRqlQueryPayload {
         queryType: 'QUERY';
+        /**
+         * Data type
+         */
         dataType?: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'OBJECT_ID' | 'DATE' | 'DATETIME' | null;
         isAList?: boolean | null;
-        rqlFormula?: unknown | null;
+        rqlFormula?: EvaluateRqlQueryPayload.RqlFormula | null;
+    }
+    namespace EvaluateRqlQueryPayload {
+        interface RqlFormula {
+            rqlFormula?: string | null;
+        }
     }
     /**
      * An action that creates a custom object record.
@@ -191,20 +309,36 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventWorkflowOwnerNullPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventWorkflowOwnerNullPayload.End;
         organizer_type: 'WORKFLOW_OWNER';
         recurrence_frequency: 'null';
         spoke_owner: string;
-        start: unknown;
+        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
@@ -214,11 +348,11 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventWorkflowOwnerDailyPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventWorkflowOwnerDailyPayload.End;
         organizer_type: 'WORKFLOW_OWNER';
         recurrence_frequency: 'DAILY';
         spoke_owner: string;
-        start: unknown;
+        start: CreateGcalEventWorkflowOwnerDailyPayload.Start;
         timezone: string;
         title: string;
         all_day_event?: boolean | null;
@@ -226,9 +360,25 @@ export declare namespace WorkflowActionExecutionCreateParams {
         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
@@ -238,11 +388,11 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventWorkflowOwnerWeeklyPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventWorkflowOwnerWeeklyPayload.End;
         organizer_type: 'WORKFLOW_OWNER';
         recurrence_frequency: 'WEEKLY';
         spoke_owner: string;
-        start: unknown;
+        start: CreateGcalEventWorkflowOwnerWeeklyPayload.Start;
         timezone: string;
         title: string;
         all_day_event?: boolean | null;
@@ -250,9 +400,25 @@ export declare namespace WorkflowActionExecutionCreateParams {
         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
@@ -262,11 +428,11 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventWorkflowOwnerMonthlyPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventWorkflowOwnerMonthlyPayload.End;
         organizer_type: 'WORKFLOW_OWNER';
         recurrence_frequency: 'MONTHLY';
         spoke_owner: string;
-        start: unknown;
+        start: CreateGcalEventWorkflowOwnerMonthlyPayload.Start;
         timezone: string;
         title: string;
         all_day_event?: boolean | null;
@@ -274,9 +440,25 @@ export declare namespace WorkflowActionExecutionCreateParams {
         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
@@ -286,11 +468,11 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventWorkflowOwnerYearlyPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventWorkflowOwnerYearlyPayload.End;
         organizer_type: 'WORKFLOW_OWNER';
         recurrence_frequency: 'YEARLY';
         spoke_owner: string;
-        start: unknown;
+        start: CreateGcalEventWorkflowOwnerYearlyPayload.Start;
         timezone: string;
         title: string;
         all_day_event?: boolean | null;
@@ -298,9 +480,25 @@ export declare namespace WorkflowActionExecutionCreateParams {
         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
@@ -310,21 +508,37 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventSupergroupNullPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventSupergroupNullPayload.End;
         organizer: Array<string>;
         organizer_type: 'SUPERGROUP';
         recurrence_frequency: 'null';
         spoke_owner: string;
-        start: unknown;
+        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
@@ -334,12 +548,12 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventSupergroupDailyPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventSupergroupDailyPayload.End;
         organizer: Array<string>;
         organizer_type: 'SUPERGROUP';
         recurrence_frequency: 'DAILY';
         spoke_owner: string;
-        start: unknown;
+        start: CreateGcalEventSupergroupDailyPayload.Start;
         timezone: string;
         title: string;
         all_day_event?: boolean | null;
@@ -347,9 +561,25 @@ export declare namespace WorkflowActionExecutionCreateParams {
         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
@@ -359,12 +589,12 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventSupergroupWeeklyPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventSupergroupWeeklyPayload.End;
         organizer: Array<string>;
         organizer_type: 'SUPERGROUP';
         recurrence_frequency: 'WEEKLY';
         spoke_owner: string;
-        start: unknown;
+        start: CreateGcalEventSupergroupWeeklyPayload.Start;
         timezone: string;
         title: string;
         all_day_event?: boolean | null;
@@ -372,9 +602,25 @@ export declare namespace WorkflowActionExecutionCreateParams {
         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
@@ -384,12 +630,12 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventSupergroupMonthlyPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventSupergroupMonthlyPayload.End;
         organizer: Array<string>;
         organizer_type: 'SUPERGROUP';
         recurrence_frequency: 'MONTHLY';
         spoke_owner: string;
-        start: unknown;
+        start: CreateGcalEventSupergroupMonthlyPayload.Start;
         timezone: string;
         title: string;
         all_day_event?: boolean | null;
@@ -397,9 +643,25 @@ export declare namespace WorkflowActionExecutionCreateParams {
         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
@@ -409,12 +671,12 @@ export declare namespace WorkflowActionExecutionCreateParams {
     interface CreateGcalEventSupergroupYearlyPayload {
         attendees: Array<string>;
         description: string;
-        end: unknown;
+        end: CreateGcalEventSupergroupYearlyPayload.End;
         organizer: Array<string>;
         organizer_type: 'SUPERGROUP';
         recurrence_frequency: 'YEARLY';
         spoke_owner: string;
-        start: unknown;
+        start: CreateGcalEventSupergroupYearlyPayload.Start;
         timezone: string;
         title: string;
         all_day_event?: boolean | null;
@@ -422,9 +684,25 @@ export declare namespace WorkflowActionExecutionCreateParams {
         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
@@ -454,6 +732,9 @@ export declare namespace WorkflowActionExecutionCreateParams {
         cycle_id: string;
         is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_REVIEWEE';
         reviewees: Array<string>;
+        /**
+         * Maximum reviewees: 500
+         */
         reviewers: Array<string>;
     }
     /**
@@ -465,6 +746,9 @@ export declare namespace WorkflowActionExecutionCreateParams {
         cycle_id: string;
         is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_TRIGGER';
         reviewees: Array<string>;
+        /**
+         * Maximum reviewees: 500
+         */
         reviewers: Array<string>;
     }
     /**
@@ -475,19 +759,50 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     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?: '1' | '0' | '2' | '3' | 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;
     }
     /**
@@ -498,20 +813,54 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     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?: '1' | '0' | '2' | '3' | 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;
     }
     /**
@@ -522,19 +871,50 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     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?: '1' | '0' | '2' | '3' | 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;
     }
     /**
@@ -545,20 +925,54 @@ export declare namespace WorkflowActionExecutionCreateParams {
      */
     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?: '1' | '0' | '2' | '3' | 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 {