@tryfinch/finch-api 6.15.0 → 6.15.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 6.15.1 (2025-01-21)
+
+Full Changelog: [v6.15.0...v6.15.1](https://github.com/Finch-API/finch-api-node/compare/v6.15.0...v6.15.1)
+
+### Chores
+
+* **internal:** add test ([#535](https://github.com/Finch-API/finch-api-node/issues/535)) ([dbff05c](https://github.com/Finch-API/finch-api-node/commit/dbff05c0f375a75906a8ee472de6579fab40db24))
+* **types:** add `| undefined` to client options properties ([#533](https://github.com/Finch-API/finch-api-node/issues/533)) ([4ceb638](https://github.com/Finch-API/finch-api-node/commit/4ceb638bbae80e7d91bc67d3262772c5db4ab7ad))
+
+
+### Documentation
+
+* update deprecation messages ([#536](https://github.com/Finch-API/finch-api-node/issues/536)) ([6fd8f63](https://github.com/Finch-API/finch-api-node/commit/6fd8f63479a70f2d36d28d29abca22f1e87615d0))
+
 ## 6.15.0 (2025-01-09)
 
 Full Changelog: [v6.14.0...v6.15.0](https://github.com/Finch-API/finch-api-node/compare/v6.14.0...v6.15.0)

package/index.d.mts

@@ -42,14 +42,14 @@ export interface ClientOptions {
      * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
      * much longer than this timeout before the promise succeeds or fails.
      */
-    timeout?: number;
+    timeout?: number | undefined;
     /**
      * An HTTP agent used to manage HTTP(S) connections.
      *
      * If not provided, an agent will be constructed by default in the Node.js environment,
      * otherwise no agent is used.
      */
-    httpAgent?: Agent;
+    httpAgent?: Agent | undefined;
     /**
      * Specify a custom `fetch` function implementation.
      *
@@ -63,26 +63,26 @@ export interface ClientOptions {
      *
      * @default 2
      */
-    maxRetries?: number;
+    maxRetries?: number | undefined;
     /**
      * Default headers to include with every request to the API.
      *
      * These can be removed in individual requests by explicitly setting the
      * header to `undefined` or `null` in request options.
      */
-    defaultHeaders?: Core.Headers;
+    defaultHeaders?: Core.Headers | undefined;
     /**
      * Default query parameters to include with every request to the API.
      *
      * These can be removed in individual requests by explicitly setting the
      * param to `undefined` in request options.
      */
-    defaultQuery?: Core.DefaultQuery;
+    defaultQuery?: Core.DefaultQuery | undefined;
     /**
      * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
      * Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
      */
-    dangerouslyAllowBrowser?: boolean;
+    dangerouslyAllowBrowser?: boolean | undefined;
 }
 /**
  * API Client for interfacing with the Finch API.

package/index.d.ts

@@ -42,14 +42,14 @@ export interface ClientOptions {
      * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
      * much longer than this timeout before the promise succeeds or fails.
      */
-    timeout?: number;
+    timeout?: number | undefined;
     /**
      * An HTTP agent used to manage HTTP(S) connections.
      *
      * If not provided, an agent will be constructed by default in the Node.js environment,
      * otherwise no agent is used.
      */
-    httpAgent?: Agent;
+    httpAgent?: Agent | undefined;
     /**
      * Specify a custom `fetch` function implementation.
      *
@@ -63,26 +63,26 @@ export interface ClientOptions {
      *
      * @default 2
      */
-    maxRetries?: number;
+    maxRetries?: number | undefined;
     /**
      * Default headers to include with every request to the API.
      *
      * These can be removed in individual requests by explicitly setting the
      * header to `undefined` or `null` in request options.
      */
-    defaultHeaders?: Core.Headers;
+    defaultHeaders?: Core.Headers | undefined;
     /**
      * Default query parameters to include with every request to the API.
      *
      * These can be removed in individual requests by explicitly setting the
      * param to `undefined` in request options.
      */
-    defaultQuery?: Core.DefaultQuery;
+    defaultQuery?: Core.DefaultQuery | undefined;
     /**
      * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
      * Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
      */
-    dangerouslyAllowBrowser?: boolean;
+    dangerouslyAllowBrowser?: boolean | undefined;
 }
 /**
  * API Client for interfacing with the Finch API.

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EACL,KAAK,qBAAqB,EAC1B,uBAAuB,EACvB,KAAK,UAAU,EACf,YAAY,EACZ,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,YAAY,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC7G,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,EACL,iBAAiB,EACjB,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,QAAQ,EACT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAE1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC;IAElB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC;IAEjC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,IAAI,CAAC,SAAS;IACvC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;;;;OAeG;gBACS,EACV,OAAwC,EACxC,WAAkB,EAClB,QAAkD,EAClD,YAA0D,EAC1D,aAA4D,EAC5D,GAAG,IAAI,EACR,GAAE,aAAkB;IAgCrB,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,SAAS,EAAE,GAAG,CAAC,SAAS,CAA2B;IACnD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,CAAmC;IAC3E,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAE7C;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBhF;;;;OAIG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,WAAW,EACX,OAAO,GACR,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,GAAG,MAAM;IAcV;;;OAGG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK;cAIxB,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAQ5D,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO;cAoBlE,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAc5E,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAOlE,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAc9C,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,MAAM,CAAC,KAAK,eAAQ;IACpB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,UAAU,2BAAqB;IACtC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AAaD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;IAEzD,MAAM,QAAQ,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;IACvD,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;IAE/D,MAAM,QAAQ,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC;IAC3D,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,MAAM,QAAQ,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IACrC,OAAO,EAAE,KAAK,UAAU,IAAI,UAAU,EAAE,KAAK,YAAY,IAAI,YAAY,EAAE,CAAC;IAE5E,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,CAAC;IAE/F,OAAO,EAAE,SAAS,IAAI,SAAS,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAEzG,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;IAEF,OAAO,EACL,iBAAiB,IAAI,iBAAiB,EACtC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;IAExB,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,MAAM,MAAM,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC5D,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACpD,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC,sBAAsB,CAAC;IAChE,MAAM,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;CACjC;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,KAAK,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,EACL,KAAK,qBAAqB,EAC1B,uBAAuB,EACvB,KAAK,UAAU,EACf,YAAY,EACZ,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,uBAAuB,EAAE,YAAY,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAC7G,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,EACL,iBAAiB,EACjB,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,QAAQ,EACT,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAE1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;IAE7C;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/C;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,IAAI,CAAC,SAAS;IACvC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;;;;OAeG;gBACS,EACV,OAAwC,EACxC,WAAkB,EAClB,QAAkD,EAClD,YAA0D,EAC1D,aAA4D,EAC5D,GAAG,IAAI,EACR,GAAE,aAAkB;IAgCrB,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,SAAS,EAAE,GAAG,CAAC,SAAS,CAA2B;IACnD,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,CAAmC;IAC3E,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAE7C;;OAEG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAoBhF;;;;OAIG;IACH,UAAU,CAAC,EACT,QAAQ,EACR,WAAW,EACX,OAAO,GACR,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,GAAG,MAAM;IAcV;;;OAGG;IACH,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK;cAIxB,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAQ5D,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO;cAoBlE,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAc5E,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;IAOlE,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAc9C,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,MAAM,CAAC,KAAK,eAAQ;IACpB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,UAAU,2BAAqB;IACtC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AAaD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;IACjD,OAAO,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;IAEzD,MAAM,QAAQ,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;IACvD,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;IAE/D,MAAM,QAAQ,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC;IAC3D,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,MAAM,QAAQ,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;IACrC,OAAO,EAAE,KAAK,UAAU,IAAI,UAAU,EAAE,KAAK,YAAY,IAAI,YAAY,EAAE,CAAC;IAE5E,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,CAAC;IAE/F,OAAO,EAAE,SAAS,IAAI,SAAS,EAAE,KAAK,QAAQ,IAAI,QAAQ,EAAE,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;IAEzG,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;IAEF,OAAO,EACL,iBAAiB,IAAI,iBAAiB,EACtC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;IAExB,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,CAAC;IAE9B,MAAM,MAAM,oBAAoB,GAAG,GAAG,CAAC,oBAAoB,CAAC;IAC5D,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC;IACpD,MAAM,MAAM,sBAAsB,GAAG,GAAG,CAAC,sBAAsB,CAAC;IAChE,MAAM,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;CACjC;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,KAAK,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryfinch/finch-api",
-  "version": "6.15.0",
+  "version": "6.15.1",
   "description": "The official TypeScript library for the Finch API",
   "author": "Finch <founders@tryfinch.com>",
   "types": "./index.d.ts",

package/resources/access-tokens.d.ts

@@ -12,7 +12,7 @@ export interface CreateAccessTokenResponse {
      */
     access_token: string;
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to identify the connection instead
+     * @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
      * of this account ID.
      */
     account_id: string;
@@ -21,7 +21,7 @@ export interface CreateAccessTokenResponse {
      */
     client_type: 'production' | 'development' | 'sandbox';
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to identify the connection instead
+     * @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
      * of this company ID.
      */
     company_id: string;

package/resources/account.d.ts

@@ -19,7 +19,7 @@ export interface DisconnectResponse {
 }
 export interface Introspection {
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to associate tokens with a Finch
+     * @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
      * connection instead of this account ID.
      */
     account_id: string;
@@ -33,7 +33,7 @@ export interface Introspection {
      */
     client_type: 'production' | 'development' | 'sandbox';
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to associate tokens with a Finch
+     * @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
      * connection instead of this company ID.
      */
     company_id: string;
@@ -71,7 +71,7 @@ export interface Introspection {
      */
     manual: boolean;
     /**
-     * @deprecated: [DEPRECATED] Use `provider_id` to identify the provider instead of
+     * @deprecated [DEPRECATED] Use `provider_id` to identify the provider instead of
      * this payroll provider ID.
      */
     payroll_provider_id: string;

package/resources/hris/employments.d.ts

@@ -79,7 +79,7 @@ export interface EmploymentData {
      */
     title?: string | null;
     /**
-     * @deprecated: This field is deprecated in favour of `source_id`
+     * @deprecated This field is deprecated in favour of `source_id`
      */
     work_id?: string | null;
 }

package/resources/sandbox/connections/accounts.d.ts

@@ -16,13 +16,13 @@ export declare class Accounts extends APIResource {
 export interface AccountCreateResponse {
     access_token: string;
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+     * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
      * access token
      */
     account_id: string;
     authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+     * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
      * access token
      */
     company_id: string;
@@ -38,13 +38,13 @@ export interface AccountCreateResponse {
 }
 export interface AccountUpdateResponse {
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+     * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
      * access token
      */
     account_id: string;
     authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+     * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
      * access token
      */
     company_id: string;

package/resources/sandbox/connections/connections.d.ts

@@ -12,13 +12,13 @@ export declare class Connections extends APIResource {
 export interface ConnectionCreateResponse {
     access_token: string;
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+     * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
      * access token
      */
     account_id: string;
     authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';
     /**
-     * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+     * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
      * access token
      */
     company_id: string;

package/resources/webhooks.d.ts

@@ -283,13 +283,13 @@ export declare namespace AccountUpdateEvent {
 }
 export interface BaseWebhookEvent {
     /**
-     * @deprecated: [DEPRECATED] Unique Finch ID of the employer account used to make
+     * @deprecated [DEPRECATED] Unique Finch ID of the employer account used to make
      * this connection. Use `connection_id` instead to identify the connection
      * associated with this event.
      */
     account_id: string;
     /**
-     * @deprecated: [DEPRECATED] Unique Finch ID of the company for which data has been
+     * @deprecated [DEPRECATED] Unique Finch ID of the company for which data has been
      * updated. Use `connection_id` instead to identify the connection associated with
      * this event.
      */

package/src/index.ts

@@ -74,7 +74,7 @@ export interface ClientOptions {
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
    */
-  timeout?: number;
+  timeout?: number | undefined;
 
   /**
    * An HTTP agent used to manage HTTP(S) connections.
@@ -82,7 +82,7 @@ export interface ClientOptions {
    * If not provided, an agent will be constructed by default in the Node.js environment,
    * otherwise no agent is used.
    */
-  httpAgent?: Agent;
+  httpAgent?: Agent | undefined;
 
   /**
    * Specify a custom `fetch` function implementation.
@@ -98,7 +98,7 @@ export interface ClientOptions {
    *
    * @default 2
    */
-  maxRetries?: number;
+  maxRetries?: number | undefined;
 
   /**
    * Default headers to include with every request to the API.
@@ -106,7 +106,7 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * header to `undefined` or `null` in request options.
    */
-  defaultHeaders?: Core.Headers;
+  defaultHeaders?: Core.Headers | undefined;
 
   /**
    * Default query parameters to include with every request to the API.
@@ -114,13 +114,13 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * param to `undefined` in request options.
    */
-  defaultQuery?: Core.DefaultQuery;
+  defaultQuery?: Core.DefaultQuery | undefined;
 
   /**
    * By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers.
    * Only set this option to `true` if you understand the risks and have appropriate mitigations in place.
    */
-  dangerouslyAllowBrowser?: boolean;
+  dangerouslyAllowBrowser?: boolean | undefined;
 }
 
 /**

package/src/resources/access-tokens.ts

@@ -45,7 +45,7 @@ export interface CreateAccessTokenResponse {
   access_token: string;
 
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to identify the connection instead
+   * @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
    * of this account ID.
    */
   account_id: string;
@@ -56,7 +56,7 @@ export interface CreateAccessTokenResponse {
   client_type: 'production' | 'development' | 'sandbox';
 
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to identify the connection instead
+   * @deprecated [DEPRECATED] Use `connection_id` to identify the connection instead
    * of this company ID.
    */
   company_id: string;

package/src/resources/account.ts

@@ -29,7 +29,7 @@ export interface DisconnectResponse {
 
 export interface Introspection {
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to associate tokens with a Finch
+   * @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
    * connection instead of this account ID.
    */
   account_id: string;
@@ -47,7 +47,7 @@ export interface Introspection {
   client_type: 'production' | 'development' | 'sandbox';
 
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to associate tokens with a Finch
+   * @deprecated [DEPRECATED] Use `connection_id` to associate tokens with a Finch
    * connection instead of this company ID.
    */
   company_id: string;
@@ -93,7 +93,7 @@ export interface Introspection {
   manual: boolean;
 
   /**
-   * @deprecated: [DEPRECATED] Use `provider_id` to identify the provider instead of
+   * @deprecated [DEPRECATED] Use `provider_id` to identify the provider instead of
    * this payroll provider ID.
    */
   payroll_provider_id: string;

package/src/resources/hris/employments.ts

@@ -119,7 +119,7 @@ export interface EmploymentData {
   title?: string | null;
 
   /**
-   * @deprecated: This field is deprecated in favour of `source_id`
+   * @deprecated This field is deprecated in favour of `source_id`
    */
   work_id?: string | null;
 }

package/src/resources/sandbox/connections/accounts.ts

@@ -34,7 +34,7 @@ export interface AccountCreateResponse {
   access_token: string;
 
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+   * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
    * access token
    */
   account_id: string;
@@ -42,7 +42,7 @@ export interface AccountCreateResponse {
   authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';
 
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+   * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
    * access token
    */
   company_id: string;
@@ -62,7 +62,7 @@ export interface AccountCreateResponse {
 
 export interface AccountUpdateResponse {
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+   * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
    * access token
    */
   account_id: string;
@@ -70,7 +70,7 @@ export interface AccountUpdateResponse {
   authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';
 
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+   * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
    * access token
    */
   company_id: string;

package/src/resources/sandbox/connections/connections.ts

@@ -29,7 +29,7 @@ export interface ConnectionCreateResponse {
   access_token: string;
 
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+   * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
    * access token
    */
   account_id: string;
@@ -37,7 +37,7 @@ export interface ConnectionCreateResponse {
   authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted';
 
   /**
-   * @deprecated: [DEPRECATED] Use `connection_id` to associate a connection with an
+   * @deprecated [DEPRECATED] Use `connection_id` to associate a connection with an
    * access token
    */
   company_id: string;

package/src/resources/webhooks.ts

@@ -557,14 +557,14 @@ export namespace AccountUpdateEvent {
 
 export interface BaseWebhookEvent {
   /**
-   * @deprecated: [DEPRECATED] Unique Finch ID of the employer account used to make
+   * @deprecated [DEPRECATED] Unique Finch ID of the employer account used to make
    * this connection. Use `connection_id` instead to identify the connection
    * associated with this event.
    */
   account_id: string;
 
   /**
-   * @deprecated: [DEPRECATED] Unique Finch ID of the company for which data has been
+   * @deprecated [DEPRECATED] Unique Finch ID of the company for which data has been
    * updated. Use `connection_id` instead to identify the connection associated with
    * this event.
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '6.15.0'; // x-release-please-version
+export const VERSION = '6.15.1'; // x-release-please-version

package/version.d.ts

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

package/version.mjs

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