@onfido/api 5.3.0 → 5.4.0

package/dist/api.d.ts

@@ -10957,6 +10957,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     deleteWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadAesDocument: (workflowRunId: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check
@@ -11531,6 +11540,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check
@@ -12105,6 +12123,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check
@@ -12692,6 +12719,16 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check

package/dist/api.js

@@ -1158,6 +1158,45 @@ const DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Retrieves the signed document or signing transaction receipt depending on the id provided.
+         * @summary Retrieves the signed document or signing transaction receipt
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} id The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAesDocument: (workflowRunId, id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'workflowRunId' is not null or undefined
+            (0, common_1.assertParamExists)('downloadAesDocument', 'workflowRunId', workflowRunId);
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('downloadAesDocument', 'id', id);
+            const localVarPath = `/advanced_electronic_signature/documents`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Token required
+            yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            if (workflowRunId !== undefined) {
+                localVarQueryParameter['workflow_run_id'] = workflowRunId;
+            }
+            if (id !== undefined) {
+                localVarQueryParameter['id'] = id;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
          * @summary Download check
@@ -3249,6 +3288,23 @@ const DefaultApiFp = function (configuration) {
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Retrieves the signed document or signing transaction receipt depending on the id provided.
+         * @summary Retrieves the signed document or signing transaction receipt
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} id The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAesDocument(workflowRunId, id, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadAesDocument(workflowRunId, id, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DefaultApi.downloadAesDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
          * @summary Download check
@@ -4305,6 +4361,17 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
         deleteWebhook(webhookId, options) {
             return localVarFp.deleteWebhook(webhookId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves the signed document or signing transaction receipt depending on the id provided.
+         * @summary Retrieves the signed document or signing transaction receipt
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} id The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAesDocument(workflowRunId, id, options) {
+            return localVarFp.downloadAesDocument(workflowRunId, id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
          * @summary Download check
@@ -5030,6 +5097,18 @@ class DefaultApi extends base_1.BaseAPI {
     deleteWebhook(webhookId, options) {
         return (0, exports.DefaultApiFp)(this.configuration).deleteWebhook(webhookId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadAesDocument(workflowRunId, id, options) {
+        return (0, exports.DefaultApiFp)(this.configuration).downloadAesDocument(workflowRunId, id, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check

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/5.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/5.4.0" }) });
         this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
     }
     /**

package/dist/esm/api.d.ts

@@ -10957,6 +10957,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     deleteWebhook: (webhookId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadAesDocument: (workflowRunId: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check
@@ -11531,6 +11540,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>>;
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check
@@ -12105,6 +12123,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<FileTransfer>;
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check
@@ -12692,6 +12719,16 @@ export declare class DefaultApi extends BaseAPI {
      * @memberof DefaultApi
      */
     deleteWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadAesDocument(workflowRunId: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileTransfer, any>>;
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check

package/dist/esm/api.js

@@ -1154,6 +1154,45 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         * Retrieves the signed document or signing transaction receipt depending on the id provided.
+         * @summary Retrieves the signed document or signing transaction receipt
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} id The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAesDocument: (workflowRunId, id, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'workflowRunId' is not null or undefined
+            assertParamExists('downloadAesDocument', 'workflowRunId', workflowRunId);
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('downloadAesDocument', 'id', id);
+            const localVarPath = `/advanced_electronic_signature/documents`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication Token required
+            yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
+            if (workflowRunId !== undefined) {
+                localVarQueryParameter['workflow_run_id'] = workflowRunId;
+            }
+            if (id !== undefined) {
+                localVarQueryParameter['id'] = id;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
          * @summary Download check
@@ -3244,6 +3283,23 @@ export const DefaultApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         * Retrieves the signed document or signing transaction receipt depending on the id provided.
+         * @summary Retrieves the signed document or signing transaction receipt
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} id The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAesDocument(workflowRunId, id, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.downloadAesDocument(workflowRunId, id, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.downloadAesDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
          * @summary Download check
@@ -4299,6 +4355,17 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
         deleteWebhook(webhookId, options) {
             return localVarFp.deleteWebhook(webhookId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves the signed document or signing transaction receipt depending on the id provided.
+         * @summary Retrieves the signed document or signing transaction receipt
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} id The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadAesDocument(workflowRunId, id, options) {
+            return localVarFp.downloadAesDocument(workflowRunId, id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
          * @summary Download check
@@ -5023,6 +5090,18 @@ export class DefaultApi extends BaseAPI {
     deleteWebhook(webhookId, options) {
         return DefaultApiFp(this.configuration).deleteWebhook(webhookId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieves the signed document or signing transaction receipt depending on the id provided.
+     * @summary Retrieves the signed document or signing transaction receipt
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} id The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    downloadAesDocument(workflowRunId, id, options) {
+        return DefaultApiFp(this.configuration).downloadAesDocument(workflowRunId, id, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Downloads a PDF of a check with a given check ID. Returns the binary data representing the PDF.
      * @summary Download check

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/5.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/5.4.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": "5.3.0",
+  "version": "5.4.0",
   "description": "Node.js library for the Onfido API",
   "author": "OpenAPI-Generator Contributors",
   "repository": {