@rippling/rippling-sdk 0.2.0-alpha.32 → 0.2.0-alpha.34

package/src/resources/draft-hires.ts

@@ -118,6 +118,11 @@ export namespace DraftHireCreateParams {
      * Custom fields for the draft hire
      */
     custom_fields?: Array<DraftHire.CustomField>;
+
+    /**
+     * Documents to attach to this draft hire
+     */
+    documents?: Array<DraftHire.Document>;
   }
 
   export namespace DraftHire {
@@ -538,6 +543,27 @@ export namespace DraftHireCreateParams {
        */
       field_value: unknown;
     }
+
+    /**
+     * A document to attach to a draft hire, referencing a pre-uploaded file.
+     */
+    export interface Document {
+      /**
+       * Id of a FileUploadTracker in ACTIVE status whose file should become a document
+       * on the hire
+       */
+      file_id: string;
+
+      /**
+       * Document name. Defaults to the uploaded file name when omitted.
+       */
+      name?: string;
+
+      /**
+       * Signature date in YYYY-MM-DD format.
+       */
+      signature_date?: string;
+    }
   }
 }
 

package/src/resources/earnings-inputs.ts

@@ -1,8 +1,11 @@
 // 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 { PageCursorURL, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 /**
  * External earnings inputs for the company
@@ -18,6 +21,26 @@ export class EarningsInputs extends APIResource {
   ): PagePromise<EarningsInputListResponsesPageCursorURL, EarningsInputListResponse> {
     return this._client.getAPIList('/earnings-inputs/', PageCursorURL<EarningsInputListResponse>, options);
   }
