@ogcio/building-blocks-sdk 0.2.90 → 0.2.92

package/dist/client/clients/profile/support.d.ts

@@ -1,6 +1,19 @@
 import type createClient from "openapi-fetch";
 import type { Logger } from "../../../types/index.js";
 import type { paths } from "./schema.js";
+type ListAnnouncementsQuery = paths["/api/v1/support/announcements/"]["get"]["parameters"]["query"];
+type BooleanListAnnouncementsQuery = Omit<ListAnnouncementsQuery, "isEnabled"> & {
+    isEnabled: boolean;
+};
+type CreateAnnouncementBody = paths["/api/v1/support/announcements/"]["post"]["requestBody"]["content"]["application/json"];
+type TypedCreateAnnouncementBody = Omit<CreateAnnouncementBody, "isEnabled" | "publishDate"> & {
+    isEnabled: boolean;
+    publishDate: Date;
+};
+type ToggleEnabledBody = paths["/api/v1/support/announcements/{id}/enabled"]["patch"]["requestBody"]["content"]["application/json"];
+type TypedToggleEnabledBody = Omit<ToggleEnabledBody, "isEnabled"> & {
+    isEnabled: boolean;
+};
 export declare class ProfileSupport {
     private readonly client;
     private readonly serviceName;
@@ -329,5 +342,670 @@ export declare class ProfileSupport {
             }[];
         };
     }>>;
