@tryfinch/finch-api 5.1.0 → 5.3.0

package/resource.mjs

@@ -1,13 +1,13 @@
 // File generated from our OpenAPI spec by Stainless.
 export class APIResource {
-  constructor(client) {
-    this.client = client;
-    this.get = client.get.bind(client);
-    this.post = client.post.bind(client);
-    this.patch = client.patch.bind(client);
-    this.put = client.put.bind(client);
-    this.delete = client.delete.bind(client);
-    this.getAPIList = client.getAPIList.bind(client);
-  }
+    constructor(client) {
+        this.client = client;
+        this.get = client.get.bind(client);
+        this.post = client.post.bind(client);
+        this.patch = client.patch.bind(client);
+        this.put = client.put.bind(client);
+        this.delete = client.delete.bind(client);
+        this.getAPIList = client.getAPIList.bind(client);
+    }
 }
-//# sourceMappingURL=resource.mjs.map
+//# sourceMappingURL=resource.mjs.map

package/resources/account.d.ts

@@ -1,54 +1,54 @@
 import * as Core from '@tryfinch/finch-api/core';
 import { APIResource } from '@tryfinch/finch-api/resource';
-import * as API from './index.js';
+import * as API from "./index.js";
 export declare class Account extends APIResource {
-  /**
-   * Disconnect an employer from your application and invalidate all `access_token`s
-   * associated with the employer. We require applications to implement the
-   * Disconnect endpoint for billing and security purposes.
-   */
-  disconnect(options?: Core.RequestOptions): Core.APIPromise<DisconnectResponse>;
-  /**
-   * Read account information associated with an `access_token`
-   */
-  introspect(options?: Core.RequestOptions): Core.APIPromise<Introspection>;
+    /**
+     * Disconnect an employer from your application and invalidate all `access_token`s
+     * associated with the employer. We require applications to implement the
+     * Disconnect endpoint for billing and security purposes.
+     */
+    disconnect(options?: Core.RequestOptions): Core.APIPromise<DisconnectResponse>;
+    /**
+     * Read account information associated with an `access_token`
+     */
+    introspect(options?: Core.RequestOptions): Core.APIPromise<Introspection>;
 }
 export interface DisconnectResponse {
-  /**
-   * If the request is successful, Finch will return “success” (HTTP 200 status).
-   */
-  status: string;
+    /**
+     * If the request is successful, Finch will return “success” (HTTP 200 status).
+     */
+    status: string;
 }
 export interface Introspection {
-  /**
-   * The client id of the application associated with the `access_token`.
-   */
-  client_id: string;
-  /**
-   * The Finch uuid of the company associated with the `access_token`.
-   */
-  company_id: string;
-  /**
-   * Whether the connection associated with the `access_token` uses the Assisted
-   * Connect Flow. (`true` if using Assisted Connect, `false` if connection is
-   * automated)
-   */
-  manual: boolean;
-  /**
-   * The payroll provider associated with the `access_token`.
-   */
-  payroll_provider_id: string;
-  /**
-   * An array of the authorized products associated with the `access_token`.
-   */
-  products: Array<string>;
-  /**
-   * The account username used for login associated with the `access_token`.
-   */
-  username: string;
+    /**
+     * The client id of the application associated with the `access_token`.
+     */
+    client_id: string;
+    /**
+     * The Finch uuid of the company associated with the `access_token`.
+     */
+    company_id: string;
+    /**
+     * Whether the connection associated with the `access_token` uses the Assisted
+     * Connect Flow. (`true` if using Assisted Connect, `false` if connection is
+     * automated)
+     */
+    manual: boolean;
+    /**
+     * The payroll provider associated with the `access_token`.
+     */
+    payroll_provider_id: string;
+    /**
+     * An array of the authorized products associated with the `access_token`.
+     */
+    products: Array<string>;
+    /**
+     * The account username used for login associated with the `access_token`.
+     */
+    username: string;
 }
 export declare namespace Account {
-  export import DisconnectResponse = API.DisconnectResponse;
-  export import Introspection = API.Introspection;
+    export import DisconnectResponse = API.DisconnectResponse;
+    export import Introspection = API.Introspection;
 }