+
+  /**
+   * Create a new earnings-input
+   */
+  create(
+    body: EarningsInputCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EarningsInputCreateResponse> {
+    return this._client.post('/earnings-inputs/', { body, ...options });
+  }
+
+  /**
+   * Delete a earnings-input
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/earnings-inputs/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
 }
 
 export type EarningsInputListResponsesPageCursorURL = PageCursorURL<EarningsInputListResponse>;
@@ -85,9 +108,126 @@ export interface EarningsInputListResponse {
   worker_id?: string;
 }
 
+/**
+ * V2 DTO representing an external earnings input record.
+ *
+ *     Used by:
+ *       - GET /earnings-inputs/  (list)
+ */
+export interface EarningsInputCreateResponse {
+  /**
+   * Unique identifier for the earnings input.
+   */
+  id?: string;
+
+  /**
+   * Earning amount as a string-encoded decimal.
+   */
+  amount?: string;
+
+  /**
+   * How the earning is assigned (e.g. BY_PAY_PERIOD).
+   */
+  assignment_type?: string;
+
+  /**
+   * Code identifying the earning type (e.g. regular_salary).
+   */
+  earning_code?: string;
+
+  /**
+   * External reference identifier for this earning.
+   */
+  external_id?: string;
+
+  /**
+   * Hours associated with this earning as a string-encoded decimal.
+   */
+  hours?: string;
+
+  /**
+   * The pay period basis date for this earning.
+   */
+  pay_period_basis_date?: string;
+
+  /**
+   * Identifier of the payroll run this earning is assigned to, if any.
+   */
+  run_id?: string;
+
+  /**
+   * Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).
+   */
+  status?: string;
+
+  /**
+   * Time tracking labels associated with this earning.
+   */
+  time_labels?: Array<string>;
+
+  /**
+   * Identifier of the worker (role ID).
+   */
+  worker_id?: string;
+}
+
+export interface EarningsInputCreateParams {
+  /**
+   * Earning amount as a string-encoded decimal.
+   */
+  amount?: string;
+
+  /**
+   * How the earning is assigned (e.g. BY_PAY_PERIOD).
+   */
+  assignment_type?: string;
+
+  /**
+   * Code identifying the earning type (e.g. regular_salary).
+   */
+  earning_code?: string;
+
+  /**
+   * External reference identifier for this earning.
+   */
+  external_id?: string;
+
+  /**
+   * Hours associated with this earning as a string-encoded decimal.
+   */
+  hours?: string;
+
+  /**
+   * The pay period basis date for this earning.
+   */
+  pay_period_basis_date?: string;
+
+  /**
+   * Identifier of the payroll run this earning is assigned to, if any.
+   */
+  run_id?: string;
+
+  /**
+   * Current status of the earnings input (e.g. UNASSIGNED, ASSIGNED).
+   */
+  status?: string;
+
+  /**
+   * Time tracking labels associated with this earning.
+   */
+  time_labels?: Array<string>;
+
+  /**
+   * Identifier of the worker (role ID).
+   */
+  worker_id?: string;
+}
+
 export declare namespace EarningsInputs {
   export {
     type EarningsInputListResponse as EarningsInputListResponse,
+    type EarningsInputCreateResponse as EarningsInputCreateResponse,
     type EarningsInputListResponsesPageCursorURL as EarningsInputListResponsesPageCursorURL,
+    type EarningsInputCreateParams as EarningsInputCreateParams,
   };
 }

package/src/resources/files.ts

@@ -0,0 +1,186 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Generate presigned URLs to upload files to Rippling storage
+ */
+export class Files extends APIResource {
+  /**
+   * Retrieve a specific file
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<FileRetrieveResponse> {
+    return this._client.get(path`/files/${id}/`, options);
+  }
+
+  /**
+   * Create a new file
+   */
+  create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileCreateResponse> {
+    return this._client.post('/files/', { body, ...options });
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface FileRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Opaque identifier for this file
+   */
+  id: string;
+
+  /**
+   * Lifecycle status: awaiting_upload | uploaded | active | infected
+   */
+  status: string;
+
+  /**
+   * MIME type supplied by the client at create time
+   */
+  content_type?: string;
+
+  /**
+   * Human-readable label for the file
+   */
+  display_name?: string;
+
+  /**
+   * Required form fields to include in the multipart POST to S3 alongside the file
+   * binary
+   */
+  upload_fields?: unknown;
+
+  /**
+   * S3 endpoint URL — POST your multipart form here to upload the file. Present only
+   * in the create response.
+   */
+  upload_url?: string;
+
+  /**
+   * URLs for accessing the uploaded file after a successful upload
+   */
+  url_data?: FileRetrieveResponse.URLData;
+}
+
+export namespace FileRetrieveResponse {
+  /**
+   * URLs for accessing the uploaded file after a successful upload
+   */
+  export interface URLData {
+    /**
+     * CDN URL for previewing the uploaded file after upload completes
+     */
+    preview_url?: string;
+
+    /**
+     * S3 URL where the file is accessible after upload
+     */
+    s3_url?: string;
+  }
+}
+
+/**
+ * Response DTO for `POST /files/` and `GET /files/{id}`.
+ */
+export interface FileCreateResponse {
+  /**
+   * Opaque identifier for this file
+   */
+  id: string;
+
+  /**
+   * Lifecycle status: awaiting_upload | uploaded | active | infected
+   */
+  status: string;
+
+  /**
+   * MIME type supplied by the client at create time
+   */
+  content_type?: string;
+
+  /**
+   * Human-readable label for the file
+   */
+  display_name?: string;
+
+  /**
+   * Required form fields to include in the multipart POST to S3 alongside the file
+   * binary
+   */
+  upload_fields?: unknown;
+
+  /**
+   * S3 endpoint URL — POST your multipart form here to upload the file. Present only
+   * in the create response.
+   */
+  upload_url?: string;
+
+  /**
+   * URLs for accessing the uploaded file after a successful upload
+   */
+  url_data?: FileCreateResponse.URLData;
+}
+
+export namespace FileCreateResponse {
+  /**
+   * URLs for accessing the uploaded file after a successful upload
+   */
+  export interface URLData {
+    /**
+     * CDN URL for previewing the uploaded file after upload completes
+     */
+    preview_url?: string;
+
+    /**
+     * S3 URL where the file is accessible after upload
+     */
+    s3_url?: string;
+  }
+}
+
+export interface FileCreateParams {
+  /**
+   * Lifecycle status: awaiting_upload | uploaded | active | infected
+   */
+  status: string;
+
+  /**
+   * MIME type supplied by the client at create time
+   */
+  content_type?: string;
+
+  /**
+   * Human-readable label for the file
+   */
+  display_name?: string;
+
+  /**
+   * Required form fields to include in the multipart POST to S3 alongside the file
+   * binary
+   */
+  upload_fields?: unknown;
+
+  /**
+   * S3 endpoint URL — POST your multipart form here to upload the file. Present only
+   * in the create response.
+   */
+  upload_url?: string;
+
+  /**
+   * URLs for accessing the uploaded file after a successful upload
+   */
+  url_data?: unknown;
+}
+
+export declare namespace Files {
+  export {
+    type FileRetrieveResponse as FileRetrieveResponse,
+    type FileCreateResponse as FileCreateResponse,
+    type FileCreateParams as FileCreateParams,
+  };
+}

package/src/resources/index.ts

@@ -112,6 +112,8 @@ export {
 export {
   EarningsInputs,
   type EarningsInputListResponse,
+  type EarningsInputCreateResponse,
+  type EarningsInputCreateParams,
   type EarningsInputListResponsesPageCursorURL,
 } from './earnings-inputs';
 export {
@@ -126,6 +128,7 @@ export {
   type EntitlementListResponse,
   type EntitlementListResponsesPageCursorURL,
 } from './entitlements';
+export { Files, type FileRetrieveResponse, type FileCreateResponse, type FileCreateParams } from './files';
 export {
   Functions,
   type Function,

package/src/resources/object-categories.ts

@@ -49,7 +49,7 @@ export class ObjectCategories extends APIResource {
   }
 
   /**
-   * Delete a object category.
+   * Delete an object category.
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/object-categories/${id}/`, {

package/src/resources/report-runs.ts

@@ -172,44 +172,44 @@ export namespace ReportRunCreateParams {
     field_id: string;
 
     /**
-     * Comparison operator for the filter. Single-value operators (eq, ne, gt, gte, lt,
-     * lte, starts_with, ends_with, contains, not_contains, before, after) require a
-     * scalar value. List operators (in, not_in) require a non-empty array. Range
-     * operators (between, not_between) require an object with 'from' and 'to' keys.
-     * No-value operators (is_empty, is_not_empty) do not require a value. Rolling-date
-     * operators (last_n, next_n) require an object with 'unit' (day, week, month,
-     * year) and 'n' (integer). Calendar-date operators (current_calendar,
-     * previous_calendar) require a unit string (day, week, month, quarter, year).
+     * Comparison operator for the filter. Single-value operators (EQ, NE, GT, GTE, LT,
+     * LTE, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, BEFORE, AFTER) require a
+     * scalar value. List operators (IN, NOT_IN) require a non-empty array. Range
+     * operators (BETWEEN, NOT_BETWEEN) require an object with 'from' and 'to' keys.
+     * No-value operators (IS_EMPTY, IS_NOT_EMPTY) do not require a value. Rolling-date
+     * operators (LAST_N, NEXT_N) require an object with 'unit' (DAY, WEEK, MONTH,
+     * YEAR) and 'n' (integer). Calendar-date operators (CURRENT_CALENDAR,
+     * PREVIOUS_CALENDAR) require a unit string (DAY, WEEK, MONTH, QUARTER, YEAR).
      */
     operator:
-      | 'eq'
-      | 'ne'
-      | 'in'
-      | 'not_in'
-      | 'starts_with'
-      | 'ends_with'
-      | 'contains'
-      | 'not_contains'
-      | 'gt'
-      | 'gte'
-      | 'lt'
-      | 'lte'
-      | 'between'
-      | 'not_between'
-      | 'is_empty'
-      | 'is_not_empty'
-      | 'before'
-      | 'after'
-      | 'last_n'
-      | 'next_n'
-      | 'current_calendar'
-      | 'previous_calendar';
+      | 'EQ'
+      | 'NE'
+      | 'IN'
+      | 'NOT_IN'
+      | 'STARTS_WITH'
+      | 'ENDS_WITH'
+      | 'CONTAINS'
+      | 'NOT_CONTAINS'
+      | 'GT'
+      | 'GTE'
+      | 'LT'
+      | 'LTE'
+      | 'BETWEEN'
+      | 'NOT_BETWEEN'
+      | 'IS_EMPTY'
+      | 'IS_NOT_EMPTY'
+      | 'BEFORE'
+      | 'AFTER'
+      | 'LAST_N'
+      | 'NEXT_N'
+      | 'CURRENT_CALENDAR'
+      | 'PREVIOUS_CALENDAR';
 
     /**
      * The filter value. Shape depends on the operator: scalar for single-value
      * operators; array for list operators; RangeValue object ({from, to}) for range
      * operators; RollingDateValue object ({unit, n}) for rolling-date operators; unit
-     * string for calendar-date operators; omitted or null for is_empty/is_not_empty.
+     * string for calendar-date operators; omitted or null for IS_EMPTY/IS_NOT_EMPTY.
      */
     value?: string | number | boolean | Array<unknown> | Filter.RangeValue | Filter.RollingDateValue | null;
   }
@@ -242,7 +242,7 @@ export namespace ReportRunCreateParams {
       /**
        * Unit of time for rolling/calendar date filters
        */
-      unit: 'day' | 'week' | 'month' | 'quarter' | 'year';
+      unit: 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
     }
   }
 

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

@@ -48,7 +48,8 @@ export interface WorkflowActionExecutionCreateParams {
     | 'enroll_into_learning_path'
     | 'report_email'
     | 'send_document'
-    | 'accrue_leave';
+    | 'accrue_leave'
+    | 'make_payment';
 
   /**
    * An action that sends an email.
@@ -102,6 +103,7 @@ export interface WorkflowActionExecutionCreateParams {
     | WorkflowActionExecutionCreateParams.SendDocumentPayload
     | WorkflowActionExecutionCreateParams.AccrueLeaveLeavePolicyPayload
     | WorkflowActionExecutionCreateParams.AccrueLeaveCompanyLeaveTypePayload
+    | WorkflowActionExecutionCreateParams.MakePaymentPayload
     | WorkflowActionExecutionCreateParams.RunQueryPayload;
 
   workflow_definition_id?: string;
@@ -2024,6 +2026,25 @@ export namespace WorkflowActionExecutionCreateParams {
     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.32'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.34'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.32";
+export declare const VERSION = "0.2.0-alpha.34";
 //# 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.32'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.34'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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