@tryfinch/finch-api 1.0.0

package/resources/hris/pay-statements.ts

@@ -0,0 +1,251 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import * as HRIS from '~/resources/hris';
+import * as Benefits from '~/resources/hris/benefits';
+import { ResponsesPage } from '~/pagination';
+
+export class PayStatements extends APIResource {
+  /**
+   * Read detailed pay statements for each individual.
+   *
+   * Deduction and contribution types are supported by the payroll systems that
+   * support Benefits.
+   */
+  retrieveMany(
+    body: PayStatementRetrieveManyParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<PayStatementResponsesResponsesPage> {
+    return this.getAPIList('/employer/pay-statement', PayStatementResponsesResponsesPage, {
+      body,
+      method: 'post',
+      ...options,
+    });
+  }
+}
+
+export class PayStatementResponsesResponsesPage extends ResponsesPage<PayStatementResponse> {}
+
+export interface PayStatement {
+  /**
+   * The array of earnings objects associated with this pay statement
+   */
+  earnings?: Array<PayStatement.Earnings | null> | null;
+
+  /**
+   * The array of deductions objects associated with this pay statement.
+   */
+  employee_deductions?: Array<PayStatement.EmployeeDeductions | null> | null;
+
+  employer_contributions?: Array<PayStatement.EmployerContributions | null> | null;
+
+  gross_pay?: HRIS.Money | null;
+
+  /**
+   * A stable Finch `id` (UUID v4) for an individual in the company
+   */
+  individual_id?: string;
+
+  net_pay?: HRIS.Money | null;
+
+  /**
+   * The payment method.
+   */
+  payment_method?: 'check' | 'direct_deposit' | null;
+
+  /**
+   * The array of taxes objects associated with this pay statement.
+   */
+  taxes?: Array<PayStatement.Taxes | 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 Earnings {
+    /**
+     * 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 Taxes {
+    /**
+     * 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 interface EmployeeDeductions {
+    /**
+     * 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?: Benefits.BenefitType | null;
+  }
+
+  export interface EmployerContributions {
+    /**
+     * 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?: Benefits.BenefitType | null;
+  }
+}
+
+export interface PayStatementResponse {
+  body?: PayStatementResponseBody;
+
+  code?: number;
+
+  payment_id?: string;
+}
+
+export interface PayStatementResponseBody {
+  paging?: HRIS.Paging;
+
+  /**
+   * The array of pay statements for the current payment.
+   */
+  pay_statements?: Array<PayStatement>;
+}
+
+export interface PayStatementRetrieveManyParams {
+  /**
+   * The array of batch requests.
+   */
+  requests: Array<PayStatementRetrieveManyParams.Requests>;
+}
+
+export namespace PayStatementRetrieveManyParams {
+  export interface Requests {
+    /**
+     * A stable Finch `id` (UUID v4) for a payment.
+     */
+    payment_id: string;
+
+    /**
+     * Number of pay statements to return (defaults to all).
+     */
+    limit?: number;
+
+    /**
+     * Index to start from.
+     */
+    offset?: number;
+  }
+
+  export interface Requests {
+    /**
+     * A stable Finch `id` (UUID v4) for a payment.
+     */
+    payment_id: string;
+
+    /**
+     * Number of pay statements to return (defaults to all).
+     */
+    limit?: number;
+
+    /**
+     * Index to start from.
+     */
+    offset?: number;
+  }
+}

package/resources/hris/payments.ts

@@ -0,0 +1,73 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import * as HRIS from '~/resources/hris';
+import { SinglePage } from '~/pagination';
+
+export class Payments extends APIResource {
+  /**
+   * Read payroll and contractor related payments by the company.
+   */
+  list(query: PaymentListParams, options?: Core.RequestOptions): Core.PagePromise<PaymentsSinglePage> {
+    return this.getAPIList('/employer/payment', PaymentsSinglePage, { query, ...options });
+  }
+}
+
+export class PaymentsSinglePage extends SinglePage<Payment> {}
+
+export interface Payment {
+  company_debit?: HRIS.Money | null;
+
+  debit_date?: string | null;
+
+  employee_taxes?: HRIS.Money | null;
+
+  employer_taxes?: HRIS.Money | null;
+
+  gross_pay?: HRIS.Money | null;
+
+  /**
+   * The unique id for the payment.
+   */
+  id?: string;
+
+  /**
+   * Array of every individual on this payment.
+   */
+  individual_ids?: Array<string> | null;
+
+  net_pay?: HRIS.Money | null;
+
+  pay_date?: string | null;
+
+  /**
+   * The pay period object.
+   */
+  pay_period?: Payment.PayPeriod | null;
+}
+
+export namespace Payment {
+  /**
+   * The pay period object.
+   */
+  export interface PayPeriod {
+    end_date?: string | null;
+
+    start_date?: string | null;
+  }
+}
+
+export interface PaymentListParams {
+  /**
+   * The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
+   * format.
+   */
+  end_date: string;
+
+  /**
+   * The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
+   * format.
+   */
+  start_date: string;
+}

package/resources/index.ts

@@ -0,0 +1,6 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export { ATS } from './ats/ats';
+export { DisconnectResponse, Introspection, Account } from './account';
+export { Income, Location, Money, Paging, HRIS } from './hris/hris';
+export { Provider, ProvidersSinglePage, Providers } from './providers';

package/resources/providers.ts

@@ -0,0 +1,59 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import * as Core from '~/core';
+import { APIResource } from '~/resource';
+import { SinglePage } from '~/pagination';
+
+export class Providers extends APIResource {
+  /**
+   * Return details on all available payroll and HR systems.
+   */
+  list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage> {
+    return this.getAPIList('/providers', ProvidersSinglePage, options);
+  }
+}
+
+export class ProvidersSinglePage extends SinglePage<Provider> {}
+
+export interface Provider {
+  /**
+   * The display name of the payroll provider.
+   */
+  display_name?: string;
+
+  /**
+   * The url to the official icon of the payroll provider.
+   */
+  icon?: string;
+
+  /**
+   * The id of the payroll provider used in Connect.
+   */
+  id?: string;
+
+  /**
+   * The url to the official logo of the payroll provider.
+   */
+  logo?: string;
+
+  /**
+   * Whether the Finch integration with this provider uses the Assisted Connect Flow
+   * by default.
+   */
+  manual?: boolean;
+
+  /**
+   * whether MFA is required for the provider.
+   */
+  mfa_required?: boolean;
+
+  /**
+   * The hex code for the primary color of the payroll provider.
+   */
+  primary_color?: string;
+
+  /**
+   * The list of Finch products supported on this payroll provider.
+   */
+  products?: Array<string>;
+}

package/resources/top-level.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless.
+
+export {};

package/tests/api-resources/account.test.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import Finch from '~/index';
+
+const finch = new Finch({ accessToken: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+
+describe('resource account', () => {
+  test('disconnect', async () => {
+    const response = await finch.account.disconnect();
+  });
+
+  test('disconnect: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.account.disconnect({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('introspect', async () => {
+    const response = await finch.account.introspect();
+  });
+
+  test('introspect: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.account.introspect({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+});

package/tests/api-resources/ats/applications.test.ts

@@ -0,0 +1,36 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import Finch from '~/index';
+
+const finch = new Finch({ accessToken: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+
+describe('resource applications', () => {
+  test('retrieve', async () => {
+    const response = await finch.ats.applications.retrieve('string');
+  });
+
+  test('retrieve: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.ats.applications.retrieve('string', { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+
+  test('list', async () => {
+    const response = await finch.ats.applications.list();
+  });
+
+  test('list: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.ats.applications.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('list: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.ats.applications.list({ limit: 0, offset: 0 }, { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+});

package/tests/api-resources/ats/candidates.test.ts

@@ -0,0 +1,36 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import Finch from '~/index';
+
+const finch = new Finch({ accessToken: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+
+describe('resource candidates', () => {
+  test('retrieve', async () => {
+    const response = await finch.ats.candidates.retrieve('string');
+  });
+
+  test('retrieve: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.ats.candidates.retrieve('string', { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+
+  test('list', async () => {
+    const response = await finch.ats.candidates.list();
+  });
+
+  test('list: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.ats.candidates.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('list: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.ats.candidates.list({ limit: 0, offset: 0 }, { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+});

package/tests/api-resources/ats/jobs.test.ts

@@ -0,0 +1,36 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import Finch from '~/index';
+
+const finch = new Finch({ accessToken: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+
+describe('resource jobs', () => {
+  test('retrieve', async () => {
+    const response = await finch.ats.jobs.retrieve('string');
+  });
+
+  test('retrieve: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.ats.jobs.retrieve('string', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('list', async () => {
+    const response = await finch.ats.jobs.list();
+  });
+
+  test('list: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.ats.jobs.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('list: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.ats.jobs.list({ limit: 0, offset: 0 }, { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+});

package/tests/api-resources/ats/offers.test.ts

@@ -0,0 +1,36 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import Finch from '~/index';
+
+const finch = new Finch({ accessToken: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+
+describe('resource offers', () => {
+  test('retrieve', async () => {
+    const response = await finch.ats.offers.retrieve('string');
+  });
+
+  test('retrieve: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.ats.offers.retrieve('string', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('list', async () => {
+    const response = await finch.ats.offers.list();
+  });
+
+  test('list: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.ats.offers.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('list: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.ats.offers.list({ limit: 0, offset: 0 }, { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+});

package/tests/api-resources/ats/stages.test.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import Finch from '~/index';
+
+const finch = new Finch({ accessToken: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+
+describe('resource stages', () => {
+  test('list', async () => {
+    const response = await finch.ats.stages.list();
+  });
+
+  test('list: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.ats.stages.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+});

package/tests/api-resources/hris/benefits/benefits.test.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless.
+
+import Finch from '~/index';
+
+const finch = new Finch({ accessToken: 'something1234', baseURL: 'http://127.0.0.1:4010' });
+
+describe('resource benefits', () => {
+  test('create', async () => {
+    const response = await finch.hris.benefits.create();
+  });
+
+  test('create: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.hris.benefits.create({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('create: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.hris.benefits.create(
+        { description: 'string', frequency: 'one_time', type: '401k' },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+
+  test('retrieve', async () => {
+    const response = await finch.hris.benefits.retrieve('string');
+  });
+
+  test('retrieve: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.hris.benefits.retrieve('string', { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+
+  test('update', async () => {
+    const response = await finch.hris.benefits.update('string');
+  });
+
+  test('update: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.hris.benefits.update('string', { path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('update: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.hris.benefits.update('string', { description: 'string' }, { path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+
+  test('list', async () => {
+    const response = await finch.hris.benefits.list();
+  });
+
+  test('list: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(finch.hris.benefits.list({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Finch.NotFoundError,
+    );
+  });
+
+  test('listSupportedBenefits', async () => {
+    const response = await finch.hris.benefits.listSupportedBenefits();
+  });
+
+  test('listSupportedBenefits: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      finch.hris.benefits.listSupportedBenefits({ path: '/_stainless_unknown_path' }),
+    ).rejects.toThrow(Finch.NotFoundError);
+  });
+});