@ogcio/building-blocks-sdk 0.2.71 → 0.2.73
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitleaksignore +10 -1
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +14 -0
- package/dist/client/clients/journey/index.d.ts +106 -7
- package/dist/client/clients/journey/index.d.ts.map +1 -1
- package/dist/client/clients/journey/index.js +11 -0
- package/dist/client/clients/journey/index.js.map +1 -1
- package/dist/client/clients/journey/schema.d.ts +363 -6
- package/dist/client/clients/journey/schema.d.ts.map +1 -1
- package/dist/client/clients/payments/index.d.ts +138 -2
- package/dist/client/clients/payments/index.d.ts.map +1 -1
- package/dist/client/clients/payments/index.js +9 -0
- package/dist/client/clients/payments/index.js.map +1 -1
- package/dist/client/clients/payments/schema.d.ts +206 -4
- package/dist/client/clients/payments/schema.d.ts.map +1 -1
- package/dist/clients-configurations/clients-configuration.json +1 -1
- package/package.json +1 -1
- package/src/client/clients/journey/index.ts +18 -0
- package/src/client/clients/journey/open-api-definition.json +1349 -65
- package/src/client/clients/journey/schema.ts +363 -6
- package/src/client/clients/payments/index.ts +15 -0
- package/src/client/clients/payments/open-api-definition.json +966 -38
- package/src/client/clients/payments/schema.ts +206 -4
- package/src/clients-configurations/clients-configuration.json +1 -1
|
@@ -130,6 +130,27 @@
|
|
|
130
130
|
"name": "search",
|
|
131
131
|
"required": false
|
|
132
132
|
},
|
|
133
|
+
{
|
|
134
|
+
"schema": {
|
|
135
|
+
"anyOf": [
|
|
136
|
+
{
|
|
137
|
+
"type": "string",
|
|
138
|
+
"enum": [
|
|
139
|
+
"active"
|
|
140
|
+
]
|
|
141
|
+
},
|
|
142
|
+
{
|
|
143
|
+
"type": "string",
|
|
144
|
+
"enum": [
|
|
145
|
+
"inactive"
|
|
146
|
+
]
|
|
147
|
+
}
|
|
148
|
+
]
|
|
149
|
+
},
|
|
150
|
+
"in": "query",
|
|
151
|
+
"name": "status",
|
|
152
|
+
"required": false
|
|
153
|
+
},
|
|
133
154
|
{
|
|
134
155
|
"schema": {
|
|
135
156
|
"type": "string"
|
|
@@ -223,7 +244,20 @@
|
|
|
223
244
|
"allowedAuthMethods": {
|
|
224
245
|
"type": "array",
|
|
225
246
|
"items": {
|
|
226
|
-
"
|
|
247
|
+
"anyOf": [
|
|
248
|
+
{
|
|
249
|
+
"type": "string",
|
|
250
|
+
"enum": [
|
|
251
|
+
"email_otp"
|
|
252
|
+
]
|
|
253
|
+
},
|
|
254
|
+
{
|
|
255
|
+
"type": "string",
|
|
256
|
+
"enum": [
|
|
257
|
+
"social:mygovid"
|
|
258
|
+
]
|
|
259
|
+
}
|
|
260
|
+
]
|
|
227
261
|
}
|
|
228
262
|
},
|
|
229
263
|
"userName": {
|
|
@@ -441,7 +475,20 @@
|
|
|
441
475
|
"allowedAuthMethods": {
|
|
442
476
|
"type": "array",
|
|
443
477
|
"items": {
|
|
444
|
-
"
|
|
478
|
+
"anyOf": [
|
|
479
|
+
{
|
|
480
|
+
"type": "string",
|
|
481
|
+
"enum": [
|
|
482
|
+
"email_otp"
|
|
483
|
+
]
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"type": "string",
|
|
487
|
+
"enum": [
|
|
488
|
+
"social:mygovid"
|
|
489
|
+
]
|
|
490
|
+
}
|
|
491
|
+
]
|
|
445
492
|
}
|
|
446
493
|
},
|
|
447
494
|
"organizationId": {
|
|
@@ -457,6 +504,34 @@
|
|
|
457
504
|
"organizationId",
|
|
458
505
|
"userId"
|
|
459
506
|
]
|
|
507
|
+
},
|
|
508
|
+
"examples": {
|
|
509
|
+
"example1": {
|
|
510
|
+
"value": {
|
|
511
|
+
"title": {
|
|
512
|
+
"en": "Test messaging",
|
|
513
|
+
"ga": "Teistphostú"
|
|
514
|
+
},
|
|
515
|
+
"allowedAuthMethods": [
|
|
516
|
+
"email_otp"
|
|
517
|
+
],
|
|
518
|
+
"organizationId": "org_1234567890abcdef",
|
|
519
|
+
"userId": "user_1234567890abcdef"
|
|
520
|
+
}
|
|
521
|
+
},
|
|
522
|
+
"example2": {
|
|
523
|
+
"value": {
|
|
524
|
+
"title": {
|
|
525
|
+
"en": "License Application",
|
|
526
|
+
"ga": "Iarratas ar Cheadúnas"
|
|
527
|
+
},
|
|
528
|
+
"allowedAuthMethods": [
|
|
529
|
+
"social:mygovid"
|
|
530
|
+
],
|
|
531
|
+
"organizationId": "org_9876543210fedcba",
|
|
532
|
+
"userId": "user_9876543210fedcba"
|
|
533
|
+
}
|
|
534
|
+
}
|
|
460
535
|
}
|
|
461
536
|
}
|
|
462
537
|
},
|
|
@@ -479,7 +554,10 @@
|
|
|
479
554
|
},
|
|
480
555
|
"required": [
|
|
481
556
|
"id"
|
|
482
|
-
]
|
|
557
|
+
],
|
|
558
|
+
"example": {
|
|
559
|
+
"id": "db28c9c2-984c-4295-9a89-ee93f4b9f059"
|
|
560
|
+
}
|
|
483
561
|
},
|
|
484
562
|
"metadata": {
|
|
485
563
|
"type": "object",
|
|
@@ -816,7 +894,20 @@
|
|
|
816
894
|
"allowedAuthMethods": {
|
|
817
895
|
"type": "array",
|
|
818
896
|
"items": {
|
|
819
|
-
"
|
|
897
|
+
"anyOf": [
|
|
898
|
+
{
|
|
899
|
+
"type": "string",
|
|
900
|
+
"enum": [
|
|
901
|
+
"email_otp"
|
|
902
|
+
]
|
|
903
|
+
},
|
|
904
|
+
{
|
|
905
|
+
"type": "string",
|
|
906
|
+
"enum": [
|
|
907
|
+
"social:mygovid"
|
|
908
|
+
]
|
|
909
|
+
}
|
|
910
|
+
]
|
|
820
911
|
}
|
|
821
912
|
},
|
|
822
913
|
"steps": {
|
|
@@ -874,6 +965,17 @@
|
|
|
874
965
|
"anyOf": [
|
|
875
966
|
{
|
|
876
967
|
"additionalProperties": false,
|
|
968
|
+
"examples": [
|
|
969
|
+
{
|
|
970
|
+
"formId": "68ca7425d5fe2c00124268f6"
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"formId": "form_1234567890abcdef"
|
|
974
|
+
},
|
|
975
|
+
{
|
|
976
|
+
"formId": "form_9876543210fedcba"
|
|
977
|
+
}
|
|
978
|
+
],
|
|
877
979
|
"type": "object",
|
|
878
980
|
"properties": {
|
|
879
981
|
"formId": {
|
|
@@ -886,6 +988,20 @@
|
|
|
886
988
|
},
|
|
887
989
|
{
|
|
888
990
|
"additionalProperties": false,
|
|
991
|
+
"examples": [
|
|
992
|
+
{
|
|
993
|
+
"paymentRequestId": "1183",
|
|
994
|
+
"title": "Payment for Application Fee"
|
|
995
|
+
},
|
|
996
|
+
{
|
|
997
|
+
"paymentRequestId": "payment_1234567890abcdef",
|
|
998
|
+
"title": "Service Registration Fee"
|
|
999
|
+
},
|
|
1000
|
+
{
|
|
1001
|
+
"paymentRequestId": "payment_9876543210fedcba",
|
|
1002
|
+
"title": "License Renewal Payment"
|
|
1003
|
+
}
|
|
1004
|
+
],
|
|
889
1005
|
"type": "object",
|
|
890
1006
|
"properties": {
|
|
891
1007
|
"paymentRequestId": {
|
|
@@ -902,6 +1018,19 @@
|
|
|
902
1018
|
},
|
|
903
1019
|
{
|
|
904
1020
|
"additionalProperties": false,
|
|
1021
|
+
"examples": [
|
|
1022
|
+
{
|
|
1023
|
+
"templateId": "template_abcdef1234567890",
|
|
1024
|
+
"title": "Payment Receipt",
|
|
1025
|
+
"recipients": [
|
|
1026
|
+
"customer@example.com"
|
|
1027
|
+
],
|
|
1028
|
+
"generatePDF": true,
|
|
1029
|
+
"uiConfig": {
|
|
1030
|
+
"setupPageVersion": "citizen-notification"
|
|
1031
|
+
}
|
|
1032
|
+
}
|
|
1033
|
+
],
|
|
905
1034
|
"type": "object",
|
|
906
1035
|
"properties": {
|
|
907
1036
|
"templateId": {
|
|
@@ -941,6 +1070,28 @@
|
|
|
941
1070
|
},
|
|
942
1071
|
{
|
|
943
1072
|
"additionalProperties": false,
|
|
1073
|
+
"examples": [
|
|
1074
|
+
{
|
|
1075
|
+
"buttonLabel": {
|
|
1076
|
+
"en": "Return to Dashboard",
|
|
1077
|
+
"ga": "Filleadh ar an mPainéal Riaracháin"
|
|
1078
|
+
},
|
|
1079
|
+
"returnUrl": "https://services.gov.ie/dashboard"
|
|
1080
|
+
},
|
|
1081
|
+
{
|
|
1082
|
+
"buttonLabel": {
|
|
1083
|
+
"en": "Continue to Next Step",
|
|
1084
|
+
"ga": "Lean ar aghaidh chuig an gcéad chéim eile"
|
|
1085
|
+
},
|
|
1086
|
+
"returnUrl": "https://services.gov.ie/next-step"
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"buttonLabel": {
|
|
1090
|
+
"en": "View Results"
|
|
1091
|
+
},
|
|
1092
|
+
"returnUrl": "https://services.gov.ie/results"
|
|
1093
|
+
}
|
|
1094
|
+
],
|
|
944
1095
|
"type": "object",
|
|
945
1096
|
"properties": {
|
|
946
1097
|
"buttonLabel": {
|
|
@@ -1000,7 +1151,20 @@
|
|
|
1000
1151
|
"configured",
|
|
1001
1152
|
"createdAt",
|
|
1002
1153
|
"updatedAt"
|
|
1003
|
-
]
|
|
1154
|
+
],
|
|
1155
|
+
"example": {
|
|
1156
|
+
"id": "step_title_001",
|
|
1157
|
+
"journeyId": "journey_1234567890abcdef",
|
|
1158
|
+
"stepType": "title",
|
|
1159
|
+
"stepData": {
|
|
1160
|
+
"uiConfig": {
|
|
1161
|
+
"setupPageVersion": "citizen-notification"
|
|
1162
|
+
}
|
|
1163
|
+
},
|
|
1164
|
+
"configured": true,
|
|
1165
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
1166
|
+
"updatedAt": "2025-10-09T15:02:00.000Z"
|
|
1167
|
+
}
|
|
1004
1168
|
}
|
|
1005
1169
|
},
|
|
1006
1170
|
"connections": {
|
|
@@ -1022,7 +1186,12 @@
|
|
|
1022
1186
|
"id",
|
|
1023
1187
|
"sourceStepId",
|
|
1024
1188
|
"destinationStepId"
|
|
1025
|
-
]
|
|
1189
|
+
],
|
|
1190
|
+
"example": {
|
|
1191
|
+
"id": "conn_1234567890abcdef",
|
|
1192
|
+
"sourceStepId": "step_title_001",
|
|
1193
|
+
"destinationStepId": "step_form_002"
|
|
1194
|
+
}
|
|
1026
1195
|
}
|
|
1027
1196
|
},
|
|
1028
1197
|
"userName": {
|
|
@@ -1299,26 +1468,391 @@
|
|
|
1299
1468
|
"schema": {
|
|
1300
1469
|
"type": "object",
|
|
1301
1470
|
"properties": {
|
|
1302
|
-
"title": {
|
|
1303
|
-
"type": "object",
|
|
1304
|
-
"properties": {
|
|
1305
|
-
"en": {
|
|
1306
|
-
"validator": {
|
|
1307
|
-
"name": "RequiredValidator",
|
|
1308
|
-
"options": {
|
|
1309
|
-
"parentField": "title"
|
|
1310
|
-
}
|
|
1311
|
-
},
|
|
1312
|
-
"type": "string"
|
|
1313
|
-
},
|
|
1314
|
-
"ga": {
|
|
1315
|
-
"type": "string"
|
|
1316
|
-
}
|
|
1317
|
-
},
|
|
1318
|
-
"required": [
|
|
1319
|
-
"en"
|
|
1320
|
-
]
|
|
1321
|
-
},
|
|
1471
|
+
"title": {
|
|
1472
|
+
"type": "object",
|
|
1473
|
+
"properties": {
|
|
1474
|
+
"en": {
|
|
1475
|
+
"validator": {
|
|
1476
|
+
"name": "RequiredValidator",
|
|
1477
|
+
"options": {
|
|
1478
|
+
"parentField": "title"
|
|
1479
|
+
}
|
|
1480
|
+
},
|
|
1481
|
+
"type": "string"
|
|
1482
|
+
},
|
|
1483
|
+
"ga": {
|
|
1484
|
+
"type": "string"
|
|
1485
|
+
}
|
|
1486
|
+
},
|
|
1487
|
+
"required": [
|
|
1488
|
+
"en"
|
|
1489
|
+
]
|
|
1490
|
+
},
|
|
1491
|
+
"allowedAuthMethods": {
|
|
1492
|
+
"type": "array",
|
|
1493
|
+
"items": {
|
|
1494
|
+
"anyOf": [
|
|
1495
|
+
{
|
|
1496
|
+
"type": "string",
|
|
1497
|
+
"enum": [
|
|
1498
|
+
"email_otp"
|
|
1499
|
+
]
|
|
1500
|
+
},
|
|
1501
|
+
{
|
|
1502
|
+
"type": "string",
|
|
1503
|
+
"enum": [
|
|
1504
|
+
"social:mygovid"
|
|
1505
|
+
]
|
|
1506
|
+
}
|
|
1507
|
+
]
|
|
1508
|
+
}
|
|
1509
|
+
},
|
|
1510
|
+
"status": {
|
|
1511
|
+
"anyOf": [
|
|
1512
|
+
{
|
|
1513
|
+
"type": "string",
|
|
1514
|
+
"enum": [
|
|
1515
|
+
"active"
|
|
1516
|
+
]
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
"type": "string",
|
|
1520
|
+
"enum": [
|
|
1521
|
+
"inactive"
|
|
1522
|
+
]
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
"type": "string",
|
|
1526
|
+
"enum": [
|
|
1527
|
+
"draft"
|
|
1528
|
+
]
|
|
1529
|
+
}
|
|
1530
|
+
]
|
|
1531
|
+
},
|
|
1532
|
+
"initialStepId": {
|
|
1533
|
+
"type": "string"
|
|
1534
|
+
}
|
|
1535
|
+
},
|
|
1536
|
+
"required": [
|
|
1537
|
+
"title",
|
|
1538
|
+
"allowedAuthMethods",
|
|
1539
|
+
"status",
|
|
1540
|
+
"initialStepId"
|
|
1541
|
+
]
|
|
1542
|
+
},
|
|
1543
|
+
"examples": {
|
|
1544
|
+
"example1": {
|
|
1545
|
+
"value": {
|
|
1546
|
+
"title": {
|
|
1547
|
+
"en": "Test messaging - Updated",
|
|
1548
|
+
"ga": "Teistphostú - Nuashonraithe"
|
|
1549
|
+
},
|
|
1550
|
+
"status": "active",
|
|
1551
|
+
"initialStepId": "step_title_001"
|
|
1552
|
+
}
|
|
1553
|
+
},
|
|
1554
|
+
"example2": {
|
|
1555
|
+
"value": {
|
|
1556
|
+
"title": {
|
|
1557
|
+
"en": "License Application",
|
|
1558
|
+
"ga": "Iarratas ar Cheadúnas"
|
|
1559
|
+
},
|
|
1560
|
+
"status": "draft",
|
|
1561
|
+
"initialStepId": "step_form_001"
|
|
1562
|
+
}
|
|
1563
|
+
}
|
|
1564
|
+
}
|
|
1565
|
+
}
|
|
1566
|
+
},
|
|
1567
|
+
"required": true
|
|
1568
|
+
},
|
|
1569
|
+
"parameters": [
|
|
1570
|
+
{
|
|
1571
|
+
"schema": {
|
|
1572
|
+
"type": "string"
|
|
1573
|
+
},
|
|
1574
|
+
"in": "path",
|
|
1575
|
+
"name": "journeyId",
|
|
1576
|
+
"required": true
|
|
1577
|
+
}
|
|
1578
|
+
],
|
|
1579
|
+
"responses": {
|
|
1580
|
+
"200": {
|
|
1581
|
+
"description": "Default Response",
|
|
1582
|
+
"content": {
|
|
1583
|
+
"application/json": {
|
|
1584
|
+
"schema": {
|
|
1585
|
+
"type": "object",
|
|
1586
|
+
"properties": {
|
|
1587
|
+
"data": {
|
|
1588
|
+
"type": "object",
|
|
1589
|
+
"properties": {
|
|
1590
|
+
"id": {
|
|
1591
|
+
"type": "string"
|
|
1592
|
+
}
|
|
1593
|
+
},
|
|
1594
|
+
"required": [
|
|
1595
|
+
"id"
|
|
1596
|
+
],
|
|
1597
|
+
"example": {
|
|
1598
|
+
"id": "db28c9c2-984c-4295-9a89-ee93f4b9f059"
|
|
1599
|
+
}
|
|
1600
|
+
},
|
|
1601
|
+
"metadata": {
|
|
1602
|
+
"type": "object",
|
|
1603
|
+
"properties": {
|
|
1604
|
+
"links": {
|
|
1605
|
+
"type": "object",
|
|
1606
|
+
"properties": {
|
|
1607
|
+
"self": {
|
|
1608
|
+
"type": "object",
|
|
1609
|
+
"properties": {
|
|
1610
|
+
"href": {
|
|
1611
|
+
"type": "string"
|
|
1612
|
+
}
|
|
1613
|
+
}
|
|
1614
|
+
},
|
|
1615
|
+
"next": {
|
|
1616
|
+
"type": "object",
|
|
1617
|
+
"properties": {
|
|
1618
|
+
"href": {
|
|
1619
|
+
"type": "string"
|
|
1620
|
+
}
|
|
1621
|
+
}
|
|
1622
|
+
},
|
|
1623
|
+
"prev": {
|
|
1624
|
+
"type": "object",
|
|
1625
|
+
"properties": {
|
|
1626
|
+
"href": {
|
|
1627
|
+
"type": "string"
|
|
1628
|
+
}
|
|
1629
|
+
}
|
|
1630
|
+
},
|
|
1631
|
+
"first": {
|
|
1632
|
+
"type": "object",
|
|
1633
|
+
"properties": {
|
|
1634
|
+
"href": {
|
|
1635
|
+
"type": "string"
|
|
1636
|
+
}
|
|
1637
|
+
}
|
|
1638
|
+
},
|
|
1639
|
+
"last": {
|
|
1640
|
+
"type": "object",
|
|
1641
|
+
"properties": {
|
|
1642
|
+
"href": {
|
|
1643
|
+
"type": "string"
|
|
1644
|
+
}
|
|
1645
|
+
}
|
|
1646
|
+
},
|
|
1647
|
+
"pages": {
|
|
1648
|
+
"type": "object",
|
|
1649
|
+
"additionalProperties": {
|
|
1650
|
+
"type": "object",
|
|
1651
|
+
"properties": {
|
|
1652
|
+
"href": {
|
|
1653
|
+
"type": "string"
|
|
1654
|
+
}
|
|
1655
|
+
}
|
|
1656
|
+
}
|
|
1657
|
+
}
|
|
1658
|
+
},
|
|
1659
|
+
"required": [
|
|
1660
|
+
"self",
|
|
1661
|
+
"first",
|
|
1662
|
+
"last",
|
|
1663
|
+
"pages"
|
|
1664
|
+
]
|
|
1665
|
+
},
|
|
1666
|
+
"totalCount": {
|
|
1667
|
+
"type": "number"
|
|
1668
|
+
}
|
|
1669
|
+
}
|
|
1670
|
+
}
|
|
1671
|
+
},
|
|
1672
|
+
"required": [
|
|
1673
|
+
"data"
|
|
1674
|
+
]
|
|
1675
|
+
}
|
|
1676
|
+
}
|
|
1677
|
+
}
|
|
1678
|
+
},
|
|
1679
|
+
"401": {
|
|
1680
|
+
"description": "Default Response",
|
|
1681
|
+
"content": {
|
|
1682
|
+
"application/json": {
|
|
1683
|
+
"schema": {
|
|
1684
|
+
"type": "object",
|
|
1685
|
+
"properties": {
|
|
1686
|
+
"code": {
|
|
1687
|
+
"type": "string"
|
|
1688
|
+
},
|
|
1689
|
+
"detail": {
|
|
1690
|
+
"type": "string"
|
|
1691
|
+
},
|
|
1692
|
+
"requestId": {
|
|
1693
|
+
"type": "string"
|
|
1694
|
+
},
|
|
1695
|
+
"name": {
|
|
1696
|
+
"type": "string"
|
|
1697
|
+
},
|
|
1698
|
+
"validation": {},
|
|
1699
|
+
"validationContext": {
|
|
1700
|
+
"type": "string"
|
|
1701
|
+
}
|
|
1702
|
+
},
|
|
1703
|
+
"required": [
|
|
1704
|
+
"code",
|
|
1705
|
+
"detail",
|
|
1706
|
+
"requestId",
|
|
1707
|
+
"name"
|
|
1708
|
+
]
|
|
1709
|
+
},
|
|
1710
|
+
"examples": {
|
|
1711
|
+
"example1": {
|
|
1712
|
+
"value": {
|
|
1713
|
+
"code": "400",
|
|
1714
|
+
"detail": "Bad Request - Invalid input data",
|
|
1715
|
+
"requestId": "req_1234567890abcdef",
|
|
1716
|
+
"name": "BadRequestError"
|
|
1717
|
+
}
|
|
1718
|
+
},
|
|
1719
|
+
"example2": {
|
|
1720
|
+
"value": {
|
|
1721
|
+
"code": "401",
|
|
1722
|
+
"detail": "Unauthorized - Missing or invalid JWT token",
|
|
1723
|
+
"requestId": "req_0987654321fedcba",
|
|
1724
|
+
"name": "UnauthorizedError"
|
|
1725
|
+
}
|
|
1726
|
+
},
|
|
1727
|
+
"example3": {
|
|
1728
|
+
"value": {
|
|
1729
|
+
"code": "404",
|
|
1730
|
+
"detail": "Not Found - Resource not found",
|
|
1731
|
+
"requestId": "req_fedcba0987654321",
|
|
1732
|
+
"name": "NotFoundError"
|
|
1733
|
+
}
|
|
1734
|
+
},
|
|
1735
|
+
"example4": {
|
|
1736
|
+
"value": {
|
|
1737
|
+
"code": "422",
|
|
1738
|
+
"detail": "Unprocessable Entity - Validation failed",
|
|
1739
|
+
"requestId": "req_abcdef1234567890",
|
|
1740
|
+
"name": "ValidationError",
|
|
1741
|
+
"validation": {
|
|
1742
|
+
"field": "title.en",
|
|
1743
|
+
"message": "Title in English is required"
|
|
1744
|
+
},
|
|
1745
|
+
"validationContext": "body"
|
|
1746
|
+
}
|
|
1747
|
+
},
|
|
1748
|
+
"example5": {
|
|
1749
|
+
"value": {
|
|
1750
|
+
"code": "500",
|
|
1751
|
+
"detail": "Internal Server Error - An unexpected error occurred",
|
|
1752
|
+
"requestId": "req_1234567890fedcba",
|
|
1753
|
+
"name": "InternalServerError"
|
|
1754
|
+
}
|
|
1755
|
+
}
|
|
1756
|
+
}
|
|
1757
|
+
}
|
|
1758
|
+
}
|
|
1759
|
+
},
|
|
1760
|
+
"500": {
|
|
1761
|
+
"description": "Default Response",
|
|
1762
|
+
"content": {
|
|
1763
|
+
"application/json": {
|
|
1764
|
+
"schema": {
|
|
1765
|
+
"type": "object",
|
|
1766
|
+
"properties": {
|
|
1767
|
+
"code": {
|
|
1768
|
+
"type": "string"
|
|
1769
|
+
},
|
|
1770
|
+
"detail": {
|
|
1771
|
+
"type": "string"
|
|
1772
|
+
},
|
|
1773
|
+
"requestId": {
|
|
1774
|
+
"type": "string"
|
|
1775
|
+
},
|
|
1776
|
+
"name": {
|
|
1777
|
+
"type": "string"
|
|
1778
|
+
},
|
|
1779
|
+
"validation": {},
|
|
1780
|
+
"validationContext": {
|
|
1781
|
+
"type": "string"
|
|
1782
|
+
}
|
|
1783
|
+
},
|
|
1784
|
+
"required": [
|
|
1785
|
+
"code",
|
|
1786
|
+
"detail",
|
|
1787
|
+
"requestId",
|
|
1788
|
+
"name"
|
|
1789
|
+
]
|
|
1790
|
+
},
|
|
1791
|
+
"examples": {
|
|
1792
|
+
"example1": {
|
|
1793
|
+
"value": {
|
|
1794
|
+
"code": "400",
|
|
1795
|
+
"detail": "Bad Request - Invalid input data",
|
|
1796
|
+
"requestId": "req_1234567890abcdef",
|
|
1797
|
+
"name": "BadRequestError"
|
|
1798
|
+
}
|
|
1799
|
+
},
|
|
1800
|
+
"example2": {
|
|
1801
|
+
"value": {
|
|
1802
|
+
"code": "401",
|
|
1803
|
+
"detail": "Unauthorized - Missing or invalid JWT token",
|
|
1804
|
+
"requestId": "req_0987654321fedcba",
|
|
1805
|
+
"name": "UnauthorizedError"
|
|
1806
|
+
}
|
|
1807
|
+
},
|
|
1808
|
+
"example3": {
|
|
1809
|
+
"value": {
|
|
1810
|
+
"code": "404",
|
|
1811
|
+
"detail": "Not Found - Resource not found",
|
|
1812
|
+
"requestId": "req_fedcba0987654321",
|
|
1813
|
+
"name": "NotFoundError"
|
|
1814
|
+
}
|
|
1815
|
+
},
|
|
1816
|
+
"example4": {
|
|
1817
|
+
"value": {
|
|
1818
|
+
"code": "422",
|
|
1819
|
+
"detail": "Unprocessable Entity - Validation failed",
|
|
1820
|
+
"requestId": "req_abcdef1234567890",
|
|
1821
|
+
"name": "ValidationError",
|
|
1822
|
+
"validation": {
|
|
1823
|
+
"field": "title.en",
|
|
1824
|
+
"message": "Title in English is required"
|
|
1825
|
+
},
|
|
1826
|
+
"validationContext": "body"
|
|
1827
|
+
}
|
|
1828
|
+
},
|
|
1829
|
+
"example5": {
|
|
1830
|
+
"value": {
|
|
1831
|
+
"code": "500",
|
|
1832
|
+
"detail": "Internal Server Error - An unexpected error occurred",
|
|
1833
|
+
"requestId": "req_1234567890fedcba",
|
|
1834
|
+
"name": "InternalServerError"
|
|
1835
|
+
}
|
|
1836
|
+
}
|
|
1837
|
+
}
|
|
1838
|
+
}
|
|
1839
|
+
}
|
|
1840
|
+
}
|
|
1841
|
+
}
|
|
1842
|
+
},
|
|
1843
|
+
"patch": {
|
|
1844
|
+
"operationId": "updateJourneyStatus",
|
|
1845
|
+
"summary": "Update journey status",
|
|
1846
|
+
"tags": [
|
|
1847
|
+
"Journeys"
|
|
1848
|
+
],
|
|
1849
|
+
"description": "Update an existing journey status",
|
|
1850
|
+
"requestBody": {
|
|
1851
|
+
"content": {
|
|
1852
|
+
"application/json": {
|
|
1853
|
+
"schema": {
|
|
1854
|
+
"type": "object",
|
|
1855
|
+
"properties": {
|
|
1322
1856
|
"status": {
|
|
1323
1857
|
"anyOf": [
|
|
1324
1858
|
{
|
|
@@ -1332,30 +1866,12 @@
|
|
|
1332
1866
|
"enum": [
|
|
1333
1867
|
"inactive"
|
|
1334
1868
|
]
|
|
1335
|
-
},
|
|
1336
|
-
{
|
|
1337
|
-
"type": "string",
|
|
1338
|
-
"enum": [
|
|
1339
|
-
"draft"
|
|
1340
|
-
]
|
|
1341
1869
|
}
|
|
1342
1870
|
]
|
|
1343
|
-
},
|
|
1344
|
-
"initialStepId": {
|
|
1345
|
-
"type": "string"
|
|
1346
|
-
},
|
|
1347
|
-
"allowedAuthMethods": {
|
|
1348
|
-
"type": "array",
|
|
1349
|
-
"items": {
|
|
1350
|
-
"type": "string"
|
|
1351
|
-
}
|
|
1352
1871
|
}
|
|
1353
1872
|
},
|
|
1354
1873
|
"required": [
|
|
1355
|
-
"
|
|
1356
|
-
"status",
|
|
1357
|
-
"initialStepId",
|
|
1358
|
-
"allowedAuthMethods"
|
|
1874
|
+
"status"
|
|
1359
1875
|
]
|
|
1360
1876
|
}
|
|
1361
1877
|
}
|
|
@@ -1383,12 +1899,25 @@
|
|
|
1383
1899
|
"data": {
|
|
1384
1900
|
"type": "object",
|
|
1385
1901
|
"properties": {
|
|
1386
|
-
"
|
|
1387
|
-
"
|
|
1902
|
+
"status": {
|
|
1903
|
+
"anyOf": [
|
|
1904
|
+
{
|
|
1905
|
+
"type": "string",
|
|
1906
|
+
"enum": [
|
|
1907
|
+
"active"
|
|
1908
|
+
]
|
|
1909
|
+
},
|
|
1910
|
+
{
|
|
1911
|
+
"type": "string",
|
|
1912
|
+
"enum": [
|
|
1913
|
+
"inactive"
|
|
1914
|
+
]
|
|
1915
|
+
}
|
|
1916
|
+
]
|
|
1388
1917
|
}
|
|
1389
1918
|
},
|
|
1390
1919
|
"required": [
|
|
1391
|
-
"
|
|
1920
|
+
"status"
|
|
1392
1921
|
]
|
|
1393
1922
|
},
|
|
1394
1923
|
"metadata": {
|
|
@@ -1667,7 +2196,10 @@
|
|
|
1667
2196
|
},
|
|
1668
2197
|
"required": [
|
|
1669
2198
|
"ok"
|
|
1670
|
-
]
|
|
2199
|
+
],
|
|
2200
|
+
"example": {
|
|
2201
|
+
"ok": true
|
|
2202
|
+
}
|
|
1671
2203
|
},
|
|
1672
2204
|
"metadata": {
|
|
1673
2205
|
"type": "object",
|
|
@@ -1998,7 +2530,20 @@
|
|
|
1998
2530
|
"allowedAuthMethods": {
|
|
1999
2531
|
"type": "array",
|
|
2000
2532
|
"items": {
|
|
2001
|
-
"
|
|
2533
|
+
"anyOf": [
|
|
2534
|
+
{
|
|
2535
|
+
"type": "string",
|
|
2536
|
+
"enum": [
|
|
2537
|
+
"email_otp"
|
|
2538
|
+
]
|
|
2539
|
+
},
|
|
2540
|
+
{
|
|
2541
|
+
"type": "string",
|
|
2542
|
+
"enum": [
|
|
2543
|
+
"social:mygovid"
|
|
2544
|
+
]
|
|
2545
|
+
}
|
|
2546
|
+
]
|
|
2002
2547
|
}
|
|
2003
2548
|
}
|
|
2004
2549
|
},
|
|
@@ -2010,7 +2555,24 @@
|
|
|
2010
2555
|
"createdAt",
|
|
2011
2556
|
"updatedAt",
|
|
2012
2557
|
"allowedAuthMethods"
|
|
2013
|
-
]
|
|
2558
|
+
],
|
|
2559
|
+
"example": {
|
|
2560
|
+
"id": "journey_1234567890abcdef",
|
|
2561
|
+
"title": {
|
|
2562
|
+
"en": "Test messaging",
|
|
2563
|
+
"ga": "Teistphostú"
|
|
2564
|
+
},
|
|
2565
|
+
"userId": "user_1234567890abcdef",
|
|
2566
|
+
"organizationId": "org_1234567890abcdef",
|
|
2567
|
+
"status": "active",
|
|
2568
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
2569
|
+
"updatedAt": "2025-10-09T15:02:00.000Z",
|
|
2570
|
+
"initialStepId": "step_title_001",
|
|
2571
|
+
"allowedAuthMethods": [
|
|
2572
|
+
"email_otp",
|
|
2573
|
+
"social:mygovid"
|
|
2574
|
+
]
|
|
2575
|
+
}
|
|
2014
2576
|
},
|
|
2015
2577
|
"metadata": {
|
|
2016
2578
|
"type": "object",
|
|
@@ -2299,7 +2861,12 @@
|
|
|
2299
2861
|
"id",
|
|
2300
2862
|
"sourceStepId",
|
|
2301
2863
|
"destinationStepId"
|
|
2302
|
-
]
|
|
2864
|
+
],
|
|
2865
|
+
"example": {
|
|
2866
|
+
"id": "conn_1234567890abcdef",
|
|
2867
|
+
"sourceStepId": "step_title_001",
|
|
2868
|
+
"destinationStepId": "step_form_002"
|
|
2869
|
+
}
|
|
2303
2870
|
}
|
|
2304
2871
|
}
|
|
2305
2872
|
},
|
|
@@ -2596,7 +3163,12 @@
|
|
|
2596
3163
|
"id",
|
|
2597
3164
|
"sourceStepId",
|
|
2598
3165
|
"destinationStepId"
|
|
2599
|
-
]
|
|
3166
|
+
],
|
|
3167
|
+
"example": {
|
|
3168
|
+
"id": "conn_1234567890abcdef",
|
|
3169
|
+
"sourceStepId": "step_title_001",
|
|
3170
|
+
"destinationStepId": "step_form_002"
|
|
3171
|
+
}
|
|
2600
3172
|
},
|
|
2601
3173
|
"metadata": {
|
|
2602
3174
|
"type": "object",
|
|
@@ -3168,7 +3740,12 @@
|
|
|
3168
3740
|
"id",
|
|
3169
3741
|
"sourceStepId",
|
|
3170
3742
|
"destinationStepId"
|
|
3171
|
-
]
|
|
3743
|
+
],
|
|
3744
|
+
"example": {
|
|
3745
|
+
"id": "conn_1234567890abcdef",
|
|
3746
|
+
"sourceStepId": "step_title_001",
|
|
3747
|
+
"destinationStepId": "step_form_002"
|
|
3748
|
+
}
|
|
3172
3749
|
},
|
|
3173
3750
|
"metadata": {
|
|
3174
3751
|
"type": "object",
|
|
@@ -3492,6 +4069,17 @@
|
|
|
3492
4069
|
"anyOf": [
|
|
3493
4070
|
{
|
|
3494
4071
|
"additionalProperties": false,
|
|
4072
|
+
"examples": [
|
|
4073
|
+
{
|
|
4074
|
+
"formId": "68ca7425d5fe2c00124268f6"
|
|
4075
|
+
},
|
|
4076
|
+
{
|
|
4077
|
+
"formId": "form_1234567890abcdef"
|
|
4078
|
+
},
|
|
4079
|
+
{
|
|
4080
|
+
"formId": "form_9876543210fedcba"
|
|
4081
|
+
}
|
|
4082
|
+
],
|
|
3495
4083
|
"type": "object",
|
|
3496
4084
|
"properties": {
|
|
3497
4085
|
"formId": {
|
|
@@ -3504,6 +4092,20 @@
|
|
|
3504
4092
|
},
|
|
3505
4093
|
{
|
|
3506
4094
|
"additionalProperties": false,
|
|
4095
|
+
"examples": [
|
|
4096
|
+
{
|
|
4097
|
+
"paymentRequestId": "1183",
|
|
4098
|
+
"title": "Payment for Application Fee"
|
|
4099
|
+
},
|
|
4100
|
+
{
|
|
4101
|
+
"paymentRequestId": "payment_1234567890abcdef",
|
|
4102
|
+
"title": "Service Registration Fee"
|
|
4103
|
+
},
|
|
4104
|
+
{
|
|
4105
|
+
"paymentRequestId": "payment_9876543210fedcba",
|
|
4106
|
+
"title": "License Renewal Payment"
|
|
4107
|
+
}
|
|
4108
|
+
],
|
|
3507
4109
|
"type": "object",
|
|
3508
4110
|
"properties": {
|
|
3509
4111
|
"paymentRequestId": {
|
|
@@ -3520,6 +4122,19 @@
|
|
|
3520
4122
|
},
|
|
3521
4123
|
{
|
|
3522
4124
|
"additionalProperties": false,
|
|
4125
|
+
"examples": [
|
|
4126
|
+
{
|
|
4127
|
+
"templateId": "template_abcdef1234567890",
|
|
4128
|
+
"title": "Payment Receipt",
|
|
4129
|
+
"recipients": [
|
|
4130
|
+
"customer@example.com"
|
|
4131
|
+
],
|
|
4132
|
+
"generatePDF": true,
|
|
4133
|
+
"uiConfig": {
|
|
4134
|
+
"setupPageVersion": "citizen-notification"
|
|
4135
|
+
}
|
|
4136
|
+
}
|
|
4137
|
+
],
|
|
3523
4138
|
"type": "object",
|
|
3524
4139
|
"properties": {
|
|
3525
4140
|
"templateId": {
|
|
@@ -3559,6 +4174,28 @@
|
|
|
3559
4174
|
},
|
|
3560
4175
|
{
|
|
3561
4176
|
"additionalProperties": false,
|
|
4177
|
+
"examples": [
|
|
4178
|
+
{
|
|
4179
|
+
"buttonLabel": {
|
|
4180
|
+
"en": "Return to Dashboard",
|
|
4181
|
+
"ga": "Filleadh ar an mPainéal Riaracháin"
|
|
4182
|
+
},
|
|
4183
|
+
"returnUrl": "https://services.gov.ie/dashboard"
|
|
4184
|
+
},
|
|
4185
|
+
{
|
|
4186
|
+
"buttonLabel": {
|
|
4187
|
+
"en": "Continue to Next Step",
|
|
4188
|
+
"ga": "Lean ar aghaidh chuig an gcéad chéim eile"
|
|
4189
|
+
},
|
|
4190
|
+
"returnUrl": "https://services.gov.ie/next-step"
|
|
4191
|
+
},
|
|
4192
|
+
{
|
|
4193
|
+
"buttonLabel": {
|
|
4194
|
+
"en": "View Results"
|
|
4195
|
+
},
|
|
4196
|
+
"returnUrl": "https://services.gov.ie/results"
|
|
4197
|
+
}
|
|
4198
|
+
],
|
|
3562
4199
|
"type": "object",
|
|
3563
4200
|
"properties": {
|
|
3564
4201
|
"buttonLabel": {
|
|
@@ -3618,7 +4255,20 @@
|
|
|
3618
4255
|
"configured",
|
|
3619
4256
|
"createdAt",
|
|
3620
4257
|
"updatedAt"
|
|
3621
|
-
]
|
|
4258
|
+
],
|
|
4259
|
+
"example": {
|
|
4260
|
+
"id": "step_title_001",
|
|
4261
|
+
"journeyId": "journey_1234567890abcdef",
|
|
4262
|
+
"stepType": "title",
|
|
4263
|
+
"stepData": {
|
|
4264
|
+
"uiConfig": {
|
|
4265
|
+
"setupPageVersion": "citizen-notification"
|
|
4266
|
+
}
|
|
4267
|
+
},
|
|
4268
|
+
"configured": true,
|
|
4269
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
4270
|
+
"updatedAt": "2025-10-09T15:02:00.000Z"
|
|
4271
|
+
}
|
|
3622
4272
|
},
|
|
3623
4273
|
"metadata": {
|
|
3624
4274
|
"type": "object",
|
|
@@ -4153,6 +4803,17 @@
|
|
|
4153
4803
|
"anyOf": [
|
|
4154
4804
|
{
|
|
4155
4805
|
"additionalProperties": false,
|
|
4806
|
+
"examples": [
|
|
4807
|
+
{
|
|
4808
|
+
"formId": "68ca7425d5fe2c00124268f6"
|
|
4809
|
+
},
|
|
4810
|
+
{
|
|
4811
|
+
"formId": "form_1234567890abcdef"
|
|
4812
|
+
},
|
|
4813
|
+
{
|
|
4814
|
+
"formId": "form_9876543210fedcba"
|
|
4815
|
+
}
|
|
4816
|
+
],
|
|
4156
4817
|
"type": "object",
|
|
4157
4818
|
"properties": {
|
|
4158
4819
|
"formId": {
|
|
@@ -4165,6 +4826,20 @@
|
|
|
4165
4826
|
},
|
|
4166
4827
|
{
|
|
4167
4828
|
"additionalProperties": false,
|
|
4829
|
+
"examples": [
|
|
4830
|
+
{
|
|
4831
|
+
"paymentRequestId": "1183",
|
|
4832
|
+
"title": "Payment for Application Fee"
|
|
4833
|
+
},
|
|
4834
|
+
{
|
|
4835
|
+
"paymentRequestId": "payment_1234567890abcdef",
|
|
4836
|
+
"title": "Service Registration Fee"
|
|
4837
|
+
},
|
|
4838
|
+
{
|
|
4839
|
+
"paymentRequestId": "payment_9876543210fedcba",
|
|
4840
|
+
"title": "License Renewal Payment"
|
|
4841
|
+
}
|
|
4842
|
+
],
|
|
4168
4843
|
"type": "object",
|
|
4169
4844
|
"properties": {
|
|
4170
4845
|
"paymentRequestId": {
|
|
@@ -4181,6 +4856,19 @@
|
|
|
4181
4856
|
},
|
|
4182
4857
|
{
|
|
4183
4858
|
"additionalProperties": false,
|
|
4859
|
+
"examples": [
|
|
4860
|
+
{
|
|
4861
|
+
"templateId": "template_abcdef1234567890",
|
|
4862
|
+
"title": "Payment Receipt",
|
|
4863
|
+
"recipients": [
|
|
4864
|
+
"customer@example.com"
|
|
4865
|
+
],
|
|
4866
|
+
"generatePDF": true,
|
|
4867
|
+
"uiConfig": {
|
|
4868
|
+
"setupPageVersion": "citizen-notification"
|
|
4869
|
+
}
|
|
4870
|
+
}
|
|
4871
|
+
],
|
|
4184
4872
|
"type": "object",
|
|
4185
4873
|
"properties": {
|
|
4186
4874
|
"templateId": {
|
|
@@ -4220,6 +4908,28 @@
|
|
|
4220
4908
|
},
|
|
4221
4909
|
{
|
|
4222
4910
|
"additionalProperties": false,
|
|
4911
|
+
"examples": [
|
|
4912
|
+
{
|
|
4913
|
+
"buttonLabel": {
|
|
4914
|
+
"en": "Return to Dashboard",
|
|
4915
|
+
"ga": "Filleadh ar an mPainéal Riaracháin"
|
|
4916
|
+
},
|
|
4917
|
+
"returnUrl": "https://services.gov.ie/dashboard"
|
|
4918
|
+
},
|
|
4919
|
+
{
|
|
4920
|
+
"buttonLabel": {
|
|
4921
|
+
"en": "Continue to Next Step",
|
|
4922
|
+
"ga": "Lean ar aghaidh chuig an gcéad chéim eile"
|
|
4923
|
+
},
|
|
4924
|
+
"returnUrl": "https://services.gov.ie/next-step"
|
|
4925
|
+
},
|
|
4926
|
+
{
|
|
4927
|
+
"buttonLabel": {
|
|
4928
|
+
"en": "View Results"
|
|
4929
|
+
},
|
|
4930
|
+
"returnUrl": "https://services.gov.ie/results"
|
|
4931
|
+
}
|
|
4932
|
+
],
|
|
4223
4933
|
"type": "object",
|
|
4224
4934
|
"properties": {
|
|
4225
4935
|
"buttonLabel": {
|
|
@@ -4386,6 +5096,17 @@
|
|
|
4386
5096
|
"anyOf": [
|
|
4387
5097
|
{
|
|
4388
5098
|
"additionalProperties": false,
|
|
5099
|
+
"examples": [
|
|
5100
|
+
{
|
|
5101
|
+
"formId": "68ca7425d5fe2c00124268f6"
|
|
5102
|
+
},
|
|
5103
|
+
{
|
|
5104
|
+
"formId": "form_1234567890abcdef"
|
|
5105
|
+
},
|
|
5106
|
+
{
|
|
5107
|
+
"formId": "form_9876543210fedcba"
|
|
5108
|
+
}
|
|
5109
|
+
],
|
|
4389
5110
|
"type": "object",
|
|
4390
5111
|
"properties": {
|
|
4391
5112
|
"formId": {
|
|
@@ -4398,6 +5119,20 @@
|
|
|
4398
5119
|
},
|
|
4399
5120
|
{
|
|
4400
5121
|
"additionalProperties": false,
|
|
5122
|
+
"examples": [
|
|
5123
|
+
{
|
|
5124
|
+
"paymentRequestId": "1183",
|
|
5125
|
+
"title": "Payment for Application Fee"
|
|
5126
|
+
},
|
|
5127
|
+
{
|
|
5128
|
+
"paymentRequestId": "payment_1234567890abcdef",
|
|
5129
|
+
"title": "Service Registration Fee"
|
|
5130
|
+
},
|
|
5131
|
+
{
|
|
5132
|
+
"paymentRequestId": "payment_9876543210fedcba",
|
|
5133
|
+
"title": "License Renewal Payment"
|
|
5134
|
+
}
|
|
5135
|
+
],
|
|
4401
5136
|
"type": "object",
|
|
4402
5137
|
"properties": {
|
|
4403
5138
|
"paymentRequestId": {
|
|
@@ -4414,6 +5149,19 @@
|
|
|
4414
5149
|
},
|
|
4415
5150
|
{
|
|
4416
5151
|
"additionalProperties": false,
|
|
5152
|
+
"examples": [
|
|
5153
|
+
{
|
|
5154
|
+
"templateId": "template_abcdef1234567890",
|
|
5155
|
+
"title": "Payment Receipt",
|
|
5156
|
+
"recipients": [
|
|
5157
|
+
"customer@example.com"
|
|
5158
|
+
],
|
|
5159
|
+
"generatePDF": true,
|
|
5160
|
+
"uiConfig": {
|
|
5161
|
+
"setupPageVersion": "citizen-notification"
|
|
5162
|
+
}
|
|
5163
|
+
}
|
|
5164
|
+
],
|
|
4417
5165
|
"type": "object",
|
|
4418
5166
|
"properties": {
|
|
4419
5167
|
"templateId": {
|
|
@@ -4453,6 +5201,28 @@
|
|
|
4453
5201
|
},
|
|
4454
5202
|
{
|
|
4455
5203
|
"additionalProperties": false,
|
|
5204
|
+
"examples": [
|
|
5205
|
+
{
|
|
5206
|
+
"buttonLabel": {
|
|
5207
|
+
"en": "Return to Dashboard",
|
|
5208
|
+
"ga": "Filleadh ar an mPainéal Riaracháin"
|
|
5209
|
+
},
|
|
5210
|
+
"returnUrl": "https://services.gov.ie/dashboard"
|
|
5211
|
+
},
|
|
5212
|
+
{
|
|
5213
|
+
"buttonLabel": {
|
|
5214
|
+
"en": "Continue to Next Step",
|
|
5215
|
+
"ga": "Lean ar aghaidh chuig an gcéad chéim eile"
|
|
5216
|
+
},
|
|
5217
|
+
"returnUrl": "https://services.gov.ie/next-step"
|
|
5218
|
+
},
|
|
5219
|
+
{
|
|
5220
|
+
"buttonLabel": {
|
|
5221
|
+
"en": "View Results"
|
|
5222
|
+
},
|
|
5223
|
+
"returnUrl": "https://services.gov.ie/results"
|
|
5224
|
+
}
|
|
5225
|
+
],
|
|
4456
5226
|
"type": "object",
|
|
4457
5227
|
"properties": {
|
|
4458
5228
|
"buttonLabel": {
|
|
@@ -4512,7 +5282,20 @@
|
|
|
4512
5282
|
"configured",
|
|
4513
5283
|
"createdAt",
|
|
4514
5284
|
"updatedAt"
|
|
4515
|
-
]
|
|
5285
|
+
],
|
|
5286
|
+
"example": {
|
|
5287
|
+
"id": "step_title_001",
|
|
5288
|
+
"journeyId": "journey_1234567890abcdef",
|
|
5289
|
+
"stepType": "title",
|
|
5290
|
+
"stepData": {
|
|
5291
|
+
"uiConfig": {
|
|
5292
|
+
"setupPageVersion": "citizen-notification"
|
|
5293
|
+
}
|
|
5294
|
+
},
|
|
5295
|
+
"configured": true,
|
|
5296
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
5297
|
+
"updatedAt": "2025-10-09T15:02:00.000Z"
|
|
5298
|
+
}
|
|
4516
5299
|
},
|
|
4517
5300
|
"metadata": {
|
|
4518
5301
|
"type": "object",
|
|
@@ -4827,6 +5610,17 @@
|
|
|
4827
5610
|
"anyOf": [
|
|
4828
5611
|
{
|
|
4829
5612
|
"additionalProperties": false,
|
|
5613
|
+
"examples": [
|
|
5614
|
+
{
|
|
5615
|
+
"formId": "68ca7425d5fe2c00124268f6"
|
|
5616
|
+
},
|
|
5617
|
+
{
|
|
5618
|
+
"formId": "form_1234567890abcdef"
|
|
5619
|
+
},
|
|
5620
|
+
{
|
|
5621
|
+
"formId": "form_9876543210fedcba"
|
|
5622
|
+
}
|
|
5623
|
+
],
|
|
4830
5624
|
"type": "object",
|
|
4831
5625
|
"properties": {
|
|
4832
5626
|
"formId": {
|
|
@@ -4839,6 +5633,20 @@
|
|
|
4839
5633
|
},
|
|
4840
5634
|
{
|
|
4841
5635
|
"additionalProperties": false,
|
|
5636
|
+
"examples": [
|
|
5637
|
+
{
|
|
5638
|
+
"paymentRequestId": "1183",
|
|
5639
|
+
"title": "Payment for Application Fee"
|
|
5640
|
+
},
|
|
5641
|
+
{
|
|
5642
|
+
"paymentRequestId": "payment_1234567890abcdef",
|
|
5643
|
+
"title": "Service Registration Fee"
|
|
5644
|
+
},
|
|
5645
|
+
{
|
|
5646
|
+
"paymentRequestId": "payment_9876543210fedcba",
|
|
5647
|
+
"title": "License Renewal Payment"
|
|
5648
|
+
}
|
|
5649
|
+
],
|
|
4842
5650
|
"type": "object",
|
|
4843
5651
|
"properties": {
|
|
4844
5652
|
"paymentRequestId": {
|
|
@@ -4855,6 +5663,19 @@
|
|
|
4855
5663
|
},
|
|
4856
5664
|
{
|
|
4857
5665
|
"additionalProperties": false,
|
|
5666
|
+
"examples": [
|
|
5667
|
+
{
|
|
5668
|
+
"templateId": "template_abcdef1234567890",
|
|
5669
|
+
"title": "Payment Receipt",
|
|
5670
|
+
"recipients": [
|
|
5671
|
+
"customer@example.com"
|
|
5672
|
+
],
|
|
5673
|
+
"generatePDF": true,
|
|
5674
|
+
"uiConfig": {
|
|
5675
|
+
"setupPageVersion": "citizen-notification"
|
|
5676
|
+
}
|
|
5677
|
+
}
|
|
5678
|
+
],
|
|
4858
5679
|
"type": "object",
|
|
4859
5680
|
"properties": {
|
|
4860
5681
|
"templateId": {
|
|
@@ -4894,6 +5715,28 @@
|
|
|
4894
5715
|
},
|
|
4895
5716
|
{
|
|
4896
5717
|
"additionalProperties": false,
|
|
5718
|
+
"examples": [
|
|
5719
|
+
{
|
|
5720
|
+
"buttonLabel": {
|
|
5721
|
+
"en": "Return to Dashboard",
|
|
5722
|
+
"ga": "Filleadh ar an mPainéal Riaracháin"
|
|
5723
|
+
},
|
|
5724
|
+
"returnUrl": "https://services.gov.ie/dashboard"
|
|
5725
|
+
},
|
|
5726
|
+
{
|
|
5727
|
+
"buttonLabel": {
|
|
5728
|
+
"en": "Continue to Next Step",
|
|
5729
|
+
"ga": "Lean ar aghaidh chuig an gcéad chéim eile"
|
|
5730
|
+
},
|
|
5731
|
+
"returnUrl": "https://services.gov.ie/next-step"
|
|
5732
|
+
},
|
|
5733
|
+
{
|
|
5734
|
+
"buttonLabel": {
|
|
5735
|
+
"en": "View Results"
|
|
5736
|
+
},
|
|
5737
|
+
"returnUrl": "https://services.gov.ie/results"
|
|
5738
|
+
}
|
|
5739
|
+
],
|
|
4897
5740
|
"type": "object",
|
|
4898
5741
|
"properties": {
|
|
4899
5742
|
"buttonLabel": {
|
|
@@ -5008,6 +5851,17 @@
|
|
|
5008
5851
|
"anyOf": [
|
|
5009
5852
|
{
|
|
5010
5853
|
"additionalProperties": false,
|
|
5854
|
+
"examples": [
|
|
5855
|
+
{
|
|
5856
|
+
"formId": "68ca7425d5fe2c00124268f6"
|
|
5857
|
+
},
|
|
5858
|
+
{
|
|
5859
|
+
"formId": "form_1234567890abcdef"
|
|
5860
|
+
},
|
|
5861
|
+
{
|
|
5862
|
+
"formId": "form_9876543210fedcba"
|
|
5863
|
+
}
|
|
5864
|
+
],
|
|
5011
5865
|
"type": "object",
|
|
5012
5866
|
"properties": {
|
|
5013
5867
|
"formId": {
|
|
@@ -5020,6 +5874,20 @@
|
|
|
5020
5874
|
},
|
|
5021
5875
|
{
|
|
5022
5876
|
"additionalProperties": false,
|
|
5877
|
+
"examples": [
|
|
5878
|
+
{
|
|
5879
|
+
"paymentRequestId": "1183",
|
|
5880
|
+
"title": "Payment for Application Fee"
|
|
5881
|
+
},
|
|
5882
|
+
{
|
|
5883
|
+
"paymentRequestId": "payment_1234567890abcdef",
|
|
5884
|
+
"title": "Service Registration Fee"
|
|
5885
|
+
},
|
|
5886
|
+
{
|
|
5887
|
+
"paymentRequestId": "payment_9876543210fedcba",
|
|
5888
|
+
"title": "License Renewal Payment"
|
|
5889
|
+
}
|
|
5890
|
+
],
|
|
5023
5891
|
"type": "object",
|
|
5024
5892
|
"properties": {
|
|
5025
5893
|
"paymentRequestId": {
|
|
@@ -5036,6 +5904,19 @@
|
|
|
5036
5904
|
},
|
|
5037
5905
|
{
|
|
5038
5906
|
"additionalProperties": false,
|
|
5907
|
+
"examples": [
|
|
5908
|
+
{
|
|
5909
|
+
"templateId": "template_abcdef1234567890",
|
|
5910
|
+
"title": "Payment Receipt",
|
|
5911
|
+
"recipients": [
|
|
5912
|
+
"customer@example.com"
|
|
5913
|
+
],
|
|
5914
|
+
"generatePDF": true,
|
|
5915
|
+
"uiConfig": {
|
|
5916
|
+
"setupPageVersion": "citizen-notification"
|
|
5917
|
+
}
|
|
5918
|
+
}
|
|
5919
|
+
],
|
|
5039
5920
|
"type": "object",
|
|
5040
5921
|
"properties": {
|
|
5041
5922
|
"templateId": {
|
|
@@ -5075,6 +5956,28 @@
|
|
|
5075
5956
|
},
|
|
5076
5957
|
{
|
|
5077
5958
|
"additionalProperties": false,
|
|
5959
|
+
"examples": [
|
|
5960
|
+
{
|
|
5961
|
+
"buttonLabel": {
|
|
5962
|
+
"en": "Return to Dashboard",
|
|
5963
|
+
"ga": "Filleadh ar an mPainéal Riaracháin"
|
|
5964
|
+
},
|
|
5965
|
+
"returnUrl": "https://services.gov.ie/dashboard"
|
|
5966
|
+
},
|
|
5967
|
+
{
|
|
5968
|
+
"buttonLabel": {
|
|
5969
|
+
"en": "Continue to Next Step",
|
|
5970
|
+
"ga": "Lean ar aghaidh chuig an gcéad chéim eile"
|
|
5971
|
+
},
|
|
5972
|
+
"returnUrl": "https://services.gov.ie/next-step"
|
|
5973
|
+
},
|
|
5974
|
+
{
|
|
5975
|
+
"buttonLabel": {
|
|
5976
|
+
"en": "View Results"
|
|
5977
|
+
},
|
|
5978
|
+
"returnUrl": "https://services.gov.ie/results"
|
|
5979
|
+
}
|
|
5980
|
+
],
|
|
5078
5981
|
"type": "object",
|
|
5079
5982
|
"properties": {
|
|
5080
5983
|
"buttonLabel": {
|
|
@@ -5134,7 +6037,20 @@
|
|
|
5134
6037
|
"configured",
|
|
5135
6038
|
"createdAt",
|
|
5136
6039
|
"updatedAt"
|
|
5137
|
-
]
|
|
6040
|
+
],
|
|
6041
|
+
"example": {
|
|
6042
|
+
"id": "step_title_001",
|
|
6043
|
+
"journeyId": "journey_1234567890abcdef",
|
|
6044
|
+
"stepType": "title",
|
|
6045
|
+
"stepData": {
|
|
6046
|
+
"uiConfig": {
|
|
6047
|
+
"setupPageVersion": "citizen-notification"
|
|
6048
|
+
}
|
|
6049
|
+
},
|
|
6050
|
+
"configured": true,
|
|
6051
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
6052
|
+
"updatedAt": "2025-10-09T15:02:00.000Z"
|
|
6053
|
+
}
|
|
5138
6054
|
},
|
|
5139
6055
|
"metadata": {
|
|
5140
6056
|
"type": "object",
|
|
@@ -5468,7 +6384,50 @@
|
|
|
5468
6384
|
"createdAt",
|
|
5469
6385
|
"updatedAt",
|
|
5470
6386
|
"choosenAuthMethod"
|
|
5471
|
-
]
|
|
6387
|
+
],
|
|
6388
|
+
"example": {
|
|
6389
|
+
"id": "970B0547",
|
|
6390
|
+
"userId": "user_1234567890abcdef",
|
|
6391
|
+
"journeyId": "journey_1234567890abcdef",
|
|
6392
|
+
"status": "submitted",
|
|
6393
|
+
"tags": [
|
|
6394
|
+
"urgent",
|
|
6395
|
+
"priority"
|
|
6396
|
+
],
|
|
6397
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
6398
|
+
"updatedAt": "2025-10-09T15:03:00.000Z",
|
|
6399
|
+
"steps": [
|
|
6400
|
+
{
|
|
6401
|
+
"id": "run_step_001",
|
|
6402
|
+
"runId": "970B0547",
|
|
6403
|
+
"stepId": "step_form_002",
|
|
6404
|
+
"stepType": "form",
|
|
6405
|
+
"status": "completed",
|
|
6406
|
+
"data": {
|
|
6407
|
+
"formSubmissionId": "68e7ce9c41ee8b6cfd77a68e",
|
|
6408
|
+
"amount": 25
|
|
6409
|
+
},
|
|
6410
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
6411
|
+
"updatedAt": "2025-10-09T15:02:30.000Z"
|
|
6412
|
+
},
|
|
6413
|
+
{
|
|
6414
|
+
"id": "run_step_002",
|
|
6415
|
+
"runId": "970B0547",
|
|
6416
|
+
"stepId": "step_payment_003",
|
|
6417
|
+
"stepType": "payment",
|
|
6418
|
+
"status": "completed",
|
|
6419
|
+
"data": {
|
|
6420
|
+
"transactionId": "txn_1234567890abcdef",
|
|
6421
|
+
"amount": 25,
|
|
6422
|
+
"date": "2025-10-09T15:03:00.000Z",
|
|
6423
|
+
"provider": "stripe"
|
|
6424
|
+
},
|
|
6425
|
+
"createdAt": "2025-10-09T15:02:30.000Z",
|
|
6426
|
+
"updatedAt": "2025-10-09T15:03:00.000Z"
|
|
6427
|
+
}
|
|
6428
|
+
],
|
|
6429
|
+
"choosenAuthMethod": "email_otp"
|
|
6430
|
+
}
|
|
5472
6431
|
}
|
|
5473
6432
|
},
|
|
5474
6433
|
"metadata": {
|
|
@@ -5802,6 +6761,19 @@
|
|
|
5802
6761
|
"data": {
|
|
5803
6762
|
"anyOf": [
|
|
5804
6763
|
{
|
|
6764
|
+
"examples": [
|
|
6765
|
+
{
|
|
6766
|
+
"formSubmissionId": "68e7ce9c41ee8b6cfd77a68e",
|
|
6767
|
+
"amount": 25
|
|
6768
|
+
},
|
|
6769
|
+
{
|
|
6770
|
+
"formSubmissionId": "form_submission_1234567890abcdef",
|
|
6771
|
+
"amount": 50
|
|
6772
|
+
},
|
|
6773
|
+
{
|
|
6774
|
+
"formSubmissionId": "form_submission_9876543210fedcba"
|
|
6775
|
+
}
|
|
6776
|
+
],
|
|
5805
6777
|
"type": "object",
|
|
5806
6778
|
"properties": {
|
|
5807
6779
|
"formSubmissionId": {
|
|
@@ -5816,6 +6788,26 @@
|
|
|
5816
6788
|
]
|
|
5817
6789
|
},
|
|
5818
6790
|
{
|
|
6791
|
+
"examples": [
|
|
6792
|
+
{
|
|
6793
|
+
"transactionId": "txn_1234567890abcdef",
|
|
6794
|
+
"amount": 25,
|
|
6795
|
+
"date": "2025-10-09T15:03:00.000Z",
|
|
6796
|
+
"provider": "stripe"
|
|
6797
|
+
},
|
|
6798
|
+
{
|
|
6799
|
+
"transactionId": "txn_9876543210fedcba",
|
|
6800
|
+
"amount": 50,
|
|
6801
|
+
"date": "2025-10-09T15:05:00.000Z",
|
|
6802
|
+
"provider": "realex"
|
|
6803
|
+
},
|
|
6804
|
+
{
|
|
6805
|
+
"transactionId": "txn_abcdef1234567890",
|
|
6806
|
+
"amount": 100,
|
|
6807
|
+
"date": "2025-10-09T15:10:00.000Z",
|
|
6808
|
+
"provider": "realex"
|
|
6809
|
+
}
|
|
6810
|
+
],
|
|
5819
6811
|
"type": "object",
|
|
5820
6812
|
"properties": {
|
|
5821
6813
|
"transactionId": {
|
|
@@ -5876,7 +6868,50 @@
|
|
|
5876
6868
|
"updatedAt",
|
|
5877
6869
|
"steps",
|
|
5878
6870
|
"choosenAuthMethod"
|
|
5879
|
-
]
|
|
6871
|
+
],
|
|
6872
|
+
"example": {
|
|
6873
|
+
"id": "970B0547",
|
|
6874
|
+
"userId": "user_1234567890abcdef",
|
|
6875
|
+
"journeyId": "journey_1234567890abcdef",
|
|
6876
|
+
"status": "submitted",
|
|
6877
|
+
"tags": [
|
|
6878
|
+
"urgent",
|
|
6879
|
+
"priority"
|
|
6880
|
+
],
|
|
6881
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
6882
|
+
"updatedAt": "2025-10-09T15:03:00.000Z",
|
|
6883
|
+
"steps": [
|
|
6884
|
+
{
|
|
6885
|
+
"id": "run_step_001",
|
|
6886
|
+
"runId": "970B0547",
|
|
6887
|
+
"stepId": "step_form_002",
|
|
6888
|
+
"stepType": "form",
|
|
6889
|
+
"status": "completed",
|
|
6890
|
+
"data": {
|
|
6891
|
+
"formSubmissionId": "68e7ce9c41ee8b6cfd77a68e",
|
|
6892
|
+
"amount": 25
|
|
6893
|
+
},
|
|
6894
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
6895
|
+
"updatedAt": "2025-10-09T15:02:30.000Z"
|
|
6896
|
+
},
|
|
6897
|
+
{
|
|
6898
|
+
"id": "run_step_002",
|
|
6899
|
+
"runId": "970B0547",
|
|
6900
|
+
"stepId": "step_payment_003",
|
|
6901
|
+
"stepType": "payment",
|
|
6902
|
+
"status": "completed",
|
|
6903
|
+
"data": {
|
|
6904
|
+
"transactionId": "txn_1234567890abcdef",
|
|
6905
|
+
"amount": 25,
|
|
6906
|
+
"date": "2025-10-09T15:03:00.000Z",
|
|
6907
|
+
"provider": "stripe"
|
|
6908
|
+
},
|
|
6909
|
+
"createdAt": "2025-10-09T15:02:30.000Z",
|
|
6910
|
+
"updatedAt": "2025-10-09T15:03:00.000Z"
|
|
6911
|
+
}
|
|
6912
|
+
],
|
|
6913
|
+
"choosenAuthMethod": "email_otp"
|
|
6914
|
+
}
|
|
5880
6915
|
},
|
|
5881
6916
|
"metadata": {
|
|
5882
6917
|
"type": "object",
|
|
@@ -6220,7 +7255,50 @@
|
|
|
6220
7255
|
"createdAt",
|
|
6221
7256
|
"updatedAt",
|
|
6222
7257
|
"choosenAuthMethod"
|
|
6223
|
-
]
|
|
7258
|
+
],
|
|
7259
|
+
"example": {
|
|
7260
|
+
"id": "970B0547",
|
|
7261
|
+
"userId": "user_1234567890abcdef",
|
|
7262
|
+
"journeyId": "journey_1234567890abcdef",
|
|
7263
|
+
"status": "submitted",
|
|
7264
|
+
"tags": [
|
|
7265
|
+
"urgent",
|
|
7266
|
+
"priority"
|
|
7267
|
+
],
|
|
7268
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
7269
|
+
"updatedAt": "2025-10-09T15:03:00.000Z",
|
|
7270
|
+
"steps": [
|
|
7271
|
+
{
|
|
7272
|
+
"id": "run_step_001",
|
|
7273
|
+
"runId": "970B0547",
|
|
7274
|
+
"stepId": "step_form_002",
|
|
7275
|
+
"stepType": "form",
|
|
7276
|
+
"status": "completed",
|
|
7277
|
+
"data": {
|
|
7278
|
+
"formSubmissionId": "68e7ce9c41ee8b6cfd77a68e",
|
|
7279
|
+
"amount": 25
|
|
7280
|
+
},
|
|
7281
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
7282
|
+
"updatedAt": "2025-10-09T15:02:30.000Z"
|
|
7283
|
+
},
|
|
7284
|
+
{
|
|
7285
|
+
"id": "run_step_002",
|
|
7286
|
+
"runId": "970B0547",
|
|
7287
|
+
"stepId": "step_payment_003",
|
|
7288
|
+
"stepType": "payment",
|
|
7289
|
+
"status": "completed",
|
|
7290
|
+
"data": {
|
|
7291
|
+
"transactionId": "txn_1234567890abcdef",
|
|
7292
|
+
"amount": 25,
|
|
7293
|
+
"date": "2025-10-09T15:03:00.000Z",
|
|
7294
|
+
"provider": "stripe"
|
|
7295
|
+
},
|
|
7296
|
+
"createdAt": "2025-10-09T15:02:30.000Z",
|
|
7297
|
+
"updatedAt": "2025-10-09T15:03:00.000Z"
|
|
7298
|
+
}
|
|
7299
|
+
],
|
|
7300
|
+
"choosenAuthMethod": "email_otp"
|
|
7301
|
+
}
|
|
6224
7302
|
}
|
|
6225
7303
|
},
|
|
6226
7304
|
"metadata": {
|
|
@@ -6554,6 +7632,19 @@
|
|
|
6554
7632
|
"data": {
|
|
6555
7633
|
"anyOf": [
|
|
6556
7634
|
{
|
|
7635
|
+
"examples": [
|
|
7636
|
+
{
|
|
7637
|
+
"formSubmissionId": "68e7ce9c41ee8b6cfd77a68e",
|
|
7638
|
+
"amount": 25
|
|
7639
|
+
},
|
|
7640
|
+
{
|
|
7641
|
+
"formSubmissionId": "form_submission_1234567890abcdef",
|
|
7642
|
+
"amount": 50
|
|
7643
|
+
},
|
|
7644
|
+
{
|
|
7645
|
+
"formSubmissionId": "form_submission_9876543210fedcba"
|
|
7646
|
+
}
|
|
7647
|
+
],
|
|
6557
7648
|
"type": "object",
|
|
6558
7649
|
"properties": {
|
|
6559
7650
|
"formSubmissionId": {
|
|
@@ -6568,6 +7659,26 @@
|
|
|
6568
7659
|
]
|
|
6569
7660
|
},
|
|
6570
7661
|
{
|
|
7662
|
+
"examples": [
|
|
7663
|
+
{
|
|
7664
|
+
"transactionId": "txn_1234567890abcdef",
|
|
7665
|
+
"amount": 25,
|
|
7666
|
+
"date": "2025-10-09T15:03:00.000Z",
|
|
7667
|
+
"provider": "stripe"
|
|
7668
|
+
},
|
|
7669
|
+
{
|
|
7670
|
+
"transactionId": "txn_9876543210fedcba",
|
|
7671
|
+
"amount": 50,
|
|
7672
|
+
"date": "2025-10-09T15:05:00.000Z",
|
|
7673
|
+
"provider": "realex"
|
|
7674
|
+
},
|
|
7675
|
+
{
|
|
7676
|
+
"transactionId": "txn_abcdef1234567890",
|
|
7677
|
+
"amount": 100,
|
|
7678
|
+
"date": "2025-10-09T15:10:00.000Z",
|
|
7679
|
+
"provider": "realex"
|
|
7680
|
+
}
|
|
7681
|
+
],
|
|
6571
7682
|
"type": "object",
|
|
6572
7683
|
"properties": {
|
|
6573
7684
|
"transactionId": {
|
|
@@ -7208,6 +8319,49 @@
|
|
|
7208
8319
|
"required": [
|
|
7209
8320
|
"status"
|
|
7210
8321
|
]
|
|
8322
|
+
},
|
|
8323
|
+
"example": {
|
|
8324
|
+
"id": "970B0547",
|
|
8325
|
+
"userId": "user_1234567890abcdef",
|
|
8326
|
+
"journeyId": "journey_1234567890abcdef",
|
|
8327
|
+
"status": "submitted",
|
|
8328
|
+
"tags": [
|
|
8329
|
+
"urgent",
|
|
8330
|
+
"priority"
|
|
8331
|
+
],
|
|
8332
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
8333
|
+
"updatedAt": "2025-10-09T15:03:00.000Z",
|
|
8334
|
+
"steps": [
|
|
8335
|
+
{
|
|
8336
|
+
"id": "run_step_001",
|
|
8337
|
+
"runId": "970B0547",
|
|
8338
|
+
"stepId": "step_form_002",
|
|
8339
|
+
"stepType": "form",
|
|
8340
|
+
"status": "completed",
|
|
8341
|
+
"data": {
|
|
8342
|
+
"formSubmissionId": "68e7ce9c41ee8b6cfd77a68e",
|
|
8343
|
+
"amount": 25
|
|
8344
|
+
},
|
|
8345
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
8346
|
+
"updatedAt": "2025-10-09T15:02:30.000Z"
|
|
8347
|
+
},
|
|
8348
|
+
{
|
|
8349
|
+
"id": "run_step_002",
|
|
8350
|
+
"runId": "970B0547",
|
|
8351
|
+
"stepId": "step_payment_003",
|
|
8352
|
+
"stepType": "payment",
|
|
8353
|
+
"status": "completed",
|
|
8354
|
+
"data": {
|
|
8355
|
+
"transactionId": "txn_1234567890abcdef",
|
|
8356
|
+
"amount": 25,
|
|
8357
|
+
"date": "2025-10-09T15:03:00.000Z",
|
|
8358
|
+
"provider": "stripe"
|
|
8359
|
+
},
|
|
8360
|
+
"createdAt": "2025-10-09T15:02:30.000Z",
|
|
8361
|
+
"updatedAt": "2025-10-09T15:03:00.000Z"
|
|
8362
|
+
}
|
|
8363
|
+
],
|
|
8364
|
+
"choosenAuthMethod": "email_otp"
|
|
7211
8365
|
}
|
|
7212
8366
|
}
|
|
7213
8367
|
},
|
|
@@ -7271,7 +8425,50 @@
|
|
|
7271
8425
|
},
|
|
7272
8426
|
"required": [
|
|
7273
8427
|
"status"
|
|
7274
|
-
]
|
|
8428
|
+
],
|
|
8429
|
+
"example": {
|
|
8430
|
+
"id": "970B0547",
|
|
8431
|
+
"userId": "user_1234567890abcdef",
|
|
8432
|
+
"journeyId": "journey_1234567890abcdef",
|
|
8433
|
+
"status": "submitted",
|
|
8434
|
+
"tags": [
|
|
8435
|
+
"urgent",
|
|
8436
|
+
"priority"
|
|
8437
|
+
],
|
|
8438
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
8439
|
+
"updatedAt": "2025-10-09T15:03:00.000Z",
|
|
8440
|
+
"steps": [
|
|
8441
|
+
{
|
|
8442
|
+
"id": "run_step_001",
|
|
8443
|
+
"runId": "970B0547",
|
|
8444
|
+
"stepId": "step_form_002",
|
|
8445
|
+
"stepType": "form",
|
|
8446
|
+
"status": "completed",
|
|
8447
|
+
"data": {
|
|
8448
|
+
"formSubmissionId": "68e7ce9c41ee8b6cfd77a68e",
|
|
8449
|
+
"amount": 25
|
|
8450
|
+
},
|
|
8451
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
8452
|
+
"updatedAt": "2025-10-09T15:02:30.000Z"
|
|
8453
|
+
},
|
|
8454
|
+
{
|
|
8455
|
+
"id": "run_step_002",
|
|
8456
|
+
"runId": "970B0547",
|
|
8457
|
+
"stepId": "step_payment_003",
|
|
8458
|
+
"stepType": "payment",
|
|
8459
|
+
"status": "completed",
|
|
8460
|
+
"data": {
|
|
8461
|
+
"transactionId": "txn_1234567890abcdef",
|
|
8462
|
+
"amount": 25,
|
|
8463
|
+
"date": "2025-10-09T15:03:00.000Z",
|
|
8464
|
+
"provider": "stripe"
|
|
8465
|
+
},
|
|
8466
|
+
"createdAt": "2025-10-09T15:02:30.000Z",
|
|
8467
|
+
"updatedAt": "2025-10-09T15:03:00.000Z"
|
|
8468
|
+
}
|
|
8469
|
+
],
|
|
8470
|
+
"choosenAuthMethod": "email_otp"
|
|
8471
|
+
}
|
|
7275
8472
|
},
|
|
7276
8473
|
"metadata": {
|
|
7277
8474
|
"type": "object",
|
|
@@ -8368,6 +9565,23 @@
|
|
|
8368
9565
|
"required": [
|
|
8369
9566
|
"journeyId"
|
|
8370
9567
|
]
|
|
9568
|
+
},
|
|
9569
|
+
"examples": {
|
|
9570
|
+
"example1": {
|
|
9571
|
+
"value": {
|
|
9572
|
+
"journeyId": "journey_1234567890abcdef"
|
|
9573
|
+
}
|
|
9574
|
+
},
|
|
9575
|
+
"example2": {
|
|
9576
|
+
"value": {
|
|
9577
|
+
"journeyId": "journey_9876543210fedcba"
|
|
9578
|
+
}
|
|
9579
|
+
},
|
|
9580
|
+
"example3": {
|
|
9581
|
+
"value": {
|
|
9582
|
+
"journeyId": "journey_abcdef1234567890"
|
|
9583
|
+
}
|
|
9584
|
+
}
|
|
8371
9585
|
}
|
|
8372
9586
|
}
|
|
8373
9587
|
},
|
|
@@ -8390,7 +9604,10 @@
|
|
|
8390
9604
|
},
|
|
8391
9605
|
"required": [
|
|
8392
9606
|
"id"
|
|
8393
|
-
]
|
|
9607
|
+
],
|
|
9608
|
+
"example": {
|
|
9609
|
+
"id": "db28c9c2-984c-4295-9a89-ee93f4b9f059"
|
|
9610
|
+
}
|
|
8394
9611
|
},
|
|
8395
9612
|
"metadata": {
|
|
8396
9613
|
"type": "object",
|
|
@@ -8758,6 +9975,29 @@
|
|
|
8758
9975
|
"runId",
|
|
8759
9976
|
"language"
|
|
8760
9977
|
]
|
|
9978
|
+
},
|
|
9979
|
+
"examples": {
|
|
9980
|
+
"example1": {
|
|
9981
|
+
"value": {
|
|
9982
|
+
"journeyId": "journey_1234567890abcdef",
|
|
9983
|
+
"runId": "970B0547",
|
|
9984
|
+
"language": "en"
|
|
9985
|
+
}
|
|
9986
|
+
},
|
|
9987
|
+
"example2": {
|
|
9988
|
+
"value": {
|
|
9989
|
+
"journeyId": "journey_9876543210fedcba",
|
|
9990
|
+
"runId": "run_9876543210fedcba",
|
|
9991
|
+
"language": "ga"
|
|
9992
|
+
}
|
|
9993
|
+
},
|
|
9994
|
+
"example3": {
|
|
9995
|
+
"value": {
|
|
9996
|
+
"journeyId": "journey_abcdef1234567890",
|
|
9997
|
+
"runId": "run_abcdef1234567890",
|
|
9998
|
+
"language": "en"
|
|
9999
|
+
}
|
|
10000
|
+
}
|
|
8761
10001
|
}
|
|
8762
10002
|
}
|
|
8763
10003
|
},
|
|
@@ -8825,7 +10065,12 @@
|
|
|
8825
10065
|
"url",
|
|
8826
10066
|
"stepId",
|
|
8827
10067
|
"stepType"
|
|
8828
|
-
]
|
|
10068
|
+
],
|
|
10069
|
+
"example": {
|
|
10070
|
+
"url": "https://forms.uat.services.gov.ie/admin/form/68ca7425d5fe2c00124268f6/results/68e7ce9c41ee8b6cfd77a68e",
|
|
10071
|
+
"stepId": "step_form_002",
|
|
10072
|
+
"stepType": "form"
|
|
10073
|
+
}
|
|
8829
10074
|
},
|
|
8830
10075
|
"metadata": {
|
|
8831
10076
|
"type": "object",
|
|
@@ -9267,7 +10512,12 @@
|
|
|
9267
10512
|
"url",
|
|
9268
10513
|
"stepId",
|
|
9269
10514
|
"stepType"
|
|
9270
|
-
]
|
|
10515
|
+
],
|
|
10516
|
+
"example": {
|
|
10517
|
+
"url": "https://forms.uat.services.gov.ie/admin/form/68ca7425d5fe2c00124268f6/results/68e7ce9c41ee8b6cfd77a68e",
|
|
10518
|
+
"stepId": "step_form_002",
|
|
10519
|
+
"stepType": "form"
|
|
10520
|
+
}
|
|
9271
10521
|
},
|
|
9272
10522
|
"metadata": {
|
|
9273
10523
|
"type": "object",
|
|
@@ -9669,6 +10919,7 @@
|
|
|
9669
10919
|
]
|
|
9670
10920
|
},
|
|
9671
10921
|
"returnUrl": {
|
|
10922
|
+
"validator": "URLValidator",
|
|
9672
10923
|
"type": "string"
|
|
9673
10924
|
}
|
|
9674
10925
|
},
|
|
@@ -9678,7 +10929,20 @@
|
|
|
9678
10929
|
"createdAt",
|
|
9679
10930
|
"actionLabel",
|
|
9680
10931
|
"returnUrl"
|
|
9681
|
-
]
|
|
10932
|
+
],
|
|
10933
|
+
"example": {
|
|
10934
|
+
"runId": "970B0547",
|
|
10935
|
+
"title": {
|
|
10936
|
+
"en": "Test messaging",
|
|
10937
|
+
"ga": "Teistphostú"
|
|
10938
|
+
},
|
|
10939
|
+
"createdAt": "2025-10-09T15:02:00.000Z",
|
|
10940
|
+
"actionLabel": {
|
|
10941
|
+
"en": "View Submission",
|
|
10942
|
+
"ga": "Féach ar an gCur isteach"
|
|
10943
|
+
},
|
|
10944
|
+
"returnUrl": "https://services.gov.ie/dashboard/submissions/970B0547"
|
|
10945
|
+
}
|
|
9682
10946
|
},
|
|
9683
10947
|
"metadata": {
|
|
9684
10948
|
"type": "object",
|
|
@@ -10027,6 +11291,18 @@
|
|
|
10027
11291
|
"required": [
|
|
10028
11292
|
"ok"
|
|
10029
11293
|
]
|
|
11294
|
+
},
|
|
11295
|
+
"examples": {
|
|
11296
|
+
"example1": {
|
|
11297
|
+
"value": {
|
|
11298
|
+
"ok": true
|
|
11299
|
+
}
|
|
11300
|
+
},
|
|
11301
|
+
"example2": {
|
|
11302
|
+
"value": {
|
|
11303
|
+
"ok": false
|
|
11304
|
+
}
|
|
11305
|
+
}
|
|
10030
11306
|
}
|
|
10031
11307
|
}
|
|
10032
11308
|
}
|
|
@@ -10170,6 +11446,14 @@
|
|
|
10170
11446
|
"name": "action",
|
|
10171
11447
|
"required": false
|
|
10172
11448
|
},
|
|
11449
|
+
{
|
|
11450
|
+
"schema": {
|
|
11451
|
+
"type": "string"
|
|
11452
|
+
},
|
|
11453
|
+
"in": "query",
|
|
11454
|
+
"name": "userId",
|
|
11455
|
+
"required": false
|
|
11456
|
+
},
|
|
10173
11457
|
{
|
|
10174
11458
|
"schema": {
|
|
10175
11459
|
"type": "string"
|