Merge pull request #136 from onfido/release-upgrade

Refresh onfido-node after onfido-openapi-spec update (40b86a1)
onfido · Jul 17, 2024 · 04ea7e1 · 04ea7e1
2 parents 90a4348 + a06d937
commit 04ea7e1
Show file tree

Hide file tree

Showing 11 changed files with 294 additions and 97 deletions.
diff --git a/.release.json b/.release.json
@@ -1,9 +1,9 @@
 {
   "source": {
     "repo_url": "https://github.com/onfido/onfido-openapi-spec",
-    "short_sha": "01ed1b5",
-    "long_sha": "01ed1b5fe0f7490bfce54816504a9fec13b33862",
-    "version": "v3.1.0"
+    "short_sha": "40b86a1",
+    "long_sha": "40b86a1c8ec8687c15514470f60428b3e7633968",
+    "version": "v3.2.0"
   },
-  "release": "v3.2.0"
+  "release": "v3.3.0"
 }
diff --git a/api.ts b/api.ts
@@ -1837,6 +1837,7 @@ export interface Document {
 
 export const DocumentFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'
@@ -2908,19 +2909,25 @@ export interface DocumentProperties {
      * @type {string}
      * @memberof DocumentProperties
      */
-    'gender'?: string;
+    'middle_name'?: string;
     /**
      * 
      * @type {string}
      * @memberof DocumentProperties
      */
-    'issuing_country'?: string;
+    'last_name'?: string;
     /**
      * 
      * @type {string}
      * @memberof DocumentProperties
      */
-    'last_name'?: string;
+    'gender'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentProperties
+     */
+    'issuing_country'?: string;
     /**
      * 
      * @type {string}
@@ -3773,6 +3780,7 @@ export interface DocumentShared {
 
 export const DocumentSharedFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'
@@ -4172,19 +4180,25 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'gender'?: string;
+    'middle_name'?: string;
     /**
      * 
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'issuing_country'?: string;
+    'last_name'?: string;
     /**
      * 
      * @type {string}
      * @memberof DocumentWithDriverVerificationReportAllOfProperties
      */
-    'last_name'?: string;
+    'gender'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocumentWithDriverVerificationReportAllOfProperties
+     */
+    'issuing_country'?: string;
     /**
      * 
      * @type {string}
@@ -9650,6 +9664,12 @@ export interface WebhookEventPayloadObject {
      * @memberof WebhookEventPayloadObject
      */
     'status'?: string;
+    /**
+     * The date and time when the operation was started, if available.
+     * @type {string}
+     * @memberof WebhookEventPayloadObject
+     */
+    'started_at_iso8601'?: string;
     /**
      * The date and time when the operation was completed, if available.
      * @type {string}
@@ -10947,6 +10967,53 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
 
 
 
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided. 
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadQesDocument: async (workflowRunId: string, fileId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'workflowRunId' is not null or undefined
+            assertParamExists('downloadQesDocument', 'workflowRunId', workflowRunId)
+            // verify required parameter 'fileId' is not null or undefined
+            assertParamExists('downloadQesDocument', 'fileId', fileId)
+            const localVarPath = `/qualified_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 = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication Token required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (workflowRunId !== undefined) {
+                localVarQueryParameter['workflow_run_id'] = workflowRunId;
+            }
+
+            if (fileId !== undefined) {
+                localVarQueryParameter['file_id'] = fileId;
+            }
+
+
+
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -13021,6 +13088,20 @@ export const DefaultApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DefaultApi.downloadMotionCaptureFrame']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided. 
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileTransfer>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.downloadQesDocument(workflowRunId, fileId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DefaultApi.downloadQesDocument']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Retrieves the signed evidence file for the designated Workflow Run 
          * @summary Retrieve Workflow Run Evidence Summary File
@@ -13825,6 +13906,17 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
         downloadMotionCaptureFrame(motionCaptureId: string, options?: any): AxiosPromise<FileTransfer> {
             return localVarFp.downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieves the signed document or application form depending on the file_id provided. 
+         * @summary Retrieves the signed document or application form
+         * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+         * @param {string} fileId The unique identifier of the file which you want to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        downloadQesDocument(workflowRunId: string, fileId: string, options?: any): AxiosPromise<FileTransfer> {
+            return localVarFp.downloadQesDocument(workflowRunId, fileId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieves the signed evidence file for the designated Workflow Run 
          * @summary Retrieve Workflow Run Evidence Summary File
@@ -14537,6 +14629,19 @@ export class DefaultApi extends BaseAPI {
         return DefaultApiFp(this.configuration).downloadMotionCaptureFrame(motionCaptureId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Retrieves the signed document or application form depending on the file_id provided. 
+     * @summary Retrieves the signed document or application form
+     * @param {string} workflowRunId The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+     * @param {string} fileId The unique identifier of the file which you want to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public downloadQesDocument(workflowRunId: string, fileId: string, options?: RawAxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).downloadQesDocument(workflowRunId, fileId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Retrieves the signed evidence file for the designated Workflow Run 
      * @summary Retrieve Workflow Run Evidence Summary File
@@ -15100,6 +15205,7 @@ export type ListWorkflowRunsSortEnum = typeof ListWorkflowRunsSortEnum[keyof typ
  */
 export const UploadDocumentFileTypeEnum = {
     Jpg: 'jpg',
+    Jpeg: 'jpeg',
     Png: 'png',
     Pdf: 'pdf',
     UnknownDefaultOpenApi: '11184809'

diff --git a/configuration.ts b/configuration.ts
@@ -101,7 +101,7 @@ export class Configuration {
         this.baseOptions = {...{ timeout: 30_000 },
                             ...param.baseOptions,
                             ...{ headers: {...param.baseOptions?.headers,
-                                           ...{'User-Agent': 'onfido-node/3.2.0'}}}};
+                                           ...{'User-Agent': 'onfido-node/3.3.0'}}}};
         this.formDataCtor = param.formDataCtor || require('form-data');         // Injiect form data constructor (if needed)
     }