@tryfinch/finch-api 5.20.2 → 5.20.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.20.3 (2024-04-04)
4
+
5
+ Full Changelog: [v5.20.2...v5.20.3](https://github.com/Finch-API/finch-api-node/compare/v5.20.2...v5.20.3)
6
+
7
+ ### Chores
8
+
9
+ * **api:** improve descriptions ([#335](https://github.com/Finch-API/finch-api-node/issues/335)) ([4423c16](https://github.com/Finch-API/finch-api-node/commit/4423c1655414ba9efe63dba4d244c2c56e7acb7e))
10
+
3
11
  ## 5.20.2 (2024-04-02)
4
12
 
5
13
  Full Changelog: [v5.20.1...v5.20.2](https://github.com/Finch-API/finch-api-node/compare/v5.20.1...v5.20.2)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tryfinch/finch-api",
3
- "version": "5.20.2",
3
+ "version": "5.20.3",
4
4
  "description": "The official TypeScript library for the Finch API",
5
5
  "author": "Finch <founders@tryfinch.com>",
6
6
  "types": "./index.d.ts",
@@ -39,9 +39,8 @@ export interface Introspection {
39
39
  /**
40
40
  * The type of the connection associated with the token.
41
41
  *
42
- * `provider` - connection to an external provider
43
- *
44
- * `finch` - finch-generated data.
42
+ * - `provider` - connection to an external provider
43
+ * - `finch` - finch-generated data.
45
44
  */
46
45
  connection_type: 'provider' | 'finch';
47
46
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,uCAAuC,CAAC;AACpE,OAAO,KAAK,MAAM,MAAM,sCAAsC,CAAC;AAE/D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAI9E;;OAEG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;CAG1E;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,sBAAsB,EAAE,aAAa,CAAC,qBAAqB,CAAC;IAE5D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,aAAa,GAAG,SAAS,CAAC;IAEtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,eAAe,EAAE,UAAU,GAAG,OAAO,CAAC;IAEtC;;;;OAIG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,qBAAqB;QACpC,iBAAiB,CAAC,EAAE,qBAAqB,CAAC,gBAAgB,CAAC;QAE3D,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,qBAAqB,CAAC;QACrC,UAAiB,gBAAgB;YAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,MAAM,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC;SACtC;KACF;CACF;AAED,yBAAiB,OAAO,CAAC;IACvB,MAAM,QAAQ,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IACjE,MAAM,QAAQ,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;CACxD"}
1
+ {"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,uCAAuC,CAAC;AACpE,OAAO,KAAK,MAAM,MAAM,sCAAsC,CAAC;AAE/D,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAI9E;;OAEG;IACH,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;CAG1E;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,sBAAsB,EAAE,aAAa,CAAC,qBAAqB,CAAC;IAE5D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,aAAa,GAAG,SAAS,CAAC;IAEtD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,eAAe,EAAE,UAAU,GAAG,OAAO,CAAC;IAEtC;;;;OAIG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,qBAAqB;QACpC,iBAAiB,CAAC,EAAE,qBAAqB,CAAC,gBAAgB,CAAC;QAE3D,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,qBAAqB,CAAC;QACrC,UAAiB,gBAAgB;YAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB,MAAM,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC;SACtC;KACF;CACF;AAED,yBAAiB,OAAO,CAAC;IACvB,MAAM,QAAQ,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IACjE,MAAM,QAAQ,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;CACxD"}
@@ -1 +1 @@
1
- {"version":3,"file":"account.js","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,2DAA2D;AAI3D,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,UAAU,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;CACF;AAdD,0BAcC;AAgFD,WAAiB,OAAO;AAGxB,CAAC,EAHgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAGvB"}
1
+ {"version":3,"file":"account.js","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,2DAA2D;AAI3D,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,UAAU,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;CACF;AAdD,0BAcC;AA+ED,WAAiB,OAAO;AAGxB,CAAC,EAHgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAGvB"}
@@ -1 +1 @@
1
- {"version":3,"file":"account.mjs","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,8BAA8B;AAI1D,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,UAAU,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;CACF;AAgFD,WAAiB,OAAO;AAGxB,CAAC,EAHgB,OAAO,KAAP,OAAO,QAGvB"}
1
+ {"version":3,"file":"account.mjs","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,8BAA8B;AAI1D,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,UAAU,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAA6B;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;CACF;AA+ED,WAAiB,OAAO;AAGxB,CAAC,EAHgB,OAAO,KAAP,OAAO,QAGvB"}
@@ -1,13 +1,10 @@
1
1
  export type ConnectionStatusType = 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth';
2
2
  /**
3
3
  * - `supported`: This operation is supported by both the provider and Finch
4
- *
5
4
  * - `not_supported_by_finch`: This operation is not supported by Finch but
6
5
  * supported by the provider
7
- *
8
6
  * - `not_supported_by_provider`: This operation is not supported by the provider,
9
7
  * so Finch cannot support
10
- *
11
8
  * - `client_access_only`: This behavior is supported by the provider, but only
12
9
  * available to the client and not to Finch
13
10
  */
@@ -15,52 +12,40 @@ export type OperationSupport = 'supported' | 'not_supported_by_finch' | 'not_sup
15
12
  export interface OperationSupportMatrix {
16
13
  /**
17
14
  * - `supported`: This operation is supported by both the provider and Finch
18
- *
19
15
  * - `not_supported_by_finch`: This operation is not supported by Finch but
20
16
  * supported by the provider
21
- *
22
17
  * - `not_supported_by_provider`: This operation is not supported by the provider,
23
18
  * so Finch cannot support
24
- *
25
19
  * - `client_access_only`: This behavior is supported by the provider, but only
26
20
  * available to the client and not to Finch
27
21
  */
28
22
  create?: OperationSupport;
29
23
  /**
30
24
  * - `supported`: This operation is supported by both the provider and Finch
31
- *
32
25
  * - `not_supported_by_finch`: This operation is not supported by Finch but
33
26
  * supported by the provider
34
- *
35
27
  * - `not_supported_by_provider`: This operation is not supported by the provider,
36
28
  * so Finch cannot support
37
- *
38
29
  * - `client_access_only`: This behavior is supported by the provider, but only
39
30
  * available to the client and not to Finch
40
31
  */
41
32
  delete?: OperationSupport;
42
33
  /**
43
34
  * - `supported`: This operation is supported by both the provider and Finch
44
- *
45
35
  * - `not_supported_by_finch`: This operation is not supported by Finch but
46
36
  * supported by the provider
47
- *
48
37
  * - `not_supported_by_provider`: This operation is not supported by the provider,
49
38
  * so Finch cannot support
50
- *
51
39
  * - `client_access_only`: This behavior is supported by the provider, but only
52
40
  * available to the client and not to Finch
53
41
  */
54
42
  read?: OperationSupport;
55
43
  /**
56
44
  * - `supported`: This operation is supported by both the provider and Finch
57
- *
58
45
  * - `not_supported_by_finch`: This operation is not supported by Finch but
59
46
  * supported by the provider
60
- *
61
47
  * - `not_supported_by_provider`: This operation is not supported by the provider,
62
48
  * so Finch cannot support
63
- *
64
49
  * - `client_access_only`: This behavior is supported by the provider, but only
65
50
  * available to the client and not to Finch
66
51
  */
@@ -1 +1 @@
1
- {"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GACT,YAAY,GACZ,WAAW,GACX,wBAAwB,GACxB,mBAAmB,GACnB,QAAQ,CAAC;AAEb;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,wBAAwB,GACxB,2BAA2B,GAC3B,oBAAoB,CAAC;AAEzB,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
1
+ {"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/resources/shared.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GACT,YAAY,GACZ,WAAW,GACX,wBAAwB,GACxB,mBAAmB,GACnB,QAAQ,CAAC;AAEb;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GACxB,WAAW,GACX,wBAAwB,GACxB,2BAA2B,GAC3B,oBAAoB,CAAC;AAEzB,MAAM,WAAW,sBAAsB;IACrC;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
@@ -54,9 +54,8 @@ export interface Introspection {
54
54
  /**
55
55
  * The type of the connection associated with the token.
56
56
  *
57
- * `provider` - connection to an external provider
58
- *
59
- * `finch` - finch-generated data.
57
+ * - `provider` - connection to an external provider
58
+ * - `finch` - finch-generated data.
60
59
  */
61
60
  connection_type: 'provider' | 'finch';
62
61
 
@@ -10,13 +10,10 @@ export type ConnectionStatusType =
10
10
 
11
11
  /**
12
12
  * - `supported`: This operation is supported by both the provider and Finch
13
- *
14
13
  * - `not_supported_by_finch`: This operation is not supported by Finch but
15
14
  * supported by the provider
16
- *
17
15
  * - `not_supported_by_provider`: This operation is not supported by the provider,
18
16
  * so Finch cannot support
19
- *
20
17
  * - `client_access_only`: This behavior is supported by the provider, but only
21
18
  * available to the client and not to Finch
22
19
  */
@@ -29,13 +26,10 @@ export type OperationSupport =
29
26
  export interface OperationSupportMatrix {
30
27
  /**
31
28
  * - `supported`: This operation is supported by both the provider and Finch
32
- *
33
29
  * - `not_supported_by_finch`: This operation is not supported by Finch but
34
30
  * supported by the provider
35
- *
36
31
  * - `not_supported_by_provider`: This operation is not supported by the provider,
37
32
  * so Finch cannot support
38
- *
39
33
  * - `client_access_only`: This behavior is supported by the provider, but only
40
34
  * available to the client and not to Finch
41
35
  */
@@ -43,13 +37,10 @@ export interface OperationSupportMatrix {
43
37
 
44
38
  /**
45
39
  * - `supported`: This operation is supported by both the provider and Finch
46
- *
47
40
  * - `not_supported_by_finch`: This operation is not supported by Finch but
48
41
  * supported by the provider
49
- *
50
42
  * - `not_supported_by_provider`: This operation is not supported by the provider,
51
43
  * so Finch cannot support
52
- *
53
44
  * - `client_access_only`: This behavior is supported by the provider, but only
54
45
  * available to the client and not to Finch
55
46
  */
@@ -57,13 +48,10 @@ export interface OperationSupportMatrix {
57
48
 
58
49
  /**
59
50
  * - `supported`: This operation is supported by both the provider and Finch
60
- *
61
51
  * - `not_supported_by_finch`: This operation is not supported by Finch but
62
52
  * supported by the provider
63
- *
64
53
  * - `not_supported_by_provider`: This operation is not supported by the provider,
65
54
  * so Finch cannot support
66
- *
67
55
  * - `client_access_only`: This behavior is supported by the provider, but only
68
56
  * available to the client and not to Finch
69
57
  */
@@ -71,13 +59,10 @@ export interface OperationSupportMatrix {
71
59
 
72
60
  /**
73
61
  * - `supported`: This operation is supported by both the provider and Finch
74
- *
75
62
  * - `not_supported_by_finch`: This operation is not supported by Finch but
76
63
  * supported by the provider
77
- *
78
64
  * - `not_supported_by_provider`: This operation is not supported by the provider,
79
65
  * so Finch cannot support
80
- *
81
66
  * - `client_access_only`: This behavior is supported by the provider, but only
82
67
  * available to the client and not to Finch
83
68
  */
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '5.20.2'; // x-release-please-version
1
+ export const VERSION = '5.20.3'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "5.20.2";
1
+ export declare const VERSION = "5.20.3";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '5.20.2'; // x-release-please-version
4
+ exports.VERSION = '5.20.3'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '5.20.2'; // x-release-please-version
1
+ export const VERSION = '5.20.3'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map