@ogcio/building-blocks-sdk 0.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 (106) hide show
  1. package/.husky/commit-msg +1 -0
  2. package/.husky/pre-push +1 -0
  3. package/.nvmrc +1 -0
  4. package/.vscode/settings.json +20 -0
  5. package/biome.jsonc +45 -0
  6. package/commitlint.config.js +6 -0
  7. package/dist/client/auth/index.d.ts +4 -0
  8. package/dist/client/auth/index.d.ts.map +1 -0
  9. package/dist/client/auth/index.js +83 -0
  10. package/dist/client/auth/index.js.map +1 -0
  11. package/dist/client/base-client.d.ts +18 -0
  12. package/dist/client/base-client.d.ts.map +1 -0
  13. package/dist/client/base-client.js +71 -0
  14. package/dist/client/base-client.js.map +1 -0
  15. package/dist/client/clients/messaging/index.d.ts +2407 -0
  16. package/dist/client/clients/messaging/index.d.ts.map +1 -0
  17. package/dist/client/clients/messaging/index.js +430 -0
  18. package/dist/client/clients/messaging/index.js.map +1 -0
  19. package/dist/client/clients/messaging/schema.d.ts +3823 -0
  20. package/dist/client/clients/messaging/schema.d.ts.map +1 -0
  21. package/dist/client/clients/messaging/schema.js +2 -0
  22. package/dist/client/clients/messaging/schema.js.map +1 -0
  23. package/dist/client/clients/payments/index.d.ts +2294 -0
  24. package/dist/client/clients/payments/index.d.ts.map +1 -0
  25. package/dist/client/clients/payments/index.js +217 -0
  26. package/dist/client/clients/payments/index.js.map +1 -0
  27. package/dist/client/clients/payments/schema.d.ts +2534 -0
  28. package/dist/client/clients/payments/schema.d.ts.map +1 -0
  29. package/dist/client/clients/payments/schema.js +2 -0
  30. package/dist/client/clients/payments/schema.js.map +1 -0
  31. package/dist/client/clients/profile/index.d.ts +1364 -0
  32. package/dist/client/clients/profile/index.d.ts.map +1 -0
  33. package/dist/client/clients/profile/index.js +102 -0
  34. package/dist/client/clients/profile/index.js.map +1 -0
  35. package/dist/client/clients/profile/schema.d.ts +1429 -0
  36. package/dist/client/clients/profile/schema.d.ts.map +1 -0
  37. package/dist/client/clients/profile/schema.js +2 -0
  38. package/dist/client/clients/profile/schema.js.map +1 -0
  39. package/dist/client/clients/scheduler/index.d.ts +14 -0
  40. package/dist/client/clients/scheduler/index.d.ts.map +1 -0
  41. package/dist/client/clients/scheduler/index.js +14 -0
  42. package/dist/client/clients/scheduler/index.js.map +1 -0
  43. package/dist/client/clients/scheduler/schema.d.ts +114 -0
  44. package/dist/client/clients/scheduler/schema.d.ts.map +1 -0
  45. package/dist/client/clients/scheduler/schema.js +2 -0
  46. package/dist/client/clients/scheduler/schema.js.map +1 -0
  47. package/dist/client/clients/upload/index.d.ts +390 -0
  48. package/dist/client/clients/upload/index.d.ts.map +1 -0
  49. package/dist/client/clients/upload/index.js +93 -0
  50. package/dist/client/clients/upload/index.js.map +1 -0
  51. package/dist/client/clients/upload/schema.d.ts +564 -0
  52. package/dist/client/clients/upload/schema.d.ts.map +1 -0
  53. package/dist/client/clients/upload/schema.js +2 -0
  54. package/dist/client/clients/upload/schema.js.map +1 -0
  55. package/dist/client/utils/client-utils.d.ts +15 -0
  56. package/dist/client/utils/client-utils.d.ts.map +1 -0
  57. package/dist/client/utils/client-utils.js +14 -0
  58. package/dist/client/utils/client-utils.js.map +1 -0
  59. package/dist/clients-configurations/clients-configuration.json +92 -0
  60. package/dist/clients-configurations/read-configuration-file.d.ts +22 -0
  61. package/dist/clients-configurations/read-configuration-file.d.ts.map +1 -0
  62. package/dist/clients-configurations/read-configuration-file.js +47 -0
  63. package/dist/clients-configurations/read-configuration-file.js.map +1 -0
  64. package/dist/index.d.ts +6 -0
  65. package/dist/index.d.ts.map +1 -0
  66. package/dist/index.js +33 -0
  67. package/dist/index.js.map +1 -0
  68. package/dist/types/index.d.ts +63 -0
  69. package/dist/types/index.d.ts.map +1 -0
  70. package/dist/types/index.js +6 -0
  71. package/dist/types/index.js.map +1 -0
  72. package/dist/utils/get-absolute-path.d.ts +3 -0
  73. package/dist/utils/get-absolute-path.d.ts.map +1 -0
  74. package/dist/utils/get-absolute-path.js +8 -0
  75. package/dist/utils/get-absolute-path.js.map +1 -0
  76. package/package.json +44 -0
  77. package/src/cli/cli-utils.ts +25 -0
  78. package/src/cli/index.ts +13 -0
  79. package/src/cli/outdated-clients-command.ts +148 -0
  80. package/src/cli/update-clients-command.ts +298 -0
  81. package/src/client/auth/index.ts +131 -0
  82. package/src/client/base-client.ts +97 -0
  83. package/src/client/clients/messaging/index.ts +683 -0
  84. package/src/client/clients/messaging/open-api-definition.json +8394 -0
  85. package/src/client/clients/messaging/schema.ts +3822 -0
  86. package/src/client/clients/payments/index.ts +349 -0
  87. package/src/client/clients/payments/open-api-definition.json +6094 -0
  88. package/src/client/clients/payments/schema.ts +2533 -0
  89. package/src/client/clients/profile/index.ts +182 -0
  90. package/src/client/clients/profile/open-api-definition.json +2876 -0
  91. package/src/client/clients/profile/schema.ts +1428 -0
  92. package/src/client/clients/scheduler/index.ts +28 -0
  93. package/src/client/clients/scheduler/open-api-definition.json +120 -0
  94. package/src/client/clients/scheduler/schema.ts +113 -0
  95. package/src/client/clients/upload/index.ts +129 -0
  96. package/src/client/clients/upload/open-api-definition.json +985 -0
  97. package/src/client/clients/upload/schema.ts +563 -0
  98. package/src/client/utils/client-utils.ts +50 -0
  99. package/src/clients-configurations/clients-configuration.json +92 -0
  100. package/src/clients-configurations/read-configuration-file.ts +68 -0
  101. package/src/index.ts +43 -0
  102. package/src/logto-node.d.ts +12 -0
  103. package/src/types/index.ts +82 -0
  104. package/src/utils/get-absolute-path.ts +10 -0
  105. package/tsconfig.json +18 -0
  106. package/tsconfig.prod.json +4 -0
