@ogcio/building-blocks-sdk 0.1.11 → 0.1.13

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.
@@ -68,7 +68,25 @@ export declare class Messaging extends BaseClient<paths> {
68
68
  };
69
69
  };
70
70
  };
71
- 400: {
71
+ "4XX": {
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
+ "5XX": {
72
90
  headers: {
73
91
  [name: string]: unknown;
74
92
  };
@@ -159,7 +177,25 @@ export declare class Messaging extends BaseClient<paths> {
159
177
  };
160
178
  };
161
179
  };
162
- 400: {
180
+ "4XX": {
181
+ headers: {
182
+ [name: string]: unknown;
183
+ };
184
+ content: {
185
+ "application/json": {
186
+ code: string;
187
+ detail: string;
188
+ requestId: string;
189
+ name: string;
190
+ validation?: {
191
+ fieldName: string;
192
+ message: string;
193
+ }[];
194
+ validationContext?: string;
195
+ };
196
+ };
197
+ };
198
+ "5XX": {
163
199
  headers: {
164
200
  [name: string]: unknown;
165
201
  };
@@ -326,6 +362,31 @@ export declare class Messaging extends BaseClient<paths> {
326
362
  data: {
327
363
  id: string;
328
364
  };
365
+ metadata?: {
366
+ links?: {
367
+ self: {
368
+ href?: string;
369
+ };
370
+ next?: {
371
+ href?: string;
372
+ };
373
+ prev?: {
374
+ href?: string;
375
+ };
376
+ first: {
377
+ href?: string;
378
+ };
379
+ last: {
380
+ href?: string;
381
+ };
382
+ pages: {
383
+ [key: string]: {
384
+ href?: string;
385
+ };
386
+ };
387
+ };
388
+ totalCount?: number;
389
+ };
329
390
  };
330
391
  };
331
392
  };
@@ -626,6 +687,31 @@ export declare class Messaging extends BaseClient<paths> {
626
687
  data: {
627
688
  id: string;
628
689
  };
690
+ metadata?: {
691
+ links?: {
692
+ self: {
693
+ href?: string;
694
+ };
695
+ next?: {
696
+ href?: string;
697
+ };
698
+ prev?: {
699
+ href?: string;
700
+ };
701
+ first: {
702
+ href?: string;
703
+ };
704
+ last: {
705
+ href?: string;
706
+ };
707
+ pages: {
708
+ [key: string]: {
709
+ href?: string;
710
+ };
711
+ };
712
+ };
713
+ totalCount?: number;
714
+ };
629
715
  };
630
716
  };
631
717
  };
@@ -681,12 +767,34 @@ export declare class Messaging extends BaseClient<paths> {
681
767
  }[];
682
768
  };
