@ogcio/building-blocks-sdk 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/.husky/commit-msg +1 -0
  2. package/.husky/pre-push +1 -0
  3. package/.nvmrc +1 -0
  4. package/.vscode/settings.json +20 -0
  5. package/biome.jsonc +45 -0
  6. package/commitlint.config.js +6 -0
  7. package/dist/client/auth/index.d.ts +4 -0
  8. package/dist/client/auth/index.d.ts.map +1 -0
  9. package/dist/client/auth/index.js +83 -0
  10. package/dist/client/auth/index.js.map +1 -0
  11. package/dist/client/base-client.d.ts +18 -0
  12. package/dist/client/base-client.d.ts.map +1 -0
  13. package/dist/client/base-client.js +71 -0
  14. package/dist/client/base-client.js.map +1 -0
  15. package/dist/client/clients/messaging/index.d.ts +2407 -0
  16. package/dist/client/clients/messaging/index.d.ts.map +1 -0
  17. package/dist/client/clients/messaging/index.js +430 -0
  18. package/dist/client/clients/messaging/index.js.map +1 -0
  19. package/dist/client/clients/messaging/schema.d.ts +3823 -0
  20. package/dist/client/clients/messaging/schema.d.ts.map +1 -0
  21. package/dist/client/clients/messaging/schema.js +2 -0
  22. package/dist/client/clients/messaging/schema.js.map +1 -0
  23. package/dist/client/clients/payments/index.d.ts +2294 -0
  24. package/dist/client/clients/payments/index.d.ts.map +1 -0
  25. package/dist/client/clients/payments/index.js +217 -0
  26. package/dist/client/clients/payments/index.js.map +1 -0
  27. package/dist/client/clients/payments/schema.d.ts +2534 -0
  28. package/dist/client/clients/payments/schema.d.ts.map +1 -0
  29. package/dist/client/clients/payments/schema.js +2 -0
  30. package/dist/client/clients/payments/schema.js.map +1 -0
  31. package/dist/client/clients/profile/index.d.ts +1364 -0
  32. package/dist/client/clients/profile/index.d.ts.map +1 -0
  33. package/dist/client/clients/profile/index.js +102 -0
  34. package/dist/client/clients/profile/index.js.map +1 -0
  35. package/dist/client/clients/profile/schema.d.ts +1429 -0
  36. package/dist/client/clients/profile/schema.d.ts.map +1 -0
  37. package/dist/client/clients/profile/schema.js +2 -0
  38. package/dist/client/clients/profile/schema.js.map +1 -0
  39. package/dist/client/clients/scheduler/index.d.ts +14 -0
  40. package/dist/client/clients/scheduler/index.d.ts.map +1 -0
  41. package/dist/client/clients/scheduler/index.js +14 -0
  42. package/dist/client/clients/scheduler/index.js.map +1 -0
  43. package/dist/client/clients/scheduler/schema.d.ts +114 -0
  44. package/dist/client/clients/scheduler/schema.d.ts.map +1 -0
  45. package/dist/client/clients/scheduler/schema.js +2 -0
  46. package/dist/client/clients/scheduler/schema.js.map +1 -0
  47. package/dist/client/clients/upload/index.d.ts +390 -0
  48. package/dist/client/clients/upload/index.d.ts.map +1 -0
  49. package/dist/client/clients/upload/index.js +93 -0
  50. package/dist/client/clients/upload/index.js.map +1 -0
  51. package/dist/client/clients/upload/schema.d.ts +564 -0
  52. package/dist/client/clients/upload/schema.d.ts.map +1 -0
  53. package/dist/client/clients/upload/schema.js +2 -0
  54. package/dist/client/clients/upload/schema.js.map +1 -0
  55. package/dist/client/utils/client-utils.d.ts +15 -0
  56. package/dist/client/utils/client-utils.d.ts.map +1 -0
  57. package/dist/client/utils/client-utils.js +14 -0
  58. package/dist/client/utils/client-utils.js.map +1 -0
  59. package/dist/clients-configurations/clients-configuration.json +92 -0
  60. package/dist/clients-configurations/read-configuration-file.d.ts +22 -0
  61. package/dist/clients-configurations/read-configuration-file.d.ts.map +1 -0
  62. package/dist/clients-configurations/read-configuration-file.js +47 -0
  63. package/dist/clients-configurations/read-configuration-file.js.map +1 -0
  64. package/dist/index.d.ts +6 -0
  65. package/dist/index.d.ts.map +1 -0
  66. package/dist/index.js +33 -0
  67. package/dist/index.js.map +1 -0
  68. package/dist/types/index.d.ts +63 -0
  69. package/dist/types/index.d.ts.map +1 -0
  70. package/dist/types/index.js +6 -0
  71. package/dist/types/index.js.map +1 -0
  72. package/dist/utils/get-absolute-path.d.ts +3 -0
  73. package/dist/utils/get-absolute-path.d.ts.map +1 -0
  74. package/dist/utils/get-absolute-path.js +8 -0
  75. package/dist/utils/get-absolute-path.js.map +1 -0
  76. package/package.json +44 -0
  77. package/src/cli/cli-utils.ts +25 -0
  78. package/src/cli/index.ts +13 -0
  79. package/src/cli/outdated-clients-command.ts +148 -0
  80. package/src/cli/update-clients-command.ts +298 -0
  81. package/src/client/auth/index.ts +131 -0
  82. package/src/client/base-client.ts +97 -0
  83. package/src/client/clients/messaging/index.ts +683 -0
  84. package/src/client/clients/messaging/open-api-definition.json +8394 -0
  85. package/src/client/clients/messaging/schema.ts +3822 -0
  86. package/src/client/clients/payments/index.ts +349 -0
  87. package/src/client/clients/payments/open-api-definition.json +6094 -0
  88. package/src/client/clients/payments/schema.ts +2533 -0
  89. package/src/client/clients/profile/index.ts +182 -0
  90. package/src/client/clients/profile/open-api-definition.json +2876 -0
  91. package/src/client/clients/profile/schema.ts +1428 -0
  92. package/src/client/clients/scheduler/index.ts +28 -0
  93. package/src/client/clients/scheduler/open-api-definition.json +120 -0
  94. package/src/client/clients/scheduler/schema.ts +113 -0
  95. package/src/client/clients/upload/index.ts +129 -0
  96. package/src/client/clients/upload/open-api-definition.json +985 -0
  97. package/src/client/clients/upload/schema.ts +563 -0
  98. package/src/client/utils/client-utils.ts +50 -0
  99. package/src/clients-configurations/clients-configuration.json +92 -0
  100. package/src/clients-configurations/read-configuration-file.ts +68 -0
  101. package/src/index.ts +43 -0
  102. package/src/logto-node.d.ts +12 -0
  103. package/src/types/index.ts +82 -0
  104. package/src/utils/get-absolute-path.ts +10 -0
  105. package/tsconfig.json +18 -0
  106. package/tsconfig.prod.json +4 -0
