@onfido/api 3.6.0 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.js CHANGED
@@ -47,13 +47,15 @@ globalAxios.interceptors.response.use((response) => __awaiter(void 0, void 0, vo
47
47
  }
48
48
  return response;
49
49
  }));
50
- export const CheckStatusEnum = {
51
- InProgress: 'in_progress',
52
- AwaitingApplicant: 'awaiting_applicant',
53
- Complete: 'complete',
54
- Withdrawn: 'withdrawn',
55
- Paused: 'paused',
56
- Reopened: 'reopened',
50
+ /**
51
+ *
52
+ * @export
53
+ * @enum {string}
54
+ */
55
+ export const ApplicantConsentName = {
56
+ PrivacyNoticesRead: 'privacy_notices_read',
57
+ SsnVerification: 'ssn_verification',
58
+ PhoneNumberVerification: 'phone_number_verification',
57
59
  UnknownDefaultOpenApi: '11184809'
58
60
  };
59
61
  export const CheckResultEnum = {
@@ -61,7 +63,17 @@ export const CheckResultEnum = {
61
63
  Consider: 'consider',
62
64
  UnknownDefaultOpenApi: '11184809'
63
65
  };
64
- export const CheckResponseStatusEnum = {
66
+ export const CheckResponseResultEnum = {
67
+ Clear: 'clear',
68
+ Consider: 'consider',
69
+ UnknownDefaultOpenApi: '11184809'
70
+ };
71
+ /**
72
+ * The current state of the check in the checking process.
73
+ * @export
74
+ * @enum {string}
75
+ */
76
+ export const CheckStatus = {
65
77
  InProgress: 'in_progress',
66
78
  AwaitingApplicant: 'awaiting_applicant',
67
79
  Complete: 'complete',
@@ -70,17 +82,6 @@ export const CheckResponseStatusEnum = {
70
82
  Reopened: 'reopened',
71
83
  UnknownDefaultOpenApi: '11184809'
72
84
  };
73
- export const CheckResponseResultEnum = {
74
- Clear: 'clear',
75
- Consider: 'consider',
76
- UnknownDefaultOpenApi: '11184809'
77
- };
78
- export const ConsentItemNameEnum = {
79
- PrivacyNoticesRead: 'privacy_notices_read',
80
- SsnVerification: 'ssn_verification',
81
- PhoneNumberVerification: 'phone_number_verification',
82
- UnknownDefaultOpenApi: '11184809'
83
- };
84
85
  /**
85
86
  *
86
87
  * @export
@@ -446,6 +447,11 @@ export const DocumentTypes = {
446
447
  ProfessionalQualificationCard: 'professional_qualification_card',
447
448
  ConsularId: 'consular_id',
448
449
  InternationalDrivingLicence: 'international_driving_licence',
450
+ HomeOfficeLetter: 'home_office_letter',
451
+ BirthCertificate: 'birth_certificate',
452
+ VehicleRegistrationCertificate: 'vehicle_registration_certificate',
453
+ FormForAffixingTheVisa: 'form_for_affixing_the_visa',
454
+ IdentificationNumberDocument: 'identification_number_document',
449
455
  UnknownDefaultOpenApi: '11184809'
450
456
  };
451
457
  export const DocumentWithDriverVerificationReportAllOfPropertiesNistIdentityEvidenceStrengthEnum = {
@@ -655,6 +661,47 @@ export const WatchlistMonitorSharedReportNameEnum = {
655
661
  Aml: 'watchlist_aml',
656
662
  UnknownDefaultOpenApi: '11184809'
657
663
  };
664
+ /**
665
+ * The current state of the object, if available.
666
+ * @export
667
+ * @enum {string}
668
+ */
669
+ export const WebhookEventObjectStatus = {
670
+ Processing: 'processing',
671
+ AwaitingInput: 'awaiting_input',
672
+ AwaitingClientInput: 'awaiting_client_input',
673
+ Approved: 'approved',
674
+ Declined: 'declined',
675
+ Review: 'review',
676
+ Abandoned: 'abandoned',
677
+ Error: 'error',
678
+ Started: 'started',
679
+ Cancelled: 'cancelled',
680
+ Completed: 'completed',
681
+ AwaitingData: 'awaiting_data',
682
+ AwaitingApproval: 'awaiting_approval',
683
+ Complete: 'complete',
684
+ Withdrawn: 'withdrawn',
685
+ InProgress: 'in_progress',
686
+ AwaitingApplicant: 'awaiting_applicant',
687
+ Paused: 'paused',
688
+ Reopened: 'reopened',
689
+ UnknownDefaultOpenApi: '11184809'
690
+ };
691
+ /**
692
+ *
693
+ * @export
694
+ * @enum {string}
695
+ */
696
+ export const WebhookEventResourceType = {
697
+ Check: 'check',
698
+ Report: 'report',
699
+ AuditLog: 'audit_log',
700
+ WorkflowRun: 'workflow_run',
701
+ WorkflowTask: 'workflow_task',
702
+ WatchlistMonitor: 'watchlist_monitor',
703
+ UnknownDefaultOpenApi: '11184809'
704
+ };
658
705
  /**
659
706
  *
660
707
  * @export
@@ -680,27 +727,7 @@ export const WebhookEventType = {
680
727
  WorkflowSignedEvidenceFileCreated: 'workflow_signed_evidence_file.created',
681
728
  UnknownDefaultOpenApi: '11184809'
682
729
  };
683
- export const WorkflowRunStatusEnum = {
684
- AwaitingInput: 'awaiting_input',
685
- Processing: 'processing',
686
- Abandoned: 'abandoned',
687
- Error: 'error',
688
- Approved: 'approved',
689
- Review: 'review',
690
- Declined: 'declined',
691
- UnknownDefaultOpenApi: '11184809'
692
- };
693
- export const WorkflowRunResponseStatusEnum = {
694
- AwaitingInput: 'awaiting_input',
695
- Processing: 'processing',
696
- Abandoned: 'abandoned',
697
- Error: 'error',
698
- Approved: 'approved',
699
- Review: 'review',
700
- Declined: 'declined',
701
- UnknownDefaultOpenApi: '11184809'
702
- };
703
- export const WorkflowRunSharedLinkLanguageEnum = {
730
+ export const WorkflowRunLinkLanguageEnum = {
704
731
  EnUs: 'en_US',
705
732
  DeDe: 'de_DE',
706
733
  EsEs: 'es_ES',
@@ -710,6 +737,22 @@ export const WorkflowRunSharedLinkLanguageEnum = {
710
737
  NlNl: 'nl_NL',
711
738
  UnknownDefaultOpenApi: '11184809'
712
739
  };
740
+ /**
741
+ *
742
+ * @export
743
+ * @enum {string}
744
+ */
745
+ export const WorkflowRunStatus = {
746
+ Processing: 'processing',
747
+ AwaitingInput: 'awaiting_input',
748
+ AwaitingClientInput: 'awaiting_client_input',
749
+ Approved: 'approved',
750
+ Declined: 'declined',
751
+ Review: 'review',
752
+ Abandoned: 'abandoned',
753
+ Error: 'error',
754
+ UnknownDefaultOpenApi: '11184809'
755
+ };
713
756
  /**
714
757
  * DefaultApi - axios parameter creator
715
758
  * @export
@@ -2732,7 +2775,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
2732
2775
  /**
2733
2776
  * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
2734
2777
  * @summary Upload a document
2735
- * @param {string} type The type of document
2778
+ * @param {DocumentTypes} type The type of document
2736
2779
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
2737
2780
  * @param {FileTransfer} file The file to be uploaded.
2738
2781
  * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
@@ -3894,7 +3937,7 @@ export const DefaultApiFp = function (configuration) {
3894
3937
  /**
3895
3938
  * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
3896
3939
  * @summary Upload a document
3897
- * @param {string} type The type of document
3940
+ * @param {DocumentTypes} type The type of document
3898
3941
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
3899
3942
  * @param {FileTransfer} file The file to be uploaded.
3900
3943
  * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
@@ -4594,7 +4637,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
4594
4637
  /**
4595
4638
  * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
4596
4639
  * @summary Upload a document
4597
- * @param {string} type The type of document
4640
+ * @param {DocumentTypes} type The type of document
4598
4641
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
4599
4642
  * @param {FileTransfer} file The file to be uploaded.
4600
4643
  * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
@@ -5338,7 +5381,7 @@ export class DefaultApi extends BaseAPI {
5338
5381
  /**
5339
5382
  * Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.
5340
5383
  * @summary Upload a document
5341
- * @param {string} type The type of document
5384
+ * @param {DocumentTypes} type The type of document
5342
5385
  * @param {string} applicantId The ID of the applicant whose document is being uploaded.
5343
5386
  * @param {FileTransfer} file The file to be uploaded.
5344
5387
  * @param {UploadDocumentFileTypeEnum} [fileType] The file type of the uploaded file
@@ -29,7 +29,7 @@ export class Configuration {
29
29
  }
30
30
  this.apiKey = 'Token token=' + param.apiToken;
31
31
  this.basePath = param.basePath || BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
32
- 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.6.0' }) });
32
+ 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/4.1.0' }) });
33
33
  this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
34
34
  }
35
35
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@onfido/api",
3
- "version": "3.6.0",
3
+ "version": "4.1.0",
4
4
  "description": "Node.js library for the Onfido API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {