@tryfinch/finch-api 6.31.0 → 8.0.0

package/src/resources/sandbox/payment.ts

@@ -1,10 +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 * as HRISAPI from "../hris/hris.js";
-import * as BenefitsAPI from "../hris/benefits/benefits.js";
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
 
 export class Payment extends APIResource {
   /**
@@ -12,32 +10,13 @@ export class Payment extends APIResource {
    *
    * @example
    * ```ts
-   * const payment = await client.sandbox.payment.create({
-   *   pay_statements: [
-   *     {
-   *       individual_id: 'b2338cfb-472f-4f72-9faa-e028c083144a',
-   *       employee_deductions: [
-   *         {
-   *           name: '401k test',
-   *           type: '401k',
-   *           amount: 2000,
-   *           currency: 'usd',
-   *         },
-   *       ],
-   *     },
-   *   ],
-   * });
+   * const payment = await client.sandbox.payment.create();
    * ```
    */
-  create(body?: PaymentCreateParams, options?: Core.RequestOptions): Core.APIPromise<PaymentCreateResponse>;
-  create(options?: Core.RequestOptions): Core.APIPromise<PaymentCreateResponse>;
   create(
-    body: PaymentCreateParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PaymentCreateResponse> {
-    if (isRequestOptions(body)) {
-      return this.create({}, body);
-    }
+    body: PaymentCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PaymentCreateResponse> {
     return this._client.post('/sandbox/payment', { body, ...options });
   }
 }
@@ -57,6 +36,9 @@ export interface PaymentCreateResponse {
 export interface PaymentCreateParams {
   end_date?: string;
 
+  /**
+   * Array of pay statements to include in the payment.
+   */
   pay_statements?: Array<PaymentCreateParams.PayStatement>;
 
   start_date?: string;
@@ -64,241 +46,121 @@ export interface PaymentCreateParams {
 
 export namespace PaymentCreateParams {
   export interface PayStatement {
-    /**
-     * The array of earnings objects associated with this pay statement
-     */
-    earnings?: Array<PayStatement.Earning | null> | null;
+    individual_id: string;
 
-    /**
-     * The array of deductions objects associated with this pay statement.
-     */
-    employee_deductions?: Array<PayStatement.EmployeeDeduction | null> | null;
+    earnings?: Array<PayStatement.Earning>;
 
-    employer_contributions?: Array<PayStatement.EmployerContribution | null> | null;
+    employee_deductions?: Array<PayStatement.EmployeeDeduction>;
 
-    gross_pay?: HRISAPI.Money | null;
+    employer_contributions?: Array<PayStatement.EmployerContribution>;
 
-    /**
-     * A stable Finch `id` (UUID v4) for an individual in the company
-     */
-    individual_id?: string;
+    gross_pay?: number;
 
-    net_pay?: HRISAPI.Money | null;
+    net_pay?: number;
 
-    /**
-     * The payment method.
-     */
     payment_method?: 'check' | 'direct_deposit' | 'other' | null;
 
-    /**
-     * The array of taxes objects associated with this pay statement.
-     */
-    taxes?: Array<PayStatement.Tax | null> | null;
+    taxes?: Array<PayStatement.Tax>;
 
-    /**
-     * The number of hours worked for this pay period
-     */
-    total_hours?: number | null;
+    total_hours?: number;
 
-    /**
-     * The type of the payment associated with the pay statement.
-     */
-    type?: 'regular_payroll' | 'off_cycle_payroll' | 'one_time_payment' | null;
+    type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll' | null;
   }
 
   export namespace PayStatement {
     export interface Earning {
-      /**
-       * The earnings amount in cents.
-       */
-      amount?: number | null;
-
-      attributes?: Earning.Attributes | null;
-
-      /**
-       * The earnings currency code.
-       */
-      currency?: string | null;
+      amount?: number;
 
-      /**
-       * The number of hours associated with this earning. (For salaried employees, this
-       * could be hours per pay period, `0` or `null`, depending on the provider).
-       */
-      hours?: number | null;
+      hours?: number;
 
-      /**
-       * The exact name of the deduction from the pay statement.
-       */
-      name?: string | null;
+      name?: string;
 
-      /**
-       * The type of earning.
-       */
       type?:
-        | 'salary'
-        | 'wage'
-        | 'reimbursement'
-        | 'overtime'
-        | 'severance'
+        | 'bonus'
+        | 'commission'
         | 'double_overtime'
+        | 'other'
+        | 'overtime'
         | 'pto'
+        | 'reimbursement'
+        | 'salary'
+        | 'severance'
         | 'sick'
-        | 'bonus'
-        | 'commission'
         | 'tips'
-        | '1099'
-        | 'other'
-        | null;
-    }
-
-    export namespace Earning {
-      export interface Attributes {
-        metadata?: Attributes.Metadata;
-      }
-
-      export namespace Attributes {
-        export interface Metadata {
-          /**
-           * The metadata to be attached to the entity by existing rules. It is a key-value
-           * pairs where the values can be of any type (string, number, boolean, object,
-           * array, etc.).
-           */
-          metadata?: Record<string, unknown>;
-        }
-      }
+        | 'wage'
+        | '1099';
     }
 
     export interface EmployeeDeduction {
-      /**
-       * The deduction amount in cents.
-       */
-      amount?: number | null;
-
-      attributes?: EmployeeDeduction.Attributes | null;
+      amount?: number;
 
       /**
-       * The deduction currency.
+       * The deduction name. Required when type is specified.
        */
-      currency?: string | null;
+      name?: string;
 
-      /**
-       * The deduction name from the pay statement.
-       */
-      name?: string | null;
-
-      /**
-       * Boolean indicating if the deduction is pre-tax.
-       */
-      pre_tax?: boolean | null;
-
-      /**
-       * Type of benefit.
-       */
-      type?: BenefitsAPI.BenefitType | null;
-    }
+      pre_tax?: boolean;
 
-    export namespace EmployeeDeduction {
-      export interface Attributes {
-        metadata?: Attributes.Metadata;
-      }
-
-      export namespace Attributes {
-        export interface Metadata {
-          /**
-           * The metadata to be attached to the entity by existing rules. It is a key-value
-           * pairs where the values can be of any type (string, number, boolean, object,
-           * array, etc.).
-           */
-          metadata?: Record<string, unknown>;
-        }
-      }
+      type?:
+        | '457'
+        | '401k'
+        | '401k_roth'
+        | '401k_loan'
+        | '403b'
+        | '403b_roth'
+        | '457_roth'
+        | 'commuter'
+        | 'custom_post_tax'
+        | 'custom_pre_tax'
+        | 'fsa_dependent_care'
+        | 'fsa_medical'
+        | 'hsa_post'
+        | 'hsa_pre'
+        | 's125_dental'
+        | 's125_medical'
+        | 's125_vision'
+        | 'simple'
+        | 'simple_ira';
     }
 
     export interface EmployerContribution {
-      /**
-       * The contribution amount in cents.
-       */
-      amount?: number | null;
-
-      attributes?: EmployerContribution.Attributes | null;
+      amount?: number;
 
       /**
-       * The contribution currency.
+       * The contribution name. Required when type is specified.
        */
-      currency?: string | null;
+      name?: string;
 
-      /**
-       * The contribution name from the pay statement.
-       */
-      name?: string | null;
-
-      /**
-       * Type of benefit.
-       */
-      type?: BenefitsAPI.BenefitType | null;
-    }
-
-    export namespace EmployerContribution {
-      export interface Attributes {
-        metadata?: Attributes.Metadata;
-      }
-
-      export namespace Attributes {
-        export interface Metadata {
-          /**
-           * The metadata to be attached to the entity by existing rules. It is a key-value
-           * pairs where the values can be of any type (string, number, boolean, object,
-           * array, etc.).
-           */
-          metadata?: Record<string, unknown>;
-        }
-      }
+      type?:
+        | '457'
+        | '401k'
+        | '401k_roth'
+        | '401k_loan'
+        | '403b'
+        | '403b_roth'
+        | '457_roth'
+        | 'commuter'
+        | 'custom_post_tax'
+        | 'custom_pre_tax'
+        | 'fsa_dependent_care'
+        | 'fsa_medical'
+        | 'hsa_post'
+        | 'hsa_pre'
+        | 's125_dental'
+        | 's125_medical'
+        | 's125_vision'
+        | 'simple'
+        | 'simple_ira';
     }
 
     export interface Tax {
-      /**
-       * The tax amount in cents.
-       */
-      amount?: number | null;
+      amount?: number;
 
-      attributes?: Tax.Attributes | null;
+      employer?: boolean;
 
-      /**
-       * The currency code.
-       */
-      currency?: string | null;
-
-      /**
-       * `true` if the amount is paid by the employers.
-       */
-      employer?: boolean | null;
-
-      /**
-       * The exact name of tax from the pay statement.
-       */
-      name?: string | null;
-
-      /**
-       * The type of taxes.
-       */
-      type?: 'state' | 'federal' | 'local' | 'fica' | null;
-    }
+      name?: string;
 
-    export namespace Tax {
-      export interface Attributes {
-        metadata?: Attributes.Metadata;
-      }
-
-      export namespace Attributes {
-        export interface Metadata {
-          /**
-           * The metadata to be attached to the entity by existing rules. It is a key-value
-           * pairs where the values can be of any type (string, number, boolean, object,
-           * array, etc.).
-           */
-          metadata?: Record<string, unknown>;
-        }
-      }
+      type?: 'federal' | 'fica' | 'local' | 'state';
     }
   }
 }

package/src/resources/sandbox/sandbox.ts

@@ -1,20 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../../resource.js";
-import * as CompanyAPI from "./company.js";
-import { Company, CompanyUpdateParams, CompanyUpdateResponse } from "./company.js";
-import * as DirectoryAPI from "./directory.js";
-import { Directory, DirectoryCreateParams, DirectoryCreateResponse } from "./directory.js";
-import * as EmploymentAPI from "./employment.js";
-import { Employment, EmploymentUpdateParams, EmploymentUpdateResponse } from "./employment.js";
-import * as IndividualAPI from "./individual.js";
-import { Individual, IndividualUpdateParams, IndividualUpdateResponse } from "./individual.js";
-import * as PaymentAPI from "./payment.js";
-import { Payment, PaymentCreateParams, PaymentCreateResponse } from "./payment.js";
-import * as ConnectionsAPI from "./connections/connections.js";
-import { ConnectionCreateParams, ConnectionCreateResponse, Connections } from "./connections/connections.js";
-import * as JobsAPI from "./jobs/jobs.js";
-import { JobCreateParams, JobCreateResponse, Jobs } from "./jobs/jobs.js";
+import { APIResource } from '../../core/resource';
+import * as CompanyAPI from './company';
+import { Company, CompanyUpdateParams, CompanyUpdateResponse } from './company';
+import * as DirectoryAPI from './directory';
+import { Directory, DirectoryCreateParams, DirectoryCreateResponse } from './directory';
+import * as EmploymentAPI from './employment';
+import { Employment, EmploymentUpdateParams, EmploymentUpdateResponse } from './employment';
+import * as IndividualAPI from './individual';
+import { Individual, IndividualUpdateParams, IndividualUpdateResponse } from './individual';
+import * as PaymentAPI from './payment';
+import { Payment, PaymentCreateParams, PaymentCreateResponse } from './payment';
+import * as ConnectionsAPI from './connections/connections';
+import { ConnectionCreateParams, ConnectionCreateResponse, Connections } from './connections/connections';
+import * as JobsAPI from './jobs/jobs';
+import { JobCreateParams, JobCreateResponse, Jobs } from './jobs/jobs';
 
 export class Sandbox extends APIResource {
   connections: ConnectionsAPI.Connections = new ConnectionsAPI.Connections(this._client);

package/src/resources/sandbox.ts

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

package/src/resources/webhooks.ts

@@ -1,9 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from "../resource.js";
-import * as Shared from "./shared.js";
-import * as BenefitsAPI from "./hris/benefits/benefits.js";
-import { fromBase64, getRequiredHeader, HeadersLike, toBase64 } from "../core.js";
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import * as BenefitsAPI from './hris/benefits/benefits';
+import type { HeadersLike } from '../internal/headers';
+import { getRequiredHeader } from '../internal/headers';
+import { fromBase64, toBase64 } from '../internal/utils';
 import { hmac } from '@noble/hashes/hmac';
 import { sha256 } from '@noble/hashes/sha2';
 
@@ -577,7 +579,7 @@ export interface BaseWebhookEvent {
 }
 
 export interface CompanyEvent extends BaseWebhookEvent {
-  data?: Record<string, unknown> | null;
+  data?: { [key: string]: unknown } | null;
 
   event_type?: 'company.updated';
 }

package/src/resources.ts

@@ -1 +1 @@
-export * from "./resources/index.js";
+export * from './resources/index';

package/src/tsconfig.json

@@ -4,8 +4,8 @@
   // via declaration maps
   "include": ["index.ts"],
   "compilerOptions": {
-    "target": "es2015",
-    "lib": ["DOM"],
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
     "moduleResolution": "node"
   }
 }