@@ -0,0 +1,2407 @@
1
+ import type createClient from "openapi-fetch";
2
+ import BaseClient from "../../base-client.js";
3
+ import { type PaginationParams } from "../../utils/client-utils.js";
4
+ import type { paths } from "./schema.js";
5
+ declare class Messaging extends BaseClient<paths> {
6
+ client: ReturnType<typeof createClient<paths>>;
7
+ protected serviceName: "messaging";
8
+ getMessagesForUser(userId: string, filter?: {
9
+ isSeen?: boolean;
10
+ search?: string;
11
+ } & PaginationParams): Promise<import("../../utils/client-utils.js").DataResponseValue<{
12
+ parameters: {
13
+ query?: {
14
+ status?: "delivered";
15
+ isSeen?: "true" | "false" | "0" | "1";
16
+ search?: string;
17
+ recipientUserId?: string;
18
+ organisationId?: string;
19
+ offset?: string;
20
+ limit?: string;
21
+ };
22
+ header?: never;
23
+ path?: never;
24
+ cookie?: never;
25
+ };
26
+ requestBody?: never;
27
+ responses: {
28
+ 200: {
29
+ headers: {
30
+ [name: string]: unknown;
31
+ };
32
+ content: {
33
+ "application/json": {
34
+ data: {
35
+ id: string;
36
+ subject: string;
37
+ createdAt: string;
38
+ threadName: string;
39
+ organisationId: string;
40
+ recipientUserId: string;
41
+ attachmentsCount: number;
42
+ }[];
43
+ metadata?: {
44
+ links?: {
45
+ self: {
46
+ href?: string;
47
+ };
48
+ next?: {
49
+ href?: string;
50
+ };
51
+ prev?: {
52
+ href?: string;
53
+ };
54
+ first: {
55
+ href?: string;
56
+ };
57
+ last: {
58
+ href?: string;
59
+ };
60
+ pages: {
61
+ [key: string]: {
62
+ href?: string;
63
+ };
64
+ };
65
+ };
66
+ totalCount?: number;
67
+ };
68
+ };
69
+ };
70
+ };
71
+ 400: {
72
+ headers: {
73
+ [name: string]: unknown;
74
+ };
75
+ content: {
76
+ "application/json": {
77
+ code: string;
78
+ detail: string;
79
+ requestId: string;
80
+ name: string;
81
+ validation?: {
82
+ fieldName: string;
83
+ message: string;
84
+ }[];
85
+ validationContext?: string;
86
+ };
87
+ };
88
+ };
89
+ };
90
+ }, {
91
+ params: {
92
+ query: {
93
+ recipientUserId: string;
94
+ status: "delivered";
95
+ isSeen: "true" | "false" | undefined;
96
+ search: string | undefined;
97
+ offset?: string;
98
+ limit?: string;
99
+ };
100
+ };
101
+ }>>;
102
+ getMessagesForOrganisation(organisationId: string, filter?: PaginationParams): Promise<import("../../utils/client-utils.js").DataResponseValue<{
103
+ parameters: {
104
+ query?: {
105
+ status?: "delivered";
106
+ isSeen?: "true" | "false" | "0" | "1";
107
+ search?: string;
108
+ recipientUserId?: string;
109
+ organisationId?: string;
110
+ offset?: string;
111
+ limit?: string;
112
+ };
113
+ header?: never;
114
+ path?: never;
115
+ cookie?: never;
116
+ };
117
+ requestBody?: never;
118
+ responses: {
119
+ 200: {
120
+ headers: {
121
+ [name: string]: unknown;
122
+ };
123
+ content: {
124
+ "application/json": {
125
+ data: {
126
+ id: string;
127
+ subject: string;
128
+ createdAt: string;
129
+ threadName: string;
130
+ organisationId: string;
131
+ recipientUserId: string;
132
+ attachmentsCount: number;
133
+ }[];
134
+ metadata?: {
135
+ links?: {
136
+ self: {
137
+ href?: string;
138
+ };
139
+ next?: {
140
+ href?: string;
141
+ };
142
+ prev?: {
143
+ href?: string;
144
+ };
145
+ first: {
146
+ href?: string;
147
+ };
148
+ last: {
149
+ href?: string;
150
+ };
151
+ pages: {
152
+ [key: string]: {
153
+ href?: string;
154
+ };
155
+ };
156
+ };
157
+ totalCount?: number;
158
+ };
159
+ };
160
+ };
161
+ };
162
+ 400: {
163
+ headers: {
164
+ [name: string]: unknown;
165
+ };
166
+ content: {
167
+ "application/json": {
168
+ code: string;
169
+ detail: string;
170
+ requestId: string;
171
+ name: string;
172
+ validation?: {
173
+ fieldName: string;
174
+ message: string;
175
+ }[];
176
+ validationContext?: string;
177
+ };
178
+ };
179
+ };
180
+ };
181
+ }, {
182
+ params: {
183
+ query: {
184
+ organisationId: string;
185
+ offset?: string;
186
+ limit?: string;
187
+ };
188
+ };
189
+ }>>;
190
+ getMessage(messageId: paths["/api/v1/messages/{messageId}"]["get"]["parameters"]["path"]["messageId"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
191
+ parameters: {
192
+ query?: never;
193
+ header?: never;
194
+ path: {
195
+ messageId: string;
196
+ };
197
+ cookie?: never;
198
+ };
199
+ requestBody?: never;
200
+ responses: {
201
+ 200: {
202
+ headers: {
203
+ [name: string]: unknown;
204
+ };
205
+ content: {
206
+ "application/json": {
207
+ data: {
208
+ subject: string;
209
+ createdAt: string;
210
+ threadName: string;
211
+ organisationId: string;
212
+ recipientUserId: string;
213
+ excerpt: string;
214
+ plainText: string;
215
+ richText: string;
216
+ isSeen: boolean;
217
+ security: "confidential" | "public";
218
+ attachments: string[];
219
+ };
220
+ metadata?: {
221
+ links?: {
222
+ self: {
223
+ href?: string;
224
+ };
225
+ next?: {
226
+ href?: string;
227
+ };
228
+ prev?: {
229
+ href?: string;
230
+ };
231
+ first: {
232
+ href?: string;
233
+ };
234
+ last: {
235
+ href?: string;
236
+ };
237
+ pages: {
238
+ [key: string]: {
239
+ href?: string;
240
+ };
241
+ };
242
+ };
243
+ totalCount?: number;
244
+ };
245
+ };
246
+ };
247
+ };
248
+ "4XX": {
249
+ headers: {
250
+ [name: string]: unknown;
251
+ };
252
+ content: {
253
+ "application/json": {
254
+ code: string;
255
+ detail: string;
256
+ requestId: string;
257
+ name: string;
258
+ validation?: {
259
+ fieldName: string;
260
+ message: string;
261
+ }[];
262
+ validationContext?: string;
263
+ };
264
+ };
265
+ };
266
+ "5XX": {
267
+ headers: {
268
+ [name: string]: unknown;
269
+ };
270
+ content: {
271
+ "application/json": {
272
+ code: string;
273
+ detail: string;
274
+ requestId: string;
275
+ name: string;
276
+ validation?: {
277
+ fieldName: string;
278
+ message: string;
279
+ }[];
280
+ validationContext?: string;
281
+ };
282
+ };
283
+ };
284
+ };
285
+ }, {
286
+ params: {
287
+ path: {
288
+ messageId: string;
289
+ };
290
+ };
291
+ }>>;
292
+ send(body: paths["/api/v1/messages/"]["post"]["requestBody"]["content"]["application/json"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
293
+ parameters: {
294
+ query?: never;
295
+ header?: never;
296
+ path?: never;
297
+ cookie?: never;
298
+ };
299
+ requestBody: {
300
+ content: {
301
+ "application/json": {
302
+ preferredTransports: ("sms" | "email" | "lifeEvent")[];
303
+ recipientUserId: string;
304
+ security: "confidential" | "public";
305
+ bypassConsent: boolean;
306
+ scheduleAt: string;
307
+ message: {
308
+ threadName?: string;
309
+ subject: string;
310
+ excerpt: string;
311
+ plainText: string;
312
+ richText: string;
313
+ language: "en" | "ga";
314
+ };
315
+ attachments?: string[];
316
+ };
317
+ };
318
+ };
319
+ responses: {
320
+ 201: {
321
+ headers: {
322
+ [name: string]: unknown;
323
+ };
324
+ content: {
325
+ "application/json": {
326
+ data: {
327
+ id: string;
328
+ };
329
+ };
330
+ };
331
+ };
332
+ "4XX": {
333
+ headers: {
334
+ [name: string]: unknown;
335
+ };
336
+ content: {
337
+ "application/json": {
338
+ code: string;
339
+ detail: string;
340
+ requestId: string;
341
+ name: string;
342
+ validation?: {
343
+ fieldName: string;
344
+ message: string;
345
+ }[];
346
+ validationContext?: string;
347
+ };
348
+ };
349
+ };
350
+ "5XX": {
351
+ headers: {
352
+ [name: string]: unknown;
353
+ };
354
+ content: {
355
+ "application/json": {
356
+ code: string;
357
+ detail: string;
358
+ requestId: string;
359
+ name: string;
360
+ validation?: {
361
+ fieldName: string;
362
+ message: string;
363
+ }[];
364
+ validationContext?: string;
365
+ };
366
+ };
367
+ };
368
+ };
369
+ }, {
370
+ body: {
371
+ preferredTransports: ("sms" | "email" | "lifeEvent")[];
372
+ recipientUserId: string;
373
+ security: "confidential" | "public";
374
+ bypassConsent: boolean;
375
+ scheduleAt: string;
376
+ message: {
377
+ threadName?: string;
378
+ subject: string;
379
+ excerpt: string;
380
+ plainText: string;
381
+ richText: string;
382
+ language: "en" | "ga";
383
+ };
384
+ attachments?: string[];
385
+ };
386
+ }>>;
387
+ getTemplates(filter?: PaginationParams): Promise<import("../../utils/client-utils.js").DataResponseValue<{
388
+ parameters: {
389
+ query?: {
390
+ offset?: string;
391
+ limit?: string;
392
+ };
393
+ header?: never;
394
+ path?: never;
395
+ cookie?: never;
396
+ };
397
+ requestBody?: never;
398
+ responses: {
399
+ 200: {
400
+ headers: {
401
+ [name: string]: unknown;
402
+ };
403
+ content: {
404
+ "application/json": {
405
+ data: {
406
+ id: string;
407
+ contents: {
408
+ language: "en" | "ga";
409
+ templateName: string;
410
+ }[];
411
+ }[];
412
+ metadata?: {
413
+ links?: {
414
+ self: {
415
+ href?: string;
416
+ };
417
+ next?: {
418
+ href?: string;
419
+ };
420
+ prev?: {
421
+ href?: string;
422
+ };
423
+ first: {
424
+ href?: string;
425
+ };
426
+ last: {
427
+ href?: string;
428
+ };
429
+ pages: {
430
+ [key: string]: {
431
+ href?: string;
432
+ };
433
+ };
434
+ };
435
+ totalCount?: number;
436
+ };
437
+ };
438
+ };
439
+ };
440
+ "4XX": {
441
+ headers: {
442
+ [name: string]: unknown;
443
+ };
444
+ content: {
445
+ "application/json": {
446
+ code: string;
447
+ detail: string;
448
+ requestId: string;
449
+ name: string;
450
+ validation?: {
451
+ fieldName: string;
452
+ message: string;
453
+ }[];
454
+ validationContext?: string;
455
+ };
456
+ };
457
+ };
458
+ "5XX": {
459
+ headers: {
460
+ [name: string]: unknown;
461
+ };
462
+ content: {
463
+ "application/json": {
464
+ code: string;
465
+ detail: string;
466
+ requestId: string;
467
+ name: string;
468
+ validation?: {
469
+ fieldName: string;
470
+ message: string;
471
+ }[];
472
+ validationContext?: string;
473
+ };
474
+ };
475
+ };
476
+ };
477
+ }, {
478
+ params: {
479
+ query: {
480
+ offset?: string;
481
+ limit?: string;
482
+ };
483
+ };
484
+ }>>;
485
+ getTemplate(templateId: paths["/api/v1/templates/{templateId}"]["get"]["parameters"]["path"]["templateId"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
486
+ parameters: {
487
+ query?: never;
488
+ header?: never;
489
+ path: {
490
+ templateId: string;
491
+ };
492
+ cookie?: never;
493
+ };
494
+ requestBody?: never;
495
+ responses: {
496
+ 200: {
497
+ headers: {
498
+ [name: string]: unknown;
499
+ };
500
+ content: {
501
+ "application/json": {
502
+ data: {
503
+ contents: {
504
+ templateName: string;
505
+ language: "en" | "ga";
506
+ subject: string;
507
+ excerpt: string;
508
+ plainText: string;
509
+ richText: string;
510
+ }[];
511
+ fields: {
512
+ fieldName: string;
513
+ }[];
514
+ };
515
+ metadata?: {
516
+ links?: {
517
+ self: {
518
+ href?: string;
519
+ };
520
+ next?: {
521
+ href?: string;
522
+ };
523
+ prev?: {
524
+ href?: string;
525
+ };
526
+ first: {
527
+ href?: string;
528
+ };
529
+ last: {
530
+ href?: string;
531
+ };
532
+ pages: {
533
+ [key: string]: {
534
+ href?: string;
535
+ };
536
+ };
537
+ };
538
+ totalCount?: number;
539
+ };
540
+ };
541
+ };
542
+ };
543
+ 404: {
544
+ headers: {
545
+ [name: string]: unknown;
546
+ };
547
+ content: {
548
+ "application/json": {
549
+ code: string;
550
+ detail: string;
551
+ requestId: string;
552
+ name: string;
553
+ validation?: {
554
+ fieldName: string;
555
+ message: string;
556
+ }[];
557
+ validationContext?: string;
558
+ };
559
+ };
560
+ };
561
+ "5XX": {
562
+ headers: {
563
+ [name: string]: unknown;
564
+ };
565
+ content: {
566
+ "application/json": {
567
+ code: string;
568
+ detail: string;
569
+ requestId: string;
570
+ name: string;
571
+ validation?: {
572
+ fieldName: string;
573
+ message: string;
574
+ }[];
575
+ validationContext?: string;
576
+ };
577
+ };
578
+ };
579
+ };
580
+ }, {
581
+ params: {
582
+ path: {
583
+ templateId: string;
584
+ };
585
+ };
586
+ }>>;
587
+ buildMessage(messages: paths["/api/v1/messages/"]["post"]["requestBody"]["content"]["application/json"]["message"][], language: string, vars: Record<string, string | null | undefined>): Promise<{
588
+ threadName: string | undefined;
589
+ subject: string;
590
+ excerpt: string;
591
+ richText: string;
592
+ plainText: string;
593
+ language: "en" | "ga";
594
+ }>;
595
+ createTemplate(body: paths["/api/v1/templates/"]["post"]["requestBody"]["content"]["application/json"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
596
+ parameters: {
597
+ query?: never;
598
+ header?: never;
599
+ path?: never;
600
+ cookie?: never;
601
+ };
602
+ requestBody: {
603
+ content: {
604
+ "application/json": {
605
+ contents: {
606
+ templateName: string;
607
+ language: "en" | "ga";
608
+ subject: string;
609
+ excerpt: string;
610
+ plainText: string;
611
+ richText: string;
612
+ }[];
613
+ variables?: {
614
+ name: string;
615
+ }[];
616
+ };
617
+ };
618
+ };
619
+ responses: {
620
+ 201: {
621
+ headers: {
622
+ [name: string]: unknown;
623
+ };
624
+ content: {
625
+ "application/json": {
626
+ data: {
627
+ id: string;
628
+ };
629
+ };
630
+ };
631
+ };
632
+ "5XX": {
633
+ headers: {
634
+ [name: string]: unknown;
635
+ };
636
+ content: {
637
+ "application/json": {
638
+ code: string;
639
+ detail: string;
640
+ requestId: string;
641
+ name: string;
642
+ validation?: {
643
+ fieldName: string;
644
+ message: string;
645
+ }[];
646
+ validationContext?: string;
647
+ };
648
+ };
649
+ };
650
+ "4XX": {
651
+ headers: {
652
+ [name: string]: unknown;
653
+ };
654
+ content: {
655
+ "application/json": {
656
+ code: string;
657
+ detail: string;
658
+ requestId: string;
659
+ name: string;
660
+ validation?: {
661
+ fieldName: string;
662
+ message: string;
663
+ }[];
664
+ validationContext?: string;
665
+ };
666
+ };
667
+ };
668
+ };
669
+ }, {
670
+ body: {
671
+ contents: {
672
+ templateName: string;
673
+ language: "en" | "ga";
674
+ subject: string;
675
+ excerpt: string;
676
+ plainText: string;
677
+ richText: string;
678
+ }[];
679
+ variables?: {
680
+ name: string;
681
+ }[];
682
+ };
683
+ }>>;
684
+ updateTemplate(templateId: paths["/api/v1/templates/{templateId}"]["put"]["parameters"]["path"]["templateId"], body: paths["/api/v1/templates/{templateId}"]["put"]["requestBody"]["content"]["application/json"]): Promise<never>;
685
+ deleteTemplate(templateId: paths["/api/v1/templates/{templateId}"]["delete"]["parameters"]["path"]["templateId"]): Promise<never>;
686
+ getEmailProviders(params?: {
687
+ primary?: boolean;
688
+ } & PaginationParams): Promise<{
689
+ error: {
690
+ code: string;
691
+ detail: string;
692
+ requestId: string;
693
+ name: string;
694
+ validation?: {
695
+ fieldName: string;
696
+ message: string;
697
+ }[];
698
+ validationContext?: string;
699
+ } | undefined;
700
+ data: {
701
+ id: string;
702
+ providerName: string;
703
+ isPrimary: boolean;
704
+ }[] | undefined;
705
+ }>;
706
+ getEmailProvider(providerId: string): Promise<{
707
+ data: {
708
+ id: string;
709
+ providerName: string;
710
+ isPrimary: boolean;
711
+ type: "email";
712
+ smtpHost: string;
713
+ smtpPort: number;
714
+ username: string;
715
+ password: string;
716
+ throttle?: number;
717
+ fromAddress: string;
718
+ ssl: boolean;
719
+ };
720
+ error?: undefined;
721
+ } | {
722
+ error: {
723
+ code: string;
724
+ detail: string;
725
+ requestId: string;
726
+ name: string;
727
+ validation?: {
728
+ fieldName: string;
729
+ message: string;
730
+ }[];
731
+ validationContext?: string;
732
+ } | undefined;
733
+ data?: undefined;
734
+ }>;
735
+ createEmailProvider(provider: {
736
+ providerName: string;
737
+ isPrimary: boolean;
738
+ smtpHost: string;
739
+ smtpPort: number;
740
+ username: string;
741
+ password: string;
742
+ throttle?: number;
743
+ fromAddress: string;
744
+ ssl: boolean;
745
+ }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
746
+ parameters: {
747
+ query?: never;
748
+ header?: never;
749
+ path?: never;
750
+ cookie?: never;
751
+ };
752
+ requestBody?: {
753
+ content: {
754
+ "application/json": {
755
+ providerName: string;
756
+ isPrimary: boolean;
757
+ type: "email";
758
+ smtpHost: string;
759
+ smtpPort: number;
760
+ username: string;
761
+ password: string;
762
+ throttle?: number;
763
+ fromAddress: string;
764
+ ssl: boolean;
765
+ } | {
766
+ providerName: string;
767
+ isPrimary: boolean;
768
+ type: "sms";
769
+ config: {
770
+ type: "AWS";
771
+ accessKey: string;
772
+ secretAccessKey: string;
773
+ region: string;
774
+ };
775
+ };
776
+ };
777
+ };
778
+ responses: {
779
+ 200: {
780
+ headers: {
781
+ [name: string]: unknown;
782
+ };
783
+ content: {
784
+ "application/json": {
785
+ data: {
786
+ id: string;
787
+ };
788
+ };
789
+ };
790
+ };
791
+ "5XX": {
792
+ headers: {
793
+ [name: string]: unknown;
794
+ };
795
+ content: {
796
+ "application/json": {
797
+ code: string;
798
+ detail: string;
799
+ requestId: string;
800
+ name: string;
801
+ validation?: {
802
+ fieldName: string;
803
+ message: string;
804
+ }[];
805
+ validationContext?: string;
806
+ };
807
+ };
808
+ };
809
+ "4XX": {
810
+ headers: {
811
+ [name: string]: unknown;
812
+ };
813
+ content: {
814
+ "application/json": {
815
+ code: string;
816
+ detail: string;
817
+ requestId: string;
818
+ name: string;
819
+ validation?: {
820
+ fieldName: string;
821
+ message: string;
822
+ }[];
823
+ validationContext?: string;
824
+ };
825
+ };
826
+ };
827
+ };
828
+ }, import("openapi-fetch").FetchOptions<{
829
+ parameters: {
830
+ query?: never;
831
+ header?: never;
832
+ path?: never;
833
+ cookie?: never;
834
+ };
835
+ requestBody?: {
836
+ content: {
837
+ "application/json": {
838
+ providerName: string;
839
+ isPrimary: boolean;
840
+ type: "email";
841
+ smtpHost: string;
842
+ smtpPort: number;
843
+ username: string;
844
+ password: string;
845
+ throttle?: number;
846
+ fromAddress: string;
847
+ ssl: boolean;
848
+ } | {
849
+ providerName: string;
850
+ isPrimary: boolean;
851
+ type: "sms";
852
+ config: {
853
+ type: "AWS";
854
+ accessKey: string;
855
+ secretAccessKey: string;
856
+ region: string;
857
+ };
858
+ };
859
+ };
860
+ };
861
+ responses: {
862
+ 200: {
863
+ headers: {
864
+ [name: string]: unknown;
865
+ };
866
+ content: {
867
+ "application/json": {
868
+ data: {
869
+ id: string;
870
+ };
871
+ };
872
+ };
873
+ };
874
+ "5XX": {
875
+ headers: {
876
+ [name: string]: unknown;
877
+ };
878
+ content: {
879
+ "application/json": {
880
+ code: string;
881
+ detail: string;
882
+ requestId: string;
883
+ name: string;
884
+ validation?: {
885
+ fieldName: string;
886
+ message: string;
887
+ }[];
888
+ validationContext?: string;
889
+ };
890
+ };
891
+ };
892
+ "4XX": {
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
+ };
908
+ };
909
+ };
910
+ };
911
+ }> | undefined>>;
912
+ updateEmailProvider(provider: {
913
+ id: string;
914
+ providerName: string;
915
+ isPrimary: boolean;
916
+ smtpHost: string;
917
+ smtpPort: number;
918
+ username: string;
919
+ password: string;
920
+ throttle?: number;
921
+ fromAddress: string;
922
+ ssl: boolean;
923
+ }): Promise<never>;
924
+ deleteEmailProvider(providerId: string): Promise<never>;
925
+ getSmsProviders(params?: {
926
+ primary?: boolean;
927
+ } & PaginationParams): Promise<{
928
+ error: {
929
+ code: string;
930
+ detail: string;
931
+ requestId: string;
932
+ name: string;
933
+ validation?: {
934
+ fieldName: string;
935
+ message: string;
936
+ }[];
937
+ validationContext?: string;
938
+ } | undefined;
939
+ data: {
940
+ id: string;
941
+ providerName: string;
942
+ isPrimary: boolean;
943
+ }[] | undefined;
944
+ }>;
945
+ getSmsProvider(providerId: string): Promise<{
946
+ data: {
947
+ id: string;
948
+ providerName: string;
949
+ isPrimary: boolean;
950
+ type: "sms";
951
+ config: {
952
+ type: "AWS";
953
+ accessKey: string;
954
+ secretAccessKey: string;
955
+ region: string;
956
+ };
957
+ };
958
+ error?: undefined;
959
+ } | {
960
+ error: {
961
+ code: string;
962
+ detail: string;
963
+ requestId: string;
964
+ name: string;
965
+ validation?: {
966
+ fieldName: string;
967
+ message: string;
968
+ }[];
969
+ validationContext?: string;
970
+ } | undefined;
971
+ data?: undefined;
972
+ }>;
973
+ updateSmsProvider(provider: {
974
+ id: string;
975
+ providerName: string;
976
+ isPrimary: boolean;
977
+ config: {
978
+ type: "AWS";
979
+ accessKey: string;
980
+ secretAccessKey: string;
981
+ region: string;
982
+ };
983
+ }): Promise<never>;
984
+ createSmsProvider(provider: {
985
+ providerName: string;
986
+ isPrimary: boolean;
987
+ config: {
988
+ type: "AWS";
989
+ accessKey: string;
990
+ secretAccessKey: string;
991
+ region: string;
992
+ };
993
+ }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
994
+ parameters: {
995
+ query?: never;
996
+ header?: never;
997
+ path?: never;
998
+ cookie?: never;
999
+ };
1000
+ requestBody?: {
1001
+ content: {
1002
+ "application/json": {
1003
+ providerName: string;
1004
+ isPrimary: boolean;
1005
+ type: "email";
1006
+ smtpHost: string;
1007
+ smtpPort: number;
1008
+ username: string;
1009
+ password: string;
1010
+ throttle?: number;
1011
+ fromAddress: string;
1012
+ ssl: boolean;
1013
+ } | {
1014
+ providerName: string;
1015
+ isPrimary: boolean;
1016
+ type: "sms";
1017
+ config: {
1018
+ type: "AWS";
1019
+ accessKey: string;
1020
+ secretAccessKey: string;
1021
+ region: string;
1022
+ };
1023
+ };
1024
+ };
1025
+ };
1026
+ responses: {
1027
+ 200: {
1028
+ headers: {
1029
+ [name: string]: unknown;
1030
+ };
1031
+ content: {
1032
+ "application/json": {
1033
+ data: {
1034
+ id: string;
1035
+ };
1036
+ };
1037
+ };
1038
+ };
1039
+ "5XX": {
1040
+ headers: {
1041
+ [name: string]: unknown;
1042
+ };
1043
+ content: {
1044
+ "application/json": {
1045
+ code: string;
1046
+ detail: string;
1047
+ requestId: string;
1048
+ name: string;
1049
+ validation?: {
1050
+ fieldName: string;
1051
+ message: string;
1052
+ }[];
1053
+ validationContext?: string;
1054
+ };
1055
+ };
1056
+ };
1057
+ "4XX": {
1058
+ headers: {
1059
+ [name: string]: unknown;
1060
+ };
1061
+ content: {
1062
+ "application/json": {
1063
+ code: string;
1064
+ detail: string;
1065
+ requestId: string;
1066
+ name: string;
1067
+ validation?: {
1068
+ fieldName: string;
1069
+ message: string;
1070
+ }[];
1071
+ validationContext?: string;
1072
+ };
1073
+ };
1074
+ };
1075
+ };
1076
+ }, import("openapi-fetch").FetchOptions<{
1077
+ parameters: {
1078
+ query?: never;
1079
+ header?: never;
1080
+ path?: never;
1081
+ cookie?: never;
1082
+ };
1083
+ requestBody?: {
1084
+ content: {
1085
+ "application/json": {
1086
+ providerName: string;
1087
+ isPrimary: boolean;
1088
+ type: "email";
1089
+ smtpHost: string;
1090
+ smtpPort: number;
1091
+ username: string;
1092
+ password: string;
1093
+ throttle?: number;
1094
+ fromAddress: string;
1095
+ ssl: boolean;
1096
+ } | {
1097
+ providerName: string;
1098
+ isPrimary: boolean;
1099
+ type: "sms";
1100
+ config: {
1101
+ type: "AWS";
1102
+ accessKey: string;
1103
+ secretAccessKey: string;
1104
+ region: string;
1105
+ };
1106
+ };
1107
+ };
1108
+ };
1109
+ responses: {
1110
+ 200: {
1111
+ headers: {
1112
+ [name: string]: unknown;
1113
+ };
1114
+ content: {
1115
+ "application/json": {
1116
+ data: {
1117
+ id: string;
1118
+ };
1119
+ };
1120
+ };
1121
+ };
1122
+ "5XX": {
1123
+ headers: {
1124
+ [name: string]: unknown;
1125
+ };
1126
+ content: {
1127
+ "application/json": {
1128
+ code: string;
1129
+ detail: string;
1130
+ requestId: string;
1131
+ name: string;
1132
+ validation?: {
1133
+ fieldName: string;
1134
+ message: string;
1135
+ }[];
1136
+ validationContext?: string;
1137
+ };
1138
+ };
1139
+ };
1140
+ "4XX": {
1141
+ headers: {
1142
+ [name: string]: unknown;
1143
+ };
1144
+ content: {
1145
+ "application/json": {
1146
+ code: string;
1147
+ detail: string;
1148
+ requestId: string;
1149
+ name: string;
1150
+ validation?: {
1151
+ fieldName: string;
1152
+ message: string;
1153
+ }[];
1154
+ validationContext?: string;
1155
+ };
1156
+ };
1157
+ };
1158
+ };
1159
+ }> | undefined>>;
1160
+ deleteSmsProvider(providerId: string): Promise<never>;
1161
+ importUsers(toImport: {
1162
+ file?: File;
1163
+ records?: object[];
1164
+ }): Promise<{
1165
+ data: {
1166
+ id: string;
1167
+ } | undefined;
1168
+ error: {
1169
+ code: string;
1170
+ detail: string;
1171
+ requestId: string;
1172
+ name: string;
1173
+ validation?: {
1174
+ fieldName: string;
1175
+ message: string;
1176
+ }[];
1177
+ validationContext?: string;
1178
+ } | undefined;
1179
+ }>;
1180
+ downloadUsersCsvTemplate(): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1181
+ parameters: {
1182
+ query?: never;
1183
+ header?: never;
1184
+ path?: never;
1185
+ cookie?: never;
1186
+ };
1187
+ requestBody?: never;
1188
+ responses: {
1189
+ 200: {
1190
+ headers: {
1191
+ [name: string]: unknown;
1192
+ };
1193
+ content: {
1194
+ "text/csv": string;
1195
+ };
1196
+ };
1197
+ };
1198
+ }, {
1199
+ parseAs: "blob";
1200
+ }>>;
1201
+ getUsersImports(pagination?: {
1202
+ limit: number;
1203
+ offset: number;
1204
+ }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1205
+ parameters: {
1206
+ query?: {
1207
+ offset?: string;
1208
+ limit?: string;
1209
+ };
1210
+ header?: never;
1211
+ path?: never;
1212
+ cookie?: never;
1213
+ };
1214
+ requestBody?: never;
1215
+ responses: {
1216
+ 200: {
1217
+ headers: {
1218
+ [name: string]: unknown;
1219
+ };
1220
+ content: {
1221
+ "application/json": {
1222
+ data: {
1223
+ organisationId: string;
1224
+ importedAt: string;
1225
+ importChannel: "api" | "csv";
1226
+ retryCount: number;
1227
+ lastRetryAt: string | null;
1228
+ id: string;
1229
+ }[];
1230
+ metadata?: {
1231
+ links?: {
1232
+ self: {
1233
+ href?: string;
1234
+ };
1235
+ next?: {
1236
+ href?: string;
1237
+ };
1238
+ prev?: {
1239
+ href?: string;
1240
+ };
1241
+ first: {
1242
+ href?: string;
1243
+ };
1244
+ last: {
1245
+ href?: string;
1246
+ };
1247
+ pages: {
1248
+ [key: string]: {
1249
+ href?: string;
1250
+ };
1251
+ };
1252
+ };
1253
+ totalCount?: number;
1254
+ };
1255
+ };
1256
+ };
1257
+ };
1258
+ };
1259
+ }, {
1260
+ params: {
1261
+ query: {
1262
+ limit: string | undefined;
1263
+ offset: string | undefined;
1264
+ };
1265
+ };
1266
+ }>>;
1267
+ getUsersImport(importId: string, includeUsersData?: boolean): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1268
+ parameters: {
1269
+ query?: {
1270
+ includeImportedData?: "true" | "false" | "0" | "1";
1271
+ };
1272
+ header?: never;
1273
+ path: {
1274
+ importId: string;
1275
+ };
1276
+ cookie?: never;
1277
+ };
1278
+ requestBody?: never;
1279
+ responses: {
1280
+ 200: {
1281
+ headers: {
1282
+ [name: string]: unknown;
1283
+ };
1284
+ content: {
1285
+ "application/json": {
1286
+ data: {
1287
+ organisationId: string;
1288
+ importedAt: string;
1289
+ usersData: {
1290
+ importIndex: number;
1291
+ phoneNumber: null | string;
1292
+ emailAddress: null | string;
1293
+ importStatus: "pending" | "imported" | "not_found" | "error" | "missing_contacts";
1294
+ importError: null | string;
1295
+ relatedUserProfileId: null | string;
1296
+ relatedUserId: null | string;
1297
+ tags?: string[];
1298
+ publicIdentityId: null | string;
1299
+ firstName: null | string;
1300
+ lastName: null | string;
1301
+ birthDate: null | string;
1302
+ address: {
1303
+ city: null | string;
1304
+ zipCode: null | string;
1305
+ street: null | string;
1306
+ country: null | string;
1307
+ region: null | string;
1308
+ } | null;
1309
+ collectedConsent: boolean;
1310
+ welcomed: boolean;
1311
+ }[];
1312
+ importChannel: "api" | "csv";
1313
+ retryCount: number;
1314
+ lastRetryAt: string | null;
1315
+ id: string;
1316
+ };
1317
+ metadata?: {
1318
+ links?: {
1319
+ self: {
1320
+ href?: string;
1321
+ };
1322
+ next?: {
1323
+ href?: string;
1324
+ };
1325
+ prev?: {
1326
+ href?: string;
1327
+ };
1328
+ first: {
1329
+ href?: string;
1330
+ };
1331
+ last: {
1332
+ href?: string;
1333
+ };
1334
+ pages: {
1335
+ [key: string]: {
1336
+ href?: string;
1337
+ };
1338
+ };
1339
+ };
1340
+ totalCount?: number;
1341
+ };
1342
+ };
1343
+ };
1344
+ };
1345
+ "5XX": {
1346
+ headers: {
1347
+ [name: string]: unknown;
1348
+ };
1349
+ content: {
1350
+ "application/json": {
1351
+ code: string;
1352
+ detail: string;
1353
+ requestId: string;
1354
+ name: string;
1355
+ validation?: {
1356
+ fieldName: string;
1357
+ message: string;
1358
+ }[];
1359
+ validationContext?: string;
1360
+ };
1361
+ };
1362
+ };
1363
+ "4XX": {
1364
+ headers: {
1365
+ [name: string]: unknown;
1366
+ };
1367
+ content: {
1368
+ "application/json": {
1369
+ code: string;
1370
+ detail: string;
1371
+ requestId: string;
1372
+ name: string;
1373
+ validation?: {
1374
+ fieldName: string;
1375
+ message: string;
1376
+ }[];
1377
+ validationContext?: string;
1378
+ };
1379
+ };
1380
+ };
1381
+ };
1382
+ }, {
1383
+ params: {
1384
+ path: {
1385
+ importId: string;
1386
+ };
1387
+ query: {
1388
+ includeImportedData: "true" | "false" | undefined;
1389
+ };
1390
+ };
1391
+ }>>;
1392
+ getUsersForImport(importId: string, activeOnly: boolean): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1393
+ parameters: {
1394
+ query?: {
1395
+ search?: string;
1396
+ transports?: string;
1397
+ importId?: string;
1398
+ activeOnly?: string;
1399
+ offset?: string;
1400
+ limit?: string;
1401
+ };
1402
+ header?: never;
1403
+ path?: never;
1404
+ cookie?: never;
1405
+ };
1406
+ requestBody?: never;
1407
+ responses: {
1408
+ 200: {
1409
+ headers: {
1410
+ [name: string]: unknown;
1411
+ };
1412
+ content: {
1413
+ "application/json": {
1414
+ data: {
1415
+ organisationSettingId: string;
1416
+ firstName: null | string;
1417
+ lastName: null | string;
1418
+ birthDate: null | string;
1419
+ lang: null | string;
1420
+ ppsn: null | string;
1421
+ id: string;
1422
+ userProfileId: null | string;
1423
+ phoneNumber: null | string;
1424
+ emailAddress: null | string;
1425
+ organisationId: string;
1426
+ organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
1427
+ organisationInvitationSentAt?: string;
1428
+ organisationInvitationFeedbackAt?: string;
1429
+ organisationPreferredTransports: ("sms" | "email")[];
1430
+ correlationQuality: "full" | "partial" | "not_related";
1431
+ userStatus: "to_be_invited" | "pending" | "disabled" | "active";
1432
+ details?: {
1433
+ publicIdentityId: null | string;
1434
+ firstName: null | string;
1435
+ lastName: null | string;
1436
+ birthDate: null | string;
1437
+ address: {
1438
+ city: null | string;
1439
+ zipCode: null | string;
1440
+ street: null | string;
1441
+ country: null | string;
1442
+ region: null | string;
1443
+ } | null;
1444
+ collectedConsent: boolean;
1445
+ welcomed: boolean;
1446
+ };
1447
+ }[];
1448
+ metadata?: {
1449
+ links?: {
1450
+ self: {
1451
+ href?: string;
1452
+ };
1453
+ next?: {
1454
+ href?: string;
1455
+ };
1456
+ prev?: {
1457
+ href?: string;
1458
+ };
1459
+ first: {
1460
+ href?: string;
1461
+ };
1462
+ last: {
1463
+ href?: string;
1464
+ };
1465
+ pages: {
1466
+ [key: string]: {
1467
+ href?: string;
1468
+ };
1469
+ };
1470
+ };
1471
+ totalCount?: number;
1472
+ };
1473
+ };
1474
+ };
1475
+ };
1476
+ "5XX": {
1477
+ headers: {
1478
+ [name: string]: unknown;
1479
+ };
1480
+ content: {
1481
+ "application/json": {
1482
+ code: string;
1483
+ detail: string;
1484
+ requestId: string;
1485
+ name: string;
1486
+ validation?: {
1487
+ fieldName: string;
1488
+ message: string;
1489
+ }[];
1490
+ validationContext?: string;
1491
+ };
1492
+ };
1493
+ };
1494
+ "4XX": {
1495
+ headers: {
1496
+ [name: string]: unknown;
1497
+ };
1498
+ content: {
1499
+ "application/json": {
1500
+ code: string;
1501
+ detail: string;
1502
+ requestId: string;
1503
+ name: string;
1504
+ validation?: {
1505
+ fieldName: string;
1506
+ message: string;
1507
+ }[];
1508
+ validationContext?: string;
1509
+ };
1510
+ };
1511
+ };
1512
+ };
1513
+ }, {
1514
+ params: {
1515
+ query: {
1516
+ importId: string;
1517
+ activeOnly: string;
1518
+ };
1519
+ };
1520
+ }>>;
1521
+ getOrganisationsSettings(filter?: PaginationParams): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1522
+ parameters: {
1523
+ query?: {
1524
+ offset?: string;
1525
+ limit?: string;
1526
+ };
1527
+ header?: never;
1528
+ path?: never;
1529
+ cookie?: never;
1530
+ };
1531
+ requestBody?: never;
1532
+ responses: {
1533
+ 200: {
1534
+ headers: {
1535
+ [name: string]: unknown;
1536
+ };
1537
+ content: {
1538
+ "application/json": {
1539
+ data: {
1540
+ id: string;
1541
+ userId: string;
1542
+ userProfileId: null | string;
1543
+ phoneNumber: null | string;
1544
+ emailAddress: null | string;
1545
+ organisationId: string;
1546
+ organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
1547
+ organisationInvitationSentAt?: string;
1548
+ organisationInvitationFeedbackAt?: string;
1549
+ organisationPreferredTransports: ("sms" | "email")[];
1550
+ correlationQuality: "full" | "partial" | "not_related";
1551
+ userStatus: "to_be_invited" | "pending" | "disabled" | "active";
1552
+ details?: {
1553
+ publicIdentityId: null | string;
1554
+ firstName: null | string;
1555
+ lastName: null | string;
1556
+ birthDate: null | string;
1557
+ address: {
1558
+ city: null | string;
1559
+ zipCode: null | string;
1560
+ street: null | string;
1561
+ country: null | string;
1562
+ region: null | string;
1563
+ } | null;
1564
+ collectedConsent: boolean;
1565
+ welcomed: boolean;
1566
+ };
1567
+ }[];
1568
+ metadata?: {
1569
+ links?: {
1570
+ self: {
1571
+ href?: string;
1572
+ };
1573
+ next?: {
1574
+ href?: string;
1575
+ };
1576
+ prev?: {
1577
+ href?: string;
1578
+ };
1579
+ first: {
1580
+ href?: string;
1581
+ };
1582
+ last: {
1583
+ href?: string;
1584
+ };
1585
+ pages: {
1586
+ [key: string]: {
1587
+ href?: string;
1588
+ };
1589
+ };
1590
+ };
1591
+ totalCount?: number;
1592
+ };
1593
+ };
1594
+ };
1595
+ };
1596
+ 400: {
1597
+ headers: {
1598
+ [name: string]: unknown;
1599
+ };
1600
+ content: {
1601
+ "application/json": {
1602
+ code: string;
1603
+ detail: string;
1604
+ requestId: string;
1605
+ name: string;
1606
+ validation?: {
1607
+ fieldName: string;
1608
+ message: string;
1609
+ }[];
1610
+ validationContext?: string;
1611
+ };
1612
+ };
1613
+ };
1614
+ 404: {
1615
+ headers: {
1616
+ [name: string]: unknown;
1617
+ };
1618
+ content: {
1619
+ "application/json": {
1620
+ code: string;
1621
+ detail: string;
1622
+ requestId: string;
1623
+ name: string;
1624
+ validation?: {
1625
+ fieldName: string;
1626
+ message: string;
1627
+ }[];
1628
+ validationContext?: string;
1629
+ };
1630
+ };
1631
+ };
1632
+ 500: {
1633
+ headers: {
1634
+ [name: string]: unknown;
1635
+ };
1636
+ content: {
1637
+ "application/json": {
1638
+ code: string;
1639
+ detail: string;
1640
+ requestId: string;
1641
+ name: string;
1642
+ validation?: {
1643
+ fieldName: string;
1644
+ message: string;
1645
+ }[];
1646
+ validationContext?: string;
1647
+ };
1648
+ };
1649
+ };
1650
+ };
1651
+ }, {
1652
+ params: {
1653
+ query: {
1654
+ offset?: string;
1655
+ limit?: string;
1656
+ };
1657
+ };
1658
+ }>>;
1659
+ getOrganisationSettings(organisationSettingId: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1660
+ parameters: {
1661
+ query?: never;
1662
+ header?: never;
1663
+ path: {
1664
+ organisationSettingId: string;
1665
+ };
1666
+ cookie?: never;
1667
+ };
1668
+ requestBody?: never;
1669
+ responses: {
1670
+ 200: {
1671
+ headers: {
1672
+ [name: string]: unknown;
1673
+ };
1674
+ content: {
1675
+ "application/json": {
1676
+ data: {
1677
+ id: string;
1678
+ userId: string;
1679
+ userProfileId: null | string;
1680
+ phoneNumber: null | string;
1681
+ emailAddress: null | string;
1682
+ organisationId: string;
1683
+ organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
1684
+ organisationInvitationSentAt?: string;
1685
+ organisationInvitationFeedbackAt?: string;
1686
+ organisationPreferredTransports: ("sms" | "email")[];
1687
+ correlationQuality: "full" | "partial" | "not_related";
1688
+ userStatus: "to_be_invited" | "pending" | "disabled" | "active";
1689
+ details?: {
1690
+ publicIdentityId: null | string;
1691
+ firstName: null | string;
1692
+ lastName: null | string;
1693
+ birthDate: null | string;
1694
+ address: {
1695
+ city: null | string;
1696
+ zipCode: null | string;
1697
+ street: null | string;
1698
+ country: null | string;
1699
+ region: null | string;
1700
+ } | null;
1701
+ collectedConsent: boolean;
1702
+ welcomed: boolean;
1703
+ };
1704
+ };
1705
+ metadata?: {
1706
+ links?: {
1707
+ self: {
1708
+ href?: string;
1709
+ };
1710
+ next?: {
1711
+ href?: string;
1712
+ };
1713
+ prev?: {
1714
+ href?: string;
1715
+ };
1716
+ first: {
1717
+ href?: string;
1718
+ };
1719
+ last: {
1720
+ href?: string;
1721
+ };
1722
+ pages: {
1723
+ [key: string]: {
1724
+ href?: string;
1725
+ };
1726
+ };
1727
+ };
1728
+ totalCount?: number;
1729
+ };
1730
+ };
1731
+ };
1732
+ };
1733
+ 400: {
1734
+ headers: {
1735
+ [name: string]: unknown;
1736
+ };
1737
+ content: {
1738
+ "application/json": {
1739
+ code: string;
1740
+ detail: string;
1741
+ requestId: string;
1742
+ name: string;
1743
+ validation?: {
1744
+ fieldName: string;
1745
+ message: string;
1746
+ }[];
1747
+ validationContext?: string;
1748
+ };
1749
+ };
1750
+ };
1751
+ 404: {
1752
+ headers: {
1753
+ [name: string]: unknown;
1754
+ };
1755
+ content: {
1756
+ "application/json": {
1757
+ code: string;
1758
+ detail: string;
1759
+ requestId: string;
1760
+ name: string;
1761
+ validation?: {
1762
+ fieldName: string;
1763
+ message: string;
1764
+ }[];
1765
+ validationContext?: string;
1766
+ };
1767
+ };
1768
+ };
1769
+ 500: {
1770
+ headers: {
1771
+ [name: string]: unknown;
1772
+ };
1773
+ content: {
1774
+ "application/json": {
1775
+ code: string;
1776
+ detail: string;
1777
+ requestId: string;
1778
+ name: string;
1779
+ validation?: {
1780
+ fieldName: string;
1781
+ message: string;
1782
+ }[];
1783
+ validationContext?: string;
1784
+ };
1785
+ };
1786
+ };
1787
+ };
1788
+ }, {
1789
+ params: {
1790
+ path: {
1791
+ organisationSettingId: string;
1792
+ };
1793
+ };
1794
+ }>>;
1795
+ updateOrganisationSettings(organisationSettingId: string, body: paths["/api/v1/organisation-settings/{organisationSettingId}"]["patch"]["requestBody"]["content"]["application/json"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1796
+ parameters: {
1797
+ query?: never;
1798
+ header?: never;
1799
+ path: {
1800
+ organisationSettingId: string;
1801
+ };
1802
+ cookie?: never;
1803
+ };
1804
+ requestBody: {
1805
+ content: {
1806
+ "application/json": {
1807
+ invitationStatusFeedback: "accepted" | "declined";
1808
+ preferredTransports: ("sms" | "email")[];
1809
+ };
1810
+ };
1811
+ };
1812
+ responses: {
1813
+ 202: {
1814
+ headers: {
1815
+ [name: string]: unknown;
1816
+ };
1817
+ content: {
1818
+ "application/json": {
1819
+ data: {
1820
+ id: string;
1821
+ userId: string;
1822
+ userProfileId: null | string;
1823
+ phoneNumber: null | string;
1824
+ emailAddress: null | string;
1825
+ organisationId: string;
1826
+ organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
1827
+ organisationInvitationSentAt?: string;
1828
+ organisationInvitationFeedbackAt?: string;
1829
+ organisationPreferredTransports: ("sms" | "email")[];
1830
+ correlationQuality: "full" | "partial" | "not_related";
1831
+ userStatus: "to_be_invited" | "pending" | "disabled" | "active";
1832
+ details?: {
1833
+ publicIdentityId: null | string;
1834
+ firstName: null | string;
1835
+ lastName: null | string;
1836
+ birthDate: null | string;
1837
+ address: {
1838
+ city: null | string;
1839
+ zipCode: null | string;
1840
+ street: null | string;
1841
+ country: null | string;
1842
+ region: null | string;
1843
+ } | null;
1844
+ collectedConsent: boolean;
1845
+ welcomed: boolean;
1846
+ };
1847
+ };
1848
+ metadata?: {
1849
+ links?: {
1850
+ self: {
1851
+ href?: string;
1852
+ };
1853
+ next?: {
1854
+ href?: string;
1855
+ };
1856
+ prev?: {
1857
+ href?: string;
1858
+ };
1859
+ first: {
1860
+ href?: string;
1861
+ };
1862
+ last: {
1863
+ href?: string;
1864
+ };
1865
+ pages: {
1866
+ [key: string]: {
1867
+ href?: string;
1868
+ };
1869
+ };
1870
+ };
1871
+ totalCount?: number;
1872
+ };
1873
+ };
1874
+ };
1875
+ };
1876
+ 400: {
1877
+ headers: {
1878
+ [name: string]: unknown;
1879
+ };
1880
+ content: {
1881
+ "application/json": {
1882
+ code: string;
1883
+ detail: string;
1884
+ requestId: string;
1885
+ name: string;
1886
+ validation?: {
1887
+ fieldName: string;
1888
+ message: string;
1889
+ }[];
1890
+ validationContext?: string;
1891
+ };
1892
+ };
1893
+ };
1894
+ 404: {
1895
+ headers: {
1896
+ [name: string]: unknown;
1897
+ };
1898
+ content: {
1899
+ "application/json": {
1900
+ code: string;
1901
+ detail: string;
1902
+ requestId: string;
1903
+ name: string;
1904
+ validation?: {
1905
+ fieldName: string;
1906
+ message: string;
1907
+ }[];
1908
+ validationContext?: string;
1909
+ };
1910
+ };
1911
+ };
1912
+ 500: {
1913
+ headers: {
1914
+ [name: string]: unknown;
1915
+ };
1916
+ content: {
1917
+ "application/json": {
1918
+ code: string;
1919
+ detail: string;
1920
+ requestId: string;
1921
+ name: string;
1922
+ validation?: {
1923
+ fieldName: string;
1924
+ message: string;
1925
+ }[];
1926
+ validationContext?: string;
1927
+ };
1928
+ };
1929
+ };
1930
+ };
1931
+ }, {
1932
+ body: {
1933
+ invitationStatusFeedback: "accepted" | "declined";
1934
+ preferredTransports: ("sms" | "email")[];
1935
+ };
1936
+ params: {
1937
+ path: {
1938
+ organisationSettingId: string;
1939
+ };
1940
+ };
1941
+ }>>;
1942
+ getMessageEvents(params: {
1943
+ search?: string;
1944
+ } & PaginationParams): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1945
+ parameters: {
1946
+ query?: {
1947
+ search?: string;
1948
+ offset?: string;
1949
+ limit?: string;
1950
+ };
1951
+ header?: never;
1952
+ path?: never;
1953
+ cookie?: never;
1954
+ };
1955
+ requestBody?: never;
1956
+ responses: {
1957
+ 200: {
1958
+ headers: {
1959
+ [name: string]: unknown;
1960
+ };
1961
+ content: {
1962
+ "application/json": {
1963
+ data: {
1964
+ id: string;
1965
+ messageId: string;
1966
+ subject: string;
1967
+ receiverFullName: string;
1968
+ eventType: string;
1969
+ eventStatus: string;
1970
+ scheduledAt: string;
1971
+ }[];
1972
+ metadata?: {
1973
+ links?: {
1974
+ self: {
1975
+ href?: string;
1976
+ };
1977
+ next?: {
1978
+ href?: string;
1979
+ };
1980
+ prev?: {
1981
+ href?: string;
1982
+ };
1983
+ first: {
1984
+ href?: string;
1985
+ };
1986
+ last: {
1987
+ href?: string;
1988
+ };
1989
+ pages: {
1990
+ [key: string]: {
1991
+ href?: string;
1992
+ };
1993
+ };
1994
+ };
1995
+ totalCount?: number;
1996
+ };
1997
+ };
1998
+ };
1999
+ };
2000
+ "5XX": {
2001
+ headers: {
2002
+ [name: string]: unknown;
2003
+ };
2004
+ content: {
2005
+ "application/json": {
2006
+ code: string;
2007
+ detail: string;
2008
+ requestId: string;
2009
+ name: string;
2010
+ validation?: {
2011
+ fieldName: string;
2012
+ message: string;
2013
+ }[];
2014
+ validationContext?: string;
2015
+ };
2016
+ };
2017
+ };
2018
+ "4XX": {
2019
+ headers: {
2020
+ [name: string]: unknown;
2021
+ };
2022
+ content: {
2023
+ "application/json": {
2024
+ code: string;
2025
+ detail: string;
2026
+ requestId: string;
2027
+ name: string;
2028
+ validation?: {
2029
+ fieldName: string;
2030
+ message: string;
2031
+ }[];
2032
+ validationContext?: string;
2033
+ };
2034
+ };
2035
+ };
2036
+ };
2037
+ }, {
2038
+ params: {
2039
+ query: {
2040
+ offset?: string;
2041
+ limit?: string;
2042
+ search: string | undefined;
2043
+ };
2044
+ };
2045
+ }>>;
2046
+ getMessageEvent(eventId: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2047
+ parameters: {
2048
+ query?: never;
2049
+ header?: never;
2050
+ path: {
2051
+ eventId: string;
2052
+ };
2053
+ cookie?: never;
2054
+ };
2055
+ requestBody?: never;
2056
+ responses: {
2057
+ 200: {
2058
+ headers: {
2059
+ [name: string]: unknown;
2060
+ };
2061
+ content: {
2062
+ "application/json": {
2063
+ data: {
2064
+ eventType: string;
2065
+ eventStatus: string;
2066
+ data: {
2067
+ messageId: string;
2068
+ receiverFullName: string;
2069
+ receiverPPSN: string;
2070
+ receiverUserId: string;
2071
+ subject: string;
2072
+ language: string;
2073
+ excerpt: string;
2074
+ richText: string;
2075
+ plainText: string;
2076
+ threadName: string;
2077
+ transports: string[];
2078
+ scheduledAt: string;
2079
+ senderUserId?: string;
2080
+ senderFullName?: string;
2081
+ senderPPSN?: string;
2082
+ senderApplicationId?: string;
2083
+ organisationName: string;
2084
+ security: "confidential" | "public";
2085
+ bypassConsent: boolean;
2086
+ } | {
2087
+ messageId: string;
2088
+ jobId: string;
2089
+ } | {
2090
+ messageId: string;
2091
+ };
2092
+ createdAt: string;
2093
+ }[];
2094
+ };
2095
+ };
2096
+ };
2097
+ "5XX": {
2098
+ headers: {
2099
+ [name: string]: unknown;
2100
+ };
2101
+ content: {
2102
+ "application/json": {
2103
+ code: string;
2104
+ detail: string;
2105
+ requestId: string;
2106
+ name: string;
2107
+ validation?: {
2108
+ fieldName: string;
2109
+ message: string;
2110
+ }[];
2111
+ validationContext?: string;
2112
+ };
2113
+ };
2114
+ };
2115
+ "4XX": {
2116
+ headers: {
2117
+ [name: string]: unknown;
2118
+ };
2119
+ content: {
2120
+ "application/json": {
2121
+ code: string;
2122
+ detail: string;
2123
+ requestId: string;
2124
+ name: string;
2125
+ validation?: {
2126
+ fieldName: string;
2127
+ message: string;
2128
+ }[];
2129
+ validationContext?: string;
2130
+ };
2131
+ };
2132
+ };
2133
+ };
2134
+ }, {
2135
+ params: {
2136
+ path: {
2137
+ eventId: string;
2138
+ };
2139
+ };
2140
+ }>>;
2141
+ getUsers(query?: paths["/api/v1/users/"]["get"]["parameters"]["query"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2142
+ parameters: {
2143
+ query?: {
2144
+ search?: string;
2145
+ transports?: string;
2146
+ importId?: string;
2147
+ activeOnly?: string;
2148
+ offset?: string;
2149
+ limit?: string;
2150
+ };
2151
+ header?: never;
2152
+ path?: never;
2153
+ cookie?: never;
2154
+ };
2155
+ requestBody?: never;
2156
+ responses: {
2157
+ 200: {
2158
+ headers: {
2159
+ [name: string]: unknown;
2160
+ };
2161
+ content: {
2162
+ "application/json": {
2163
+ data: {
2164
+ organisationSettingId: string;
2165
+ firstName: null | string;
2166
+ lastName: null | string;
2167
+ birthDate: null | string;
2168
+ lang: null | string;
2169
+ ppsn: null | string;
2170
+ id: string;
2171
+ userProfileId: null | string;
2172
+ phoneNumber: null | string;
2173
+ emailAddress: null | string;
2174
+ organisationId: string;
2175
+ organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
2176
+ organisationInvitationSentAt?: string;
2177
+ organisationInvitationFeedbackAt?: string;
2178
+ organisationPreferredTransports: ("sms" | "email")[];
2179
+ correlationQuality: "full" | "partial" | "not_related";
2180
+ userStatus: "to_be_invited" | "pending" | "disabled" | "active";
2181
+ details?: {
2182
+ publicIdentityId: null | string;
2183
+ firstName: null | string;
2184
+ lastName: null | string;
2185
+ birthDate: null | string;
2186
+ address: {
2187
+ city: null | string;
2188
+ zipCode: null | string;
2189
+ street: null | string;
2190
+ country: null | string;
2191
+ region: null | string;
2192
+ } | null;
2193
+ collectedConsent: boolean;
2194
+ welcomed: boolean;
2195
+ };
2196
+ }[];
2197
+ metadata?: {
2198
+ links?: {
2199
+ self: {
2200
+ href?: string;
2201
+ };
2202
+ next?: {
2203
+ href?: string;
2204
+ };
2205
+ prev?: {
2206
+ href?: string;
2207
+ };
2208
+ first: {
2209
+ href?: string;
2210
+ };
2211
+ last: {
2212
+ href?: string;
2213
+ };
2214
+ pages: {
2215
+ [key: string]: {
2216
+ href?: string;
2217
+ };
2218
+ };
2219
+ };
2220
+ totalCount?: number;
2221
+ };
2222
+ };
2223
+ };
2224
+ };
2225
+ "5XX": {
2226
+ headers: {
2227
+ [name: string]: unknown;
2228
+ };
2229
+ content: {
2230
+ "application/json": {
2231
+ code: string;
2232
+ detail: string;
2233
+ requestId: string;
2234
+ name: string;
2235
+ validation?: {
2236
+ fieldName: string;
2237
+ message: string;
2238
+ }[];
2239
+ validationContext?: string;
2240
+ };
2241
+ };
2242
+ };
2243
+ "4XX": {
2244
+ headers: {
2245
+ [name: string]: unknown;
2246
+ };
2247
+ content: {
2248
+ "application/json": {
2249
+ code: string;
2250
+ detail: string;
2251
+ requestId: string;
2252
+ name: string;
2253
+ validation?: {
2254
+ fieldName: string;
2255
+ message: string;
2256
+ }[];
2257
+ validationContext?: string;
2258
+ };
2259
+ };
2260
+ };
2261
+ };
2262
+ }, {
2263
+ params: {
2264
+ query: {
2265
+ offset?: string;
2266
+ limit?: string;
2267
+ search?: string;
2268
+ transports?: string;
2269
+ importId?: string;
2270
+ activeOnly?: string;
2271
+ };
2272
+ };
2273
+ }>>;
2274
+ getUser(userId: paths["/api/v1/users/{userId}"]["get"]["parameters"]["path"]["userId"], activeOnly: boolean): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2275
+ parameters: {
2276
+ query?: {
2277
+ activeOnly?: string;
2278
+ };
2279
+ header?: never;
2280
+ path: {
2281
+ userId: string;
2282
+ };
2283
+ cookie?: never;
2284
+ };
2285
+ requestBody?: never;
2286
+ responses: {
2287
+ 200: {
2288
+ headers: {
2289
+ [name: string]: unknown;
2290
+ };
2291
+ content: {
2292
+ "application/json": {
2293
+ data: {
2294
+ organisationSettingId: string;
2295
+ firstName: null | string;
2296
+ lastName: null | string;
2297
+ birthDate: null | string;
2298
+ lang: null | string;
2299
+ ppsn: null | string;
2300
+ id: string;
2301
+ userProfileId: null | string;
2302
+ phoneNumber: null | string;
2303
+ emailAddress: null | string;
2304
+ organisationId: string;
2305
+ organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
2306
+ organisationInvitationSentAt?: string;
2307
+ organisationInvitationFeedbackAt?: string;
2308
+ organisationPreferredTransports: ("sms" | "email")[];
2309
+ correlationQuality: "full" | "partial" | "not_related";
2310
+ userStatus: "to_be_invited" | "pending" | "disabled" | "active";
2311
+ details?: {
2312
+ publicIdentityId: null | string;
2313
+ firstName: null | string;
2314
+ lastName: null | string;
2315
+ birthDate: null | string;
2316
+ address: {
2317
+ city: null | string;
2318
+ zipCode: null | string;
2319
+ street: null | string;
2320
+ country: null | string;
2321
+ region: null | string;
2322
+ } | null;
2323
+ collectedConsent: boolean;
2324
+ welcomed: boolean;
2325
+ };
2326
+ };
2327
+ metadata?: {
2328
+ links?: {
2329
+ self: {
2330
+ href?: string;
2331
+ };
2332
+ next?: {
2333
+ href?: string;
2334
+ };
2335
+ prev?: {
2336
+ href?: string;
2337
+ };
2338
+ first: {
2339
+ href?: string;
2340
+ };
2341
+ last: {
2342
+ href?: string;
2343
+ };
2344
+ pages: {
2345
+ [key: string]: {
2346
+ href?: string;
2347
+ };
2348
+ };
2349
+ };
2350
+ totalCount?: number;
2351
+ };
2352
+ };
2353
+ };
2354
+ };
2355
+ "5XX": {
2356
+ headers: {
2357
+ [name: string]: unknown;
2358
+ };
2359
+ content: {
2360
+ "application/json": {
2361
+ code: string;
2362
+ detail: string;
2363
+ requestId: string;
2364
+ name: string;
2365
+ validation?: {
2366
+ fieldName: string;
2367
+ message: string;
2368
+ }[];
2369
+ validationContext?: string;
2370
+ };
2371
+ };
2372
+ };
2373
+ "4XX": {
2374
+ headers: {
2375
+ [name: string]: unknown;
2376
+ };
2377
+ content: {
2378
+ "application/json": {
2379
+ code: string;
2380
+ detail: string;
2381
+ requestId: string;
2382
+ name: string;
2383
+ validation?: {
2384
+ fieldName: string;
2385
+ message: string;
2386
+ }[];
2387
+ validationContext?: string;
2388
+ };
2389
+ };
2390
+ };
2391
+ };
2392
+ }, {
2393
+ params: {
2394
+ path: {
2395
+ userId: string;
2396
+ };
2397
+ query: {
2398
+ activeOnly: string | undefined;
2399
+ };
2400
+ };
2401
+ }>>;
2402
+ seeMessage(messageId: string): Promise<never>;
2403
+ unseeMessage(messageId: string): Promise<never>;
2404
+ newInterpolator(interpolations: Record<string, string>): (acc: string, key: string) => string;
2405
+ }
2406
+ export default Messaging;
2407
+ //# sourceMappingURL=index.d.ts.map