Initial version of onfido-node (3.0.0) generated from onfido-openapi-spec

.github/workflows/node.js.yml

@@ -20,7 +20,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 15.x, 16.x, 18.x]
+        node-version: [16.x, 18.x, 20.x, 21.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -31,18 +31,17 @@ jobs:
         node-version: ${{ matrix.node-version }}
     - run: npm ci
     - run: npm run build --if-present
-    - name: Mock testing
-      run: npm test
-    # - name: E2E testing
-    #   if: ${{ matrix.node-version == '14.x' &&
-    #       github.event.pull_request.head.repo.full_name == github.repository &&
-    #       github.actor != 'dependabot[bot]' }}
-    #   run: npm test -i
-    #   env:
-    #     ONFIDO_API_TOKEN: ${{secrets.ONFIDO_API_TOKEN}}
-    #     ONFIDO_SAMPLE_APPLICANT_ID: ${{secrets.ONFIDO_SAMPLE_APPLICANT_ID}}
-    #     ONFIDO_SAMPLE_VIDEO_ID_1: ${{secrets.ONFIDO_SAMPLE_VIDEO_ID_1}}
-    #     ONFIDO_SAMPLE_VIDEO_ID_2: ${{secrets.ONFIDO_SAMPLE_VIDEO_ID_2}}
-    #     ONFIDO_SAMPLE_MOTION_ID_1: ${{secrets.ONFIDO_SAMPLE_MOTION_ID_1}}
-    #     ONFIDO_SAMPLE_MOTION_ID_2: ${{secrets.ONFIDO_SAMPLE_MOTION_ID_2}}
-    #     NOCK_OFF: true
+    - name: Run linter over tests
+      run: npx prettier -c test/**/*.ts
+    - name: E2E testing
+      if: ${{ matrix.node-version == '16.x' &&
+          github.event.pull_request.head.repo.full_name == github.repository &&
+          github.actor != 'dependabot[bot]' }}
+      run: npm test -- -i
+      env:
+        ONFIDO_API_TOKEN: ${{ secrets.ONFIDO_API_TOKEN }}
+        ONFIDO_SAMPLE_APPLICANT_ID: ${{ secrets.ONFIDO_SAMPLE_APPLICANT_ID }}
+        ONFIDO_SAMPLE_VIDEO_ID_1: ${{ secrets.ONFIDO_SAMPLE_VIDEO_ID_1 }}
+        ONFIDO_SAMPLE_VIDEO_ID_2: ${{ secrets.ONFIDO_SAMPLE_VIDEO_ID_2 }}
+        ONFIDO_SAMPLE_MOTION_ID_1: ${{ secrets.ONFIDO_SAMPLE_MOTION_ID_1 }}
+        ONFIDO_SAMPLE_MOTION_ID_2: ${{ secrets.ONFIDO_SAMPLE_MOTION_ID_2 }}

.github/workflows/npm-publish.yml

@@ -16,18 +16,15 @@ jobs:
         with:
           node-version: 14
       - run: npm ci
-      - name: Mock testing
-        run: npm test
-      # - name: E2E testing
-      #   run: npm test -i
-      #   env:
-      #     ONFIDO_API_TOKEN: ${{secrets.ONFIDO_API_TOKEN}}
-      #     ONFIDO_SAMPLE_APPLICANT_ID: ${{secrets.ONFIDO_SAMPLE_APPLICANT_ID}}
-      #     ONFIDO_SAMPLE_VIDEO_ID_1: ${{secrets.ONFIDO_SAMPLE_VIDEO_ID_1}}
-      #     ONFIDO_SAMPLE_VIDEO_ID_2: ${{secrets.ONFIDO_SAMPLE_VIDEO_ID_2}}
-      #     ONFIDO_SAMPLE_MOTION_ID_1: ${{secrets.ONFIDO_SAMPLE_MOTION_ID_1}}
-      #     ONFIDO_SAMPLE_MOTION_ID_2: ${{secrets.ONFIDO_SAMPLE_MOTION_ID_2}}
-      #     NOCK_OFF: true
+      - name: E2E testing
+        run: npm test -i
+        env:
+          ONFIDO_API_TOKEN: ${{secrets.ONFIDO_API_TOKEN}}
+          ONFIDO_SAMPLE_APPLICANT_ID: ${{secrets.ONFIDO_SAMPLE_APPLICANT_ID}}
+          ONFIDO_SAMPLE_VIDEO_ID_1: ${{secrets.ONFIDO_SAMPLE_VIDEO_ID_1}}
+          ONFIDO_SAMPLE_VIDEO_ID_2: ${{secrets.ONFIDO_SAMPLE_VIDEO_ID_2}}
+          ONFIDO_SAMPLE_MOTION_ID_1: ${{secrets.ONFIDO_SAMPLE_MOTION_ID_1}}
+          ONFIDO_SAMPLE_MOTION_ID_2: ${{secrets.ONFIDO_SAMPLE_MOTION_ID_2}}
 
   publish-npm:
     needs: build

.npmignore

@@ -0,0 +1 @@
+# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm

.openapi-generator/FILES

@@ -0,0 +1,268 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+LICENSE
+README.md
+api.ts
+api/default-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+model/address-builder.ts
+model/address-shared.ts
+model/address.ts
+model/addresses.ts
+model/applicant-builder.ts
+model/applicant-consent.ts
+model/applicant-request.ts
+model/applicant-response.ts
+model/applicant-shared.ts
+model/applicant.ts
+model/applicants-list.ts
+model/check-builder.ts
+model/check-request.ts
+model/check-response.ts
+model/check-shared.ts
+model/check.ts
+model/checks-list.ts
+model/complete-task-request.ts
+model/country-codes.ts
+model/device-intelligence-breakdown-breakdown-device-breakdown.ts
+model/device-intelligence-breakdown-breakdown-device.ts
+model/device-intelligence-breakdown-breakdown.ts
+model/device-intelligence-breakdown-properties-device.ts
+model/device-intelligence-breakdown-properties-geolocation.ts
+model/device-intelligence-breakdown-properties-ip.ts
+model/device-intelligence-breakdown-properties.ts
+model/device-intelligence-breakdown.ts
+model/device-intelligence-report.ts
+model/document-breakdown-age-validation-breakdown.ts
+model/document-breakdown-age-validation.ts
+model/document-breakdown-compromised-document-breakdown.ts
+model/document-breakdown-compromised-document.ts
+model/document-breakdown-data-comparison-breakdown-issuing-country.ts
+model/document-breakdown-data-comparison-breakdown.ts
+model/document-breakdown-data-comparison.ts
+model/document-breakdown-data-consistency-breakdown.ts
+model/document-breakdown-data-consistency.ts
+model/document-breakdown-data-validation-breakdown-document-expiration.ts
+model/document-breakdown-data-validation-breakdown-expiry-date.ts
+model/document-breakdown-data-validation-breakdown.ts
+model/document-breakdown-data-validation.ts
+model/document-breakdown-image-integrity-breakdown-colour-picture.ts
+model/document-breakdown-image-integrity-breakdown-conclusive-document-quality.ts
+model/document-breakdown-image-integrity-breakdown-image-quality.ts
+model/document-breakdown-image-integrity-breakdown-supported-document.ts
+model/document-breakdown-image-integrity-breakdown.ts
+model/document-breakdown-image-integrity.ts
+model/document-breakdown-issuing-authority-breakdown-nfc-active-authentication.ts
+model/document-breakdown-issuing-authority-breakdown-nfc-passive-authentication.ts
+model/document-breakdown-issuing-authority-breakdown.ts
+model/document-breakdown-issuing-authority.ts
+model/document-breakdown-police-record.ts
+model/document-breakdown-visual-authenticity-breakdown-digital-tampering.ts
+model/document-breakdown-visual-authenticity-breakdown-face-detection.ts
+model/document-breakdown-visual-authenticity-breakdown-fonts.ts
+model/document-breakdown-visual-authenticity-breakdown-original-document-present.ts
+model/document-breakdown-visual-authenticity-breakdown-other.ts
+model/document-breakdown-visual-authenticity-breakdown-picture-face-integrity.ts
+model/document-breakdown-visual-authenticity-breakdown-security-features.ts
+model/document-breakdown-visual-authenticity-breakdown-template.ts
+model/document-breakdown-visual-authenticity-breakdown.ts
+model/document-breakdown-visual-authenticity.ts
+model/document-breakdown.ts
+model/document-cdqreasons.ts
+model/document-iqreasons.ts
+model/document-odpreasons.ts
+model/document-properties-address-lines.ts
+model/document-properties-barcode-inner.ts
+model/document-properties-document-classification.ts
+model/document-properties-document-numbers-inner.ts
+model/document-properties-driving-licence-information.ts
+model/document-properties-extracted-data.ts
+model/document-properties-nfc.ts
+model/document-properties.ts
+model/document-report.ts
+model/document-response.ts
+model/document-shared.ts
+model/document-video-report.ts
+model/document-video-with-address-information.ts
+model/document-with-address-information-report.ts
+model/document-with-driver-verification-report-all-of-properties-all-of-passenger-vehicle.ts
+model/document-with-driver-verification-report-all-of-properties-all-of-vehicle-class-details-inner.ts
+model/document-with-driver-verification-report-all-of-properties.ts
+model/document-with-driver-verification-report.ts
+model/document-with-driving-licence-information-report.ts
+model/document.ts
+model/documents-list.ts
+model/error-properties.ts
+model/error-properties1.ts
+model/error1.ts
+model/extract-request.ts
+model/extraction-document-classification.ts
+model/extraction-extracted-data.ts
+model/extraction.ts
+model/facial-similarity-motion-breakdown-face-comparison.ts
+model/facial-similarity-motion-breakdown-image-integrity-breakdown-face-detected.ts
+model/facial-similarity-motion-breakdown-image-integrity-breakdown-source-integrity.ts
+model/facial-similarity-motion-breakdown-image-integrity-breakdown.ts
+model/facial-similarity-motion-breakdown-image-integrity.ts
+model/facial-similarity-motion-breakdown-visual-authenticity-breakdown-spoofing-detection.ts
+model/facial-similarity-motion-breakdown-visual-authenticity-breakdown.ts
+model/facial-similarity-motion-breakdown-visual-authenticity.ts
+model/facial-similarity-motion-breakdown.ts
+model/facial-similarity-motion-report.ts
+model/facial-similarity-photo-breakdown-face-comparison-breakdown-face-match-properties.ts
+model/facial-similarity-photo-breakdown-face-comparison-breakdown-face-match.ts
+model/facial-similarity-photo-breakdown-face-comparison-breakdown.ts
+model/facial-similarity-photo-breakdown-face-comparison.ts
+model/facial-similarity-photo-breakdown-image-integrity-breakdown-face-detected.ts
+model/facial-similarity-photo-breakdown-image-integrity-breakdown-source-integrity.ts
+model/facial-similarity-photo-breakdown-image-integrity-breakdown.ts
+model/facial-similarity-photo-breakdown-image-integrity.ts
+model/facial-similarity-photo-breakdown-visual-authenticity-breakdown-spoofing-detection-properties.ts
+model/facial-similarity-photo-breakdown-visual-authenticity-breakdown-spoofing-detection.ts
+model/facial-similarity-photo-breakdown-visual-authenticity-breakdown.ts
+model/facial-similarity-photo-breakdown-visual-authenticity.ts
+model/facial-similarity-photo-breakdown.ts
+model/facial-similarity-photo-fully-auto-breakdown-image-integrity-breakdown-source-integrity.ts
+model/facial-similarity-photo-fully-auto-breakdown-image-integrity-breakdown.ts
+model/facial-similarity-photo-fully-auto-breakdown-image-integrity.ts
+model/facial-similarity-photo-fully-auto-breakdown.ts
+model/facial-similarity-photo-fully-auto-report.ts
+model/facial-similarity-photo-report.ts
+model/facial-similarity-video-breakdown-face-comparison.ts
+model/facial-similarity-video-breakdown-image-integrity-breakdown-face-detected.ts
+model/facial-similarity-video-breakdown-image-integrity-breakdown-source-integrity.ts
+model/facial-similarity-video-breakdown-image-integrity-breakdown.ts
+model/facial-similarity-video-breakdown-image-integrity.ts
+model/facial-similarity-video-breakdown-visual-authenticity-breakdown-liveness-detected.ts
+model/facial-similarity-video-breakdown-visual-authenticity-breakdown-spoofing-detection.ts
+model/facial-similarity-video-breakdown-visual-authenticity-breakdown.ts
+model/facial-similarity-video-breakdown-visual-authenticity.ts
+model/facial-similarity-video-breakdown.ts
+model/facial-similarity-video-report.ts
+model/generate-sdk-token-request.ts
+model/id-number.ts
+model/id-photo-response.ts
+model/id-photo.ts
+model/identity-enhanced-breakdown-address-breakdown-credit-agencies-properties.ts
+model/identity-enhanced-breakdown-address-breakdown-credit-agencies.ts
+model/identity-enhanced-breakdown-address-breakdown-telephone-database.ts
+model/identity-enhanced-breakdown-address-breakdown-voting-register.ts
+model/identity-enhanced-breakdown-address-breakdown.ts
+model/identity-enhanced-breakdown-address.ts
+model/identity-enhanced-breakdown-date-of-birth-breakdown-credit-agencies.ts
+model/identity-enhanced-breakdown-date-of-birth-breakdown-voting-register.ts
+model/identity-enhanced-breakdown-date-of-birth-breakdown.ts
+model/identity-enhanced-breakdown-date-of-birth.ts
+model/identity-enhanced-breakdown-mortality.ts
+model/identity-enhanced-breakdown-sources-breakdown-total-sources-properties.ts
+model/identity-enhanced-breakdown-sources-breakdown-total-sources.ts
+model/identity-enhanced-breakdown-sources-breakdown.ts
+model/identity-enhanced-breakdown-sources.ts
+model/identity-enhanced-breakdown.ts
+model/identity-enhanced-properties-matched-addresses-inner.ts
+model/identity-enhanced-properties.ts
+model/identity-enhanced-report.ts
+model/idphotos-list.ts
+model/index.ts
+model/india-pan-report-all-of-breakdown-device-breakdown-pan-valid.ts
+model/india-pan-report-all-of-breakdown-device-breakdown.ts
+model/india-pan-report-all-of-breakdown-device.ts
+model/india-pan-report-all-of-breakdown.ts
+model/india-pan-report-all-of-properties-device.ts
+model/india-pan-report-all-of-properties.ts
+model/india-pan-report.ts
+model/known-faces-breakdown-image-integrity.ts
+model/known-faces-breakdown-previously-seen-faces.ts
+model/known-faces-breakdown.ts
+model/known-faces-properties-matches-inner.ts
+model/known-faces-properties.ts
+model/known-faces-report.ts
+model/live-photo-response.ts
+model/live-photo.ts
+model/live-photos-list.ts
+model/live-video.ts
+model/liveo-videos-list.ts
+model/location-builder.ts
+model/location-shared.ts
+model/location.ts
+model/model-error.ts
+model/motion-capture.ts
+model/motion-captures-list.ts
+model/photo-auto-reasons.ts
+model/photo-reasons.ts
+model/proof-of-address-breakdown-data-comparison-breakdown.ts
+model/proof-of-address-breakdown-data-comparison.ts
+model/proof-of-address-breakdown-document-classification-breakdown.ts
+model/proof-of-address-breakdown-document-classification.ts
+model/proof-of-address-breakdown-image-integrity-breakdown.ts
+model/proof-of-address-breakdown-image-integrity.ts
+model/proof-of-address-breakdown.ts
+model/proof-of-address-properties.ts
+model/proof-of-address-report.ts
+model/repeat-attempts-repeat-attempts-inner.ts
+model/repeat-attempts.ts
+model/report-document.ts
+model/report-name.ts
+model/report-shared.ts
+model/report.ts
+model/reports-list.ts
+model/results-feedback.ts
+model/sdktoken.ts
+model/task.ts
+model/update-monitor-match-request.ts
+model/us-driving-licence-breakdown-address-breakdown.ts
+model/us-driving-licence-breakdown-address.ts
+model/us-driving-licence-breakdown-document-breakdown.ts
+model/us-driving-licence-breakdown-document.ts
+model/us-driving-licence-breakdown-personal-breakdown.ts
+model/us-driving-licence-breakdown-personal.ts
+model/us-driving-licence-breakdown.ts
+model/us-driving-licence-report.ts
+model/video-reasons.ts
+model/watchlist-aml-breakdown-adverse-media.ts
+model/watchlist-aml-breakdown-legal-and-regulatory-warnings.ts
+model/watchlist-aml-breakdown-politically-exposed-person.ts
+model/watchlist-aml-breakdown-sanction.ts
+model/watchlist-aml-breakdown.ts
+model/watchlist-aml-properties.ts
+model/watchlist-aml-report.ts
+model/watchlist-enhanced-breakdown.ts
+model/watchlist-enhanced-properties.ts
+model/watchlist-enhanced-report.ts
+model/watchlist-monitor-match.ts
+model/watchlist-monitor.ts
+model/watchlist-peps-only-report.ts
+model/watchlist-sanctions-only-report.ts
+model/watchlist-standard-breakdown.ts
+model/watchlist-standard-properties.ts
+model/watchlist-standard-report.ts
+model/webhook-builder.ts
+model/webhook-create.ts
+model/webhook-event-payload-object.ts
+model/webhook-event-payload.ts
+model/webhook-event-type.ts
+model/webhook-event.ts
+model/webhook-resend-data-inner.ts
+model/webhook-resend.ts
+model/webhook-response.ts
+model/webhook-shared.ts
+model/webhook-update.ts
+model/webhook-updater.ts
+model/webhook.ts
+model/webhooks-list.ts
+model/workflow-run-builder.ts
+model/workflow-run-request.ts
+model/workflow-run-response-error.ts
+model/workflow-run-response.ts
+model/workflow-run-shared-link.ts
+model/workflow-run-shared.ts
+model/workflow-run.ts
+package.json
+tsconfig.esm.json
+tsconfig.json
+webhook-event-verifier.ts

.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.3.0

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v3.0.0 12th March 2024
+
+- Automatically generate library from [Onfido OpenAPI spec](https://github.com/onfido/onfido-openapi-spec/tree/master)
+
 ## v2.9.0 24 November 2023
 
 - Add `resource` to `WebhookEvent`
@@ -34,7 +38,7 @@
 
 ## v2.3.1, 24 May 2022
 
-- Reinstated `privacyNoticesReadConsentGiven` parameter 
+- Reinstated `privacyNoticesReadConsentGiven` parameter
 
 ## v2.3.0, 10 May 2022
 
@@ -61,12 +65,12 @@
 
 ## v2.0.2, 25 May 2021
 
-- Added `environments` to Webhook object 
+- Added `environments` to Webhook object
 
 ## v2.0.1, 17 May 2021
 
 - Added `sub_result` to trigger sandbox pre-determined responses for Document report sub-results
-- Added `consider` array functionality for sandbox pre-determined responses 
+- Added `consider` array functionality for sandbox pre-determined responses
 
 ## v2.0.0, 9 April 2021
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Onfido
+Copyright (c) 2024 Onfido
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal