@tryfinch/finch-api 1.0.0

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

@@ -0,0 +1,28 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.IndividualResponsesResponsesPage =
+  exports.EmploymentDataResponsesResponsesPage =
+  exports.EmploymentData =
+    void 0;
+var employment_data_1 = require('./employment-data');
+Object.defineProperty(exports, 'EmploymentData', {
+  enumerable: true,
+  get: function () {
+    return employment_data_1.EmploymentData;
+  },
+});
+Object.defineProperty(exports, 'EmploymentDataResponsesResponsesPage', {
+  enumerable: true,
+  get: function () {
+    return employment_data_1.EmploymentDataResponsesResponsesPage;
+  },
+});
+var individuals_1 = require('./individuals');
+Object.defineProperty(exports, 'IndividualResponsesResponsesPage', {
+  enumerable: true,
+  get: function () {
+    return individuals_1.IndividualResponsesResponsesPage;
+  },
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../resources/hris/individuals/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,qDAK2B;AAJzB,iHAAA,cAAc,OAAA;AAGd,uIAAA,oCAAoC,OAAA;AAEtC,6CAKuB;AADrB,+HAAA,gCAAgC,OAAA"}

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

@@ -0,0 +1,86 @@
+import * as Core from '../../../core';
+import { APIResource } from '../../../resource';
+import * as HRIS from '../../../resources/hris';
+import { EmploymentData } from './employment-data';
+import { ResponsesPage } from '../../../pagination';
+export declare class Individuals extends APIResource {
+  employmentData: EmploymentData;
+  /**
+   * Read individual data, excluding income and employment data
+   */
+  retrieveMany(
+    body?: IndividualRetrieveManyParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<IndividualResponsesResponsesPage>;
+  retrieveMany(options?: Core.RequestOptions): Core.PagePromise<IndividualResponsesResponsesPage>;
+}
+export declare class IndividualResponsesResponsesPage extends ResponsesPage<IndividualResponse> {}
+export interface Individual {
+  dob?: string | null;
+  emails?: Array<Individual.Emails> | null;
+  /**
+   * The legal first name of the individual.
+   */
+  first_name?: string | null;
+  /**
+   * The gender of the individual.
+   */
+  gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
+  /**
+   * A stable Finch `id` (UUID v4) for an individual in the company.
+   */
+  id?: string;
+  /**
+   * The legal last name of the individual.
+   */
+  last_name?: string | null;
+  /**
+   * The legal middle name of the individual.
+   */
+  middle_name?: string | null;
+  phone_numbers?: Array<Individual.PhoneNumbers | null> | null;
+  /**
+   * The preferred name of the individual.
+   */
+  preferred_name?: string | null;
+  residence?: HRIS.Location | null;
+  /**
+   * Note: This property is only available if enabled for your account. Please reach
+   * out to your Finch representative if you would like access.
+   */
+  ssn?: string | null;
+}
+export declare namespace Individual {
+  interface Emails {
+    data?: string;
+    type?: 'work' | 'personal';
+  }
+  interface PhoneNumbers {
+    data?: string | null;
+    type?: 'work' | 'personal' | null;
+  }
+}
+export interface IndividualResponse {
+  body?: Individual;
+  code?: number;
+  individual_id?: string;
+}
+export interface IndividualRetrieveManyParams {
+  options?: IndividualRetrieveManyParams.Options | null;
+  requests?: Array<IndividualRetrieveManyParams.Requests>;
+}
+export declare namespace IndividualRetrieveManyParams {
+  interface Requests {
+    individual_id?: string;
+  }
+  interface Options {
+    include?: Array<string>;
+  }
+  interface Options {
+    include?: Array<string>;
+  }
+  interface Requests {
+    individual_id?: string;
+  }
+}
+//# sourceMappingURL=individuals.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"individuals.d.ts","sourceRoot":"","sources":["../../../../../resources/hris/individuals/individuals.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,qBAAa,WAAY,SAAQ,WAAW;IAC1C,cAAc,EAAE,cAAc,CAAmC;IAEjE;;OAEG;IACH,YAAY,CACV,IAAI,CAAC,EAAE,4BAA4B,EACnC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,gCAAgC,CAAC;IACrD,YAAY,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,gCAAgC,CAAC;CAchG;AAED,qBAAa,gCAAiC,SAAQ,aAAa,CAAC,kBAAkB,CAAC;CAAG;AAE1F,MAAM,WAAW,UAAU;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,oBAAoB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,SAAS,CAAC,EAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,MAAM;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;KAC5B;IAED,UAAiB,YAAY;QAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;KACnC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,4BAA4B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEtD,QAAQ,CAAC,EAAE,KAAK,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;CACzD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C,UAAiB,QAAQ;QACvB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IAED,UAAiB,OAAO;QACtB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;IAED,UAAiB,OAAO;QACtB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACzB;IAED,UAAiB,QAAQ;QACvB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF"}

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

@@ -0,0 +1,28 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.IndividualResponsesResponsesPage = exports.Individuals = void 0;
+const resource_1 = require('../../../resource');
+const core_1 = require('../../../core');
+const employment_data_1 = require('./employment-data');
+const pagination_1 = require('../../../pagination');
+class Individuals extends resource_1.APIResource {
+  constructor() {
+    super(...arguments);
+    this.employmentData = new employment_data_1.EmploymentData(this.client);
+  }
+  retrieveMany(body = {}, options) {
+    if ((0, core_1.isRequestOptions)(body)) {
+      return this.retrieveMany({}, body);
+    }
+    return this.getAPIList(
+      '/employer/individual',
+      IndividualResponsesResponsesPage,
+      Object.assign({ body, method: 'post' }, options),
+    );
+  }
+}
+exports.Individuals = Individuals;
+class IndividualResponsesResponsesPage extends pagination_1.ResponsesPage {}
+exports.IndividualResponsesResponsesPage = IndividualResponsesResponsesPage;
+//# sourceMappingURL=individuals.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"individuals.js","sourceRoot":"","sources":["../../../../../resources/hris/individuals/individuals.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,iCAA0C;AAE1C,uDAAmD;AACnD,6CAA6C;AAE7C,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,mBAAc,GAAmB,IAAI,gCAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAuBnE,CAAC;IAbC,YAAY,CACV,OAA2D,EAAE,EAC7D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,IAAI,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,EAAE,gCAAgC,kBAC7E,IAAI,EACJ,MAAM,EAAE,MAAM,IACX,OAAO,EACV,CAAC;IACL,CAAC;CACF;AAxBD,kCAwBC;AAED,MAAa,gCAAiC,SAAQ,0BAAiC;CAAG;AAA1F,4EAA0F"}

package/dist/cjs/resources/hris/pay-statements.d.ts

@@ -0,0 +1,201 @@
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as HRIS from '../../resources/hris';
+import * as Benefits from '../../resources/hris/benefits';
+import { ResponsesPage } from '../../pagination';
+export declare class PayStatements extends APIResource {
+  /**
+   * Read detailed pay statements for each individual.
+   *
+   * Deduction and contribution types are supported by the payroll systems that
+   * support Benefits.
+   */
+  retrieveMany(
+    body: PayStatementRetrieveManyParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PayStatementResponsesResponsesPage>;
+}
+export declare class PayStatementResponsesResponsesPage extends ResponsesPage<PayStatementResponse> {}
+export interface PayStatement {
+  /**
+   * The array of earnings objects associated with this pay statement
+   */
+  earnings?: Array<PayStatement.Earnings | null> | null;
+  /**
+   * The array of deductions objects associated with this pay statement.
+   */
+  employee_deductions?: Array<PayStatement.EmployeeDeductions | null> | null;
+  employer_contributions?: Array<PayStatement.EmployerContributions | null> | null;
+  gross_pay?: HRIS.Money | null;
+  /**
+   * A stable Finch `id` (UUID v4) for an individual in the company
+   */
+  individual_id?: string;
+  net_pay?: HRIS.Money | null;
+  /**
+   * The payment method.
+   */
+  payment_method?: 'check' | 'direct_deposit' | null;
+  /**
+   * The array of taxes objects associated with this pay statement.
+   */
+  taxes?: Array<PayStatement.Taxes | null> | null;
+  /**
+   * The number of hours worked for this pay period
+   */
+  total_hours?: number | null;
+  /**
+   * The type of the payment associated with the pay statement.
+   */
+  type?: 'regular_payroll' | 'off_cycle_payroll' | 'one_time_payment' | null;
+}
+export declare namespace PayStatement {
+  interface Earnings {
+    /**
+     * The earnings amount in cents.
+     */
+    amount?: number | null;
+    /**
+     * The earnings currency code.
+     */
+    currency?: string | null;
+    /**
+     * The number of hours associated with this earning. (For salaried employees, this
+     * could be hours per pay period, `0` or `null`, depending on the provider).
+     */
+    hours?: number | null;
+    /**
+     * The exact name of the deduction from the pay statement.
+     */
+    name?: string | null;
+    /**
+     * The type of earning.
+     */
+    type?:
+      | 'salary'
+      | 'wage'
+      | 'reimbursement'
+      | 'overtime'
+      | 'severance'
+      | 'double_overtime'
+      | 'pto'
+      | 'sick'
+      | 'bonus'
+      | 'commission'
+      | 'tips'
+      | '1099'
+      | 'other'
+      | null;
+  }
+  interface Taxes {
+    /**
+     * The tax amount in cents.
+     */
+    amount?: number | null;
+    /**
+     * The currency code.
+     */
+    currency?: string | null;
+    /**
+     * `true` if the amount is paid by the employers.
+     */
+    employer?: boolean | null;
+    /**
+     * The exact name of tax from the pay statement.
+     */
+    name?: string | null;
+    /**
+     * The type of taxes.
+     */
+    type?: 'state' | 'federal' | 'local' | 'fica' | null;
+  }
+  interface EmployeeDeductions {
+    /**
+     * The deduction amount in cents.
+     */
+    amount?: number | null;
+    /**
+     * The deduction currency.
+     */
+    currency?: string | null;
+    /**
+     * The deduction name from the pay statement.
+     */
+    name?: string | null;
+    /**
+     * Boolean indicating if the deduction is pre-tax.
+     */
+    pre_tax?: boolean | null;
+    /**
+     * Type of benefit.
+     */
+    type?: Benefits.BenefitType | null;
+  }
+  interface EmployerContributions {
+    /**
+     * The contribution amount in cents.
+     */
+    amount?: number | null;
+    /**
+     * The contribution currency.
+     */
+    currency?: string | null;
+    /**
+     * The contribution name from the pay statement.
+     */
+    name?: string | null;
+    /**
+     * Type of benefit.
+     */
+    type?: Benefits.BenefitType | null;
+  }
+}
+export interface PayStatementResponse {
+  body?: PayStatementResponseBody;
+  code?: number;
+  payment_id?: string;
+}
+export interface PayStatementResponseBody {
+  paging?: HRIS.Paging;
+  /**
+   * The array of pay statements for the current payment.
+   */
+  pay_statements?: Array<PayStatement>;
+}
+export interface PayStatementRetrieveManyParams {
+  /**
+   * The array of batch requests.
+   */
+  requests: Array<PayStatementRetrieveManyParams.Requests>;
+}
+export declare namespace PayStatementRetrieveManyParams {
+  interface Requests {
+    /**
+     * A stable Finch `id` (UUID v4) for a payment.
+     */
+    payment_id: string;
+    /**
+     * Number of pay statements to return (defaults to all).
+     */
+    limit?: number;
+    /**
+     * Index to start from.
+     */
+    offset?: number;
+  }
+  interface Requests {
+    /**
+     * A stable Finch `id` (UUID v4) for a payment.
+     */
+    payment_id: string;
+    /**
+     * Number of pay statements to return (defaults to all).
+     */
+    limit?: number;
+    /**
+     * Index to start from.
+     */
+    offset?: number;
+  }
+}
+//# sourceMappingURL=pay-statements.d.ts.map

package/dist/cjs/resources/hris/pay-statements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay-statements.d.ts","sourceRoot":"","sources":["../../../../resources/hris/pay-statements.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,KAAK,QAAQ,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;;;;OAKG;IACH,YAAY,CACV,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,kCAAkC,CAAC;CAOxD;AAED,qBAAa,kCAAmC,SAAQ,aAAa,CAAC,oBAAoB,CAAC;CAAG;AAE9F,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAE3E,sBAAsB,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,qBAAqB,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEjF,SAAS,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,OAAO,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,kBAAkB,GAAG,IAAI,CAAC;CAC5E;AAED,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,QAAQ;QACvB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EACD,QAAQ,GACR,MAAM,GACN,eAAe,GACf,UAAU,GACV,WAAW,GACX,iBAAiB,GACjB,KAAK,GACL,MAAM,GACN,OAAO,GACP,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,CAAC;KACV;IAED,UAAiB,KAAK;QACpB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;KACtD;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,qBAAqB;QACpC;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,QAAQ,CAAC,WAAW,GAAG,IAAI,CAAC;KACpC;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,wBAAwB,CAAC;IAEhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;CAC1D;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,QAAQ;QACvB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF"}

package/dist/cjs/resources/hris/pay-statements.js

@@ -0,0 +1,25 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.PayStatementResponsesResponsesPage = exports.PayStatements = void 0;
+const resource_1 = require('../../resource');
+const pagination_1 = require('../../pagination');
+class PayStatements extends resource_1.APIResource {
+  /**
+   * Read detailed pay statements for each individual.
+   *
+   * Deduction and contribution types are supported by the payroll systems that
+   * support Benefits.
+   */
+  retrieveMany(body, options) {
+    return this.getAPIList(
+      '/employer/pay-statement',
+      PayStatementResponsesResponsesPage,
+      Object.assign({ body, method: 'post' }, options),
+    );
+  }
+}
+exports.PayStatements = PayStatements;
+class PayStatementResponsesResponsesPage extends pagination_1.ResponsesPage {}
+exports.PayStatementResponsesResponsesPage = PayStatementResponsesResponsesPage;
+//# sourceMappingURL=pay-statements.js.map

package/dist/cjs/resources/hris/pay-statements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pay-statements.js","sourceRoot":"","sources":["../../../../resources/hris/pay-statements.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AAGzC,6CAA6C;AAE7C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;OAKG;IACH,YAAY,CACV,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,kCAAkC,kBAClF,IAAI,EACJ,MAAM,EAAE,MAAM,IACX,OAAO,EACV,CAAC;IACL,CAAC;CACF;AAjBD,sCAiBC;AAED,MAAa,kCAAmC,SAAQ,0BAAmC;CAAG;AAA9F,gFAA8F"}

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

@@ -0,0 +1,54 @@
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import * as HRIS from '../../resources/hris';
+import { SinglePage } from '../../pagination';
+export declare class Payments extends APIResource {
+  /**
+   * Read payroll and contractor related payments by the company.
+   */
+  list(query: PaymentListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentsSinglePage>;
+}
+export declare class PaymentsSinglePage extends SinglePage<Payment> {}
+export interface Payment {
+  company_debit?: HRIS.Money | null;
+  debit_date?: string | null;
+  employee_taxes?: HRIS.Money | null;
+  employer_taxes?: HRIS.Money | null;
+  gross_pay?: HRIS.Money | null;
+  /**
+   * The unique id for the payment.
+   */
+  id?: string;
+  /**
+   * Array of every individual on this payment.
+   */
+  individual_ids?: Array<string> | null;
+  net_pay?: HRIS.Money | null;
+  pay_date?: string | null;
+  /**
+   * The pay period object.
+   */
+  pay_period?: Payment.PayPeriod | null;
+}
+export declare namespace Payment {
+  /**
+   * The pay period object.
+   */
+  interface PayPeriod {
+    end_date?: string | null;
+    start_date?: string | null;
+  }
+}
+export interface PaymentListParams {
+  /**
+   * The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
+   * format.
+   */
+  end_date: string;
+  /**
+   * The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
+   * format.
+   */
+  start_date: string;
+}
+//# sourceMappingURL=payments.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../../../resources/hris/payments.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,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC;CAGpG;AAED,qBAAa,kBAAmB,SAAQ,UAAU,CAAC,OAAO,CAAC;CAAG;AAE9D,MAAM,WAAW,OAAO;IACtB,aAAa,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAElC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,cAAc,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAEnC,cAAc,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAEnC,SAAS,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEtC,OAAO,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAE5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC;CACvC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,SAAS;QACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB"}

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

@@ -0,0 +1,18 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.PaymentsSinglePage = exports.Payments = void 0;
+const resource_1 = require('../../resource');
+const pagination_1 = require('../../pagination');
+class Payments extends resource_1.APIResource {
+  /**
+   * Read payroll and contractor related payments by the company.
+   */
+  list(query, options) {
+    return this.getAPIList('/employer/payment', PaymentsSinglePage, Object.assign({ query }, options));
+  }
+}
+exports.Payments = Payments;
+class PaymentsSinglePage extends pagination_1.SinglePage {}
+exports.PaymentsSinglePage = PaymentsSinglePage;
+//# sourceMappingURL=payments.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../../../resources/hris/payments.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AAEzC,6CAA0C;AAE1C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,IAAI,CAAC,KAAwB,EAAE,OAA6B;QAC1D,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,kBAAkB,kBAAI,KAAK,IAAK,OAAO,EAAG,CAAC;IACzF,CAAC;CACF;AAPD,4BAOC;AAED,MAAa,kBAAmB,SAAQ,uBAAmB;CAAG;AAA9D,gDAA8D"}

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

@@ -0,0 +1,5 @@
+export { ATS } from './ats/ats';
+export { DisconnectResponse, Introspection, Account } from './account';
+export { Income, Location, Money, Paging, HRIS } from './hris/hris';
+export { Provider, ProvidersSinglePage, Providers } from './providers';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/dist/cjs/resources/index.js

@@ -0,0 +1,39 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.Providers = exports.ProvidersSinglePage = exports.HRIS = exports.Account = exports.ATS = void 0;
+var ats_1 = require('./ats/ats');
+Object.defineProperty(exports, 'ATS', {
+  enumerable: true,
+  get: function () {
+    return ats_1.ATS;
+  },
+});
+var account_1 = require('./account');
+Object.defineProperty(exports, 'Account', {
+  enumerable: true,
+  get: function () {
+    return account_1.Account;
+  },
+});
+var hris_1 = require('./hris/hris');
+Object.defineProperty(exports, 'HRIS', {
+  enumerable: true,
+  get: function () {
+    return hris_1.HRIS;
+  },
+});
+var providers_1 = require('./providers');
+Object.defineProperty(exports, 'ProvidersSinglePage', {
+  enumerable: true,
+  get: function () {
+    return providers_1.ProvidersSinglePage;
+  },
+});
+Object.defineProperty(exports, 'Providers', {
+  enumerable: true,
+  get: function () {
+    return providers_1.Providers;
+  },
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../resources/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,iCAAgC;AAAvB,0FAAA,GAAG,OAAA;AACZ,qCAAuE;AAA3B,kGAAA,OAAO,OAAA;AACnD,oCAAoE;AAA1B,4FAAA,IAAI,OAAA;AAC9C,yCAAuE;AAApD,gHAAA,mBAAmB,OAAA;AAAE,sGAAA,SAAS,OAAA"}

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

@@ -0,0 +1,46 @@
+import * as Core from '../core';
+import { APIResource } from '../resource';
+import { SinglePage } from '../pagination';
+export declare class Providers extends APIResource {
+  /**
+   * Return details on all available payroll and HR systems.
+   */
+  list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage>;
+}
+export declare class ProvidersSinglePage extends SinglePage<Provider> {}
+export interface Provider {
+  /**
+   * The display name of the payroll provider.
+   */
+  display_name?: string;
+  /**
+   * The url to the official icon of the payroll provider.
+   */
+  icon?: string;
+  /**
+   * The id of the payroll provider used in Connect.
+   */
+  id?: string;
+  /**
+   * The url to the official logo of the payroll provider.
+   */
+  logo?: string;
+  /**
+   * Whether the Finch integration with this provider uses the Assisted Connect Flow
+   * by default.
+   */
+  manual?: boolean;
+  /**
+   * whether MFA is required for the provider.
+   */
+  mfa_required?: boolean;
+  /**
+   * The hex code for the primary color of the payroll provider.
+   */
+  primary_color?: string;
+  /**
+   * The list of Finch products supported on this payroll provider.
+   */
+  products?: Array<string>;
+}
+//# sourceMappingURL=providers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../../../resources/providers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC;CAG3E;AAED,qBAAa,mBAAoB,SAAQ,UAAU,CAAC,QAAQ,CAAC;CAAG;AAEhE,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B"}

package/dist/cjs/resources/providers.js

@@ -0,0 +1,18 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.ProvidersSinglePage = exports.Providers = void 0;
+const resource_1 = require('../resource');
+const pagination_1 = require('../pagination');
+class Providers extends resource_1.APIResource {
+  /**
+   * Return details on all available payroll and HR systems.
+   */
+  list(options) {
+    return this.getAPIList('/providers', ProvidersSinglePage, options);
+  }
+}
+exports.Providers = Providers;
+class ProvidersSinglePage extends pagination_1.SinglePage {}
+exports.ProvidersSinglePage = ProvidersSinglePage;
+//# sourceMappingURL=providers.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../../../resources/providers.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,yCAAyC;AACzC,6CAA0C;AAE1C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AAPD,8BAOC;AAED,MAAa,mBAAoB,SAAQ,uBAAoB;CAAG;AAAhE,kDAAgE"}

package/dist/cjs/resources/top-level.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=top-level.d.ts.map

package/dist/cjs/resources/top-level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"top-level.d.ts","sourceRoot":"","sources":["../../../resources/top-level.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC"}

package/dist/cjs/resources/top-level.js

@@ -0,0 +1,4 @@
+'use strict';
+// File generated from our OpenAPI spec by Stainless.
+Object.defineProperty(exports, '__esModule', { value: true });
+//# sourceMappingURL=top-level.js.map

package/dist/cjs/resources/top-level.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"top-level.js","sourceRoot":"","sources":["../../../resources/top-level.ts"],"names":[],"mappings":";AAAA,qDAAqD"}

package/dist/cjs/tests/api-resources/account.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=account.test.d.ts.map

package/dist/cjs/tests/api-resources/account.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.test.d.ts","sourceRoot":"","sources":["../../../../tests/api-resources/account.test.ts"],"names":[],"mappings":""}