@ogcio/building-blocks-sdk 0.2.48 → 0.2.50

package/src/client/clients/profile/organisation.ts

@@ -0,0 +1,16 @@
+import type createClient from "openapi-fetch";
+import type { paths } from "./schema.js";
+
+export class ProfileOrganisation {
+  constructor(
+    private readonly client: ReturnType<typeof createClient<paths>>,
+  ) {}
+
+  async getLatestConsentStatement(
+    query: paths["/api/v1/organisations/consent-statements/latest"]["get"]["parameters"]["query"],
+  ) {
+    return this.client.GET("/api/v1/organisations/consent-statements/latest", {
+      params: { query },
+    });
+  }
+}

package/src/client/clients/profile/schema.ts

@@ -1,4 +1,55 @@
 export interface paths {
+    "/api/v1/citizens/consent-statements/latest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get the latest statement for a subject */
+        get: operations["citizenLatestStatement"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/organisations/consent-statements/latest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get the latest Statement for a subject */
+        get: operations["organizationLatestStatement"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/organisations/consent-statements/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Create Statement for a subject */
+        post: operations["organizationCreateStatement"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/citizens/consents/": {
         parameters: {
             query?: never;
@@ -328,6 +379,453 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    citizenLatestStatement: {
+        parameters: {
+            query: {
+                subject: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            subject: string;
+                            version: number;
+                            /** Format: date-time */
+                            createdAt: string;
+                        } & {
+                            translations: {
+                                en: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    /** Format: uuid */
+                                    consentStatementId: string;
+                                    language: "en" | "ga";
+                                    bodyTop: string[];
+                                    bodyList: string[];
+                                    bodyBottom: string[];
+                                    bodySmall: string[];
+                                    bodyLinks: {
+                                        [key: string]: string;
+                                    };
+                                    bodyFooter: string | null;
+                                    title: string;
+                                    /** Format: date-time */
+                                    createdAt: string;
+                                };
+                                ga: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    /** Format: uuid */
+                                    consentStatementId: string;
+                                    language: "en" | "ga";
+                                    bodyTop: string[];
+                                    bodyList: string[];
+                                    bodyBottom: string[];
+                                    bodySmall: string[];
+                                    bodyLinks: {
+                                        [key: string]: string;
+                                    };
+                                    bodyFooter: string | null;
+                                    title: string;
+                                    /** Format: date-time */
+                                    createdAt: string;
+                                };
+                            };
+                        };
+                        metadata?: {
+                            /** @description Object containing the links to the related endpoints */
+                            links?: {
+                                self: {
+                                    /** @description URL pointing to the request itself */
+                                    href?: string;
+                                };
+                                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;
+                                };
+                                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;
+                                };
+                                first: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                last: {
+                                    /** @description URL pointing to the first 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' */
+                                pages: {
+                                    [key: string]: {
+                                        href?: string;
+                                    };
+                                };
+                            };
+                            /** @description Number representing the total number of available items */
+                            totalCount?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                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 */
+            "5XX": {
+                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;
+                    };
+                };
+            };
+        };
+    };
+    organizationLatestStatement: {
+        parameters: {
+            query: {
+                subject: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            subject: string;
+                            version: number;
+                            /** Format: date-time */
+                            createdAt: string;
+                        } & {
+                            translations: {
+                                en: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    /** Format: uuid */
+                                    consentStatementId: string;
+                                    language: "en" | "ga";
+                                    bodyTop: string[];
+                                    bodyList: string[];
+                                    bodyBottom: string[];
+                                    bodySmall: string[];
+                                    bodyLinks: {
+                                        [key: string]: string;
+                                    };
+                                    bodyFooter: string | null;
+                                    title: string;
+                                    /** Format: date-time */
+                                    createdAt: string;
+                                };
+                                ga: {
+                                    /** Format: uuid */
+                                    id: string;
+                                    /** Format: uuid */
+                                    consentStatementId: string;
+                                    language: "en" | "ga";
+                                    bodyTop: string[];
+                                    bodyList: string[];
+                                    bodyBottom: string[];
+                                    bodySmall: string[];
+                                    bodyLinks: {
+                                        [key: string]: string;
+                                    };
+                                    bodyFooter: string | null;
+                                    title: string;
+                                    /** Format: date-time */
+                                    createdAt: string;
+                                };
+                            };
+                        };
+                        metadata?: {
+                            /** @description Object containing the links to the related endpoints */
+                            links?: {
+                                self: {
+                                    /** @description URL pointing to the request itself */
+                                    href?: string;
+                                };
+                                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;
+                                };
+                                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;
+                                };
+                                first: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                last: {
+                                    /** @description URL pointing to the first 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' */
+                                pages: {
+                                    [key: string]: {
+                                        href?: string;
+                                    };
+                                };
+                            };
+                            /** @description Number representing the total number of available items */
+                            totalCount?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                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 */
+            "5XX": {
+                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;
+                    };
+                };
+            };
+        };
+    };
+    organizationCreateStatement: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    consent: {
+                        subject: string;
+                        version: number;
+                    };
+                    translations: {
+                        en: {
+                            bodyTop: string[];
+                            bodyList: string[];
+                            bodyBottom: string[];
+                            bodySmall: string[];
+                            bodyLinks: {
+                                [key: string]: string;
+                            };
+                            bodyFooter: string | null;
+                            title: string;
+                        };
+                        ga: {
+                            bodyTop: string[];
+                            bodyList: string[];
+                            bodyBottom: string[];
+                            bodySmall: string[];
+                            bodyLinks: {
+                                [key: string]: string;
+                            };
+                            bodyFooter: string | null;
+                            title: string;
+                        };
+                    };
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                        };
+                        metadata?: {
+                            /** @description Object containing the links to the related endpoints */
+                            links?: {
+                                self: {
+                                    /** @description URL pointing to the request itself */
+                                    href?: string;
+                                };
+                                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;
+                                };
+                                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;
+                                };
+                                first: {
+                                    /** @description URL pointing to the first page of results in a paginated response */
+                                    href?: string;
+                                };
+                                last: {
+                                    /** @description URL pointing to the first 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' */
+                                pages: {
+                                    [key: string]: {
+                                        href?: string;
+                                    };
+                                };
+                            };
+                            /** @description Number representing the total number of available items */
+                            totalCount?: number;
+                        };
+                    };
+                };
+            };
+            /** @description Default Response */
+            "4XX": {
+                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 */
+            "5XX": {
+                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;
+                    };
+                };
+            };
+        };
+    };
     citizenListConsents: {
         parameters: {
             query: {
@@ -357,6 +855,8 @@ export interface operations {
                             status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
                             subject: string;
                             createdAt: string;
+                            /** Format: uuid */
+                            consentStatementId: string;
                         }[];
                         metadata?: {
                             /** @description Object containing the links to the related endpoints */
@@ -459,6 +959,8 @@ export interface operations {
                     /** @enum {string} */
                     subject: "messaging";
                     status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                    /** Format: uuid */
+                    consentStatementId: string;
                 };
             };
         };
@@ -553,6 +1055,8 @@ export interface operations {
                             status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
                             subject: string;
                             createdAt: string;
+                            /** Format: uuid */
+                            consentStatementId: string;
                         };
                         metadata?: {
                             /** @description Object containing the links to the related endpoints */
@@ -674,6 +1178,8 @@ export interface operations {
                             status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
                             subject: string;
                             createdAt: string;
+                            /** Format: uuid */
+                            consentStatementId: string;
                         }[];
                         metadata?: {
                             /** @description Object containing the links to the related endpoints */
@@ -929,7 +1435,11 @@ export interface operations {
                             /** Format: date-time */
                             updatedAt?: string;
                             consentStatuses?: {
-                                messaging: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                messaging: {
+                                    status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                    /** Format: uuid */
+                                    consent_statement_id: string;
+                                };
                             } | null;
                             details?: {
                                 email: string;
@@ -1082,7 +1592,11 @@ export interface operations {
                             /** Format: date-time */
                             updatedAt?: string;
                             consentStatuses?: {
-                                messaging: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                messaging: {
+                                    status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                    /** Format: uuid */
+                                    consent_statement_id: string;
+                                };
                             } | null;
                             details?: {
                                 email: string;
@@ -1384,7 +1898,11 @@ export interface operations {
                             /** Format: date-time */
                             updatedAt?: string;
                             consentStatuses?: {
-                                messaging: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                messaging: {
+                                    status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                    /** Format: uuid */
+                                    consent_statement_id: string;
+                                };
                             } | null;
                             details?: {
                                 email: string;
@@ -1534,7 +2052,11 @@ export interface operations {
                             /** Format: date-time */
                             updatedAt?: string;
                             consentStatuses?: {
-                                messaging: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                messaging: {
+                                    status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                    /** Format: uuid */
+                                    consent_statement_id: string;
+                                };
                             } | null;
                             details?: {
                                 email: string;
@@ -1943,7 +2465,11 @@ export interface operations {
                             /** Format: date-time */
                             updatedAt?: string;
                             consentStatuses?: {
-                                messaging: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                messaging: {
+                                    status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                    /** Format: uuid */
+                                    consent_statement_id: string;
+                                };
                             } | null;
                             details?: {
                                 email: string;
@@ -2114,7 +2640,11 @@ export interface operations {
                             /** Format: date-time */
                             updatedAt?: string;
                             consentStatuses?: {
-                                messaging: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                messaging: {
+                                    status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                    /** Format: uuid */
+                                    consent_statement_id: string;
+                                };
                             } | null;
                             details?: {
                                 email: string;
@@ -2279,7 +2809,11 @@ export interface operations {
                             /** Format: date-time */
                             updatedAt?: string;
                             consentStatuses?: {
-                                messaging: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                messaging: {
+                                    status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                                    /** Format: uuid */
+                                    consent_statement_id: string;
+                                };
                             } | null;
                             details?: {
                                 email: string;