@tryfinch/finch-api 5.14.3 → 5.16.0

package/src/resources/sandbox/employment.ts

@@ -0,0 +1,279 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as EmploymentAPI from "./employment";
+import * as HRISAPI from "../hris/hris";
+
+export class Employment extends APIResource {
+  /**
+   * Update sandbox employment
+   */
+  update(
+    individualId: string,
+    body?: EmploymentUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EmploymentUpdateResponse>;
+  update(individualId: string, options?: Core.RequestOptions): Core.APIPromise<EmploymentUpdateResponse>;
+  update(
+    individualId: string,
+    body: EmploymentUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<EmploymentUpdateResponse> {
+    if (isRequestOptions(body)) {
+      return this.update(individualId, {}, body);
+    }
+    return this._client.put(`/sandbox/employment/${individualId}`, { body, ...options });
+  }
+}
+
+export interface EmploymentUpdateResponse {
+  /**
+   * A stable Finch `id` (UUID v4) for an individual in the company.
+   */
+  id?: string;
+
+  /**
+   * Worker's compensation classification code for this employee
+   */
+  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<EmploymentUpdateResponse.CustomField>;
+
+  /**
+   * The department object.
+   */
+  department?: EmploymentUpdateResponse.Department | null;
+
+  /**
+   * The employment object.
+   */
+  employment?: EmploymentUpdateResponse.Employment | null;
+
+  end_date?: string | null;
+
+  /**
+   * The legal first name of the individual.
+   */
+  first_name?: string | 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,
+   * depending on what information the provider returns.
+   */
+  income?: HRISAPI.Income | null;
+
+  /**
+   * The array of income history.
+   */
+  income_history?: Array<HRISAPI.Income | null> | null;
+
+  /**
+   * `true` if the individual an an active employee or contractor at the company.
+   */
+  is_active?: boolean | null;
+
+  /**
+   * The legal last name of the individual.
+   */
+  last_name?: string | null;
+
+  location?: HRISAPI.Location | null;
+
+  /**
+   * The manager object representing the manager of the individual within the org.
+   */
+  manager?: EmploymentUpdateResponse.Manager | null;
+
+  /**
+   * The legal middle name of the individual.
+   */
+  middle_name?: string | null;
+
+  /**
+   * The source system's unique employment identifier for this individual
+   */
+  source_id?: string;
+
+  start_date?: string | null;
+
+  /**
+   * The current title of the individual.
+   */
+  title?: string | null;
+}
+
+export namespace EmploymentUpdateResponse {
+  export interface CustomField {
+    name?: string | null;
+
+    value?: unknown;
+  }
+
+  /**
+   * The department object.
+   */
+  export interface Department {
+    /**
+     * The name of the department associated with the individual.
+     */
+    name?: string | null;
+  }
+
+  /**
+   * The employment object.
+   */
+  export interface Employment {
+    /**
+     * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+     */
+    subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+
+    /**
+     * The main employment type of the individual.
+     */
+    type?: 'employee' | 'contractor' | null;
+  }
+
+  /**
+   * The manager object representing the manager of the individual within the org.
+   */
+  export interface Manager {
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company.
+     */
+    id?: string;
+  }
+}
+
+export interface EmploymentUpdateParams {
+  /**
+   * Worker's compensation classification code for this employee
+   */
+  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<EmploymentUpdateParams.CustomField>;
+
+  /**
+   * The department object.
+   */
+  department?: EmploymentUpdateParams.Department | null;
+
+  /**
+   * The employment object.
+   */
+  employment?: EmploymentUpdateParams.Employment | null;
+
+  end_date?: string | null;
+
+  /**
+   * The legal first name of the individual.
+   */
+  first_name?: string | 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,
+   * depending on what information the provider returns.
+   */
+  income?: HRISAPI.Income | null;
+
+  /**
+   * The array of income history.
+   */
+  income_history?: Array<HRISAPI.Income | null> | null;
+
+  /**
+   * `true` if the individual an an active employee or contractor at the company.
+   */
+  is_active?: boolean | null;
+
+  /**
+   * The legal last name of the individual.
+   */
+  last_name?: string | null;
+
+  location?: HRISAPI.Location | null;
+
+  /**
+   * The manager object representing the manager of the individual within the org.
+   */
+  manager?: EmploymentUpdateParams.Manager | null;
+
+  /**
+   * The legal middle name of the individual.
+   */
+  middle_name?: string | null;
+
+  /**
+   * The source system's unique employment identifier for this individual
+   */
+  source_id?: string;
+
+  start_date?: string | null;
+
+  /**
+   * The current title of the individual.
+   */
+  title?: string | null;
+}
+
+export namespace EmploymentUpdateParams {
+  export interface CustomField {
+    name?: string | null;
+
+    value?: unknown;
+  }
+
+  /**
+   * The department object.
+   */
+  export interface Department {
+    /**
+     * The name of the department associated with the individual.
+     */
+    name?: string | null;
+  }
+
+  /**
+   * The employment object.
+   */
+  export interface Employment {
+    /**
+     * The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.
+     */
+    subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor' | null;
+
+    /**
+     * The main employment type of the individual.
+     */
+    type?: 'employee' | 'contractor' | null;
+  }
+
+  /**
+   * The manager object representing the manager of the individual within the org.
+   */
+  export interface Manager {
+    /**
+     * A stable Finch `id` (UUID v4) for an individual in the company.
+     */
+    id?: string;
+  }
+}
+
+export namespace Employment {
+  export import EmploymentUpdateResponse = EmploymentAPI.EmploymentUpdateResponse;
+  export import EmploymentUpdateParams = EmploymentAPI.EmploymentUpdateParams;
+}

package/src/resources/sandbox/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { CompanyUpdateResponse, CompanyUpdateParams, Company } from './company';
+export { ConnectionCreateResponse, ConnectionCreateParams, Connections } from './connections/index';
+export { DirectoryCreateResponse, DirectoryCreateParams, Directory } from './directory';
+export { EmploymentUpdateResponse, EmploymentUpdateParams, Employment } from './employment';
+export { IndividualUpdateResponse, IndividualUpdateParams, Individual } from './individual';
+export { Jobs } from './jobs/index';
+export { PaymentCreateResponse, PaymentCreateParams, Payment } from './payment';
+export { Sandbox } from './sandbox';

package/src/resources/sandbox/individual.ts

@@ -0,0 +1,193 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as IndividualAPI from "./individual";
+import * as HRISAPI from "../hris/hris";
+
+export class Individual extends APIResource {
+  /**
+   * Update sandbox individual
+   */
+  update(
+    individualId: string,
+    body?: IndividualUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<IndividualUpdateResponse>;
+  update(individualId: string, options?: Core.RequestOptions): Core.APIPromise<IndividualUpdateResponse>;
+  update(
+    individualId: string,
+    body: IndividualUpdateParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<IndividualUpdateResponse> {
+    if (isRequestOptions(body)) {
+      return this.update(individualId, {}, body);
+    }
+    return this._client.put(`/sandbox/individual/${individualId}`, { body, ...options });
+  }
+}
+
+export interface IndividualUpdateResponse {
+  /**
+   * A stable Finch `id` (UUID v4) for an individual in the company.
+   */
+  id?: string;
+
+  dob?: string | null;
+
+  emails?: Array<IndividualUpdateResponse.Email> | null;
+
+  /**
+   * Social Security Number of the individual in **encrypted** format. This field is
+   * only available with the `ssn` scope enabled and the
+   * `options: { include: ['ssn'] }` param set in the body.
+   */
+  encrypted_ssn?: string | null;
+
+  /**
+   * The EEOC-defined ethnicity of the individual.
+   */
+  ethnicity?:
+    | 'asian'
+    | 'white'
+    | 'black_or_african_american'
+    | 'native_hawaiian_or_pacific_islander'
+    | 'american_indian_or_alaska_native'
+    | 'hispanic_or_latino'
+    | 'two_or_more_races'
+    | 'decline_to_specify'
+    | null;
+
+  /**
+   * The legal first name of the individual.
+   */
+  first_name?: string | null;
+
+  /**
+   * The gender of the individual.
+   */
+  gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
+
+  /**
+   * The legal last name of the individual.
+   */
+  last_name?: string | null;
+
+  /**
+   * The legal middle name of the individual.
+   */
+  middle_name?: string | null;
+
+  phone_numbers?: Array<IndividualUpdateResponse.PhoneNumber | null> | null;
+
+  /**
+   * The preferred name of the individual.
+   */
+  preferred_name?: string | null;
+
+  residence?: HRISAPI.Location | null;
+
+  /**
+   * Social Security Number of the individual. This field is only available with the
+   * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
+   * body.
+   */
+  ssn?: string | null;
+}
+
+export namespace IndividualUpdateResponse {
+  export interface Email {
+    data?: string;
+
+    type?: 'work' | 'personal';
+  }
+
+  export interface PhoneNumber {
+    data?: string;
+
+    type?: 'work' | 'personal';
+  }
+}
+
+export interface IndividualUpdateParams {
+  dob?: string | null;
+
+  emails?: Array<IndividualUpdateParams.Email> | null;
+
+  /**
+   * Social Security Number of the individual in **encrypted** format. This field is
+   * only available with the `ssn` scope enabled and the
+   * `options: { include: ['ssn'] }` param set in the body.
+   */
+  encrypted_ssn?: string | null;
+
+  /**
+   * The EEOC-defined ethnicity of the individual.
+   */
+  ethnicity?:
+    | 'asian'
+    | 'white'
+    | 'black_or_african_american'
+    | 'native_hawaiian_or_pacific_islander'
+    | 'american_indian_or_alaska_native'
+    | 'hispanic_or_latino'
+    | 'two_or_more_races'
+    | 'decline_to_specify'
+    | null;
+
+  /**
+   * The legal first name of the individual.
+   */
+  first_name?: string | null;
+
+  /**
+   * The gender of the individual.
+   */
+  gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null;
+
+  /**
+   * The legal last name of the individual.
+   */
+  last_name?: string | null;
+
+  /**
+   * The legal middle name of the individual.
+   */
+  middle_name?: string | null;
+
+  phone_numbers?: Array<IndividualUpdateParams.PhoneNumber | null> | null;
+
+  /**
+   * The preferred name of the individual.
+   */
+  preferred_name?: string | null;
+
+  residence?: HRISAPI.Location | null;
+
+  /**
+   * Social Security Number of the individual. This field is only available with the
+   * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
+   * body.
+   */
+  ssn?: string | null;
+}
+
+export namespace IndividualUpdateParams {
+  export interface Email {
+    data?: string;
+
+    type?: 'work' | 'personal';
+  }
+
+  export interface PhoneNumber {
+    data?: string;
+
+    type?: 'work' | 'personal';
+  }
+}
+
+export namespace Individual {
+  export import IndividualUpdateResponse = IndividualAPI.IndividualUpdateResponse;
+  export import IndividualUpdateParams = IndividualAPI.IndividualUpdateParams;
+}

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

@@ -0,0 +1,44 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from "../../../core";
+import { APIResource } from "../../../resource";
+import * as ConfigurationAPI from "./configuration";
+
+export class Configuration extends APIResource {
+  /**
+   * Get configurations for sandbox jobs
+   */
+  retrieve(options?: Core.RequestOptions): Core.APIPromise<ConfigurationRetrieveResponse> {
+    return this._client.get('/sandbox/jobs/configuration', options);
+  }
+
+  /**
+   * Update configurations for sandbox jobs
+   */
+  update(
+    body: ConfigurationUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SandboxJobConfiguration> {
+    return this._client.put('/sandbox/jobs/configuration', { body, ...options });
+  }
+}
+
+export interface SandboxJobConfiguration {
+  completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error';
+
+  type: 'data_sync_all';
+}
+
+export type ConfigurationRetrieveResponse = Array<SandboxJobConfiguration>;
+
+export interface ConfigurationUpdateParams {
+  completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error';
+
+  type: 'data_sync_all';
+}
+
+export namespace Configuration {
+  export import SandboxJobConfiguration = ConfigurationAPI.SandboxJobConfiguration;
+  export import ConfigurationRetrieveResponse = ConfigurationAPI.ConfigurationRetrieveResponse;
+  export import ConfigurationUpdateParams = ConfigurationAPI.ConfigurationUpdateParams;
+}

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

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { Jobs } from './jobs';
+export {
+  SandboxJobConfiguration,
+  ConfigurationRetrieveResponse,
+  ConfigurationUpdateParams,
+  Configuration,
+} from './configuration';

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

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import { APIResource } from "../../../resource";
+import * as ConfigurationAPI from "./configuration";
+
+export class Jobs extends APIResource {
+  configuration: ConfigurationAPI.Configuration = new ConfigurationAPI.Configuration(this._client);
+}
+
+export namespace Jobs {
+  export import Configuration = ConfigurationAPI.Configuration;
+  export import SandboxJobConfiguration = ConfigurationAPI.SandboxJobConfiguration;
+  export import ConfigurationRetrieveResponse = ConfigurationAPI.ConfigurationRetrieveResponse;
+  export import ConfigurationUpdateParams = ConfigurationAPI.ConfigurationUpdateParams;
+}