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

import { APIResource } from '../core/resource';
import { PageCursorURL, PagePromise } from '../core/pagination';
import { RequestOptions } from '../internal/request-options';

/**
 * Earning types configured for the company
 */
export class EarningTypes extends APIResource {
  /**
   * A list of earning-types.
   *
   * - Requires: `Global Payroll`
   */
  list(
    options?: RequestOptions,
  ): PagePromise<EarningTypeListResponsesPageCursorURL, EarningTypeListResponse> {
    return this._client.getAPIList('/earning-types/', PageCursorURL<EarningTypeListResponse>, options);
  }
}

export type EarningTypeListResponsesPageCursorURL = PageCursorURL<EarningTypeListResponse>;

/**
 * V2 DTO representing a company earning type.
 *
 *     Used by:
 *       - GET /earning-types/  (list)
 */
export interface EarningTypeListResponse {
  /**
   * Unique identifier for the earning type.
   */
  id?: string;

  /**
   * ISO country code where the earning type applies.
   */
  country_code?: string;

  /**
   * Human-readable name of the earning type.
   */
  display_name?: string;

  /**
   * Code identifying the earning type (e.g. regular_salary, commission).
   */
  earning_code?: string;
}

export declare namespace EarningTypes {
  export {
    type EarningTypeListResponse as EarningTypeListResponse,
    type EarningTypeListResponsesPageCursorURL as EarningTypeListResponsesPageCursorURL,
  };
}