humanos 1.0.1

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.
Files changed (89) hide show
  1. package/README.md +246 -0
  2. package/dist/index.d.mts +3898 -0
  3. package/dist/index.d.ts +3898 -0
  4. package/dist/index.js +1526 -0
  5. package/dist/index.mjs +1437 -0
  6. package/generated/.openapi-generator/FILES +82 -0
  7. package/generated/.openapi-generator/VERSION +1 -0
  8. package/generated/.openapi-generator-ignore +23 -0
  9. package/generated/README.md +46 -0
  10. package/generated/api/credentials-api.ts +148 -0
  11. package/generated/api/requests-api.ts +577 -0
  12. package/generated/api/resource-api.ts +318 -0
  13. package/generated/api/user-api.ts +241 -0
  14. package/generated/api/webhooks-api.ts +352 -0
  15. package/generated/api.ts +21 -0
  16. package/generated/base.ts +86 -0
  17. package/generated/common.ts +150 -0
  18. package/generated/configuration.ts +110 -0
  19. package/generated/git_push.sh +57 -0
  20. package/generated/index.ts +18 -0
  21. package/generated/models/action-type.ts +33 -0
  22. package/generated/models/agent-detail-entity.ts +36 -0
  23. package/generated/models/cancel-request404-response.ts +42 -0
  24. package/generated/models/create-subject-dto.ts +45 -0
  25. package/generated/models/create-subject-entity.ts +59 -0
  26. package/generated/models/credential-dto.ts +57 -0
  27. package/generated/models/credential-entity.ts +64 -0
  28. package/generated/models/credential-event-user.ts +42 -0
  29. package/generated/models/credential-event.ts +94 -0
  30. package/generated/models/credential-full-entity.ts +82 -0
  31. package/generated/models/credential-status.ts +33 -0
  32. package/generated/models/credential-subject.ts +39 -0
  33. package/generated/models/delivery-action-type.ts +31 -0
  34. package/generated/models/generate-credential-entity.ts +42 -0
  35. package/generated/models/generate-request-dto.ts +106 -0
  36. package/generated/models/generate-request-entity.ts +48 -0
  37. package/generated/models/generate-subject-entity.ts +48 -0
  38. package/generated/models/generate400-response.ts +42 -0
  39. package/generated/models/get-credential-entity.ts +48 -0
  40. package/generated/models/get-credential404-response.ts +42 -0
  41. package/generated/models/get-request-detail404-response.ts +42 -0
  42. package/generated/models/get-subject400-response.ts +42 -0
  43. package/generated/models/get-subject404-response.ts +42 -0
  44. package/generated/models/group-entity.ts +63 -0
  45. package/generated/models/group-resource-entity.ts +64 -0
  46. package/generated/models/groups-entity.ts +39 -0
  47. package/generated/models/identity-dto.ts +132 -0
  48. package/generated/models/identity-event-decision.ts +48 -0
  49. package/generated/models/identity-event-identity.ts +84 -0
  50. package/generated/models/identity-event.ts +94 -0
  51. package/generated/models/identity-field-placement.ts +73 -0
  52. package/generated/models/identity-field-type.ts +38 -0
  53. package/generated/models/index.ts +64 -0
  54. package/generated/models/issuer-detail-entity.ts +36 -0
  55. package/generated/models/mandate-data-dto-type.ts +73 -0
  56. package/generated/models/mandate-data-dto-value.ts +24 -0
  57. package/generated/models/mandate-data-dto.ts +71 -0
  58. package/generated/models/mandate-data-type.ts +37 -0
  59. package/generated/models/otp-failed-event-otp-error.ts +36 -0
  60. package/generated/models/otp-failed-event-otp.ts +39 -0
  61. package/generated/models/otp-failed-event.ts +85 -0
  62. package/generated/models/request-detail-entity.ts +94 -0
  63. package/generated/models/request-entity.ts +94 -0
  64. package/generated/models/request-query.ts +100 -0
  65. package/generated/models/request-subject-entity.ts +48 -0
  66. package/generated/models/requests-entity.ts +39 -0
  67. package/generated/models/resource-entity.ts +94 -0
  68. package/generated/models/resource-query.ts +70 -0
  69. package/generated/models/resources-entity.ts +39 -0
  70. package/generated/models/signature-placement-item-dto.ts +72 -0
  71. package/generated/models/signature-placement.ts +56 -0
  72. package/generated/models/subject-contact-entity.ts +42 -0
  73. package/generated/models/subject-entity.ts +48 -0
  74. package/generated/models/subject-query.ts +42 -0
  75. package/generated/models/subject.ts +42 -0
  76. package/generated/models/success-entity.ts +30 -0
  77. package/generated/models/test-event.ts +82 -0
  78. package/generated/models/w3-cproof.ts +82 -0
  79. package/generated/models/w3-cverifiable-credential.ts +90 -0
  80. package/generated/models/webhook-call-event.ts +56 -0
  81. package/generated/models/webhook-event-type-credential.ts +30 -0
  82. package/generated/models/webhook-event-type-identity.ts +30 -0
  83. package/generated/models/webhook-event-type-otpfailed.ts +30 -0
  84. package/generated/models/webhook-event-type-test.ts +30 -0
  85. package/generated/models/webhook-event-type.ts +33 -0
  86. package/generated/package.json +33 -0
  87. package/generated/tsconfig.esm.json +7 -0
  88. package/generated/tsconfig.json +18 -0
  89. package/package.json +68 -0
