@ogcio/building-blocks-sdk 0.2.90 → 0.2.91
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/profile/citizen.d.ts +230 -0
- package/dist/client/clients/profile/citizen.d.ts.map +1 -1
- package/dist/client/clients/profile/citizen.js +20 -0
- package/dist/client/clients/profile/citizen.js.map +1 -1
- package/dist/client/clients/profile/index.d.ts.map +1 -1
- package/dist/client/clients/profile/organisation.d.ts.map +1 -1
- package/dist/client/clients/profile/schema.d.ts +888 -0
- package/dist/client/clients/profile/schema.d.ts.map +1 -1
- package/dist/client/clients/profile/support.d.ts +678 -0
- package/dist/client/clients/profile/support.d.ts.map +1 -1
- package/dist/client/clients/profile/support.js +42 -0
- package/dist/client/clients/profile/support.js.map +1 -1
- package/package.json +3 -3
- package/src/client/clients/profile/citizen.ts +39 -0
- package/src/client/clients/profile/open-api-definition.json +4165 -1332
- package/src/client/clients/profile/schema.ts +888 -0
- package/src/client/clients/profile/support.ts +81 -0
|
@@ -1,4 +1,90 @@
|
|
|
1
1
|
export interface paths {
|
|
2
|
+
"/api/v1/citizens/announcements/": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/** @description List published announcements for the current citizen profile */
|
|
10
|
+
get: operations["citizenListAnnouncements"];
|
|
11
|
+
put?: never;
|
|
12
|
+
post?: never;
|
|
13
|
+
delete?: never;
|
|
14
|
+
options?: never;
|
|
15
|
+
head?: never;
|
|
16
|
+
patch?: never;
|
|
17
|
+
trace?: never;
|
|
18
|
+
};
|
|
19
|
+
"/api/v1/citizens/announcements/acknowledgements": {
|
|
20
|
+
parameters: {
|
|
21
|
+
query?: never;
|
|
22
|
+
header?: never;
|
|
23
|
+
path?: never;
|
|
24
|
+
cookie?: never;
|
|
25
|
+
};
|
|
26
|
+
get?: never;
|
|
27
|
+
put?: never;
|
|
28
|
+
/** @description Acknowledge the current set of announcements for the current citizen profile */
|
|
29
|
+
post: operations["citizenAcknowledgeAnnouncements"];
|
|
30
|
+
delete?: never;
|
|
31
|
+
options?: never;
|
|
32
|
+
head?: never;
|
|
33
|
+
patch?: never;
|
|
34
|
+
trace?: never;
|
|
35
|
+
};
|
|
36
|
+
"/api/v1/support/announcements/": {
|
|
37
|
+
parameters: {
|
|
38
|
+
query?: never;
|
|
39
|
+
header?: never;
|
|
40
|
+
path?: never;
|
|
41
|
+
cookie?: never;
|
|
42
|
+
};
|
|
43
|
+
/** @description List announcements for support users */
|
|
44
|
+
get: operations["supportListAnnouncements"];
|
|
45
|
+
put?: never;
|
|
46
|
+
/** @description Create an announcement for a specific application */
|
|
47
|
+
post: operations["supportCreateAnnouncement"];
|
|
48
|
+
delete?: never;
|
|
49
|
+
options?: never;
|
|
50
|
+
head?: never;
|
|
51
|
+
patch?: never;
|
|
52
|
+
trace?: never;
|
|
53
|
+
};
|
|
54
|
+
"/api/v1/support/announcements/{id}": {
|
|
55
|
+
parameters: {
|
|
56
|
+
query?: never;
|
|
57
|
+
header?: never;
|
|
58
|
+
path?: never;
|
|
59
|
+
cookie?: never;
|
|
60
|
+
};
|
|
61
|
+
/** @description Get a support announcement by id */
|
|
62
|
+
get: operations["supportGetAnnouncement"];
|
|
63
|
+
put?: never;
|
|
64
|
+
post?: never;
|
|
65
|
+
delete?: never;
|
|
66
|
+
options?: never;
|
|
67
|
+
head?: never;
|
|
68
|
+
patch?: never;
|
|
69
|
+
trace?: never;
|
|
70
|
+
};
|
|
71
|
+
"/api/v1/support/announcements/{id}/enabled": {
|
|
72
|
+
parameters: {
|
|
73
|
+
query?: never;
|
|
74
|
+
header?: never;
|
|
75
|
+
path?: never;
|
|
76
|
+
cookie?: never;
|
|
77
|
+
};
|
|
78
|
+
get?: never;
|
|
79
|
+
put?: never;
|
|
80
|
+
post?: never;
|
|
81
|
+
delete?: never;
|
|
82
|
+
options?: never;
|
|
83
|
+
head?: never;
|
|
84
|
+
/** @description Toggle announcement enabled state for support users */
|
|
85
|
+
patch: operations["supportSetAnnouncementEnabled"];
|
|
86
|
+
trace?: never;
|
|
87
|
+
};
|
|
2
88
|
"/api/v1/citizens/consent-statements/current": {
|
|
3
89
|
parameters: {
|
|
4
90
|
query?: never;
|
|
@@ -600,6 +686,808 @@ export interface components {
|
|
|
600
686
|
}
|
|
601
687
|
export type $defs = Record<string, never>;
|
|
602
688
|
export interface operations {
|
|
689
|
+
citizenListAnnouncements: {
|
|
690
|
+
parameters: {
|
|
691
|
+
query: {
|
|
692
|
+
applicationId: "profile" | "dashboard" | "messaging";
|
|
693
|
+
new_only?: "true" | "false" | "0" | "1";
|
|
694
|
+
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
695
|
+
offset?: string;
|
|
696
|
+
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
697
|
+
limit?: string;
|
|
698
|
+
};
|
|
699
|
+
header?: never;
|
|
700
|
+
path?: never;
|
|
701
|
+
cookie?: never;
|
|
702
|
+
};
|
|
703
|
+
requestBody?: never;
|
|
704
|
+
responses: {
|
|
705
|
+
/** @description Default Response */
|
|
706
|
+
200: {
|
|
707
|
+
headers: {
|
|
708
|
+
[name: string]: unknown;
|
|
709
|
+
};
|
|
710
|
+
content: {
|
|
711
|
+
"application/json": {
|
|
712
|
+
data: ({
|
|
713
|
+
/** Format: uuid */
|
|
714
|
+
id: string;
|
|
715
|
+
applicationId: string;
|
|
716
|
+
isEnabled: boolean;
|
|
717
|
+
/** Format: date-time */
|
|
718
|
+
publishDate: string;
|
|
719
|
+
/** Format: date-time */
|
|
720
|
+
createdAt: string;
|
|
721
|
+
createdBy: string | null;
|
|
722
|
+
} & {
|
|
723
|
+
translations: {
|
|
724
|
+
en: {
|
|
725
|
+
/** Format: uuid */
|
|
726
|
+
id: string;
|
|
727
|
+
/** Format: uuid */
|
|
728
|
+
announcementId: string;
|
|
729
|
+
language: "en" | "ga";
|
|
730
|
+
title: string;
|
|
731
|
+
description: string;
|
|
732
|
+
/** Format: date-time */
|
|
733
|
+
createdAt: string;
|
|
734
|
+
};
|
|
735
|
+
ga: {
|
|
736
|
+
/** Format: uuid */
|
|
737
|
+
id: string;
|
|
738
|
+
/** Format: uuid */
|
|
739
|
+
announcementId: string;
|
|
740
|
+
language: "en" | "ga";
|
|
741
|
+
title: string;
|
|
742
|
+
description: string;
|
|
743
|
+
/** Format: date-time */
|
|
744
|
+
createdAt: string;
|
|
745
|
+
};
|
|
746
|
+
};
|
|
747
|
+
})[];
|
|
748
|
+
metadata?: {
|
|
749
|
+
/** @description Object containing the links to the related endpoints */
|
|
750
|
+
links?: {
|
|
751
|
+
self: {
|
|
752
|
+
/** @description URL pointing to the request itself */
|
|
753
|
+
href?: string;
|
|
754
|
+
};
|
|
755
|
+
next?: {
|
|
756
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
757
|
+
href?: string;
|
|
758
|
+
};
|
|
759
|
+
prev?: {
|
|
760
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
761
|
+
href?: string;
|
|
762
|
+
};
|
|
763
|
+
first: {
|
|
764
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
765
|
+
href?: string;
|
|
766
|
+
};
|
|
767
|
+
last: {
|
|
768
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
769
|
+
href?: string;
|
|
770
|
+
};
|
|
771
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
772
|
+
pages: {
|
|
773
|
+
[key: string]: {
|
|
774
|
+
href?: string;
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
};
|
|
778
|
+
/** @description Number representing the total number of available items */
|
|
779
|
+
totalCount?: number;
|
|
780
|
+
};
|
|
781
|
+
};
|
|
782
|
+
};
|
|
783
|
+
};
|
|
784
|
+
/** @description Default Response */
|
|
785
|
+
"4XX": {
|
|
786
|
+
headers: {
|
|
787
|
+
[name: string]: unknown;
|
|
788
|
+
};
|
|
789
|
+
content: {
|
|
790
|
+
"application/json": {
|
|
791
|
+
/** @description Code used to categorize the error */
|
|
792
|
+
code: string;
|
|
793
|
+
/** @description Description of the error */
|
|
794
|
+
detail: string;
|
|
795
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
796
|
+
requestId: string;
|
|
797
|
+
/** @description Name of the error type */
|
|
798
|
+
name: string;
|
|
799
|
+
/** @description List of the validation errors */
|
|
800
|
+
validation?: {
|
|
801
|
+
fieldName: string;
|
|
802
|
+
message: string;
|
|
803
|
+
}[];
|
|
804
|
+
validationContext?: string;
|
|
805
|
+
statusCode: number;
|
|
806
|
+
};
|
|
807
|
+
};
|
|
808
|
+
};
|
|
809
|
+
/** @description Default Response */
|
|
810
|
+
"5XX": {
|
|
811
|
+
headers: {
|
|
812
|
+
[name: string]: unknown;
|
|
813
|
+
};
|
|
814
|
+
content: {
|
|
815
|
+
"application/json": {
|
|
816
|
+
/** @description Code used to categorize the error */
|
|
817
|
+
code: string;
|
|
818
|
+
/** @description Description of the error */
|
|
819
|
+
detail: string;
|
|
820
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
821
|
+
requestId: string;
|
|
822
|
+
/** @description Name of the error type */
|
|
823
|
+
name: string;
|
|
824
|
+
/** @description List of the validation errors */
|
|
825
|
+
validation?: {
|
|
826
|
+
fieldName: string;
|
|
827
|
+
message: string;
|
|
828
|
+
}[];
|
|
829
|
+
validationContext?: string;
|
|
830
|
+
statusCode: number;
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
};
|
|
834
|
+
};
|
|
835
|
+
};
|
|
836
|
+
citizenAcknowledgeAnnouncements: {
|
|
837
|
+
parameters: {
|
|
838
|
+
query?: never;
|
|
839
|
+
header?: never;
|
|
840
|
+
path?: never;
|
|
841
|
+
cookie?: never;
|
|
842
|
+
};
|
|
843
|
+
requestBody: {
|
|
844
|
+
content: {
|
|
845
|
+
"application/json": {
|
|
846
|
+
applicationId: "profile" | "dashboard" | "messaging";
|
|
847
|
+
announcementIds: string[];
|
|
848
|
+
};
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
responses: {
|
|
852
|
+
/** @description Default Response */
|
|
853
|
+
201: {
|
|
854
|
+
headers: {
|
|
855
|
+
[name: string]: unknown;
|
|
856
|
+
};
|
|
857
|
+
content: {
|
|
858
|
+
"application/json": {
|
|
859
|
+
data: {
|
|
860
|
+
acknowledgedIds: string[];
|
|
861
|
+
};
|
|
862
|
+
metadata?: {
|
|
863
|
+
/** @description Object containing the links to the related endpoints */
|
|
864
|
+
links?: {
|
|
865
|
+
self: {
|
|
866
|
+
/** @description URL pointing to the request itself */
|
|
867
|
+
href?: string;
|
|
868
|
+
};
|
|
869
|
+
next?: {
|
|
870
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
871
|
+
href?: string;
|
|
872
|
+
};
|
|
873
|
+
prev?: {
|
|
874
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
875
|
+
href?: string;
|
|
876
|
+
};
|
|
877
|
+
first: {
|
|
878
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
879
|
+
href?: string;
|
|
880
|
+
};
|
|
881
|
+
last: {
|
|
882
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
883
|
+
href?: string;
|
|
884
|
+
};
|
|
885
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
886
|
+
pages: {
|
|
887
|
+
[key: string]: {
|
|
888
|
+
href?: string;
|
|
889
|
+
};
|
|
890
|
+
};
|
|
891
|
+
};
|
|
892
|
+
/** @description Number representing the total number of available items */
|
|
893
|
+
totalCount?: number;
|
|
894
|
+
};
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
/** @description Default Response */
|
|
899
|
+
"4XX": {
|
|
900
|
+
headers: {
|
|
901
|
+
[name: string]: unknown;
|
|
902
|
+
};
|
|
903
|
+
content: {
|
|
904
|
+
"application/json": {
|
|
905
|
+
/** @description Code used to categorize the error */
|
|
906
|
+
code: string;
|
|
907
|
+
/** @description Description of the error */
|
|
908
|
+
detail: string;
|
|
909
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
910
|
+
requestId: string;
|
|
911
|
+
/** @description Name of the error type */
|
|
912
|
+
name: string;
|
|
913
|
+
/** @description List of the validation errors */
|
|
914
|
+
validation?: {
|
|
915
|
+
fieldName: string;
|
|
916
|
+
message: string;
|
|
917
|
+
}[];
|
|
918
|
+
validationContext?: string;
|
|
919
|
+
statusCode: number;
|
|
920
|
+
};
|
|
921
|
+
};
|
|
922
|
+
};
|
|
923
|
+
/** @description Default Response */
|
|
924
|
+
"5XX": {
|
|
925
|
+
headers: {
|
|
926
|
+
[name: string]: unknown;
|
|
927
|
+
};
|
|
928
|
+
content: {
|
|
929
|
+
"application/json": {
|
|
930
|
+
/** @description Code used to categorize the error */
|
|
931
|
+
code: string;
|
|
932
|
+
/** @description Description of the error */
|
|
933
|
+
detail: string;
|
|
934
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
935
|
+
requestId: string;
|
|
936
|
+
/** @description Name of the error type */
|
|
937
|
+
name: string;
|
|
938
|
+
/** @description List of the validation errors */
|
|
939
|
+
validation?: {
|
|
940
|
+
fieldName: string;
|
|
941
|
+
message: string;
|
|
942
|
+
}[];
|
|
943
|
+
validationContext?: string;
|
|
944
|
+
statusCode: number;
|
|
945
|
+
};
|
|
946
|
+
};
|
|
947
|
+
};
|
|
948
|
+
};
|
|
949
|
+
};
|
|
950
|
+
supportListAnnouncements: {
|
|
951
|
+
parameters: {
|
|
952
|
+
query?: {
|
|
953
|
+
applicationId?: "profile" | "dashboard" | "messaging";
|
|
954
|
+
isEnabled?: "true" | "false" | "0" | "1";
|
|
955
|
+
/** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
|
|
956
|
+
offset?: string;
|
|
957
|
+
/** @description Indicates the maximum number (100) of items that will be returned in a single request */
|
|
958
|
+
limit?: string;
|
|
959
|
+
};
|
|
960
|
+
header?: never;
|
|
961
|
+
path?: never;
|
|
962
|
+
cookie?: never;
|
|
963
|
+
};
|
|
964
|
+
requestBody?: never;
|
|
965
|
+
responses: {
|
|
966
|
+
/** @description Default Response */
|
|
967
|
+
200: {
|
|
968
|
+
headers: {
|
|
969
|
+
[name: string]: unknown;
|
|
970
|
+
};
|
|
971
|
+
content: {
|
|
972
|
+
"application/json": {
|
|
973
|
+
data: {
|
|
974
|
+
/** Format: uuid */
|
|
975
|
+
id: string;
|
|
976
|
+
applicationId: string;
|
|
977
|
+
isEnabled: boolean;
|
|
978
|
+
/** Format: date-time */
|
|
979
|
+
publishDate: string;
|
|
980
|
+
/** Format: date-time */
|
|
981
|
+
createdAt: string;
|
|
982
|
+
createdBy: string | null;
|
|
983
|
+
}[];
|
|
984
|
+
metadata?: {
|
|
985
|
+
/** @description Object containing the links to the related endpoints */
|
|
986
|
+
links?: {
|
|
987
|
+
self: {
|
|
988
|
+
/** @description URL pointing to the request itself */
|
|
989
|
+
href?: string;
|
|
990
|
+
};
|
|
991
|
+
next?: {
|
|
992
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
993
|
+
href?: string;
|
|
994
|
+
};
|
|
995
|
+
prev?: {
|
|
996
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
997
|
+
href?: string;
|
|
998
|
+
};
|
|
999
|
+
first: {
|
|
1000
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1001
|
+
href?: string;
|
|
1002
|
+
};
|
|
1003
|
+
last: {
|
|
1004
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1005
|
+
href?: string;
|
|
1006
|
+
};
|
|
1007
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1008
|
+
pages: {
|
|
1009
|
+
[key: string]: {
|
|
1010
|
+
href?: string;
|
|
1011
|
+
};
|
|
1012
|
+
};
|
|
1013
|
+
};
|
|
1014
|
+
/** @description Number representing the total number of available items */
|
|
1015
|
+
totalCount?: number;
|
|
1016
|
+
};
|
|
1017
|
+
};
|
|
1018
|
+
};
|
|
1019
|
+
};
|
|
1020
|
+
/** @description Default Response */
|
|
1021
|
+
"4XX": {
|
|
1022
|
+
headers: {
|
|
1023
|
+
[name: string]: unknown;
|
|
1024
|
+
};
|
|
1025
|
+
content: {
|
|
1026
|
+
"application/json": {
|
|
1027
|
+
/** @description Code used to categorize the error */
|
|
1028
|
+
code: string;
|
|
1029
|
+
/** @description Description of the error */
|
|
1030
|
+
detail: string;
|
|
1031
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1032
|
+
requestId: string;
|
|
1033
|
+
/** @description Name of the error type */
|
|
1034
|
+
name: string;
|
|
1035
|
+
/** @description List of the validation errors */
|
|
1036
|
+
validation?: {
|
|
1037
|
+
fieldName: string;
|
|
1038
|
+
message: string;
|
|
1039
|
+
}[];
|
|
1040
|
+
validationContext?: string;
|
|
1041
|
+
statusCode: number;
|
|
1042
|
+
};
|
|
1043
|
+
};
|
|
1044
|
+
};
|
|
1045
|
+
/** @description Default Response */
|
|
1046
|
+
"5XX": {
|
|
1047
|
+
headers: {
|
|
1048
|
+
[name: string]: unknown;
|
|
1049
|
+
};
|
|
1050
|
+
content: {
|
|
1051
|
+
"application/json": {
|
|
1052
|
+
/** @description Code used to categorize the error */
|
|
1053
|
+
code: string;
|
|
1054
|
+
/** @description Description of the error */
|
|
1055
|
+
detail: string;
|
|
1056
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1057
|
+
requestId: string;
|
|
1058
|
+
/** @description Name of the error type */
|
|
1059
|
+
name: string;
|
|
1060
|
+
/** @description List of the validation errors */
|
|
1061
|
+
validation?: {
|
|
1062
|
+
fieldName: string;
|
|
1063
|
+
message: string;
|
|
1064
|
+
}[];
|
|
1065
|
+
validationContext?: string;
|
|
1066
|
+
statusCode: number;
|
|
1067
|
+
};
|
|
1068
|
+
};
|
|
1069
|
+
};
|
|
1070
|
+
};
|
|
1071
|
+
};
|
|
1072
|
+
supportCreateAnnouncement: {
|
|
1073
|
+
parameters: {
|
|
1074
|
+
query?: never;
|
|
1075
|
+
header?: never;
|
|
1076
|
+
path?: never;
|
|
1077
|
+
cookie?: never;
|
|
1078
|
+
};
|
|
1079
|
+
requestBody: {
|
|
1080
|
+
content: {
|
|
1081
|
+
"application/json": {
|
|
1082
|
+
applicationId: "profile" | "dashboard" | "messaging";
|
|
1083
|
+
/** @enum {string} */
|
|
1084
|
+
isEnabled: "true" | "false" | "0" | "1";
|
|
1085
|
+
/** Format: date-time */
|
|
1086
|
+
publishDate: string;
|
|
1087
|
+
translations: {
|
|
1088
|
+
en: {
|
|
1089
|
+
title: string;
|
|
1090
|
+
description: string;
|
|
1091
|
+
};
|
|
1092
|
+
ga: {
|
|
1093
|
+
title: string;
|
|
1094
|
+
description: string;
|
|
1095
|
+
};
|
|
1096
|
+
};
|
|
1097
|
+
};
|
|
1098
|
+
};
|
|
1099
|
+
};
|
|
1100
|
+
responses: {
|
|
1101
|
+
/** @description Default Response */
|
|
1102
|
+
200: {
|
|
1103
|
+
headers: {
|
|
1104
|
+
[name: string]: unknown;
|
|
1105
|
+
};
|
|
1106
|
+
content: {
|
|
1107
|
+
"application/json": {
|
|
1108
|
+
data: {
|
|
1109
|
+
/** Format: uuid */
|
|
1110
|
+
id: string;
|
|
1111
|
+
};
|
|
1112
|
+
metadata?: {
|
|
1113
|
+
/** @description Object containing the links to the related endpoints */
|
|
1114
|
+
links?: {
|
|
1115
|
+
self: {
|
|
1116
|
+
/** @description URL pointing to the request itself */
|
|
1117
|
+
href?: string;
|
|
1118
|
+
};
|
|
1119
|
+
next?: {
|
|
1120
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1121
|
+
href?: string;
|
|
1122
|
+
};
|
|
1123
|
+
prev?: {
|
|
1124
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1125
|
+
href?: string;
|
|
1126
|
+
};
|
|
1127
|
+
first: {
|
|
1128
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1129
|
+
href?: string;
|
|
1130
|
+
};
|
|
1131
|
+
last: {
|
|
1132
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1133
|
+
href?: string;
|
|
1134
|
+
};
|
|
1135
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1136
|
+
pages: {
|
|
1137
|
+
[key: string]: {
|
|
1138
|
+
href?: string;
|
|
1139
|
+
};
|
|
1140
|
+
};
|
|
1141
|
+
};
|
|
1142
|
+
/** @description Number representing the total number of available items */
|
|
1143
|
+
totalCount?: number;
|
|
1144
|
+
};
|
|
1145
|
+
};
|
|
1146
|
+
};
|
|
1147
|
+
};
|
|
1148
|
+
/** @description Default Response */
|
|
1149
|
+
"4XX": {
|
|
1150
|
+
headers: {
|
|
1151
|
+
[name: string]: unknown;
|
|
1152
|
+
};
|
|
1153
|
+
content: {
|
|
1154
|
+
"application/json": {
|
|
1155
|
+
/** @description Code used to categorize the error */
|
|
1156
|
+
code: string;
|
|
1157
|
+
/** @description Description of the error */
|
|
1158
|
+
detail: string;
|
|
1159
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1160
|
+
requestId: string;
|
|
1161
|
+
/** @description Name of the error type */
|
|
1162
|
+
name: string;
|
|
1163
|
+
/** @description List of the validation errors */
|
|
1164
|
+
validation?: {
|
|
1165
|
+
fieldName: string;
|
|
1166
|
+
message: string;
|
|
1167
|
+
}[];
|
|
1168
|
+
validationContext?: string;
|
|
1169
|
+
statusCode: number;
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
};
|
|
1173
|
+
/** @description Default Response */
|
|
1174
|
+
"5XX": {
|
|
1175
|
+
headers: {
|
|
1176
|
+
[name: string]: unknown;
|
|
1177
|
+
};
|
|
1178
|
+
content: {
|
|
1179
|
+
"application/json": {
|
|
1180
|
+
/** @description Code used to categorize the error */
|
|
1181
|
+
code: string;
|
|
1182
|
+
/** @description Description of the error */
|
|
1183
|
+
detail: string;
|
|
1184
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1185
|
+
requestId: string;
|
|
1186
|
+
/** @description Name of the error type */
|
|
1187
|
+
name: string;
|
|
1188
|
+
/** @description List of the validation errors */
|
|
1189
|
+
validation?: {
|
|
1190
|
+
fieldName: string;
|
|
1191
|
+
message: string;
|
|
1192
|
+
}[];
|
|
1193
|
+
validationContext?: string;
|
|
1194
|
+
statusCode: number;
|
|
1195
|
+
};
|
|
1196
|
+
};
|
|
1197
|
+
};
|
|
1198
|
+
};
|
|
1199
|
+
};
|
|
1200
|
+
supportGetAnnouncement: {
|
|
1201
|
+
parameters: {
|
|
1202
|
+
query?: never;
|
|
1203
|
+
header?: never;
|
|
1204
|
+
path: {
|
|
1205
|
+
id: string;
|
|
1206
|
+
};
|
|
1207
|
+
cookie?: never;
|
|
1208
|
+
};
|
|
1209
|
+
requestBody?: never;
|
|
1210
|
+
responses: {
|
|
1211
|
+
/** @description Default Response */
|
|
1212
|
+
200: {
|
|
1213
|
+
headers: {
|
|
1214
|
+
[name: string]: unknown;
|
|
1215
|
+
};
|
|
1216
|
+
content: {
|
|
1217
|
+
"application/json": {
|
|
1218
|
+
data: {
|
|
1219
|
+
/** Format: uuid */
|
|
1220
|
+
id: string;
|
|
1221
|
+
applicationId: string;
|
|
1222
|
+
isEnabled: boolean;
|
|
1223
|
+
/** Format: date-time */
|
|
1224
|
+
publishDate: string;
|
|
1225
|
+
/** Format: date-time */
|
|
1226
|
+
createdAt: string;
|
|
1227
|
+
createdBy: string | null;
|
|
1228
|
+
} & {
|
|
1229
|
+
translations: {
|
|
1230
|
+
en: {
|
|
1231
|
+
/** Format: uuid */
|
|
1232
|
+
id: string;
|
|
1233
|
+
/** Format: uuid */
|
|
1234
|
+
announcementId: string;
|
|
1235
|
+
language: "en" | "ga";
|
|
1236
|
+
title: string;
|
|
1237
|
+
description: string;
|
|
1238
|
+
/** Format: date-time */
|
|
1239
|
+
createdAt: string;
|
|
1240
|
+
};
|
|
1241
|
+
ga: {
|
|
1242
|
+
/** Format: uuid */
|
|
1243
|
+
id: string;
|
|
1244
|
+
/** Format: uuid */
|
|
1245
|
+
announcementId: string;
|
|
1246
|
+
language: "en" | "ga";
|
|
1247
|
+
title: string;
|
|
1248
|
+
description: string;
|
|
1249
|
+
/** Format: date-time */
|
|
1250
|
+
createdAt: string;
|
|
1251
|
+
};
|
|
1252
|
+
};
|
|
1253
|
+
};
|
|
1254
|
+
metadata?: {
|
|
1255
|
+
/** @description Object containing the links to the related endpoints */
|
|
1256
|
+
links?: {
|
|
1257
|
+
self: {
|
|
1258
|
+
/** @description URL pointing to the request itself */
|
|
1259
|
+
href?: string;
|
|
1260
|
+
};
|
|
1261
|
+
next?: {
|
|
1262
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1263
|
+
href?: string;
|
|
1264
|
+
};
|
|
1265
|
+
prev?: {
|
|
1266
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1267
|
+
href?: string;
|
|
1268
|
+
};
|
|
1269
|
+
first: {
|
|
1270
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1271
|
+
href?: string;
|
|
1272
|
+
};
|
|
1273
|
+
last: {
|
|
1274
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1275
|
+
href?: string;
|
|
1276
|
+
};
|
|
1277
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1278
|
+
pages: {
|
|
1279
|
+
[key: string]: {
|
|
1280
|
+
href?: string;
|
|
1281
|
+
};
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
/** @description Number representing the total number of available items */
|
|
1285
|
+
totalCount?: number;
|
|
1286
|
+
};
|
|
1287
|
+
};
|
|
1288
|
+
};
|
|
1289
|
+
};
|
|
1290
|
+
/** @description Default Response */
|
|
1291
|
+
"4XX": {
|
|
1292
|
+
headers: {
|
|
1293
|
+
[name: string]: unknown;
|
|
1294
|
+
};
|
|
1295
|
+
content: {
|
|
1296
|
+
"application/json": {
|
|
1297
|
+
/** @description Code used to categorize the error */
|
|
1298
|
+
code: string;
|
|
1299
|
+
/** @description Description of the error */
|
|
1300
|
+
detail: string;
|
|
1301
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1302
|
+
requestId: string;
|
|
1303
|
+
/** @description Name of the error type */
|
|
1304
|
+
name: string;
|
|
1305
|
+
/** @description List of the validation errors */
|
|
1306
|
+
validation?: {
|
|
1307
|
+
fieldName: string;
|
|
1308
|
+
message: string;
|
|
1309
|
+
}[];
|
|
1310
|
+
validationContext?: string;
|
|
1311
|
+
statusCode: number;
|
|
1312
|
+
};
|
|
1313
|
+
};
|
|
1314
|
+
};
|
|
1315
|
+
/** @description Default Response */
|
|
1316
|
+
"5XX": {
|
|
1317
|
+
headers: {
|
|
1318
|
+
[name: string]: unknown;
|
|
1319
|
+
};
|
|
1320
|
+
content: {
|
|
1321
|
+
"application/json": {
|
|
1322
|
+
/** @description Code used to categorize the error */
|
|
1323
|
+
code: string;
|
|
1324
|
+
/** @description Description of the error */
|
|
1325
|
+
detail: string;
|
|
1326
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1327
|
+
requestId: string;
|
|
1328
|
+
/** @description Name of the error type */
|
|
1329
|
+
name: string;
|
|
1330
|
+
/** @description List of the validation errors */
|
|
1331
|
+
validation?: {
|
|
1332
|
+
fieldName: string;
|
|
1333
|
+
message: string;
|
|
1334
|
+
}[];
|
|
1335
|
+
validationContext?: string;
|
|
1336
|
+
statusCode: number;
|
|
1337
|
+
};
|
|
1338
|
+
};
|
|
1339
|
+
};
|
|
1340
|
+
};
|
|
1341
|
+
};
|
|
1342
|
+
supportSetAnnouncementEnabled: {
|
|
1343
|
+
parameters: {
|
|
1344
|
+
query?: never;
|
|
1345
|
+
header?: never;
|
|
1346
|
+
path: {
|
|
1347
|
+
id: string;
|
|
1348
|
+
};
|
|
1349
|
+
cookie?: never;
|
|
1350
|
+
};
|
|
1351
|
+
requestBody: {
|
|
1352
|
+
content: {
|
|
1353
|
+
"application/json": {
|
|
1354
|
+
/** @enum {string} */
|
|
1355
|
+
isEnabled: "true" | "false" | "0" | "1";
|
|
1356
|
+
};
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
responses: {
|
|
1360
|
+
/** @description Default Response */
|
|
1361
|
+
200: {
|
|
1362
|
+
headers: {
|
|
1363
|
+
[name: string]: unknown;
|
|
1364
|
+
};
|
|
1365
|
+
content: {
|
|
1366
|
+
"application/json": {
|
|
1367
|
+
data: {
|
|
1368
|
+
/** Format: uuid */
|
|
1369
|
+
id: string;
|
|
1370
|
+
applicationId: string;
|
|
1371
|
+
isEnabled: boolean;
|
|
1372
|
+
/** Format: date-time */
|
|
1373
|
+
publishDate: string;
|
|
1374
|
+
/** Format: date-time */
|
|
1375
|
+
createdAt: string;
|
|
1376
|
+
createdBy: string | null;
|
|
1377
|
+
} & {
|
|
1378
|
+
translations: {
|
|
1379
|
+
en: {
|
|
1380
|
+
/** Format: uuid */
|
|
1381
|
+
id: string;
|
|
1382
|
+
/** Format: uuid */
|
|
1383
|
+
announcementId: string;
|
|
1384
|
+
language: "en" | "ga";
|
|
1385
|
+
title: string;
|
|
1386
|
+
description: string;
|
|
1387
|
+
/** Format: date-time */
|
|
1388
|
+
createdAt: string;
|
|
1389
|
+
};
|
|
1390
|
+
ga: {
|
|
1391
|
+
/** Format: uuid */
|
|
1392
|
+
id: string;
|
|
1393
|
+
/** Format: uuid */
|
|
1394
|
+
announcementId: string;
|
|
1395
|
+
language: "en" | "ga";
|
|
1396
|
+
title: string;
|
|
1397
|
+
description: string;
|
|
1398
|
+
/** Format: date-time */
|
|
1399
|
+
createdAt: string;
|
|
1400
|
+
};
|
|
1401
|
+
};
|
|
1402
|
+
};
|
|
1403
|
+
metadata?: {
|
|
1404
|
+
/** @description Object containing the links to the related endpoints */
|
|
1405
|
+
links?: {
|
|
1406
|
+
self: {
|
|
1407
|
+
/** @description URL pointing to the request itself */
|
|
1408
|
+
href?: string;
|
|
1409
|
+
};
|
|
1410
|
+
next?: {
|
|
1411
|
+
/** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1412
|
+
href?: string;
|
|
1413
|
+
};
|
|
1414
|
+
prev?: {
|
|
1415
|
+
/** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
|
|
1416
|
+
href?: string;
|
|
1417
|
+
};
|
|
1418
|
+
first: {
|
|
1419
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1420
|
+
href?: string;
|
|
1421
|
+
};
|
|
1422
|
+
last: {
|
|
1423
|
+
/** @description URL pointing to the first page of results in a paginated response */
|
|
1424
|
+
href?: string;
|
|
1425
|
+
};
|
|
1426
|
+
/** @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2' */
|
|
1427
|
+
pages: {
|
|
1428
|
+
[key: string]: {
|
|
1429
|
+
href?: string;
|
|
1430
|
+
};
|
|
1431
|
+
};
|
|
1432
|
+
};
|
|
1433
|
+
/** @description Number representing the total number of available items */
|
|
1434
|
+
totalCount?: number;
|
|
1435
|
+
};
|
|
1436
|
+
};
|
|
1437
|
+
};
|
|
1438
|
+
};
|
|
1439
|
+
/** @description Default Response */
|
|
1440
|
+
"4XX": {
|
|
1441
|
+
headers: {
|
|
1442
|
+
[name: string]: unknown;
|
|
1443
|
+
};
|
|
1444
|
+
content: {
|
|
1445
|
+
"application/json": {
|
|
1446
|
+
/** @description Code used to categorize the error */
|
|
1447
|
+
code: string;
|
|
1448
|
+
/** @description Description of the error */
|
|
1449
|
+
detail: string;
|
|
1450
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1451
|
+
requestId: string;
|
|
1452
|
+
/** @description Name of the error type */
|
|
1453
|
+
name: string;
|
|
1454
|
+
/** @description List of the validation errors */
|
|
1455
|
+
validation?: {
|
|
1456
|
+
fieldName: string;
|
|
1457
|
+
message: string;
|
|
1458
|
+
}[];
|
|
1459
|
+
validationContext?: string;
|
|
1460
|
+
statusCode: number;
|
|
1461
|
+
};
|
|
1462
|
+
};
|
|
1463
|
+
};
|
|
1464
|
+
/** @description Default Response */
|
|
1465
|
+
"5XX": {
|
|
1466
|
+
headers: {
|
|
1467
|
+
[name: string]: unknown;
|
|
1468
|
+
};
|
|
1469
|
+
content: {
|
|
1470
|
+
"application/json": {
|
|
1471
|
+
/** @description Code used to categorize the error */
|
|
1472
|
+
code: string;
|
|
1473
|
+
/** @description Description of the error */
|
|
1474
|
+
detail: string;
|
|
1475
|
+
/** @description Unique request id. This one will be used to troubleshoot the problems */
|
|
1476
|
+
requestId: string;
|
|
1477
|
+
/** @description Name of the error type */
|
|
1478
|
+
name: string;
|
|
1479
|
+
/** @description List of the validation errors */
|
|
1480
|
+
validation?: {
|
|
1481
|
+
fieldName: string;
|
|
1482
|
+
message: string;
|
|
1483
|
+
}[];
|
|
1484
|
+
validationContext?: string;
|
|
1485
|
+
statusCode: number;
|
|
1486
|
+
};
|
|
1487
|
+
};
|
|
1488
|
+
};
|
|
1489
|
+
};
|
|
1490
|
+
};
|
|
603
1491
|
citizenCurrentStatement: {
|
|
604
1492
|
parameters: {
|
|
605
1493
|
query: {
|