@tryfinch/finch-api 6.21.0 → 6.22.1

package/src/resources/hris/company.ts

@@ -1,139 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
-import * as HRISAPI from './hris';
-
-export class CompanyResource extends APIResource {
-  /**
-   * Read basic company data
-   */
-  retrieve(options?: Core.RequestOptions): Core.APIPromise<Company> {
-    return this._client.get('/employer/company', options);
-  }
-}
-
-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<HRISAPI.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 namespace Company {
-  export 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;
-  }
-
-  export interface Department {
-    /**
-     * The department name.
-     */
-    name?: string | null;
-
-    /**
-     * The parent department, if present.
-     */
-    parent?: Department.Parent | null;
-  }
-
-  export namespace Department {
-    /**
-     * The parent department, if present.
-     */
-    export interface Parent {
-      /**
-       * The parent department's name.
-       */
-      name?: string | null;
-    }
-  }
-
-  /**
-   * The entity type object.
-   */
-  export 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'
-      | 'lp'
-      | 'corporation'
-      | 'sole_proprietor'
-      | 'non_profit'
-      | 'partnership'
-      | 'cooperative'
-      | null;
-  }
-}
-
-export declare namespace CompanyResource {
-  export { type Company as Company };
-}
+export * from './company/index';

package/src/resources/hris/directory.ts

@@ -32,7 +32,7 @@ export class Directory extends APIResource {
 
 export interface IndividualInDirectory {
   /**
-   * A stable Finch id (UUID v4) for an individual in the company.
+   * A stable Finch `id` (UUID v4) for an individual in the company.
    */
   id?: string;
 

package/src/resources/hris/employments.ts

@@ -25,7 +25,7 @@ export class EmploymentDataResponsesPage extends ResponsesPage<EmploymentDataRes
 
 export interface EmploymentData {
   /**
-   * string A stable Finch `id` (UUID v4) for an individual in the company.
+   * A stable Finch `id` (UUID v4) for an individual in the company.
    */
   id?: string;
 
@@ -51,7 +51,8 @@ export interface EmploymentData {
   employment?: EmploymentData.Employment | null;
 
   /**
-   * The detailed employment status of the individual. Available options: `active`, `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+   * The detailed employment status of the individual. Available options: `active`,
+   * `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
    */
   employment_status?:
     | 'active'
@@ -146,7 +147,8 @@ export namespace EmploymentData {
    */
   export interface Employment {
     /**
-     * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+     * 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;
 
@@ -172,6 +174,9 @@ export interface EmploymentDataResponse {
 
   code?: number;
 
+  /**
+   * A stable Finch `id` (UUID v4) for an individual in the company.
+   */
   individual_id?: string;
 }
 

package/src/resources/hris/hris.ts

@@ -1,8 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
-import * as CompanyAPI from './company';
-import { Company, CompanyResource } from './company';
 import * as DirectoryAPI from './directory';
 import {
   Directory,
@@ -66,6 +64,8 @@ import {
   SupportedBenefitsSinglePage,
   UpdateCompanyBenefitResponse,
 } from './benefits/benefits';
+import * as CompanyAPI from './company/company';
+import { Company, CompanyResource } from './company/company';
 
 export class HRIS extends APIResource {
   company: CompanyAPI.CompanyResource = new CompanyAPI.CompanyResource(this._client);

package/src/resources/hris/index.ts

@@ -18,7 +18,7 @@ export {
   type BenefitCreateParams,
   type BenefitUpdateParams,
 } from './benefits/index';
-export { CompanyResource, type Company } from './company';
+export { CompanyResource, type Company } from './company/index';
 export {
   Directory,
   type IndividualInDirectory,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.21.0'; // x-release-please-version
+export const VERSION = '6.22.1'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "6.21.0";
+export declare const VERSION = "6.22.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '6.21.0'; // x-release-please-version
+exports.VERSION = '6.22.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '6.21.0'; // x-release-please-version
+export const VERSION = '6.22.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map