import { APIResource } from "../../core/resource.mjs"; import * as Shared from "../shared.mjs"; import { GroupMembersPageCursorURL } from "../shared.mjs"; import { APIPromise } from "../../core/api-promise.mjs"; import { PagePromise } from "../../core/pagination.mjs"; import { RequestOptions } from "../../internal/request-options.mjs"; /** * Supergroups used by the company */ export declare class ExclusionMembers extends APIResource { /** * Retrieve supergroup exclusion members matching the input parameters. * * - Requires: `API Tier 1` * - Expandable fields: `worker` * - Sortable fields: `id`, `created_at`, `updated_at` * * @example HTTP * Representative request and response shapes. * ``` * GET /supergroups/{group_id}/exclusion-members/?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", * "full_name": "string", * "work_email": "string", * "worker_id": "string", * "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": [] * } * } * ], * "next_link": "string" * } * ``` */ list(groupID: string, query?: ExclusionMemberListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Update the list of supergroup exclusion members. * * @example HTTP * Representative request and response shapes. * ``` * PATCH /supergroups/{group_id}/exclusion-members/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * {} * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "ok": false * } * ``` */ update(groupID: string, body?: ExclusionMemberUpdateParams | null | undefined, options?: RequestOptions): APIPromise; } export interface ExclusionMemberUpdateResponse { /** * Whether the operation succeeded. */ ok?: boolean; } export interface ExclusionMemberListParams { cursor?: string; expand?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; order_by?: string; } export interface ExclusionMemberUpdateParams { Operations?: Array; } export declare namespace ExclusionMemberUpdateParams { interface Operation { /** * add or remove */ op?: string; /** * The members to add or remove. */ value?: Array; } namespace Operation { interface Value { /** * A member id. */ id?: string; } } } export declare namespace ExclusionMembers { export { type ExclusionMemberUpdateResponse as ExclusionMemberUpdateResponse, type ExclusionMemberListParams as ExclusionMemberListParams, type ExclusionMemberUpdateParams as ExclusionMemberUpdateParams, }; } export { type GroupMembersPageCursorURL }; //# sourceMappingURL=exclusion-members.d.mts.map