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

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

@@ -0,0 +1,925 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class WorkflowActionExecutions extends APIResource {
+  /**
+   * Execute a workflow action
+   */
+  create(
+    body: WorkflowActionExecutionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<WorkflowActionExecutionCreateResponse> {
+    return this._client.post('/workflow-action-executions/', { body, ...options });
+  }
+}
+
+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 namespace WorkflowActionExecutionCreateParams {
+  /**
+   * An action that sends an email.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=69745350310'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendEmailPayload {
+    action_type: 'INDIVIDUAL_EMAILS' | 'GROUP_EMAIL';
+
+    body: string;
+
+    send_to: unknown;
+
+    subject: string;
+
+    attachments?: Array<unknown> | null;
+  }
+
+  /**
+   * An action that sends a slack message
+   * <helpdocslink href='https://help.rippling.com/article?articleId=921068789043'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendSlackSingleDirectMessagePayload {
+    action_type: 'SINGLE_DIRECT_MESSAGE';
+
+    body: string;
+
+    recipients: Array<string>;
+  }
+
+  /**
+   * An action that sends a slack message
+   * <helpdocslink href='https://help.rippling.com/article?articleId=921068789043'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendSlackGroupDirectMessagePayload {
+    action_type: 'GROUP_DIRECT_MESSAGE';
+
+    body: string;
+
+    recipients: Array<string>;
+  }
+
+  /**
+   * An action that sends a slack message
+   * <helpdocslink href='https://help.rippling.com/article?articleId=921068789043'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendSlackPublicChannelMessagePayload {
+    action_type: 'PUBLIC_CHANNEL_MESSAGE';
+
+    body: string;
+
+    channel: string;
+  }
+
+  /**
+   * An action that sends a slack message
+   * <helpdocslink href='https://help.rippling.com/article?articleId=921068789043'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendSlackPrivateChannelMessagePayload {
+    action_type: 'PRIVATE_CHANNEL_MESSAGE';
+
+    body: string;
+
+    channel: string;
+  }
+
+  /**
+   * Assign tasks to configurable recipients
+   * <helpdocslink href='https://help.rippling.com/article?articleId=31954759021'>Help
+   * docs</helpdocslink>
+   */
+  export interface CreateAppNotificationPayload {
+    description: string;
+
+    recipients: Array<string>;
+
+    subject: string;
+
+    dueDate?: unknown | null;
+  }
+
+  /**
+   * An action that sends a text message.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=750790843425'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendSMSPayload {
+    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>
+   */
+  export interface SendPushNotificationPayload {
+    header: string;
+
+    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>
+   */
+  export interface SendHTTPRequestPayload {
+    url: string;
+
+    customHTTPHeaders?: unknown | null;
+
+    expectedResponseSchema?: unknown | null;
+
+    method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE' | null;
+
+    payload?: unknown | null;
+
+    queryParams?: unknown | null;
+  }
+
+  /**
+   * An action that deletes a custom object record.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=226426887042'>Help
+   * docs</helpdocslink>
+   */
+  export interface DeleteCustomObjectRecordPayload {
+    customObjectAPIName: string;
+
+    recordID: string;
+  }
+
+  /**
+   * An action that sends a survey.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=942946267690'>Help
+   * docs</helpdocslink>
+   */
+  export 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>
+   */
+  export 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>
+   */
+  export interface EvaluateRqlQueryPayload {
+    queryType: 'QUERY';
+
+    dataType?: 'STRING' | 'NUMBER' | 'BOOLEAN' | 'OBJECT_ID' | 'DATE' | 'DATETIME' | null;
+
+    isAList?: boolean | null;
+
+    rqlFormula?: unknown | null;
+  }
+
+  /**
+   * An action that creates a custom object record.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=226426887042'>Help
+   * docs</helpdocslink>
+   */
+  export interface UpsertCustomObjectPayload {
+    customObjectAPIName: string;
+  }
+
+  /**
+   * An action that updates a custom object record.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=226426887042'>Help
+   * docs</helpdocslink>
+   */
+  export 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>
+   */
+  export interface CreateGcalEventWorkflowOwnerNullPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer_type: 'WORKFLOW_OWNER';
+
+    recurrence_frequency: 'null';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventWorkflowOwnerDailyPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer_type: 'WORKFLOW_OWNER';
+
+    recurrence_frequency: 'DAILY';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    recurrence_has_end?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventWorkflowOwnerWeeklyPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer_type: 'WORKFLOW_OWNER';
+
+    recurrence_frequency: 'WEEKLY';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    recurrence_has_end?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventWorkflowOwnerMonthlyPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer_type: 'WORKFLOW_OWNER';
+
+    recurrence_frequency: 'MONTHLY';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    recurrence_has_end?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventWorkflowOwnerYearlyPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer_type: 'WORKFLOW_OWNER';
+
+    recurrence_frequency: 'YEARLY';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    recurrence_has_end?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventSupergroupNullPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer: Array<string>;
+
+    organizer_type: 'SUPERGROUP';
+
+    recurrence_frequency: 'null';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventSupergroupDailyPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer: Array<string>;
+
+    organizer_type: 'SUPERGROUP';
+
+    recurrence_frequency: 'DAILY';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    recurrence_has_end?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventSupergroupWeeklyPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer: Array<string>;
+
+    organizer_type: 'SUPERGROUP';
+
+    recurrence_frequency: 'WEEKLY';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    recurrence_has_end?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventSupergroupMonthlyPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer: Array<string>;
+
+    organizer_type: 'SUPERGROUP';
+
+    recurrence_frequency: 'MONTHLY';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    recurrence_has_end?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * 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>
+   */
+  export interface CreateGcalEventSupergroupYearlyPayload {
+    attendees: Array<string>;
+
+    description: string;
+
+    end: unknown;
+
+    organizer: Array<string>;
+
+    organizer_type: 'SUPERGROUP';
+
+    recurrence_frequency: 'YEARLY';
+
+    spoke_owner: string;
+
+    start: unknown;
+
+    timezone: string;
+
+    title: string;
+
+    all_day_event?: boolean | null;
+
+    guestsCanInviteOthers?: boolean | null;
+
+    guestsCanModify?: boolean | null;
+
+    guestsCanSeeOtherGuests?: boolean | null;
+
+    recurrence_has_end?: boolean | null;
+
+    transparency?: 'opaque' | 'transparent' | null;
+
+    visibility?: 'default' | 'public' | 'private' | null;
+  }
+
+  /**
+   * An action that sends a teams message
+   * <helpdocslink href='https://help.rippling.com/article?articleId=558988438231'>Help
+   * docs</helpdocslink>
+   */
+  export 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>
+   */
+  export 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>
+   */
+  export interface AssignReviewReviewerRelativeToRevieweePayload {
+    cycle_id: string;
+
+    is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_REVIEWEE';
+
+    reviewees: Array<string>;
+
+    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>
+   */
+  export interface AssignReviewReviewerRelativeToTriggerPayload {
+    cycle_id: string;
+
+    is_reviewer_relative_to_reviewee: 'REVIEWER_RELATIVE_TO_TRIGGER';
+
+    reviewees: Array<string>;
+
+    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>
+   */
+  export interface SendReportSftpPasswordExcelPayload {
+    authentication_type: 'PASSWORD';
+
+    file_path: string;
+
+    file_type: 'EXCEL';
+
+    host_name: string;
+
+    report_id: string;
+
+    user_name: string;
+
+    add_role_referenced_id_column?: boolean | null;
+
+    csv_quoting?: '1' | '0' | '2' | '3' | null;
+
+    currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+
+    date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+
+    file_name?: string | null;
+
+    file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
+
+    port?: number | null;
+
+    show_sub_totals?: boolean | null;
+
+    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>
+   */
+  export interface SendReportSftpPasswordCsvPayload {
+    authentication_type: 'PASSWORD';
+
+    file_path: string;
+
+    file_type: 'CSV';
+
+    host_name: string;
+
+    report_id: string;
+
+    user_name: string;
+
+    add_role_referenced_id_column?: boolean | null;
+
+    csv_quoting?: '1' | '0' | '2' | '3' | null;
+
+    csv_separator?: ',' | ';' | '\t' | '|' | null;
+
+    currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+
+    date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+
+    file_name?: string | null;
+
+    file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
+
+    port?: number | null;
+
+    show_sub_totals?: boolean | null;
+
+    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>
+   */
+  export interface SendReportSftpSSHKeyExcelPayload {
+    authentication_type: 'SSH_KEY';
+
+    file_path: string;
+
+    file_type: 'EXCEL';
+
+    host_name: string;
+
+    report_id: string;
+
+    user_name: string;
+
+    add_role_referenced_id_column?: boolean | null;
+
+    csv_quoting?: '1' | '0' | '2' | '3' | null;
+
+    currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+
+    date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+
+    file_name?: string | null;
+
+    file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
+
+    port?: number | null;
+
+    show_sub_totals?: boolean | null;
+
+    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>
+   */
+  export interface SendReportSftpSSHKeyCsvPayload {
+    authentication_type: 'SSH_KEY';
+
+    file_path: string;
+
+    file_type: 'CSV';
+
+    host_name: string;
+
+    report_id: string;
+
+    user_name: string;
+
+    add_role_referenced_id_column?: boolean | null;
+
+    csv_quoting?: '1' | '0' | '2' | '3' | null;
+
+    csv_separator?: ',' | ';' | '\t' | '|' | null;
+
+    currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+
+    date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+
+    file_name?: string | null;
+
+    file_suffix?: 'DEFAULT_FORMAT' | 'EPOCH_FORMAT' | 'NO_SUFFIX' | null;
+
+    port?: number | null;
+
+    show_sub_totals?: boolean | null;
+
+    time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
+  }
+
+  export interface RunQueryPayload {
+    query: string;
+
+    product_name?: string | null;
+  }
+}
+
+export declare namespace WorkflowActionExecutions {
+  export {
+    type WorkflowActionExecutionCreateResponse as WorkflowActionExecutionCreateResponse,
+    type WorkflowActionExecutionCreateParams as WorkflowActionExecutionCreateParams,
+  };
+}