@tryfinch/finch-api 9.0.0 → 9.8.0

package/src/client.ts

@@ -11,7 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
-import * as qs from './internal/qs';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Pagination from './core/pagination';
@@ -241,6 +241,18 @@ export class Finch {
     this.fetch = options.fetch ?? Shims.getDefaultFetch();
     this.#encoder = Opts.FallbackEncoder;
 
+    const customHeadersEnv = readEnv('FINCH_CUSTOM_HEADERS');
+    if (customHeadersEnv) {
+      const parsed: Record<string, string> = {};
+      for (const line of customHeadersEnv.split('\n')) {
+        const colon = line.indexOf(':');
+        if (colon >= 0) {
+          parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim();
+        }
+      }
+      options.defaultHeaders = { ...parsed, ...options.defaultHeaders };
+    }
+
     this._options = options;
 
     this.accessToken = accessToken;
@@ -333,8 +345,8 @@ export class Finch {
     return buildHeaders([{ Authorization }]);
   }
 
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return qs.stringify(query, { arrayFormat: 'brackets' });
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -366,12 +378,13 @@ export class Finch {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -555,7 +568,7 @@ export class Finch {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -592,9 +605,14 @@ export class Finch {
   getAPIList<Item, PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>>(
     path: string,
     Page: new (...args: any[]) => PageClass,
-    opts?: RequestOptions,
+    opts?: PromiseOrValue<RequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
-    return this.requestAPIList(Page, { method: 'get', path, ...opts });
+    return this.requestAPIList(
+      Page,
+      opts && 'then' in opts ?
+        opts.then((opts) => ({ method: 'get', path, ...opts }))
+      : { method: 'get', path, ...opts },
+    );
   }
 
   requestAPIList<
@@ -602,7 +620,7 @@ export class Finch {
     PageClass extends Pagination.AbstractPage<Item> = Pagination.AbstractPage<Item>,
   >(
     Page: new (...args: ConstructorParameters<typeof Pagination.AbstractPage>) => PageClass,
-    options: FinalRequestOptions,
+    options: PromiseOrValue<FinalRequestOptions>,
   ): Pagination.PagePromise<PageClass, Item> {
     const request = this.makeRequest(options, null, undefined);
     return new Pagination.PagePromise<PageClass, Item>(this as any as Finch, request, Page);
@@ -615,9 +633,10 @@ export class Finch {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
 
-    const timeout = setTimeout(() => controller.abort(), ms);
+    const timeout = setTimeout(abort, ms);
 
     const isReadableBody =
       ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -694,9 +713,9 @@ export class Finch {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -785,6 +804,12 @@ export class Finch {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -817,6 +842,14 @@ export class Finch {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body),
+      };
     } else {
       return this.#encoder({ body, headers });
     }

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: Finch, props: APIResponseP
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }

package/src/internal/types.ts

@@ -40,7 +40,6 @@ type OverloadedParameters<T> =
   : T extends (...args: infer A) => unknown ? A
   : never;
 
-/* eslint-disable */
 /**
  * These imports attempt to get types from a parent package's dependencies.
  * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which
@@ -63,19 +62,18 @@ type OverloadedParameters<T> =
  *
  * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
  */
-/** @ts-ignore For users with \@types/node */
+/** @ts-ignore For users with \@types/node */ /* prettier-ignore */
 type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
-/** @ts-ignore For users with undici */
+/** @ts-ignore For users with undici */ /* prettier-ignore */
 type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
-/** @ts-ignore For users with \@types/bun */
+/** @ts-ignore For users with \@types/bun */ /* prettier-ignore */
 type BunRequestInit = globalThis.FetchRequestInit;
-/** @ts-ignore For users with node-fetch@2 */
+/** @ts-ignore For users with node-fetch@2 */ /* prettier-ignore */
 type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
-/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */
+/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ /* prettier-ignore */
 type NodeFetch3RequestInit =  NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
-/** @ts-ignore For users who use Deno */
+/** @ts-ignore For users who use Deno */ /* prettier-ignore */
 type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
-/* eslint-enable */
 
 type RequestInits =
   | NotAny<UndiciTypesRequestInit>

package/src/internal/utils/env.ts

@@ -9,10 +9,10 @@
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof (globalThis as any).process !== 'undefined') {
-    return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
+    return (globalThis as any).process.env?.[env]?.trim() || undefined;
   }
   if (typeof (globalThis as any).Deno !== 'undefined') {
-    return (globalThis as any).Deno.env?.get?.(env)?.trim();
+    return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
   }
   return undefined;
 };

package/src/internal/utils/log.ts

@@ -107,6 +107,8 @@ export const formatRequestDetails = (details: {
           name,
           (
             name.toLowerCase() === 'authorization' ||
+            name.toLowerCase() === 'api-key' ||
+            name.toLowerCase() === 'x-api-key' ||
             name.toLowerCase() === 'cookie' ||
             name.toLowerCase() === 'set-cookie'
           ) ?

package/src/internal/utils/query.ts

@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as qs from '../qs/stringify';
+
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return qs.stringify(query, { arrayFormat: 'brackets' });
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/access-tokens.ts

@@ -98,6 +98,12 @@ export interface CreateAccessTokenResponse {
    * for this connection
    */
   customer_id?: string | null;
+
+  /**
+   * The name of your customer you provided to Finch when a connect session was
+   * created for this connection
+   */
+  customer_name?: string | null;
 }
 
 export interface AccessTokenCreateParams {

package/src/resources/account.ts

@@ -180,6 +180,18 @@ export namespace Introspection {
      * The source ID of the entity
      */
     source_id: string | null;
+
+    /**
+     * The status of the entity connection
+     */
+    status:
+      | 'pending'
+      | 'processing'
+      | 'connected'
+      | 'error_no_account_setup'
+      | 'error_permissions'
+      | 'reauth'
+      | 'disconnected';
   }
 }
 

package/src/resources/connect/sessions.ts

@@ -63,7 +63,9 @@ export interface SessionNewParams {
   customer_name: string;
 
   /**
-   * The Finch products to request access to
+   * The Finch products to request access to. Use `benefits` to access deductions
+   * endpoints — `deduction` is a deprecated alias that is still accepted but should
+   * not be combined with `benefits`.
    */
   products: Array<
     | 'benefits'
@@ -140,7 +142,9 @@ export interface SessionReauthenticateParams {
   minutes_to_expire?: number;
 
   /**
-   * The products to request access to (optional for reauthentication)
+   * The products to request access to (optional for reauthentication). Use
+   * `benefits` to access deductions endpoints — `deduction` is a deprecated alias
+   * that is still accepted but should not be combined with `benefits`.
    */
   products?: Array<
     | 'benefits'

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

@@ -141,12 +141,12 @@ export type CompanyBenefitsSinglePage = SinglePage<CompanyBenefit>;
 export type SupportedBenefitsSinglePage = SinglePage<SupportedBenefit>;
 
 export type BenefitContribution =
-  | BenefitContribution.UnionMember0
-  | BenefitContribution.UnionMember1
-  | BenefitContribution.UnionMember2;
+  | BenefitContribution.BenefitContributionFixed
+  | BenefitContribution.BenefitContributionPercent
+  | BenefitContribution.BenefitContributionTiered;
 
 export namespace BenefitContribution {
-  export interface UnionMember0 {
+  export interface BenefitContributionFixed {
     /**
      * Contribution amount in cents.
      */
@@ -158,7 +158,7 @@ export namespace BenefitContribution {
     type: 'fixed';
   }
 
-  export interface UnionMember1 {
+  export interface BenefitContributionPercent {
     /**
      * Contribution amount in basis points (1/100th of a percent).
      */
@@ -170,12 +170,12 @@ export namespace BenefitContribution {
     type: 'percent';
   }
 
-  export interface UnionMember2 {
+  export interface BenefitContributionTiered {
     /**
      * Array of tier objects defining employer match tiers based on employee
      * contribution thresholds.
      */
-    tiers: Array<UnionMember2.Tier>;
+    tiers: Array<BenefitContributionTiered.Tier>;
 
     /**
      * Tiered contribution type (only valid for company_contribution).
@@ -183,7 +183,7 @@ export namespace BenefitContribution {
     type: 'tiered';
   }
 
-  export namespace UnionMember2 {
+  export namespace BenefitContributionTiered {
     export interface Tier {
       match: number;
 

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

@@ -116,7 +116,7 @@ export interface EnrolledIndividualBenefitResponse {
 }
 
 export interface IndividualBenefit {
-  body: IndividualBenefit.UnionMember0 | IndividualBenefit.BatchError;
+  body: IndividualBenefit.IndividualBenefit | IndividualBenefit.BatchError;
 
   code: number;
 
@@ -124,7 +124,7 @@ export interface IndividualBenefit {
 }
 
 export namespace IndividualBenefit {
-  export interface UnionMember0 {
+  export interface IndividualBenefit {
     /**
      * If the benefit supports annual maximum, the amount in cents for this individual.
      */
@@ -142,16 +142,19 @@ export namespace IndividualBenefit {
      * matching structures.
      */
     company_contribution:
-      | UnionMember0.UnionMember0
-      | UnionMember0.UnionMember1
-      | UnionMember0.UnionMember2
+      | IndividualBenefit.CompanyContributionFixed
+      | IndividualBenefit.CompanyContributionPercent
+      | IndividualBenefit.CompanyContributionTiered
       | null;
 
     /**
      * Employee deduction configuration. Supports both fixed amounts (in cents) and
      * percentage-based contributions (in basis points where 100 = 1%).
      */
-    employee_deduction: UnionMember0.UnionMember0 | UnionMember0.UnionMember1 | null;
+    employee_deduction:
+      | IndividualBenefit.EmployeeDeductionContributionFixed
+      | IndividualBenefit.EmployeeDeductionContributionPercent
+      | null;
 
     /**
      * Type for HSA contribution limit if the benefit is a HSA.
@@ -159,8 +162,8 @@ export namespace IndividualBenefit {
     hsa_contribution_limit?: 'individual' | 'family' | null;
   }
 
-  export namespace UnionMember0 {
-    export interface UnionMember0 {
+  export namespace IndividualBenefit {
+    export interface CompanyContributionFixed {
       /**
        * Contribution amount in cents (for type=fixed) or basis points (for type=percent,
        * where 100 = 1%). Not used for type=tiered.
@@ -174,7 +177,7 @@ export namespace IndividualBenefit {
       type: 'fixed';
     }
 
-    export interface UnionMember1 {
+    export interface CompanyContributionPercent {
       /**
        * Contribution amount in cents (for type=fixed) or basis points (for type=percent,
        * where 100 = 1%). Not used for type=tiered.
@@ -188,12 +191,12 @@ export namespace IndividualBenefit {
       type: 'percent';
     }
 
-    export interface UnionMember2 {
+    export interface CompanyContributionTiered {
       /**
        * Array of tier objects defining employer match tiers based on employee
        * contribution thresholds. Required when type=tiered.
        */
-      tiers: Array<UnionMember2.Tier>;
+      tiers: Array<CompanyContributionTiered.Tier>;
 
       /**
        * Contribution type. Supported values: "fixed" (amount in cents), "percent"
@@ -202,7 +205,7 @@ export namespace IndividualBenefit {
       type: 'tiered';
     }
 
-    export namespace UnionMember2 {
+    export namespace CompanyContributionTiered {
       export interface Tier {
         match: number;
 
@@ -210,7 +213,7 @@ export namespace IndividualBenefit {
       }
     }
 
-    export interface UnionMember0 {
+    export interface EmployeeDeductionContributionFixed {
       /**
        * Contribution amount in cents (for type=fixed) or basis points (for type=percent,
        * where 100 = 1%).
@@ -224,7 +227,7 @@ export namespace IndividualBenefit {
       type: 'fixed';
     }
 
-    export interface UnionMember1 {
+    export interface EmployeeDeductionContributionPercent {
       /**
        * Contribution amount in cents (for type=fixed) or basis points (for type=percent,
        * where 100 = 1%).

package/src/resources/hris/employments.ts

@@ -36,10 +36,10 @@ export class Employments extends APIResource {
 
 export type EmploymentDataResponsesPage = ResponsesPage<EmploymentDataResponse>;
 
-export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError;
+export type EmploymentData = EmploymentData.EmploymentData | EmploymentData.BatchError;
 
 export namespace EmploymentData {
-  export interface UnionMember0 {
+  export interface EmploymentData {
     /**
      * A stable Finch `id` (UUID v4) for an individual in the company.
      */
@@ -53,12 +53,12 @@ export namespace EmploymentData {
     /**
      * The department object.
      */
-    department: UnionMember0.Department | null;
+    department: EmploymentData.Department | null;
 
     /**
      * The employment object.
      */
-    employment: UnionMember0.Employment | null;
+    employment: EmploymentData.Employment | null;
 
     /**
      * The detailed employment status of the individual.
@@ -80,6 +80,12 @@ export namespace EmploymentData {
      */
     first_name: string | null;
 
+    /**
+     * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+     * `unknown`.
+     */
+    flsa_status: 'exempt' | 'non_exempt' | 'unknown' | null;
+
     /**
      * `true` if the individual an an active employee or contractor at the company.
      */
@@ -97,7 +103,7 @@ export namespace EmploymentData {
     /**
      * The manager object representing the manager of the individual within the org.
      */
-    manager: UnionMember0.Manager | null;
+    manager: EmploymentData.Manager | null;
 
     /**
      * The legal middle name of the individual.
@@ -116,7 +122,7 @@ export namespace EmploymentData {
      * employer in the system. Custom fields are not currently supported for assisted
      * connections.
      */
-    custom_fields?: Array<UnionMember0.CustomField> | null;
+    custom_fields?: Array<EmploymentData.CustomField> | null;
 
     /**
      * The employee's income as reported by the provider. This may not always be
@@ -141,7 +147,7 @@ export namespace EmploymentData {
     work_id?: string | null;
   }
 
-  export namespace UnionMember0 {
+  export namespace EmploymentData {
     /**
      * The department object.
      */

package/src/resources/hris/individuals.ts

@@ -34,10 +34,10 @@ export class Individuals extends APIResource {
 
 export type IndividualResponsesPage = ResponsesPage<IndividualResponse>;
 
-export type Individual = Individual.UnionMember0 | Individual.BatchError;
+export type Individual = Individual.Individual | Individual.BatchError;
 
 export namespace Individual {
-  export interface UnionMember0 {
+  export interface Individual {
     /**
      * A stable Finch `id` (UUID v4) for an individual in the company.
      */
@@ -79,7 +79,7 @@ export namespace Individual {
      */
     middle_name: string | null;
 
-    phone_numbers: Array<UnionMember0.PhoneNumber | null> | null;
+    phone_numbers: Array<Individual.PhoneNumber | null> | null;
 
     /**
      * The preferred name of the individual.
@@ -88,7 +88,7 @@ export namespace Individual {
 
     residence: HRISAPI.Location | null;
 
-    emails?: Array<UnionMember0.Email> | null;
+    emails?: Array<Individual.Email> | null;
 
     /**
      * Social Security Number of the individual in **encrypted** format. This field is
@@ -106,7 +106,7 @@ export namespace Individual {
     ssn?: string | null;
   }
 
-  export namespace UnionMember0 {
+  export namespace Individual {
     export interface PhoneNumber {
       data: string | null;
 

package/src/resources/sandbox/directory.ts

@@ -109,6 +109,12 @@ export namespace DirectoryCreateParams {
      */
     first_name?: string | null;
 
+    /**
+     * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+     * `unknown`.
+     */
+    flsa_status?: 'exempt' | 'non_exempt' | 'unknown' | null;
+
     /**
      * The gender of the individual.
      */

package/src/resources/sandbox/employment.ts

@@ -78,6 +78,12 @@ export interface EmploymentUpdateResponse {
    */
   first_name?: string | null;
 
+  /**
+   * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+   * `unknown`.
+   */
+  flsa_status?: 'exempt' | 'non_exempt' | 'unknown' | null;
+
   /**
    * The employee's income as reported by the provider. This may not always be
    * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
@@ -214,6 +220,12 @@ export interface EmploymentUpdateParams {
    */
   first_name?: string | null;
 
+  /**
+   * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+   * `unknown`.
+   */
+  flsa_status?: 'exempt' | 'non_exempt' | 'unknown' | null;
+
   /**
    * The employee's income as reported by the provider. This may not always be
    * annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,

package/src/resources/webhooks.ts

@@ -576,6 +576,11 @@ export interface BaseWebhookEvent {
    * Unique Finch ID of the connection associated with the webhook event.
    */
   connection_id?: string;
+
+  /**
+   * Unique Finch id of the entity for which data has been updated.
+   */
+  entity_id?: string;
 }
 
 export interface CompanyEvent extends BaseWebhookEvent {
@@ -638,7 +643,10 @@ export interface JobCompletionEvent extends BaseWebhookEvent {
     | 'job.benefit_register.completed'
     | 'job.benefit_unenroll.completed'
     | 'job.benefit_update.completed'
-    | 'job.data_sync_all.completed';
+    | 'job.data_sync_all.completed'
+    | 'job.w4_form_employee_sync.completed'
+    | 'job.initial_data_sync_org.succeeded'
+    | 'job.initial_data_sync_payroll.succeeded';
 }
 
 export namespace JobCompletionEvent {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '9.0.0'; // x-release-please-version
+export const VERSION = '9.8.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "9.0.0";
+export declare const VERSION = "9.8.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "9.0.0";
+export declare const VERSION = "9.8.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '9.0.0'; // x-release-please-version
+exports.VERSION = '9.8.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '9.0.0'; // x-release-please-version
+export const VERSION = '9.8.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map