@tryfinch/finch-api 1.1.0 → 3.0.0

package/{resources → src/resources}/ats/applications.ts

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import * as Stages from '~/resources/ats/stages';
-import { ApplicationsPage, ApplicationsPageParams } from '~/pagination';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
+import * as Stages from '@tryfinch/finch-api/resources/ats/stages';
+import * as API from './';
+import { ApplicationsPage, ApplicationsPageParams } from '@tryfinch/finch-api/pagination';
 
 export class Applications extends APIResource {
   /**
@@ -31,10 +32,10 @@ export class Applications extends APIResource {
 }
 
 export interface Application {
-  candidate_id: string;
-
   id: string;
 
+  candidate_id: string;
+
   job_id: string;
 
   offer_id: string | null;
@@ -53,3 +54,8 @@ export namespace Application {
 }
 
 export interface ApplicationListParams extends ApplicationsPageParams {}
+
+export namespace Applications {
+  export import Application = API.Application;
+  export import ApplicationListParams = API.ApplicationListParams;
+}

package/src/resources/ats/ats.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { Candidates } from './candidates';
+import { Applications } from './applications';
+import { Stages } from './stages';
+import { Jobs } from './jobs';
+import { Offers } from './offers';
+import * as API from './';
+
+export class ATS extends APIResource {
+  candidates: Candidates = new Candidates(this.client);
+  applications: Applications = new Applications(this.client);
+  stages: Stages = new Stages(this.client);
+  jobs: Jobs = new Jobs(this.client);
+  offers: Offers = new Offers(this.client);
+}
+
+export namespace ATS {
+  export import Candidates = API.Candidates;
+  export import Candidate = API.Candidate;
+  export import CandidateListParams = API.CandidateListParams;
+
+  export import Applications = API.Applications;
+  export import Application = API.Application;
+  export import ApplicationListParams = API.ApplicationListParams;
+
+  export import Stages = API.Stages;
+  export import Stage = API.Stage;
+  export import StagesSinglePage = API.StagesSinglePage;
+
+  export import Jobs = API.Jobs;
+  export import Job = API.Job;
+  export import JobListParams = API.JobListParams;
+
+  export import Offers = API.Offers;
+  export import Offer = API.Offer;
+  export import OfferListParams = API.OfferListParams;
+}

package/{resources → src/resources}/ats/candidates.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import { CandidatesPage, CandidatesPageParams } from '~/pagination';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
+import * as API from './';
+import { CandidatesPage, CandidatesPageParams } from '@tryfinch/finch-api/pagination';
 
 export class Candidates extends APIResource {
   /**
@@ -35,6 +36,8 @@ export class Candidates extends APIResource {
  * A candidate represents an individual associated with one or more applications.
  */
 export interface Candidate {
+  id: string;
+
   /**
    * Array of Finch uuids corresponding to `application`s for this individual
    */
@@ -42,29 +45,27 @@ export interface Candidate {
 
   created_at: string;
 
-  emails: Array<Candidate.Emails>;
+  emails: Array<Candidate.Email>;
 
   first_name: string | null;
 
   full_name: string | null;
 
-  id: string;
-
   last_activity_at: string;
 
   last_name: string | null;
 
-  phone_numbers: Array<Candidate.PhoneNumbers>;
+  phone_numbers: Array<Candidate.PhoneNumber>;
 }
 
 export namespace Candidate {
-  export interface Emails {
+  export interface Email {
     data?: string | null;
 
     type?: string | null;
   }
 
-  export interface PhoneNumbers {
+  export interface PhoneNumber {
     data?: string | null;
 
     type?: string | null;
@@ -72,3 +73,8 @@ export namespace Candidate {
 }
 
 export interface CandidateListParams extends CandidatesPageParams {}
+
+export namespace Candidates {
+  export import Candidate = API.Candidate;
+  export import CandidateListParams = API.CandidateListParams;
+}

package/src/resources/ats/index.ts

@@ -0,0 +1,8 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { ATS } from './ats';
+export { Application, ApplicationListParams, Applications } from './applications';
+export { Candidate, CandidateListParams, Candidates } from './candidates';
+export { Job, JobListParams, Jobs } from './jobs';
+export { Offer, OfferListParams, Offers } from './offers';
+export { Stage, StagesSinglePage, Stages } from './stages';

package/{resources → src/resources}/ats/jobs.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import { JobsPage, JobsPageParams } from '~/pagination';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
+import * as API from './';
+import { JobsPage, JobsPageParams } from '@tryfinch/finch-api/pagination';
 
 export class Jobs extends APIResource {
   /**
@@ -30,6 +31,8 @@ export class Jobs extends APIResource {
 }
 
 export interface Job {
+  id: string;
+
   closed_at: string | null;
 
   created_at: string | null;
@@ -38,8 +41,6 @@ export interface Job {
 
   hiring_team: Job.HiringTeam;
 
-  id: string;
-
   name: string | null;
 
   status: 'open' | 'closed' | 'on_hold' | 'draft' | 'archived' | null;
@@ -51,20 +52,25 @@ export namespace Job {
   }
 
   export interface HiringTeam {
-    hiring_managers?: Array<HiringTeam.HiringManagers> | null;
+    hiring_managers?: Array<HiringTeam.HiringManager> | null;
 
-    recruiters?: Array<HiringTeam.Recruiters> | null;
+    recruiters?: Array<HiringTeam.Recruiter> | null;
   }
 
   export namespace HiringTeam {
-    export interface HiringManagers {
+    export interface HiringManager {
       name?: string;
     }
 
-    export interface Recruiters {
+    export interface Recruiter {
       name?: string;
     }
   }
 }
 
 export interface JobListParams extends JobsPageParams {}
+
+export namespace Jobs {
+  export import Job = API.Job;
+  export import JobListParams = API.JobListParams;
+}

package/{resources → src/resources}/ats/offers.ts

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import { OffersPage, OffersPageParams } from '~/pagination';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
+import * as API from './';
+import { OffersPage, OffersPageParams } from '@tryfinch/finch-api/pagination';
 
 export class Offers extends APIResource {
   /**
@@ -30,14 +31,14 @@ export class Offers extends APIResource {
 }
 
 export interface Offer {
+  id: string;
+
   application_id: string;
 
   candidate_id: string;
 
   created_at: string;
 
-  id: string;
-
   job_id: string;
 
   status:
@@ -55,3 +56,8 @@ export interface Offer {
 }
 
 export interface OfferListParams extends OffersPageParams {}
+
+export namespace Offers {
+  export import Offer = API.Offer;
+  export import OfferListParams = API.OfferListParams;
+}

package/{resources → src/resources}/ats/stages.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 Stages extends APIResource {
   /**
@@ -17,6 +18,8 @@ export class Stages extends APIResource {
 }
 
 export class StagesSinglePage extends SinglePage<Stage> {}
+// alias so we can export it in the namespace
+type _StagesSinglePage = StagesSinglePage;
 
 export interface Stage {
   id?: string;
@@ -29,3 +32,8 @@ export interface Stage {
 
   name?: string | null;
 }
+
+export namespace Stages {
+  export import Stage = API.Stage;
+  export type StagesSinglePage = _StagesSinglePage;
+}

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

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
 import { Individuals } from './individuals';
-import { SinglePage } from '~/pagination';
+import * as API from './';
+import { SinglePage } from '@tryfinch/finch-api/pagination';
 
 export class Benefits extends APIResource {
   individuals: Individuals = new Individuals(this.client);
@@ -85,8 +86,12 @@ export class Benefits extends APIResource {
 }
 
 export class CompanyBenefitsSinglePage extends SinglePage<CompanyBenefit> {}
+// alias so we can export it in the namespace
+type _CompanyBenefitsSinglePage = CompanyBenefitsSinglePage;
 
 export class SupportedBenefitsSinglePage extends SinglePage<SupportedBenefit> {}
+// alias so we can export it in the namespace
+type _SupportedBenefitsSinglePage = SupportedBenefitsSinglePage;
 
 export type BenefitFrequency = 'one_time' | 'every_paycheck' | null;
 
@@ -212,3 +217,29 @@ export interface BenefitUpdateParams {
    */
   description?: string;
 }
+
+export namespace 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 type CompanyBenefitsSinglePage = _CompanyBenefitsSinglePage;
+  export type SupportedBenefitsSinglePage = _SupportedBenefitsSinglePage;
+  export import BenefitCreateParams = API.BenefitCreateParams;
+  export import BenefitUpdateParams = API.BenefitUpdateParams;
+
+  export import Individuals = API.Individuals;
+  export import EnrolledIndividual = API.EnrolledIndividual;
+  export import IndividualBenefit = API.IndividualBenefit;
+  export import UnenrolledIndividual = API.UnenrolledIndividual;
+  export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
+  export import EnrolledIndividualsSinglePage = API.EnrolledIndividualsSinglePage;
+  export import IndividualBenefitsSinglePage = API.IndividualBenefitsSinglePage;
+  export import UnenrolledIndividualsSinglePage = API.UnenrolledIndividualsSinglePage;
+  export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
+  export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
+  export import IndividualUnenrollParams = API.IndividualUnenrollParams;
+}

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

@@ -12,6 +12,7 @@ export {
   BenefitUpdateParams,
   CompanyBenefitsSinglePage,
   SupportedBenefitsSinglePage,
+  Benefits,
 } from './benefits';
 export {
   EnrolledIndividual,
@@ -24,4 +25,5 @@ export {
   EnrolledIndividualsSinglePage,
   IndividualBenefitsSinglePage,
   UnenrolledIndividualsSinglePage,
+  Individuals,
 } from './individuals';

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

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import * as Benefits from '~/resources/hris/benefits';
-import { SinglePage } from '~/pagination';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
+import * as Benefits from '@tryfinch/finch-api/resources/hris/benefits/index';
+import * as API from './';
+import { SinglePage } from '@tryfinch/finch-api/pagination';
 
 export class Individuals extends APIResource {
   /**
@@ -102,10 +103,16 @@ export class Individuals extends APIResource {
 }
 
 export class EnrolledIndividualsSinglePage extends SinglePage<EnrolledIndividual> {}
+// alias so we can export it in the namespace
+type _EnrolledIndividualsSinglePage = EnrolledIndividualsSinglePage;
 
 export class IndividualBenefitsSinglePage extends SinglePage<IndividualBenefit> {}
+// alias so we can export it in the namespace
+type _IndividualBenefitsSinglePage = IndividualBenefitsSinglePage;
 
 export class UnenrolledIndividualsSinglePage extends SinglePage<UnenrolledIndividual> {}
+// alias so we can export it in the namespace
+type _UnenrolledIndividualsSinglePage = UnenrolledIndividualsSinglePage;
 
 export interface EnrolledIndividual {
   body?: EnrolledIndividual.Body;
@@ -232,3 +239,16 @@ export interface IndividualUnenrollParams {
    */
   individual_ids?: Array<string>;
 }
+
+export namespace Individuals {
+  export import EnrolledIndividual = API.EnrolledIndividual;
+  export import IndividualBenefit = API.IndividualBenefit;
+  export import UnenrolledIndividual = API.UnenrolledIndividual;
+  export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
+  export type EnrolledIndividualsSinglePage = _EnrolledIndividualsSinglePage;
+  export type IndividualBenefitsSinglePage = _IndividualBenefitsSinglePage;
+  export type UnenrolledIndividualsSinglePage = _UnenrolledIndividualsSinglePage;
+  export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
+  export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
+  export import IndividualUnenrollParams = API.IndividualUnenrollParams;
+}

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

@@ -1,8 +1,9 @@
 // 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 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 './';
 
 export class CompanyResource extends APIResource {
   /**
@@ -14,15 +15,20 @@ export class CompanyResource extends APIResource {
 }
 
 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.Accounts> | null;
+  accounts: Array<Company.Account> | null;
 
   /**
    * The array of company departments.
    */
-  departments: Array<Company.Departments | null> | null;
+  departments: Array<Company.Department | null> | null;
 
   /**
    * The employer identification number.
@@ -34,11 +40,6 @@ export interface Company {
    */
   entity: Company.Entity | null;
 
-  /**
-   * A stable Finch `id` (UUID v4) for the company.
-   */
-  id: string;
-
   /**
    * The legal name of the company.
    */
@@ -58,22 +59,35 @@ export interface Company {
 }
 
 export namespace Company {
-  /**
-   * The entity type object.
-   */
-  export interface Entity {
+  export interface Account {
     /**
-     * The tax payer subtype of the company.
+     * The name of the bank associated in the payroll/HRIS system.
      */
-    subtype?: 's_corporation' | 'c_corporation' | 'b_corporation' | null;
+    account_name?: string | null;
 
     /**
-     * The tax payer type of the company.
+     * 10-12 digit number to specify the bank account
      */
-    type?: 'llc' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null;
+    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 Departments {
+  export interface Department {
     /**
      * The department name.
      */
@@ -82,10 +96,10 @@ export namespace Company {
     /**
      * The parent department, if present.
      */
-    parent?: Departments.Parent | null;
+    parent?: Department.Parent | null;
   }
 
-  export namespace Departments {
+  export namespace Department {
     /**
      * The parent department, if present.
      */
@@ -97,31 +111,22 @@ export namespace Company {
     }
   }
 
-  export interface Accounts {
-    /**
-     * 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;
-
+  /**
+   * The entity type object.
+   */
+  export interface Entity {
     /**
-     * Name of the banking institution.
+     * The tax payer subtype of the company.
      */
-    institution_name?: string | null;
+    subtype?: 's_corporation' | 'c_corporation' | 'b_corporation' | null;
 
     /**
-     * A nine-digit code that's based on the U.S. Bank location where your account was
-     * opened.
+     * The tax payer type of the company.
      */
-    routing_number?: string | null;
+    type?: 'llc' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null;
   }
 }
+
+export namespace CompanyResource {
+  export import Company = API.Company;
+}

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

@@ -1,9 +1,10 @@
 // File generated from our OpenAPI spec by Stainless.
 
-import * as Core from '~/core';
-import { APIResource } from '~/resource';
-import { isRequestOptions } from '~/core';
-import { IndividualsPage, IndividualsPageParams } from '~/pagination';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { isRequestOptions } from '@tryfinch/finch-api/core';
+import * as API from './';
+import { IndividualsPage, IndividualsPageParams } from '@tryfinch/finch-api/pagination';
 
 export class Directory extends APIResource {
   /**
@@ -26,6 +27,11 @@ export class Directory extends APIResource {
 }
 
 export interface IndividualInDirectory {
+  /**
+   * A stable Finch id (UUID v4) for an individual in the company.
+   */
+  id?: string;
+
   /**
    * The department object.
    */
@@ -36,11 +42,6 @@ export interface IndividualInDirectory {
    */
   first_name?: string | null;
 
-  /**
-   * A stable Finch id (UUID v4) for an individual in the company.
-   */
-  id?: string;
-
   /**
    * `true` if the individual is an active employee or contractor at the company.
    */
@@ -64,24 +65,29 @@ export interface IndividualInDirectory {
 
 export namespace IndividualInDirectory {
   /**
-   * The manager object.
+   * The department object.
    */
-  export interface Manager {
+  export interface Department {
     /**
-     * A stable Finch `id` (UUID v4) for an individual in the company.
+     * The name of the department.
      */
-    id?: string;
+    name?: string | null;
   }
 
   /**
-   * The department object.
+   * The manager object.
    */
-  export interface Department {
+  export interface Manager {
     /**
-     * The name of the department.
+     * A stable Finch `id` (UUID v4) for an individual in the company.
      */
-    name?: string | null;
+    id?: string;
   }
 }
 
 export interface DirectoryListIndividualsParams extends IndividualsPageParams {}
+
+export namespace Directory {
+  export import IndividualInDirectory = API.IndividualInDirectory;
+  export import DirectoryListIndividualsParams = API.DirectoryListIndividualsParams;
+}