@tryfinch/finch-api 1.1.0 → 3.0.0

package/{resources → src/resources}/hris/hris.ts

@@ -1,12 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import { APIResource } from '~/resource';
+import { APIResource } from '@tryfinch/finch-api/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';
+import * as API from './';
 
 export class HRIS extends APIResource {
   company: CompanyResource = new CompanyResource(this.client);
@@ -111,3 +112,48 @@ export interface Paging {
    */
   offset?: number;
 }
+
+export namespace HRIS {
+  export import Income = API.Income;
+  export import Location = API.Location;
+  export import Money = API.Money;
+  export import Paging = API.Paging;
+
+  export import CompanyResource = API.CompanyResource;
+  export import Company = API.Company;
+
+  export import Payments = API.Payments;
+  export import Payment = API.Payment;
+  export import PaymentsSinglePage = API.PaymentsSinglePage;
+  export import PaymentListParams = API.PaymentListParams;
+
+  export import PayStatements = API.PayStatements;
+  export import PayStatement = API.PayStatement;
+  export import PayStatementResponse = API.PayStatementResponse;
+  export import PayStatementResponseBody = API.PayStatementResponseBody;
+  export import PayStatementResponsesResponsesPage = API.PayStatementResponsesResponsesPage;
+  export import PayStatementRetrieveManyParams = API.PayStatementRetrieveManyParams;
+
+  export import Directory = API.Directory;
+  export import IndividualInDirectory = API.IndividualInDirectory;
+  export import DirectoryListIndividualsParams = API.DirectoryListIndividualsParams;
+
+  export import Individuals = API.Individuals;
+  export import Individual = API.Individual;
+  export import IndividualResponse = API.IndividualResponse;
+  export import IndividualResponsesResponsesPage = API.IndividualResponsesResponsesPage;
+  export import IndividualRetrieveManyParams = API.IndividualRetrieveManyParams;
+
+  export import Benefits = API.Benefits;
+  export import BenefitFrequency = API.BenefitFrequency;
+  export import BenefitType = API.BenefitType;
+  export import BenfitContribution = API.BenfitContribution;
+  export import CompanyBenefit = API.CompanyBenefit;
+  export import CreateCompanyBenefitsResponse = API.CreateCompanyBenefitsResponse;
+  export import SupportedBenefit = API.SupportedBenefit;
+  export import UpdateCompanyBenefitResponse = API.UpdateCompanyBenefitResponse;
+  export import CompanyBenefitsSinglePage = API.CompanyBenefitsSinglePage;
+  export import SupportedBenefitsSinglePage = API.SupportedBenefitsSinglePage;
+  export import BenefitCreateParams = API.BenefitCreateParams;
+  export import BenefitUpdateParams = API.BenefitUpdateParams;
+}

package/{resources → src/resources}/hris/index.ts

@@ -12,21 +12,24 @@ export {
   BenefitUpdateParams,
   CompanyBenefitsSinglePage,
   SupportedBenefitsSinglePage,
+  Benefits,
 } from './benefits';
-export { Company } from './company';
-export { Income, Location, Money, Paging } from './hris';
+export { Company, CompanyResource } from './company';
+export { Income, Location, Money, Paging, HRIS } from './hris';
 export {
   Individual,
   IndividualResponse,
   IndividualRetrieveManyParams,
   IndividualResponsesResponsesPage,
+  Individuals,
 } from './individuals';
-export { IndividualInDirectory, DirectoryListIndividualsParams } from './directory';
+export { IndividualInDirectory, DirectoryListIndividualsParams, Directory } from './directory';
 export {
   PayStatement,
   PayStatementResponse,
   PayStatementResponseBody,
   PayStatementRetrieveManyParams,
   PayStatementResponsesResponsesPage,
+  PayStatements,
 } from './pay-statements';
-export { Payment, PaymentListParams, PaymentsSinglePage } from './payments';
+export { Payment, PaymentListParams, PaymentsSinglePage, Payments } from './payments';

package/{resources → src/resources}/hris/individuals/employment-data.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import * as HRIS from '~/resources/hris';
-import { ResponsesPage } from '~/pagination';
+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 './';
+import { ResponsesPage } from '@tryfinch/finch-api/pagination';
 
 export class EmploymentData extends APIResource {
   /**
@@ -26,8 +27,15 @@ export class EmploymentData extends APIResource {
 }
 
 export class EmploymentDataResponsesResponsesPage extends ResponsesPage<EmploymentDataResponse> {}
+// alias so we can export it in the namespace
+type _EmploymentDataResponsesResponsesPage = EmploymentDataResponsesResponsesPage;
 
 export interface EmploymentData {
+  /**
+   * string A stable Finch `id` (UUID v4) for an individual in the company.
+   */
+  id?: string;
+
   /**
    * Worker's compensation classification code for this employee
    */
@@ -50,11 +58,6 @@ export interface EmploymentData {
    */
   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,
@@ -116,16 +119,6 @@ export interface EmploymentData {
 }
 
 export namespace EmploymentData {
-  /**
-   * The manager object representing the manager of the individual within the org.
-   */
-  export interface Manager {
-    /**
-     * A stable Finch `id` (UUID v4) for an individual in the company.
-     */
-    id?: string;
-  }
-
   /**
    * The department object.
    */
@@ -150,6 +143,16 @@ export namespace EmploymentData {
      */
     type?: 'employee' | 'contractor' | null;
   }
+
+  /**
+   * The manager object representing the manager of the individual within the org.
+   */
+  export interface Manager {
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company.
+     */
+    id?: string;
+  }
 }
 
 export interface EmploymentDataResponse {
@@ -164,11 +167,11 @@ export interface EmploymentDataRetrieveManyParams {
   /**
    * The array of batch requests.
    */
-  requests: Array<EmploymentDataRetrieveManyParams.Requests>;
+  requests: Array<EmploymentDataRetrieveManyParams.Request>;
 }
 
 export namespace EmploymentDataRetrieveManyParams {
-  export interface Requests {
+  export interface Request {
     /**
      * 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
@@ -177,3 +180,10 @@ export namespace EmploymentDataRetrieveManyParams {
     individual_id: string;
   }
 }
+
+export namespace EmploymentData {
+  export import EmploymentData = API.EmploymentData;
+  export import EmploymentDataResponse = API.EmploymentDataResponse;
+  export type EmploymentDataResponsesResponsesPage = _EmploymentDataResponsesResponsesPage;
+  export import EmploymentDataRetrieveManyParams = API.EmploymentDataRetrieveManyParams;
+}

package/{resources → src/resources}/hris/individuals/index.ts

@@ -11,4 +11,5 @@ export {
   IndividualResponse,
   IndividualRetrieveManyParams,
   IndividualResponsesResponsesPage,
+  Individuals,
 } from './individuals';

package/{resources → src/resources}/hris/individuals/individuals.ts

@@ -1,11 +1,12 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import * as HRIS from '~/resources/hris';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
+import * as HRIS from '@tryfinch/finch-api/resources/hris/index';
 import { EmploymentData } from './employment-data';
-import { ResponsesPage } from '~/pagination';
+import * as API from './';
+import { ResponsesPage } from '@tryfinch/finch-api/pagination';
 
 export class Individuals extends APIResource {
   employmentData: EmploymentData = new EmploymentData(this.client);
@@ -34,11 +35,18 @@ export class Individuals extends APIResource {
 }
 
 export class IndividualResponsesResponsesPage extends ResponsesPage<IndividualResponse> {}
+// alias so we can export it in the namespace
+type _IndividualResponsesResponsesPage = IndividualResponsesResponsesPage;
 
 export interface Individual {
+  /**
+   * A stable Finch `id` (UUID v4) for an individual in the company.
+   */
+  id?: string;
+
   dob?: string | null;
 
-  emails?: Array<Individual.Emails> | null;
+  emails?: Array<Individual.Email> | null;
 
   /**
    * The legal first name of the individual.
@@ -50,11 +58,6 @@ export interface 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.
    */
@@ -65,7 +68,7 @@ export interface Individual {
    */
   middle_name?: string | null;
 
-  phone_numbers?: Array<Individual.PhoneNumbers | null> | null;
+  phone_numbers?: Array<Individual.PhoneNumber | null> | null;
 
   /**
    * The preferred name of the individual.
@@ -82,13 +85,13 @@ export interface Individual {
 }
 
 export namespace Individual {
-  export interface Emails {
+  export interface Email {
     data?: string;
 
     type?: 'work' | 'personal';
   }
 
-  export interface PhoneNumbers {
+  export interface PhoneNumber {
     data?: string | null;
 
     type?: 'work' | 'personal' | null;
@@ -106,7 +109,7 @@ export interface IndividualResponse {
 export interface IndividualRetrieveManyParams {
   options?: IndividualRetrieveManyParams.Options | null;
 
-  requests?: Array<IndividualRetrieveManyParams.Requests>;
+  requests?: Array<IndividualRetrieveManyParams.Request>;
 }
 
 export namespace IndividualRetrieveManyParams {
@@ -114,7 +117,19 @@ export namespace IndividualRetrieveManyParams {
     include?: Array<string>;
   }
 
-  export interface Requests {
+  export interface Request {
     individual_id?: string;
   }
 }
+
+export namespace Individuals {
+  export import Individual = API.Individual;
+  export import IndividualResponse = API.IndividualResponse;
+  export type IndividualResponsesResponsesPage = _IndividualResponsesResponsesPage;
+  export import IndividualRetrieveManyParams = API.IndividualRetrieveManyParams;
+
+  export import EmploymentData = API.EmploymentData;
+  export import EmploymentDataResponse = API.EmploymentDataResponse;
+  export import EmploymentDataResponsesResponsesPage = API.EmploymentDataResponsesResponsesPage;
+  export import EmploymentDataRetrieveManyParams = API.EmploymentDataRetrieveManyParams;
+}

package/{resources → src/resources}/hris/pay-statements.ts

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-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';
+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 './';
+import { ResponsesPage } from '@tryfinch/finch-api/pagination';
 
 export class PayStatements extends APIResource {
   /**
@@ -26,19 +27,21 @@ export class PayStatements extends APIResource {
 }
 
 export class PayStatementResponsesResponsesPage extends ResponsesPage<PayStatementResponse> {}
+// alias so we can export it in the namespace
+type _PayStatementResponsesResponsesPage = PayStatementResponsesResponsesPage;
 
 export interface PayStatement {
   /**
    * The array of earnings objects associated with this pay statement
    */
-  earnings?: Array<PayStatement.Earnings | null> | null;
+  earnings?: Array<PayStatement.Earning | null> | null;
 
   /**
    * The array of deductions objects associated with this pay statement.
    */
-  employee_deductions?: Array<PayStatement.EmployeeDeductions | null> | null;
+  employee_deductions?: Array<PayStatement.EmployeeDeduction | null> | null;
 
-  employer_contributions?: Array<PayStatement.EmployerContributions | null> | null;
+  employer_contributions?: Array<PayStatement.EmployerContribution | null> | null;
 
   gross_pay?: HRIS.Money | null;
 
@@ -57,7 +60,7 @@ export interface PayStatement {
   /**
    * The array of taxes objects associated with this pay statement.
    */
-  taxes?: Array<PayStatement.Taxes | null> | null;
+  taxes?: Array<PayStatement.Tax | null> | null;
 
   /**
    * The number of hours worked for this pay period
@@ -71,7 +74,7 @@ export interface PayStatement {
 }
 
 export namespace PayStatement {
-  export interface Earnings {
+  export interface Earning {
     /**
      * The earnings amount in cents.
      */
@@ -113,80 +116,80 @@ export namespace PayStatement {
       | null;
   }
 
-  export interface Taxes {
+  export interface EmployeeDeduction {
     /**
-     * The tax amount in cents.
+     * The deduction amount in cents.
      */
     amount?: number | null;
 
     /**
-     * The currency code.
+     * The deduction currency.
      */
     currency?: string | null;
 
     /**
-     * `true` if the amount is paid by the employers.
+     * The deduction name from the pay statement.
      */
-    employer?: boolean | null;
+    name?: string | null;
 
     /**
-     * The exact name of tax from the pay statement.
+     * Boolean indicating if the deduction is pre-tax.
      */
-    name?: string | null;
+    pre_tax?: boolean | null;
 
     /**
-     * The type of taxes.
+     * Type of benefit.
      */
-    type?: 'state' | 'federal' | 'local' | 'fica' | null;
+    type?: Benefits.BenefitType | null;
   }
 
-  export interface EmployeeDeductions {
+  export interface EmployerContribution {
     /**
-     * The deduction amount in cents.
+     * The contribution amount in cents.
      */
     amount?: number | null;
 
     /**
-     * The deduction currency.
+     * The contribution currency.
      */
     currency?: string | null;
 
     /**
-     * The deduction name from the pay statement.
+     * The contribution 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;
   }
 
-  export interface EmployerContributions {
+  export interface Tax {
     /**
-     * The contribution amount in cents.
+     * The tax amount in cents.
      */
     amount?: number | null;
 
     /**
-     * The contribution currency.
+     * The currency code.
      */
     currency?: string | null;
 
     /**
-     * The contribution name from the pay statement.
+     * `true` if the amount is paid by the employers.
+     */
+    employer?: boolean | null;
+
+    /**
+     * The exact name of tax from the pay statement.
      */
     name?: string | null;
 
     /**
-     * Type of benefit.
+     * The type of taxes.
      */
-    type?: Benefits.BenefitType | null;
+    type?: 'state' | 'federal' | 'local' | 'fica' | null;
   }
 }
 
@@ -211,11 +214,11 @@ export interface PayStatementRetrieveManyParams {
   /**
    * The array of batch requests.
    */
-  requests: Array<PayStatementRetrieveManyParams.Requests>;
+  requests: Array<PayStatementRetrieveManyParams.Request>;
 }
 
 export namespace PayStatementRetrieveManyParams {
-  export interface Requests {
+  export interface Request {
     /**
      * A stable Finch `id` (UUID v4) for a payment.
      */
@@ -232,3 +235,11 @@ export namespace PayStatementRetrieveManyParams {
     offset?: number;
   }
 }
+
+export namespace PayStatements {
+  export import PayStatement = API.PayStatement;
+  export import PayStatementResponse = API.PayStatementResponse;
+  export import PayStatementResponseBody = API.PayStatementResponseBody;
+  export type PayStatementResponsesResponsesPage = _PayStatementResponsesResponsesPage;
+  export import PayStatementRetrieveManyParams = API.PayStatementRetrieveManyParams;
+}

package/{resources → src/resources}/hris/payments.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import * as HRIS from '~/resources/hris';
-import { SinglePage } from '~/pagination';
+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 './';
+import { SinglePage } from '@tryfinch/finch-api/pagination';
 
 export class Payments extends APIResource {
   /**
@@ -15,8 +16,15 @@ export class Payments extends APIResource {
 }
 
 export class PaymentsSinglePage extends SinglePage<Payment> {}
+// alias so we can export it in the namespace
+type _PaymentsSinglePage = PaymentsSinglePage;
 
 export interface Payment {
+  /**
+   * The unique id for the payment.
+   */
+  id?: string;
+
   company_debit?: HRIS.Money | null;
 
   debit_date?: string | null;
@@ -27,11 +35,6 @@ export interface Payment {
 
   gross_pay?: HRIS.Money | null;
 
-  /**
-   * The unique id for the payment.
-   */
-  id?: string;
-
   /**
    * Array of every individual on this payment.
    */
@@ -71,3 +74,9 @@ export interface PaymentListParams {
    */
   start_date: string;
 }
+
+export namespace Payments {
+  export import Payment = API.Payment;
+  export type PaymentsSinglePage = _PaymentsSinglePage;
+  export import PaymentListParams = API.PaymentListParams;
+}

package/{resources → src/resources}/providers.ts

@@ -1,8 +1,9 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { SinglePage } from '~/pagination';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import * as API from './';
+import { SinglePage } from '@tryfinch/finch-api/pagination';
 
 export class Providers extends APIResource {
   /**
@@ -14,8 +15,15 @@ export class Providers extends APIResource {
 }
 
 export class ProvidersSinglePage extends SinglePage<Provider> {}
+// alias so we can export it in the namespace
+type _ProvidersSinglePage = ProvidersSinglePage;
 
 export interface Provider {
+  /**
+   * The id of the payroll provider used in Connect.
+   */
+  id?: string;
+
   /**
    * The display name of the payroll provider.
    */
@@ -26,11 +34,6 @@ export interface Provider {
    */
   icon?: string;
 
-  /**
-   * The id of the payroll provider used in Connect.
-   */
-  id?: string;
-
   /**
    * The url to the official logo of the payroll provider.
    */
@@ -57,3 +60,8 @@ export interface Provider {
    */
   products?: Array<string>;
 }
+
+export namespace Providers {
+  export import Provider = API.Provider;
+  export type ProvidersSinglePage = _ProvidersSinglePage;
+}