import { APIResource } from "../core/resource.js"; import * as BusinessPartnersAPI from "./business-partners.js"; import * as JobAssignmentsAPI from "./job-assignments.js"; import { AttributeChangeDetailsPageCursorURL } from "./job-assignments.js"; import * as JobCodesAPI from "./job-codes.js"; import { APIPromise } from "../core/api-promise.js"; import { PageCursorURL, PagePromise } from "../core/pagination.js"; import { RequestOptions } from "../internal/request-options.js"; /** * Job related information for the company */ export declare class JobPayRateExceptions extends APIResource { /** * A list of job pay rate exceptions. * * - Requires: `API Tier 1` * - Filterable fields: `job_code_id` * - Expandable fields: `job_code` * - Sortable fields: `id`, `created_at`, `updated_at` * * @example HTTP * Representative request and response shapes. * ``` * GET /job-pay-rate-exceptions/?filter=filter&expand=expand&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", * "job_code_id": "string", * "job_code": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "job_dimension_id": "string", * "job_dimension": {}, * "external_id": "string", * "group_id": "string", * "custom_location": {}, * "work_location_id": "string", * "work_location": {}, * "department_id": "string", * "department": {}, * "pay_rate": "string", * "pay_rate_exceptions_id": [], * "pay_rate_exceptions": [], * "is_archived": "string" * }, * "exception_dimension_type": "JOB_CODE", * "exception_dimension_id": "string", * "pay_rate": 0 * } * ], * "next_link": "string" * } * ``` */ list(query?: JobPayRateExceptionListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Retrieve a specific job pay rate exception * * @example HTTP * Representative request and response shapes. * ``` * GET /job-pay-rate-exceptions/{id}/?expand=expand 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, query?: JobPayRateExceptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise; /** * A list of attribute change logs. * * - Requires: `API Tier 1` * - Expandable fields: `changed_by_worker` * - Sortable fields: `id` * * @example HTTP * Representative request and response shapes. * ``` * GET /job-pay-rate-exceptions/{job_pay_rate_exception_id}/change-log/?expand=expand&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", * "attribute_changes": [ * {} * ], * "changed_by_worker_id": "string", * "changed_by_worker": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "user_id": "string", * "user": {}, * "is_manager": "string", * "manager_id": "string", * "manager": {}, * "legal_entity_id": "string", * "legal_entity": {}, * "country": "AF", * "start_date": "string", * "end_date": "string", * "number": "string", * "work_email": "string", * "personal_email": "string", * "status": "INIT", * "location": {}, * "employment_type_id": "string", * "employment_type": {}, * "gender": "MALE", * "date_of_birth": "string", * "race": "BLACK", * "ethnicity": "HISPANIC_OR_LATINO", * "citizenship": "AF", * "compensation_id": "string", * "compensation": {}, * "overtime_exemption": "EXEMPT", * "department_id": "string", * "department": {}, * "teams_id": [], * "teams": [], * "title": "string", * "title_effective_date": "string", * "level_id": "string", * "level": {}, * "job_function_id": "string", * "job_function": {}, * "termination_details": {}, * "pay_schedule_id": "string", * "work_schedule": {}, * "compensation_grade": {}, * "original_start_date": "string", * "custom_fields": [], * "country_fields": {}, * "business_partners_id": [], * "business_partners": [] * }, * "reason": "string", * "effective_from_date": "string" * } * ], * "next_link": "string" * } * ``` */ listChangeLog(jobPayRateExceptionID: string, query?: JobPayRateExceptionListChangeLogParams | null | undefined, options?: RequestOptions): PagePromise; } export type JobPayRateExceptionsPageCursorURL = PageCursorURL; export interface JobPayRateException { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Identifier of dimension object on which exception is configured. This objects * details can be queried from exception_dimension_type's resource */ exception_dimension_id: string; /** * Identifier of Job for which exception is configured. */ job_code_id: string; /** * The pay rate for exception on job_code_id and exception_dimension_id combination */ pay_rate: number; /** * Record update date */ updated_at: string; /** * Type of dimension on which exception is configured */ exception_dimension_type?: 'JOB_CODE' | 'LEVEL' | 'TEAM' | 'DEPARTMENT' | 'WORK_LOCATION'; /** * Job for which exception is configured. * * Expandable field */ job_code?: JobCodesAPI.JobCode; } /** * Meta information for the response. */ export interface JobPayRateExceptionRetrieveResponse extends BusinessPartnersAPI.Meta, JobPayRateException { } export interface JobPayRateExceptionListParams { cursor?: string; expand?: string; filter?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; order_by?: string; } export interface JobPayRateExceptionRetrieveParams { expand?: string; } export interface JobPayRateExceptionListChangeLogParams { cursor?: string; expand?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; order_by?: string; } export declare namespace JobPayRateExceptions { export { type JobPayRateException as JobPayRateException, type JobPayRateExceptionRetrieveResponse as JobPayRateExceptionRetrieveResponse, type JobPayRateExceptionsPageCursorURL as JobPayRateExceptionsPageCursorURL, type JobPayRateExceptionListParams as JobPayRateExceptionListParams, type JobPayRateExceptionRetrieveParams as JobPayRateExceptionRetrieveParams, type JobPayRateExceptionListChangeLogParams as JobPayRateExceptionListChangeLogParams, }; } export { type AttributeChangeDetailsPageCursorURL }; //# sourceMappingURL=job-pay-rate-exceptions.d.ts.map