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

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

@@ -43,7 +43,13 @@ export interface WorkflowActionExecutionCreateParams {
     | 'send_teams'
     | 'assign_review'
     | 'send_report_sftp'
-    | 'run_query';
+    | 'run_query'
+    | 'enroll_into_course'
+    | 'enroll_into_learning_path'
+    | 'report_email'
+    | 'send_document'
+    | 'accrue_leave'
+    | 'make_payment';
 
   /**
    * An action that sends an email.
@@ -84,6 +90,20 @@ export interface WorkflowActionExecutionCreateParams {
     | WorkflowActionExecutionCreateParams.SendReportSftpPasswordCsvPayload
     | WorkflowActionExecutionCreateParams.SendReportSftpSSHKeyExcelPayload
     | WorkflowActionExecutionCreateParams.SendReportSftpSSHKeyCsvPayload
+    | WorkflowActionExecutionCreateParams.EnrollIntoCourse1WeekPayload
+    | WorkflowActionExecutionCreateParams.EnrollIntoCourse2WeeksPayload
+    | WorkflowActionExecutionCreateParams.EnrollIntoCourse1MonthPayload
+    | WorkflowActionExecutionCreateParams.EnrollIntoCourse3MonthsPayload
+    | WorkflowActionExecutionCreateParams.EnrollIntoCourse6MonthsPayload
+    | WorkflowActionExecutionCreateParams.EnrollIntoCourse12MonthsPayload
+    | WorkflowActionExecutionCreateParams.EnrollIntoCourseCustomPayload
+    | WorkflowActionExecutionCreateParams.EnrollIntoLearningPathPayload
+    | WorkflowActionExecutionCreateParams.SendReportEmailExcelPayload
+    | WorkflowActionExecutionCreateParams.SendReportEmailCsvPayload
+    | WorkflowActionExecutionCreateParams.SendDocumentPayload
+    | WorkflowActionExecutionCreateParams.AccrueLeaveLeavePolicyPayload
+    | WorkflowActionExecutionCreateParams.AccrueLeaveCompanyLeaveTypePayload
+    | WorkflowActionExecutionCreateParams.MakePaymentPayload
     | WorkflowActionExecutionCreateParams.RunQueryPayload;
 
   workflow_definition_id?: string;
@@ -1415,6 +1435,616 @@ export namespace WorkflowActionExecutionCreateParams {
     time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
   }
 
+  /**
+   * Automatically enroll people into a course
+   */
+  export interface EnrollIntoCourse1WeekPayload {
+    /**
+     * Select a course to enroll people in
+     */
+    course_id: string;
+
+    due_date: '1_week';
+
+    /**
+     * Select people to enroll in this course
+     */
+    role_ids: Array<string>;
+
+    /**
+     * Skip enrollment if the employee already has a valid certificate for this course
+     */
+    skip_if_certified?: boolean | null;
+  }
+
+  /**
+   * Automatically enroll people into a course
+   */
+  export interface EnrollIntoCourse2WeeksPayload {
+    /**
+     * Select a course to enroll people in
+     */
+    course_id: string;
+
+    due_date: '2_weeks';
+
+    /**
+     * Select people to enroll in this course
+     */
+    role_ids: Array<string>;
+
+    /**
+     * Skip enrollment if the employee already has a valid certificate for this course
+     */
+    skip_if_certified?: boolean | null;
+  }
+
+  /**
+   * Automatically enroll people into a course
+   */
+  export interface EnrollIntoCourse1MonthPayload {
+    /**
+     * Select a course to enroll people in
+     */
+    course_id: string;
+
+    due_date: '1_month';
+
+    /**
+     * Select people to enroll in this course
+     */
+    role_ids: Array<string>;
+
+    /**
+     * Skip enrollment if the employee already has a valid certificate for this course
+     */
+    skip_if_certified?: boolean | null;
+  }
+
+  /**
+   * Automatically enroll people into a course
+   */
+  export interface EnrollIntoCourse3MonthsPayload {
+    /**
+     * Select a course to enroll people in
+     */
+    course_id: string;
+
+    due_date: '3_months';
+
+    /**
+     * Select people to enroll in this course
+     */
+    role_ids: Array<string>;
+
+    /**
+     * Skip enrollment if the employee already has a valid certificate for this course
+     */
+    skip_if_certified?: boolean | null;
+  }
+
+  /**
+   * Automatically enroll people into a course
+   */
+  export interface EnrollIntoCourse6MonthsPayload {
+    /**
+     * Select a course to enroll people in
+     */
+    course_id: string;
+
+    due_date: '6_months';
+
+    /**
+     * Select people to enroll in this course
+     */
+    role_ids: Array<string>;
+
+    /**
+     * Skip enrollment if the employee already has a valid certificate for this course
+     */
+    skip_if_certified?: boolean | null;
+  }
+
+  /**
+   * Automatically enroll people into a course
+   */
+  export interface EnrollIntoCourse12MonthsPayload {
+    /**
+     * Select a course to enroll people in
+     */
+    course_id: string;
+
+    due_date: '12_months';
+
+    /**
+     * Select people to enroll in this course
+     */
+    role_ids: Array<string>;
+
+    /**
+     * Skip enrollment if the employee already has a valid certificate for this course
+     */
+    skip_if_certified?: boolean | null;
+  }
+
+  /**
+   * Automatically enroll people into a course
+   */
+  export interface EnrollIntoCourseCustomPayload {
+    /**
+     * Select a course to enroll people in
+     */
+    course_id: string;
+
+    due_date: 'custom';
+
+    /**
+     * Select people to enroll in this course
+     */
+    role_ids: Array<string>;
+
+    /**
+     * Time unit
+     */
+    custom_due_duration?: 'day' | 'week' | 'month' | 'year' | null;
+
+    /**
+     * Number of days/weeks/months/years
+     */
+    custom_due_value?: number | null;
+
+    /**
+     * Skip enrollment if the employee already has a valid certificate for this course
+     */
+    skip_if_certified?: boolean | null;
+  }
+
+  /**
+   * Automatically enroll people into a learning path
+   */
+  export interface EnrollIntoLearningPathPayload {
+    /**
+     * Select a learning path to enroll people in
+     */
+    learning_path_id: string;
+
+    /**
+     * Select people to enroll in this learning path
+     */
+    role_ids: Array<string>;
+
+    /**
+     * Time unit
+     */
+    custom_due_unit?: 'day' | 'week' | 'month' | 'year' | null;
+
+    /**
+     * Number of days/weeks/months/years
+     */
+    custom_due_value?: number | null;
+
+    /**
+     * Number of days after completing one course before the next is due
+     */
+    days_between_courses?: number | null;
+
+    /**
+     * Due date type
+     */
+    due_date_type?: 'global' | 'relative' | null;
+
+    /**
+     * Due in
+     */
+    due_in?: '1_week' | '2_weeks' | '1_month' | '3_months' | '6_months' | '12_months' | 'custom' | null;
+
+    /**
+     * Give credit for courses the employee has already completed
+     */
+    induct_completed_enrollments?: boolean | null;
+
+    /**
+     * Skip enrollment if the employee already completed this learning path
+     */
+    skip_if_completed?: boolean | null;
+  }
+
+  /**
+   * Send Report via Email.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=382019482598'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendReportEmailExcelPayload {
+    file_type: 'EXCEL';
+
+    /**
+     * Not all report types are supported in workflows, like change and trend reports
+     */
+    report_id: string;
+
+    /**
+     * Whose report view should be used to generate this report? (Only the workflow
+     * owner's access level will be available if external emails are included.)
+     */
+    run_report_perms: 'RECIPIENT' | 'WORKFLOW_OWNER';
+
+    send_to: SendReportEmailExcelPayload.SendTo;
+
+    add_role_referenced_id_column?: boolean | null;
+
+    /**
+     * CSV quoting
+     */
+    csv_quoting?: 1 | 0 | 2 | 3 | null;
+
+    /**
+     * Currency field formatting
+     */
+    currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+
+    /**
+     * Date & time formatting
+     */
+    date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+
+    show_sub_totals?: boolean | null;
+
+    /**
+     * Time zones
+     */
+    time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
+  }
+
+  export namespace SendReportEmailExcelPayload {
+    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;
+      }
+    }
+  }
+
+  /**
+   * Send Report via Email.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=382019482598'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendReportEmailCsvPayload {
+    file_type: 'CSV';
+
+    /**
+     * Not all report types are supported in workflows, like change and trend reports
+     */
+    report_id: string;
+
+    /**
+     * Whose report view should be used to generate this report? (Only the workflow
+     * owner's access level will be available if external emails are included.)
+     */
+    run_report_perms: 'RECIPIENT' | 'WORKFLOW_OWNER';
+
+    send_to: SendReportEmailCsvPayload.SendTo;
+
+    add_role_referenced_id_column?: boolean | null;
+
+    /**
+     * CSV quoting
+     */
+    csv_quoting?: 1 | 0 | 2 | 3 | null;
+
+    /**
+     * Custom separator
+     */
+    csv_separator?: ',' | ';' | '\t' | '|' | null;
+
+    /**
+     * Currency field formatting
+     */
+    currency_fields?: 'WITH_CURRENCY_TYPE' | 'WITHOUT_CURRENCY_TYPE' | null;
+
+    /**
+     * Date & time formatting
+     */
+    date_and_time_formatting?: 'ISO_FORMAT' | 'LOCALE_FORMAT' | null;
+
+    show_sub_totals?: boolean | null;
+
+    /**
+     * Time zones
+     */
+    time_zones?: 'UTC' | 'PRESERVE_TZ' | 'VIEWER_LOCALE' | null;
+  }
+
+  export namespace SendReportEmailCsvPayload {
+    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;
+      }
+    }
+  }
+
+  /**
+   * Sends a document to employees
+   * <helpdocslink href='https://help.rippling.com/article?articleId=5M7eDUNcGIZndtJQv99mjW'>Help
+   * docs</helpdocslink>
+   */
+  export interface SendDocumentPayload {
+    document: string;
+
+    /**
+     * Maximum recipients: 500
+     */
+    recipients: Array<string>;
+  }
+
+  /**
+   * Adjust time off balance of a leave policy or a leave type
+   * <helpdocslink href='https://help.rippling.com/article?articleId=807953794978'>Help
+   * docs</helpdocslink>
+   */
+  export interface AccrueLeaveLeavePolicyPayload {
+    /**
+     * Choose how to adjust the employee's leave balance
+     */
+    balance_action_type: 'ADD_BALANCE' | 'DEDUCT_BALANCE';
+
+    balance_increment: number;
+
+    /**
+     * The unit of time to accrue leave in
+     */
+    balance_unit: 'HOURS' | 'DAYS' | 'WEEKS';
+
+    leave_policy: string;
+
+    pto_type: 'LEAVE_POLICY';
+
+    recipients: Array<string>;
+  }
+
+  /**
+   * Adjust time off balance of a leave policy or a leave type
+   * <helpdocslink href='https://help.rippling.com/article?articleId=807953794978'>Help
+   * docs</helpdocslink>
+   */
+  export interface AccrueLeaveCompanyLeaveTypePayload {
+    /**
+     * Choose how to adjust the employee's leave balance
+     */
+    balance_action_type: 'ADD_BALANCE' | 'DEDUCT_BALANCE';
+
+    balance_increment: number;
+
+    /**
+     * The unit of time to accrue leave in
+     */
+    balance_unit: 'HOURS' | 'DAYS' | 'WEEKS';
+
+    company_leave_type: string;
+
+    pto_type: 'COMPANY_LEAVE_TYPE';
+
+    recipients: Array<string>;
+  }
+
+  /**
+   * Send a payment to employee(s). This payment will be applied to the next upcoming
+   * payroll run.
+   * <helpdocslink href='https://help.rippling.com/article?articleId=2AcZ3Rsql2FVUy3ghiFCFt'>Help
+   * docs</helpdocslink>
+   */
+  export interface MakePaymentPayload {
+    /**
+     * Set a max amount that can be earned under this workflow
+     */
+    apply_cap: boolean;
+
+    description: string;
+
+    payment_amount: number;
+
+    recipients: Array<string>;
+  }
+
   export interface RunQueryPayload {
     query: string;
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.31'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.33'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.31";
+export declare const VERSION = "0.2.0-alpha.33";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.31";
+export declare const VERSION = "0.2.0-alpha.33";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.31'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.33'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.31'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.33'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map