@ogcio/building-blocks-sdk 0.2.20 → 0.2.21

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.
@@ -4,127 +4,6 @@ import type { paths } from "./schema.js";
4
4
  export declare class Profile extends BaseClient<paths> {
5
5
  protected client: ReturnType<typeof createClient<paths>>;
6
6
  protected serviceName: "profile";
7
- /**
8
- * @deprecated Use getProfile() instead of getUser()
9
- */
10
- getUser(profileId: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
11
- parameters: {
12
- query?: {
13
- privateDetails?: "true" | "false" | "0" | "1";
14
- organizationId?: string;
15
- };
16
- header?: never;
17
- path: {
18
- profileId: string;
19
- };
20
- cookie?: never;
21
- };
22
- requestBody?: never;
23
- responses: {
24
- 200: {
25
- headers: {
26
- [name: string]: unknown;
27
- };
28
- content: {
29
- "application/json": {
30
- data: {
31
- id: string;
32
- publicName: string;
33
- email: string;
34
- primaryUserId: string;
35
- safeLevel?: number;
36
- preferredLanguage: "en" | "ga";
37
- createdAt?: string;
38
- updatedAt?: string;
39
- details?: {
40
- email: string;
41
- firstName: string;
42
- lastName: string;
43
- city?: string;
44
- address?: string;
45
- phone?: string;
46
- dateOfBirth?: string;
47
- ppsn?: string;
48
- preferredLanguage: "en" | "ga";
49
- };
50
- };
51
- metadata?: {
52
- links?: {
53
- self: {
54
- href?: string;
55
- };
56
- next?: {
57
- href?: string;
58
- };
59
- prev?: {
60
- href?: string;
61
- };
62
- first: {
63
- href?: string;
64
- };
65
- last: {
66
- href?: string;
67
- };
68
- pages: {
69
- [key: string]: {
70
- href?: string;
71
- };
72
- };
73
- };
74
- totalCount?: number;
75
- };
76
- };
77
- };
78
- };
79
- "4XX": {
80
- headers: {
81
- [name: string]: unknown;
82
- };
83
- content: {
84
- "application/json": {
85
- code: string;
86
- detail: string;
87
- requestId: string;
88
- name: string;
89
- validation?: {
90
- fieldName: string;
91
- message: string;
92
- }[];
93
- validationContext?: string;
94
- statusCode: number;
95
- };
96
- };
97
- };
98
- "5XX": {
99
- headers: {
100
- [name: string]: unknown;
101
- };
102
- content: {
103
- "application/json": {
104
- code: string;
105
- detail: string;
106
- requestId: string;
107
- name: string;
108
- validation?: {
109
- fieldName: string;
110
- message: string;
111
- }[];
112
- validationContext?: string;
113
- statusCode: number;
114
- };
115
- };
116
- };
117
- };
118
- }, {
119
- params: {
120
- path: {
121
- profileId: string;
122
- };
123
- query: {
124
- privateDetails: "true" | "false";
125
- };
126
- };
127
- }>>;
128
7
  getProfile(profileId: string, privateDetails?: boolean): Promise<import("../../utils/client-utils.js").DataResponseValue<{
129
8
  parameters: {
130
9
  query?: {
@@ -243,135 +122,6 @@ export declare class Profile extends BaseClient<paths> {
243
122
  };
244
123
  };
245
124
  }>>;
246
- /**
247
- * @deprecated Use getProfile() instead of getUser()
248
- */
249
- createUser(data: NonNullable<NonNullable<paths["/api/v1/profiles/import-profiles"]["post"]["requestBody"]>["content"]["application/json"]["profiles"]>[number]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
250
- parameters: {
251
- query?: {
252
- privateDetails?: "true" | "false" | "0" | "1";
253
- };
254
- header?: never;
255
- path?: never;
256
- cookie?: never;
257
- };
258
- requestBody?: {
259
- content: {
260
- "application/json": {
261
- profiles?: {
262
- email: string;
263
- firstName: string;
264
- lastName: string;
265
- city?: string;
266
- address?: string;
267
- phone?: string;
268
- dateOfBirth?: string;
269
- ppsn?: string;
270
- preferredLanguage?: "en" | "ga";
271
- }[];
272
- file?: unknown;
273
- };
274
- "multipart/form-data": {
275
- profiles?: {
276
- email: string;
277
- firstName: string;
278
- lastName: string;
279
- city?: string;
280
- address?: string;
281
- phone?: string;
282
- dateOfBirth?: string;
283
- ppsn?: string;
284
- preferredLanguage?: "en" | "ga";
285
- }[];
286
- file?: unknown;
287
- };
288
- "text/csv": {
289
- profiles?: {
290
- email: string;
291
- firstName: string;
292
- lastName: string;
293
- city?: string;
294
- address?: string;
295
- phone?: string;
296
- dateOfBirth?: string;
297
- ppsn?: string;
298
- preferredLanguage?: "en" | "ga";
299
- }[];
300
- file?: unknown;
301
- };
302
- };
303
- };
304
- responses: {
305
- 200: {
306
- headers: {
307
- [name: string]: unknown;
308
- };
309
- content: {
310
- "application/json": {
311
- status: string;
312
- profileImportId: string;
313
- };
314
- };
315
- };
316
- "4XX": {
317
- headers: {
318
- [name: string]: unknown;
319
- };
320
- content: {
321
- "application/json": {
322
- code: string;
323
- detail: string;
324
- requestId: string;
325
- name: string;
326
- validation?: {
327
- fieldName: string;
328
- message: string;
329
- }[];
330
- validationContext?: string;
331
- statusCode: number;
332
- };
333
- };
334
- };
335
- "5XX": {
336
- headers: {
337
- [name: string]: unknown;
338
- };
339
- content: {
340
- "application/json": {
341
- code: string;
342
- detail: string;
343
- requestId: string;
344
- name: string;
345
- validation?: {
346
- fieldName: string;
347
- message: string;
348
- }[];
349
- validationContext?: string;
350
- statusCode: number;
351
- };
352
- };
353
- };
354
- };
355
- }, {
356
- body: {
357
- profiles: {
358
- email: string;
359
- firstName: string;
360
- lastName: string;
361
- city?: string;
362
- address?: string;
363
- phone?: string;
364
- dateOfBirth?: string;
365
- ppsn?: string;
366
- preferredLanguage?: "en" | "ga";
367
- }[];
368
- };
369
- params: {
370
- query: {
371
- privateDetails: "true" | "false";
372
- };
373
- };
374
- }>>;
375
125
  createProfile(data: NonNullable<NonNullable<paths["/api/v1/profiles/import-profiles"]["post"]["requestBody"]>["content"]["application/json"]["profiles"]>[number], privateDetails?: boolean): Promise<import("../../utils/client-utils.js").DataResponseValue<{
376
126
  parameters: {
377
127
  query?: {
@@ -498,10 +248,7 @@ export declare class Profile extends BaseClient<paths> {
498
248
  };
499
249
  };
500
250
  }>>;
501
- /**
502
- * @deprecated Use getProfile() instead of getUser()
503
- */
504
- updateUser(profileId: string, data: NonNullable<paths["/api/v1/profiles/{profileId}"]["put"]["requestBody"]>["content"]["application/json"], organizationId?: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
251
+ updateProfile(profileId: string, data: NonNullable<paths["/api/v1/profiles/{profileId}"]["put"]["requestBody"]>["content"]["application/json"], organizationId?: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
505
252
  parameters: {
506
253
  query?: {
507
254
  organizationId?: string;
@@ -512,10 +259,10 @@ export declare class Profile extends BaseClient<paths> {
512
259
  };
513
260
  cookie?: never;
514
261
  };
515
- requestBody?: {
262
+ requestBody: {
516
263
  content: {
517
264
  "application/json": {
518
- publicName?: string;
265
+ publicName: string;
519
266
  email?: string;
520
267
  phone?: string;
521
268
  address?: string;
@@ -523,7 +270,7 @@ export declare class Profile extends BaseClient<paths> {
523
270
  firstName?: string;
524
271
  lastName?: string;
525
272
  dateOfBirth?: string;
526
- preferredLanguage?: "en" | "ga";
273
+ preferredLanguage: "en" | "ga";
527
274
  };
528
275
  };
529
276
  };
@@ -632,7 +379,7 @@ export declare class Profile extends BaseClient<paths> {
632
379
  };
633
380
  };
634
381
  body: {
635
- publicName?: string;
382
+ publicName: string;
636
383
  email?: string;
637
384
  phone?: string;
638
385
  address?: string;
@@ -640,10 +387,10 @@ export declare class Profile extends BaseClient<paths> {
640
387
  firstName?: string;
641
388
  lastName?: string;
642
389
  dateOfBirth?: string;
643
- preferredLanguage?: "en" | "ga";
390
+ preferredLanguage: "en" | "ga";
644
391
  };
645
392
  }>>;
646
- updateProfile(profileId: string, data: NonNullable<paths["/api/v1/profiles/{profileId}"]["put"]["requestBody"]>["content"]["application/json"], organizationId?: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
393
+ patchProfile(profileId: string, data?: NonNullable<paths["/api/v1/profiles/{profileId}"]["patch"]["requestBody"]>["content"]["application/json"], organizationId?: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
647
394
  parameters: {
648
395
  query?: {
649
396
  organizationId?: string;
@@ -666,6 +413,7 @@ export declare class Profile extends BaseClient<paths> {
666
413
  lastName?: string;
667
414
  dateOfBirth?: string;
668
415
  preferredLanguage?: "en" | "ga";
416
+ primaryUserId?: string;
669
417
  };
670
418
  };
671
419
  };
@@ -783,417 +531,10 @@ export declare class Profile extends BaseClient<paths> {
783
531
  lastName?: string;
784
532
  dateOfBirth?: string;
785
533
  preferredLanguage?: "en" | "ga";
534
+ primaryUserId?: string;
786
535
  };
787
- }>>;
788
- /**
789
- * @deprecated Use getProfile() instead of getUser()
790
- */
791
- patchUser(profileId: string, data: NonNullable<paths["/api/v1/profiles/{profileId}"]["put"]["requestBody"]>["content"]["application/json"], organizationId?: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
792
- parameters: {
793
- query?: {
794
- organizationId?: string;
795
- };
796
- header?: never;
797
- path: {
798
- profileId: string;
799
- };
800
- cookie?: never;
801
- };
802
- requestBody?: {
803
- content: {
804
- "application/json": {
805
- publicName?: string;
806
- email?: string;
807
- phone?: string;
808
- address?: string;
809
- city?: string;
810
- firstName?: string;
811
- lastName?: string;
812
- dateOfBirth?: string;
813
- preferredLanguage?: "en" | "ga";
814
- };
815
- };
816
- };
817
- responses: {
818
- 200: {
819
- headers: {
820
- [name: string]: unknown;
821
- };
822
- content: {
823
- "application/json": {
824
- data: {
825
- id: string;
826
- publicName: string;
827
- email: string;
828
- primaryUserId: string;
829
- safeLevel?: number;
830
- preferredLanguage: "en" | "ga";
831
- createdAt?: string;
832
- updatedAt?: string;
833
- details?: {
834
- email: string;
835
- firstName: string;
836
- lastName: string;
837
- city?: string;
838
- address?: string;
839
- phone?: string;
840
- dateOfBirth?: string;
841
- ppsn?: string;
842
- preferredLanguage: "en" | "ga";
843
- };
844
- };
845
- metadata?: {
846
- links?: {
847
- self: {
848
- href?: string;
849
- };
850
- next?: {
851
- href?: string;
852
- };
853
- prev?: {
854
- href?: string;
855
- };
856
- first: {
857
- href?: string;
858
- };
859
- last: {
860
- href?: string;
861
- };
862
- pages: {
863
- [key: string]: {
864
- href?: string;
865
- };
866
- };
867
- };
868
- totalCount?: number;
869
- };
870
- };
871
- };
872
- };
873
- "4XX": {
874
- headers: {
875
- [name: string]: unknown;
876
- };
877
- content: {
878
- "application/json": {
879
- code: string;
880
- detail: string;
881
- requestId: string;
882
- name: string;
883
- validation?: {
884
- fieldName: string;
885
- message: string;
886
- }[];
887
- validationContext?: string;
888
- statusCode: number;
889
- };
890
- };
891
- };
892
- "5XX": {
893
- headers: {
894
- [name: string]: unknown;
895
- };
896
- content: {
897
- "application/json": {
898
- code: string;
899
- detail: string;
900
- requestId: string;
901
- name: string;
902
- validation?: {
903
- fieldName: string;
904
- message: string;
905
- }[];
906
- validationContext?: string;
907
- statusCode: number;
908
- };
909
- };
910
- };
911
- };
912
- }, {
913
- params: {
914
- path: {
915
- profileId: string;
916
- };
917
- query: {
918
- organizationId: string | undefined;
919
- };
920
- };
921
- body: {
922
- publicName?: string;
923
- email?: string;
924
- phone?: string;
925
- address?: string;
926
- city?: string;
927
- firstName?: string;
928
- lastName?: string;
929
- dateOfBirth?: string;
930
- preferredLanguage?: "en" | "ga";
931
- };
932
- }> | undefined>;
933
- patchProfile(profileId: string, data?: NonNullable<paths["/api/v1/profiles/{profileId}"]["patch"]["requestBody"]>["content"]["application/json"], organizationId?: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
934
- parameters: {
935
- query?: {
936
- organizationId?: string;
937
- };
938
- header?: never;
939
- path: {
940
- profileId: string;
941
- };
942
- cookie?: never;
943
- };
944
- requestBody?: {
945
- content: {
946
- "application/json": {
947
- publicName?: string;
948
- email?: string;
949
- phone?: string;
950
- address?: string;
951
- city?: string;
952
- firstName?: string;
953
- lastName?: string;
954
- dateOfBirth?: string;
955
- preferredLanguage?: "en" | "ga";
956
- };
957
- };
958
- };
959
- responses: {
960
- 200: {
961
- headers: {
962
- [name: string]: unknown;
963
- };
964
- content: {
965
- "application/json": {
966
- data: {
967
- id: string;
968
- publicName: string;
969
- email: string;
970
- primaryUserId: string;
971
- safeLevel?: number;
972
- preferredLanguage: "en" | "ga";
973
- createdAt?: string;
974
- updatedAt?: string;
975
- details?: {
976
- email: string;
977
- firstName: string;
978
- lastName: string;
979
- city?: string;
980
- address?: string;
981
- phone?: string;
982
- dateOfBirth?: string;
983
- ppsn?: string;
984
- preferredLanguage: "en" | "ga";
985
- };
986
- };
987
- metadata?: {
988
- links?: {
989
- self: {
990
- href?: string;
991
- };
992
- next?: {
993
- href?: string;
994
- };
995
- prev?: {
996
- href?: string;
997
- };
998
- first: {
999
- href?: string;
1000
- };
1001
- last: {
1002
- href?: string;
1003
- };
1004
- pages: {
1005
- [key: string]: {
1006
- href?: string;
1007
- };
1008
- };
1009
- };
1010
- totalCount?: number;
1011
- };
1012
- };
1013
- };
1014
- };
1015
- "4XX": {
1016
- headers: {
1017
- [name: string]: unknown;
1018
- };
1019
- content: {
1020
- "application/json": {
1021
- code: string;
1022
- detail: string;
1023
- requestId: string;
1024
- name: string;
1025
- validation?: {
1026
- fieldName: string;
1027
- message: string;
1028
- }[];
1029
- validationContext?: string;
1030
- statusCode: number;
1031
- };
1032
- };
1033
- };
1034
- "5XX": {
1035
- headers: {
1036
- [name: string]: unknown;
1037
- };
1038
- content: {
1039
- "application/json": {
1040
- code: string;
1041
- detail: string;
1042
- requestId: string;
1043
- name: string;
1044
- validation?: {
1045
- fieldName: string;
1046
- message: string;
1047
- }[];
1048
- validationContext?: string;
1049
- statusCode: number;
1050
- };
1051
- };
1052
- };
1053
- };
1054
- }, {
1055
- params: {
1056
- path: {
1057
- profileId: string;
1058
- };
1059
- query: {
1060
- organizationId: string | undefined;
1061
- };
1062
- };
1063
- body: {
1064
- publicName?: string;
1065
- email?: string;
1066
- phone?: string;
1067
- address?: string;
1068
- city?: string;
1069
- firstName?: string;
1070
- lastName?: string;
1071
- dateOfBirth?: string;
1072
- preferredLanguage?: "en" | "ga";
1073
- };
1074
- }> | undefined>;
1075
- /**
1076
- * @deprecated Use getProfile() instead of getUser()
1077
- */
1078
- findUser(query: paths["/api/v1/profiles/find-profile"]["get"]["parameters"]["query"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1079
- parameters: {
1080
- query?: {
1081
- email?: string;
1082
- firstName?: string;
1083
- lastName?: string;
1084
- phone?: string;
1085
- };
1086
- header?: never;
1087
- path?: never;
1088
- cookie?: never;
1089
- };
1090
- requestBody?: never;
1091
- responses: {
1092
- 200: {
1093
- headers: {
1094
- [name: string]: unknown;
1095
- };
1096
- content: {
1097
- "application/json": {
1098
- data: {
1099
- id: string;
1100
- publicName: string;
1101
- email: string;
1102
- primaryUserId: string;
1103
- safeLevel?: number;
1104
- preferredLanguage: "en" | "ga";
1105
- createdAt?: string;
1106
- updatedAt?: string;
1107
- details?: {
1108
- email: string;
1109
- firstName: string;
1110
- lastName: string;
1111
- city?: string;
1112
- address?: string;
1113
- phone?: string;
1114
- dateOfBirth?: string;
1115
- ppsn?: string;
1116
- preferredLanguage: "en" | "ga";
1117
- };
1118
- };
1119
- metadata?: {
1120
- links?: {
1121
- self: {
1122
- href?: string;
1123
- };
1124
- next?: {
1125
- href?: string;
1126
- };
1127
- prev?: {
1128
- href?: string;
1129
- };
1130
- first: {
1131
- href?: string;
1132
- };
1133
- last: {
1134
- href?: string;
1135
- };
1136
- pages: {
1137
- [key: string]: {
1138
- href?: string;
1139
- };
1140
- };
1141
- };
1142
- totalCount?: number;
1143
- };
1144
- };
1145
- };
1146
- };
1147
- "4XX": {
1148
- headers: {
1149
- [name: string]: unknown;
1150
- };
1151
- content: {
1152
- "application/json": {
1153
- code: string;
1154
- detail: string;
1155
- requestId: string;
1156
- name: string;
1157
- validation?: {
1158
- fieldName: string;
1159
- message: string;
1160
- }[];
1161
- validationContext?: string;
1162
- statusCode: number;
1163
- };
1164
- };
1165
- };
1166
- "5XX": {
1167
- headers: {
1168
- [name: string]: unknown;
1169
- };
1170
- content: {
1171
- "application/json": {
1172
- code: string;
1173
- detail: string;
1174
- requestId: string;
1175
- name: string;
1176
- validation?: {
1177
- fieldName: string;
1178
- message: string;
1179
- }[];
1180
- validationContext?: string;
1181
- statusCode: number;
1182
- };
1183
- };
1184
- };
1185
- };
1186
- }, {
1187
- params: {
1188
- query: {
1189
- email?: string;
1190
- firstName?: string;
1191
- lastName?: string;
1192
- phone?: string;
1193
- } | undefined;
1194
- };
1195
- }>>;
1196
- findProfile(query: paths["/api/v1/profiles/find-profile"]["get"]["parameters"]["query"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
536
+ }> | undefined>;
537
+ findProfile(query: paths["/api/v1/profiles/find-profile"]["get"]["parameters"]["query"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1197
538
  parameters: {
1198
539
  query?: {
1199
540
  email?: string;
@@ -1311,121 +652,6 @@ export declare class Profile extends BaseClient<paths> {
1311
652
  } | undefined;
1312
653
  };
1313
654
  }>>;
1314
- /**
1315
- * @deprecated Use getProfile() instead of getUser()
1316
- */
1317
- selectUsers(ids: paths["/api/v1/profiles/select-profiles"]["get"]["parameters"]["query"]["ids"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1318
- parameters: {
1319
- query: {
1320
- ids: string;
1321
- };
1322
- header?: never;
1323
- path?: never;
1324
- cookie?: never;
1325
- };
1326
- requestBody?: never;
1327
- responses: {
1328
- 200: {
1329
- headers: {
1330
- [name: string]: unknown;
1331
- };
1332
- content: {
1333
- "application/json": {
1334
- data: {
1335
- id: string;
1336
- publicName: string;
1337
- email: string;
1338
- primaryUserId: string;
1339
- safeLevel?: number;
1340
- preferredLanguage: "en" | "ga";
1341
- createdAt?: string;
1342
- updatedAt?: string;
1343
- details?: {
1344
- email: string;
1345
- firstName: string;
1346
- lastName: string;
1347
- city?: string;
1348
- address?: string;
1349
- phone?: string;
1350
- dateOfBirth?: string;
1351
- ppsn?: string;
1352
- preferredLanguage: "en" | "ga";
1353
- };
1354
- }[];
1355
- metadata?: {
1356
- links?: {
1357
- self: {
1358
- href?: string;
1359
- };
1360
- next?: {
1361
- href?: string;
1362
- };
1363
- prev?: {
1364
- href?: string;
1365
- };
1366
- first: {
1367
- href?: string;
1368
- };
1369
- last: {
1370
- href?: string;
1371
- };
1372
- pages: {
1373
- [key: string]: {
1374
- href?: string;
1375
- };
1376
- };
1377
- };
1378
- totalCount?: number;
1379
- };
1380
- };
1381
- };
1382
- };
1383
- "4XX": {
1384
- headers: {
1385
- [name: string]: unknown;
1386
- };
1387
- content: {
1388
- "application/json": {
1389
- code: string;
1390
- detail: string;
1391
- requestId: string;
1392
- name: string;
1393
- validation?: {
1394
- fieldName: string;
1395
- message: string;
1396
- }[];
1397
- validationContext?: string;
1398
- statusCode: number;
1399
- };
1400
- };
1401
- };
1402
- "5XX": {
1403
- headers: {
1404
- [name: string]: unknown;
1405
- };
1406
- content: {
1407
- "application/json": {
1408
- code: string;
1409
- detail: string;
1410
- requestId: string;
1411
- name: string;
1412
- validation?: {
1413
- fieldName: string;
1414
- message: string;
1415
- }[];
1416
- validationContext?: string;
1417
- statusCode: number;
1418
- };
1419
- };
1420
- };
1421
- };
1422
- }, {
1423
- params: {
1424
- query: {
1425
- ids: string;
1426
- };
1427
- };
1428
- }>>;
1429
655
  selectProfiles(ids: paths["/api/v1/profiles/select-profiles"]["get"]["parameters"]["query"]["ids"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1430
656
  parameters: {
1431
657
  query: {