@ogcio/building-blocks-sdk 0.2.89 → 0.2.90
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +7 -0
- package/biome.jsonc +1 -1
- package/dist/client/clients/messaging/index.d.ts +86 -2
- package/dist/client/clients/messaging/index.d.ts.map +1 -1
- package/dist/client/clients/messaging/index.js +25 -2
- package/dist/client/clients/messaging/index.js.map +1 -1
- package/dist/client/clients/messaging/schema.d.ts +877 -2
- package/dist/client/clients/messaging/schema.d.ts.map +1 -1
- package/dist/client/clients/messaging/support.d.ts +2 -0
- package/dist/client/clients/messaging/support.d.ts.map +1 -1
- package/dist/client/clients/messaging/tags.d.ts +587 -0
- package/dist/client/clients/messaging/tags.d.ts.map +1 -0
- package/dist/client/clients/messaging/tags.js +49 -0
- package/dist/client/clients/messaging/tags.js.map +1 -0
- package/dist/client/clients/profile/index.d.ts.map +1 -1
- package/dist/client/clients/profile/index.js +1 -1
- package/dist/client/clients/profile/index.js.map +1 -1
- package/dist/client/clients/scheduler/schema.d.ts +1 -1
- package/dist/client/clients/scheduler/schema.d.ts.map +1 -1
- package/dist/client/clients/upload/index.d.ts +1 -1
- package/dist/client/clients/upload/index.d.ts.map +1 -1
- package/dist/client/clients/upload/schema.d.ts +4 -4
- package/dist/client/clients/upload/schema.d.ts.map +1 -1
- package/dist/client/clients/upload/support.d.ts +1 -1
- package/dist/client/clients/upload/support.d.ts.map +1 -1
- package/package.json +7 -7
- package/src/client/clients/messaging/index.ts +39 -2
- package/src/client/clients/messaging/open-api-definition.json +3113 -1242
- package/src/client/clients/messaging/schema.ts +877 -2
- package/src/client/clients/messaging/tags.ts +86 -0
- package/src/client/clients/profile/index.ts +1 -1
- package/src/client/clients/profile/open-api-definition.json +49 -0
- package/src/client/clients/scheduler/open-api-definition.json +33 -32
- package/src/client/clients/scheduler/schema.ts +1 -1
- package/src/client/clients/upload/open-api-definition.json +10 -6
- package/src/client/clients/upload/schema.ts +4 -4
|
@@ -57,6 +57,40 @@
|
|
|
57
57
|
"name": "search",
|
|
58
58
|
"required": false
|
|
59
59
|
},
|
|
60
|
+
{
|
|
61
|
+
"schema": {
|
|
62
|
+
"type": "string",
|
|
63
|
+
"format": "date-time"
|
|
64
|
+
},
|
|
65
|
+
"in": "query",
|
|
66
|
+
"name": "deletedAfterDateTime",
|
|
67
|
+
"required": false
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"schema": {
|
|
71
|
+
"type": "string",
|
|
72
|
+
"format": "uuid"
|
|
73
|
+
},
|
|
74
|
+
"in": "query",
|
|
75
|
+
"name": "tagId",
|
|
76
|
+
"required": false,
|
|
77
|
+
"description": "Filter messages by tag id"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"schema": {
|
|
81
|
+
"type": "string",
|
|
82
|
+
"enum": [
|
|
83
|
+
"true",
|
|
84
|
+
"false",
|
|
85
|
+
"0",
|
|
86
|
+
"1"
|
|
87
|
+
]
|
|
88
|
+
},
|
|
89
|
+
"in": "query",
|
|
90
|
+
"name": "untagged",
|
|
91
|
+
"required": false,
|
|
92
|
+
"description": "If true, return only messages without a tag"
|
|
93
|
+
},
|
|
60
94
|
{
|
|
61
95
|
"schema": {
|
|
62
96
|
"type": "string"
|
|
@@ -700,6 +734,192 @@
|
|
|
700
734
|
}
|
|
701
735
|
}
|
|
702
736
|
}
|
|
737
|
+
},
|
|
738
|
+
"delete": {
|
|
739
|
+
"tags": [
|
|
740
|
+
"Messages"
|
|
741
|
+
],
|
|
742
|
+
"description": "Deletes the message with the given message id",
|
|
743
|
+
"requestBody": {
|
|
744
|
+
"required": true,
|
|
745
|
+
"content": {
|
|
746
|
+
"application/json": {
|
|
747
|
+
"schema": {
|
|
748
|
+
"type": "object",
|
|
749
|
+
"required": [
|
|
750
|
+
"ids"
|
|
751
|
+
],
|
|
752
|
+
"properties": {
|
|
753
|
+
"ids": {
|
|
754
|
+
"type": "array",
|
|
755
|
+
"items": {
|
|
756
|
+
"type": "string",
|
|
757
|
+
"format": "uuid"
|
|
758
|
+
},
|
|
759
|
+
"description": "List of message ids to delete",
|
|
760
|
+
"minItems": 1,
|
|
761
|
+
"maxItems": 100
|
|
762
|
+
}
|
|
763
|
+
}
|
|
764
|
+
}
|
|
765
|
+
}
|
|
766
|
+
}
|
|
767
|
+
},
|
|
768
|
+
"responses": {
|
|
769
|
+
"200": {
|
|
770
|
+
"description": "Default Response",
|
|
771
|
+
"content": {
|
|
772
|
+
"application/json": {
|
|
773
|
+
"schema": {
|
|
774
|
+
"type": "object",
|
|
775
|
+
"required": [
|
|
776
|
+
"data"
|
|
777
|
+
],
|
|
778
|
+
"properties": {
|
|
779
|
+
"data": {
|
|
780
|
+
"type": "object",
|
|
781
|
+
"required": [
|
|
782
|
+
"ids"
|
|
783
|
+
],
|
|
784
|
+
"properties": {
|
|
785
|
+
"ids": {
|
|
786
|
+
"type": "array",
|
|
787
|
+
"items": {
|
|
788
|
+
"type": "string",
|
|
789
|
+
"format": "uuid"
|
|
790
|
+
},
|
|
791
|
+
"description": "List of message ids to delete",
|
|
792
|
+
"minItems": 1,
|
|
793
|
+
"maxItems": 100
|
|
794
|
+
}
|
|
795
|
+
}
|
|
796
|
+
}
|
|
797
|
+
}
|
|
798
|
+
}
|
|
799
|
+
}
|
|
800
|
+
}
|
|
801
|
+
},
|
|
802
|
+
"5XX": {
|
|
803
|
+
"description": "Default Response",
|
|
804
|
+
"content": {
|
|
805
|
+
"application/json": {
|
|
806
|
+
"schema": {
|
|
807
|
+
"type": "object",
|
|
808
|
+
"required": [
|
|
809
|
+
"code",
|
|
810
|
+
"detail",
|
|
811
|
+
"requestId",
|
|
812
|
+
"name",
|
|
813
|
+
"statusCode"
|
|
814
|
+
],
|
|
815
|
+
"properties": {
|
|
816
|
+
"code": {
|
|
817
|
+
"type": "string",
|
|
818
|
+
"description": "Code used to categorize the error"
|
|
819
|
+
},
|
|
820
|
+
"detail": {
|
|
821
|
+
"type": "string",
|
|
822
|
+
"description": "Description of the error"
|
|
823
|
+
},
|
|
824
|
+
"requestId": {
|
|
825
|
+
"type": "string",
|
|
826
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
827
|
+
},
|
|
828
|
+
"name": {
|
|
829
|
+
"type": "string",
|
|
830
|
+
"description": "Name of the error type"
|
|
831
|
+
},
|
|
832
|
+
"validation": {
|
|
833
|
+
"type": "array",
|
|
834
|
+
"items": {
|
|
835
|
+
"type": "object",
|
|
836
|
+
"required": [
|
|
837
|
+
"fieldName",
|
|
838
|
+
"message"
|
|
839
|
+
],
|
|
840
|
+
"properties": {
|
|
841
|
+
"fieldName": {
|
|
842
|
+
"type": "string"
|
|
843
|
+
},
|
|
844
|
+
"message": {
|
|
845
|
+
"type": "string"
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
},
|
|
849
|
+
"description": "List of the validation errors"
|
|
850
|
+
},
|
|
851
|
+
"validationContext": {
|
|
852
|
+
"type": "string"
|
|
853
|
+
},
|
|
854
|
+
"statusCode": {
|
|
855
|
+
"type": "number"
|
|
856
|
+
}
|
|
857
|
+
}
|
|
858
|
+
}
|
|
859
|
+
}
|
|
860
|
+
}
|
|
861
|
+
},
|
|
862
|
+
"4XX": {
|
|
863
|
+
"description": "Default Response",
|
|
864
|
+
"content": {
|
|
865
|
+
"application/json": {
|
|
866
|
+
"schema": {
|
|
867
|
+
"type": "object",
|
|
868
|
+
"required": [
|
|
869
|
+
"code",
|
|
870
|
+
"detail",
|
|
871
|
+
"requestId",
|
|
872
|
+
"name",
|
|
873
|
+
"statusCode"
|
|
874
|
+
],
|
|
875
|
+
"properties": {
|
|
876
|
+
"code": {
|
|
877
|
+
"type": "string",
|
|
878
|
+
"description": "Code used to categorize the error"
|
|
879
|
+
},
|
|
880
|
+
"detail": {
|
|
881
|
+
"type": "string",
|
|
882
|
+
"description": "Description of the error"
|
|
883
|
+
},
|
|
884
|
+
"requestId": {
|
|
885
|
+
"type": "string",
|
|
886
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
887
|
+
},
|
|
888
|
+
"name": {
|
|
889
|
+
"type": "string",
|
|
890
|
+
"description": "Name of the error type"
|
|
891
|
+
},
|
|
892
|
+
"validation": {
|
|
893
|
+
"type": "array",
|
|
894
|
+
"items": {
|
|
895
|
+
"type": "object",
|
|
896
|
+
"required": [
|
|
897
|
+
"fieldName",
|
|
898
|
+
"message"
|
|
899
|
+
],
|
|
900
|
+
"properties": {
|
|
901
|
+
"fieldName": {
|
|
902
|
+
"type": "string"
|
|
903
|
+
},
|
|
904
|
+
"message": {
|
|
905
|
+
"type": "string"
|
|
906
|
+
}
|
|
907
|
+
}
|
|
908
|
+
},
|
|
909
|
+
"description": "List of the validation errors"
|
|
910
|
+
},
|
|
911
|
+
"validationContext": {
|
|
912
|
+
"type": "string"
|
|
913
|
+
},
|
|
914
|
+
"statusCode": {
|
|
915
|
+
"type": "number"
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
}
|
|
920
|
+
}
|
|
921
|
+
}
|
|
922
|
+
}
|
|
703
923
|
}
|
|
704
924
|
},
|
|
705
925
|
"/api/v1/messages/search": {
|
|
@@ -734,6 +954,25 @@
|
|
|
734
954
|
"search": {
|
|
735
955
|
"type": "string"
|
|
736
956
|
},
|
|
957
|
+
"deletedAfterDateTime": {
|
|
958
|
+
"type": "string",
|
|
959
|
+
"format": "date-time"
|
|
960
|
+
},
|
|
961
|
+
"tagId": {
|
|
962
|
+
"type": "string",
|
|
963
|
+
"format": "uuid",
|
|
964
|
+
"description": "Filter messages by tag id"
|
|
965
|
+
},
|
|
966
|
+
"untagged": {
|
|
967
|
+
"type": "string",
|
|
968
|
+
"enum": [
|
|
969
|
+
"true",
|
|
970
|
+
"false",
|
|
971
|
+
"0",
|
|
972
|
+
"1"
|
|
973
|
+
],
|
|
974
|
+
"description": "If true, return only messages without a tag"
|
|
975
|
+
},
|
|
737
976
|
"recipientUserId": {
|
|
738
977
|
"type": "string",
|
|
739
978
|
"description": "Either recipientUserId and organisationId are mandatory"
|
|
@@ -1036,6 +1275,20 @@
|
|
|
1036
1275
|
],
|
|
1037
1276
|
"description": "Returns the requested message",
|
|
1038
1277
|
"parameters": [
|
|
1278
|
+
{
|
|
1279
|
+
"schema": {
|
|
1280
|
+
"type": "string",
|
|
1281
|
+
"enum": [
|
|
1282
|
+
"true",
|
|
1283
|
+
"false",
|
|
1284
|
+
"0",
|
|
1285
|
+
"1"
|
|
1286
|
+
]
|
|
1287
|
+
},
|
|
1288
|
+
"in": "query",
|
|
1289
|
+
"name": "deleted",
|
|
1290
|
+
"required": false
|
|
1291
|
+
},
|
|
1039
1292
|
{
|
|
1040
1293
|
"schema": {
|
|
1041
1294
|
"type": "string",
|
|
@@ -1794,64 +2047,51 @@
|
|
|
1794
2047
|
}
|
|
1795
2048
|
}
|
|
1796
2049
|
},
|
|
1797
|
-
"/api/v1/
|
|
1798
|
-
"
|
|
1799
|
-
"operationId": "
|
|
2050
|
+
"/api/v1/messages/tags": {
|
|
2051
|
+
"post": {
|
|
2052
|
+
"operationId": "AssignTagToMessages",
|
|
1800
2053
|
"tags": [
|
|
1801
|
-
"
|
|
2054
|
+
"Tags"
|
|
1802
2055
|
],
|
|
1803
|
-
"description": "
|
|
1804
|
-
"
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
|
-
"
|
|
1809
|
-
"
|
|
1810
|
-
"
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
|
|
1839
|
-
|
|
1840
|
-
"required": false,
|
|
1841
|
-
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
1842
|
-
},
|
|
1843
|
-
{
|
|
1844
|
-
"schema": {
|
|
1845
|
-
"type": "string",
|
|
1846
|
-
"default": "20",
|
|
1847
|
-
"pattern": "^([1-9]|100)|undefined$"
|
|
1848
|
-
},
|
|
1849
|
-
"in": "query",
|
|
1850
|
-
"name": "limit",
|
|
1851
|
-
"required": false,
|
|
1852
|
-
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
2056
|
+
"description": "Assigns or removes a tag on multiple messages",
|
|
2057
|
+
"requestBody": {
|
|
2058
|
+
"required": true,
|
|
2059
|
+
"content": {
|
|
2060
|
+
"application/json": {
|
|
2061
|
+
"schema": {
|
|
2062
|
+
"type": "object",
|
|
2063
|
+
"required": [
|
|
2064
|
+
"tagId",
|
|
2065
|
+
"messageIds"
|
|
2066
|
+
],
|
|
2067
|
+
"properties": {
|
|
2068
|
+
"tagId": {
|
|
2069
|
+
"anyOf": [
|
|
2070
|
+
{
|
|
2071
|
+
"type": "string",
|
|
2072
|
+
"format": "uuid",
|
|
2073
|
+
"description": "Tag id to assign"
|
|
2074
|
+
},
|
|
2075
|
+
{
|
|
2076
|
+
"type": "null",
|
|
2077
|
+
"description": "Set to null to remove the tag"
|
|
2078
|
+
}
|
|
2079
|
+
]
|
|
2080
|
+
},
|
|
2081
|
+
"messageIds": {
|
|
2082
|
+
"type": "array",
|
|
2083
|
+
"items": {
|
|
2084
|
+
"type": "string",
|
|
2085
|
+
"format": "uuid",
|
|
2086
|
+
"description": "Message ids to assign/remove the tag on"
|
|
2087
|
+
},
|
|
2088
|
+
"minItems": 1
|
|
2089
|
+
}
|
|
2090
|
+
}
|
|
2091
|
+
}
|
|
2092
|
+
}
|
|
1853
2093
|
}
|
|
1854
|
-
|
|
2094
|
+
},
|
|
1855
2095
|
"responses": {
|
|
1856
2096
|
"200": {
|
|
1857
2097
|
"description": "Default Response",
|
|
@@ -1864,35 +2104,28 @@
|
|
|
1864
2104
|
],
|
|
1865
2105
|
"properties": {
|
|
1866
2106
|
"data": {
|
|
1867
|
-
"type": "
|
|
1868
|
-
"
|
|
1869
|
-
"
|
|
1870
|
-
"
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
"
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
|
|
1878
|
-
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1886
|
-
"
|
|
1887
|
-
"type": "boolean",
|
|
1888
|
-
"description": "If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type"
|
|
1889
|
-
},
|
|
1890
|
-
"type": {
|
|
2107
|
+
"type": "object",
|
|
2108
|
+
"required": [
|
|
2109
|
+
"tagId",
|
|
2110
|
+
"messageIds"
|
|
2111
|
+
],
|
|
2112
|
+
"properties": {
|
|
2113
|
+
"tagId": {
|
|
2114
|
+
"anyOf": [
|
|
2115
|
+
{
|
|
2116
|
+
"type": "string",
|
|
2117
|
+
"format": "uuid"
|
|
2118
|
+
},
|
|
2119
|
+
{
|
|
2120
|
+
"type": "null"
|
|
2121
|
+
}
|
|
2122
|
+
]
|
|
2123
|
+
},
|
|
2124
|
+
"messageIds": {
|
|
2125
|
+
"type": "array",
|
|
2126
|
+
"items": {
|
|
1891
2127
|
"type": "string",
|
|
1892
|
-
"
|
|
1893
|
-
"email"
|
|
1894
|
-
],
|
|
1895
|
-
"description": "Provider types that can be manipulated"
|
|
2128
|
+
"format": "uuid"
|
|
1896
2129
|
}
|
|
1897
2130
|
}
|
|
1898
2131
|
}
|
|
@@ -1980,7 +2213,7 @@
|
|
|
1980
2213
|
}
|
|
1981
2214
|
}
|
|
1982
2215
|
},
|
|
1983
|
-
"
|
|
2216
|
+
"4XX": {
|
|
1984
2217
|
"description": "Default Response",
|
|
1985
2218
|
"content": {
|
|
1986
2219
|
"application/json": {
|
|
@@ -2040,7 +2273,7 @@
|
|
|
2040
2273
|
}
|
|
2041
2274
|
}
|
|
2042
2275
|
},
|
|
2043
|
-
"
|
|
2276
|
+
"5XX": {
|
|
2044
2277
|
"description": "Default Response",
|
|
2045
2278
|
"content": {
|
|
2046
2279
|
"application/json": {
|
|
@@ -2101,158 +2334,135 @@
|
|
|
2101
2334
|
}
|
|
2102
2335
|
}
|
|
2103
2336
|
}
|
|
2104
|
-
}
|
|
2105
|
-
|
|
2106
|
-
|
|
2337
|
+
}
|
|
2338
|
+
},
|
|
2339
|
+
"/api/v1/providers/": {
|
|
2340
|
+
"get": {
|
|
2341
|
+
"operationId": "ListProviders",
|
|
2107
2342
|
"tags": [
|
|
2108
2343
|
"Providers"
|
|
2109
2344
|
],
|
|
2110
|
-
"description": "
|
|
2111
|
-
"
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
"
|
|
2116
|
-
"
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
"
|
|
2175
|
-
|
|
2176
|
-
"
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
"
|
|
2186
|
-
"
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
-
|
|
2202
|
-
|
|
2203
|
-
|
|
2204
|
-
|
|
2205
|
-
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
|
|
2229
|
-
|
|
2230
|
-
|
|
2231
|
-
},
|
|
2232
|
-
"metadata": {
|
|
2233
|
-
"type": "object",
|
|
2234
|
-
"properties": {
|
|
2235
|
-
"links": {
|
|
2236
|
-
"type": "object",
|
|
2237
|
-
"required": [
|
|
2238
|
-
"self",
|
|
2239
|
-
"first",
|
|
2240
|
-
"last",
|
|
2241
|
-
"pages"
|
|
2242
|
-
],
|
|
2243
|
-
"properties": {
|
|
2244
|
-
"self": {
|
|
2245
|
-
"type": "object",
|
|
2246
|
-
"properties": {
|
|
2247
|
-
"href": {
|
|
2248
|
-
"type": "string",
|
|
2249
|
-
"description": "URL pointing to the request itself"
|
|
2250
|
-
}
|
|
2251
|
-
}
|
|
2252
|
-
},
|
|
2253
|
-
"next": {
|
|
2254
|
-
"type": "object",
|
|
2255
|
-
"properties": {
|
|
2345
|
+
"description": "Returns the providers matching the requested query",
|
|
2346
|
+
"parameters": [
|
|
2347
|
+
{
|
|
2348
|
+
"schema": {
|
|
2349
|
+
"type": "string",
|
|
2350
|
+
"enum": [
|
|
2351
|
+
"true",
|
|
2352
|
+
"false",
|
|
2353
|
+
"0",
|
|
2354
|
+
"1"
|
|
2355
|
+
]
|
|
2356
|
+
},
|
|
2357
|
+
"in": "query",
|
|
2358
|
+
"name": "primary",
|
|
2359
|
+
"required": false,
|
|
2360
|
+
"description": "If set, returns only the primary providers if true, otherwise the non-primary ones"
|
|
2361
|
+
},
|
|
2362
|
+
{
|
|
2363
|
+
"schema": {
|
|
2364
|
+
"type": "string",
|
|
2365
|
+
"enum": [
|
|
2366
|
+
"email"
|
|
2367
|
+
]
|
|
2368
|
+
},
|
|
2369
|
+
"in": "query",
|
|
2370
|
+
"name": "type",
|
|
2371
|
+
"required": true,
|
|
2372
|
+
"description": "Provider types that can be manipulated"
|
|
2373
|
+
},
|
|
2374
|
+
{
|
|
2375
|
+
"schema": {
|
|
2376
|
+
"type": "string",
|
|
2377
|
+
"pattern": "^[0-9][0-9]*|undefined$",
|
|
2378
|
+
"default": "0"
|
|
2379
|
+
},
|
|
2380
|
+
"in": "query",
|
|
2381
|
+
"name": "offset",
|
|
2382
|
+
"required": false,
|
|
2383
|
+
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
2384
|
+
},
|
|
2385
|
+
{
|
|
2386
|
+
"schema": {
|
|
2387
|
+
"type": "string",
|
|
2388
|
+
"default": "20",
|
|
2389
|
+
"pattern": "^([1-9]|100)|undefined$"
|
|
2390
|
+
},
|
|
2391
|
+
"in": "query",
|
|
2392
|
+
"name": "limit",
|
|
2393
|
+
"required": false,
|
|
2394
|
+
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
2395
|
+
}
|
|
2396
|
+
],
|
|
2397
|
+
"responses": {
|
|
2398
|
+
"200": {
|
|
2399
|
+
"description": "Default Response",
|
|
2400
|
+
"content": {
|
|
2401
|
+
"application/json": {
|
|
2402
|
+
"schema": {
|
|
2403
|
+
"type": "object",
|
|
2404
|
+
"required": [
|
|
2405
|
+
"data"
|
|
2406
|
+
],
|
|
2407
|
+
"properties": {
|
|
2408
|
+
"data": {
|
|
2409
|
+
"type": "array",
|
|
2410
|
+
"items": {
|
|
2411
|
+
"type": "object",
|
|
2412
|
+
"required": [
|
|
2413
|
+
"id",
|
|
2414
|
+
"providerName",
|
|
2415
|
+
"isPrimary",
|
|
2416
|
+
"type"
|
|
2417
|
+
],
|
|
2418
|
+
"properties": {
|
|
2419
|
+
"id": {
|
|
2420
|
+
"type": "string",
|
|
2421
|
+
"format": "uuid",
|
|
2422
|
+
"description": "Unique id of the provider"
|
|
2423
|
+
},
|
|
2424
|
+
"providerName": {
|
|
2425
|
+
"type": "string",
|
|
2426
|
+
"description": "Name of the provider"
|
|
2427
|
+
},
|
|
2428
|
+
"isPrimary": {
|
|
2429
|
+
"type": "boolean",
|
|
2430
|
+
"description": "If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type"
|
|
2431
|
+
},
|
|
2432
|
+
"type": {
|
|
2433
|
+
"type": "string",
|
|
2434
|
+
"enum": [
|
|
2435
|
+
"email"
|
|
2436
|
+
],
|
|
2437
|
+
"description": "Provider types that can be manipulated"
|
|
2438
|
+
}
|
|
2439
|
+
}
|
|
2440
|
+
}
|
|
2441
|
+
},
|
|
2442
|
+
"metadata": {
|
|
2443
|
+
"type": "object",
|
|
2444
|
+
"properties": {
|
|
2445
|
+
"links": {
|
|
2446
|
+
"type": "object",
|
|
2447
|
+
"required": [
|
|
2448
|
+
"self",
|
|
2449
|
+
"first",
|
|
2450
|
+
"last",
|
|
2451
|
+
"pages"
|
|
2452
|
+
],
|
|
2453
|
+
"properties": {
|
|
2454
|
+
"self": {
|
|
2455
|
+
"type": "object",
|
|
2456
|
+
"properties": {
|
|
2457
|
+
"href": {
|
|
2458
|
+
"type": "string",
|
|
2459
|
+
"description": "URL pointing to the request itself"
|
|
2460
|
+
}
|
|
2461
|
+
}
|
|
2462
|
+
},
|
|
2463
|
+
"next": {
|
|
2464
|
+
"type": "object",
|
|
2465
|
+
"properties": {
|
|
2256
2466
|
"href": {
|
|
2257
2467
|
"type": "string",
|
|
2258
2468
|
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
@@ -2433,39 +2643,113 @@
|
|
|
2433
2643
|
}
|
|
2434
2644
|
}
|
|
2435
2645
|
}
|
|
2436
|
-
}
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
"get": {
|
|
2646
|
+
},
|
|
2647
|
+
"post": {
|
|
2648
|
+
"operationId": "CreateProvider",
|
|
2440
2649
|
"tags": [
|
|
2441
2650
|
"Providers"
|
|
2442
2651
|
],
|
|
2443
|
-
"description": "
|
|
2444
|
-
"
|
|
2445
|
-
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
"
|
|
2449
|
-
"
|
|
2450
|
-
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
|
|
2464
|
-
|
|
2652
|
+
"description": "Creates a new provider",
|
|
2653
|
+
"requestBody": {
|
|
2654
|
+
"required": true,
|
|
2655
|
+
"content": {
|
|
2656
|
+
"application/json": {
|
|
2657
|
+
"schema": {
|
|
2658
|
+
"anyOf": [
|
|
2659
|
+
{
|
|
2660
|
+
"type": "object",
|
|
2661
|
+
"required": [
|
|
2662
|
+
"providerName",
|
|
2663
|
+
"isPrimary",
|
|
2664
|
+
"type",
|
|
2665
|
+
"smtpHost",
|
|
2666
|
+
"smtpPort",
|
|
2667
|
+
"username",
|
|
2668
|
+
"password",
|
|
2669
|
+
"fromAddress",
|
|
2670
|
+
"ssl"
|
|
2671
|
+
],
|
|
2672
|
+
"properties": {
|
|
2673
|
+
"providerName": {
|
|
2674
|
+
"type": "string",
|
|
2675
|
+
"description": "Name of the provider",
|
|
2676
|
+
"minLength": 1
|
|
2677
|
+
},
|
|
2678
|
+
"isPrimary": {
|
|
2679
|
+
"type": "boolean",
|
|
2680
|
+
"description": "If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type"
|
|
2681
|
+
},
|
|
2682
|
+
"type": {
|
|
2683
|
+
"type": "string",
|
|
2684
|
+
"enum": [
|
|
2685
|
+
"email"
|
|
2686
|
+
]
|
|
2687
|
+
},
|
|
2688
|
+
"smtpHost": {
|
|
2689
|
+
"type": "string",
|
|
2690
|
+
"description": "Address of the SMTP host",
|
|
2691
|
+
"minLength": 1
|
|
2692
|
+
},
|
|
2693
|
+
"smtpPort": {
|
|
2694
|
+
"type": "number",
|
|
2695
|
+
"description": "Port of the SMTP host"
|
|
2696
|
+
},
|
|
2697
|
+
"username": {
|
|
2698
|
+
"type": "string",
|
|
2699
|
+
"description": "Username to use to log into the SMTP server",
|
|
2700
|
+
"minLength": 1
|
|
2701
|
+
},
|
|
2702
|
+
"password": {
|
|
2703
|
+
"type": "string",
|
|
2704
|
+
"description": "Password to use to log into the SMTP server",
|
|
2705
|
+
"minLength": 1
|
|
2706
|
+
},
|
|
2707
|
+
"throttle": {
|
|
2708
|
+
"type": "number",
|
|
2709
|
+
"description": "Optional field to adjust how long time between each mail, in miliseconds"
|
|
2710
|
+
},
|
|
2711
|
+
"fromAddress": {
|
|
2712
|
+
"type": "string",
|
|
2713
|
+
"description": "Email address to use as sender",
|
|
2714
|
+
"minLength": 1
|
|
2715
|
+
},
|
|
2716
|
+
"ssl": {
|
|
2717
|
+
"type": "boolean",
|
|
2718
|
+
"description": "Is connection to the SMTP server secure?"
|
|
2719
|
+
},
|
|
2720
|
+
"headers": {
|
|
2721
|
+
"anyOf": [
|
|
2722
|
+
{
|
|
2723
|
+
"type": "null"
|
|
2724
|
+
},
|
|
2725
|
+
{
|
|
2726
|
+
"type": "object",
|
|
2727
|
+
"description": "Optional field to add custom headers to all emails sent with this provider",
|
|
2728
|
+
"additionalProperties": {
|
|
2729
|
+
"anyOf": [
|
|
2730
|
+
{
|
|
2731
|
+
"type": "string"
|
|
2732
|
+
},
|
|
2733
|
+
{
|
|
2734
|
+
"type": "array",
|
|
2735
|
+
"items": {
|
|
2736
|
+
"type": "string"
|
|
2737
|
+
}
|
|
2738
|
+
}
|
|
2739
|
+
]
|
|
2740
|
+
}
|
|
2741
|
+
}
|
|
2742
|
+
]
|
|
2743
|
+
}
|
|
2744
|
+
}
|
|
2745
|
+
}
|
|
2746
|
+
]
|
|
2747
|
+
}
|
|
2748
|
+
}
|
|
2465
2749
|
}
|
|
2466
|
-
|
|
2750
|
+
},
|
|
2467
2751
|
"responses": {
|
|
2468
|
-
"
|
|
2752
|
+
"201": {
|
|
2469
2753
|
"description": "Default Response",
|
|
2470
2754
|
"content": {
|
|
2471
2755
|
"application/json": {
|
|
@@ -2478,85 +2762,12 @@
|
|
|
2478
2762
|
"data": {
|
|
2479
2763
|
"type": "object",
|
|
2480
2764
|
"required": [
|
|
2481
|
-
"id"
|
|
2482
|
-
"providerName",
|
|
2483
|
-
"isPrimary",
|
|
2484
|
-
"type",
|
|
2485
|
-
"smtpHost",
|
|
2486
|
-
"smtpPort",
|
|
2487
|
-
"username",
|
|
2488
|
-
"fromAddress",
|
|
2489
|
-
"ssl"
|
|
2765
|
+
"id"
|
|
2490
2766
|
],
|
|
2491
2767
|
"properties": {
|
|
2492
2768
|
"id": {
|
|
2493
2769
|
"type": "string",
|
|
2494
2770
|
"format": "uuid"
|
|
2495
|
-
},
|
|
2496
|
-
"providerName": {
|
|
2497
|
-
"type": "string",
|
|
2498
|
-
"description": "Name of the provider",
|
|
2499
|
-
"minLength": 1
|
|
2500
|
-
},
|
|
2501
|
-
"isPrimary": {
|
|
2502
|
-
"type": "boolean",
|
|
2503
|
-
"description": "If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type"
|
|
2504
|
-
},
|
|
2505
|
-
"type": {
|
|
2506
|
-
"type": "string",
|
|
2507
|
-
"enum": [
|
|
2508
|
-
"email"
|
|
2509
|
-
]
|
|
2510
|
-
},
|
|
2511
|
-
"smtpHost": {
|
|
2512
|
-
"type": "string",
|
|
2513
|
-
"description": "Address of the SMTP host",
|
|
2514
|
-
"minLength": 1
|
|
2515
|
-
},
|
|
2516
|
-
"smtpPort": {
|
|
2517
|
-
"type": "number",
|
|
2518
|
-
"description": "Port of the SMTP host"
|
|
2519
|
-
},
|
|
2520
|
-
"username": {
|
|
2521
|
-
"type": "string",
|
|
2522
|
-
"description": "Username to use to log into the SMTP server",
|
|
2523
|
-
"minLength": 1
|
|
2524
|
-
},
|
|
2525
|
-
"throttle": {
|
|
2526
|
-
"type": "number",
|
|
2527
|
-
"description": "Optional field to adjust how long time between each mail, in miliseconds"
|
|
2528
|
-
},
|
|
2529
|
-
"fromAddress": {
|
|
2530
|
-
"type": "string",
|
|
2531
|
-
"description": "Email address to use as sender",
|
|
2532
|
-
"minLength": 1
|
|
2533
|
-
},
|
|
2534
|
-
"ssl": {
|
|
2535
|
-
"type": "boolean",
|
|
2536
|
-
"description": "Is connection to the SMTP server secure?"
|
|
2537
|
-
},
|
|
2538
|
-
"headers": {
|
|
2539
|
-
"anyOf": [
|
|
2540
|
-
{
|
|
2541
|
-
"type": "null"
|
|
2542
|
-
},
|
|
2543
|
-
{
|
|
2544
|
-
"type": "object",
|
|
2545
|
-
"additionalProperties": {
|
|
2546
|
-
"anyOf": [
|
|
2547
|
-
{
|
|
2548
|
-
"type": "string"
|
|
2549
|
-
},
|
|
2550
|
-
{
|
|
2551
|
-
"type": "array",
|
|
2552
|
-
"items": {
|
|
2553
|
-
"type": "string"
|
|
2554
|
-
}
|
|
2555
|
-
}
|
|
2556
|
-
]
|
|
2557
|
-
}
|
|
2558
|
-
}
|
|
2559
|
-
]
|
|
2560
2771
|
}
|
|
2561
2772
|
}
|
|
2562
2773
|
},
|
|
@@ -2764,118 +2975,27 @@
|
|
|
2764
2975
|
}
|
|
2765
2976
|
}
|
|
2766
2977
|
}
|
|
2767
|
-
}
|
|
2768
|
-
|
|
2769
|
-
|
|
2978
|
+
}
|
|
2979
|
+
},
|
|
2980
|
+
"/api/v1/providers/{providerId}": {
|
|
2981
|
+
"get": {
|
|
2770
2982
|
"tags": [
|
|
2771
2983
|
"Providers"
|
|
2772
2984
|
],
|
|
2773
|
-
"description": "
|
|
2774
|
-
"requestBody": {
|
|
2775
|
-
"required": true,
|
|
2776
|
-
"content": {
|
|
2777
|
-
"application/json": {
|
|
2778
|
-
"schema": {
|
|
2779
|
-
"type": "object",
|
|
2780
|
-
"required": [
|
|
2781
|
-
"id",
|
|
2782
|
-
"providerName",
|
|
2783
|
-
"isPrimary",
|
|
2784
|
-
"type",
|
|
2785
|
-
"smtpHost",
|
|
2786
|
-
"smtpPort",
|
|
2787
|
-
"username",
|
|
2788
|
-
"fromAddress",
|
|
2789
|
-
"ssl"
|
|
2790
|
-
],
|
|
2791
|
-
"properties": {
|
|
2792
|
-
"id": {
|
|
2793
|
-
"type": "string",
|
|
2794
|
-
"format": "uuid"
|
|
2795
|
-
},
|
|
2796
|
-
"providerName": {
|
|
2797
|
-
"type": "string",
|
|
2798
|
-
"description": "Name of the provider",
|
|
2799
|
-
"minLength": 1
|
|
2800
|
-
},
|
|
2801
|
-
"isPrimary": {
|
|
2802
|
-
"type": "boolean",
|
|
2803
|
-
"description": "If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type"
|
|
2804
|
-
},
|
|
2805
|
-
"type": {
|
|
2806
|
-
"type": "string",
|
|
2807
|
-
"enum": [
|
|
2808
|
-
"email"
|
|
2809
|
-
]
|
|
2810
|
-
},
|
|
2811
|
-
"smtpHost": {
|
|
2812
|
-
"type": "string",
|
|
2813
|
-
"description": "Address of the SMTP host",
|
|
2814
|
-
"minLength": 1
|
|
2815
|
-
},
|
|
2816
|
-
"smtpPort": {
|
|
2817
|
-
"type": "number",
|
|
2818
|
-
"description": "Port of the SMTP host"
|
|
2819
|
-
},
|
|
2820
|
-
"username": {
|
|
2821
|
-
"type": "string",
|
|
2822
|
-
"description": "Username to use to log into the SMTP server",
|
|
2823
|
-
"minLength": 1
|
|
2824
|
-
},
|
|
2825
|
-
"throttle": {
|
|
2826
|
-
"type": "number",
|
|
2827
|
-
"description": "Optional field to adjust how long time between each mail, in miliseconds"
|
|
2828
|
-
},
|
|
2829
|
-
"fromAddress": {
|
|
2830
|
-
"type": "string",
|
|
2831
|
-
"description": "Email address to use as sender",
|
|
2832
|
-
"minLength": 1
|
|
2833
|
-
},
|
|
2834
|
-
"ssl": {
|
|
2835
|
-
"type": "boolean",
|
|
2836
|
-
"description": "Is connection to the SMTP server secure?"
|
|
2837
|
-
},
|
|
2838
|
-
"headers": {
|
|
2839
|
-
"anyOf": [
|
|
2840
|
-
{
|
|
2841
|
-
"type": "null"
|
|
2842
|
-
},
|
|
2843
|
-
{
|
|
2844
|
-
"type": "object",
|
|
2845
|
-
"additionalProperties": {
|
|
2846
|
-
"anyOf": [
|
|
2847
|
-
{
|
|
2848
|
-
"type": "string"
|
|
2849
|
-
},
|
|
2850
|
-
{
|
|
2851
|
-
"type": "array",
|
|
2852
|
-
"items": {
|
|
2853
|
-
"type": "string"
|
|
2854
|
-
}
|
|
2855
|
-
}
|
|
2856
|
-
]
|
|
2857
|
-
}
|
|
2858
|
-
}
|
|
2859
|
-
]
|
|
2860
|
-
},
|
|
2861
|
-
"password": {
|
|
2862
|
-
"anyOf": [
|
|
2863
|
-
{
|
|
2864
|
-
"type": "string",
|
|
2865
|
-
"description": "Password to use to log into the SMTP server",
|
|
2866
|
-
"minLength": 0
|
|
2867
|
-
},
|
|
2868
|
-
{
|
|
2869
|
-
"type": "null"
|
|
2870
|
-
}
|
|
2871
|
-
]
|
|
2872
|
-
}
|
|
2873
|
-
}
|
|
2874
|
-
}
|
|
2875
|
-
}
|
|
2876
|
-
}
|
|
2877
|
-
},
|
|
2985
|
+
"description": "Returns the requested provider",
|
|
2878
2986
|
"parameters": [
|
|
2987
|
+
{
|
|
2988
|
+
"schema": {
|
|
2989
|
+
"type": "string",
|
|
2990
|
+
"enum": [
|
|
2991
|
+
"email"
|
|
2992
|
+
]
|
|
2993
|
+
},
|
|
2994
|
+
"in": "query",
|
|
2995
|
+
"name": "type",
|
|
2996
|
+
"required": true,
|
|
2997
|
+
"description": "Provider types that can be manipulated"
|
|
2998
|
+
},
|
|
2879
2999
|
{
|
|
2880
3000
|
"schema": {
|
|
2881
3001
|
"type": "string",
|
|
@@ -2900,63 +3020,137 @@
|
|
|
2900
3020
|
"data": {
|
|
2901
3021
|
"type": "object",
|
|
2902
3022
|
"required": [
|
|
2903
|
-
"id"
|
|
3023
|
+
"id",
|
|
3024
|
+
"providerName",
|
|
3025
|
+
"isPrimary",
|
|
3026
|
+
"type",
|
|
3027
|
+
"smtpHost",
|
|
3028
|
+
"smtpPort",
|
|
3029
|
+
"username",
|
|
3030
|
+
"fromAddress",
|
|
3031
|
+
"ssl"
|
|
2904
3032
|
],
|
|
2905
3033
|
"properties": {
|
|
2906
3034
|
"id": {
|
|
2907
3035
|
"type": "string",
|
|
2908
3036
|
"format": "uuid"
|
|
2909
|
-
}
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
"
|
|
2916
|
-
"type": "
|
|
2917
|
-
"
|
|
2918
|
-
|
|
2919
|
-
|
|
2920
|
-
|
|
2921
|
-
|
|
2922
|
-
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2936
|
-
|
|
2937
|
-
|
|
2938
|
-
|
|
2939
|
-
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
|
|
2957
|
-
|
|
2958
|
-
|
|
2959
|
-
|
|
3037
|
+
},
|
|
3038
|
+
"providerName": {
|
|
3039
|
+
"type": "string",
|
|
3040
|
+
"description": "Name of the provider",
|
|
3041
|
+
"minLength": 1
|
|
3042
|
+
},
|
|
3043
|
+
"isPrimary": {
|
|
3044
|
+
"type": "boolean",
|
|
3045
|
+
"description": "If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type"
|
|
3046
|
+
},
|
|
3047
|
+
"type": {
|
|
3048
|
+
"type": "string",
|
|
3049
|
+
"enum": [
|
|
3050
|
+
"email"
|
|
3051
|
+
]
|
|
3052
|
+
},
|
|
3053
|
+
"smtpHost": {
|
|
3054
|
+
"type": "string",
|
|
3055
|
+
"description": "Address of the SMTP host",
|
|
3056
|
+
"minLength": 1
|
|
3057
|
+
},
|
|
3058
|
+
"smtpPort": {
|
|
3059
|
+
"type": "number",
|
|
3060
|
+
"description": "Port of the SMTP host"
|
|
3061
|
+
},
|
|
3062
|
+
"username": {
|
|
3063
|
+
"type": "string",
|
|
3064
|
+
"description": "Username to use to log into the SMTP server",
|
|
3065
|
+
"minLength": 1
|
|
3066
|
+
},
|
|
3067
|
+
"throttle": {
|
|
3068
|
+
"type": "number",
|
|
3069
|
+
"description": "Optional field to adjust how long time between each mail, in miliseconds"
|
|
3070
|
+
},
|
|
3071
|
+
"fromAddress": {
|
|
3072
|
+
"type": "string",
|
|
3073
|
+
"description": "Email address to use as sender",
|
|
3074
|
+
"minLength": 1
|
|
3075
|
+
},
|
|
3076
|
+
"ssl": {
|
|
3077
|
+
"type": "boolean",
|
|
3078
|
+
"description": "Is connection to the SMTP server secure?"
|
|
3079
|
+
},
|
|
3080
|
+
"headers": {
|
|
3081
|
+
"anyOf": [
|
|
3082
|
+
{
|
|
3083
|
+
"type": "null"
|
|
3084
|
+
},
|
|
3085
|
+
{
|
|
3086
|
+
"type": "object",
|
|
3087
|
+
"description": "Optional field to add custom headers to all emails sent with this provider",
|
|
3088
|
+
"additionalProperties": {
|
|
3089
|
+
"anyOf": [
|
|
3090
|
+
{
|
|
3091
|
+
"type": "string"
|
|
3092
|
+
},
|
|
3093
|
+
{
|
|
3094
|
+
"type": "array",
|
|
3095
|
+
"items": {
|
|
3096
|
+
"type": "string"
|
|
3097
|
+
}
|
|
3098
|
+
}
|
|
3099
|
+
]
|
|
3100
|
+
}
|
|
3101
|
+
}
|
|
3102
|
+
]
|
|
3103
|
+
}
|
|
3104
|
+
}
|
|
3105
|
+
},
|
|
3106
|
+
"metadata": {
|
|
3107
|
+
"type": "object",
|
|
3108
|
+
"properties": {
|
|
3109
|
+
"links": {
|
|
3110
|
+
"type": "object",
|
|
3111
|
+
"required": [
|
|
3112
|
+
"self",
|
|
3113
|
+
"first",
|
|
3114
|
+
"last",
|
|
3115
|
+
"pages"
|
|
3116
|
+
],
|
|
3117
|
+
"properties": {
|
|
3118
|
+
"self": {
|
|
3119
|
+
"type": "object",
|
|
3120
|
+
"properties": {
|
|
3121
|
+
"href": {
|
|
3122
|
+
"type": "string",
|
|
3123
|
+
"description": "URL pointing to the request itself"
|
|
3124
|
+
}
|
|
3125
|
+
}
|
|
3126
|
+
},
|
|
3127
|
+
"next": {
|
|
3128
|
+
"type": "object",
|
|
3129
|
+
"properties": {
|
|
3130
|
+
"href": {
|
|
3131
|
+
"type": "string",
|
|
3132
|
+
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
3133
|
+
}
|
|
3134
|
+
}
|
|
3135
|
+
},
|
|
3136
|
+
"prev": {
|
|
3137
|
+
"type": "object",
|
|
3138
|
+
"properties": {
|
|
3139
|
+
"href": {
|
|
3140
|
+
"type": "string",
|
|
3141
|
+
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
3142
|
+
}
|
|
3143
|
+
}
|
|
3144
|
+
},
|
|
3145
|
+
"first": {
|
|
3146
|
+
"type": "object",
|
|
3147
|
+
"properties": {
|
|
3148
|
+
"href": {
|
|
3149
|
+
"type": "string",
|
|
3150
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
3151
|
+
}
|
|
3152
|
+
}
|
|
3153
|
+
},
|
|
2960
3154
|
"last": {
|
|
2961
3155
|
"type": "object",
|
|
2962
3156
|
"properties": {
|
|
@@ -3114,25 +3308,118 @@
|
|
|
3114
3308
|
}
|
|
3115
3309
|
}
|
|
3116
3310
|
},
|
|
3117
|
-
"
|
|
3118
|
-
"operationId": "
|
|
3311
|
+
"put": {
|
|
3312
|
+
"operationId": "UpdateProvider",
|
|
3119
3313
|
"tags": [
|
|
3120
3314
|
"Providers"
|
|
3121
3315
|
],
|
|
3122
|
-
"description": "
|
|
3316
|
+
"description": "Updates the requested provider",
|
|
3317
|
+
"requestBody": {
|
|
3318
|
+
"required": true,
|
|
3319
|
+
"content": {
|
|
3320
|
+
"application/json": {
|
|
3321
|
+
"schema": {
|
|
3322
|
+
"type": "object",
|
|
3323
|
+
"required": [
|
|
3324
|
+
"id",
|
|
3325
|
+
"providerName",
|
|
3326
|
+
"isPrimary",
|
|
3327
|
+
"type",
|
|
3328
|
+
"smtpHost",
|
|
3329
|
+
"smtpPort",
|
|
3330
|
+
"username",
|
|
3331
|
+
"fromAddress",
|
|
3332
|
+
"ssl"
|
|
3333
|
+
],
|
|
3334
|
+
"properties": {
|
|
3335
|
+
"id": {
|
|
3336
|
+
"type": "string",
|
|
3337
|
+
"format": "uuid"
|
|
3338
|
+
},
|
|
3339
|
+
"providerName": {
|
|
3340
|
+
"type": "string",
|
|
3341
|
+
"description": "Name of the provider",
|
|
3342
|
+
"minLength": 1
|
|
3343
|
+
},
|
|
3344
|
+
"isPrimary": {
|
|
3345
|
+
"type": "boolean",
|
|
3346
|
+
"description": "If true, the provider is set as primary for the selected type for the current organisation. Please note, each organisation can only have one primary provider for each type"
|
|
3347
|
+
},
|
|
3348
|
+
"type": {
|
|
3349
|
+
"type": "string",
|
|
3350
|
+
"enum": [
|
|
3351
|
+
"email"
|
|
3352
|
+
]
|
|
3353
|
+
},
|
|
3354
|
+
"smtpHost": {
|
|
3355
|
+
"type": "string",
|
|
3356
|
+
"description": "Address of the SMTP host",
|
|
3357
|
+
"minLength": 1
|
|
3358
|
+
},
|
|
3359
|
+
"smtpPort": {
|
|
3360
|
+
"type": "number",
|
|
3361
|
+
"description": "Port of the SMTP host"
|
|
3362
|
+
},
|
|
3363
|
+
"username": {
|
|
3364
|
+
"type": "string",
|
|
3365
|
+
"description": "Username to use to log into the SMTP server",
|
|
3366
|
+
"minLength": 1
|
|
3367
|
+
},
|
|
3368
|
+
"throttle": {
|
|
3369
|
+
"type": "number",
|
|
3370
|
+
"description": "Optional field to adjust how long time between each mail, in miliseconds"
|
|
3371
|
+
},
|
|
3372
|
+
"fromAddress": {
|
|
3373
|
+
"type": "string",
|
|
3374
|
+
"description": "Email address to use as sender",
|
|
3375
|
+
"minLength": 1
|
|
3376
|
+
},
|
|
3377
|
+
"ssl": {
|
|
3378
|
+
"type": "boolean",
|
|
3379
|
+
"description": "Is connection to the SMTP server secure?"
|
|
3380
|
+
},
|
|
3381
|
+
"headers": {
|
|
3382
|
+
"anyOf": [
|
|
3383
|
+
{
|
|
3384
|
+
"type": "null"
|
|
3385
|
+
},
|
|
3386
|
+
{
|
|
3387
|
+
"type": "object",
|
|
3388
|
+
"description": "Optional field to add custom headers to all emails sent with this provider",
|
|
3389
|
+
"additionalProperties": {
|
|
3390
|
+
"anyOf": [
|
|
3391
|
+
{
|
|
3392
|
+
"type": "string"
|
|
3393
|
+
},
|
|
3394
|
+
{
|
|
3395
|
+
"type": "array",
|
|
3396
|
+
"items": {
|
|
3397
|
+
"type": "string"
|
|
3398
|
+
}
|
|
3399
|
+
}
|
|
3400
|
+
]
|
|
3401
|
+
}
|
|
3402
|
+
}
|
|
3403
|
+
]
|
|
3404
|
+
},
|
|
3405
|
+
"password": {
|
|
3406
|
+
"anyOf": [
|
|
3407
|
+
{
|
|
3408
|
+
"type": "string",
|
|
3409
|
+
"description": "Password to use to log into the SMTP server",
|
|
3410
|
+
"minLength": 0
|
|
3411
|
+
},
|
|
3412
|
+
{
|
|
3413
|
+
"type": "null"
|
|
3414
|
+
}
|
|
3415
|
+
]
|
|
3416
|
+
}
|
|
3417
|
+
}
|
|
3418
|
+
}
|
|
3419
|
+
}
|
|
3420
|
+
}
|
|
3421
|
+
},
|
|
3123
3422
|
"parameters": [
|
|
3124
|
-
{
|
|
3125
|
-
"schema": {
|
|
3126
|
-
"type": "string",
|
|
3127
|
-
"enum": [
|
|
3128
|
-
"email"
|
|
3129
|
-
]
|
|
3130
|
-
},
|
|
3131
|
-
"in": "query",
|
|
3132
|
-
"name": "type",
|
|
3133
|
-
"required": true,
|
|
3134
|
-
"description": "Provider types that can be manipulated"
|
|
3135
|
-
},
|
|
3136
3423
|
{
|
|
3137
3424
|
"schema": {
|
|
3138
3425
|
"type": "string",
|
|
@@ -3370,46 +3657,34 @@
|
|
|
3370
3657
|
}
|
|
3371
3658
|
}
|
|
3372
3659
|
}
|
|
3373
|
-
}
|
|
3374
|
-
|
|
3375
|
-
|
|
3376
|
-
"get": {
|
|
3377
|
-
"operationId": "ListTemplates",
|
|
3660
|
+
},
|
|
3661
|
+
"delete": {
|
|
3662
|
+
"operationId": "DeleteProvider",
|
|
3378
3663
|
"tags": [
|
|
3379
|
-
"
|
|
3664
|
+
"Providers"
|
|
3380
3665
|
],
|
|
3381
|
-
"description": "
|
|
3666
|
+
"description": "Deletes the requested provider",
|
|
3382
3667
|
"parameters": [
|
|
3383
3668
|
{
|
|
3384
3669
|
"schema": {
|
|
3385
3670
|
"type": "string",
|
|
3386
|
-
"
|
|
3387
|
-
|
|
3671
|
+
"enum": [
|
|
3672
|
+
"email"
|
|
3673
|
+
]
|
|
3388
3674
|
},
|
|
3389
3675
|
"in": "query",
|
|
3390
|
-
"name": "
|
|
3391
|
-
"required":
|
|
3392
|
-
"description": "
|
|
3676
|
+
"name": "type",
|
|
3677
|
+
"required": true,
|
|
3678
|
+
"description": "Provider types that can be manipulated"
|
|
3393
3679
|
},
|
|
3394
3680
|
{
|
|
3395
3681
|
"schema": {
|
|
3396
3682
|
"type": "string",
|
|
3397
|
-
"
|
|
3398
|
-
"pattern": "^([1-9]|100)|undefined$"
|
|
3399
|
-
},
|
|
3400
|
-
"in": "query",
|
|
3401
|
-
"name": "limit",
|
|
3402
|
-
"required": false,
|
|
3403
|
-
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
3404
|
-
},
|
|
3405
|
-
{
|
|
3406
|
-
"schema": {
|
|
3407
|
-
"type": "string"
|
|
3683
|
+
"format": "uuid"
|
|
3408
3684
|
},
|
|
3409
|
-
"in": "
|
|
3410
|
-
"name": "
|
|
3411
|
-
"required":
|
|
3412
|
-
"description": "If set, filters by template name in all available languages"
|
|
3685
|
+
"in": "path",
|
|
3686
|
+
"name": "providerId",
|
|
3687
|
+
"required": true
|
|
3413
3688
|
}
|
|
3414
3689
|
],
|
|
3415
3690
|
"responses": {
|
|
@@ -3424,43 +3699,14 @@
|
|
|
3424
3699
|
],
|
|
3425
3700
|
"properties": {
|
|
3426
3701
|
"data": {
|
|
3427
|
-
"type": "
|
|
3428
|
-
"
|
|
3429
|
-
"
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
"id": {
|
|
3436
|
-
"type": "string",
|
|
3437
|
-
"format": "uuid",
|
|
3438
|
-
"description": "Unique id of the template"
|
|
3439
|
-
},
|
|
3440
|
-
"contents": {
|
|
3441
|
-
"type": "array",
|
|
3442
|
-
"items": {
|
|
3443
|
-
"type": "object",
|
|
3444
|
-
"required": [
|
|
3445
|
-
"language",
|
|
3446
|
-
"templateName"
|
|
3447
|
-
],
|
|
3448
|
-
"properties": {
|
|
3449
|
-
"language": {
|
|
3450
|
-
"type": "string",
|
|
3451
|
-
"enum": [
|
|
3452
|
-
"en",
|
|
3453
|
-
"ga"
|
|
3454
|
-
],
|
|
3455
|
-
"description": "Template content language"
|
|
3456
|
-
},
|
|
3457
|
-
"templateName": {
|
|
3458
|
-
"type": "string",
|
|
3459
|
-
"description": "Template name for the related language"
|
|
3460
|
-
}
|
|
3461
|
-
}
|
|
3462
|
-
}
|
|
3463
|
-
}
|
|
3702
|
+
"type": "object",
|
|
3703
|
+
"required": [
|
|
3704
|
+
"id"
|
|
3705
|
+
],
|
|
3706
|
+
"properties": {
|
|
3707
|
+
"id": {
|
|
3708
|
+
"type": "string",
|
|
3709
|
+
"format": "uuid"
|
|
3464
3710
|
}
|
|
3465
3711
|
}
|
|
3466
3712
|
},
|
|
@@ -3547,7 +3793,7 @@
|
|
|
3547
3793
|
}
|
|
3548
3794
|
}
|
|
3549
3795
|
},
|
|
3550
|
-
"
|
|
3796
|
+
"5XX": {
|
|
3551
3797
|
"description": "Default Response",
|
|
3552
3798
|
"content": {
|
|
3553
3799
|
"application/json": {
|
|
@@ -3607,7 +3853,7 @@
|
|
|
3607
3853
|
}
|
|
3608
3854
|
}
|
|
3609
3855
|
},
|
|
3610
|
-
"
|
|
3856
|
+
"4XX": {
|
|
3611
3857
|
"description": "Default Response",
|
|
3612
3858
|
"content": {
|
|
3613
3859
|
"application/json": {
|
|
@@ -3668,93 +3914,50 @@
|
|
|
3668
3914
|
}
|
|
3669
3915
|
}
|
|
3670
3916
|
}
|
|
3671
|
-
}
|
|
3672
|
-
|
|
3673
|
-
|
|
3917
|
+
}
|
|
3918
|
+
},
|
|
3919
|
+
"/api/v1/templates/": {
|
|
3920
|
+
"get": {
|
|
3921
|
+
"operationId": "ListTemplates",
|
|
3674
3922
|
"tags": [
|
|
3675
3923
|
"Templates"
|
|
3676
3924
|
],
|
|
3677
|
-
"description": "
|
|
3678
|
-
"
|
|
3679
|
-
|
|
3680
|
-
|
|
3681
|
-
|
|
3682
|
-
"
|
|
3683
|
-
|
|
3684
|
-
|
|
3685
|
-
|
|
3686
|
-
|
|
3687
|
-
|
|
3688
|
-
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
|
|
3695
|
-
|
|
3696
|
-
|
|
3697
|
-
|
|
3698
|
-
|
|
3699
|
-
|
|
3700
|
-
|
|
3701
|
-
|
|
3702
|
-
|
|
3703
|
-
|
|
3704
|
-
|
|
3705
|
-
|
|
3706
|
-
|
|
3707
|
-
|
|
3708
|
-
|
|
3709
|
-
],
|
|
3710
|
-
"description": "Template content language"
|
|
3711
|
-
},
|
|
3712
|
-
"subject": {
|
|
3713
|
-
"type": "string",
|
|
3714
|
-
"description": "Subject of the template",
|
|
3715
|
-
"minLength": 1
|
|
3716
|
-
},
|
|
3717
|
-
"excerpt": {
|
|
3718
|
-
"type": "string",
|
|
3719
|
-
"description": "Brief description of the template content"
|
|
3720
|
-
},
|
|
3721
|
-
"plainText": {
|
|
3722
|
-
"type": "string",
|
|
3723
|
-
"description": "Plain text version of the template",
|
|
3724
|
-
"minLength": 1
|
|
3725
|
-
},
|
|
3726
|
-
"richText": {
|
|
3727
|
-
"type": "string",
|
|
3728
|
-
"description": "Rich text version of the template"
|
|
3729
|
-
}
|
|
3730
|
-
}
|
|
3731
|
-
},
|
|
3732
|
-
"minItems": 1
|
|
3733
|
-
},
|
|
3734
|
-
"variables": {
|
|
3735
|
-
"type": "array",
|
|
3736
|
-
"items": {
|
|
3737
|
-
"type": "object",
|
|
3738
|
-
"required": [
|
|
3739
|
-
"name"
|
|
3740
|
-
],
|
|
3741
|
-
"properties": {
|
|
3742
|
-
"name": {
|
|
3743
|
-
"type": "string",
|
|
3744
|
-
"minLength": 1
|
|
3745
|
-
}
|
|
3746
|
-
}
|
|
3747
|
-
},
|
|
3748
|
-
"minItems": 1,
|
|
3749
|
-
"description": "List of the variables that are needed to be filled to create a message using this template"
|
|
3750
|
-
}
|
|
3751
|
-
}
|
|
3752
|
-
}
|
|
3753
|
-
}
|
|
3925
|
+
"description": "Returns the providers matching the requested query",
|
|
3926
|
+
"parameters": [
|
|
3927
|
+
{
|
|
3928
|
+
"schema": {
|
|
3929
|
+
"type": "string",
|
|
3930
|
+
"pattern": "^[0-9][0-9]*|undefined$",
|
|
3931
|
+
"default": "0"
|
|
3932
|
+
},
|
|
3933
|
+
"in": "query",
|
|
3934
|
+
"name": "offset",
|
|
3935
|
+
"required": false,
|
|
3936
|
+
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
3937
|
+
},
|
|
3938
|
+
{
|
|
3939
|
+
"schema": {
|
|
3940
|
+
"type": "string",
|
|
3941
|
+
"default": "20",
|
|
3942
|
+
"pattern": "^([1-9]|100)|undefined$"
|
|
3943
|
+
},
|
|
3944
|
+
"in": "query",
|
|
3945
|
+
"name": "limit",
|
|
3946
|
+
"required": false,
|
|
3947
|
+
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
3948
|
+
},
|
|
3949
|
+
{
|
|
3950
|
+
"schema": {
|
|
3951
|
+
"type": "string"
|
|
3952
|
+
},
|
|
3953
|
+
"in": "query",
|
|
3954
|
+
"name": "search",
|
|
3955
|
+
"required": false,
|
|
3956
|
+
"description": "If set, filters by template name in all available languages"
|
|
3754
3957
|
}
|
|
3755
|
-
|
|
3958
|
+
],
|
|
3756
3959
|
"responses": {
|
|
3757
|
-
"
|
|
3960
|
+
"200": {
|
|
3758
3961
|
"description": "Default Response",
|
|
3759
3962
|
"content": {
|
|
3760
3963
|
"application/json": {
|
|
@@ -3765,14 +3968,43 @@
|
|
|
3765
3968
|
],
|
|
3766
3969
|
"properties": {
|
|
3767
3970
|
"data": {
|
|
3768
|
-
"type": "
|
|
3769
|
-
"
|
|
3770
|
-
"
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
|
|
3971
|
+
"type": "array",
|
|
3972
|
+
"items": {
|
|
3973
|
+
"type": "object",
|
|
3974
|
+
"required": [
|
|
3975
|
+
"id",
|
|
3976
|
+
"contents"
|
|
3977
|
+
],
|
|
3978
|
+
"properties": {
|
|
3979
|
+
"id": {
|
|
3980
|
+
"type": "string",
|
|
3981
|
+
"format": "uuid",
|
|
3982
|
+
"description": "Unique id of the template"
|
|
3983
|
+
},
|
|
3984
|
+
"contents": {
|
|
3985
|
+
"type": "array",
|
|
3986
|
+
"items": {
|
|
3987
|
+
"type": "object",
|
|
3988
|
+
"required": [
|
|
3989
|
+
"language",
|
|
3990
|
+
"templateName"
|
|
3991
|
+
],
|
|
3992
|
+
"properties": {
|
|
3993
|
+
"language": {
|
|
3994
|
+
"type": "string",
|
|
3995
|
+
"enum": [
|
|
3996
|
+
"en",
|
|
3997
|
+
"ga"
|
|
3998
|
+
],
|
|
3999
|
+
"description": "Template content language"
|
|
4000
|
+
},
|
|
4001
|
+
"templateName": {
|
|
4002
|
+
"type": "string",
|
|
4003
|
+
"description": "Template name for the related language"
|
|
4004
|
+
}
|
|
4005
|
+
}
|
|
4006
|
+
}
|
|
4007
|
+
}
|
|
3776
4008
|
}
|
|
3777
4009
|
}
|
|
3778
4010
|
},
|
|
@@ -3859,7 +4091,7 @@
|
|
|
3859
4091
|
}
|
|
3860
4092
|
}
|
|
3861
4093
|
},
|
|
3862
|
-
"
|
|
4094
|
+
"4XX": {
|
|
3863
4095
|
"description": "Default Response",
|
|
3864
4096
|
"content": {
|
|
3865
4097
|
"application/json": {
|
|
@@ -3919,7 +4151,7 @@
|
|
|
3919
4151
|
}
|
|
3920
4152
|
}
|
|
3921
4153
|
},
|
|
3922
|
-
"
|
|
4154
|
+
"5XX": {
|
|
3923
4155
|
"description": "Default Response",
|
|
3924
4156
|
"content": {
|
|
3925
4157
|
"application/json": {
|
|
@@ -3980,28 +4212,93 @@
|
|
|
3980
4212
|
}
|
|
3981
4213
|
}
|
|
3982
4214
|
}
|
|
3983
|
-
}
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
"get": {
|
|
3987
|
-
"operationId": "GetTemplate",
|
|
4215
|
+
},
|
|
4216
|
+
"post": {
|
|
4217
|
+
"operationId": "CreateTemplate",
|
|
3988
4218
|
"tags": [
|
|
3989
4219
|
"Templates"
|
|
3990
4220
|
],
|
|
3991
|
-
"description": "
|
|
3992
|
-
"
|
|
3993
|
-
|
|
3994
|
-
|
|
3995
|
-
|
|
3996
|
-
"
|
|
3997
|
-
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
|
|
4221
|
+
"description": "Creates a new template",
|
|
4222
|
+
"requestBody": {
|
|
4223
|
+
"required": true,
|
|
4224
|
+
"content": {
|
|
4225
|
+
"application/json": {
|
|
4226
|
+
"schema": {
|
|
4227
|
+
"type": "object",
|
|
4228
|
+
"required": [
|
|
4229
|
+
"contents"
|
|
4230
|
+
],
|
|
4231
|
+
"properties": {
|
|
4232
|
+
"contents": {
|
|
4233
|
+
"type": "array",
|
|
4234
|
+
"items": {
|
|
4235
|
+
"type": "object",
|
|
4236
|
+
"required": [
|
|
4237
|
+
"templateName",
|
|
4238
|
+
"language",
|
|
4239
|
+
"subject",
|
|
4240
|
+
"plainText"
|
|
4241
|
+
],
|
|
4242
|
+
"properties": {
|
|
4243
|
+
"templateName": {
|
|
4244
|
+
"type": "string",
|
|
4245
|
+
"description": "Template name for the related language",
|
|
4246
|
+
"minLength": 1
|
|
4247
|
+
},
|
|
4248
|
+
"language": {
|
|
4249
|
+
"type": "string",
|
|
4250
|
+
"enum": [
|
|
4251
|
+
"en",
|
|
4252
|
+
"ga"
|
|
4253
|
+
],
|
|
4254
|
+
"description": "Template content language"
|
|
4255
|
+
},
|
|
4256
|
+
"subject": {
|
|
4257
|
+
"type": "string",
|
|
4258
|
+
"description": "Subject of the template",
|
|
4259
|
+
"minLength": 1
|
|
4260
|
+
},
|
|
4261
|
+
"excerpt": {
|
|
4262
|
+
"type": "string",
|
|
4263
|
+
"description": "Brief description of the template content"
|
|
4264
|
+
},
|
|
4265
|
+
"plainText": {
|
|
4266
|
+
"type": "string",
|
|
4267
|
+
"description": "Plain text version of the template",
|
|
4268
|
+
"minLength": 1
|
|
4269
|
+
},
|
|
4270
|
+
"richText": {
|
|
4271
|
+
"type": "string",
|
|
4272
|
+
"description": "Rich text version of the template"
|
|
4273
|
+
}
|
|
4274
|
+
}
|
|
4275
|
+
},
|
|
4276
|
+
"minItems": 1
|
|
4277
|
+
},
|
|
4278
|
+
"variables": {
|
|
4279
|
+
"type": "array",
|
|
4280
|
+
"items": {
|
|
4281
|
+
"type": "object",
|
|
4282
|
+
"required": [
|
|
4283
|
+
"name"
|
|
4284
|
+
],
|
|
4285
|
+
"properties": {
|
|
4286
|
+
"name": {
|
|
4287
|
+
"type": "string",
|
|
4288
|
+
"minLength": 1
|
|
4289
|
+
}
|
|
4290
|
+
}
|
|
4291
|
+
},
|
|
4292
|
+
"minItems": 1,
|
|
4293
|
+
"description": "List of the variables that are needed to be filled to create a message using this template"
|
|
4294
|
+
}
|
|
4295
|
+
}
|
|
4296
|
+
}
|
|
4297
|
+
}
|
|
4001
4298
|
}
|
|
4002
|
-
|
|
4299
|
+
},
|
|
4003
4300
|
"responses": {
|
|
4004
|
-
"
|
|
4301
|
+
"201": {
|
|
4005
4302
|
"description": "Default Response",
|
|
4006
4303
|
"content": {
|
|
4007
4304
|
"application/json": {
|
|
@@ -4014,69 +4311,12 @@
|
|
|
4014
4311
|
"data": {
|
|
4015
4312
|
"type": "object",
|
|
4016
4313
|
"required": [
|
|
4017
|
-
"
|
|
4018
|
-
"fields"
|
|
4314
|
+
"id"
|
|
4019
4315
|
],
|
|
4020
4316
|
"properties": {
|
|
4021
|
-
"
|
|
4022
|
-
"type": "
|
|
4023
|
-
"
|
|
4024
|
-
"type": "object",
|
|
4025
|
-
"required": [
|
|
4026
|
-
"templateName",
|
|
4027
|
-
"language",
|
|
4028
|
-
"subject",
|
|
4029
|
-
"plainText"
|
|
4030
|
-
],
|
|
4031
|
-
"properties": {
|
|
4032
|
-
"templateName": {
|
|
4033
|
-
"type": "string",
|
|
4034
|
-
"description": "Template name for the related language",
|
|
4035
|
-
"minLength": 1
|
|
4036
|
-
},
|
|
4037
|
-
"language": {
|
|
4038
|
-
"type": "string",
|
|
4039
|
-
"enum": [
|
|
4040
|
-
"en",
|
|
4041
|
-
"ga"
|
|
4042
|
-
],
|
|
4043
|
-
"description": "Template content language"
|
|
4044
|
-
},
|
|
4045
|
-
"subject": {
|
|
4046
|
-
"type": "string",
|
|
4047
|
-
"description": "Subject of the template",
|
|
4048
|
-
"minLength": 1
|
|
4049
|
-
},
|
|
4050
|
-
"excerpt": {
|
|
4051
|
-
"type": "string",
|
|
4052
|
-
"description": "Brief description of the template content"
|
|
4053
|
-
},
|
|
4054
|
-
"plainText": {
|
|
4055
|
-
"type": "string",
|
|
4056
|
-
"description": "Plain text version of the template",
|
|
4057
|
-
"minLength": 1
|
|
4058
|
-
},
|
|
4059
|
-
"richText": {
|
|
4060
|
-
"type": "string",
|
|
4061
|
-
"description": "Rich text version of the template"
|
|
4062
|
-
}
|
|
4063
|
-
}
|
|
4064
|
-
}
|
|
4065
|
-
},
|
|
4066
|
-
"fields": {
|
|
4067
|
-
"type": "array",
|
|
4068
|
-
"items": {
|
|
4069
|
-
"type": "object",
|
|
4070
|
-
"required": [
|
|
4071
|
-
"fieldName"
|
|
4072
|
-
],
|
|
4073
|
-
"properties": {
|
|
4074
|
-
"fieldName": {
|
|
4075
|
-
"type": "string"
|
|
4076
|
-
}
|
|
4077
|
-
},
|
|
4078
|
-
"description": "List of the variables that are needed to be filled to create a message using this template"
|
|
4079
|
-
}
|
|
4317
|
+
"id": {
|
|
4318
|
+
"type": "string",
|
|
4319
|
+
"format": "uuid"
|
|
4080
4320
|
}
|
|
4081
4321
|
}
|
|
4082
4322
|
},
|
|
@@ -4163,7 +4403,7 @@
|
|
|
4163
4403
|
}
|
|
4164
4404
|
}
|
|
4165
4405
|
},
|
|
4166
|
-
"
|
|
4406
|
+
"5XX": {
|
|
4167
4407
|
"description": "Default Response",
|
|
4168
4408
|
"content": {
|
|
4169
4409
|
"application/json": {
|
|
@@ -4223,7 +4463,7 @@
|
|
|
4223
4463
|
}
|
|
4224
4464
|
}
|
|
4225
4465
|
},
|
|
4226
|
-
"
|
|
4466
|
+
"4XX": {
|
|
4227
4467
|
"description": "Default Response",
|
|
4228
4468
|
"content": {
|
|
4229
4469
|
"application/json": {
|
|
@@ -4284,96 +4524,15 @@
|
|
|
4284
4524
|
}
|
|
4285
4525
|
}
|
|
4286
4526
|
}
|
|
4287
|
-
}
|
|
4288
|
-
|
|
4289
|
-
|
|
4527
|
+
}
|
|
4528
|
+
},
|
|
4529
|
+
"/api/v1/templates/{templateId}": {
|
|
4530
|
+
"get": {
|
|
4531
|
+
"operationId": "GetTemplate",
|
|
4290
4532
|
"tags": [
|
|
4291
4533
|
"Templates"
|
|
4292
4534
|
],
|
|
4293
|
-
"description": "
|
|
4294
|
-
"requestBody": {
|
|
4295
|
-
"required": true,
|
|
4296
|
-
"content": {
|
|
4297
|
-
"application/json": {
|
|
4298
|
-
"schema": {
|
|
4299
|
-
"type": "object",
|
|
4300
|
-
"required": [
|
|
4301
|
-
"id",
|
|
4302
|
-
"contents"
|
|
4303
|
-
],
|
|
4304
|
-
"properties": {
|
|
4305
|
-
"id": {
|
|
4306
|
-
"type": "string",
|
|
4307
|
-
"format": "uuid"
|
|
4308
|
-
},
|
|
4309
|
-
"contents": {
|
|
4310
|
-
"type": "array",
|
|
4311
|
-
"items": {
|
|
4312
|
-
"type": "object",
|
|
4313
|
-
"required": [
|
|
4314
|
-
"templateName",
|
|
4315
|
-
"language",
|
|
4316
|
-
"subject",
|
|
4317
|
-
"plainText"
|
|
4318
|
-
],
|
|
4319
|
-
"properties": {
|
|
4320
|
-
"templateName": {
|
|
4321
|
-
"type": "string",
|
|
4322
|
-
"description": "Template name for the related language",
|
|
4323
|
-
"minLength": 1
|
|
4324
|
-
},
|
|
4325
|
-
"language": {
|
|
4326
|
-
"type": "string",
|
|
4327
|
-
"enum": [
|
|
4328
|
-
"en",
|
|
4329
|
-
"ga"
|
|
4330
|
-
],
|
|
4331
|
-
"description": "Template content language"
|
|
4332
|
-
},
|
|
4333
|
-
"subject": {
|
|
4334
|
-
"type": "string",
|
|
4335
|
-
"description": "Subject of the template",
|
|
4336
|
-
"minLength": 1
|
|
4337
|
-
},
|
|
4338
|
-
"excerpt": {
|
|
4339
|
-
"type": "string",
|
|
4340
|
-
"description": "Brief description of the template content"
|
|
4341
|
-
},
|
|
4342
|
-
"plainText": {
|
|
4343
|
-
"type": "string",
|
|
4344
|
-
"description": "Plain text version of the template",
|
|
4345
|
-
"minLength": 1
|
|
4346
|
-
},
|
|
4347
|
-
"richText": {
|
|
4348
|
-
"type": "string",
|
|
4349
|
-
"description": "Rich text version of the template"
|
|
4350
|
-
}
|
|
4351
|
-
}
|
|
4352
|
-
},
|
|
4353
|
-
"minItems": 1
|
|
4354
|
-
},
|
|
4355
|
-
"variables": {
|
|
4356
|
-
"type": "array",
|
|
4357
|
-
"items": {
|
|
4358
|
-
"type": "object",
|
|
4359
|
-
"required": [
|
|
4360
|
-
"name"
|
|
4361
|
-
],
|
|
4362
|
-
"properties": {
|
|
4363
|
-
"name": {
|
|
4364
|
-
"type": "string",
|
|
4365
|
-
"minLength": 1
|
|
4366
|
-
}
|
|
4367
|
-
}
|
|
4368
|
-
},
|
|
4369
|
-
"minItems": 1,
|
|
4370
|
-
"description": "List of the variables that are needed to be filled to create a message using this template"
|
|
4371
|
-
}
|
|
4372
|
-
}
|
|
4373
|
-
}
|
|
4374
|
-
}
|
|
4375
|
-
}
|
|
4376
|
-
},
|
|
4535
|
+
"description": "Returns the requested template",
|
|
4377
4536
|
"parameters": [
|
|
4378
4537
|
{
|
|
4379
4538
|
"schema": {
|
|
@@ -4399,14 +4558,71 @@
|
|
|
4399
4558
|
"data": {
|
|
4400
4559
|
"type": "object",
|
|
4401
4560
|
"required": [
|
|
4402
|
-
"
|
|
4561
|
+
"contents",
|
|
4562
|
+
"fields"
|
|
4403
4563
|
],
|
|
4404
4564
|
"properties": {
|
|
4405
|
-
"
|
|
4406
|
-
"type": "
|
|
4407
|
-
"
|
|
4408
|
-
|
|
4409
|
-
|
|
4565
|
+
"contents": {
|
|
4566
|
+
"type": "array",
|
|
4567
|
+
"items": {
|
|
4568
|
+
"type": "object",
|
|
4569
|
+
"required": [
|
|
4570
|
+
"templateName",
|
|
4571
|
+
"language",
|
|
4572
|
+
"subject",
|
|
4573
|
+
"plainText"
|
|
4574
|
+
],
|
|
4575
|
+
"properties": {
|
|
4576
|
+
"templateName": {
|
|
4577
|
+
"type": "string",
|
|
4578
|
+
"description": "Template name for the related language",
|
|
4579
|
+
"minLength": 1
|
|
4580
|
+
},
|
|
4581
|
+
"language": {
|
|
4582
|
+
"type": "string",
|
|
4583
|
+
"enum": [
|
|
4584
|
+
"en",
|
|
4585
|
+
"ga"
|
|
4586
|
+
],
|
|
4587
|
+
"description": "Template content language"
|
|
4588
|
+
},
|
|
4589
|
+
"subject": {
|
|
4590
|
+
"type": "string",
|
|
4591
|
+
"description": "Subject of the template",
|
|
4592
|
+
"minLength": 1
|
|
4593
|
+
},
|
|
4594
|
+
"excerpt": {
|
|
4595
|
+
"type": "string",
|
|
4596
|
+
"description": "Brief description of the template content"
|
|
4597
|
+
},
|
|
4598
|
+
"plainText": {
|
|
4599
|
+
"type": "string",
|
|
4600
|
+
"description": "Plain text version of the template",
|
|
4601
|
+
"minLength": 1
|
|
4602
|
+
},
|
|
4603
|
+
"richText": {
|
|
4604
|
+
"type": "string",
|
|
4605
|
+
"description": "Rich text version of the template"
|
|
4606
|
+
}
|
|
4607
|
+
}
|
|
4608
|
+
}
|
|
4609
|
+
},
|
|
4610
|
+
"fields": {
|
|
4611
|
+
"type": "array",
|
|
4612
|
+
"items": {
|
|
4613
|
+
"type": "object",
|
|
4614
|
+
"required": [
|
|
4615
|
+
"fieldName"
|
|
4616
|
+
],
|
|
4617
|
+
"properties": {
|
|
4618
|
+
"fieldName": {
|
|
4619
|
+
"type": "string"
|
|
4620
|
+
}
|
|
4621
|
+
},
|
|
4622
|
+
"description": "List of the variables that are needed to be filled to create a message using this template"
|
|
4623
|
+
}
|
|
4624
|
+
}
|
|
4625
|
+
}
|
|
4410
4626
|
},
|
|
4411
4627
|
"metadata": {
|
|
4412
4628
|
"type": "object",
|
|
@@ -4491,7 +4707,7 @@
|
|
|
4491
4707
|
}
|
|
4492
4708
|
}
|
|
4493
4709
|
},
|
|
4494
|
-
"
|
|
4710
|
+
"404": {
|
|
4495
4711
|
"description": "Default Response",
|
|
4496
4712
|
"content": {
|
|
4497
4713
|
"application/json": {
|
|
@@ -4613,12 +4829,95 @@
|
|
|
4613
4829
|
}
|
|
4614
4830
|
}
|
|
4615
4831
|
},
|
|
4616
|
-
"
|
|
4617
|
-
"operationId": "
|
|
4832
|
+
"put": {
|
|
4833
|
+
"operationId": "UpdateTemplate",
|
|
4618
4834
|
"tags": [
|
|
4619
4835
|
"Templates"
|
|
4620
4836
|
],
|
|
4621
|
-
"description": "
|
|
4837
|
+
"description": "Updates the requested template",
|
|
4838
|
+
"requestBody": {
|
|
4839
|
+
"required": true,
|
|
4840
|
+
"content": {
|
|
4841
|
+
"application/json": {
|
|
4842
|
+
"schema": {
|
|
4843
|
+
"type": "object",
|
|
4844
|
+
"required": [
|
|
4845
|
+
"id",
|
|
4846
|
+
"contents"
|
|
4847
|
+
],
|
|
4848
|
+
"properties": {
|
|
4849
|
+
"id": {
|
|
4850
|
+
"type": "string",
|
|
4851
|
+
"format": "uuid"
|
|
4852
|
+
},
|
|
4853
|
+
"contents": {
|
|
4854
|
+
"type": "array",
|
|
4855
|
+
"items": {
|
|
4856
|
+
"type": "object",
|
|
4857
|
+
"required": [
|
|
4858
|
+
"templateName",
|
|
4859
|
+
"language",
|
|
4860
|
+
"subject",
|
|
4861
|
+
"plainText"
|
|
4862
|
+
],
|
|
4863
|
+
"properties": {
|
|
4864
|
+
"templateName": {
|
|
4865
|
+
"type": "string",
|
|
4866
|
+
"description": "Template name for the related language",
|
|
4867
|
+
"minLength": 1
|
|
4868
|
+
},
|
|
4869
|
+
"language": {
|
|
4870
|
+
"type": "string",
|
|
4871
|
+
"enum": [
|
|
4872
|
+
"en",
|
|
4873
|
+
"ga"
|
|
4874
|
+
],
|
|
4875
|
+
"description": "Template content language"
|
|
4876
|
+
},
|
|
4877
|
+
"subject": {
|
|
4878
|
+
"type": "string",
|
|
4879
|
+
"description": "Subject of the template",
|
|
4880
|
+
"minLength": 1
|
|
4881
|
+
},
|
|
4882
|
+
"excerpt": {
|
|
4883
|
+
"type": "string",
|
|
4884
|
+
"description": "Brief description of the template content"
|
|
4885
|
+
},
|
|
4886
|
+
"plainText": {
|
|
4887
|
+
"type": "string",
|
|
4888
|
+
"description": "Plain text version of the template",
|
|
4889
|
+
"minLength": 1
|
|
4890
|
+
},
|
|
4891
|
+
"richText": {
|
|
4892
|
+
"type": "string",
|
|
4893
|
+
"description": "Rich text version of the template"
|
|
4894
|
+
}
|
|
4895
|
+
}
|
|
4896
|
+
},
|
|
4897
|
+
"minItems": 1
|
|
4898
|
+
},
|
|
4899
|
+
"variables": {
|
|
4900
|
+
"type": "array",
|
|
4901
|
+
"items": {
|
|
4902
|
+
"type": "object",
|
|
4903
|
+
"required": [
|
|
4904
|
+
"name"
|
|
4905
|
+
],
|
|
4906
|
+
"properties": {
|
|
4907
|
+
"name": {
|
|
4908
|
+
"type": "string",
|
|
4909
|
+
"minLength": 1
|
|
4910
|
+
}
|
|
4911
|
+
}
|
|
4912
|
+
},
|
|
4913
|
+
"minItems": 1,
|
|
4914
|
+
"description": "List of the variables that are needed to be filled to create a message using this template"
|
|
4915
|
+
}
|
|
4916
|
+
}
|
|
4917
|
+
}
|
|
4918
|
+
}
|
|
4919
|
+
}
|
|
4920
|
+
},
|
|
4622
4921
|
"parameters": [
|
|
4623
4922
|
{
|
|
4624
4923
|
"schema": {
|
|
@@ -4857,99 +5156,22 @@
|
|
|
4857
5156
|
}
|
|
4858
5157
|
}
|
|
4859
5158
|
}
|
|
4860
|
-
}
|
|
4861
|
-
|
|
4862
|
-
|
|
4863
|
-
"get": {
|
|
5159
|
+
},
|
|
5160
|
+
"delete": {
|
|
5161
|
+
"operationId": "DeleteTemplate",
|
|
4864
5162
|
"tags": [
|
|
4865
|
-
"
|
|
5163
|
+
"Templates"
|
|
4866
5164
|
],
|
|
4867
|
-
"description": "
|
|
5165
|
+
"description": "Deletes the requested template",
|
|
4868
5166
|
"parameters": [
|
|
4869
|
-
{
|
|
4870
|
-
"schema": {
|
|
4871
|
-
"type": "string"
|
|
4872
|
-
},
|
|
4873
|
-
"in": "query",
|
|
4874
|
-
"name": "search",
|
|
4875
|
-
"required": false,
|
|
4876
|
-
"description": "If set, it filters the events for the messages containing the searched value in the subject or recipients of the message"
|
|
4877
|
-
},
|
|
4878
|
-
{
|
|
4879
|
-
"schema": {
|
|
4880
|
-
"type": "string",
|
|
4881
|
-
"format": "date"
|
|
4882
|
-
},
|
|
4883
|
-
"in": "query",
|
|
4884
|
-
"name": "dateFrom",
|
|
4885
|
-
"required": false,
|
|
4886
|
-
"description": "If set, it filters the events for the messages created after the set date"
|
|
4887
|
-
},
|
|
4888
|
-
{
|
|
4889
|
-
"schema": {
|
|
4890
|
-
"type": "string",
|
|
4891
|
-
"format": "date"
|
|
4892
|
-
},
|
|
4893
|
-
"in": "query",
|
|
4894
|
-
"name": "dateTo",
|
|
4895
|
-
"required": false,
|
|
4896
|
-
"description": "If set, it filters the events for the messages created before the set date"
|
|
4897
|
-
},
|
|
4898
|
-
{
|
|
4899
|
-
"schema": {
|
|
4900
|
-
"type": "string",
|
|
4901
|
-
"enum": [
|
|
4902
|
-
"delivered",
|
|
4903
|
-
"scheduled",
|
|
4904
|
-
"opened",
|
|
4905
|
-
"failed"
|
|
4906
|
-
]
|
|
4907
|
-
},
|
|
4908
|
-
"in": "query",
|
|
4909
|
-
"name": "status",
|
|
4910
|
-
"required": false,
|
|
4911
|
-
"description": "If set, it will filter status for the latest occured message event"
|
|
4912
|
-
},
|
|
4913
5167
|
{
|
|
4914
5168
|
"schema": {
|
|
4915
5169
|
"type": "string",
|
|
4916
5170
|
"format": "uuid"
|
|
4917
5171
|
},
|
|
4918
|
-
"in": "
|
|
4919
|
-
"name": "
|
|
4920
|
-
"required":
|
|
4921
|
-
"description": "If set, search for events related to the message id"
|
|
4922
|
-
},
|
|
4923
|
-
{
|
|
4924
|
-
"schema": {
|
|
4925
|
-
"type": "string"
|
|
4926
|
-
},
|
|
4927
|
-
"in": "query",
|
|
4928
|
-
"name": "recipientId",
|
|
4929
|
-
"required": false,
|
|
4930
|
-
"description": "If set, search for events related to the recipient user id"
|
|
4931
|
-
},
|
|
4932
|
-
{
|
|
4933
|
-
"schema": {
|
|
4934
|
-
"type": "string",
|
|
4935
|
-
"pattern": "^[0-9][0-9]*|undefined$",
|
|
4936
|
-
"default": "0"
|
|
4937
|
-
},
|
|
4938
|
-
"in": "query",
|
|
4939
|
-
"name": "offset",
|
|
4940
|
-
"required": false,
|
|
4941
|
-
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
4942
|
-
},
|
|
4943
|
-
{
|
|
4944
|
-
"schema": {
|
|
4945
|
-
"type": "string",
|
|
4946
|
-
"default": "20",
|
|
4947
|
-
"pattern": "^([1-9]|100)|undefined$"
|
|
4948
|
-
},
|
|
4949
|
-
"in": "query",
|
|
4950
|
-
"name": "limit",
|
|
4951
|
-
"required": false,
|
|
4952
|
-
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
5172
|
+
"in": "path",
|
|
5173
|
+
"name": "templateId",
|
|
5174
|
+
"required": true
|
|
4953
5175
|
}
|
|
4954
5176
|
],
|
|
4955
5177
|
"responses": {
|
|
@@ -4964,49 +5186,14 @@
|
|
|
4964
5186
|
],
|
|
4965
5187
|
"properties": {
|
|
4966
5188
|
"data": {
|
|
4967
|
-
"type": "
|
|
4968
|
-
"
|
|
4969
|
-
"
|
|
4970
|
-
|
|
4971
|
-
|
|
4972
|
-
|
|
4973
|
-
"
|
|
4974
|
-
"
|
|
4975
|
-
"eventType",
|
|
4976
|
-
"eventStatus",
|
|
4977
|
-
"scheduledAt"
|
|
4978
|
-
],
|
|
4979
|
-
"properties": {
|
|
4980
|
-
"id": {
|
|
4981
|
-
"type": "string",
|
|
4982
|
-
"format": "uuid",
|
|
4983
|
-
"description": "Unique id of the event"
|
|
4984
|
-
},
|
|
4985
|
-
"messageId": {
|
|
4986
|
-
"type": "string",
|
|
4987
|
-
"format": "uuid",
|
|
4988
|
-
"description": "Unique id of the related message"
|
|
4989
|
-
},
|
|
4990
|
-
"subject": {
|
|
4991
|
-
"type": "string",
|
|
4992
|
-
"description": "Subject of the related message"
|
|
4993
|
-
},
|
|
4994
|
-
"receiverFullName": {
|
|
4995
|
-
"type": "string",
|
|
4996
|
-
"description": "Full name of the recipient"
|
|
4997
|
-
},
|
|
4998
|
-
"eventType": {
|
|
4999
|
-
"type": "string",
|
|
5000
|
-
"description": "Event type description"
|
|
5001
|
-
},
|
|
5002
|
-
"eventStatus": {
|
|
5003
|
-
"type": "string",
|
|
5004
|
-
"description": "Status for event type"
|
|
5005
|
-
},
|
|
5006
|
-
"scheduledAt": {
|
|
5007
|
-
"type": "string",
|
|
5008
|
-
"description": "Date and time which describes when the message has to be sent"
|
|
5009
|
-
}
|
|
5189
|
+
"type": "object",
|
|
5190
|
+
"required": [
|
|
5191
|
+
"id"
|
|
5192
|
+
],
|
|
5193
|
+
"properties": {
|
|
5194
|
+
"id": {
|
|
5195
|
+
"type": "string",
|
|
5196
|
+
"format": "uuid"
|
|
5010
5197
|
}
|
|
5011
5198
|
}
|
|
5012
5199
|
},
|
|
@@ -5093,7 +5280,7 @@
|
|
|
5093
5280
|
}
|
|
5094
5281
|
}
|
|
5095
5282
|
},
|
|
5096
|
-
"
|
|
5283
|
+
"4XX": {
|
|
5097
5284
|
"description": "Default Response",
|
|
5098
5285
|
"content": {
|
|
5099
5286
|
"application/json": {
|
|
@@ -5153,7 +5340,7 @@
|
|
|
5153
5340
|
}
|
|
5154
5341
|
}
|
|
5155
5342
|
},
|
|
5156
|
-
"
|
|
5343
|
+
"5XX": {
|
|
5157
5344
|
"description": "Default Response",
|
|
5158
5345
|
"content": {
|
|
5159
5346
|
"application/json": {
|
|
@@ -5216,21 +5403,97 @@
|
|
|
5216
5403
|
}
|
|
5217
5404
|
}
|
|
5218
5405
|
},
|
|
5219
|
-
"/api/v1/message-events/
|
|
5406
|
+
"/api/v1/message-events/": {
|
|
5220
5407
|
"get": {
|
|
5221
5408
|
"tags": [
|
|
5222
5409
|
"Message events"
|
|
5223
5410
|
],
|
|
5224
|
-
"description": "Returns the
|
|
5411
|
+
"description": "Returns the message events that match the requested query",
|
|
5225
5412
|
"parameters": [
|
|
5413
|
+
{
|
|
5414
|
+
"schema": {
|
|
5415
|
+
"type": "string"
|
|
5416
|
+
},
|
|
5417
|
+
"in": "query",
|
|
5418
|
+
"name": "search",
|
|
5419
|
+
"required": false,
|
|
5420
|
+
"description": "If set, it filters the events for the messages containing the searched value in the subject or recipients of the message"
|
|
5421
|
+
},
|
|
5422
|
+
{
|
|
5423
|
+
"schema": {
|
|
5424
|
+
"type": "string",
|
|
5425
|
+
"format": "date"
|
|
5426
|
+
},
|
|
5427
|
+
"in": "query",
|
|
5428
|
+
"name": "dateFrom",
|
|
5429
|
+
"required": false,
|
|
5430
|
+
"description": "If set, it filters the events for the messages created after the set date"
|
|
5431
|
+
},
|
|
5432
|
+
{
|
|
5433
|
+
"schema": {
|
|
5434
|
+
"type": "string",
|
|
5435
|
+
"format": "date"
|
|
5436
|
+
},
|
|
5437
|
+
"in": "query",
|
|
5438
|
+
"name": "dateTo",
|
|
5439
|
+
"required": false,
|
|
5440
|
+
"description": "If set, it filters the events for the messages created before the set date"
|
|
5441
|
+
},
|
|
5442
|
+
{
|
|
5443
|
+
"schema": {
|
|
5444
|
+
"type": "string",
|
|
5445
|
+
"enum": [
|
|
5446
|
+
"delivered",
|
|
5447
|
+
"scheduled",
|
|
5448
|
+
"opened",
|
|
5449
|
+
"failed"
|
|
5450
|
+
]
|
|
5451
|
+
},
|
|
5452
|
+
"in": "query",
|
|
5453
|
+
"name": "status",
|
|
5454
|
+
"required": false,
|
|
5455
|
+
"description": "If set, it will filter status for the latest occured message event"
|
|
5456
|
+
},
|
|
5226
5457
|
{
|
|
5227
5458
|
"schema": {
|
|
5228
5459
|
"type": "string",
|
|
5229
5460
|
"format": "uuid"
|
|
5230
5461
|
},
|
|
5231
|
-
"in": "
|
|
5232
|
-
"name": "
|
|
5233
|
-
"required":
|
|
5462
|
+
"in": "query",
|
|
5463
|
+
"name": "messageId",
|
|
5464
|
+
"required": false,
|
|
5465
|
+
"description": "If set, search for events related to the message id"
|
|
5466
|
+
},
|
|
5467
|
+
{
|
|
5468
|
+
"schema": {
|
|
5469
|
+
"type": "string"
|
|
5470
|
+
},
|
|
5471
|
+
"in": "query",
|
|
5472
|
+
"name": "recipientId",
|
|
5473
|
+
"required": false,
|
|
5474
|
+
"description": "If set, search for events related to the recipient user id"
|
|
5475
|
+
},
|
|
5476
|
+
{
|
|
5477
|
+
"schema": {
|
|
5478
|
+
"type": "string",
|
|
5479
|
+
"pattern": "^[0-9][0-9]*|undefined$",
|
|
5480
|
+
"default": "0"
|
|
5481
|
+
},
|
|
5482
|
+
"in": "query",
|
|
5483
|
+
"name": "offset",
|
|
5484
|
+
"required": false,
|
|
5485
|
+
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
5486
|
+
},
|
|
5487
|
+
{
|
|
5488
|
+
"schema": {
|
|
5489
|
+
"type": "string",
|
|
5490
|
+
"default": "20",
|
|
5491
|
+
"pattern": "^([1-9]|100)|undefined$"
|
|
5492
|
+
},
|
|
5493
|
+
"in": "query",
|
|
5494
|
+
"name": "limit",
|
|
5495
|
+
"required": false,
|
|
5496
|
+
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
5234
5497
|
}
|
|
5235
5498
|
],
|
|
5236
5499
|
"responses": {
|
|
@@ -5249,17 +5512,32 @@
|
|
|
5249
5512
|
"items": {
|
|
5250
5513
|
"type": "object",
|
|
5251
5514
|
"required": [
|
|
5515
|
+
"id",
|
|
5252
5516
|
"messageId",
|
|
5517
|
+
"subject",
|
|
5518
|
+
"receiverFullName",
|
|
5253
5519
|
"eventType",
|
|
5254
5520
|
"eventStatus",
|
|
5255
|
-
"
|
|
5256
|
-
"createdAt"
|
|
5521
|
+
"scheduledAt"
|
|
5257
5522
|
],
|
|
5258
5523
|
"properties": {
|
|
5524
|
+
"id": {
|
|
5525
|
+
"type": "string",
|
|
5526
|
+
"format": "uuid",
|
|
5527
|
+
"description": "Unique id of the event"
|
|
5528
|
+
},
|
|
5259
5529
|
"messageId": {
|
|
5260
5530
|
"type": "string",
|
|
5261
5531
|
"format": "uuid",
|
|
5262
|
-
"description": "
|
|
5532
|
+
"description": "Unique id of the related message"
|
|
5533
|
+
},
|
|
5534
|
+
"subject": {
|
|
5535
|
+
"type": "string",
|
|
5536
|
+
"description": "Subject of the related message"
|
|
5537
|
+
},
|
|
5538
|
+
"receiverFullName": {
|
|
5539
|
+
"type": "string",
|
|
5540
|
+
"description": "Full name of the recipient"
|
|
5263
5541
|
},
|
|
5264
5542
|
"eventType": {
|
|
5265
5543
|
"type": "string",
|
|
@@ -5269,45 +5547,311 @@
|
|
|
5269
5547
|
"type": "string",
|
|
5270
5548
|
"description": "Status for event type"
|
|
5271
5549
|
},
|
|
5272
|
-
"
|
|
5273
|
-
"
|
|
5274
|
-
|
|
5550
|
+
"scheduledAt": {
|
|
5551
|
+
"type": "string",
|
|
5552
|
+
"description": "Date and time which describes when the message has to be sent"
|
|
5553
|
+
}
|
|
5554
|
+
}
|
|
5555
|
+
}
|
|
5556
|
+
},
|
|
5557
|
+
"metadata": {
|
|
5558
|
+
"type": "object",
|
|
5559
|
+
"properties": {
|
|
5560
|
+
"links": {
|
|
5561
|
+
"type": "object",
|
|
5562
|
+
"required": [
|
|
5563
|
+
"self",
|
|
5564
|
+
"first",
|
|
5565
|
+
"last",
|
|
5566
|
+
"pages"
|
|
5567
|
+
],
|
|
5568
|
+
"properties": {
|
|
5569
|
+
"self": {
|
|
5570
|
+
"type": "object",
|
|
5571
|
+
"properties": {
|
|
5572
|
+
"href": {
|
|
5573
|
+
"type": "string",
|
|
5574
|
+
"description": "URL pointing to the request itself"
|
|
5575
|
+
}
|
|
5576
|
+
}
|
|
5577
|
+
},
|
|
5578
|
+
"next": {
|
|
5579
|
+
"type": "object",
|
|
5580
|
+
"properties": {
|
|
5581
|
+
"href": {
|
|
5582
|
+
"type": "string",
|
|
5583
|
+
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
5584
|
+
}
|
|
5585
|
+
}
|
|
5586
|
+
},
|
|
5587
|
+
"prev": {
|
|
5588
|
+
"type": "object",
|
|
5589
|
+
"properties": {
|
|
5590
|
+
"href": {
|
|
5591
|
+
"type": "string",
|
|
5592
|
+
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
5593
|
+
}
|
|
5594
|
+
}
|
|
5595
|
+
},
|
|
5596
|
+
"first": {
|
|
5597
|
+
"type": "object",
|
|
5598
|
+
"properties": {
|
|
5599
|
+
"href": {
|
|
5600
|
+
"type": "string",
|
|
5601
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
5602
|
+
}
|
|
5603
|
+
}
|
|
5604
|
+
},
|
|
5605
|
+
"last": {
|
|
5606
|
+
"type": "object",
|
|
5607
|
+
"properties": {
|
|
5608
|
+
"href": {
|
|
5609
|
+
"type": "string",
|
|
5610
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
5611
|
+
}
|
|
5612
|
+
}
|
|
5613
|
+
},
|
|
5614
|
+
"pages": {
|
|
5615
|
+
"type": "object",
|
|
5616
|
+
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
5617
|
+
"additionalProperties": {
|
|
5275
5618
|
"type": "object",
|
|
5276
|
-
"required": [
|
|
5277
|
-
"messageId",
|
|
5278
|
-
"receiverFullName",
|
|
5279
|
-
"receiverPPSN",
|
|
5280
|
-
"receiverUserId",
|
|
5281
|
-
"subject",
|
|
5282
|
-
"language",
|
|
5283
|
-
"plainText",
|
|
5284
|
-
"transports",
|
|
5285
|
-
"scheduledAt",
|
|
5286
|
-
"organisationName",
|
|
5287
|
-
"security"
|
|
5288
|
-
],
|
|
5289
5619
|
"properties": {
|
|
5290
|
-
"
|
|
5291
|
-
"type": "string"
|
|
5292
|
-
|
|
5293
|
-
|
|
5294
|
-
|
|
5295
|
-
|
|
5296
|
-
|
|
5297
|
-
|
|
5298
|
-
|
|
5299
|
-
|
|
5300
|
-
|
|
5301
|
-
|
|
5302
|
-
|
|
5303
|
-
|
|
5304
|
-
|
|
5305
|
-
|
|
5306
|
-
|
|
5307
|
-
|
|
5308
|
-
|
|
5309
|
-
|
|
5310
|
-
|
|
5620
|
+
"href": {
|
|
5621
|
+
"type": "string"
|
|
5622
|
+
}
|
|
5623
|
+
}
|
|
5624
|
+
}
|
|
5625
|
+
}
|
|
5626
|
+
},
|
|
5627
|
+
"description": "Object containing the links to the related endpoints"
|
|
5628
|
+
},
|
|
5629
|
+
"totalCount": {
|
|
5630
|
+
"type": "number",
|
|
5631
|
+
"description": "Number representing the total number of available items"
|
|
5632
|
+
}
|
|
5633
|
+
}
|
|
5634
|
+
}
|
|
5635
|
+
}
|
|
5636
|
+
}
|
|
5637
|
+
}
|
|
5638
|
+
}
|
|
5639
|
+
},
|
|
5640
|
+
"5XX": {
|
|
5641
|
+
"description": "Default Response",
|
|
5642
|
+
"content": {
|
|
5643
|
+
"application/json": {
|
|
5644
|
+
"schema": {
|
|
5645
|
+
"type": "object",
|
|
5646
|
+
"required": [
|
|
5647
|
+
"code",
|
|
5648
|
+
"detail",
|
|
5649
|
+
"requestId",
|
|
5650
|
+
"name",
|
|
5651
|
+
"statusCode"
|
|
5652
|
+
],
|
|
5653
|
+
"properties": {
|
|
5654
|
+
"code": {
|
|
5655
|
+
"type": "string",
|
|
5656
|
+
"description": "Code used to categorize the error"
|
|
5657
|
+
},
|
|
5658
|
+
"detail": {
|
|
5659
|
+
"type": "string",
|
|
5660
|
+
"description": "Description of the error"
|
|
5661
|
+
},
|
|
5662
|
+
"requestId": {
|
|
5663
|
+
"type": "string",
|
|
5664
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
5665
|
+
},
|
|
5666
|
+
"name": {
|
|
5667
|
+
"type": "string",
|
|
5668
|
+
"description": "Name of the error type"
|
|
5669
|
+
},
|
|
5670
|
+
"validation": {
|
|
5671
|
+
"type": "array",
|
|
5672
|
+
"items": {
|
|
5673
|
+
"type": "object",
|
|
5674
|
+
"required": [
|
|
5675
|
+
"fieldName",
|
|
5676
|
+
"message"
|
|
5677
|
+
],
|
|
5678
|
+
"properties": {
|
|
5679
|
+
"fieldName": {
|
|
5680
|
+
"type": "string"
|
|
5681
|
+
},
|
|
5682
|
+
"message": {
|
|
5683
|
+
"type": "string"
|
|
5684
|
+
}
|
|
5685
|
+
}
|
|
5686
|
+
},
|
|
5687
|
+
"description": "List of the validation errors"
|
|
5688
|
+
},
|
|
5689
|
+
"validationContext": {
|
|
5690
|
+
"type": "string"
|
|
5691
|
+
},
|
|
5692
|
+
"statusCode": {
|
|
5693
|
+
"type": "number"
|
|
5694
|
+
}
|
|
5695
|
+
}
|
|
5696
|
+
}
|
|
5697
|
+
}
|
|
5698
|
+
}
|
|
5699
|
+
},
|
|
5700
|
+
"4XX": {
|
|
5701
|
+
"description": "Default Response",
|
|
5702
|
+
"content": {
|
|
5703
|
+
"application/json": {
|
|
5704
|
+
"schema": {
|
|
5705
|
+
"type": "object",
|
|
5706
|
+
"required": [
|
|
5707
|
+
"code",
|
|
5708
|
+
"detail",
|
|
5709
|
+
"requestId",
|
|
5710
|
+
"name",
|
|
5711
|
+
"statusCode"
|
|
5712
|
+
],
|
|
5713
|
+
"properties": {
|
|
5714
|
+
"code": {
|
|
5715
|
+
"type": "string",
|
|
5716
|
+
"description": "Code used to categorize the error"
|
|
5717
|
+
},
|
|
5718
|
+
"detail": {
|
|
5719
|
+
"type": "string",
|
|
5720
|
+
"description": "Description of the error"
|
|
5721
|
+
},
|
|
5722
|
+
"requestId": {
|
|
5723
|
+
"type": "string",
|
|
5724
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
5725
|
+
},
|
|
5726
|
+
"name": {
|
|
5727
|
+
"type": "string",
|
|
5728
|
+
"description": "Name of the error type"
|
|
5729
|
+
},
|
|
5730
|
+
"validation": {
|
|
5731
|
+
"type": "array",
|
|
5732
|
+
"items": {
|
|
5733
|
+
"type": "object",
|
|
5734
|
+
"required": [
|
|
5735
|
+
"fieldName",
|
|
5736
|
+
"message"
|
|
5737
|
+
],
|
|
5738
|
+
"properties": {
|
|
5739
|
+
"fieldName": {
|
|
5740
|
+
"type": "string"
|
|
5741
|
+
},
|
|
5742
|
+
"message": {
|
|
5743
|
+
"type": "string"
|
|
5744
|
+
}
|
|
5745
|
+
}
|
|
5746
|
+
},
|
|
5747
|
+
"description": "List of the validation errors"
|
|
5748
|
+
},
|
|
5749
|
+
"validationContext": {
|
|
5750
|
+
"type": "string"
|
|
5751
|
+
},
|
|
5752
|
+
"statusCode": {
|
|
5753
|
+
"type": "number"
|
|
5754
|
+
}
|
|
5755
|
+
}
|
|
5756
|
+
}
|
|
5757
|
+
}
|
|
5758
|
+
}
|
|
5759
|
+
}
|
|
5760
|
+
}
|
|
5761
|
+
}
|
|
5762
|
+
},
|
|
5763
|
+
"/api/v1/message-events/{eventId}": {
|
|
5764
|
+
"get": {
|
|
5765
|
+
"tags": [
|
|
5766
|
+
"Message events"
|
|
5767
|
+
],
|
|
5768
|
+
"description": "Returns the selected event",
|
|
5769
|
+
"parameters": [
|
|
5770
|
+
{
|
|
5771
|
+
"schema": {
|
|
5772
|
+
"type": "string",
|
|
5773
|
+
"format": "uuid"
|
|
5774
|
+
},
|
|
5775
|
+
"in": "path",
|
|
5776
|
+
"name": "eventId",
|
|
5777
|
+
"required": true
|
|
5778
|
+
}
|
|
5779
|
+
],
|
|
5780
|
+
"responses": {
|
|
5781
|
+
"200": {
|
|
5782
|
+
"description": "Default Response",
|
|
5783
|
+
"content": {
|
|
5784
|
+
"application/json": {
|
|
5785
|
+
"schema": {
|
|
5786
|
+
"type": "object",
|
|
5787
|
+
"required": [
|
|
5788
|
+
"data"
|
|
5789
|
+
],
|
|
5790
|
+
"properties": {
|
|
5791
|
+
"data": {
|
|
5792
|
+
"type": "array",
|
|
5793
|
+
"items": {
|
|
5794
|
+
"type": "object",
|
|
5795
|
+
"required": [
|
|
5796
|
+
"messageId",
|
|
5797
|
+
"eventType",
|
|
5798
|
+
"eventStatus",
|
|
5799
|
+
"data",
|
|
5800
|
+
"createdAt"
|
|
5801
|
+
],
|
|
5802
|
+
"properties": {
|
|
5803
|
+
"messageId": {
|
|
5804
|
+
"type": "string",
|
|
5805
|
+
"format": "uuid",
|
|
5806
|
+
"description": "Message id"
|
|
5807
|
+
},
|
|
5808
|
+
"eventType": {
|
|
5809
|
+
"type": "string",
|
|
5810
|
+
"description": "Event type description"
|
|
5811
|
+
},
|
|
5812
|
+
"eventStatus": {
|
|
5813
|
+
"type": "string",
|
|
5814
|
+
"description": "Status for event type"
|
|
5815
|
+
},
|
|
5816
|
+
"data": {
|
|
5817
|
+
"anyOf": [
|
|
5818
|
+
{
|
|
5819
|
+
"type": "object",
|
|
5820
|
+
"required": [
|
|
5821
|
+
"messageId",
|
|
5822
|
+
"receiverFullName",
|
|
5823
|
+
"receiverPPSN",
|
|
5824
|
+
"receiverUserId",
|
|
5825
|
+
"subject",
|
|
5826
|
+
"language",
|
|
5827
|
+
"plainText",
|
|
5828
|
+
"transports",
|
|
5829
|
+
"scheduledAt",
|
|
5830
|
+
"organisationName",
|
|
5831
|
+
"security"
|
|
5832
|
+
],
|
|
5833
|
+
"properties": {
|
|
5834
|
+
"messageId": {
|
|
5835
|
+
"type": "string",
|
|
5836
|
+
"description": "Unique id of the related message"
|
|
5837
|
+
},
|
|
5838
|
+
"receiverFullName": {
|
|
5839
|
+
"type": "string",
|
|
5840
|
+
"description": "Full name of the recipient"
|
|
5841
|
+
},
|
|
5842
|
+
"receiverPPSN": {
|
|
5843
|
+
"type": "string",
|
|
5844
|
+
"description": "PPSN of the recipient"
|
|
5845
|
+
},
|
|
5846
|
+
"receiverUserId": {
|
|
5847
|
+
"type": "string",
|
|
5848
|
+
"description": "User id of recipient"
|
|
5849
|
+
},
|
|
5850
|
+
"subject": {
|
|
5851
|
+
"type": "string",
|
|
5852
|
+
"description": "Subject of the related message"
|
|
5853
|
+
},
|
|
5854
|
+
"language": {
|
|
5311
5855
|
"type": "string",
|
|
5312
5856
|
"description": "Language of the related message"
|
|
5313
5857
|
},
|
|
@@ -5865,32 +6409,1532 @@
|
|
|
5865
6409
|
}
|
|
5866
6410
|
}
|
|
5867
6411
|
},
|
|
5868
|
-
"/api/v1/support/messages/search": {
|
|
5869
|
-
"post": {
|
|
5870
|
-
"operationId": "SupportListMessagesPost",
|
|
6412
|
+
"/api/v1/support/messages/search": {
|
|
6413
|
+
"post": {
|
|
6414
|
+
"operationId": "SupportListMessagesPost",
|
|
6415
|
+
"tags": [
|
|
6416
|
+
"Messages Support"
|
|
6417
|
+
],
|
|
6418
|
+
"description": "Returns all the messages for the requested organisation or the requested recipient",
|
|
6419
|
+
"requestBody": {
|
|
6420
|
+
"required": true,
|
|
6421
|
+
"content": {
|
|
6422
|
+
"application/json": {
|
|
6423
|
+
"schema": {
|
|
6424
|
+
"type": "object",
|
|
6425
|
+
"required": [
|
|
6426
|
+
"recipientUserIds"
|
|
6427
|
+
],
|
|
6428
|
+
"properties": {
|
|
6429
|
+
"recipientUserIds": {
|
|
6430
|
+
"type": "array",
|
|
6431
|
+
"items": {
|
|
6432
|
+
"type": "string",
|
|
6433
|
+
"description": "Unique id of the recipient"
|
|
6434
|
+
},
|
|
6435
|
+
"description": "Filter messages by recipient user ids",
|
|
6436
|
+
"minItems": 1,
|
|
6437
|
+
"maxItems": 10
|
|
6438
|
+
}
|
|
6439
|
+
}
|
|
6440
|
+
}
|
|
6441
|
+
}
|
|
6442
|
+
}
|
|
6443
|
+
},
|
|
6444
|
+
"parameters": [
|
|
6445
|
+
{
|
|
6446
|
+
"schema": {
|
|
6447
|
+
"type": "string",
|
|
6448
|
+
"pattern": "^[0-9][0-9]*|undefined$",
|
|
6449
|
+
"default": "0"
|
|
6450
|
+
},
|
|
6451
|
+
"in": "query",
|
|
6452
|
+
"name": "offset",
|
|
6453
|
+
"required": false,
|
|
6454
|
+
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
6455
|
+
},
|
|
6456
|
+
{
|
|
6457
|
+
"schema": {
|
|
6458
|
+
"type": "string",
|
|
6459
|
+
"default": "20",
|
|
6460
|
+
"pattern": "^([1-9]|100)|undefined$"
|
|
6461
|
+
},
|
|
6462
|
+
"in": "query",
|
|
6463
|
+
"name": "limit",
|
|
6464
|
+
"required": false,
|
|
6465
|
+
"description": "Indicates the maximum number (100) of items that will be returned in a single request"
|
|
6466
|
+
},
|
|
6467
|
+
{
|
|
6468
|
+
"schema": {
|
|
6469
|
+
"type": "string",
|
|
6470
|
+
"format": "date-time"
|
|
6471
|
+
},
|
|
6472
|
+
"in": "query",
|
|
6473
|
+
"name": "deletedAfterDateTime",
|
|
6474
|
+
"required": false,
|
|
6475
|
+
"description": "Filter messages deleted after specified date"
|
|
6476
|
+
}
|
|
6477
|
+
],
|
|
6478
|
+
"responses": {
|
|
6479
|
+
"200": {
|
|
6480
|
+
"description": "Default Response",
|
|
6481
|
+
"content": {
|
|
6482
|
+
"application/json": {
|
|
6483
|
+
"schema": {
|
|
6484
|
+
"type": "object",
|
|
6485
|
+
"required": [
|
|
6486
|
+
"data"
|
|
6487
|
+
],
|
|
6488
|
+
"properties": {
|
|
6489
|
+
"data": {
|
|
6490
|
+
"type": "array",
|
|
6491
|
+
"items": {
|
|
6492
|
+
"type": "object",
|
|
6493
|
+
"required": [
|
|
6494
|
+
"id",
|
|
6495
|
+
"organisationId",
|
|
6496
|
+
"recipientUserId",
|
|
6497
|
+
"threadName",
|
|
6498
|
+
"isSeen",
|
|
6499
|
+
"subject",
|
|
6500
|
+
"richText",
|
|
6501
|
+
"plainText",
|
|
6502
|
+
"createdAt",
|
|
6503
|
+
"scheduledAt",
|
|
6504
|
+
"attachmentIds"
|
|
6505
|
+
],
|
|
6506
|
+
"properties": {
|
|
6507
|
+
"id": {
|
|
6508
|
+
"type": "string",
|
|
6509
|
+
"description": "Unique Id of the message"
|
|
6510
|
+
},
|
|
6511
|
+
"organisationId": {
|
|
6512
|
+
"type": "string",
|
|
6513
|
+
"description": "Organisation sender id"
|
|
6514
|
+
},
|
|
6515
|
+
"recipientUserId": {
|
|
6516
|
+
"type": "string",
|
|
6517
|
+
"description": "Unique id of the recipient"
|
|
6518
|
+
},
|
|
6519
|
+
"threadName": {
|
|
6520
|
+
"anyOf": [
|
|
6521
|
+
{
|
|
6522
|
+
"type": "string",
|
|
6523
|
+
"description": "Thread Name used to group messages"
|
|
6524
|
+
},
|
|
6525
|
+
{
|
|
6526
|
+
"type": "null"
|
|
6527
|
+
}
|
|
6528
|
+
]
|
|
6529
|
+
},
|
|
6530
|
+
"isSeen": {
|
|
6531
|
+
"type": "boolean",
|
|
6532
|
+
"description": "Whether the message has been seen"
|
|
6533
|
+
},
|
|
6534
|
+
"subject": {
|
|
6535
|
+
"type": "string",
|
|
6536
|
+
"description": "Subject"
|
|
6537
|
+
},
|
|
6538
|
+
"richText": {
|
|
6539
|
+
"anyOf": [
|
|
6540
|
+
{
|
|
6541
|
+
"type": "string",
|
|
6542
|
+
"description": "Rich text content of the message"
|
|
6543
|
+
},
|
|
6544
|
+
{
|
|
6545
|
+
"type": "null"
|
|
6546
|
+
}
|
|
6547
|
+
]
|
|
6548
|
+
},
|
|
6549
|
+
"plainText": {
|
|
6550
|
+
"type": "string",
|
|
6551
|
+
"description": "Plain text content of the message"
|
|
6552
|
+
},
|
|
6553
|
+
"createdAt": {
|
|
6554
|
+
"type": "string",
|
|
6555
|
+
"description": "Creation date time"
|
|
6556
|
+
},
|
|
6557
|
+
"scheduledAt": {
|
|
6558
|
+
"type": "string",
|
|
6559
|
+
"description": "Scheduled date time"
|
|
6560
|
+
},
|
|
6561
|
+
"attachmentIds": {
|
|
6562
|
+
"type": "array",
|
|
6563
|
+
"items": {
|
|
6564
|
+
"type": "string",
|
|
6565
|
+
"description": "Attachment Ids"
|
|
6566
|
+
}
|
|
6567
|
+
}
|
|
6568
|
+
}
|
|
6569
|
+
}
|
|
6570
|
+
},
|
|
6571
|
+
"metadata": {
|
|
6572
|
+
"type": "object",
|
|
6573
|
+
"properties": {
|
|
6574
|
+
"links": {
|
|
6575
|
+
"type": "object",
|
|
6576
|
+
"required": [
|
|
6577
|
+
"self",
|
|
6578
|
+
"first",
|
|
6579
|
+
"last",
|
|
6580
|
+
"pages"
|
|
6581
|
+
],
|
|
6582
|
+
"properties": {
|
|
6583
|
+
"self": {
|
|
6584
|
+
"type": "object",
|
|
6585
|
+
"properties": {
|
|
6586
|
+
"href": {
|
|
6587
|
+
"type": "string",
|
|
6588
|
+
"description": "URL pointing to the request itself"
|
|
6589
|
+
}
|
|
6590
|
+
}
|
|
6591
|
+
},
|
|
6592
|
+
"next": {
|
|
6593
|
+
"type": "object",
|
|
6594
|
+
"properties": {
|
|
6595
|
+
"href": {
|
|
6596
|
+
"type": "string",
|
|
6597
|
+
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
6598
|
+
}
|
|
6599
|
+
}
|
|
6600
|
+
},
|
|
6601
|
+
"prev": {
|
|
6602
|
+
"type": "object",
|
|
6603
|
+
"properties": {
|
|
6604
|
+
"href": {
|
|
6605
|
+
"type": "string",
|
|
6606
|
+
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
6607
|
+
}
|
|
6608
|
+
}
|
|
6609
|
+
},
|
|
6610
|
+
"first": {
|
|
6611
|
+
"type": "object",
|
|
6612
|
+
"properties": {
|
|
6613
|
+
"href": {
|
|
6614
|
+
"type": "string",
|
|
6615
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
6616
|
+
}
|
|
6617
|
+
}
|
|
6618
|
+
},
|
|
6619
|
+
"last": {
|
|
6620
|
+
"type": "object",
|
|
6621
|
+
"properties": {
|
|
6622
|
+
"href": {
|
|
6623
|
+
"type": "string",
|
|
6624
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
6625
|
+
}
|
|
6626
|
+
}
|
|
6627
|
+
},
|
|
6628
|
+
"pages": {
|
|
6629
|
+
"type": "object",
|
|
6630
|
+
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
6631
|
+
"additionalProperties": {
|
|
6632
|
+
"type": "object",
|
|
6633
|
+
"properties": {
|
|
6634
|
+
"href": {
|
|
6635
|
+
"type": "string"
|
|
6636
|
+
}
|
|
6637
|
+
}
|
|
6638
|
+
}
|
|
6639
|
+
}
|
|
6640
|
+
},
|
|
6641
|
+
"description": "Object containing the links to the related endpoints"
|
|
6642
|
+
},
|
|
6643
|
+
"totalCount": {
|
|
6644
|
+
"type": "number",
|
|
6645
|
+
"description": "Number representing the total number of available items"
|
|
6646
|
+
}
|
|
6647
|
+
}
|
|
6648
|
+
}
|
|
6649
|
+
}
|
|
6650
|
+
}
|
|
6651
|
+
}
|
|
6652
|
+
}
|
|
6653
|
+
},
|
|
6654
|
+
"4XX": {
|
|
6655
|
+
"description": "Default Response",
|
|
6656
|
+
"content": {
|
|
6657
|
+
"application/json": {
|
|
6658
|
+
"schema": {
|
|
6659
|
+
"type": "object",
|
|
6660
|
+
"required": [
|
|
6661
|
+
"code",
|
|
6662
|
+
"detail",
|
|
6663
|
+
"requestId",
|
|
6664
|
+
"name",
|
|
6665
|
+
"statusCode"
|
|
6666
|
+
],
|
|
6667
|
+
"properties": {
|
|
6668
|
+
"code": {
|
|
6669
|
+
"type": "string",
|
|
6670
|
+
"description": "Code used to categorize the error"
|
|
6671
|
+
},
|
|
6672
|
+
"detail": {
|
|
6673
|
+
"type": "string",
|
|
6674
|
+
"description": "Description of the error"
|
|
6675
|
+
},
|
|
6676
|
+
"requestId": {
|
|
6677
|
+
"type": "string",
|
|
6678
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
6679
|
+
},
|
|
6680
|
+
"name": {
|
|
6681
|
+
"type": "string",
|
|
6682
|
+
"description": "Name of the error type"
|
|
6683
|
+
},
|
|
6684
|
+
"validation": {
|
|
6685
|
+
"type": "array",
|
|
6686
|
+
"items": {
|
|
6687
|
+
"type": "object",
|
|
6688
|
+
"required": [
|
|
6689
|
+
"fieldName",
|
|
6690
|
+
"message"
|
|
6691
|
+
],
|
|
6692
|
+
"properties": {
|
|
6693
|
+
"fieldName": {
|
|
6694
|
+
"type": "string"
|
|
6695
|
+
},
|
|
6696
|
+
"message": {
|
|
6697
|
+
"type": "string"
|
|
6698
|
+
}
|
|
6699
|
+
}
|
|
6700
|
+
},
|
|
6701
|
+
"description": "List of the validation errors"
|
|
6702
|
+
},
|
|
6703
|
+
"validationContext": {
|
|
6704
|
+
"type": "string"
|
|
6705
|
+
},
|
|
6706
|
+
"statusCode": {
|
|
6707
|
+
"type": "number"
|
|
6708
|
+
}
|
|
6709
|
+
}
|
|
6710
|
+
}
|
|
6711
|
+
}
|
|
6712
|
+
}
|
|
6713
|
+
},
|
|
6714
|
+
"5XX": {
|
|
6715
|
+
"description": "Default Response",
|
|
6716
|
+
"content": {
|
|
6717
|
+
"application/json": {
|
|
6718
|
+
"schema": {
|
|
6719
|
+
"type": "object",
|
|
6720
|
+
"required": [
|
|
6721
|
+
"code",
|
|
6722
|
+
"detail",
|
|
6723
|
+
"requestId",
|
|
6724
|
+
"name",
|
|
6725
|
+
"statusCode"
|
|
6726
|
+
],
|
|
6727
|
+
"properties": {
|
|
6728
|
+
"code": {
|
|
6729
|
+
"type": "string",
|
|
6730
|
+
"description": "Code used to categorize the error"
|
|
6731
|
+
},
|
|
6732
|
+
"detail": {
|
|
6733
|
+
"type": "string",
|
|
6734
|
+
"description": "Description of the error"
|
|
6735
|
+
},
|
|
6736
|
+
"requestId": {
|
|
6737
|
+
"type": "string",
|
|
6738
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
6739
|
+
},
|
|
6740
|
+
"name": {
|
|
6741
|
+
"type": "string",
|
|
6742
|
+
"description": "Name of the error type"
|
|
6743
|
+
},
|
|
6744
|
+
"validation": {
|
|
6745
|
+
"type": "array",
|
|
6746
|
+
"items": {
|
|
6747
|
+
"type": "object",
|
|
6748
|
+
"required": [
|
|
6749
|
+
"fieldName",
|
|
6750
|
+
"message"
|
|
6751
|
+
],
|
|
6752
|
+
"properties": {
|
|
6753
|
+
"fieldName": {
|
|
6754
|
+
"type": "string"
|
|
6755
|
+
},
|
|
6756
|
+
"message": {
|
|
6757
|
+
"type": "string"
|
|
6758
|
+
}
|
|
6759
|
+
}
|
|
6760
|
+
},
|
|
6761
|
+
"description": "List of the validation errors"
|
|
6762
|
+
},
|
|
6763
|
+
"validationContext": {
|
|
6764
|
+
"type": "string"
|
|
6765
|
+
},
|
|
6766
|
+
"statusCode": {
|
|
6767
|
+
"type": "number"
|
|
6768
|
+
}
|
|
6769
|
+
}
|
|
6770
|
+
}
|
|
6771
|
+
}
|
|
6772
|
+
}
|
|
6773
|
+
}
|
|
6774
|
+
}
|
|
6775
|
+
}
|
|
6776
|
+
},
|
|
6777
|
+
"/api/v1/support/messages/": {
|
|
6778
|
+
"post": {
|
|
6779
|
+
"operationId": "SupportCreateMessage",
|
|
6780
|
+
"tags": [
|
|
6781
|
+
"Messages"
|
|
6782
|
+
],
|
|
6783
|
+
"description": "Creates a message",
|
|
6784
|
+
"requestBody": {
|
|
6785
|
+
"required": true,
|
|
6786
|
+
"content": {
|
|
6787
|
+
"application/json": {
|
|
6788
|
+
"schema": {
|
|
6789
|
+
"type": "object",
|
|
6790
|
+
"required": [
|
|
6791
|
+
"preferredTransports",
|
|
6792
|
+
"recipientUserId",
|
|
6793
|
+
"security",
|
|
6794
|
+
"scheduleAt",
|
|
6795
|
+
"message"
|
|
6796
|
+
],
|
|
6797
|
+
"properties": {
|
|
6798
|
+
"preferredTransports": {
|
|
6799
|
+
"type": "array",
|
|
6800
|
+
"items": {
|
|
6801
|
+
"type": "string",
|
|
6802
|
+
"enum": [
|
|
6803
|
+
"email",
|
|
6804
|
+
"lifeEvent"
|
|
6805
|
+
],
|
|
6806
|
+
"description": "All the available provider types"
|
|
6807
|
+
},
|
|
6808
|
+
"description": "The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used"
|
|
6809
|
+
},
|
|
6810
|
+
"recipientUserId": {
|
|
6811
|
+
"type": "string",
|
|
6812
|
+
"description": "Unique user id of the recipient"
|
|
6813
|
+
},
|
|
6814
|
+
"security": {
|
|
6815
|
+
"type": "string",
|
|
6816
|
+
"enum": [
|
|
6817
|
+
"confidential",
|
|
6818
|
+
"public"
|
|
6819
|
+
],
|
|
6820
|
+
"description": "Confidentiality level of the message"
|
|
6821
|
+
},
|
|
6822
|
+
"scheduleAt": {
|
|
6823
|
+
"type": "string",
|
|
6824
|
+
"format": "date-time",
|
|
6825
|
+
"description": "Date and time of when schedule the message"
|
|
6826
|
+
},
|
|
6827
|
+
"message": {
|
|
6828
|
+
"type": "object",
|
|
6829
|
+
"required": [
|
|
6830
|
+
"subject",
|
|
6831
|
+
"plainText",
|
|
6832
|
+
"language"
|
|
6833
|
+
],
|
|
6834
|
+
"properties": {
|
|
6835
|
+
"threadName": {
|
|
6836
|
+
"type": "string",
|
|
6837
|
+
"description": "Thread Name used to group messages",
|
|
6838
|
+
"minLength": 1
|
|
6839
|
+
},
|
|
6840
|
+
"subject": {
|
|
6841
|
+
"type": "string",
|
|
6842
|
+
"description": "Subject. This is the only part that will be seen outside of the messaging platform is security is 'confidential'",
|
|
6843
|
+
"minLength": 1
|
|
6844
|
+
},
|
|
6845
|
+
"excerpt": {
|
|
6846
|
+
"type": "string",
|
|
6847
|
+
"description": "Brief description of the message"
|
|
6848
|
+
},
|
|
6849
|
+
"plainText": {
|
|
6850
|
+
"type": "string",
|
|
6851
|
+
"description": "Plain text version of the message",
|
|
6852
|
+
"minLength": 1
|
|
6853
|
+
},
|
|
6854
|
+
"richText": {
|
|
6855
|
+
"type": "string",
|
|
6856
|
+
"description": "Rich text (html) version of the message"
|
|
6857
|
+
},
|
|
6858
|
+
"language": {
|
|
6859
|
+
"type": "string",
|
|
6860
|
+
"enum": [
|
|
6861
|
+
"en",
|
|
6862
|
+
"ga"
|
|
6863
|
+
],
|
|
6864
|
+
"description": "Language used to send the message"
|
|
6865
|
+
},
|
|
6866
|
+
"externalId": {
|
|
6867
|
+
"type": "string",
|
|
6868
|
+
"description": "External id to link the message to an external system"
|
|
6869
|
+
}
|
|
6870
|
+
}
|
|
6871
|
+
},
|
|
6872
|
+
"attachments": {
|
|
6873
|
+
"type": "array",
|
|
6874
|
+
"items": {
|
|
6875
|
+
"type": "string",
|
|
6876
|
+
"format": "uuid"
|
|
6877
|
+
}
|
|
6878
|
+
}
|
|
6879
|
+
}
|
|
6880
|
+
}
|
|
6881
|
+
}
|
|
6882
|
+
}
|
|
6883
|
+
},
|
|
6884
|
+
"responses": {
|
|
6885
|
+
"201": {
|
|
6886
|
+
"description": "Default Response",
|
|
6887
|
+
"content": {
|
|
6888
|
+
"application/json": {
|
|
6889
|
+
"schema": {
|
|
6890
|
+
"type": "object",
|
|
6891
|
+
"required": [
|
|
6892
|
+
"data"
|
|
6893
|
+
],
|
|
6894
|
+
"properties": {
|
|
6895
|
+
"data": {
|
|
6896
|
+
"type": "object",
|
|
6897
|
+
"required": [
|
|
6898
|
+
"id"
|
|
6899
|
+
],
|
|
6900
|
+
"properties": {
|
|
6901
|
+
"id": {
|
|
6902
|
+
"type": "string",
|
|
6903
|
+
"format": "uuid",
|
|
6904
|
+
"description": "Unique Id of the resource"
|
|
6905
|
+
}
|
|
6906
|
+
}
|
|
6907
|
+
},
|
|
6908
|
+
"metadata": {
|
|
6909
|
+
"type": "object",
|
|
6910
|
+
"properties": {
|
|
6911
|
+
"links": {
|
|
6912
|
+
"type": "object",
|
|
6913
|
+
"required": [
|
|
6914
|
+
"self",
|
|
6915
|
+
"first",
|
|
6916
|
+
"last",
|
|
6917
|
+
"pages"
|
|
6918
|
+
],
|
|
6919
|
+
"properties": {
|
|
6920
|
+
"self": {
|
|
6921
|
+
"type": "object",
|
|
6922
|
+
"properties": {
|
|
6923
|
+
"href": {
|
|
6924
|
+
"type": "string",
|
|
6925
|
+
"description": "URL pointing to the request itself"
|
|
6926
|
+
}
|
|
6927
|
+
}
|
|
6928
|
+
},
|
|
6929
|
+
"next": {
|
|
6930
|
+
"type": "object",
|
|
6931
|
+
"properties": {
|
|
6932
|
+
"href": {
|
|
6933
|
+
"type": "string",
|
|
6934
|
+
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
6935
|
+
}
|
|
6936
|
+
}
|
|
6937
|
+
},
|
|
6938
|
+
"prev": {
|
|
6939
|
+
"type": "object",
|
|
6940
|
+
"properties": {
|
|
6941
|
+
"href": {
|
|
6942
|
+
"type": "string",
|
|
6943
|
+
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
6944
|
+
}
|
|
6945
|
+
}
|
|
6946
|
+
},
|
|
6947
|
+
"first": {
|
|
6948
|
+
"type": "object",
|
|
6949
|
+
"properties": {
|
|
6950
|
+
"href": {
|
|
6951
|
+
"type": "string",
|
|
6952
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
6953
|
+
}
|
|
6954
|
+
}
|
|
6955
|
+
},
|
|
6956
|
+
"last": {
|
|
6957
|
+
"type": "object",
|
|
6958
|
+
"properties": {
|
|
6959
|
+
"href": {
|
|
6960
|
+
"type": "string",
|
|
6961
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
6962
|
+
}
|
|
6963
|
+
}
|
|
6964
|
+
},
|
|
6965
|
+
"pages": {
|
|
6966
|
+
"type": "object",
|
|
6967
|
+
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
6968
|
+
"additionalProperties": {
|
|
6969
|
+
"type": "object",
|
|
6970
|
+
"properties": {
|
|
6971
|
+
"href": {
|
|
6972
|
+
"type": "string"
|
|
6973
|
+
}
|
|
6974
|
+
}
|
|
6975
|
+
}
|
|
6976
|
+
}
|
|
6977
|
+
},
|
|
6978
|
+
"description": "Object containing the links to the related endpoints"
|
|
6979
|
+
},
|
|
6980
|
+
"totalCount": {
|
|
6981
|
+
"type": "number",
|
|
6982
|
+
"description": "Number representing the total number of available items"
|
|
6983
|
+
}
|
|
6984
|
+
}
|
|
6985
|
+
}
|
|
6986
|
+
}
|
|
6987
|
+
}
|
|
6988
|
+
}
|
|
6989
|
+
}
|
|
6990
|
+
},
|
|
6991
|
+
"4XX": {
|
|
6992
|
+
"description": "Default Response",
|
|
6993
|
+
"content": {
|
|
6994
|
+
"application/json": {
|
|
6995
|
+
"schema": {
|
|
6996
|
+
"type": "object",
|
|
6997
|
+
"required": [
|
|
6998
|
+
"code",
|
|
6999
|
+
"detail",
|
|
7000
|
+
"requestId",
|
|
7001
|
+
"name",
|
|
7002
|
+
"statusCode"
|
|
7003
|
+
],
|
|
7004
|
+
"properties": {
|
|
7005
|
+
"code": {
|
|
7006
|
+
"type": "string",
|
|
7007
|
+
"description": "Code used to categorize the error"
|
|
7008
|
+
},
|
|
7009
|
+
"detail": {
|
|
7010
|
+
"type": "string",
|
|
7011
|
+
"description": "Description of the error"
|
|
7012
|
+
},
|
|
7013
|
+
"requestId": {
|
|
7014
|
+
"type": "string",
|
|
7015
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
7016
|
+
},
|
|
7017
|
+
"name": {
|
|
7018
|
+
"type": "string",
|
|
7019
|
+
"description": "Name of the error type"
|
|
7020
|
+
},
|
|
7021
|
+
"validation": {
|
|
7022
|
+
"type": "array",
|
|
7023
|
+
"items": {
|
|
7024
|
+
"type": "object",
|
|
7025
|
+
"required": [
|
|
7026
|
+
"fieldName",
|
|
7027
|
+
"message"
|
|
7028
|
+
],
|
|
7029
|
+
"properties": {
|
|
7030
|
+
"fieldName": {
|
|
7031
|
+
"type": "string"
|
|
7032
|
+
},
|
|
7033
|
+
"message": {
|
|
7034
|
+
"type": "string"
|
|
7035
|
+
}
|
|
7036
|
+
}
|
|
7037
|
+
},
|
|
7038
|
+
"description": "List of the validation errors"
|
|
7039
|
+
},
|
|
7040
|
+
"validationContext": {
|
|
7041
|
+
"type": "string"
|
|
7042
|
+
},
|
|
7043
|
+
"statusCode": {
|
|
7044
|
+
"type": "number"
|
|
7045
|
+
}
|
|
7046
|
+
}
|
|
7047
|
+
}
|
|
7048
|
+
}
|
|
7049
|
+
}
|
|
7050
|
+
},
|
|
7051
|
+
"5XX": {
|
|
7052
|
+
"description": "Default Response",
|
|
7053
|
+
"content": {
|
|
7054
|
+
"application/json": {
|
|
7055
|
+
"schema": {
|
|
7056
|
+
"type": "object",
|
|
7057
|
+
"required": [
|
|
7058
|
+
"code",
|
|
7059
|
+
"detail",
|
|
7060
|
+
"requestId",
|
|
7061
|
+
"name",
|
|
7062
|
+
"statusCode"
|
|
7063
|
+
],
|
|
7064
|
+
"properties": {
|
|
7065
|
+
"code": {
|
|
7066
|
+
"type": "string",
|
|
7067
|
+
"description": "Code used to categorize the error"
|
|
7068
|
+
},
|
|
7069
|
+
"detail": {
|
|
7070
|
+
"type": "string",
|
|
7071
|
+
"description": "Description of the error"
|
|
7072
|
+
},
|
|
7073
|
+
"requestId": {
|
|
7074
|
+
"type": "string",
|
|
7075
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
7076
|
+
},
|
|
7077
|
+
"name": {
|
|
7078
|
+
"type": "string",
|
|
7079
|
+
"description": "Name of the error type"
|
|
7080
|
+
},
|
|
7081
|
+
"validation": {
|
|
7082
|
+
"type": "array",
|
|
7083
|
+
"items": {
|
|
7084
|
+
"type": "object",
|
|
7085
|
+
"required": [
|
|
7086
|
+
"fieldName",
|
|
7087
|
+
"message"
|
|
7088
|
+
],
|
|
7089
|
+
"properties": {
|
|
7090
|
+
"fieldName": {
|
|
7091
|
+
"type": "string"
|
|
7092
|
+
},
|
|
7093
|
+
"message": {
|
|
7094
|
+
"type": "string"
|
|
7095
|
+
}
|
|
7096
|
+
}
|
|
7097
|
+
},
|
|
7098
|
+
"description": "List of the validation errors"
|
|
7099
|
+
},
|
|
7100
|
+
"validationContext": {
|
|
7101
|
+
"type": "string"
|
|
7102
|
+
},
|
|
7103
|
+
"statusCode": {
|
|
7104
|
+
"type": "number"
|
|
7105
|
+
}
|
|
7106
|
+
}
|
|
7107
|
+
}
|
|
7108
|
+
}
|
|
7109
|
+
}
|
|
7110
|
+
}
|
|
7111
|
+
}
|
|
7112
|
+
}
|
|
7113
|
+
},
|
|
7114
|
+
"/api/v1/tags/": {
|
|
7115
|
+
"post": {
|
|
7116
|
+
"operationId": "CreateTag",
|
|
7117
|
+
"tags": [
|
|
7118
|
+
"Tags"
|
|
7119
|
+
],
|
|
7120
|
+
"description": "Creates a tag for the logged-in user",
|
|
7121
|
+
"requestBody": {
|
|
7122
|
+
"required": true,
|
|
7123
|
+
"content": {
|
|
7124
|
+
"application/json": {
|
|
7125
|
+
"schema": {
|
|
7126
|
+
"type": "object",
|
|
7127
|
+
"required": [
|
|
7128
|
+
"label"
|
|
7129
|
+
],
|
|
7130
|
+
"properties": {
|
|
7131
|
+
"label": {
|
|
7132
|
+
"type": "string",
|
|
7133
|
+
"description": "Display name of the tag",
|
|
7134
|
+
"minLength": 1,
|
|
7135
|
+
"maxLength": 100
|
|
7136
|
+
},
|
|
7137
|
+
"parentTagId": {
|
|
7138
|
+
"type": "string",
|
|
7139
|
+
"format": "uuid",
|
|
7140
|
+
"description": "Parent tag id (omit for root-level tag)"
|
|
7141
|
+
}
|
|
7142
|
+
}
|
|
7143
|
+
}
|
|
7144
|
+
}
|
|
7145
|
+
}
|
|
7146
|
+
},
|
|
7147
|
+
"responses": {
|
|
7148
|
+
"201": {
|
|
7149
|
+
"description": "Default Response",
|
|
7150
|
+
"content": {
|
|
7151
|
+
"application/json": {
|
|
7152
|
+
"schema": {
|
|
7153
|
+
"type": "object",
|
|
7154
|
+
"required": [
|
|
7155
|
+
"data"
|
|
7156
|
+
],
|
|
7157
|
+
"properties": {
|
|
7158
|
+
"data": {
|
|
7159
|
+
"type": "object",
|
|
7160
|
+
"required": [
|
|
7161
|
+
"id"
|
|
7162
|
+
],
|
|
7163
|
+
"properties": {
|
|
7164
|
+
"id": {
|
|
7165
|
+
"type": "string",
|
|
7166
|
+
"format": "uuid",
|
|
7167
|
+
"description": "Unique Id of the created tag"
|
|
7168
|
+
}
|
|
7169
|
+
}
|
|
7170
|
+
},
|
|
7171
|
+
"metadata": {
|
|
7172
|
+
"type": "object",
|
|
7173
|
+
"properties": {
|
|
7174
|
+
"links": {
|
|
7175
|
+
"type": "object",
|
|
7176
|
+
"required": [
|
|
7177
|
+
"self",
|
|
7178
|
+
"first",
|
|
7179
|
+
"last",
|
|
7180
|
+
"pages"
|
|
7181
|
+
],
|
|
7182
|
+
"properties": {
|
|
7183
|
+
"self": {
|
|
7184
|
+
"type": "object",
|
|
7185
|
+
"properties": {
|
|
7186
|
+
"href": {
|
|
7187
|
+
"type": "string",
|
|
7188
|
+
"description": "URL pointing to the request itself"
|
|
7189
|
+
}
|
|
7190
|
+
}
|
|
7191
|
+
},
|
|
7192
|
+
"next": {
|
|
7193
|
+
"type": "object",
|
|
7194
|
+
"properties": {
|
|
7195
|
+
"href": {
|
|
7196
|
+
"type": "string",
|
|
7197
|
+
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
7198
|
+
}
|
|
7199
|
+
}
|
|
7200
|
+
},
|
|
7201
|
+
"prev": {
|
|
7202
|
+
"type": "object",
|
|
7203
|
+
"properties": {
|
|
7204
|
+
"href": {
|
|
7205
|
+
"type": "string",
|
|
7206
|
+
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
7207
|
+
}
|
|
7208
|
+
}
|
|
7209
|
+
},
|
|
7210
|
+
"first": {
|
|
7211
|
+
"type": "object",
|
|
7212
|
+
"properties": {
|
|
7213
|
+
"href": {
|
|
7214
|
+
"type": "string",
|
|
7215
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
7216
|
+
}
|
|
7217
|
+
}
|
|
7218
|
+
},
|
|
7219
|
+
"last": {
|
|
7220
|
+
"type": "object",
|
|
7221
|
+
"properties": {
|
|
7222
|
+
"href": {
|
|
7223
|
+
"type": "string",
|
|
7224
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
7225
|
+
}
|
|
7226
|
+
}
|
|
7227
|
+
},
|
|
7228
|
+
"pages": {
|
|
7229
|
+
"type": "object",
|
|
7230
|
+
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
7231
|
+
"additionalProperties": {
|
|
7232
|
+
"type": "object",
|
|
7233
|
+
"properties": {
|
|
7234
|
+
"href": {
|
|
7235
|
+
"type": "string"
|
|
7236
|
+
}
|
|
7237
|
+
}
|
|
7238
|
+
}
|
|
7239
|
+
}
|
|
7240
|
+
},
|
|
7241
|
+
"description": "Object containing the links to the related endpoints"
|
|
7242
|
+
},
|
|
7243
|
+
"totalCount": {
|
|
7244
|
+
"type": "number",
|
|
7245
|
+
"description": "Number representing the total number of available items"
|
|
7246
|
+
}
|
|
7247
|
+
}
|
|
7248
|
+
}
|
|
7249
|
+
}
|
|
7250
|
+
}
|
|
7251
|
+
}
|
|
7252
|
+
}
|
|
7253
|
+
},
|
|
7254
|
+
"4XX": {
|
|
7255
|
+
"description": "Default Response",
|
|
7256
|
+
"content": {
|
|
7257
|
+
"application/json": {
|
|
7258
|
+
"schema": {
|
|
7259
|
+
"type": "object",
|
|
7260
|
+
"required": [
|
|
7261
|
+
"code",
|
|
7262
|
+
"detail",
|
|
7263
|
+
"requestId",
|
|
7264
|
+
"name",
|
|
7265
|
+
"statusCode"
|
|
7266
|
+
],
|
|
7267
|
+
"properties": {
|
|
7268
|
+
"code": {
|
|
7269
|
+
"type": "string",
|
|
7270
|
+
"description": "Code used to categorize the error"
|
|
7271
|
+
},
|
|
7272
|
+
"detail": {
|
|
7273
|
+
"type": "string",
|
|
7274
|
+
"description": "Description of the error"
|
|
7275
|
+
},
|
|
7276
|
+
"requestId": {
|
|
7277
|
+
"type": "string",
|
|
7278
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
7279
|
+
},
|
|
7280
|
+
"name": {
|
|
7281
|
+
"type": "string",
|
|
7282
|
+
"description": "Name of the error type"
|
|
7283
|
+
},
|
|
7284
|
+
"validation": {
|
|
7285
|
+
"type": "array",
|
|
7286
|
+
"items": {
|
|
7287
|
+
"type": "object",
|
|
7288
|
+
"required": [
|
|
7289
|
+
"fieldName",
|
|
7290
|
+
"message"
|
|
7291
|
+
],
|
|
7292
|
+
"properties": {
|
|
7293
|
+
"fieldName": {
|
|
7294
|
+
"type": "string"
|
|
7295
|
+
},
|
|
7296
|
+
"message": {
|
|
7297
|
+
"type": "string"
|
|
7298
|
+
}
|
|
7299
|
+
}
|
|
7300
|
+
},
|
|
7301
|
+
"description": "List of the validation errors"
|
|
7302
|
+
},
|
|
7303
|
+
"validationContext": {
|
|
7304
|
+
"type": "string"
|
|
7305
|
+
},
|
|
7306
|
+
"statusCode": {
|
|
7307
|
+
"type": "number"
|
|
7308
|
+
}
|
|
7309
|
+
}
|
|
7310
|
+
}
|
|
7311
|
+
}
|
|
7312
|
+
}
|
|
7313
|
+
},
|
|
7314
|
+
"5XX": {
|
|
7315
|
+
"description": "Default Response",
|
|
7316
|
+
"content": {
|
|
7317
|
+
"application/json": {
|
|
7318
|
+
"schema": {
|
|
7319
|
+
"type": "object",
|
|
7320
|
+
"required": [
|
|
7321
|
+
"code",
|
|
7322
|
+
"detail",
|
|
7323
|
+
"requestId",
|
|
7324
|
+
"name",
|
|
7325
|
+
"statusCode"
|
|
7326
|
+
],
|
|
7327
|
+
"properties": {
|
|
7328
|
+
"code": {
|
|
7329
|
+
"type": "string",
|
|
7330
|
+
"description": "Code used to categorize the error"
|
|
7331
|
+
},
|
|
7332
|
+
"detail": {
|
|
7333
|
+
"type": "string",
|
|
7334
|
+
"description": "Description of the error"
|
|
7335
|
+
},
|
|
7336
|
+
"requestId": {
|
|
7337
|
+
"type": "string",
|
|
7338
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
7339
|
+
},
|
|
7340
|
+
"name": {
|
|
7341
|
+
"type": "string",
|
|
7342
|
+
"description": "Name of the error type"
|
|
7343
|
+
},
|
|
7344
|
+
"validation": {
|
|
7345
|
+
"type": "array",
|
|
7346
|
+
"items": {
|
|
7347
|
+
"type": "object",
|
|
7348
|
+
"required": [
|
|
7349
|
+
"fieldName",
|
|
7350
|
+
"message"
|
|
7351
|
+
],
|
|
7352
|
+
"properties": {
|
|
7353
|
+
"fieldName": {
|
|
7354
|
+
"type": "string"
|
|
7355
|
+
},
|
|
7356
|
+
"message": {
|
|
7357
|
+
"type": "string"
|
|
7358
|
+
}
|
|
7359
|
+
}
|
|
7360
|
+
},
|
|
7361
|
+
"description": "List of the validation errors"
|
|
7362
|
+
},
|
|
7363
|
+
"validationContext": {
|
|
7364
|
+
"type": "string"
|
|
7365
|
+
},
|
|
7366
|
+
"statusCode": {
|
|
7367
|
+
"type": "number"
|
|
7368
|
+
}
|
|
7369
|
+
}
|
|
7370
|
+
}
|
|
7371
|
+
}
|
|
7372
|
+
}
|
|
7373
|
+
}
|
|
7374
|
+
}
|
|
7375
|
+
},
|
|
7376
|
+
"get": {
|
|
7377
|
+
"operationId": "ListTags",
|
|
7378
|
+
"tags": [
|
|
7379
|
+
"Tags"
|
|
7380
|
+
],
|
|
7381
|
+
"description": "Returns all tags for the logged-in user (flat list)",
|
|
7382
|
+
"responses": {
|
|
7383
|
+
"200": {
|
|
7384
|
+
"description": "Default Response",
|
|
7385
|
+
"content": {
|
|
7386
|
+
"application/json": {
|
|
7387
|
+
"schema": {
|
|
7388
|
+
"type": "object",
|
|
7389
|
+
"required": [
|
|
7390
|
+
"data"
|
|
7391
|
+
],
|
|
7392
|
+
"properties": {
|
|
7393
|
+
"data": {
|
|
7394
|
+
"type": "array",
|
|
7395
|
+
"items": {
|
|
7396
|
+
"type": "object",
|
|
7397
|
+
"required": [
|
|
7398
|
+
"id",
|
|
7399
|
+
"userId",
|
|
7400
|
+
"label",
|
|
7401
|
+
"parentTagId",
|
|
7402
|
+
"path",
|
|
7403
|
+
"createdAt",
|
|
7404
|
+
"updatedAt"
|
|
7405
|
+
],
|
|
7406
|
+
"properties": {
|
|
7407
|
+
"id": {
|
|
7408
|
+
"type": "string",
|
|
7409
|
+
"format": "uuid",
|
|
7410
|
+
"description": "Unique Id of the tag"
|
|
7411
|
+
},
|
|
7412
|
+
"userId": {
|
|
7413
|
+
"type": "string",
|
|
7414
|
+
"description": "Owner user id"
|
|
7415
|
+
},
|
|
7416
|
+
"label": {
|
|
7417
|
+
"type": "string",
|
|
7418
|
+
"description": "Display name of the tag"
|
|
7419
|
+
},
|
|
7420
|
+
"parentTagId": {
|
|
7421
|
+
"anyOf": [
|
|
7422
|
+
{
|
|
7423
|
+
"type": "string",
|
|
7424
|
+
"format": "uuid",
|
|
7425
|
+
"description": "Parent tag id"
|
|
7426
|
+
},
|
|
7427
|
+
{
|
|
7428
|
+
"type": "null"
|
|
7429
|
+
}
|
|
7430
|
+
]
|
|
7431
|
+
},
|
|
7432
|
+
"path": {
|
|
7433
|
+
"type": "string",
|
|
7434
|
+
"description": "Materialized ltree path"
|
|
7435
|
+
},
|
|
7436
|
+
"createdAt": {
|
|
7437
|
+
"type": "string",
|
|
7438
|
+
"description": "Creation date time"
|
|
7439
|
+
},
|
|
7440
|
+
"updatedAt": {
|
|
7441
|
+
"type": "string",
|
|
7442
|
+
"description": "Last update date time"
|
|
7443
|
+
}
|
|
7444
|
+
}
|
|
7445
|
+
}
|
|
7446
|
+
},
|
|
7447
|
+
"metadata": {
|
|
7448
|
+
"type": "object",
|
|
7449
|
+
"properties": {
|
|
7450
|
+
"links": {
|
|
7451
|
+
"type": "object",
|
|
7452
|
+
"required": [
|
|
7453
|
+
"self",
|
|
7454
|
+
"first",
|
|
7455
|
+
"last",
|
|
7456
|
+
"pages"
|
|
7457
|
+
],
|
|
7458
|
+
"properties": {
|
|
7459
|
+
"self": {
|
|
7460
|
+
"type": "object",
|
|
7461
|
+
"properties": {
|
|
7462
|
+
"href": {
|
|
7463
|
+
"type": "string",
|
|
7464
|
+
"description": "URL pointing to the request itself"
|
|
7465
|
+
}
|
|
7466
|
+
}
|
|
7467
|
+
},
|
|
7468
|
+
"next": {
|
|
7469
|
+
"type": "object",
|
|
7470
|
+
"properties": {
|
|
7471
|
+
"href": {
|
|
7472
|
+
"type": "string",
|
|
7473
|
+
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
7474
|
+
}
|
|
7475
|
+
}
|
|
7476
|
+
},
|
|
7477
|
+
"prev": {
|
|
7478
|
+
"type": "object",
|
|
7479
|
+
"properties": {
|
|
7480
|
+
"href": {
|
|
7481
|
+
"type": "string",
|
|
7482
|
+
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
7483
|
+
}
|
|
7484
|
+
}
|
|
7485
|
+
},
|
|
7486
|
+
"first": {
|
|
7487
|
+
"type": "object",
|
|
7488
|
+
"properties": {
|
|
7489
|
+
"href": {
|
|
7490
|
+
"type": "string",
|
|
7491
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
7492
|
+
}
|
|
7493
|
+
}
|
|
7494
|
+
},
|
|
7495
|
+
"last": {
|
|
7496
|
+
"type": "object",
|
|
7497
|
+
"properties": {
|
|
7498
|
+
"href": {
|
|
7499
|
+
"type": "string",
|
|
7500
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
7501
|
+
}
|
|
7502
|
+
}
|
|
7503
|
+
},
|
|
7504
|
+
"pages": {
|
|
7505
|
+
"type": "object",
|
|
7506
|
+
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
7507
|
+
"additionalProperties": {
|
|
7508
|
+
"type": "object",
|
|
7509
|
+
"properties": {
|
|
7510
|
+
"href": {
|
|
7511
|
+
"type": "string"
|
|
7512
|
+
}
|
|
7513
|
+
}
|
|
7514
|
+
}
|
|
7515
|
+
}
|
|
7516
|
+
},
|
|
7517
|
+
"description": "Object containing the links to the related endpoints"
|
|
7518
|
+
},
|
|
7519
|
+
"totalCount": {
|
|
7520
|
+
"type": "number",
|
|
7521
|
+
"description": "Number representing the total number of available items"
|
|
7522
|
+
}
|
|
7523
|
+
}
|
|
7524
|
+
}
|
|
7525
|
+
}
|
|
7526
|
+
}
|
|
7527
|
+
}
|
|
7528
|
+
}
|
|
7529
|
+
},
|
|
7530
|
+
"4XX": {
|
|
7531
|
+
"description": "Default Response",
|
|
7532
|
+
"content": {
|
|
7533
|
+
"application/json": {
|
|
7534
|
+
"schema": {
|
|
7535
|
+
"type": "object",
|
|
7536
|
+
"required": [
|
|
7537
|
+
"code",
|
|
7538
|
+
"detail",
|
|
7539
|
+
"requestId",
|
|
7540
|
+
"name",
|
|
7541
|
+
"statusCode"
|
|
7542
|
+
],
|
|
7543
|
+
"properties": {
|
|
7544
|
+
"code": {
|
|
7545
|
+
"type": "string",
|
|
7546
|
+
"description": "Code used to categorize the error"
|
|
7547
|
+
},
|
|
7548
|
+
"detail": {
|
|
7549
|
+
"type": "string",
|
|
7550
|
+
"description": "Description of the error"
|
|
7551
|
+
},
|
|
7552
|
+
"requestId": {
|
|
7553
|
+
"type": "string",
|
|
7554
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
7555
|
+
},
|
|
7556
|
+
"name": {
|
|
7557
|
+
"type": "string",
|
|
7558
|
+
"description": "Name of the error type"
|
|
7559
|
+
},
|
|
7560
|
+
"validation": {
|
|
7561
|
+
"type": "array",
|
|
7562
|
+
"items": {
|
|
7563
|
+
"type": "object",
|
|
7564
|
+
"required": [
|
|
7565
|
+
"fieldName",
|
|
7566
|
+
"message"
|
|
7567
|
+
],
|
|
7568
|
+
"properties": {
|
|
7569
|
+
"fieldName": {
|
|
7570
|
+
"type": "string"
|
|
7571
|
+
},
|
|
7572
|
+
"message": {
|
|
7573
|
+
"type": "string"
|
|
7574
|
+
}
|
|
7575
|
+
}
|
|
7576
|
+
},
|
|
7577
|
+
"description": "List of the validation errors"
|
|
7578
|
+
},
|
|
7579
|
+
"validationContext": {
|
|
7580
|
+
"type": "string"
|
|
7581
|
+
},
|
|
7582
|
+
"statusCode": {
|
|
7583
|
+
"type": "number"
|
|
7584
|
+
}
|
|
7585
|
+
}
|
|
7586
|
+
}
|
|
7587
|
+
}
|
|
7588
|
+
}
|
|
7589
|
+
},
|
|
7590
|
+
"5XX": {
|
|
7591
|
+
"description": "Default Response",
|
|
7592
|
+
"content": {
|
|
7593
|
+
"application/json": {
|
|
7594
|
+
"schema": {
|
|
7595
|
+
"type": "object",
|
|
7596
|
+
"required": [
|
|
7597
|
+
"code",
|
|
7598
|
+
"detail",
|
|
7599
|
+
"requestId",
|
|
7600
|
+
"name",
|
|
7601
|
+
"statusCode"
|
|
7602
|
+
],
|
|
7603
|
+
"properties": {
|
|
7604
|
+
"code": {
|
|
7605
|
+
"type": "string",
|
|
7606
|
+
"description": "Code used to categorize the error"
|
|
7607
|
+
},
|
|
7608
|
+
"detail": {
|
|
7609
|
+
"type": "string",
|
|
7610
|
+
"description": "Description of the error"
|
|
7611
|
+
},
|
|
7612
|
+
"requestId": {
|
|
7613
|
+
"type": "string",
|
|
7614
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
7615
|
+
},
|
|
7616
|
+
"name": {
|
|
7617
|
+
"type": "string",
|
|
7618
|
+
"description": "Name of the error type"
|
|
7619
|
+
},
|
|
7620
|
+
"validation": {
|
|
7621
|
+
"type": "array",
|
|
7622
|
+
"items": {
|
|
7623
|
+
"type": "object",
|
|
7624
|
+
"required": [
|
|
7625
|
+
"fieldName",
|
|
7626
|
+
"message"
|
|
7627
|
+
],
|
|
7628
|
+
"properties": {
|
|
7629
|
+
"fieldName": {
|
|
7630
|
+
"type": "string"
|
|
7631
|
+
},
|
|
7632
|
+
"message": {
|
|
7633
|
+
"type": "string"
|
|
7634
|
+
}
|
|
7635
|
+
}
|
|
7636
|
+
},
|
|
7637
|
+
"description": "List of the validation errors"
|
|
7638
|
+
},
|
|
7639
|
+
"validationContext": {
|
|
7640
|
+
"type": "string"
|
|
7641
|
+
},
|
|
7642
|
+
"statusCode": {
|
|
7643
|
+
"type": "number"
|
|
7644
|
+
}
|
|
7645
|
+
}
|
|
7646
|
+
}
|
|
7647
|
+
}
|
|
7648
|
+
}
|
|
7649
|
+
}
|
|
7650
|
+
}
|
|
7651
|
+
}
|
|
7652
|
+
},
|
|
7653
|
+
"/api/v1/tags/tree": {
|
|
7654
|
+
"get": {
|
|
7655
|
+
"operationId": "GetTagTree",
|
|
7656
|
+
"tags": [
|
|
7657
|
+
"Tags"
|
|
7658
|
+
],
|
|
7659
|
+
"description": "Returns the tag tree for the logged-in user, sorted alphabetically",
|
|
7660
|
+
"responses": {
|
|
7661
|
+
"200": {
|
|
7662
|
+
"description": "Default Response",
|
|
7663
|
+
"content": {
|
|
7664
|
+
"application/json": {
|
|
7665
|
+
"schema": {
|
|
7666
|
+
"type": "object",
|
|
7667
|
+
"required": [
|
|
7668
|
+
"data"
|
|
7669
|
+
],
|
|
7670
|
+
"properties": {
|
|
7671
|
+
"data": {
|
|
7672
|
+
"type": "array",
|
|
7673
|
+
"items": {
|
|
7674
|
+
"type": "object",
|
|
7675
|
+
"required": [
|
|
7676
|
+
"id",
|
|
7677
|
+
"label",
|
|
7678
|
+
"unreadMessages",
|
|
7679
|
+
"children"
|
|
7680
|
+
],
|
|
7681
|
+
"properties": {
|
|
7682
|
+
"id": {
|
|
7683
|
+
"type": "string",
|
|
7684
|
+
"format": "uuid"
|
|
7685
|
+
},
|
|
7686
|
+
"label": {
|
|
7687
|
+
"type": "string"
|
|
7688
|
+
},
|
|
7689
|
+
"unreadMessages": {
|
|
7690
|
+
"type": "number",
|
|
7691
|
+
"description": "Number of unread messages for the tag"
|
|
7692
|
+
},
|
|
7693
|
+
"children": {
|
|
7694
|
+
"type": "array",
|
|
7695
|
+
"items": {}
|
|
7696
|
+
}
|
|
7697
|
+
}
|
|
7698
|
+
}
|
|
7699
|
+
},
|
|
7700
|
+
"metadata": {
|
|
7701
|
+
"type": "object",
|
|
7702
|
+
"properties": {
|
|
7703
|
+
"links": {
|
|
7704
|
+
"type": "object",
|
|
7705
|
+
"required": [
|
|
7706
|
+
"self",
|
|
7707
|
+
"first",
|
|
7708
|
+
"last",
|
|
7709
|
+
"pages"
|
|
7710
|
+
],
|
|
7711
|
+
"properties": {
|
|
7712
|
+
"self": {
|
|
7713
|
+
"type": "object",
|
|
7714
|
+
"properties": {
|
|
7715
|
+
"href": {
|
|
7716
|
+
"type": "string",
|
|
7717
|
+
"description": "URL pointing to the request itself"
|
|
7718
|
+
}
|
|
7719
|
+
}
|
|
7720
|
+
},
|
|
7721
|
+
"next": {
|
|
7722
|
+
"type": "object",
|
|
7723
|
+
"properties": {
|
|
7724
|
+
"href": {
|
|
7725
|
+
"type": "string",
|
|
7726
|
+
"description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
7727
|
+
}
|
|
7728
|
+
}
|
|
7729
|
+
},
|
|
7730
|
+
"prev": {
|
|
7731
|
+
"type": "object",
|
|
7732
|
+
"properties": {
|
|
7733
|
+
"href": {
|
|
7734
|
+
"type": "string",
|
|
7735
|
+
"description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
|
|
7736
|
+
}
|
|
7737
|
+
}
|
|
7738
|
+
},
|
|
7739
|
+
"first": {
|
|
7740
|
+
"type": "object",
|
|
7741
|
+
"properties": {
|
|
7742
|
+
"href": {
|
|
7743
|
+
"type": "string",
|
|
7744
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
7745
|
+
}
|
|
7746
|
+
}
|
|
7747
|
+
},
|
|
7748
|
+
"last": {
|
|
7749
|
+
"type": "object",
|
|
7750
|
+
"properties": {
|
|
7751
|
+
"href": {
|
|
7752
|
+
"type": "string",
|
|
7753
|
+
"description": "URL pointing to the first page of results in a paginated response"
|
|
7754
|
+
}
|
|
7755
|
+
}
|
|
7756
|
+
},
|
|
7757
|
+
"pages": {
|
|
7758
|
+
"type": "object",
|
|
7759
|
+
"description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
|
|
7760
|
+
"additionalProperties": {
|
|
7761
|
+
"type": "object",
|
|
7762
|
+
"properties": {
|
|
7763
|
+
"href": {
|
|
7764
|
+
"type": "string"
|
|
7765
|
+
}
|
|
7766
|
+
}
|
|
7767
|
+
}
|
|
7768
|
+
}
|
|
7769
|
+
},
|
|
7770
|
+
"description": "Object containing the links to the related endpoints"
|
|
7771
|
+
},
|
|
7772
|
+
"totalCount": {
|
|
7773
|
+
"type": "number",
|
|
7774
|
+
"description": "Number representing the total number of available items"
|
|
7775
|
+
}
|
|
7776
|
+
}
|
|
7777
|
+
}
|
|
7778
|
+
}
|
|
7779
|
+
}
|
|
7780
|
+
}
|
|
7781
|
+
}
|
|
7782
|
+
},
|
|
7783
|
+
"4XX": {
|
|
7784
|
+
"description": "Default Response",
|
|
7785
|
+
"content": {
|
|
7786
|
+
"application/json": {
|
|
7787
|
+
"schema": {
|
|
7788
|
+
"type": "object",
|
|
7789
|
+
"required": [
|
|
7790
|
+
"code",
|
|
7791
|
+
"detail",
|
|
7792
|
+
"requestId",
|
|
7793
|
+
"name",
|
|
7794
|
+
"statusCode"
|
|
7795
|
+
],
|
|
7796
|
+
"properties": {
|
|
7797
|
+
"code": {
|
|
7798
|
+
"type": "string",
|
|
7799
|
+
"description": "Code used to categorize the error"
|
|
7800
|
+
},
|
|
7801
|
+
"detail": {
|
|
7802
|
+
"type": "string",
|
|
7803
|
+
"description": "Description of the error"
|
|
7804
|
+
},
|
|
7805
|
+
"requestId": {
|
|
7806
|
+
"type": "string",
|
|
7807
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
7808
|
+
},
|
|
7809
|
+
"name": {
|
|
7810
|
+
"type": "string",
|
|
7811
|
+
"description": "Name of the error type"
|
|
7812
|
+
},
|
|
7813
|
+
"validation": {
|
|
7814
|
+
"type": "array",
|
|
7815
|
+
"items": {
|
|
7816
|
+
"type": "object",
|
|
7817
|
+
"required": [
|
|
7818
|
+
"fieldName",
|
|
7819
|
+
"message"
|
|
7820
|
+
],
|
|
7821
|
+
"properties": {
|
|
7822
|
+
"fieldName": {
|
|
7823
|
+
"type": "string"
|
|
7824
|
+
},
|
|
7825
|
+
"message": {
|
|
7826
|
+
"type": "string"
|
|
7827
|
+
}
|
|
7828
|
+
}
|
|
7829
|
+
},
|
|
7830
|
+
"description": "List of the validation errors"
|
|
7831
|
+
},
|
|
7832
|
+
"validationContext": {
|
|
7833
|
+
"type": "string"
|
|
7834
|
+
},
|
|
7835
|
+
"statusCode": {
|
|
7836
|
+
"type": "number"
|
|
7837
|
+
}
|
|
7838
|
+
}
|
|
7839
|
+
}
|
|
7840
|
+
}
|
|
7841
|
+
}
|
|
7842
|
+
},
|
|
7843
|
+
"5XX": {
|
|
7844
|
+
"description": "Default Response",
|
|
7845
|
+
"content": {
|
|
7846
|
+
"application/json": {
|
|
7847
|
+
"schema": {
|
|
7848
|
+
"type": "object",
|
|
7849
|
+
"required": [
|
|
7850
|
+
"code",
|
|
7851
|
+
"detail",
|
|
7852
|
+
"requestId",
|
|
7853
|
+
"name",
|
|
7854
|
+
"statusCode"
|
|
7855
|
+
],
|
|
7856
|
+
"properties": {
|
|
7857
|
+
"code": {
|
|
7858
|
+
"type": "string",
|
|
7859
|
+
"description": "Code used to categorize the error"
|
|
7860
|
+
},
|
|
7861
|
+
"detail": {
|
|
7862
|
+
"type": "string",
|
|
7863
|
+
"description": "Description of the error"
|
|
7864
|
+
},
|
|
7865
|
+
"requestId": {
|
|
7866
|
+
"type": "string",
|
|
7867
|
+
"description": "Unique request id. This one will be used to troubleshoot the problems"
|
|
7868
|
+
},
|
|
7869
|
+
"name": {
|
|
7870
|
+
"type": "string",
|
|
7871
|
+
"description": "Name of the error type"
|
|
7872
|
+
},
|
|
7873
|
+
"validation": {
|
|
7874
|
+
"type": "array",
|
|
7875
|
+
"items": {
|
|
7876
|
+
"type": "object",
|
|
7877
|
+
"required": [
|
|
7878
|
+
"fieldName",
|
|
7879
|
+
"message"
|
|
7880
|
+
],
|
|
7881
|
+
"properties": {
|
|
7882
|
+
"fieldName": {
|
|
7883
|
+
"type": "string"
|
|
7884
|
+
},
|
|
7885
|
+
"message": {
|
|
7886
|
+
"type": "string"
|
|
7887
|
+
}
|
|
7888
|
+
}
|
|
7889
|
+
},
|
|
7890
|
+
"description": "List of the validation errors"
|
|
7891
|
+
},
|
|
7892
|
+
"validationContext": {
|
|
7893
|
+
"type": "string"
|
|
7894
|
+
},
|
|
7895
|
+
"statusCode": {
|
|
7896
|
+
"type": "number"
|
|
7897
|
+
}
|
|
7898
|
+
}
|
|
7899
|
+
}
|
|
7900
|
+
}
|
|
7901
|
+
}
|
|
7902
|
+
}
|
|
7903
|
+
}
|
|
7904
|
+
}
|
|
7905
|
+
},
|
|
7906
|
+
"/api/v1/tags/{tagId}": {
|
|
7907
|
+
"patch": {
|
|
7908
|
+
"operationId": "UpdateTag",
|
|
5871
7909
|
"tags": [
|
|
5872
|
-
"
|
|
7910
|
+
"Tags"
|
|
5873
7911
|
],
|
|
5874
|
-
"description": "
|
|
7912
|
+
"description": "Updates a tag (name and/or parent)",
|
|
5875
7913
|
"requestBody": {
|
|
5876
7914
|
"required": true,
|
|
5877
7915
|
"content": {
|
|
5878
7916
|
"application/json": {
|
|
5879
7917
|
"schema": {
|
|
5880
7918
|
"type": "object",
|
|
5881
|
-
"required": [
|
|
5882
|
-
"recipientUserIds"
|
|
5883
|
-
],
|
|
5884
7919
|
"properties": {
|
|
5885
|
-
"
|
|
5886
|
-
"type": "
|
|
5887
|
-
"
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
|
-
|
|
5892
|
-
"
|
|
5893
|
-
|
|
7920
|
+
"label": {
|
|
7921
|
+
"type": "string",
|
|
7922
|
+
"description": "New display name",
|
|
7923
|
+
"minLength": 1,
|
|
7924
|
+
"maxLength": 100
|
|
7925
|
+
},
|
|
7926
|
+
"parentTagId": {
|
|
7927
|
+
"anyOf": [
|
|
7928
|
+
{
|
|
7929
|
+
"type": "string",
|
|
7930
|
+
"format": "uuid",
|
|
7931
|
+
"description": "New parent tag id"
|
|
7932
|
+
},
|
|
7933
|
+
{
|
|
7934
|
+
"type": "null",
|
|
7935
|
+
"description": "Set to null to move to root"
|
|
7936
|
+
}
|
|
7937
|
+
]
|
|
5894
7938
|
}
|
|
5895
7939
|
}
|
|
5896
7940
|
}
|
|
@@ -5901,24 +7945,12 @@
|
|
|
5901
7945
|
{
|
|
5902
7946
|
"schema": {
|
|
5903
7947
|
"type": "string",
|
|
5904
|
-
"
|
|
5905
|
-
"default": "0"
|
|
5906
|
-
},
|
|
5907
|
-
"in": "query",
|
|
5908
|
-
"name": "offset",
|
|
5909
|
-
"required": false,
|
|
5910
|
-
"description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
|
|
5911
|
-
},
|
|
5912
|
-
{
|
|
5913
|
-
"schema": {
|
|
5914
|
-
"type": "string",
|
|
5915
|
-
"default": "20",
|
|
5916
|
-
"pattern": "^([1-9]|100)|undefined$"
|
|
7948
|
+
"format": "uuid"
|
|
5917
7949
|
},
|
|
5918
|
-
"in": "
|
|
5919
|
-
"name": "
|
|
5920
|
-
"required":
|
|
5921
|
-
"description": "
|
|
7950
|
+
"in": "path",
|
|
7951
|
+
"name": "tagId",
|
|
7952
|
+
"required": true,
|
|
7953
|
+
"description": "Unique Id of the tag"
|
|
5922
7954
|
}
|
|
5923
7955
|
],
|
|
5924
7956
|
"responses": {
|
|
@@ -5933,84 +7965,14 @@
|
|
|
5933
7965
|
],
|
|
5934
7966
|
"properties": {
|
|
5935
7967
|
"data": {
|
|
5936
|
-
"type": "
|
|
5937
|
-
"
|
|
5938
|
-
"
|
|
5939
|
-
|
|
5940
|
-
|
|
5941
|
-
|
|
5942
|
-
"
|
|
5943
|
-
"
|
|
5944
|
-
"isSeen",
|
|
5945
|
-
"subject",
|
|
5946
|
-
"richText",
|
|
5947
|
-
"plainText",
|
|
5948
|
-
"createdAt",
|
|
5949
|
-
"scheduledAt",
|
|
5950
|
-
"attachmentIds"
|
|
5951
|
-
],
|
|
5952
|
-
"properties": {
|
|
5953
|
-
"id": {
|
|
5954
|
-
"type": "string",
|
|
5955
|
-
"description": "Unique Id of the message"
|
|
5956
|
-
},
|
|
5957
|
-
"organisationId": {
|
|
5958
|
-
"type": "string",
|
|
5959
|
-
"description": "Organisation sender id"
|
|
5960
|
-
},
|
|
5961
|
-
"recipientUserId": {
|
|
5962
|
-
"type": "string",
|
|
5963
|
-
"description": "Unique id of the recipient"
|
|
5964
|
-
},
|
|
5965
|
-
"threadName": {
|
|
5966
|
-
"anyOf": [
|
|
5967
|
-
{
|
|
5968
|
-
"type": "string",
|
|
5969
|
-
"description": "Thread Name used to group messages"
|
|
5970
|
-
},
|
|
5971
|
-
{
|
|
5972
|
-
"type": "null"
|
|
5973
|
-
}
|
|
5974
|
-
]
|
|
5975
|
-
},
|
|
5976
|
-
"isSeen": {
|
|
5977
|
-
"type": "boolean",
|
|
5978
|
-
"description": "Whether the message has been seen"
|
|
5979
|
-
},
|
|
5980
|
-
"subject": {
|
|
5981
|
-
"type": "string",
|
|
5982
|
-
"description": "Subject"
|
|
5983
|
-
},
|
|
5984
|
-
"richText": {
|
|
5985
|
-
"anyOf": [
|
|
5986
|
-
{
|
|
5987
|
-
"type": "string",
|
|
5988
|
-
"description": "Rich text content of the message"
|
|
5989
|
-
},
|
|
5990
|
-
{
|
|
5991
|
-
"type": "null"
|
|
5992
|
-
}
|
|
5993
|
-
]
|
|
5994
|
-
},
|
|
5995
|
-
"plainText": {
|
|
5996
|
-
"type": "string",
|
|
5997
|
-
"description": "Plain text content of the message"
|
|
5998
|
-
},
|
|
5999
|
-
"createdAt": {
|
|
6000
|
-
"type": "string",
|
|
6001
|
-
"description": "Creation date time"
|
|
6002
|
-
},
|
|
6003
|
-
"scheduledAt": {
|
|
6004
|
-
"type": "string",
|
|
6005
|
-
"description": "Scheduled date time"
|
|
6006
|
-
},
|
|
6007
|
-
"attachmentIds": {
|
|
6008
|
-
"type": "array",
|
|
6009
|
-
"items": {
|
|
6010
|
-
"type": "string",
|
|
6011
|
-
"description": "Attachment Ids"
|
|
6012
|
-
}
|
|
6013
|
-
}
|
|
7968
|
+
"type": "object",
|
|
7969
|
+
"required": [
|
|
7970
|
+
"id"
|
|
7971
|
+
],
|
|
7972
|
+
"properties": {
|
|
7973
|
+
"id": {
|
|
7974
|
+
"type": "string",
|
|
7975
|
+
"format": "uuid"
|
|
6014
7976
|
}
|
|
6015
7977
|
}
|
|
6016
7978
|
},
|
|
@@ -6218,117 +8180,27 @@
|
|
|
6218
8180
|
}
|
|
6219
8181
|
}
|
|
6220
8182
|
}
|
|
6221
|
-
}
|
|
6222
|
-
|
|
6223
|
-
|
|
6224
|
-
"post": {
|
|
6225
|
-
"operationId": "SupportCreateMessage",
|
|
8183
|
+
},
|
|
8184
|
+
"delete": {
|
|
8185
|
+
"operationId": "DeleteTag",
|
|
6226
8186
|
"tags": [
|
|
6227
|
-
"
|
|
8187
|
+
"Tags"
|
|
6228
8188
|
],
|
|
6229
|
-
"description": "
|
|
6230
|
-
"
|
|
6231
|
-
|
|
6232
|
-
|
|
6233
|
-
|
|
6234
|
-
"
|
|
6235
|
-
|
|
6236
|
-
|
|
6237
|
-
|
|
6238
|
-
|
|
6239
|
-
|
|
6240
|
-
"scheduleAt",
|
|
6241
|
-
"message"
|
|
6242
|
-
],
|
|
6243
|
-
"properties": {
|
|
6244
|
-
"preferredTransports": {
|
|
6245
|
-
"type": "array",
|
|
6246
|
-
"items": {
|
|
6247
|
-
"type": "string",
|
|
6248
|
-
"enum": [
|
|
6249
|
-
"email",
|
|
6250
|
-
"lifeEvent"
|
|
6251
|
-
],
|
|
6252
|
-
"description": "All the available provider types"
|
|
6253
|
-
},
|
|
6254
|
-
"description": "The list of the preferred transports to use. If the selected transports are not available for the recipient, others will be used"
|
|
6255
|
-
},
|
|
6256
|
-
"recipientUserId": {
|
|
6257
|
-
"type": "string",
|
|
6258
|
-
"description": "Unique user id of the recipient"
|
|
6259
|
-
},
|
|
6260
|
-
"security": {
|
|
6261
|
-
"type": "string",
|
|
6262
|
-
"enum": [
|
|
6263
|
-
"confidential",
|
|
6264
|
-
"public"
|
|
6265
|
-
],
|
|
6266
|
-
"description": "Confidentiality level of the message"
|
|
6267
|
-
},
|
|
6268
|
-
"scheduleAt": {
|
|
6269
|
-
"type": "string",
|
|
6270
|
-
"format": "date-time",
|
|
6271
|
-
"description": "Date and time of when schedule the message"
|
|
6272
|
-
},
|
|
6273
|
-
"message": {
|
|
6274
|
-
"type": "object",
|
|
6275
|
-
"required": [
|
|
6276
|
-
"subject",
|
|
6277
|
-
"plainText",
|
|
6278
|
-
"language"
|
|
6279
|
-
],
|
|
6280
|
-
"properties": {
|
|
6281
|
-
"threadName": {
|
|
6282
|
-
"type": "string",
|
|
6283
|
-
"description": "Thread Name used to group messages",
|
|
6284
|
-
"minLength": 1
|
|
6285
|
-
},
|
|
6286
|
-
"subject": {
|
|
6287
|
-
"type": "string",
|
|
6288
|
-
"description": "Subject. This is the only part that will be seen outside of the messaging platform is security is 'confidential'",
|
|
6289
|
-
"minLength": 1
|
|
6290
|
-
},
|
|
6291
|
-
"excerpt": {
|
|
6292
|
-
"type": "string",
|
|
6293
|
-
"description": "Brief description of the message"
|
|
6294
|
-
},
|
|
6295
|
-
"plainText": {
|
|
6296
|
-
"type": "string",
|
|
6297
|
-
"description": "Plain text version of the message",
|
|
6298
|
-
"minLength": 1
|
|
6299
|
-
},
|
|
6300
|
-
"richText": {
|
|
6301
|
-
"type": "string",
|
|
6302
|
-
"description": "Rich text (html) version of the message"
|
|
6303
|
-
},
|
|
6304
|
-
"language": {
|
|
6305
|
-
"type": "string",
|
|
6306
|
-
"enum": [
|
|
6307
|
-
"en",
|
|
6308
|
-
"ga"
|
|
6309
|
-
],
|
|
6310
|
-
"description": "Language used to send the message"
|
|
6311
|
-
},
|
|
6312
|
-
"externalId": {
|
|
6313
|
-
"type": "string",
|
|
6314
|
-
"description": "External id to link the message to an external system"
|
|
6315
|
-
}
|
|
6316
|
-
}
|
|
6317
|
-
},
|
|
6318
|
-
"attachments": {
|
|
6319
|
-
"type": "array",
|
|
6320
|
-
"items": {
|
|
6321
|
-
"type": "string",
|
|
6322
|
-
"format": "uuid"
|
|
6323
|
-
}
|
|
6324
|
-
}
|
|
6325
|
-
}
|
|
6326
|
-
}
|
|
6327
|
-
}
|
|
8189
|
+
"description": "Deletes a tag and its descendants. Blocked if any have messages attached.",
|
|
8190
|
+
"parameters": [
|
|
8191
|
+
{
|
|
8192
|
+
"schema": {
|
|
8193
|
+
"type": "string",
|
|
8194
|
+
"format": "uuid"
|
|
8195
|
+
},
|
|
8196
|
+
"in": "path",
|
|
8197
|
+
"name": "tagId",
|
|
8198
|
+
"required": true,
|
|
8199
|
+
"description": "Unique Id of the tag"
|
|
6328
8200
|
}
|
|
6329
|
-
|
|
8201
|
+
],
|
|
6330
8202
|
"responses": {
|
|
6331
|
-
"
|
|
8203
|
+
"200": {
|
|
6332
8204
|
"description": "Default Response",
|
|
6333
8205
|
"content": {
|
|
6334
8206
|
"application/json": {
|
|
@@ -6346,8 +8218,7 @@
|
|
|
6346
8218
|
"properties": {
|
|
6347
8219
|
"id": {
|
|
6348
8220
|
"type": "string",
|
|
6349
|
-
"format": "uuid"
|
|
6350
|
-
"description": "Unique Id of the resource"
|
|
8221
|
+
"format": "uuid"
|
|
6351
8222
|
}
|
|
6352
8223
|
}
|
|
6353
8224
|
},
|