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` */ list(query?: BusinessPartnerGroupListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Create a new business partner group */ create(body: BusinessPartnerGroupCreateParams, options?: RequestOptions): APIPromise; /** * Retrieve a specific business partner group */ retrieve(id: string, query?: BusinessPartnerGroupRetrieveParams | null | undefined, options?: RequestOptions): APIPromise; /** * Delete a business partner group */ 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; 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