import { APIResource } from "../../core/resource.mjs";
import * as BusinessPartnersAPI from "../business-partners.mjs";
import * as OffCycleAPI from "./off-cycle.mjs";
import { OffCycle, OffCycleCreateParams, OffCycleCreateResponse } from "./off-cycle.mjs";
import * as WorkerPayrollRecordsAPI from "./worker-payroll-records.mjs";
import { WorkerPayrollRecordListParams, WorkerPayrollRecordListResponse, WorkerPayrollRecordListResponsesPageCursorURL, WorkerPayrollRecords } from "./worker-payroll-records.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { PageCursorURL, PagePromise } from "../../core/pagination.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
/**
 * Payroll runs for the company
 */
export declare class PayrollRuns extends APIResource {
    offCycle: OffCycleAPI.OffCycle;
    workerPayrollRecords: WorkerPayrollRecordsAPI.WorkerPayrollRecords;
    /**
     * A list of payroll-runs.
     *
     * - Requires: `Global Payroll`
     * - Sortable fields: `check_date`
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * GET /payroll-runs/?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",
     *       "run_state": "string",
     *       "run_type": "string",
     *       "check_date": "string",
     *       "debit_date": "string",
     *       "title": "string",
     *       "approval_deadline": "string",
     *       "approved_at": "string",
     *       "paid_at": "string",
     *       "lock_deadline": "string",
     *       "pay_period": {
     *         "start_date": "string",
     *         "end_date": "string",
     *         "pay_frequency": "string"
     *       },
     *       "company_entity_id": "string",
     *       "country_code": "string",
     *       "payment_type": "string"
     *     }
     *   ],
     *   "next_link": "string"
     * }
     * ```
     */
    list(query?: PayrollRunListParams | null | undefined, options?: RequestOptions): PagePromise<PayrollRunListResponsesPageCursorURL, PayrollRunListResponse>;
    /**
     * Retrieve a specific payroll-run
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * GET /payroll-runs/{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<PayrollRunRetrieveResponse>;
}
export type PayrollRunListResponsesPageCursorURL = PageCursorURL<PayrollRunListResponse>;
/**
 * V2 DTO representing a single payroll run.
 *
 *     Used by:
 *       - GET /payroll-runs/      (list)
 *       - GET /payroll-runs/{id}  (retrieve)
 */
export interface PayrollRunListResponse {
    /**
     * Unique identifier for the payroll run.
     */
    id?: string;
    /**
     * Deadline for approving the payroll run.
     */
    approval_deadline?: string;
    /**
     * Timestamp when the run was approved.
     */
    approved_at?: string;
    /**
     * Date the paycheck is issued.
     */
    check_date?: string;
    /**
     * Identifier linking this payroll run to the company's legal entity in the HRIS
     * system.
     */
    company_entity_id?: string;
    /**
     * ISO country code where the payroll run applies.
     */
    country_code?: string;
    /**
     * Date funds are debited from the company's account.
     */
    debit_date?: string;
    /**
     * Deadline after which the run is locked for changes.
     */
    lock_deadline?: string;
    /**
     * Timestamp when the run was marked as paid.
     */
    paid_at?: string;
    /**
     * Pay period details for this run.
     */
    pay_period?: PayrollRunListResponse.PayPeriod;
    /**
     * Payment method used (e.g. WIRE, ACH).
     */
    payment_type?: string;
    /**
     * Current state of the run (e.g. DRAFT, PAID, APPROVED).
     */
    run_state?: string;
    /**
     * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
     */
    run_type?: string;
    /**
     * Human-readable title of the payroll run.
     */
    title?: string;
}
export declare namespace PayrollRunListResponse {
    /**
     * Pay period details for this run.
     */
    interface PayPeriod {
        /**
         * End date of the pay period.
         */
        end_date?: string;
        /**
         * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
         */
        pay_frequency?: string;
        /**
         * Start date of the pay period.
         */
        start_date?: string;
    }
}
/**
 * Meta information for the response.
 */
export interface PayrollRunRetrieveResponse extends BusinessPartnersAPI.Meta {
    /**
     * Unique identifier for the payroll run.
     */
    id?: string;
    /**
     * Deadline for approving the payroll run.
     */
    approval_deadline?: string;
    /**
     * Timestamp when the run was approved.
     */
    approved_at?: string;
    /**
     * Date the paycheck is issued.
     */
    check_date?: string;
    /**
     * Identifier linking this payroll run to the company's legal entity in the HRIS
     * system.
     */
    company_entity_id?: string;
    /**
     * ISO country code where the payroll run applies.
     */
    country_code?: string;
    /**
     * Date funds are debited from the company's account.
     */
    debit_date?: string;
    /**
     * Deadline after which the run is locked for changes.
     */
    lock_deadline?: string;
    /**
     * Timestamp when the run was marked as paid.
     */
    paid_at?: string;
    /**
     * Pay period details for this run.
     */
    pay_period?: PayrollRunRetrieveResponse.PayPeriod;
    /**
     * Payment method used (e.g. WIRE, ACH).
     */
    payment_type?: string;
    /**
     * Current state of the run (e.g. DRAFT, PAID, APPROVED).
     */
    run_state?: string;
    /**
     * Type of the run (e.g. REGULAR, OFF_CYCLE, CORRECTION).
     */
    run_type?: string;
    /**
     * Human-readable title of the payroll run.
     */
    title?: string;
}
export declare namespace PayrollRunRetrieveResponse {
    /**
     * Pay period details for this run.
     */
    interface PayPeriod {
        /**
         * End date of the pay period.
         */
        end_date?: string;
        /**
         * Pay frequency for this period (e.g. BI_WEEKLY, SEMI_MONTHLY, MONTHLY, WEEKLY).
         */
        pay_frequency?: string;
        /**
         * Start date of the pay period.
         */
        start_date?: string;
    }
}
export interface PayrollRunListParams {
    cursor?: string;
    /**
     * The maximum number of results to return. Defaults to 50. Maximum is 100.
     */
    limit?: number;
    order_by?: string;
}
export declare namespace PayrollRuns {
    export { type PayrollRunListResponse as PayrollRunListResponse, type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse, type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL, type PayrollRunListParams as PayrollRunListParams, };
    export { OffCycle as OffCycle, type OffCycleCreateResponse as OffCycleCreateResponse, type OffCycleCreateParams as OffCycleCreateParams, };
    export { WorkerPayrollRecords as WorkerPayrollRecords, type WorkerPayrollRecordListResponse as WorkerPayrollRecordListResponse, type WorkerPayrollRecordListResponsesPageCursorURL as WorkerPayrollRecordListResponsesPageCursorURL, type WorkerPayrollRecordListParams as WorkerPayrollRecordListParams, };
}
//# sourceMappingURL=payroll-runs.d.mts.map