-//# sourceMappingURL=account.d.ts.map
+//# sourceMappingURL=account.d.ts.map

package/resources/account.js

@@ -1,24 +1,25 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.Account = void 0;
-const resource_1 = require('@tryfinch/finch-api/resource');
+const resource_1 = require("@tryfinch/finch-api/resource");
 class Account extends resource_1.APIResource {
-  /**
-   * Disconnect an employer from your application and invalidate all `access_token`s
-   * associated with the employer. We require applications to implement the
-   * Disconnect endpoint for billing and security purposes.
-   */
-  disconnect(options) {
-    return this.post('/disconnect', options);
-  }
-  /**
-   * Read account information associated with an `access_token`
-   */
-  introspect(options) {
-    return this.get('/introspect', options);
-  }
+    /**
+     * Disconnect an employer from your application and invalidate all `access_token`s
+     * associated with the employer. We require applications to implement the
+     * Disconnect endpoint for billing and security purposes.
+     */
+    disconnect(options) {
+        return this.post('/disconnect', options);
+    }
+    /**
+     * Read account information associated with an `access_token`
+     */
+    introspect(options) {
+        return this.get('/introspect', options);
+    }
 }
 exports.Account = Account;
-(function (Account) {})((Account = exports.Account || (exports.Account = {})));
-//# sourceMappingURL=account.js.map
+(function (Account) {
+})(Account = exports.Account || (exports.Account = {}));
+//# sourceMappingURL=account.js.map

package/resources/account.mjs

@@ -1,20 +1,21 @@
 // File generated from our OpenAPI spec by Stainless.
 import { APIResource } from '@tryfinch/finch-api/resource';
 export class Account extends APIResource {
-  /**
-   * Disconnect an employer from your application and invalidate all `access_token`s
-   * associated with the employer. We require applications to implement the
-   * Disconnect endpoint for billing and security purposes.
-   */
-  disconnect(options) {
-    return this.post('/disconnect', options);
-  }
-  /**
-   * Read account information associated with an `access_token`
-   */
-  introspect(options) {
-    return this.get('/introspect', options);
-  }
+    /**
+     * Disconnect an employer from your application and invalidate all `access_token`s
+     * associated with the employer. We require applications to implement the
+     * Disconnect endpoint for billing and security purposes.
+     */
+    disconnect(options) {
+        return this.post('/disconnect', options);
+    }
+    /**
+     * Read account information associated with an `access_token`
+     */
+    introspect(options) {
+        return this.get('/introspect', options);
+    }
 }
-(function (Account) {})(Account || (Account = {}));
-//# sourceMappingURL=account.mjs.map
+(function (Account) {
+})(Account || (Account = {}));
+//# sourceMappingURL=account.mjs.map

package/resources/hris/benefits/benefits.d.ts

@@ -1,182 +1,155 @@
 import * as Core from '@tryfinch/finch-api/core';
 import { APIResource } from '@tryfinch/finch-api/resource';
