@tryfinch/finch-api 6.31.0 → 7.0.0

package/src/resources/jobs/automated.ts

@@ -1,8 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import { isRequestOptions } from "../../core.js";
-import * as Core from "../../core.js";
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Automated extends APIResource {
   /**
@@ -21,18 +22,15 @@ export class Automated extends APIResource {
    * 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> {
+  create(body: AutomatedCreateParams, options?: RequestOptions): 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);
+  retrieve(jobID: string, options?: RequestOptions): APIPromise<AutomatedAsyncJob> {
+    return this._client.get(path`/jobs/automated/${jobID}`, options);
   }
 
   /**
@@ -40,15 +38,10 @@ export class Automated extends APIResource {
    * 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.APIPromise<AutomatedListResponse>;
-  list(options?: Core.RequestOptions): Core.APIPromise<AutomatedListResponse>;
   list(
-    query: AutomatedListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AutomatedListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
+    query: AutomatedListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AutomatedListResponse> {
     return this._client.get('/jobs/automated', { query, ...options });
   }
 }
@@ -84,7 +77,7 @@ export interface AutomatedAsyncJob {
   /**
    * 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.
+   * field will be null.
    */
   scheduled_at: string | null;
 
@@ -119,20 +112,25 @@ export interface AutomatedCreateResponse {
    */
   allowed_refreshes: number;
 
+  /**
+   * The number of remaining refreshes available (per hour, fixed window)
+   */
+  remaining_refreshes: number;
+
   /**
    * The id of the job that has been created.
    */
-  job_id: string;
+  job_id?: string;
 
   /**
    * The url that can be used to retrieve the job status
    */
-  job_url: string;
+  job_url?: string;
 
   /**
-   * The number of remaining refreshes available (per hour, fixed window)
+   * ISO 8601 timestamp indicating when to retry the request
    */
-  remaining_refreshes: number;
+  retry_at?: string;
 }
 
 export interface AutomatedListResponse {

package/src/resources/jobs/index.ts

@@ -7,6 +7,6 @@ export {
   type AutomatedListResponse,
   type AutomatedCreateParams,
   type AutomatedListParams,
-} from "./automated.js";
-export { Jobs } from "./jobs.js";
-export { Manual, type ManualAsyncJob } from "./manual.js";
+} from './automated';
+export { Jobs } from './jobs';
+export { Manual, type ManualAsyncJob } from './manual';

package/src/resources/jobs/jobs.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import * as AutomatedAPI from "./automated.js";
+import { APIResource } from '../../core/resource';
+import * as AutomatedAPI from './automated';
 import {
   Automated,
   AutomatedAsyncJob,
@@ -9,9 +9,9 @@ import {
   AutomatedCreateResponse,
   AutomatedListParams,
   AutomatedListResponse,
-} from "./automated.js";
-import * as ManualAPI from "./manual.js";
-import { Manual, ManualAsyncJob } from "./manual.js";
+} from './automated';
+import * as ManualAPI from './manual';
+import { Manual, ManualAsyncJob } from './manual';
 
 export class Jobs extends APIResource {
   automated: AutomatedAPI.Automated = new AutomatedAPI.Automated(this._client);

package/src/resources/jobs/manual.ts

@@ -1,15 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 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);
+  retrieve(jobID: string, options?: RequestOptions): APIPromise<ManualAsyncJob> {
+    return this._client.get(path`/jobs/manual/${jobID}`, options);
   }
 }
 

package/src/resources/jobs.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from "./jobs/index.js";
+export * from './jobs/index';

package/src/resources/payroll/index.ts

@@ -1,10 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  PayGroupListResponsesSinglePage,
   PayGroups,
   type PayGroupRetrieveResponse,
   type PayGroupListResponse,
+  type PayGroupRetrieveParams,
   type PayGroupListParams,
-} from "./pay-groups.js";
-export { Payroll } from "./payroll.js";
+  type PayGroupListResponsesSinglePage,
+} from './pay-groups';
+export { Payroll } from './payroll';

package/src/resources/payroll/pay-groups.ts

