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

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

@@ -96,15 +96,133 @@ export namespace WorkflowActionExecutionCreateParams {
    * docs</helpdocslink>
    */
   export 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;
+  }
+
+  export namespace SendEmailPayload {
+    export interface SendTo {
+      bcc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
+
+      cc?: SendTo.Recipient1 | SendTo.Recipient2 | null;
+
+      to?: SendTo.Recipient1 | SendTo.Recipient2 | null;
+    }
+
+    export namespace SendTo {
+      export 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;
+      }
+
+      export 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;
+      }
+
+      export 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;
+      }
+
+      export 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;
+      }
+
+      export 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;
+      }
+
+      export 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;
+      }
+    }
+
+    export interface Attachment {
+      fileName: string;
+    }
   }
 
   /**
@@ -115,6 +233,11 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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>;
@@ -128,6 +251,11 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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>;
@@ -141,6 +269,11 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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;
@@ -154,6 +287,11 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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;
@@ -171,7 +309,17 @@ export namespace WorkflowActionExecutionCreateParams {
 
     subject: string;
 
-    dueDate?: unknown | null;
+    dueDate?: CreateAppNotificationPayload.DueDate | CreateAppNotificationPayload.DueDate1 | null;
+  }
+
+  export namespace CreateAppNotificationPayload {
+    export interface DueDate {
+      date: string;
+    }
+
+    export interface DueDate1 {
+      daysFromNow: number;
+    }
   }
 
   /**
@@ -180,6 +328,9 @@ export namespace WorkflowActionExecutionCreateParams {
    * docs</helpdocslink>
    */
   export interface SendSMSPayload {
+    /**
+     * Maximum characters: 500
+     */
     message: string;
 
     recipients: Array<string>;
@@ -192,8 +343,14 @@ export namespace WorkflowActionExecutionCreateParams {
    * docs</helpdocslink>
    */
   export interface SendPushNotificationPayload {
+    /**
+     * Maximum character count: 65
+     */
     header: string;
 
+    /**
+     * In many devices, your description will be truncated after 178 characters.
+     */
     message: string;
 
     recipients: Array<string>;
@@ -209,15 +366,18 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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;
   }
 
   /**
@@ -267,11 +427,20 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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;
+  }
+
+  export namespace EvaluateRqlQueryPayload {
+    export interface RqlFormula {
+      rqlFormula?: string | null;
+    }
   }
 
   /**
@@ -303,7 +472,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventWorkflowOwnerNullPayload.End;
 
     organizer_type: 'WORKFLOW_OWNER';
 
@@ -311,7 +480,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventWorkflowOwnerNullPayload.Start;
 
     timezone: string;
 
@@ -325,11 +494,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     guestsCanSeeOtherGuests?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventWorkflowOwnerNullPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -341,7 +530,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventWorkflowOwnerDailyPayload.End;
 
     organizer_type: 'WORKFLOW_OWNER';
 
@@ -349,7 +538,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventWorkflowOwnerDailyPayload.Start;
 
     timezone: string;
 
@@ -365,11 +554,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     recurrence_has_end?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventWorkflowOwnerDailyPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -381,7 +590,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventWorkflowOwnerWeeklyPayload.End;
 
     organizer_type: 'WORKFLOW_OWNER';
 
@@ -389,7 +598,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventWorkflowOwnerWeeklyPayload.Start;
 
     timezone: string;
 
@@ -405,11 +614,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     recurrence_has_end?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventWorkflowOwnerWeeklyPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -421,7 +650,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventWorkflowOwnerMonthlyPayload.End;
 
     organizer_type: 'WORKFLOW_OWNER';
 
@@ -429,7 +658,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventWorkflowOwnerMonthlyPayload.Start;
 
     timezone: string;
 
@@ -445,11 +674,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     recurrence_has_end?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventWorkflowOwnerMonthlyPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -461,7 +710,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventWorkflowOwnerYearlyPayload.End;
 
     organizer_type: 'WORKFLOW_OWNER';
 
@@ -469,7 +718,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventWorkflowOwnerYearlyPayload.Start;
 
     timezone: string;
 
@@ -485,11 +734,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     recurrence_has_end?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventWorkflowOwnerYearlyPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -501,7 +770,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventSupergroupNullPayload.End;
 
     organizer: Array<string>;
 
@@ -511,7 +780,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventSupergroupNullPayload.Start;
 
     timezone: string;
 
@@ -525,11 +794,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     guestsCanSeeOtherGuests?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventSupergroupNullPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -541,7 +830,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventSupergroupDailyPayload.End;
 
     organizer: Array<string>;
 
@@ -551,7 +840,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventSupergroupDailyPayload.Start;
 
     timezone: string;
 
@@ -567,11 +856,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     recurrence_has_end?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventSupergroupDailyPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -583,7 +892,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventSupergroupWeeklyPayload.End;
 
     organizer: Array<string>;
 
@@ -593,7 +902,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventSupergroupWeeklyPayload.Start;
 
     timezone: string;
 
@@ -609,11 +918,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     recurrence_has_end?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventSupergroupWeeklyPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -625,7 +954,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventSupergroupMonthlyPayload.End;
 
     organizer: Array<string>;
 
@@ -635,7 +964,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventSupergroupMonthlyPayload.Start;
 
     timezone: string;
 
@@ -651,11 +980,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     recurrence_has_end?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventSupergroupMonthlyPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * This action will create a Google Calendar event with the specified organizer and
    * attendees
@@ -667,7 +1016,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     description: string;
 
-    end: unknown;
+    end: CreateGcalEventSupergroupYearlyPayload.End;
 
     organizer: Array<string>;
 
@@ -677,7 +1026,7 @@ export namespace WorkflowActionExecutionCreateParams {
 
     spoke_owner: string;
 
-    start: unknown;
+    start: CreateGcalEventSupergroupYearlyPayload.Start;
 
     timezone: string;
 
@@ -693,11 +1042,31 @@ export namespace WorkflowActionExecutionCreateParams {
 
     recurrence_has_end?: boolean | null;
 
+    /**
+     * Show me as
+     */
     transparency?: 'opaque' | 'transparent' | null;
 
+    /**
+     * Calendar Visibility
+     */
     visibility?: 'default' | 'public' | 'private' | null;
   }
 
+  export namespace CreateGcalEventSupergroupYearlyPayload {
+    export interface End {
+      date: string;
+
+      time: string;
+    }
+
+    export interface Start {
+      date: string;
+
+      time: string;
+    }
+  }
+
   /**
    * An action that sends a teams message
    * <helpdocslink href='https://help.rippling.com/article?articleId=558988438231'>Help
@@ -736,6 +1105,9 @@ export namespace WorkflowActionExecutionCreateParams {
 
     reviewees: Array<string>;
 
+    /**
+     * Maximum reviewees: 500
+     */
     reviewers: Array<string>;
   }
 
@@ -751,6 +1123,9 @@ export namespace WorkflowActionExecutionCreateParams {
 
     reviewees: Array<string>;
 
+    /**
+     * Maximum reviewees: 500
+     */
     reviewers: Array<string>;
   }
 
@@ -763,32 +1138,63 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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;
   }
 
@@ -801,34 +1207,68 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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;
   }
 
@@ -841,32 +1281,63 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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;
   }
 
@@ -879,34 +1350,68 @@ export namespace WorkflowActionExecutionCreateParams {
   export 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;
   }