-import { Individuals } from './individuals.js';
-import * as API from './index.js';
+import { Individuals } from "./individuals.js";
+import * as API from "./index.js";
 import { SinglePage } from '@tryfinch/finch-api/pagination';
 export declare class Benefits extends APIResource {
-  individuals: Individuals;
-  /**
-   * **Availability: Automated and Assisted Benefits providers**
-   *
-   * Creates a new company-wide benefit. Please use the `/meta` endpoint to view
-   * available types for each provider.
-   */
-  create(
-    body?: BenefitCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<CreateCompanyBenefitsResponse>;
-  create(options?: Core.RequestOptions): Core.APIPromise<CreateCompanyBenefitsResponse>;
-  /**
-   * **Availability: Automated Benefits providers only**
-   *
-   * Lists benefit information for a given benefit
-   */
-  retrieve(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<CompanyBenefit>;
-  /**
-   * **Availability: Automated and Assisted Benefits providers**
-   *
-   * Updates an existing company-wide benefit
-   */
-  update(
-    benefitId: string,
-    body?: BenefitUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<UpdateCompanyBenefitResponse>;
-  update(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<UpdateCompanyBenefitResponse>;
-  /**
-   * **Availability: Automated Benefits providers only**
-   *
-   * List all company-wide benefits.
-   */
-  list(options?: Core.RequestOptions): Core.PagePromise<CompanyBenefitsSinglePage, CompanyBenefit>;
-  /**
-   * **Availability: Automated and Assisted Benefits providers**
-   *
-   * Lists available types and configurations for the provider associated with the
-   * access token.
-   */
-  listSupportedBenefits(
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<SupportedBenefitsSinglePage, SupportedBenefit>;
+    individuals: Individuals;
+    /**
+     * **Availability: Automated and Assisted Benefits providers**
+     *
+     * Creates a new company-wide benefit. Please use the `/meta` endpoint to view
+     * available types for each provider.
+     */
+    create(body?: BenefitCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateCompanyBenefitsResponse>;
+    create(options?: Core.RequestOptions): Core.APIPromise<CreateCompanyBenefitsResponse>;
+    /**
+     * **Availability: Automated Benefits providers only**
+     *
+     * Lists benefit information for a given benefit
+     */
+    retrieve(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<CompanyBenefit>;
+    /**
+     * **Availability: Automated and Assisted Benefits providers**
+     *
+     * Updates an existing company-wide benefit
+     */
+    update(benefitId: string, body?: BenefitUpdateParams, options?: Core.RequestOptions): Core.APIPromise<UpdateCompanyBenefitResponse>;
+    update(benefitId: string, options?: Core.RequestOptions): Core.APIPromise<UpdateCompanyBenefitResponse>;
+    /**
+     * **Availability: Automated Benefits providers only**
+     *
+     * List all company-wide benefits.
+     */
+    list(options?: Core.RequestOptions): Core.PagePromise<CompanyBenefitsSinglePage, CompanyBenefit>;
+    /**
+     * **Availability: Automated and Assisted Benefits providers**
+     *
+     * Lists available types and configurations for the provider associated with the
+     * access token.
+     */
+    listSupportedBenefits(options?: Core.RequestOptions): Core.PagePromise<SupportedBenefitsSinglePage, SupportedBenefit>;
+}
+export declare class CompanyBenefitsSinglePage extends SinglePage<CompanyBenefit> {
 }
-export declare class CompanyBenefitsSinglePage extends SinglePage<CompanyBenefit> {}
 type _CompanyBenefitsSinglePage = CompanyBenefitsSinglePage;
-export declare class SupportedBenefitsSinglePage extends SinglePage<SupportedBenefit> {}
+export declare class SupportedBenefitsSinglePage extends SinglePage<SupportedBenefit> {
+}
 type _SupportedBenefitsSinglePage = SupportedBenefitsSinglePage;
 export type BenefitFrequency = 'one_time' | 'every_paycheck' | null;
 /**
  * Type of benefit.
  */
-export type BenefitType =
-  | '401k'
-  | '401k_roth'
-  | '401k_loan'
-  | '403b'
-  | '403b_roth'
-  | '457'
-  | '457_roth'
-  | 's125_medical'
-  | 's125_dental'
-  | 's125_vision'
-  | 'hsa_pre'
-  | 'hsa_post'
-  | 'fsa_medical'
-  | 'fsa_dependent_care'
-  | 'simple_ira'
-  | 'simple'
-  | 'commuter'
-  | 'custom_post_tax'
-  | 'custom_pre_tax'
-  | null;
+export type BenefitType = '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457' | '457_roth' | 's125_medical' | 's125_dental' | 's125_vision' | 'hsa_pre' | 'hsa_post' | 'fsa_medical' | 'fsa_dependent_care' | 'simple_ira' | 'simple' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | null;
 export interface BenfitContribution {
-  /**
-   * Contribution amount in cents (if `fixed`) or basis points (if `percent`).
-   */
-  amount?: number | null;
-  /**
-   * Contribution type.
-   */
-  type?: 'fixed' | 'percent' | null;
+    /**
+     * Contribution amount in cents (if `fixed`) or basis points (if `percent`).
+     */
+    amount?: number | null;
+    /**
+     * Contribution type.
+     */
+    type?: 'fixed' | 'percent' | null;
 }
 export interface CompanyBenefit {
-  benefit_id: string;
-  company_contribution: BenfitContribution | null;
-  description: string | null;
-  employee_deduction: BenfitContribution | null;
-  frequency: BenefitFrequency | null;
-  /**
-   * Type of benefit.
-   */
-  type: BenefitType | null;
+    benefit_id: string;
+    company_contribution: BenfitContribution | null;
+    description: string | null;
+    employee_deduction: BenfitContribution | null;
+    frequency: BenefitFrequency | null;
+    /**
+     * Type of benefit.
+     */
+    type: BenefitType | null;
 }
 export interface CreateCompanyBenefitsResponse {
-  benefit_id: string;
+    benefit_id: string;
 }
 export interface SupportedBenefit {
-  /**
-   * Whether the provider supports an annual maximum for this benefit.
-   */
-  annual_maximum?: boolean | null;
-  /**
-   * Whether the provider supports catch up for this benefit. This field will only be
-   * true for retirement benefits.
-   */
-  catch_up?: boolean | null;
-  /**
-   * Supported contribution types. An empty array indicates contributions are not
-   * supported.
-   */
-  company_contribution?: Array<'fixed' | 'percent'> | null;
-  description?: string | null;
-  /**
-   * Supported deduction types. An empty array indicates deductions are not
-   * supported.
-   */
-  employee_deduction?: Array<'fixed' | 'percent'> | null;
-  /**
-   * The list of frequencies supported by the provider for this benefit
-   */
-  frequencies?: Array<BenefitFrequency | null>;
-  /**
-   * Whether the provider supports HSA contribution limits. Empty if this feature is
-   * not supported for the benefit. This array only has values for HSA benefits.
-   */
-  hsa_contribution_limit?: Array<'individual' | 'family'> | null;
-  /**
-   * Type of benefit.
-   */
-  type?: BenefitType | null;
+    /**
+     * Whether the provider supports an annual maximum for this benefit.
+     */
+    annual_maximum?: boolean | null;
+    /**
+     * Whether the provider supports catch up for this benefit. This field will only be
+     * true for retirement benefits.
+     */
+    catch_up?: boolean | null;
+    /**
+     * Supported contribution types. An empty array indicates contributions are not
+     * supported.
+     */
+    company_contribution?: Array<'fixed' | 'percent'> | null;
+    description?: string | null;
+    /**
+     * Supported deduction types. An empty array indicates deductions are not
+     * supported.
+     */
+    employee_deduction?: Array<'fixed' | 'percent'> | null;
+    /**
+     * The list of frequencies supported by the provider for this benefit
+     */
+    frequencies?: Array<BenefitFrequency | null>;
+    /**
+     * Whether the provider supports HSA contribution limits. Empty if this feature is
+     * not supported for the benefit. This array only has values for HSA benefits.
+     */
+    hsa_contribution_limit?: Array<'individual' | 'family'> | null;
+    /**
+     * Type of benefit.
+     */
+    type?: BenefitType | null;
 }
 export interface UpdateCompanyBenefitResponse {
-  benefit_id: string;
+    benefit_id: string;
 }
 export interface BenefitCreateParams {
-  description?: string;
-  frequency?: BenefitFrequency | null;
-  /**
-   * Type of benefit.
-   */
-  type?: BenefitType | null;
+    description?: string;
+    frequency?: BenefitFrequency | null;
+    /**
+     * Type of benefit.
+     */
+    type?: BenefitType | null;
 }
 export interface BenefitUpdateParams {
-  /**
-   * Updated name or description.
-   */
-  description?: string;
+    /**
+     * Updated name or description.
+     */
+    description?: string;
 }
 export declare namespace Benefits {
-  export import BenefitFrequency = API.BenefitFrequency;
-  export import BenefitType = API.BenefitType;
-  export import BenfitContribution = API.BenfitContribution;
-  export import CompanyBenefit = API.CompanyBenefit;
-  export import CreateCompanyBenefitsResponse = API.CreateCompanyBenefitsResponse;
-  export import SupportedBenefit = API.SupportedBenefit;
-  export import UpdateCompanyBenefitResponse = API.UpdateCompanyBenefitResponse;
-  type CompanyBenefitsSinglePage = _CompanyBenefitsSinglePage;
-  type SupportedBenefitsSinglePage = _SupportedBenefitsSinglePage;
-  export import BenefitCreateParams = API.BenefitCreateParams;
-  export import BenefitUpdateParams = API.BenefitUpdateParams;
-  export import Individuals = API.Individuals;
-  export import EnrolledIndividual = API.EnrolledIndividual;
-  export import IndividualBenefit = API.IndividualBenefit;
-  export import UnenrolledIndividual = API.UnenrolledIndividual;
-  export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
-  export import EnrolledIndividualsSinglePage = API.EnrolledIndividualsSinglePage;
-  export import IndividualBenefitsSinglePage = API.IndividualBenefitsSinglePage;
-  export import UnenrolledIndividualsSinglePage = API.UnenrolledIndividualsSinglePage;
-  export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
-  export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
-  export import IndividualUnenrollManyParams = API.IndividualUnenrollManyParams;
+    export import BenefitFrequency = API.BenefitFrequency;
+    export import BenefitType = API.BenefitType;
+    export import BenfitContribution = API.BenfitContribution;
+    export import CompanyBenefit = API.CompanyBenefit;
+    export import CreateCompanyBenefitsResponse = API.CreateCompanyBenefitsResponse;
+    export import SupportedBenefit = API.SupportedBenefit;
+    export import UpdateCompanyBenefitResponse = API.UpdateCompanyBenefitResponse;
+    type CompanyBenefitsSinglePage = _CompanyBenefitsSinglePage;
+    type SupportedBenefitsSinglePage = _SupportedBenefitsSinglePage;
+    export import BenefitCreateParams = API.BenefitCreateParams;
+    export import BenefitUpdateParams = API.BenefitUpdateParams;
+    export import Individuals = API.Individuals;
+    export import EnrolledIndividual = API.EnrolledIndividual;
+    export import IndividualBenefit = API.IndividualBenefit;
+    export import UnenrolledIndividual = API.UnenrolledIndividual;
+    export import IndividualEnrolledIDsResponse = API.IndividualEnrolledIDsResponse;
+    export import EnrolledIndividualsSinglePage = API.EnrolledIndividualsSinglePage;
+    export import IndividualBenefitsSinglePage = API.IndividualBenefitsSinglePage;
+    export import UnenrolledIndividualsSinglePage = API.UnenrolledIndividualsSinglePage;
+    export import IndividualEnrollManyParams = API.IndividualEnrollManyParams;
+    export import IndividualRetrieveManyBenefitsParams = API.IndividualRetrieveManyBenefitsParams;
+    export import IndividualUnenrollManyParams = API.IndividualUnenrollManyParams;
 }
 export {};
-//# sourceMappingURL=benefits.d.ts.map
+//# sourceMappingURL=benefits.d.ts.map