@tryfinch/finch-api 1.0.0

package/dist/cjs/resources/hris/company.d.ts

@@ -0,0 +1,104 @@
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as HRIS from '../../resources/hris';
+export declare class CompanyResource extends APIResource {
+  /**
+   * Read basic company data
+   */
+  retrieve(options?: Core.RequestOptions): Promise<Core.APIResponse<Company>>;
+}
+export interface Company {
+  /**
+   * An array of bank account objects associated with the payroll/HRIS system.
+   */
+  accounts: Array<Company.Accounts> | null;
+  /**
+   * The array of company departments.
+   */
+  departments: Array<Company.Departments | null> | null;
+  /**
+   * The employer identification number.
+   */
+  ein: string | null;
+  /**
+   * The entity type object.
+   */
+  entity: Company.Entity | null;
+  /**
+   * A stable Finch `id` (UUID v4) for the company.
+   */
+  id: string;
+  /**
+   * The legal name of the company.
+   */
+  legal_name: string | null;
+  locations: Array<HRIS.Location | null> | null;
+  /**
+   * The email of the main administrator on the account.
+   */
+  primary_email: string | null;
+  /**
+   * The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
+   */
+  primary_phone_number: string | null;
+}
+export declare namespace Company {
+  /**
+   * The entity type object.
+   */
+  interface Entity {
+    /**
+     * The tax payer subtype of the company.
+     */
+    subtype?: 's_corporation' | 'c_corporation' | 'b_corporation' | null;
+    /**
+     * The tax payer type of the company.
+     */
+    type?: 'llc' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null;
+  }
+  interface Departments {
+    /**
+     * The department name.
+     */
+    name?: string | null;
+    /**
+     * The parent department, if present.
+     */
+    parent?: Departments.Parent | null;
+  }
+  namespace Departments {
+    /**
+     * The parent department, if present.
+     */
+    interface Parent {
+      /**
+       * The parent department's name.
+       */
+      name?: string | null;
+    }
+  }
+  interface Accounts {
+    /**
+     * The name of the bank associated in the payroll/HRIS system.
+     */
+    account_name?: string | null;
+    /**
+     * 10-12 digit number to specify the bank account
+     */
+    account_number?: string | null;
+    /**
+     * The type of bank account.
+     */
+    account_type?: 'checking' | 'savings' | null;
+    /**
+     * Name of the banking institution.
+     */
+    institution_name?: string | null;
+    /**
+     * A nine-digit code that's based on the U.S. Bank location where your account was
+     * opened.
+     */
+    routing_number?: string | null;
+  }
+}
+//# sourceMappingURL=company.d.ts.map

package/dist/cjs/resources/hris/company.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"company.d.ts","sourceRoot":"","sources":["../../../../resources/hris/company.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AAEzC,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;CAG5E;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;CACrC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,CAAC,EAAE,eAAe,GAAG,eAAe,GAAG,eAAe,GAAG,IAAI,CAAC;QAErE;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,GAAG,aAAa,GAAG,iBAAiB,GAAG,YAAY,GAAG,aAAa,GAAG,aAAa,GAAG,IAAI,CAAC;KACxG;IAED,UAAiB,WAAW;QAC1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,WAAW,CAAC;QAC3B;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,YAAY,CAAC,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI,CAAC;QAE7C;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEjC;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;CACF"}

package/dist/cjs/resources/hris/company.js

@@ -0,0 +1,15 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.CompanyResource = void 0;
+const resource_1 = require('../../resource');
+class CompanyResource extends resource_1.APIResource {
+  /**
+   * Read basic company data
+   */
+  retrieve(options) {
+    return this.get('/employer/company', options);
+  }
+}
+exports.CompanyResource = CompanyResource;
+//# sourceMappingURL=company.js.map

package/dist/cjs/resources/hris/company.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"company.js","sourceRoot":"","sources":["../../../../resources/hris/company.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AAGzC,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;OAEG;IACH,QAAQ,CAAC,OAA6B;QACpC,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;CACF;AAPD,0CAOC"}

package/dist/cjs/resources/hris/directory.d.ts

