// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../core/resource';
import * as BusinessPartnersAPI from './business-partners';
import { APIPromise } from '../core/api-promise';
import { PageCursorURL, PagePromise } from '../core/pagination';
import { RequestOptions } from '../internal/request-options';
import { path } from '../internal/utils/path';

/**
 * Organizational job categories that group similar roles and responsibilities within a company
 */
export class JobFunctions extends APIResource {
  /**
   * A list of job functions.
   *
   * - Requires: `API Tier 1`
   * - Sortable fields: `id`, `created_at`, `updated_at`
   */
  list(
    query: JobFunctionListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<JobFunctionListResponsesPageCursorURL, JobFunctionListResponse> {
    return this._client.getAPIList('/job-functions/', PageCursorURL<JobFunctionListResponse>, {
      query,
      ...options,
    });
  }

  /**
   * Retrieve a specific job function
   */
  retrieve(id: string, options?: RequestOptions): APIPromise<JobFunctionRetrieveResponse> {
    return this._client.get(path`/job-functions/${id}/`, options);
  }
}

export type JobFunctionListResponsesPageCursorURL = PageCursorURL<JobFunctionListResponse>;

export interface JobFunctionListResponse {
  /**
   * Identifier field
   */
  id: string;

  /**
   * Record creation date
   */
  created_at: string;

  /**
   * Record update date
   */
  updated_at: string;

  /**
   * Displayed name of the job function
   */
  name?: string;
}

/**
 * Meta information for the response.
 */
export interface JobFunctionRetrieveResponse extends BusinessPartnersAPI.Meta {
  /**
   * Identifier field
   */
  id: string;

  /**
   * Record creation date
   */
  created_at: string;

  /**
   * Record update date
   */
  updated_at: string;

  /**
   * Displayed name of the job function
   */
  name?: string;
}

export interface JobFunctionListParams {
  cursor?: string;

  order_by?: string;
}

export declare namespace JobFunctions {
  export {
    type JobFunctionListResponse as JobFunctionListResponse,
    type JobFunctionRetrieveResponse as JobFunctionRetrieveResponse,
    type JobFunctionListResponsesPageCursorURL as JobFunctionListResponsesPageCursorURL,
    type JobFunctionListParams as JobFunctionListParams,
  };
}