@rippling/rippling-sdk 0.2.0-alpha.77 → 0.2.0-alpha.79

package/src/lib/manifest/custom-field.ts

@@ -68,38 +68,106 @@ export type CustomFieldDefaultValue =
   | { value: string; rqlDefinitionFormula?: never }
   | { value?: never; rqlDefinitionFormula: string };
 
-interface CustomFieldCommonProps {
+/** Properties shared by formula and user-input custom fields. */
+export interface CustomFieldBaseProps<ModelRqlName extends string = string> {
   fieldId?: string;
   name: string;
   section: CustomFieldSection;
-  modelRqlName: string;
+  modelRqlName: ModelRqlName;
   dataType: CustomFieldDataType;
   apiName: CustomFieldApiName;
+  description?: string | null;
+  displayOrder?: number | null;
+}
+
+type NonSensitiveCustomFieldPermissionClassification = Exclude<
+  CustomFieldPermissionClassification,
+  'SENSITIVE_PERSONAL_INFO' | 'SENSITIVE_EMPLOYMENT_INFO'
+>;
+
+/** Permission properties required for every Employee custom field. */
+export type EmployeeCustomFieldPermissionProps = { applicableGroup: string } & (
+  | {
+      fieldReadAccess: 'ALL_ACCESS';
+      fieldPermissionClassification: NonSensitiveCustomFieldPermissionClassification;
+    }
+  | {
+      fieldReadAccess: 'ADMIN_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS';
+      fieldPermissionClassification: CustomFieldPermissionClassification;
+    }
+);
+
+/** Optional permission properties used by non-Employee custom fields. */
+export interface NonEmployeeCustomFieldPermissionProps {
   fieldPermissionClassification?: CustomFieldPermissionClassification | null;
   fieldReadAccess?: CustomFieldReadAccess | null;
-  fieldWriteAccess?: CustomFieldWriteAccess | null;
   applicableGroup?: string | null;
-  description?: string | null;
-  displayOrder?: number | null;
 }
 
-export type CustomFieldProps = CustomFieldCommonProps &
-  (
-    | {
-        rqlDefinitionFormula: string;
-        collectDuring?: null;
-        required?: null;
-        tip?: null;
-        defaultValue?: null;
-      }
-    | {
-        rqlDefinitionFormula?: null;
-        collectDuring?: CustomFieldCollectionTiming | null;
-        required?: boolean | null;
-        tip?: string | null;
-        defaultValue?: CustomFieldDefaultValue | null;
-      }
-  );
+export type CustomFieldPermissionProps<ModelRqlName extends string = string> =
+  ModelRqlName extends 'Employee' ? EmployeeCustomFieldPermissionProps
+  : NonEmployeeCustomFieldPermissionProps;
+
+interface CustomFieldUserInputOptions {
+  rqlDefinitionFormula?: null;
+  required?: boolean | null;
+  tip?: string | null;
+  defaultValue?: CustomFieldDefaultValue | null;
+}
+
+type EmployeeCustomFieldUserInputAccess =
+  | {
+      collectDuring: 'ONBOARDING';
+      fieldReadAccess: 'ALL_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS';
+      fieldWriteAccess: 'EMPLOYEE_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS' | 'NO_ACCESS';
+    }
+  | {
+      collectDuring?: 'NONE' | 'HIRING' | 'TERMINATING' | null;
+      fieldWriteAccess: CustomFieldWriteAccess;
+    };
+
+interface NonEmployeeCustomFieldUserInputAccess {
+  collectDuring?: CustomFieldCollectionTiming | null;
+  fieldWriteAccess?: CustomFieldWriteAccess | null;
+}
+
+type CustomFieldUserInputAccess<ModelRqlName extends string> =
+  ModelRqlName extends 'Employee' ? EmployeeCustomFieldUserInputAccess
+  : NonEmployeeCustomFieldUserInputAccess;
+
+interface CustomFieldFormulaOptions {
+  rqlDefinitionFormula: string;
+  fieldWriteAccess: 'NO_ACCESS';
+  collectDuring?: null;
+  required?: null;
+  tip?: null;
+  defaultValue?: null;
+}
+
+/** A calculated custom field whose value cannot be edited directly. */
+export type FormulaCustomFieldProps<ModelRqlName extends string = string> =
+  CustomFieldBaseProps<ModelRqlName> & CustomFieldPermissionProps<ModelRqlName> & CustomFieldFormulaOptions;
+
+/** A custom field whose value is supplied by a user or a default value. */
+export type UserInputCustomFieldProps<ModelRqlName extends string = string> =
+  CustomFieldBaseProps<ModelRqlName> &
+    CustomFieldPermissionProps<ModelRqlName> &
+    CustomFieldUserInputOptions &
+    CustomFieldUserInputAccess<ModelRqlName>;
+
+/** A formula or user-input custom field on the given model. */
+export type CustomFieldProps<ModelRqlName extends string = string> =
+  | FormulaCustomFieldProps<ModelRqlName>
+  | UserInputCustomFieldProps<ModelRqlName>;
+
+/** A calculated Employee custom field. */
+export type EmployeeFormulaCustomFieldProps = FormulaCustomFieldProps<'Employee'>;
+
+/** An Employee custom field whose value is supplied by a user or a default value. */
+export type EmployeeUserInputCustomFieldProps = UserInputCustomFieldProps<'Employee'>;
+
+/** Any supported Employee custom field. */
+export type EmployeeCustomFieldProps = EmployeeFormulaCustomFieldProps | EmployeeUserInputCustomFieldProps;
 
 function cloneJson<T>(value: T): T {
   if (value == null) return value;
@@ -153,7 +221,7 @@ function customFieldDataTypeFromWire(dataType: Record<string, any>): CustomField
 }
 
 /** A Custom Field V2 field on a native or custom object. */
-export class CustomField {
+export class CustomField<const ModelRqlName extends string = string> {
   static readonly componentType = 'CUSTOM_FIELD_V2' as const;
 
   static toDeletionIdentifier(customFieldId: string): ManifestComponentDeletion {
@@ -161,9 +229,17 @@ export class CustomField {
   }
 
   private readonly _fieldId: string;
-  private readonly props: CustomFieldProps;
+  private readonly props: CustomFieldProps<ModelRqlName>;
 
-  constructor(scope: ManifestScope, props: CustomFieldProps) {
+  constructor(scope: ManifestScope, props: CustomFieldProps<ModelRqlName>) {
+    const runtimeProps = props as CustomFieldBaseProps<string> & {
+      fieldPermissionClassification?: CustomFieldPermissionClassification | null;
+      fieldReadAccess?: CustomFieldReadAccess | null;
+      fieldWriteAccess?: CustomFieldWriteAccess | null;
+      applicableGroup?: string | null;
+      collectDuring?: CustomFieldCollectionTiming | null;
+      rqlDefinitionFormula?: string | null;
+    };
     if (!props.apiName.endsWith('__cfv2')) {
       throw new Error(`Custom Field V2 api_name must end with __cfv2: ${props.apiName}`);
     }
@@ -173,11 +249,45 @@ export class CustomField {
           `but the field belongs to "${props.modelRqlName}".`,
       );
     }
+    if (runtimeProps.rqlDefinitionFormula != null && runtimeProps.fieldWriteAccess !== 'NO_ACCESS') {
+      throw new Error(`Formula custom field "${props.apiName}" must have fieldWriteAccess "NO_ACCESS".`);
+    }
+    if (props.modelRqlName === 'Employee') {
+      if (
+        runtimeProps.fieldPermissionClassification == null ||
+        runtimeProps.fieldReadAccess == null ||
+        runtimeProps.fieldWriteAccess == null ||
+        runtimeProps.applicableGroup == null
+      ) {
+        throw new Error(
+          `Employee custom field "${props.apiName}" requires fieldPermissionClassification, ` +
+            `fieldReadAccess, fieldWriteAccess, and applicableGroup.`,
+        );
+      }
+      if (
+        runtimeProps.fieldReadAccess === 'ALL_ACCESS' &&
+        (runtimeProps.fieldPermissionClassification === 'SENSITIVE_PERSONAL_INFO' ||
+          runtimeProps.fieldPermissionClassification === 'SENSITIVE_EMPLOYMENT_INFO')
+      ) {
+        throw new Error(
+          `Employee custom field "${props.apiName}" cannot use a sensitive permission classification ` +
+            `with fieldReadAccess "ALL_ACCESS".`,
+        );
+      }
+      if (
+        runtimeProps.collectDuring === 'ONBOARDING' &&
+        (runtimeProps.fieldReadAccess === 'ADMIN_ACCESS' || runtimeProps.fieldWriteAccess === 'ADMIN_ACCESS')
+      ) {
+        throw new Error(
+          `Employee onboarding custom field "${props.apiName}" must grant the employee read and write access.`,
+        );
+      }
+    }
     this._fieldId = props.fieldId ?? generateId('cfv2');
     this.props = {
       ...props,
       dataType: cloneJson(props.dataType),
-    };
+    } as CustomFieldProps<ModelRqlName>;
     scope._register(this);
   }
 
@@ -228,8 +338,12 @@ export class CustomField {
       displayOrder: (component['display_order'] as number | null | undefined) ?? null,
     };
     if (typeof formula === 'string') {
+      if (common.fieldWriteAccess != null && common.fieldWriteAccess !== 'NO_ACCESS') {
+        throw new TypeError(`Formula CUSTOM_FIELD_V2 field_write_access must be NO_ACCESS.`);
+      }
       return new CustomField(scope, {
         ...common,
+        fieldWriteAccess: 'NO_ACCESS',
         rqlDefinitionFormula: formula,
         collectDuring: null,
         required: null,

package/src/lib/manifest/index.ts

@@ -25,15 +25,24 @@ export {
   CustomField,
   CustomField as CustomFieldV2,
   type CustomFieldApiName,
+  type CustomFieldBaseProps,
   type CustomFieldCollectionTiming,
   type CustomFieldDataType,
   type CustomFieldDefaultValue,
   type CustomFieldPermissionClassification,
+  type CustomFieldPermissionProps,
   type CustomFieldProps,
   type CustomFieldReadAccess,
   type CustomFieldType,
   type CustomFieldUniqueIDCharacterType,
   type CustomFieldWriteAccess,
+  type EmployeeCustomFieldPermissionProps,
+  type EmployeeCustomFieldProps,
+  type EmployeeFormulaCustomFieldProps,
+  type EmployeeUserInputCustomFieldProps,
+  type FormulaCustomFieldProps,
+  type NonEmployeeCustomFieldPermissionProps,
+  type UserInputCustomFieldProps,
 } from './custom-field';
 
 export { CustomFieldSection, type CustomFieldSectionProps } from './custom-field-section';

package/src/resources/index.ts

@@ -314,6 +314,11 @@ export {
   type LeaveBalanceRetrieveParams,
   type LeaveBalancesPageCursorURL,
 } from './leave-balances';
+export {
+  LeaveProgramEvaluations,
+  type LeaveProgramEvaluationCreateResponse,
+  type LeaveProgramEvaluationCreateParams,
+} from './leave-program-evaluations';
 export {
   LeaveRequests,
   type LeaveRequest,

package/src/resources/leave-program-evaluations.ts

@@ -0,0 +1,88 @@
+// 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';
+
+/**
+ * Leave program evaluations produced by the leave rules engine
+ */
+export class LeaveProgramEvaluations extends APIResource {
+  /**
+   * Evaluate leave programs for an employee leave request.
+   */
+  create(
+    body: LeaveProgramEvaluationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<LeaveProgramEvaluationCreateResponse> {
+    return this._client.post('/leave-program-evaluations/', { body, ...options });
+  }
+}
+
+export interface LeaveProgramEvaluationCreateResponse {
+  /**
+   * Combined leave plan derived from all non-ineligible program results.
+   */
+  leave_plan: unknown;
+
+  /**
+   * Distinct evidence gaps reported by evaluated eligibility rules.
+   */
+  missing_evidence: Array<string>;
+
+  /**
+   * Per-program rule outputs in evaluation order.
+   */
+  program_results: Array<unknown>;
+}
+
+export interface LeaveProgramEvaluationCreateParams {
+  /**
+   * Requested leave start date.
+   */
+  claim_start_date: string;
+
+  /**
+   * Normalized leave reason to evaluate against statutory and custom leave programs.
+   */
+  leave_reason:
+    | 'BONDING'
+    | 'PREGNANCY_DISABILITY'
+    | 'PREGNANCY_ACCOMMODATION'
+    | 'MEDICAL'
+    | 'VACATION'
+    | 'OTHER';
+
+  /**
+   * Role ID for the employee whose leave request should be evaluated.
+   */
+  role_id: string;
+
+  /**
+   * Optional date the child entered the family for bonding leave programs.
+   */
+  child_entered_family_date?: string;
+
+  /**
+   * Optional parental leave relationship type for parental leave programs.
+   */
+  parental_leave_type?:
+    | 'birthing_parent'
+    | 'non_birthing_parent'
+    | 'adoption_parent'
+    | 'supporting_person'
+    | 'foster_parent';
+
+  /**
+   * Optional leave program codes to evaluate. When omitted, every registered leave
+   * program runs in dependency order.
+   */
+  program_codes?: Array<string>;
+}
+
+export declare namespace LeaveProgramEvaluations {
+  export {
+    type LeaveProgramEvaluationCreateResponse as LeaveProgramEvaluationCreateResponse,
+    type LeaveProgramEvaluationCreateParams as LeaveProgramEvaluationCreateParams,
+  };
+}

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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