@tryfinch/finch-api 3.1.3 → 4.0.0

package/src/resources/ats/candidates.ts

@@ -11,7 +11,7 @@ export class Candidates extends APIResource {
    * Gets a candidate from an organization. A candidate represents an individual
    * associated with one or more applications.
    */
-  retrieve(candidateId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Candidate>> {
+  retrieve(candidateId: string, options?: Core.RequestOptions): Core.APIPromise<Candidate> {
     return this.get(`/ats/candidates/${candidateId}`, options);
   }
 
@@ -19,12 +19,15 @@ export class Candidates extends APIResource {
    * Gets all of an organization's candidates. A candidate represents an individual
    * associated with one or more applications.
    */
-  list(query?: CandidateListParams, options?: Core.RequestOptions): Core.PagePromise<CandidatesPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<CandidatesPage>;
+  list(
+    query?: CandidateListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<CandidatesPage, Candidate>;
+  list(options?: Core.RequestOptions): Core.PagePromise<CandidatesPage, Candidate>;
   list(
     query: CandidateListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<CandidatesPage> {
+  ): Core.PagePromise<CandidatesPage, Candidate> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/ats/jobs.ts

@@ -10,19 +10,19 @@ export class Jobs extends APIResource {
   /**
    * Gets a job from an organization.
    */
-  retrieve(jobId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Job>> {
+  retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<Job> {
     return this.get(`/ats/jobs/${jobId}`, options);
   }
 
   /**
    * Gets all of an organization's jobs.
    */
-  list(query?: JobListParams, options?: Core.RequestOptions): Core.PagePromise<JobsPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<JobsPage>;
+  list(query?: JobListParams, options?: Core.RequestOptions): Core.PagePromise<JobsPage, Job>;
+  list(options?: Core.RequestOptions): Core.PagePromise<JobsPage, Job>;
   list(
     query: JobListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<JobsPage> {
+  ): Core.PagePromise<JobsPage, Job> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/ats/offers.ts

@@ -10,19 +10,19 @@ export class Offers extends APIResource {
   /**
    * Get a single offer from an organization.
    */
-  retrieve(offerId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Offer>> {
+  retrieve(offerId: string, options?: Core.RequestOptions): Core.APIPromise<Offer> {
     return this.get(`/ats/offers/${offerId}`, options);
   }
 
   /**
    * Get all offers put out by an organization.
    */
-  list(query?: OfferListParams, options?: Core.RequestOptions): Core.PagePromise<OffersPage>;
-  list(options?: Core.RequestOptions): Core.PagePromise<OffersPage>;
+  list(query?: OfferListParams, options?: Core.RequestOptions): Core.PagePromise<OffersPage, Offer>;
+  list(options?: Core.RequestOptions): Core.PagePromise<OffersPage, Offer>;
   list(
     query: OfferListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<OffersPage> {
+  ): Core.PagePromise<OffersPage, Offer> {
     if (isRequestOptions(query)) {
       return this.list({}, query);
     }

package/src/resources/ats/stages.ts

@@ -12,7 +12,7 @@ export class Stages extends APIResource {
    * in the system. Use the `job_id` to determine whether a job applies specifically
    * to a job.
    */
-  list(options?: Core.RequestOptions): Core.PagePromise<StagesSinglePage> {
+  list(options?: Core.RequestOptions): Core.PagePromise<StagesSinglePage, Stage> {
     return this.getAPIList('/ats/stages', StagesSinglePage, options);
   }
 }

package/src/resources/hris/benefits/benefits.ts

@@ -19,12 +19,12 @@ export class Benefits extends APIResource {
   create(
     body?: BenefitCreateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<CreateCompanyBenefitsResponse>>;
-  create(options?: Core.RequestOptions): Promise<Core.APIResponse<CreateCompanyBenefitsResponse>>;
+  ): Core.APIPromise<CreateCompanyBenefitsResponse>;
+  create(options?: Core.RequestOptions): Core.APIPromise<CreateCompanyBenefitsResponse>;
   create(
     body: BenefitCreateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<CreateCompanyBenefitsResponse>> {
+  ): Core.APIPromise<CreateCompanyBenefitsResponse> {
     if (isRequestOptions(body)) {
       return this.create({}, body);
     }
@@ -36,7 +36,7 @@ export class Benefits extends APIResource {
    *
    * Lists benefit information for a given benefit
    */
-  retrieve(benefitId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<CompanyBenefit>> {
+  retrieve(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<CompanyBenefit> {
     return this.get(`/employer/benefits/${benefitId}`, options);
   }
 
@@ -49,16 +49,13 @@ export class Benefits extends APIResource {
     benefitId: string,
     body?: BenefitUpdateParams,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<UpdateCompanyBenefitResponse>>;
-  update(
-    benefitId: string,
-    options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<UpdateCompanyBenefitResponse>>;
+  ): Core.APIPromise<UpdateCompanyBenefitResponse>;
+  update(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<UpdateCompanyBenefitResponse>;
   update(
     benefitId: string,
     body: BenefitUpdateParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<UpdateCompanyBenefitResponse>> {
+  ): Core.APIPromise<UpdateCompanyBenefitResponse> {
     if (isRequestOptions(body)) {
       return this.update(benefitId, {}, body);
     }
@@ -70,7 +67,7 @@ export class Benefits extends APIResource {
    *
    * List all company-wide benefits.
    */
-  list(options?: Core.RequestOptions): Core.PagePromise<CompanyBenefitsSinglePage> {
+  list(options?: Core.RequestOptions): Core.PagePromise<CompanyBenefitsSinglePage, CompanyBenefit> {
     return this.getAPIList('/employer/benefits', CompanyBenefitsSinglePage, options);
   }
 
@@ -80,7 +77,9 @@ export class Benefits extends APIResource {
    * Lists available types and configurations for the provider associated with the
    * access token.
    */
-  listSupportedBenefits(options?: Core.RequestOptions): Core.PagePromise<SupportedBenefitsSinglePage> {
+  listSupportedBenefits(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<SupportedBenefitsSinglePage, SupportedBenefit> {
     return this.getAPIList('/employer/benefits/meta', SupportedBenefitsSinglePage, options);
   }
 }

package/src/resources/hris/benefits/individuals.ts

@@ -24,7 +24,7 @@ export class Individuals extends APIResource {
     benefitId: string,
     body: IndividualEnrollManyParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EnrolledIndividualsSinglePage> {
+  ): Core.PagePromise<EnrolledIndividualsSinglePage, EnrolledIndividual> {
     return this.getAPIList(`/employer/benefits/${benefitId}/individuals`, EnrolledIndividualsSinglePage, {
       body,
       method: 'post',
@@ -40,7 +40,7 @@ export class Individuals extends APIResource {
   enrolledIds(
     benefitId: string,
     options?: Core.RequestOptions,
-  ): Promise<Core.APIResponse<IndividualEnrolledIDsResponse>> {
+  ): Core.APIPromise<IndividualEnrolledIDsResponse> {
     return this.get(`/employer/benefits/${benefitId}/enrolled`, options);
   }
 
@@ -53,16 +53,16 @@ export class Individuals extends APIResource {
     benefitId: string,
     query?: IndividualRetrieveManyBenefitsParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualBenefitsSinglePage>;
+  ): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
   retrieveManyBenefits(
     benefitId: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualBenefitsSinglePage>;
+  ): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit>;
   retrieveManyBenefits(
     benefitId: string,
     query: IndividualRetrieveManyBenefitsParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualBenefitsSinglePage> {
+  ): Core.PagePromise<IndividualBenefitsSinglePage, IndividualBenefit> {
     if (isRequestOptions(query)) {
       return this.retrieveManyBenefits(benefitId, {}, query);
     }
@@ -81,16 +81,16 @@ export class Individuals extends APIResource {
     benefitId: string,
     body?: IndividualUnenrollParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<UnenrolledIndividualsSinglePage>;
+  ): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual>;
   unenroll(
     benefitId: string,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<UnenrolledIndividualsSinglePage>;
+  ): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual>;
   unenroll(
     benefitId: string,
     body: IndividualUnenrollParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<UnenrolledIndividualsSinglePage> {
+  ): Core.PagePromise<UnenrolledIndividualsSinglePage, UnenrolledIndividual> {
     if (isRequestOptions(body)) {
       return this.unenroll(benefitId, {}, body);
     }

package/src/resources/hris/company.ts

@@ -9,7 +9,7 @@ export class CompanyResource extends APIResource {
   /**
    * Read basic company data
    */
-  retrieve(options?: Core.RequestOptions): Promise<Core.APIResponse<Company>> {
+  retrieve(options?: Core.RequestOptions): Core.APIPromise<Company> {
     return this.get('/employer/company', options);
   }
 }

package/src/resources/hris/directory.ts

@@ -13,12 +13,12 @@ export class Directory extends APIResource {
   listIndividuals(
     query?: DirectoryListIndividualsParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualsPage>;
-  listIndividuals(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage>;
+  ): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
+  listIndividuals(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
   listIndividuals(
     query: DirectoryListIndividualsParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualsPage> {
+  ): Core.PagePromise<IndividualsPage, IndividualInDirectory> {
     if (isRequestOptions(query)) {
       return this.listIndividuals({}, query);
     }

package/src/resources/hris/individuals/employment-data.ts

@@ -17,7 +17,7 @@ export class EmploymentData extends APIResource {
   retrieveMany(
     body: EmploymentDataRetrieveManyParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<EmploymentDataResponsesResponsesPage> {
+  ): Core.PagePromise<EmploymentDataResponsesResponsesPage, EmploymentDataResponse> {
     return this.getAPIList('/employer/employment', EmploymentDataResponsesResponsesPage, {
       body,
       method: 'post',

package/src/resources/hris/individuals/individuals.ts

@@ -17,12 +17,14 @@ export class Individuals extends APIResource {
   retrieveMany(
     body?: IndividualRetrieveManyParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualResponsesResponsesPage>;
-  retrieveMany(options?: Core.RequestOptions): Core.PagePromise<IndividualResponsesResponsesPage>;
+  ): Core.PagePromise<IndividualResponsesResponsesPage, IndividualResponse>;
+  retrieveMany(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<IndividualResponsesResponsesPage, IndividualResponse>;
   retrieveMany(
     body: IndividualRetrieveManyParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualResponsesResponsesPage> {
+  ): Core.PagePromise<IndividualResponsesResponsesPage, IndividualResponse> {
     if (isRequestOptions(body)) {
       return this.retrieveMany({}, body);
     }

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

@@ -17,7 +17,7 @@ export class PayStatements extends APIResource {
   retrieveMany(
     body: PayStatementRetrieveManyParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<PayStatementResponsesResponsesPage> {
+  ): Core.PagePromise<PayStatementResponsesResponsesPage, PayStatementResponse> {
     return this.getAPIList('/employer/pay-statement', PayStatementResponsesResponsesPage, {
       body,
       method: 'post',

package/src/resources/hris/payments.ts

@@ -10,7 +10,10 @@ export class Payments extends APIResource {
   /**
    * Read payroll and contractor related payments by the company.
    */
-  list(query: PaymentListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentsSinglePage> {
+  list(
+    query: PaymentListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PaymentsSinglePage, Payment> {
     return this.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
   }
 }

package/src/resources/providers.ts

@@ -9,7 +9,7 @@ export class Providers extends APIResource {
   /**
    * Return details on all available payroll and HR systems.
    */
-  list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage> {
+  list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage, Provider> {
     return this.getAPIList('/providers', ProvidersSinglePage, options);
   }
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.1.3'; // x-release-please-version
+export const VERSION = '4.0.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = '3.1.3';
+export declare const VERSION = '4.0.0';
 //# 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 = '3.1.3'; // x-release-please-version
+exports.VERSION = '4.0.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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