683
769
  }>>;
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: import("openapi-typescript-helpers").ErrorResponse<{
770
+ updateTemplate(templateId: paths["/api/v1/templates/{templateId}"]["put"]["parameters"]["path"]["templateId"], body: paths["/api/v1/templates/{templateId}"]["put"]["requestBody"]["content"]["application/json"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
771
+ parameters: {
772
+ query?: never;
773
+ header?: never;
774
+ path: {
775
+ templateId: string;
776
+ };
777
+ cookie?: never;
778
+ };
779
+ requestBody: {
780
+ content: {
781
+ "application/json": {
782
+ id: string;
783
+ contents: {
784
+ templateName: string;
785
+ language: "en" | "ga";
786
+ subject: string;
787
+ excerpt: string;
788
+ plainText: string;
789
+ richText: string;
790
+ }[];
791
+ variables?: {
792
+ name: string;
793
+ }[];
794
+ };
795
+ };
796
+ };
797
+ responses: {
690
798
  200: {
691
799
  headers: {
692
800
  [name: string]: unknown;
@@ -695,10 +803,7 @@ export declare class Messaging extends BaseClient<paths> {
695
803
  "application/json": {
696
804
  data: {
697
805
  id: string;
698
- providerName: string;
699
- isPrimary: boolean;
700
- type: "sms" | "email";
701
- }[];
806
+ };
702
807
  metadata?: {
703
808
  links?: {
704
809
  self: {
@@ -727,7 +832,7 @@ export declare class Messaging extends BaseClient<paths> {
727
832
  };
728
833
  };
729
834
  };
730
- "5XX": {
835
+ "4XX": {
731
836
  headers: {
732
837
  [name: string]: unknown;
733
838
  };
@@ -745,7 +850,7 @@ export declare class Messaging extends BaseClient<paths> {
745
850
  };
746
851
  };
747
852
  };
748
- "4XX": {
853
+ "5XX": {
749
854
  headers: {
750
855
  [name: string]: unknown;
751
856
  };
@@ -763,30 +868,39 @@ export declare class Messaging extends BaseClient<paths> {
763
868
  };
764
869
  };
765
870
  };
766
- }, `${string}/${string}`> | undefined;
767
- data: {
768
- id: string;
769
- providerName: string;
770
- isPrimary: boolean;
771
- }[] | undefined;
772
- }>;
773
- getEmailProvider(providerId: string): Promise<{
774
- data: {
871
+ };
872
+ }, {
873
+ params: {
874
+ path: {
875
+ templateId: string;
876
+ };
877
+ };
878
+ body: {
775
879
  id: string;
776
- providerName: string;
777
- isPrimary: boolean;
778
- type: "email";
779
- smtpHost: string;
780
- smtpPort: number;
781
- username: string;
782
- password: string;
783
- throttle?: number;
784
- fromAddress: string;
785
- ssl: boolean;
880
+ contents: {
881
+ templateName: string;
882
+ language: "en" | "ga";
883
+ subject: string;
884
+ excerpt: string;
885
+ plainText: string;
886
+ richText: string;
887
+ }[];
888
+ variables?: {
889
+ name: string;
890
+ }[];
786
891
  };
787
- error?: undefined;
788
- } | {
789
- error: import("openapi-typescript-helpers").ErrorResponse<{
892
+ }>>;
893
+ deleteTemplate(templateId: paths["/api/v1/templates/{templateId}"]["delete"]["parameters"]["path"]["templateId"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
894
+ parameters: {
895
+ query?: never;
896
+ header?: never;
897
+ path: {
898
+ templateId: string;
899
+ };
900
+ cookie?: never;
901
+ };
902
+ requestBody?: never;
903
+ responses: {
790
904
  200: {
791
905
  headers: {
792
906
  [name: string]: unknown;
@@ -795,27 +909,6 @@ export declare class Messaging extends BaseClient<paths> {
795
909
  "application/json": {
796
910
  data: {
797
911
  id: string;
798
- providerName: string;
799
- isPrimary: boolean;
800
- type: "email";
801
- smtpHost: string;
802
- smtpPort: number;
803
- username: string;
804
- password: string;
805
- throttle?: number;
806
- fromAddress: string;
807
- ssl: boolean;
808
- } | {
809
- id: string;
810
- providerName: string;
811
- isPrimary: boolean;
812
- type: "sms";
813
- config: {
814
- type: "AWS";
815
- accessKey: string;
816
- secretAccessKey: string;
817
- region: string;
818
- };
819
912
  };
820
913
  metadata?: {
821
914
  links?: {
@@ -845,7 +938,7 @@ export declare class Messaging extends BaseClient<paths> {
845
938
  };
846
939
  };
847
940
  };
848
- "5XX": {
941
+ "4XX": {
849
942
  headers: {
850
943
  [name: string]: unknown;
851
944
  };
@@ -863,7 +956,7 @@ export declare class Messaging extends BaseClient<paths> {
863
956
  };
864
957
  };
865
958
  };
866
- "4XX": {
959
+ "5XX": {
867
960
  headers: {
868
961
  [name: string]: unknown;
869
962
  };
@@ -881,200 +974,15 @@ export declare class Messaging extends BaseClient<paths> {
881
974
  };
882
975
  };
883
976
  };
884
- }, `${string}/${string}`> | undefined;
885
- data?: undefined;
886
- }>;
887
- createEmailProvider(provider: {
888
- providerName: string;
889
- isPrimary: boolean;
890
- smtpHost: string;
891
- smtpPort: number;
892
- username: string;
893
- password: string;
894
- throttle?: number;
895
- fromAddress: string;
896
- ssl: boolean;
897
- }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
898
- parameters: {
899
- query?: never;
900
- header?: never;
901
- path?: never;
902
- cookie?: never;
903
977
  };
904
- requestBody?: {
905
- content: {
906
- "application/json": {
907
- providerName: string;
908
- isPrimary: boolean;
909
- type: "email";
910
- smtpHost: string;
911
- smtpPort: number;
912
- username: string;
913
- password: string;
914
- throttle?: number;
915
- fromAddress: string;
916
- ssl: boolean;
917
- } | {
918
- providerName: string;
919
- isPrimary: boolean;
920
- type: "sms";
921
- config: {
922
- type: "AWS";
923
- accessKey: string;
924
- secretAccessKey: string;
925
- region: string;
926
- };
927
- };
978
+ }, {
979
+ params: {
980
+ path: {
981
+ templateId: string;
928
982
  };
929
983
  };
930
- responses: {
931
- 200: {
932
- headers: {
933
- [name: string]: unknown;
934
- };
935
- content: {
936
- "application/json": {
937
- data: {
938
- id: string;
939
- };
940
- };
941
- };
942
- };
943
- "5XX": {
944
- headers: {
945
- [name: string]: unknown;
946
- };
947
- content: {
948
- "application/json": {
949
- code: string;
950
- detail: string;
951
- requestId: string;
952
- name: string;
953
- validation?: {
954
- fieldName: string;
955
- message: string;
956
- }[];
957
- validationContext?: string;
958
- };
959
- };
960
- };
961
- "4XX": {
962
- headers: {
963
- [name: string]: unknown;
964
- };
965
- content: {
966
- "application/json": {
967
- code: string;
968
- detail: string;
969
- requestId: string;
970
- name: string;
971
- validation?: {
972
- fieldName: string;
973
- message: string;
974
- }[];
975
- validationContext?: string;
976
- };
977
- };
978
- };
979
- };
980
- }, import("openapi-fetch").FetchOptions<{
981
- parameters: {
982
- query?: never;
983
- header?: never;
984
- path?: never;
985
- cookie?: never;
986
- };
987
- requestBody?: {
988
- content: {
989
- "application/json": {
990
- providerName: string;
991
- isPrimary: boolean;
992
- type: "email";
993
- smtpHost: string;
994
- smtpPort: number;
995
- username: string;
996
- password: string;
997
- throttle?: number;
998
- fromAddress: string;
999
- ssl: boolean;
1000
- } | {
1001
- providerName: string;
1002
- isPrimary: boolean;
1003
- type: "sms";
1004
- config: {
1005
- type: "AWS";
1006
- accessKey: string;
1007
- secretAccessKey: string;
1008
- region: string;
1009
- };
1010
- };
1011
- };
1012
- };
1013
- responses: {
1014
- 200: {
1015
- headers: {
1016
- [name: string]: unknown;
1017
- };
1018
- content: {
1019
- "application/json": {
1020
- data: {
1021
- id: string;
1022
- };
1023
- };
1024
- };
1025
- };
1026
- "5XX": {
1027
- headers: {
1028
- [name: string]: unknown;
1029
- };
1030
- content: {
1031
- "application/json": {
1032
- code: string;
1033
- detail: string;
1034
- requestId: string;
1035
- name: string;
1036
- validation?: {
1037
- fieldName: string;
1038
- message: string;
1039
- }[];
1040
- validationContext?: string;
1041
- };
1042
- };
1043
- };
1044
- "4XX": {
1045
- headers: {
1046
- [name: string]: unknown;
1047
- };
1048
- content: {
1049
- "application/json": {
1050
- code: string;
1051
- detail: string;
1052
- requestId: string;
1053
- name: string;
1054
- validation?: {
1055
- fieldName: string;
1056
- message: string;
1057
- }[];
1058
- validationContext?: string;
1059
- };
1060
- };
1061
- };
1062
- };
1063
- }> | undefined>>;
1064
- updateEmailProvider(provider: {
1065
- id: string;
1066
- providerName: string;
1067
- isPrimary: boolean;
1068
- smtpHost: string;
1069
- smtpPort: number;
1070
- username: string;
1071
- password: string;
1072
- throttle?: number;
1073
- fromAddress: string;
1074
- ssl: boolean;
1075
- }): Promise<never>;
1076
- deleteEmailProvider(providerId: string): Promise<never>;
1077
- getSmsProviders(params?: {
984
+ }>>;
985
+ getEmailProviders(params?: {
1078
986
  primary?: boolean;
1079
987
  } & PaginationParams): Promise<{
1080
988
  error: import("openapi-typescript-helpers").ErrorResponse<{
@@ -1161,18 +1069,19 @@ export declare class Messaging extends BaseClient<paths> {
1161
1069
  isPrimary: boolean;
1162
1070
  }[] | undefined;
1163
1071
  }>;
1164
- getSmsProvider(providerId: string): Promise<{
1072
+ getEmailProvider(providerId: string): Promise<{
1165
1073
  data: {
1166
1074
  id: string;
1167
1075
  providerName: string;
1168
1076
  isPrimary: boolean;
1169
- type: "sms";
1170
- config: {
1171
- type: "AWS";
1172
- accessKey: string;
1173
- secretAccessKey: string;
1174
- region: string;
1175
- };
1077
+ type: "email";
1078
+ smtpHost: string;
1079
+ smtpPort: number;
1080
+ username: string;
1081
+ password: string;
1082
+ throttle?: number;
1083
+ fromAddress: string;
1084
+ ssl: boolean;
1176
1085
  };
1177
1086
  error?: undefined;
1178
1087
  } | {
@@ -1274,26 +1183,16 @@ export declare class Messaging extends BaseClient<paths> {
1274
1183
  }, `${string}/${string}`> | undefined;
1275
1184
  data?: undefined;
1276
1185
  }>;
1277
- updateSmsProvider(provider: {
1278
- id: string;
1279
- providerName: string;
1280
- isPrimary: boolean;
1281
- config: {
1282
- type: "AWS";
1283
- accessKey: string;
1284
- secretAccessKey: string;
1285
- region: string;
1286
- };
1287
- }): Promise<never>;
1288
- createSmsProvider(provider: {
1186
+ createEmailProvider(provider: {
1289
1187
  providerName: string;
1290
1188
  isPrimary: boolean;
1291
- config: {
1292
- type: "AWS";
1293
- accessKey: string;
1294
- secretAccessKey: string;
1295
- region: string;
1296
- };
1189
+ smtpHost: string;
1190
+ smtpPort: number;
1191
+ username: string;
1192
+ password: string;
1193
+ throttle?: number;
1194
+ fromAddress: string;
1195
+ ssl: boolean;
1297
1196
  }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1298
1197
  parameters: {
1299
1198
  query?: never;
@@ -1328,7 +1227,7 @@ export declare class Messaging extends BaseClient<paths> {
1328
1227
  };
1329
1228
  };
1330
1229
  responses: {
1331
- 200: {
1230
+ 201: {
1332
1231
  headers: {
1333
1232
  [name: string]: unknown;
1334
1233
  };
@@ -1337,6 +1236,31 @@ export declare class Messaging extends BaseClient<paths> {
1337
1236
  data: {
1338
1237
  id: string;
1339
1238
  };
1239
+ metadata?: {
1240
+ links?: {
1241
+ self: {
1242
+ href?: string;
1243
+ };
1244
+ next?: {
1245
+ href?: string;
1246
+ };
1247
+ prev?: {
1248
+ href?: string;
1249
+ };
1250
+ first: {
1251
+ href?: string;
1252
+ };
1253
+ last: {
1254
+ href?: string;
1255
+ };
1256
+ pages: {
1257
+ [key: string]: {
1258
+ href?: string;
1259
+ };
1260
+ };
1261
+ };
1262
+ totalCount?: number;
1263
+ };
1340
1264
  };
1341
1265
  };
1342
1266
  };
@@ -1411,7 +1335,7 @@ export declare class Messaging extends BaseClient<paths> {
1411
1335
  };
1412
1336
  };
1413
1337
  responses: {
1414
- 200: {
1338
+ 201: {
1415
1339
  headers: {
1416
1340
  [name: string]: unknown;
1417
1341
  };
@@ -1420,6 +1344,31 @@ export declare class Messaging extends BaseClient<paths> {
1420
1344
  data: {
1421
1345
  id: string;
1422
1346
  };
1347
+ metadata?: {
1348
+ links?: {
1349
+ self: {
1350
+ href?: string;
1351
+ };
1352
+ next?: {
1353
+ href?: string;
1354
+ };
1355
+ prev?: {
1356
+ href?: string;
1357
+ };
1358
+ first: {
1359
+ href?: string;
1360
+ };
1361
+ last: {
1362
+ href?: string;
1363
+ };
1364
+ pages: {
1365
+ [key: string]: {
1366
+ href?: string;
1367
+ };
1368
+ };
1369
+ };
1370
+ totalCount?: number;
1371
+ };
1423
1372
  };
1424
1373
  };
1425
1374
  };
@@ -1461,7 +1410,1087 @@ export declare class Messaging extends BaseClient<paths> {
1461
1410
  };
1462
1411
  };
1463
1412
  }> | undefined>>;
1464
- deleteSmsProvider(providerId: string): Promise<never>;
1413
+ updateEmailProvider(provider: {
1414
+ id: string;
1415
+ providerName: string;
1416
+ isPrimary: boolean;
1417
+ smtpHost: string;
1418
+ smtpPort: number;
1419
+ username: string;
1420
+ password: string;
1421
+ throttle?: number;
1422
+ fromAddress: string;
1423
+ ssl: boolean;
1424
+ }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1425
+ parameters: {
1426
+ query?: never;
1427
+ header?: never;
1428
+ path: {
1429
+ providerId: string;
1430
+ };
1431
+ cookie?: never;
1432
+ };
1433
+ requestBody?: {
1434
+ content: {
1435
+ "application/json": {
1436
+ id: string;
1437
+ providerName: string;
1438
+ isPrimary: boolean;
1439
+ type: "email";
1440
+ smtpHost: string;
1441
+ smtpPort: number;
1442
+ username: string;
1443
+ password: string;
1444
+ throttle?: number;
1445
+ fromAddress: string;
1446
+ ssl: boolean;
1447
+ } | {
1448
+ id: string;
1449
+ providerName: string;
1450
+ isPrimary: boolean;
1451
+ type: "sms";
1452
+ config: {
1453
+ type: "AWS";
1454
+ accessKey: string;
1455
+ secretAccessKey: string;
1456
+ region: string;
1457
+ };
1458
+ };
1459
+ };
1460
+ };
1461
+ responses: {
1462
+ 200: {
1463
+ headers: {
1464
+ [name: string]: unknown;
1465
+ };
1466
+ content: {
1467
+ "application/json": {
1468
+ data: {
1469
+ id: string;
1470
+ };
1471
+ metadata?: {
1472
+ links?: {
1473
+ self: {
1474
+ href?: string;
1475
+ };
1476
+ next?: {
1477
+ href?: string;
1478
+ };
1479
+ prev?: {
1480
+ href?: string;
1481
+ };
1482
+ first: {
1483
+ href?: string;
1484
+ };
1485
+ last: {
1486
+ href?: string;
1487
+ };
1488
+ pages: {
1489
+ [key: string]: {
1490
+ href?: string;
1491
+ };
1492
+ };
1493
+ };
1494
+ totalCount?: number;
1495
+ };
1496
+ };
1497
+ };
1498
+ };
1499
+ "5XX": {
1500
+ headers: {
1501
+ [name: string]: unknown;
1502
+ };
1503
+ content: {
1504
+ "application/json": {
1505
+ code: string;
1506
+ detail: string;
1507
+ requestId: string;
1508
+ name: string;
1509
+ validation?: {
1510
+ fieldName: string;
1511
+ message: string;
1512
+ }[];
1513
+ validationContext?: string;
1514
+ };
1515
+ };
1516
+ };
1517
+ "4XX": {
1518
+ headers: {
1519
+ [name: string]: unknown;
1520
+ };
1521
+ content: {
1522
+ "application/json": {
1523
+ code: string;
1524
+ detail: string;
1525
+ requestId: string;
1526
+ name: string;
1527
+ validation?: {
1528
+ fieldName: string;
1529
+ message: string;
1530
+ }[];
1531
+ validationContext?: string;
1532
+ };
1533
+ };
1534
+ };
1535
+ };
1536
+ }, import("openapi-fetch").FetchOptions<{
1537
+ parameters: {
1538
+ query?: never;
1539
+ header?: never;
1540
+ path: {
1541
+ providerId: string;
1542
+ };
1543
+ cookie?: never;
1544
+ };
1545
+ requestBody?: {
1546
+ content: {
1547
+ "application/json": {
1548
+ id: string;
1549
+ providerName: string;
1550
+ isPrimary: boolean;
1551
+ type: "email";
1552
+ smtpHost: string;
1553
+ smtpPort: number;
1554
+ username: string;
1555
+ password: string;
1556
+ throttle?: number;
1557
+ fromAddress: string;
1558
+ ssl: boolean;
1559
+ } | {
1560
+ id: string;
1561
+ providerName: string;
1562
+ isPrimary: boolean;
1563
+ type: "sms";
1564
+ config: {
1565
+ type: "AWS";
1566
+ accessKey: string;
1567
+ secretAccessKey: string;
1568
+ region: string;
1569
+ };
1570
+ };
1571
+ };
1572
+ };
1573
+ responses: {
1574
+ 200: {
1575
+ headers: {
1576
+ [name: string]: unknown;
1577
+ };
1578
+ content: {
1579
+ "application/json": {
1580
+ data: {
1581
+ id: string;
1582
+ };
1583
+ metadata?: {
1584
+ links?: {
1585
+ self: {
1586
+ href?: string;
1587
+ };
1588
+ next?: {
1589
+ href?: string;
1590
+ };
1591
+ prev?: {
1592
+ href?: string;
1593
+ };
1594
+ first: {
1595
+ href?: string;
1596
+ };
1597
+ last: {
1598
+ href?: string;
1599
+ };
1600
+ pages: {
1601
+ [key: string]: {
1602
+ href?: string;
1603
+ };
1604
+ };
1605
+ };
1606
+ totalCount?: number;
1607
+ };
1608
+ };
1609
+ };
1610
+ };
1611
+ "5XX": {
1612
+ headers: {
1613
+ [name: string]: unknown;
1614
+ };
1615
+ content: {
1616
+ "application/json": {
1617
+ code: string;
1618
+ detail: string;
1619
+ requestId: string;
1620
+ name: string;
1621
+ validation?: {
1622
+ fieldName: string;
1623
+ message: string;
1624
+ }[];
1625
+ validationContext?: string;
1626
+ };
1627
+ };
1628
+ };
1629
+ "4XX": {
1630
+ headers: {
1631
+ [name: string]: unknown;
1632
+ };
1633
+ content: {
1634
+ "application/json": {
1635
+ code: string;
1636
+ detail: string;
1637
+ requestId: string;
1638
+ name: string;
1639
+ validation?: {
1640
+ fieldName: string;
1641
+ message: string;
1642
+ }[];
1643
+ validationContext?: string;
1644
+ };
1645
+ };
1646
+ };
1647
+ };
1648
+ }>>>;
1649
+ deleteEmailProvider(providerId: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1650
+ parameters: {
1651
+ query?: never;
1652
+ header?: never;
1653
+ path: {
1654
+ providerId: string;
1655
+ };
1656
+ cookie?: never;
1657
+ };
1658
+ requestBody?: never;
1659
+ responses: {
1660
+ 200: {
1661
+ headers: {
1662
+ [name: string]: unknown;
1663
+ };
1664
+ content: {
1665
+ "application/json": {
1666
+ data: {
1667
+ id: string;
1668
+ };
1669
+ metadata?: {
1670
+ links?: {
1671
+ self: {
1672
+ href?: string;
1673
+ };
1674
+ next?: {
1675
+ href?: string;
1676
+ };
1677
+ prev?: {
1678
+ href?: string;
1679
+ };
1680
+ first: {
1681
+ href?: string;
1682
+ };
1683
+ last: {
1684
+ href?: string;
1685
+ };
1686
+ pages: {
1687
+ [key: string]: {
1688
+ href?: string;
1689
+ };
1690
+ };
1691
+ };
1692
+ totalCount?: number;
1693
+ };
1694
+ };
1695
+ };
1696
+ };
1697
+ "5XX": {
1698
+ headers: {
1699
+ [name: string]: unknown;
1700
+ };
1701
+ content: {
1702
+ "application/json": {
1703
+ code: string;
1704
+ detail: string;
1705
+ requestId: string;
1706
+ name: string;
1707
+ validation?: {
1708
+ fieldName: string;
1709
+ message: string;
1710
+ }[];
1711
+ validationContext?: string;
1712
+ };
1713
+ };
1714
+ };
1715
+ "4XX": {
1716
+ headers: {
1717
+ [name: string]: unknown;
1718
+ };
1719
+ content: {
1720
+ "application/json": {
1721
+ code: string;
1722
+ detail: string;
1723
+ requestId: string;
1724
+ name: string;
1725
+ validation?: {
1726
+ fieldName: string;
1727
+ message: string;
1728
+ }[];
1729
+ validationContext?: string;
1730
+ };
1731
+ };
1732
+ };
1733
+ };
1734
+ }, {
1735
+ params: {
1736
+ path: {
1737
+ providerId: string;
1738
+ };
1739
+ };
1740
+ }>>;
1741
+ getSmsProviders(params?: {
1742
+ primary?: boolean;
1743
+ } & PaginationParams): Promise<{
1744
+ error: import("openapi-typescript-helpers").ErrorResponse<{
1745
+ 200: {
1746
+ headers: {
1747
+ [name: string]: unknown;
1748
+ };
1749
+ content: {
1750
+ "application/json": {
1751
+ data: {
1752
+ id: string;
1753
+ providerName: string;
1754
+ isPrimary: boolean;
1755
+ type: "sms" | "email";
1756
+ }[];
1757
+ metadata?: {
1758
+ links?: {
1759
+ self: {
1760
+ href?: string;
1761
+ };
1762
+ next?: {
1763
+ href?: string;
1764
+ };
1765
+ prev?: {
1766
+ href?: string;
1767
+ };
1768
+ first: {
1769
+ href?: string;
1770
+ };
1771
+ last: {
1772
+ href?: string;
1773
+ };
1774
+ pages: {
1775
+ [key: string]: {
1776
+ href?: string;
1777
+ };
1778
+ };
1779
+ };
1780
+ totalCount?: number;
1781
+ };
1782
+ };
1783
+ };
1784
+ };
1785
+ "5XX": {
1786
+ headers: {
1787
+ [name: string]: unknown;
1788
+ };
1789
+ content: {
1790
+ "application/json": {
1791
+ code: string;
1792
+ detail: string;
1793
+ requestId: string;
1794
+ name: string;
1795
+ validation?: {
1796
+ fieldName: string;
1797
+ message: string;
1798
+ }[];
1799
+ validationContext?: string;
1800
+ };
1801
+ };
1802
+ };
1803
+ "4XX": {
1804
+ headers: {
1805
+ [name: string]: unknown;
1806
+ };
1807
+ content: {
1808
+ "application/json": {
1809
+ code: string;
1810
+ detail: string;
1811
+ requestId: string;
1812
+ name: string;
1813
+ validation?: {
1814
+ fieldName: string;
1815
+ message: string;
1816
+ }[];
1817
+ validationContext?: string;
1818
+ };
1819
+ };
1820
+ };
1821
+ }, `${string}/${string}`> | undefined;
1822
+ data: {
1823
+ id: string;
1824
+ providerName: string;
1825
+ isPrimary: boolean;
1826
+ }[] | undefined;
1827
+ }>;
1828
+ getSmsProvider(providerId: string): Promise<{
1829
+ data: {
1830
+ id: string;
1831
+ providerName: string;
1832
+ isPrimary: boolean;
1833
+ type: "sms";
1834
+ config: {
1835
+ type: "AWS";
1836
+ accessKey: string;
1837
+ secretAccessKey: string;
1838
+ region: string;
1839
+ };
1840
+ };
1841
+ error?: undefined;
1842
+ } | {
1843
+ error: import("openapi-typescript-helpers").ErrorResponse<{
1844
+ 200: {
1845
+ headers: {
1846
+ [name: string]: unknown;
1847
+ };
1848
+ content: {
1849
+ "application/json": {
1850
+ data: {
1851
+ id: string;
1852
+ providerName: string;
1853
+ isPrimary: boolean;
1854
+ type: "email";
1855
+ smtpHost: string;
1856
+ smtpPort: number;
1857
+ username: string;
1858
+ password: string;
1859
+ throttle?: number;
1860
+ fromAddress: string;
1861
+ ssl: boolean;
1862
+ } | {
1863
+ id: string;
1864
+ providerName: string;
1865
+ isPrimary: boolean;
1866
+ type: "sms";
1867
+ config: {
1868
+ type: "AWS";
1869
+ accessKey: string;
1870
+ secretAccessKey: string;
1871
+ region: string;
1872
+ };
1873
+ };
1874
+ metadata?: {
1875
+ links?: {
1876
+ self: {
1877
+ href?: string;
1878
+ };
1879
+ next?: {
1880
+ href?: string;
1881
+ };
1882
+ prev?: {
1883
+ href?: string;
1884
+ };
1885
+ first: {
1886
+ href?: string;
1887
+ };
1888
+ last: {
1889
+ href?: string;
1890
+ };
1891
+ pages: {
1892
+ [key: string]: {
1893
+ href?: string;
1894
+ };
1895
+ };
1896
+ };
1897
+ totalCount?: number;
1898
+ };
1899
+ };
1900
+ };
1901
+ };
1902
+ "5XX": {
1903
+ headers: {
1904
+ [name: string]: unknown;
1905
+ };
1906
+ content: {
1907
+ "application/json": {
1908
+ code: string;
1909
+ detail: string;
1910
+ requestId: string;
1911
+ name: string;
1912
+ validation?: {
1913
+ fieldName: string;
1914
+ message: string;
1915
+ }[];
1916
+ validationContext?: string;
1917
+ };
1918
+ };
1919
+ };
1920
+ "4XX": {
1921
+ headers: {
1922
+ [name: string]: unknown;
1923
+ };
1924
+ content: {
1925
+ "application/json": {
1926
+ code: string;
1927
+ detail: string;
1928
+ requestId: string;
1929
+ name: string;
1930
+ validation?: {
1931
+ fieldName: string;
1932
+ message: string;
1933
+ }[];
1934
+ validationContext?: string;
1935
+ };
1936
+ };
1937
+ };
1938
+ }, `${string}/${string}`> | undefined;
1939
+ data?: undefined;
1940
+ }>;
1941
+ updateSmsProvider(provider: {
1942
+ id: string;
1943
+ providerName: string;
1944
+ isPrimary: boolean;
1945
+ config: {
1946
+ type: "AWS";
1947
+ accessKey: string;
1948
+ secretAccessKey: string;
1949
+ region: string;
1950
+ };
1951
+ }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1952
+ parameters: {
1953
+ query?: never;
1954
+ header?: never;
1955
+ path: {
1956
+ providerId: string;
1957
+ };
1958
+ cookie?: never;
1959
+ };
1960
+ requestBody?: {
1961
+ content: {
1962
+ "application/json": {
1963
+ id: string;
1964
+ providerName: string;
1965
+ isPrimary: boolean;
1966
+ type: "email";
1967
+ smtpHost: string;
1968
+ smtpPort: number;
1969
+ username: string;
1970
+ password: string;
1971
+ throttle?: number;
1972
+ fromAddress: string;
1973
+ ssl: boolean;
1974
+ } | {
1975
+ id: string;
1976
+ providerName: string;
1977
+ isPrimary: boolean;
1978
+ type: "sms";
1979
+ config: {
1980
+ type: "AWS";
1981
+ accessKey: string;
1982
+ secretAccessKey: string;
1983
+ region: string;
1984
+ };
1985
+ };
1986
+ };
1987
+ };
1988
+ responses: {
1989
+ 200: {
1990
+ headers: {
1991
+ [name: string]: unknown;
1992
+ };
1993
+ content: {
1994
+ "application/json": {
1995
+ data: {
1996
+ id: string;
1997
+ };
1998
+ metadata?: {
1999
+ links?: {
2000
+ self: {
2001
+ href?: string;
2002
+ };
2003
+ next?: {
2004
+ href?: string;
2005
+ };
2006
+ prev?: {
2007
+ href?: string;
2008
+ };
2009
+ first: {
2010
+ href?: string;
2011
+ };
2012
+ last: {
2013
+ href?: string;
2014
+ };
2015
+ pages: {
2016
+ [key: string]: {
2017
+ href?: string;
2018
+ };
2019
+ };
2020
+ };
2021
+ totalCount?: number;
2022
+ };
2023
+ };
2024
+ };
2025
+ };
2026
+ "5XX": {
2027
+ headers: {
2028
+ [name: string]: unknown;
2029
+ };
2030
+ content: {
2031
+ "application/json": {
2032
+ code: string;
2033
+ detail: string;
2034
+ requestId: string;
2035
+ name: string;
2036
+ validation?: {
2037
+ fieldName: string;
2038
+ message: string;
2039
+ }[];
2040
+ validationContext?: string;
2041
+ };
2042
+ };
2043
+ };
2044
+ "4XX": {
2045
+ headers: {
2046
+ [name: string]: unknown;
2047
+ };
2048
+ content: {
2049
+ "application/json": {
2050
+ code: string;
2051
+ detail: string;
2052
+ requestId: string;
2053
+ name: string;
2054
+ validation?: {
2055
+ fieldName: string;
2056
+ message: string;
2057
+ }[];
2058
+ validationContext?: string;
2059
+ };
2060
+ };
2061
+ };
2062
+ };
2063
+ }, import("openapi-fetch").FetchOptions<{
2064
+ parameters: {
2065
+ query?: never;
2066
+ header?: never;
2067
+ path: {
2068
+ providerId: string;
2069
+ };
2070
+ cookie?: never;
2071
+ };
2072
+ requestBody?: {
2073
+ content: {
2074
+ "application/json": {
2075
+ id: string;
2076
+ providerName: string;
2077
+ isPrimary: boolean;
2078
+ type: "email";
2079
+ smtpHost: string;
2080
+ smtpPort: number;
2081
+ username: string;
2082
+ password: string;
2083
+ throttle?: number;
2084
+ fromAddress: string;
2085
+ ssl: boolean;
2086
+ } | {
2087
+ id: string;
2088
+ providerName: string;
2089
+ isPrimary: boolean;
2090
+ type: "sms";
2091
+ config: {
2092
+ type: "AWS";
2093
+ accessKey: string;
2094
+ secretAccessKey: string;
2095
+ region: string;
2096
+ };
2097
+ };
2098
+ };
2099
+ };
2100
+ responses: {
2101
+ 200: {
2102
+ headers: {
2103
+ [name: string]: unknown;
2104
+ };
2105
+ content: {
2106
+ "application/json": {
2107
+ data: {
2108
+ id: string;
2109
+ };
2110
+ metadata?: {
2111
+ links?: {
2112
+ self: {
2113
+ href?: string;
2114
+ };
2115
+ next?: {
2116
+ href?: string;
2117
+ };
2118
+ prev?: {
2119
+ href?: string;
2120
+ };
2121
+ first: {
2122
+ href?: string;
2123
+ };
2124
+ last: {
2125
+ href?: string;
2126
+ };
2127
+ pages: {
2128
+ [key: string]: {
2129
+ href?: string;
2130
+ };
2131
+ };
2132
+ };
2133
+ totalCount?: number;
2134
+ };
2135
+ };
2136
+ };
2137
+ };
2138
+ "5XX": {
2139
+ headers: {
2140
+ [name: string]: unknown;
2141
+ };
2142
+ content: {
2143
+ "application/json": {
2144
+ code: string;
2145
+ detail: string;
2146
+ requestId: string;
2147
+ name: string;
2148
+ validation?: {
2149
+ fieldName: string;
2150
+ message: string;
2151
+ }[];
2152
+ validationContext?: string;
2153
+ };
2154
+ };
2155
+ };
2156
+ "4XX": {
2157
+ headers: {
2158
+ [name: string]: unknown;
2159
+ };
2160
+ content: {
2161
+ "application/json": {
2162
+ code: string;
2163
+ detail: string;
2164
+ requestId: string;
2165
+ name: string;
2166
+ validation?: {
2167
+ fieldName: string;
2168
+ message: string;
2169
+ }[];
2170
+ validationContext?: string;
2171
+ };
2172
+ };
2173
+ };
2174
+ };
2175
+ }>>>;
2176
+ createSmsProvider(provider: {
2177
+ providerName: string;
2178
+ isPrimary: boolean;
2179
+ config: {
2180
+ type: "AWS";
2181
+ accessKey: string;
2182
+ secretAccessKey: string;
2183
+ region: string;
2184
+ };
2185
+ }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2186
+ parameters: {
2187
+ query?: never;
2188
+ header?: never;
2189
+ path?: never;
2190
+ cookie?: never;
2191
+ };
2192
+ requestBody?: {
2193
+ content: {
2194
+ "application/json": {
2195
+ providerName: string;
2196
+ isPrimary: boolean;
2197
+ type: "email";
2198
+ smtpHost: string;
2199
+ smtpPort: number;
2200
+ username: string;
2201
+ password: string;
2202
+ throttle?: number;
2203
+ fromAddress: string;
2204
+ ssl: boolean;
2205
+ } | {
2206
+ providerName: string;
2207
+ isPrimary: boolean;
2208
+ type: "sms";
2209
+ config: {
2210
+ type: "AWS";
2211
+ accessKey: string;
2212
+ secretAccessKey: string;
2213
+ region: string;
2214
+ };
2215
+ };
2216
+ };
2217
+ };
2218
+ responses: {
2219
+ 201: {
2220
+ headers: {
2221
+ [name: string]: unknown;
2222
+ };
2223
+ content: {
2224
+ "application/json": {
2225
+ data: {
2226
+ id: string;
2227
+ };
2228
+ metadata?: {
2229
+ links?: {
2230
+ self: {
2231
+ href?: string;
2232
+ };
2233
+ next?: {
2234
+ href?: string;
2235
+ };
2236
+ prev?: {
2237
+ href?: string;
2238
+ };
2239
+ first: {
2240
+ href?: string;
2241
+ };
2242
+ last: {
2243
+ href?: string;
2244
+ };
2245
+ pages: {
2246
+ [key: string]: {
2247
+ href?: string;
2248
+ };
2249
+ };
2250
+ };
2251
+ totalCount?: number;
2252
+ };
2253
+ };
2254
+ };
2255
+ };
2256
+ "5XX": {
2257
+ headers: {
2258
+ [name: string]: unknown;
2259
+ };
2260
+ content: {
2261
+ "application/json": {
2262
+ code: string;
2263
+ detail: string;
2264
+ requestId: string;
2265
+ name: string;
2266
+ validation?: {
2267
+ fieldName: string;
2268
+ message: string;
2269
+ }[];
2270
+ validationContext?: string;
2271
+ };
2272
+ };
2273
+ };
2274
+ "4XX": {
2275
+ headers: {
2276
+ [name: string]: unknown;
2277
+ };
2278
+ content: {
2279
+ "application/json": {
2280
+ code: string;
2281
+ detail: string;
2282
+ requestId: string;
2283
+ name: string;
2284
+ validation?: {
2285
+ fieldName: string;
2286
+ message: string;
2287
+ }[];
2288
+ validationContext?: string;
2289
+ };
2290
+ };
2291
+ };
2292
+ };
2293
+ }, import("openapi-fetch").FetchOptions<{
2294
+ parameters: {
2295
+ query?: never;
2296
+ header?: never;
2297
+ path?: never;
2298
+ cookie?: never;
2299
+ };
2300
+ requestBody?: {
2301
+ content: {
2302
+ "application/json": {
2303
+ providerName: string;
2304
+ isPrimary: boolean;
2305
+ type: "email";
2306
+ smtpHost: string;
2307
+ smtpPort: number;
2308
+ username: string;
2309
+ password: string;
2310
+ throttle?: number;
2311
+ fromAddress: string;
2312
+ ssl: boolean;
2313
+ } | {
2314
+ providerName: string;
2315
+ isPrimary: boolean;
2316
+ type: "sms";
2317
+ config: {
2318
+ type: "AWS";
2319
+ accessKey: string;
2320
+ secretAccessKey: string;
2321
+ region: string;
2322
+ };
2323
+ };
2324
+ };
2325
+ };
2326
+ responses: {
2327
+ 201: {
2328
+ headers: {
2329
+ [name: string]: unknown;
2330
+ };
2331
+ content: {
2332
+ "application/json": {
2333
+ data: {
2334
+ id: string;
2335
+ };
2336
+ metadata?: {
2337
+ links?: {
2338
+ self: {
2339
+ href?: string;
2340
+ };
2341
+ next?: {
2342
+ href?: string;
2343
+ };
2344
+ prev?: {
2345
+ href?: string;
2346
+ };
2347
+ first: {
2348
+ href?: string;
2349
+ };
2350
+ last: {
2351
+ href?: string;
2352
+ };
2353
+ pages: {
2354
+ [key: string]: {
2355
+ href?: string;
2356
+ };
2357
+ };
2358
+ };
2359
+ totalCount?: number;
2360
+ };
2361
+ };
2362
+ };
2363
+ };
2364
+ "5XX": {
2365
+ headers: {
2366
+ [name: string]: unknown;
2367
+ };
2368
+ content: {
2369
+ "application/json": {
2370
+ code: string;
2371
+ detail: string;
2372
+ requestId: string;
2373
+ name: string;
2374
+ validation?: {
2375
+ fieldName: string;
2376
+ message: string;
2377
+ }[];
2378
+ validationContext?: string;
2379
+ };
2380
+ };
2381
+ };
2382
+ "4XX": {
2383
+ headers: {
2384
+ [name: string]: unknown;
2385
+ };
2386
+ content: {
2387
+ "application/json": {
2388
+ code: string;
2389
+ detail: string;
2390
+ requestId: string;
2391
+ name: string;
2392
+ validation?: {
2393
+ fieldName: string;
2394
+ message: string;
2395
+ }[];
2396
+ validationContext?: string;
2397
+ };
2398
+ };
2399
+ };
2400
+ };
2401
+ }> | undefined>>;
2402
+ deleteSmsProvider(providerId: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2403
+ parameters: {
2404
+ query?: never;
2405
+ header?: never;
2406
+ path: {
2407
+ providerId: string;
2408
+ };
2409
+ cookie?: never;
2410
+ };
2411
+ requestBody?: never;
2412
+ responses: {
2413
+ 200: {
2414
+ headers: {
2415
+ [name: string]: unknown;
2416
+ };
2417
+ content: {
2418
+ "application/json": {
2419
+ data: {
2420
+ id: string;
2421
+ };
2422
+ metadata?: {
2423
+ links?: {
2424
+ self: {
2425
+ href?: string;
2426
+ };
2427
+ next?: {
2428
+ href?: string;
2429
+ };
2430
+ prev?: {
2431
+ href?: string;
2432
+ };
2433
+ first: {
2434
+ href?: string;
2435
+ };
2436
+ last: {
2437
+ href?: string;
2438
+ };
2439
+ pages: {
2440
+ [key: string]: {
2441
+ href?: string;
2442
+ };
2443
+ };
2444
+ };
2445
+ totalCount?: number;
2446
+ };
2447
+ };
2448
+ };
2449
+ };
2450
+ "5XX": {
2451
+ headers: {
2452
+ [name: string]: unknown;
2453
+ };
2454
+ content: {
2455
+ "application/json": {
2456
+ code: string;
2457
+ detail: string;
2458
+ requestId: string;
2459
+ name: string;
2460
+ validation?: {
2461
+ fieldName: string;
2462
+ message: string;
2463
+ }[];
2464
+ validationContext?: string;
2465
+ };
2466
+ };
2467
+ };
2468
+ "4XX": {
2469
+ headers: {
2470
+ [name: string]: unknown;
2471
+ };
2472
+ content: {
2473
+ "application/json": {
2474
+ code: string;
2475
+ detail: string;
2476
+ requestId: string;
2477
+ name: string;
2478
+ validation?: {
2479
+ fieldName: string;
2480
+ message: string;
2481
+ }[];
2482
+ validationContext?: string;
2483
+ };
2484
+ };
2485
+ };
2486
+ };
2487
+ }, {
2488
+ params: {
2489
+ path: {
2490
+ providerId: string;
2491
+ };
2492
+ };
2493
+ }>>;
1465
2494
  importUsers(toImport: {
1466
2495
  file?: File;
1467
2496
  records?: object[];