@tryfinch/finch-api 5.1.0 → 5.3.0

package/resources/hris/employments.d.ts

@@ -1,152 +1,150 @@
 import * as Core from '@tryfinch/finch-api/core';
 import { APIResource } from '@tryfinch/finch-api/resource';
 import * as HRIS from '@tryfinch/finch-api/resources/hris/index';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { ResponsesPage } from '@tryfinch/finch-api/pagination';
 export declare class Employments extends APIResource {
-  /**
-   * Read individual employment and income data
-   *
-   * Note: Income information is returned 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.
-   */
-  retrieveMany(
-    body: EmploymentRetrieveManyParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<EmploymentDataResponsesPage, EmploymentDataResponse>;
+    /**
+     * Read individual employment and income data
+     *
+     * Note: Income information is returned 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.
+     */
+    retrieveMany(body: EmploymentRetrieveManyParams, options?: Core.RequestOptions): Core.PagePromise<EmploymentDataResponsesPage, EmploymentDataResponse>;
+}
+export declare class EmploymentDataResponsesPage extends ResponsesPage<EmploymentDataResponse> {
 }
-export declare class EmploymentDataResponsesPage extends ResponsesPage<EmploymentDataResponse> {}
 type _EmploymentDataResponsesPage = EmploymentDataResponsesPage;
 export interface EmploymentData {
-  /**
-   * string 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;
-  /**
-   * The department object.
-   */
-  department?: EmploymentData.Department | null;
-  /**
-   * The employment object.
-   */
-  employment?: EmploymentData.Employment | null;
-  end_date?: string | null;
-  /**
-   * The legal first name of the individual.
-   */
-  first_name?: string | 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?: HRIS.Income | null;
-  /**
-   * The array of income history.
-   */
-  income_history?: Array<HRIS.Income | null> | null;
-  /**
-   * `true` if the individual an an active employee or contractor at the company.
-   */
-  is_active?: boolean | null;
-  /**
-   * The legal last name of the individual.
-   */
-  last_name?: string | null;
-  location?: HRIS.Location | null;
-  /**
-   * The manager object representing the manager of the individual within the org.
-   */
-  manager?: EmploymentData.Manager | null;
-  /**
-   * The legal middle name of the individual.
-   */
-  middle_name?: string | null;
-  /**
-   * Note: This property is only available if enabled for your account. Please reach
-   * out to your Finch representative if you would like access.
-   */
-  pay_group_ids?: Array<string> | null;
-  start_date?: string | null;
-  /**
-   * The current title of the individual.
-   */
-  title?: string | null;
-  /**
-   * Note: This property is only available if enabled for your account. Please reach
-   * out to your Finch representative if you would like access.
-   */
-  work_id?: string | null;
-  /**
-   * Note: This property is only available if enabled for your account. Please reach
-   * out to your Finch representative if you would like access.
-   */
-  work_id_2?: string | null;
-}
-export declare namespace EmploymentData {
-  /**
-   * The department object.
-   */
-  interface Department {
     /**
-     * The name of the department associated with the individual.
+     * string A stable Finch `id` (UUID v4) for an individual in the company.
      */
-    name?: string | null;
-  }
-  /**
-   * The employment object.
-   */
-  interface Employment {
+    id?: string;
     /**
-     * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+     * Worker's compensation classification code for this employee
      */
-    subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+    class_code?: string | null;
     /**
-     * The main employment type of the individual.
+     * The department object.
      */
-    type?: 'employee' | 'contractor' | null;
-  }
-  /**
-   * The manager object representing the manager of the individual within the org.
-   */
-  interface Manager {
+    department?: EmploymentData.Department | null;
     /**
-     * A stable Finch `id` (UUID v4) for an individual in the company.
+     * The employment object.
      */
-    id?: string;
-  }
+    employment?: EmploymentData.Employment | null;
+    end_date?: string | null;
+    /**
+     * The legal first name of the individual.
+     */
+    first_name?: string | 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?: HRIS.Income | null;
+    /**
+     * The array of income history.
+     */
+    income_history?: Array<HRIS.Income | null> | null;
+    /**
+     * `true` if the individual an an active employee or contractor at the company.
+     */
+    is_active?: boolean | null;
+    /**
+     * The legal last name of the individual.
+     */
+    last_name?: string | null;
+    location?: HRIS.Location | null;
+    /**
+     * The manager object representing the manager of the individual within the org.
+     */
+    manager?: EmploymentData.Manager | null;
+    /**
+     * The legal middle name of the individual.
+     */
+    middle_name?: string | null;
+    /**
+     * Note: This property is only available if enabled for your account. Please reach
+     * out to your Finch representative if you would like access.
+     */
+    pay_group_ids?: Array<string> | null;
+    start_date?: string | null;
+    /**
+     * The current title of the individual.
+     */
+    title?: string | null;
+    /**
+     * Note: This property is only available if enabled for your account. Please reach
+     * out to your Finch representative if you would like access.
+     */
+    work_id?: string | null;
+    /**
+     * Note: This property is only available if enabled for your account. Please reach
+     * out to your Finch representative if you would like access.
+     */
+    work_id_2?: string | null;
+}
+export declare namespace EmploymentData {
+    /**
+     * The department object.
+     */
+    interface Department {
+        /**
+         * The name of the department associated with the individual.
+         */
+        name?: string | null;
+    }
+    /**
+     * The employment object.
+     */
+    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.
+     */
+    interface Manager {
+        /**
+         * A stable Finch `id` (UUID v4) for an individual in the company.
+         */
+        id?: string;
+    }
 }
 export interface EmploymentDataResponse {
-  body?: EmploymentData;
-  code?: number;
-  individual_id?: string;
+    body?: EmploymentData;
+    code?: number;
+    individual_id?: string;
 }
 export interface EmploymentRetrieveManyParams {
-  /**
-   * The array of batch requests.
-   */
-  requests: Array<EmploymentRetrieveManyParams.Request>;
-}
-export declare namespace EmploymentRetrieveManyParams {
-  interface Request {
     /**
-     * A stable Finch `id` (UUID v4) for an individual in the company. There is no
-     * limit to the number of `individual_id` to send per request. It is preferantial
-     * to send all ids in a single request for Finch to optimize provider rate-limits.
+     * The array of batch requests.
      */
-    individual_id: string;
-  }
+    requests: Array<EmploymentRetrieveManyParams.Request>;
+}
+export declare namespace EmploymentRetrieveManyParams {
+    interface Request {
+        /**
+         * A stable Finch `id` (UUID v4) for an individual in the company. There is no
+         * limit to the number of `individual_id` to send per request. It is preferantial
+         * to send all ids in a single request for Finch to optimize provider rate-limits.
+         */
+        individual_id: string;
+    }
 }
 export declare namespace Employments {
-  export import EmploymentData = API.EmploymentData;
-  export import EmploymentDataResponse = API.EmploymentDataResponse;
-  type EmploymentDataResponsesPage = _EmploymentDataResponsesPage;
-  export import EmploymentRetrieveManyParams = API.EmploymentRetrieveManyParams;
+    export import EmploymentData = API.EmploymentData;
+    export import EmploymentDataResponse = API.EmploymentDataResponse;
+    type EmploymentDataResponsesPage = _EmploymentDataResponsesPage;
+    export import EmploymentRetrieveManyParams = API.EmploymentRetrieveManyParams;
 }
 export {};
-//# sourceMappingURL=employments.d.ts.map
+//# sourceMappingURL=employments.d.ts.map

package/resources/hris/employments.js

@@ -1,27 +1,29 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.EmploymentDataResponsesPage = exports.Employments = void 0;
-const resource_1 = require('@tryfinch/finch-api/resource');
-const pagination_1 = require('@tryfinch/finch-api/pagination');
+const resource_1 = require("@tryfinch/finch-api/resource");
+const pagination_1 = require("@tryfinch/finch-api/pagination");
 class Employments extends resource_1.APIResource {
-  /**
-   * Read individual employment and income data
-   *
-   * Note: Income information is returned 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.
-   */
-  retrieveMany(body, options) {
-    return this.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
-      body,
-      method: 'post',
-      ...options,
-    });
-  }
+    /**
+     * Read individual employment and income data
+     *
+     * Note: Income information is returned 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.
+     */
+    retrieveMany(body, options) {
+        return this.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
 }
 exports.Employments = Employments;