@@ -0,0 +1,65 @@
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { IndividualsPage, IndividualsPageParams } from '../../pagination';
+export declare class Directory extends APIResource {
+  /**
+   * Read company directory and organization structure
+   */
+  listIndividuals(
+    query?: DirectoryListIndividualsParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<IndividualsPage>;
+  listIndividuals(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage>;
+}
+export interface IndividualInDirectory {
+  /**
+   * The department object.
+   */
+  department?: IndividualInDirectory.Department | null;
+  /**
+   * The legal first name of the individual.
+   */
+  first_name?: string | null;
+  /**
+   * A stable Finch id (UUID v4) for an individual in the company.
+   */
+  id?: string;
+  /**
+   * `true` if the individual is an active employee or contractor at the company.
+   */
+  is_active?: boolean | null;
+  /**
+   * The legal last name of the individual.
+   */
+  last_name?: string | null;
+  /**
+   * The manager object.
+   */
+  manager?: IndividualInDirectory.Manager | null;
+  /**
+   * The legal middle name of the individual.
+   */
+  middle_name?: string | null;
+}
+export declare namespace IndividualInDirectory {
+  /**
+   * The manager object.
+   */
+  interface Manager {
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company.
+     */
+    id?: string;
+  }
+  /**
+   * The department object.
+   */
+  interface Department {
+    /**
+     * The name of the department.
+     */
+    name?: string | null;
+  }
+}
+export interface DirectoryListIndividualsParams extends IndividualsPageParams {}
+//# sourceMappingURL=directory.d.ts.map

package/dist/cjs/resources/hris/directory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"directory.d.ts","sourceRoot":"","sources":["../../../../resources/hris/directory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAEtE,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,eAAe,CACb,KAAK,CAAC,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC;IACpC,eAAe,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC;CAUlF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC,UAAU,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC,OAAO,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;CAAG"}

package/dist/cjs/resources/hris/directory.js

@@ -0,0 +1,21 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.Directory = void 0;
+const resource_1 = require('../../resource');
+const core_1 = require('../../core');
+const pagination_1 = require('../../pagination');
+class Directory extends resource_1.APIResource {
+  listIndividuals(query = {}, options) {
+    if ((0, core_1.isRequestOptions)(query)) {
+      return this.listIndividuals({}, query);
+    }
+    return this.getAPIList(
+      '/employer/directory',
+      pagination_1.IndividualsPage,
+      Object.assign({ query }, options),
+    );
+  }
+}
+exports.Directory = Directory;
+//# sourceMappingURL=directory.js.map

package/dist/cjs/resources/hris/directory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"directory.js","sourceRoot":"","sources":["../../../../resources/hris/directory.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAC1C,6CAAsE;AAEtE,MAAa,SAAU,SAAQ,sBAAW;IASxC,eAAe,CACb,QAA8D,EAAE,EAChE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACxC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,qBAAqB,EAAE,4BAAe,kBAAI,KAAK,IAAK,OAAO,EAAG,CAAC;IACxF,CAAC;CACF;AAlBD,8BAkBC"}

package/dist/cjs/resources/hris/hris.d.ts

@@ -0,0 +1,95 @@
+import { APIResource } from '../../resource';
+import { CompanyResource } from './company';
+import { Payments } from './payments';
+import { PayStatements } from './pay-statements';
+import { Directory } from './directory';
+import { Individuals } from './individuals/individuals';
+import { Benefits } from './benefits/benefits';
+export declare class HRIS extends APIResource {
+  company: CompanyResource;
+  payments: Payments;
+  payStatements: PayStatements;
+  directory: Directory;
+  individuals: Individuals;
+  benefits: Benefits;
+}
+/**
+ * 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.
+ */
+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;
+}
+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;
+}
+export interface Money {
+  /**
+   * 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;
+}
+//# sourceMappingURL=hris.d.ts.map

package/dist/cjs/resources/hris/hris.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hris.d.ts","sourceRoot":"","sources":["../../../../resources/hris/hris.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,qBAAa,IAAK,SAAQ,WAAW;IACnC,OAAO,EAAE,eAAe,CAAoC;IAC5D,QAAQ,EAAE,QAAQ,CAA6B;IAC/C,aAAa,EAAE,aAAa,CAAkC;IAC9D,SAAS,EAAE,SAAS,CAA8B;IAClD,WAAW,EAAE,WAAW,CAAgC;IACxD,QAAQ,EAAE,QAAQ,CAA6B;CAChD;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,CAAC,EACD,QAAQ,GACR,WAAW,GACX,SAAS,GACT,cAAc,GACd,WAAW,GACX,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,OAAO,GACP,IAAI,CAAC;CACV;AAED,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/cjs/resources/hris/hris.js

@@ -0,0 +1,24 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.HRIS = void 0;
+const resource_1 = require('../../resource');
+const company_1 = require('./company');
+const payments_1 = require('./payments');
+const pay_statements_1 = require('./pay-statements');
+const directory_1 = require('./directory');
+const individuals_1 = require('./individuals/individuals');
+const benefits_1 = require('./benefits/benefits');
+class HRIS extends resource_1.APIResource {
+  constructor() {
+    super(...arguments);
+    this.company = new company_1.CompanyResource(this.client);
+    this.payments = new payments_1.Payments(this.client);
+    this.payStatements = new pay_statements_1.PayStatements(this.client);
+    this.directory = new directory_1.Directory(this.client);
+    this.individuals = new individuals_1.Individuals(this.client);
+    this.benefits = new benefits_1.Benefits(this.client);
+  }
+}
+exports.HRIS = HRIS;
+//# sourceMappingURL=hris.js.map

package/dist/cjs/resources/hris/hris.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hris.js","sourceRoot":"","sources":["../../../../resources/hris/hris.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,yCAAyC;AACzC,uCAA4C;AAC5C,yCAAsC;AACtC,qDAAiD;AACjD,2CAAwC;AACxC,2DAAwD;AACxD,kDAA+C;AAE/C,MAAa,IAAK,SAAQ,sBAAW;IAArC;;QACE,YAAO,GAAoB,IAAI,yBAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5D,aAAQ,GAAa,IAAI,mBAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/C,kBAAa,GAAkB,IAAI,8BAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9D,cAAS,GAAc,IAAI,qBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClD,gBAAW,GAAgB,IAAI,yBAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxD,aAAQ,GAAa,IAAI,mBAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;CAAA;AAPD,oBAOC"}

package/dist/cjs/resources/hris/index.d.ts

@@ -0,0 +1,31 @@
+export {
+  BenefitFrequency,
+  BenefitType,
+  BenfitContribution,
+  CompanyBenefit,
+  CreateCompanyBenefitsResponse,
+  SupportedBenefit,
+  UpdateCompanyBenefitResponse,
+  BenefitCreateParams,
+  BenefitUpdateParams,
+  CompanyBenefitsSinglePage,
+  SupportedBenefitsSinglePage,
+} from './benefits';
+export { Company } from './company';
+export { Income, Location, Money, Paging } from './hris';
+export {
+  Individual,
+  IndividualResponse,
+  IndividualRetrieveManyParams,
+  IndividualResponsesResponsesPage,
+} from './individuals';
+export { IndividualInDirectory, DirectoryListIndividualsParams } from './directory';
+export {
+  PayStatement,
+  PayStatementResponse,
+  PayStatementResponseBody,
+  PayStatementRetrieveManyParams,
+  PayStatementResponsesResponsesPage,
+} from './pay-statements';
+export { Payment, PaymentListParams, PaymentsSinglePage } from './payments';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/resources/hris/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../resources/hris/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,kBAAkB,EAClB,cAAc,EACd,6BAA6B,EAC7B,gBAAgB,EAChB,4BAA4B,EAC5B,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACzD,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,4BAA4B,EAC5B,gCAAgC,GACjC,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,qBAAqB,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAC;AACpF,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,wBAAwB,EACxB,8BAA8B,EAC9B,kCAAkC,GACnC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/dist/cjs/resources/hris/index.js

@@ -0,0 +1,44 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.PaymentsSinglePage =
+  exports.PayStatementResponsesResponsesPage =
+  exports.IndividualResponsesResponsesPage =
+  exports.SupportedBenefitsSinglePage =
+  exports.CompanyBenefitsSinglePage =
+    void 0;
+var benefits_1 = require('./benefits');
+Object.defineProperty(exports, 'CompanyBenefitsSinglePage', {
+  enumerable: true,
+  get: function () {
+    return benefits_1.CompanyBenefitsSinglePage;
+  },
+});
+Object.defineProperty(exports, 'SupportedBenefitsSinglePage', {
+  enumerable: true,
+  get: function () {
+    return benefits_1.SupportedBenefitsSinglePage;
+  },
+});
+var individuals_1 = require('./individuals');
+Object.defineProperty(exports, 'IndividualResponsesResponsesPage', {
+  enumerable: true,
+  get: function () {
+    return individuals_1.IndividualResponsesResponsesPage;
+  },
+});
+var pay_statements_1 = require('./pay-statements');
+Object.defineProperty(exports, 'PayStatementResponsesResponsesPage', {
+  enumerable: true,
+  get: function () {
+    return pay_statements_1.PayStatementResponsesResponsesPage;
+  },
+});
+var payments_1 = require('./payments');
+Object.defineProperty(exports, 'PaymentsSinglePage', {
+  enumerable: true,
+  get: function () {
+    return payments_1.PaymentsSinglePage;
+  },
+});
+//# sourceMappingURL=index.js.map

package/dist/cjs/resources/hris/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../resources/hris/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,uCAYoB;AAFlB,qHAAA,yBAAyB,OAAA;AACzB,uHAAA,2BAA2B,OAAA;AAI7B,6CAKuB;AADrB,+HAAA,gCAAgC,OAAA;AAGlC,mDAM0B;AADxB,oIAAA,kCAAkC,OAAA;AAEpC,uCAA4E;AAAvC,8GAAA,kBAAkB,OAAA"}

package/dist/cjs/resources/hris/individuals/employment-data.d.ts

@@ -0,0 +1,151 @@
+import * as Core from '../../../core';
+import { APIResource } from '../../../resource';
+import * as HRIS from '../../../resources/hris';
+import { ResponsesPage } from '../../../pagination';
+export declare class EmploymentData 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: EmploymentDataRetrieveManyParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<EmploymentDataResponsesResponsesPage>;
+}
+export declare class EmploymentDataResponsesResponsesPage extends ResponsesPage<EmploymentDataResponse> {}
+export interface EmploymentData {
+  /**
+   * 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;
+  /**
+   * string A stable Finch `id` (UUID v4) for an individual in the company.
+   */
+  id?: string;
+  /**
+   * 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 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;
+  }
+  /**
+   * 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;
+  }
+}
+export interface EmploymentDataResponse {
+  body?: EmploymentData;
+  code?: number;
+  individual_id?: string;
+}
+export interface EmploymentDataRetrieveManyParams {
+  /**
+   * The array of batch requests.
+   */
+  requests: Array<EmploymentDataRetrieveManyParams.Requests>;
+}
+export declare namespace EmploymentDataRetrieveManyParams {
+  interface Requests {
+    /**
+     * 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;
+  }
+  interface Requests {
+    /**
+     * 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;
+  }
+}
+//# sourceMappingURL=employment-data.d.ts.map

package/dist/cjs/resources/hris/individuals/employment-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"employment-data.d.ts","sourceRoot":"","sources":["../../../../../resources/hris/individuals/employment-data.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;OAMG;IACH,YAAY,CACV,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,oCAAoC,CAAC;CAO1D;AAED,qBAAa,oCAAqC,SAAQ,aAAa,CAAC,sBAAsB,CAAC;CAAG;AAElG,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IAE9C,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,QAAQ,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;KACb;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,MAAM,GAAG,UAAU,GAAG,uBAAuB,GAAG,IAAI,CAAC;QAEtG;;WAEG;QACH,IAAI,CAAC,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAAC;KACzC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,cAAc,CAAC;IAEtB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,gCAAgC,CAAC,QAAQ,CAAC,CAAC;CAC5D;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,QAAQ;QACvB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,QAAQ;QACvB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;CACF"}

package/dist/cjs/resources/hris/individuals/employment-data.js

@@ -0,0 +1,26 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.EmploymentDataResponsesResponsesPage = exports.EmploymentData = void 0;
+const resource_1 = require('../../../resource');
+const pagination_1 = require('../../../pagination');
+class EmploymentData 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',
+      EmploymentDataResponsesResponsesPage,
+      Object.assign({ body, method: 'post' }, options),
+    );
+  }
+}
+exports.EmploymentData = EmploymentData;
+class EmploymentDataResponsesResponsesPage extends pagination_1.ResponsesPage {}
+exports.EmploymentDataResponsesResponsesPage = EmploymentDataResponsesResponsesPage;
+//# sourceMappingURL=employment-data.js.map

package/dist/cjs/resources/hris/individuals/employment-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"employment-data.js","sourceRoot":"","sources":["../../../../../resources/hris/individuals/employment-data.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AAEzC,6CAA6C;AAE7C,MAAa,cAAe,SAAQ,sBAAW;IAC7C;;;;;;OAMG;IACH,YAAY,CACV,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,EAAE,oCAAoC,kBACjF,IAAI,EACJ,MAAM,EAAE,MAAM,IACX,OAAO,EACV,CAAC;IACL,CAAC;CACF;AAlBD,wCAkBC;AAED,MAAa,oCAAqC,SAAQ,0BAAqC;CAAG;AAAlG,oFAAkG"}

package/dist/cjs/resources/hris/individuals/index.d.ts

@@ -0,0 +1,13 @@
+export {
+  EmploymentData,
+  EmploymentDataResponse,
+  EmploymentDataRetrieveManyParams,
+  EmploymentDataResponsesResponsesPage,
+} from './employment-data';
+export {
+  Individual,
+  IndividualResponse,
+  IndividualRetrieveManyParams,
+  IndividualResponsesResponsesPage,
+} from './individuals';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/resources/hris/individuals/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../resources/hris/individuals/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,gCAAgC,EAChC,oCAAoC,GACrC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,4BAA4B,EAC5B,gCAAgC,GACjC,MAAM,eAAe,CAAC"}