@tryfinch/finch-api 5.14.3 → 5.16.0

package/src/resources/sandbox/payment.ts

@@ -0,0 +1,215 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as PaymentAPI from "./payment";
+import * as HRISAPI from "../hris/hris";
+import * as BenefitsAPI from "../hris/benefits/benefits";
+
+export class Payment extends APIResource {
+  /**
+   * Add a new sandbox payment
+   */
+  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);
+    }
+    return this._client.post('/sandbox/payment', { body, ...options });
+  }
+}
+
+export interface PaymentCreateResponse {
+  /**
+   * The date of the payment.
+   */
+  pay_date: string;
+
+  /**
+   * The ID of the payment.
+   */
+  payment_id: string;
+}
+
+export interface PaymentCreateParams {
+  end_date?: string;
+
+  pay_statements?: Array<PaymentCreateParams.PayStatement>;
+
+  start_date?: string;
+}
+
+export namespace PaymentCreateParams {
+  export interface PayStatement {
+    /**
+     * The array of earnings objects associated with this pay statement
+     */
+    earnings?: Array<PayStatement.Earning | null> | null;
+
+    /**
+     * The array of deductions objects associated with this pay statement.
+     */
+    employee_deductions?: Array<PayStatement.EmployeeDeduction | null> | null;
+
+    employer_contributions?: Array<PayStatement.EmployerContribution | null> | null;
+
+    gross_pay?: HRISAPI.Money | null;
+
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company
+     */
+    individual_id?: string;
+
+    net_pay?: HRISAPI.Money | null;
+
+    /**
+     * The payment method.
+     */
+    payment_method?: 'check' | 'direct_deposit' | null;
+
+    /**
+     * The array of taxes objects associated with this pay statement.
+     */
+    taxes?: Array<PayStatement.Tax | null> | null;
+
+    /**
+     * The number of hours worked for this pay period
+     */
+    total_hours?: number | null;
+
+    /**
+     * The type of the payment associated with the pay statement.
+     */
+    type?: 'regular_payroll' | 'off_cycle_payroll' | 'one_time_payment' | null;
+  }
+
+  export namespace PayStatement {
+    export interface Earning {
+      /**
+       * The earnings amount in cents.
+       */
+      amount?: number | null;
+
+      /**
+       * The earnings currency code.
+       */
+      currency?: string | null;
+
+      /**
+       * 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;
+
+      /**
+       * The exact name of the deduction from the pay statement.
+       */
+      name?: string | null;
+
+      /**
+       * The type of earning.
+       */
+      type?:
+        | 'salary'
+        | 'wage'
+        | 'reimbursement'
+        | 'overtime'
+        | 'severance'
+        | 'double_overtime'
+        | 'pto'
+        | 'sick'
+        | 'bonus'
+        | 'commission'
+        | 'tips'
+        | '1099'
+        | 'other'
+        | null;
+    }
+
+    export interface EmployeeDeduction {
+      /**
+       * The deduction amount in cents.
+       */
+      amount?: number | null;
+
+      /**
+       * The deduction currency.
+       */
+      currency?: string | null;
+
+      /**
+       * 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;
+    }
+
+    export interface EmployerContribution {
+      /**
+       * The contribution amount in cents.
+       */
+      amount?: number | null;
+
+      /**
+       * The contribution currency.
+       */
+      currency?: string | null;
+
+      /**
+       * The contribution name from the pay statement.
+       */
+      name?: string | null;
+
+      /**
+       * Type of benefit.
+       */
+      type?: BenefitsAPI.BenefitType | null;
+    }
+
+    export interface Tax {
+      /**
+       * The tax amount in cents.
+       */
+      amount?: number | null;
+
+      /**
+       * 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;
+    }
+  }
+}
+
+export namespace Payment {
+  export import PaymentCreateResponse = PaymentAPI.PaymentCreateResponse;
+  export import PaymentCreateParams = PaymentAPI.PaymentCreateParams;
+}

package/src/resources/sandbox/sandbox.ts

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

package/src/resources/shared.ts

@@ -1,5 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 
+export type ConnectionStatusType =
+  | 'pending'
+  | 'processing'
+  | 'connected'
+  | 'error_no_account_setup'
+  | 'error_permissions'
+  | 'reauth';
+
 /**
  * - `supported`: This operation is supported by both the provider and Finch
  *

package/src/uploads.ts

@@ -184,7 +184,7 @@ export const isMultipartBody = (body: any): body is MultipartBody =>
  * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
  * Otherwise returns the request as is.
  */
-export const maybeMultipartFormRequestOptions = async <T extends {} = Record<string, unknown>>(
+export const maybeMultipartFormRequestOptions = async <T = Record<string, unknown>>(
   opts: RequestOptions<T>,
 ): Promise<RequestOptions<T | MultipartBody>> => {
   if (!hasUploadableValue(opts.body)) return opts;
@@ -193,7 +193,7 @@ export const maybeMultipartFormRequestOptions = async <T extends {} = Record<str
   return getMultipartRequestOptions(form, opts);
 };
 
-export const multipartFormRequestOptions = async <T extends {} = Record<string, unknown>>(
+export const multipartFormRequestOptions = async <T = Record<string, unknown>>(
   opts: RequestOptions<T>,
 ): Promise<RequestOptions<T | MultipartBody>> => {
   const form = await createForm(opts.body);

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.14.3'; // x-release-please-version
+export const VERSION = '5.16.0'; // x-release-please-version

package/uploads.d.ts

@@ -69,7 +69,7 @@ export declare const isMultipartBody: (body: any) => body is MultipartBody;
  * Returns a multipart/form-data request if any part of the given request body contains a File / Blob value.
  * Otherwise returns the request as is.
  */
-export declare const maybeMultipartFormRequestOptions: <T extends {} = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
-export declare const multipartFormRequestOptions: <T extends {} = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
+export declare const maybeMultipartFormRequestOptions: <T = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
+export declare const multipartFormRequestOptions: <T = Record<string, unknown>>(opts: RequestOptions<T>) => Promise<RequestOptions<MultipartBody | T>>;
 export declare const createForm: <T = Record<string, unknown>>(body: T | undefined) => Promise<FormData>;
 //# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EACL,QAAQ,EAER,KAAK,IAAI,EACT,KAAK,eAAe,EAEpB,KAAK,YAAY,EAElB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,KAAK,YAAY,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;AAC9F,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,IAAI,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE7F;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,YAAY,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,6EAA6E;IAC7E,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CAE/C;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,oFAAoF;IACpF,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC3B;AAED,eAAO,MAAM,cAAc,UAAW,GAAG,0BAIP,CAAC;AAEnC,eAAO,MAAM,UAAU,UAAW,GAAG,sBAKlB,CAAC;AAEpB;;;GAGG;AACH,eAAO,MAAM,UAAU,UAAW,GAAG;mBAAwC,QAAQ,WAAW,CAAC;CAOxD,CAAC;AAE1C,eAAO,MAAM,YAAY,UAAW,GAAG,wBAEtC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;AAEnG;;;;;;;;GAQG;AACH,wBAAsB,MAAM,CAC1B,KAAK,EAAE,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,EAC7C,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,OAAO,GAAE,eAAe,GAAG,SAAc,GACxC,OAAO,CAAC,QAAQ,CAAC,CAuBnB;AAmDD,eAAO,MAAM,eAAe,SAAU,GAAG,0BACsD,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,gCAAgC,iHAO5C,CAAC;AAEF,eAAO,MAAM,2BAA2B,iHAKvC,CAAC;AAEF,eAAO,MAAM,UAAU,wDAA6D,QAAQ,QAAQ,CAInG,CAAC"}
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,EACL,QAAQ,EAER,KAAK,IAAI,EACT,KAAK,eAAe,EAEpB,KAAK,YAAY,EAElB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,KAAK,YAAY,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC;AAC9F,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,IAAI,GAAG,UAAU,GAAG,QAAQ,CAAC;AAE7F;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,YAAY,GAAG,YAAY,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4EAA4E;IAC5E,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,6EAA6E;IAC7E,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CAE/C;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,oFAAoF;IACpF,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC3B;AAED,eAAO,MAAM,cAAc,UAAW,GAAG,0BAIP,CAAC;AAEnC,eAAO,MAAM,UAAU,UAAW,GAAG,sBAKlB,CAAC;AAEpB;;;GAGG;AACH,eAAO,MAAM,UAAU,UAAW,GAAG;mBAAwC,QAAQ,WAAW,CAAC;CAOxD,CAAC;AAE1C,eAAO,MAAM,YAAY,UAAW,GAAG,wBAEtC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;AAEnG;;;;;;;;GAQG;AACH,wBAAsB,MAAM,CAC1B,KAAK,EAAE,WAAW,GAAG,WAAW,CAAC,WAAW,CAAC,EAC7C,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,OAAO,GAAE,eAAe,GAAG,SAAc,GACxC,OAAO,CAAC,QAAQ,CAAC,CAuBnB;AAmDD,eAAO,MAAM,eAAe,SAAU,GAAG,0BACsD,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,gCAAgC,sGAO5C,CAAC;AAEF,eAAO,MAAM,2BAA2B,sGAKvC,CAAC;AAEF,eAAO,MAAM,UAAU,wDAA6D,QAAQ,QAAQ,CAInG,CAAC"}

package/version.d.ts

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

package/version.mjs

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