@@ -1,43 +1,38 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import { isRequestOptions } from "../../core.js";
-import * as Core from "../../core.js";
-import { SinglePage } from "../../pagination.js";
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { PagePromise, SinglePage } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class PayGroups extends APIResource {
   /**
    * Read information from a single pay group
    */
-  retrieve(payGroupId: string, options?: Core.RequestOptions): Core.APIPromise<PayGroupRetrieveResponse> {
-    return this._client.get(`/employer/pay-groups/${payGroupId}`, options);
+  retrieve(
+    payGroupID: string,
+    query: PayGroupRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PayGroupRetrieveResponse> {
+    return this._client.get(path`/employer/pay-groups/${payGroupID}`, { query, ...options });
   }
 
   /**
    * Read company pay groups and frequencies
    */
   list(
-    query?: PayGroupListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PayGroupListResponsesSinglePage, PayGroupListResponse>;
-  list(
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PayGroupListResponsesSinglePage, PayGroupListResponse>;
-  list(
-    query: PayGroupListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<PayGroupListResponsesSinglePage, PayGroupListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/employer/pay-groups', PayGroupListResponsesSinglePage, {
+    query: PayGroupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PayGroupListResponsesSinglePage, PayGroupListResponse> {
+    return this._client.getAPIList('/employer/pay-groups', SinglePage<PayGroupListResponse>, {
       query,
       ...options,
     });
   }
 }
 
-export class PayGroupListResponsesSinglePage extends SinglePage<PayGroupListResponse> {}
+export type PayGroupListResponsesSinglePage = SinglePage<PayGroupListResponse>;
 
 export interface PayGroupRetrieveResponse {
   /**
@@ -57,14 +52,14 @@ export interface PayGroupRetrieveResponse {
    */
   pay_frequencies: Array<
     | 'annually'
-    | 'semi_annually'
-    | 'quarterly'
-    | 'monthly'
-    | 'semi_monthly'
     | 'bi_weekly'
-    | 'weekly'
     | 'daily'
+    | 'monthly'
     | 'other'
+    | 'quarterly'
+    | 'semi_annually'
+    | 'semi_monthly'
+    | 'weekly'
   >;
 }
 
@@ -72,42 +67,53 @@ export interface PayGroupListResponse {
   /**
    * Finch id (uuidv4) for the pay group
    */
-  id?: string;
+  id: string;
 
   /**
    * Name of the pay group
    */
-  name?: string;
+  name: string;
 
   /**
    * List of pay frequencies associated with this pay group
    */
-  pay_frequencies?: Array<
+  pay_frequencies: Array<
     | 'annually'
-    | 'semi_annually'
-    | 'quarterly'
-    | 'monthly'
-    | 'semi_monthly'
     | 'bi_weekly'
-    | 'weekly'
     | 'daily'
+    | 'monthly'
     | 'other'
+    | 'quarterly'
+    | 'semi_annually'
+    | 'semi_monthly'
+    | 'weekly'
   >;
 }
 
+export interface PayGroupRetrieveParams {
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+}
+
 export interface PayGroupListParams {
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+
   individual_id?: string;
 
   pay_frequencies?: Array<string>;
 }
 
-PayGroups.PayGroupListResponsesSinglePage = PayGroupListResponsesSinglePage;
-
 export declare namespace PayGroups {
   export {
     type PayGroupRetrieveResponse as PayGroupRetrieveResponse,
     type PayGroupListResponse as PayGroupListResponse,
-    PayGroupListResponsesSinglePage as PayGroupListResponsesSinglePage,
+    type PayGroupListResponsesSinglePage as PayGroupListResponsesSinglePage,
+    type PayGroupRetrieveParams as PayGroupRetrieveParams,
     type PayGroupListParams as PayGroupListParams,
   };
 }

package/src/resources/payroll/payroll.ts

@@ -1,28 +1,29 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import * as PayGroupsAPI from "./pay-groups.js";
+import { APIResource } from '../../core/resource';
+import * as PayGroupsAPI from './pay-groups';
 import {
   PayGroupListParams,
   PayGroupListResponse,
   PayGroupListResponsesSinglePage,
+  PayGroupRetrieveParams,
   PayGroupRetrieveResponse,
   PayGroups,
-} from "./pay-groups.js";
+} from './pay-groups';
 
 export class Payroll extends APIResource {
   payGroups: PayGroupsAPI.PayGroups = new PayGroupsAPI.PayGroups(this._client);
 }
 
 Payroll.PayGroups = PayGroups;
-Payroll.PayGroupListResponsesSinglePage = PayGroupListResponsesSinglePage;
 
 export declare namespace Payroll {
   export {
     PayGroups as PayGroups,
     type PayGroupRetrieveResponse as PayGroupRetrieveResponse,
     type PayGroupListResponse as PayGroupListResponse,
-    PayGroupListResponsesSinglePage as PayGroupListResponsesSinglePage,
+    type PayGroupListResponsesSinglePage as PayGroupListResponsesSinglePage,
+    type PayGroupRetrieveParams as PayGroupRetrieveParams,
     type PayGroupListParams as PayGroupListParams,
   };
 }

package/src/resources/payroll.ts

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export * from "./payroll/index.js";
+export * from './payroll/index';