@onfido/api 4.2.0 → 4.4.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/api.d.ts CHANGED
@@ -3022,10 +3022,10 @@ export interface DocumentProperties {
3022
3022
  'address_lines'?: DocumentPropertiesAddressLines;
3023
3023
  /**
3024
3024
  *
3025
- * @type {DocumentPropertiesBarcode}
3025
+ * @type {Array<DocumentPropertiesBarcodeInner>}
3026
3026
  * @memberof DocumentProperties
3027
3027
  */
3028
- 'barcode'?: DocumentPropertiesBarcode;
3028
+ 'barcode'?: Array<DocumentPropertiesBarcodeInner>;
3029
3029
  /**
3030
3030
  *
3031
3031
  * @type {DocumentPropertiesNfc}
@@ -3124,115 +3124,115 @@ export interface DocumentPropertiesAddressLines {
3124
3124
  /**
3125
3125
  *
3126
3126
  * @export
3127
- * @interface DocumentPropertiesBarcode
3127
+ * @interface DocumentPropertiesBarcodeInner
3128
3128
  */
3129
- export interface DocumentPropertiesBarcode {
3129
+ export interface DocumentPropertiesBarcodeInner {
3130
3130
  /**
3131
3131
  *
3132
3132
  * @type {string}
3133
- * @memberof DocumentPropertiesBarcode
3133
+ * @memberof DocumentPropertiesBarcodeInner
3134
3134
  */
3135
3135
  'first_name'?: string;
3136
3136
  /**
3137
3137
  *
3138
3138
  * @type {string}
3139
- * @memberof DocumentPropertiesBarcode
3139
+ * @memberof DocumentPropertiesBarcodeInner
3140
3140
  */
3141
3141
  'middle_name'?: string;
3142
3142
  /**
3143
3143
  *
3144
3144
  * @type {string}
3145
- * @memberof DocumentPropertiesBarcode
3145
+ * @memberof DocumentPropertiesBarcodeInner
3146
3146
  */
3147
3147
  'last_name'?: string;
3148
3148
  /**
3149
3149
  *
3150
3150
  * @type {string}
3151
- * @memberof DocumentPropertiesBarcode
3151
+ * @memberof DocumentPropertiesBarcodeInner
3152
3152
  */
3153
3153
  'document_type'?: string;
3154
3154
  /**
3155
3155
  *
3156
3156
  * @type {string}
3157
- * @memberof DocumentPropertiesBarcode
3157
+ * @memberof DocumentPropertiesBarcodeInner
3158
3158
  */
3159
3159
  'date_of_expiry'?: string;
3160
3160
  /**
3161
3161
  *
3162
3162
  * @type {string}
3163
- * @memberof DocumentPropertiesBarcode
3163
+ * @memberof DocumentPropertiesBarcodeInner
3164
3164
  */
3165
3165
  'date_of_birth'?: string;
3166
3166
  /**
3167
3167
  *
3168
3168
  * @type {string}
3169
- * @memberof DocumentPropertiesBarcode
3169
+ * @memberof DocumentPropertiesBarcodeInner
3170
3170
  */
3171
3171
  'issuing_date'?: string;
3172
3172
  /**
3173
3173
  *
3174
3174
  * @type {string}
3175
- * @memberof DocumentPropertiesBarcode
3175
+ * @memberof DocumentPropertiesBarcodeInner
3176
3176
  */
3177
3177
  'address_line_1'?: string;
3178
3178
  /**
3179
3179
  *
3180
3180
  * @type {string}
3181
- * @memberof DocumentPropertiesBarcode
3181
+ * @memberof DocumentPropertiesBarcodeInner
3182
3182
  */
3183
3183
  'address_line_2'?: string;
3184
3184
  /**
3185
3185
  *
3186
3186
  * @type {string}
3187
- * @memberof DocumentPropertiesBarcode
3187
+ * @memberof DocumentPropertiesBarcodeInner
3188
3188
  */
3189
3189
  'address_line_3'?: string;
3190
3190
  /**
3191
3191
  *
3192
3192
  * @type {string}
3193
- * @memberof DocumentPropertiesBarcode
3193
+ * @memberof DocumentPropertiesBarcodeInner
3194
3194
  */
3195
3195
  'address_line_4'?: string;
3196
3196
  /**
3197
3197
  *
3198
3198
  * @type {string}
3199
- * @memberof DocumentPropertiesBarcode
3199
+ * @memberof DocumentPropertiesBarcodeInner
3200
3200
  */
3201
3201
  'address_line_5'?: string;
3202
3202
  /**
3203
3203
  *
3204
3204
  * @type {string}
3205
- * @memberof DocumentPropertiesBarcode
3205
+ * @memberof DocumentPropertiesBarcodeInner
3206
3206
  */
3207
3207
  'issuing_state'?: string;
3208
3208
  /**
3209
3209
  *
3210
3210
  * @type {string}
3211
- * @memberof DocumentPropertiesBarcode
3211
+ * @memberof DocumentPropertiesBarcodeInner
3212
3212
  */
3213
3213
  'class'?: string;
3214
3214
  /**
3215
3215
  *
3216
3216
  * @type {string}
3217
- * @memberof DocumentPropertiesBarcode
3217
+ * @memberof DocumentPropertiesBarcodeInner
3218
3218
  */
3219
3219
  'gender'?: string;
3220
3220
  /**
3221
3221
  *
3222
3222
  * @type {string}
3223
- * @memberof DocumentPropertiesBarcode
3223
+ * @memberof DocumentPropertiesBarcodeInner
3224
3224
  */
3225
3225
  'issuing_country'?: string;
3226
3226
  /**
3227
3227
  *
3228
3228
  * @type {string}
3229
- * @memberof DocumentPropertiesBarcode
3229
+ * @memberof DocumentPropertiesBarcodeInner
3230
3230
  */
3231
3231
  'document_number'?: string;
3232
3232
  /**
3233
3233
  *
3234
3234
  * @type {string}
3235
- * @memberof DocumentPropertiesBarcode
3235
+ * @memberof DocumentPropertiesBarcodeInner
3236
3236
  */
3237
3237
  'real_id_classification'?: string;
3238
3238
  }
@@ -4321,10 +4321,10 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4321
4321
  'address_lines'?: DocumentPropertiesAddressLines;
4322
4322
  /**
4323
4323
  *
4324
- * @type {DocumentPropertiesBarcode}
4324
+ * @type {Array<DocumentPropertiesBarcodeInner>}
4325
4325
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4326
4326
  */
4327
- 'barcode'?: DocumentPropertiesBarcode;
4327
+ 'barcode'?: Array<DocumentPropertiesBarcodeInner>;
4328
4328
  /**
4329
4329
  *
4330
4330
  * @type {DocumentPropertiesNfc}
@@ -8072,7 +8072,7 @@ export interface Task {
8072
8072
  */
8073
8073
  'input'?: object;
8074
8074
  /**
8075
- * Output object with the fields produced by the Task execution.
8075
+ * Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
8076
8076
  * @type {object}
8077
8077
  * @memberof Task
8078
8078
  */
@@ -10089,7 +10089,7 @@ export interface WebhookEventPayloadResource {
10089
10089
  */
10090
10090
  'input'?: object;
10091
10091
  /**
10092
- * Output object with the fields produced by the Task execution.
10092
+ * Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
10093
10093
  * @type {object}
10094
10094
  * @memberof WebhookEventPayloadResource
10095
10095
  */
@@ -10125,6 +10125,8 @@ export declare const WebhookEventResourceType: {
10125
10125
  readonly WorkflowRun: "workflow_run";
10126
10126
  readonly WorkflowTask: "workflow_task";
10127
10127
  readonly WatchlistMonitor: "watchlist_monitor";
10128
+ readonly WorkflowTimelineFile: "workflow_timeline_file";
10129
+ readonly WorkflowRunEvidenceFolder: "workflow_run_evidence_folder";
10128
10130
  readonly UnknownDefaultOpenApi: "11184809";
10129
10131
  };
10130
10132
  export type WebhookEventResourceType = typeof WebhookEventResourceType[keyof typeof WebhookEventResourceType];
@@ -10151,6 +10153,7 @@ export declare const WebhookEventType: {
10151
10153
  readonly ReportCompleted: "report.completed";
10152
10154
  readonly WorkflowTimelineFileCreated: "workflow_timeline_file.created";
10153
10155
  readonly WorkflowSignedEvidenceFileCreated: "workflow_signed_evidence_file.created";
10156
+ readonly WorkflowRunEvidenceFolderCreated: "workflow_run_evidence_folder.created";
10154
10157
  readonly UnknownDefaultOpenApi: "11184809";
10155
10158
  };
10156
10159
  export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
package/dist/api.js CHANGED
@@ -750,6 +750,8 @@ exports.WebhookEventResourceType = {
750
750
  WorkflowRun: 'workflow_run',
751
751
  WorkflowTask: 'workflow_task',
752
752
  WatchlistMonitor: 'watchlist_monitor',
753
+ WorkflowTimelineFile: 'workflow_timeline_file',
754
+ WorkflowRunEvidenceFolder: 'workflow_run_evidence_folder',
753
755
  UnknownDefaultOpenApi: '11184809'
754
756
  };
755
757
  /**
@@ -775,6 +777,7 @@ exports.WebhookEventType = {
775
777
  ReportCompleted: 'report.completed',
776
778
  WorkflowTimelineFileCreated: 'workflow_timeline_file.created',
777
779
  WorkflowSignedEvidenceFileCreated: 'workflow_signed_evidence_file.created',
780
+ WorkflowRunEvidenceFolderCreated: 'workflow_run_evidence_folder.created',
778
781
  UnknownDefaultOpenApi: '11184809'
779
782
  };
780
783
  exports.WorkflowRunLinkLanguageEnum = {
@@ -32,7 +32,7 @@ class Configuration {
32
32
  }
33
33
  this.apiKey = 'Token token=' + param.apiToken;
34
34
  this.basePath = param.basePath || base_1.BASE_PATH.replace('.eu.', `.${Region[param.region || Region.EU].toLowerCase()}.`);
35
- 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.2.0' }) });
35
+ 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.4.0' }) });
36
36
  this.formDataCtor = param.formDataCtor || require('form-data'); // Injiect form data constructor (if needed)
37
37
  }
38
38
  /**
package/dist/esm/api.d.ts CHANGED
@@ -3022,10 +3022,10 @@ export interface DocumentProperties {
3022
3022
  'address_lines'?: DocumentPropertiesAddressLines;
3023
3023
  /**
3024
3024
  *
3025
- * @type {DocumentPropertiesBarcode}
3025
+ * @type {Array<DocumentPropertiesBarcodeInner>}
3026
3026
  * @memberof DocumentProperties
3027
3027
  */
3028
- 'barcode'?: DocumentPropertiesBarcode;
3028
+ 'barcode'?: Array<DocumentPropertiesBarcodeInner>;
3029
3029
  /**
3030
3030
  *
3031
3031
  * @type {DocumentPropertiesNfc}
@@ -3124,115 +3124,115 @@ export interface DocumentPropertiesAddressLines {
3124
3124
  /**
3125
3125
  *
3126
3126
  * @export
3127
- * @interface DocumentPropertiesBarcode
3127
+ * @interface DocumentPropertiesBarcodeInner
3128
3128
  */
3129
- export interface DocumentPropertiesBarcode {
3129
+ export interface DocumentPropertiesBarcodeInner {
3130
3130
  /**
3131
3131
  *
3132
3132
  * @type {string}
3133
- * @memberof DocumentPropertiesBarcode
3133
+ * @memberof DocumentPropertiesBarcodeInner
3134
3134
  */
3135
3135
  'first_name'?: string;
3136
3136
  /**
3137
3137
  *
3138
3138
  * @type {string}
3139
- * @memberof DocumentPropertiesBarcode
3139
+ * @memberof DocumentPropertiesBarcodeInner
3140
3140
  */
3141
3141
  'middle_name'?: string;
3142
3142
  /**
3143
3143
  *
3144
3144
  * @type {string}
3145
- * @memberof DocumentPropertiesBarcode
3145
+ * @memberof DocumentPropertiesBarcodeInner
3146
3146
  */
3147
3147
  'last_name'?: string;
3148
3148
  /**
3149
3149
  *
3150
3150
  * @type {string}
3151
- * @memberof DocumentPropertiesBarcode
3151
+ * @memberof DocumentPropertiesBarcodeInner
3152
3152
  */
3153
3153
  'document_type'?: string;
3154
3154
  /**
3155
3155
  *
3156
3156
  * @type {string}
3157
- * @memberof DocumentPropertiesBarcode
3157
+ * @memberof DocumentPropertiesBarcodeInner
3158
3158
  */
3159
3159
  'date_of_expiry'?: string;
3160
3160
  /**
3161
3161
  *
3162
3162
  * @type {string}
3163
- * @memberof DocumentPropertiesBarcode
3163
+ * @memberof DocumentPropertiesBarcodeInner
3164
3164
  */
3165
3165
  'date_of_birth'?: string;
3166
3166
  /**
3167
3167
  *
3168
3168
  * @type {string}
3169
- * @memberof DocumentPropertiesBarcode
3169
+ * @memberof DocumentPropertiesBarcodeInner
3170
3170
  */
3171
3171
  'issuing_date'?: string;
3172
3172
  /**
3173
3173
  *
3174
3174
  * @type {string}
3175
- * @memberof DocumentPropertiesBarcode
3175
+ * @memberof DocumentPropertiesBarcodeInner
3176
3176
  */
3177
3177
  'address_line_1'?: string;
3178
3178
  /**
3179
3179
  *
3180
3180
  * @type {string}
3181
- * @memberof DocumentPropertiesBarcode
3181
+ * @memberof DocumentPropertiesBarcodeInner
3182
3182
  */
3183
3183
  'address_line_2'?: string;
3184
3184
  /**
3185
3185
  *
3186
3186
  * @type {string}
3187
- * @memberof DocumentPropertiesBarcode
3187
+ * @memberof DocumentPropertiesBarcodeInner
3188
3188
  */
3189
3189
  'address_line_3'?: string;
3190
3190
  /**
3191
3191
  *
3192
3192
  * @type {string}
3193
- * @memberof DocumentPropertiesBarcode
3193
+ * @memberof DocumentPropertiesBarcodeInner
3194
3194
  */
3195
3195
  'address_line_4'?: string;
3196
3196
  /**
3197
3197
  *
3198
3198
  * @type {string}
3199
- * @memberof DocumentPropertiesBarcode
3199
+ * @memberof DocumentPropertiesBarcodeInner
3200
3200
  */
3201
3201
  'address_line_5'?: string;
3202
3202
  /**
3203
3203
  *
3204
3204
  * @type {string}
3205
- * @memberof DocumentPropertiesBarcode
3205
+ * @memberof DocumentPropertiesBarcodeInner
3206
3206
  */
3207
3207
  'issuing_state'?: string;
3208
3208
  /**
3209
3209
  *
3210
3210
  * @type {string}
3211
- * @memberof DocumentPropertiesBarcode
3211
+ * @memberof DocumentPropertiesBarcodeInner
3212
3212
  */
3213
3213
  'class'?: string;
3214
3214
  /**
3215
3215
  *
3216
3216
  * @type {string}
3217
- * @memberof DocumentPropertiesBarcode
3217
+ * @memberof DocumentPropertiesBarcodeInner
3218
3218
  */
3219
3219
  'gender'?: string;
3220
3220
  /**
3221
3221
  *
3222
3222
  * @type {string}
3223
- * @memberof DocumentPropertiesBarcode
3223
+ * @memberof DocumentPropertiesBarcodeInner
3224
3224
  */
3225
3225
  'issuing_country'?: string;
3226
3226
  /**
3227
3227
  *
3228
3228
  * @type {string}
3229
- * @memberof DocumentPropertiesBarcode
3229
+ * @memberof DocumentPropertiesBarcodeInner
3230
3230
  */
3231
3231
  'document_number'?: string;
3232
3232
  /**
3233
3233
  *
3234
3234
  * @type {string}
3235
- * @memberof DocumentPropertiesBarcode
3235
+ * @memberof DocumentPropertiesBarcodeInner
3236
3236
  */
3237
3237
  'real_id_classification'?: string;
3238
3238
  }
@@ -4321,10 +4321,10 @@ export interface DocumentWithDriverVerificationReportAllOfProperties {
4321
4321
  'address_lines'?: DocumentPropertiesAddressLines;
4322
4322
  /**
4323
4323
  *
4324
- * @type {DocumentPropertiesBarcode}
4324
+ * @type {Array<DocumentPropertiesBarcodeInner>}
4325
4325
  * @memberof DocumentWithDriverVerificationReportAllOfProperties
4326
4326
  */
4327
- 'barcode'?: DocumentPropertiesBarcode;
4327
+ 'barcode'?: Array<DocumentPropertiesBarcodeInner>;
4328
4328
  /**
4329
4329
  *
4330
4330
  * @type {DocumentPropertiesNfc}
@@ -8072,7 +8072,7 @@ export interface Task {
8072
8072
  */
8073
8073
  'input'?: object;
8074
8074
  /**
8075
- * Output object with the fields produced by the Task execution.
8075
+ * Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
8076
8076
  * @type {object}
8077
8077
  * @memberof Task
8078
8078
  */
@@ -10089,7 +10089,7 @@ export interface WebhookEventPayloadResource {
10089
10089
  */
10090
10090
  'input'?: object;
10091
10091
  /**
10092
- * Output object with the fields produced by the Task execution.
10092
+ * Value field (it can be an Object, List, etc.) with the fields produced by the Task execution.
10093
10093
  * @type {object}
10094
10094
  * @memberof WebhookEventPayloadResource
10095
10095
  */
@@ -10125,6 +10125,8 @@ export declare const WebhookEventResourceType: {
10125
10125
  readonly WorkflowRun: "workflow_run";
10126
10126
  readonly WorkflowTask: "workflow_task";
10127
10127
  readonly WatchlistMonitor: "watchlist_monitor";
10128
+ readonly WorkflowTimelineFile: "workflow_timeline_file";
10129
+ readonly WorkflowRunEvidenceFolder: "workflow_run_evidence_folder";
10128
10130
  readonly UnknownDefaultOpenApi: "11184809";
10129
10131
  };
10130
10132
  export type WebhookEventResourceType = typeof WebhookEventResourceType[keyof typeof WebhookEventResourceType];
@@ -10151,6 +10153,7 @@ export declare const WebhookEventType: {
10151
10153
  readonly ReportCompleted: "report.completed";
10152
10154
  readonly WorkflowTimelineFileCreated: "workflow_timeline_file.created";
10153
10155
  readonly WorkflowSignedEvidenceFileCreated: "workflow_signed_evidence_file.created";
10156
+ readonly WorkflowRunEvidenceFolderCreated: "workflow_run_evidence_folder.created";
10154
10157
  readonly UnknownDefaultOpenApi: "11184809";
10155
10158
  };
10156
10159
  export type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
package/dist/esm/api.js CHANGED
@@ -746,6 +746,8 @@ export const WebhookEventResourceType = {
746
746
  WorkflowRun: 'workflow_run',
747
747
  WorkflowTask: 'workflow_task',
748
748
  WatchlistMonitor: 'watchlist_monitor',
749
+ WorkflowTimelineFile: 'workflow_timeline_file',
750
+ WorkflowRunEvidenceFolder: 'workflow_run_evidence_folder',
749
751
  UnknownDefaultOpenApi: '11184809'
750
752
  };
751
753
  /**
@@ -771,6 +773,7 @@ export const WebhookEventType = {
771
773
  ReportCompleted: 'report.completed',
772
774
  WorkflowTimelineFileCreated: 'workflow_timeline_file.created',
773
775
  WorkflowSignedEvidenceFileCreated: 'workflow_signed_evidence_file.created',
776
+ WorkflowRunEvidenceFolderCreated: 'workflow_run_evidence_folder.created',
774
777
  UnknownDefaultOpenApi: '11184809'
775
778
  };
776
779
  export const WorkflowRunLinkLanguageEnum = {
@@ -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/4.2.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.4.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": "4.2.0",
3
+ "version": "4.4.0",
4
4
  "description": "Node.js library for the Onfido API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {