@tryfinch/finch-api 5.1.0 → 5.3.0

package/resources/index.js

@@ -1,52 +1,14 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
-exports.Webhooks =
-  exports.Providers =
-  exports.ProvidersSinglePage =
-  exports.HRIS =
-  exports.Account =
-  exports.ATS =
-    void 0;
-var ats_1 = require('./ats/ats.js');
-Object.defineProperty(exports, 'ATS', {
-  enumerable: true,
-  get: function () {
-    return ats_1.ATS;
-  },
-});
-var account_1 = require('./account.js');
-Object.defineProperty(exports, 'Account', {
-  enumerable: true,
-  get: function () {
-    return account_1.Account;
-  },
-});
-var hris_1 = require('./hris/hris.js');
-Object.defineProperty(exports, 'HRIS', {
-  enumerable: true,
-  get: function () {
-    return hris_1.HRIS;
-  },
-});
-var providers_1 = require('./providers.js');
-Object.defineProperty(exports, 'ProvidersSinglePage', {
-  enumerable: true,
-  get: function () {
-    return providers_1.ProvidersSinglePage;
-  },
-});
-Object.defineProperty(exports, 'Providers', {
-  enumerable: true,
-  get: function () {
-    return providers_1.Providers;
-  },
-});
-var webhooks_1 = require('./webhooks.js');
-Object.defineProperty(exports, 'Webhooks', {
-  enumerable: true,
-  get: function () {
-    return webhooks_1.Webhooks;
-  },
-});
-//# sourceMappingURL=index.js.map
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Webhooks = exports.Providers = exports.ProvidersSinglePage = exports.HRIS = exports.Account = void 0;
+var account_1 = require("./account.js");
+Object.defineProperty(exports, "Account", { enumerable: true, get: function () { return account_1.Account; } });
+var hris_1 = require("./hris/hris.js");
+Object.defineProperty(exports, "HRIS", { enumerable: true, get: function () { return hris_1.HRIS; } });
+var providers_1 = require("./providers.js");
+Object.defineProperty(exports, "ProvidersSinglePage", { enumerable: true, get: function () { return providers_1.ProvidersSinglePage; } });
+Object.defineProperty(exports, "Providers", { enumerable: true, get: function () { return providers_1.Providers; } });
+var webhooks_1 = require("./webhooks.js");
+Object.defineProperty(exports, "Webhooks", { enumerable: true, get: function () { return webhooks_1.Webhooks; } });
+//# sourceMappingURL=index.js.map

package/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,oCAAgC;AAAvB,0FAAA,GAAG,OAAA;AACZ,wCAAuE;AAA3B,kGAAA,OAAO,OAAA;AACnD,uCAAoE;AAA1B,4FAAA,IAAI,OAAA;AAC9C,4CAAuE;AAApD,gHAAA,mBAAmB,OAAA;AAAE,sGAAA,SAAS,OAAA;AACjD,0CAAsC;AAA7B,oGAAA,QAAQ,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,wCAAuE;AAA3B,kGAAA,OAAO,OAAA;AACnD,uCAAoE;AAA1B,4FAAA,IAAI,OAAA;AAC9C,4CAAuE;AAApD,gHAAA,mBAAmB,OAAA;AAAE,sGAAA,SAAS,OAAA;AACjD,0CAAsC;AAA7B,oGAAA,QAAQ,OAAA"}

package/resources/index.mjs

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless.
-export { ATS } from './ats/ats.mjs';
-export { Account } from './account.mjs';
-export { HRIS } from './hris/hris.mjs';
-export { ProvidersSinglePage, Providers } from './providers.mjs';
-export { Webhooks } from './webhooks.mjs';
-//# sourceMappingURL=index.mjs.map
+export { Account } from "./account.mjs";
+export { HRIS } from "./hris/hris.mjs";
+export { ProvidersSinglePage, Providers } from "./providers.mjs";
+export { Webhooks } from "./webhooks.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,GAAG,EAAE;OACP,EAAqC,OAAO,EAAE;OAC9C,EAAmC,IAAI,EAAE;OACzC,EAAY,mBAAmB,EAAE,SAAS,EAAE;OAC5C,EAAE,QAAQ,EAAE"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAAqC,OAAO,EAAE;OAC9C,EAAmC,IAAI,EAAE;OACzC,EAAY,mBAAmB,EAAE,SAAS,EAAE;OAC5C,EAAE,QAAQ,EAAE"}

package/resources/providers.d.ts

@@ -1,53 +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";
 import { SinglePage } from '@tryfinch/finch-api/pagination';
 export declare class Providers extends APIResource {
-  /**
-   * Return details on all available payroll and HR systems.
-   */
-  list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage, Provider>;
+    /**
+     * Return details on all available payroll and HR systems.
+     */
+    list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage, Provider>;
+}
+export declare class ProvidersSinglePage extends SinglePage<Provider> {
 }
-export declare class ProvidersSinglePage extends SinglePage<Provider> {}
 type _ProvidersSinglePage = ProvidersSinglePage;
 export interface Provider {
-  /**
-   * The id of the payroll provider used in Connect.
-   */
-  id?: string;
-  /**
-   * The display name of the payroll provider.
-   */
-  display_name?: string;
-  /**
-   * The url to the official icon of the payroll provider.
-   */
-  icon?: 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>;
+    /**
+     * The id of the payroll provider used in Connect.
+     */
+    id?: string;
+    /**
+     * The display name of the payroll provider.
+     */
+    display_name?: string;
+    /**
+     * The url to the official icon of the payroll provider.
+     */
+    icon?: 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>;
 }
 export declare namespace Providers {
-  export import Provider = API.Provider;
-  type ProvidersSinglePage = _ProvidersSinglePage;
+    export import Provider = API.Provider;
+    type ProvidersSinglePage = _ProvidersSinglePage;
 }
 export {};
-//# sourceMappingURL=providers.d.ts.map
+//# sourceMappingURL=providers.d.ts.map

package/resources/providers.js

@@ -1,19 +1,21 @@
-'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.ProvidersSinglePage = exports.Providers = void 0;
-const resource_1 = require('@tryfinch/finch-api/resource');
-const pagination_1 = require('@tryfinch/finch-api/pagination');
+const resource_1 = require("@tryfinch/finch-api/resource");
+const pagination_1 = require("@tryfinch/finch-api/pagination");
 class Providers extends resource_1.APIResource {
-  /**
-   * Return details on all available payroll and HR systems.
-   */
-  list(options) {
-    return this.getAPIList('/providers', ProvidersSinglePage, options);
-  }
+    /**
+     * Return details on all available payroll and HR systems.
+     */
+    list(options) {
+        return this.getAPIList('/providers', ProvidersSinglePage, options);
+    }
 }
 exports.Providers = Providers;
-class ProvidersSinglePage extends pagination_1.SinglePage {}
+class ProvidersSinglePage extends pagination_1.SinglePage {
+}
 exports.ProvidersSinglePage = ProvidersSinglePage;
-(function (Providers) {})((Providers = exports.Providers || (exports.Providers = {})));
-//# sourceMappingURL=providers.js.map
+(function (Providers) {
+})(Providers = exports.Providers || (exports.Providers = {}));
+//# sourceMappingURL=providers.js.map

package/resources/providers.mjs

@@ -2,13 +2,15 @@
 import { APIResource } from '@tryfinch/finch-api/resource';
 import { SinglePage } from '@tryfinch/finch-api/pagination';
 export class Providers extends APIResource {
-  /**
-   * Return details on all available payroll and HR systems.
-   */
-  list(options) {
-    return this.getAPIList('/providers', ProvidersSinglePage, options);
-  }
+    /**
+     * Return details on all available payroll and HR systems.
+     */
+    list(options) {
+        return this.getAPIList('/providers', ProvidersSinglePage, options);
+    }
 }
-export class ProvidersSinglePage extends SinglePage {}
-(function (Providers) {})(Providers || (Providers = {}));
-//# sourceMappingURL=providers.mjs.map
+export class ProvidersSinglePage extends SinglePage {
+}
+(function (Providers) {
+})(Providers || (Providers = {}));
+//# sourceMappingURL=providers.mjs.map

