@ogcio/building-blocks-sdk 0.2.97 → 0.2.99

package/src/client/clients/messaging-public-api/schema.ts

@@ -0,0 +1,2463 @@
+export interface paths {
+    "/api/v1/citizens/messages/{messageId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get a single message by id for the authenticated citizen */
+        get: {
+            parameters: {
+                query?: {
+                    /**
+                     * @description Include stored gateway metadata for the message
+                     * @example true
+                     */
+                    includeMetadata?: "true" | "false" | "1" | "0";
+                };
+                header?: never;
+                path: {
+                    /**
+                     * @description Unique identifier of the message to retrieve
+                     * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                     */
+                    messageId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Full detail of a single message for an authenticated citizen
+                             * @example {
+                             *       "subject": "Welcome to MessagingIE",
+                             *       "createdAt": "2025-11-25T14:30:00Z",
+                             *       "threadName": null,
+                             *       "organisationId": "f6a7b8c9-d0e1-2345-f123-456789012345",
+                             *       "recipientUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
+                             *       "excerpt": "Dear John Doe, Welcome...",
+                             *       "plainText": "Dear John Doe, Welcome to MessagingIE.",
+                             *       "richText": null,
+                             *       "isSeen": false,
+                             *       "security": "confidential",
+                             *       "attachments": [],
+                             *       "externalId": null
+                             *     }
+                             */
+                            data: {
+                                /**
+                                 * @description Subject
+                                 * @example Welcome to MessagingIE
+                                 */
+                                subject: string;
+                                /**
+                                 * Format: date-time
+                                 * @description Creation date time
+                                 * @example 2025-11-25T14:30:00Z
+                                 */
+                                createdAt: string;
+                                /**
+                                 * @description Thread name the message belongs to, if any
+                                 * @example Support Thread
+                                 */
+                                threadName: string | null;
+                                /**
+                                 * @description Organisation sender id
+                                 * @example f6a7b8c9-d0e1-2345-f123-456789012345
+                                 */
+                                organisationId: string;
+                                /**
+                                 * @description Unique id of the recipient
+                                 * @example b2c3d4e5-f6a7-8901-bcde-f12345678901
+                                 */
+                                recipientUserId: string;
+                                /**
+                                 * @description Short excerpt of the message body, if available
+                                 * @example Dear John Doe, Welcome...
+                                 */
+                                excerpt: string | null;
+                                /**
+                                 * @description Plain text body
+                                 * @example Dear John Doe, Welcome to MessagingIE.
+                                 */
+                                plainText: string;
+                                /**
+                                 * @description HTML-formatted body of the message, if available
+                                 * @example <p>Dear <strong>John Doe</strong>...</p>
+                                 */
+                                richText: string | null;
+                                /**
+                                 * @description Whether the message has been seen
+                                 * @example false
+                                 */
+                                isSeen: boolean;
+                                /**
+                                 * @description Security classification of the message
+                                 * @example confidential
+                                 * @enum {unknown}
+                                 */
+                                security: "public" | "confidential";
+                                /**
+                                 * @description Attachment identifiers
+                                 * @example []
+                                 */
+                                attachments: string[];
+                                /**
+                                 * @description External reference identifier for the message, if any
+                                 * @example ext-ref-001
+                                 */
+                                externalId: string | null;
+                                /**
+                                 * @description Optional gateway metadata associated with the message
+                                 * @example null
+                                 */
+                                metadata?: {
+                                    /**
+                                     * @description Journey context associated with this message
+                                     * @example {
+                                     *       "submissionId": "22222222-2222-2222-2222-222222222222"
+                                     *     }
+                                     */
+                                    journey?: {
+                                        /**
+                                         * @description Identifier of the journey that triggered this message
+                                         * @example 11111111-1111-1111-1111-111111111111
+                                         */
+                                        journeyId?: string;
+                                        /**
+                                         * @description Identifier of the journey submission linked to this message
+                                         * @example 22222222-2222-2222-2222-222222222222
+                                         */
+                                        submissionId: string;
+                                    };
+                                } | null;
+                            };
+                            metadata?: {
+                                /** @description Object containing the links to the related endpoints */
+                                links?: {
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *     }
+                                     */
+                                    self: {
+                                        /** @description URL pointing to the request itself */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
+                                     *     }
+                                     */
+                                    next?: {
+                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    prev?: {
+                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    first: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
+                                     *     }
+                                     */
+                                    last: {
+                                        /** @description URL pointing to the last page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'
+                                     * @example {
+                                     *       "page1": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *       },
+                                     *       "page2": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *       }
+                                     *     }
+                                     */
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                /**
+                                 * @description Number representing the total number of available items
+                                 * @example 150
+                                 */
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                502: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/citizens/messages/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get paginated messages for the authenticated citizen */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
+                    offset?: string;
+                    /** @description Indicates the maximum number (100) of items that will be returned in a single request */
+                    limit?: string;
+                    /**
+                     * @description Filter by subject text
+                     * @example Welcome
+                     */
+                    search?: string;
+                    /**
+                     * @description Return only messages linked to the given journey submission
+                     * @example sub-uuid-456
+                     */
+                    submissionId?: string;
+                    /**
+                     * @description Filter by message seen status
+                     * @example true
+                     */
+                    isSeen?: "true" | "false" | "1" | "0";
+                    /**
+                     * @description Return messages deleted after this timestamp
+                     * @example 2025-11-01T00:00:00Z
+                     */
+                    deletedAfterDateTime?: string;
+                    /**
+                     * @description Include stored gateway metadata for each message
+                     * @example true
+                     */
+                    includeMetadata?: "true" | "false" | "1" | "0";
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                /**
+                                 * @description Unique Id of the message
+                                 * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                                 */
+                                id: string;
+                                /**
+                                 * @description Subject
+                                 * @example Welcome to MessagingIE
+                                 */
+                                subject: string;
+                                /**
+                                 * Format: date-time
+                                 * @description Creation date time
+                                 * @example 2025-11-25T14:30:00Z
+                                 */
+                                createdAt: string;
+                                /**
+                                 * @description Thread name the message belongs to, if any
+                                 * @example Support Thread
+                                 */
+                                threadName: string | null;
+                                /**
+                                 * @description Organisation sender id
+                                 * @example f6a7b8c9-d0e1-2345-f123-456789012345
+                                 */
+                                organisationId: string;
+                                /**
+                                 * @description Unique id of the recipient
+                                 * @example b2c3d4e5-f6a7-8901-bcde-f12345678901
+                                 */
+                                recipientUserId: string;
+                                /**
+                                 * @description Number of attachments
+                                 * @example 0
+                                 */
+                                attachmentsCount: number;
+                                /**
+                                 * @description Optional gateway metadata associated with the message
+                                 * @example null
+                                 */
+                                metadata?: {
+                                    /**
+                                     * @description Journey context associated with this message
+                                     * @example {
+                                     *       "submissionId": "22222222-2222-2222-2222-222222222222"
+                                     *     }
+                                     */
+                                    journey?: {
+                                        /**
+                                         * @description Identifier of the journey that triggered this message
+                                         * @example 11111111-1111-1111-1111-111111111111
+                                         */
+                                        journeyId?: string;
+                                        /**
+                                         * @description Identifier of the journey submission linked to this message
+                                         * @example 22222222-2222-2222-2222-222222222222
+                                         */
+                                        submissionId: string;
+                                    };
+                                } | null;
+                            }[];
+                            metadata?: {
+                                /** @description Object containing the links to the related endpoints */
+                                links?: {
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *     }
+                                     */
+                                    self: {
+                                        /** @description URL pointing to the request itself */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
+                                     *     }
+                                     */
+                                    next?: {
+                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    prev?: {
+                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    first: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
+                                     *     }
+                                     */
+                                    last: {
+                                        /** @description URL pointing to the last page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'
+                                     * @example {
+                                     *       "page1": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *       },
+                                     *       "page2": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *       }
+                                     *     }
+                                     */
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                /**
+                                 * @description Number representing the total number of available items
+                                 * @example 150
+                                 */
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                502: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/citizens/messages/consent": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Persist consent for normalized message metadata */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Organisation identifier the consent applies to
+                         * @example testing-org
+                         */
+                        organizationId: string;
+                        /**
+                         * @description Gateway-level metadata associated with a message
+                         * @example {
+                         *       "journey": {
+                         *         "submissionId": "22222222-2222-2222-2222-222222222222"
+                         *       }
+                         *     }
+                         */
+                        metadata: {
+                            /**
+                             * @description Journey context associated with this message
+                             * @example {
+                             *       "submissionId": "22222222-2222-2222-2222-222222222222"
+                             *     }
+                             */
+                            journey?: {
+                                /**
+                                 * @description Identifier of the journey that triggered this message
+                                 * @example 11111111-1111-1111-1111-111111111111
+                                 */
+                                journeyId?: string;
+                                /**
+                                 * @description Identifier of the journey submission linked to this message
+                                 * @example 22222222-2222-2222-2222-222222222222
+                                 */
+                                submissionId: string;
+                            };
+                        };
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Record of normalised message metadata consent submitted by an organisation
+                             * @example {
+                             *       "profileId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
+                             *       "metadata": {
+                             *         "journey": {
+                             *           "submissionId": "22222222-2222-2222-2222-222222222222"
+                             *         }
+                             *       },
+                             *       "submittedAt": "2025-11-25T14:30:00Z"
+                             *     }
+                             */
+                            data: {
+                                /**
+                                 * @description Profile identifier of the citizen who gave consent
+                                 * @example b2c3d4e5-f6a7-8901-bcde-f12345678901
+                                 */
+                                profileId: string;
+                                /**
+                                 * @description Gateway-level metadata associated with a message
+                                 * @example {
+                                 *       "journey": {
+                                 *         "submissionId": "22222222-2222-2222-2222-222222222222"
+                                 *       }
+                                 *     }
+                                 */
+                                metadata: {
+                                    /**
+                                     * @description Journey context associated with this message
+                                     * @example {
+                                     *       "submissionId": "22222222-2222-2222-2222-222222222222"
+                                     *     }
+                                     */
+                                    journey?: {
+                                        /**
+                                         * @description Identifier of the journey that triggered this message
+                                         * @example 11111111-1111-1111-1111-111111111111
+                                         */
+                                        journeyId?: string;
+                                        /**
+                                         * @description Identifier of the journey submission linked to this message
+                                         * @example 22222222-2222-2222-2222-222222222222
+                                         */
+                                        submissionId: string;
+                                    };
+                                };
+                                /**
+                                 * Format: date-time
+                                 * @description ISO 8601 timestamp when consent was recorded
+                                 * @example 2025-11-25T14:30:00Z
+                                 */
+                                submittedAt: string;
+                            };
+                            metadata?: {
+                                /** @description Object containing the links to the related endpoints */
+                                links?: {
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *     }
+                                     */
+                                    self: {
+                                        /** @description URL pointing to the request itself */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
+                                     *     }
+                                     */
+                                    next?: {
+                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    prev?: {
+                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    first: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
+                                     *     }
+                                     */
+                                    last: {
+                                        /** @description URL pointing to the last page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'
+                                     * @example {
+                                     *       "page1": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *       },
+                                     *       "page2": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *       }
+                                     *     }
+                                     */
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                /**
+                                 * @description Number representing the total number of available items
+                                 * @example 150
+                                 */
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                /** @description Default Response */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Record of normalised message metadata consent submitted by an organisation
+                             * @example {
+                             *       "profileId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
+                             *       "metadata": {
+                             *         "journey": {
+                             *           "submissionId": "22222222-2222-2222-2222-222222222222"
+                             *         }
+                             *       },
+                             *       "submittedAt": "2025-11-25T14:30:00Z"
+                             *     }
+                             */
+                            data: {
+                                /**
+                                 * @description Profile identifier of the citizen who gave consent
+                                 * @example b2c3d4e5-f6a7-8901-bcde-f12345678901
+                                 */
+                                profileId: string;
+                                /**
+                                 * @description Gateway-level metadata associated with a message
+                                 * @example {
+                                 *       "journey": {
+                                 *         "submissionId": "22222222-2222-2222-2222-222222222222"
+                                 *       }
+                                 *     }
+                                 */
+                                metadata: {
+                                    /**
+                                     * @description Journey context associated with this message
+                                     * @example {
+                                     *       "submissionId": "22222222-2222-2222-2222-222222222222"
+                                     *     }
+                                     */
+                                    journey?: {
+                                        /**
+                                         * @description Identifier of the journey that triggered this message
+                                         * @example 11111111-1111-1111-1111-111111111111
+                                         */
+                                        journeyId?: string;
+                                        /**
+                                         * @description Identifier of the journey submission linked to this message
+                                         * @example 22222222-2222-2222-2222-222222222222
+                                         */
+                                        submissionId: string;
+                                    };
+                                };
+                                /**
+                                 * Format: date-time
+                                 * @description ISO 8601 timestamp when consent was recorded
+                                 * @example 2025-11-25T14:30:00Z
+                                 */
+                                submittedAt: string;
+                            };
+                            metadata?: {
+                                /** @description Object containing the links to the related endpoints */
+                                links?: {
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *     }
+                                     */
+                                    self: {
+                                        /** @description URL pointing to the request itself */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
+                                     *     }
+                                     */
+                                    next?: {
+                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    prev?: {
+                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    first: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
+                                     *     }
+                                     */
+                                    last: {
+                                        /** @description URL pointing to the last page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'
+                                     * @example {
+                                     *       "page1": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *       },
+                                     *       "page2": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *       }
+                                     *     }
+                                     */
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                /**
+                                 * @description Number representing the total number of available items
+                                 * @example 150
+                                 */
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/organisations/messages/{messageId}/events": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get complete event history for a message */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /**
+                     * @description Unique identifier of the message whose history to retrieve
+                     * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                     */
+                    messageId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                /**
+                                 * Format: uuid
+                                 * @description Message id
+                                 * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                                 */
+                                messageId: string;
+                                /**
+                                 * @description Event type description
+                                 * @example delivered
+                                 */
+                                eventType: string;
+                                /**
+                                 * @description Status for event type
+                                 * @example success
+                                 */
+                                eventStatus: string;
+                                /**
+                                 * @description Event-specific payload; shape depends on the event type (create, schedule, or error)
+                                 * @example {
+                                 *       "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+                                 *       "receiverFullName": "John Doe",
+                                 *       "receiverPPSN": "1234567T",
+                                 *       "receiverUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
+                                 *       "subject": "Welcome to MessagingIE",
+                                 *       "language": "en",
+                                 *       "plainText": "Dear John Doe, Welcome to MessagingIE.",
+                                 *       "transports": [
+                                 *         "email"
+                                 *       ],
+                                 *       "scheduledAt": "2025-11-25T14:30:00Z",
+                                 *       "organisationName": "Department of Social Protection",
+                                 *       "security": "confidential"
+                                 *     }
+                                 */
+                                data: {
+                                    /**
+                                     * @description Unique id of the related message
+                                     * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                                     */
+                                    messageId: string;
+                                    /**
+                                     * @description Full name of the recipient
+                                     * @example John Doe
+                                     */
+                                    receiverFullName: string;
+                                    /**
+                                     * @description PPSN of the recipient
+                                     * @example 1234567T
+                                     */
+                                    receiverPPSN: string;
+                                    /**
+                                     * @description User id of recipient
+                                     * @example b2c3d4e5-f6a7-8901-bcde-f12345678901
+                                     */
+                                    receiverUserId: string;
+                                    /**
+                                     * @description Subject of the related message
+                                     * @example Welcome to MessagingIE
+                                     */
+                                    subject: string;
+                                    /**
+                                     * @description Language of the related message
+                                     * @example en
+                                     */
+                                    language: string;
+                                    /**
+                                     * @description Excerpt of the related message
+                                     * @example Dear John Doe, Welcome...
+                                     */
+                                    excerpt?: string;
+                                    /**
+                                     * @description Rich text content of the related message
+                                     * @example <p>Dear <strong>John Doe</strong>...</p>
+                                     */
+                                    richText?: string;
+                                    /**
+                                     * @description Plain text context of the related message
+                                     * @example Dear John Doe, Welcome to MessagingIE.
+                                     */
+                                    plainText: string;
+                                    /**
+                                     * @description Thread name of the related message
+                                     * @example Support Thread
+                                     */
+                                    threadName?: string;
+                                    /**
+                                     * @description Selected transports to send the message
+                                     * @example [
+                                     *       "email"
+                                     *     ]
+                                     */
+                                    transports: string[];
+                                    /**
+                                     * Format: date-time
+                                     * @description Date and time which describes when the message has to be sent
+                                     * @example 2025-11-25T14:30:00Z
+                                     */
+                                    scheduledAt: string;
+                                    /**
+                                     * @description Unique user id of the sender
+                                     * @example c3d4e5f6-a7b8-9012-cdef-123456789012
+                                     */
+                                    senderUserId?: string;
+                                    /**
+                                     * @description Full name of the sender
+                                     * @example Jane Smith
+                                     */
+                                    senderFullName?: string;
+                                    /**
+                                     * @description PPSN of the sender
+                                     * @example 9876543A
+                                     */
+                                    senderPPSN?: string;
+                                    /**
+                                     * @description Unique id of the M2M application that sent the message
+                                     * @example d4e5f6a7-b8c9-0123-def1-234567890123
+                                     */
+                                    senderApplicationId?: string;
+                                    /**
+                                     * @description Organisation related to the sender
+                                     * @example Department of Social Protection
+                                     */
+                                    organisationName: string;
+                                    /**
+                                     * @description Security classification of the message: 'public' to show the original message in the sent email, 'confidential' to show the content only after login in MessagingIE
+                                     * @example confidential
+                                     * @enum {unknown}
+                                     */
+                                    security: "public" | "confidential";
+                                } | {
+                                    /**
+                                     * @description Unique id of the related message
+                                     * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                                     */
+                                    messageId: string;
+                                    /**
+                                     * @description Unique id of the job
+                                     * @example e5f6a7b8-c9d0-1234-ef12-345678901234
+                                     */
+                                    jobId: string;
+                                } | {
+                                    /**
+                                     * @description Unique id of the related message
+                                     * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                                     */
+                                    messageId: string;
+                                };
+                                /**
+                                 * Format: date-time
+                                 * @description Date and time which describes when the event has been recorded
+                                 * @example 2025-11-25T14:30:05Z
+                                 */
+                                createdAt: string;
+                            }[];
+                            metadata?: {
+                                /** @description Object containing the links to the related endpoints */
+                                links?: {
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *     }
+                                     */
+                                    self: {
+                                        /** @description URL pointing to the request itself */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
+                                     *     }
+                                     */
+                                    next?: {
+                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    prev?: {
+                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    first: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
+                                     *     }
+                                     */
+                                    last: {
+                                        /** @description URL pointing to the last page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'
+                                     * @example {
+                                     *       "page1": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *       },
+                                     *       "page2": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *       }
+                                     *     }
+                                     */
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                /**
+                                 * @description Number representing the total number of available items
+                                 * @example 150
+                                 */
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/organisations/messages/events": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Get latest event for a list of messages with pagination, filters, and HATEOAS links */
+        post: {
+            parameters: {
+                query?: {
+                    /** @description Indicates where to start fetching data or how many records to skip, defining the initial position within the list */
+                    offset?: string;
+                    /** @description Indicates the maximum number (100) of items that will be returned in a single request */
+                    limit?: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            /** @description Filter criteria for retrieving the latest message event */
+            requestBody: {
+                content: {
+                    /**
+                     * @example {
+                     *       "recipientEmail": "john.doe@example.com",
+                     *       "subjectContains": "Welcome",
+                     *       "dateFrom": "2025-11-01",
+                     *       "dateTo": "2025-11-30",
+                     *       "status": "delivered"
+                     *     }
+                     */
+                    "application/json": {
+                        /**
+                         * Format: email
+                         * @description Filter events by recipient email address
+                         * @example john.doe@example.com
+                         */
+                        recipientEmail?: string;
+                        /**
+                         * @description Filter events by recipient profile identifier
+                         * @example b2c3d4e5-f6a7-8901-bcde-f12345678901
+                         */
+                        recipientId?: string;
+                        /**
+                         * @description Filter events where the subject contains this substring
+                         * @example Welcome
+                         */
+                        subjectContains?: string;
+                        /**
+                         * Format: date
+                         * @description Return events on or after this date (YYYY-MM-DD)
+                         * @example 2025-11-01
+                         */
+                        dateFrom?: string;
+                        /**
+                         * Format: date
+                         * @description Return events on or before this date (YYYY-MM-DD)
+                         * @example 2025-11-30
+                         */
+                        dateTo?: string;
+                        /**
+                         * @description Filter events by status
+                         * @example delivered
+                         * @enum {unknown}
+                         */
+                        status?: "delivered" | "scheduled" | "opened" | "failed";
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                /**
+                                 * Format: uuid
+                                 * @description Unique id of the event
+                                 * @example e1f2e3f4-a5b6-7890-abcd-ef1234567890
+                                 */
+                                id: string;
+                                /**
+                                 * Format: uuid
+                                 * @description Unique id of the related message
+                                 * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                                 */
+                                messageId: string;
+                                /**
+                                 * @description Subject of the related message
+                                 * @example Welcome to MessagingIE
+                                 */
+                                subject: string;
+                                /**
+                                 * @description Full name of the recipient
+                                 * @example John Doe
+                                 */
+                                receiverFullName: string;
+                                /**
+                                 * @description Event type description
+                                 * @example delivered
+                                 */
+                                eventType: string;
+                                /**
+                                 * @description Status for event type
+                                 * @example success
+                                 */
+                                eventStatus: string;
+                                /**
+                                 * @description Date and time which describes when the message has to be sent
+                                 * @example 2025-11-25T14:30:00Z
+                                 */
+                                scheduledAt: string;
+                            }[];
+                            metadata?: {
+                                /** @description Object containing the links to the related endpoints */
+                                links?: {
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *     }
+                                     */
+                                    self: {
+                                        /** @description URL pointing to the request itself */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
+                                     *     }
+                                     */
+                                    next?: {
+                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    prev?: {
+                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    first: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
+                                     *     }
+                                     */
+                                    last: {
+                                        /** @description URL pointing to the last page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'
+                                     * @example {
+                                     *       "page1": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *       },
+                                     *       "page2": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *       }
+                                     *     }
+                                     */
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                /**
+                                 * @description Number representing the total number of available items
+                                 * @example 150
+                                 */
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/organisations/messages/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Send a message with optional attachments (multipart/form-data) */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            /** @description Request body for sending a new message */
+            requestBody: {
+                content: {
+                    /**
+                     * @example {
+                     *       "subject": "Welcome to MessagingIE",
+                     *       "plainTextBody": "Dear John Doe, Welcome to MessagingIE.",
+                     *       "securityLevel": "confidential",
+                     *       "language": "en",
+                     *       "scheduledAt": "2025-11-25T14:30:00Z",
+                     *       "recipient": {
+                     *         "type": "profileId",
+                     *         "profileId": "frehui776"
+                     *       }
+                     *     }
+                     */
+                    "multipart/form-data": {
+                        /**
+                         * @description Message subject line (1-500 characters)
+                         * @example Welcome to MessagingIE
+                         */
+                        subject: string;
+                        /**
+                         * @description Plain text version of the message body
+                         * @example Dear John Doe, Welcome to MessagingIE.
+                         */
+                        plainTextBody: string;
+                        /**
+                         * @description HTML version of the message body (optional)
+                         * @example <p>Dear <strong>John Doe</strong>,</p><p>Welcome to MessagingIE.</p>
+                         */
+                        htmlBody?: string;
+                        /**
+                         * @description Security classification of the message: 'public' to show the original message in the sent email, 'confidential' to show the content only after login in MessagingIE
+                         * @example confidential
+                         * @enum {unknown}
+                         */
+                        securityLevel: "public" | "confidential";
+                        /**
+                         * @description Message language: 'en' for English, 'ga' for Irish (Gaeilge)
+                         * @example en
+                         * @enum {unknown}
+                         */
+                        language: "en" | "ga";
+                        /**
+                         * Format: date-time
+                         * @description ISO 8601 timestamp (Europe/Dublin TZ assumed)
+                         * @example 2025-11-25T14:30:00Z
+                         */
+                        scheduledAt: string;
+                        /**
+                         * @description Recipient of the message; one of email, identity (PPSN+DOB), or profile-id variants
+                         * @example {
+                         *       "type": "profileId",
+                         *       "profileId": "frehui776"
+                         *     }
+                         */
+                        recipient: {
+                            /**
+                             * @description Recipient type identifier for email-based recipients
+                             * @example email
+                             * @enum {string}
+                             */
+                            type: "email";
+                            /**
+                             * @description Recipient's first name
+                             * @example John
+                             */
+                            firstName: string;
+                            /**
+                             * @description Recipient's last name
+                             * @example Doe
+                             */
+                            lastName: string;
+                            /**
+                             * Format: email
+                             * @description Recipient's email address
+                             * @example john.doe@example.ie
+                             */
+                            email: string;
+                            /**
+                             * @description Personal Public Service Number (optional for email recipients)
+                             * @example 1234567T
+                             */
+                            ppsn?: string;
+                            /**
+                             * Format: date
+                             * @description Recipient's date of birth in YYYY-MM-DD format (optional for email recipients)
+                             * @example 1985-03-15
+                             */
+                            dateOfBirth?: string;
+                        } | {
+                            /**
+                             * @description Recipient type identifier for identity-based recipients
+                             * @example identity
+                             * @enum {string}
+                             */
+                            type: "identity";
+                            /**
+                             * @description Personal Public Service Number (required for identity recipients)
+                             * @example 1234567T
+                             */
+                            ppsn: string;
+                            /**
+                             * Format: date
+                             * @description Recipient's date of birth in YYYY-MM-DD format (required for identity recipients)
+                             * @example 1985-03-15
+                             */
+                            dateOfBirth: string;
+                        } | {
+                            /**
+                             * @description Recipient type identifier for profile-id recipients
+                             * @example profileId
+                             * @enum {string}
+                             */
+                            type: "profileId";
+                            /**
+                             * @description Profile identifier supplied by the caller; the gateway forwards it without profile lookup
+                             * @example frehui776
+                             */
+                            profileId: string;
+                        };
+                        /**
+                         * @description Gateway-level metadata associated with a message
+                         * @example {
+                         *       "journey": {
+                         *         "submissionId": "22222222-2222-2222-2222-222222222222"
+                         *       }
+                         *     }
+                         */
+                        metadata?: {
+                            /**
+                             * @description Journey context associated with this message
+                             * @example {
+                             *       "submissionId": "22222222-2222-2222-2222-222222222222"
+                             *     }
+                             */
+                            journey?: {
+                                /**
+                                 * @description Identifier of the journey that triggered this message
+                                 * @example 11111111-1111-1111-1111-111111111111
+                                 */
+                                journeyId?: string;
+                                /**
+                                 * @description Identifier of the journey submission linked to this message
+                                 * @example 22222222-2222-2222-2222-222222222222
+                                 */
+                                submissionId: string;
+                            };
+                        };
+                        /** @description Multipart file attachments (handled at transport layer) */
+                        attachments?: unknown;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /**
+                             * @description Response body returned after successfully sending a message
+                             * @example {
+                             *       "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+                             *       "recipientId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
+                             *       "attachmentIds": []
+                             *     }
+                             */
+                            data: {
+                                /**
+                                 * Format: uuid
+                                 * @description Unique identifier for the created message
+                                 * @example a1b2c3d4-e5f6-7890-abcd-ef1234567890
+                                 */
+                                messageId: string;
+                                /**
+                                 * Format: uuid
+                                 * @description Unique identifier for the message recipient profile
+                                 * @example b2c3d4e5-f6a7-8901-bcde-f12345678901
+                                 */
+                                recipientId: string;
+                                /**
+                                 * @description List of attachment identifiers associated with the message
+                                 * @example [
+                                 *       "c3d4e5f6-a7b8-9012-cdef-123456789012",
+                                 *       "d4e5f6a7-b8c9-0123-def1-234567890123"
+                                 *     ]
+                                 */
+                                attachmentIds: string[];
+                                /**
+                                 * @description Warning details when message metadata could not be persisted
+                                 * @example {
+                                 *       "code": "MESSAGE_METADATA_NOT_STORED",
+                                 *       "detail": "Message metadata could not be stored"
+                                 *     }
+                                 */
+                                warning?: {
+                                    /**
+                                     * @description Machine-readable code identifying the warning type
+                                     * @example MESSAGE_METADATA_NOT_STORED
+                                     * @enum {string}
+                                     */
+                                    code: "MESSAGE_METADATA_NOT_STORED";
+                                    /**
+                                     * @description Human-readable description of the warning
+                                     * @example Message metadata could not be stored
+                                     */
+                                    detail: string;
+                                };
+                            };
+                            metadata?: {
+                                /** @description Object containing the links to the related endpoints */
+                                links?: {
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *     }
+                                     */
+                                    self: {
+                                        /** @description URL pointing to the request itself */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=40&limit=20"
+                                     *     }
+                                     */
+                                    next?: {
+                                        /** @description URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    prev?: {
+                                        /** @description URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *     }
+                                     */
+                                    first: {
+                                        /** @description URL pointing to the first page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description Object containing the URL link
+                                     * @example {
+                                     *       "href": "https://api.example.ie/api/v1/the-endpoint?offset=120&limit=20"
+                                     *     }
+                                     */
+                                    last: {
+                                        /** @description URL pointing to the last page of results in a paginated response */
+                                        href?: string;
+                                    };
+                                    /**
+                                     * @description It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'
+                                     * @example {
+                                     *       "page1": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=0&limit=20"
+                                     *       },
+                                     *       "page2": {
+                                     *         "href": "https://api.example.ie/api/v1/the-endpoint?offset=20&limit=20"
+                                     *       }
+                                     *     }
+                                     */
+                                    pages: {
+                                        [key: string]: {
+                                            href?: string;
+                                        };
+                                    };
+                                };
+                                /**
+                                 * @description Number representing the total number of available items
+                                 * @example 150
+                                 */
+                                totalCount?: number;
+                            };
+                        };
+                    };
+                };
+                /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                409: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                413: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                502: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                504: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @description Code used to categorize the error */
+                            code: string;
+                            /** @description Description of the error */
+                            detail: string;
+                            /** @description Unique request id. This one will be used to troubleshoot the problems */
+                            requestId: string;
+                            /** @description Name of the error type */
+                            name: string;
+                            /** @description List of the validation errors */
+                            validation?: {
+                                fieldName: string;
+                                message: string;
+                            }[];
+                            validationContext?: string;
+                            statusCode: number;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: never;
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;