// 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 * as WorkersAPI from './workers';
import { APIPromise } from '../core/api-promise';
import { PageCursorURL, PagePromise } from '../core/pagination';
import { RequestOptions } from '../internal/request-options';
import { path } from '../internal/utils/path';

/**
 * Compensation bands details associated with workers
 */
export class CompensationBandsDetails extends APIResource {
  /**
   * A list of compensation bands details.
   *
   * - Requires: `API Tier 1`
   * - Filterable fields: `created_at`, `updated_at`, `internal_job_code`,
   *   `worker_id`
   * - Expandable fields: `worker`
   * - Sortable fields: `id`, `created_at`, `updated_at`
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /compensation-bands-details/?filter=filter&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",
   *       "internal_job_code": "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(
    query: CompensationBandsDetailListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<CompensationBandsDetailListResponsesPageCursorURL, CompensationBandsDetailListResponse> {
    return this._client.getAPIList(
      '/compensation-bands-details/',
      PageCursorURL<CompensationBandsDetailListResponse>,
      { query, ...options },
    );
  }

  /**
   * Retrieve a specific compensation bands detail
   *
   * @example HTTP
   * Representative request and response shapes.
   * ```
   * GET /compensation-bands-details/{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: CompensationBandsDetailRetrieveParams | null | undefined = {},
    options?: RequestOptions,
  ): APIPromise<CompensationBandsDetailRetrieveResponse> {
    return this._client.get(path`/compensation-bands-details/${id}/`, { query, ...options });
  }
}

export type CompensationBandsDetailListResponsesPageCursorURL =
  PageCursorURL<CompensationBandsDetailListResponse>;

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

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

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

  /**
   * Internal job code
   */
  internal_job_code?: string;

  /**
   * The worker associated with compensation bands
   *
   * Expandable field
   */
  worker?: WorkersAPI.Worker;

  /**
   * ID of the worker associated with compensation bands
   */
  worker_id?: string;
}

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

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

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

  /**
   * Internal job code
   */
  internal_job_code?: string;

  /**
   * The worker associated with compensation bands
   *
   * Expandable field
   */
  worker?: WorkersAPI.Worker;

  /**
   * ID of the worker associated with compensation bands
   */
  worker_id?: string;
}

export interface CompensationBandsDetailListParams {
  cursor?: string;

  expand?: string;

  filter?: string;

  /**
   * The maximum number of results to return. Defaults to 50. Maximum is 100.
   */
  limit?: number;

  order_by?: string;
}

export interface CompensationBandsDetailRetrieveParams {
  expand?: string;
}

export declare namespace CompensationBandsDetails {
  export {
    type CompensationBandsDetailListResponse as CompensationBandsDetailListResponse,
    type CompensationBandsDetailRetrieveResponse as CompensationBandsDetailRetrieveResponse,
    type CompensationBandsDetailListResponsesPageCursorURL as CompensationBandsDetailListResponsesPageCursorURL,
    type CompensationBandsDetailListParams as CompensationBandsDetailListParams,
    type CompensationBandsDetailRetrieveParams as CompensationBandsDetailRetrieveParams,
  };
}