+    readonly announcements: {
+        list: (queryParams: BooleanListAnnouncementsQuery) => Promise<import("../../utils/client-utils.js").DataResponseValue<{
+            parameters: {
+                query?: {
+                    applicationId?: "profile" | "dashboard" | "messaging";
+                    isEnabled?: "true" | "false" | "0" | "1";
+                    offset?: string;
+                    limit?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                id: string;
+                                applicationId: string;
+                                isEnabled: boolean;
+                                publishDate: string;
+                                createdAt: string;
+                                createdBy: string | null;
+                            }[];
+                            metadata?: {
+                                links?: {
+                                    self: {
+                                        href?: string;
+                                    };
+                                    next?: {
+                                        href?: string;
+                                    };
+                                    prev?: {
+                                        href?: string;
+                                    };
+                                    first: {
+                                        href?: string;
+                                    };
+                                    last: {
+                                        href?: string;
+                                    };
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                "4XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                "5XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        }, {
+            params: {
+                query: {
+                    isEnabled: "true" | "false" | undefined;
+                };
+            };
+        }>>;
+        create: (body: TypedCreateAnnouncementBody) => Promise<import("../../utils/client-utils.js").DataResponseValue<{
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        applicationId: "profile" | "dashboard" | "messaging";
+                        isEnabled: "true" | "false" | "0" | "1";
+                        publishDate: string;
+                        translations: {
+                            en: {
+                                title: string;
+                                description: string;
+                            };
+                            ga: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
+                };
+            };
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                id: string;
+                            };
+                            metadata?: {
+                                links?: {
+                                    self: {
+                                        href?: string;
+                                    };
+                                    next?: {
+                                        href?: string;
+                                    };
+                                    prev?: {
+                                        href?: string;
+                                    };
+                                    first: {
+                                        href?: string;
+                                    };
+                                    last: {
+                                        href?: string;
+                                    };
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                "4XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                "5XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        }, import("openapi-fetch").FetchOptions<{
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        applicationId: "profile" | "dashboard" | "messaging";
+                        isEnabled: "true" | "false" | "0" | "1";
+                        publishDate: string;
+                        translations: {
+                            en: {
+                                title: string;
+                                description: string;
+                            };
+                            ga: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
+                };
+            };
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                id: string;
+                            };
+                            metadata?: {
+                                links?: {
+                                    self: {
+                                        href?: string;
+                                    };
+                                    next?: {
+                                        href?: string;
+                                    };
+                                    prev?: {
+                                        href?: string;
+                                    };
+                                    first: {
+                                        href?: string;
+                                    };
+                                    last: {
+                                        href?: string;
+                                    };
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                "4XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                "5XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        }>>>;
+        toggleEnabled: (id: string, body: TypedToggleEnabledBody) => Promise<import("../../utils/client-utils.js").DataResponseValue<{
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        isEnabled: "true" | "false" | "0" | "1";
+                    };
+                };
+            };
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                id: string;
+                                applicationId: string;
+                                isEnabled: boolean;
+                                publishDate: string;
+                                createdAt: string;
+                                createdBy: string | null;
+                            } & {
+                                translations: {
+                                    en: {
+                                        id: string;
+                                        announcementId: string;
+                                        language: "en" | "ga";
+                                        title: string;
+                                        description: string;
+                                        createdAt: string;
+                                    };
+                                    ga: {
+                                        id: string;
+                                        announcementId: string;
+                                        language: "en" | "ga";
+                                        title: string;
+                                        description: string;
+                                        createdAt: string;
+                                    };
+                                };
+                            };
+                            metadata?: {
+                                links?: {
+                                    self: {
+                                        href?: string;
+                                    };
+                                    next?: {
+                                        href?: string;
+                                    };
+                                    prev?: {
+                                        href?: string;
+                                    };
+                                    first: {
+                                        href?: string;
+                                    };
+                                    last: {
+                                        href?: string;
+                                    };
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                "4XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                "5XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        }, import("openapi-fetch").FetchOptions<{
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        isEnabled: "true" | "false" | "0" | "1";
+                    };
+                };
+            };
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                id: string;
+                                applicationId: string;
+                                isEnabled: boolean;
+                                publishDate: string;
+                                createdAt: string;
+                                createdBy: string | null;
+                            } & {
+                                translations: {
+                                    en: {
+                                        id: string;
+                                        announcementId: string;
+                                        language: "en" | "ga";
+                                        title: string;
+                                        description: string;
+                                        createdAt: string;
+                                    };
+                                    ga: {
+                                        id: string;
+                                        announcementId: string;
+                                        language: "en" | "ga";
+                                        title: string;
+                                        description: string;
+                                        createdAt: string;
+                                    };
+                                };
+                            };
+                            metadata?: {
+                                links?: {
+                                    self: {
+                                        href?: string;
+                                    };
+                                    next?: {
+                                        href?: string;
+                                    };
+                                    prev?: {
+                                        href?: string;
+                                    };
+                                    first: {
+                                        href?: string;
+                                    };
+                                    last: {
+                                        href?: string;
+                                    };
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                "4XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                "5XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        }>>>;
+        get: (id: string) => Promise<import("../../utils/client-utils.js").DataResponseValue<{
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                id: string;
+                                applicationId: string;
+                                isEnabled: boolean;
+                                publishDate: string;
+                                createdAt: string;
+                                createdBy: string | null;
+                            } & {
+                                translations: {
+                                    en: {
+                                        id: string;
+                                        announcementId: string;
+                                        language: "en" | "ga";
+                                        title: string;
+                                        description: string;
+                                        createdAt: string;
+                                    };
+                                    ga: {
+                                        id: string;
+                                        announcementId: string;
+                                        language: "en" | "ga";
+                                        title: string;
+                                        description: string;
+                                        createdAt: string;
+                                    };
+                                };
+                            };
+                            metadata?: {
+                                links?: {
+                                    self: {
+                                        href?: string;
+                                    };
+                                    next?: {
+                                        href?: string;
+                                    };
+                                    prev?: {
+                                        href?: string;
+                                    };
+                                    first: {
+                                        href?: string;
+                                    };
+                                    last: {
+                                        href?: string;
+                                    };
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                "4XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                "5XX": {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        }, {
+            params: {
+                path: {
+                    id: string;
+                };
+            };
+        }>>;
+    };
 }
+export {};
 //# sourceMappingURL=support.d.ts.map