package/resources/top-level.d.ts

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=top-level.d.ts.map
+//# sourceMappingURL=top-level.d.ts.map

package/resources/top-level.js

@@ -1,4 +1,4 @@
-'use strict';
+"use strict";
 // File generated from our OpenAPI spec by Stainless.
-Object.defineProperty(exports, '__esModule', { value: true });
-//# sourceMappingURL=top-level.js.map
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=top-level.js.map

package/resources/top-level.mjs

@@ -1,3 +1,3 @@
 // File generated from our OpenAPI spec by Stainless.
 export {};
-//# sourceMappingURL=top-level.mjs.map
+//# sourceMappingURL=top-level.mjs.map

package/resources/webhooks.d.ts

@@ -1,22 +1,22 @@
 import { APIResource } from '@tryfinch/finch-api/resource';
 import { HeadersLike } from '@tryfinch/finch-api/core';
 export declare class Webhooks extends APIResource {
-  /**
-   * Validates that the given payload was sent by Finch and parses the payload.
-   */
-  unwrap(payload: string, headers: HeadersLike, secret?: string | undefined | null): Object;
-  private parseSecret;
-  private signPayload;
-  /** Make an assertion, if not `true`, then throw. */
-  private assert;
-  /** Compare to array buffers or data views in a way that timing based attacks
-   * cannot gain information about the platform. */
-  private timingSafeEqual;
-  /**
-   * Validates whether or not the webhook payload was sent by Finch.
-   *
-   * An error will be raised if the webhook payload was not sent by Finch.
-   */
-  verifySignature(body: string, headers: HeadersLike, secret?: string | undefined | null): void;
+    /**
+     * Validates that the given payload was sent by Finch and parses the payload.
+     */
+    unwrap(payload: string, headers: HeadersLike, secret?: string | undefined | null): Object;
+    private parseSecret;
+    private signPayload;
+    /** Make an assertion, if not `true`, then throw. */
+    private assert;
+    /** Compare to array buffers or data views in a way that timing based attacks
+     * cannot gain information about the platform. */
+    private timingSafeEqual;
+    /**
+     * Validates whether or not the webhook payload was sent by Finch.
+     *
+     * An error will be raised if the webhook payload was not sent by Finch.
+     */
+    verifySignature(body: string, headers: HeadersLike, secret?: string | undefined | null): void;
 }
-//# sourceMappingURL=webhooks.d.ts.map
+//# sourceMappingURL=webhooks.d.ts.map

package/resources/webhooks.js

@@ -1,118 +1,114 @@
-'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.Webhooks = void 0;
-const resource_1 = require('@tryfinch/finch-api/resource');
-const crypto_1 = require('crypto');
-const core_1 = require('@tryfinch/finch-api/core');
+const resource_1 = require("@tryfinch/finch-api/resource");
+const crypto_1 = require("crypto");
+const core_1 = require("@tryfinch/finch-api/core");
 class Webhooks extends resource_1.APIResource {
-  /**
-   * Validates that the given payload was sent by Finch and parses the payload.
-   */
-  unwrap(payload, headers, secret = this.client.webhookSecret) {
-    this.verifySignature(payload, headers, secret);
-    return JSON.parse(payload);
-  }
-  parseSecret(secret) {
-    if (!secret) {
-      throw new Error(
-        "The webhook secret must either be set using the env var, FINCH_WEBHOOK_SECRET, on the client class, Finch({ webhook_secret: '123' }), or passed to this function",
-      );
+    /**
+     * Validates that the given payload was sent by Finch and parses the payload.
+     */
+    unwrap(payload, headers, secret = this.client.webhookSecret) {
+        this.verifySignature(payload, headers, secret);
+        return JSON.parse(payload);
     }
-    const buf = Buffer.from(secret, 'base64');
-    if (buf.toString('base64') !== secret) {
-      throw new Error(`Given secret is not valid`);
+    parseSecret(secret) {
+        if (!secret) {
+            throw new Error("The webhook secret must either be set using the env var, FINCH_WEBHOOK_SECRET, on the client class, Finch({ webhook_secret: '123' }), or passed to this function");
+        }
+        const buf = Buffer.from(secret, 'base64');
+        if (buf.toString('base64') !== secret) {
+            throw new Error(`Given secret is not valid`);
+        }
+        return new Uint8Array(buf);
     }
-    return new Uint8Array(buf);
-  }
-  signPayload(payload, { eventId, timestamp, secret }) {
-    const encoder = new TextEncoder();
-    const toSign = encoder.encode(`${eventId}.${timestamp.getTime() / 1000}.${payload}`);
-    const hmac = (0, crypto_1.createHmac)('sha256', secret);
-    hmac.update(toSign);
-    return `v1,${hmac.digest('base64')}`;
-  }
-  /** Make an assertion, if not `true`, then throw. */
-  assert(expr, msg = '') {
-    if (!expr) {
-      throw new Error(msg);
+    signPayload(payload, { eventId, timestamp, secret }) {
+        const encoder = new TextEncoder();
+        const toSign = encoder.encode(`${eventId}.${timestamp.getTime() / 1000}.${payload}`);
+        const hmac = (0, crypto_1.createHmac)('sha256', secret);
+        hmac.update(toSign);
+        return `v1,${hmac.digest('base64')}`;
     }
-  }
-  /** Compare to array buffers or data views in a way that timing based attacks
-   * cannot gain information about the platform. */
-  timingSafeEqual(a, b) {
-    if (a.byteLength !== b.byteLength) {
-      return false;
+    /** Make an assertion, if not `true`, then throw. */
+    assert(expr, msg = '') {
+        if (!expr) {
+            throw new Error(msg);
+        }
     }
-    if (!(a instanceof DataView)) {
-      a = new DataView(ArrayBuffer.isView(a) ? a.buffer : a);
+    /** Compare to array buffers or data views in a way that timing based attacks
+     * cannot gain information about the platform. */
+    timingSafeEqual(a, b) {
+        if (a.byteLength !== b.byteLength) {
+            return false;
+        }
+        if (!(a instanceof DataView)) {
+            a = new DataView(ArrayBuffer.isView(a) ? a.buffer : a);
+        }
+        if (!(b instanceof DataView)) {
+            b = new DataView(ArrayBuffer.isView(b) ? b.buffer : b);
+        }
+        this.assert(a instanceof DataView);
+        this.assert(b instanceof DataView);
+        const length = a.byteLength;
+        let out = 0;
+        let i = -1;
+        while (++i < length) {
+            out |= a.getUint8(i) ^ b.getUint8(i);
+        }
+        return out === 0;
     }
-    if (!(b instanceof DataView)) {
-      b = new DataView(ArrayBuffer.isView(b) ? b.buffer : b);
+    /**
+     * Validates whether or not the webhook payload was sent by Finch.
+     *
+     * An error will be raised if the webhook payload was not sent by Finch.
+     */
+    verifySignature(body, headers, secret = this.client.webhookSecret) {
+        const parsedSecret = this.parseSecret(secret);
+        const eventId = (0, core_1.getHeader)(headers, 'finch-event-id');
+        if (!eventId) {
+            throw new Error('Could not find finch-event-id header');
+        }
+        const msgTimestamp = (0, core_1.getHeader)(headers, 'finch-timestamp');
+        if (!msgTimestamp) {
+            throw new Error('Could not find finch-timestamp header');
+        }
+        const msgSignature = (0, core_1.getHeader)(headers, 'finch-signature');
+        if (!msgSignature) {
+            throw new Error('Could not find finch-signature header');
+        }
+        const now = Math.floor(Date.now() / 1000);
+        const timestampSeconds = parseInt(msgTimestamp, 10);
+        if (isNaN(timestampSeconds)) {
+            throw new Error(`Invalid timestamp header: ${msgTimestamp}`);
+        }
+        if (typeof body !== 'string') {
+            throw new Error('Webhook body must be passed as the raw JSON string sent from the server (do not parse it first).');
+        }
+        const webhook_tolerance_in_seconds = 5 * 60; // 5 minutes
+        if (now - timestampSeconds > webhook_tolerance_in_seconds) {
+            throw new Error('Webhook timestamp is too old');
+        }
+        if (timestampSeconds > now + webhook_tolerance_in_seconds) {
+            throw new Error('Webhook timestamp is too new');
+        }
+        const timestamp = new Date(timestampSeconds * 1000);
+        const computedSignature = this.signPayload(body, { eventId, timestamp, secret: parsedSecret });
+        const expectedSignature = computedSignature.split(',')[1];
+        const passedSignatures = msgSignature.split(' ');
+        const encoder = new globalThis.TextEncoder();
+        for (const versionedSignature of passedSignatures) {
+            const [version, signature] = versionedSignature.split(',');
+            if (version !== 'v1') {
+                continue;
+            }
+            if (this.timingSafeEqual(encoder.encode(signature), encoder.encode(expectedSignature))) {
+                // valid!
+                return;
+            }
+        }
+        throw new Error('None of the given webhook signatures match the expected signature');
     }
-    this.assert(a instanceof DataView);
-    this.assert(b instanceof DataView);
-    const length = a.byteLength;
-    let out = 0;
-    let i = -1;
-    while (++i < length) {
-      out |= a.getUint8(i) ^ b.getUint8(i);
-    }
-    return out === 0;
-  }
-  /**
-   * Validates whether or not the webhook payload was sent by Finch.
-   *
-   * An error will be raised if the webhook payload was not sent by Finch.
-   */
-  verifySignature(body, headers, secret = this.client.webhookSecret) {
-    const parsedSecret = this.parseSecret(secret);
-    const eventId = (0, core_1.getHeader)(headers, 'finch-event-id');
-    if (!eventId) {
-      throw new Error('Could not find finch-event-id header');
-    }
-    const msgTimestamp = (0, core_1.getHeader)(headers, 'finch-timestamp');
-    if (!msgTimestamp) {
-      throw new Error('Could not find finch-timestamp header');
-    }
-    const msgSignature = (0, core_1.getHeader)(headers, 'finch-signature');
-    if (!msgSignature) {
-      throw new Error('Could not find finch-signature header');
-    }
-    const now = Math.floor(Date.now() / 1000);
-    const timestampSeconds = parseInt(msgTimestamp, 10);
-    if (isNaN(timestampSeconds)) {
-      throw new Error(`Invalid timestamp header: ${msgTimestamp}`);
-    }
-    if (typeof body !== 'string') {
-      throw new Error(
-        'Webhook body must be passed as the raw JSON string sent from the server (do not parse it first).',
-      );
-    }
-    const webhook_tolerance_in_seconds = 5 * 60; // 5 minutes
-    if (now - timestampSeconds > webhook_tolerance_in_seconds) {
-      throw new Error('Webhook timestamp is too old');
-    }
-    if (timestampSeconds > now + webhook_tolerance_in_seconds) {
-      throw new Error('Webhook timestamp is too new');
-    }
-    const timestamp = new Date(timestampSeconds * 1000);
-    const computedSignature = this.signPayload(body, { eventId, timestamp, secret: parsedSecret });
-    const expectedSignature = computedSignature.split(',')[1];
-    const passedSignatures = msgSignature.split(' ');
-    const encoder = new globalThis.TextEncoder();
-    for (const versionedSignature of passedSignatures) {
-      const [version, signature] = versionedSignature.split(',');
-      if (version !== 'v1') {
-        continue;
-      }
-      if (this.timingSafeEqual(encoder.encode(signature), encoder.encode(expectedSignature))) {
-        // valid!
-        return;
-      }
-    }
-    throw new Error('None of the given webhook signatures match the expected signature');
-  }
 }
 exports.Webhooks = Webhooks;
-//# sourceMappingURL=webhooks.js.map
+//# sourceMappingURL=webhooks.js.map