@tryfinch/finch-api 5.1.0 → 5.3.0

package/resources/hris/individuals.mjs

@@ -3,17 +3,19 @@ import { APIResource } from '@tryfinch/finch-api/resource';
 import { isRequestOptions } from '@tryfinch/finch-api/core';
 import { ResponsesPage } from '@tryfinch/finch-api/pagination';
 export class Individuals extends APIResource {
-  retrieveMany(body = {}, options) {
-    if (isRequestOptions(body)) {
-      return this.retrieveMany({}, body);
+    retrieveMany(body = {}, options) {
+        if (isRequestOptions(body)) {
+            return this.retrieveMany({}, body);
+        }
+        return this.getAPIList('/employer/individual', IndividualResponsesPage, {
+            body,
+            method: 'post',
+            ...options,
+        });
     }
-    return this.getAPIList('/employer/individual', IndividualResponsesPage, {
-      body,
-      method: 'post',
-      ...options,
-    });
-  }
 }
-export class IndividualResponsesPage extends ResponsesPage {}
-(function (Individuals) {})(Individuals || (Individuals = {}));
-//# sourceMappingURL=individuals.mjs.map
+export class IndividualResponsesPage extends ResponsesPage {
+}
+(function (Individuals) {
+})(Individuals || (Individuals = {}));
+//# sourceMappingURL=individuals.mjs.map

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

@@ -2,196 +2,180 @@ 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 Benefits from '@tryfinch/finch-api/resources/hris/benefits/index';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { ResponsesPage } from '@tryfinch/finch-api/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<PayStatementResponsesPage, PayStatementResponse>;
+    /**
+     * 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<PayStatementResponsesPage, PayStatementResponse>;
+}
+export declare class PayStatementResponsesPage extends ResponsesPage<PayStatementResponse> {
 }
-export declare class PayStatementResponsesPage extends ResponsesPage<PayStatementResponse> {}
 type _PayStatementResponsesPage = PayStatementResponsesPage;
 export interface PayStatement {
-  /**
-   * The array of earnings objects associated with this pay statement
-   */
-  earnings?: Array<PayStatement.Earning | null> | null;
-  /**
-   * The array of deductions objects associated with this pay statement.
-   */
-  employee_deductions?: Array<PayStatement.EmployeeDeduction | null> | null;
-  employer_contributions?: Array<PayStatement.EmployerContribution | 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.Tax | 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 Earning {
-    /**
-     * 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 EmployeeDeduction {
-    /**
-     * 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.
+     * The array of earnings objects associated with this pay statement
      */
-    pre_tax?: boolean | null;
+    earnings?: Array<PayStatement.Earning | null> | null;
     /**
-     * Type of benefit.
+     * The array of deductions objects associated with this pay statement.
      */
-    type?: Benefits.BenefitType | null;
-  }
-  interface EmployerContribution {
+    employee_deductions?: Array<PayStatement.EmployeeDeduction | null> | null;
+    employer_contributions?: Array<PayStatement.EmployerContribution | null> | null;
+    gross_pay?: HRIS.Money | null;
     /**
-     * The contribution amount in cents.
+     * A stable Finch `id` (UUID v4) for an individual in the company
      */
-    amount?: number | null;
+    individual_id?: string;
+    net_pay?: HRIS.Money | null;
     /**
-     * The contribution currency.
+     * The payment method.
      */
-    currency?: string | null;
+    payment_method?: 'check' | 'direct_deposit' | null;
     /**
-     * The contribution name from the pay statement.
+     * The array of taxes objects associated with this pay statement.
      */
-    name?: string | null;
+    taxes?: Array<PayStatement.Tax | null> | null;
     /**
-     * Type of benefit.
+     * The number of hours worked for this pay period
      */
-    type?: Benefits.BenefitType | null;
-  }
-  interface Tax {
+    total_hours?: number | null;
     /**
-     * The tax amount in cents.
+     * The type of the payment associated with the pay statement.
      */
-    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;
-  }
+    type?: 'regular_payroll' | 'off_cycle_payroll' | 'one_time_payment' | null;
+}
+export declare namespace PayStatement {
+    interface Earning {
+        /**
+         * 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 EmployeeDeduction {
+        /**
+         * 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 EmployerContribution {
+        /**
+         * 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;
+    }
+    interface Tax {
+        /**
+         * 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;
+    }
 }
 export interface PayStatementResponse {
-  body?: PayStatementResponseBody;
-  code?: number;
-  payment_id?: string;
+    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.Request>;
-}
-export declare namespace PayStatementRetrieveManyParams {
-  interface Request {
-    /**
-     * A stable Finch `id` (UUID v4) for a payment.
-     */
-    payment_id: string;
+    paging?: HRIS.Paging;
     /**
-     * Number of pay statements to return (defaults to all).
+     * The array of pay statements for the current payment.
      */
-    limit?: number;
+    pay_statements?: Array<PayStatement>;
+}
+export interface PayStatementRetrieveManyParams {
     /**
-     * Index to start from.
+     * The array of batch requests.
      */
-    offset?: number;
-  }
+    requests: Array<PayStatementRetrieveManyParams.Request>;
+}
+export declare namespace PayStatementRetrieveManyParams {
+    interface Request {
+        /**
+         * 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;
+    }
 }
 export declare namespace PayStatements {
-  export import PayStatement = API.PayStatement;
-  export import PayStatementResponse = API.PayStatementResponse;
-  export import PayStatementResponseBody = API.PayStatementResponseBody;
-  type PayStatementResponsesPage = _PayStatementResponsesPage;
-  export import PayStatementRetrieveManyParams = API.PayStatementRetrieveManyParams;
+    export import PayStatement = API.PayStatement;
+    export import PayStatementResponse = API.PayStatementResponse;
+    export import PayStatementResponseBody = API.PayStatementResponseBody;
+    type PayStatementResponsesPage = _PayStatementResponsesPage;
+    export import PayStatementRetrieveManyParams = API.PayStatementRetrieveManyParams;
 }
 export {};
-//# sourceMappingURL=pay-statements.d.ts.map
+//# sourceMappingURL=pay-statements.d.ts.map

package/resources/hris/pay-statements.js

@@ -1,26 +1,28 @@
-'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.PayStatementResponsesPage = exports.PayStatements = 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 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', PayStatementResponsesPage, {
-      body,
-      method: 'post',
-      ...options,
-    });
-  }
+    /**
+     * 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', PayStatementResponsesPage, {
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
 }
 exports.PayStatements = PayStatements;
-class PayStatementResponsesPage extends pagination_1.ResponsesPage {}
+class PayStatementResponsesPage extends pagination_1.ResponsesPage {
+}
 exports.PayStatementResponsesPage = PayStatementResponsesPage;
-(function (PayStatements) {})((PayStatements = exports.PayStatements || (exports.PayStatements = {})));
-//# sourceMappingURL=pay-statements.js.map
+(function (PayStatements) {
+})(PayStatements = exports.PayStatements || (exports.PayStatements = {}));
+//# sourceMappingURL=pay-statements.js.map

package/resources/hris/pay-statements.mjs

@@ -2,20 +2,22 @@
 import { APIResource } from '@tryfinch/finch-api/resource';
 import { ResponsesPage } from '@tryfinch/finch-api/pagination';
 export 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, options) {
-    return this.getAPIList('/employer/pay-statement', PayStatementResponsesPage, {
-      body,
-      method: 'post',
-      ...options,
-    });
-  }
+    /**
+     * 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', PayStatementResponsesPage, {
+            body,
+            method: 'post',
+            ...options,
+        });
+    }
 }
-export class PayStatementResponsesPage extends ResponsesPage {}
-(function (PayStatements) {})(PayStatements || (PayStatements = {}));
-//# sourceMappingURL=pay-statements.mjs.map
+export class PayStatementResponsesPage extends ResponsesPage {
+}
+(function (PayStatements) {
+})(PayStatements || (PayStatements = {}));
+//# sourceMappingURL=pay-statements.mjs.map

package/resources/hris/payments.d.ts

@@ -1,65 +1,63 @@
 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 { SinglePage } from '@tryfinch/finch-api/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, Payment>;
+    /**
+     * Read payroll and contractor related payments by the company.
+     */
+    list(query: PaymentListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentsSinglePage, Payment>;
+}
+export declare class PaymentsSinglePage extends SinglePage<Payment> {
 }
-export declare class PaymentsSinglePage extends SinglePage<Payment> {}
 type _PaymentsSinglePage = PaymentsSinglePage;
 export interface Payment {
-  /**
-   * The unique id for the payment.
-   */
-  id?: string;
-  company_debit?: HRIS.Money | null;
-  debit_date?: string | null;
-  employee_taxes?: HRIS.Money | null;
-  employer_taxes?: HRIS.Money | null;
-  gross_pay?: HRIS.Money | null;
-  /**
-   * 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;
+    /**
+     * The unique id for the payment.
+     */
+    id?: string;
+    company_debit?: HRIS.Money | null;
+    debit_date?: string | null;
+    employee_taxes?: HRIS.Money | null;
+    employer_taxes?: HRIS.Money | null;
+    gross_pay?: HRIS.Money | null;
+    /**
+     * 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;
-  }
+    /**
+     * 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;
+    /**
+     * 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;
 }
 export declare namespace Payments {
-  export import Payment = API.Payment;
-  type PaymentsSinglePage = _PaymentsSinglePage;
-  export import PaymentListParams = API.PaymentListParams;
+    export import Payment = API.Payment;
+    type PaymentsSinglePage = _PaymentsSinglePage;
+    export import PaymentListParams = API.PaymentListParams;
 }
 export {};
-//# sourceMappingURL=payments.d.ts.map
+//# sourceMappingURL=payments.d.ts.map

package/resources/hris/payments.js

@@ -1,19 +1,21 @@
-'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.PaymentsSinglePage = exports.Payments = 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 Payments extends resource_1.APIResource {
-  /**
-   * Read payroll and contractor related payments by the company.
-   */
-  list(query, options) {
-    return this.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
-  }
+    /**
+     * Read payroll and contractor related payments by the company.
+     */
+    list(query, options) {
+        return this.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
+    }
 }
 exports.Payments = Payments;
-class PaymentsSinglePage extends pagination_1.SinglePage {}
+class PaymentsSinglePage extends pagination_1.SinglePage {
+}
 exports.PaymentsSinglePage = PaymentsSinglePage;
-(function (Payments) {})((Payments = exports.Payments || (exports.Payments = {})));
-//# sourceMappingURL=payments.js.map
+(function (Payments) {
+})(Payments = exports.Payments || (exports.Payments = {}));
+//# sourceMappingURL=payments.js.map

package/resources/hris/payments.mjs

@@ -2,13 +2,15 @@
 import { APIResource } from '@tryfinch/finch-api/resource';
 import { SinglePage } from '@tryfinch/finch-api/pagination';
 export class Payments extends APIResource {
-  /**
-   * Read payroll and contractor related payments by the company.
-   */
-  list(query, options) {
-    return this.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
-  }
+    /**
+     * Read payroll and contractor related payments by the company.
+     */
+    list(query, options) {
+        return this.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
+    }
 }
-export class PaymentsSinglePage extends SinglePage {}
-(function (Payments) {})(Payments || (Payments = {}));
-//# sourceMappingURL=payments.mjs.map
+export class PaymentsSinglePage extends SinglePage {
+}
+(function (Payments) {
+})(Payments || (Payments = {}));
+//# sourceMappingURL=payments.mjs.map

package/resources/index.d.ts

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

package/resources/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,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;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,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;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}