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

package/resources/work-locations.d.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class WorkLocations extends APIResource {
     /**
-     * A List of work locations
+     * A list of work locations.
      *
      * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -24,7 +24,7 @@ export declare class WorkLocations extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<WorkLocationRetrieveResponse>;
     /**
-     * Updated a specific work location
+     * Update a specific work location.
      */
     update(id: string, body: WorkLocationUpdateParams, options?: RequestOptions): APIPromise<WorkLocation>;
     /**

package/resources/work-locations.js

@@ -11,7 +11,7 @@ const path_1 = require("../internal/utils/path.js");
  */
 class WorkLocations extends resource_1.APIResource {
     /**
-     * A List of work locations
+     * A list of work locations.
      *
      * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -32,7 +32,7 @@ class WorkLocations extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/work-locations/${id}/`, options);
     }
     /**
-     * Updated a specific work location
+     * Update a specific work location.
      */
     update(id, body, options) {
         return this._client.patch((0, path_1.path) `/work-locations/${id}/`, { body, ...options });

package/resources/work-locations.mjs

@@ -8,7 +8,7 @@ import { path } from "../internal/utils/path.mjs";
  */
 export class WorkLocations extends APIResource {
     /**
-     * A List of work locations
+     * A list of work locations.
      *
      * - Requires: `API Tier 1`
      * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -29,7 +29,7 @@ export class WorkLocations extends APIResource {
         return this._client.get(path `/work-locations/${id}/`, options);
     }
     /**
-     * Updated a specific work location
+     * Update a specific work location.
      */
     update(id, body, options) {
         return this._client.patch(path `/work-locations/${id}/`, { body, ...options });

package/resources/workers.d.mts

@@ -15,7 +15,7 @@ import { RequestOptions } from "../internal/request-options.mjs";
  */
 export declare class Workers extends APIResource {
     /**
-     * A List of workers
+     * A list of workers.
      *
      * - Requires: `API Tier 1`
      * - Filterable fields: `status`, `work_email`, `user_id`, `created_at`,

package/resources/workers.d.ts

@@ -15,7 +15,7 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class Workers extends APIResource {
     /**
-     * A List of workers
+     * A list of workers.
      *
      * - Requires: `API Tier 1`
      * - Filterable fields: `status`, `work_email`, `user_id`, `created_at`,

package/resources/workers.js

@@ -10,7 +10,7 @@ const path_1 = require("../internal/utils/path.js");
  */
 class Workers extends resource_1.APIResource {
     /**
-     * A List of workers
+     * A list of workers.
      *
      * - Requires: `API Tier 1`
      * - Filterable fields: `status`, `work_email`, `user_id`, `created_at`,

package/resources/workers.mjs

@@ -7,7 +7,7 @@ import { path } from "../internal/utils/path.mjs";
  */
 export class Workers extends APIResource {
     /**
-     * A List of workers
+     * A list of workers.
      *
      * - Requires: `API Tier 1`
      * - Filterable fields: `status`, `work_email`, `user_id`, `created_at`,

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

@@ -0,0 +1,572 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+/**
+ * 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 {
+        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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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';
+        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>
+     */
+    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: 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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>
+     */
+    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>;
+        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>;
+        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';
+        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>
+     */
+    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>
+     */
+    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>
+     */
+    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;
+    }
+    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.mts.map