import { APIResource } from "../core/resource.mjs"; import * as BusinessPartnersAPI from "./business-partners.mjs"; import * as WorkersAPI from "./workers.mjs"; import { APIPromise } from "../core/api-promise.mjs"; import { PageCursorURL, PagePromise } from "../core/pagination.mjs"; import { RequestOptions } from "../internal/request-options.mjs"; /** * Business partners of the company */ export declare class BusinessPartnerGroups extends APIResource { /** * A list of business partner groups. * * - Requires: `API Tier 1` * - Expandable fields: `default_business_partner` * - Sortable fields: `id`, `created_at`, `updated_at` * * @example HTTP * Representative request and response shapes. * ``` * GET /business-partner-groups/?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", * "name": "string", * "domain": "HR", * "default_business_partner_id": "string", * "default_business_partner": { * "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(query?: BusinessPartnerGroupListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Create a new business partner group * * @example HTTP * Representative request and response shapes. * ``` * POST /business-partner-groups/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * { * "name": "name" * } * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "domain": "HR", * "default_business_partner_id": "string", * "default_business_partner": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "user_id": "string", * "user": { * "id": "string", * "created_at": "string", * "updated_at": "string" * }, * "is_manager": false, * "manager_id": "string", * "manager": { * "id": "string", * "created_at": "string", * "updated_at": "string" * }, * "legal_entity_id": "string", * "legal_entity": { * "id": "string", * "created_at": "string", * "updated_at": "string" * }, * "country": "AF", * "start_date": "string", * "end_date": "string", * "number": 0, * "work_email": "string", * "personal_email": "string", * "status": "INIT", * "location": { * "type": "REMOTE", * "work_location_id": "string" * }, * "employment_type_id": "string", * "employment_type": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "label": "string" * }, * "gender": "MALE", * "date_of_birth": "string", * "race": "BLACK", * "ethnicity": "HISPANIC_OR_LATINO", * "citizenship": "AF", * "compensation_id": "string", * "compensation": { * "id": "string", * "created_at": "string", * "updated_at": "string" * }, * "overtime_exemption": "EXEMPT", * "department_id": "string", * "department": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "parent_id": "string" * }, * "teams_id": [ * "string" * ], * "teams": [ * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "parent_id": "string", * "parent": {}, * "name": "string" * } * ], * "title": "string", * "title_effective_date": "string", * "level_id": "string", * "level": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "parent_id": "string", * "parent": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "parent_id": "string", * "parent": {}, * "global_level": "string", * "description": "string", * "scope_of_responsibilities": "string", * "experience_requirements": "string", * "rank": "string", * "track_id": "string", * "track": {} * }, * "global_level": 0, * "description": "string", * "scope_of_responsibilities": "string", * "experience_requirements": "string", * "rank": 0, * "track_id": "string", * "track": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "is_default": "string", * "order": "string", * "start_global_level": "string" * } * }, * "job_function_id": "string", * "job_function": { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string" * }, * "termination_details": { * "type": "VOLUNTARY", * "reason": "string" * }, * "pay_schedule_id": "string", * "work_schedule": {}, * "compensation_grade": { * "id": "string", * "label": "string" * }, * "original_start_date": "string", * "custom_fields": [ * null * ], * "country_fields": { * "us": { * "ssn": "string" * }, * "ca": { * "sin": "string" * }, * "nz": { * "ird_number": "string" * } * }, * "business_partners_id": [ * "string" * ], * "business_partners": [ * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "business_partner_group_id": "string", * "business_partner_group": {}, * "worker_id": "string", * "worker": {}, * "client_group_id": "string", * "client_group": {}, * "client_group_member_count": "string" * } * ] * } * } * ``` */ create(body: BusinessPartnerGroupCreateParams, options?: RequestOptions): APIPromise; /** * Retrieve a specific business partner group * * @example HTTP * Representative request and response shapes. * ``` * GET /business-partner-groups/{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?: BusinessPartnerGroupRetrieveParams | null | undefined, options?: RequestOptions): APIPromise; /** * Delete a business partner group * * @example HTTP * Representative request and response shapes. * ``` * DELETE /business-partner-groups/{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 BusinessPartnerGroupsPageCursorURL = PageCursorURL; export interface BusinessPartnerGroup { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Name used to identify business partner group */ name: string; /** * Record update date */ updated_at: string; /** * Optional default business partner worker to whom all employees will be mapped if * not explicitly mapped to a business partner in the group. * * Expandable field */ default_business_partner?: WorkersAPI.Worker; /** * Id of Optional default business partner worker to whom all employees will be * mapped if not explicitly mapped to a business partner in the group. */ default_business_partner_id?: string; /** * Type of business partner group */ domain?: 'HR' | 'IT' | 'FINANCE' | 'RECRUITING' | 'OTHER'; } /** * Meta information for the response. */ export interface BusinessPartnerGroupRetrieveResponse extends BusinessPartnersAPI.Meta, BusinessPartnerGroup { } export interface BusinessPartnerGroupListParams { cursor?: string; expand?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; order_by?: string; } export interface BusinessPartnerGroupCreateParams { /** * Name used to identify business partner group */ name: string; /** * Id of Optional default business partner worker to whom all employees will be * mapped if not explicitly mapped to a business partner in the group. */ default_business_partner_id?: string; /** * Type of business partner group */ domain?: 'HR' | 'IT' | 'FINANCE' | 'RECRUITING' | 'OTHER'; } export interface BusinessPartnerGroupRetrieveParams { expand?: string; } export declare namespace BusinessPartnerGroups { export { type BusinessPartnerGroup as BusinessPartnerGroup, type BusinessPartnerGroupRetrieveResponse as BusinessPartnerGroupRetrieveResponse, type BusinessPartnerGroupsPageCursorURL as BusinessPartnerGroupsPageCursorURL, type BusinessPartnerGroupListParams as BusinessPartnerGroupListParams, type BusinessPartnerGroupCreateParams as BusinessPartnerGroupCreateParams, type BusinessPartnerGroupRetrieveParams as BusinessPartnerGroupRetrieveParams, }; } //# sourceMappingURL=business-partner-groups.d.mts.map