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

package/src/resources/custom-objects/records.ts

@@ -12,7 +12,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Records extends APIResource {
   /**
-   * A List of custom object records
+   * A list of custom object records.
    *
    * - Requires: `API Tier 1`
    */
@@ -28,7 +28,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Create a new custom object record
+   * Create a new custom object record.
    */
   create(
     customObjectAPIName: string,
@@ -39,7 +39,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * A List of custom object records filtered by querying
+   * A list of custom object records filtered by query.
    */
   query(
     customObjectAPIName: string,
@@ -53,7 +53,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Retrieve a specific custom object record
+   * Retrieve a specific custom object record.
    */
   retrieve(
     customObjectAPIName: string,
@@ -64,7 +64,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Updated a specific custom object record
+   * Update a specific custom object record.
    */
   update(
     customObjectAPIName: string,
@@ -79,7 +79,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Delete a custom object record
+   * Delete a custom object record.
    */
   delete(customObjectAPIName: string, codrID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/custom-objects/${customObjectAPIName}/records/${codrID}/`, {
@@ -89,7 +89,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Retrieve a specific custom object record by its external_id
+   * Retrieve a specific custom object record by its external_id.
    */
   retrieveByExternalID(
     customObjectAPIName: string,
@@ -103,7 +103,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * bulk create new custom object records
+   * Bulk create new custom object records.
    */
   bulkCreate(
     customObjectAPIName: string,
@@ -117,7 +117,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Bulk Updated a specific custom object records
+   * Bulk update custom object records.
    */
   bulkUpdate(
     customObjectAPIName: string,
@@ -131,7 +131,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Bulk Delete custom object records
+   * Bulk delete custom object records.
    */
   bulkDelete(
     customObjectAPIName: string,
@@ -180,6 +180,9 @@ export interface CustomObjectDataRow {
 
   owner_role?: CustomObjectDataRow.OwnerRole;
 
+  /**
+   * The timestamp when the record was last updated by the system.
+   */
   system_updated_at?: string;
 
   [k: string]: unknown;
@@ -187,26 +190,53 @@ export interface CustomObjectDataRow {
 
 export namespace CustomObjectDataRow {
   export interface CreatedBy {
+    /**
+     * The unique identifier of the role.
+     */
     id?: string;
 
+    /**
+     * The display name of the role.
+     */
     display_value?: string;
 
+    /**
+     * The URL of the role's profile image.
+     */
     image?: string;
   }
 
   export interface LastModifiedBy {
+    /**
+     * The unique identifier of the role.
+     */
     id?: string;
 
+    /**
+     * The display name of the role.
+     */
     display_value?: string;
 
+    /**
+     * The URL of the role's profile image.
+     */
     image?: string;
   }
 
   export interface OwnerRole {
+    /**
+     * The unique identifier of the role.
+     */
     id?: string;
 
+    /**
+     * The display name of the role.
+     */
     display_value?: string;
 
+    /**
+     * The URL of the role's profile image.
+     */
     image?: string;
   }
 }
@@ -236,32 +266,59 @@ export interface RecordBulkUpdateResponse {
 export type RecordCreateParams = { [key: string]: unknown };
 
 export interface RecordQueryParams {
+  /**
+   * A cursor for pagination to fetch the next page of results.
+   */
   cursor?: string;
 
+  /**
+   * The maximum number of results to return.
+   */
   limit?: number;
 
+  /**
+   * The query string to filter results.
+   */
   query?: string;
 }
 
 export type RecordUpdateParams = { [key: string]: unknown };
 
 export interface RecordBulkCreateParams {
+  /**
+   * If true, the entire operation fails if any record fails. If false, partial
+   * success is allowed.
+   */
   all_or_nothing?: boolean;
 
+  /**
+   * The list of records to create.
+   */
   rows_to_write?: Array<{ [key: string]: unknown }>;
 }
 
 export interface RecordBulkUpdateParams {
+  /**
+   * If true, the entire operation fails if any record fails. If false, partial
+   * success is allowed.
+   */
   all_or_nothing?: boolean;
 
+  /**
+   * The list of records to update.
+   */
   rows_to_update?: Array<{ [key: string]: unknown }>;
 }
 
 export interface RecordBulkDeleteParams {
+  /**
+   * If true, the entire operation fails if any record fails. If false, partial
+   * success is allowed.
+   */
   all_or_nothing?: boolean;
 
   /**
-   * a list of ids, e.g. [id_1, id_2].
+   * A list of record IDs to delete, e.g. [id_1, id_2].
    */
   rows_to_delete?: Array<string>;
 }

package/src/resources/custom-pages.ts

@@ -10,9 +10,9 @@ import { path } from '../internal/utils/path';
 
 export class CustomPages extends APIResource {
   /**
-   * A List of CustomPage
+   * A list of CustomPage.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Custom Apps Platform API`
    */
   list(options?: RequestOptions): PagePromise<CustomPageListResponsesPageCursorURL, CustomPageListResponse> {
     return this._client.getAPIList('/custom-pages/', PageCursorURL<CustomPageListResponse>, options);
@@ -36,7 +36,7 @@ export class CustomPages extends APIResource {
   }
 
   /**
-   * Updated a specific CustomPage
+   * Update a specific CustomPage.
    */
   update(
     id: string,

package/src/resources/custom-settings.ts

@@ -10,7 +10,7 @@ import { path } from '../internal/utils/path';
 
 export class CustomSettings extends APIResource {
   /**
-   * A List of Setting
+   * A list of Setting.
    *
    * - Requires: `Functions API`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -43,7 +43,7 @@ export class CustomSettings extends APIResource {
   }
 
   /**
-   * Updated a specific Setting
+   * Update a specific Setting.
    */
   update(
     id: string,

package/src/resources/departments.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class Departments extends APIResource {
   /**
-   * A List of departments
+   * A list of departments.
    *
    * - Requires: `API Tier 1`
    * - Expandable fields: `parent`, `department_hierarchy`
@@ -44,7 +44,7 @@ export class Departments extends APIResource {
   }
 
   /**
-   * Updated a specific department
+   * Update a specific department.
    */
   update(id: string, body: DepartmentUpdateParams, options?: RequestOptions): APIPromise<Department> {
     return this._client.patch(path`/departments/${id}/`, { body, ...options });

package/src/resources/draft-hires.ts

@@ -247,6 +247,11 @@ export namespace DraftHireCreateParams {
        */
       target_annual_bonus?: number;
 
+      /**
+       * Target annual bonus as a percentage
+       */
+      target_annual_bonus_percent?: number;
+
       /**
        * Teams IDs
        */
@@ -510,6 +515,11 @@ export namespace DraftHireCreateParams {
        * Work location ID
        */
       location_id?: string;
+
+      /**
+       * State code of the work location
+       */
+      state_code?: string;
     }
 
     /**

package/src/resources/earning-types.ts

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Earning types configured for the company
+ */
+export class EarningTypes extends APIResource {
+  /**
+   * A list of earning-types.
+   *
+   * - Requires: `Payroll API`
+   */
+  list(
+    options?: RequestOptions,
+  ): PagePromise<EarningTypeListResponsesPageCursorURL, EarningTypeListResponse> {
+    return this._client.getAPIList('/earning-types/', PageCursorURL<EarningTypeListResponse>, options);
+  }
+}
+
+export type EarningTypeListResponsesPageCursorURL = PageCursorURL<EarningTypeListResponse>;
+
+/**
+ * V2 DTO representing a company earning type.
+ *
+ *     Used by:
+ *       - GET /earning-types/  (list)
+ */
+export interface EarningTypeListResponse {
+  /**
+   * Unique identifier for the earning type.
+   */
+  id?: string;
+
+  /**
+   * Company entity relationship identifier (CER ID) linking the earning type to the
+   * HRIS legal entity.
+   */
+  company_entity_id?: string;
+
+  /**
+   * ISO country code where the earning type applies.
+   */
+  country_code?: string;
+
+  /**
+   * Human-readable name of the earning type.
+   */
+  display_name?: string;
+
+  /**
+   * Code identifying the earning type (e.g. regular_salary, commission).
+   */
+  earning_code?: string;
+}
+
+export declare namespace EarningTypes {
+  export {
+    type EarningTypeListResponse as EarningTypeListResponse,
+    type EarningTypeListResponsesPageCursorURL as EarningTypeListResponsesPageCursorURL,
+  };
+}

package/src/resources/employment-types.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class EmploymentTypes extends APIResource {
   /**
-   * A List of employment types
+   * A list of employment types.
    *
    * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/entitlements.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Entitlements extends APIResource {
   /**
-   * A List of entitlements
+   * A list of entitlements.
    *
    * - Requires: `API Tier 1`
    */

package/src/resources/functions/deployments.ts

@@ -10,7 +10,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Deployments extends APIResource {
   /**
-   * A List of function deployments
+   * A list of function deployments.
    *
    * - Requires: `API Tier 2`
    */
@@ -19,7 +19,7 @@ export class Deployments extends APIResource {
   }
 
   /**
-   * Create a new function deployment
+   * Create a new function deployment.
    */
   create(
     functionAPIName: string,
@@ -30,7 +30,7 @@ export class Deployments extends APIResource {
   }
 
   /**
-   * Retrieve a specific function deployment
+   * Retrieve a specific function deployment.
    */
   retrieve(
     deploymentID: string,
@@ -42,7 +42,7 @@ export class Deployments extends APIResource {
   }
 
   /**
-   * A List of function deployment logs
+   * A list of function deployment logs.
    *
    * - Requires: `API Tier 2`
    */
@@ -193,10 +193,16 @@ export interface DeploymentCreateParams {
 }
 
 export interface DeploymentRetrieveParams {
+  /**
+   * The API name of the function.
+   */
   function_api_name: string;
 }
 
 export interface DeploymentListLogsParams {
+  /**
+   * The API name of the function.
+   */
   function_api_name: string;
 }
 

package/src/resources/functions/executions.ts

@@ -11,7 +11,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Executions extends APIResource {
   /**
-   * A List of function executions
+   * A list of function executions.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -29,7 +29,7 @@ export class Executions extends APIResource {
   }
 
   /**
-   * Create a new function execution
+   * Create a new function execution.
    */
   create(
     functionAPIName: string,
@@ -40,7 +40,7 @@ export class Executions extends APIResource {
   }
 
   /**
-   * Retrieve a specific function execution
+   * Retrieve a specific function execution.
    */
   retrieve(
     executionID: string,
@@ -52,7 +52,7 @@ export class Executions extends APIResource {
   }
 
   /**
-   * A List of function execution logs
+   * A list of function execution logs.
    *
    * - Requires: `API Tier 2`
    */
@@ -160,10 +160,16 @@ export interface ExecutionCreateParams {
 }
 
 export interface ExecutionRetrieveParams {
+  /**
+   * The API name of the function.
+   */
   function_api_name: string;
 }
 
 export interface ExecutionListLogsParams {
+  /**
+   * The API name of the function.
+   */
   function_api_name: string;
 }
 

package/src/resources/functions/functions.ts

@@ -35,7 +35,7 @@ export class Functions extends APIResource {
   executions: ExecutionsAPI.Executions = new ExecutionsAPI.Executions(this._client);
 
   /**
-   * A List of functions
+   * A list of functions.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -48,14 +48,14 @@ export class Functions extends APIResource {
   }
 
   /**
-   * Create a new function
+   * Create a new function.
    */
   create(body: FunctionCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise<Function> {
     return this._client.post('/functions/', { body, ...options });
   }
 
   /**
-   * Retrieve a specific function
+   * Retrieve a specific function.
    */
   retrieve(functionAPIName: string, options?: RequestOptions): APIPromise<Function> {
     return this._client.get(path`/functions/${functionAPIName}/`, options);
@@ -73,13 +73,14 @@ export class Functions extends APIResource {
   }
 
   /**
-   * Create a new function dev bundle
+   * Create a new function dev bundle.
    */
   createDevBundle(
     functionAPIName: string,
+    body?: FunctionCreateDevBundleParams | null | undefined,
     options?: RequestOptions,
   ): APIPromise<FunctionCreateDevBundleResponse> {
-    return this._client.post(path`/functions/${functionAPIName}/dev_bundles/`, options);
+    return this._client.post(path`/functions/${functionAPIName}/dev_bundles/`, { body, ...options });
   }
 }
 
@@ -176,11 +177,6 @@ export interface FunctionCreateParams {
 }
 
 export interface FunctionUpdateParams {
-  /**
-   * The API name of the function
-   */
-  api_name?: string;
-
   /**
    * The current draft of code for the function
    */
@@ -196,17 +192,14 @@ export interface FunctionUpdateParams {
    */
   description?: string;
 
-  /**
-   * Whether this function runs asynchronously
-   */
-  is_async?: boolean;
-
   /**
    * The function name
    */
   name?: string;
 }
 
+export interface FunctionCreateDevBundleParams {}
+
 Functions.Deployments = Deployments;
 Functions.Executions = Executions;
 
@@ -218,6 +211,7 @@ export declare namespace Functions {
     type FunctionListParams as FunctionListParams,
     type FunctionCreateParams as FunctionCreateParams,
     type FunctionUpdateParams as FunctionUpdateParams,
+    type FunctionCreateDevBundleParams as FunctionCreateDevBundleParams,
   };
 
   export {

package/src/resources/functions/index.ts

@@ -26,5 +26,6 @@ export {
   type FunctionListParams,
   type FunctionCreateParams,
   type FunctionUpdateParams,
+  type FunctionCreateDevBundleParams,
   type FunctionsPageCursorURL,
 } from './functions';

package/src/resources/headcount-positions.ts

@@ -19,7 +19,7 @@ import { path } from '../internal/utils/path';
  */
 export class HeadcountPositions extends APIResource {
   /**
-   * A List of headcount positions
+   * A list of headcount positions.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `created_at`, `position_id`, `position_type`,

package/src/resources/headcount-priorities.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class HeadcountPriorities extends APIResource {
   /**
-   * A List of headcount priorities
+   * A list of headcount priorities.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/index.ts

@@ -49,11 +49,6 @@ export {
   type CompensationRetrieveParams,
   type CompensationsPageCursorURL,
 } from './compensations';
-export {
-  CreateAppNotification,
-  type CreateAppNotificationCreateResponse,
-  type CreateAppNotificationCreateParams,
-} from './create-app-notification';
 export {
   CustomApps,
   type CustomAppListResponse,
@@ -109,6 +104,11 @@ export {
   type DepartmentsPageCursorURL,
 } from './departments';
 export { DraftHires, type DraftHireCreateResponse, type DraftHireCreateParams } from './draft-hires';
+export {
+  EarningTypes,
+  type EarningTypeListResponse,
+  type EarningTypeListResponsesPageCursorURL,
+} from './earning-types';
 export {
   EmploymentTypes,
   type CompanyEmploymentType,
@@ -128,6 +128,7 @@ export {
   type FunctionListParams,
   type FunctionCreateParams,
   type FunctionUpdateParams,
+  type FunctionCreateDevBundleParams,
   type FunctionsPageCursorURL,
 } from './functions/functions';
 export {
@@ -293,6 +294,13 @@ export {
   type ObjectCategoryUpdateParams,
   type ObjectCategoriesPageCursorURL,
 } from './object-categories';
+export {
+  PayrollRuns,
+  type PayrollRunListResponse,
+  type PayrollRunRetrieveResponse,
+  type PayrollRunListParams,
+  type PayrollRunListResponsesPageCursorURL,
+} from './payroll-runs';
 export {
   PlatformCapabilities,
   type PlatformCapabilityListResponse,
@@ -304,7 +312,7 @@ export {
   type ReportRunRetrieveResponse,
   type ReportRunCreateParams,
 } from './report-runs';
-export { RunQuery, type RunQueryCreateResponse, type RunQueryCreateParams } from './run-query';
+export { Reports, type ReportRetrieveResponse } from './reports/reports';
 export { SSOMeResource, type SSOMe, type SSOMeListParams } from './sso-me';
 export {
   Schedules,
@@ -318,8 +326,6 @@ export {
   type ScheduleUpdateParams,
   type ScheduleListResponsesPageCursorURL,
 } from './schedules';
-export { SendEmail, type SendEmailCreateResponse, type SendEmailCreateParams } from './send-email';
-export { SendSlack, type SendSlackCreateResponse, type SendSlackCreateParams } from './send-slack';
 export {
   ShiftAssignments,
   type ShiftAssignmentUpdateCustomfieldsResponse,
@@ -448,3 +454,8 @@ export {
   type WorkerRetrieveParams,
   type WorkersPageCursorURL,
 } from './workers';
+export {
+  WorkflowActionExecutions,
+  type WorkflowActionExecutionCreateResponse,
+  type WorkflowActionExecutionCreateParams,
+} from './workflow-action-executions';

package/src/resources/job-assignments.ts

@@ -16,7 +16,7 @@ import { path } from '../internal/utils/path';
  */
 export class JobAssignments extends APIResource {
   /**
-   * A List of job assignments
+   * A list of job assignments.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `worker_id`, `job_code_id`
@@ -49,7 +49,7 @@ export class JobAssignments extends APIResource {
   }
 
   /**
-   * Updated a specific job assignment
+   * Update a specific job assignment.
    */
   update(id: string, body: JobAssignmentUpdateParams, options?: RequestOptions): APIPromise<JobAssignment> {
     return this._client.patch(path`/job-assignments/${id}/`, { body, ...options });
@@ -66,7 +66,7 @@ export class JobAssignments extends APIResource {
   }
 
   /**
-   * A List of attribute change logs
+   * A list of attribute change logs.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `changed_by_worker`