package/src/client/clients/profile/open-api-definition.json ADDED
@@ -0,0 +1,2876 @@
1
+ {
2
+ "openapi": "3.0.3",
3
+ "info": {
4
+ "title": "OGCIO Profile API",
5
+ "description": "API for OGCIO Profile Service",
6
+ "version": "0.1.0"
7
+ },
8
+ "components": {
9
+ "schemas": {}
10
+ },
11
+ "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/": {
31
+ "get": {
32
+ "tags": [
33
+ "Addresses"
34
+ ],
35
+ "responses": {
36
+ "200": {
37
+ "description": "Default Response",
38
+ "content": {
39
+ "application/json": {
40
+ "schema": {
41
+ "type": "object",
42
+ "properties": {
43
+ "data": {
44
+ "type": "array",
45
+ "items": {
46
+ "type": "object",
47
+ "properties": {
48
+ "addressId": {
49
+ "type": "string"
50
+ },
51
+ "addressLine1": {
52
+ "type": "string"
53
+ },
54
+ "addressLine2": {
55
+ "type": "string"
56
+ },
57
+ "town": {
58
+ "type": "string"
59
+ },
60
+ "county": {
61
+ "type": "string"
62
+ },
63
+ "eirecode": {
64
+ "type": "string"
65
+ },
66
+ "updatedAt": {
67
+ "type": "string"
68
+ },
69
+ "moveInDate": {
70
+ "type": "string"
71
+ },
72
+ "moveOutDate": {
73
+ "type": "string"
74
+ },
75
+ "isPrimary": {
76
+ "type": "boolean"
77
+ },
78
+ "ownershipStatus": {
79
+ "type": "string"
80
+ }
81
+ },
82
+ "required": [
83
+ "addressId",
84
+ "addressLine1",
85
+ "addressLine2",
86
+ "town",
87
+ "county",
88
+ "eirecode",
89
+ "updatedAt"
90
+ ]
91
+ }
92
+ },
93
+ "metadata": {
94
+ "type": "object",
95
+ "properties": {
96
+ "links": {
97
+ "description": "Object containing the links to the related endpoints",
98
+ "type": "object",
99
+ "properties": {
100
+ "self": {
101
+ "type": "object",
102
+ "properties": {
103
+ "href": {
104
+ "description": "URL pointing to the request itself",
105
+ "type": "string"
106
+ }
107
+ }
108
+ },
109
+ "next": {
110
+ "type": "object",
111
+ "properties": {
112
+ "href": {
113
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
114
+ "type": "string"
115
+ }
116
+ }
117
+ },
118
+ "prev": {
119
+ "type": "object",
120
+ "properties": {
121
+ "href": {
122
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
123
+ "type": "string"
124
+ }
125
+ }
126
+ },
127
+ "first": {
128
+ "type": "object",
129
+ "properties": {
130
+ "href": {
131
+ "description": "URL pointing to the first page of results in a paginated response",
132
+ "type": "string"
133
+ }
134
+ }
135
+ },
136
+ "last": {
137
+ "type": "object",
138
+ "properties": {
139
+ "href": {
140
+ "description": "URL pointing to the first page of results in a paginated response",
141
+ "type": "string"
142
+ }
143
+ }
144
+ },
145
+ "pages": {
146
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
147
+ "type": "object",
148
+ "additionalProperties": {
149
+ "type": "object",
150
+ "properties": {
151
+ "href": {
152
+ "type": "string"
153
+ }
154
+ }
155
+ }
156
+ }
157
+ },
158
+ "required": [
159
+ "self",
160
+ "first",
161
+ "last",
162
+ "pages"
163
+ ]
164
+ },
165
+ "totalCount": {
166
+ "description": "Number representing the total number of available items",
167
+ "type": "number"
168
+ }
169
+ }
170
+ }
171
+ },
172
+ "required": [
173
+ "data"
174
+ ]
175
+ }
176
+ }
177
+ }
178
+ },
179
+ "500": {
180
+ "description": "Default Response",
181
+ "content": {
182
+ "application/json": {
183
+ "schema": {
184
+ "type": "object",
185
+ "properties": {
186
+ "code": {
187
+ "type": "string"
188
+ },
189
+ "detail": {
190
+ "type": "string"
191
+ },
192
+ "requestId": {
193
+ "type": "string"
194
+ },
195
+ "name": {
196
+ "type": "string"
197
+ },
198
+ "validation": {},
199
+ "validationContext": {
200
+ "type": "string"
201
+ }
202
+ },
203
+ "required": [
204
+ "code",
205
+ "detail",
206
+ "requestId",
207
+ "name"
208
+ ]
209
+ }
210
+ }
211
+ }
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
+ },
363
+ "500": {
364
+ "description": "Default Response",
365
+ "content": {
366
+ "application/json": {
367
+ "schema": {
368
+ "type": "object",
369
+ "properties": {
370
+ "code": {
371
+ "type": "string"
372
+ },
373
+ "detail": {
374
+ "type": "string"
375
+ },
376
+ "requestId": {
377
+ "type": "string"
378
+ },
379
+ "name": {
380
+ "type": "string"
381
+ },
382
+ "validation": {},
383
+ "validationContext": {
384
+ "type": "string"
385
+ }
386
+ },
387
+ "required": [
388
+ "code",
389
+ "detail",
390
+ "requestId",
391
+ "name"
392
+ ]
393
+ }
394
+ }
395
+ }
396
+ }
397
+ }
398
+ }
399
+ },
400
+ "/api/v1/addresses/{addressId}": {
401
+ "get": {
402
+ "tags": [
403
+ "Addresses"
404
+ ],
405
+ "parameters": [
406
+ {
407
+ "schema": {
408
+ "type": "string"
409
+ },
410
+ "in": "path",
411
+ "name": "addressId",
412
+ "required": true
413
+ }
414
+ ],
415
+ "responses": {
416
+ "200": {
417
+ "description": "Default Response",
418
+ "content": {
419
+ "application/json": {
420
+ "schema": {
421
+ "type": "object",
422
+ "properties": {
423
+ "data": {
424
+ "type": "object",
425
+ "properties": {
426
+ "addressId": {
427
+ "type": "string"
428
+ },
429
+ "addressLine1": {
430
+ "type": "string"
431
+ },
432
+ "addressLine2": {
433
+ "type": "string"
434
+ },
435
+ "town": {
436
+ "type": "string"
437
+ },
438
+ "county": {
439
+ "type": "string"
440
+ },
441
+ "eirecode": {
442
+ "type": "string"
443
+ },
444
+ "updatedAt": {
445
+ "type": "string"
446
+ },
447
+ "moveInDate": {
448
+ "type": "string"
449
+ },
450
+ "moveOutDate": {
451
+ "type": "string"
452
+ },
453
+ "isPrimary": {
454
+ "type": "boolean"
455
+ },
456
+ "ownershipStatus": {
457
+ "type": "string"
458
+ }
459
+ },
460
+ "required": [
461
+ "addressId",
462
+ "addressLine1",
463
+ "addressLine2",
464
+ "town",
465
+ "county",
466
+ "eirecode",
467
+ "updatedAt"
468
+ ]
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
+ }
613
+ },
614
+ "required": [
615
+ "code",
616
+ "detail",
617
+ "requestId",
618
+ "name"
619
+ ]
620
+ }
621
+ }
622
+ }
623
+ }
624
+ }
625
+ },
626
+ "put": {
627
+ "tags": [
628
+ "Addresses"
629
+ ],
630
+ "requestBody": {
631
+ "content": {
632
+ "application/json": {
633
+ "schema": {
634
+ "type": "object",
635
+ "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": {
696
+ "type": "object",
697
+ "properties": {
698
+ "id": {
699
+ "type": "string"
700
+ }
701
+ },
702
+ "required": [
703
+ "id"
704
+ ]
705
+ },
706
+ "metadata": {
707
+ "type": "object",
708
+ "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
+ ]
777
+ },
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": {
905
+ "type": "string"
906
+ }
907
+ },
908
+ "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
+ }
989
+ }
990
+ },
991
+ "required": [
992
+ "data"
993
+ ]
994
+ }
995
+ }
996
+ }
997
+ },
998
+ "404": {
999
+ "description": "Default Response",
1000
+ "content": {
1001
+ "application/json": {
1002
+ "schema": {
1003
+ "type": "object",
1004
+ "properties": {
1005
+ "code": {
1006
+ "type": "string"
1007
+ },
1008
+ "detail": {
1009
+ "type": "string"
1010
+ },
1011
+ "requestId": {
1012
+ "type": "string"
1013
+ },
1014
+ "name": {
1015
+ "type": "string"
1016
+ },
1017
+ "validation": {},
1018
+ "validationContext": {
1019
+ "type": "string"
1020
+ }
1021
+ },
1022
+ "required": [
1023
+ "code",
1024
+ "detail",
1025
+ "requestId",
1026
+ "name"
1027
+ ]
1028
+ }
1029
+ }
1030
+ }
1031
+ },
1032
+ "500": {
1033
+ "description": "Default Response",
1034
+ "content": {
1035
+ "application/json": {
1036
+ "schema": {
1037
+ "type": "object",
1038
+ "properties": {
1039
+ "code": {
1040
+ "type": "string"
1041
+ },
1042
+ "detail": {
1043
+ "type": "string"
1044
+ },
1045
+ "requestId": {
1046
+ "type": "string"
1047
+ },
1048
+ "name": {
1049
+ "type": "string"
1050
+ },
1051
+ "validation": {},
1052
+ "validationContext": {
1053
+ "type": "string"
1054
+ }
1055
+ },
1056
+ "required": [
1057
+ "code",
1058
+ "detail",
1059
+ "requestId",
1060
+ "name"
1061
+ ]
1062
+ }
1063
+ }
1064
+ }
1065
+ }
1066
+ }
1067
+ },
1068
+ "delete": {
1069
+ "tags": [
1070
+ "Addresses"
1071
+ ],
1072
+ "parameters": [
1073
+ {
1074
+ "schema": {
1075
+ "type": "string"
1076
+ },
1077
+ "in": "path",
1078
+ "name": "addressId",
1079
+ "required": true
1080
+ }
1081
+ ],
1082
+ "responses": {
1083
+ "200": {
1084
+ "description": "Default Response",
1085
+ "content": {
1086
+ "application/json": {
1087
+ "schema": {
1088
+ "type": "object",
1089
+ "properties": {
1090
+ "data": {
1091
+ "type": "object",
1092
+ "properties": {
1093
+ "id": {
1094
+ "type": "string"
1095
+ }
1096
+ },
1097
+ "required": [
1098
+ "id"
1099
+ ]
1100
+ },
1101
+ "metadata": {
1102
+ "type": "object",
1103
+ "properties": {
1104
+ "links": {
1105
+ "description": "Object containing the links to the related endpoints",
1106
+ "type": "object",
1107
+ "properties": {
1108
+ "self": {
1109
+ "type": "object",
1110
+ "properties": {
1111
+ "href": {
1112
+ "description": "URL pointing to the request itself",
1113
+ "type": "string"
1114
+ }
1115
+ }
1116
+ },
1117
+ "next": {
1118
+ "type": "object",
1119
+ "properties": {
1120
+ "href": {
1121
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
1122
+ "type": "string"
1123
+ }
1124
+ }
1125
+ },
1126
+ "prev": {
1127
+ "type": "object",
1128
+ "properties": {
1129
+ "href": {
1130
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
1131
+ "type": "string"
1132
+ }
1133
+ }
1134
+ },
1135
+ "first": {
1136
+ "type": "object",
1137
+ "properties": {
1138
+ "href": {
1139
+ "description": "URL pointing to the first page of results in a paginated response",
1140
+ "type": "string"
1141
+ }
1142
+ }
1143
+ },
1144
+ "last": {
1145
+ "type": "object",
1146
+ "properties": {
1147
+ "href": {
1148
+ "description": "URL pointing to the first page of results in a paginated response",
1149
+ "type": "string"
1150
+ }
1151
+ }
1152
+ },
1153
+ "pages": {
1154
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1155
+ "type": "object",
1156
+ "additionalProperties": {
1157
+ "type": "object",
1158
+ "properties": {
1159
+ "href": {
1160
+ "type": "string"
1161
+ }
1162
+ }
1163
+ }
1164
+ }
1165
+ },
1166
+ "required": [
1167
+ "self",
1168
+ "first",
1169
+ "last",
1170
+ "pages"
1171
+ ]
1172
+ },
1173
+ "totalCount": {
1174
+ "description": "Number representing the total number of available items",
1175
+ "type": "number"
1176
+ }
1177
+ }
1178
+ }
1179
+ },
1180
+ "required": [
1181
+ "data"
1182
+ ]
1183
+ }
1184
+ }
1185
+ }
1186
+ },
1187
+ "404": {
1188
+ "description": "Default Response",
1189
+ "content": {
1190
+ "application/json": {
1191
+ "schema": {
1192
+ "type": "object",
1193
+ "properties": {
1194
+ "code": {
1195
+ "type": "string"
1196
+ },
1197
+ "detail": {
1198
+ "type": "string"
1199
+ },
1200
+ "requestId": {
1201
+ "type": "string"
1202
+ },
1203
+ "name": {
1204
+ "type": "string"
1205
+ },
1206
+ "validation": {},
1207
+ "validationContext": {
1208
+ "type": "string"
1209
+ }
1210
+ },
1211
+ "required": [
1212
+ "code",
1213
+ "detail",
1214
+ "requestId",
1215
+ "name"
1216
+ ]
1217
+ }
1218
+ }
1219
+ }
1220
+ },
1221
+ "500": {
1222
+ "description": "Default Response",
1223
+ "content": {
1224
+ "application/json": {
1225
+ "schema": {
1226
+ "type": "object",
1227
+ "properties": {
1228
+ "code": {
1229
+ "type": "string"
1230
+ },
1231
+ "detail": {
1232
+ "type": "string"
1233
+ },
1234
+ "requestId": {
1235
+ "type": "string"
1236
+ },
1237
+ "name": {
1238
+ "type": "string"
1239
+ },
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": {
1272
+ "type": "array",
1273
+ "items": {
1274
+ "type": "object",
1275
+ "properties": {
1276
+ "firstname": {
1277
+ "type": "string"
1278
+ },
1279
+ "lastname": {
1280
+ "type": "string"
1281
+ },
1282
+ "type": {
1283
+ "type": "string"
1284
+ },
1285
+ "issueDate": {
1286
+ "type": "string"
1287
+ },
1288
+ "expiryDate": {
1289
+ "type": "string"
1290
+ },
1291
+ "documentNumber": {
1292
+ "type": "string"
1293
+ }
1294
+ },
1295
+ "required": [
1296
+ "firstname",
1297
+ "lastname",
1298
+ "type",
1299
+ "issueDate",
1300
+ "documentNumber"
1301
+ ]
1302
+ }
1303
+ },
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
+ "validationContext": {
1411
+ "type": "string"
1412
+ }
1413
+ },
1414
+ "required": [
1415
+ "code",
1416
+ "detail",
1417
+ "requestId",
1418
+ "name"
1419
+ ]
1420
+ }
1421
+ }
1422
+ }
1423
+ }
1424
+ }
1425
+ }
1426
+ },
1427
+ "/api/v1/users/{userId}": {
1428
+ "get": {
1429
+ "tags": [
1430
+ "Users"
1431
+ ],
1432
+ "parameters": [
1433
+ {
1434
+ "schema": {
1435
+ "type": "string"
1436
+ },
1437
+ "in": "path",
1438
+ "name": "userId",
1439
+ "required": true
1440
+ }
1441
+ ],
1442
+ "responses": {
1443
+ "200": {
1444
+ "description": "Default Response",
1445
+ "content": {
1446
+ "application/json": {
1447
+ "schema": {
1448
+ "type": "object",
1449
+ "properties": {
1450
+ "data": {
1451
+ "type": "object",
1452
+ "properties": {
1453
+ "title": {
1454
+ "default": null,
1455
+ "anyOf": [
1456
+ {
1457
+ "type": "null"
1458
+ },
1459
+ {
1460
+ "type": "string"
1461
+ }
1462
+ ]
1463
+ },
1464
+ "firstName": {
1465
+ "type": "string"
1466
+ },
1467
+ "lastName": {
1468
+ "type": "string"
1469
+ },
1470
+ "dateOfBirth": {
1471
+ "default": null,
1472
+ "anyOf": [
1473
+ {
1474
+ "type": "null"
1475
+ },
1476
+ {
1477
+ "format": "date-time",
1478
+ "type": "string"
1479
+ }
1480
+ ]
1481
+ },
1482
+ "ppsn": {
1483
+ "default": null,
1484
+ "anyOf": [
1485
+ {
1486
+ "type": "null"
1487
+ },
1488
+ {
1489
+ "type": "string"
1490
+ }
1491
+ ]
1492
+ },
1493
+ "ppsnVisible": {
1494
+ "default": false,
1495
+ "anyOf": [
1496
+ {
1497
+ "type": "null"
1498
+ },
1499
+ {
1500
+ "type": "boolean"
1501
+ }
1502
+ ]
1503
+ },
1504
+ "gender": {
1505
+ "default": null,
1506
+ "anyOf": [
1507
+ {
1508
+ "type": "null"
1509
+ },
1510
+ {
1511
+ "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
+ },
1525
+ {
1526
+ "type": "string"
1527
+ }
1528
+ ]
1529
+ },
1530
+ "consentToPrefillData": {
1531
+ "default": false,
1532
+ "anyOf": [
1533
+ {
1534
+ "type": "null"
1535
+ },
1536
+ {
1537
+ "type": "boolean"
1538
+ }
1539
+ ]
1540
+ },
1541
+ "preferredLanguage": {
1542
+ "default": "en",
1543
+ "type": "string"
1544
+ }
1545
+ },
1546
+ "required": [
1547
+ "firstName",
1548
+ "lastName",
1549
+ "email",
1550
+ "preferredLanguage"
1551
+ ]
1552
+ },
1553
+ "metadata": {
1554
+ "type": "object",
1555
+ "properties": {
1556
+ "links": {
1557
+ "description": "Object containing the links to the related endpoints",
1558
+ "type": "object",
1559
+ "properties": {
1560
+ "self": {
1561
+ "type": "object",
1562
+ "properties": {
1563
+ "href": {
1564
+ "description": "URL pointing to the request itself",
1565
+ "type": "string"
1566
+ }
1567
+ }
1568
+ },
1569
+ "next": {
1570
+ "type": "object",
1571
+ "properties": {
1572
+ "href": {
1573
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
1574
+ "type": "string"
1575
+ }
1576
+ }
1577
+ },
1578
+ "prev": {
1579
+ "type": "object",
1580
+ "properties": {
1581
+ "href": {
1582
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
1583
+ "type": "string"
1584
+ }
1585
+ }
1586
+ },
1587
+ "first": {
1588
+ "type": "object",
1589
+ "properties": {
1590
+ "href": {
1591
+ "description": "URL pointing to the first page of results in a paginated response",
1592
+ "type": "string"
1593
+ }
1594
+ }
1595
+ },
1596
+ "last": {
1597
+ "type": "object",
1598
+ "properties": {
1599
+ "href": {
1600
+ "description": "URL pointing to the first page of results in a paginated response",
1601
+ "type": "string"
1602
+ }
1603
+ }
1604
+ },
1605
+ "pages": {
1606
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1607
+ "type": "object",
1608
+ "additionalProperties": {
1609
+ "type": "object",
1610
+ "properties": {
1611
+ "href": {
1612
+ "type": "string"
1613
+ }
1614
+ }
1615
+ }
1616
+ }
1617
+ },
1618
+ "required": [
1619
+ "self",
1620
+ "first",
1621
+ "last",
1622
+ "pages"
1623
+ ]
1624
+ },
1625
+ "totalCount": {
1626
+ "description": "Number representing the total number of available items",
1627
+ "type": "number"
1628
+ }
1629
+ }
1630
+ }
1631
+ },
1632
+ "required": [
1633
+ "data"
1634
+ ]
1635
+ }
1636
+ }
1637
+ }
1638
+ },
1639
+ "404": {
1640
+ "description": "Default Response",
1641
+ "content": {
1642
+ "application/json": {
1643
+ "schema": {
1644
+ "type": "object",
1645
+ "properties": {
1646
+ "code": {
1647
+ "type": "string"
1648
+ },
1649
+ "detail": {
1650
+ "type": "string"
1651
+ },
1652
+ "requestId": {
1653
+ "type": "string"
1654
+ },
1655
+ "name": {
1656
+ "type": "string"
1657
+ },
1658
+ "validation": {},
1659
+ "validationContext": {
1660
+ "type": "string"
1661
+ }
1662
+ },
1663
+ "required": [
1664
+ "code",
1665
+ "detail",
1666
+ "requestId",
1667
+ "name"
1668
+ ]
1669
+ }
1670
+ }
1671
+ }
1672
+ },
1673
+ "500": {
1674
+ "description": "Default Response",
1675
+ "content": {
1676
+ "application/json": {
1677
+ "schema": {
1678
+ "type": "object",
1679
+ "properties": {
1680
+ "code": {
1681
+ "type": "string"
1682
+ },
1683
+ "detail": {
1684
+ "type": "string"
1685
+ },
1686
+ "requestId": {
1687
+ "type": "string"
1688
+ },
1689
+ "name": {
1690
+ "type": "string"
1691
+ },
1692
+ "validation": {},
1693
+ "validationContext": {
1694
+ "type": "string"
1695
+ }
1696
+ },
1697
+ "required": [
1698
+ "code",
1699
+ "detail",
1700
+ "requestId",
1701
+ "name"
1702
+ ]
1703
+ }
1704
+ }
1705
+ }
1706
+ }
1707
+ }
1708
+ },
1709
+ "put": {
1710
+ "tags": [
1711
+ "Users"
1712
+ ],
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
+ }
1752
+ },
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
+ }
1767
+ },
1768
+ "required": true
1769
+ },
1770
+ "parameters": [
1771
+ {
1772
+ "schema": {
1773
+ "type": "string"
1774
+ },
1775
+ "in": "path",
1776
+ "name": "userId",
1777
+ "required": true
1778
+ }
1779
+ ],
1780
+ "responses": {
1781
+ "200": {
1782
+ "description": "Default Response",
1783
+ "content": {
1784
+ "application/json": {
1785
+ "schema": {
1786
+ "type": "object",
1787
+ "properties": {
1788
+ "data": {
1789
+ "type": "object",
1790
+ "properties": {
1791
+ "id": {
1792
+ "type": "string"
1793
+ }
1794
+ },
1795
+ "required": [
1796
+ "id"
1797
+ ]
1798
+ },
1799
+ "metadata": {
1800
+ "type": "object",
1801
+ "properties": {
1802
+ "links": {
1803
+ "description": "Object containing the links to the related endpoints",
1804
+ "type": "object",
1805
+ "properties": {
1806
+ "self": {
1807
+ "type": "object",
1808
+ "properties": {
1809
+ "href": {
1810
+ "description": "URL pointing to the request itself",
1811
+ "type": "string"
1812
+ }
1813
+ }
1814
+ },
1815
+ "next": {
1816
+ "type": "object",
1817
+ "properties": {
1818
+ "href": {
1819
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
1820
+ "type": "string"
1821
+ }
1822
+ }
1823
+ },
1824
+ "prev": {
1825
+ "type": "object",
1826
+ "properties": {
1827
+ "href": {
1828
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
1829
+ "type": "string"
1830
+ }
1831
+ }
1832
+ },
1833
+ "first": {
1834
+ "type": "object",
1835
+ "properties": {
1836
+ "href": {
1837
+ "description": "URL pointing to the first page of results in a paginated response",
1838
+ "type": "string"
1839
+ }
1840
+ }
1841
+ },
1842
+ "last": {
1843
+ "type": "object",
1844
+ "properties": {
1845
+ "href": {
1846
+ "description": "URL pointing to the first page of results in a paginated response",
1847
+ "type": "string"
1848
+ }
1849
+ }
1850
+ },
1851
+ "pages": {
1852
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
1853
+ "type": "object",
1854
+ "additionalProperties": {
1855
+ "type": "object",
1856
+ "properties": {
1857
+ "href": {
1858
+ "type": "string"
1859
+ }
1860
+ }
1861
+ }
1862
+ }
1863
+ },
1864
+ "required": [
1865
+ "self",
1866
+ "first",
1867
+ "last",
1868
+ "pages"
1869
+ ]
1870
+ },
1871
+ "totalCount": {
1872
+ "description": "Number representing the total number of available items",
1873
+ "type": "number"
1874
+ }
1875
+ }
1876
+ }
1877
+ },
1878
+ "required": [
1879
+ "data"
1880
+ ]
1881
+ }
1882
+ }
1883
+ }
1884
+ },
1885
+ "404": {
1886
+ "description": "Default Response",
1887
+ "content": {
1888
+ "application/json": {
1889
+ "schema": {
1890
+ "type": "object",
1891
+ "properties": {
1892
+ "code": {
1893
+ "type": "string"
1894
+ },
1895
+ "detail": {
1896
+ "type": "string"
1897
+ },
1898
+ "requestId": {
1899
+ "type": "string"
1900
+ },
1901
+ "name": {
1902
+ "type": "string"
1903
+ },
1904
+ "validation": {},
1905
+ "validationContext": {
1906
+ "type": "string"
1907
+ }
1908
+ },
1909
+ "required": [
1910
+ "code",
1911
+ "detail",
1912
+ "requestId",
1913
+ "name"
1914
+ ]
1915
+ }
1916
+ }
1917
+ }
1918
+ },
1919
+ "500": {
1920
+ "description": "Default Response",
1921
+ "content": {
1922
+ "application/json": {
1923
+ "schema": {
1924
+ "type": "object",
1925
+ "properties": {
1926
+ "code": {
1927
+ "type": "string"
1928
+ },
1929
+ "detail": {
1930
+ "type": "string"
1931
+ },
1932
+ "requestId": {
1933
+ "type": "string"
1934
+ },
1935
+ "name": {
1936
+ "type": "string"
1937
+ },
1938
+ "validation": {},
1939
+ "validationContext": {
1940
+ "type": "string"
1941
+ }
1942
+ },
1943
+ "required": [
1944
+ "code",
1945
+ "detail",
1946
+ "requestId",
1947
+ "name"
1948
+ ]
1949
+ }
1950
+ }
1951
+ }
1952
+ }
1953
+ }
1954
+ },
1955
+ "patch": {
1956
+ "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
+ },
1979
+ "parameters": [
1980
+ {
1981
+ "schema": {
1982
+ "type": "string"
1983
+ },
1984
+ "in": "path",
1985
+ "name": "userId",
1986
+ "required": true
1987
+ }
1988
+ ],
1989
+ "responses": {
1990
+ "200": {
1991
+ "description": "Default Response",
1992
+ "content": {
1993
+ "application/json": {
1994
+ "schema": {
1995
+ "type": "object",
1996
+ "properties": {
1997
+ "data": {
1998
+ "type": "object",
1999
+ "properties": {
2000
+ "id": {
2001
+ "type": "string"
2002
+ }
2003
+ },
2004
+ "required": [
2005
+ "id"
2006
+ ]
2007
+ },
2008
+ "metadata": {
2009
+ "type": "object",
2010
+ "properties": {
2011
+ "links": {
2012
+ "description": "Object containing the links to the related endpoints",
2013
+ "type": "object",
2014
+ "properties": {
2015
+ "self": {
2016
+ "type": "object",
2017
+ "properties": {
2018
+ "href": {
2019
+ "description": "URL pointing to the request itself",
2020
+ "type": "string"
2021
+ }
2022
+ }
2023
+ },
2024
+ "next": {
2025
+ "type": "object",
2026
+ "properties": {
2027
+ "href": {
2028
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
2029
+ "type": "string"
2030
+ }
2031
+ }
2032
+ },
2033
+ "prev": {
2034
+ "type": "object",
2035
+ "properties": {
2036
+ "href": {
2037
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
2038
+ "type": "string"
2039
+ }
2040
+ }
2041
+ },
2042
+ "first": {
2043
+ "type": "object",
2044
+ "properties": {
2045
+ "href": {
2046
+ "description": "URL pointing to the first page of results in a paginated response",
2047
+ "type": "string"
2048
+ }
2049
+ }
2050
+ },
2051
+ "last": {
2052
+ "type": "object",
2053
+ "properties": {
2054
+ "href": {
2055
+ "description": "URL pointing to the first page of results in a paginated response",
2056
+ "type": "string"
2057
+ }
2058
+ }
2059
+ },
2060
+ "pages": {
2061
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
2062
+ "type": "object",
2063
+ "additionalProperties": {
2064
+ "type": "object",
2065
+ "properties": {
2066
+ "href": {
2067
+ "type": "string"
2068
+ }
2069
+ }
2070
+ }
2071
+ }
2072
+ },
2073
+ "required": [
2074
+ "self",
2075
+ "first",
2076
+ "last",
2077
+ "pages"
2078
+ ]
2079
+ },
2080
+ "totalCount": {
2081
+ "description": "Number representing the total number of available items",
2082
+ "type": "number"
2083
+ }
2084
+ }
2085
+ }
2086
+ },
2087
+ "required": [
2088
+ "data"
2089
+ ]
2090
+ }
2091
+ }
2092
+ }
2093
+ },
2094
+ "404": {
2095
+ "description": "Default Response",
2096
+ "content": {
2097
+ "application/json": {
2098
+ "schema": {
2099
+ "type": "object",
2100
+ "properties": {
2101
+ "code": {
2102
+ "type": "string"
2103
+ },
2104
+ "detail": {
2105
+ "type": "string"
2106
+ },
2107
+ "requestId": {
2108
+ "type": "string"
2109
+ },
2110
+ "name": {
2111
+ "type": "string"
2112
+ },
2113
+ "validation": {},
2114
+ "validationContext": {
2115
+ "type": "string"
2116
+ }
2117
+ },
2118
+ "required": [
2119
+ "code",
2120
+ "detail",
2121
+ "requestId",
2122
+ "name"
2123
+ ]
2124
+ }
2125
+ }
2126
+ }
2127
+ },
2128
+ "500": {
2129
+ "description": "Default Response",
2130
+ "content": {
2131
+ "application/json": {
2132
+ "schema": {
2133
+ "type": "object",
2134
+ "properties": {
2135
+ "code": {
2136
+ "type": "string"
2137
+ },
2138
+ "detail": {
2139
+ "type": "string"
2140
+ },
2141
+ "requestId": {
2142
+ "type": "string"
2143
+ },
2144
+ "name": {
2145
+ "type": "string"
2146
+ },
2147
+ "validation": {},
2148
+ "validationContext": {
2149
+ "type": "string"
2150
+ }
2151
+ },
2152
+ "required": [
2153
+ "code",
2154
+ "detail",
2155
+ "requestId",
2156
+ "name"
2157
+ ]
2158
+ }
2159
+ }
2160
+ }
2161
+ }
2162
+ }
2163
+ }
2164
+ },
2165
+ "/api/v1/users/": {
2166
+ "post": {
2167
+ "tags": [
2168
+ "Users"
2169
+ ],
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
+ }
2219
+ },
2220
+ "required": true
2221
+ },
2222
+ "responses": {
2223
+ "200": {
2224
+ "description": "Default Response",
2225
+ "content": {
2226
+ "application/json": {
2227
+ "schema": {
2228
+ "type": "object",
2229
+ "properties": {
2230
+ "data": {
2231
+ "type": "object",
2232
+ "properties": {
2233
+ "id": {
2234
+ "type": "string"
2235
+ }
2236
+ },
2237
+ "required": [
2238
+ "id"
2239
+ ]
2240
+ },
2241
+ "metadata": {
2242
+ "type": "object",
2243
+ "properties": {
2244
+ "links": {
2245
+ "description": "Object containing the links to the related endpoints",
2246
+ "type": "object",
2247
+ "properties": {
2248
+ "self": {
2249
+ "type": "object",
2250
+ "properties": {
2251
+ "href": {
2252
+ "description": "URL pointing to the request itself",
2253
+ "type": "string"
2254
+ }
2255
+ }
2256
+ },
2257
+ "next": {
2258
+ "type": "object",
2259
+ "properties": {
2260
+ "href": {
2261
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
2262
+ "type": "string"
2263
+ }
2264
+ }
2265
+ },
2266
+ "prev": {
2267
+ "type": "object",
2268
+ "properties": {
2269
+ "href": {
2270
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
2271
+ "type": "string"
2272
+ }
2273
+ }
2274
+ },
2275
+ "first": {
2276
+ "type": "object",
2277
+ "properties": {
2278
+ "href": {
2279
+ "description": "URL pointing to the first page of results in a paginated response",
2280
+ "type": "string"
2281
+ }
2282
+ }
2283
+ },
2284
+ "last": {
2285
+ "type": "object",
2286
+ "properties": {
2287
+ "href": {
2288
+ "description": "URL pointing to the first page of results in a paginated response",
2289
+ "type": "string"
2290
+ }
2291
+ }
2292
+ },
2293
+ "pages": {
2294
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
2295
+ "type": "object",
2296
+ "additionalProperties": {
2297
+ "type": "object",
2298
+ "properties": {
2299
+ "href": {
2300
+ "type": "string"
2301
+ }
2302
+ }
2303
+ }
2304
+ }
2305
+ },
2306
+ "required": [
2307
+ "self",
2308
+ "first",
2309
+ "last",
2310
+ "pages"
2311
+ ]
2312
+ },
2313
+ "totalCount": {
2314
+ "description": "Number representing the total number of available items",
2315
+ "type": "number"
2316
+ }
2317
+ }
2318
+ }
2319
+ },
2320
+ "required": [
2321
+ "data"
2322
+ ]
2323
+ }
2324
+ }
2325
+ }
2326
+ },
2327
+ "500": {
2328
+ "description": "Default Response",
2329
+ "content": {
2330
+ "application/json": {
2331
+ "schema": {
2332
+ "type": "object",
2333
+ "properties": {
2334
+ "code": {
2335
+ "type": "string"
2336
+ },
2337
+ "detail": {
2338
+ "type": "string"
2339
+ },
2340
+ "requestId": {
2341
+ "type": "string"
2342
+ },
2343
+ "name": {
2344
+ "type": "string"
2345
+ },
2346
+ "validation": {},
2347
+ "validationContext": {
2348
+ "type": "string"
2349
+ }
2350
+ },
2351
+ "required": [
2352
+ "code",
2353
+ "detail",
2354
+ "requestId",
2355
+ "name"
2356
+ ]
2357
+ }
2358
+ }
2359
+ }
2360
+ }
2361
+ }
2362
+ }
2363
+ },
2364
+ "/api/v1/users/find": {
2365
+ "get": {
2366
+ "tags": [
2367
+ "Users"
2368
+ ],
2369
+ "parameters": [
2370
+ {
2371
+ "schema": {
2372
+ "type": "string"
2373
+ },
2374
+ "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
2417
+ },
2418
+ {
2419
+ "schema": {
2420
+ "type": "string"
2421
+ },
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
2433
+ }
2434
+ ],
2435
+ "responses": {
2436
+ "200": {
2437
+ "description": "Default Response",
2438
+ "content": {
2439
+ "application/json": {
2440
+ "schema": {
2441
+ "type": "object",
2442
+ "properties": {
2443
+ "data": {
2444
+ "type": "object",
2445
+ "properties": {
2446
+ "id": {
2447
+ "type": "string"
2448
+ },
2449
+ "firstname": {
2450
+ "type": "string"
2451
+ },
2452
+ "lastname": {
2453
+ "type": "string"
2454
+ },
2455
+ "matchQuality": {
2456
+ "anyOf": [
2457
+ {
2458
+ "type": "string",
2459
+ "enum": [
2460
+ "exact"
2461
+ ]
2462
+ },
2463
+ {
2464
+ "type": "string",
2465
+ "enum": [
2466
+ "approximate"
2467
+ ]
2468
+ }
2469
+ ]
2470
+ }
2471
+ },
2472
+ "required": [
2473
+ "id",
2474
+ "firstname",
2475
+ "lastname",
2476
+ "matchQuality"
2477
+ ]
2478
+ },
2479
+ "metadata": {
2480
+ "type": "object",
2481
+ "properties": {
2482
+ "links": {
2483
+ "description": "Object containing the links to the related endpoints",
2484
+ "type": "object",
2485
+ "properties": {
2486
+ "self": {
2487
+ "type": "object",
2488
+ "properties": {
2489
+ "href": {
2490
+ "description": "URL pointing to the request itself",
2491
+ "type": "string"
2492
+ }
2493
+ }
2494
+ },
2495
+ "next": {
2496
+ "type": "object",
2497
+ "properties": {
2498
+ "href": {
2499
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
2500
+ "type": "string"
2501
+ }
2502
+ }
2503
+ },
2504
+ "prev": {
2505
+ "type": "object",
2506
+ "properties": {
2507
+ "href": {
2508
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
2509
+ "type": "string"
2510
+ }
2511
+ }
2512
+ },
2513
+ "first": {
2514
+ "type": "object",
2515
+ "properties": {
2516
+ "href": {
2517
+ "description": "URL pointing to the first page of results in a paginated response",
2518
+ "type": "string"
2519
+ }
2520
+ }
2521
+ },
2522
+ "last": {
2523
+ "type": "object",
2524
+ "properties": {
2525
+ "href": {
2526
+ "description": "URL pointing to the first page of results in a paginated response",
2527
+ "type": "string"
2528
+ }
2529
+ }
2530
+ },
2531
+ "pages": {
2532
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
2533
+ "type": "object",
2534
+ "additionalProperties": {
2535
+ "type": "object",
2536
+ "properties": {
2537
+ "href": {
2538
+ "type": "string"
2539
+ }
2540
+ }
2541
+ }
2542
+ }
2543
+ },
2544
+ "required": [
2545
+ "self",
2546
+ "first",
2547
+ "last",
2548
+ "pages"
2549
+ ]
2550
+ },
2551
+ "totalCount": {
2552
+ "description": "Number representing the total number of available items",
2553
+ "type": "number"
2554
+ }
2555
+ }
2556
+ }
2557
+ },
2558
+ "required": [
2559
+ "data"
2560
+ ]
2561
+ }
2562
+ }
2563
+ }
2564
+ },
2565
+ "404": {
2566
+ "description": "Default Response",
2567
+ "content": {
2568
+ "application/json": {
2569
+ "schema": {
2570
+ "type": "object",
2571
+ "properties": {
2572
+ "code": {
2573
+ "type": "string"
2574
+ },
2575
+ "detail": {
2576
+ "type": "string"
2577
+ },
2578
+ "requestId": {
2579
+ "type": "string"
2580
+ },
2581
+ "name": {
2582
+ "type": "string"
2583
+ },
2584
+ "validation": {},
2585
+ "validationContext": {
2586
+ "type": "string"
2587
+ }
2588
+ },
2589
+ "required": [
2590
+ "code",
2591
+ "detail",
2592
+ "requestId",
2593
+ "name"
2594
+ ]
2595
+ }
2596
+ }
2597
+ }
2598
+ },
2599
+ "500": {
2600
+ "description": "Default Response",
2601
+ "content": {
2602
+ "application/json": {
2603
+ "schema": {
2604
+ "type": "object",
2605
+ "properties": {
2606
+ "code": {
2607
+ "type": "string"
2608
+ },
2609
+ "detail": {
2610
+ "type": "string"
2611
+ },
2612
+ "requestId": {
2613
+ "type": "string"
2614
+ },
2615
+ "name": {
2616
+ "type": "string"
2617
+ },
2618
+ "validation": {},
2619
+ "validationContext": {
2620
+ "type": "string"
2621
+ }
2622
+ },
2623
+ "required": [
2624
+ "code",
2625
+ "detail",
2626
+ "requestId",
2627
+ "name"
2628
+ ]
2629
+ }
2630
+ }
2631
+ }
2632
+ }
2633
+ }
2634
+ }
2635
+ },
2636
+ "/api/v1/users/select": {
2637
+ "post": {
2638
+ "tags": [
2639
+ "Users"
2640
+ ],
2641
+ "requestBody": {
2642
+ "content": {
2643
+ "application/json": {
2644
+ "schema": {
2645
+ "type": "object",
2646
+ "properties": {
2647
+ "ids": {
2648
+ "type": "array",
2649
+ "items": {
2650
+ "type": "string"
2651
+ }
2652
+ }
2653
+ },
2654
+ "required": [
2655
+ "ids"
2656
+ ]
2657
+ }
2658
+ }
2659
+ },
2660
+ "required": true
2661
+ },
2662
+ "responses": {
2663
+ "200": {
2664
+ "description": "Default Response",
2665
+ "content": {
2666
+ "application/json": {
2667
+ "schema": {
2668
+ "type": "object",
2669
+ "properties": {
2670
+ "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
+ }
2697
+ },
2698
+ "required": [
2699
+ "id",
2700
+ "firstName",
2701
+ "lastName",
2702
+ "ppsn",
2703
+ "preferredLanguage"
2704
+ ]
2705
+ }
2706
+ },
2707
+ "metadata": {
2708
+ "type": "object",
2709
+ "properties": {
2710
+ "links": {
2711
+ "description": "Object containing the links to the related endpoints",
2712
+ "type": "object",
2713
+ "properties": {
2714
+ "self": {
2715
+ "type": "object",
2716
+ "properties": {
2717
+ "href": {
2718
+ "description": "URL pointing to the request itself",
2719
+ "type": "string"
2720
+ }
2721
+ }
2722
+ },
2723
+ "next": {
2724
+ "type": "object",
2725
+ "properties": {
2726
+ "href": {
2727
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
2728
+ "type": "string"
2729
+ }
2730
+ }
2731
+ },
2732
+ "prev": {
2733
+ "type": "object",
2734
+ "properties": {
2735
+ "href": {
2736
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
2737
+ "type": "string"
2738
+ }
2739
+ }
2740
+ },
2741
+ "first": {
2742
+ "type": "object",
2743
+ "properties": {
2744
+ "href": {
2745
+ "description": "URL pointing to the first page of results in a paginated response",
2746
+ "type": "string"
2747
+ }
2748
+ }
2749
+ },
2750
+ "last": {
2751
+ "type": "object",
2752
+ "properties": {
2753
+ "href": {
2754
+ "description": "URL pointing to the first page of results in a paginated response",
2755
+ "type": "string"
2756
+ }
2757
+ }
2758
+ },
2759
+ "pages": {
2760
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
2761
+ "type": "object",
2762
+ "additionalProperties": {
2763
+ "type": "object",
2764
+ "properties": {
2765
+ "href": {
2766
+ "type": "string"
2767
+ }
2768
+ }
2769
+ }
2770
+ }
2771
+ },
2772
+ "required": [
2773
+ "self",
2774
+ "first",
2775
+ "last",
2776
+ "pages"
2777
+ ]
2778
+ },
2779
+ "totalCount": {
2780
+ "description": "Number representing the total number of available items",
2781
+ "type": "number"
2782
+ }
2783
+ }
2784
+ }
2785
+ },
2786
+ "required": [
2787
+ "data"
2788
+ ]
2789
+ }
2790
+ }
2791
+ }
2792
+ },
2793
+ "4XX": {
2794
+ "description": "Default Response",
2795
+ "content": {
2796
+ "application/json": {
2797
+ "schema": {
2798
+ "type": "object",
2799
+ "properties": {
2800
+ "code": {
2801
+ "type": "string"
2802
+ },
2803
+ "detail": {
2804
+ "type": "string"
2805
+ },
2806
+ "requestId": {
2807
+ "type": "string"
2808
+ },
2809
+ "name": {
2810
+ "type": "string"
2811
+ },
2812
+ "validation": {},
2813
+ "validationContext": {
2814
+ "type": "string"
2815
+ }
2816
+ },
2817
+ "required": [
2818
+ "code",
2819
+ "detail",
2820
+ "requestId",
2821
+ "name"
2822
+ ]
2823
+ }
2824
+ }
2825
+ }
2826
+ },
2827
+ "5XX": {
2828
+ "description": "Default Response",
2829
+ "content": {
2830
+ "application/json": {
2831
+ "schema": {
2832
+ "type": "object",
2833
+ "properties": {
2834
+ "code": {
2835
+ "type": "string"
2836
+ },
2837
+ "detail": {
2838
+ "type": "string"
2839
+ },
2840
+ "requestId": {
2841
+ "type": "string"
2842
+ },
2843
+ "name": {
2844
+ "type": "string"
2845
+ },
2846
+ "validation": {},
2847
+ "validationContext": {
2848
+ "type": "string"
2849
+ }
2850
+ },
2851
+ "required": [
2852
+ "code",
2853
+ "detail",
2854
+ "requestId",
2855
+ "name"
2856
+ ]
2857
+ }
2858
+ }
2859
+ }
2860
+ }
2861
+ }
2862
+ }
2863
+ }
2864
+ },
2865
+ "tags": [
2866
+ {
2867
+ "name": "User"
2868
+ },
2869
+ {
2870
+ "name": "Addresses"
2871
+ },
2872
+ {
2873
+ "name": "Entitlements"
2874
+ }
2875
+ ]
2876
+ }