@tryfinch/finch-api 5.4.1 → 5.5.0

package/src/_shims/index.d.ts

@@ -62,6 +62,8 @@ export type Readable = SelectType<manual.Readable, auto.Readable>;
 export type FsReadStream = SelectType<manual.FsReadStream, auto.FsReadStream>;
 // @ts-ignore
 export type ReadableStream = SelectType<manual.ReadableStream, auto.ReadableStream>;
+// @ts-ignore
+export const ReadableStream: SelectType<typeof manual.ReadableStream, typeof auto.ReadableStream>;
 
 export function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
   form: FormData,

package/src/_shims/node-runtime.ts

@@ -14,6 +14,9 @@ import { type RequestOptions } from '../core';
 import { MultipartBody } from './MultipartBody';
 import { type Shims } from './registry';
 
+// @ts-ignore (this package does not have proper export maps for this export)
+import { ReadableStream } from 'web-streams-polyfill/dist/ponyfill.es2018.js';
+
 type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
 
 let fileFromPathWarned = false;
@@ -59,8 +62,8 @@ async function getMultipartRequestOptions<T extends {} = Record<string, unknown>
 export function getRuntime(): Shims {
   // Polyfill global object if needed.
   if (typeof AbortController === 'undefined') {
-    // @ts-ignore
-    AbortController = AbortControllerPolyfill;
+    // @ts-expect-error (the types are subtly different, but compatible in practice)
+    globalThis.AbortController = AbortControllerPolyfill;
   }
   return {
     kind: 'node',
@@ -71,6 +74,7 @@ export function getRuntime(): Shims {
     FormData: fd.FormData,
     Blob: fd.Blob,
     File: fd.File,
+    ReadableStream,
     getMultipartRequestOptions,
     getDefaultAgent: (url: string): Agent => (url.startsWith('https') ? defaultHttpsAgent : defaultHttpAgent),
     fileFromPath,

package/src/_shims/node-types.d.ts

@@ -7,7 +7,7 @@ import * as fd from 'formdata-node';
 export { type Agent } from 'node:http';
 export { type Readable } from 'node:stream';
 export { type ReadStream as FsReadStream } from 'node:fs';
-export { type ReadableStream } from 'web-streams-polyfill';
+export { ReadableStream } from 'web-streams-polyfill';
 
 export const fetch: typeof nf.default;
 

package/src/_shims/registry.ts

@@ -12,6 +12,7 @@ export interface Shims {
   FormData: any;
   Blob: any;
   File: any;
+  ReadableStream: any;
   getMultipartRequestOptions: <T extends {} = Record<string, unknown>>(
     form: Shims['FormData'],
     opts: RequestOptions<T>,
@@ -32,6 +33,7 @@ export let Headers: Shims['Headers'] | undefined = undefined;
 export let FormData: Shims['FormData'] | undefined = undefined;
 export let Blob: Shims['Blob'] | undefined = undefined;
 export let File: Shims['File'] | undefined = undefined;
+export let ReadableStream: Shims['ReadableStream'] | undefined = undefined;
 export let getMultipartRequestOptions: Shims['getMultipartRequestOptions'] | undefined = undefined;
 export let getDefaultAgent: Shims['getDefaultAgent'] | undefined = undefined;
 export let fileFromPath: Shims['fileFromPath'] | undefined = undefined;
@@ -57,6 +59,7 @@ export function setShims(shims: Shims, options: { auto: boolean } = { auto: fals
   FormData = shims.FormData;
   Blob = shims.Blob;
   File = shims.File;
+  ReadableStream = shims.ReadableStream;
   getMultipartRequestOptions = shims.getMultipartRequestOptions;
   getDefaultAgent = shims.getDefaultAgent;
   fileFromPath = shims.fileFromPath;

package/src/_shims/web-runtime.ts

@@ -72,6 +72,18 @@ export function getRuntime({ manuallyImported }: { manuallyImported?: boolean }
           }
         }
       ),
+    ReadableStream:
+      // @ts-ignore
+      typeof ReadableStream !== 'undefined' ? ReadableStream : (
+        class ReadableStream {
+          // @ts-ignore
+          constructor() {
+            throw new Error(
+              `streaming isn't supported in this environment yet as 'ReadableStream' is undefined. ${recommendation}`,
+            );
+          }
+        }
+      ),
     getMultipartRequestOptions: async <T extends {} = Record<string, unknown>>(
       // @ts-ignore
       form: FormData,

package/src/_shims/web-types.d.ts

@@ -79,4 +79,5 @@ export declare class FsReadStream extends Readable {
 }
 
 type _ReadableStream<R = any> = ReadableStream<R>;
-export { type _ReadableStream as ReadableStream };
+declare const _ReadableStream: typeof ReadableStream;
+export { _ReadableStream as ReadableStream };

package/src/core.ts

@@ -1052,16 +1052,33 @@ export const isHeadersProtocol = (headers: any): headers is HeadersProtocol => {
   return typeof headers?.get === 'function';
 };
 
-export const getHeader = (headers: HeadersLike, key: string): string | null | undefined => {
-  const lowerKey = key.toLowerCase();
-  if (isHeadersProtocol(headers)) return headers.get(key) || headers.get(lowerKey);
-  const value = headers[key] || headers[lowerKey];
-  if (Array.isArray(value)) {
-    if (value.length <= 1) return value[0];
-    console.warn(`Received ${value.length} entries for the ${key} header, using the first entry.`);
-    return value[0];
+export const getRequiredHeader = (headers: HeadersLike, header: string): string => {
+  const lowerCasedHeader = header.toLowerCase();
+  if (isHeadersProtocol(headers)) {
+    // to deal with the case where the header looks like Stainless-Event-Id
+    const intercapsHeader =
+      header[0]?.toUpperCase() +
+      header.substring(1).replace(/([^\w])(\w)/g, (_m, g1, g2) => g1 + g2.toUpperCase());
+    for (const key of [header, lowerCasedHeader, header.toUpperCase(), intercapsHeader]) {
+      const value = headers.get(key);
+      if (value) {
+        return value;
+      }
+    }
   }
-  return value;
+
+  for (const [key, value] of Object.entries(headers)) {
+    if (key.toLowerCase() === lowerCasedHeader) {
+      if (Array.isArray(value)) {
+        if (value.length <= 1) return value[0];
+        console.warn(`Received ${value.length} entries for the ${header} header, using the first entry.`);
+        return value[0];
+      }
+      return value;
+    }
+  }
+
+  throw new Error(`Could not find ${header} header`);
 };
 
 /**

package/src/error.ts

@@ -15,20 +15,30 @@ export class APIError extends FinchError {
     message: string | undefined,
     headers: Headers | undefined,
   ) {
-    super(`${status} ${APIError.makeMessage(error, message)}`);
+    super(`${APIError.makeMessage(status, error, message)}`);
     this.status = status;
     this.headers = headers;
     this.error = error;
   }
 
-  private static makeMessage(error: any, message: string | undefined) {
-    return (
+  private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
+    const msg =
       error?.message ?
         typeof error.message === 'string' ? error.message
         : JSON.stringify(error.message)
       : error ? JSON.stringify(error)
-      : message || 'status code (no body)'
-    );
+      : message;
+
+    if (status && msg) {
+      return `${status} ${msg}`;
+    }
+    if (status) {
+      return `${status} status code (no body)`;
+    }
+    if (msg) {
+      return msg;
+    }
+    return '(no status code or body)';
   }
 
   static generate(

package/src/index.ts

@@ -2,16 +2,28 @@
 
 import * as Core from './core';
 import * as Pagination from './pagination';
-import * as API from './resources/index';
 import * as Errors from './error';
 import { type Agent } from './_shims/index';
 import * as Uploads from './uploads';
+import * as API from "./ch/finch-api/resources/index";
 
 export interface ClientOptions {
+  accessToken?: string | null;
+
   /**
-   * Set it to null if you want to send unauthenticated requests.
+   * Defaults to process.env['FINCH_CLIENT_ID'].
    */
-  accessToken?: string | null;
+  clientId?: string | null;
+
+  /**
+   * Defaults to process.env['FINCH_CLIENT_SECRET'].
+   */
+  clientSecret?: string | null;
+
+  /**
+   * Defaults to process.env['FINCH_WEBHOOK_SECRET'].
+   */
+  webhookSecret?: string | null;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
@@ -66,27 +78,24 @@ export interface ClientOptions {
    * param to `undefined` in request options.
    */
   defaultQuery?: Core.DefaultQuery;
-
-  clientId?: string | null;
-
-  clientSecret?: string | null;
-
-  webhookSecret?: string | null;
 }
 
 /** API Client for interfacing with the Finch API. */
 export class Finch extends Core.APIClient {
   accessToken: string | null;
-  clientId?: string | null;
-  clientSecret?: string | null;
-  webhookSecret?: string | null;
+  clientId: string | null;
+  clientSecret: string | null;
+  webhookSecret: string | null;
 
   private _options: ClientOptions;
 
   /**
    * API Client for interfacing with the Finch API.
    *
-   * @param {string | null} opts.accessToken - The Access Token to send to the API.
+   * @param {string | null} [opts.accessToken]
+   * @param {string | null} [opts.clientId==process.env['FINCH_CLIENT_ID'] ?? null]
+   * @param {string | null} [opts.clientSecret==process.env['FINCH_CLIENT_SECRET'] ?? null]
+   * @param {string | null} [opts.webhookSecret==process.env['FINCH_WEBHOOK_SECRET'] ?? null]
    * @param {string} [opts.baseURL] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
@@ -94,9 +103,6 @@ export class Finch extends Core.APIClient {
    * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
    * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
    * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
-   * @param {string | null} [opts.clientId]
-   * @param {string | null} [opts.clientSecret]
-   * @param {string | null} [opts.webhookSecret]
    */
   constructor({
     accessToken = null,

package/src/pagination.ts

@@ -1,7 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
-import * as HRIS from './resources/hris/index';
+import * as DirectoryAPI from "./ch/finch-api/resources/hris/directory";
+import * as HRISAPI from "./ch/finch-api/resources/hris/hris";
 
 export type SinglePageResponse<Item> = Item[];
 
@@ -77,9 +78,9 @@ export interface IndividualsPageResponse {
   /**
    * The array of employees.
    */
-  individuals: Array<HRIS.IndividualInDirectory>;
+  individuals: Array<DirectoryAPI.IndividualInDirectory>;
 
-  paging: HRIS.Paging;
+  paging: HRISAPI.Paging;
 }
 
 export interface IndividualsPageParams {
@@ -95,15 +96,15 @@ export interface IndividualsPageParams {
 }
 
 export class IndividualsPage
-  extends AbstractPage<HRIS.IndividualInDirectory>
+  extends AbstractPage<DirectoryAPI.IndividualInDirectory>
   implements IndividualsPageResponse
 {
-  paging: HRIS.Paging;
+  paging: HRISAPI.Paging;
 
   /**
    * The array of employees.
    */
-  individuals: Array<HRIS.IndividualInDirectory>;
+  individuals: Array<DirectoryAPI.IndividualInDirectory>;
 
   constructor(
     client: APIClient,
@@ -117,7 +118,7 @@ export class IndividualsPage
     this.individuals = body.individuals;
   }
 
-  getPaginatedItems(): HRIS.IndividualInDirectory[] {
+  getPaginatedItems(): DirectoryAPI.IndividualInDirectory[] {
     return this.individuals;
   }
 

package/src/resources/account.ts

@@ -2,7 +2,7 @@
 
 import * as Core from "../ch/finch-api/core";
 import { APIResource } from "../ch/finch-api/resource";
-import * as API from './index';
+import * as AccountAPI from "../ch/finch-api/resources/account";
 
 export class Account extends APIResource {
   /**
@@ -64,6 +64,6 @@ export interface Introspection {
 }
 
 export namespace Account {
-  export import DisconnectResponse = API.DisconnectResponse;
-  export import Introspection = API.Introspection;
+  export import DisconnectResponse = AccountAPI.DisconnectResponse;
+  export import Introspection = AccountAPI.Introspection;
 }

package/src/resources/hris/benefits/benefits.ts

@@ -3,12 +3,12 @@
 import * as Core from "../../../ch/finch-api/core";
 import { APIResource } from "../../../ch/finch-api/resource";
 import { isRequestOptions } from "../../../ch/finch-api/core";
-import { Individuals } from './individuals';
-import * as API from './index';
+import * as BenefitsAPI from "../../../ch/finch-api/resources/hris/benefits/benefits";
+import * as IndividualsAPI from "../../../ch/finch-api/resources/hris/benefits/individuals";
 import { SinglePage } from "../../../ch/finch-api/pagination";
 
 export class Benefits extends APIResource {
-  individuals: Individuals = new Individuals(this.client);
+  individuals: IndividualsAPI.Individuals = new IndividualsAPI.Individuals(this.client);
 
   /**
    * **Availability: Automated and Assisted Benefits providers**
@@ -85,12 +85,20 @@ export class Benefits extends APIResource {
 }
 
 export class CompanyBenefitsSinglePage extends SinglePage<CompanyBenefit> {}
-// alias so we can export it in the namespace
-type _CompanyBenefitsSinglePage = CompanyBenefitsSinglePage;
 
 export class SupportedBenefitsSinglePage extends SinglePage<SupportedBenefit> {}
-// alias so we can export it in the namespace
-type _SupportedBenefitsSinglePage = SupportedBenefitsSinglePage;
+
+export interface BenefitContribution {
+  /**
+   * Contribution amount in cents (if `fixed`) or basis points (if `percent`).
+   */
+  amount?: number | null;
+
+  /**
+   * Contribution type.
+   */
+  type?: 'fixed' | 'percent' | null;
+}
 
 export type BenefitFrequency = 'one_time' | 'every_paycheck' | null;
 
@@ -119,26 +127,19 @@ export type BenefitType =
   | 'custom_pre_tax'
   | null;
 
-export interface BenfitContribution {
-  /**
-   * Contribution amount in cents (if `fixed`) or basis points (if `percent`).
-   */
-  amount?: number | null;
-
-  /**
-   * Contribution type.
-   */
-  type?: 'fixed' | 'percent' | null;
-}
+/**
+ * @deprecated use `BenefitContribution` instead
+ */
+export type BenfitContribution = BenefitContribution | null;
 
 export interface CompanyBenefit {
   benefit_id: string;
 
-  company_contribution: BenfitContribution | null;
+  company_contribution: BenefitContribution | null;
 
   description: string | null;
 
-  employee_deduction: BenfitContribution | null;
+  employee_deduction: BenefitContribution | null;
 
   frequency: BenefitFrequency | null;
 
@@ -218,27 +219,30 @@ export interface BenefitUpdateParams {
 }
 
 export namespace Benefits {
-  export import BenefitFrequency = API.BenefitFrequency;
-  export import BenefitType = API.BenefitType;
-  export import BenfitContribution = API.BenfitContribution;
-  export import CompanyBenefit = API.CompanyBenefit;
-  export import CreateCompanyBenefitsResponse = API.CreateCompanyBenefitsResponse;
-  export import SupportedBenefit = API.SupportedBenefit;
-  export import UpdateCompanyBenefitResponse = API.UpdateCompanyBenefitResponse;
-  export type CompanyBenefitsSinglePage = _CompanyBenefitsSinglePage;
-  export type SupportedBenefitsSinglePage = _SupportedBenefitsSinglePage;
-  export import BenefitCreateParams = API.BenefitCreateParams;
-  export import BenefitUpdateParams = API.BenefitUpdateParams;
-
-  export import Individuals = API.Individuals;
-  export import EnrolledIndividual = API.EnrolledIndividual;
-  export import IndividualBenefit = API.IndividualBenefit;
-  export import UnenrolledIndividual = API.UnenrolledIndividual;
-  export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
-  export import EnrolledIndividualsSinglePage = API.EnrolledIndividualsSinglePage;
-  export import IndividualBenefitsSinglePage = API.IndividualBenefitsSinglePage;
-  export import UnenrolledIndividualsSinglePage = API.UnenrolledIndividualsSinglePage;
-  export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
-  export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
-  export import IndividualUnenrollManyParams = API.IndividualUnenrollManyParams;
+  export import BenefitContribution = BenefitsAPI.BenefitContribution;
+  export import BenefitFrequency = BenefitsAPI.BenefitFrequency;
+  export import BenefitType = BenefitsAPI.BenefitType;
+  /**
+   * @deprecated use `BenefitContribution` instead
+   */
+  export import BenfitContribution = BenefitsAPI.BenfitContribution;
+  export import CompanyBenefit = BenefitsAPI.CompanyBenefit;
+  export import CreateCompanyBenefitsResponse = BenefitsAPI.CreateCompanyBenefitsResponse;
+  export import SupportedBenefit = BenefitsAPI.SupportedBenefit;
+  export import UpdateCompanyBenefitResponse = BenefitsAPI.UpdateCompanyBenefitResponse;
+  export import CompanyBenefitsSinglePage = BenefitsAPI.CompanyBenefitsSinglePage;
+  export import SupportedBenefitsSinglePage = BenefitsAPI.SupportedBenefitsSinglePage;
+  export import BenefitCreateParams = BenefitsAPI.BenefitCreateParams;
+  export import BenefitUpdateParams = BenefitsAPI.BenefitUpdateParams;
+  export import Individuals = IndividualsAPI.Individuals;
+  export import EnrolledIndividual = IndividualsAPI.EnrolledIndividual;
+  export import IndividualBenefit = IndividualsAPI.IndividualBenefit;
+  export import UnenrolledIndividual = IndividualsAPI.UnenrolledIndividual;
+  export import IndividualEnrolledIDsResponse = IndividualsAPI.IndividualEnrolledIDsResponse;
+  export import EnrolledIndividualsSinglePage = IndividualsAPI.EnrolledIndividualsSinglePage;
+  export import IndividualBenefitsSinglePage = IndividualsAPI.IndividualBenefitsSinglePage;
+  export import UnenrolledIndividualsSinglePage = IndividualsAPI.UnenrolledIndividualsSinglePage;
+  export import IndividualEnrollManyParams = IndividualsAPI.IndividualEnrollManyParams;
+  export import IndividualRetrieveManyBenefitsParams = IndividualsAPI.IndividualRetrieveManyBenefitsParams;
+  export import IndividualUnenrollManyParams = IndividualsAPI.IndividualUnenrollManyParams;
 }

package/src/resources/hris/benefits/index.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless.
 
 export {
+  BenefitContribution,
   BenefitFrequency,
   BenefitType,
   BenfitContribution,

package/src/resources/hris/benefits/individuals.ts

@@ -3,8 +3,8 @@
 import * as Core from "../../../ch/finch-api/core";
 import { APIResource } from "../../../ch/finch-api/resource";
 import { isRequestOptions } from "../../../ch/finch-api/core";
-import * as Benefits from "../../../ch/finch-api/resources/hris/benefits/index";
-import * as API from './index';
+import * as IndividualsAPI from "../../../ch/finch-api/resources/hris/benefits/individuals";
+import * as BenefitsAPI from "../../../ch/finch-api/resources/hris/benefits/benefits";
 import { SinglePage } from "../../../ch/finch-api/pagination";
 
 export class Individuals extends APIResource {
@@ -103,16 +103,10 @@ export class Individuals extends APIResource {
 }
 
 export class EnrolledIndividualsSinglePage extends SinglePage<EnrolledIndividual> {}
-// alias so we can export it in the namespace
-type _EnrolledIndividualsSinglePage = EnrolledIndividualsSinglePage;
 
 export class IndividualBenefitsSinglePage extends SinglePage<IndividualBenefit> {}
-// alias so we can export it in the namespace
-type _IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
 
 export class UnenrolledIndividualsSinglePage extends SinglePage<UnenrolledIndividual> {}
-// alias so we can export it in the namespace
-type _UnenrolledIndividualsSinglePage = UnenrolledIndividualsSinglePage;
 
 export interface EnrolledIndividual {
   body?: EnrolledIndividual.Body;
@@ -165,9 +159,9 @@ export namespace IndividualBenefit {
      */
     catch_up?: boolean | null;
 
-    company_contribution?: Benefits.BenfitContribution | null;
+    company_contribution?: BenefitsAPI.BenefitContribution | null;
 
-    employee_deduction?: Benefits.BenfitContribution | null;
+    employee_deduction?: BenefitsAPI.BenefitContribution | null;
 
     /**
      * Type for HSA contribution limit if the benefit is a HSA.
@@ -241,14 +235,14 @@ export interface IndividualUnenrollManyParams {
 }
 
 export namespace Individuals {
-  export import EnrolledIndividual = API.EnrolledIndividual;
-  export import IndividualBenefit = API.IndividualBenefit;
-  export import UnenrolledIndividual = API.UnenrolledIndividual;
-  export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
-  export type EnrolledIndividualsSinglePage = _EnrolledIndividualsSinglePage;
-  export type IndividualBenefitsSinglePage = _IndividualBenefitsSinglePage;
-  export type UnenrolledIndividualsSinglePage = _UnenrolledIndividualsSinglePage;
-  export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
-  export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
-  export import IndividualUnenrollManyParams = API.IndividualUnenrollManyParams;
+  export import EnrolledIndividual = IndividualsAPI.EnrolledIndividual;
+  export import IndividualBenefit = IndividualsAPI.IndividualBenefit;
+  export import UnenrolledIndividual = IndividualsAPI.UnenrolledIndividual;
+  export import IndividualEnrolledIDsResponse = IndividualsAPI.IndividualEnrolledIDsResponse;
+  export import EnrolledIndividualsSinglePage = IndividualsAPI.EnrolledIndividualsSinglePage;
+  export import IndividualBenefitsSinglePage = IndividualsAPI.IndividualBenefitsSinglePage;
+  export import UnenrolledIndividualsSinglePage = IndividualsAPI.UnenrolledIndividualsSinglePage;
+  export import IndividualEnrollManyParams = IndividualsAPI.IndividualEnrollManyParams;
+  export import IndividualRetrieveManyBenefitsParams = IndividualsAPI.IndividualRetrieveManyBenefitsParams;
+  export import IndividualUnenrollManyParams = IndividualsAPI.IndividualUnenrollManyParams;
 }

package/src/resources/hris/company.ts

@@ -2,8 +2,8 @@
 
 import * as Core from "../../ch/finch-api/core";
 import { APIResource } from "../../ch/finch-api/resource";
-import * as HRIS from "../../ch/finch-api/resources/hris/index";
-import * as API from './index';
+import * as CompanyAPI from "../../ch/finch-api/resources/hris/company";
+import * as HRISAPI from "../../ch/finch-api/resources/hris/hris";
 
 export class CompanyResource extends APIResource {
   /**
@@ -45,7 +45,7 @@ export interface Company {
    */
   legal_name: string | null;
 
-  locations: Array<HRIS.Location | null> | null;
+  locations: Array<HRISAPI.Location | null> | null;
 
   /**
    * The email of the main administrator on the account.
@@ -128,5 +128,5 @@ export namespace Company {
 }
 
 export namespace CompanyResource {
-  export import Company = API.Company;
+  export import Company = CompanyAPI.Company;
 }

package/src/resources/hris/directory.ts

@@ -3,27 +3,32 @@
 import * as Core from "../../ch/finch-api/core";
 import { APIResource } from "../../ch/finch-api/resource";
 import { isRequestOptions } from "../../ch/finch-api/core";
-import * as API from './index';
-import { IndividualsPage, IndividualsPageParams } from "../../ch/finch-api/pagination";
+import * as DirectoryAPI from "../../ch/finch-api/resources/hris/directory";
+import { IndividualsPage, type IndividualsPageParams } from "../../ch/finch-api/pagination";
 
 export class Directory extends APIResource {
   /**
    * Read company directory and organization structure
    */
-  listIndividuals(
-    query?: DirectoryListIndividualsParams,
+  list(
+    query?: DirectoryListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
-  listIndividuals(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
-  listIndividuals(
-    query: DirectoryListIndividualsParams | Core.RequestOptions = {},
+  list(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
+  list(
+    query: DirectoryListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<IndividualsPage, IndividualInDirectory> {
     if (isRequestOptions(query)) {
-      return this.listIndividuals({}, query);
+      return this.list({}, query);
     }
     return this.getAPIList('/employer/directory', IndividualsPage, { query, ...options });
   }
+
+  /**
+   * @deprecated use `list` instead
+   */
+  listIndividuals = this.list;
 }
 
 export interface IndividualInDirectory {
@@ -85,9 +90,12 @@ export namespace IndividualInDirectory {
   }
 }
 
+export interface DirectoryListParams extends IndividualsPageParams {}
+
 export interface DirectoryListIndividualsParams extends IndividualsPageParams {}
 
 export namespace Directory {
-  export import IndividualInDirectory = API.IndividualInDirectory;
-  export import DirectoryListIndividualsParams = API.DirectoryListIndividualsParams;
+  export import IndividualInDirectory = DirectoryAPI.IndividualInDirectory;
+  export import DirectoryListParams = DirectoryAPI.DirectoryListParams;
+  export import DirectoryListIndividualsParams = DirectoryAPI.DirectoryListIndividualsParams;
 }