@tryfinch/finch-api 5.1.0 → 5.3.0

package/resources/hris/company.d.ts

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

package/resources/hris/company.js

@@ -1,18 +1,17 @@
-'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.CompanyResource = void 0;
-const resource_1 = require('@tryfinch/finch-api/resource');
+const resource_1 = require("@tryfinch/finch-api/resource");
 class CompanyResource extends resource_1.APIResource {
-  /**
-   * Read basic company data
-   */
-  retrieve(options) {
-    return this.get('/employer/company', options);
-  }
+    /**
+     * Read basic company data
+     */
+    retrieve(options) {
+        return this.get('/employer/company', options);
+    }
 }
 exports.CompanyResource = CompanyResource;
-(function (CompanyResource) {})(
-  (CompanyResource = exports.CompanyResource || (exports.CompanyResource = {})),
-);
-//# sourceMappingURL=company.js.map
+(function (CompanyResource) {
+})(CompanyResource = exports.CompanyResource || (exports.CompanyResource = {}));
+//# sourceMappingURL=company.js.map

package/resources/hris/company.mjs

@@ -1,12 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 import { APIResource } from '@tryfinch/finch-api/resource';
 export class CompanyResource extends APIResource {
-  /**
-   * Read basic company data
-   */
-  retrieve(options) {
-    return this.get('/employer/company', options);
-  }
+    /**
+     * Read basic company data
+     */
+    retrieve(options) {
+        return this.get('/employer/company', options);
+    }
 }
-(function (CompanyResource) {})(CompanyResource || (CompanyResource = {}));
-//# sourceMappingURL=company.mjs.map
+(function (CompanyResource) {
+})(CompanyResource || (CompanyResource = {}));
+//# sourceMappingURL=company.mjs.map

package/resources/hris/directory.d.ts

@@ -1,70 +1,68 @@
 import * as Core from '@tryfinch/finch-api/core';
 import { APIResource } from '@tryfinch/finch-api/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 import { IndividualsPage, IndividualsPageParams } from '@tryfinch/finch-api/pagination';
 export declare class Directory extends APIResource {
-  /**
-   * Read company directory and organization structure
-   */
-  listIndividuals(
-    query?: DirectoryListIndividualsParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
-  listIndividuals(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
+    /**
+     * Read company directory and organization structure
+     */
+    listIndividuals(query?: DirectoryListIndividualsParams, options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
+    listIndividuals(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
 }
 export interface IndividualInDirectory {
-  /**
-   * A stable Finch id (UUID v4) for an individual in the company.
-   */
-  id?: string;
-  /**
-   * The department object.
-   */
-  department?: IndividualInDirectory.Department | null;
-  /**
-   * The legal first name of the individual.
-   */
-  first_name?: string | null;
-  /**
-   * `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;
+    /**
+     * A stable Finch id (UUID v4) for an individual in the company.
+     */
+    id?: string;
+    /**
+     * The department object.
+     */
+    department?: IndividualInDirectory.Department | null;
+    /**
+     * The legal first name of the individual.
+     */
+    first_name?: string | null;
+    /**
+     * `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 department object.
-   */
-  interface Department {
     /**
-     * The name of the department.
+     * The department object.
      */
-    name?: string | null;
-  }
-  /**
-   * The manager object.
-   */
-  interface Manager {
+    interface Department {
+        /**
+         * The name of the department.
+         */
+        name?: string | null;
+    }
     /**
-     * A stable Finch `id` (UUID v4) for an individual in the company.
+     * The manager object.
      */
-    id?: string;
-  }
+    interface Manager {
+        /**
+         * A stable Finch `id` (UUID v4) for an individual in the company.
+         */
+        id?: string;
+    }
+}
+export interface DirectoryListIndividualsParams extends IndividualsPageParams {
 }
-export interface DirectoryListIndividualsParams extends IndividualsPageParams {}
 export declare namespace Directory {
-  export import IndividualInDirectory = API.IndividualInDirectory;
-  export import DirectoryListIndividualsParams = API.DirectoryListIndividualsParams;
+    export import IndividualInDirectory = API.IndividualInDirectory;
+    export import DirectoryListIndividualsParams = API.DirectoryListIndividualsParams;
 }
-//# sourceMappingURL=directory.d.ts.map
+//# sourceMappingURL=directory.d.ts.map

package/resources/hris/directory.js

@@ -1,18 +1,19 @@
-'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.Directory = void 0;
-const resource_1 = require('@tryfinch/finch-api/resource');
-const core_1 = require('@tryfinch/finch-api/core');
-const pagination_1 = require('@tryfinch/finch-api/pagination');
+const resource_1 = require("@tryfinch/finch-api/resource");
+const core_1 = require("@tryfinch/finch-api/core");
+const pagination_1 = require("@tryfinch/finch-api/pagination");
 class Directory extends resource_1.APIResource {
-  listIndividuals(query = {}, options) {
-    if ((0, core_1.isRequestOptions)(query)) {
-      return this.listIndividuals({}, query);
+    listIndividuals(query = {}, options) {
+        if ((0, core_1.isRequestOptions)(query)) {
+            return this.listIndividuals({}, query);
+        }
+        return this.getAPIList('/employer/directory', pagination_1.IndividualsPage, { query, ...options });
     }
-    return this.getAPIList('/employer/directory', pagination_1.IndividualsPage, { query, ...options });
-  }
 }
 exports.Directory = Directory;
-(function (Directory) {})((Directory = exports.Directory || (exports.Directory = {})));
-//# sourceMappingURL=directory.js.map
+(function (Directory) {
+})(Directory = exports.Directory || (exports.Directory = {}));
+//# sourceMappingURL=directory.js.map

package/resources/hris/directory.mjs

@@ -3,12 +3,13 @@ import { APIResource } from '@tryfinch/finch-api/resource';
 import { isRequestOptions } from '@tryfinch/finch-api/core';
 import { IndividualsPage } from '@tryfinch/finch-api/pagination';
 export class Directory extends APIResource {
-  listIndividuals(query = {}, options) {
-    if (isRequestOptions(query)) {
-      return this.listIndividuals({}, query);
+    listIndividuals(query = {}, options) {
+        if (isRequestOptions(query)) {
+            return this.listIndividuals({}, query);
+        }
+        return this.getAPIList('/employer/directory', IndividualsPage, { query, ...options });
     }
-    return this.getAPIList('/employer/directory', IndividualsPage, { query, ...options });
-  }
 }
-(function (Directory) {})(Directory || (Directory = {}));
-//# sourceMappingURL=directory.mjs.map
+(function (Directory) {
+})(Directory || (Directory = {}));
+//# sourceMappingURL=directory.mjs.map