@tryfinch/finch-api 6.31.0 → 7.0.0

package/src/resources/hris/company/pay-statement-item/rules.ts

@@ -1,9 +1,10 @@
 // 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 { ResponsesPage } from "../../../../pagination.js";
+import { APIResource } from '../../../../core/resource';
+import { APIPromise } from '../../../../core/api-promise';
+import { PagePromise, ResponsesPage } from '../../../../core/pagination';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
 
 export class Rules extends APIResource {
   /**
@@ -20,16 +21,16 @@ export class Rules extends APIResource {
    *   await client.hris.company.payStatementItem.rules.create();
    * ```
    */
-  create(body?: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
-  create(options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
   create(
-    body: RuleCreateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleCreateResponse> {
-    if (isRequestOptions(body)) {
-      return this.create({}, body);
-    }
-    return this._client.post('/employer/pay-statement-item/rule', { body, ...options });
+    params: RuleCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RuleCreateResponse> {
+    const { entity_ids, ...body } = params ?? {};
+    return this._client.post('/employer/pay-statement-item/rule', {
+      query: { entity_ids },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -45,20 +46,16 @@ export class Rules extends APIResource {
    * ```
    */
   update(
-    ruleId: string,
-    body?: RuleUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleUpdateResponse>;
-  update(ruleId: string, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse>;
-  update(
-    ruleId: string,
-    body: RuleUpdateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RuleUpdateResponse> {
-    if (isRequestOptions(body)) {
-      return this.update(ruleId, {}, body);
-    }
-    return this._client.put(`/employer/pay-statement-item/rule/${ruleId}`, { body, ...options });
+    ruleID: string,
+    params: RuleUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RuleUpdateResponse> {
+    const { entity_ids, ...body } = params ?? {};
+    return this._client.put(path`/employer/pay-statement-item/rule/${ruleID}`, {
+      query: { entity_ids },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -73,8 +70,14 @@ export class Rules extends APIResource {
    * }
    * ```
    */
-  list(options?: Core.RequestOptions): Core.PagePromise<RuleListResponsesPage, RuleListResponse> {
-    return this._client.getAPIList('/employer/pay-statement-item/rule', RuleListResponsesPage, options);
+  list(
+    query: RuleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<RuleListResponsesPage, RuleListResponse> {
+    return this._client.getAPIList('/employer/pay-statement-item/rule', ResponsesPage<RuleListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -89,12 +92,20 @@ export class Rules extends APIResource {
    *   );
    * ```
    */
-  delete(ruleId: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse> {
-    return this._client.delete(`/employer/pay-statement-item/rule/${ruleId}`, options);
+  delete(
+    ruleID: string,
+    params: RuleDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RuleDeleteResponse> {
+    const { entity_ids } = params ?? {};
+    return this._client.delete(path`/employer/pay-statement-item/rule/${ruleID}`, {
+      query: { entity_ids },
+      ...options,
+    });
   }
 }
 
-export class RuleListResponsesPage extends ResponsesPage<RuleListResponse> {}
+export type RuleListResponsesPage = ResponsesPage<RuleListResponse>;
 
 export interface RuleCreateResponse {
   /**
@@ -149,7 +160,7 @@ export namespace RuleCreateResponse {
      * The metadata to be attached in the entity. It is a key-value pairs where the
      * values can be of any type (string, number, boolean, object, array, etc.).
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
   }
 
   export interface Condition {
@@ -223,7 +234,7 @@ export namespace RuleUpdateResponse {
      * The metadata to be attached in the entity. It is a key-value pairs where the
      * values can be of any type (string, number, boolean, object, array, etc.).
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
   }
 
   export interface Condition {
@@ -297,7 +308,7 @@ export namespace RuleListResponse {
      * The metadata to be attached in the entity. It is a key-value pairs where the
      * values can be of any type (string, number, boolean, object, array, etc.).
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
   }
 
   export interface Condition {
@@ -376,7 +387,7 @@ export namespace RuleDeleteResponse {
      * The metadata to be attached in the entity. It is a key-value pairs where the
      * values can be of any type (string, number, boolean, object, array, etc.).
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
   }
 
   export interface Condition {
@@ -399,24 +410,33 @@ export namespace RuleDeleteResponse {
 
 export interface RuleCreateParams {
   /**
-   * Specifies the fields to be applied when the condition is met.
+   * Query param: The entity IDs to create the rule for.
+   */
+  entity_ids?: Array<string>;
+
+  /**
+   * Body param: Specifies the fields to be applied when the condition is met.
    */
   attributes?: RuleCreateParams.Attributes;
 
+  /**
+   * Body param:
+   */
   conditions?: Array<RuleCreateParams.Condition>;
 
   /**
-   * Specifies when the rules should stop applying rules based on the date.
+   * Body param: Specifies when the rules should stop applying rules based on the
+   * date.
    */
   effective_end_date?: string | null;
 
   /**
-   * Specifies when the rule should begin applying based on the date.
+   * Body param: Specifies when the rule should begin applying based on the date.
    */
   effective_start_date?: string | null;
 
   /**
-   * The entity type to which the rule is applied.
+   * Body param: The entity type to which the rule is applied.
    */
   entity_type?: 'pay_statement_item';
 }
@@ -430,7 +450,7 @@ export namespace RuleCreateParams {
      * The metadata to be attached in the entity. It is a key-value pairs where the
      * values can be of any type (string, number, boolean, object, array, etc.).
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
   }
 
   export interface Condition {
@@ -452,10 +472,30 @@ export namespace RuleCreateParams {
 }
 
 export interface RuleUpdateParams {
+  /**
+   * Query param: The entity IDs to update the rule for.
+   */
+  entity_ids?: Array<string>;
+
+  /**
+   * Body param:
+   */
   optionalProperty?: unknown;
 }
 
-Rules.RuleListResponsesPage = RuleListResponsesPage;
+export interface RuleListParams {
+  /**
+   * The entity IDs to retrieve rules for.
+   */
+  entity_ids?: Array<string>;
+}
+
+export interface RuleDeleteParams {
+  /**
+   * The entity IDs to delete the rule for.
+   */
+  entity_ids?: Array<string>;
+}
 
 export declare namespace Rules {
   export {
@@ -463,8 +503,10 @@ export declare namespace Rules {
     type RuleUpdateResponse as RuleUpdateResponse,
     type RuleListResponse as RuleListResponse,
     type RuleDeleteResponse as RuleDeleteResponse,
-    RuleListResponsesPage as RuleListResponsesPage,
+    type RuleListResponsesPage as RuleListResponsesPage,
     type RuleCreateParams as RuleCreateParams,
     type RuleUpdateParams as RuleUpdateParams,
+    type RuleListParams as RuleListParams,
+    type RuleDeleteParams as RuleDeleteParams,
   };
 }

package/src/resources/hris/company/pay-statement-item.ts

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

package/src/resources/hris/company.ts

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

package/src/resources/hris/directory.ts

@@ -1,9 +1,8 @@
 // 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 { IndividualsPage, type IndividualsPageParams } from "../../pagination.js";
+import { APIResource } from '../../core/resource';
+import { IndividualsPage, type IndividualsPageParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Directory extends APIResource {
   /**
@@ -18,18 +17,13 @@ export class Directory extends APIResource {
    * ```
    */
   list(
-    query?: DirectoryListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
-  list(options?: Core.RequestOptions): Core.PagePromise<IndividualsPage, IndividualInDirectory>;
-  list(
-    query: DirectoryListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<IndividualsPage, IndividualInDirectory> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/employer/directory', IndividualsPage, { query, ...options });
+    query: DirectoryListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<IndividualsPage, IndividualInDirectory> {
+    return this._client.getAPIList('/employer/directory', IndividualsPage, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -97,9 +91,19 @@ export namespace IndividualInDirectory {
   }
 }
 
-export interface DirectoryListParams extends IndividualsPageParams {}
+export interface DirectoryListParams extends IndividualsPageParams {
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+}
 
-export interface DirectoryListIndividualsParams extends IndividualsPageParams {}
+export interface DirectoryListIndividualsParams extends IndividualsPageParams {
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+}
 
 export declare namespace Directory {
   export {

package/src/resources/hris/documents.ts

@@ -1,9 +1,10 @@
 // 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 * as Shared from "../shared.js";
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Documents extends APIResource {
   /**
@@ -15,15 +16,10 @@ export class Documents extends APIResource {
    * const documents = await client.hris.documents.list();
    * ```
    */
-  list(query?: DocumentListParams, options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
-  list(options?: Core.RequestOptions): Core.APIPromise<DocumentListResponse>;
   list(
-    query: DocumentListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<DocumentListResponse> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
+    query: DocumentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DocumentListResponse> {
     return this._client.get('/employer/documents', { query, ...options });
   }
 
@@ -38,8 +34,12 @@ export class Documents extends APIResource {
    * );
    * ```
    */
-  retreive(documentId: string, options?: Core.RequestOptions): Core.APIPromise<DocumentRetreiveResponse> {
-    return this._client.get(`/employer/documents/${documentId}`, options);
+  retreive(
+    documentID: string,
+    query: DocumentRetreiveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DocumentRetreiveResponse> {
+    return this._client.get(path`/employer/documents/${documentID}`, { query, ...options });
   }
 }
 
@@ -47,29 +47,29 @@ export interface DocumentResponse {
   /**
    * A stable Finch id for the document.
    */
-  id?: string;
+  id: string;
 
   /**
    * The ID of the individual associated with the document. This will be null for
    * employer-level documents.
    */
-  individual_id?: string | null;
+  individual_id: string | null;
 
   /**
    * The type of document.
    */
-  type?: 'w4_2020' | 'w4_2005';
+  type: 'w4_2020' | 'w4_2005';
 
   /**
    * A URL to access the document. Format:
    * `https://api.tryfinch.com/employer/documents/:document_id`.
    */
-  url?: string;
+  url: string;
 
   /**
    * The year the document applies to, if available.
    */
-  year?: number | null;
+  year: number;
 }
 
 /**
@@ -80,17 +80,17 @@ export interface W42005 {
   /**
    * Detailed information specific to the 2005 W4 form.
    */
-  data?: W42005.Data;
+  data: W42005.Data;
 
   /**
    * Specifies the form type, indicating that this document is a 2005 W4 form.
    */
-  type?: 'w4_2005';
+  type: 'w4_2005';
 
   /**
    * The tax year this W4 document applies to.
    */
-  year?: number | null;
+  year: number;
 }
 
 export namespace W42005 {
@@ -101,27 +101,27 @@ export namespace W42005 {
     /**
      * Additional withholding amount (in cents).
      */
-    additional_withholding?: number | null;
+    additional_withholding: number;
 
     /**
      * Indicates exemption status from federal tax withholding.
      */
-    exemption?: 'exempt' | 'non_exempt';
+    exemption: 'exempt' | 'non_exempt' | null;
 
     /**
      * The individual's filing status for tax purposes.
      */
-    filing_status?: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single' | null;
+    filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single' | null;
 
     /**
      * The unique identifier for the individual associated with this 2005 W4 form.
      */
-    individual_id?: string;
+    individual_id: string;
 
     /**
      * Total number of allowances claimed (in cents).
      */
-    total_number_of_allowances?: number | null;
+    total_number_of_allowances: number;
   }
 }
 
@@ -133,17 +133,17 @@ export interface W42020 {
   /**
    * Detailed information specific to the 2020 W4 form.
    */
-  data?: W42020.Data;
+  data: W42020.Data;
 
   /**
    * Specifies the form type, indicating that this document is a 2020 W4 form.
    */
-  type?: 'w4_2020';
+  type: 'w4_2020';
 
   /**
    * The tax year this W4 document applies to.
    */
-  year?: number | null;
+  year: number;
 }
 
 export namespace W42020 {
@@ -155,27 +155,27 @@ export namespace W42020 {
      * Amount claimed for dependents other than qualifying children under 17 (in
      * cents).
      */
-    amount_for_other_dependents?: number | null;
+    amount_for_other_dependents: number;
 
     /**
      * Amount claimed for dependents under 17 years old (in cents).
      */
-    amount_for_qualifying_children_under_17?: number | null;
+    amount_for_qualifying_children_under_17: number;
 
     /**
      * Deductible expenses (in cents).
      */
-    deductions?: number | null;
+    deductions: number;
 
     /**
      * Additional withholding amount (in cents).
      */
-    extra_withholding?: number | null;
+    extra_withholding: number;
 
     /**
      * The individual's filing status for tax purposes.
      */
-    filing_status?:
+    filing_status:
       | 'head_of_household'
       | 'married_filing_jointly_or_qualifying_surviving_spouse'
       | 'single_or_married_filing_separately'
@@ -184,17 +184,17 @@ export namespace W42020 {
     /**
      * The unique identifier for the individual associated with this document.
      */
-    individual_id?: string;
+    individual_id: string;
 
     /**
      * Additional income from sources outside of primary employment (in cents).
      */
-    other_income?: number | null;
+    other_income: number;
 
     /**
      * Total amount claimed for dependents and other credits (in cents).
      */
-    total_claim_dependent_and_other_credits?: number | null;
+    total_claim_dependent_and_other_credits: number;
   }
 }
 
@@ -211,6 +211,11 @@ export interface DocumentListResponse {
 export type DocumentRetreiveResponse = W42020 | W42005;
 
 export interface DocumentListParams {
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+
   /**
    * Comma-delimited list of stable Finch uuids for each individual. If empty,
    * defaults to all individuals
@@ -234,6 +239,13 @@ export interface DocumentListParams {
   types?: Array<'w4_2020' | 'w4_2005'>;
 }
 
+export interface DocumentRetreiveParams {
+  /**
+   * The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
+}
+
 export declare namespace Documents {
   export {
     type DocumentResponse as DocumentResponse,
@@ -242,5 +254,6 @@ export declare namespace Documents {
     type DocumentListResponse as DocumentListResponse,
     type DocumentRetreiveResponse as DocumentRetreiveResponse,
     type DocumentListParams as DocumentListParams,
+    type DocumentRetreiveParams as DocumentRetreiveParams,
   };
 }

package/src/resources/hris/employments.ts

@@ -1,9 +1,9 @@
 // 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 * as HRISAPI from "./hris.js";
-import { ResponsesPage } from "../../pagination.js";
+import { APIResource } from '../../core/resource';
+import * as HRISAPI from './hris';
+import { PagePromise, ResponsesPage } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Employments extends APIResource {
   /**
@@ -20,10 +20,12 @@ export class Employments extends APIResource {
    * ```
    */
   retrieveMany(
-    body: EmploymentRetrieveManyParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<EmploymentDataResponsesPage, EmploymentDataResponse> {
-    return this._client.getAPIList('/employer/employment', EmploymentDataResponsesPage, {
+    params: EmploymentRetrieveManyParams,
+    options?: RequestOptions,
+  ): PagePromise<EmploymentDataResponsesPage, EmploymentDataResponse> {
+    const { entity_ids, ...body } = params;
+    return this._client.getAPIList('/employer/employment', ResponsesPage<EmploymentDataResponse>, {
+      query: { entity_ids },
       body,
       method: 'post',
       ...options,
@@ -31,7 +33,7 @@ export class Employments extends APIResource {
   }
 }
 
-export class EmploymentDataResponsesPage extends ResponsesPage<EmploymentDataResponse> {}
+export type EmploymentDataResponsesPage = ResponsesPage<EmploymentDataResponse>;
 
 export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError;
 
@@ -47,13 +49,6 @@ export namespace EmploymentData {
      */
     class_code: string | null;
 
-    /**
-     * Custom fields for the individual. These are fields which are defined by the
-     * employer in the system. Custom fields are not currently supported for assisted
-     * connections.
-     */
-    custom_fields: Array<UnionMember0.CustomField> | null;
-
     /**
      * The department object.
      */
@@ -117,9 +112,11 @@ export namespace EmploymentData {
     title: string | null;
 
     /**
-     * @deprecated This field is deprecated in favour of `source_id`
+     * Custom fields for the individual. These are fields which are defined by the
+     * employer in the system. Custom fields are not currently supported for assisted
+     * connections.
      */
-    work_id: string | null;
+    custom_fields?: Array<UnionMember0.CustomField> | null;
 
     /**
      * The employee's income as reported by the provider. This may not always be
@@ -137,15 +134,14 @@ export namespace EmploymentData {
      * The source system's unique employment identifier for this individual
      */
     source_id?: string | null;
+
+    /**
+     * @deprecated This field is deprecated in favour of `source_id`
+     */
+    work_id?: string | null;
   }
 
   export namespace UnionMember0 {
-    export interface CustomField {
-      name?: string | null;
-
-      value?: string | null | Array<unknown> | null | unknown | number | null | boolean | null;
-    }
-
     /**
      * The department object.
      */
@@ -181,6 +177,12 @@ export namespace EmploymentData {
        */
       id: string;
     }
+
+    export interface CustomField {
+      name?: string | null;
+
+      value?: string | null | Array<unknown> | null | unknown | number | null | boolean | null;
+    }
   }
 
   export interface BatchError {
@@ -207,9 +209,14 @@ export interface EmploymentDataResponse {
 
 export interface EmploymentRetrieveManyParams {
   /**
-   * The array of batch requests.
+   * Body param: The array of batch requests.
    */
   requests: Array<EmploymentRetrieveManyParams.Request>;
+
+  /**
+   * Query param: The entity IDs to specify which entities' data to access.
+   */
+  entity_ids?: Array<string>;
 }
 
 export namespace EmploymentRetrieveManyParams {
@@ -223,13 +230,11 @@ export namespace EmploymentRetrieveManyParams {
   }
 }
 
-Employments.EmploymentDataResponsesPage = EmploymentDataResponsesPage;
-
 export declare namespace Employments {
   export {
     type EmploymentData as EmploymentData,
     type EmploymentDataResponse as EmploymentDataResponse,
-    EmploymentDataResponsesPage as EmploymentDataResponsesPage,
+    type EmploymentDataResponsesPage as EmploymentDataResponsesPage,
     type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams,
   };
 }