@ogcio/building-blocks-sdk 0.2.51 → 0.2.52
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +7 -0
- package/dist/client/auth/index.d.ts.map +1 -1
- package/dist/client/clients/messaging/index.d.ts.map +1 -1
- package/dist/client/clients/profile/citizen.d.ts +191 -40
- package/dist/client/clients/profile/citizen.d.ts.map +1 -1
- package/dist/client/clients/profile/citizen.js +31 -10
- package/dist/client/clients/profile/citizen.js.map +1 -1
- package/dist/client/clients/profile/index.d.ts +77 -8
- package/dist/client/clients/profile/index.d.ts.map +1 -1
- package/dist/client/clients/profile/index.js +4 -4
- package/dist/client/clients/profile/index.js.map +1 -1
- package/dist/client/clients/profile/organisation.d.ts +861 -21
- package/dist/client/clients/profile/organisation.d.ts.map +1 -1
- package/dist/client/clients/profile/organisation.js +64 -4
- package/dist/client/clients/profile/organisation.js.map +1 -1
- package/dist/client/clients/profile/schema.d.ts +1773 -595
- package/dist/client/clients/profile/schema.d.ts.map +1 -1
- package/dist/client/clients/upload/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/package.json +16 -16
- package/src/client/clients/profile/citizen.ts +54 -14
- package/src/client/clients/profile/index.ts +13 -5
- package/src/client/clients/profile/open-api-definition.json +6812 -3375
- package/src/client/clients/profile/organisation.ts +117 -5
- package/src/client/clients/profile/schema.ts +1773 -595
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
export interface paths {
|
|
2
|
-
"/api/v1/citizens/consent-statements/
|
|
2
|
+
"/api/v1/citizens/consent-statements/current": {
|
|
3
3
|
parameters: {
|
|
4
4
|
query?: never;
|
|
5
5
|
header?: never;
|
|
6
6
|
path?: never;
|
|
7
7
|
cookie?: never;
|
|
8
8
|
};
|
|
9
|
-
/** @description Get the
|
|
10
|
-
get: operations["
|
|
9
|
+
/** @description Get the current statement for a subject */
|
|
10
|
+
get: operations["citizenCurrentStatement"];
|
|
11
11
|
put?: never;
|
|
12
12
|
post?: never;
|
|
13
13
|
delete?: never;
|
|
@@ -16,15 +16,32 @@ export interface paths {
|
|
|
16
16
|
patch?: never;
|
|
17
17
|
trace?: never;
|
|
18
18
|
};
|
|
19
|
-
"/api/v1/
|
|
19
|
+
"/api/v1/citizens/consent-statements/{id}": {
|
|
20
20
|
parameters: {
|
|
21
21
|
query?: never;
|
|
22
22
|
header?: never;
|
|
23
23
|
path?: never;
|
|
24
24
|
cookie?: never;
|
|
25
25
|
};
|
|
26
|
-
/** @description Get
|
|
27
|
-
get: operations["
|
|
26
|
+
/** @description Get a statement by id */
|
|
27
|
+
get: operations["citizenGetStatement"];
|
|
28
|
+
put?: never;
|
|
29
|
+
post?: never;
|
|
30
|
+
delete?: never;
|
|
31
|
+
options?: never;
|
|
32
|
+
head?: never;
|
|
33
|
+
patch?: never;
|
|
34
|
+
trace?: never;
|
|
35
|
+
};
|
|
36
|
+
"/api/v1/organisations/consent-statements/current": {
|
|
37
|
+
parameters: {
|
|
38
|
+
query?: never;
|
|
39
|
+
header?: never;
|
|
40
|
+
path?: never;
|
|
41
|
+
cookie?: never;
|
|
42
|
+
};
|
|
43
|
+
/** @description Get the current Statement for a subject */
|
|
44
|
+
get: operations["organizationCurrentStatement"];
|
|
28
45
|
put?: never;
|
|
29
46
|
post?: never;
|
|
30
47
|
delete?: never;
|
|
@@ -40,7 +57,8 @@ export interface paths {
|
|
|
40
57
|
path?: never;
|
|
41
58
|
cookie?: never;
|
|
42
59
|
};
|
|
43
|
-
|
|
60
|
+
/** @description List all statements for a subject */
|
|
61
|
+
get: operations["organizationListStatements"];
|
|
44
62
|
put?: never;
|
|
45
63
|
/** @description Create Statement for a subject */
|
|
46
64
|
post: operations["organizationCreateStatement"];
|
|
@@ -50,6 +68,41 @@ export interface paths {
|
|
|
50
68
|
patch?: never;
|
|
51
69
|
trace?: never;
|
|
52
70
|
};
|
|
71
|
+
"/api/v1/organisations/consent-statements/{id}": {
|
|
72
|
+
parameters: {
|
|
73
|
+
query?: never;
|
|
74
|
+
header?: never;
|
|
75
|
+
path?: never;
|
|
76
|
+
cookie?: never;
|
|
77
|
+
};
|
|
78
|
+
/** @description Get get a statement by id */
|
|
79
|
+
get: operations["organizationGetStatement"];
|
|
80
|
+
/** @description Update statement */
|
|
81
|
+
put: operations["organizationUpdateStatement"];
|
|
82
|
+
post?: never;
|
|
83
|
+
delete?: never;
|
|
84
|
+
options?: never;
|
|
85
|
+
head?: never;
|
|
86
|
+
patch?: never;
|
|
87
|
+
trace?: never;
|
|
88
|
+
};
|
|
89
|
+
"/api/v1/organisations/consent-statements/{id}/disable": {
|
|
90
|
+
parameters: {
|
|
91
|
+
query?: never;
|
|
92
|
+
header?: never;
|
|
93
|
+
path?: never;
|
|
94
|
+
cookie?: never;
|
|
95
|
+
};
|
|
96
|
+
get?: never;
|
|
97
|
+
put?: never;
|
|
98
|
+
post?: never;
|
|
99
|
+
delete?: never;
|
|
100
|
+
options?: never;
|
|
101
|
+
head?: never;
|
|
102
|
+
/** @description Disable a consent statement (User Admin only) */
|
|
103
|
+
patch: operations["organizationDisableStatement"];
|
|
104
|
+
trace?: never;
|
|
105
|
+
};
|
|
53
106
|
"/api/v1/citizens/consents/": {
|
|
54
107
|
parameters: {
|
|
55
108
|
query?: never;
|
|
@@ -60,8 +113,8 @@ export interface paths {
|
|
|
60
113
|
/** @description List the consents for a user, sorted by descending submission date */
|
|
61
114
|
get: operations["citizenListConsents"];
|
|
62
115
|
put?: never;
|
|
63
|
-
/** @description Submit
|
|
64
|
-
post: operations["
|
|
116
|
+
/** @description Submit consents for the logged in user */
|
|
117
|
+
post: operations["citizenSubmitConsents"];
|
|
65
118
|
delete?: never;
|
|
66
119
|
options?: never;
|
|
67
120
|
head?: never;
|
|
@@ -92,7 +145,7 @@ export interface paths {
|
|
|
92
145
|
path?: never;
|
|
93
146
|
cookie?: never;
|
|
94
147
|
};
|
|
95
|
-
/** @description List the
|
|
148
|
+
/** @description List the submission for the selected user */
|
|
96
149
|
get: operations["organisationListConsents"];
|
|
97
150
|
put?: never;
|
|
98
151
|
post?: never;
|
|
@@ -102,6 +155,23 @@ export interface paths {
|
|
|
102
155
|
patch?: never;
|
|
103
156
|
trace?: never;
|
|
104
157
|
};
|
|
158
|
+
"/api/v1/organisations/consents/latest": {
|
|
159
|
+
parameters: {
|
|
160
|
+
query?: never;
|
|
161
|
+
header?: never;
|
|
162
|
+
path?: never;
|
|
163
|
+
cookie?: never;
|
|
164
|
+
};
|
|
165
|
+
/** @description List the latest submission for the selected subject. Will return the ones for the specific profile, if set */
|
|
166
|
+
get: operations["organisationListLatestConsents"];
|
|
167
|
+
put?: never;
|
|
168
|
+
post?: never;
|
|
169
|
+
delete?: never;
|
|
170
|
+
options?: never;
|
|
171
|
+
head?: never;
|
|
172
|
+
patch?: never;
|
|
173
|
+
trace?: never;
|
|
174
|
+
};
|
|
105
175
|
"/api/v1/jobs/import-profiles/{profileImportId}": {
|
|
106
176
|
parameters: {
|
|
107
177
|
query?: never;
|
|
@@ -237,30 +307,30 @@ export interface paths {
|
|
|
237
307
|
patch?: never;
|
|
238
308
|
trace?: never;
|
|
239
309
|
};
|
|
240
|
-
"/api/v1/profiles/
|
|
310
|
+
"/api/v1/profiles/select-profiles": {
|
|
241
311
|
parameters: {
|
|
242
312
|
query?: never;
|
|
243
313
|
header?: never;
|
|
244
314
|
path?: never;
|
|
245
315
|
cookie?: never;
|
|
246
316
|
};
|
|
247
|
-
get
|
|
317
|
+
get: operations["selectProfiles"];
|
|
248
318
|
put?: never;
|
|
249
|
-
post
|
|
319
|
+
post?: never;
|
|
250
320
|
delete?: never;
|
|
251
321
|
options?: never;
|
|
252
322
|
head?: never;
|
|
253
323
|
patch?: never;
|
|
254
324
|
trace?: never;
|
|
255
325
|
};
|
|
256
|
-
"/api/v1/profiles/
|
|
326
|
+
"/api/v1/profiles/find-profile": {
|
|
257
327
|
parameters: {
|
|
258
328
|
query?: never;
|
|
259
329
|
header?: never;
|
|
260
330
|
path?: never;
|
|
261
331
|
cookie?: never;
|
|
262
332
|
};
|
|
263
|
-
get: operations["
|
|
333
|
+
get: operations["findProfile"];
|
|
264
334
|
put?: never;
|
|
265
335
|
post?: never;
|
|
266
336
|
delete?: never;
|
|
@@ -269,70 +339,71 @@ export interface paths {
|
|
|
269
339
|
patch?: never;
|
|
270
340
|
trace?: never;
|
|
271
341
|
};
|
|
272
|
-
"/api/v1/profiles/
|
|
342
|
+
"/api/v1/profiles/{profileId}": {
|
|
273
343
|
parameters: {
|
|
274
344
|
query?: never;
|
|
275
345
|
header?: never;
|
|
276
346
|
path?: never;
|
|
277
347
|
cookie?: never;
|
|
278
348
|
};
|
|
279
|
-
get: operations["
|
|
280
|
-
put
|
|
349
|
+
get: operations["getProfile"];
|
|
350
|
+
put: operations["putProfile"];
|
|
281
351
|
post?: never;
|
|
282
352
|
delete?: never;
|
|
283
353
|
options?: never;
|
|
284
354
|
head?: never;
|
|
285
|
-
patch
|
|
355
|
+
patch: operations["patchProfile"];
|
|
286
356
|
trace?: never;
|
|
287
357
|
};
|
|
288
|
-
"/api/v1/profiles/
|
|
358
|
+
"/api/v1/profiles/import-profiles": {
|
|
289
359
|
parameters: {
|
|
290
360
|
query?: never;
|
|
291
361
|
header?: never;
|
|
292
362
|
path?: never;
|
|
293
363
|
cookie?: never;
|
|
294
364
|
};
|
|
295
|
-
|
|
296
|
-
get: operations["listProfileImports"];
|
|
365
|
+
get?: never;
|
|
297
366
|
put?: never;
|
|
298
|
-
|
|
367
|
+
/** @deprecated */
|
|
368
|
+
post: operations["importProfilesOld"];
|
|
299
369
|
delete?: never;
|
|
300
370
|
options?: never;
|
|
301
371
|
head?: never;
|
|
302
372
|
patch?: never;
|
|
303
373
|
trace?: never;
|
|
304
374
|
};
|
|
305
|
-
"/api/v1/profiles/imports/
|
|
375
|
+
"/api/v1/profiles/imports/": {
|
|
306
376
|
parameters: {
|
|
307
377
|
query?: never;
|
|
308
378
|
header?: never;
|
|
309
379
|
path?: never;
|
|
310
380
|
cookie?: never;
|
|
311
381
|
};
|
|
312
|
-
/** @description
|
|
313
|
-
get: operations["
|
|
382
|
+
/** @description List profile imports with pagination */
|
|
383
|
+
get: operations["listProfileImports"];
|
|
314
384
|
put?: never;
|
|
315
|
-
post
|
|
385
|
+
post: operations["importProfiles"];
|
|
316
386
|
delete?: never;
|
|
317
387
|
options?: never;
|
|
318
388
|
head?: never;
|
|
319
389
|
patch?: never;
|
|
320
390
|
trace?: never;
|
|
321
391
|
};
|
|
322
|
-
"/api/v1/profiles/{
|
|
392
|
+
"/api/v1/profiles/imports/{importId}": {
|
|
323
393
|
parameters: {
|
|
324
394
|
query?: never;
|
|
325
395
|
header?: never;
|
|
326
396
|
path?: never;
|
|
327
397
|
cookie?: never;
|
|
328
398
|
};
|
|
329
|
-
|
|
330
|
-
|
|
399
|
+
/** @description Get details of profiles in a specific import */
|
|
400
|
+
get: operations["getProfileImportDetails"];
|
|
401
|
+
put?: never;
|
|
331
402
|
post?: never;
|
|
332
403
|
delete?: never;
|
|
333
404
|
options?: never;
|
|
334
405
|
head?: never;
|
|
335
|
-
patch
|
|
406
|
+
patch?: never;
|
|
336
407
|
trace?: never;
|
|
337
408
|
};
|
|
338
409
|
"/api/v1/profiles/imports/template": {
|
|
@@ -379,7 +450,7 @@ export interface components {
|
|
|
379
450
|
}
|
|
380
451
|
export type $defs = Record<string, never>;
|
|
381
452
|
export interface operations {
|
|
382
|
-
|
|
453
|
+
citizenCurrentStatement: {
|
|
383
454
|
parameters: {
|
|
384
455
|
query: {
|
|
385
456
|
subject: string;
|
|
@@ -397,13 +468,17 @@ export interface operations {
|
|
|
397
468
|
};
|
|
398
469
|
content: {
|
|
399
470
|
"application/json": {
|
|
400
|
-
data: {
|
|
471
|
+
data: ({
|
|
401
472
|
/** Format: uuid */
|
|
402
473
|
id: string;
|
|
403
474
|
subject: string;
|
|
404
475
|
version: number;
|
|
405
476
|
/** Format: date-time */
|
|
406
477
|
createdAt: string;
|
|
478
|
+
/** Format: date-time */
|
|
479
|
+
publishDate: string;
|
|
480
|
+
isEnabled: boolean;
|
|
481
|
+
createdBy: string;
|
|
407
482
|
} & {
|
|
408
483
|
translations: {
|
|
409
484
|
en: {
|
|
@@ -411,16 +486,10 @@ export interface operations {
|
|
|
411
486
|
id: string;
|
|
412
487
|
/** Format: uuid */
|
|
413
488
|
consentStatementId: string;
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
bodyList: string[];
|
|
417
|
-
bodyBottom: string[];
|
|
418
|
-
bodySmall: string[];
|
|
419
|
-
bodyLinks: {
|
|
420
|
-
[key: string]: string;
|
|
421
|
-
};
|
|
422
|
-
bodyFooter: string | null;
|
|
489
|
+
description: string | null;
|
|
490
|
+
disclaimer: string | null;
|
|
423
491
|
title: string;
|
|
492
|
+
language: "en" | "ga";
|
|
424
493
|
/** Format: date-time */
|
|
425
494
|
createdAt: string;
|
|
426
495
|
};
|
|
@@ -429,21 +498,15 @@ export interface operations {
|
|
|
429
498
|
id: string;
|
|
430
499
|
/** Format: uuid */
|
|
431
500
|
consentStatementId: string;
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
bodyList: string[];
|
|
435
|
-
bodyBottom: string[];
|
|
436
|
-
bodySmall: string[];
|
|
437
|
-
bodyLinks: {
|
|
438
|
-
[key: string]: string;
|
|
439
|
-
};
|
|
440
|
-
bodyFooter: string | null;
|
|
501
|
+
description: string | null;
|
|
502
|
+
disclaimer: string | null;
|
|
441
503
|
title: string;
|
|
504
|
+
language: "en" | "ga";
|
|
442
505
|
/** Format: date-time */
|
|
443
506
|
createdAt: string;
|
|
444
507
|
};
|
|
445
508
|
};
|
|
446
|
-
};
|
|
509
|
+
})[];
|
|
447
510
|
metadata?: {
|
|
448
511
|
/** @description Object containing the links to the related endpoints */
|
|
449
512
|
links?: {
|
|
@@ -532,13 +595,13 @@ export interface operations {
|
|
|
532
595
|
};
|
|
533
596
|
};
|
|
534
597
|
};
|
|
535
|
-
|
|
598
|
+
citizenGetStatement: {
|
|
536
599
|
parameters: {
|
|
537
|
-
query
|
|
538
|
-
subject: string;
|
|
539
|
-
};
|
|
600
|
+
query?: never;
|
|
540
601
|
header?: never;
|
|
541
|
-
path
|
|
602
|
+
path: {
|
|
603
|
+
id: string;
|
|
604
|
+
};
|
|
542
605
|
cookie?: never;
|
|
543
606
|
};
|
|
544
607
|
requestBody?: never;
|
|
@@ -557,6 +620,10 @@ export interface operations {
|
|
|
557
620
|
version: number;
|
|
558
621
|
/** Format: date-time */
|
|
559
622
|
createdAt: string;
|
|
623
|
+
/** Format: date-time */
|
|
624
|
+
publishDate: string;
|
|
625
|
+
isEnabled: boolean;
|
|
626
|
+
createdBy: string;
|
|
560
627
|
} & {
|
|
561
628
|
translations: {
|
|
562
629
|
en: {
|
|
@@ -564,16 +631,10 @@ export interface operations {
|
|
|
564
631
|
id: string;
|
|
565
632
|
/** Format: uuid */
|
|
566
633
|
consentStatementId: string;
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
bodyList: string[];
|
|
570
|
-
bodyBottom: string[];
|
|
571
|
-
bodySmall: string[];
|
|
572
|
-
bodyLinks: {
|
|
573
|
-
[key: string]: string;
|
|
574
|
-
};
|
|
575
|
-
bodyFooter: string | null;
|
|
634
|
+
description: string | null;
|
|
635
|
+
disclaimer: string | null;
|
|
576
636
|
title: string;
|
|
637
|
+
language: "en" | "ga";
|
|
577
638
|
/** Format: date-time */
|
|
578
639
|
createdAt: string;
|
|
579
640
|
};
|
|
@@ -582,16 +643,10 @@ export interface operations {
|
|
|
582
643
|
id: string;
|
|
583
644
|
/** Format: uuid */
|
|
584
645
|
consentStatementId: string;
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
bodyList: string[];
|
|
588
|
-
bodyBottom: string[];
|
|
589
|
-
bodySmall: string[];
|
|
590
|
-
bodyLinks: {
|
|
591
|
-
[key: string]: string;
|
|
592
|
-
};
|
|
593
|
-
bodyFooter: string | null;
|
|
646
|
+
description: string | null;
|
|
647
|
+
disclaimer: string | null;
|
|
594
648
|
title: string;
|
|
649
|
+
language: "en" | "ga";
|
|
595
650
|
/** Format: date-time */
|
|
596
651
|
createdAt: string;
|
|
597
652
|
};
|
|
@@ -685,47 +740,16 @@ export interface operations {
|
|
|
685
740
|
};
|
|
686
741
|
};
|
|
687
742
|
};
|
|
688
|
-
|
|
743
|
+
organizationCurrentStatement: {
|
|
689
744
|
parameters: {
|
|
690
|
-
query
|
|
745
|
+
query: {
|
|
746
|
+
subject: string;
|
|
747
|
+
};
|
|
691
748
|
header?: never;
|
|
692
749
|
path?: never;
|
|
693
750
|
cookie?: never;
|
|
694
751
|
};
|
|
695
|
-
requestBody
|
|
696
|
-
content: {
|
|
697
|
-
"application/json": {
|
|
698
|
-
consent: {
|
|
699
|
-
subject: string;
|
|
700
|
-
version: number;
|
|
701
|
-
};
|
|
702
|
-
translations: {
|
|
703
|
-
en: {
|
|
704
|
-
bodyTop: string[];
|
|
705
|
-
bodyList: string[];
|
|
706
|
-
bodyBottom: string[];
|
|
707
|
-
bodySmall: string[];
|
|
708
|
-
bodyLinks: {
|
|
709
|
-
[key: string]: string;
|
|
710
|
-
};
|
|
711
|
-
bodyFooter: string | null;
|
|
712
|
-
title: string;
|
|
713
|
-
};
|
|
714
|
-
ga: {
|
|
715
|
-
bodyTop: string[];
|
|
716
|
-
bodyList: string[];
|
|
717
|
-
bodyBottom: string[];
|
|
718
|
-
bodySmall: string[];
|
|
719
|
-
bodyLinks: {
|
|
720
|
-
[key: string]: string;
|
|
721
|
-
};
|
|
722
|
-
bodyFooter: string | null;
|
|
723
|
-
title: string;
|
|
724
|
-
};
|
|
725
|
-
};
|
|
726
|
-
};
|
|
727
|
-
};
|
|
728
|
-
};
|
|
752
|
+
requestBody?: never;
|
|
729
753
|
responses: {
|
|
730
754
|
/** @description Default Response */
|
|
731
755
|
200: {
|
|
@@ -734,10 +758,45 @@ export interface operations {
|
|
|
734
758
|
};
|
|
735
759
|
content: {
|
|
736
760
|
"application/json": {
|
|
737
|
-
data: {
|
|
761
|
+
data: ({
|
|
738
762
|
/** Format: uuid */
|
|
739
763
|
id: string;
|
|
740
|
-
|
|
764
|
+
subject: string;
|
|
765
|
+
version: number;
|
|
766
|
+
/** Format: date-time */
|
|
767
|
+
createdAt: string;
|
|
768
|
+
/** Format: date-time */
|
|
769
|
+
publishDate: string;
|
|
770
|
+
isEnabled: boolean;
|
|
771
|
+
createdBy: string;
|
|
772
|
+
} & {
|
|
773
|
+
translations: {
|
|
774
|
+
en: {
|
|
775
|
+
/** Format: uuid */
|
|
776
|
+
id: string;
|
|
777
|
+
/** Format: uuid */
|
|
778
|
+
consentStatementId: string;
|
|
779
|
+
description: string | null;
|
|
780
|
+
disclaimer: string | null;
|
|
781
|
+
title: string;
|
|
782
|
+
language: "en" | "ga";
|
|
783
|
+
/** Format: date-time */
|
|
784
|
+
createdAt: string;
|
|
785
|
+
};
|
|
786
|
+
ga: {
|
|
787
|
+
/** Format: uuid */
|
|
788
|
+
id: string;
|
|
789
|
+
/** Format: uuid */
|
|
790
|
+
consentStatementId: string;
|
|
791
|
+
description: string | null;
|
|
792
|
+
disclaimer: string | null;
|
|
793
|
+
title: string;
|
|
794
|
+
language: "en" | "ga";
|
|
795
|
+
/** Format: date-time */
|
|
796
|
+
createdAt: string;
|
|
797
|
+
};
|
|
798
|
+
};
|
|
799
|
+
})[];
|
|
741
800
|
metadata?: {
|
|
742
801
|
/** @description Object containing the links to the related endpoints */
|
|
743
802
|
links?: {
|
|
@@ -826,10 +885,11 @@ export interface operations {
|
|
|
826
885
|
};
|
|
827
886
|
};
|
|
828
887
|
};
|
|
829
|
-
|
|
888
|
+
organizationListStatements: {
|
|
830
889
|
parameters: {
|
|
831
|
-
query
|
|
832
|
-
subject
|
|
890
|
+
query?: {
|
|
891
|
+
subject?: string;
|
|
892
|
+
isEnabled?: "true" | "false" | "0" | "1";
|
|
833
893
|
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
834
894
|
offset?: string;
|
|
835
895
|
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
@@ -851,12 +911,14 @@ export interface operations {
|
|
|
851
911
|
data: {
|
|
852
912
|
/** Format: uuid */
|
|
853
913
|
id: string;
|
|
854
|
-
profileId: string;
|
|
855
|
-
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
856
914
|
subject: string;
|
|
915
|
+
version: number;
|
|
916
|
+
/** Format: date-time */
|
|
857
917
|
createdAt: string;
|
|
858
|
-
/** Format:
|
|
859
|
-
|
|
918
|
+
/** Format: date-time */
|
|
919
|
+
publishDate: string;
|
|
920
|
+
isEnabled: boolean;
|
|
921
|
+
createdBy: string;
|
|
860
922
|
}[];
|
|
861
923
|
metadata?: {
|
|
862
924
|
/** @description Object containing the links to the related endpoints */
|
|
@@ -946,7 +1008,7 @@ export interface operations {
|
|
|
946
1008
|
};
|
|
947
1009
|
};
|
|
948
1010
|
};
|
|
949
|
-
|
|
1011
|
+
organizationCreateStatement: {
|
|
950
1012
|
parameters: {
|
|
951
1013
|
query?: never;
|
|
952
1014
|
header?: never;
|
|
@@ -956,11 +1018,23 @@ export interface operations {
|
|
|
956
1018
|
requestBody: {
|
|
957
1019
|
content: {
|
|
958
1020
|
"application/json": {
|
|
1021
|
+
subject: string;
|
|
1022
|
+
/** Format: date-time */
|
|
1023
|
+
publishDate: string;
|
|
959
1024
|
/** @enum {string} */
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
1025
|
+
isEnabled: "true" | "false" | "0" | "1";
|
|
1026
|
+
translations: {
|
|
1027
|
+
en: {
|
|
1028
|
+
description: string | null;
|
|
1029
|
+
disclaimer: string | null;
|
|
1030
|
+
title: string;
|
|
1031
|
+
};
|
|
1032
|
+
ga: {
|
|
1033
|
+
description: string | null;
|
|
1034
|
+
disclaimer: string | null;
|
|
1035
|
+
title: string;
|
|
1036
|
+
};
|
|
1037
|
+
};
|
|
964
1038
|
};
|
|
965
1039
|
};
|
|
966
1040
|
};
|
|
@@ -973,8 +1047,42 @@ export interface operations {
|
|
|
973
1047
|
content: {
|
|
974
1048
|
"application/json": {
|
|
975
1049
|
data: {
|
|
1050
|
+
/** Format: uuid */
|
|
976
1051
|
id: string;
|
|
977
1052
|
};
|
|
1053
|
+
metadata?: {
|
|
1054
|
+
/** @description Object containing the links to the related endpoints */
|
|
1055
|
+
links?: {
|
|
1056
|
+
self: {
|
|
1057
|
+
/** @description URL pointing to the request itself */
|
|
1058
|
+
href?: string;
|
|
1059
|
+
};
|
|
1060
|
+
next?: {
|
|
1061
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1062
|
+
href?: string;
|
|
1063
|
+
};
|
|
1064
|
+
prev?: {
|
|
1065
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1066
|
+
href?: string;
|
|
1067
|
+
};
|
|
1068
|
+
first: {
|
|
1069
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1070
|
+
href?: string;
|
|
1071
|
+
};
|
|
1072
|
+
last: {
|
|
1073
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1074
|
+
href?: string;
|
|
1075
|
+
};
|
|
1076
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1077
|
+
pages: {
|
|
1078
|
+
[key: string]: {
|
|
1079
|
+
href?: string;
|
|
1080
|
+
};
|
|
1081
|
+
};
|
|
1082
|
+
};
|
|
1083
|
+
/** @description Number representing the total number of available items */
|
|
1084
|
+
totalCount?: number;
|
|
1085
|
+
};
|
|
978
1086
|
};
|
|
979
1087
|
};
|
|
980
1088
|
};
|
|
@@ -1030,13 +1138,13 @@ export interface operations {
|
|
|
1030
1138
|
};
|
|
1031
1139
|
};
|
|
1032
1140
|
};
|
|
1033
|
-
|
|
1141
|
+
organizationGetStatement: {
|
|
1034
1142
|
parameters: {
|
|
1035
|
-
query
|
|
1036
|
-
subject: "messaging";
|
|
1037
|
-
};
|
|
1143
|
+
query?: never;
|
|
1038
1144
|
header?: never;
|
|
1039
|
-
path
|
|
1145
|
+
path: {
|
|
1146
|
+
id: string;
|
|
1147
|
+
};
|
|
1040
1148
|
cookie?: never;
|
|
1041
1149
|
};
|
|
1042
1150
|
requestBody?: never;
|
|
@@ -1051,28 +1159,57 @@ export interface operations {
|
|
|
1051
1159
|
data: {
|
|
1052
1160
|
/** Format: uuid */
|
|
1053
1161
|
id: string;
|
|
1054
|
-
profileId: string;
|
|
1055
|
-
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1056
1162
|
subject: string;
|
|
1163
|
+
version: number;
|
|
1164
|
+
/** Format: date-time */
|
|
1057
1165
|
createdAt: string;
|
|
1058
|
-
/** Format:
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
/**
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
/**
|
|
1074
|
-
|
|
1075
|
-
};
|
|
1166
|
+
/** Format: date-time */
|
|
1167
|
+
publishDate: string;
|
|
1168
|
+
isEnabled: boolean;
|
|
1169
|
+
createdBy: string;
|
|
1170
|
+
} & {
|
|
1171
|
+
translations: {
|
|
1172
|
+
en: {
|
|
1173
|
+
/** Format: uuid */
|
|
1174
|
+
id: string;
|
|
1175
|
+
/** Format: uuid */
|
|
1176
|
+
consentStatementId: string;
|
|
1177
|
+
description: string | null;
|
|
1178
|
+
disclaimer: string | null;
|
|
1179
|
+
title: string;
|
|
1180
|
+
language: "en" | "ga";
|
|
1181
|
+
/** Format: date-time */
|
|
1182
|
+
createdAt: string;
|
|
1183
|
+
};
|
|
1184
|
+
ga: {
|
|
1185
|
+
/** Format: uuid */
|
|
1186
|
+
id: string;
|
|
1187
|
+
/** Format: uuid */
|
|
1188
|
+
consentStatementId: string;
|
|
1189
|
+
description: string | null;
|
|
1190
|
+
disclaimer: string | null;
|
|
1191
|
+
title: string;
|
|
1192
|
+
language: "en" | "ga";
|
|
1193
|
+
/** Format: date-time */
|
|
1194
|
+
createdAt: string;
|
|
1195
|
+
};
|
|
1196
|
+
};
|
|
1197
|
+
};
|
|
1198
|
+
metadata?: {
|
|
1199
|
+
/** @description Object containing the links to the related endpoints */
|
|
1200
|
+
links?: {
|
|
1201
|
+
self: {
|
|
1202
|
+
/** @description URL pointing to the request itself */
|
|
1203
|
+
href?: string;
|
|
1204
|
+
};
|
|
1205
|
+
next?: {
|
|
1206
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1207
|
+
href?: string;
|
|
1208
|
+
};
|
|
1209
|
+
prev?: {
|
|
1210
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1211
|
+
href?: string;
|
|
1212
|
+
};
|
|
1076
1213
|
first: {
|
|
1077
1214
|
/** @description URL pointing to the first page of results in a paginated response */
|
|
1078
1215
|
href?: string;
|
|
@@ -1146,23 +1283,38 @@ export interface operations {
|
|
|
1146
1283
|
};
|
|
1147
1284
|
};
|
|
1148
1285
|
};
|
|
1149
|
-
|
|
1286
|
+
organizationUpdateStatement: {
|
|
1150
1287
|
parameters: {
|
|
1151
|
-
query?:
|
|
1152
|
-
/** @description Service for which list consents */
|
|
1153
|
-
subject?: string;
|
|
1154
|
-
/** @description User for whom list the consents */
|
|
1155
|
-
profileId?: string;
|
|
1156
|
-
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
1157
|
-
offset?: string;
|
|
1158
|
-
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
1159
|
-
limit?: string;
|
|
1160
|
-
};
|
|
1288
|
+
query?: never;
|
|
1161
1289
|
header?: never;
|
|
1162
|
-
path
|
|
1290
|
+
path: {
|
|
1291
|
+
id: string;
|
|
1292
|
+
};
|
|
1163
1293
|
cookie?: never;
|
|
1164
1294
|
};
|
|
1165
|
-
requestBody
|
|
1295
|
+
requestBody: {
|
|
1296
|
+
content: {
|
|
1297
|
+
"application/json": {
|
|
1298
|
+
subject: string;
|
|
1299
|
+
/** Format: date-time */
|
|
1300
|
+
publishDate: string;
|
|
1301
|
+
/** @enum {string} */
|
|
1302
|
+
isEnabled: "true" | "false" | "0" | "1";
|
|
1303
|
+
translations: {
|
|
1304
|
+
en: {
|
|
1305
|
+
description: string | null;
|
|
1306
|
+
disclaimer: string | null;
|
|
1307
|
+
title: string;
|
|
1308
|
+
};
|
|
1309
|
+
ga: {
|
|
1310
|
+
description: string | null;
|
|
1311
|
+
disclaimer: string | null;
|
|
1312
|
+
title: string;
|
|
1313
|
+
};
|
|
1314
|
+
};
|
|
1315
|
+
};
|
|
1316
|
+
};
|
|
1317
|
+
};
|
|
1166
1318
|
responses: {
|
|
1167
1319
|
/** @description Default Response */
|
|
1168
1320
|
200: {
|
|
@@ -1174,13 +1326,7 @@ export interface operations {
|
|
|
1174
1326
|
data: {
|
|
1175
1327
|
/** Format: uuid */
|
|
1176
1328
|
id: string;
|
|
1177
|
-
|
|
1178
|
-
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1179
|
-
subject: string;
|
|
1180
|
-
createdAt: string;
|
|
1181
|
-
/** Format: uuid */
|
|
1182
|
-
consentStatementId: string;
|
|
1183
|
-
}[];
|
|
1329
|
+
};
|
|
1184
1330
|
metadata?: {
|
|
1185
1331
|
/** @description Object containing the links to the related endpoints */
|
|
1186
1332
|
links?: {
|
|
@@ -1269,13 +1415,12 @@ export interface operations {
|
|
|
1269
1415
|
};
|
|
1270
1416
|
};
|
|
1271
1417
|
};
|
|
1272
|
-
|
|
1418
|
+
organizationDisableStatement: {
|
|
1273
1419
|
parameters: {
|
|
1274
1420
|
query?: never;
|
|
1275
1421
|
header?: never;
|
|
1276
1422
|
path: {
|
|
1277
|
-
|
|
1278
|
-
organisationId: string;
|
|
1423
|
+
id: string;
|
|
1279
1424
|
};
|
|
1280
1425
|
cookie?: never;
|
|
1281
1426
|
};
|
|
@@ -1289,15 +1434,41 @@ export interface operations {
|
|
|
1289
1434
|
content: {
|
|
1290
1435
|
"application/json": {
|
|
1291
1436
|
data: {
|
|
1437
|
+
/** Format: uuid */
|
|
1292
1438
|
id: string;
|
|
1439
|
+
subject: string;
|
|
1440
|
+
version: number;
|
|
1441
|
+
/** Format: date-time */
|
|
1442
|
+
createdAt: string;
|
|
1443
|
+
/** Format: date-time */
|
|
1444
|
+
publishDate: string;
|
|
1445
|
+
isEnabled: boolean;
|
|
1446
|
+
createdBy: string;
|
|
1447
|
+
} & {
|
|
1293
1448
|
translations: {
|
|
1294
1449
|
en: {
|
|
1295
|
-
|
|
1296
|
-
|
|
1450
|
+
/** Format: uuid */
|
|
1451
|
+
id: string;
|
|
1452
|
+
/** Format: uuid */
|
|
1453
|
+
consentStatementId: string;
|
|
1454
|
+
description: string | null;
|
|
1455
|
+
disclaimer: string | null;
|
|
1456
|
+
title: string;
|
|
1457
|
+
language: "en" | "ga";
|
|
1458
|
+
/** Format: date-time */
|
|
1459
|
+
createdAt: string;
|
|
1297
1460
|
};
|
|
1298
1461
|
ga: {
|
|
1299
|
-
|
|
1300
|
-
|
|
1462
|
+
/** Format: uuid */
|
|
1463
|
+
id: string;
|
|
1464
|
+
/** Format: uuid */
|
|
1465
|
+
consentStatementId: string;
|
|
1466
|
+
description: string | null;
|
|
1467
|
+
disclaimer: string | null;
|
|
1468
|
+
title: string;
|
|
1469
|
+
language: "en" | "ga";
|
|
1470
|
+
/** Format: date-time */
|
|
1471
|
+
createdAt: string;
|
|
1301
1472
|
};
|
|
1302
1473
|
};
|
|
1303
1474
|
};
|
|
@@ -1338,7 +1509,32 @@ export interface operations {
|
|
|
1338
1509
|
};
|
|
1339
1510
|
};
|
|
1340
1511
|
/** @description Default Response */
|
|
1341
|
-
|
|
1512
|
+
403: {
|
|
1513
|
+
headers: {
|
|
1514
|
+
[name: string]: unknown;
|
|
1515
|
+
};
|
|
1516
|
+
content: {
|
|
1517
|
+
"application/json": {
|
|
1518
|
+
/** @description Code used to categorize the error */
|
|
1519
|
+
code: string;
|
|
1520
|
+
/** @description Description of the error */
|
|
1521
|
+
detail: string;
|
|
1522
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1523
|
+
requestId: string;
|
|
1524
|
+
/** @description Name of the error type */
|
|
1525
|
+
name: string;
|
|
1526
|
+
/** @description List of the validation errors */
|
|
1527
|
+
validation?: {
|
|
1528
|
+
fieldName: string;
|
|
1529
|
+
message: string;
|
|
1530
|
+
}[];
|
|
1531
|
+
validationContext?: string;
|
|
1532
|
+
statusCode: number;
|
|
1533
|
+
};
|
|
1534
|
+
};
|
|
1535
|
+
};
|
|
1536
|
+
/** @description Default Response */
|
|
1537
|
+
404: {
|
|
1342
1538
|
headers: {
|
|
1343
1539
|
[name: string]: unknown;
|
|
1344
1540
|
};
|
|
@@ -1389,19 +1585,10 @@ export interface operations {
|
|
|
1389
1585
|
};
|
|
1390
1586
|
};
|
|
1391
1587
|
};
|
|
1392
|
-
|
|
1588
|
+
citizenListConsents: {
|
|
1393
1589
|
parameters: {
|
|
1394
|
-
query
|
|
1395
|
-
|
|
1396
|
-
search?: string;
|
|
1397
|
-
/** @description If set, the endpoint searches for users whom contain this value in either the imported first name */
|
|
1398
|
-
firstName?: string;
|
|
1399
|
-
/** @description If set, the endpoint searches for users whom contain this value in either the imported last name */
|
|
1400
|
-
lastName?: string;
|
|
1401
|
-
/** @description If set, the endpoint searches for users whom contain this value in either the imported email */
|
|
1402
|
-
email?: string;
|
|
1403
|
-
/** @description If true and super admin permissions are available, it returns users with private details. */
|
|
1404
|
-
privateDetails?: "true" | "false" | "0" | "1";
|
|
1590
|
+
query: {
|
|
1591
|
+
subject: string;
|
|
1405
1592
|
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
1406
1593
|
offset?: string;
|
|
1407
1594
|
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
@@ -1421,45 +1608,21 @@ export interface operations {
|
|
|
1421
1608
|
content: {
|
|
1422
1609
|
"application/json": {
|
|
1423
1610
|
data: {
|
|
1611
|
+
/** Format: uuid */
|
|
1424
1612
|
id: string;
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
*/
|
|
1434
|
-
preferredLanguage: "en" | "ga";
|
|
1435
|
-
/** Format: date-time */
|
|
1436
|
-
createdAt?: string;
|
|
1437
|
-
/** Format: date-time */
|
|
1438
|
-
updatedAt?: string;
|
|
1439
|
-
consentStatuses?: {
|
|
1440
|
-
messaging: {
|
|
1441
|
-
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1442
|
-
/** Format: uuid */
|
|
1443
|
-
consent_statement_id: string;
|
|
1444
|
-
};
|
|
1445
|
-
} | null;
|
|
1446
|
-
details?: {
|
|
1447
|
-
email: string;
|
|
1448
|
-
firstName: string;
|
|
1449
|
-
lastName: string;
|
|
1450
|
-
city?: string;
|
|
1451
|
-
address?: string;
|
|
1452
|
-
phone?: string;
|
|
1453
|
-
/** Format: date */
|
|
1454
|
-
dateOfBirth?: string;
|
|
1455
|
-
ppsn?: string;
|
|
1456
|
-
/**
|
|
1457
|
-
* @default en
|
|
1458
|
-
* @enum {string}
|
|
1459
|
-
*/
|
|
1460
|
-
preferredLanguage: "en" | "ga";
|
|
1461
|
-
externalId?: string;
|
|
1613
|
+
profileId: string;
|
|
1614
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1615
|
+
subject: string;
|
|
1616
|
+
createdAt: string;
|
|
1617
|
+
/** Format: uuid */
|
|
1618
|
+
consentStatementId: string;
|
|
1619
|
+
consentStatement: {
|
|
1620
|
+
version: number;
|
|
1462
1621
|
};
|
|
1622
|
+
cascadeReason?: string | null;
|
|
1623
|
+
cascadeSourceProfileId?: string | null;
|
|
1624
|
+
sourceProfileEmail?: string | null;
|
|
1625
|
+
targetProfileEmail?: string | null;
|
|
1463
1626
|
}[];
|
|
1464
1627
|
metadata?: {
|
|
1465
1628
|
/** @description Object containing the links to the related endpoints */
|
|
@@ -1549,14 +1712,9 @@ export interface operations {
|
|
|
1549
1712
|
};
|
|
1550
1713
|
};
|
|
1551
1714
|
};
|
|
1552
|
-
|
|
1715
|
+
citizenSubmitConsents: {
|
|
1553
1716
|
parameters: {
|
|
1554
|
-
query?:
|
|
1555
|
-
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
1556
|
-
offset?: string;
|
|
1557
|
-
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
1558
|
-
limit?: string;
|
|
1559
|
-
};
|
|
1717
|
+
query?: never;
|
|
1560
1718
|
header?: never;
|
|
1561
1719
|
path?: never;
|
|
1562
1720
|
cookie?: never;
|
|
@@ -1564,93 +1722,57 @@ export interface operations {
|
|
|
1564
1722
|
requestBody: {
|
|
1565
1723
|
content: {
|
|
1566
1724
|
"application/json": {
|
|
1567
|
-
|
|
1568
|
-
|
|
1725
|
+
consents: {
|
|
1726
|
+
subject: string;
|
|
1727
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1728
|
+
/** Format: uuid */
|
|
1729
|
+
consentStatementId: string;
|
|
1730
|
+
}[];
|
|
1569
1731
|
};
|
|
1570
1732
|
};
|
|
1571
1733
|
};
|
|
1572
1734
|
responses: {
|
|
1573
1735
|
/** @description Default Response */
|
|
1574
|
-
|
|
1736
|
+
201: {
|
|
1575
1737
|
headers: {
|
|
1576
1738
|
[name: string]: unknown;
|
|
1577
1739
|
};
|
|
1578
1740
|
content: {
|
|
1579
1741
|
"application/json": {
|
|
1580
1742
|
data: {
|
|
1743
|
+
/** Format: uuid */
|
|
1581
1744
|
id: string;
|
|
1582
|
-
|
|
1583
|
-
|
|
1584
|
-
email: string;
|
|
1585
|
-
primaryUserId: string;
|
|
1586
|
-
safeLevel?: number;
|
|
1587
|
-
/**
|
|
1588
|
-
* @default en
|
|
1589
|
-
* @enum {string}
|
|
1590
|
-
*/
|
|
1591
|
-
preferredLanguage: "en" | "ga";
|
|
1592
|
-
/** Format: date-time */
|
|
1593
|
-
createdAt?: string;
|
|
1745
|
+
subject: string;
|
|
1746
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1594
1747
|
/** Format: date-time */
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
|
|
1603
|
-
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1748
|
+
submittedAt: string;
|
|
1749
|
+
/** Format: uuid */
|
|
1750
|
+
consentStatementId: string;
|
|
1751
|
+
statementVersion: number;
|
|
1752
|
+
isLatestStatement: boolean;
|
|
1753
|
+
}[];
|
|
1754
|
+
errors?: {
|
|
1755
|
+
subject: string;
|
|
1756
|
+
/** Format: uuid */
|
|
1757
|
+
consentStatementId: string;
|
|
1758
|
+
errors: string[];
|
|
1759
|
+
}[];
|
|
1760
|
+
};
|
|
1761
|
+
};
|
|
1762
|
+
};
|
|
1763
|
+
/** @description Default Response */
|
|
1764
|
+
400: {
|
|
1765
|
+
headers: {
|
|
1766
|
+
[name: string]: unknown;
|
|
1767
|
+
};
|
|
1768
|
+
content: {
|
|
1769
|
+
"application/json": {
|
|
1770
|
+
errors: {
|
|
1771
|
+
subject: string;
|
|
1772
|
+
/** Format: uuid */
|
|
1773
|
+
consentStatementId: string;
|
|
1774
|
+
errors: string[];
|
|
1620
1775
|
}[];
|
|
1621
|
-
metadata?: {
|
|
1622
|
-
/** @description Object containing the links to the related endpoints */
|
|
1623
|
-
links?: {
|
|
1624
|
-
self: {
|
|
1625
|
-
/** @description URL pointing to the request itself */
|
|
1626
|
-
href?: string;
|
|
1627
|
-
};
|
|
1628
|
-
next?: {
|
|
1629
|
-
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1630
|
-
href?: string;
|
|
1631
|
-
};
|
|
1632
|
-
prev?: {
|
|
1633
|
-
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1634
|
-
href?: string;
|
|
1635
|
-
};
|
|
1636
|
-
first: {
|
|
1637
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
1638
|
-
href?: string;
|
|
1639
|
-
};
|
|
1640
|
-
last: {
|
|
1641
|
-
/** @description URL pointing to the first page of results in a paginated response */
|
|
1642
|
-
href?: string;
|
|
1643
|
-
};
|
|
1644
|
-
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1645
|
-
pages: {
|
|
1646
|
-
[key: string]: {
|
|
1647
|
-
href?: string;
|
|
1648
|
-
};
|
|
1649
|
-
};
|
|
1650
|
-
};
|
|
1651
|
-
/** @description Number representing the total number of available items */
|
|
1652
|
-
totalCount?: number;
|
|
1653
|
-
};
|
|
1654
1776
|
};
|
|
1655
1777
|
};
|
|
1656
1778
|
};
|
|
@@ -1706,99 +1828,16 @@ export interface operations {
|
|
|
1706
1828
|
};
|
|
1707
1829
|
};
|
|
1708
1830
|
};
|
|
1709
|
-
|
|
1831
|
+
citizenLatestConsent: {
|
|
1710
1832
|
parameters: {
|
|
1711
|
-
query
|
|
1712
|
-
|
|
1713
|
-
onlyPrivateDetails?: "true" | "false" | "0" | "1";
|
|
1714
|
-
importType?: "ppsn-only" | "full";
|
|
1833
|
+
query: {
|
|
1834
|
+
subject: string;
|
|
1715
1835
|
};
|
|
1716
1836
|
header?: never;
|
|
1717
1837
|
path?: never;
|
|
1718
1838
|
cookie?: never;
|
|
1719
1839
|
};
|
|
1720
|
-
requestBody?:
|
|
1721
|
-
content: {
|
|
1722
|
-
"application/json": {
|
|
1723
|
-
profiles?: {
|
|
1724
|
-
email: string;
|
|
1725
|
-
firstName: string;
|
|
1726
|
-
lastName: string;
|
|
1727
|
-
city?: string;
|
|
1728
|
-
address?: string;
|
|
1729
|
-
phone?: string;
|
|
1730
|
-
/** Format: date */
|
|
1731
|
-
dateOfBirth?: string;
|
|
1732
|
-
ppsn?: string;
|
|
1733
|
-
/**
|
|
1734
|
-
* @default en
|
|
1735
|
-
* @enum {string}
|
|
1736
|
-
*/
|
|
1737
|
-
preferredLanguage?: "en" | "ga";
|
|
1738
|
-
externalId?: string;
|
|
1739
|
-
}[];
|
|
1740
|
-
ppsnOnlyProfiles?: {
|
|
1741
|
-
ppsn: string;
|
|
1742
|
-
externalId?: string;
|
|
1743
|
-
/** Format: date */
|
|
1744
|
-
dateOfBirth?: string;
|
|
1745
|
-
}[];
|
|
1746
|
-
file?: unknown;
|
|
1747
|
-
};
|
|
1748
|
-
"multipart/form-data": {
|
|
1749
|
-
profiles?: {
|
|
1750
|
-
email: string;
|
|
1751
|
-
firstName: string;
|
|
1752
|
-
lastName: string;
|
|
1753
|
-
city?: string;
|
|
1754
|
-
address?: string;
|
|
1755
|
-
phone?: string;
|
|
1756
|
-
/** Format: date */
|
|
1757
|
-
dateOfBirth?: string;
|
|
1758
|
-
ppsn?: string;
|
|
1759
|
-
/**
|
|
1760
|
-
* @default en
|
|
1761
|
-
* @enum {string}
|
|
1762
|
-
*/
|
|
1763
|
-
preferredLanguage?: "en" | "ga";
|
|
1764
|
-
externalId?: string;
|
|
1765
|
-
}[];
|
|
1766
|
-
ppsnOnlyProfiles?: {
|
|
1767
|
-
ppsn: string;
|
|
1768
|
-
externalId?: string;
|
|
1769
|
-
/** Format: date */
|
|
1770
|
-
dateOfBirth?: string;
|
|
1771
|
-
}[];
|
|
1772
|
-
file?: unknown;
|
|
1773
|
-
};
|
|
1774
|
-
"text/csv": {
|
|
1775
|
-
profiles?: {
|
|
1776
|
-
email: string;
|
|
1777
|
-
firstName: string;
|
|
1778
|
-
lastName: string;
|
|
1779
|
-
city?: string;
|
|
1780
|
-
address?: string;
|
|
1781
|
-
phone?: string;
|
|
1782
|
-
/** Format: date */
|
|
1783
|
-
dateOfBirth?: string;
|
|
1784
|
-
ppsn?: string;
|
|
1785
|
-
/**
|
|
1786
|
-
* @default en
|
|
1787
|
-
* @enum {string}
|
|
1788
|
-
*/
|
|
1789
|
-
preferredLanguage?: "en" | "ga";
|
|
1790
|
-
externalId?: string;
|
|
1791
|
-
}[];
|
|
1792
|
-
ppsnOnlyProfiles?: {
|
|
1793
|
-
ppsn: string;
|
|
1794
|
-
externalId?: string;
|
|
1795
|
-
/** Format: date */
|
|
1796
|
-
dateOfBirth?: string;
|
|
1797
|
-
}[];
|
|
1798
|
-
file?: unknown;
|
|
1799
|
-
};
|
|
1800
|
-
};
|
|
1801
|
-
};
|
|
1840
|
+
requestBody?: never;
|
|
1802
1841
|
responses: {
|
|
1803
1842
|
/** @description Default Response */
|
|
1804
1843
|
200: {
|
|
@@ -1807,8 +1846,49 @@ export interface operations {
|
|
|
1807
1846
|
};
|
|
1808
1847
|
content: {
|
|
1809
1848
|
"application/json": {
|
|
1810
|
-
|
|
1811
|
-
|
|
1849
|
+
data: {
|
|
1850
|
+
/** Format: uuid */
|
|
1851
|
+
id: string;
|
|
1852
|
+
profileId: string;
|
|
1853
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1854
|
+
subject: string;
|
|
1855
|
+
createdAt: string;
|
|
1856
|
+
/** Format: uuid */
|
|
1857
|
+
consentStatementId: string;
|
|
1858
|
+
};
|
|
1859
|
+
metadata?: {
|
|
1860
|
+
/** @description Object containing the links to the related endpoints */
|
|
1861
|
+
links?: {
|
|
1862
|
+
self: {
|
|
1863
|
+
/** @description URL pointing to the request itself */
|
|
1864
|
+
href?: string;
|
|
1865
|
+
};
|
|
1866
|
+
next?: {
|
|
1867
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1868
|
+
href?: string;
|
|
1869
|
+
};
|
|
1870
|
+
prev?: {
|
|
1871
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1872
|
+
href?: string;
|
|
1873
|
+
};
|
|
1874
|
+
first: {
|
|
1875
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1876
|
+
href?: string;
|
|
1877
|
+
};
|
|
1878
|
+
last: {
|
|
1879
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1880
|
+
href?: string;
|
|
1881
|
+
};
|
|
1882
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1883
|
+
pages: {
|
|
1884
|
+
[key: string]: {
|
|
1885
|
+
href?: string;
|
|
1886
|
+
};
|
|
1887
|
+
};
|
|
1888
|
+
};
|
|
1889
|
+
/** @description Number representing the total number of available items */
|
|
1890
|
+
totalCount?: number;
|
|
1891
|
+
};
|
|
1812
1892
|
};
|
|
1813
1893
|
};
|
|
1814
1894
|
};
|
|
@@ -1864,11 +1944,17 @@ export interface operations {
|
|
|
1864
1944
|
};
|
|
1865
1945
|
};
|
|
1866
1946
|
};
|
|
1867
|
-
|
|
1947
|
+
organisationListConsents: {
|
|
1868
1948
|
parameters: {
|
|
1869
1949
|
query: {
|
|
1870
|
-
/** @description
|
|
1871
|
-
|
|
1950
|
+
/** @description Service for which list consents */
|
|
1951
|
+
subject: string;
|
|
1952
|
+
/** @description User for whom list the consents */
|
|
1953
|
+
profileId: string;
|
|
1954
|
+
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
1955
|
+
offset?: string;
|
|
1956
|
+
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
1957
|
+
limit?: string;
|
|
1872
1958
|
};
|
|
1873
1959
|
header?: never;
|
|
1874
1960
|
path?: never;
|
|
@@ -1884,45 +1970,21 @@ export interface operations {
|
|
|
1884
1970
|
content: {
|
|
1885
1971
|
"application/json": {
|
|
1886
1972
|
data: {
|
|
1973
|
+
/** Format: uuid */
|
|
1887
1974
|
id: string;
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
|
|
1893
|
-
|
|
1894
|
-
|
|
1895
|
-
|
|
1896
|
-
*/
|
|
1897
|
-
preferredLanguage: "en" | "ga";
|
|
1898
|
-
/** Format: date-time */
|
|
1899
|
-
createdAt?: string;
|
|
1900
|
-
/** Format: date-time */
|
|
1901
|
-
updatedAt?: string;
|
|
1902
|
-
consentStatuses?: {
|
|
1903
|
-
messaging: {
|
|
1904
|
-
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1905
|
-
/** Format: uuid */
|
|
1906
|
-
consent_statement_id: string;
|
|
1907
|
-
};
|
|
1908
|
-
} | null;
|
|
1909
|
-
details?: {
|
|
1910
|
-
email: string;
|
|
1911
|
-
firstName: string;
|
|
1912
|
-
lastName: string;
|
|
1913
|
-
city?: string;
|
|
1914
|
-
address?: string;
|
|
1915
|
-
phone?: string;
|
|
1916
|
-
/** Format: date */
|
|
1917
|
-
dateOfBirth?: string;
|
|
1918
|
-
ppsn?: string;
|
|
1919
|
-
/**
|
|
1920
|
-
* @default en
|
|
1921
|
-
* @enum {string}
|
|
1922
|
-
*/
|
|
1923
|
-
preferredLanguage: "en" | "ga";
|
|
1924
|
-
externalId?: string;
|
|
1975
|
+
profileId: string;
|
|
1976
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
1977
|
+
subject: string;
|
|
1978
|
+
createdAt: string;
|
|
1979
|
+
/** Format: uuid */
|
|
1980
|
+
consentStatementId: string;
|
|
1981
|
+
consentStatement: {
|
|
1982
|
+
version: number;
|
|
1925
1983
|
};
|
|
1984
|
+
cascadeReason?: string | null;
|
|
1985
|
+
cascadeSourceProfileId?: string | null;
|
|
1986
|
+
sourceProfileEmail?: string | null;
|
|
1987
|
+
targetProfileEmail?: string | null;
|
|
1926
1988
|
}[];
|
|
1927
1989
|
metadata?: {
|
|
1928
1990
|
/** @description Object containing the links to the related endpoints */
|
|
@@ -2012,17 +2074,17 @@ export interface operations {
|
|
|
2012
2074
|
};
|
|
2013
2075
|
};
|
|
2014
2076
|
};
|
|
2015
|
-
|
|
2077
|
+
organisationListLatestConsents: {
|
|
2016
2078
|
parameters: {
|
|
2017
|
-
query
|
|
2018
|
-
/** @description
|
|
2019
|
-
|
|
2020
|
-
/** @description
|
|
2021
|
-
|
|
2022
|
-
/** @description
|
|
2023
|
-
|
|
2024
|
-
/** @description
|
|
2025
|
-
|
|
2079
|
+
query: {
|
|
2080
|
+
/** @description Service for which list consents */
|
|
2081
|
+
subject: string;
|
|
2082
|
+
/** @description User for whom list the consents */
|
|
2083
|
+
profileId?: string;
|
|
2084
|
+
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
2085
|
+
offset?: string;
|
|
2086
|
+
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
2087
|
+
limit?: string;
|
|
2026
2088
|
};
|
|
2027
2089
|
header?: never;
|
|
2028
2090
|
path?: never;
|
|
@@ -2038,46 +2100,22 @@ export interface operations {
|
|
|
2038
2100
|
content: {
|
|
2039
2101
|
"application/json": {
|
|
2040
2102
|
data: {
|
|
2103
|
+
/** Format: uuid */
|
|
2041
2104
|
id: string;
|
|
2042
|
-
|
|
2043
|
-
|
|
2044
|
-
|
|
2045
|
-
|
|
2046
|
-
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
|
|
2050
|
-
*/
|
|
2051
|
-
preferredLanguage: "en" | "ga";
|
|
2052
|
-
/** Format: date-time */
|
|
2053
|
-
createdAt?: string;
|
|
2054
|
-
/** Format: date-time */
|
|
2055
|
-
updatedAt?: string;
|
|
2056
|
-
consentStatuses?: {
|
|
2057
|
-
messaging: {
|
|
2058
|
-
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2059
|
-
/** Format: uuid */
|
|
2060
|
-
consent_statement_id: string;
|
|
2061
|
-
};
|
|
2062
|
-
} | null;
|
|
2063
|
-
details?: {
|
|
2064
|
-
email: string;
|
|
2065
|
-
firstName: string;
|
|
2066
|
-
lastName: string;
|
|
2067
|
-
city?: string;
|
|
2068
|
-
address?: string;
|
|
2069
|
-
phone?: string;
|
|
2070
|
-
/** Format: date */
|
|
2071
|
-
dateOfBirth?: string;
|
|
2072
|
-
ppsn?: string;
|
|
2073
|
-
/**
|
|
2074
|
-
* @default en
|
|
2075
|
-
* @enum {string}
|
|
2076
|
-
*/
|
|
2077
|
-
preferredLanguage: "en" | "ga";
|
|
2078
|
-
externalId?: string;
|
|
2105
|
+
profileId: string;
|
|
2106
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2107
|
+
subject: string;
|
|
2108
|
+
createdAt: string;
|
|
2109
|
+
/** Format: uuid */
|
|
2110
|
+
consentStatementId: string;
|
|
2111
|
+
consentStatement: {
|
|
2112
|
+
version: number;
|
|
2079
2113
|
};
|
|
2080
|
-
|
|
2114
|
+
cascadeReason?: string | null;
|
|
2115
|
+
cascadeSourceProfileId?: string | null;
|
|
2116
|
+
sourceProfileEmail?: string | null;
|
|
2117
|
+
targetProfileEmail?: string | null;
|
|
2118
|
+
}[];
|
|
2081
2119
|
metadata?: {
|
|
2082
2120
|
/** @description Object containing the links to the related endpoints */
|
|
2083
2121
|
links?: {
|
|
@@ -2166,20 +2204,14 @@ export interface operations {
|
|
|
2166
2204
|
};
|
|
2167
2205
|
};
|
|
2168
2206
|
};
|
|
2169
|
-
|
|
2207
|
+
getOrganisation: {
|
|
2170
2208
|
parameters: {
|
|
2171
|
-
query?:
|
|
2172
|
-
organizationId?: string;
|
|
2173
|
-
source?: "csv" | "json";
|
|
2174
|
-
/** @description If set, the endpoint searches for profile imports with this value in the metadata.filename */
|
|
2175
|
-
search?: string;
|
|
2176
|
-
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
2177
|
-
offset?: string;
|
|
2178
|
-
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
2179
|
-
limit?: string;
|
|
2180
|
-
};
|
|
2209
|
+
query?: never;
|
|
2181
2210
|
header?: never;
|
|
2182
|
-
path
|
|
2211
|
+
path: {
|
|
2212
|
+
/** @description The organisation ID to get the translation for */
|
|
2213
|
+
organisationId: string;
|
|
2214
|
+
};
|
|
2183
2215
|
cookie?: never;
|
|
2184
2216
|
};
|
|
2185
2217
|
requestBody?: never;
|
|
@@ -2192,20 +2224,18 @@ export interface operations {
|
|
|
2192
2224
|
content: {
|
|
2193
2225
|
"application/json": {
|
|
2194
2226
|
data: {
|
|
2195
|
-
/** Format: uuid */
|
|
2196
2227
|
id: string;
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
-
|
|
2202
|
-
|
|
2228
|
+
translations: {
|
|
2229
|
+
en: {
|
|
2230
|
+
name: string;
|
|
2231
|
+
shortName: string;
|
|
2232
|
+
};
|
|
2233
|
+
ga: {
|
|
2234
|
+
name: string;
|
|
2235
|
+
shortName: string;
|
|
2236
|
+
};
|
|
2203
2237
|
};
|
|
2204
|
-
|
|
2205
|
-
createdAt: string;
|
|
2206
|
-
/** Format: date-time */
|
|
2207
|
-
updatedAt: string;
|
|
2208
|
-
}[];
|
|
2238
|
+
};
|
|
2209
2239
|
metadata?: {
|
|
2210
2240
|
/** @description Object containing the links to the related endpoints */
|
|
2211
2241
|
links?: {
|
|
@@ -2294,13 +2324,28 @@ export interface operations {
|
|
|
2294
2324
|
};
|
|
2295
2325
|
};
|
|
2296
2326
|
};
|
|
2297
|
-
|
|
2327
|
+
indexProfiles: {
|
|
2298
2328
|
parameters: {
|
|
2299
|
-
query?:
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2329
|
+
query?: {
|
|
2330
|
+
/** @description If set, the endpoint searches for users whom contain this value in either the public name or the email address */
|
|
2331
|
+
search?: string;
|
|
2332
|
+
/** @description If set, the endpoint searches for users whom contain this value in either the imported first name */
|
|
2333
|
+
firstName?: string;
|
|
2334
|
+
/** @description If set, the endpoint searches for users whom contain this value in either the imported last name */
|
|
2335
|
+
lastName?: string;
|
|
2336
|
+
/** @description If set, the endpoint searches for users whom contain this value in either the imported email */
|
|
2337
|
+
email?: string;
|
|
2338
|
+
/** @description If true and super admin permissions are available, it returns users with private details. */
|
|
2339
|
+
privateDetails?: "true" | "false" | "0" | "1";
|
|
2340
|
+
/** @description Write subjects split by comma, if set will return consent statuses for those subjects, otherwise consent statuses will be null */
|
|
2341
|
+
consentSubjects?: string;
|
|
2342
|
+
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
2343
|
+
offset?: string;
|
|
2344
|
+
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
2345
|
+
limit?: string;
|
|
2303
2346
|
};
|
|
2347
|
+
header?: never;
|
|
2348
|
+
path?: never;
|
|
2304
2349
|
cookie?: never;
|
|
2305
2350
|
};
|
|
2306
2351
|
requestBody?: never;
|
|
@@ -2313,15 +2358,40 @@ export interface operations {
|
|
|
2313
2358
|
content: {
|
|
2314
2359
|
"application/json": {
|
|
2315
2360
|
data: {
|
|
2316
|
-
|
|
2317
|
-
|
|
2361
|
+
id: string;
|
|
2362
|
+
publicName: string;
|
|
2363
|
+
/** Format: email */
|
|
2364
|
+
email: string;
|
|
2365
|
+
primaryUserId: string;
|
|
2366
|
+
safeLevel?: number;
|
|
2367
|
+
/**
|
|
2368
|
+
* @default en
|
|
2369
|
+
* @enum {string}
|
|
2370
|
+
*/
|
|
2371
|
+
preferredLanguage: "en" | "ga";
|
|
2318
2372
|
/** Format: date-time */
|
|
2319
2373
|
createdAt?: string;
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2374
|
+
/** Format: date-time */
|
|
2375
|
+
updatedAt?: string;
|
|
2376
|
+
consentStatuses?: {
|
|
2377
|
+
[key: string]: {
|
|
2378
|
+
subject: string;
|
|
2379
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2380
|
+
/** Format: date-time */
|
|
2381
|
+
submittedAt?: string;
|
|
2382
|
+
/** Format: uuid */
|
|
2383
|
+
statementId?: string;
|
|
2384
|
+
statementVersion?: number;
|
|
2385
|
+
isLatestStatement?: boolean;
|
|
2386
|
+
};
|
|
2387
|
+
} | {
|
|
2388
|
+
[key: string]: {
|
|
2389
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2390
|
+
/** Format: uuid */
|
|
2391
|
+
consent_statement_id: string;
|
|
2392
|
+
};
|
|
2393
|
+
} | null;
|
|
2394
|
+
details?: {
|
|
2325
2395
|
email: string;
|
|
2326
2396
|
firstName: string;
|
|
2327
2397
|
lastName: string;
|
|
@@ -2337,9 +2407,8 @@ export interface operations {
|
|
|
2337
2407
|
*/
|
|
2338
2408
|
preferredLanguage: "en" | "ga";
|
|
2339
2409
|
externalId?: string;
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
};
|
|
2410
|
+
};
|
|
2411
|
+
}[];
|
|
2343
2412
|
metadata?: {
|
|
2344
2413
|
/** @description Object containing the links to the related endpoints */
|
|
2345
2414
|
links?: {
|
|
@@ -2428,20 +2497,26 @@ export interface operations {
|
|
|
2428
2497
|
};
|
|
2429
2498
|
};
|
|
2430
2499
|
};
|
|
2431
|
-
|
|
2500
|
+
searchPostProfiles: {
|
|
2432
2501
|
parameters: {
|
|
2433
2502
|
query?: {
|
|
2434
|
-
|
|
2435
|
-
|
|
2503
|
+
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
2504
|
+
offset?: string;
|
|
2505
|
+
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
2506
|
+
limit?: string;
|
|
2436
2507
|
};
|
|
2437
2508
|
header?: never;
|
|
2438
|
-
path
|
|
2439
|
-
/** @description ID of the profile to retrieve */
|
|
2440
|
-
profileId: string;
|
|
2441
|
-
};
|
|
2509
|
+
path?: never;
|
|
2442
2510
|
cookie?: never;
|
|
2443
2511
|
};
|
|
2444
|
-
requestBody
|
|
2512
|
+
requestBody: {
|
|
2513
|
+
content: {
|
|
2514
|
+
"application/json": {
|
|
2515
|
+
ppsns: string[];
|
|
2516
|
+
organizationId?: string;
|
|
2517
|
+
};
|
|
2518
|
+
};
|
|
2519
|
+
};
|
|
2445
2520
|
responses: {
|
|
2446
2521
|
/** @description Default Response */
|
|
2447
2522
|
200: {
|
|
@@ -2467,7 +2542,18 @@ export interface operations {
|
|
|
2467
2542
|
/** Format: date-time */
|
|
2468
2543
|
updatedAt?: string;
|
|
2469
2544
|
consentStatuses?: {
|
|
2470
|
-
|
|
2545
|
+
[key: string]: {
|
|
2546
|
+
subject: string;
|
|
2547
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2548
|
+
/** Format: date-time */
|
|
2549
|
+
submittedAt?: string;
|
|
2550
|
+
/** Format: uuid */
|
|
2551
|
+
statementId?: string;
|
|
2552
|
+
statementVersion?: number;
|
|
2553
|
+
isLatestStatement?: boolean;
|
|
2554
|
+
};
|
|
2555
|
+
} | {
|
|
2556
|
+
[key: string]: {
|
|
2471
2557
|
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2472
2558
|
/** Format: uuid */
|
|
2473
2559
|
consent_statement_id: string;
|
|
@@ -2490,14 +2576,7 @@ export interface operations {
|
|
|
2490
2576
|
preferredLanguage: "en" | "ga";
|
|
2491
2577
|
externalId?: string;
|
|
2492
2578
|
};
|
|
2493
|
-
|
|
2494
|
-
linkedProfiles?: {
|
|
2495
|
-
id: string;
|
|
2496
|
-
/** Format: email */
|
|
2497
|
-
email: string;
|
|
2498
|
-
publicName: string;
|
|
2499
|
-
}[];
|
|
2500
|
-
};
|
|
2579
|
+
}[];
|
|
2501
2580
|
metadata?: {
|
|
2502
2581
|
/** @description Object containing the links to the related endpoints */
|
|
2503
2582
|
links?: {
|
|
@@ -2586,37 +2665,19 @@ export interface operations {
|
|
|
2586
2665
|
};
|
|
2587
2666
|
};
|
|
2588
2667
|
};
|
|
2589
|
-
|
|
2668
|
+
selectProfiles: {
|
|
2590
2669
|
parameters: {
|
|
2591
|
-
query
|
|
2592
|
-
/** @description
|
|
2593
|
-
|
|
2670
|
+
query: {
|
|
2671
|
+
/** @description Comma-separated list of profile IDs */
|
|
2672
|
+
ids: string;
|
|
2673
|
+
/** @description Write subjects split by comma, if set will return consent statuses for those subjects, otherwise consent statuses will be null */
|
|
2674
|
+
consentSubjects?: string;
|
|
2594
2675
|
};
|
|
2595
2676
|
header?: never;
|
|
2596
|
-
path
|
|
2597
|
-
/** @description ID of the profile to update */
|
|
2598
|
-
profileId: string;
|
|
2599
|
-
};
|
|
2677
|
+
path?: never;
|
|
2600
2678
|
cookie?: never;
|
|
2601
2679
|
};
|
|
2602
|
-
requestBody
|
|
2603
|
-
content: {
|
|
2604
|
-
"application/json": {
|
|
2605
|
-
publicName: string;
|
|
2606
|
-
/** Format: email */
|
|
2607
|
-
email?: string;
|
|
2608
|
-
phone?: string;
|
|
2609
|
-
address?: string;
|
|
2610
|
-
city?: string;
|
|
2611
|
-
firstName?: string;
|
|
2612
|
-
lastName?: string;
|
|
2613
|
-
/** Format: date */
|
|
2614
|
-
dateOfBirth?: string;
|
|
2615
|
-
/** @enum {string} */
|
|
2616
|
-
preferredLanguage: "en" | "ga";
|
|
2617
|
-
};
|
|
2618
|
-
};
|
|
2619
|
-
};
|
|
2680
|
+
requestBody?: never;
|
|
2620
2681
|
responses: {
|
|
2621
2682
|
/** @description Default Response */
|
|
2622
2683
|
200: {
|
|
@@ -2642,7 +2703,18 @@ export interface operations {
|
|
|
2642
2703
|
/** Format: date-time */
|
|
2643
2704
|
updatedAt?: string;
|
|
2644
2705
|
consentStatuses?: {
|
|
2645
|
-
|
|
2706
|
+
[key: string]: {
|
|
2707
|
+
subject: string;
|
|
2708
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2709
|
+
/** Format: date-time */
|
|
2710
|
+
submittedAt?: string;
|
|
2711
|
+
/** Format: uuid */
|
|
2712
|
+
statementId?: string;
|
|
2713
|
+
statementVersion?: number;
|
|
2714
|
+
isLatestStatement?: boolean;
|
|
2715
|
+
};
|
|
2716
|
+
} | {
|
|
2717
|
+
[key: string]: {
|
|
2646
2718
|
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2647
2719
|
/** Format: uuid */
|
|
2648
2720
|
consent_statement_id: string;
|
|
@@ -2665,7 +2737,7 @@ export interface operations {
|
|
|
2665
2737
|
preferredLanguage: "en" | "ga";
|
|
2666
2738
|
externalId?: string;
|
|
2667
2739
|
};
|
|
2668
|
-
};
|
|
2740
|
+
}[];
|
|
2669
2741
|
metadata?: {
|
|
2670
2742
|
/** @description Object containing the links to the related endpoints */
|
|
2671
2743
|
links?: {
|
|
@@ -2754,38 +2826,25 @@ export interface operations {
|
|
|
2754
2826
|
};
|
|
2755
2827
|
};
|
|
2756
2828
|
};
|
|
2757
|
-
|
|
2829
|
+
findProfile: {
|
|
2758
2830
|
parameters: {
|
|
2759
2831
|
query?: {
|
|
2760
|
-
/** @description
|
|
2761
|
-
|
|
2832
|
+
/** @description Email address to search for */
|
|
2833
|
+
email?: string;
|
|
2834
|
+
/** @description First name to search for */
|
|
2835
|
+
firstName?: string;
|
|
2836
|
+
/** @description Last name to search for */
|
|
2837
|
+
lastName?: string;
|
|
2838
|
+
/** @description Phone number to search for */
|
|
2839
|
+
phone?: string;
|
|
2840
|
+
/** @description Write subjects split by comma, if set will return consent statuses for those subjects, otherwise consent statuses will be null */
|
|
2841
|
+
consentSubjects?: string;
|
|
2762
2842
|
};
|
|
2763
2843
|
header?: never;
|
|
2764
|
-
path
|
|
2765
|
-
/** @description ID of the profile to update */
|
|
2766
|
-
profileId: string;
|
|
2767
|
-
};
|
|
2844
|
+
path?: never;
|
|
2768
2845
|
cookie?: never;
|
|
2769
2846
|
};
|
|
2770
|
-
requestBody?:
|
|
2771
|
-
content: {
|
|
2772
|
-
"application/json": {
|
|
2773
|
-
publicName?: string;
|
|
2774
|
-
/** Format: email */
|
|
2775
|
-
email?: string;
|
|
2776
|
-
phone?: string;
|
|
2777
|
-
address?: string;
|
|
2778
|
-
city?: string;
|
|
2779
|
-
firstName?: string;
|
|
2780
|
-
lastName?: string;
|
|
2781
|
-
/** Format: date */
|
|
2782
|
-
dateOfBirth?: string;
|
|
2783
|
-
/** @enum {string} */
|
|
2784
|
-
preferredLanguage?: "en" | "ga";
|
|
2785
|
-
primaryUserId?: string;
|
|
2786
|
-
};
|
|
2787
|
-
};
|
|
2788
|
-
};
|
|
2847
|
+
requestBody?: never;
|
|
2789
2848
|
responses: {
|
|
2790
2849
|
/** @description Default Response */
|
|
2791
2850
|
200: {
|
|
@@ -2811,7 +2870,18 @@ export interface operations {
|
|
|
2811
2870
|
/** Format: date-time */
|
|
2812
2871
|
updatedAt?: string;
|
|
2813
2872
|
consentStatuses?: {
|
|
2814
|
-
|
|
2873
|
+
[key: string]: {
|
|
2874
|
+
subject: string;
|
|
2875
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2876
|
+
/** Format: date-time */
|
|
2877
|
+
submittedAt?: string;
|
|
2878
|
+
/** Format: uuid */
|
|
2879
|
+
statementId?: string;
|
|
2880
|
+
statementVersion?: number;
|
|
2881
|
+
isLatestStatement?: boolean;
|
|
2882
|
+
};
|
|
2883
|
+
} | {
|
|
2884
|
+
[key: string]: {
|
|
2815
2885
|
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
2816
2886
|
/** Format: uuid */
|
|
2817
2887
|
consent_statement_id: string;
|
|
@@ -2923,6 +2993,1114 @@ export interface operations {
|
|
|
2923
2993
|
};
|
|
2924
2994
|
};
|
|
2925
2995
|
};
|
|
2996
|
+
getProfile: {
|
|
2997
|
+
parameters: {
|
|
2998
|
+
query?: {
|
|
2999
|
+
privateDetails?: "true" | "false" | "0" | "1";
|
|
3000
|
+
organizationId?: string;
|
|
3001
|
+
/** @description Comma-separated list of consent categories to retrieve status for. */
|
|
3002
|
+
consentSubjects?: string;
|
|
3003
|
+
};
|
|
3004
|
+
header?: never;
|
|
3005
|
+
path: {
|
|
3006
|
+
/** @description ID of the profile to retrieve */
|
|
3007
|
+
profileId: string;
|
|
3008
|
+
};
|
|
3009
|
+
cookie?: never;
|
|
3010
|
+
};
|
|
3011
|
+
requestBody?: never;
|
|
3012
|
+
responses: {
|
|
3013
|
+
/** @description Default Response */
|
|
3014
|
+
200: {
|
|
3015
|
+
headers: {
|
|
3016
|
+
[name: string]: unknown;
|
|
3017
|
+
};
|
|
3018
|
+
content: {
|
|
3019
|
+
"application/json": {
|
|
3020
|
+
data: {
|
|
3021
|
+
id: string;
|
|
3022
|
+
publicName: string;
|
|
3023
|
+
/** Format: email */
|
|
3024
|
+
email: string;
|
|
3025
|
+
primaryUserId: string;
|
|
3026
|
+
safeLevel?: number;
|
|
3027
|
+
/**
|
|
3028
|
+
* @default en
|
|
3029
|
+
* @enum {string}
|
|
3030
|
+
*/
|
|
3031
|
+
preferredLanguage: "en" | "ga";
|
|
3032
|
+
/** Format: date-time */
|
|
3033
|
+
createdAt?: string;
|
|
3034
|
+
/** Format: date-time */
|
|
3035
|
+
updatedAt?: string;
|
|
3036
|
+
consentStatuses?: {
|
|
3037
|
+
[key: string]: {
|
|
3038
|
+
subject: string;
|
|
3039
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
3040
|
+
/** Format: date-time */
|
|
3041
|
+
submittedAt?: string;
|
|
3042
|
+
/** Format: uuid */
|
|
3043
|
+
statementId?: string;
|
|
3044
|
+
statementVersion?: number;
|
|
3045
|
+
isLatestStatement?: boolean;
|
|
3046
|
+
};
|
|
3047
|
+
} | {
|
|
3048
|
+
[key: string]: {
|
|
3049
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
3050
|
+
/** Format: uuid */
|
|
3051
|
+
consent_statement_id: string;
|
|
3052
|
+
};
|
|
3053
|
+
} | null;
|
|
3054
|
+
details?: {
|
|
3055
|
+
email: string;
|
|
3056
|
+
firstName: string;
|
|
3057
|
+
lastName: string;
|
|
3058
|
+
city?: string;
|
|
3059
|
+
address?: string;
|
|
3060
|
+
phone?: string;
|
|
3061
|
+
/** Format: date */
|
|
3062
|
+
dateOfBirth?: string;
|
|
3063
|
+
ppsn?: string;
|
|
3064
|
+
/**
|
|
3065
|
+
* @default en
|
|
3066
|
+
* @enum {string}
|
|
3067
|
+
*/
|
|
3068
|
+
preferredLanguage: "en" | "ga";
|
|
3069
|
+
externalId?: string;
|
|
3070
|
+
};
|
|
3071
|
+
/** @description Linked profiles that have the current profile as primary profile */
|
|
3072
|
+
linkedProfiles?: {
|
|
3073
|
+
id: string;
|
|
3074
|
+
/** Format: email */
|
|
3075
|
+
email: string;
|
|
3076
|
+
publicName: string;
|
|
3077
|
+
}[];
|
|
3078
|
+
};
|
|
3079
|
+
metadata?: {
|
|
3080
|
+
/** @description Object containing the links to the related endpoints */
|
|
3081
|
+
links?: {
|
|
3082
|
+
self: {
|
|
3083
|
+
/** @description URL pointing to the request itself */
|
|
3084
|
+
href?: string;
|
|
3085
|
+
};
|
|
3086
|
+
next?: {
|
|
3087
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
3088
|
+
href?: string;
|
|
3089
|
+
};
|
|
3090
|
+
prev?: {
|
|
3091
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
3092
|
+
href?: string;
|
|
3093
|
+
};
|
|
3094
|
+
first: {
|
|
3095
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
3096
|
+
href?: string;
|
|
3097
|
+
};
|
|
3098
|
+
last: {
|
|
3099
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
3100
|
+
href?: string;
|
|
3101
|
+
};
|
|
3102
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
3103
|
+
pages: {
|
|
3104
|
+
[key: string]: {
|
|
3105
|
+
href?: string;
|
|
3106
|
+
};
|
|
3107
|
+
};
|
|
3108
|
+
};
|
|
3109
|
+
/** @description Number representing the total number of available items */
|
|
3110
|
+
totalCount?: number;
|
|
3111
|
+
};
|
|
3112
|
+
};
|
|
3113
|
+
};
|
|
3114
|
+
};
|
|
3115
|
+
/** @description Default Response */
|
|
3116
|
+
"4XX": {
|
|
3117
|
+
headers: {
|
|
3118
|
+
[name: string]: unknown;
|
|
3119
|
+
};
|
|
3120
|
+
content: {
|
|
3121
|
+
"application/json": {
|
|
3122
|
+
/** @description Code used to categorize the error */
|
|
3123
|
+
code: string;
|
|
3124
|
+
/** @description Description of the error */
|
|
3125
|
+
detail: string;
|
|
3126
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3127
|
+
requestId: string;
|
|
3128
|
+
/** @description Name of the error type */
|
|
3129
|
+
name: string;
|
|
3130
|
+
/** @description List of the validation errors */
|
|
3131
|
+
validation?: {
|
|
3132
|
+
fieldName: string;
|
|
3133
|
+
message: string;
|
|
3134
|
+
}[];
|
|
3135
|
+
validationContext?: string;
|
|
3136
|
+
statusCode: number;
|
|
3137
|
+
};
|
|
3138
|
+
};
|
|
3139
|
+
};
|
|
3140
|
+
/** @description Default Response */
|
|
3141
|
+
"5XX": {
|
|
3142
|
+
headers: {
|
|
3143
|
+
[name: string]: unknown;
|
|
3144
|
+
};
|
|
3145
|
+
content: {
|
|
3146
|
+
"application/json": {
|
|
3147
|
+
/** @description Code used to categorize the error */
|
|
3148
|
+
code: string;
|
|
3149
|
+
/** @description Description of the error */
|
|
3150
|
+
detail: string;
|
|
3151
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3152
|
+
requestId: string;
|
|
3153
|
+
/** @description Name of the error type */
|
|
3154
|
+
name: string;
|
|
3155
|
+
/** @description List of the validation errors */
|
|
3156
|
+
validation?: {
|
|
3157
|
+
fieldName: string;
|
|
3158
|
+
message: string;
|
|
3159
|
+
}[];
|
|
3160
|
+
validationContext?: string;
|
|
3161
|
+
statusCode: number;
|
|
3162
|
+
};
|
|
3163
|
+
};
|
|
3164
|
+
};
|
|
3165
|
+
};
|
|
3166
|
+
};
|
|
3167
|
+
putProfile: {
|
|
3168
|
+
parameters: {
|
|
3169
|
+
query?: {
|
|
3170
|
+
/** @description Organization ID owning the profile */
|
|
3171
|
+
organizationId?: string;
|
|
3172
|
+
};
|
|
3173
|
+
header?: never;
|
|
3174
|
+
path: {
|
|
3175
|
+
/** @description ID of the profile to update */
|
|
3176
|
+
profileId: string;
|
|
3177
|
+
};
|
|
3178
|
+
cookie?: never;
|
|
3179
|
+
};
|
|
3180
|
+
requestBody: {
|
|
3181
|
+
content: {
|
|
3182
|
+
"application/json": {
|
|
3183
|
+
publicName: string;
|
|
3184
|
+
/** Format: email */
|
|
3185
|
+
email?: string;
|
|
3186
|
+
phone?: string;
|
|
3187
|
+
address?: string;
|
|
3188
|
+
city?: string;
|
|
3189
|
+
firstName?: string;
|
|
3190
|
+
lastName?: string;
|
|
3191
|
+
/** Format: date */
|
|
3192
|
+
dateOfBirth?: string;
|
|
3193
|
+
/** @enum {string} */
|
|
3194
|
+
preferredLanguage: "en" | "ga";
|
|
3195
|
+
};
|
|
3196
|
+
};
|
|
3197
|
+
};
|
|
3198
|
+
responses: {
|
|
3199
|
+
/** @description Default Response */
|
|
3200
|
+
200: {
|
|
3201
|
+
headers: {
|
|
3202
|
+
[name: string]: unknown;
|
|
3203
|
+
};
|
|
3204
|
+
content: {
|
|
3205
|
+
"application/json": {
|
|
3206
|
+
data: {
|
|
3207
|
+
id: string;
|
|
3208
|
+
publicName: string;
|
|
3209
|
+
/** Format: email */
|
|
3210
|
+
email: string;
|
|
3211
|
+
primaryUserId: string;
|
|
3212
|
+
safeLevel?: number;
|
|
3213
|
+
/**
|
|
3214
|
+
* @default en
|
|
3215
|
+
* @enum {string}
|
|
3216
|
+
*/
|
|
3217
|
+
preferredLanguage: "en" | "ga";
|
|
3218
|
+
/** Format: date-time */
|
|
3219
|
+
createdAt?: string;
|
|
3220
|
+
/** Format: date-time */
|
|
3221
|
+
updatedAt?: string;
|
|
3222
|
+
consentStatuses?: {
|
|
3223
|
+
[key: string]: {
|
|
3224
|
+
subject: string;
|
|
3225
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
3226
|
+
/** Format: date-time */
|
|
3227
|
+
submittedAt?: string;
|
|
3228
|
+
/** Format: uuid */
|
|
3229
|
+
statementId?: string;
|
|
3230
|
+
statementVersion?: number;
|
|
3231
|
+
isLatestStatement?: boolean;
|
|
3232
|
+
};
|
|
3233
|
+
} | {
|
|
3234
|
+
[key: string]: {
|
|
3235
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
3236
|
+
/** Format: uuid */
|
|
3237
|
+
consent_statement_id: string;
|
|
3238
|
+
};
|
|
3239
|
+
} | null;
|
|
3240
|
+
details?: {
|
|
3241
|
+
email: string;
|
|
3242
|
+
firstName: string;
|
|
3243
|
+
lastName: string;
|
|
3244
|
+
city?: string;
|
|
3245
|
+
address?: string;
|
|
3246
|
+
phone?: string;
|
|
3247
|
+
/** Format: date */
|
|
3248
|
+
dateOfBirth?: string;
|
|
3249
|
+
ppsn?: string;
|
|
3250
|
+
/**
|
|
3251
|
+
* @default en
|
|
3252
|
+
* @enum {string}
|
|
3253
|
+
*/
|
|
3254
|
+
preferredLanguage: "en" | "ga";
|
|
3255
|
+
externalId?: string;
|
|
3256
|
+
};
|
|
3257
|
+
};
|
|
3258
|
+
metadata?: {
|
|
3259
|
+
/** @description Object containing the links to the related endpoints */
|
|
3260
|
+
links?: {
|
|
3261
|
+
self: {
|
|
3262
|
+
/** @description URL pointing to the request itself */
|
|
3263
|
+
href?: string;
|
|
3264
|
+
};
|
|
3265
|
+
next?: {
|
|
3266
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
3267
|
+
href?: string;
|
|
3268
|
+
};
|
|
3269
|
+
prev?: {
|
|
3270
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
3271
|
+
href?: string;
|
|
3272
|
+
};
|
|
3273
|
+
first: {
|
|
3274
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
3275
|
+
href?: string;
|
|
3276
|
+
};
|
|
3277
|
+
last: {
|
|
3278
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
3279
|
+
href?: string;
|
|
3280
|
+
};
|
|
3281
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
3282
|
+
pages: {
|
|
3283
|
+
[key: string]: {
|
|
3284
|
+
href?: string;
|
|
3285
|
+
};
|
|
3286
|
+
};
|
|
3287
|
+
};
|
|
3288
|
+
/** @description Number representing the total number of available items */
|
|
3289
|
+
totalCount?: number;
|
|
3290
|
+
};
|
|
3291
|
+
};
|
|
3292
|
+
};
|
|
3293
|
+
};
|
|
3294
|
+
/** @description Default Response */
|
|
3295
|
+
"4XX": {
|
|
3296
|
+
headers: {
|
|
3297
|
+
[name: string]: unknown;
|
|
3298
|
+
};
|
|
3299
|
+
content: {
|
|
3300
|
+
"application/json": {
|
|
3301
|
+
/** @description Code used to categorize the error */
|
|
3302
|
+
code: string;
|
|
3303
|
+
/** @description Description of the error */
|
|
3304
|
+
detail: string;
|
|
3305
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3306
|
+
requestId: string;
|
|
3307
|
+
/** @description Name of the error type */
|
|
3308
|
+
name: string;
|
|
3309
|
+
/** @description List of the validation errors */
|
|
3310
|
+
validation?: {
|
|
3311
|
+
fieldName: string;
|
|
3312
|
+
message: string;
|
|
3313
|
+
}[];
|
|
3314
|
+
validationContext?: string;
|
|
3315
|
+
statusCode: number;
|
|
3316
|
+
};
|
|
3317
|
+
};
|
|
3318
|
+
};
|
|
3319
|
+
/** @description Default Response */
|
|
3320
|
+
"5XX": {
|
|
3321
|
+
headers: {
|
|
3322
|
+
[name: string]: unknown;
|
|
3323
|
+
};
|
|
3324
|
+
content: {
|
|
3325
|
+
"application/json": {
|
|
3326
|
+
/** @description Code used to categorize the error */
|
|
3327
|
+
code: string;
|
|
3328
|
+
/** @description Description of the error */
|
|
3329
|
+
detail: string;
|
|
3330
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3331
|
+
requestId: string;
|
|
3332
|
+
/** @description Name of the error type */
|
|
3333
|
+
name: string;
|
|
3334
|
+
/** @description List of the validation errors */
|
|
3335
|
+
validation?: {
|
|
3336
|
+
fieldName: string;
|
|
3337
|
+
message: string;
|
|
3338
|
+
}[];
|
|
3339
|
+
validationContext?: string;
|
|
3340
|
+
statusCode: number;
|
|
3341
|
+
};
|
|
3342
|
+
};
|
|
3343
|
+
};
|
|
3344
|
+
};
|
|
3345
|
+
};
|
|
3346
|
+
patchProfile: {
|
|
3347
|
+
parameters: {
|
|
3348
|
+
query?: {
|
|
3349
|
+
/** @description Organization ID owning the profile */
|
|
3350
|
+
organizationId?: string;
|
|
3351
|
+
};
|
|
3352
|
+
header?: never;
|
|
3353
|
+
path: {
|
|
3354
|
+
/** @description ID of the profile to update */
|
|
3355
|
+
profileId: string;
|
|
3356
|
+
};
|
|
3357
|
+
cookie?: never;
|
|
3358
|
+
};
|
|
3359
|
+
requestBody?: {
|
|
3360
|
+
content: {
|
|
3361
|
+
"application/json": {
|
|
3362
|
+
publicName?: string;
|
|
3363
|
+
/** Format: email */
|
|
3364
|
+
email?: string;
|
|
3365
|
+
phone?: string;
|
|
3366
|
+
address?: string;
|
|
3367
|
+
city?: string;
|
|
3368
|
+
firstName?: string;
|
|
3369
|
+
lastName?: string;
|
|
3370
|
+
/** Format: date */
|
|
3371
|
+
dateOfBirth?: string;
|
|
3372
|
+
/** @enum {string} */
|
|
3373
|
+
preferredLanguage?: "en" | "ga";
|
|
3374
|
+
primaryUserId?: string;
|
|
3375
|
+
};
|
|
3376
|
+
};
|
|
3377
|
+
};
|
|
3378
|
+
responses: {
|
|
3379
|
+
/** @description Default Response */
|
|
3380
|
+
200: {
|
|
3381
|
+
headers: {
|
|
3382
|
+
[name: string]: unknown;
|
|
3383
|
+
};
|
|
3384
|
+
content: {
|
|
3385
|
+
"application/json": {
|
|
3386
|
+
data: {
|
|
3387
|
+
id: string;
|
|
3388
|
+
publicName: string;
|
|
3389
|
+
/** Format: email */
|
|
3390
|
+
email: string;
|
|
3391
|
+
primaryUserId: string;
|
|
3392
|
+
safeLevel?: number;
|
|
3393
|
+
/**
|
|
3394
|
+
* @default en
|
|
3395
|
+
* @enum {string}
|
|
3396
|
+
*/
|
|
3397
|
+
preferredLanguage: "en" | "ga";
|
|
3398
|
+
/** Format: date-time */
|
|
3399
|
+
createdAt?: string;
|
|
3400
|
+
/** Format: date-time */
|
|
3401
|
+
updatedAt?: string;
|
|
3402
|
+
consentStatuses?: {
|
|
3403
|
+
[key: string]: {
|
|
3404
|
+
subject: string;
|
|
3405
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
3406
|
+
/** Format: date-time */
|
|
3407
|
+
submittedAt?: string;
|
|
3408
|
+
/** Format: uuid */
|
|
3409
|
+
statementId?: string;
|
|
3410
|
+
statementVersion?: number;
|
|
3411
|
+
isLatestStatement?: boolean;
|
|
3412
|
+
};
|
|
3413
|
+
} | {
|
|
3414
|
+
[key: string]: {
|
|
3415
|
+
status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
|
|
3416
|
+
/** Format: uuid */
|
|
3417
|
+
consent_statement_id: string;
|
|
3418
|
+
};
|
|
3419
|
+
} | null;
|
|
3420
|
+
details?: {
|
|
3421
|
+
email: string;
|
|
3422
|
+
firstName: string;
|
|
3423
|
+
lastName: string;
|
|
3424
|
+
city?: string;
|
|
3425
|
+
address?: string;
|
|
3426
|
+
phone?: string;
|
|
3427
|
+
/** Format: date */
|
|
3428
|
+
dateOfBirth?: string;
|
|
3429
|
+
ppsn?: string;
|
|
3430
|
+
/**
|
|
3431
|
+
* @default en
|
|
3432
|
+
* @enum {string}
|
|
3433
|
+
*/
|
|
3434
|
+
preferredLanguage: "en" | "ga";
|
|
3435
|
+
externalId?: string;
|
|
3436
|
+
};
|
|
3437
|
+
};
|
|
3438
|
+
metadata?: {
|
|
3439
|
+
/** @description Object containing the links to the related endpoints */
|
|
3440
|
+
links?: {
|
|
3441
|
+
self: {
|
|
3442
|
+
/** @description URL pointing to the request itself */
|
|
3443
|
+
href?: string;
|
|
3444
|
+
};
|
|
3445
|
+
next?: {
|
|
3446
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
3447
|
+
href?: string;
|
|
3448
|
+
};
|
|
3449
|
+
prev?: {
|
|
3450
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
3451
|
+
href?: string;
|
|
3452
|
+
};
|
|
3453
|
+
first: {
|
|
3454
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
3455
|
+
href?: string;
|
|
3456
|
+
};
|
|
3457
|
+
last: {
|
|
3458
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
3459
|
+
href?: string;
|
|
3460
|
+
};
|
|
3461
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
3462
|
+
pages: {
|
|
3463
|
+
[key: string]: {
|
|
3464
|
+
href?: string;
|
|
3465
|
+
};
|
|
3466
|
+
};
|
|
3467
|
+
};
|
|
3468
|
+
/** @description Number representing the total number of available items */
|
|
3469
|
+
totalCount?: number;
|
|
3470
|
+
};
|
|
3471
|
+
};
|
|
3472
|
+
};
|
|
3473
|
+
};
|
|
3474
|
+
/** @description Default Response */
|
|
3475
|
+
"4XX": {
|
|
3476
|
+
headers: {
|
|
3477
|
+
[name: string]: unknown;
|
|
3478
|
+
};
|
|
3479
|
+
content: {
|
|
3480
|
+
"application/json": {
|
|
3481
|
+
/** @description Code used to categorize the error */
|
|
3482
|
+
code: string;
|
|
3483
|
+
/** @description Description of the error */
|
|
3484
|
+
detail: string;
|
|
3485
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3486
|
+
requestId: string;
|
|
3487
|
+
/** @description Name of the error type */
|
|
3488
|
+
name: string;
|
|
3489
|
+
/** @description List of the validation errors */
|
|
3490
|
+
validation?: {
|
|
3491
|
+
fieldName: string;
|
|
3492
|
+
message: string;
|
|
3493
|
+
}[];
|
|
3494
|
+
validationContext?: string;
|
|
3495
|
+
statusCode: number;
|
|
3496
|
+
};
|
|
3497
|
+
};
|
|
3498
|
+
};
|
|
3499
|
+
/** @description Default Response */
|
|
3500
|
+
"5XX": {
|
|
3501
|
+
headers: {
|
|
3502
|
+
[name: string]: unknown;
|
|
3503
|
+
};
|
|
3504
|
+
content: {
|
|
3505
|
+
"application/json": {
|
|
3506
|
+
/** @description Code used to categorize the error */
|
|
3507
|
+
code: string;
|
|
3508
|
+
/** @description Description of the error */
|
|
3509
|
+
detail: string;
|
|
3510
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3511
|
+
requestId: string;
|
|
3512
|
+
/** @description Name of the error type */
|
|
3513
|
+
name: string;
|
|
3514
|
+
/** @description List of the validation errors */
|
|
3515
|
+
validation?: {
|
|
3516
|
+
fieldName: string;
|
|
3517
|
+
message: string;
|
|
3518
|
+
}[];
|
|
3519
|
+
validationContext?: string;
|
|
3520
|
+
statusCode: number;
|
|
3521
|
+
};
|
|
3522
|
+
};
|
|
3523
|
+
};
|
|
3524
|
+
};
|
|
3525
|
+
};
|
|
3526
|
+
importProfilesOld: {
|
|
3527
|
+
parameters: {
|
|
3528
|
+
query?: {
|
|
3529
|
+
privateDetails?: "true" | "false" | "0" | "1";
|
|
3530
|
+
onlyPrivateDetails?: "true" | "false" | "0" | "1";
|
|
3531
|
+
importType?: "ppsn-only" | "full";
|
|
3532
|
+
};
|
|
3533
|
+
header?: never;
|
|
3534
|
+
path?: never;
|
|
3535
|
+
cookie?: never;
|
|
3536
|
+
};
|
|
3537
|
+
requestBody?: {
|
|
3538
|
+
content: {
|
|
3539
|
+
"application/json": {
|
|
3540
|
+
profiles?: {
|
|
3541
|
+
email: string;
|
|
3542
|
+
firstName: string;
|
|
3543
|
+
lastName: string;
|
|
3544
|
+
city?: string;
|
|
3545
|
+
address?: string;
|
|
3546
|
+
phone?: string;
|
|
3547
|
+
/** Format: date */
|
|
3548
|
+
dateOfBirth?: string;
|
|
3549
|
+
ppsn?: string;
|
|
3550
|
+
/**
|
|
3551
|
+
* @default en
|
|
3552
|
+
* @enum {string}
|
|
3553
|
+
*/
|
|
3554
|
+
preferredLanguage?: "en" | "ga";
|
|
3555
|
+
externalId?: string;
|
|
3556
|
+
}[];
|
|
3557
|
+
ppsnOnlyProfiles?: {
|
|
3558
|
+
ppsn: string;
|
|
3559
|
+
externalId?: string;
|
|
3560
|
+
/** Format: date */
|
|
3561
|
+
dateOfBirth?: string;
|
|
3562
|
+
}[];
|
|
3563
|
+
file?: unknown;
|
|
3564
|
+
};
|
|
3565
|
+
"multipart/form-data": {
|
|
3566
|
+
profiles?: {
|
|
3567
|
+
email: string;
|
|
3568
|
+
firstName: string;
|
|
3569
|
+
lastName: string;
|
|
3570
|
+
city?: string;
|
|
3571
|
+
address?: string;
|
|
3572
|
+
phone?: string;
|
|
3573
|
+
/** Format: date */
|
|
3574
|
+
dateOfBirth?: string;
|
|
3575
|
+
ppsn?: string;
|
|
3576
|
+
/**
|
|
3577
|
+
* @default en
|
|
3578
|
+
* @enum {string}
|
|
3579
|
+
*/
|
|
3580
|
+
preferredLanguage?: "en" | "ga";
|
|
3581
|
+
externalId?: string;
|
|
3582
|
+
}[];
|
|
3583
|
+
ppsnOnlyProfiles?: {
|
|
3584
|
+
ppsn: string;
|
|
3585
|
+
externalId?: string;
|
|
3586
|
+
/** Format: date */
|
|
3587
|
+
dateOfBirth?: string;
|
|
3588
|
+
}[];
|
|
3589
|
+
file?: unknown;
|
|
3590
|
+
};
|
|
3591
|
+
"text/csv": {
|
|
3592
|
+
profiles?: {
|
|
3593
|
+
email: string;
|
|
3594
|
+
firstName: string;
|
|
3595
|
+
lastName: string;
|
|
3596
|
+
city?: string;
|
|
3597
|
+
address?: string;
|
|
3598
|
+
phone?: string;
|
|
3599
|
+
/** Format: date */
|
|
3600
|
+
dateOfBirth?: string;
|
|
3601
|
+
ppsn?: string;
|
|
3602
|
+
/**
|
|
3603
|
+
* @default en
|
|
3604
|
+
* @enum {string}
|
|
3605
|
+
*/
|
|
3606
|
+
preferredLanguage?: "en" | "ga";
|
|
3607
|
+
externalId?: string;
|
|
3608
|
+
}[];
|
|
3609
|
+
ppsnOnlyProfiles?: {
|
|
3610
|
+
ppsn: string;
|
|
3611
|
+
externalId?: string;
|
|
3612
|
+
/** Format: date */
|
|
3613
|
+
dateOfBirth?: string;
|
|
3614
|
+
}[];
|
|
3615
|
+
file?: unknown;
|
|
3616
|
+
};
|
|
3617
|
+
};
|
|
3618
|
+
};
|
|
3619
|
+
responses: {
|
|
3620
|
+
/** @description Default Response */
|
|
3621
|
+
200: {
|
|
3622
|
+
headers: {
|
|
3623
|
+
[name: string]: unknown;
|
|
3624
|
+
};
|
|
3625
|
+
content: {
|
|
3626
|
+
"application/json": {
|
|
3627
|
+
status: string;
|
|
3628
|
+
profileImportId: string;
|
|
3629
|
+
};
|
|
3630
|
+
};
|
|
3631
|
+
};
|
|
3632
|
+
/** @description Default Response */
|
|
3633
|
+
"4XX": {
|
|
3634
|
+
headers: {
|
|
3635
|
+
[name: string]: unknown;
|
|
3636
|
+
};
|
|
3637
|
+
content: {
|
|
3638
|
+
"application/json": {
|
|
3639
|
+
/** @description Code used to categorize the error */
|
|
3640
|
+
code: string;
|
|
3641
|
+
/** @description Description of the error */
|
|
3642
|
+
detail: string;
|
|
3643
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3644
|
+
requestId: string;
|
|
3645
|
+
/** @description Name of the error type */
|
|
3646
|
+
name: string;
|
|
3647
|
+
/** @description List of the validation errors */
|
|
3648
|
+
validation?: {
|
|
3649
|
+
fieldName: string;
|
|
3650
|
+
message: string;
|
|
3651
|
+
}[];
|
|
3652
|
+
validationContext?: string;
|
|
3653
|
+
statusCode: number;
|
|
3654
|
+
};
|
|
3655
|
+
};
|
|
3656
|
+
};
|
|
3657
|
+
/** @description Default Response */
|
|
3658
|
+
"5XX": {
|
|
3659
|
+
headers: {
|
|
3660
|
+
[name: string]: unknown;
|
|
3661
|
+
};
|
|
3662
|
+
content: {
|
|
3663
|
+
"application/json": {
|
|
3664
|
+
/** @description Code used to categorize the error */
|
|
3665
|
+
code: string;
|
|
3666
|
+
/** @description Description of the error */
|
|
3667
|
+
detail: string;
|
|
3668
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3669
|
+
requestId: string;
|
|
3670
|
+
/** @description Name of the error type */
|
|
3671
|
+
name: string;
|
|
3672
|
+
/** @description List of the validation errors */
|
|
3673
|
+
validation?: {
|
|
3674
|
+
fieldName: string;
|
|
3675
|
+
message: string;
|
|
3676
|
+
}[];
|
|
3677
|
+
validationContext?: string;
|
|
3678
|
+
statusCode: number;
|
|
3679
|
+
};
|
|
3680
|
+
};
|
|
3681
|
+
};
|
|
3682
|
+
};
|
|
3683
|
+
};
|
|
3684
|
+
listProfileImports: {
|
|
3685
|
+
parameters: {
|
|
3686
|
+
query?: {
|
|
3687
|
+
organizationId?: string;
|
|
3688
|
+
source?: "csv" | "json";
|
|
3689
|
+
/** @description If set, the endpoint searches for profile imports with this value in the metadata.filename */
|
|
3690
|
+
search?: string;
|
|
3691
|
+
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
3692
|
+
offset?: string;
|
|
3693
|
+
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
3694
|
+
limit?: string;
|
|
3695
|
+
};
|
|
3696
|
+
header?: never;
|
|
3697
|
+
path?: never;
|
|
3698
|
+
cookie?: never;
|
|
3699
|
+
};
|
|
3700
|
+
requestBody?: never;
|
|
3701
|
+
responses: {
|
|
3702
|
+
/** @description Default Response */
|
|
3703
|
+
200: {
|
|
3704
|
+
headers: {
|
|
3705
|
+
[name: string]: unknown;
|
|
3706
|
+
};
|
|
3707
|
+
content: {
|
|
3708
|
+
"application/json": {
|
|
3709
|
+
data: {
|
|
3710
|
+
/** Format: uuid */
|
|
3711
|
+
id: string;
|
|
3712
|
+
organisationId?: string;
|
|
3713
|
+
status: string;
|
|
3714
|
+
source: "csv" | "json";
|
|
3715
|
+
metadata?: {
|
|
3716
|
+
filename: string;
|
|
3717
|
+
mimetype: string;
|
|
3718
|
+
};
|
|
3719
|
+
/** Format: date-time */
|
|
3720
|
+
createdAt: string;
|
|
3721
|
+
/** Format: date-time */
|
|
3722
|
+
updatedAt: string;
|
|
3723
|
+
}[];
|
|
3724
|
+
metadata?: {
|
|
3725
|
+
/** @description Object containing the links to the related endpoints */
|
|
3726
|
+
links?: {
|
|
3727
|
+
self: {
|
|
3728
|
+
/** @description URL pointing to the request itself */
|
|
3729
|
+
href?: string;
|
|
3730
|
+
};
|
|
3731
|
+
next?: {
|
|
3732
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
3733
|
+
href?: string;
|
|
3734
|
+
};
|
|
3735
|
+
prev?: {
|
|
3736
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
3737
|
+
href?: string;
|
|
3738
|
+
};
|
|
3739
|
+
first: {
|
|
3740
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
3741
|
+
href?: string;
|
|
3742
|
+
};
|
|
3743
|
+
last: {
|
|
3744
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
3745
|
+
href?: string;
|
|
3746
|
+
};
|
|
3747
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
3748
|
+
pages: {
|
|
3749
|
+
[key: string]: {
|
|
3750
|
+
href?: string;
|
|
3751
|
+
};
|
|
3752
|
+
};
|
|
3753
|
+
};
|
|
3754
|
+
/** @description Number representing the total number of available items */
|
|
3755
|
+
totalCount?: number;
|
|
3756
|
+
};
|
|
3757
|
+
};
|
|
3758
|
+
};
|
|
3759
|
+
};
|
|
3760
|
+
/** @description Default Response */
|
|
3761
|
+
"4XX": {
|
|
3762
|
+
headers: {
|
|
3763
|
+
[name: string]: unknown;
|
|
3764
|
+
};
|
|
3765
|
+
content: {
|
|
3766
|
+
"application/json": {
|
|
3767
|
+
/** @description Code used to categorize the error */
|
|
3768
|
+
code: string;
|
|
3769
|
+
/** @description Description of the error */
|
|
3770
|
+
detail: string;
|
|
3771
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3772
|
+
requestId: string;
|
|
3773
|
+
/** @description Name of the error type */
|
|
3774
|
+
name: string;
|
|
3775
|
+
/** @description List of the validation errors */
|
|
3776
|
+
validation?: {
|
|
3777
|
+
fieldName: string;
|
|
3778
|
+
message: string;
|
|
3779
|
+
}[];
|
|
3780
|
+
validationContext?: string;
|
|
3781
|
+
statusCode: number;
|
|
3782
|
+
};
|
|
3783
|
+
};
|
|
3784
|
+
};
|
|
3785
|
+
/** @description Default Response */
|
|
3786
|
+
"5XX": {
|
|
3787
|
+
headers: {
|
|
3788
|
+
[name: string]: unknown;
|
|
3789
|
+
};
|
|
3790
|
+
content: {
|
|
3791
|
+
"application/json": {
|
|
3792
|
+
/** @description Code used to categorize the error */
|
|
3793
|
+
code: string;
|
|
3794
|
+
/** @description Description of the error */
|
|
3795
|
+
detail: string;
|
|
3796
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3797
|
+
requestId: string;
|
|
3798
|
+
/** @description Name of the error type */
|
|
3799
|
+
name: string;
|
|
3800
|
+
/** @description List of the validation errors */
|
|
3801
|
+
validation?: {
|
|
3802
|
+
fieldName: string;
|
|
3803
|
+
message: string;
|
|
3804
|
+
}[];
|
|
3805
|
+
validationContext?: string;
|
|
3806
|
+
statusCode: number;
|
|
3807
|
+
};
|
|
3808
|
+
};
|
|
3809
|
+
};
|
|
3810
|
+
};
|
|
3811
|
+
};
|
|
3812
|
+
importProfiles: {
|
|
3813
|
+
parameters: {
|
|
3814
|
+
query?: {
|
|
3815
|
+
privateDetails?: "true" | "false" | "0" | "1";
|
|
3816
|
+
onlyPrivateDetails?: "true" | "false" | "0" | "1";
|
|
3817
|
+
importType?: "ppsn-only" | "full";
|
|
3818
|
+
};
|
|
3819
|
+
header?: never;
|
|
3820
|
+
path?: never;
|
|
3821
|
+
cookie?: never;
|
|
3822
|
+
};
|
|
3823
|
+
requestBody?: {
|
|
3824
|
+
content: {
|
|
3825
|
+
"application/json": {
|
|
3826
|
+
profiles?: {
|
|
3827
|
+
email: string;
|
|
3828
|
+
firstName: string;
|
|
3829
|
+
lastName: string;
|
|
3830
|
+
city?: string;
|
|
3831
|
+
address?: string;
|
|
3832
|
+
phone?: string;
|
|
3833
|
+
/** Format: date */
|
|
3834
|
+
dateOfBirth?: string;
|
|
3835
|
+
ppsn?: string;
|
|
3836
|
+
/**
|
|
3837
|
+
* @default en
|
|
3838
|
+
* @enum {string}
|
|
3839
|
+
*/
|
|
3840
|
+
preferredLanguage?: "en" | "ga";
|
|
3841
|
+
externalId?: string;
|
|
3842
|
+
}[];
|
|
3843
|
+
ppsnOnlyProfiles?: {
|
|
3844
|
+
ppsn: string;
|
|
3845
|
+
externalId?: string;
|
|
3846
|
+
/** Format: date */
|
|
3847
|
+
dateOfBirth?: string;
|
|
3848
|
+
}[];
|
|
3849
|
+
file?: unknown;
|
|
3850
|
+
};
|
|
3851
|
+
"multipart/form-data": {
|
|
3852
|
+
profiles?: {
|
|
3853
|
+
email: string;
|
|
3854
|
+
firstName: string;
|
|
3855
|
+
lastName: string;
|
|
3856
|
+
city?: string;
|
|
3857
|
+
address?: string;
|
|
3858
|
+
phone?: string;
|
|
3859
|
+
/** Format: date */
|
|
3860
|
+
dateOfBirth?: string;
|
|
3861
|
+
ppsn?: string;
|
|
3862
|
+
/**
|
|
3863
|
+
* @default en
|
|
3864
|
+
* @enum {string}
|
|
3865
|
+
*/
|
|
3866
|
+
preferredLanguage?: "en" | "ga";
|
|
3867
|
+
externalId?: string;
|
|
3868
|
+
}[];
|
|
3869
|
+
ppsnOnlyProfiles?: {
|
|
3870
|
+
ppsn: string;
|
|
3871
|
+
externalId?: string;
|
|
3872
|
+
/** Format: date */
|
|
3873
|
+
dateOfBirth?: string;
|
|
3874
|
+
}[];
|
|
3875
|
+
file?: unknown;
|
|
3876
|
+
};
|
|
3877
|
+
"text/csv": {
|
|
3878
|
+
profiles?: {
|
|
3879
|
+
email: string;
|
|
3880
|
+
firstName: string;
|
|
3881
|
+
lastName: string;
|
|
3882
|
+
city?: string;
|
|
3883
|
+
address?: string;
|
|
3884
|
+
phone?: string;
|
|
3885
|
+
/** Format: date */
|
|
3886
|
+
dateOfBirth?: string;
|
|
3887
|
+
ppsn?: string;
|
|
3888
|
+
/**
|
|
3889
|
+
* @default en
|
|
3890
|
+
* @enum {string}
|
|
3891
|
+
*/
|
|
3892
|
+
preferredLanguage?: "en" | "ga";
|
|
3893
|
+
externalId?: string;
|
|
3894
|
+
}[];
|
|
3895
|
+
ppsnOnlyProfiles?: {
|
|
3896
|
+
ppsn: string;
|
|
3897
|
+
externalId?: string;
|
|
3898
|
+
/** Format: date */
|
|
3899
|
+
dateOfBirth?: string;
|
|
3900
|
+
}[];
|
|
3901
|
+
file?: unknown;
|
|
3902
|
+
};
|
|
3903
|
+
};
|
|
3904
|
+
};
|
|
3905
|
+
responses: {
|
|
3906
|
+
/** @description Default Response */
|
|
3907
|
+
200: {
|
|
3908
|
+
headers: {
|
|
3909
|
+
[name: string]: unknown;
|
|
3910
|
+
};
|
|
3911
|
+
content: {
|
|
3912
|
+
"application/json": {
|
|
3913
|
+
status: string;
|
|
3914
|
+
profileImportId: string;
|
|
3915
|
+
};
|
|
3916
|
+
};
|
|
3917
|
+
};
|
|
3918
|
+
/** @description Default Response */
|
|
3919
|
+
"4XX": {
|
|
3920
|
+
headers: {
|
|
3921
|
+
[name: string]: unknown;
|
|
3922
|
+
};
|
|
3923
|
+
content: {
|
|
3924
|
+
"application/json": {
|
|
3925
|
+
/** @description Code used to categorize the error */
|
|
3926
|
+
code: string;
|
|
3927
|
+
/** @description Description of the error */
|
|
3928
|
+
detail: string;
|
|
3929
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3930
|
+
requestId: string;
|
|
3931
|
+
/** @description Name of the error type */
|
|
3932
|
+
name: string;
|
|
3933
|
+
/** @description List of the validation errors */
|
|
3934
|
+
validation?: {
|
|
3935
|
+
fieldName: string;
|
|
3936
|
+
message: string;
|
|
3937
|
+
}[];
|
|
3938
|
+
validationContext?: string;
|
|
3939
|
+
statusCode: number;
|
|
3940
|
+
};
|
|
3941
|
+
};
|
|
3942
|
+
};
|
|
3943
|
+
/** @description Default Response */
|
|
3944
|
+
"5XX": {
|
|
3945
|
+
headers: {
|
|
3946
|
+
[name: string]: unknown;
|
|
3947
|
+
};
|
|
3948
|
+
content: {
|
|
3949
|
+
"application/json": {
|
|
3950
|
+
/** @description Code used to categorize the error */
|
|
3951
|
+
code: string;
|
|
3952
|
+
/** @description Description of the error */
|
|
3953
|
+
detail: string;
|
|
3954
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
3955
|
+
requestId: string;
|
|
3956
|
+
/** @description Name of the error type */
|
|
3957
|
+
name: string;
|
|
3958
|
+
/** @description List of the validation errors */
|
|
3959
|
+
validation?: {
|
|
3960
|
+
fieldName: string;
|
|
3961
|
+
message: string;
|
|
3962
|
+
}[];
|
|
3963
|
+
validationContext?: string;
|
|
3964
|
+
statusCode: number;
|
|
3965
|
+
};
|
|
3966
|
+
};
|
|
3967
|
+
};
|
|
3968
|
+
};
|
|
3969
|
+
};
|
|
3970
|
+
getProfileImportDetails: {
|
|
3971
|
+
parameters: {
|
|
3972
|
+
query?: never;
|
|
3973
|
+
header?: never;
|
|
3974
|
+
path: {
|
|
3975
|
+
importId: string;
|
|
3976
|
+
};
|
|
3977
|
+
cookie?: never;
|
|
3978
|
+
};
|
|
3979
|
+
requestBody?: never;
|
|
3980
|
+
responses: {
|
|
3981
|
+
/** @description Default Response */
|
|
3982
|
+
200: {
|
|
3983
|
+
headers: {
|
|
3984
|
+
[name: string]: unknown;
|
|
3985
|
+
};
|
|
3986
|
+
content: {
|
|
3987
|
+
"application/json": {
|
|
3988
|
+
data: {
|
|
3989
|
+
organisationId: string;
|
|
3990
|
+
status: string;
|
|
3991
|
+
/** Format: date-time */
|
|
3992
|
+
createdAt?: string;
|
|
3993
|
+
metadata: {
|
|
3994
|
+
filename: string;
|
|
3995
|
+
mimetype: string;
|
|
3996
|
+
};
|
|
3997
|
+
details: {
|
|
3998
|
+
email: string;
|
|
3999
|
+
firstName: string;
|
|
4000
|
+
lastName: string;
|
|
4001
|
+
city?: string;
|
|
4002
|
+
address?: string;
|
|
4003
|
+
phone?: string;
|
|
4004
|
+
/** Format: date */
|
|
4005
|
+
dateOfBirth?: string;
|
|
4006
|
+
ppsn?: string;
|
|
4007
|
+
/**
|
|
4008
|
+
* @default en
|
|
4009
|
+
* @enum {string}
|
|
4010
|
+
*/
|
|
4011
|
+
preferredLanguage: "en" | "ga";
|
|
4012
|
+
externalId?: string;
|
|
4013
|
+
status: string;
|
|
4014
|
+
}[];
|
|
4015
|
+
};
|
|
4016
|
+
metadata?: {
|
|
4017
|
+
/** @description Object containing the links to the related endpoints */
|
|
4018
|
+
links?: {
|
|
4019
|
+
self: {
|
|
4020
|
+
/** @description URL pointing to the request itself */
|
|
4021
|
+
href?: string;
|
|
4022
|
+
};
|
|
4023
|
+
next?: {
|
|
4024
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
4025
|
+
href?: string;
|
|
4026
|
+
};
|
|
4027
|
+
prev?: {
|
|
4028
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
4029
|
+
href?: string;
|
|
4030
|
+
};
|
|
4031
|
+
first: {
|
|
4032
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
4033
|
+
href?: string;
|
|
4034
|
+
};
|
|
4035
|
+
last: {
|
|
4036
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
4037
|
+
href?: string;
|
|
4038
|
+
};
|
|
4039
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
4040
|
+
pages: {
|
|
4041
|
+
[key: string]: {
|
|
4042
|
+
href?: string;
|
|
4043
|
+
};
|
|
4044
|
+
};
|
|
4045
|
+
};
|
|
4046
|
+
/** @description Number representing the total number of available items */
|
|
4047
|
+
totalCount?: number;
|
|
4048
|
+
};
|
|
4049
|
+
};
|
|
4050
|
+
};
|
|
4051
|
+
};
|
|
4052
|
+
/** @description Default Response */
|
|
4053
|
+
"4XX": {
|
|
4054
|
+
headers: {
|
|
4055
|
+
[name: string]: unknown;
|
|
4056
|
+
};
|
|
4057
|
+
content: {
|
|
4058
|
+
"application/json": {
|
|
4059
|
+
/** @description Code used to categorize the error */
|
|
4060
|
+
code: string;
|
|
4061
|
+
/** @description Description of the error */
|
|
4062
|
+
detail: string;
|
|
4063
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
4064
|
+
requestId: string;
|
|
4065
|
+
/** @description Name of the error type */
|
|
4066
|
+
name: string;
|
|
4067
|
+
/** @description List of the validation errors */
|
|
4068
|
+
validation?: {
|
|
4069
|
+
fieldName: string;
|
|
4070
|
+
message: string;
|
|
4071
|
+
}[];
|
|
4072
|
+
validationContext?: string;
|
|
4073
|
+
statusCode: number;
|
|
4074
|
+
};
|
|
4075
|
+
};
|
|
4076
|
+
};
|
|
4077
|
+
/** @description Default Response */
|
|
4078
|
+
"5XX": {
|
|
4079
|
+
headers: {
|
|
4080
|
+
[name: string]: unknown;
|
|
4081
|
+
};
|
|
4082
|
+
content: {
|
|
4083
|
+
"application/json": {
|
|
4084
|
+
/** @description Code used to categorize the error */
|
|
4085
|
+
code: string;
|
|
4086
|
+
/** @description Description of the error */
|
|
4087
|
+
detail: string;
|
|
4088
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
4089
|
+
requestId: string;
|
|
4090
|
+
/** @description Name of the error type */
|
|
4091
|
+
name: string;
|
|
4092
|
+
/** @description List of the validation errors */
|
|
4093
|
+
validation?: {
|
|
4094
|
+
fieldName: string;
|
|
4095
|
+
message: string;
|
|
4096
|
+
}[];
|
|
4097
|
+
validationContext?: string;
|
|
4098
|
+
statusCode: number;
|
|
4099
|
+
};
|
|
4100
|
+
};
|
|
4101
|
+
};
|
|
4102
|
+
};
|
|
4103
|
+
};
|
|
2926
4104
|
getProfileTemplate: {
|
|
2927
4105
|
parameters: {
|
|
2928
4106
|
query?: never;
|