@tryfinch/finch-api 5.17.2 → 5.18.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 5.18.0 (2024-02-02)
+
+Full Changelog: [v5.17.2...v5.18.0](https://github.com/Finch-API/finch-api-node/compare/v5.17.2...v5.18.0)
+
+### Features
+
+* **api:** create access token reads client opts if not provided ([#290](https://github.com/Finch-API/finch-api-node/issues/290)) ([8cd787e](https://github.com/Finch-API/finch-api-node/commit/8cd787e107c7ffb2b850d095ab49c6b8144e2c04))
+
+
+### Chores
+
+* **interal:** make link to api.md relative ([#292](https://github.com/Finch-API/finch-api-node/issues/292)) ([12dd552](https://github.com/Finch-API/finch-api-node/commit/12dd552314f7d83eae9d51e8a67a33710e506f32))
+
 ## 5.17.2 (2024-01-30)
 
 Full Changelog: [v5.17.1...v5.17.2](https://github.com/Finch-API/finch-api-node/compare/v5.17.1...v5.17.2)

package/README.md

@@ -4,7 +4,7 @@
 
 This library provides convenient access to the Finch REST API from server-side TypeScript or JavaScript.
 
-The REST API documentation can be found [in the Finch Documentation Center](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](https://www.github.com/Finch-API/finch-api-node/blob/main/api.md).
+The REST API documentation can be found [in the Finch Documentation Center](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -16,7 +16,7 @@ yarn add @tryfinch/finch-api
 
 ## Usage
 
-The full API of this library can be found in [api.md](https://www.github.com/Finch-API/finch-api-node/blob/main/api.md).
+The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js

package/package.json

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

package/resources/access-tokens.d.ts

@@ -11,10 +11,10 @@ export interface CreateAccessTokenResponse {
     access_token: string;
 }
 export interface AccessTokenCreateParams {
-    client_id: string;
-    client_secret: string;
     code: string;
     redirect_uri: string;
+    client_id?: string;
+    client_secret?: string;
 }
 export declare namespace AccessTokens {
     export import CreateAccessTokenResponse = AccessTokensAPI.CreateAccessTokenResponse;

package/resources/access-tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"access-tokens.d.ts","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,eAAe,MAAM,6CAA6C,CAAC;AAE/E,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAG9C;AAED,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,MAAM,CAAC;IAElB,aAAa,EAAE,MAAM,CAAC;IAEtB,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,YAAY,CAAC;IAC5B,MAAM,QAAQ,yBAAyB,GAAG,eAAe,CAAC,yBAAyB,CAAC;IACpF,MAAM,QAAQ,uBAAuB,GAAG,eAAe,CAAC,uBAAuB,CAAC;CACjF"}
+{"version":3,"file":"access-tokens.d.ts","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,eAAe,MAAM,6CAA6C,CAAC;AAE/E,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAkB9C;AAED,MAAM,WAAW,yBAAyB;IACxC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,yBAAiB,YAAY,CAAC;IAC5B,MAAM,QAAQ,yBAAyB,GAAG,eAAe,CAAC,yBAAyB,CAAC;IACpF,MAAM,QAAQ,uBAAuB,GAAG,eAAe,CAAC,uBAAuB,CAAC;CACjF"}

package/resources/access-tokens.js

@@ -8,7 +8,18 @@ class AccessTokens extends resource_1.APIResource {
      * Exchange the authorization code for an access token
      */
     create(body, options) {
-        return this._client.post('/auth/token', { body, ...options });
+        const clientID = body.client_id || this._client.clientId;
+        if (!clientID)
+            throw new Error('client_id must be provided as an argument or with the FINCH_CLIENT_ID environment variable');
+        const clientSecret = body.client_secret || this._client.clientSecret;
+        if (!clientSecret)
+            throw new Error('client_secret must be provided as an argument or with the FINCH_CLIENT_SECRET environment variable');
+        const bodyWithReplacements = {
+            ...body,
+            client_id: clientID,
+            client_secret: clientSecret,
+        };
+        return this._client.post('/auth/token', { body: bodyWithReplacements, ...options });
     }
 }
 exports.AccessTokens = AccessTokens;

package/resources/access-tokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"access-tokens.js","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2DAA2D;AAG3D,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AAVD,oCAUC;AAgBD,WAAiB,YAAY;AAG7B,CAAC,EAHgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAG5B"}
+{"version":3,"file":"access-tokens.js","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2DAA2D;AAG3D,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzD,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAC;QACJ,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;QACrE,IAAI,CAAC,YAAY;YACf,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;QACJ,MAAM,oBAAoB,GAAG;YAC3B,GAAG,IAAI;YACP,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,YAAY;SAC5B,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AAzBD,oCAyBC;AAgBD,WAAiB,YAAY;AAG7B,CAAC,EAHgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAG5B"}

package/resources/access-tokens.mjs

@@ -5,7 +5,18 @@ export class AccessTokens extends APIResource {
      * Exchange the authorization code for an access token
      */
     create(body, options) {
-        return this._client.post('/auth/token', { body, ...options });
+        const clientID = body.client_id || this._client.clientId;
+        if (!clientID)
+            throw new Error('client_id must be provided as an argument or with the FINCH_CLIENT_ID environment variable');
+        const clientSecret = body.client_secret || this._client.clientSecret;
+        if (!clientSecret)
+            throw new Error('client_secret must be provided as an argument or with the FINCH_CLIENT_SECRET environment variable');
+        const bodyWithReplacements = {
+            ...body,
+            client_id: clientID,
+            client_secret: clientSecret,
+        };
+        return this._client.post('/auth/token', { body: bodyWithReplacements, ...options });
     }
 }
 (function (AccessTokens) {

package/resources/access-tokens.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"access-tokens.mjs","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;AAG1D,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChE,CAAC;CACF;AAgBD,WAAiB,YAAY;AAG7B,CAAC,EAHgB,YAAY,KAAZ,YAAY,QAG5B"}
+{"version":3,"file":"access-tokens.mjs","sourceRoot":"","sources":["../src/resources/access-tokens.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;AAG1D,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;OAEG;IACH,MAAM,CACJ,IAA6B,EAC7B,OAA6B;QAE7B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzD,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CACb,4FAA4F,CAC7F,CAAC;QACJ,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;QACrE,IAAI,CAAC,YAAY;YACf,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;QACJ,MAAM,oBAAoB,GAAG;YAC3B,GAAG,IAAI;YACP,SAAS,EAAE,QAAQ;YACnB,aAAa,EAAE,YAAY;SAC5B,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AAgBD,WAAiB,YAAY;AAG7B,CAAC,EAHgB,YAAY,KAAZ,YAAY,QAG5B"}

package/src/resources/access-tokens.ts

@@ -12,7 +12,22 @@ export class AccessTokens extends APIResource {
     body: AccessTokenCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CreateAccessTokenResponse> {
-    return this._client.post('/auth/token', { body, ...options });
+    const clientID = body.client_id || this._client.clientId;
+    if (!clientID)
+      throw new Error(
+        'client_id must be provided as an argument or with the FINCH_CLIENT_ID environment variable',
+      );
+    const clientSecret = body.client_secret || this._client.clientSecret;
+    if (!clientSecret)
+      throw new Error(
+        'client_secret must be provided as an argument or with the FINCH_CLIENT_SECRET environment variable',
+      );
+    const bodyWithReplacements = {
+      ...body,
+      client_id: clientID,
+      client_secret: clientSecret,
+    };
+    return this._client.post('/auth/token', { body: bodyWithReplacements, ...options });
   }
 }
 
@@ -21,13 +36,13 @@ export interface CreateAccessTokenResponse {
 }
 
 export interface AccessTokenCreateParams {
-  client_id: string;
-
-  client_secret: string;
-
   code: string;
 
   redirect_uri: string;
+
+  client_id?: string;
+
+  client_secret?: string;
 }
 
 export namespace AccessTokens {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.17.2'; // x-release-please-version
+export const VERSION = '5.18.0'; // x-release-please-version

package/version.d.ts

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

package/version.mjs

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