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"; /** * Break types configured by the company for time tracking */ export declare class BreakPolicies extends APIResource { /** * A list of break policies. * * - Requires: `API Tier 1` * - Sortable fields: `id`, `created_at`, `updated_at` * * @example HTTP * Representative request and response shapes. * ``` * GET /break-policies/?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", * "name": "string", * "country_code": "string", * "is_default": false * } * ], * "next_link": "string" * } * ``` */ list(query?: BreakPolicyListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Retrieve a specific break policy * * @example HTTP * Representative request and response shapes. * ``` * GET /break-policies/{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; } export type BreakPolicyListResponsesPageCursorURL = PageCursorURL; export interface BreakPolicyListResponse { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * The display name of the break policy. For default policies this is the * system-generated label (e.g. 'Default Break policy: All Workers | California'); * for custom policies this is the admin-provided description. */ name: string; /** * Record update date */ updated_at: string; /** * ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB'). */ country_code?: string; /** * Whether this is a system-seeded default policy (true) or a custom policy created * by an admin (false). */ is_default?: boolean; } /** * Meta information for the response. */ export interface BreakPolicyRetrieveResponse extends BusinessPartnersAPI.Meta { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * The display name of the break policy. For default policies this is the * system-generated label (e.g. 'Default Break policy: All Workers | California'); * for custom policies this is the admin-provided description. */ name: string; /** * Record update date */ updated_at: string; /** * ISO 3166-1 alpha-2 country code the policy applies to (e.g. 'US', 'CA', 'GB'). */ country_code?: string; /** * Whether this is a system-seeded default policy (true) or a custom policy created * by an admin (false). */ is_default?: boolean; } export interface BreakPolicyListParams { cursor?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; order_by?: string; } export declare namespace BreakPolicies { export { type BreakPolicyListResponse as BreakPolicyListResponse, type BreakPolicyRetrieveResponse as BreakPolicyRetrieveResponse, type BreakPolicyListResponsesPageCursorURL as BreakPolicyListResponsesPageCursorURL, type BreakPolicyListParams as BreakPolicyListParams, }; } //# sourceMappingURL=break-policies.d.mts.map