@ogcio/building-blocks-sdk 0.1.18 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/.gitleaksignore +2 -0
  2. package/.release-please-manifest.json +1 -1
  3. package/CHANGELOG.md +11 -0
  4. package/dist/client/clients/featureFlags/schema.d.ts +205 -63
  5. package/dist/client/clients/featureFlags/schema.d.ts.map +1 -1
  6. package/dist/client/clients/messaging/index.d.ts +2 -1835
  7. package/dist/client/clients/messaging/index.d.ts.map +1 -1
  8. package/dist/client/clients/messaging/index.js +3 -179
  9. package/dist/client/clients/messaging/index.js.map +1 -1
  10. package/dist/client/clients/messaging/schema.d.ts +2763 -2750
  11. package/dist/client/clients/messaging/schema.d.ts.map +1 -1
  12. package/dist/client/clients/profile/index.d.ts +852 -440
  13. package/dist/client/clients/profile/index.d.ts.map +1 -1
  14. package/dist/client/clients/profile/index.js +88 -54
  15. package/dist/client/clients/profile/index.js.map +1 -1
  16. package/dist/client/clients/profile/schema.d.ts +1237 -1114
  17. package/dist/client/clients/profile/schema.d.ts.map +1 -1
  18. package/dist/clients-configurations/clients-configuration.json +5 -4
  19. package/package.json +1 -1
  20. package/src/client/clients/featureFlags/open-api-definition.json +184 -95
  21. package/src/client/clients/featureFlags/schema.ts +205 -63
  22. package/src/client/clients/messaging/index.ts +2 -278
  23. package/src/client/clients/messaging/open-api-definition.json +30 -18
  24. package/src/client/clients/messaging/schema.ts +2763 -2750
  25. package/src/client/clients/profile/index.ts +140 -84
  26. package/src/client/clients/profile/open-api-definition.json +1825 -1323
  27. package/src/client/clients/profile/schema.ts +1237 -1114
  28. package/src/clients-configurations/clients-configuration.json +5 -4
@@ -1,36 +1,59 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "title": "OGCIO Profile API",
5
- "description": "API for OGCIO Profile Service",
6
- "version": "0.1.0"
4
+ "title": "Life Events Profile API",
5
+ "description": "API for Life Events Profile Service",
6
+ "version": "0.0.1"
7
7
  },
8
8
  "components": {
9
+ "securitySchemes": {
10
+ "bearerAuth": {
11
+ "type": "http",
12
+ "scheme": "bearer",
13
+ "bearerFormat": "JWT"
14
+ }
15
+ },
9
16
  "schemas": {}
10
17
  },
