@onfido/api 3.3.0 → 3.5.0

package/README.md

@@ -132,15 +132,15 @@ onfido
 
 ### File download
 
-File downloads, for example `onfido.downloadDocument(documentId, {responseType: 'arraybuffer'})`, will return an instance of a specific object for this endpoint.
+File downloads, for example `onfido.downloadDocument(documentId)`, will return an instance of a `FileTransfer` object.
 
-These objects will have a content type, e.g. `image/png`.
+This object will have a content type, e.g. `image/png`.
 
 ```js
 download.headers["content-type"];
 ```
 
-Call `slice()` to get a `Blob` of the download:
+Call `slice()` to get a `Buffer` of the download:
 
 ```js
 const blob = download.data.slice();
@@ -148,16 +148,18 @@ const blob = download.data.slice();
 
 ### File upload
 
-For some common types of streams, like instances of `fs.ReadStream`, you can provide the stream directly:
+File upload should make use of the provided `FileTransfer` class, e.g.:
 
 ```js
 onfido.uploadDocument(
   "passport",
   "<APPLICANT_ID>",
-  fs.createReadStream("path/to/passport.png")
+  new FileTransfer(Buffer.from(document.buffer), document.filename)
 );
 ```
 
+`FileTransfer` object can also be created from an existing file, e.g. `new FileTransfer("path/to/passport.png")`.
+
 ### Webhook event verification
 
 Webhook events payload needs to be verified before it can be accessed. Library allows to easily decode the payload and verify its signature before returning it as an object for user convenience:

package/dist/api.d.ts

@@ -9738,6 +9738,12 @@ export interface WorkflowRun {
      * @memberof WorkflowRun
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRun
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -9798,6 +9804,12 @@ export interface WorkflowRun {
      * @memberof WorkflowRun
      */
     'error'?: WorkflowRunResponseError;
+    /**
+     * Client token to use when loading this workflow run in the Onfido SDK.
+     * @type {string}
+     * @memberof WorkflowRun
+     */
+    'sdk_token'?: string | null;
 }
 export declare const WorkflowRunStatusEnum: {
     readonly AwaitingInput: "awaiting_input";
@@ -9834,6 +9846,12 @@ export interface WorkflowRunBuilder {
      * @memberof WorkflowRunBuilder
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRunBuilder
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -9924,6 +9942,12 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     'error'?: WorkflowRunResponseError;
+    /**
+     * Client token to use when loading this workflow run in the Onfido SDK.
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    'sdk_token'?: string | null;
 }
 export declare const WorkflowRunResponseStatusEnum: {
     readonly AwaitingInput: "awaiting_input";
@@ -9979,6 +10003,12 @@ export interface WorkflowRunShared {
      * @memberof WorkflowRunShared
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRunShared
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}

package/dist/api.js

@@ -2789,7 +2789,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
                 localVarFormParams.append('validate_image_quality', String(validateImageQuality));
             }
             if (location !== undefined) {
-                localVarFormParams.append('location', new Blob([JSON.stringify(location)], { type: "application/json", }));
+                localVarFormParams.append('location', JSON.stringify(location));
             }
             localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);

package/dist/configuration.js

@@ -32,7 +32,7 @@ class Configuration {
         }
         this.apiKey = 'Token token=' + param.apiToken;
         this.basePath = param.basePath || base_1.BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
-        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.3.0' }) });
+        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.5.0' }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**

package/dist/esm/api.d.ts

@@ -9738,6 +9738,12 @@ export interface WorkflowRun {
      * @memberof WorkflowRun
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRun
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -9798,6 +9804,12 @@ export interface WorkflowRun {
      * @memberof WorkflowRun
      */
     'error'?: WorkflowRunResponseError;
+    /**
+     * Client token to use when loading this workflow run in the Onfido SDK.
+     * @type {string}
+     * @memberof WorkflowRun
+     */
+    'sdk_token'?: string | null;
 }
 export declare const WorkflowRunStatusEnum: {
     readonly AwaitingInput: "awaiting_input";
@@ -9834,6 +9846,12 @@ export interface WorkflowRunBuilder {
      * @memberof WorkflowRunBuilder
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRunBuilder
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}
@@ -9924,6 +9942,12 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     'error'?: WorkflowRunResponseError;
+    /**
+     * Client token to use when loading this workflow run in the Onfido SDK.
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    'sdk_token'?: string | null;
 }
 export declare const WorkflowRunResponseStatusEnum: {
     readonly AwaitingInput: "awaiting_input";
@@ -9979,6 +10003,12 @@ export interface WorkflowRunShared {
      * @memberof WorkflowRunShared
      */
     'tags'?: Array<string> | null;
+    /**
+     * Customer-provided user identifier.
+     * @type {string}
+     * @memberof WorkflowRunShared
+     */
+    'customer_user_id'?: string;
     /**
      *
      * @type {WorkflowRunSharedLink}

package/dist/esm/api.js

@@ -2785,7 +2785,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
                 localVarFormParams.append('validate_image_quality', String(validateImageQuality));
             }
             if (location !== undefined) {
-                localVarFormParams.append('location', new Blob([JSON.stringify(location)], { type: "application/json", }));
+                localVarFormParams.append('location', JSON.stringify(location));
             }
             localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
             setSearchParams(localVarUrlObj, localVarQueryParameter);

package/dist/esm/configuration.js

@@ -29,7 +29,7 @@ export class Configuration {
         }
         this.apiKey = 'Token token=' + param.apiToken;
         this.basePath = param.basePath || BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
-        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.3.0' }) });
+        this.baseOptions = Object.assign(Object.assign({ timeout: 30000 }, param.baseOptions), { headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': 'onfido-node/3.5.0' }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onfido/api",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "description": "Node.js library for the Onfido API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -45,7 +45,7 @@
     }
   },
   "dependencies": {
-    "axios": "^1.6.1"
+    "axios": "^1.7.4"
   },
   "devDependencies": {
     "@faker-js/faker": "^8.4.1",