@tryfinch/finch-api 8.2.1 → 9.8.0

package/src/resources/hris/directory.ts

@@ -23,6 +23,7 @@ export class Directory extends APIResource {
     return this._client.getAPIList('/employer/directory', IndividualsPage, {
       query,
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 
@@ -98,11 +99,21 @@ export interface DirectoryListParams extends IndividualsPageParams {
   entity_ids?: Array<string>;
 }
 
-export interface DirectoryListIndividualsParams extends IndividualsPageParams {
+export interface DirectoryListIndividualsParams {
   /**
    * The entity IDs to specify which entities' data to access.
    */
   entity_ids?: Array<string>;
+
+  /**
+   * Number of employees to return (defaults to all)
+   */
+  limit?: number;
+
+  /**
+   * Index to start from (defaults to 0)
+   */
+  offset?: number;
 }
 
 export declare namespace Directory {

package/src/resources/hris/documents.ts

@@ -20,7 +20,7 @@ export class Documents extends APIResource {
     query: DocumentListParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<DocumentListResponse> {
-    return this._client.get('/employer/documents', { query, ...options });
+    return this._client.get('/employer/documents', { query, ...options, __security: { bearerAuth: true } });
   }
 
   /**
@@ -39,7 +39,11 @@ export class Documents extends APIResource {
     query: DocumentRetreiveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<DocumentRetreiveResponse> {
-    return this._client.get(path`/employer/documents/${documentID}`, { query, ...options });
+    return this._client.get(path`/employer/documents/${documentID}`, {
+      query,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/src/resources/hris/employments.ts

@@ -29,16 +29,17 @@ export class Employments extends APIResource {
       body,
       method: 'post',
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 }
 
 export type EmploymentDataResponsesPage = ResponsesPage<EmploymentDataResponse>;
 
-export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError;
+export type EmploymentData = EmploymentData.EmploymentData | EmploymentData.BatchError;
 
 export namespace EmploymentData {
-  export interface UnionMember0 {
+  export interface EmploymentData {
     /**
      * A stable Finch `id` (UUID v4) for an individual in the company.
      */
@@ -52,12 +53,12 @@ export namespace EmploymentData {
     /**
      * The department object.
      */
-    department: UnionMember0.Department | null;
+    department: EmploymentData.Department | null;
 
     /**
      * The employment object.
      */
-    employment: UnionMember0.Employment | null;
+    employment: EmploymentData.Employment | null;
 
     /**
      * The detailed employment status of the individual.
@@ -79,6 +80,12 @@ export namespace EmploymentData {
      */
     first_name: string | null;
 
+    /**
+     * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+     * `unknown`.
+     */
+    flsa_status: 'exempt' | 'non_exempt' | 'unknown' | null;
+
     /**
      * `true` if the individual an an active employee or contractor at the company.
      */
@@ -96,7 +103,7 @@ export namespace EmploymentData {
     /**
      * The manager object representing the manager of the individual within the org.
      */
-    manager: UnionMember0.Manager | null;
+    manager: EmploymentData.Manager | null;
 
     /**
      * The legal middle name of the individual.
@@ -115,7 +122,7 @@ export namespace EmploymentData {
      * employer in the system. Custom fields are not currently supported for assisted
      * connections.
      */
-    custom_fields?: Array<UnionMember0.CustomField> | null;
+    custom_fields?: Array<EmploymentData.CustomField> | null;
 
     /**
      * The employee's income as reported by the provider. This may not always be
@@ -140,7 +147,7 @@ export namespace EmploymentData {
     work_id?: string | null;
   }
 
-  export namespace UnionMember0 {
+  export namespace EmploymentData {
     /**
      * The department object.
      */

package/src/resources/hris/individuals.ts

@@ -27,16 +27,17 @@ export class Individuals extends APIResource {
       body,
       method: 'post',
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 }
 
 export type IndividualResponsesPage = ResponsesPage<IndividualResponse>;
 
-export type Individual = Individual.UnionMember0 | Individual.BatchError;
+export type Individual = Individual.Individual | Individual.BatchError;
 
 export namespace Individual {
-  export interface UnionMember0 {
+  export interface Individual {
     /**
      * A stable Finch `id` (UUID v4) for an individual in the company.
      */
@@ -78,7 +79,7 @@ export namespace Individual {
      */
     middle_name: string | null;
 
-    phone_numbers: Array<UnionMember0.PhoneNumber | null> | null;
+    phone_numbers: Array<Individual.PhoneNumber | null> | null;
 
     /**
      * The preferred name of the individual.
@@ -87,7 +88,7 @@ export namespace Individual {
 
     residence: HRISAPI.Location | null;
 
-    emails?: Array<UnionMember0.Email> | null;
+    emails?: Array<Individual.Email> | null;
 
     /**
      * Social Security Number of the individual in **encrypted** format. This field is
@@ -105,7 +106,7 @@ export namespace Individual {
     ssn?: string | null;
   }
 
-  export namespace UnionMember0 {
+  export namespace Individual {
     export interface PhoneNumber {
       data: string | null;
 

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

@@ -39,6 +39,7 @@ export class PayStatements extends APIResource {
       body,
       method: 'post',
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 }

package/src/resources/hris/payments.ts

@@ -21,7 +21,11 @@ export class Payments extends APIResource {
    * ```
    */
   list(query: PaymentListParams, options?: RequestOptions): PagePromise<PaymentsSinglePage, Payment> {
-    return this._client.getAPIList('/employer/payment', SinglePage<Payment>, { query, ...options });
+    return this._client.getAPIList('/employer/payment', SinglePage<Payment>, {
+      query,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/src/resources/jobs/automated.ts

@@ -23,14 +23,14 @@ export class Automated extends APIResource {
    * access to this endpoint, please contact your Finch account manager.
    */
   create(body: AutomatedCreateParams, options?: RequestOptions): APIPromise<AutomatedCreateResponse> {
-    return this._client.post('/jobs/automated', { body, ...options });
+    return this._client.post('/jobs/automated', { body, ...options, __security: { bearerAuth: true } });
   }
 
   /**
    * Get an automated job by `job_id`.
    */
   retrieve(jobID: string, options?: RequestOptions): APIPromise<AutomatedAsyncJob> {
-    return this._client.get(path`/jobs/automated/${jobID}`, options);
+    return this._client.get(path`/jobs/automated/${jobID}`, { ...options, __security: { bearerAuth: true } });
   }
 
   /**
@@ -42,7 +42,7 @@ export class Automated extends APIResource {
     query: AutomatedListParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<AutomatedListResponse> {
-    return this._client.get('/jobs/automated', { query, ...options });
+    return this._client.get('/jobs/automated', { query, ...options, __security: { bearerAuth: true } });
   }
 }
 

package/src/resources/jobs/manual.ts

@@ -11,7 +11,7 @@ export class Manual extends APIResource {
    * jobs including those for both automated and assisted integrations.
    */
   retrieve(jobID: string, options?: RequestOptions): APIPromise<ManualAsyncJob> {
-    return this._client.get(path`/jobs/manual/${jobID}`, options);
+    return this._client.get(path`/jobs/manual/${jobID}`, { ...options, __security: { bearerAuth: true } });
   }
 }
 

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

@@ -15,7 +15,11 @@ export class PayGroups extends APIResource {
     query: PayGroupRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<PayGroupRetrieveResponse> {
-    return this._client.get(path`/employer/pay-groups/${payGroupID}`, { query, ...options });
+    return this._client.get(path`/employer/pay-groups/${payGroupID}`, {
+      query,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 
   /**
@@ -28,6 +32,7 @@ export class PayGroups extends APIResource {
     return this._client.getAPIList('/employer/pay-groups', SinglePage<PayGroupListResponse>, {
       query,
       ...options,
+      __security: { bearerAuth: true },
     });
   }
 }

package/src/resources/providers.ts

@@ -9,7 +9,10 @@ export class Providers extends APIResource {
    * Return details on all available payroll and HR systems.
    */
   list(options?: RequestOptions): PagePromise<ProviderListResponsesSinglePage, ProviderListResponse> {
-    return this._client.getAPIList('/providers', SinglePage<ProviderListResponse>, options);
+    return this._client.getAPIList('/providers', SinglePage<ProviderListResponse>, {
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/src/resources/request-forwarding.ts

@@ -15,7 +15,7 @@ export class RequestForwarding extends APIResource {
     body: RequestForwardingForwardParams,
     options?: RequestOptions,
   ): APIPromise<RequestForwardingForwardResponse> {
-    return this._client.post('/forward', { body, ...options });
+    return this._client.post('/forward', { body, ...options, __security: { bearerAuth: true } });
   }
 }
 

package/src/resources/sandbox/company.ts

@@ -33,7 +33,7 @@ export class Company extends APIResource {
    * ```
    */
   update(body: CompanyUpdateParams, options?: RequestOptions): APIPromise<CompanyUpdateResponse> {
-    return this._client.put('/sandbox/company', { body, ...options });
+    return this._client.put('/sandbox/company', { body, ...options, __security: { bearerAuth: true } });
   }
 }
 

package/src/resources/sandbox/connections/accounts.ts

@@ -19,7 +19,11 @@ export class Accounts extends APIResource {
    * ```
    */
   create(body: AccountCreateParams, options?: RequestOptions): APIPromise<AccountCreateResponse> {
-    return this._client.post('/sandbox/connections/accounts', { body, ...options });
+    return this._client.post('/sandbox/connections/accounts', {
+      body,
+      ...options,
+      __security: { basicAuth: true },
+    });
   }
 
   /**
@@ -38,7 +42,11 @@ export class Accounts extends APIResource {
     body: AccountUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<AccountUpdateResponse> {
-    return this._client.put('/sandbox/connections/accounts', { body, ...options });
+    return this._client.put('/sandbox/connections/accounts', {
+      body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/src/resources/sandbox/connections/connections.ts

@@ -26,7 +26,7 @@ export class Connections extends APIResource {
    * ```
    */
   create(body: ConnectionCreateParams, options?: RequestOptions): APIPromise<ConnectionCreateResponse> {
-    return this._client.post('/sandbox/connections', { body, ...options });
+    return this._client.post('/sandbox/connections', { body, ...options, __security: { basicAuth: true } });
   }
 }
 

package/src/resources/sandbox/directory.ts

@@ -19,7 +19,11 @@ export class Directory extends APIResource {
     options?: RequestOptions,
   ): APIPromise<DirectoryCreateResponse> {
     const { body } = params ?? {};
-    return this._client.post('/sandbox/directory', { body: body, ...options });
+    return this._client.post('/sandbox/directory', {
+      body: body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 
@@ -105,6 +109,12 @@ export namespace DirectoryCreateParams {
      */
     first_name?: string | null;
 
+    /**
+     * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+     * `unknown`.
+     */
+    flsa_status?: 'exempt' | 'non_exempt' | 'unknown' | null;
+
     /**
      * The gender of the individual.
      */

package/src/resources/sandbox/employment.ts

@@ -22,7 +22,11 @@ export class Employment extends APIResource {
     body: EmploymentUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<EmploymentUpdateResponse> {
-    return this._client.put(path`/sandbox/employment/${individualID}`, { body, ...options });
+    return this._client.put(path`/sandbox/employment/${individualID}`, {
+      body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 
@@ -74,6 +78,12 @@ export interface EmploymentUpdateResponse {
    */
   first_name?: string | null;
 
+  /**
+   * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+   * `unknown`.
+   */
+  flsa_status?: 'exempt' | 'non_exempt' | 'unknown' | null;
+
   /**
    * 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,
@@ -210,6 +220,12 @@ export interface EmploymentUpdateParams {
    */
   first_name?: string | null;
 
+  /**
+   * The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
+   * `unknown`.
+   */
+  flsa_status?: 'exempt' | 'non_exempt' | 'unknown' | null;
+
   /**
    * 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,

package/src/resources/sandbox/individual.ts

@@ -22,7 +22,11 @@ export class Individual extends APIResource {
     body: IndividualUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<IndividualUpdateResponse> {
-    return this._client.put(path`/sandbox/individual/${individualID}`, { body, ...options });
+    return this._client.put(path`/sandbox/individual/${individualID}`, {
+      body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/src/resources/sandbox/jobs/configuration.ts

@@ -15,7 +15,7 @@ export class Configuration extends APIResource {
    * ```
    */
   retrieve(options?: RequestOptions): APIPromise<ConfigurationRetrieveResponse> {
-    return this._client.get('/sandbox/jobs/configuration', options);
+    return this._client.get('/sandbox/jobs/configuration', { ...options, __security: { bearerAuth: true } });
   }
 
   /**
@@ -31,7 +31,11 @@ export class Configuration extends APIResource {
    * ```
    */
   update(body: ConfigurationUpdateParams, options?: RequestOptions): APIPromise<SandboxJobConfiguration> {
-    return this._client.put('/sandbox/jobs/configuration', { body, ...options });
+    return this._client.put('/sandbox/jobs/configuration', {
+      body,
+      ...options,
+      __security: { bearerAuth: true },
+    });
   }
 }
 

package/src/resources/sandbox/jobs/jobs.ts

@@ -25,7 +25,7 @@ export class Jobs extends APIResource {
    * ```
    */
   create(body: JobCreateParams, options?: RequestOptions): APIPromise<JobCreateResponse> {
-    return this._client.post('/sandbox/jobs', { body, ...options });
+    return this._client.post('/sandbox/jobs', { body, ...options, __security: { bearerAuth: true } });
   }
 }
 

package/src/resources/sandbox/payment.ts

@@ -17,7 +17,7 @@ export class Payment extends APIResource {
     body: PaymentCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<PaymentCreateResponse> {
-    return this._client.post('/sandbox/payment', { body, ...options });
+    return this._client.post('/sandbox/payment', { body, ...options, __security: { bearerAuth: true } });
   }
 }
 

package/src/resources/webhooks.ts

@@ -576,6 +576,11 @@ export interface BaseWebhookEvent {
    * Unique Finch ID of the connection associated with the webhook event.
    */
   connection_id?: string;
+
+  /**
+   * Unique Finch id of the entity for which data has been updated.
+   */
+  entity_id?: string;
 }
 
 export interface CompanyEvent extends BaseWebhookEvent {
@@ -638,7 +643,10 @@ export interface JobCompletionEvent extends BaseWebhookEvent {
     | 'job.benefit_register.completed'
     | 'job.benefit_unenroll.completed'
     | 'job.benefit_update.completed'
-    | 'job.data_sync_all.completed';
+    | 'job.data_sync_all.completed'
+    | 'job.w4_form_employee_sync.completed'
+    | 'job.initial_data_sync_org.succeeded'
+    | 'job.initial_data_sync_payroll.succeeded';
 }
 
 export namespace JobCompletionEvent {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '8.2.1'; // x-release-please-version
+export const VERSION = '9.8.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "8.2.1";
+export declare const VERSION = "9.8.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

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

package/version.mjs

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