11
18
  "paths": {
12
- "/health": {
13
- "get": {
14
- "responses": {
15
- "200": {
16
- "description": "Default Response"
17
- }
18
- }
19
- }
20
- },
21
- "/user-login-wh": {
22
- "post": {
23
- "responses": {
24
- "200": {
25
- "description": "Default Response"
26
- }
27
- }
28
- }
29
- },
30
- "/api/v1/addresses/": {
19
+ "/api/v1/profiles/": {
31
20
  "get": {
21
+ "operationId": "indexProfiles",
32
22
  "tags": [
33
- "Addresses"
23
+ "Profiles"
24
+ ],
25
+ "parameters": [
26
+ {
27
+ "schema": {
28
+ "type": "string"
29
+ },
30
+ "in": "query",
31
+ "name": "search",
32
+ "required": false,
33
+ "description": "If set, the endpoint searches for users whom contain this value in either the public name or the email address"
34
+ },
35
+ {
36
+ "schema": {
37
+ "pattern": "^[0-9][0-9]*|undefined$",
38
+ "default": "0",
39
+ "type": "string"
40
+ },
41
+ "in": "query",
42
+ "name": "offset",
43
+ "required": false,
44
+ "description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
45
+ },
46
+ {
47
+ "schema": {
48
+ "default": "20",
49
+ "pattern": "^([1-9]|100)|undefined$",
50
+ "type": "string"
51
+ },
52
+ "in": "query",
53
+ "name": "limit",
54
+ "required": false,
55
+ "description": "Indicates the maximum number (100) of items that will be returned in a single request"
56
+ }
34
57
  ],
35
58
  "responses": {
36
59
  "200": {
@@ -45,48 +68,44 @@
45
68
  "items": {
46
69
  "type": "object",
47
70
  "properties": {
48
- "addressId": {
49
- "type": "string"
50
- },
51
- "addressLine1": {
52
- "type": "string"
53
- },
54
- "addressLine2": {
71
+ "id": {
55
72
  "type": "string"
56
73
  },
57
- "town": {
74
+ "publicName": {
58
75
  "type": "string"
59
76
  },
60
- "county": {
77
+ "email": {
78
+ "format": "email",
61
79
  "type": "string"
62
80
  },
63
- "eirecode": {
81
+ "primaryUserId": {
64
82
  "type": "string"
65
83
  },
66
- "updatedAt": {
67
- "type": "string"
84
+ "safeLevel": {
85
+ "type": "number"
68
86
  },
69
- "moveInDate": {
70
- "type": "string"
87
+ "preferredLanguage": {
88
+ "type": "string",
89
+ "enum": [
90
+ "en",
91
+ "ga"
92
+ ],
93
+ "default": "en"
71
94
  },
72
- "moveOutDate": {
95
+ "createdAt": {
96
+ "format": "date-time",
73
97
  "type": "string"
74
98
  },
75
- "isPrimary": {
76
- "type": "boolean"
77
- },
78
- "ownershipStatus": {
99
+ "updatedAt": {
100
+ "format": "date-time",
79
101
  "type": "string"
80
102
  }
81
103
  },
82
104
  "required": [
83
- "addressId",
84
- "addressLine1",
85
- "addressLine2",
86
- "town",
87
- "county",
88
- "eirecode",
89
- "updatedAt"
105
+ "id",
106
+ "publicName",
107
+ "email",
108
+ "primaryUserId"
90
109
  ]
91
110
  }
92
111
  },
@@ -176,7 +195,7 @@
176
195
  }
177
196
  }
178
197
  },
179
- "500": {
198
+ "4XX": {
180
199
  "description": "Default Response",
181
200
  "content": {
182
201
  "application/json": {
@@ -184,18 +203,40 @@
184
203
  "type": "object",
185
204
  "properties": {
186
205
  "code": {
206
+ "description": "Code used to categorize the error",
187
207
  "type": "string"
188
208
  },
189
209
  "detail": {
210
+ "description": "Description of the error",
190
211
  "type": "string"
191
212
  },
192
213
  "requestId": {
214
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
193
215
  "type": "string"
194
216
  },
195
217
  "name": {
218
+ "description": "Name of the error type",
196
219
  "type": "string"
197
220
  },
198
- "validation": {},
221
+ "validation": {
222
+ "description": "List of the validation errors",
223
+ "type": "array",
224
+ "items": {
225
+ "type": "object",
226
+ "properties": {
227
+ "fieldName": {
228
+ "type": "string"
229
+ },
230
+ "message": {
231
+ "type": "string"
232
+ }
233
+ },
234
+ "required": [
235
+ "fieldName",
236
+ "message"
237
+ ]
238
+ }
239
+ },
199
240
  "validationContext": {
200
241
  "type": "string"
201
242
  }
@@ -209,158 +250,8 @@
209
250
  }
210
251
  }
211
252
  }
212
- }
213
- }
214
- },
215
- "post": {
216
- "tags": [
217
- "Addresses"
218
- ],
219
- "requestBody": {
220
- "content": {
221
- "application/json": {
222
- "schema": {
223
- "type": "object",
224
- "properties": {
225
- "addressLine1": {
226
- "type": "string"
227
- },
228
- "addressLine2": {
229
- "type": "string"
230
- },
231
- "town": {
232
- "type": "string"
233
- },
234
- "county": {
235
- "type": "string"
236
- },
237
- "eirecode": {
238
- "type": "string"
239
- },
240
- "moveInDate": {
241
- "type": "string"
242
- },
243
- "moveOutDate": {
244
- "type": "string"
245
- }
246
- },
247
- "required": [
248
- "addressLine1",
249
- "town",
250
- "county",
251
- "eirecode"
252
- ]
253
- }
254
- }
255
- },
256
- "required": true
257
- },
258
- "responses": {
259
- "200": {
260
- "description": "Default Response",
261
- "content": {
262
- "application/json": {
263
- "schema": {
264
- "type": "object",
265
- "properties": {
266
- "data": {
267
- "type": "object",
268
- "properties": {
269
- "id": {
270
- "type": "string"
271
- }
272
- },
273
- "required": [
274
- "id"
275
- ]
276
- },
277
- "metadata": {
278
- "type": "object",
279
- "properties": {
280
- "links": {
281
- "description": "Object containing the links to the related endpoints",
282
- "type": "object",
283
- "properties": {
284
- "self": {
285
- "type": "object",
286
- "properties": {
287
- "href": {
288
- "description": "URL pointing to the request itself",
289
- "type": "string"
290
- }
291
- }
292
- },
293
- "next": {
294
- "type": "object",
295
- "properties": {
296
- "href": {
297
- "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
298
- "type": "string"
299
- }
300
- }
301
- },
302
- "prev": {
303
- "type": "object",
304
- "properties": {
305
- "href": {
306
- "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
307
- "type": "string"
308
- }
309
- }
310
- },
311
- "first": {
312
- "type": "object",
313
- "properties": {
314
- "href": {
315
- "description": "URL pointing to the first page of results in a paginated response",
316
- "type": "string"
317
- }
318
- }
319
- },
320
- "last": {
321
- "type": "object",
322
- "properties": {
323
- "href": {
324
- "description": "URL pointing to the first page of results in a paginated response",
325
- "type": "string"
326
- }
327
- }
328
- },
329
- "pages": {
330
- "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
331
- "type": "object",
332
- "additionalProperties": {
333
- "type": "object",
334
- "properties": {
335
- "href": {
336
- "type": "string"
337
- }
338
- }
339
- }
340
- }
341
- },
342
- "required": [
343
- "self",
344
- "first",
345
- "last",
346
- "pages"
347
- ]
348
- },
349
- "totalCount": {
350
- "description": "Number representing the total number of available items",
351
- "type": "number"
352
- }
353
- }
354
- }
355
- },
356
- "required": [
357
- "data"
358
- ]
359
- }
360
- }
361
- }
362
253
  },
363
- "500": {
254
+ "5XX": {
364
255
  "description": "Default Response",
365
256
  "content": {
366
257
  "application/json": {
@@ -368,18 +259,40 @@
368
259
  "type": "object",
369
260
  "properties": {
370
261
  "code": {
262
+ "description": "Code used to categorize the error",
371
263
  "type": "string"
372
264
  },
373
265
  "detail": {
266
+ "description": "Description of the error",
374
267
  "type": "string"
375
268
  },
376
269
  "requestId": {
270
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
377
271
  "type": "string"
378
272
  },
379
273
  "name": {
274
+ "description": "Name of the error type",
380
275
  "type": "string"
381
276
  },
382
- "validation": {},
277
+ "validation": {
278
+ "description": "List of the validation errors",
279
+ "type": "array",
280
+ "items": {
281
+ "type": "object",
282
+ "properties": {
283
+ "fieldName": {
284
+ "type": "string"
285
+ },
286
+ "message": {
287
+ "type": "string"
288
+ }
289
+ },
290
+ "required": [
291
+ "fieldName",
292
+ "message"
293
+ ]
294
+ }
295
+ },
383
296
  "validationContext": {
384
297
  "type": "string"
385
298
  }
@@ -397,605 +310,208 @@
397
310
  }
398
311
  }
399
312
  },
400
- "/api/v1/addresses/{addressId}": {
401
- "get": {
313
+ "/api/v1/profiles/import-profiles": {
314
+ "post": {
315
+ "operationId": "importProfiles",
402
316
  "tags": [
403
- "Addresses"
404
- ],
405
- "parameters": [
406
- {
407
- "schema": {
408
- "type": "string"
409
- },
410
- "in": "path",
411
- "name": "addressId",
412
- "required": true
413
- }
317
+ "Profiles"
414
318
  ],
415
- "responses": {
416
- "200": {
417
- "description": "Default Response",
418
- "content": {
419
- "application/json": {
420
- "schema": {
421
- "type": "object",
422
- "properties": {
423
- "data": {
319
+ "requestBody": {
320
+ "content": {
321
+ "application/json": {
322
+ "schema": {
323
+ "type": "object",
324
+ "properties": {
325
+ "profiles": {
326
+ "minItems": 1,
327
+ "type": "array",
328
+ "items": {
424
329
  "type": "object",
425
330
  "properties": {
426
- "addressId": {
331
+ "email": {
332
+ "format": "email",
427
333
  "type": "string"
428
334
  },
429
- "addressLine1": {
335
+ "firstName": {
430
336
  "type": "string"
431
337
  },
432
- "addressLine2": {
338
+ "lastName": {
433
339
  "type": "string"
434
340
  },
435
- "town": {
341
+ "city": {
436
342
  "type": "string"
437
343
  },
438
- "county": {
344
+ "address": {
439
345
  "type": "string"
440
346
  },
441
- "eirecode": {
347
+ "phone": {
442
348
  "type": "string"
443
349
  },
444
- "updatedAt": {
350
+ "dateOfBirth": {
351
+ "format": "date",
445
352
  "type": "string"
446
353
  },
447
- "moveInDate": {
354
+ "ppsn": {
448
355
  "type": "string"
449
356
  },
450
- "moveOutDate": {
451
- "type": "string"
452
- },
453
- "isPrimary": {
454
- "type": "boolean"
455
- },
456
- "ownershipStatus": {
457
- "type": "string"
357
+ "preferredLanguage": {
358
+ "type": "string",
359
+ "enum": [
360
+ "en",
361
+ "ga"
362
+ ],
363
+ "default": "en"
458
364
  }
459
365
  },
460
366
  "required": [
461
- "addressId",
462
- "addressLine1",
463
- "addressLine2",
464
- "town",
465
- "county",
466
- "eirecode",
467
- "updatedAt"
367
+ "email",
368
+ "firstName",
369
+ "lastName"
468
370
  ]
469
- },
470
- "metadata": {
471
- "type": "object",
472
- "properties": {
473
- "links": {
474
- "description": "Object containing the links to the related endpoints",
475
- "type": "object",
476
- "properties": {
477
- "self": {
478
- "type": "object",
479
- "properties": {
480
- "href": {
481
- "description": "URL pointing to the request itself",
482
- "type": "string"
483
- }
484
- }
485
- },
486
- "next": {
487
- "type": "object",
488
- "properties": {
489
- "href": {
490
- "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
491
- "type": "string"
492
- }
493
- }
494
- },
495
- "prev": {
496
- "type": "object",
497
- "properties": {
498
- "href": {
499
- "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
500
- "type": "string"
501
- }
502
- }
503
- },
504
- "first": {
505
- "type": "object",
506
- "properties": {
507
- "href": {
508
- "description": "URL pointing to the first page of results in a paginated response",
509
- "type": "string"
510
- }
511
- }
512
- },
513
- "last": {
514
- "type": "object",
515
- "properties": {
516
- "href": {
517
- "description": "URL pointing to the first page of results in a paginated response",
518
- "type": "string"
519
- }
520
- }
521
- },
522
- "pages": {
523
- "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
524
- "type": "object",
525
- "additionalProperties": {
526
- "type": "object",
527
- "properties": {
528
- "href": {
529
- "type": "string"
530
- }
531
- }
532
- }
533
- }
534
- },
535
- "required": [
536
- "self",
537
- "first",
538
- "last",
539
- "pages"
540
- ]
541
- },
542
- "totalCount": {
543
- "description": "Number representing the total number of available items",
544
- "type": "number"
545
- }
546
- }
547
- }
548
- },
549
- "required": [
550
- "data"
551
- ]
552
- }
553
- }
554
- }
555
- },
556
- "404": {
557
- "description": "Default Response",
558
- "content": {
559
- "application/json": {
560
- "schema": {
561
- "type": "object",
562
- "properties": {
563
- "code": {
564
- "type": "string"
565
- },
566
- "detail": {
567
- "type": "string"
568
- },
569
- "requestId": {
570
- "type": "string"
571
- },
572
- "name": {
573
- "type": "string"
574
- },
575
- "validation": {},
576
- "validationContext": {
577
- "type": "string"
578
- }
579
- },
580
- "required": [
581
- "code",
582
- "detail",
583
- "requestId",
584
- "name"
585
- ]
586
- }
587
- }
588
- }
589
- },
590
- "500": {
591
- "description": "Default Response",
592
- "content": {
593
- "application/json": {
594
- "schema": {
595
- "type": "object",
596
- "properties": {
597
- "code": {
598
- "type": "string"
599
- },
600
- "detail": {
601
- "type": "string"
602
- },
603
- "requestId": {
604
- "type": "string"
605
- },
606
- "name": {
607
- "type": "string"
608
- },
609
- "validation": {},
610
- "validationContext": {
611
- "type": "string"
612
371
  }
613
372
  },
614
- "required": [
615
- "code",
616
- "detail",
617
- "requestId",
618
- "name"
619
- ]
373
+ "file": {}
620
374
  }
621
375
  }
622
- }
623
- }
624
- }
625
- },
626
- "put": {
627
- "tags": [
628
- "Addresses"
629
- ],
630
- "requestBody": {
631
- "content": {
632
- "application/json": {
376
+ },
377
+ "multipart/form-data": {
633
378
  "schema": {
634
379
  "type": "object",
635
380
  "properties": {
636
- "addressLine1": {
637
- "type": "string"
638
- },
639
- "addressLine2": {
640
- "type": "string"
641
- },
642
- "town": {
643
- "type": "string"
644
- },
645
- "county": {
646
- "type": "string"
647
- },
648
- "eirecode": {
649
- "type": "string"
650
- },
651
- "moveInDate": {
652
- "type": "string"
653
- },
654
- "moveOutDate": {
655
- "type": "string"
656
- },
657
- "isPrimary": {
658
- "type": "boolean"
659
- },
660
- "ownershipStatus": {
661
- "type": "string"
662
- }
663
- },
664
- "required": [
665
- "addressLine1",
666
- "town",
667
- "county",
668
- "eirecode",
669
- "isPrimary",
670
- "ownershipStatus"
671
- ]
672
- }
673
- }
674
- },
675
- "required": true
676
- },
677
- "parameters": [
678
- {
679
- "schema": {
680
- "type": "string"
681
- },
682
- "in": "path",
683
- "name": "addressId",
684
- "required": true
685
- }
686
- ],
687
- "responses": {
688
- "200": {
689
- "description": "Default Response",
690
- "content": {
691
- "application/json": {
692
- "schema": {
693
- "type": "object",
694
- "properties": {
695
- "data": {
381
+ "profiles": {
382
+ "minItems": 1,
383
+ "type": "array",
384
+ "items": {
696
385
  "type": "object",
697
386
  "properties": {
698
- "id": {
387
+ "email": {
388
+ "format": "email",
389
+ "type": "string"
390
+ },
391
+ "firstName": {
392
+ "type": "string"
393
+ },
394
+ "lastName": {
395
+ "type": "string"
396
+ },
397
+ "city": {
398
+ "type": "string"
399
+ },
400
+ "address": {
401
+ "type": "string"
402
+ },
403
+ "phone": {
404
+ "type": "string"
405
+ },
406
+ "dateOfBirth": {
407
+ "format": "date",
408
+ "type": "string"
409
+ },
410
+ "ppsn": {
699
411
  "type": "string"
412
+ },
413
+ "preferredLanguage": {
414
+ "type": "string",
415
+ "enum": [
416
+ "en",
417
+ "ga"
418
+ ],
419
+ "default": "en"
700
420
  }
701
421
  },
702
422
  "required": [
703
- "id"
423
+ "email",
424
+ "firstName",
425
+ "lastName"
704
426
  ]
705
- },
706
- "metadata": {
427
+ }
428
+ },
429
+ "file": {}
430
+ }
431
+ }
432
+ },
433
+ "text/csv": {
434
+ "schema": {
435
+ "type": "object",
436
+ "properties": {
437
+ "profiles": {
438
+ "minItems": 1,
439
+ "type": "array",
440
+ "items": {
707
441
  "type": "object",
708
442
  "properties": {
709
- "links": {
710
- "description": "Object containing the links to the related endpoints",
711
- "type": "object",
712
- "properties": {
713
- "self": {
714
- "type": "object",
715
- "properties": {
716
- "href": {
717
- "description": "URL pointing to the request itself",
718
- "type": "string"
719
- }
720
- }
721
- },
722
- "next": {
723
- "type": "object",
724
- "properties": {
725
- "href": {
726
- "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
727
- "type": "string"
728
- }
729
- }
730
- },
731
- "prev": {
732
- "type": "object",
733
- "properties": {
734
- "href": {
735
- "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
736
- "type": "string"
737
- }
738
- }
739
- },
740
- "first": {
741
- "type": "object",
742
- "properties": {
743
- "href": {
744
- "description": "URL pointing to the first page of results in a paginated response",
745
- "type": "string"
746
- }
747
- }
748
- },
749
- "last": {
750
- "type": "object",
751
- "properties": {
752
- "href": {
753
- "description": "URL pointing to the first page of results in a paginated response",
754
- "type": "string"
755
- }
756
- }
757
- },
758
- "pages": {
759
- "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
760
- "type": "object",
761
- "additionalProperties": {
762
- "type": "object",
763
- "properties": {
764
- "href": {
765
- "type": "string"
766
- }
767
- }
768
- }
769
- }
770
- },
771
- "required": [
772
- "self",
773
- "first",
774
- "last",
775
- "pages"
776
- ]
443
+ "email": {
444
+ "format": "email",
445
+ "type": "string"
777
446
  },
778
- "totalCount": {
779
- "description": "Number representing the total number of available items",
780
- "type": "number"
781
- }
782
- }
783
- }
784
- },
785
- "required": [
786
- "data"
787
- ]
788
- }
789
- }
790
- }
791
- },
792
- "404": {
793
- "description": "Default Response",
794
- "content": {
795
- "application/json": {
796
- "schema": {
797
- "type": "object",
798
- "properties": {
799
- "code": {
800
- "type": "string"
801
- },
802
- "detail": {
803
- "type": "string"
804
- },
805
- "requestId": {
806
- "type": "string"
807
- },
808
- "name": {
809
- "type": "string"
810
- },
811
- "validation": {},
812
- "validationContext": {
813
- "type": "string"
814
- }
815
- },
816
- "required": [
817
- "code",
818
- "detail",
819
- "requestId",
820
- "name"
821
- ]
822
- }
823
- }
824
- }
825
- },
826
- "500": {
827
- "description": "Default Response",
828
- "content": {
829
- "application/json": {
830
- "schema": {
831
- "type": "object",
832
- "properties": {
833
- "code": {
834
- "type": "string"
835
- },
836
- "detail": {
837
- "type": "string"
838
- },
839
- "requestId": {
840
- "type": "string"
841
- },
842
- "name": {
843
- "type": "string"
844
- },
845
- "validation": {},
846
- "validationContext": {
847
- "type": "string"
848
- }
849
- },
850
- "required": [
851
- "code",
852
- "detail",
853
- "requestId",
854
- "name"
855
- ]
856
- }
857
- }
858
- }
859
- }
860
- }
861
- },
862
- "patch": {
863
- "tags": [
864
- "Addresses"
865
- ],
866
- "requestBody": {
867
- "content": {
868
- "application/json": {
869
- "schema": {
870
- "type": "object",
871
- "properties": {
872
- "isPrimary": {
873
- "type": "boolean"
874
- },
875
- "ownershipStatus": {
876
- "type": "string"
877
- }
878
- }
879
- }
880
- }
881
- }
882
- },
883
- "parameters": [
884
- {
885
- "schema": {
886
- "type": "string"
887
- },
888
- "in": "path",
889
- "name": "addressId",
890
- "required": true
891
- }
892
- ],
893
- "responses": {
894
- "200": {
895
- "description": "Default Response",
896
- "content": {
897
- "application/json": {
898
- "schema": {
899
- "type": "object",
900
- "properties": {
901
- "data": {
902
- "type": "object",
903
- "properties": {
904
- "id": {
447
+ "firstName": {
448
+ "type": "string"
449
+ },
450
+ "lastName": {
451
+ "type": "string"
452
+ },
453
+ "city": {
454
+ "type": "string"
455
+ },
456
+ "address": {
457
+ "type": "string"
458
+ },
459
+ "phone": {
460
+ "type": "string"
461
+ },
462
+ "dateOfBirth": {
463
+ "format": "date",
464
+ "type": "string"
465
+ },
466
+ "ppsn": {
905
467
  "type": "string"
468
+ },
469
+ "preferredLanguage": {
470
+ "type": "string",
471
+ "enum": [
472
+ "en",
473
+ "ga"
474
+ ],
475
+ "default": "en"
906
476
  }
907
477
  },
908
478
  "required": [
909
- "id"
910
- ]
911
- },
912
- "metadata": {
913
- "type": "object",
914
- "properties": {
915
- "links": {
916
- "description": "Object containing the links to the related endpoints",
917
- "type": "object",
918
- "properties": {
919
- "self": {
920
- "type": "object",
921
- "properties": {
922
- "href": {
923
- "description": "URL pointing to the request itself",
924
- "type": "string"
925
- }
926
- }
927
- },
928
- "next": {
929
- "type": "object",
930
- "properties": {
931
- "href": {
932
- "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
933
- "type": "string"
934
- }
935
- }
936
- },
937
- "prev": {
938
- "type": "object",
939
- "properties": {
940
- "href": {
941
- "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
942
- "type": "string"
943
- }
944
- }
945
- },
946
- "first": {
947
- "type": "object",
948
- "properties": {
949
- "href": {
950
- "description": "URL pointing to the first page of results in a paginated response",
951
- "type": "string"
952
- }
953
- }
954
- },
955
- "last": {
956
- "type": "object",
957
- "properties": {
958
- "href": {
959
- "description": "URL pointing to the first page of results in a paginated response",
960
- "type": "string"
961
- }
962
- }
963
- },
964
- "pages": {
965
- "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
966
- "type": "object",
967
- "additionalProperties": {
968
- "type": "object",
969
- "properties": {
970
- "href": {
971
- "type": "string"
972
- }
973
- }
974
- }
975
- }
976
- },
977
- "required": [
978
- "self",
979
- "first",
980
- "last",
981
- "pages"
982
- ]
983
- },
984
- "totalCount": {
985
- "description": "Number representing the total number of available items",
986
- "type": "number"
987
- }
988
- }
479
+ "email",
480
+ "firstName",
481
+ "lastName"
482
+ ]
483
+ }
484
+ },
485
+ "file": {}
486
+ }
487
+ }
488
+ }
489
+ }
490
+ },
491
+ "responses": {
492
+ "200": {
493
+ "description": "Default Response",
494
+ "content": {
495
+ "application/json": {
496
+ "schema": {
497
+ "type": "object",
498
+ "properties": {
499
+ "status": {
500
+ "type": "string"
501
+ },
502
+ "jobId": {
503
+ "type": "string"
989
504
  }
990
505
  },
991
506
  "required": [
992
- "data"
507
+ "status",
508
+ "jobId"
993
509
  ]
994
510
  }
995
511
  }
996
512
  }
997
513
  },
998
- "404": {
514
+ "4XX": {
999
515
  "description": "Default Response",
1000
516
  "content": {
1001
517
  "application/json": {
@@ -1003,18 +519,40 @@
1003
519
  "type": "object",
1004
520
  "properties": {
1005
521
  "code": {
522
+ "description": "Code used to categorize the error",
1006
523
  "type": "string"
1007
524
  },
1008
525
  "detail": {
526
+ "description": "Description of the error",
1009
527
  "type": "string"
1010
528
  },
1011
529
  "requestId": {
530
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1012
531
  "type": "string"
1013
532
  },
1014
533
  "name": {
534
+ "description": "Name of the error type",
1015
535
  "type": "string"
1016
536
  },
1017
- "validation": {},
537
+ "validation": {
538
+ "description": "List of the validation errors",
539
+ "type": "array",
540
+ "items": {
541
+ "type": "object",
542
+ "properties": {
543
+ "fieldName": {
544
+ "type": "string"
545
+ },
546
+ "message": {
547
+ "type": "string"
548
+ }
549
+ },
550
+ "required": [
551
+ "fieldName",
552
+ "message"
553
+ ]
554
+ }
555
+ },
1018
556
  "validationContext": {
1019
557
  "type": "string"
1020
558
  }
@@ -1029,7 +567,7 @@
1029
567
  }
1030
568
  }
1031
569
  },
1032
- "500": {
570
+ "5XX": {
1033
571
  "description": "Default Response",
1034
572
  "content": {
1035
573
  "application/json": {
@@ -1037,18 +575,40 @@
1037
575
  "type": "object",
1038
576
  "properties": {
1039
577
  "code": {
578
+ "description": "Code used to categorize the error",
1040
579
  "type": "string"
1041
580
  },
1042
581
  "detail": {
582
+ "description": "Description of the error",
1043
583
  "type": "string"
1044
584
  },
1045
585
  "requestId": {
586
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1046
587
  "type": "string"
1047
588
  },
1048
589
  "name": {
590
+ "description": "Name of the error type",
1049
591
  "type": "string"
1050
592
  },
1051
- "validation": {},
593
+ "validation": {
594
+ "description": "List of the validation errors",
595
+ "type": "array",
596
+ "items": {
597
+ "type": "object",
598
+ "properties": {
599
+ "fieldName": {
600
+ "type": "string"
601
+ },
602
+ "message": {
603
+ "type": "string"
604
+ }
605
+ },
606
+ "required": [
607
+ "fieldName",
608
+ "message"
609
+ ]
610
+ }
611
+ },
1052
612
  "validationContext": {
1053
613
  "type": "string"
1054
614
  }
@@ -1064,19 +624,24 @@
1064
624
  }
1065
625
  }
1066
626
  }
1067
- },
1068
- "delete": {
627
+ }
628
+ },
629
+ "/api/v1/profiles/select-profiles": {
630
+ "get": {
631
+ "operationId": "selectProfiles",
1069
632
  "tags": [
1070
- "Addresses"
633
+ "Profiles"
1071
634
  ],
1072
635
  "parameters": [
1073
636
  {
1074
637
  "schema": {
638
+ "pattern": "^[a-zA-Z0-9-]+(,[a-zA-Z0-9-]+)*$",
1075
639
  "type": "string"
1076
640
  },
1077
- "in": "path",
1078
- "name": "addressId",
1079
- "required": true
641
+ "in": "query",
642
+ "name": "ids",
643
+ "required": true,
644
+ "description": "Comma-separated list of profile IDs"
1080
645
  }
1081
646
  ],
1082
647
  "responses": {
@@ -1088,15 +653,94 @@
1088
653
  "type": "object",
1089
654
  "properties": {
1090
655
  "data": {
1091
- "type": "object",
1092
- "properties": {
1093
- "id": {
1094
- "type": "string"
1095
- }
1096
- },
1097
- "required": [
1098
- "id"
1099
- ]
656
+ "type": "array",
657
+ "items": {
658
+ "type": "object",
659
+ "properties": {
660
+ "id": {
661
+ "type": "string"
662
+ },
663
+ "publicName": {
664
+ "type": "string"
665
+ },
666
+ "email": {
667
+ "format": "email",
668
+ "type": "string"
669
+ },
670
+ "primaryUserId": {
671
+ "type": "string"
672
+ },
673
+ "safeLevel": {
674
+ "type": "number"
675
+ },
676
+ "preferredLanguage": {
677
+ "type": "string",
678
+ "enum": [
679
+ "en",
680
+ "ga"
681
+ ],
682
+ "default": "en"
683
+ },
684
+ "createdAt": {
685
+ "format": "date-time",
686
+ "type": "string"
687
+ },
688
+ "updatedAt": {
689
+ "format": "date-time",
690
+ "type": "string"
691
+ },
692
+ "details": {
693
+ "type": "object",
694
+ "properties": {
695
+ "email": {
696
+ "format": "email",
697
+ "type": "string"
698
+ },
699
+ "firstName": {
700
+ "type": "string"
701
+ },
702
+ "lastName": {
703
+ "type": "string"
704
+ },
705
+ "city": {
706
+ "type": "string"
707
+ },
708
+ "address": {
709
+ "type": "string"
710
+ },
711
+ "phone": {
712
+ "type": "string"
713
+ },
714
+ "dateOfBirth": {
715
+ "format": "date",
716
+ "type": "string"
717
+ },
718
+ "ppsn": {
719
+ "type": "string"
720
+ },
721
+ "preferredLanguage": {
722
+ "type": "string",
723
+ "enum": [
724
+ "en",
725
+ "ga"
726
+ ],
727
+ "default": "en"
728
+ }
729
+ },
730
+ "required": [
731
+ "email",
732
+ "firstName",
733
+ "lastName"
734
+ ]
735
+ }
736
+ },
737
+ "required": [
738
+ "id",
739
+ "publicName",
740
+ "email",
741
+ "primaryUserId"
742
+ ]
743
+ }
1100
744
  },
1101
745
  "metadata": {
1102
746
  "type": "object",
@@ -1184,7 +828,7 @@
1184
828
  }
1185
829
  }
1186
830
  },
1187
- "404": {
831
+ "4XX": {
1188
832
  "description": "Default Response",
1189
833
  "content": {
1190
834
  "application/json": {
@@ -1192,18 +836,40 @@
1192
836
  "type": "object",
1193
837
  "properties": {
1194
838
  "code": {
839
+ "description": "Code used to categorize the error",
1195
840
  "type": "string"
1196
841
  },
1197
842
  "detail": {
843
+ "description": "Description of the error",
1198
844
  "type": "string"
1199
845
  },
1200
846
  "requestId": {
847
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1201
848
  "type": "string"
1202
849
  },
1203
850
  "name": {
851
+ "description": "Name of the error type",
1204
852
  "type": "string"
1205
853
  },
1206
- "validation": {},
854
+ "validation": {
855
+ "description": "List of the validation errors",
856
+ "type": "array",
857
+ "items": {
858
+ "type": "object",
859
+ "properties": {
860
+ "fieldName": {
861
+ "type": "string"
862
+ },
863
+ "message": {
864
+ "type": "string"
865
+ }
866
+ },
867
+ "required": [
868
+ "fieldName",
869
+ "message"
870
+ ]
871
+ }
872
+ },
1207
873
  "validationContext": {
1208
874
  "type": "string"
1209
875
  }
@@ -1218,7 +884,7 @@
1218
884
  }
1219
885
  }
1220
886
  },
1221
- "500": {
887
+ "5XX": {
1222
888
  "description": "Default Response",
1223
889
  "content": {
1224
890
  "application/json": {
@@ -1226,187 +892,40 @@
1226
892
  "type": "object",
1227
893
  "properties": {
1228
894
  "code": {
895
+ "description": "Code used to categorize the error",
1229
896
  "type": "string"
1230
897
  },
1231
898
  "detail": {
899
+ "description": "Description of the error",
1232
900
  "type": "string"
1233
901
  },
1234
902
  "requestId": {
903
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1235
904
  "type": "string"
1236
905
  },
1237
906
  "name": {
907
+ "description": "Name of the error type",
1238
908
  "type": "string"
1239
909
  },
1240
- "validation": {},
1241
- "validationContext": {
1242
- "type": "string"
1243
- }
1244
- },
1245
- "required": [
1246
- "code",
1247
- "detail",
1248
- "requestId",
1249
- "name"
1250
- ]
1251
- }
1252
- }
1253
- }
1254
- }
1255
- }
1256
- }
1257
- },
1258
- "/api/v1/entitlements/": {
1259
- "get": {
1260
- "tags": [
1261
- "Entitlements"
1262
- ],
1263
- "responses": {
1264
- "200": {
1265
- "description": "Default Response",
1266
- "content": {
1267
- "application/json": {
1268
- "schema": {
1269
- "type": "object",
1270
- "properties": {
1271
- "data": {
910
+ "validation": {
911
+ "description": "List of the validation errors",
1272
912
  "type": "array",
1273
913
  "items": {
1274
914
  "type": "object",
1275
915
  "properties": {
1276
- "firstname": {
1277
- "type": "string"
1278
- },
1279
- "lastname": {
1280
- "type": "string"
1281
- },
1282
- "type": {
1283
- "type": "string"
1284
- },
1285
- "issueDate": {
916
+ "fieldName": {
1286
917
  "type": "string"
1287
918
  },
1288
- "expiryDate": {
1289
- "type": "string"
1290
- },
1291
- "documentNumber": {
919
+ "message": {
1292
920
  "type": "string"
1293
921
  }
1294
922
  },
1295
923
  "required": [
1296
- "firstname",
1297
- "lastname",
1298
- "type",
1299
- "issueDate",
1300
- "documentNumber"
924
+ "fieldName",
925
+ "message"
1301
926
  ]
1302
927
  }
1303
928
  },
1304
- "metadata": {
1305
- "type": "object",
1306
- "properties": {
1307
- "links": {
1308
- "description": "Object containing the links to the related endpoints",
1309
- "type": "object",
1310
- "properties": {
1311
- "self": {
1312
- "type": "object",
1313
- "properties": {
1314
- "href": {
1315
- "description": "URL pointing to the request itself",
1316
- "type": "string"
1317
- }
1318
- }
1319
- },
1320
- "next": {
1321
- "type": "object",
1322
- "properties": {
1323
- "href": {
1324
- "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
1325
- "type": "string"
1326
- }
1327
- }
1328
- },
1329
- "prev": {
1330
- "type": "object",
1331
- "properties": {
1332
- "href": {
1333
- "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
1334
- "type": "string"
1335
- }
1336
- }
1337
- },
1338
- "first": {
1339
- "type": "object",
1340
- "properties": {
1341
- "href": {
1342
- "description": "URL pointing to the first page of results in a paginated response",
1343
- "type": "string"
1344
- }
1345
- }
1346
- },
1347
- "last": {
1348
- "type": "object",
1349
- "properties": {
1350
- "href": {
1351
- "description": "URL pointing to the first page of results in a paginated response",
1352
- "type": "string"
1353
- }
1354
- }
1355
- },
1356
- "pages": {
1357
- "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1358
- "type": "object",
1359
- "additionalProperties": {
1360
- "type": "object",
1361
- "properties": {
1362
- "href": {
1363
- "type": "string"
1364
- }
1365
- }
1366
- }
1367
- }
1368
- },
1369
- "required": [
1370
- "self",
1371
- "first",
1372
- "last",
1373
- "pages"
1374
- ]
1375
- },
1376
- "totalCount": {
1377
- "description": "Number representing the total number of available items",
1378
- "type": "number"
1379
- }
1380
- }
1381
- }
1382
- },
1383
- "required": [
1384
- "data"
1385
- ]
1386
- }
1387
- }
1388
- }
1389
- },
1390
- "500": {
1391
- "description": "Default Response",
1392
- "content": {
1393
- "application/json": {
1394
- "schema": {
1395
- "type": "object",
1396
- "properties": {
1397
- "code": {
1398
- "type": "string"
1399
- },
1400
- "detail": {
1401
- "type": "string"
1402
- },
1403
- "requestId": {
1404
- "type": "string"
1405
- },
1406
- "name": {
1407
- "type": "string"
1408
- },
1409
- "validation": {},
1410
929
  "validationContext": {
1411
930
  "type": "string"
1412
931
  }
@@ -1424,19 +943,49 @@
1424
943
  }
1425
944
  }
1426
945
  },
1427
- "/api/v1/users/{userId}": {
946
+ "/api/v1/profiles/find-profile": {
1428
947
  "get": {
948
+ "operationId": "findProfile",
1429
949
  "tags": [
1430
- "Users"
950
+ "Profiles"
1431
951
  ],
1432
952
  "parameters": [
953
+ {
954
+ "schema": {
955
+ "format": "email",
956
+ "type": "string"
957
+ },
958
+ "in": "query",
959
+ "name": "email",
960
+ "required": false,
961
+ "description": "Email address to search for"
962
+ },
1433
963
  {
1434
964
  "schema": {
1435
965
  "type": "string"
1436
966
  },
1437
- "in": "path",
1438
- "name": "userId",
1439
- "required": true
967
+ "in": "query",
968
+ "name": "firstName",
969
+ "required": false,
970
+ "description": "First name to search for"
971
+ },
972
+ {
973
+ "schema": {
974
+ "type": "string"
975
+ },
976
+ "in": "query",
977
+ "name": "lastName",
978
+ "required": false,
979
+ "description": "Last name to search for"
980
+ },
981
+ {
982
+ "schema": {
983
+ "type": "string"
984
+ },
985
+ "in": "query",
986
+ "name": "phone",
987
+ "required": false,
988
+ "description": "Phone number to search for"
1440
989
  }
1441
990
  ],
1442
991
  "responses": {
@@ -1450,104 +999,88 @@
1450
999
  "data": {
1451
1000
  "type": "object",
1452
1001
  "properties": {
1453
- "title": {
1454
- "default": null,
1455
- "anyOf": [
1456
- {
1457
- "type": "null"
1458
- },
1459
- {
1460
- "type": "string"
1461
- }
1462
- ]
1002
+ "id": {
1003
+ "type": "string"
1463
1004
  },
1464
- "firstName": {
1005
+ "publicName": {
1465
1006
  "type": "string"
1466
1007
  },
1467
- "lastName": {
1008
+ "email": {
1009
+ "format": "email",
1468
1010
  "type": "string"
1469
1011
  },
1470
- "dateOfBirth": {
1471
- "default": null,
1472
- "anyOf": [
1473
- {
1474
- "type": "null"
1012
+ "primaryUserId": {
1013
+ "type": "string"
1014
+ },
1015
+ "safeLevel": {
1016
+ "type": "number"
1017
+ },
1018
+ "preferredLanguage": {
1019
+ "type": "string",
1020
+ "enum": [
1021
+ "en",
1022
+ "ga"
1023
+ ],
1024
+ "default": "en"
1025
+ },
1026
+ "createdAt": {
1027
+ "format": "date-time",
1028
+ "type": "string"
1029
+ },
1030
+ "updatedAt": {
1031
+ "format": "date-time",
1032
+ "type": "string"
1033
+ },
1034
+ "details": {
1035
+ "type": "object",
1036
+ "properties": {
1037
+ "email": {
1038
+ "format": "email",
1039
+ "type": "string"
1475
1040
  },
1476
- {
1477
- "format": "date-time",
1041
+ "firstName": {
1478
1042
  "type": "string"
1479
- }
1480
- ]
1481
- },
1482
- "ppsn": {
1483
- "default": null,
1484
- "anyOf": [
1485
- {
1486
- "type": "null"
1487
1043
  },
1488
- {
1044
+ "lastName": {
1489
1045
  "type": "string"
1490
- }
1491
- ]
1492
- },
1493
- "ppsnVisible": {
1494
- "default": false,
1495
- "anyOf": [
1496
- {
1497
- "type": "null"
1498
1046
  },
1499
- {
1500
- "type": "boolean"
1501
- }
1502
- ]
1503
- },
1504
- "gender": {
1505
- "default": null,
1506
- "anyOf": [
1507
- {
1508
- "type": "null"
1047
+ "city": {
1048
+ "type": "string"
1509
1049
  },
1510
- {
1050
+ "address": {
1511
1051
  "type": "string"
1512
- }
1513
- ]
1514
- },
1515
- "email": {
1516
- "format": "email",
1517
- "type": "string"
1518
- },
1519
- "phone": {
1520
- "default": null,
1521
- "anyOf": [
1522
- {
1523
- "type": "null"
1524
1052
  },
1525
- {
1053
+ "phone": {
1526
1054
  "type": "string"
1527
- }
1528
- ]
1529
- },
1530
- "consentToPrefillData": {
1531
- "default": false,
1532
- "anyOf": [
1533
- {
1534
- "type": "null"
1535
1055
  },
1536
- {
1537
- "type": "boolean"
1056
+ "dateOfBirth": {
1057
+ "format": "date",
1058
+ "type": "string"
1059
+ },
1060
+ "ppsn": {
1061
+ "type": "string"
1062
+ },
1063
+ "preferredLanguage": {
1064
+ "type": "string",
1065
+ "enum": [
1066
+ "en",
1067
+ "ga"
1068
+ ],
1069
+ "default": "en"
1538
1070
  }
1071
+ },
1072
+ "required": [
1073
+ "email",
1074
+ "firstName",
1075
+ "lastName"
1539
1076
  ]
1540
- },
1541
- "preferredLanguage": {
1542
- "default": "en",
1543
- "type": "string"
1544
1077
  }
1545
1078
  },
1546
1079
  "required": [
1547
- "firstName",
1548
- "lastName",
1080
+ "id",
1081
+ "publicName",
1549
1082
  "email",
1550
- "preferredLanguage"
1083
+ "primaryUserId"
1551
1084
  ]
1552
1085
  },
1553
1086
  "metadata": {
@@ -1636,7 +1169,7 @@
1636
1169
  }
1637
1170
  }
1638
1171
  },
1639
- "404": {
1172
+ "4XX": {
1640
1173
  "description": "Default Response",
1641
1174
  "content": {
1642
1175
  "application/json": {
@@ -1644,18 +1177,40 @@
1644
1177
  "type": "object",
1645
1178
  "properties": {
1646
1179
  "code": {
1180
+ "description": "Code used to categorize the error",
1647
1181
  "type": "string"
1648
1182
  },
1649
1183
  "detail": {
1184
+ "description": "Description of the error",
1650
1185
  "type": "string"
1651
1186
  },
1652
1187
  "requestId": {
1188
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1653
1189
  "type": "string"
1654
1190
  },
1655
1191
  "name": {
1192
+ "description": "Name of the error type",
1656
1193
  "type": "string"
1657
1194
  },
1658
- "validation": {},
1195
+ "validation": {
1196
+ "description": "List of the validation errors",
1197
+ "type": "array",
1198
+ "items": {
1199
+ "type": "object",
1200
+ "properties": {
1201
+ "fieldName": {
1202
+ "type": "string"
1203
+ },
1204
+ "message": {
1205
+ "type": "string"
1206
+ }
1207
+ },
1208
+ "required": [
1209
+ "fieldName",
1210
+ "message"
1211
+ ]
1212
+ }
1213
+ },
1659
1214
  "validationContext": {
1660
1215
  "type": "string"
1661
1216
  }
@@ -1670,7 +1225,7 @@
1670
1225
  }
1671
1226
  }
1672
1227
  },
1673
- "500": {
1228
+ "5XX": {
1674
1229
  "description": "Default Response",
1675
1230
  "content": {
1676
1231
  "application/json": {
@@ -1678,18 +1233,40 @@
1678
1233
  "type": "object",
1679
1234
  "properties": {
1680
1235
  "code": {
1236
+ "description": "Code used to categorize the error",
1681
1237
  "type": "string"
1682
1238
  },
1683
1239
  "detail": {
1240
+ "description": "Description of the error",
1684
1241
  "type": "string"
1685
1242
  },
1686
1243
  "requestId": {
1244
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1687
1245
  "type": "string"
1688
1246
  },
1689
1247
  "name": {
1248
+ "description": "Name of the error type",
1690
1249
  "type": "string"
1691
1250
  },
1692
- "validation": {},
1251
+ "validation": {
1252
+ "description": "List of the validation errors",
1253
+ "type": "array",
1254
+ "items": {
1255
+ "type": "object",
1256
+ "properties": {
1257
+ "fieldName": {
1258
+ "type": "string"
1259
+ },
1260
+ "message": {
1261
+ "type": "string"
1262
+ }
1263
+ },
1264
+ "required": [
1265
+ "fieldName",
1266
+ "message"
1267
+ ]
1268
+ }
1269
+ },
1693
1270
  "validationContext": {
1694
1271
  "type": "string"
1695
1272
  }
@@ -1705,76 +1282,65 @@
1705
1282
  }
1706
1283
  }
1707
1284
  }
1708
- },
1709
- "put": {
1285
+ }
1286
+ },
1287
+ "/api/v1/profiles/imports": {
1288
+ "get": {
1710
1289
  "tags": [
1711
- "Users"
1290
+ "profiles"
1712
1291
  ],
1713
- "requestBody": {
1714
- "content": {
1715
- "application/json": {
1716
- "schema": {
1717
- "type": "object",
1718
- "properties": {
1719
- "firstname": {
1720
- "type": "string"
1721
- },
1722
- "lastname": {
1723
- "type": "string"
1724
- },
1725
- "email": {
1726
- "type": "string"
1727
- },
1728
- "title": {
1729
- "type": "string"
1730
- },
1731
- "dateOfBirth": {
1732
- "type": "string"
1733
- },
1734
- "ppsn": {
1735
- "type": "string"
1736
- },
1737
- "ppsnVisible": {
1738
- "type": "boolean"
1739
- },
1740
- "gender": {
1741
- "type": "string"
1742
- },
1743
- "phone": {
1744
- "type": "string"
1745
- },
1746
- "consentToPrefillData": {
1747
- "type": "boolean"
1748
- },
1749
- "preferredLanguage": {
1750
- "type": "string"
1751
- }
1292
+ "description": "List profile imports with pagination",
1293
+ "parameters": [
1294
+ {
1295
+ "schema": {
1296
+ "type": "string"
1297
+ },
1298
+ "in": "query",
1299
+ "name": "organizationId",
1300
+ "required": false
1301
+ },
1302
+ {
1303
+ "schema": {
1304
+ "anyOf": [
1305
+ {
1306
+ "type": "string",
1307
+ "enum": [
1308
+ "csv"
1309
+ ]
1752
1310
  },
1753
- "required": [
1754
- "firstname",
1755
- "lastname",
1756
- "email",
1757
- "title",
1758
- "dateOfBirth",
1759
- "ppsn",
1760
- "ppsnVisible",
1761
- "gender",
1762
- "phone",
1763
- "preferredLanguage"
1764
- ]
1765
- }
1766
- }
1311
+ {
1312
+ "type": "string",
1313
+ "enum": [
1314
+ "json"
1315
+ ]
1316
+ }
1317
+ ]
1318
+ },
1319
+ "in": "query",
1320
+ "name": "source",
1321
+ "required": false
1767
1322
  },
1768
- "required": true
1769
- },
1770
- "parameters": [
1771
1323
  {
1772
1324
  "schema": {
1325
+ "pattern": "^[0-9][0-9]*|undefined$",
1326
+ "default": "0",
1773
1327
  "type": "string"
1774
1328
  },
1775
- "in": "path",
1776
- "name": "userId",
1777
- "required": true
1329
+ "in": "query",
1330
+ "name": "offset",
1331
+ "required": false,
1332
+ "description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
1333
+ },
1334
+ {
1335
+ "schema": {
1336
+ "default": "20",
1337
+ "pattern": "^([1-9]|100)|undefined$",
1338
+ "type": "string"
1339
+ },
1340
+ "in": "query",
1341
+ "name": "limit",
1342
+ "required": false,
1343
+ "description": "Indicates the maximum number (100) of items that will be returned in a single request"
1778
1344
  }
1779
1345
  ],
1780
1346
  "responses": {
@@ -1786,15 +1352,72 @@
1786
1352
  "type": "object",
1787
1353
  "properties": {
1788
1354
  "data": {
1789
- "type": "object",
1790
- "properties": {
1791
- "id": {
1792
- "type": "string"
1793
- }
1794
- },
1795
- "required": [
1796
- "id"
1797
- ]
1355
+ "type": "array",
1356
+ "items": {
1357
+ "type": "object",
1358
+ "properties": {
1359
+ "id": {
1360
+ "format": "uuid",
1361
+ "type": "string"
1362
+ },
1363
+ "jobId": {
1364
+ "type": "string"
1365
+ },
1366
+ "organisationId": {
1367
+ "type": "string"
1368
+ },
1369
+ "status": {
1370
+ "type": "string"
1371
+ },
1372
+ "source": {
1373
+ "anyOf": [
1374
+ {
1375
+ "type": "string",
1376
+ "enum": [
1377
+ "csv"
1378
+ ]
1379
+ },
1380
+ {
1381
+ "type": "string",
1382
+ "enum": [
1383
+ "json"
1384
+ ]
1385
+ }
1386
+ ]
1387
+ },
1388
+ "metadata": {
1389
+ "type": "object",
1390
+ "properties": {
1391
+ "filename": {
1392
+ "type": "string"
1393
+ },
1394
+ "mimetype": {
1395
+ "type": "string"
1396
+ }
1397
+ },
1398
+ "required": [
1399
+ "filename",
1400
+ "mimetype"
1401
+ ]
1402
+ },
1403
+ "createdAt": {
1404
+ "format": "date-time",
1405
+ "type": "string"
1406
+ },
1407
+ "updatedAt": {
1408
+ "format": "date-time",
1409
+ "type": "string"
1410
+ }
1411
+ },
1412
+ "required": [
1413
+ "id",
1414
+ "jobId",
1415
+ "status",
1416
+ "source",
1417
+ "createdAt",
1418
+ "updatedAt"
1419
+ ]
1420
+ }
1798
1421
  },
1799
1422
  "metadata": {
1800
1423
  "type": "object",
@@ -1882,7 +1505,7 @@
1882
1505
  }
1883
1506
  }
1884
1507
  },
1885
- "404": {
1508
+ "4XX": {
1886
1509
  "description": "Default Response",
1887
1510
  "content": {
1888
1511
  "application/json": {
@@ -1890,18 +1513,40 @@
1890
1513
  "type": "object",
1891
1514
  "properties": {
1892
1515
  "code": {
1516
+ "description": "Code used to categorize the error",
1893
1517
  "type": "string"
1894
1518
  },
1895
1519
  "detail": {
1520
+ "description": "Description of the error",
1896
1521
  "type": "string"
1897
1522
  },
1898
1523
  "requestId": {
1524
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1899
1525
  "type": "string"
1900
1526
  },
1901
1527
  "name": {
1528
+ "description": "Name of the error type",
1902
1529
  "type": "string"
1903
1530
  },
1904
- "validation": {},
1531
+ "validation": {
1532
+ "description": "List of the validation errors",
1533
+ "type": "array",
1534
+ "items": {
1535
+ "type": "object",
1536
+ "properties": {
1537
+ "fieldName": {
1538
+ "type": "string"
1539
+ },
1540
+ "message": {
1541
+ "type": "string"
1542
+ }
1543
+ },
1544
+ "required": [
1545
+ "fieldName",
1546
+ "message"
1547
+ ]
1548
+ }
1549
+ },
1905
1550
  "validationContext": {
1906
1551
  "type": "string"
1907
1552
  }
@@ -1916,7 +1561,7 @@
1916
1561
  }
1917
1562
  }
1918
1563
  },
1919
- "500": {
1564
+ "5XX": {
1920
1565
  "description": "Default Response",
1921
1566
  "content": {
1922
1567
  "application/json": {
@@ -1924,18 +1569,40 @@
1924
1569
  "type": "object",
1925
1570
  "properties": {
1926
1571
  "code": {
1572
+ "description": "Code used to categorize the error",
1927
1573
  "type": "string"
1928
1574
  },
1929
1575
  "detail": {
1576
+ "description": "Description of the error",
1930
1577
  "type": "string"
1931
1578
  },
1932
1579
  "requestId": {
1580
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
1933
1581
  "type": "string"
1934
1582
  },
1935
1583
  "name": {
1584
+ "description": "Name of the error type",
1936
1585
  "type": "string"
1937
1586
  },
1938
- "validation": {},
1587
+ "validation": {
1588
+ "description": "List of the validation errors",
1589
+ "type": "array",
1590
+ "items": {
1591
+ "type": "object",
1592
+ "properties": {
1593
+ "fieldName": {
1594
+ "type": "string"
1595
+ },
1596
+ "message": {
1597
+ "type": "string"
1598
+ }
1599
+ },
1600
+ "required": [
1601
+ "fieldName",
1602
+ "message"
1603
+ ]
1604
+ }
1605
+ },
1939
1606
  "validationContext": {
1940
1607
  "type": "string"
1941
1608
  }
@@ -1951,38 +1618,22 @@
1951
1618
  }
1952
1619
  }
1953
1620
  }
1954
- },
1955
- "patch": {
1621
+ }
1622
+ },
1623
+ "/api/v1/profiles/imports/{importId}": {
1624
+ "get": {
1625
+ "operationId": "getProfileImportDetails",
1956
1626
  "tags": [
1957
- "Users"
1958
- ],
1959
- "requestBody": {
1960
- "content": {
1961
- "application/json": {
1962
- "schema": {
1963
- "type": "object",
1964
- "properties": {
1965
- "ppsnVisible": {
1966
- "type": "boolean"
1967
- },
1968
- "consentToPrefillData": {
1969
- "type": "boolean"
1970
- },
1971
- "preferredLanguage": {
1972
- "type": "string"
1973
- }
1974
- }
1975
- }
1976
- }
1977
- }
1978
- },
1627
+ "Profiles"
1628
+ ],
1629
+ "description": "Get details of profiles in a specific import",
1979
1630
  "parameters": [
1980
1631
  {
1981
1632
  "schema": {
1982
1633
  "type": "string"
1983
1634
  },
1984
1635
  "in": "path",
1985
- "name": "userId",
1636
+ "name": "importId",
1986
1637
  "required": true
1987
1638
  }
1988
1639
  ],
@@ -1995,15 +1646,51 @@
1995
1646
  "type": "object",
1996
1647
  "properties": {
1997
1648
  "data": {
1998
- "type": "object",
1999
- "properties": {
2000
- "id": {
2001
- "type": "string"
2002
- }
2003
- },
2004
- "required": [
2005
- "id"
2006
- ]
1649
+ "type": "array",
1650
+ "items": {
1651
+ "type": "object",
1652
+ "properties": {
1653
+ "email": {
1654
+ "format": "email",
1655
+ "type": "string"
1656
+ },
1657
+ "firstName": {
1658
+ "type": "string"
1659
+ },
1660
+ "lastName": {
1661
+ "type": "string"
1662
+ },
1663
+ "city": {
1664
+ "type": "string"
1665
+ },
1666
+ "address": {
1667
+ "type": "string"
1668
+ },
1669
+ "phone": {
1670
+ "type": "string"
1671
+ },
1672
+ "dateOfBirth": {
1673
+ "format": "date",
1674
+ "type": "string"
1675
+ },
1676
+ "ppsn": {
1677
+ "type": "string"
1678
+ },
1679
+ "preferredLanguage": {
1680
+ "type": "string",
1681
+ "enum": [
1682
+ "en",
1683
+ "ga"
1684
+ ],
1685
+ "default": "en"
1686
+ }
1687
+ },
1688
+ "required": [
1689
+ "email",
1690
+ "firstName",
1691
+ "lastName"
1692
+ ]
1693
+ }
2007
1694
  },
2008
1695
  "metadata": {
2009
1696
  "type": "object",
@@ -2091,7 +1778,7 @@
2091
1778
  }
2092
1779
  }
2093
1780
  },
2094
- "404": {
1781
+ "4XX": {
2095
1782
  "description": "Default Response",
2096
1783
  "content": {
2097
1784
  "application/json": {
@@ -2099,18 +1786,40 @@
2099
1786
  "type": "object",
2100
1787
  "properties": {
2101
1788
  "code": {
1789
+ "description": "Code used to categorize the error",
2102
1790
  "type": "string"
2103
1791
  },
2104
1792
  "detail": {
1793
+ "description": "Description of the error",
2105
1794
  "type": "string"
2106
1795
  },
2107
1796
  "requestId": {
1797
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
2108
1798
  "type": "string"
2109
1799
  },
2110
1800
  "name": {
1801
+ "description": "Name of the error type",
2111
1802
  "type": "string"
2112
1803
  },
2113
- "validation": {},
1804
+ "validation": {
1805
+ "description": "List of the validation errors",
1806
+ "type": "array",
1807
+ "items": {
1808
+ "type": "object",
1809
+ "properties": {
1810
+ "fieldName": {
1811
+ "type": "string"
1812
+ },
1813
+ "message": {
1814
+ "type": "string"
1815
+ }
1816
+ },
1817
+ "required": [
1818
+ "fieldName",
1819
+ "message"
1820
+ ]
1821
+ }
1822
+ },
2114
1823
  "validationContext": {
2115
1824
  "type": "string"
2116
1825
  }
@@ -2125,7 +1834,7 @@
2125
1834
  }
2126
1835
  }
2127
1836
  },
2128
- "500": {
1837
+ "5XX": {
2129
1838
  "description": "Default Response",
2130
1839
  "content": {
2131
1840
  "application/json": {
@@ -2133,18 +1842,40 @@
2133
1842
  "type": "object",
2134
1843
  "properties": {
2135
1844
  "code": {
1845
+ "description": "Code used to categorize the error",
2136
1846
  "type": "string"
2137
1847
  },
2138
1848
  "detail": {
1849
+ "description": "Description of the error",
2139
1850
  "type": "string"
2140
1851
  },
2141
1852
  "requestId": {
1853
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
2142
1854
  "type": "string"
2143
1855
  },
2144
1856
  "name": {
1857
+ "description": "Name of the error type",
2145
1858
  "type": "string"
2146
1859
  },
2147
- "validation": {},
1860
+ "validation": {
1861
+ "description": "List of the validation errors",
1862
+ "type": "array",
1863
+ "items": {
1864
+ "type": "object",
1865
+ "properties": {
1866
+ "fieldName": {
1867
+ "type": "string"
1868
+ },
1869
+ "message": {
1870
+ "type": "string"
1871
+ }
1872
+ },
1873
+ "required": [
1874
+ "fieldName",
1875
+ "message"
1876
+ ]
1877
+ }
1878
+ },
2148
1879
  "validationContext": {
2149
1880
  "type": "string"
2150
1881
  }
@@ -2162,63 +1893,31 @@
2162
1893
  }
2163
1894
  }
2164
1895
  },
2165
- "/api/v1/users/": {
2166
- "post": {
1896
+ "/api/v1/profiles/{profileId}": {
1897
+ "get": {
1898
+ "operationId": "getProfile",
2167
1899
  "tags": [
2168
- "Users"
1900
+ "Profiles"
2169
1901
  ],
2170
- "requestBody": {
2171
- "content": {
2172
- "application/json": {
2173
- "schema": {
2174
- "type": "object",
2175
- "properties": {
2176
- "firstname": {
2177
- "type": "string"
2178
- },
2179
- "lastname": {
2180
- "type": "string"
2181
- },
2182
- "email": {
2183
- "type": "string"
2184
- },
2185
- "title": {
2186
- "type": "string"
2187
- },
2188
- "dateOfBirth": {
2189
- "type": "string"
2190
- },
2191
- "ppsn": {
2192
- "type": "string"
2193
- },
2194
- "ppsnVisible": {
2195
- "type": "boolean"
2196
- },
2197
- "gender": {
2198
- "type": "string"
2199
- },
2200
- "phone": {
2201
- "type": "string"
2202
- },
2203
- "consentToPrefillData": {
2204
- "type": "boolean"
2205
- },
2206
- "preferredLanguage": {
2207
- "default": "en",
2208
- "type": "string"
2209
- }
2210
- },
2211
- "required": [
2212
- "firstname",
2213
- "lastname",
2214
- "email",
2215
- "preferredLanguage"
2216
- ]
2217
- }
2218
- }
1902
+ "parameters": [
1903
+ {
1904
+ "schema": {
1905
+ "type": "string"
1906
+ },
1907
+ "in": "query",
1908
+ "name": "organizationId",
1909
+ "required": false
2219
1910
  },
2220
- "required": true
2221
- },
1911
+ {
1912
+ "schema": {
1913
+ "type": "string"
1914
+ },
1915
+ "in": "path",
1916
+ "name": "profileId",
1917
+ "required": true,
1918
+ "description": "ID of the profile to retrieve"
1919
+ }
1920
+ ],
2222
1921
  "responses": {
2223
1922
  "200": {
2224
1923
  "description": "Default Response",
@@ -2232,10 +1931,86 @@
2232
1931
  "properties": {
2233
1932
  "id": {
2234
1933
  "type": "string"
1934
+ },
1935
+ "publicName": {
1936
+ "type": "string"
1937
+ },
1938
+ "email": {
1939
+ "format": "email",
1940
+ "type": "string"
1941
+ },
1942
+ "primaryUserId": {
1943
+ "type": "string"
1944
+ },
1945
+ "safeLevel": {
1946
+ "type": "number"
1947
+ },
1948
+ "preferredLanguage": {
1949
+ "type": "string",
1950
+ "enum": [
1951
+ "en",
1952
+ "ga"
1953
+ ],
1954
+ "default": "en"
1955
+ },
1956
+ "createdAt": {
1957
+ "format": "date-time",
1958
+ "type": "string"
1959
+ },
1960
+ "updatedAt": {
1961
+ "format": "date-time",
1962
+ "type": "string"
1963
+ },
1964
+ "details": {
1965
+ "type": "object",
1966
+ "properties": {
1967
+ "email": {
1968
+ "format": "email",
1969
+ "type": "string"
1970
+ },
1971
+ "firstName": {
1972
+ "type": "string"
1973
+ },
1974
+ "lastName": {
1975
+ "type": "string"
1976
+ },
1977
+ "city": {
1978
+ "type": "string"
1979
+ },
1980
+ "address": {
1981
+ "type": "string"
1982
+ },
1983
+ "phone": {
1984
+ "type": "string"
1985
+ },
1986
+ "dateOfBirth": {
1987
+ "format": "date",
1988
+ "type": "string"
1989
+ },
1990
+ "ppsn": {
1991
+ "type": "string"
1992
+ },
1993
+ "preferredLanguage": {
1994
+ "type": "string",
1995
+ "enum": [
1996
+ "en",
1997
+ "ga"
1998
+ ],
1999
+ "default": "en"
2000
+ }
2001
+ },
2002
+ "required": [
2003
+ "email",
2004
+ "firstName",
2005
+ "lastName"
2006
+ ]
2235
2007
  }
2236
2008
  },
2237
2009
  "required": [
2238
- "id"
2010
+ "id",
2011
+ "publicName",
2012
+ "email",
2013
+ "primaryUserId"
2239
2014
  ]
2240
2015
  },
2241
2016
  "metadata": {
@@ -2324,7 +2099,63 @@
2324
2099
  }
2325
2100
  }
2326
2101
  },
2327
- "500": {
2102
+ "4XX": {
2103
+ "description": "Default Response",
2104
+ "content": {
2105
+ "application/json": {
2106
+ "schema": {
2107
+ "type": "object",
2108
+ "properties": {
2109
+ "code": {
2110
+ "description": "Code used to categorize the error",
2111
+ "type": "string"
2112
+ },
2113
+ "detail": {
2114
+ "description": "Description of the error",
2115
+ "type": "string"
2116
+ },
2117
+ "requestId": {
2118
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
2119
+ "type": "string"
2120
+ },
2121
+ "name": {
2122
+ "description": "Name of the error type",
2123
+ "type": "string"
2124
+ },
2125
+ "validation": {
2126
+ "description": "List of the validation errors",
2127
+ "type": "array",
2128
+ "items": {
2129
+ "type": "object",
2130
+ "properties": {
2131
+ "fieldName": {
2132
+ "type": "string"
2133
+ },
2134
+ "message": {
2135
+ "type": "string"
2136
+ }
2137
+ },
2138
+ "required": [
2139
+ "fieldName",
2140
+ "message"
2141
+ ]
2142
+ }
2143
+ },
2144
+ "validationContext": {
2145
+ "type": "string"
2146
+ }
2147
+ },
2148
+ "required": [
2149
+ "code",
2150
+ "detail",
2151
+ "requestId",
2152
+ "name"
2153
+ ]
2154
+ }
2155
+ }
2156
+ }
2157
+ },
2158
+ "5XX": {
2328
2159
  "description": "Default Response",
2329
2160
  "content": {
2330
2161
  "application/json": {
@@ -2332,18 +2163,40 @@
2332
2163
  "type": "object",
2333
2164
  "properties": {
2334
2165
  "code": {
2166
+ "description": "Code used to categorize the error",
2335
2167
  "type": "string"
2336
2168
  },
2337
2169
  "detail": {
2170
+ "description": "Description of the error",
2338
2171
  "type": "string"
2339
2172
  },
2340
2173
  "requestId": {
2174
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
2341
2175
  "type": "string"
2342
2176
  },
2343
2177
  "name": {
2178
+ "description": "Name of the error type",
2344
2179
  "type": "string"
2345
2180
  },
2346
- "validation": {},
2181
+ "validation": {
2182
+ "description": "List of the validation errors",
2183
+ "type": "array",
2184
+ "items": {
2185
+ "type": "object",
2186
+ "properties": {
2187
+ "fieldName": {
2188
+ "type": "string"
2189
+ },
2190
+ "message": {
2191
+ "type": "string"
2192
+ }
2193
+ },
2194
+ "required": [
2195
+ "fieldName",
2196
+ "message"
2197
+ ]
2198
+ }
2199
+ },
2347
2200
  "validationContext": {
2348
2201
  "type": "string"
2349
2202
  }
@@ -2358,78 +2211,77 @@
2358
2211
  }
2359
2212
  }
2360
2213
  }
2361
- }
2362
- }
2363
- },
2364
- "/api/v1/users/find": {
2365
- "get": {
2366
- "tags": [
2367
- "Users"
2368
- ],
2214
+ }
2215
+ },
2216
+ "put": {
2217
+ "operationId": "updateProfilePut",
2218
+ "tags": [
2219
+ "Profiles"
2220
+ ],
2221
+ "requestBody": {
2222
+ "content": {
2223
+ "application/json": {
2224
+ "schema": {
2225
+ "additionalProperties": false,
2226
+ "type": "object",
2227
+ "properties": {
2228
+ "publicName": {
2229
+ "type": "string"
2230
+ },
2231
+ "email": {
2232
+ "format": "email",
2233
+ "type": "string"
2234
+ },
2235
+ "phone": {
2236
+ "type": "string"
2237
+ },
2238
+ "address": {
2239
+ "type": "string"
2240
+ },
2241
+ "city": {
2242
+ "type": "string"
2243
+ },
2244
+ "firstName": {
2245
+ "type": "string"
2246
+ },
2247
+ "lastName": {
2248
+ "type": "string"
2249
+ },
2250
+ "dateOfBirth": {
2251
+ "format": "date",
2252
+ "type": "string"
2253
+ },
2254
+ "preferredLanguage": {
2255
+ "type": "string",
2256
+ "enum": [
2257
+ "en",
2258
+ "ga"
2259
+ ],
2260
+ "default": "en"
2261
+ }
2262
+ }
2263
+ }
2264
+ }
2265
+ }
2266
+ },
2369
2267
  "parameters": [
2370
2268
  {
2371
2269
  "schema": {
2372
2270
  "type": "string"
2373
2271
  },
2374
2272
  "in": "query",
2375
- "name": "firstname",
2376
- "required": false
2377
- },
2378
- {
2379
- "schema": {
2380
- "type": "string"
2381
- },
2382
- "in": "query",
2383
- "name": "lastname",
2384
- "required": false
2385
- },
2386
- {
2387
- "schema": {
2388
- "type": "string"
2389
- },
2390
- "in": "query",
2391
- "name": "email",
2392
- "required": false
2393
- },
2394
- {
2395
- "schema": {
2396
- "type": "string"
2397
- },
2398
- "in": "query",
2399
- "name": "dateOfBirth",
2400
- "required": false
2401
- },
2402
- {
2403
- "schema": {
2404
- "type": "string"
2405
- },
2406
- "in": "query",
2407
- "name": "ppsn",
2408
- "required": false
2409
- },
2410
- {
2411
- "schema": {
2412
- "type": "string"
2413
- },
2414
- "in": "query",
2415
- "name": "gender",
2416
- "required": false
2273
+ "name": "organizationId",
2274
+ "required": false,
2275
+ "description": "Organization ID owning the profile"
2417
2276
  },
2418
2277
  {
2419
2278
  "schema": {
2420
2279
  "type": "string"
2421
2280
  },
2422
- "in": "query",
2423
- "name": "phone",
2424
- "required": false
2425
- },
2426
- {
2427
- "schema": {
2428
- "type": "boolean"
2429
- },
2430
- "in": "query",
2431
- "name": "strict",
2432
- "required": false
2281
+ "in": "path",
2282
+ "name": "profileId",
2283
+ "required": true,
2284
+ "description": "ID of the profile to update"
2433
2285
  }
2434
2286
  ],
2435
2287
  "responses": {
@@ -2446,34 +2298,85 @@
2446
2298
  "id": {
2447
2299
  "type": "string"
2448
2300
  },
2449
- "firstname": {
2301
+ "publicName": {
2450
2302
  "type": "string"
2451
2303
  },
2452
- "lastname": {
2304
+ "email": {
2305
+ "format": "email",
2453
2306
  "type": "string"
2454
2307
  },
2455
- "matchQuality": {
2456
- "anyOf": [
2457
- {
2458
- "type": "string",
2459
- "enum": [
2460
- "exact"
2461
- ]
2308
+ "primaryUserId": {
2309
+ "type": "string"
2310
+ },
2311
+ "safeLevel": {
2312
+ "type": "number"
2313
+ },
2314
+ "preferredLanguage": {
2315
+ "type": "string",
2316
+ "enum": [
2317
+ "en",
2318
+ "ga"
2319
+ ],
2320
+ "default": "en"
2321
+ },
2322
+ "createdAt": {
2323
+ "format": "date-time",
2324
+ "type": "string"
2325
+ },
2326
+ "updatedAt": {
2327
+ "format": "date-time",
2328
+ "type": "string"
2329
+ },
2330
+ "details": {
2331
+ "type": "object",
2332
+ "properties": {
2333
+ "email": {
2334
+ "format": "email",
2335
+ "type": "string"
2462
2336
  },
2463
- {
2337
+ "firstName": {
2338
+ "type": "string"
2339
+ },
2340
+ "lastName": {
2341
+ "type": "string"
2342
+ },
2343
+ "city": {
2344
+ "type": "string"
2345
+ },
2346
+ "address": {
2347
+ "type": "string"
2348
+ },
2349
+ "phone": {
2350
+ "type": "string"
2351
+ },
2352
+ "dateOfBirth": {
2353
+ "format": "date",
2354
+ "type": "string"
2355
+ },
2356
+ "ppsn": {
2357
+ "type": "string"
2358
+ },
2359
+ "preferredLanguage": {
2464
2360
  "type": "string",
2465
2361
  "enum": [
2466
- "approximate"
2467
- ]
2362
+ "en",
2363
+ "ga"
2364
+ ],
2365
+ "default": "en"
2468
2366
  }
2367
+ },
2368
+ "required": [
2369
+ "email",
2370
+ "firstName",
2371
+ "lastName"
2469
2372
  ]
2470
2373
  }
2471
2374
  },
2472
2375
  "required": [
2473
2376
  "id",
2474
- "firstname",
2475
- "lastname",
2476
- "matchQuality"
2377
+ "publicName",
2378
+ "email",
2379
+ "primaryUserId"
2477
2380
  ]
2478
2381
  },
2479
2382
  "metadata": {
@@ -2562,7 +2465,7 @@
2562
2465
  }
2563
2466
  }
2564
2467
  },
2565
- "404": {
2468
+ "4XX": {
2566
2469
  "description": "Default Response",
2567
2470
  "content": {
2568
2471
  "application/json": {
@@ -2570,18 +2473,40 @@
2570
2473
  "type": "object",
2571
2474
  "properties": {
2572
2475
  "code": {
2476
+ "description": "Code used to categorize the error",
2573
2477
  "type": "string"
2574
2478
  },
2575
2479
  "detail": {
2480
+ "description": "Description of the error",
2576
2481
  "type": "string"
2577
2482
  },
2578
2483
  "requestId": {
2484
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
2579
2485
  "type": "string"
2580
2486
  },
2581
2487
  "name": {
2488
+ "description": "Name of the error type",
2582
2489
  "type": "string"
2583
2490
  },
2584
- "validation": {},
2491
+ "validation": {
2492
+ "description": "List of the validation errors",
2493
+ "type": "array",
2494
+ "items": {
2495
+ "type": "object",
2496
+ "properties": {
2497
+ "fieldName": {
2498
+ "type": "string"
2499
+ },
2500
+ "message": {
2501
+ "type": "string"
2502
+ }
2503
+ },
2504
+ "required": [
2505
+ "fieldName",
2506
+ "message"
2507
+ ]
2508
+ }
2509
+ },
2585
2510
  "validationContext": {
2586
2511
  "type": "string"
2587
2512
  }
@@ -2596,7 +2521,7 @@
2596
2521
  }
2597
2522
  }
2598
2523
  },
2599
- "500": {
2524
+ "5XX": {
2600
2525
  "description": "Default Response",
2601
2526
  "content": {
2602
2527
  "application/json": {
@@ -2604,18 +2529,40 @@
2604
2529
  "type": "object",
2605
2530
  "properties": {
2606
2531
  "code": {
2532
+ "description": "Code used to categorize the error",
2607
2533
  "type": "string"
2608
2534
  },
2609
2535
  "detail": {
2536
+ "description": "Description of the error",
2610
2537
  "type": "string"
2611
2538
  },
2612
2539
  "requestId": {
2540
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
2613
2541
  "type": "string"
2614
2542
  },
2615
2543
  "name": {
2544
+ "description": "Name of the error type",
2616
2545
  "type": "string"
2617
2546
  },
2618
- "validation": {},
2547
+ "validation": {
2548
+ "description": "List of the validation errors",
2549
+ "type": "array",
2550
+ "items": {
2551
+ "type": "object",
2552
+ "properties": {
2553
+ "fieldName": {
2554
+ "type": "string"
2555
+ },
2556
+ "message": {
2557
+ "type": "string"
2558
+ }
2559
+ },
2560
+ "required": [
2561
+ "fieldName",
2562
+ "message"
2563
+ ]
2564
+ }
2565
+ },
2619
2566
  "validationContext": {
2620
2567
  "type": "string"
2621
2568
  }
@@ -2631,34 +2578,78 @@
2631
2578
  }
2632
2579
  }
2633
2580
  }
2634
- }
2635
- },
2636
- "/api/v1/users/select": {
2637
- "post": {
2581
+ },
2582
+ "patch": {
2583
+ "operationId": "updateProfilePatch",
2638
2584
  "tags": [
2639
- "Users"
2585
+ "Profiles"
2640
2586
  ],
2641
2587
  "requestBody": {
2642
2588
  "content": {
2643
2589
  "application/json": {
2644
2590
  "schema": {
2591
+ "additionalProperties": false,
2645
2592
  "type": "object",
2646
2593
  "properties": {
2647
- "ids": {
2648
- "type": "array",
2649
- "items": {
2650
- "type": "string"
2651
- }
2594
+ "publicName": {
2595
+ "type": "string"
2596
+ },
2597
+ "email": {
2598
+ "format": "email",
2599
+ "type": "string"
2600
+ },
2601
+ "phone": {
2602
+ "type": "string"
2603
+ },
2604
+ "address": {
2605
+ "type": "string"
2606
+ },
2607
+ "city": {
2608
+ "type": "string"
2609
+ },
2610
+ "firstName": {
2611
+ "type": "string"
2612
+ },
2613
+ "lastName": {
2614
+ "type": "string"
2615
+ },
2616
+ "dateOfBirth": {
2617
+ "format": "date",
2618
+ "type": "string"
2619
+ },
2620
+ "preferredLanguage": {
2621
+ "type": "string",
2622
+ "enum": [
2623
+ "en",
2624
+ "ga"
2625
+ ],
2626
+ "default": "en"
2652
2627
  }
2653
- },
2654
- "required": [
2655
- "ids"
2656
- ]
2628
+ }
2657
2629
  }
2658
2630
  }
2659
- },
2660
- "required": true
2631
+ }
2661
2632
  },
2633
+ "parameters": [
2634
+ {
2635
+ "schema": {
2636
+ "type": "string"
2637
+ },
2638
+ "in": "query",
2639
+ "name": "organizationId",
2640
+ "required": false,
2641
+ "description": "Organization ID owning the profile"
2642
+ },
2643
+ {
2644
+ "schema": {
2645
+ "type": "string"
2646
+ },
2647
+ "in": "path",
2648
+ "name": "profileId",
2649
+ "required": true,
2650
+ "description": "ID of the profile to update"
2651
+ }
2652
+ ],
2662
2653
  "responses": {
2663
2654
  "200": {
2664
2655
  "description": "Default Response",
@@ -2668,41 +2659,91 @@
2668
2659
  "type": "object",
2669
2660
  "properties": {
2670
2661
  "data": {
2671
- "type": "array",
2672
- "items": {
2673
- "type": "object",
2674
- "properties": {
2675
- "id": {
2676
- "type": "string"
2677
- },
2678
- "firstName": {
2679
- "type": "string"
2680
- },
2681
- "lastName": {
2682
- "type": "string"
2683
- },
2684
- "ppsn": {
2685
- "type": "string"
2686
- },
2687
- "email": {
2688
- "format": "email",
2689
- "type": "string"
2690
- },
2691
- "phone": {
2692
- "type": "string"
2693
- },
2694
- "preferredLanguage": {
2695
- "type": "string"
2696
- }
2662
+ "type": "object",
2663
+ "properties": {
2664
+ "id": {
2665
+ "type": "string"
2697
2666
  },
2698
- "required": [
2699
- "id",
2700
- "firstName",
2701
- "lastName",
2702
- "ppsn",
2703
- "preferredLanguage"
2704
- ]
2705
- }
2667
+ "publicName": {
2668
+ "type": "string"
2669
+ },
2670
+ "email": {
2671
+ "format": "email",
2672
+ "type": "string"
2673
+ },
2674
+ "primaryUserId": {
2675
+ "type": "string"
2676
+ },
2677
+ "safeLevel": {
2678
+ "type": "number"
2679
+ },
2680
+ "preferredLanguage": {
2681
+ "type": "string",
2682
+ "enum": [
2683
+ "en",
2684
+ "ga"
2685
+ ],
2686
+ "default": "en"
2687
+ },
2688
+ "createdAt": {
2689
+ "format": "date-time",
2690
+ "type": "string"
2691
+ },
2692
+ "updatedAt": {
2693
+ "format": "date-time",
2694
+ "type": "string"
2695
+ },
2696
+ "details": {
2697
+ "type": "object",
2698
+ "properties": {
2699
+ "email": {
2700
+ "format": "email",
2701
+ "type": "string"
2702
+ },
2703
+ "firstName": {
2704
+ "type": "string"
2705
+ },
2706
+ "lastName": {
2707
+ "type": "string"
2708
+ },
2709
+ "city": {
2710
+ "type": "string"
2711
+ },
2712
+ "address": {
2713
+ "type": "string"
2714
+ },
2715
+ "phone": {
2716
+ "type": "string"
2717
+ },
2718
+ "dateOfBirth": {
2719
+ "format": "date",
2720
+ "type": "string"
2721
+ },
2722
+ "ppsn": {
2723
+ "type": "string"
2724
+ },
2725
+ "preferredLanguage": {
2726
+ "type": "string",
2727
+ "enum": [
2728
+ "en",
2729
+ "ga"
2730
+ ],
2731
+ "default": "en"
2732
+ }
2733
+ },
2734
+ "required": [
2735
+ "email",
2736
+ "firstName",
2737
+ "lastName"
2738
+ ]
2739
+ }
2740
+ },
2741
+ "required": [
2742
+ "id",
2743
+ "publicName",
2744
+ "email",
2745
+ "primaryUserId"
2746
+ ]
2706
2747
  },
2707
2748
  "metadata": {
2708
2749
  "type": "object",
@@ -2798,18 +2839,40 @@
2798
2839
  "type": "object",
2799
2840
  "properties": {
2800
2841
  "code": {
2842
+ "description": "Code used to categorize the error",
2801
2843
  "type": "string"
2802
2844
  },
2803
2845
  "detail": {
2846
+ "description": "Description of the error",
2804
2847
  "type": "string"
2805
2848
  },
2806
2849
  "requestId": {
2850
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
2807
2851
  "type": "string"
2808
2852
  },
2809
2853
  "name": {
2854
+ "description": "Name of the error type",
2810
2855
  "type": "string"
2811
2856
  },
2812
- "validation": {},
2857
+ "validation": {
2858
+ "description": "List of the validation errors",
2859
+ "type": "array",
2860
+ "items": {
2861
+ "type": "object",
2862
+ "properties": {
2863
+ "fieldName": {
2864
+ "type": "string"
2865
+ },
2866
+ "message": {
2867
+ "type": "string"
2868
+ }
2869
+ },
2870
+ "required": [
2871
+ "fieldName",
2872
+ "message"
2873
+ ]
2874
+ }
2875
+ },
2813
2876
  "validationContext": {
2814
2877
  "type": "string"
2815
2878
  }
@@ -2832,18 +2895,40 @@
2832
2895
  "type": "object",
2833
2896
  "properties": {
2834
2897
  "code": {
2898
+ "description": "Code used to categorize the error",
2835
2899
  "type": "string"
2836
2900
  },
2837
2901
  "detail": {
2902
+ "description": "Description of the error",
2838
2903
  "type": "string"
2839
2904
  },
2840
2905
  "requestId": {
2906
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
2841
2907
  "type": "string"
2842
2908
  },
2843
2909
  "name": {
2910
+ "description": "Name of the error type",
2844
2911
  "type": "string"
2845
2912
  },
2846
- "validation": {},
2913
+ "validation": {
2914
+ "description": "List of the validation errors",
2915
+ "type": "array",
2916
+ "items": {
2917
+ "type": "object",
2918
+ "properties": {
2919
+ "fieldName": {
2920
+ "type": "string"
2921
+ },
2922
+ "message": {
2923
+ "type": "string"
2924
+ }
2925
+ },
2926
+ "required": [
2927
+ "fieldName",
2928
+ "message"
2929
+ ]
2930
+ }
2931
+ },
2847
2932
  "validationContext": {
2848
2933
  "type": "string"
2849
2934
  }
@@ -2860,17 +2945,434 @@
2860
2945
  }
2861
2946
  }
2862
2947
  }
2863
- }
2864
- },
2865
- "tags": [
2866
- {
2867
- "name": "User"
2868
2948
  },
2869
- {
2870
- "name": "Addresses"
2949
+ "/api/v1/profiles/imports/template": {
2950
+ "get": {
2951
+ "operationId": "getProfileTemplate",
2952
+ "tags": [
2953
+ "Profiles"
2954
+ ],
2955
+ "responses": {
2956
+ "200": {
2957
+ "description": "Default Response",
2958
+ "content": {
2959
+ "text/csv": {
2960
+ "schema": {
2961
+ "type": "object",
2962
+ "properties": {
2963
+ "type": {
2964
+ "type": "string",
2965
+ "enum": [
2966
+ "Buffer"
2967
+ ]
2968
+ },
2969
+ "data": {
2970
+ "type": "array",
2971
+ "items": {
2972
+ "type": "number"
2973
+ }
2974
+ }
2975
+ },
2976
+ "required": [
2977
+ "type",
2978
+ "data"
2979
+ ]
2980
+ }
2981
+ }
2982
+ }
2983
+ },
2984
+ "4XX": {
2985
+ "description": "Default Response",
2986
+ "content": {
2987
+ "text/csv": {
2988
+ "schema": {
2989
+ "type": "object",
2990
+ "properties": {
2991
+ "code": {
2992
+ "description": "Code used to categorize the error",
2993
+ "type": "string"
2994
+ },
2995
+ "detail": {
2996
+ "description": "Description of the error",
2997
+ "type": "string"
2998
+ },
2999
+ "requestId": {
3000
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
3001
+ "type": "string"
3002
+ },
3003
+ "name": {
3004
+ "description": "Name of the error type",
3005
+ "type": "string"
3006
+ },
3007
+ "validation": {
3008
+ "description": "List of the validation errors",
3009
+ "type": "array",
3010
+ "items": {
3011
+ "type": "object",
3012
+ "properties": {
3013
+ "fieldName": {
3014
+ "type": "string"
3015
+ },
3016
+ "message": {
3017
+ "type": "string"
3018
+ }
3019
+ },
3020
+ "required": [
3021
+ "fieldName",
3022
+ "message"
3023
+ ]
3024
+ }
3025
+ },
3026
+ "validationContext": {
3027
+ "type": "string"
3028
+ }
3029
+ },
3030
+ "required": [
3031
+ "code",
3032
+ "detail",
3033
+ "requestId",
3034
+ "name"
3035
+ ]
3036
+ }
3037
+ }
3038
+ }
3039
+ },
3040
+ "5XX": {
3041
+ "description": "Default Response",
3042
+ "content": {
3043
+ "text/csv": {
3044
+ "schema": {
3045
+ "type": "object",
3046
+ "properties": {
3047
+ "code": {
3048
+ "description": "Code used to categorize the error",
3049
+ "type": "string"
3050
+ },
3051
+ "detail": {
3052
+ "description": "Description of the error",
3053
+ "type": "string"
3054
+ },
3055
+ "requestId": {
3056
+ "description": "Unique request id. This one will be used to troubleshoot the problems",
3057
+ "type": "string"
3058
+ },
3059
+ "name": {
3060
+ "description": "Name of the error type",
3061
+ "type": "string"
3062
+ },
3063
+ "validation": {
3064
+ "description": "List of the validation errors",
3065
+ "type": "array",
3066
+ "items": {
3067
+ "type": "object",
3068
+ "properties": {
3069
+ "fieldName": {
3070
+ "type": "string"
3071
+ },
3072
+ "message": {
3073
+ "type": "string"
3074
+ }
3075
+ },
3076
+ "required": [
3077
+ "fieldName",
3078
+ "message"
3079
+ ]
3080
+ }
3081
+ },
3082
+ "validationContext": {
3083
+ "type": "string"
3084
+ }
3085
+ },
3086
+ "required": [
3087
+ "code",
3088
+ "detail",
3089
+ "requestId",
3090
+ "name"
3091
+ ]
3092
+ }
3093
+ }
3094
+ }
3095
+ }
3096
+ }
3097
+ }
2871
3098
  },
3099
+ "/user-login-wh": {
3100
+ "post": {
3101
+ "operationId": "logtoUserCreated",
3102
+ "tags": [
3103
+ "webhooks"
3104
+ ],
3105
+ "requestBody": {
3106
+ "content": {
3107
+ "application/json": {
3108
+ "schema": {
3109
+ "type": "object",
3110
+ "properties": {
3111
+ "hookId": {
3112
+ "anyOf": [
3113
+ {
3114
+ "type": "string"
3115
+ },
3116
+ {
3117
+ "type": "null"
3118
+ }
3119
+ ]
3120
+ },
3121
+ "event": {
3122
+ "anyOf": [
3123
+ {
3124
+ "type": "string"
3125
+ },
3126
+ {
3127
+ "type": "null"
3128
+ }
3129
+ ]
3130
+ },
3131
+ "sessionId": {
3132
+ "anyOf": [
3133
+ {
3134
+ "type": "string"
3135
+ },
3136
+ {
3137
+ "type": "null"
3138
+ }
3139
+ ]
3140
+ },
3141
+ "userAgent": {
3142
+ "anyOf": [
3143
+ {
3144
+ "type": "string"
3145
+ },
3146
+ {
3147
+ "type": "null"
3148
+ }
3149
+ ]
3150
+ },
3151
+ "ip": {
3152
+ "anyOf": [
3153
+ {
3154
+ "type": "string"
3155
+ },
3156
+ {
3157
+ "type": "null"
3158
+ }
3159
+ ]
3160
+ },
3161
+ "path": {
3162
+ "anyOf": [
3163
+ {
3164
+ "type": "string"
3165
+ },
3166
+ {
3167
+ "type": "null"
3168
+ }
3169
+ ]
3170
+ },
3171
+ "method": {
3172
+ "anyOf": [
3173
+ {
3174
+ "type": "string"
3175
+ },
3176
+ {
3177
+ "type": "null"
3178
+ }
3179
+ ]
3180
+ },
3181
+ "status": {
3182
+ "type": "number"
3183
+ },
3184
+ "createdAt": {
3185
+ "format": "date-time",
3186
+ "type": "string"
3187
+ },
3188
+ "data": {
3189
+ "type": "object",
3190
+ "properties": {
3191
+ "id": {
3192
+ "type": "string"
3193
+ },
3194
+ "username": {
3195
+ "anyOf": [
3196
+ {
3197
+ "type": "string"
3198
+ },
3199
+ {
3200
+ "type": "null"
3201
+ }
3202
+ ]
3203
+ },
3204
+ "primaryEmail": {
3205
+ "format": "email",
3206
+ "type": "string"
3207
+ },
3208
+ "primaryPhone": {
3209
+ "anyOf": [
3210
+ {
3211
+ "type": "string"
3212
+ },
3213
+ {
3214
+ "type": "null"
3215
+ }
3216
+ ]
3217
+ },
3218
+ "name": {
3219
+ "anyOf": [
3220
+ {
3221
+ "type": "string"
3222
+ },
3223
+ {
3224
+ "type": "null"
3225
+ }
3226
+ ]
3227
+ },
3228
+ "avatar": {
3229
+ "anyOf": [
3230
+ {
3231
+ "type": "string"
3232
+ },
3233
+ {
3234
+ "type": "null"
3235
+ }
3236
+ ]
3237
+ },
3238
+ "customData": {
3239
+ "type": "object",
3240
+ "properties": {
3241
+ "jobId": {
3242
+ "anyOf": [
3243
+ {
3244
+ "type": "string"
3245
+ },
3246
+ {
3247
+ "type": "null"
3248
+ }
3249
+ ]
3250
+ },
3251
+ "organizationId": {
3252
+ "anyOf": [
3253
+ {
3254
+ "type": "string"
3255
+ },
3256
+ {
3257
+ "type": "null"
3258
+ }
3259
+ ]
3260
+ }
3261
+ }
3262
+ },
3263
+ "identities": {
3264
+ "type": "object",
3265
+ "additionalProperties": {
3266
+ "type": "object",
3267
+ "properties": {
3268
+ "details": {
3269
+ "type": "object",
3270
+ "properties": {
3271
+ "email": {
3272
+ "anyOf": [
3273
+ {
3274
+ "type": "string"
3275
+ },
3276
+ {
3277
+ "type": "null"
3278
+ }
3279
+ ]
3280
+ },
3281
+ "rawData": {
3282
+ "type": "object",
3283
+ "additionalProperties": {
3284
+ "anyOf": [
3285
+ {
3286
+ "type": "string"
3287
+ },
3288
+ {
3289
+ "type": "null"
3290
+ },
3291
+ {
3292
+ "type": "number"
3293
+ },
3294
+ {
3295
+ "type": "boolean"
3296
+ }
3297
+ ]
3298
+ }
3299
+ }
3300
+ },
3301
+ "required": [
3302
+ "rawData"
3303
+ ]
3304
+ }
3305
+ },
3306
+ "required": [
3307
+ "details"
3308
+ ]
3309
+ }
3310
+ },
3311
+ "lastSignInAt": {
3312
+ "anyOf": [
3313
+ {
3314
+ "type": "number"
3315
+ },
3316
+ {
3317
+ "type": "null"
3318
+ }
3319
+ ]
3320
+ },
3321
+ "createdAt": {
3322
+ "type": "number"
3323
+ },
3324
+ "updatedAt": {
3325
+ "type": "number"
3326
+ },
3327
+ "profile": {
3328
+ "type": "object",
3329
+ "additionalProperties": {}
3330
+ },
3331
+ "applicationId": {
3332
+ "anyOf": [
3333
+ {
3334
+ "type": "string"
3335
+ },
3336
+ {
3337
+ "type": "null"
3338
+ }
3339
+ ]
3340
+ },
3341
+ "isSuspended": {
3342
+ "type": "boolean"
3343
+ },
3344
+ "hasPassword": {
3345
+ "type": "boolean"
3346
+ }
3347
+ },
3348
+ "required": [
3349
+ "id",
3350
+ "username",
3351
+ "primaryEmail",
3352
+ "customData",
3353
+ "identities"
3354
+ ]
3355
+ }
3356
+ },
3357
+ "required": [
3358
+ "data"
3359
+ ]
3360
+ }
3361
+ }
3362
+ },
3363
+ "required": true
3364
+ },
3365
+ "responses": {
3366
+ "200": {
3367
+ "description": "Default Response"
3368
+ }
3369
+ }
3370
+ }
3371
+ }
3372
+ },
3373
+ "security": [
2872
3374
  {
2873
- "name": "Entitlements"
3375
+ "bearerAuth": []
2874
3376
  }
2875
3377
  ]
2876
3378
  }