@tryfinch/finch-api 6.27.0 → 6.29.0

package/src/resources/hris/documents.ts

@@ -1,14 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
-import * as Shared from '../shared';
+import { APIResource } from "../../resource.js";
+import { isRequestOptions } from "../../core.js";
+import * as Core from "../../core.js";
+import * as Shared from "../shared.js";
 
 export class Documents extends APIResource {
   /**
    * **Beta:** This endpoint is in beta and may change. Retrieve a list of
    * company-wide documents.
+   *
+   * @example
+   * ```ts
+   * const documents = await client.hris.documents.list();
+   * ```
    */
   list(query?: DocumentListParams, options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
@@ -25,6 +30,13 @@ export class Documents extends APIResource {
   /**
    * **Beta:** This endpoint is in beta and may change. Retrieve details of a
    * specific document by its ID.
+   *
+   * @example
+   * ```ts
+   * const response = await client.hris.documents.retreive(
+   *   'document_id',
+   * );
+   * ```
    */
   retreive(documentId: string, options?: Core.RequestOptions): Core.APIPromise<DocumentRetreiveResponse> {
     return this._client.get(`/employer/documents/${documentId}`, options);

package/src/resources/hris/employments.ts

@@ -1,13 +1,23 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as HRISAPI from './hris';
-import { ResponsesPage } from '../../pagination';
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+import * as HRISAPI from "./hris.js";
+import { ResponsesPage } from "../../pagination.js";
 
 export class Employments extends APIResource {
   /**
    * Read individual employment and income data
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const employmentDataResponse of client.hris.employments.retrieveMany(
+   *   { requests: [{ individual_id: 'individual_id' }] },
+   * )) {
+   *   // ...
+   * }
+   * ```
    */
   retrieveMany(
     body: EmploymentRetrieveManyParams,
@@ -23,161 +33,175 @@ export class Employments extends APIResource {
 
 export class EmploymentDataResponsesPage extends ResponsesPage<EmploymentDataResponse> {}
 
-export interface EmploymentData {
-  /**
-   * A stable Finch `id` (UUID v4) for an individual in the company.
-   */
-  id?: string;
-
-  /**
-   * Worker's compensation classification code for this employee
-   */
-  class_code?: string | null;
+export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError;
 
-  /**
-   * Custom fields for the individual. These are fields which are defined by the
-   * employer in the system.
-   */
-  custom_fields?: Array<EmploymentData.CustomField> | null;
-
-  /**
-   * The department object.
-   */
-  department?: EmploymentData.Department | null;
+export namespace EmploymentData {
+  export interface UnionMember0 {
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company.
+     */
+    id: string;
 
-  /**
-   * The employment object.
-   */
-  employment?: EmploymentData.Employment | null;
+    /**
+     * Worker's compensation classification code for this employee
+     */
+    class_code: string | null;
 
-  /**
-   * The detailed employment status of the individual. Available options: `active`,
-   * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
-   */
-  employment_status?:
-    | 'active'
-    | 'deceased'
-    | 'leave'
-    | 'onboarding'
-    | 'prehire'
-    | 'retired'
-    | 'terminated'
-    | null;
-
-  end_date?: string | null;
+    /**
+     * Custom fields for the individual. These are fields which are defined by the
+     * employer in the system.
+     */
+    custom_fields: Array<UnionMember0.CustomField> | null;
 
-  /**
-   * The legal first name of the individual.
-   */
-  first_name?: string | null;
+    /**
+     * The department object.
+     */
+    department: UnionMember0.Department | 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,
-   * depending on what information the provider returns.
-   */
-  income?: HRISAPI.Income | null;
+    /**
+     * The employment object.
+     */
+    employment: UnionMember0.Employment | null;
 
-  /**
-   * The array of income history.
-   */
-  income_history?: Array<HRISAPI.Income | null> | null;
+    /**
+     * The detailed employment status of the individual. Available options: `active`,
+     * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+     */
+    employment_status:
+      | 'active'
+      | 'deceased'
+      | 'leave'
+      | 'onboarding'
+      | 'prehire'
+      | 'retired'
+      | 'terminated'
+      | null;
+
+    end_date: string | null;
 
-  /**
-   * `true` if the individual an an active employee or contractor at the company.
-   */
-  is_active?: boolean | null;
+    /**
+     * The legal first name of the individual.
+     */
+    first_name: string | null;
 
-  /**
-   * The legal last name of the individual.
-   */
-  last_name?: string | null;
+    /**
+     * `true` if the individual an an active employee or contractor at the company.
+     */
+    is_active: boolean | null;
 
-  latest_rehire_date?: string | null;
+    /**
+     * The legal last name of the individual.
+     */
+    last_name: string | null;
 
-  location?: HRISAPI.Location | null;
+    latest_rehire_date: string | null;
 
-  /**
-   * The manager object representing the manager of the individual within the org.
-   */
-  manager?: EmploymentData.Manager | null;
+    location: HRISAPI.Location | null;
 
-  /**
-   * The legal middle name of the individual.
-   */
-  middle_name?: string | null;
+    /**
+     * The manager object representing the manager of the individual within the org.
+     */
+    manager: UnionMember0.Manager | null;
 
-  /**
-   * The source system's unique employment identifier for this individual
-   */
-  source_id?: string | null;
+    /**
+     * The legal middle name of the individual.
+     */
+    middle_name: string | null;
 
-  start_date?: string | null;
+    /**
+     * The source system's unique employment identifier for this individual
+     */
+    source_id: string | null;
 
-  /**
-   * The current title of the individual.
-   */
-  title?: string | null;
+    start_date: string | null;
 
-  /**
-   * @deprecated This field is deprecated in favour of `source_id`
-   */
-  work_id?: string | null;
-}
+    /**
+     * The current title of the individual.
+     */
+    title: string | null;
 
-export namespace EmploymentData {
-  export interface CustomField {
-    name?: string;
+    /**
+     * @deprecated This field is deprecated in favour of `source_id`
+     */
+    work_id: string | null;
 
-    value?: unknown;
-  }
+    /**
+     * 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,
+     * depending on what information the provider returns.
+     */
+    income?: HRISAPI.Income | null;
 
-  /**
-   * The department object.
-   */
-  export interface Department {
     /**
-     * The name of the department associated with the individual.
+     * The array of income history.
      */
-    name?: string | null;
+    income_history?: Array<HRISAPI.Income | null> | null;
   }
 
-  /**
-   * The employment object.
-   */
-  export interface Employment {
+  export namespace UnionMember0 {
+    export interface CustomField {
+      name?: string;
+
+      value?: string | Array<unknown> | unknown | number | boolean | null;
+    }
+
     /**
-     * The secondary employment type of the individual. Options: `full_time`,
-     * `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+     * The department object.
      */
-    subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+    export interface Department {
+      /**
+       * The name of the department associated with the individual.
+       */
+      name: string | null;
+    }
 
     /**
-     * The main employment type of the individual.
+     * The employment object.
      */
-    type?: 'employee' | 'contractor' | null;
-  }
+    export interface Employment {
+      /**
+       * The secondary employment type of the individual. Options: `full_time`,
+       * `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+       */
+      subtype: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+
+      /**
+       * The main employment type of the individual.
+       */
+      type: 'employee' | 'contractor' | null;
+    }
 
-  /**
-   * The manager object representing the manager of the individual within the org.
-   */
-  export interface Manager {
     /**
-     * A stable Finch `id` (UUID v4) for an individual in the company.
+     * The manager object representing the manager of the individual within the org.
      */
-    id?: string;
+    export interface Manager {
+      /**
+       * A stable Finch `id` (UUID v4) for an individual in the company.
+       */
+      id: string;
+    }
+  }
+
+  export interface BatchError {
+    code: number;
+
+    message: string;
+
+    name: string;
+
+    finch_code?: string;
   }
 }
 
 export interface EmploymentDataResponse {
-  body?: EmploymentData;
+  body: EmploymentData;
 
-  code?: number;
+  code: number;
 
   /**
    * A stable Finch `id` (UUID v4) for an individual in the company.
    */
-  individual_id?: string;
+  individual_id: string;
 }
 
 export interface EmploymentRetrieveManyParams {

package/src/resources/hris/hris.ts

@@ -1,14 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as DirectoryAPI from './directory';
+import { APIResource } from "../../resource.js";
+import * as DirectoryAPI from "./directory.js";
 import {
   Directory,
   DirectoryListIndividualsParams,
   DirectoryListParams,
   IndividualInDirectory,
-} from './directory';
-import * as DocumentsAPI from './documents';
+} from "./directory.js";
+import * as DocumentsAPI from "./documents.js";
 import {
   DocumentListParams,
   DocumentListResponse,
@@ -17,24 +17,24 @@ import {
   Documents,
   W42005,
   W42020,
-} from './documents';
-import * as EmploymentsAPI from './employments';
+} from "./documents.js";
+import * as EmploymentsAPI from "./employments.js";
 import {
   EmploymentData,
   EmploymentDataResponse,
   EmploymentDataResponsesPage,
   EmploymentRetrieveManyParams,
   Employments,
-} from './employments';
-import * as IndividualsAPI from './individuals';
+} from "./employments.js";
+import * as IndividualsAPI from "./individuals.js";
 import {
   Individual,
   IndividualResponse,
   IndividualResponsesPage,
   IndividualRetrieveManyParams,
   Individuals,
-} from './individuals';
-import * as PayStatementsAPI from './pay-statements';
+} from "./individuals.js";
+import * as PayStatementsAPI from "./pay-statements.js";
 import {
   PayStatement,
   PayStatementResponse,
@@ -42,10 +42,10 @@ import {
   PayStatementResponsesPage,
   PayStatementRetrieveManyParams,
   PayStatements,
-} from './pay-statements';
-import * as PaymentsAPI from './payments';
-import { Payment, PaymentListParams, Payments, PaymentsSinglePage } from './payments';
-import * as BenefitsAPI from './benefits/benefits';
+} from "./pay-statements.js";
+import * as PaymentsAPI from "./payments.js";
+import { Payment, PaymentListParams, Payments, PaymentsSinglePage } from "./payments.js";
+import * as BenefitsAPI from "./benefits/benefits.js";
 import {
   BenefitContribution,
   BenefitCreateParams,
@@ -64,9 +64,9 @@ import {
   SupportPerBenefitType,
   SupportedBenefit,
   UpdateCompanyBenefitResponse,
-} from './benefits/benefits';
-import * as CompanyAPI from './company/company';
-import { Company, CompanyResource } from './company/company';
+} from "./benefits/benefits.js";
+import * as CompanyAPI from "./company/company.js";
+import { Company, CompanyResource } from "./company/company.js";
 
 export class HRIS extends APIResource {
   company: CompanyAPI.CompanyResource = new CompanyAPI.CompanyResource(this._client);
@@ -88,23 +88,23 @@ export interface Income {
   /**
    * The income amount in cents.
    */
-  amount?: number | null;
+  amount: number | null;
 
   /**
    * The currency code.
    */
-  currency?: string | null;
+  currency: string | null;
 
   /**
    * The date the income amount went into effect.
    */
-  effective_date?: string | null;
+  effective_date: string | null;
 
   /**
    * The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
    * `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
    */
-  unit?:
+  unit:
     | 'yearly'
     | 'quarterly'
     | 'monthly'
@@ -121,36 +121,36 @@ export interface Location {
   /**
    * City, district, suburb, town, or village.
    */
-  city?: string | null;
+  city: string | null;
 
   /**
    * The 2-letter ISO 3166 country code.
    */
-  country?: string | null;
+  country: string | null;
 
   /**
    * Street address or PO box.
    */
-  line1?: string | null;
+  line1: string | null;
 
   /**
    * Apartment, suite, unit, or building.
    */
-  line2?: string | null;
-
-  name?: string | null;
+  line2: string | null;
 
   /**
    * The postal code or zip code.
    */
-  postal_code?: string | null;
-
-  source_id?: string | null;
+  postal_code: string | null;
 
   /**
    * The state code.
    */
-  state?: string | null;
+  state: string | null;
+
+  name?: string | null;
+
+  source_id?: string | null;
 }
 
 export interface Money {

package/src/resources/hris/index.ts

@@ -18,14 +18,14 @@ export {
   type BenfitContribution,
   type BenefitCreateParams,
   type BenefitUpdateParams,
-} from './benefits/index';
-export { CompanyResource, type Company } from './company/index';
+} from "./benefits/index.js";
+export { CompanyResource, type Company } from "./company/index.js";
 export {
   Directory,
   type IndividualInDirectory,
   type DirectoryListParams,
   type DirectoryListIndividualsParams,
-} from './directory';
+} from "./directory.js";
 export {
   Documents,
   type DocumentResponse,
@@ -34,22 +34,22 @@ export {
   type DocumentListResponse,
   type DocumentRetreiveResponse,
   type DocumentListParams,
-} from './documents';
+} from "./documents.js";
 export {
   EmploymentDataResponsesPage,
   Employments,
   type EmploymentData,
   type EmploymentDataResponse,
   type EmploymentRetrieveManyParams,
-} from './employments';
-export { HRIS, type Income, type Location, type Money } from './hris';
+} from "./employments.js";
+export { HRIS, type Income, type Location, type Money } from "./hris.js";
 export {
   IndividualResponsesPage,
   Individuals,
   type Individual,
   type IndividualResponse,
   type IndividualRetrieveManyParams,
-} from './individuals';
+} from "./individuals.js";
 export {
   PayStatementResponsesPage,
   PayStatements,
@@ -57,5 +57,5 @@ export {
   type PayStatementResponse,
   type PayStatementResponseBody,
   type PayStatementRetrieveManyParams,
-} from './pay-statements';
-export { PaymentsSinglePage, Payments, type Payment, type PaymentListParams } from './payments';
+} from "./pay-statements.js";
+export { PaymentsSinglePage, Payments, type Payment, type PaymentListParams } from "./payments.js";