@@ -0,0 +1,3898 @@
1
+ import * as axios from 'axios';
2
+ import axios__default, { AxiosInstance, RawAxiosRequestConfig, AxiosPromise, InternalAxiosRequestConfig } from 'axios';
3
+
4
+ /**
5
+ * Humanos API
6
+ * Humanos API
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ interface ConfigurationParameters {
16
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
17
+ username?: string;
18
+ password?: string;
19
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
20
+ basePath?: string;
21
+ serverIndex?: number;
22
+ baseOptions?: any;
23
+ formDataCtor?: new () => any;
24
+ }
25
+ declare class Configuration {
26
+ /**
27
+ * parameter for apiKey security
28
+ * @param name security name
29
+ * @memberof Configuration
30
+ */
31
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
32
+ /**
33
+ * parameter for basic security
34
+ *
35
+ * @type {string}
36
+ * @memberof Configuration
37
+ */
38
+ username?: string;
39
+ /**
40
+ * parameter for basic security
41
+ *
42
+ * @type {string}
43
+ * @memberof Configuration
44
+ */
45
+ password?: string;
46
+ /**
47
+ * parameter for oauth2 security
48
+ * @param name security name
49
+ * @param scopes oauth2 scope
50
+ * @memberof Configuration
51
+ */
52
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
53
+ /**
54
+ * override base path
55
+ *
56
+ * @type {string}
57
+ * @memberof Configuration
58
+ */
59
+ basePath?: string;
60
+ /**
61
+ * override server index
62
+ *
63
+ * @type {number}
64
+ * @memberof Configuration
65
+ */
66
+ serverIndex?: number;
67
+ /**
68
+ * base options for axios calls
69
+ *
70
+ * @type {any}
71
+ * @memberof Configuration
72
+ */
73
+ baseOptions?: any;
74
+ /**
75
+ * The FormData constructor that will be used to create multipart form data
76
+ * requests. You can inject this here so that execution environments that
77
+ * do not support the FormData class can still run the generated client.
78
+ *
79
+ * @type {new () => FormData}
80
+ */
81
+ formDataCtor?: new () => any;
82
+ constructor(param?: ConfigurationParameters);
83
+ /**
84
+ * Check if the given MIME is a JSON MIME.
85
+ * JSON MIME examples:
86
+ * application/json
87
+ * application/json; charset=UTF8
88
+ * APPLICATION/JSON
89
+ * application/vnd.company+json
90
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
91
+ * @return True if the given MIME is JSON, false otherwise.
92
+ */
93
+ isJsonMime(mime: string): boolean;
94
+ }
95
+
96
+ /**
97
+ * Humanos API
98
+ * Humanos API
99
+ *
100
+ * The version of the OpenAPI document: 1.0
101
+ *
102
+ *
103
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
104
+ * https://openapi-generator.tech
105
+ * Do not edit the class manually.
106
+ */
107
+
108
+ /**
109
+ *
110
+ * @export
111
+ * @interface RequestArgs
112
+ */
113
+ interface RequestArgs {
114
+ url: string;
115
+ options: RawAxiosRequestConfig;
116
+ }
117
+ /**
118
+ *
119
+ * @export
120
+ * @class BaseAPI
121
+ */
122
+ declare class BaseAPI {
123
+ protected basePath: string;
124
+ protected axios: AxiosInstance;
125
+ protected configuration: Configuration | undefined;
126
+ constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
127
+ }
128
+
129
+ /**
130
+ * Humanos API
131
+ * Humanos API
132
+ *
133
+ * The version of the OpenAPI document: 1.0
134
+ *
135
+ *
136
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
137
+ * https://openapi-generator.tech
138
+ * Do not edit the class manually.
139
+ */
140
+ /**
141
+ *
142
+ * @export
143
+ * @enum {string}
144
+ */
145
+ declare const ActionType: {
146
+ readonly Issue: "ISSUE";
147
+ readonly Accept: "ACCEPT";
148
+ readonly Reject: "REJECT";
149
+ readonly Revoke: "REVOKE";
150
+ };
151
+ type ActionType = typeof ActionType[keyof typeof ActionType];
152
+
153
+ /**
154
+ * Humanos API
155
+ * Humanos API
156
+ *
157
+ * The version of the OpenAPI document: 1.0
158
+ *
159
+ *
160
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
161
+ * https://openapi-generator.tech
162
+ * Do not edit the class manually.
163
+ */
164
+ /**
165
+ *
166
+ * @export
167
+ * @interface AgentDetailEntity
168
+ */
169
+ interface AgentDetailEntity {
170
+ /**
171
+ * Name of the agent
172
+ * @type {string}
173
+ * @memberof AgentDetailEntity
174
+ */
175
+ 'name'?: string;
176
+ /**
177
+ * Public Decentralized Identifier (DID) of the agent
178
+ * @type {string}
179
+ * @memberof AgentDetailEntity
180
+ */
181
+ 'did': string;
182
+ }
183
+
184
+ /**
185
+ * Humanos API
186
+ * Humanos API
187
+ *
188
+ * The version of the OpenAPI document: 1.0
189
+ *
190
+ *
191
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
192
+ * https://openapi-generator.tech
193
+ * Do not edit the class manually.
194
+ */
195
+ /**
196
+ *
197
+ * @export
198
+ * @interface CancelRequest404Response
199
+ */
200
+ interface CancelRequest404Response {
201
+ /**
202
+ *
203
+ * @type {number}
204
+ * @memberof CancelRequest404Response
205
+ */
206
+ 'statusCode'?: number;
207
+ /**
208
+ *
209
+ * @type {string}
210
+ * @memberof CancelRequest404Response
211
+ */
212
+ 'message'?: string;
213
+ /**
214
+ *
215
+ * @type {string}
216
+ * @memberof CancelRequest404Response
217
+ */
218
+ 'error'?: string;
219
+ }
220
+
221
+ /**
222
+ * Humanos API
223
+ * Humanos API
224
+ *
225
+ * The version of the OpenAPI document: 1.0
226
+ *
227
+ *
228
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
229
+ * https://openapi-generator.tech
230
+ * Do not edit the class manually.
231
+ */
232
+ /**
233
+ *
234
+ * @export
235
+ * @interface IdentityDto
236
+ */
237
+ interface IdentityDto {
238
+ /**
239
+ * Full name of the person
240
+ * @type {string}
241
+ * @memberof IdentityDto
242
+ */
243
+ 'fullName': string;
244
+ /**
245
+ * Birth date. Must be a valid date in the past.
246
+ * @type {string}
247
+ * @memberof IdentityDto
248
+ */
249
+ 'birth': string;
250
+ /**
251
+ * Document ID number
252
+ * @type {string}
253
+ * @memberof IdentityDto
254
+ */
255
+ 'docId': string;
256
+ /**
257
+ * Full document ID (extended version). Must start with docId and contain additional characters.
258
+ * @type {string}
259
+ * @memberof IdentityDto
260
+ */
261
+ 'fullDocId'?: string;
262
+ /**
263
+ * 3-letter ISO 3166-1 alpha-3 country code (e.g., PRT, USA, GBR). Must be exactly 3 characters. Spaces will be automatically removed.
264
+ * @type {string}
265
+ * @memberof IdentityDto
266
+ */
267
+ 'countryAlpha3': string;
268
+ /**
269
+ * Male (M), Female (F), Other (O)
270
+ * @type {string}
271
+ * @memberof IdentityDto
272
+ */
273
+ 'gender'?: string;
274
+ /**
275
+ * Document expiration date. Format: YYYY-MM-DD or ISO 8601.
276
+ * @type {string}
277
+ * @memberof IdentityDto
278
+ */
279
+ 'expiresAt'?: string;
280
+ /**
281
+ * Document issue date. Format: YYYY-MM-DD or ISO 8601.
282
+ * @type {string}
283
+ * @memberof IdentityDto
284
+ */
285
+ 'issueDate'?: string;
286
+ /**
287
+ * Tax identification number.
288
+ * @type {string}
289
+ * @memberof IdentityDto
290
+ */
291
+ 'taxNumber'?: string;
292
+ /**
293
+ * Health insurance number
294
+ * @type {string}
295
+ * @memberof IdentityDto
296
+ */
297
+ 'healthNumber'?: string;
298
+ /**
299
+ * Social security number
300
+ * @type {string}
301
+ * @memberof IdentityDto
302
+ */
303
+ 'socialSecurityNumber'?: string;
304
+ /**
305
+ * Photo of the person (base64 encoded or URL).
306
+ * @type {string}
307
+ * @memberof IdentityDto
308
+ */
309
+ 'photo'?: string;
310
+ /**
311
+ * Height of the person in centimeters Will filter numbers only
312
+ * @type {string}
313
+ * @memberof IdentityDto
314
+ */
315
+ 'height'?: string;
316
+ /**
317
+ * Type of document (e.g., passport, ID card, driver license). Maximum 50 characters.
318
+ * @type {string}
319
+ * @memberof IdentityDto
320
+ */
321
+ 'documentType'?: string;
322
+ /**
323
+ * Document discriminator
324
+ * @type {string}
325
+ * @memberof IdentityDto
326
+ */
327
+ 'documentDiscriminator'?: string;
328
+ /**
329
+ * Place of birth. Maximum 50 characters.
330
+ * @type {string}
331
+ * @memberof IdentityDto
332
+ */
333
+ 'placeOfBirth'?: string;
334
+ /**
335
+ * Machine Readable Zone (MRZ) text from the document. Maximum 2000 characters.
336
+ * @type {string}
337
+ * @memberof IdentityDto
338
+ */
339
+ 'mrzText'?: string;
340
+ /**
341
+ * Additional extra information in JSON format. Maximum 2000 characters.
342
+ * @type {string}
343
+ * @memberof IdentityDto
344
+ */
345
+ 'extra'?: string;
346
+ }
347
+
348
+ /**
349
+ * Humanos API
350
+ * Humanos API
351
+ *
352
+ * The version of the OpenAPI document: 1.0
353
+ *
354
+ *
355
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
356
+ * https://openapi-generator.tech
357
+ * Do not edit the class manually.
358
+ */
359
+
360
+ /**
361
+ *
362
+ * @export
363
+ * @interface CreateSubjectDto
364
+ */
365
+ interface CreateSubjectDto {
366
+ /**
367
+ * Contact value (email or phone)
368
+ * @type {string}
369
+ * @memberof CreateSubjectDto
370
+ */
371
+ 'contact': string;
372
+ /**
373
+ * Identifier to help you identify the user in your own system. We recommend using a unique value.
374
+ * @type {string}
375
+ * @memberof CreateSubjectDto
376
+ */
377
+ 'internalId'?: string;
378
+ /**
379
+ * Identity information to be assigned to the user
380
+ * @type {IdentityDto}
381
+ * @memberof CreateSubjectDto
382
+ */
383
+ 'identity'?: IdentityDto;
384
+ }
385
+
386
+ /**
387
+ * Humanos API
388
+ * Humanos API
389
+ *
390
+ * The version of the OpenAPI document: 1.0
391
+ *
392
+ *
393
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
394
+ * https://openapi-generator.tech
395
+ * Do not edit the class manually.
396
+ */
397
+ /**
398
+ *
399
+ * @export
400
+ * @interface Subject
401
+ */
402
+ interface Subject {
403
+ /**
404
+ * Contact value (email or phone)
405
+ * @type {string}
406
+ * @memberof Subject
407
+ */
408
+ 'contact': string;
409
+ /**
410
+ * Public Decentralized Identifier (DID) of the user
411
+ * @type {string}
412
+ * @memberof Subject
413
+ */
414
+ 'did'?: string;
415
+ /**
416
+ * Identifier to help you identify the user in your own system. We recommend using a unique value.
417
+ * @type {string}
418
+ * @memberof Subject
419
+ */
420
+ 'internalId'?: string;
421
+ }
422
+
423
+ /**
424
+ * Humanos API
425
+ * Humanos API
426
+ *
427
+ * The version of the OpenAPI document: 1.0
428
+ *
429
+ *
430
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
431
+ * https://openapi-generator.tech
432
+ * Do not edit the class manually.
433
+ */
434
+
435
+ /**
436
+ *
437
+ * @export
438
+ * @interface CreateSubjectEntity
439
+ */
440
+ interface CreateSubjectEntity {
441
+ /**
442
+ * HTTP status code indicating the result of the operation for this specific subject: - 200: Success - 201: Success, but nothing was updated - 400: Invalid body payload. Information will be at the message field - 402: Invalid identity due to invalid countryAlpha3 - 407: This call contained this contact more than once - 408: This call contained this identity more than once - 409: Duplicate Identity - 410: Duplicate Identity. This user already has an identity with this countryAlpha3
443
+ * @type {number}
444
+ * @memberof CreateSubjectEntity
445
+ */
446
+ 'status': CreateSubjectEntityStatusEnum;
447
+ /**
448
+ * Success or error message
449
+ * @type {string}
450
+ * @memberof CreateSubjectEntity
451
+ */
452
+ 'message': string;
453
+ /**
454
+ * User information. Will just contain the contact if the operation fails
455
+ * @type {Subject}
456
+ * @memberof CreateSubjectEntity
457
+ */
458
+ 'user': Subject;
459
+ }
460
+ declare const CreateSubjectEntityStatusEnum: {
461
+ readonly NUMBER_200: 200;
462
+ readonly NUMBER_201: 201;
463
+ readonly NUMBER_400: 400;
464
+ readonly NUMBER_402: 402;
465
+ readonly NUMBER_407: 407;
466
+ readonly NUMBER_408: 408;
467
+ readonly NUMBER_409: 409;
468
+ readonly NUMBER_410: 410;
469
+ };
470
+ type CreateSubjectEntityStatusEnum = typeof CreateSubjectEntityStatusEnum[keyof typeof CreateSubjectEntityStatusEnum];
471
+
472
+ /**
473
+ * Humanos API
474
+ * Humanos API
475
+ *
476
+ * The version of the OpenAPI document: 1.0
477
+ *
478
+ *
479
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
480
+ * https://openapi-generator.tech
481
+ * Do not edit the class manually.
482
+ */
483
+ /**
484
+ * The actual value for this credential data item. Format depends on `type`: use a string for consent text or base64 PDF, or an object for form configuration. Shown to the subject when not hidden.
485
+ * @export
486
+ * @interface MandateDataDtoValue
487
+ */
488
+ interface MandateDataDtoValue {
489
+ }
490
+
491
+ /**
492
+ * Humanos API
493
+ * Humanos API
494
+ *
495
+ * The version of the OpenAPI document: 1.0
496
+ *
497
+ *
498
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
499
+ * https://openapi-generator.tech
500
+ * Do not edit the class manually.
501
+ */
502
+
503
+ /**
504
+ *
505
+ * @export
506
+ * @interface MandateDataDto
507
+ */
508
+ interface MandateDataDto {
509
+ /**
510
+ * Display name for this data field (e.g. \"Identity document\", \"Consent statement\"). Shown in the UI and in signatures.
511
+ * @type {string}
512
+ * @memberof MandateDataDto
513
+ */
514
+ 'label': string;
515
+ /**
516
+ * Type of the data. - pdf: the value must be a base64 string of the pdf file - url: must be a url string - string: must be a string - number: must be a number - boolean: must be a boolean - date: must be a date - object: must be an object - array: must be an array
517
+ * @type {string}
518
+ * @memberof MandateDataDto
519
+ */
520
+ 'type': MandateDataDtoTypeEnum;
521
+ /**
522
+ *
523
+ * @type {MandateDataDtoValue}
524
+ * @memberof MandateDataDto
525
+ */
526
+ 'value': MandateDataDtoValue;
527
+ /**
528
+ * Whether to display the field to the subject and to be included in the signatures generated
529
+ * @type {boolean}
530
+ * @memberof MandateDataDto
531
+ */
532
+ 'hidden'?: boolean;
533
+ /**
534
+ * Nested fields for object types. Each element has the same structure as MandateDataDto.
535
+ * @type {Array<object>}
536
+ * @memberof MandateDataDto
537
+ */
538
+ 'fields'?: Array<object>;
539
+ }
540
+ declare const MandateDataDtoTypeEnum: {
541
+ readonly String: "string";
542
+ readonly Number: "number";
543
+ readonly Boolean: "boolean";
544
+ readonly Object: "object";
545
+ readonly Array: "array";
546
+ readonly Date: "date";
547
+ readonly Pdf: "pdf";
548
+ readonly Url: "url";
549
+ };
550
+ type MandateDataDtoTypeEnum = typeof MandateDataDtoTypeEnum[keyof typeof MandateDataDtoTypeEnum];
551
+
552
+ /**
553
+ * Humanos API
554
+ * Humanos API
555
+ *
556
+ * The version of the OpenAPI document: 1.0
557
+ *
558
+ *
559
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
560
+ * https://openapi-generator.tech
561
+ * Do not edit the class manually.
562
+ */
563
+
564
+ /**
565
+ *
566
+ * @export
567
+ * @interface CredentialDto
568
+ */
569
+ interface CredentialDto {
570
+ /**
571
+ * The scope of a credential is used to identify the context of the credential
572
+ * @type {string}
573
+ * @memberof CredentialDto
574
+ */
575
+ 'scope': string;
576
+ /**
577
+ * The type of the credential, can help categorize credentials. General methods should use the type JSON - Type JSON is recommended for general use. - Type DOCUMENT should include the following unhidden fields: { label: \"display name\", type: \"pdf\" } - Type CONSENT should include the following unhidden fields: { label: \"display name\", type: \"url\" }, { label: \"text\", type: \"string\" }
578
+ * @type {string}
579
+ * @memberof CredentialDto
580
+ */
581
+ 'type': string;
582
+ /**
583
+ * Name of the credential
584
+ * @type {string}
585
+ * @memberof CredentialDto
586
+ */
587
+ 'name': string;
588
+ /**
589
+ * Identifier to help you identify the credential in your own system. We recommend using a unique value.
590
+ * @type {string}
591
+ * @memberof CredentialDto
592
+ */
593
+ 'internalId'?: string;
594
+ /**
595
+ * Data associated with the credential
596
+ * @type {Array<MandateDataDto>}
597
+ * @memberof CredentialDto
598
+ */
599
+ 'data': Array<MandateDataDto>;
600
+ }
601
+
602
+ /**
603
+ * Humanos API
604
+ * Humanos API
605
+ *
606
+ * The version of the OpenAPI document: 1.0
607
+ *
608
+ *
609
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
610
+ * https://openapi-generator.tech
611
+ * Do not edit the class manually.
612
+ */
613
+ /**
614
+ *
615
+ * @export
616
+ * @interface CredentialEntity
617
+ */
618
+ interface CredentialEntity {
619
+ /**
620
+ * Unique identifier for the created credential
621
+ * @type {string}
622
+ * @memberof CredentialEntity
623
+ */
624
+ 'id': string;
625
+ /**
626
+ * Name of the credential
627
+ * @type {string}
628
+ * @memberof CredentialEntity
629
+ */
630
+ 'name'?: string;
631
+ /**
632
+ * Identifier to help you identify the credential in your own system. We recommend using a unique value.
633
+ * @type {string}
634
+ * @memberof CredentialEntity
635
+ */
636
+ 'internalId'?: string;
637
+ /**
638
+ * Type of resource for this credential (e.g., DOCUMENT, CONSENT, FORM)
639
+ * @type {string}
640
+ * @memberof CredentialEntity
641
+ */
642
+ 'resourceType': string;
643
+ /**
644
+ * Status of the credential
645
+ * @type {string}
646
+ * @memberof CredentialEntity
647
+ */
648
+ 'status': CredentialEntityStatusEnum;
649
+ }
650
+ declare const CredentialEntityStatusEnum: {
651
+ readonly Pending: "PENDING";
652
+ readonly Approved: "APPROVED";
653
+ readonly Rejected: "REJECTED";
654
+ readonly Revoked: "REVOKED";
655
+ };
656
+ type CredentialEntityStatusEnum = typeof CredentialEntityStatusEnum[keyof typeof CredentialEntityStatusEnum];
657
+
658
+ /**
659
+ * Humanos API
660
+ * Humanos API
661
+ *
662
+ * The version of the OpenAPI document: 1.0
663
+ *
664
+ *
665
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
666
+ * https://openapi-generator.tech
667
+ * Do not edit the class manually.
668
+ */
669
+ /**
670
+ *
671
+ * @export
672
+ * @interface CredentialEventUser
673
+ */
674
+ interface CredentialEventUser {
675
+ /**
676
+ *
677
+ * @type {string}
678
+ * @memberof CredentialEventUser
679
+ */
680
+ 'contact': string;
681
+ /**
682
+ *
683
+ * @type {string}
684
+ * @memberof CredentialEventUser
685
+ */
686
+ 'did': string;
687
+ /**
688
+ *
689
+ * @type {string}
690
+ * @memberof CredentialEventUser
691
+ */
692
+ 'internalId'?: string;
693
+ }
694
+
695
+ /**
696
+ * Humanos API
697
+ * Humanos API
698
+ *
699
+ * The version of the OpenAPI document: 1.0
700
+ *
701
+ *
702
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
703
+ * https://openapi-generator.tech
704
+ * Do not edit the class manually.
705
+ */
706
+ /**
707
+ *
708
+ * @export
709
+ * @interface W3CProof
710
+ */
711
+ interface W3CProof {
712
+ /**
713
+ * Type of the proof
714
+ * @type {string}
715
+ * @memberof W3CProof
716
+ */
717
+ 'type': string;
718
+ /**
719
+ * Cryptosuite of the proof
720
+ * @type {string}
721
+ * @memberof W3CProof
722
+ */
723
+ 'cryptosuite': string;
724
+ /**
725
+ * Proof purpose of the proof
726
+ * @type {string}
727
+ * @memberof W3CProof
728
+ */
729
+ 'proofPurpose': string;
730
+ /**
731
+ * Verification method of the proof
732
+ * @type {string}
733
+ * @memberof W3CProof
734
+ */
735
+ 'verificationMethod': string;
736
+ /**
737
+ * Resulting value of signing the w3cCredential
738
+ * @type {string}
739
+ * @memberof W3CProof
740
+ */
741
+ 'proofValue': string;
742
+ /**
743
+ * Action type of the proof Contacts can ACCEPT, REJECT or REVOKE a credential. Issuer always has actionType ActionTypeEnum.ISSUE.
744
+ * @type {string}
745
+ * @memberof W3CProof
746
+ */
747
+ 'actionType': W3CProofActionTypeEnum;
748
+ /**
749
+ * Hash of the action type and the proofValue. Calculated by keccak256(toUtf8Bytes(proofValue.actionType))`
750
+ * @type {string}
751
+ * @memberof W3CProof
752
+ */
753
+ 'actionProof': string;
754
+ /**
755
+ * Created at date of the proof
756
+ * @type {string}
757
+ * @memberof W3CProof
758
+ */
759
+ 'createdAt': string;
760
+ }
761
+ declare const W3CProofActionTypeEnum: {
762
+ readonly Issue: "ISSUE";
763
+ readonly Accept: "ACCEPT";
764
+ readonly Reject: "REJECT";
765
+ readonly Revoke: "REVOKE";
766
+ };
767
+ type W3CProofActionTypeEnum = typeof W3CProofActionTypeEnum[keyof typeof W3CProofActionTypeEnum];
768
+
769
+ /**
770
+ * Humanos API
771
+ * Humanos API
772
+ *
773
+ * The version of the OpenAPI document: 1.0
774
+ *
775
+ *
776
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
777
+ * https://openapi-generator.tech
778
+ * Do not edit the class manually.
779
+ */
780
+
781
+ /**
782
+ *
783
+ * @export
784
+ * @interface CredentialFullEntity
785
+ */
786
+ interface CredentialFullEntity {
787
+ /**
788
+ * Unique identifier for the created credential
789
+ * @type {string}
790
+ * @memberof CredentialFullEntity
791
+ */
792
+ 'id': string;
793
+ /**
794
+ * Name of the credential
795
+ * @type {string}
796
+ * @memberof CredentialFullEntity
797
+ */
798
+ 'name'?: string;
799
+ /**
800
+ * Identifier to help you identify the credential in your own system. We recommend using a unique value.
801
+ * @type {string}
802
+ * @memberof CredentialFullEntity
803
+ */
804
+ 'internalId'?: string;
805
+ /**
806
+ * Type of resource for this credential (e.g., DOCUMENT, CONSENT, FORM)
807
+ * @type {string}
808
+ * @memberof CredentialFullEntity
809
+ */
810
+ 'resourceType': string;
811
+ /**
812
+ * Status of the credential
813
+ * @type {string}
814
+ * @memberof CredentialFullEntity
815
+ */
816
+ 'status': CredentialFullEntityStatusEnum;
817
+ /**
818
+ * Cryptographic proof(s) for the credential
819
+ * @type {Array<W3CProof>}
820
+ * @memberof CredentialFullEntity
821
+ */
822
+ 'proofs': Array<W3CProof>;
823
+ /**
824
+ * Raw mandate data array containing the credential field values.
825
+ * @type {Array<MandateDataDto>}
826
+ * @memberof CredentialFullEntity
827
+ */
828
+ 'data': Array<MandateDataDto>;
829
+ }
830
+ declare const CredentialFullEntityStatusEnum: {
831
+ readonly Pending: "PENDING";
832
+ readonly Approved: "APPROVED";
833
+ readonly Rejected: "REJECTED";
834
+ readonly Revoked: "REVOKED";
835
+ };
836
+ type CredentialFullEntityStatusEnum = typeof CredentialFullEntityStatusEnum[keyof typeof CredentialFullEntityStatusEnum];
837
+
838
+ /**
839
+ * Humanos API
840
+ * Humanos API
841
+ *
842
+ * The version of the OpenAPI document: 1.0
843
+ *
844
+ *
845
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
846
+ * https://openapi-generator.tech
847
+ * Do not edit the class manually.
848
+ */
849
+ /**
850
+ *
851
+ * @export
852
+ * @enum {string}
853
+ */
854
+ declare const DeliveryActionType: {
855
+ readonly Accept: "accept";
856
+ readonly Reject: "reject";
857
+ };
858
+ type DeliveryActionType = typeof DeliveryActionType[keyof typeof DeliveryActionType];
859
+
860
+ /**
861
+ * Humanos API
862
+ * Humanos API
863
+ *
864
+ * The version of the OpenAPI document: 1.0
865
+ *
866
+ *
867
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
868
+ * https://openapi-generator.tech
869
+ * Do not edit the class manually.
870
+ */
871
+ /**
872
+ *
873
+ * @export
874
+ * @enum {string}
875
+ */
876
+ declare const WebhookEventTypeCREDENTIAL: {
877
+ readonly Credential: "credential";
878
+ };
879
+ type WebhookEventTypeCREDENTIAL = typeof WebhookEventTypeCREDENTIAL[keyof typeof WebhookEventTypeCREDENTIAL];
880
+
881
+ /**
882
+ * Humanos API
883
+ * Humanos API
884
+ *
885
+ * The version of the OpenAPI document: 1.0
886
+ *
887
+ *
888
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
889
+ * https://openapi-generator.tech
890
+ * Do not edit the class manually.
891
+ */
892
+
893
+ /**
894
+ *
895
+ * @export
896
+ * @interface CredentialEvent
897
+ */
898
+ interface CredentialEvent {
899
+ [key: string]: any;
900
+ /**
901
+ *
902
+ * @type {WebhookEventTypeCREDENTIAL}
903
+ * @memberof CredentialEvent
904
+ */
905
+ 'eventType': WebhookEventTypeCREDENTIAL;
906
+ /**
907
+ *
908
+ * @type {string}
909
+ * @memberof CredentialEvent
910
+ */
911
+ 'requestId': string;
912
+ /**
913
+ *
914
+ * @type {string}
915
+ * @memberof CredentialEvent
916
+ */
917
+ 'internalId'?: string;
918
+ /**
919
+ *
920
+ * @type {string}
921
+ * @memberof CredentialEvent
922
+ */
923
+ 'issuerDid': string;
924
+ /**
925
+ *
926
+ * @type {CredentialEventUser}
927
+ * @memberof CredentialEvent
928
+ */
929
+ 'user': CredentialEventUser;
930
+ /**
931
+ *
932
+ * @type {string}
933
+ * @memberof CredentialEvent
934
+ */
935
+ 'decisionDate': string;
936
+ /**
937
+ *
938
+ * @type {string}
939
+ * @memberof CredentialEvent
940
+ */
941
+ 'api_version'?: string;
942
+ /**
943
+ *
944
+ * @type {DeliveryActionType}
945
+ * @memberof CredentialEvent
946
+ */
947
+ 'action': DeliveryActionType;
948
+ /**
949
+ *
950
+ * @type {CredentialFullEntity}
951
+ * @memberof CredentialEvent
952
+ */
953
+ 'credential': CredentialFullEntity;
954
+ }
955
+
956
+ /**
957
+ * Humanos API
958
+ * Humanos API
959
+ *
960
+ * The version of the OpenAPI document: 1.0
961
+ *
962
+ *
963
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
964
+ * https://openapi-generator.tech
965
+ * Do not edit the class manually.
966
+ */
967
+ /**
968
+ *
969
+ * @export
970
+ * @enum {string}
971
+ */
972
+ declare const CredentialStatus: {
973
+ readonly Pending: "PENDING";
974
+ readonly Approved: "APPROVED";
975
+ readonly Rejected: "REJECTED";
976
+ readonly Revoked: "REVOKED";
977
+ };
978
+ type CredentialStatus = typeof CredentialStatus[keyof typeof CredentialStatus];
979
+
980
+ /**
981
+ * Humanos API
982
+ * Humanos API
983
+ *
984
+ * The version of the OpenAPI document: 1.0
985
+ *
986
+ *
987
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
988
+ * https://openapi-generator.tech
989
+ * Do not edit the class manually.
990
+ */
991
+
992
+ /**
993
+ *
994
+ * @export
995
+ * @interface CredentialSubject
996
+ */
997
+ interface CredentialSubject {
998
+ /**
999
+ * Public Decentralized Identifier (DID) of the user
1000
+ * @type {string}
1001
+ * @memberof CredentialSubject
1002
+ */
1003
+ 'id': string;
1004
+ /**
1005
+ * Data of the credential subject
1006
+ * @type {Array<MandateDataDto>}
1007
+ * @memberof CredentialSubject
1008
+ */
1009
+ 'data': Array<MandateDataDto>;
1010
+ }
1011
+
1012
+ /**
1013
+ * Humanos API
1014
+ * Humanos API
1015
+ *
1016
+ * The version of the OpenAPI document: 1.0
1017
+ *
1018
+ *
1019
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1020
+ * https://openapi-generator.tech
1021
+ * Do not edit the class manually.
1022
+ */
1023
+ /**
1024
+ *
1025
+ * @export
1026
+ * @interface Generate400Response
1027
+ */
1028
+ interface Generate400Response {
1029
+ /**
1030
+ *
1031
+ * @type {number}
1032
+ * @memberof Generate400Response
1033
+ */
1034
+ 'statusCode'?: number;
1035
+ /**
1036
+ *
1037
+ * @type {string}
1038
+ * @memberof Generate400Response
1039
+ */
1040
+ 'message'?: string;
1041
+ /**
1042
+ *
1043
+ * @type {string}
1044
+ * @memberof Generate400Response
1045
+ */
1046
+ 'error'?: string;
1047
+ }
1048
+
1049
+ /**
1050
+ * Humanos API
1051
+ * Humanos API
1052
+ *
1053
+ * The version of the OpenAPI document: 1.0
1054
+ *
1055
+ *
1056
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1057
+ * https://openapi-generator.tech
1058
+ * Do not edit the class manually.
1059
+ */
1060
+ /**
1061
+ *
1062
+ * @export
1063
+ * @interface GenerateCredentialEntity
1064
+ */
1065
+ interface GenerateCredentialEntity {
1066
+ /**
1067
+ * Unique identifier for the created credential
1068
+ * @type {string}
1069
+ * @memberof GenerateCredentialEntity
1070
+ */
1071
+ 'id': string;
1072
+ /**
1073
+ * Name of the credential
1074
+ * @type {string}
1075
+ * @memberof GenerateCredentialEntity
1076
+ */
1077
+ 'name'?: string;
1078
+ /**
1079
+ * Identifier to help you identify the credential in your own system. We recommend using a unique value.
1080
+ * @type {string}
1081
+ * @memberof GenerateCredentialEntity
1082
+ */
1083
+ 'internalId'?: string;
1084
+ }
1085
+
1086
+ /**
1087
+ * Humanos API
1088
+ * Humanos API
1089
+ *
1090
+ * The version of the OpenAPI document: 1.0
1091
+ *
1092
+ *
1093
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1094
+ * https://openapi-generator.tech
1095
+ * Do not edit the class manually.
1096
+ */
1097
+ /**
1098
+ *
1099
+ * @export
1100
+ * @interface SignaturePlacementItemDto
1101
+ */
1102
+ interface SignaturePlacementItemDto {
1103
+ /**
1104
+ * Resource ID for resource-based documents
1105
+ * @type {string}
1106
+ * @memberof SignaturePlacementItemDto
1107
+ */
1108
+ 'resourceId'?: string;
1109
+ /**
1110
+ * Index into credentials[] for uploaded PDFs
1111
+ * @type {number}
1112
+ * @memberof SignaturePlacementItemDto
1113
+ */
1114
+ 'inlineCredentialIndex'?: number;
1115
+ /**
1116
+ * Contact email or phone matching contacts[]
1117
+ * @type {string}
1118
+ * @memberof SignaturePlacementItemDto
1119
+ */
1120
+ 'contact': string;
1121
+ /**
1122
+ * X position (0-100%)
1123
+ * @type {number}
1124
+ * @memberof SignaturePlacementItemDto
1125
+ */
1126
+ 'x': number;
1127
+ /**
1128
+ * Y position (0-100%)
1129
+ * @type {number}
1130
+ * @memberof SignaturePlacementItemDto
1131
+ */
1132
+ 'y': number;
1133
+ /**
1134
+ * Width (0-100%)
1135
+ * @type {number}
1136
+ * @memberof SignaturePlacementItemDto
1137
+ */
1138
+ 'width': number;
1139
+ /**
1140
+ * Height (0-100%)
1141
+ * @type {number}
1142
+ * @memberof SignaturePlacementItemDto
1143
+ */
1144
+ 'height': number;
1145
+ /**
1146
+ * 0-based page index
1147
+ * @type {number}
1148
+ * @memberof SignaturePlacementItemDto
1149
+ */
1150
+ 'pageIndex': number;
1151
+ }
1152
+
1153
+ /**
1154
+ * Humanos API
1155
+ * Humanos API
1156
+ *
1157
+ * The version of the OpenAPI document: 1.0
1158
+ *
1159
+ *
1160
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1161
+ * https://openapi-generator.tech
1162
+ * Do not edit the class manually.
1163
+ */
1164
+
1165
+ /**
1166
+ *
1167
+ * @export
1168
+ * @interface GenerateRequestDto
1169
+ */
1170
+ interface GenerateRequestDto {
1171
+ /**
1172
+ * Name to be assigned to the request
1173
+ * @type {string}
1174
+ * @memberof GenerateRequestDto
1175
+ */
1176
+ 'name'?: string;
1177
+ /**
1178
+ * Array of contact emails or phone numbers
1179
+ * @type {Array<string>}
1180
+ * @memberof GenerateRequestDto
1181
+ */
1182
+ 'contacts': Array<string>;
1183
+ /**
1184
+ * Security level for the request
1185
+ * @type {string}
1186
+ * @memberof GenerateRequestDto
1187
+ */
1188
+ 'securityLevel'?: GenerateRequestDtoSecurityLevelEnum;
1189
+ /**
1190
+ * Whether filters or allows credentials with the exact same data to be requested. This applies to both duplicate resourceIds passed in the body or associated with groupIds provided.
1191
+ * @type {boolean}
1192
+ * @memberof GenerateRequestDto
1193
+ */
1194
+ 'allowDuplicates'?: boolean;
1195
+ /**
1196
+ * Ids of existing group resources to be included in the request
1197
+ * @type {Array<string>}
1198
+ * @memberof GenerateRequestDto
1199
+ */
1200
+ 'groupIds'?: Array<string>;
1201
+ /**
1202
+ * Ids of existing resources to be included in the request
1203
+ * @type {Array<string>}
1204
+ * @memberof GenerateRequestDto
1205
+ */
1206
+ 'resourcesIds'?: Array<string>;
1207
+ /**
1208
+ * Inline JSON credentials to be included in the request
1209
+ * @type {Array<CredentialDto>}
1210
+ * @memberof GenerateRequestDto
1211
+ */
1212
+ 'credentials'?: Array<CredentialDto>;
1213
+ /**
1214
+ * Predefined signature placements for document credentials
1215
+ * @type {Array<SignaturePlacementItemDto>}
1216
+ * @memberof GenerateRequestDto
1217
+ */
1218
+ 'signaturePlacements'?: Array<SignaturePlacementItemDto>;
1219
+ /**
1220
+ * What language to use when sending notifications to the user
1221
+ * @type {string}
1222
+ * @memberof GenerateRequestDto
1223
+ */
1224
+ 'language'?: string;
1225
+ /**
1226
+ * URL to redirect the subject after completing the request
1227
+ * @type {string}
1228
+ * @memberof GenerateRequestDto
1229
+ */
1230
+ 'redirectUrl'?: string;
1231
+ /**
1232
+ * Internal identifier for the request
1233
+ * @type {string}
1234
+ * @memberof GenerateRequestDto
1235
+ */
1236
+ 'internalId'?: string;
1237
+ }
1238
+ declare const GenerateRequestDtoSecurityLevelEnum: {
1239
+ readonly Contact: "CONTACT";
1240
+ readonly OrganizationKyc: "ORGANIZATION_KYC";
1241
+ readonly HumanosKyc: "HUMANOS_KYC";
1242
+ readonly HumanosRevalidation: "HUMANOS_REVALIDATION";
1243
+ };
1244
+ type GenerateRequestDtoSecurityLevelEnum = typeof GenerateRequestDtoSecurityLevelEnum[keyof typeof GenerateRequestDtoSecurityLevelEnum];
1245
+
1246
+ /**
1247
+ * Humanos API
1248
+ * Humanos API
1249
+ *
1250
+ * The version of the OpenAPI document: 1.0
1251
+ *
1252
+ *
1253
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1254
+ * https://openapi-generator.tech
1255
+ * Do not edit the class manually.
1256
+ */
1257
+ /**
1258
+ *
1259
+ * @export
1260
+ * @interface GenerateSubjectEntity
1261
+ */
1262
+ interface GenerateSubjectEntity {
1263
+ /**
1264
+ * Contact value (email or phone)
1265
+ * @type {string}
1266
+ * @memberof GenerateSubjectEntity
1267
+ */
1268
+ 'contact': string;
1269
+ /**
1270
+ * Public Decentralized Identifier (DID) of the user
1271
+ * @type {string}
1272
+ * @memberof GenerateSubjectEntity
1273
+ */
1274
+ 'did': string;
1275
+ /**
1276
+ * Code for the subject-OTP link. Only present if the issuer is configured to not send the OTP.
1277
+ * @type {string}
1278
+ * @memberof GenerateSubjectEntity
1279
+ */
1280
+ 'code'?: string;
1281
+ /**
1282
+ * Link to the subject-OTP link. Only present if the issuer is configured to not send the OTP.
1283
+ * @type {string}
1284
+ * @memberof GenerateSubjectEntity
1285
+ */
1286
+ 'link'?: string;
1287
+ }
1288
+
1289
+ /**
1290
+ * Humanos API
1291
+ * Humanos API
1292
+ *
1293
+ * The version of the OpenAPI document: 1.0
1294
+ *
1295
+ *
1296
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1297
+ * https://openapi-generator.tech
1298
+ * Do not edit the class manually.
1299
+ */
1300
+
1301
+ /**
1302
+ *
1303
+ * @export
1304
+ * @interface GenerateRequestEntity
1305
+ */
1306
+ interface GenerateRequestEntity {
1307
+ /**
1308
+ * List of credentials created in this request. Each credential is associated with one or more subjects.
1309
+ * @type {Array<GenerateCredentialEntity>}
1310
+ * @memberof GenerateRequestEntity
1311
+ */
1312
+ 'credentials': Array<GenerateCredentialEntity>;
1313
+ /**
1314
+ * Unique identifier for the request
1315
+ * @type {string}
1316
+ * @memberof GenerateRequestEntity
1317
+ */
1318
+ 'id': string;
1319
+ /**
1320
+ * List of subjects (users) associated with this request
1321
+ * @type {Array<GenerateSubjectEntity>}
1322
+ * @memberof GenerateRequestEntity
1323
+ */
1324
+ 'subjects': Array<GenerateSubjectEntity>;
1325
+ }
1326
+
1327
+ /**
1328
+ * Humanos API
1329
+ * Humanos API
1330
+ *
1331
+ * The version of the OpenAPI document: 1.0
1332
+ *
1333
+ *
1334
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1335
+ * https://openapi-generator.tech
1336
+ * Do not edit the class manually.
1337
+ */
1338
+ /**
1339
+ *
1340
+ * @export
1341
+ * @interface GetCredential404Response
1342
+ */
1343
+ interface GetCredential404Response {
1344
+ /**
1345
+ *
1346
+ * @type {number}
1347
+ * @memberof GetCredential404Response
1348
+ */
1349
+ 'statusCode'?: number;
1350
+ /**
1351
+ *
1352
+ * @type {string}
1353
+ * @memberof GetCredential404Response
1354
+ */
1355
+ 'message'?: string;
1356
+ /**
1357
+ *
1358
+ * @type {string}
1359
+ * @memberof GetCredential404Response
1360
+ */
1361
+ 'error'?: string;
1362
+ }
1363
+
1364
+ /**
1365
+ * Humanos API
1366
+ * Humanos API
1367
+ *
1368
+ * The version of the OpenAPI document: 1.0
1369
+ *
1370
+ *
1371
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1372
+ * https://openapi-generator.tech
1373
+ * Do not edit the class manually.
1374
+ */
1375
+
1376
+ /**
1377
+ *
1378
+ * @export
1379
+ * @interface W3CVerifiableCredential
1380
+ */
1381
+ interface W3CVerifiableCredential {
1382
+ /**
1383
+ * JSON-LD context for the W3C Verifiable Credential
1384
+ * @type {Array<string>}
1385
+ * @memberof W3CVerifiableCredential
1386
+ */
1387
+ '@context': Array<string>;
1388
+ /**
1389
+ * Unique identifier for the credential
1390
+ * @type {string}
1391
+ * @memberof W3CVerifiableCredential
1392
+ */
1393
+ 'id': string;
1394
+ /**
1395
+ * Scope of the credential
1396
+ * @type {string}
1397
+ * @memberof W3CVerifiableCredential
1398
+ */
1399
+ 'scope': string;
1400
+ /**
1401
+ * Type of the credential
1402
+ * @type {Array<string>}
1403
+ * @memberof W3CVerifiableCredential
1404
+ */
1405
+ 'type': Array<string>;
1406
+ /**
1407
+ * Issuer of the credential (DID)
1408
+ * @type {string}
1409
+ * @memberof W3CVerifiableCredential
1410
+ */
1411
+ 'issuer': string;
1412
+ /**
1413
+ * VC 1.1 issuance date (deprecated, use validFrom)
1414
+ * @type {string}
1415
+ * @memberof W3CVerifiableCredential
1416
+ */
1417
+ 'issuanceDate'?: string;
1418
+ /**
1419
+ * VC 2.0 valid from date
1420
+ * @type {string}
1421
+ * @memberof W3CVerifiableCredential
1422
+ */
1423
+ 'validFrom'?: string;
1424
+ /**
1425
+ * VC 2.0 valid until date
1426
+ * @type {string}
1427
+ * @memberof W3CVerifiableCredential
1428
+ */
1429
+ 'validUntil'?: string;
1430
+ /**
1431
+ * Credential subject containing the actual credential data
1432
+ * @type {Array<CredentialSubject>}
1433
+ * @memberof W3CVerifiableCredential
1434
+ */
1435
+ 'credentialSubject': Array<CredentialSubject>;
1436
+ /**
1437
+ * Cryptographic proof(s) for the credential
1438
+ * @type {Array<W3CProof>}
1439
+ * @memberof W3CVerifiableCredential
1440
+ */
1441
+ 'proof'?: Array<W3CProof>;
1442
+ }
1443
+
1444
+ /**
1445
+ * Humanos API
1446
+ * Humanos API
1447
+ *
1448
+ * The version of the OpenAPI document: 1.0
1449
+ *
1450
+ *
1451
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1452
+ * https://openapi-generator.tech
1453
+ * Do not edit the class manually.
1454
+ */
1455
+
1456
+ /**
1457
+ *
1458
+ * @export
1459
+ * @interface GetCredentialEntity
1460
+ */
1461
+ interface GetCredentialEntity {
1462
+ /**
1463
+ * Credential full entity
1464
+ * @type {CredentialFullEntity}
1465
+ * @memberof GetCredentialEntity
1466
+ */
1467
+ 'credential': CredentialFullEntity;
1468
+ /**
1469
+ * W3C Verifiable Credential in JSON-LD format
1470
+ * @type {W3CVerifiableCredential}
1471
+ * @memberof GetCredentialEntity
1472
+ */
1473
+ 'w3cCredential': W3CVerifiableCredential;
1474
+ /**
1475
+ * Base64-encoded PDF document (only included when includePdf=true and resource type is DOCUMENT)
1476
+ * @type {string}
1477
+ * @memberof GetCredentialEntity
1478
+ */
1479
+ 'pdf'?: string;
1480
+ }
1481
+
1482
+ /**
1483
+ * Humanos API
1484
+ * Humanos API
1485
+ *
1486
+ * The version of the OpenAPI document: 1.0
1487
+ *
1488
+ *
1489
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1490
+ * https://openapi-generator.tech
1491
+ * Do not edit the class manually.
1492
+ */
1493
+ /**
1494
+ *
1495
+ * @export
1496
+ * @interface GetRequestDetail404Response
1497
+ */
1498
+ interface GetRequestDetail404Response {
1499
+ /**
1500
+ *
1501
+ * @type {number}
1502
+ * @memberof GetRequestDetail404Response
1503
+ */
1504
+ 'statusCode'?: number;
1505
+ /**
1506
+ *
1507
+ * @type {string}
1508
+ * @memberof GetRequestDetail404Response
1509
+ */
1510
+ 'message'?: string;
1511
+ /**
1512
+ *
1513
+ * @type {string}
1514
+ * @memberof GetRequestDetail404Response
1515
+ */
1516
+ 'error'?: string;
1517
+ }
1518
+
1519
+ /**
1520
+ * Humanos API
1521
+ * Humanos API
1522
+ *
1523
+ * The version of the OpenAPI document: 1.0
1524
+ *
1525
+ *
1526
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1527
+ * https://openapi-generator.tech
1528
+ * Do not edit the class manually.
1529
+ */
1530
+ /**
1531
+ *
1532
+ * @export
1533
+ * @interface GetSubject400Response
1534
+ */
1535
+ interface GetSubject400Response {
1536
+ /**
1537
+ *
1538
+ * @type {number}
1539
+ * @memberof GetSubject400Response
1540
+ */
1541
+ 'statusCode'?: number;
1542
+ /**
1543
+ *
1544
+ * @type {string}
1545
+ * @memberof GetSubject400Response
1546
+ */
1547
+ 'message'?: string;
1548
+ /**
1549
+ *
1550
+ * @type {string}
1551
+ * @memberof GetSubject400Response
1552
+ */
1553
+ 'error'?: string;
1554
+ }
1555
+
1556
+ /**
1557
+ * Humanos API
1558
+ * Humanos API
1559
+ *
1560
+ * The version of the OpenAPI document: 1.0
1561
+ *
1562
+ *
1563
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1564
+ * https://openapi-generator.tech
1565
+ * Do not edit the class manually.
1566
+ */
1567
+ /**
1568
+ *
1569
+ * @export
1570
+ * @interface GetSubject404Response
1571
+ */
1572
+ interface GetSubject404Response {
1573
+ /**
1574
+ *
1575
+ * @type {number}
1576
+ * @memberof GetSubject404Response
1577
+ */
1578
+ 'statusCode'?: number;
1579
+ /**
1580
+ *
1581
+ * @type {string}
1582
+ * @memberof GetSubject404Response
1583
+ */
1584
+ 'message'?: string;
1585
+ /**
1586
+ *
1587
+ * @type {string}
1588
+ * @memberof GetSubject404Response
1589
+ */
1590
+ 'error'?: string;
1591
+ }
1592
+
1593
+ /**
1594
+ * Humanos API
1595
+ * Humanos API
1596
+ *
1597
+ * The version of the OpenAPI document: 1.0
1598
+ *
1599
+ *
1600
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1601
+ * https://openapi-generator.tech
1602
+ * Do not edit the class manually.
1603
+ */
1604
+ /**
1605
+ *
1606
+ * @export
1607
+ * @interface GroupResourceEntity
1608
+ */
1609
+ interface GroupResourceEntity {
1610
+ /**
1611
+ * Unique identifier for the resource
1612
+ * @type {string}
1613
+ * @memberof GroupResourceEntity
1614
+ */
1615
+ 'id': string;
1616
+ /**
1617
+ * Name of the resource
1618
+ * @type {string}
1619
+ * @memberof GroupResourceEntity
1620
+ */
1621
+ 'name': string;
1622
+ /**
1623
+ * Type of the resource
1624
+ * @type {string}
1625
+ * @memberof GroupResourceEntity
1626
+ */
1627
+ 'type': GroupResourceEntityTypeEnum;
1628
+ /**
1629
+ * Whether the resource is currently active. Only active resources can be requested
1630
+ * @type {boolean}
1631
+ * @memberof GroupResourceEntity
1632
+ */
1633
+ 'active': boolean;
1634
+ /**
1635
+ * Identifier to help you identify the resource in your own system. We recommend using a unique value.
1636
+ * @type {string}
1637
+ * @memberof GroupResourceEntity
1638
+ */
1639
+ 'internalId'?: string;
1640
+ }
1641
+ declare const GroupResourceEntityTypeEnum: {
1642
+ readonly Consent: "CONSENT";
1643
+ readonly Form: "FORM";
1644
+ readonly Document: "DOCUMENT";
1645
+ readonly Json: "JSON";
1646
+ };
1647
+ type GroupResourceEntityTypeEnum = typeof GroupResourceEntityTypeEnum[keyof typeof GroupResourceEntityTypeEnum];
1648
+
1649
+ /**
1650
+ * Humanos API
1651
+ * Humanos API
1652
+ *
1653
+ * The version of the OpenAPI document: 1.0
1654
+ *
1655
+ *
1656
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1657
+ * https://openapi-generator.tech
1658
+ * Do not edit the class manually.
1659
+ */
1660
+
1661
+ /**
1662
+ *
1663
+ * @export
1664
+ * @interface GroupEntity
1665
+ */
1666
+ interface GroupEntity {
1667
+ /**
1668
+ * Unique identifier for the group
1669
+ * @type {string}
1670
+ * @memberof GroupEntity
1671
+ */
1672
+ 'id': string;
1673
+ /**
1674
+ * Name of the group
1675
+ * @type {string}
1676
+ * @memberof GroupEntity
1677
+ */
1678
+ 'name': string;
1679
+ /**
1680
+ * Description of the group
1681
+ * @type {string}
1682
+ * @memberof GroupEntity
1683
+ */
1684
+ 'description'?: string;
1685
+ /**
1686
+ * Whether the group is currently active. Only active groups can be requested
1687
+ * @type {boolean}
1688
+ * @memberof GroupEntity
1689
+ */
1690
+ 'active': boolean;
1691
+ /**
1692
+ * List of resources in this group
1693
+ * @type {Array<GroupResourceEntity>}
1694
+ * @memberof GroupEntity
1695
+ */
1696
+ 'resources': Array<GroupResourceEntity>;
1697
+ /**
1698
+ * Date and time of the group last update
1699
+ * @type {string}
1700
+ * @memberof GroupEntity
1701
+ */
1702
+ 'updatedAt': string;
1703
+ }
1704
+
1705
+ /**
1706
+ * Humanos API
1707
+ * Humanos API
1708
+ *
1709
+ * The version of the OpenAPI document: 1.0
1710
+ *
1711
+ *
1712
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1713
+ * https://openapi-generator.tech
1714
+ * Do not edit the class manually.
1715
+ */
1716
+
1717
+ /**
1718
+ *
1719
+ * @export
1720
+ * @interface GroupsEntity
1721
+ */
1722
+ interface GroupsEntity {
1723
+ /**
1724
+ * Array of resource groups matching the query parameters
1725
+ * @type {Array<GroupEntity>}
1726
+ * @memberof GroupsEntity
1727
+ */
1728
+ 'data': Array<GroupEntity>;
1729
+ /**
1730
+ * Total number of pages available based on the page size and total count
1731
+ * @type {number}
1732
+ * @memberof GroupsEntity
1733
+ */
1734
+ 'totalPages': number;
1735
+ }
1736
+
1737
+ /**
1738
+ * Humanos API
1739
+ * Humanos API
1740
+ *
1741
+ * The version of the OpenAPI document: 1.0
1742
+ *
1743
+ *
1744
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1745
+ * https://openapi-generator.tech
1746
+ * Do not edit the class manually.
1747
+ */
1748
+ /**
1749
+ *
1750
+ * @export
1751
+ * @interface IdentityEventDecision
1752
+ */
1753
+ interface IdentityEventDecision {
1754
+ /**
1755
+ *
1756
+ * @type {boolean}
1757
+ * @memberof IdentityEventDecision
1758
+ */
1759
+ 'success': boolean;
1760
+ /**
1761
+ *
1762
+ * @type {boolean}
1763
+ * @memberof IdentityEventDecision
1764
+ */
1765
+ 'isFraud': boolean;
1766
+ /**
1767
+ *
1768
+ * @type {number}
1769
+ * @memberof IdentityEventDecision
1770
+ */
1771
+ 'riskScore': number;
1772
+ /**
1773
+ *
1774
+ * @type {string}
1775
+ * @memberof IdentityEventDecision
1776
+ */
1777
+ 'message'?: string;
1778
+ }
1779
+
1780
+ /**
1781
+ * Humanos API
1782
+ * Humanos API
1783
+ *
1784
+ * The version of the OpenAPI document: 1.0
1785
+ *
1786
+ *
1787
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1788
+ * https://openapi-generator.tech
1789
+ * Do not edit the class manually.
1790
+ */
1791
+ /**
1792
+ *
1793
+ * @export
1794
+ * @interface IdentityEventIdentity
1795
+ */
1796
+ interface IdentityEventIdentity {
1797
+ /**
1798
+ *
1799
+ * @type {string}
1800
+ * @memberof IdentityEventIdentity
1801
+ */
1802
+ 'fullName': string;
1803
+ /**
1804
+ *
1805
+ * @type {string}
1806
+ * @memberof IdentityEventIdentity
1807
+ */
1808
+ 'gender': string;
1809
+ /**
1810
+ *
1811
+ * @type {string}
1812
+ * @memberof IdentityEventIdentity
1813
+ */
1814
+ 'birth': string;
1815
+ /**
1816
+ *
1817
+ * @type {string}
1818
+ * @memberof IdentityEventIdentity
1819
+ */
1820
+ 'docId': string;
1821
+ /**
1822
+ *
1823
+ * @type {string}
1824
+ * @memberof IdentityEventIdentity
1825
+ */
1826
+ 'fullDocId': string;
1827
+ /**
1828
+ *
1829
+ * @type {string}
1830
+ * @memberof IdentityEventIdentity
1831
+ */
1832
+ 'expiresAt': string;
1833
+ /**
1834
+ *
1835
+ * @type {string}
1836
+ * @memberof IdentityEventIdentity
1837
+ */
1838
+ 'issueDate': string;
1839
+ /**
1840
+ *
1841
+ * @type {string}
1842
+ * @memberof IdentityEventIdentity
1843
+ */
1844
+ 'placeOfBirth': string;
1845
+ /**
1846
+ *
1847
+ * @type {string}
1848
+ * @memberof IdentityEventIdentity
1849
+ */
1850
+ 'documentType': string;
1851
+ /**
1852
+ *
1853
+ * @type {string}
1854
+ * @memberof IdentityEventIdentity
1855
+ */
1856
+ 'countryAlpha3': string;
1857
+ }
1858
+
1859
+ /**
1860
+ * Humanos API
1861
+ * Humanos API
1862
+ *
1863
+ * The version of the OpenAPI document: 1.0
1864
+ *
1865
+ *
1866
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1867
+ * https://openapi-generator.tech
1868
+ * Do not edit the class manually.
1869
+ */
1870
+ /**
1871
+ *
1872
+ * @export
1873
+ * @enum {string}
1874
+ */
1875
+ declare const WebhookEventTypeIDENTITY: {
1876
+ readonly Identity: "identity";
1877
+ };
1878
+ type WebhookEventTypeIDENTITY = typeof WebhookEventTypeIDENTITY[keyof typeof WebhookEventTypeIDENTITY];
1879
+
1880
+ /**
1881
+ * Humanos API
1882
+ * Humanos API
1883
+ *
1884
+ * The version of the OpenAPI document: 1.0
1885
+ *
1886
+ *
1887
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1888
+ * https://openapi-generator.tech
1889
+ * Do not edit the class manually.
1890
+ */
1891
+
1892
+ /**
1893
+ *
1894
+ * @export
1895
+ * @interface IdentityEvent
1896
+ */
1897
+ interface IdentityEvent {
1898
+ [key: string]: any;
1899
+ /**
1900
+ *
1901
+ * @type {WebhookEventTypeIDENTITY}
1902
+ * @memberof IdentityEvent
1903
+ */
1904
+ 'eventType': WebhookEventTypeIDENTITY;
1905
+ /**
1906
+ *
1907
+ * @type {string}
1908
+ * @memberof IdentityEvent
1909
+ */
1910
+ 'requestId': string;
1911
+ /**
1912
+ *
1913
+ * @type {string}
1914
+ * @memberof IdentityEvent
1915
+ */
1916
+ 'internalId'?: string;
1917
+ /**
1918
+ *
1919
+ * @type {string}
1920
+ * @memberof IdentityEvent
1921
+ */
1922
+ 'issuerDid': string;
1923
+ /**
1924
+ *
1925
+ * @type {CredentialEventUser}
1926
+ * @memberof IdentityEvent
1927
+ */
1928
+ 'user': CredentialEventUser;
1929
+ /**
1930
+ *
1931
+ * @type {string}
1932
+ * @memberof IdentityEvent
1933
+ */
1934
+ 'decisionDate': string;
1935
+ /**
1936
+ *
1937
+ * @type {string}
1938
+ * @memberof IdentityEvent
1939
+ */
1940
+ 'api_version'?: string;
1941
+ /**
1942
+ *
1943
+ * @type {IdentityEventIdentity}
1944
+ * @memberof IdentityEvent
1945
+ */
1946
+ 'identity': IdentityEventIdentity;
1947
+ /**
1948
+ *
1949
+ * @type {IdentityEventDecision}
1950
+ * @memberof IdentityEvent
1951
+ */
1952
+ 'decision': IdentityEventDecision;
1953
+ }
1954
+
1955
+ /**
1956
+ * Humanos API
1957
+ * Humanos API
1958
+ *
1959
+ * The version of the OpenAPI document: 1.0
1960
+ *
1961
+ *
1962
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1963
+ * https://openapi-generator.tech
1964
+ * Do not edit the class manually.
1965
+ */
1966
+ /**
1967
+ *
1968
+ * @export
1969
+ * @enum {string}
1970
+ */
1971
+ declare const IdentityFieldType: {
1972
+ readonly FullName: "FULL_NAME";
1973
+ readonly Birth: "BIRTH";
1974
+ readonly HealthNumber: "HEALTH_NUMBER";
1975
+ readonly TaxNumber: "TAX_NUMBER";
1976
+ readonly DocId: "DOC_ID";
1977
+ readonly CountryAlpha3: "COUNTRY_ALPHA3";
1978
+ readonly SocialSecurityNumber: "SOCIAL_SECURITY_NUMBER";
1979
+ readonly Email: "EMAIL";
1980
+ readonly Phone: "PHONE";
1981
+ };
1982
+ type IdentityFieldType = typeof IdentityFieldType[keyof typeof IdentityFieldType];
1983
+
1984
+ /**
1985
+ * Humanos API
1986
+ * Humanos API
1987
+ *
1988
+ * The version of the OpenAPI document: 1.0
1989
+ *
1990
+ *
1991
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1992
+ * https://openapi-generator.tech
1993
+ * Do not edit the class manually.
1994
+ */
1995
+
1996
+ /**
1997
+ *
1998
+ * @export
1999
+ * @interface IdentityFieldPlacement
2000
+ */
2001
+ interface IdentityFieldPlacement {
2002
+ [key: string]: any;
2003
+ /**
2004
+ *
2005
+ * @type {IdentityFieldType}
2006
+ * @memberof IdentityFieldPlacement
2007
+ */
2008
+ 'fieldType': IdentityFieldType;
2009
+ /**
2010
+ *
2011
+ * @type {number}
2012
+ * @memberof IdentityFieldPlacement
2013
+ */
2014
+ 'x': number;
2015
+ /**
2016
+ *
2017
+ * @type {number}
2018
+ * @memberof IdentityFieldPlacement
2019
+ */
2020
+ 'y': number;
2021
+ /**
2022
+ *
2023
+ * @type {number}
2024
+ * @memberof IdentityFieldPlacement
2025
+ */
2026
+ 'width': number;
2027
+ /**
2028
+ *
2029
+ * @type {number}
2030
+ * @memberof IdentityFieldPlacement
2031
+ */
2032
+ 'height': number;
2033
+ /**
2034
+ *
2035
+ * @type {number}
2036
+ * @memberof IdentityFieldPlacement
2037
+ */
2038
+ 'pageIndex': number;
2039
+ /**
2040
+ *
2041
+ * @type {string}
2042
+ * @memberof IdentityFieldPlacement
2043
+ */
2044
+ 'value'?: string;
2045
+ }
2046
+
2047
+ /**
2048
+ * Humanos API
2049
+ * Humanos API
2050
+ *
2051
+ * The version of the OpenAPI document: 1.0
2052
+ *
2053
+ *
2054
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2055
+ * https://openapi-generator.tech
2056
+ * Do not edit the class manually.
2057
+ */
2058
+ /**
2059
+ *
2060
+ * @export
2061
+ * @interface IssuerDetailEntity
2062
+ */
2063
+ interface IssuerDetailEntity {
2064
+ /**
2065
+ * Name of the issuer organization
2066
+ * @type {string}
2067
+ * @memberof IssuerDetailEntity
2068
+ */
2069
+ 'name'?: string;
2070
+ /**
2071
+ * Public Decentralized Identifier (DID) of the issuer
2072
+ * @type {string}
2073
+ * @memberof IssuerDetailEntity
2074
+ */
2075
+ 'did': string;
2076
+ }
2077
+
2078
+ /**
2079
+ * Humanos API
2080
+ * Humanos API
2081
+ *
2082
+ * The version of the OpenAPI document: 1.0
2083
+ *
2084
+ *
2085
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2086
+ * https://openapi-generator.tech
2087
+ * Do not edit the class manually.
2088
+ */
2089
+ /**
2090
+ *
2091
+ * @export
2092
+ * @enum {string}
2093
+ */
2094
+ declare const MandateDataType: {
2095
+ readonly String: "string";
2096
+ readonly Number: "number";
2097
+ readonly Boolean: "boolean";
2098
+ readonly Object: "object";
2099
+ readonly Array: "array";
2100
+ readonly Date: "date";
2101
+ readonly Pdf: "pdf";
2102
+ readonly Url: "url";
2103
+ };
2104
+ type MandateDataType = typeof MandateDataType[keyof typeof MandateDataType];
2105
+
2106
+ /**
2107
+ * Humanos API
2108
+ * Humanos API
2109
+ *
2110
+ * The version of the OpenAPI document: 1.0
2111
+ *
2112
+ *
2113
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2114
+ * https://openapi-generator.tech
2115
+ * Do not edit the class manually.
2116
+ */
2117
+
2118
+ /**
2119
+ *
2120
+ * @export
2121
+ * @interface MandateDataDtoType
2122
+ */
2123
+ interface MandateDataDtoType {
2124
+ [key: string]: any;
2125
+ /**
2126
+ * Value of the data field. Format depends on the type.
2127
+ * @type {any}
2128
+ * @memberof MandateDataDtoType
2129
+ */
2130
+ 'value': any;
2131
+ /**
2132
+ *
2133
+ * @type {MandateDataType}
2134
+ * @memberof MandateDataDtoType
2135
+ */
2136
+ 'type': MandateDataType;
2137
+ /**
2138
+ *
2139
+ * @type {string}
2140
+ * @memberof MandateDataDtoType
2141
+ */
2142
+ 'label': string;
2143
+ /**
2144
+ *
2145
+ * @type {string}
2146
+ * @memberof MandateDataDtoType
2147
+ */
2148
+ 'hash'?: string;
2149
+ /**
2150
+ *
2151
+ * @type {string}
2152
+ * @memberof MandateDataDtoType
2153
+ */
2154
+ 'description'?: string;
2155
+ /**
2156
+ *
2157
+ * @type {boolean}
2158
+ * @memberof MandateDataDtoType
2159
+ */
2160
+ 'hidden'?: boolean;
2161
+ /**
2162
+ *
2163
+ * @type {Array<MandateDataDtoType>}
2164
+ * @memberof MandateDataDtoType
2165
+ */
2166
+ 'fields'?: Array<MandateDataDtoType>;
2167
+ }
2168
+
2169
+ /**
2170
+ * Humanos API
2171
+ * Humanos API
2172
+ *
2173
+ * The version of the OpenAPI document: 1.0
2174
+ *
2175
+ *
2176
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2177
+ * https://openapi-generator.tech
2178
+ * Do not edit the class manually.
2179
+ */
2180
+ /**
2181
+ *
2182
+ * @export
2183
+ * @interface OtpFailedEventOtpError
2184
+ */
2185
+ interface OtpFailedEventOtpError {
2186
+ /**
2187
+ *
2188
+ * @type {string}
2189
+ * @memberof OtpFailedEventOtpError
2190
+ */
2191
+ 'code': string;
2192
+ /**
2193
+ *
2194
+ * @type {string}
2195
+ * @memberof OtpFailedEventOtpError
2196
+ */
2197
+ 'message': string;
2198
+ }
2199
+
2200
+ /**
2201
+ * Humanos API
2202
+ * Humanos API
2203
+ *
2204
+ * The version of the OpenAPI document: 1.0
2205
+ *
2206
+ *
2207
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2208
+ * https://openapi-generator.tech
2209
+ * Do not edit the class manually.
2210
+ */
2211
+
2212
+ /**
2213
+ *
2214
+ * @export
2215
+ * @interface OtpFailedEventOtp
2216
+ */
2217
+ interface OtpFailedEventOtp {
2218
+ /**
2219
+ *
2220
+ * @type {string}
2221
+ * @memberof OtpFailedEventOtp
2222
+ */
2223
+ 'resendEndpoint': string;
2224
+ /**
2225
+ *
2226
+ * @type {OtpFailedEventOtpError}
2227
+ * @memberof OtpFailedEventOtp
2228
+ */
2229
+ 'error': OtpFailedEventOtpError;
2230
+ }
2231
+
2232
+ /**
2233
+ * Humanos API
2234
+ * Humanos API
2235
+ *
2236
+ * The version of the OpenAPI document: 1.0
2237
+ *
2238
+ *
2239
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2240
+ * https://openapi-generator.tech
2241
+ * Do not edit the class manually.
2242
+ */
2243
+ /**
2244
+ *
2245
+ * @export
2246
+ * @enum {string}
2247
+ */
2248
+ declare const WebhookEventTypeOTPFAILED: {
2249
+ readonly OtpFailed: "otp.failed";
2250
+ };
2251
+ type WebhookEventTypeOTPFAILED = typeof WebhookEventTypeOTPFAILED[keyof typeof WebhookEventTypeOTPFAILED];
2252
+
2253
+ /**
2254
+ * Humanos API
2255
+ * Humanos API
2256
+ *
2257
+ * The version of the OpenAPI document: 1.0
2258
+ *
2259
+ *
2260
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2261
+ * https://openapi-generator.tech
2262
+ * Do not edit the class manually.
2263
+ */
2264
+
2265
+ /**
2266
+ *
2267
+ * @export
2268
+ * @interface OtpFailedEvent
2269
+ */
2270
+ interface OtpFailedEvent {
2271
+ [key: string]: any;
2272
+ /**
2273
+ *
2274
+ * @type {WebhookEventTypeOTPFAILED}
2275
+ * @memberof OtpFailedEvent
2276
+ */
2277
+ 'eventType': WebhookEventTypeOTPFAILED;
2278
+ /**
2279
+ *
2280
+ * @type {string}
2281
+ * @memberof OtpFailedEvent
2282
+ */
2283
+ 'requestId': string;
2284
+ /**
2285
+ *
2286
+ * @type {string}
2287
+ * @memberof OtpFailedEvent
2288
+ */
2289
+ 'internalId'?: string;
2290
+ /**
2291
+ *
2292
+ * @type {string}
2293
+ * @memberof OtpFailedEvent
2294
+ */
2295
+ 'issuerDid': string;
2296
+ /**
2297
+ *
2298
+ * @type {CredentialEventUser}
2299
+ * @memberof OtpFailedEvent
2300
+ */
2301
+ 'user': CredentialEventUser;
2302
+ /**
2303
+ *
2304
+ * @type {string}
2305
+ * @memberof OtpFailedEvent
2306
+ */
2307
+ 'decisionDate': string;
2308
+ /**
2309
+ *
2310
+ * @type {string}
2311
+ * @memberof OtpFailedEvent
2312
+ */
2313
+ 'api_version'?: string;
2314
+ /**
2315
+ *
2316
+ * @type {OtpFailedEventOtp}
2317
+ * @memberof OtpFailedEvent
2318
+ */
2319
+ 'otp': OtpFailedEventOtp;
2320
+ }
2321
+
2322
+ /**
2323
+ * Humanos API
2324
+ * Humanos API
2325
+ *
2326
+ * The version of the OpenAPI document: 1.0
2327
+ *
2328
+ *
2329
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2330
+ * https://openapi-generator.tech
2331
+ * Do not edit the class manually.
2332
+ */
2333
+ /**
2334
+ *
2335
+ * @export
2336
+ * @interface RequestSubjectEntity
2337
+ */
2338
+ interface RequestSubjectEntity {
2339
+ /**
2340
+ * Contact value (email or phone)
2341
+ * @type {string}
2342
+ * @memberof RequestSubjectEntity
2343
+ */
2344
+ 'contact': string;
2345
+ /**
2346
+ * Public Decentralized Identifier (DID) of the user
2347
+ * @type {string}
2348
+ * @memberof RequestSubjectEntity
2349
+ */
2350
+ 'did'?: string;
2351
+ /**
2352
+ * Identifier to help you identify the user in your own system. We recommend using a unique value.
2353
+ * @type {string}
2354
+ * @memberof RequestSubjectEntity
2355
+ */
2356
+ 'internalId'?: string;
2357
+ /**
2358
+ * Name of the user if exists and accessible
2359
+ * @type {string}
2360
+ * @memberof RequestSubjectEntity
2361
+ */
2362
+ 'name'?: string;
2363
+ }
2364
+
2365
+ /**
2366
+ * Humanos API
2367
+ * Humanos API
2368
+ *
2369
+ * The version of the OpenAPI document: 1.0
2370
+ *
2371
+ *
2372
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2373
+ * https://openapi-generator.tech
2374
+ * Do not edit the class manually.
2375
+ */
2376
+
2377
+ /**
2378
+ *
2379
+ * @export
2380
+ * @interface RequestDetailEntity
2381
+ */
2382
+ interface RequestDetailEntity {
2383
+ /**
2384
+ * Unique identifier for the request
2385
+ * @type {string}
2386
+ * @memberof RequestDetailEntity
2387
+ */
2388
+ 'id': string;
2389
+ /**
2390
+ * Name of the credential request
2391
+ * @type {string}
2392
+ * @memberof RequestDetailEntity
2393
+ */
2394
+ 'name'?: string;
2395
+ /**
2396
+ * Identity level required for all subjects in this request
2397
+ * @type {string}
2398
+ * @memberof RequestDetailEntity
2399
+ */
2400
+ 'securityLevel': RequestDetailEntitySecurityLevelEnum;
2401
+ /**
2402
+ * List of subjects (users) associated with this request (minified: name, did, contact)
2403
+ * @type {Array<RequestSubjectEntity>}
2404
+ * @memberof RequestDetailEntity
2405
+ */
2406
+ 'subjects': Array<RequestSubjectEntity>;
2407
+ /**
2408
+ * Date and time of the request creation
2409
+ * @type {string}
2410
+ * @memberof RequestDetailEntity
2411
+ */
2412
+ 'createdAt': string;
2413
+ /**
2414
+ * List of credentials included in this request. Each credential contains W3C Verifiable Credential data that can be cryptographically verified.
2415
+ * @type {Array<CredentialFullEntity>}
2416
+ * @memberof RequestDetailEntity
2417
+ */
2418
+ 'credentials': Array<CredentialFullEntity>;
2419
+ /**
2420
+ * Agent information if this request was created by an agent. Null if created directly by the organization.
2421
+ * @type {AgentDetailEntity}
2422
+ * @memberof RequestDetailEntity
2423
+ */
2424
+ 'agent'?: AgentDetailEntity;
2425
+ /**
2426
+ * Issuer information (your organization) that created this request
2427
+ * @type {IssuerDetailEntity}
2428
+ * @memberof RequestDetailEntity
2429
+ */
2430
+ 'issuer': IssuerDetailEntity;
2431
+ }
2432
+ declare const RequestDetailEntitySecurityLevelEnum: {
2433
+ readonly Contact: "CONTACT";
2434
+ readonly OrganizationKyc: "ORGANIZATION_KYC";
2435
+ readonly HumanosKyc: "HUMANOS_KYC";
2436
+ readonly HumanosRevalidation: "HUMANOS_REVALIDATION";
2437
+ };
2438
+ type RequestDetailEntitySecurityLevelEnum = typeof RequestDetailEntitySecurityLevelEnum[keyof typeof RequestDetailEntitySecurityLevelEnum];
2439
+
2440
+ /**
2441
+ * Humanos API
2442
+ * Humanos API
2443
+ *
2444
+ * The version of the OpenAPI document: 1.0
2445
+ *
2446
+ *
2447
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2448
+ * https://openapi-generator.tech
2449
+ * Do not edit the class manually.
2450
+ */
2451
+
2452
+ /**
2453
+ *
2454
+ * @export
2455
+ * @interface RequestEntity
2456
+ */
2457
+ interface RequestEntity {
2458
+ /**
2459
+ * List of credentials created in this request. Each credential is associated with one or more subjects.
2460
+ * @type {Array<CredentialEntity>}
2461
+ * @memberof RequestEntity
2462
+ */
2463
+ 'credentials': Array<CredentialEntity>;
2464
+ /**
2465
+ * Unique identifier for the request
2466
+ * @type {string}
2467
+ * @memberof RequestEntity
2468
+ */
2469
+ 'id': string;
2470
+ /**
2471
+ * Name of the credential request
2472
+ * @type {string}
2473
+ * @memberof RequestEntity
2474
+ */
2475
+ 'name'?: string;
2476
+ /**
2477
+ * Identity level required for all subjects in this request
2478
+ * @type {string}
2479
+ * @memberof RequestEntity
2480
+ */
2481
+ 'securityLevel': RequestEntitySecurityLevelEnum;
2482
+ /**
2483
+ * Language to be sent both in the otp and displayed in the link to the user
2484
+ * @type {string}
2485
+ * @memberof RequestEntity
2486
+ */
2487
+ 'language'?: string;
2488
+ /**
2489
+ * URL to redirect the subject after completing the request
2490
+ * @type {string}
2491
+ * @memberof RequestEntity
2492
+ */
2493
+ 'redirectUrl'?: string;
2494
+ /**
2495
+ * Internal identifier for the request
2496
+ * @type {string}
2497
+ * @memberof RequestEntity
2498
+ */
2499
+ 'internalId'?: string;
2500
+ /**
2501
+ * List of subjects (users) associated with this request (minified: name, did, contact)
2502
+ * @type {Array<RequestSubjectEntity>}
2503
+ * @memberof RequestEntity
2504
+ */
2505
+ 'subjects': Array<RequestSubjectEntity>;
2506
+ /**
2507
+ * Date and time of the request creation
2508
+ * @type {string}
2509
+ * @memberof RequestEntity
2510
+ */
2511
+ 'createdAt': string;
2512
+ }
2513
+ declare const RequestEntitySecurityLevelEnum: {
2514
+ readonly Contact: "CONTACT";
2515
+ readonly OrganizationKyc: "ORGANIZATION_KYC";
2516
+ readonly HumanosKyc: "HUMANOS_KYC";
2517
+ readonly HumanosRevalidation: "HUMANOS_REVALIDATION";
2518
+ };
2519
+ type RequestEntitySecurityLevelEnum = typeof RequestEntitySecurityLevelEnum[keyof typeof RequestEntitySecurityLevelEnum];
2520
+
2521
+ /**
2522
+ * Humanos API
2523
+ * Humanos API
2524
+ *
2525
+ * The version of the OpenAPI document: 1.0
2526
+ *
2527
+ *
2528
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2529
+ * https://openapi-generator.tech
2530
+ * Do not edit the class manually.
2531
+ */
2532
+ /**
2533
+ *
2534
+ * @export
2535
+ * @interface RequestQuery
2536
+ */
2537
+ interface RequestQuery {
2538
+ /**
2539
+ * Page number
2540
+ * @type {number}
2541
+ * @memberof RequestQuery
2542
+ */
2543
+ 'pageIndex'?: number;
2544
+ /**
2545
+ * Number of items per page
2546
+ * @type {number}
2547
+ * @memberof RequestQuery
2548
+ */
2549
+ 'pageSize'?: number;
2550
+ /**
2551
+ * Search query to filter by. Is case-insensitive and does not need to match the entire value.
2552
+ * @type {string}
2553
+ * @memberof RequestQuery
2554
+ */
2555
+ 'search'?: string;
2556
+ /**
2557
+ * Contact value (email or phone)
2558
+ * @type {string}
2559
+ * @memberof RequestQuery
2560
+ */
2561
+ 'contact'?: string;
2562
+ /**
2563
+ * Public Decentralized Identifier (DID) of the user
2564
+ * @type {string}
2565
+ * @memberof RequestQuery
2566
+ */
2567
+ 'did'?: string;
2568
+ /**
2569
+ * Identifier to help you identify the user in your own system. We recommend using a unique value.
2570
+ * @type {string}
2571
+ * @memberof RequestQuery
2572
+ */
2573
+ 'subjectInternalId'?: string;
2574
+ /**
2575
+ * Filter by internal ID.
2576
+ * @type {string}
2577
+ * @memberof RequestQuery
2578
+ */
2579
+ 'internalId'?: string;
2580
+ /**
2581
+ * Filter by credential internal ID.
2582
+ * @type {string}
2583
+ * @memberof RequestQuery
2584
+ */
2585
+ 'credentialInternalId'?: string;
2586
+ /**
2587
+ * Filter by security level. Can be a single value or array
2588
+ * @type {Array<string>}
2589
+ * @memberof RequestQuery
2590
+ */
2591
+ 'securityLevel'?: Array<RequestQuerySecurityLevelEnum>;
2592
+ /**
2593
+ * Filter from date (will be converted to start of day)
2594
+ * @type {string}
2595
+ * @memberof RequestQuery
2596
+ */
2597
+ 'dateFrom'?: string;
2598
+ /**
2599
+ * Filter to date (will be converted to end of day). Requires dateFrom.
2600
+ * @type {string}
2601
+ * @memberof RequestQuery
2602
+ */
2603
+ 'dateTo'?: string;
2604
+ }
2605
+ declare const RequestQuerySecurityLevelEnum: {
2606
+ readonly Contact: "CONTACT";
2607
+ readonly OrganizationKyc: "ORGANIZATION_KYC";
2608
+ readonly HumanosKyc: "HUMANOS_KYC";
2609
+ readonly HumanosRevalidation: "HUMANOS_REVALIDATION";
2610
+ };
2611
+ type RequestQuerySecurityLevelEnum = typeof RequestQuerySecurityLevelEnum[keyof typeof RequestQuerySecurityLevelEnum];
2612
+
2613
+ /**
2614
+ * Humanos API
2615
+ * Humanos API
2616
+ *
2617
+ * The version of the OpenAPI document: 1.0
2618
+ *
2619
+ *
2620
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2621
+ * https://openapi-generator.tech
2622
+ * Do not edit the class manually.
2623
+ */
2624
+
2625
+ /**
2626
+ *
2627
+ * @export
2628
+ * @interface RequestsEntity
2629
+ */
2630
+ interface RequestsEntity {
2631
+ /**
2632
+ * Array of credential requests matching the query parameters
2633
+ * @type {Array<RequestEntity>}
2634
+ * @memberof RequestsEntity
2635
+ */
2636
+ 'data': Array<RequestEntity>;
2637
+ /**
2638
+ * Total number of pages available based on the page size and total count
2639
+ * @type {number}
2640
+ * @memberof RequestsEntity
2641
+ */
2642
+ 'totalPages': number;
2643
+ }
2644
+
2645
+ /**
2646
+ * Humanos API
2647
+ * Humanos API
2648
+ *
2649
+ * The version of the OpenAPI document: 1.0
2650
+ *
2651
+ *
2652
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2653
+ * https://openapi-generator.tech
2654
+ * Do not edit the class manually.
2655
+ */
2656
+ /**
2657
+ *
2658
+ * @export
2659
+ * @interface ResourceEntity
2660
+ */
2661
+ interface ResourceEntity {
2662
+ /**
2663
+ * Unique identifier for the resource
2664
+ * @type {string}
2665
+ * @memberof ResourceEntity
2666
+ */
2667
+ 'id': string;
2668
+ /**
2669
+ * Name of the resource
2670
+ * @type {string}
2671
+ * @memberof ResourceEntity
2672
+ */
2673
+ 'name': string;
2674
+ /**
2675
+ * Type of the resource
2676
+ * @type {string}
2677
+ * @memberof ResourceEntity
2678
+ */
2679
+ 'type': ResourceEntityTypeEnum;
2680
+ /**
2681
+ * Whether the resource is currently active. Only active resources can be requested
2682
+ * @type {boolean}
2683
+ * @memberof ResourceEntity
2684
+ */
2685
+ 'active': boolean;
2686
+ /**
2687
+ * Identifier to help you identify the resource in your own system. We recommend using a unique value.
2688
+ * @type {string}
2689
+ * @memberof ResourceEntity
2690
+ */
2691
+ 'internalId'?: string;
2692
+ /**
2693
+ * Description of the resource. Used to further clarify the resource.
2694
+ * @type {string}
2695
+ * @memberof ResourceEntity
2696
+ */
2697
+ 'description'?: string;
2698
+ /**
2699
+ * Array of group IDs that this resource belongs to
2700
+ * @type {Array<string>}
2701
+ * @memberof ResourceEntity
2702
+ */
2703
+ 'groupIds': Array<string>;
2704
+ /**
2705
+ * Content of the resource. The structure depends on the resource type: - DOCUMENT: Base64 encoded PDF string - CONSENT: Text of the consent - FORM: Form configuration data
2706
+ * @type {string}
2707
+ * @memberof ResourceEntity
2708
+ */
2709
+ 'content'?: string;
2710
+ /**
2711
+ * Link to the consent
2712
+ * @type {string}
2713
+ * @memberof ResourceEntity
2714
+ */
2715
+ 'consentUrl'?: string;
2716
+ /**
2717
+ * Date and time of the resource last update
2718
+ * @type {string}
2719
+ * @memberof ResourceEntity
2720
+ */
2721
+ 'updatedAt': string;
2722
+ }
2723
+ declare const ResourceEntityTypeEnum: {
2724
+ readonly Consent: "CONSENT";
2725
+ readonly Form: "FORM";
2726
+ readonly Document: "DOCUMENT";
2727
+ readonly Json: "JSON";
2728
+ };
2729
+ type ResourceEntityTypeEnum = typeof ResourceEntityTypeEnum[keyof typeof ResourceEntityTypeEnum];
2730
+
2731
+ /**
2732
+ * Humanos API
2733
+ * Humanos API
2734
+ *
2735
+ * The version of the OpenAPI document: 1.0
2736
+ *
2737
+ *
2738
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2739
+ * https://openapi-generator.tech
2740
+ * Do not edit the class manually.
2741
+ */
2742
+ /**
2743
+ *
2744
+ * @export
2745
+ * @interface ResourceQuery
2746
+ */
2747
+ interface ResourceQuery {
2748
+ /**
2749
+ * Page number
2750
+ * @type {number}
2751
+ * @memberof ResourceQuery
2752
+ */
2753
+ 'pageIndex'?: number;
2754
+ /**
2755
+ * Number of items per page
2756
+ * @type {number}
2757
+ * @memberof ResourceQuery
2758
+ */
2759
+ 'pageSize'?: number;
2760
+ /**
2761
+ * Search query to filter by. Is case-insensitive and does not need to match the entire value.
2762
+ * @type {string}
2763
+ * @memberof ResourceQuery
2764
+ */
2765
+ 'search'?: string;
2766
+ /**
2767
+ * Filter by active status. Accepts true/false as string or boolean.
2768
+ * @type {boolean}
2769
+ * @memberof ResourceQuery
2770
+ */
2771
+ 'active'?: boolean;
2772
+ /**
2773
+ * Filter by resource types. Can be a single value or array
2774
+ * @type {Array<string>}
2775
+ * @memberof ResourceQuery
2776
+ */
2777
+ 'types'?: Array<ResourceQueryTypesEnum>;
2778
+ /**
2779
+ * Identifier to help you identify the resource in your own system. We recommend using a unique value.
2780
+ * @type {string}
2781
+ * @memberof ResourceQuery
2782
+ */
2783
+ 'internalId'?: string;
2784
+ }
2785
+ declare const ResourceQueryTypesEnum: {
2786
+ readonly Consent: "CONSENT";
2787
+ readonly Form: "FORM";
2788
+ readonly Document: "DOCUMENT";
2789
+ readonly Json: "JSON";
2790
+ };
2791
+ type ResourceQueryTypesEnum = typeof ResourceQueryTypesEnum[keyof typeof ResourceQueryTypesEnum];
2792
+
2793
+ /**
2794
+ * Humanos API
2795
+ * Humanos API
2796
+ *
2797
+ * The version of the OpenAPI document: 1.0
2798
+ *
2799
+ *
2800
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2801
+ * https://openapi-generator.tech
2802
+ * Do not edit the class manually.
2803
+ */
2804
+
2805
+ /**
2806
+ *
2807
+ * @export
2808
+ * @interface ResourcesEntity
2809
+ */
2810
+ interface ResourcesEntity {
2811
+ /**
2812
+ * Array of resources matching the query parameters
2813
+ * @type {Array<ResourceEntity>}
2814
+ * @memberof ResourcesEntity
2815
+ */
2816
+ 'data': Array<ResourceEntity>;
2817
+ /**
2818
+ * Total number of pages available based on the page size and total count
2819
+ * @type {number}
2820
+ * @memberof ResourcesEntity
2821
+ */
2822
+ 'totalPages': number;
2823
+ }
2824
+
2825
+ /**
2826
+ * Humanos API
2827
+ * Humanos API
2828
+ *
2829
+ * The version of the OpenAPI document: 1.0
2830
+ *
2831
+ *
2832
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2833
+ * https://openapi-generator.tech
2834
+ * Do not edit the class manually.
2835
+ */
2836
+ /**
2837
+ *
2838
+ * @export
2839
+ * @interface SignaturePlacement
2840
+ */
2841
+ interface SignaturePlacement {
2842
+ [key: string]: any;
2843
+ /**
2844
+ *
2845
+ * @type {number}
2846
+ * @memberof SignaturePlacement
2847
+ */
2848
+ 'x': number;
2849
+ /**
2850
+ *
2851
+ * @type {number}
2852
+ * @memberof SignaturePlacement
2853
+ */
2854
+ 'y': number;
2855
+ /**
2856
+ *
2857
+ * @type {number}
2858
+ * @memberof SignaturePlacement
2859
+ */
2860
+ 'width': number;
2861
+ /**
2862
+ *
2863
+ * @type {number}
2864
+ * @memberof SignaturePlacement
2865
+ */
2866
+ 'height': number;
2867
+ /**
2868
+ *
2869
+ * @type {number}
2870
+ * @memberof SignaturePlacement
2871
+ */
2872
+ 'pageIndex': number;
2873
+ }
2874
+
2875
+ /**
2876
+ * Humanos API
2877
+ * Humanos API
2878
+ *
2879
+ * The version of the OpenAPI document: 1.0
2880
+ *
2881
+ *
2882
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2883
+ * https://openapi-generator.tech
2884
+ * Do not edit the class manually.
2885
+ */
2886
+ /**
2887
+ *
2888
+ * @export
2889
+ * @interface SubjectContactEntity
2890
+ */
2891
+ interface SubjectContactEntity {
2892
+ /**
2893
+ * Contact value (email or phone)
2894
+ * @type {string}
2895
+ * @memberof SubjectContactEntity
2896
+ */
2897
+ 'contact': string;
2898
+ /**
2899
+ * Public Decentralized Identifier (DID) of the user
2900
+ * @type {string}
2901
+ * @memberof SubjectContactEntity
2902
+ */
2903
+ 'did'?: string;
2904
+ /**
2905
+ * Whether the contact has been verified. Always verified for the first contact, otherwise after code verification
2906
+ * @type {boolean}
2907
+ * @memberof SubjectContactEntity
2908
+ */
2909
+ 'verified': boolean;
2910
+ }
2911
+
2912
+ /**
2913
+ * Humanos API
2914
+ * Humanos API
2915
+ *
2916
+ * The version of the OpenAPI document: 1.0
2917
+ *
2918
+ *
2919
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2920
+ * https://openapi-generator.tech
2921
+ * Do not edit the class manually.
2922
+ */
2923
+
2924
+ /**
2925
+ *
2926
+ * @export
2927
+ * @interface SubjectEntity
2928
+ */
2929
+ interface SubjectEntity {
2930
+ /**
2931
+ * List of contacts associated with the user
2932
+ * @type {Array<SubjectContactEntity>}
2933
+ * @memberof SubjectEntity
2934
+ */
2935
+ 'contacts': Array<SubjectContactEntity>;
2936
+ /**
2937
+ * Identity information (KYC data) for the user, if available
2938
+ * @type {IdentityDto}
2939
+ * @memberof SubjectEntity
2940
+ */
2941
+ 'identity'?: IdentityDto;
2942
+ /**
2943
+ * Identifier to help you identify the user in your own system. We recommend using a unique value.
2944
+ * @type {string}
2945
+ * @memberof SubjectEntity
2946
+ */
2947
+ 'internalId'?: string;
2948
+ }
2949
+
2950
+ /**
2951
+ * Humanos API
2952
+ * Humanos API
2953
+ *
2954
+ * The version of the OpenAPI document: 1.0
2955
+ *
2956
+ *
2957
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2958
+ * https://openapi-generator.tech
2959
+ * Do not edit the class manually.
2960
+ */
2961
+ /**
2962
+ *
2963
+ * @export
2964
+ * @interface SubjectQuery
2965
+ */
2966
+ interface SubjectQuery {
2967
+ /**
2968
+ * Contact value (email or phone)
2969
+ * @type {string}
2970
+ * @memberof SubjectQuery
2971
+ */
2972
+ 'contact'?: string;
2973
+ /**
2974
+ * Public Decentralized Identifier (DID) of the user
2975
+ * @type {string}
2976
+ * @memberof SubjectQuery
2977
+ */
2978
+ 'did'?: string;
2979
+ /**
2980
+ * Identifier to help you identify the user in your own system. We recommend using a unique value.
2981
+ * @type {string}
2982
+ * @memberof SubjectQuery
2983
+ */
2984
+ 'internalId'?: string;
2985
+ }
2986
+
2987
+ /**
2988
+ * Humanos API
2989
+ * Humanos API
2990
+ *
2991
+ * The version of the OpenAPI document: 1.0
2992
+ *
2993
+ *
2994
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2995
+ * https://openapi-generator.tech
2996
+ * Do not edit the class manually.
2997
+ */
2998
+ /**
2999
+ *
3000
+ * @export
3001
+ * @interface SuccessEntity
3002
+ */
3003
+ interface SuccessEntity {
3004
+ /**
3005
+ * Whether the operation was successful
3006
+ * @type {boolean}
3007
+ * @memberof SuccessEntity
3008
+ */
3009
+ 'success': boolean;
3010
+ }
3011
+
3012
+ /**
3013
+ * Humanos API
3014
+ * Humanos API
3015
+ *
3016
+ * The version of the OpenAPI document: 1.0
3017
+ *
3018
+ *
3019
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3020
+ * https://openapi-generator.tech
3021
+ * Do not edit the class manually.
3022
+ */
3023
+ /**
3024
+ *
3025
+ * @export
3026
+ * @enum {string}
3027
+ */
3028
+ declare const WebhookEventTypeTEST: {
3029
+ readonly Test: "test";
3030
+ };
3031
+ type WebhookEventTypeTEST = typeof WebhookEventTypeTEST[keyof typeof WebhookEventTypeTEST];
3032
+
3033
+ /**
3034
+ * Humanos API
3035
+ * Humanos API
3036
+ *
3037
+ * The version of the OpenAPI document: 1.0
3038
+ *
3039
+ *
3040
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3041
+ * https://openapi-generator.tech
3042
+ * Do not edit the class manually.
3043
+ */
3044
+
3045
+ /**
3046
+ *
3047
+ * @export
3048
+ * @interface TestEvent
3049
+ */
3050
+ interface TestEvent {
3051
+ [key: string]: any;
3052
+ /**
3053
+ *
3054
+ * @type {WebhookEventTypeTEST}
3055
+ * @memberof TestEvent
3056
+ */
3057
+ 'eventType': WebhookEventTypeTEST;
3058
+ /**
3059
+ *
3060
+ * @type {string}
3061
+ * @memberof TestEvent
3062
+ */
3063
+ 'requestId': string;
3064
+ /**
3065
+ *
3066
+ * @type {string}
3067
+ * @memberof TestEvent
3068
+ */
3069
+ 'internalId'?: string;
3070
+ /**
3071
+ *
3072
+ * @type {string}
3073
+ * @memberof TestEvent
3074
+ */
3075
+ 'issuerDid': string;
3076
+ /**
3077
+ *
3078
+ * @type {CredentialEventUser}
3079
+ * @memberof TestEvent
3080
+ */
3081
+ 'user': CredentialEventUser;
3082
+ /**
3083
+ *
3084
+ * @type {string}
3085
+ * @memberof TestEvent
3086
+ */
3087
+ 'decisionDate': string;
3088
+ /**
3089
+ *
3090
+ * @type {string}
3091
+ * @memberof TestEvent
3092
+ */
3093
+ 'api_version'?: string;
3094
+ /**
3095
+ *
3096
+ * @type {string}
3097
+ * @memberof TestEvent
3098
+ */
3099
+ 'message': string;
3100
+ }
3101
+
3102
+ /**
3103
+ * Humanos API
3104
+ * Humanos API
3105
+ *
3106
+ * The version of the OpenAPI document: 1.0
3107
+ *
3108
+ *
3109
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3110
+ * https://openapi-generator.tech
3111
+ * Do not edit the class manually.
3112
+ */
3113
+
3114
+ /**
3115
+ * @type WebhookCallEvent
3116
+ * @export
3117
+ */
3118
+ type WebhookCallEvent = {
3119
+ eventType: 'credential';
3120
+ } & CredentialEvent | {
3121
+ eventType: 'identity';
3122
+ } & IdentityEvent | {
3123
+ eventType: 'otp.failed';
3124
+ } & OtpFailedEvent | {
3125
+ eventType: 'test';
3126
+ } & TestEvent;
3127
+
3128
+ /**
3129
+ * Humanos API
3130
+ * Humanos API
3131
+ *
3132
+ * The version of the OpenAPI document: 1.0
3133
+ *
3134
+ *
3135
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3136
+ * https://openapi-generator.tech
3137
+ * Do not edit the class manually.
3138
+ */
3139
+ /**
3140
+ *
3141
+ * @export
3142
+ * @enum {string}
3143
+ */
3144
+ declare const WebhookEventType: {
3145
+ readonly Credential: "credential";
3146
+ readonly Identity: "identity";
3147
+ readonly OtpFailed: "otp.failed";
3148
+ readonly Test: "test";
3149
+ };
3150
+ type WebhookEventType = typeof WebhookEventType[keyof typeof WebhookEventType];
3151
+
3152
+ /**
3153
+ * CredentialsApi - axios parameter creator
3154
+ * @export
3155
+ */
3156
+ declare const CredentialsApiAxiosParamCreator: (configuration?: Configuration) => {
3157
+ /**
3158
+ * Retrieve a specific credential by its ID Returns the W3C Verifiable Credential data structure including cryptographic proofs Optionally includes the PDF content for document type credentials
3159
+ * @summary Get Credential
3160
+ * @param {string} credentialId Unique identifier of the credential. Must be a valid MongoDB ObjectId.
3161
+ * @param {boolean} [includePdf] Whether to include the PDF content for document type credentials
3162
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3163
+ * @param {*} [options] Override http request option.
3164
+ * @throws {RequiredError}
3165
+ */
3166
+ getCredential: (credentialId: string, includePdf?: boolean, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3167
+ };
3168
+ /**
3169
+ * CredentialsApi - functional programming interface
3170
+ * @export
3171
+ */
3172
+ declare const CredentialsApiFp: (configuration?: Configuration) => {
3173
+ /**
3174
+ * Retrieve a specific credential by its ID Returns the W3C Verifiable Credential data structure including cryptographic proofs Optionally includes the PDF content for document type credentials
3175
+ * @summary Get Credential
3176
+ * @param {string} credentialId Unique identifier of the credential. Must be a valid MongoDB ObjectId.
3177
+ * @param {boolean} [includePdf] Whether to include the PDF content for document type credentials
3178
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3179
+ * @param {*} [options] Override http request option.
3180
+ * @throws {RequiredError}
3181
+ */
3182
+ getCredential(credentialId: string, includePdf?: boolean, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCredentialEntity>>;
3183
+ };
3184
+ /**
3185
+ * CredentialsApi - factory interface
3186
+ * @export
3187
+ */
3188
+ declare const CredentialsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3189
+ /**
3190
+ * Retrieve a specific credential by its ID Returns the W3C Verifiable Credential data structure including cryptographic proofs Optionally includes the PDF content for document type credentials
3191
+ * @summary Get Credential
3192
+ * @param {string} credentialId Unique identifier of the credential. Must be a valid MongoDB ObjectId.
3193
+ * @param {boolean} [includePdf] Whether to include the PDF content for document type credentials
3194
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3195
+ * @param {*} [options] Override http request option.
3196
+ * @throws {RequiredError}
3197
+ */
3198
+ getCredential(credentialId: string, includePdf?: boolean, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetCredentialEntity>;
3199
+ };
3200
+ /**
3201
+ * CredentialsApi - object-oriented interface
3202
+ * @export
3203
+ * @class CredentialsApi
3204
+ * @extends {BaseAPI}
3205
+ */
3206
+ declare class CredentialsApi extends BaseAPI {
3207
+ /**
3208
+ * Retrieve a specific credential by its ID Returns the W3C Verifiable Credential data structure including cryptographic proofs Optionally includes the PDF content for document type credentials
3209
+ * @summary Get Credential
3210
+ * @param {string} credentialId Unique identifier of the credential. Must be a valid MongoDB ObjectId.
3211
+ * @param {boolean} [includePdf] Whether to include the PDF content for document type credentials
3212
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3213
+ * @param {*} [options] Override http request option.
3214
+ * @throws {RequiredError}
3215
+ * @memberof CredentialsApi
3216
+ */
3217
+ getCredential(credentialId: string, includePdf?: boolean, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetCredentialEntity, any, {}>>;
3218
+ }
3219
+
3220
+ /**
3221
+ * RequestsApi - axios parameter creator
3222
+ * @export
3223
+ */
3224
+ declare const RequestsApiAxiosParamCreator: (configuration?: Configuration) => {
3225
+ /**
3226
+ * This action will cancel a credential request, by setting the canceledAt timestamp on the request. This operation is irreversible, and will prevent the request from being processed further by the subjects
3227
+ * @summary Cancel
3228
+ * @param {string} requestId Unique identifier of the credential request to cancel. Must be a valid MongoDB ObjectId.
3229
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3230
+ * @param {*} [options] Override http request option.
3231
+ * @throws {RequiredError}
3232
+ */
3233
+ cancelRequest: (requestId: string, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3234
+ /**
3235
+ * Create a new credential request for one or more subjects (users). This endpoint will: - Create credentials from resources or inline JSON data - Associate credentials with subjects - Generate and send OTPs for approval via email or SMS Request details: - Resources can be specified via group IDs, resource IDs, or as inline JSON credentials - Maximum 30 credentials per request - Maximum 20 contacts per request - OTPs are automatically sent to all subjects after creation
3236
+ * @summary Create
3237
+ * @param {GenerateRequestDto} generateRequestDto Request body containing contacts (subjects), security level, and resources to create credentials from. Resources can be specified via groupIds, resourcesIds, or inline credentials array.
3238
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3239
+ * @param {*} [options] Override http request option.
3240
+ * @throws {RequiredError}
3241
+ */
3242
+ generate: (generateRequestDto: GenerateRequestDto, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3243
+ /**
3244
+ * Retrieve detailed information about a specific credential request This includes complete W3C Verifiable Credential data for each credential, subject information, agent details (if applicable), and issuer information The credentials are returned in W3C-compliant format and can be cryptographically verified
3245
+ * @summary Get Detail
3246
+ * @param {string} requestId Unique identifier of the credential request. Must be a valid MongoDB ObjectId.
3247
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3248
+ * @param {*} [options] Override http request option.
3249
+ * @throws {RequiredError}
3250
+ */
3251
+ getRequestDetail: (requestId: string, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3252
+ /**
3253
+ * Retrieve a paginated list of credential requests for your organization Each request includes information about the credentials, subjects (users), security level, and creation date. One exact search query must be provided
3254
+ * @summary Get
3255
+ * @param {number} [pageIndex] Page number
3256
+ * @param {number} [pageSize] Number of items per page
3257
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3258
+ * @param {string} [contact] Contact value (email or phone)
3259
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3260
+ * @param {string} [subjectInternalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3261
+ * @param {string} [internalId] Filter by internal ID.
3262
+ * @param {string} [credentialInternalId] Filter by credential internal ID.
3263
+ * @param {Array<GetRequestsSecurityLevelEnum>} [securityLevel] Filter by security level. Can be a single value or array
3264
+ * @param {string} [dateFrom] Filter from date (will be converted to start of day)
3265
+ * @param {string} [dateTo] Filter to date (will be converted to end of day). Requires dateFrom.
3266
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3267
+ * @param {*} [options] Override http request option.
3268
+ * @throws {RequiredError}
3269
+ */
3270
+ getRequests: (pageIndex?: number, pageSize?: number, search?: string, contact?: string, did?: string, subjectInternalId?: string, internalId?: string, credentialInternalId?: string, securityLevel?: Array<GetRequestsSecurityLevelEnum>, dateFrom?: string, dateTo?: string, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3271
+ /**
3272
+ * Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS (depending on their contact type) with a code and a signing URL One exact search query must be provided The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
3273
+ * @summary Resend OTP
3274
+ * @param {string} requestId Unique identifier of the request.
3275
+ * @param {string} [contact] Contact value (email or phone)
3276
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3277
+ * @param {string} [internalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3278
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3279
+ * @param {*} [options] Override http request option.
3280
+ * @throws {RequiredError}
3281
+ */
3282
+ resendOtp: (requestId: string, contact?: string, did?: string, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3283
+ };
3284
+ /**
3285
+ * RequestsApi - functional programming interface
3286
+ * @export
3287
+ */
3288
+ declare const RequestsApiFp: (configuration?: Configuration) => {
3289
+ /**
3290
+ * This action will cancel a credential request, by setting the canceledAt timestamp on the request. This operation is irreversible, and will prevent the request from being processed further by the subjects
3291
+ * @summary Cancel
3292
+ * @param {string} requestId Unique identifier of the credential request to cancel. Must be a valid MongoDB ObjectId.
3293
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3294
+ * @param {*} [options] Override http request option.
3295
+ * @throws {RequiredError}
3296
+ */
3297
+ cancelRequest(requestId: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessEntity>>;
3298
+ /**
3299
+ * Create a new credential request for one or more subjects (users). This endpoint will: - Create credentials from resources or inline JSON data - Associate credentials with subjects - Generate and send OTPs for approval via email or SMS Request details: - Resources can be specified via group IDs, resource IDs, or as inline JSON credentials - Maximum 30 credentials per request - Maximum 20 contacts per request - OTPs are automatically sent to all subjects after creation
3300
+ * @summary Create
3301
+ * @param {GenerateRequestDto} generateRequestDto Request body containing contacts (subjects), security level, and resources to create credentials from. Resources can be specified via groupIds, resourcesIds, or inline credentials array.
3302
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3303
+ * @param {*} [options] Override http request option.
3304
+ * @throws {RequiredError}
3305
+ */
3306
+ generate(generateRequestDto: GenerateRequestDto, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateRequestEntity>>;
3307
+ /**
3308
+ * Retrieve detailed information about a specific credential request This includes complete W3C Verifiable Credential data for each credential, subject information, agent details (if applicable), and issuer information The credentials are returned in W3C-compliant format and can be cryptographically verified
3309
+ * @summary Get Detail
3310
+ * @param {string} requestId Unique identifier of the credential request. Must be a valid MongoDB ObjectId.
3311
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3312
+ * @param {*} [options] Override http request option.
3313
+ * @throws {RequiredError}
3314
+ */
3315
+ getRequestDetail(requestId: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestDetailEntity>>;
3316
+ /**
3317
+ * Retrieve a paginated list of credential requests for your organization Each request includes information about the credentials, subjects (users), security level, and creation date. One exact search query must be provided
3318
+ * @summary Get
3319
+ * @param {number} [pageIndex] Page number
3320
+ * @param {number} [pageSize] Number of items per page
3321
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3322
+ * @param {string} [contact] Contact value (email or phone)
3323
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3324
+ * @param {string} [subjectInternalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3325
+ * @param {string} [internalId] Filter by internal ID.
3326
+ * @param {string} [credentialInternalId] Filter by credential internal ID.
3327
+ * @param {Array<GetRequestsSecurityLevelEnum>} [securityLevel] Filter by security level. Can be a single value or array
3328
+ * @param {string} [dateFrom] Filter from date (will be converted to start of day)
3329
+ * @param {string} [dateTo] Filter to date (will be converted to end of day). Requires dateFrom.
3330
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3331
+ * @param {*} [options] Override http request option.
3332
+ * @throws {RequiredError}
3333
+ */
3334
+ getRequests(pageIndex?: number, pageSize?: number, search?: string, contact?: string, did?: string, subjectInternalId?: string, internalId?: string, credentialInternalId?: string, securityLevel?: Array<GetRequestsSecurityLevelEnum>, dateFrom?: string, dateTo?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestsEntity>>;
3335
+ /**
3336
+ * Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS (depending on their contact type) with a code and a signing URL One exact search query must be provided The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
3337
+ * @summary Resend OTP
3338
+ * @param {string} requestId Unique identifier of the request.
3339
+ * @param {string} [contact] Contact value (email or phone)
3340
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3341
+ * @param {string} [internalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3342
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3343
+ * @param {*} [options] Override http request option.
3344
+ * @throws {RequiredError}
3345
+ */
3346
+ resendOtp(requestId: string, contact?: string, did?: string, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessEntity>>;
3347
+ };
3348
+ /**
3349
+ * RequestsApi - factory interface
3350
+ * @export
3351
+ */
3352
+ declare const RequestsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3353
+ /**
3354
+ * This action will cancel a credential request, by setting the canceledAt timestamp on the request. This operation is irreversible, and will prevent the request from being processed further by the subjects
3355
+ * @summary Cancel
3356
+ * @param {string} requestId Unique identifier of the credential request to cancel. Must be a valid MongoDB ObjectId.
3357
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3358
+ * @param {*} [options] Override http request option.
3359
+ * @throws {RequiredError}
3360
+ */
3361
+ cancelRequest(requestId: string, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessEntity>;
3362
+ /**
3363
+ * Create a new credential request for one or more subjects (users). This endpoint will: - Create credentials from resources or inline JSON data - Associate credentials with subjects - Generate and send OTPs for approval via email or SMS Request details: - Resources can be specified via group IDs, resource IDs, or as inline JSON credentials - Maximum 30 credentials per request - Maximum 20 contacts per request - OTPs are automatically sent to all subjects after creation
3364
+ * @summary Create
3365
+ * @param {GenerateRequestDto} generateRequestDto Request body containing contacts (subjects), security level, and resources to create credentials from. Resources can be specified via groupIds, resourcesIds, or inline credentials array.
3366
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3367
+ * @param {*} [options] Override http request option.
3368
+ * @throws {RequiredError}
3369
+ */
3370
+ generate(generateRequestDto: GenerateRequestDto, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<GenerateRequestEntity>;
3371
+ /**
3372
+ * Retrieve detailed information about a specific credential request This includes complete W3C Verifiable Credential data for each credential, subject information, agent details (if applicable), and issuer information The credentials are returned in W3C-compliant format and can be cryptographically verified
3373
+ * @summary Get Detail
3374
+ * @param {string} requestId Unique identifier of the credential request. Must be a valid MongoDB ObjectId.
3375
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3376
+ * @param {*} [options] Override http request option.
3377
+ * @throws {RequiredError}
3378
+ */
3379
+ getRequestDetail(requestId: string, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<RequestDetailEntity>;
3380
+ /**
3381
+ * Retrieve a paginated list of credential requests for your organization Each request includes information about the credentials, subjects (users), security level, and creation date. One exact search query must be provided
3382
+ * @summary Get
3383
+ * @param {number} [pageIndex] Page number
3384
+ * @param {number} [pageSize] Number of items per page
3385
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3386
+ * @param {string} [contact] Contact value (email or phone)
3387
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3388
+ * @param {string} [subjectInternalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3389
+ * @param {string} [internalId] Filter by internal ID.
3390
+ * @param {string} [credentialInternalId] Filter by credential internal ID.
3391
+ * @param {Array<GetRequestsSecurityLevelEnum>} [securityLevel] Filter by security level. Can be a single value or array
3392
+ * @param {string} [dateFrom] Filter from date (will be converted to start of day)
3393
+ * @param {string} [dateTo] Filter to date (will be converted to end of day). Requires dateFrom.
3394
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3395
+ * @param {*} [options] Override http request option.
3396
+ * @throws {RequiredError}
3397
+ */
3398
+ getRequests(pageIndex?: number, pageSize?: number, search?: string, contact?: string, did?: string, subjectInternalId?: string, internalId?: string, credentialInternalId?: string, securityLevel?: Array<GetRequestsSecurityLevelEnum>, dateFrom?: string, dateTo?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<RequestsEntity>;
3399
+ /**
3400
+ * Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS (depending on their contact type) with a code and a signing URL One exact search query must be provided The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
3401
+ * @summary Resend OTP
3402
+ * @param {string} requestId Unique identifier of the request.
3403
+ * @param {string} [contact] Contact value (email or phone)
3404
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3405
+ * @param {string} [internalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3406
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3407
+ * @param {*} [options] Override http request option.
3408
+ * @throws {RequiredError}
3409
+ */
3410
+ resendOtp(requestId: string, contact?: string, did?: string, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessEntity>;
3411
+ };
3412
+ /**
3413
+ * RequestsApi - object-oriented interface
3414
+ * @export
3415
+ * @class RequestsApi
3416
+ * @extends {BaseAPI}
3417
+ */
3418
+ declare class RequestsApi extends BaseAPI {
3419
+ /**
3420
+ * This action will cancel a credential request, by setting the canceledAt timestamp on the request. This operation is irreversible, and will prevent the request from being processed further by the subjects
3421
+ * @summary Cancel
3422
+ * @param {string} requestId Unique identifier of the credential request to cancel. Must be a valid MongoDB ObjectId.
3423
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3424
+ * @param {*} [options] Override http request option.
3425
+ * @throws {RequiredError}
3426
+ * @memberof RequestsApi
3427
+ */
3428
+ cancelRequest(requestId: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<SuccessEntity, any, {}>>;
3429
+ /**
3430
+ * Create a new credential request for one or more subjects (users). This endpoint will: - Create credentials from resources or inline JSON data - Associate credentials with subjects - Generate and send OTPs for approval via email or SMS Request details: - Resources can be specified via group IDs, resource IDs, or as inline JSON credentials - Maximum 30 credentials per request - Maximum 20 contacts per request - OTPs are automatically sent to all subjects after creation
3431
+ * @summary Create
3432
+ * @param {GenerateRequestDto} generateRequestDto Request body containing contacts (subjects), security level, and resources to create credentials from. Resources can be specified via groupIds, resourcesIds, or inline credentials array.
3433
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3434
+ * @param {*} [options] Override http request option.
3435
+ * @throws {RequiredError}
3436
+ * @memberof RequestsApi
3437
+ */
3438
+ generate(generateRequestDto: GenerateRequestDto, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GenerateRequestEntity, any, {}>>;
3439
+ /**
3440
+ * Retrieve detailed information about a specific credential request This includes complete W3C Verifiable Credential data for each credential, subject information, agent details (if applicable), and issuer information The credentials are returned in W3C-compliant format and can be cryptographically verified
3441
+ * @summary Get Detail
3442
+ * @param {string} requestId Unique identifier of the credential request. Must be a valid MongoDB ObjectId.
3443
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3444
+ * @param {*} [options] Override http request option.
3445
+ * @throws {RequiredError}
3446
+ * @memberof RequestsApi
3447
+ */
3448
+ getRequestDetail(requestId: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RequestDetailEntity, any, {}>>;
3449
+ /**
3450
+ * Retrieve a paginated list of credential requests for your organization Each request includes information about the credentials, subjects (users), security level, and creation date. One exact search query must be provided
3451
+ * @summary Get
3452
+ * @param {number} [pageIndex] Page number
3453
+ * @param {number} [pageSize] Number of items per page
3454
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3455
+ * @param {string} [contact] Contact value (email or phone)
3456
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3457
+ * @param {string} [subjectInternalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3458
+ * @param {string} [internalId] Filter by internal ID.
3459
+ * @param {string} [credentialInternalId] Filter by credential internal ID.
3460
+ * @param {Array<GetRequestsSecurityLevelEnum>} [securityLevel] Filter by security level. Can be a single value or array
3461
+ * @param {string} [dateFrom] Filter from date (will be converted to start of day)
3462
+ * @param {string} [dateTo] Filter to date (will be converted to end of day). Requires dateFrom.
3463
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3464
+ * @param {*} [options] Override http request option.
3465
+ * @throws {RequiredError}
3466
+ * @memberof RequestsApi
3467
+ */
3468
+ getRequests(pageIndex?: number, pageSize?: number, search?: string, contact?: string, did?: string, subjectInternalId?: string, internalId?: string, credentialInternalId?: string, securityLevel?: Array<GetRequestsSecurityLevelEnum>, dateFrom?: string, dateTo?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RequestsEntity, any, {}>>;
3469
+ /**
3470
+ * Resend a One-Time Password (OTP) to a subject for credential approval, via email or SMS (depending on their contact type) with a code and a signing URL One exact search query must be provided The endpoint validates: - The request is not canceled - Maximum attempts have not been reached, only successful OTP sends count towards resend limits - Sufficient time has passed since the last successful resend - Billing restrictions apply
3471
+ * @summary Resend OTP
3472
+ * @param {string} requestId Unique identifier of the request.
3473
+ * @param {string} [contact] Contact value (email or phone)
3474
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3475
+ * @param {string} [internalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3476
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3477
+ * @param {*} [options] Override http request option.
3478
+ * @throws {RequiredError}
3479
+ * @memberof RequestsApi
3480
+ */
3481
+ resendOtp(requestId: string, contact?: string, did?: string, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<SuccessEntity, any, {}>>;
3482
+ }
3483
+ /**
3484
+ * @export
3485
+ */
3486
+ declare const GetRequestsSecurityLevelEnum: {
3487
+ readonly Contact: "CONTACT";
3488
+ readonly OrganizationKyc: "ORGANIZATION_KYC";
3489
+ readonly HumanosKyc: "HUMANOS_KYC";
3490
+ readonly HumanosRevalidation: "HUMANOS_REVALIDATION";
3491
+ };
3492
+ type GetRequestsSecurityLevelEnum = typeof GetRequestsSecurityLevelEnum[keyof typeof GetRequestsSecurityLevelEnum];
3493
+
3494
+ /**
3495
+ * ResourceApi - axios parameter creator
3496
+ * @export
3497
+ */
3498
+ declare const ResourceApiAxiosParamCreator: (configuration?: Configuration) => {
3499
+ /**
3500
+ * Retrieve information about the existing groups, including its resources, and the total number of pages. Resource groups allow to pack resources together and easily request them.
3501
+ * @summary Get Groups
3502
+ * @param {number} [pageIndex] Page number
3503
+ * @param {number} [pageSize] Number of items per page
3504
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3505
+ * @param {boolean} [active] Filter by active status. Accepts true/false as string or boolean.
3506
+ * @param {Array<GetGroupsTypesEnum>} [types] Filter by resource types. Can be a single value or array
3507
+ * @param {string} [internalId] Identifier to help you identify the resource in your own system. We recommend using a unique value.
3508
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3509
+ * @param {*} [options] Override http request option.
3510
+ * @throws {RequiredError}
3511
+ */
3512
+ getGroups: (pageIndex?: number, pageSize?: number, search?: string, active?: boolean, types?: Array<GetGroupsTypesEnum>, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3513
+ /**
3514
+ * Retrieve a paginated list of resources for your organization. Resources can be documents, consents, forms.
3515
+ * @summary Get Resources
3516
+ * @param {number} [pageIndex] Page number
3517
+ * @param {number} [pageSize] Number of items per page
3518
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3519
+ * @param {boolean} [active] Filter by active status. Accepts true/false as string or boolean.
3520
+ * @param {Array<GetResourcesTypesEnum>} [types] Filter by resource types. Can be a single value or array
3521
+ * @param {string} [internalId] Identifier to help you identify the resource in your own system. We recommend using a unique value.
3522
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3523
+ * @param {*} [options] Override http request option.
3524
+ * @throws {RequiredError}
3525
+ */
3526
+ getResources: (pageIndex?: number, pageSize?: number, search?: string, active?: boolean, types?: Array<GetResourcesTypesEnum>, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3527
+ };
3528
+ /**
3529
+ * ResourceApi - functional programming interface
3530
+ * @export
3531
+ */
3532
+ declare const ResourceApiFp: (configuration?: Configuration) => {
3533
+ /**
3534
+ * Retrieve information about the existing groups, including its resources, and the total number of pages. Resource groups allow to pack resources together and easily request them.
3535
+ * @summary Get Groups
3536
+ * @param {number} [pageIndex] Page number
3537
+ * @param {number} [pageSize] Number of items per page
3538
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3539
+ * @param {boolean} [active] Filter by active status. Accepts true/false as string or boolean.
3540
+ * @param {Array<GetGroupsTypesEnum>} [types] Filter by resource types. Can be a single value or array
3541
+ * @param {string} [internalId] Identifier to help you identify the resource in your own system. We recommend using a unique value.
3542
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3543
+ * @param {*} [options] Override http request option.
3544
+ * @throws {RequiredError}
3545
+ */
3546
+ getGroups(pageIndex?: number, pageSize?: number, search?: string, active?: boolean, types?: Array<GetGroupsTypesEnum>, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupsEntity>>;
3547
+ /**
3548
+ * Retrieve a paginated list of resources for your organization. Resources can be documents, consents, forms.
3549
+ * @summary Get Resources
3550
+ * @param {number} [pageIndex] Page number
3551
+ * @param {number} [pageSize] Number of items per page
3552
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3553
+ * @param {boolean} [active] Filter by active status. Accepts true/false as string or boolean.
3554
+ * @param {Array<GetResourcesTypesEnum>} [types] Filter by resource types. Can be a single value or array
3555
+ * @param {string} [internalId] Identifier to help you identify the resource in your own system. We recommend using a unique value.
3556
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3557
+ * @param {*} [options] Override http request option.
3558
+ * @throws {RequiredError}
3559
+ */
3560
+ getResources(pageIndex?: number, pageSize?: number, search?: string, active?: boolean, types?: Array<GetResourcesTypesEnum>, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourcesEntity>>;
3561
+ };
3562
+ /**
3563
+ * ResourceApi - factory interface
3564
+ * @export
3565
+ */
3566
+ declare const ResourceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3567
+ /**
3568
+ * Retrieve information about the existing groups, including its resources, and the total number of pages. Resource groups allow to pack resources together and easily request them.
3569
+ * @summary Get Groups
3570
+ * @param {number} [pageIndex] Page number
3571
+ * @param {number} [pageSize] Number of items per page
3572
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3573
+ * @param {boolean} [active] Filter by active status. Accepts true/false as string or boolean.
3574
+ * @param {Array<GetGroupsTypesEnum>} [types] Filter by resource types. Can be a single value or array
3575
+ * @param {string} [internalId] Identifier to help you identify the resource in your own system. We recommend using a unique value.
3576
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3577
+ * @param {*} [options] Override http request option.
3578
+ * @throws {RequiredError}
3579
+ */
3580
+ getGroups(pageIndex?: number, pageSize?: number, search?: string, active?: boolean, types?: Array<GetGroupsTypesEnum>, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<GroupsEntity>;
3581
+ /**
3582
+ * Retrieve a paginated list of resources for your organization. Resources can be documents, consents, forms.
3583
+ * @summary Get Resources
3584
+ * @param {number} [pageIndex] Page number
3585
+ * @param {number} [pageSize] Number of items per page
3586
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3587
+ * @param {boolean} [active] Filter by active status. Accepts true/false as string or boolean.
3588
+ * @param {Array<GetResourcesTypesEnum>} [types] Filter by resource types. Can be a single value or array
3589
+ * @param {string} [internalId] Identifier to help you identify the resource in your own system. We recommend using a unique value.
3590
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3591
+ * @param {*} [options] Override http request option.
3592
+ * @throws {RequiredError}
3593
+ */
3594
+ getResources(pageIndex?: number, pageSize?: number, search?: string, active?: boolean, types?: Array<GetResourcesTypesEnum>, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResourcesEntity>;
3595
+ };
3596
+ /**
3597
+ * ResourceApi - object-oriented interface
3598
+ * @export
3599
+ * @class ResourceApi
3600
+ * @extends {BaseAPI}
3601
+ */
3602
+ declare class ResourceApi extends BaseAPI {
3603
+ /**
3604
+ * Retrieve information about the existing groups, including its resources, and the total number of pages. Resource groups allow to pack resources together and easily request them.
3605
+ * @summary Get Groups
3606
+ * @param {number} [pageIndex] Page number
3607
+ * @param {number} [pageSize] Number of items per page
3608
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3609
+ * @param {boolean} [active] Filter by active status. Accepts true/false as string or boolean.
3610
+ * @param {Array<GetGroupsTypesEnum>} [types] Filter by resource types. Can be a single value or array
3611
+ * @param {string} [internalId] Identifier to help you identify the resource in your own system. We recommend using a unique value.
3612
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3613
+ * @param {*} [options] Override http request option.
3614
+ * @throws {RequiredError}
3615
+ * @memberof ResourceApi
3616
+ */
3617
+ getGroups(pageIndex?: number, pageSize?: number, search?: string, active?: boolean, types?: Array<GetGroupsTypesEnum>, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GroupsEntity, any, {}>>;
3618
+ /**
3619
+ * Retrieve a paginated list of resources for your organization. Resources can be documents, consents, forms.
3620
+ * @summary Get Resources
3621
+ * @param {number} [pageIndex] Page number
3622
+ * @param {number} [pageSize] Number of items per page
3623
+ * @param {string} [search] Search query to filter by. Is case-insensitive and does not need to match the entire value.
3624
+ * @param {boolean} [active] Filter by active status. Accepts true/false as string or boolean.
3625
+ * @param {Array<GetResourcesTypesEnum>} [types] Filter by resource types. Can be a single value or array
3626
+ * @param {string} [internalId] Identifier to help you identify the resource in your own system. We recommend using a unique value.
3627
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3628
+ * @param {*} [options] Override http request option.
3629
+ * @throws {RequiredError}
3630
+ * @memberof ResourceApi
3631
+ */
3632
+ getResources(pageIndex?: number, pageSize?: number, search?: string, active?: boolean, types?: Array<GetResourcesTypesEnum>, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ResourcesEntity, any, {}>>;
3633
+ }
3634
+ /**
3635
+ * @export
3636
+ */
3637
+ declare const GetGroupsTypesEnum: {
3638
+ readonly Consent: "CONSENT";
3639
+ readonly Form: "FORM";
3640
+ readonly Document: "DOCUMENT";
3641
+ readonly Json: "JSON";
3642
+ };
3643
+ type GetGroupsTypesEnum = typeof GetGroupsTypesEnum[keyof typeof GetGroupsTypesEnum];
3644
+ /**
3645
+ * @export
3646
+ */
3647
+ declare const GetResourcesTypesEnum: {
3648
+ readonly Consent: "CONSENT";
3649
+ readonly Form: "FORM";
3650
+ readonly Document: "DOCUMENT";
3651
+ readonly Json: "JSON";
3652
+ };
3653
+ type GetResourcesTypesEnum = typeof GetResourcesTypesEnum[keyof typeof GetResourcesTypesEnum];
3654
+
3655
+ /**
3656
+ * UserApi - axios parameter creator
3657
+ * @export
3658
+ */
3659
+ declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
3660
+ /**
3661
+ * This endpoint allows organizations to import their existing users information into Humanos, for better management and control. - Multiple users can be created in a call. - A user can be created with just a contact (email or phone). - Optionally, additional identity information (KYC) can be included. - Optionally, organizations can attach an internal Id to allow mapping users within their database.
3662
+ * @summary Create User
3663
+ * @param {Array<CreateSubjectDto>} createSubjectDto Array of subjects to create. Each subject represents a user to be imported into Humanos
3664
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3665
+ * @param {*} [options] Override http request option.
3666
+ * @throws {RequiredError}
3667
+ */
3668
+ create: (createSubjectDto: Array<CreateSubjectDto>, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3669
+ /**
3670
+ * Retrieves detailed information about a user. Can and must be searched by only one of the following: contact, did, or internalId
3671
+ * @summary Get User
3672
+ * @param {string} [contact] Contact value (email or phone)
3673
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3674
+ * @param {string} [internalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3675
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3676
+ * @param {*} [options] Override http request option.
3677
+ * @throws {RequiredError}
3678
+ */
3679
+ getSubject: (contact?: string, did?: string, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3680
+ };
3681
+ /**
3682
+ * UserApi - functional programming interface
3683
+ * @export
3684
+ */
3685
+ declare const UserApiFp: (configuration?: Configuration) => {
3686
+ /**
3687
+ * This endpoint allows organizations to import their existing users information into Humanos, for better management and control. - Multiple users can be created in a call. - A user can be created with just a contact (email or phone). - Optionally, additional identity information (KYC) can be included. - Optionally, organizations can attach an internal Id to allow mapping users within their database.
3688
+ * @summary Create User
3689
+ * @param {Array<CreateSubjectDto>} createSubjectDto Array of subjects to create. Each subject represents a user to be imported into Humanos
3690
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3691
+ * @param {*} [options] Override http request option.
3692
+ * @throws {RequiredError}
3693
+ */
3694
+ create(createSubjectDto: Array<CreateSubjectDto>, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CreateSubjectEntity>>>;
3695
+ /**
3696
+ * Retrieves detailed information about a user. Can and must be searched by only one of the following: contact, did, or internalId
3697
+ * @summary Get User
3698
+ * @param {string} [contact] Contact value (email or phone)
3699
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3700
+ * @param {string} [internalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3701
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3702
+ * @param {*} [options] Override http request option.
3703
+ * @throws {RequiredError}
3704
+ */
3705
+ getSubject(contact?: string, did?: string, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubjectEntity>>;
3706
+ };
3707
+ /**
3708
+ * UserApi - factory interface
3709
+ * @export
3710
+ */
3711
+ declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3712
+ /**
3713
+ * This endpoint allows organizations to import their existing users information into Humanos, for better management and control. - Multiple users can be created in a call. - A user can be created with just a contact (email or phone). - Optionally, additional identity information (KYC) can be included. - Optionally, organizations can attach an internal Id to allow mapping users within their database.
3714
+ * @summary Create User
3715
+ * @param {Array<CreateSubjectDto>} createSubjectDto Array of subjects to create. Each subject represents a user to be imported into Humanos
3716
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3717
+ * @param {*} [options] Override http request option.
3718
+ * @throws {RequiredError}
3719
+ */
3720
+ create(createSubjectDto: Array<CreateSubjectDto>, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CreateSubjectEntity>>;
3721
+ /**
3722
+ * Retrieves detailed information about a user. Can and must be searched by only one of the following: contact, did, or internalId
3723
+ * @summary Get User
3724
+ * @param {string} [contact] Contact value (email or phone)
3725
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3726
+ * @param {string} [internalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3727
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3728
+ * @param {*} [options] Override http request option.
3729
+ * @throws {RequiredError}
3730
+ */
3731
+ getSubject(contact?: string, did?: string, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): AxiosPromise<SubjectEntity>;
3732
+ };
3733
+ /**
3734
+ * UserApi - object-oriented interface
3735
+ * @export
3736
+ * @class UserApi
3737
+ * @extends {BaseAPI}
3738
+ */
3739
+ declare class UserApi extends BaseAPI {
3740
+ /**
3741
+ * This endpoint allows organizations to import their existing users information into Humanos, for better management and control. - Multiple users can be created in a call. - A user can be created with just a contact (email or phone). - Optionally, additional identity information (KYC) can be included. - Optionally, organizations can attach an internal Id to allow mapping users within their database.
3742
+ * @summary Create User
3743
+ * @param {Array<CreateSubjectDto>} createSubjectDto Array of subjects to create. Each subject represents a user to be imported into Humanos
3744
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3745
+ * @param {*} [options] Override http request option.
3746
+ * @throws {RequiredError}
3747
+ * @memberof UserApi
3748
+ */
3749
+ create(createSubjectDto: Array<CreateSubjectDto>, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateSubjectEntity[], any, {}>>;
3750
+ /**
3751
+ * Retrieves detailed information about a user. Can and must be searched by only one of the following: contact, did, or internalId
3752
+ * @summary Get User
3753
+ * @param {string} [contact] Contact value (email or phone)
3754
+ * @param {string} [did] Public Decentralized Identifier (DID) of the user
3755
+ * @param {string} [internalId] Identifier to help you identify the user in your own system. We recommend using a unique value.
3756
+ * @param {string} [aPIVersion] Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today\&#39;s date.
3757
+ * @param {*} [options] Override http request option.
3758
+ * @throws {RequiredError}
3759
+ * @memberof UserApi
3760
+ */
3761
+ getSubject(contact?: string, did?: string, internalId?: string, aPIVersion?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<SubjectEntity, any, {}>>;
3762
+ }
3763
+
3764
+ /** The API version this SDK release is pinned to (YYYY-MM-DD). */
3765
+ declare const API_VERSION = "2026-03-24";
3766
+ /** Identifies this SDK's language in request headers. */
3767
+ declare const SDK_LANGUAGE = "typescript";
3768
+ interface HumanosClientConfig {
3769
+ /** Base URL for the Humanos API (e.g., https://api.humanos.id) */
3770
+ basePath: string;
3771
+ /** Your API key from Humanos */
3772
+ apiKey: string;
3773
+ /** Your signature secret from Humanos */
3774
+ signatureSecret: string;
3775
+ /** Optional: Custom axios instance configuration */
3776
+ axiosConfig?: Parameters<typeof axios__default.create>[0];
3777
+ }
3778
+ /**
3779
+ * Humanos API Client with automatic request signing
3780
+ *
3781
+ * All API requests made through this client automatically include
3782
+ * the required X-Timestamp and X-Signature headers.
3783
+ *
3784
+ * @example
3785
+ * ```typescript
3786
+ * const client = new HumanosClient({
3787
+ * basePath: 'https://api.humanos.id',
3788
+ * apiKey: 'your-api-key',
3789
+ * signatureSecret: 'your-signature-secret',
3790
+ * });
3791
+ *
3792
+ * // All requests are automatically signed
3793
+ * const requests = await client.requests.getRequests();
3794
+ * const resources = await client.resources.getResources();
3795
+ * ```
3796
+ */
3797
+ declare class HumanosClient {
3798
+ /** API for managing credential requests */
3799
+ readonly requests: RequestsApi;
3800
+ /** API for managing resources (documents, consents, forms, products) */
3801
+ readonly resources: ResourceApi;
3802
+ /** API for managing users */
3803
+ readonly users: UserApi;
3804
+ /** The underlying axios instance (for advanced use cases) */
3805
+ readonly axios: AxiosInstance;
3806
+ /** The API configuration */
3807
+ readonly config: Configuration;
3808
+ constructor(clientConfig: HumanosClientConfig);
3809
+ }
3810
+ /**
3811
+ * Create a pre-configured Humanos client
3812
+ * Convenience function for creating a client with automatic signing
3813
+ *
3814
+ * @example
3815
+ * ```typescript
3816
+ * const client = createHumanosClient({
3817
+ * basePath: process.env.HUMANOS_API_URL,
3818
+ * apiKey: process.env.HUMANOS_API_KEY,
3819
+ * signatureSecret: process.env.HUMANOS_SIGNATURE_SECRET,
3820
+ * });
3821
+ * ```
3822
+ */
3823
+ declare function createHumanosClient(config: HumanosClientConfig): HumanosClient;
3824
+
3825
+ /**
3826
+ * Generate HMAC-SHA256 signature for API requests
3827
+ * @param body - Request body (will be JSON stringified)
3828
+ * @param signatureSecret - Your signature secret from Humanos
3829
+ * @param timestamp - Unix timestamp in milliseconds
3830
+ * @returns Hex-encoded HMAC-SHA256 signature
3831
+ */
3832
+ declare function generateSignature(body: unknown, signatureSecret: string, timestamp: number): string;
3833
+ /**
3834
+ * Create an axios request interceptor that automatically adds signature headers
3835
+ * @param signatureSecret - Your signature secret from Humanos
3836
+ * @returns Axios request interceptor function
3837
+ */
3838
+ declare function createSignatureInterceptor(signatureSecret: string): (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig;
3839
+ /**
3840
+ * Apply signature interceptor to an axios instance
3841
+ * All requests made with this instance will automatically include signature headers
3842
+ * @param axiosInstance - Axios instance to configure
3843
+ * @param signatureSecret - Your signature secret from Humanos
3844
+ */
3845
+ declare function applySignatureInterceptor(axiosInstance: AxiosInstance, signatureSecret: string): void;
3846
+
3847
+ interface WebhookHeaders {
3848
+ "x-signature": string;
3849
+ "x-timestamp": string;
3850
+ }
3851
+ interface EncryptedPayload {
3852
+ iv: string;
3853
+ data: string;
3854
+ tag: string;
3855
+ }
3856
+ interface WebhookConfig {
3857
+ signatureSecret: string;
3858
+ encryptionSecret: string;
3859
+ encryptionSalt: string;
3860
+ /** Tolerance for timestamp validation in milliseconds (default: 5 minutes) */
3861
+ toleranceMs?: number;
3862
+ }
3863
+ /**
3864
+ * Verify webhook signature from Humanos
3865
+ * @param payload - Raw request body as string
3866
+ * @param signature - Value from x-signature header
3867
+ * @param timestamp - Value from x-timestamp header (as number)
3868
+ * @param signatureSecret - Your signature secret
3869
+ * @param toleranceMs - Maximum allowed time difference in ms (default: 5 minutes)
3870
+ * @returns true if signature is valid
3871
+ */
3872
+ declare function verifyWebhookSignature(payload: string, signature: string, timestamp: number, signatureSecret: string, toleranceMs?: number): boolean;
3873
+ /**
3874
+ * Decrypt webhook payload using AES-256-GCM
3875
+ * @param encryptedPayload - The encrypted payload object with iv, data, and tag
3876
+ * @param encryptionSecret - Your encryption secret (base64 encoded)
3877
+ * @param encryptionSalt - Your encryption salt
3878
+ * @returns Decrypted payload as parsed JSON
3879
+ */
3880
+ declare function decryptWebhookPayload<T = unknown>(encryptedPayload: EncryptedPayload, encryptionSecret: string, encryptionSalt: string): T;
3881
+ /**
3882
+ * Verify and decrypt a webhook in one step
3883
+ * @param rawBody - Raw request body as string (for signature verification)
3884
+ * @param headers - Request headers containing x-signature and x-timestamp
3885
+ * @param config - Webhook configuration with secrets
3886
+ * @returns Decrypted and verified webhook payload
3887
+ * @throws Error if signature is invalid or decryption fails
3888
+ */
3889
+ declare function processWebhook<T = unknown>(rawBody: string, headers: WebhookHeaders | Record<string, string>, config: WebhookConfig): T;
3890
+ /**
3891
+ * Express middleware for handling Humanos webhooks
3892
+ * @param config - Webhook configuration with secrets
3893
+ * @param handler - Function to handle the decrypted webhook payload
3894
+ * @returns Express request handler
3895
+ */
3896
+ declare function createWebhookHandler<T = unknown>(config: WebhookConfig, handler: (payload: T) => void | Promise<void>): (req: any, res: any) => Promise<void>;
3897
+
3898
+ export { API_VERSION, ActionType, type AgentDetailEntity, type CancelRequest404Response, Configuration, type ConfigurationParameters, type CreateSubjectDto, type CreateSubjectEntity, CreateSubjectEntityStatusEnum, type CredentialDto, type CredentialEntity, CredentialEntityStatusEnum, type CredentialEvent, type CredentialEventUser, type CredentialFullEntity, CredentialFullEntityStatusEnum, CredentialStatus, type CredentialSubject, CredentialsApi, CredentialsApiAxiosParamCreator, CredentialsApiFactory, CredentialsApiFp, DeliveryActionType, type EncryptedPayload, type Generate400Response, type GenerateCredentialEntity, type GenerateRequestDto, GenerateRequestDtoSecurityLevelEnum, type GenerateRequestEntity, type GenerateSubjectEntity, type GetCredential404Response, type GetCredentialEntity, GetGroupsTypesEnum, type GetRequestDetail404Response, GetRequestsSecurityLevelEnum, GetResourcesTypesEnum, type GetSubject400Response, type GetSubject404Response, type GroupEntity, type GroupResourceEntity, GroupResourceEntityTypeEnum, type GroupsEntity, HumanosClient, type HumanosClientConfig, type IdentityDto, type IdentityEvent, type IdentityEventDecision, type IdentityEventIdentity, type IdentityFieldPlacement, IdentityFieldType, type IssuerDetailEntity, type MandateDataDto, type MandateDataDtoType, MandateDataDtoTypeEnum, type MandateDataDtoValue, MandateDataType, type OtpFailedEvent, type OtpFailedEventOtp, type OtpFailedEventOtpError, type RequestDetailEntity, RequestDetailEntitySecurityLevelEnum, type RequestEntity, RequestEntitySecurityLevelEnum, type RequestQuery, RequestQuerySecurityLevelEnum, type RequestSubjectEntity, RequestsApi, RequestsApiAxiosParamCreator, RequestsApiFactory, RequestsApiFp, type RequestsEntity, ResourceApi, ResourceApiAxiosParamCreator, ResourceApiFactory, ResourceApiFp, type ResourceEntity, ResourceEntityTypeEnum, type ResourceQuery, ResourceQueryTypesEnum, type ResourcesEntity, SDK_LANGUAGE, type SignaturePlacement, type SignaturePlacementItemDto, type Subject, type SubjectContactEntity, type SubjectEntity, type SubjectQuery, type SuccessEntity, type TestEvent, UserApi, UserApiAxiosParamCreator, UserApiFactory, UserApiFp, type W3CProof, W3CProofActionTypeEnum, type W3CVerifiableCredential, type WebhookCallEvent, type WebhookConfig, WebhookEventType, WebhookEventTypeCREDENTIAL, WebhookEventTypeIDENTITY, WebhookEventTypeOTPFAILED, WebhookEventTypeTEST, type WebhookHeaders, applySignatureInterceptor, createHumanosClient, createSignatureInterceptor, createWebhookHandler, decryptWebhookPayload, generateSignature, processWebhook, verifyWebhookSignature };