@tryfinch/finch-api 5.12.1 → 5.14.0

package/src/pagination.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless.
 
 import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
+import * as Shared from "./resources/shared";
 import * as DirectoryAPI from "./resources/hris/directory";
-import * as HRISAPI from "./resources/hris/hris";
 
 export type SinglePageResponse<Item> = Item[];
 
@@ -80,7 +80,7 @@ export interface IndividualsPageResponse {
    */
   individuals: Array<DirectoryAPI.IndividualInDirectory>;
 
-  paging: HRISAPI.Paging;
+  paging: Shared.Paging;
 }
 
 export interface IndividualsPageParams {
@@ -99,7 +99,7 @@ export class IndividualsPage
   extends AbstractPage<DirectoryAPI.IndividualInDirectory>
   implements IndividualsPageResponse
 {
-  paging: HRISAPI.Paging;
+  paging: Shared.Paging;
 
   /**
    * The array of employees.
@@ -149,3 +149,65 @@ export class IndividualsPage
     return null;
   }
 }
+
+export interface PageResponse<Item> {
+  paging: Shared.Paging;
+
+  data?: Array<Item>;
+}
+
+export interface PageParams {
+  /**
+   * Number of employees to return (defaults to all)
+   */
+  limit?: number;
+
+  /**
+   * Index to start from (defaults to 0)
+   */
+  offset?: number;
+}
+
+export class Page<Item> extends AbstractPage<Item> implements PageResponse<Item> {
+  paging: Shared.Paging;
+
+  data: Array<Item>;
+
+  constructor(client: APIClient, response: Response, body: PageResponse<Item>, options: FinalRequestOptions) {
+    super(client, response, body, options);
+
+    this.paging = body.paging;
+    this.data = body.data || [];
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data;
+  }
+
+  // @deprecated Please use `nextPageInfo()` instead
+  nextPageParams(): Partial<PageParams> | null {
+    const info = this.nextPageInfo();
+    if (!info) return null;
+    if ('params' in info) return info.params;
+    const params = Object.fromEntries(info.url.searchParams);
+    if (!Object.keys(params).length) return null;
+    return params;
+  }
+
+  nextPageInfo(): PageInfo | null {
+    const offset = this.paging.offset;
+    if (!offset) return null;
+
+    const length = this.data.length;
+    const currentCount = offset + length;
+
+    const totalCount = this.paging.count;
+    if (!totalCount) return null;
+
+    if (currentCount < totalCount) {
+      return { params: { offset: currentCount } };
+    }
+
+    return null;
+  }
+}

package/src/resources/account.ts

@@ -40,11 +40,22 @@ export interface Introspection {
    */
   client_id: string;
 
+  /**
+   * The type of application associated with a token.
+   */
+  client_type: 'production' | 'development' | 'sandbox';
+
   /**
    * The Finch uuid of the company associated with the `access_token`.
    */
   company_id: string;
 
+  /**
+   * The type of the connection associated with the token.<br> `provider` -
+   * connection to an external provider<br> `finch` - finch-generated data.
+   */
+  connection_type: 'provider' | 'finch';
+
   /**
    * Whether the connection associated with the `access_token` uses the Assisted
    * Connect Flow. (`true` if using Assisted Connect, `false` if connection is

package/src/resources/hris/company.ts

@@ -123,7 +123,15 @@ export namespace Company {
     /**
      * The tax payer type of the company.
      */
-    type?: 'llc' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null;
+    type?:
+      | 'llc'
+      | 'lp'
+      | 'corporation'
+      | 'sole_proprietor'
+      | 'non_profit'
+      | 'partnership'
+      | 'cooperative'
+      | null;
   }
 }
 

package/src/resources/hris/hris.ts

@@ -103,23 +103,10 @@ export interface Money {
   currency?: string;
 }
 
-export interface Paging {
-  /**
-   * The total number of elements for the entire query (not just the given page)
-   */
-  count?: number;
-
-  /**
-   * The current start index of the returned list of elements
-   */
-  offset?: number;
-}
-
 export namespace HRIS {
   export import Income = HRISAPI.Income;
   export import Location = HRISAPI.Location;
   export import Money = HRISAPI.Money;
-  export import Paging = HRISAPI.Paging;
   export import CompanyResource = CompanyAPI.CompanyResource;
   export import Company = CompanyAPI.Company;
   export import Directory = DirectoryAPI.Directory;

package/src/resources/hris/index.ts

@@ -26,7 +26,7 @@ export {
   EmploymentDataResponsesPage,
   Employments,
 } from './employments';
-export { Income, Location, Money, Paging, HRIS } from './hris';
+export { Income, Location, Money, HRIS } from './hris';
 export {
   Individual,
   IndividualResponse,

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

@@ -3,6 +3,7 @@
 import * as Core from "../../core";
 import { APIResource } from "../../resource";
 import * as PayStatementsAPI from "./pay-statements";
+import * as Shared from "../shared";
 import * as HRISAPI from "./hris";
 import * as BenefitsAPI from "./benefits/benefits";
 import { ResponsesPage } from "../../pagination";
@@ -200,7 +201,7 @@ export interface PayStatementResponse {
 }
 
 export interface PayStatementResponseBody {
-  paging?: HRISAPI.Paging;
+  paging?: Shared.Paging;
 
   /**
    * The array of pay statements for the current payment.

package/src/resources/index.ts

@@ -2,7 +2,8 @@
 
 export * from './shared';
 export { DisconnectResponse, Introspection, Account } from './account';
-export { Income, Location, Money, Paging, HRIS } from './hris/hris';
+export { Income, Location, Money, HRIS } from './hris/hris';
+export { Jobs } from './jobs/jobs';
 export { Provider, ProvidersSinglePage, Providers } from './providers';
 export {
   RequestForwardingForwardResponse,

package/src/resources/jobs/automated.ts

@@ -0,0 +1,139 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as AutomatedAPI from "./automated";
+import { Page, type PageParams } from "../../pagination";
+
+export class Automated extends APIResource {
+  /**
+   * Enqueue an automated job. Currently, only the `data_sync_all` job type is
+   * supported, which will enqueue a job to re-sync all data for a connection.
+   * `data_sync_all` has a concurrency limit of 1 job at a time per connection. This
+   * means that if this endpoint is called while a job is already in progress for
+   * this connection, Finch will return the `job_id` of the job that is currently in
+   * progress. Finch allows a fixed window rate limit of 1 forced refresh per hour
+   * per connection.
+   *
+   * This endpoint is available for _Scale_ tier customers as an add-on. To request
+   * access to this endpoint, please contact your Finch account manager.
+   */
+  create(
+    body: AutomatedCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<AutomatedCreateResponse> {
+    return this._client.post('/jobs/automated', { body, ...options });
+  }
+
+  /**
+   * Get an automated job by `job_id`.
+   */
+  retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<AutomatedAsyncJob> {
+    return this._client.get(`/jobs/automated/${jobId}`, options);
+  }
+
+  /**
+   * Get all automated jobs. Automated jobs are completed by a machine. By default,
+   * jobs are sorted in descending order by submission time. For scheduled jobs such
+   * as data syncs, only the next scheduled job is shown.
+   */
+  list(
+    query?: AutomatedListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AutomatedAsyncJobsPage, AutomatedAsyncJob>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AutomatedAsyncJobsPage, AutomatedAsyncJob>;
+  list(
+    query: AutomatedListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AutomatedAsyncJobsPage, AutomatedAsyncJob> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.getAPIList('/jobs/automated', AutomatedAsyncJobsPage, { query, ...options });
+  }
+}
+
+export class AutomatedAsyncJobsPage extends Page<AutomatedAsyncJob> {}
+
+export interface AutomatedAsyncJob {
+  /**
+   * The datetime the job completed.
+   */
+  completed_at: string | null;
+
+  /**
+   * The datetime when the job was created. for scheduled jobs, this will be the
+   * initial connection time. For ad-hoc jobs, this will be the time the creation
+   * request was received.
+   */
+  created_at: string;
+
+  /**
+   * The id of the job that has been created.
+   */
+  job_id: string;
+
+  /**
+   * The url that can be used to retrieve the job status
+   */
+  job_url: string;
+
+  /**
+   * The datetime a job is scheduled to be run. For scheduled jobs, this datetime can
+   * be in the future if the job has not yet been enqueued. For ad-hoc jobs, this
+   * field will be null.
+   */
+  scheduled_at: string | null;
+
+  /**
+   * The datetime a job entered into the job queue.
+   */
+  started_at: string | null;
+
+  status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error';
+
+  /**
+   * Only `data_sync_all` currently supported
+   */
+  type: 'data_sync_all';
+}
+
+export interface AutomatedCreateResponse {
+  /**
+   * The number of allowed refreshes per hour (per hour, fixed window)
+   */
+  allowed_refreshes: number;
+
+  /**
+   * The id of the job that has been created.
+   */
+  job_id: string;
+
+  /**
+   * The url that can be used to retrieve the job status
+   */
+  job_url: string;
+
+  /**
+   * The number of remaining refreshes available (per hour, fixed window)
+   */
+  remaining_refreshes: number;
+}
+
+export interface AutomatedCreateParams {
+  /**
+   * The type of job to start. Currently the only supported type is `data_sync_all`
+   */
+  type: 'data_sync_all';
+}
+
+export interface AutomatedListParams extends PageParams {}
+
+export namespace Automated {
+  export import AutomatedAsyncJob = AutomatedAPI.AutomatedAsyncJob;
+  export import AutomatedCreateResponse = AutomatedAPI.AutomatedCreateResponse;
+  export import AutomatedAsyncJobsPage = AutomatedAPI.AutomatedAsyncJobsPage;
+  export import AutomatedCreateParams = AutomatedAPI.AutomatedCreateParams;
+  export import AutomatedListParams = AutomatedAPI.AutomatedListParams;
+}

package/src/resources/jobs/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export {
+  AutomatedAsyncJob,
+  AutomatedCreateResponse,
+  AutomatedCreateParams,
+  AutomatedListParams,
+  AutomatedAsyncJobsPage,
+  Automated,
+} from './automated';
+export { Jobs } from './jobs';
+export { ManualAsyncJob, Manual } from './manual';

package/src/resources/jobs/jobs.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import { APIResource } from "../../resource";
+import * as AutomatedAPI from "./automated";
+import * as ManualAPI from "./manual";
+
+export class Jobs extends APIResource {
+  automated: AutomatedAPI.Automated = new AutomatedAPI.Automated(this._client);
+  manual: ManualAPI.Manual = new ManualAPI.Manual(this._client);
+}
+
+export namespace Jobs {
+  export import Automated = AutomatedAPI.Automated;
+  export import AutomatedAsyncJob = AutomatedAPI.AutomatedAsyncJob;
+  export import AutomatedCreateResponse = AutomatedAPI.AutomatedCreateResponse;
+  export import AutomatedAsyncJobsPage = AutomatedAPI.AutomatedAsyncJobsPage;
+  export import AutomatedCreateParams = AutomatedAPI.AutomatedCreateParams;
+  export import AutomatedListParams = AutomatedAPI.AutomatedListParams;
+  export import Manual = ManualAPI.Manual;
+  export import ManualAsyncJob = ManualAPI.ManualAsyncJob;
+}

package/src/resources/jobs/manual.ts

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as ManualAPI from "./manual";
+
+export class Manual extends APIResource {
+  /**
+   * Get a manual job by `job_id`. Manual jobs are completed by a human and include
+   * Assisted Benefits jobs.
+   */
+  retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<ManualAsyncJob> {
+    return this._client.get(`/jobs/manual/${jobId}`, options);
+  }
+}
+
+export interface ManualAsyncJob {
+  /**
+   * Specific information about the job, such as individual statuses for batch jobs.
+   */
+  body: Array<unknown> | null;
+
+  job_id: string;
+
+  status: 'pending' | 'in_progress' | 'error' | 'complete';
+}
+
+export namespace Manual {
+  export import ManualAsyncJob = ManualAPI.ManualAsyncJob;
+}

package/src/resources/shared.ts

@@ -60,3 +60,15 @@ export interface OperationSupportMatrix {
    */
   update?: OperationSupport;
 }
+
+export interface Paging {
+  /**
+   * The total number of elements for the entire query (not just the given page)
+   */
+  count?: number;
+
+  /**
+   * The current start index of the returned list of elements
+   */
+  offset?: number;
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.12.1'; // x-release-please-version
+export const VERSION = '5.14.0'; // x-release-please-version

package/version.d.ts

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

package/version.mjs

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