-class EmploymentDataResponsesPage extends pagination_1.ResponsesPage {}
+class EmploymentDataResponsesPage extends pagination_1.ResponsesPage {
+}
 exports.EmploymentDataResponsesPage = EmploymentDataResponsesPage;
-(function (Employments) {})((Employments = exports.Employments || (exports.Employments = {})));
-//# sourceMappingURL=employments.js.map
+(function (Employments) {
+})(Employments = exports.Employments || (exports.Employments = {}));
+//# sourceMappingURL=employments.js.map

package/resources/hris/employments.mjs

@@ -2,21 +2,23 @@
 import { APIResource } from '@tryfinch/finch-api/resource';
 import { ResponsesPage } from '@tryfinch/finch-api/pagination';
 export class Employments extends APIResource {
-  /**
-   * Read individual employment and income data
-   *
-   * Note: Income information is returned 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.
-   */
-  retrieveMany(body, options) {
-    return this.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
-      body,
-      method: 'post',
-      ...options,
-    });
-  }
+    /**
+     * Read individual employment and income data
+     *
+     * Note: Income information is returned 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.
+     */
+    retrieveMany(body, options) {
+        return this.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
 }
-export class EmploymentDataResponsesPage extends ResponsesPage {}
-(function (Employments) {})(Employments || (Employments = {}));
-//# sourceMappingURL=employments.mjs.map
+export class EmploymentDataResponsesPage extends ResponsesPage {
+}
+(function (Employments) {
+})(Employments || (Employments = {}));
+//# sourceMappingURL=employments.mjs.map

