import { APIResource } from "../core/resource.mjs"; import * as BusinessPartnersAPI from "./business-partners.mjs"; import { APIPromise } from "../core/api-promise.mjs"; import { PageCursorURL, PagePromise } from "../core/pagination.mjs"; import { RequestOptions } from "../internal/request-options.mjs"; /** * Job related information for the company */ export declare class ScheduledJobAssignments extends APIResource { /** * A list of scheduled job assignments. * * - Requires: `API Tier 1` * - Sortable fields: `id`, `created_at`, `updated_at`, `effective_from` * * @example HTTP * Representative request and response shapes. * ``` * GET /scheduled-job-assignments/?order_by=order_by&limit=50&cursor=cursor HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "__meta": { * "redacted_fields": [ * { * "name": "date_of_birth", * "reason": "Insufficient entitlements" * } * ] * }, * "results": [ * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "worker_id": "string", * "job_code_id": "string", * "job_dimension_id": "string", * "job_code_name": "string", * "job_dimension_name": "string", * "change_type": "ASSIGN", * "effective_from": "string", * "reason": "string", * "changed_by_id": "string", * "pay_rate": 0 * } * ], * "next_link": "string" * } * ``` */ list(query?: ScheduledJobAssignmentListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Retrieve a specific scheduled job assignment * * @example HTTP * Representative request and response shapes. * ``` * GET /scheduled-job-assignments/{id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "__meta": { * "redacted_fields": [ * {} * ] * } * } * ``` */ retrieve(id: string, options?: RequestOptions): APIPromise; /** * Delete a scheduled job assignment * * @example HTTP * Representative request and response shapes. * ``` * DELETE /scheduled-job-assignments/{id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 204 No Content * ``` */ delete(id: string, options?: RequestOptions): APIPromise; } export type ScheduledJobAssignmentListResponsesPageCursorURL = PageCursorURL; /** * Platform API DTO for a scheduled job assignment or unassignment change. */ export interface ScheduledJobAssignmentListResponse { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Record update date */ updated_at: string; /** * Type of scheduled change: ASSIGN or UNASSIGN. */ change_type?: 'ASSIGN' | 'UNASSIGN'; /** * The ID of the role that created this scheduled change. */ changed_by_id?: string; /** * When the scheduled change will be applied (ISO 8601). */ effective_from?: string; /** * The ID of the job code. */ job_code_id?: string; /** * Display name of the job code. */ job_code_name?: string; /** * The ID of the job dimension. */ job_dimension_id?: string; /** * Display name of the job dimension. */ job_dimension_name?: string; /** * New pay rate value, if the change includes a pay rate. */ pay_rate?: number; /** * Reason provided when the scheduled change was created. */ reason?: string; /** * The ID of the worker (role) the scheduled changes target. */ worker_id?: string; } /** * Meta information for the response. */ export interface ScheduledJobAssignmentRetrieveResponse extends BusinessPartnersAPI.Meta { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Record update date */ updated_at: string; /** * Type of scheduled change: ASSIGN or UNASSIGN. */ change_type?: 'ASSIGN' | 'UNASSIGN'; /** * The ID of the role that created this scheduled change. */ changed_by_id?: string; /** * When the scheduled change will be applied (ISO 8601). */ effective_from?: string; /** * The ID of the job code. */ job_code_id?: string; /** * Display name of the job code. */ job_code_name?: string; /** * The ID of the job dimension. */ job_dimension_id?: string; /** * Display name of the job dimension. */ job_dimension_name?: string; /** * New pay rate value, if the change includes a pay rate. */ pay_rate?: number; /** * Reason provided when the scheduled change was created. */ reason?: string; /** * The ID of the worker (role) the scheduled changes target. */ worker_id?: string; } export interface ScheduledJobAssignmentListParams { cursor?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; order_by?: string; } export declare namespace ScheduledJobAssignments { export { type ScheduledJobAssignmentListResponse as ScheduledJobAssignmentListResponse, type ScheduledJobAssignmentRetrieveResponse as ScheduledJobAssignmentRetrieveResponse, type ScheduledJobAssignmentListResponsesPageCursorURL as ScheduledJobAssignmentListResponsesPageCursorURL, type ScheduledJobAssignmentListParams as ScheduledJobAssignmentListParams, }; } //# sourceMappingURL=scheduled-job-assignments.d.mts.map