@rippling/rippling-sdk 0.2.0-alpha.25 → 0.2.0-alpha.27

package/src/resources/draft-hires.ts

@@ -5,6 +5,9 @@ import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Candidates who have not yet started work at the company
+ */
 export class DraftHires extends APIResource {
   /**
    * Create bulk draft hire
@@ -152,6 +155,13 @@ export namespace DraftHireCreateParams {
        */
       duties?: string;
 
+      /**
+       * EEOC job classification (e.g., EXECUTIVE, MID_LEVEL, PROFESSIONALS, TECHNICIANS,
+       * SALES_WORKERS, SUPPORT_WORKERS, CRAFT_WORKERS, OPERATIVES, HELPERS,
+       * SERVICE_WORKERS)
+       */
+      eeoc_job_classification?: string;
+
       /**
        * Equity number of shares
        */
@@ -359,6 +369,11 @@ export namespace DraftHireCreateParams {
        */
       locale?: PersonalInfo.Locale;
 
+      /**
+       * Personal phone number
+       */
+      personal_phone?: PersonalInfo.PersonalPhone;
+
       /**
        * Race of the candidate
        */
@@ -455,6 +470,26 @@ export namespace DraftHireCreateParams {
          */
         timezone?: string;
       }
+
+      /**
+       * Personal phone number
+       */
+      export interface PersonalPhone {
+        /**
+         * Country code for the phone number
+         */
+        country_code?: string;
+
+        /**
+         * Phone number extension
+         */
+        extension?: string;
+
+        /**
+         * National phone number without country code
+         */
+        national_number?: string;
+      }
     }
 
     /**

package/src/resources/employment-types.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Employment types used by the company
+ */
 export class EmploymentTypes extends APIResource {
   /**
    * A List of employment types

package/src/resources/entitlements.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Availability of API features to the company or Partners.
+ */
 export class Entitlements extends APIResource {
   /**
    * A List of entitlements

package/src/resources/functions/deployments.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Deployments extends APIResource {
   /**
    * A List of function deployments

package/src/resources/functions/executions.ts

@@ -6,6 +6,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Executions extends APIResource {
   /**
    * A List of function executions
@@ -17,10 +20,10 @@ export class Executions extends APIResource {
     functionAPIName: string,
     query: ExecutionListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ExecutionListResponsesPageCursorURL, ExecutionListResponse> {
+  ): PagePromise<FunctionExecutionsPageCursorURL, FunctionExecution> {
     return this._client.getAPIList(
       path`/functions/${functionAPIName}/executions/`,
-      PageCursorURL<ExecutionListResponse>,
+      PageCursorURL<FunctionExecution>,
       { query, ...options },
     );
   }
@@ -32,7 +35,7 @@ export class Executions extends APIResource {
     functionAPIName: string,
     body: ExecutionCreateParams,
     options?: RequestOptions,
-  ): APIPromise<ExecutionCreateResponse> {
+  ): APIPromise<FunctionExecution> {
     return this._client.post(path`/functions/${functionAPIName}/executions/`, { body, ...options });
   }
 
@@ -43,7 +46,7 @@ export class Executions extends APIResource {
     executionID: string,
     params: ExecutionRetrieveParams,
     options?: RequestOptions,
-  ): APIPromise<ExecutionRetrieveResponse> {
+  ): APIPromise<FunctionExecution> {
     const { function_api_name } = params;
     return this._client.get(path`/functions/${function_api_name}/executions/${executionID}/`, options);
   }
@@ -63,103 +66,9 @@ export class Executions extends APIResource {
   }
 }
 
-export type ExecutionListResponsesPageCursorURL = PageCursorURL<ExecutionListResponse>;
+export type FunctionExecutionsPageCursorURL = PageCursorURL<FunctionExecution>;
 
-export interface ExecutionListResponse {
-  /**
-   * Identifier field
-   */
-  id: string;
-
-  /**
-   * Record creation date
-   */
-  created_at: string;
-
-  /**
-   * The ID of the function this execution belongs to
-   */
-  function_id: string;
-
-  /**
-   * The inputs of the execution
-   */
-  inputs: unknown;
-
-  /**
-   * Record update date
-   */
-  updated_at: string;
-
-  /**
-   * The end time of the execution
-   */
-  finished_at?: string;
-
-  /**
-   * The outputs of the execution
-   */
-  outputs?: unknown;
-
-  /**
-   * The start time of the execution
-   */
-  started_at?: string;
-
-  /**
-   * The status of the execution
-   */
-  status?: string;
-}
-
-export interface ExecutionCreateResponse {
-  /**
-   * Identifier field
-   */
-  id: string;
-
-  /**
-   * Record creation date
-   */
-  created_at: string;
-
-  /**
-   * The ID of the function this execution belongs to
-   */
-  function_id: string;
-
-  /**
-   * The inputs of the execution
-   */
-  inputs: unknown;
-
-  /**
-   * Record update date
-   */
-  updated_at: string;
-
-  /**
-   * The end time of the execution
-   */
-  finished_at?: string;
-
-  /**
-   * The outputs of the execution
-   */
-  outputs?: unknown;
-
-  /**
-   * The start time of the execution
-   */
-  started_at?: string;
-
-  /**
-   * The status of the execution
-   */
-  status?: string;
-}
-
-export interface ExecutionRetrieveResponse {
+export interface FunctionExecution {
   /**
    * Identifier field
    */
@@ -260,11 +169,9 @@ export interface ExecutionListLogsParams {
 
 export declare namespace Executions {
   export {
-    type ExecutionListResponse as ExecutionListResponse,
-    type ExecutionCreateResponse as ExecutionCreateResponse,
-    type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
+    type FunctionExecution as FunctionExecution,
     type ExecutionListLogsResponse as ExecutionListLogsResponse,
-    type ExecutionListResponsesPageCursorURL as ExecutionListResponsesPageCursorURL,
+    type FunctionExecutionsPageCursorURL as FunctionExecutionsPageCursorURL,
     type ExecutionListParams as ExecutionListParams,
     type ExecutionCreateParams as ExecutionCreateParams,
     type ExecutionRetrieveParams as ExecutionRetrieveParams,

package/src/resources/functions/functions.ts

@@ -14,21 +14,22 @@ import {
 import * as ExecutionsAPI from './executions';
 import {
   ExecutionCreateParams,
-  ExecutionCreateResponse,
   ExecutionListLogsParams,
   ExecutionListLogsResponse,
   ExecutionListParams,
-  ExecutionListResponse,
-  ExecutionListResponsesPageCursorURL,
   ExecutionRetrieveParams,
-  ExecutionRetrieveResponse,
   Executions,
+  FunctionExecution,
+  FunctionExecutionsPageCursorURL,
 } from './executions';
 import { APIPromise } from '../../core/api-promise';
 import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Functions extends APIResource {
   deployments: DeploymentsAPI.Deployments = new DeploymentsAPI.Deployments(this._client);
   executions: ExecutionsAPI.Executions = new ExecutionsAPI.Executions(this._client);
@@ -120,6 +121,11 @@ export interface Function {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */
@@ -158,6 +164,11 @@ export interface FunctionCreateParams {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */
@@ -185,6 +196,11 @@ export interface FunctionUpdateParams {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */
@@ -216,11 +232,9 @@ export declare namespace Functions {
 
   export {
     Executions as Executions,
-    type ExecutionListResponse as ExecutionListResponse,
-    type ExecutionCreateResponse as ExecutionCreateResponse,
-    type ExecutionRetrieveResponse as ExecutionRetrieveResponse,
+    type FunctionExecution as FunctionExecution,
     type ExecutionListLogsResponse as ExecutionListLogsResponse,
-    type ExecutionListResponsesPageCursorURL as ExecutionListResponsesPageCursorURL,
+    type FunctionExecutionsPageCursorURL as FunctionExecutionsPageCursorURL,
     type ExecutionListParams as ExecutionListParams,
     type ExecutionCreateParams as ExecutionCreateParams,
     type ExecutionRetrieveParams as ExecutionRetrieveParams,

package/src/resources/functions/index.ts

@@ -11,15 +11,13 @@ export {
 } from './deployments';
 export {
   Executions,
-  type ExecutionListResponse,
-  type ExecutionCreateResponse,
-  type ExecutionRetrieveResponse,
+  type FunctionExecution,
   type ExecutionListLogsResponse,
   type ExecutionListParams,
   type ExecutionCreateParams,
   type ExecutionRetrieveParams,
   type ExecutionListLogsParams,
-  type ExecutionListResponsesPageCursorURL,
+  type FunctionExecutionsPageCursorURL,
 } from './executions';
 export {
   Functions,

package/src/resources/headcount-positions.ts

@@ -14,6 +14,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Headcount allocations for the company
+ */
 export class HeadcountPositions extends APIResource {
   /**
    * A List of headcount positions

package/src/resources/headcount-priorities.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Organizational classifications used to categorize hiring needs based on business urgency and strategic importance
+ */
 export class HeadcountPriorities extends APIResource {
   /**
    * A List of headcount priorities

package/src/resources/index.ts

@@ -33,6 +33,14 @@ export {
   type CandidateListResponsesPageCursorURL,
 } from './candidates';
 export { Companies, type Company, type CompanyListParams, type CompaniesPageCursorURL } from './companies';
+export {
+  CompensationBandsDetails,
+  type CompensationBandsDetailListResponse,
+  type CompensationBandsDetailRetrieveResponse,
+  type CompensationBandsDetailListParams,
+  type CompensationBandsDetailRetrieveParams,
+  type CompensationBandsDetailListResponsesPageCursorURL,
+} from './compensation-bands-details';
 export {
   Compensations,
   type Compensation,
@@ -41,6 +49,21 @@ export {
   type CompensationRetrieveParams,
   type CompensationsPageCursorURL,
 } from './compensations';
+export {
+  CreateAppNotification,
+  type CreateAppNotificationCreateResponse,
+  type CreateAppNotificationCreateParams,
+} from './create-app-notification';
+export {
+  CustomApps,
+  type CustomAppListResponse,
+  type CustomAppCreateResponse,
+  type CustomAppRetrieveResponse,
+  type CustomAppUpdateResponse,
+  type CustomAppCreateParams,
+  type CustomAppUpdateParams,
+  type CustomAppListResponsesPageCursorURL,
+} from './custom-apps';
 export {
   CustomFields,
   type CustomFieldListResponse,
@@ -54,12 +77,35 @@ export {
   type CustomObjectUpdateParams,
   type CustomObjectsPageCursorURL,
 } from './custom-objects/custom-objects';
+export {
+  CustomPages,
+  type CustomPageListResponse,
+  type CustomPageCreateResponse,
+  type CustomPageRetrieveResponse,
+  type CustomPageUpdateResponse,
+  type CustomPageCreateParams,
+  type CustomPageUpdateParams,
+  type CustomPageListResponsesPageCursorURL,
+} from './custom-pages';
+export {
+  CustomSettings,
+  type CustomSettingListResponse,
+  type CustomSettingCreateResponse,
+  type CustomSettingRetrieveResponse,
+  type CustomSettingUpdateResponse,
+  type CustomSettingListParams,
+  type CustomSettingCreateParams,
+  type CustomSettingUpdateParams,
+  type CustomSettingListResponsesPageCursorURL,
+} from './custom-settings';
 export {
   Departments,
   type Department,
   type DepartmentRetrieveResponse,
   type DepartmentListParams,
+  type DepartmentCreateParams,
   type DepartmentRetrieveParams,
+  type DepartmentUpdateParams,
   type DepartmentsPageCursorURL,
 } from './departments';
 export { DraftHires, type DraftHireCreateResponse, type DraftHireCreateParams } from './draft-hires';
@@ -105,7 +151,9 @@ export {
   type JobAssignment,
   type JobAssignmentRetrieveResponse,
   type JobAssignmentListParams,
+  type JobAssignmentCreateParams,
   type JobAssignmentRetrieveParams,
+  type JobAssignmentUpdateParams,
   type JobAssignmentListChangeLogParams,
   type AttributeChangeDetailsPageCursorURL,
   type JobAssignmentsPageCursorURL,
@@ -154,6 +202,11 @@ export {
   type JobRequisitionListParams,
   type JobRequisitionsPageCursorURL,
 } from './job-requisitions';
+export {
+  JobRequisitionsWrite,
+  type JobRequisitionsWriteCreateResponse,
+  type JobRequisitionsWriteCreateParams,
+} from './job-requisitions-write';
 export {
   KioskBadges,
   type TimeKioskBadge,
@@ -169,10 +222,13 @@ export {
 } from './kiosk-badges';
 export {
   LeaveAccruals,
-  type LeaveAccrualRetrieveResponse,
+  type LeaveAccrualListResponse,
   type LeaveAccrualCreateResponse,
-  type LeaveAccrualRetrieveParams,
+  type LeaveAccrualRetrieveResponse,
+  type LeaveAccrualListParams,
   type LeaveAccrualCreateParams,
+  type LeaveAccrualRetrieveParams,
+  type LeaveAccrualListResponsesPageCursorURL,
 } from './leave-accruals';
 export {
   LeaveBalances,
@@ -225,6 +281,11 @@ export {
   type LocationFactorListParams,
   type LocationFactorListResponsesPageCursorURL,
 } from './location-factors';
+export {
+  Metadata,
+  type MetadataListResponse,
+  type MetadataListResponsesPageCursorURL,
+} from './metadata/metadata';
 export {
   ObjectCategories,
   type ObjectCategory,
@@ -232,6 +293,18 @@ export {
   type ObjectCategoryUpdateParams,
   type ObjectCategoriesPageCursorURL,
 } from './object-categories';
+export {
+  PlatformCapabilities,
+  type PlatformCapabilityListResponse,
+  type PlatformCapabilityListResponsesPageCursorURL,
+} from './platform-capabilities';
+export {
+  ReportRuns,
+  type ReportRunCreateResponse,
+  type ReportRunRetrieveResponse,
+  type ReportRunCreateParams,
+} from './report-runs';
+export { RunQuery, type RunQueryCreateResponse, type RunQueryCreateParams } from './run-query';
 export { SSOMeResource, type SSOMe, type SSOMeRetrieveParams } from './sso-me';
 export {
   Schedules,
@@ -245,6 +318,13 @@ 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,
+  type ShiftAssignmentUpdateCustomfieldsParams,
+} from './shift-assignments';
 export {
   ShiftInputs,
   type ShiftInput,
@@ -307,6 +387,17 @@ export {
   type TimeEntryUpdateParams,
   type TimeEntryListResponsesPageCursorURL,
 } from './time-entries';
+export {
+  Titles,
+  type TitleListResponse,
+  type TitleCreateResponse,
+  type TitleRetrieveResponse,
+  type TitleUpdateResponse,
+  type TitleListParams,
+  type TitleCreateParams,
+  type TitleUpdateParams,
+  type TitleListResponsesPageCursorURL,
+} from './titles';
 export {
   Tracks,
   type Track,
@@ -314,14 +405,23 @@ export {
   type TrackListParams,
   type TracksPageCursorURL,
 } from './tracks';
+export {
+  UnassignedShifts,
+  type UnassignedShiftUpdateCustomfieldsResponse,
+  type UnassignedShiftAssignResponse,
+  type UnassignedShiftUpdateCustomfieldsParams,
+  type UnassignedShiftAssignParams,
+} from './unassigned-shifts';
 export {
   Unassignedshifts,
   type UnassignedshiftListResponse,
   type UnassignedshiftCreateResponse,
   type UnassignedshiftRetrieveResponse,
+  type UnassignedshiftUpdateResponse,
   type UnassignedshiftListParams,
   type UnassignedshiftCreateParams,
   type UnassignedshiftRetrieveParams,
+  type UnassignedshiftUpdateParams,
   type UnassignedshiftListResponsesPageCursorURL,
 } from './unassignedshifts';
 export {
@@ -336,6 +436,8 @@ export {
   type WorkLocation,
   type WorkLocationRetrieveResponse,
   type WorkLocationListParams,
+  type WorkLocationCreateParams,
+  type WorkLocationUpdateParams,
   type WorkLocationsPageCursorURL,
 } from './work-locations';
 export {