package/resources/hris/hris.d.ts

@@ -1,20 +1,20 @@
 import { APIResource } from '@tryfinch/finch-api/resource';
-import { CompanyResource } from './company.js';
-import { Directory } from './directory.js';
-import { Individuals } from './individuals.js';
-import { Employments } from './employments.js';
-import { Payments } from './payments.js';
-import { PayStatements } from './pay-statements.js';
-import { Benefits } from './benefits/benefits.js';
-import * as API from './index.js';
+import { CompanyResource } from "./company.js";
+import { Directory } from "./directory.js";
+import { Individuals } from "./individuals.js";
+import { Employments } from "./employments.js";
+import { Payments } from "./payments.js";
+import { PayStatements } from "./pay-statements.js";
+import { Benefits } from "./benefits/benefits.js";
+import * as API from "./index.js";
 export declare class HRIS extends APIResource {
-  company: CompanyResource;
-  directory: Directory;
-  individuals: Individuals;
-  employments: Employments;
-  payments: Payments;
-  payStatements: PayStatements;
-  benefits: Benefits;
+    company: CompanyResource;
+    directory: Directory;
+    individuals: Individuals;
+    employments: Employments;
+    payments: Payments;
+    payStatements: PayStatements;
+    benefits: Benefits;
 }
 /**
  * The employee's income as reported by the provider. This may not always be
@@ -22,120 +22,110 @@ export declare class HRIS extends APIResource {
  * depending on what information the provider returns.
  */
 export interface Income {
-  /**
-   * The income amount in cents.
-   */
-  amount?: number | null;
-  /**
-   * The currency code.
-   */
-  currency?: string | null;
-  /**
-   * The date the income amount went into effect.
-   */
-  effective_date?: string | null;
-  /**
-   * The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
-   * `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
-   */
-  unit?:
-    | 'yearly'
-    | 'quarterly'
-    | 'monthly'
-    | 'semi_monthly'
-    | 'bi_weekly'
-    | 'weekly'
-    | 'daily'
-    | 'hourly'
-    | 'fixed'
-    | null;
+    /**
+     * The income amount in cents.
+     */
+    amount?: number | null;
+    /**
+     * The currency code.
+     */
+    currency?: string | null;
+    /**
+     * The date the income amount went into effect.
+     */
+    effective_date?: string | null;
+    /**
+     * The income unit of payment. Options: `yearly`, `quarterly`, `monthly`,
+     * `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.
+     */
+    unit?: 'yearly' | 'quarterly' | 'monthly' | 'semi_monthly' | 'bi_weekly' | 'weekly' | 'daily' | 'hourly' | 'fixed' | null;
 }
 export interface Location {
-  /**
-   * City, district, suburb, town, or village.
-   */
-  city?: string | null;
-  /**
-   * The 2-letter ISO 3166 country code.
-   */
-  country?: string | null;
-  /**
-   * Street address or PO box.
-   */
-  line1?: string | null;
-  /**
-   * Apartment, suite, unit, or building.
-   */
-  line2?: string | null;
-  name?: string | null;
-  /**
-   * The postal code or zip code.
-   */
-  postal_code?: string | null;
-  source_id?: string | null;
-  /**
-   * The state code.
-   */
-  state?: string | null;
+    /**
+     * City, district, suburb, town, or village.
+     */
+    city?: string | null;
+    /**
+     * The 2-letter ISO 3166 country code.
+     */
+    country?: string | null;
+    /**
+     * Street address or PO box.
+     */
+    line1?: string | null;
+    /**
+     * Apartment, suite, unit, or building.
+     */
+    line2?: string | null;
+    name?: string | null;
+    /**
+     * The postal code or zip code.
+     */
+    postal_code?: string | null;
+    source_id?: string | null;
+    /**
+     * The state code.
+     */
+    state?: string | null;
 }
 export interface Money {
-  /**
-   * Amount for money object (in cents)
-   */
-  amount?: number;
-  currency?: string;
+    /**
+     * Amount for money object (in cents)
+     */
+    amount?: number;
+    currency?: string;
 }
 export interface Paging {
-  /**
-   * The total number of elements for the entire query (not just the given page)
-   */
-  count?: number;
-  /**
-   * The current start index of the returned list of elements
-   */
-  offset?: number;
+    /**
+     * The total number of elements for the entire query (not just the given page)
+     */
+    count?: number;
+    /**
+     * The current start index of the returned list of elements
+     */
+    offset?: number;
 }
 export declare namespace HRIS {
-  export import Income = API.Income;
-  export import Location = API.Location;
-  export import Money = API.Money;
-  export import Paging = API.Paging;
-  export import CompanyResource = API.CompanyResource;
-  export import Company = API.Company;
-  export import Directory = API.Directory;
-  export import IndividualInDirectory = API.IndividualInDirectory;
-  export import DirectoryListIndividualsParams = API.DirectoryListIndividualsParams;
-  export import Individuals = API.Individuals;
-  export import Individual = API.Individual;
-  export import IndividualResponse = API.IndividualResponse;
-  export import IndividualResponsesPage = API.IndividualResponsesPage;
-  export import IndividualRetrieveManyParams = API.IndividualRetrieveManyParams;
-  export import Employments = API.Employments;
-  export import EmploymentData = API.EmploymentData;
-  export import EmploymentDataResponse = API.EmploymentDataResponse;
-  export import EmploymentDataResponsesPage = API.EmploymentDataResponsesPage;
-  export import EmploymentRetrieveManyParams = API.EmploymentRetrieveManyParams;
-  export import Payments = API.Payments;
-  export import Payment = API.Payment;
-  export import PaymentsSinglePage = API.PaymentsSinglePage;
-  export import PaymentListParams = API.PaymentListParams;
-  export import PayStatements = API.PayStatements;
-  export import PayStatement = API.PayStatement;
-  export import PayStatementResponse = API.PayStatementResponse;
-  export import PayStatementResponseBody = API.PayStatementResponseBody;
-  export import PayStatementResponsesPage = API.PayStatementResponsesPage;
-  export import PayStatementRetrieveManyParams = API.PayStatementRetrieveManyParams;
-  export import Benefits = API.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 import CompanyBenefitsSinglePage = API.CompanyBenefitsSinglePage;
-  export import SupportedBenefitsSinglePage = API.SupportedBenefitsSinglePage;
-  export import BenefitCreateParams = API.BenefitCreateParams;
-  export import BenefitUpdateParams = API.BenefitUpdateParams;
+    export import Income = API.Income;
+    export import Location = API.Location;
+    export import Money = API.Money;
+    export import Paging = API.Paging;
+    export import CompanyResource = API.CompanyResource;
+    export import Company = API.Company;
+    export import Directory = API.Directory;
+    export import IndividualInDirectory = API.IndividualInDirectory;
+    export import DirectoryListIndividualsParams = API.DirectoryListIndividualsParams;
+    export import Individuals = API.Individuals;
+    export import Individual = API.Individual;
+    export import IndividualResponse = API.IndividualResponse;
+    export import IndividualResponsesPage = API.IndividualResponsesPage;
+    export import IndividualRetrieveManyParams = API.IndividualRetrieveManyParams;
+    export import Employments = API.Employments;
+    export import EmploymentData = API.EmploymentData;
+    export import EmploymentDataResponse = API.EmploymentDataResponse;
+    export import EmploymentDataResponsesPage = API.EmploymentDataResponsesPage;
+    export import EmploymentRetrieveManyParams = API.EmploymentRetrieveManyParams;
+    export import Payments = API.Payments;
+    export import Payment = API.Payment;
+    export import PaymentsSinglePage = API.PaymentsSinglePage;
+    export import PaymentListParams = API.PaymentListParams;
+    export import PayStatements = API.PayStatements;
+    export import PayStatement = API.PayStatement;
+    export import PayStatementResponse = API.PayStatementResponse;
+    export import PayStatementResponseBody = API.PayStatementResponseBody;
+    export import PayStatementResponsesPage = API.PayStatementResponsesPage;
+    export import PayStatementRetrieveManyParams = API.PayStatementRetrieveManyParams;
+    export import Benefits = API.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 import CompanyBenefitsSinglePage = API.CompanyBenefitsSinglePage;
+    export import SupportedBenefitsSinglePage = API.SupportedBenefitsSinglePage;
+    export import BenefitCreateParams = API.BenefitCreateParams;
+    export import BenefitUpdateParams = API.BenefitUpdateParams;
 }
-//# sourceMappingURL=hris.d.ts.map
+//# sourceMappingURL=hris.d.ts.map