@ogcio/building-blocks-sdk 0.2.88 → 0.2.90

package/src/client/clients/messaging/tags.ts

@@ -0,0 +1,86 @@
+import type createClient from "openapi-fetch";
+import type { Logger } from "../../../types/index.js";
+import {
+  formatError,
+  formatResponse,
+  throwIfEmpty,
+} from "../../utils/client-utils.js";
+import type { paths } from "./schema.js";
+
+export class MessagingTags {
+  constructor(
+    private readonly client: ReturnType<typeof createClient<paths>>,
+    private readonly serviceName: string,
+    private readonly logger: Logger | undefined,
+  ) {}
+
+  async assignToMessages(
+    body: paths["/api/v1/messages/tags"]["post"]["requestBody"]["content"]["application/json"],
+  ) {
+    return this.client
+      .POST("/api/v1/messages/tags", {
+        body,
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+
+  async getAll() {
+    return this.client.GET("/api/v1/tags/", {}).then(
+      (response) => formatResponse(response, this.serviceName, this.logger),
+      (reason) => formatError(reason, this.serviceName, this.logger),
+    );
+  }
+
+  async getTree() {
+    return this.client.GET("/api/v1/tags/tree", {}).then(
+      (response) => formatResponse(response, this.serviceName, this.logger),
+      (reason) => formatError(reason, this.serviceName, this.logger),
+    );
+  }
+
+  async create(
+    body: paths["/api/v1/tags/"]["post"]["requestBody"]["content"]["application/json"],
+  ) {
+    return this.client
+      .POST("/api/v1/tags/", {
+        body,
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+
+  async update(
+    tagId: paths["/api/v1/tags/{tagId}"]["patch"]["parameters"]["path"]["tagId"],
+    body: paths["/api/v1/tags/{tagId}"]["patch"]["requestBody"]["content"]["application/json"],
+  ) {
+    throwIfEmpty(tagId);
+    return this.client
+      .PATCH("/api/v1/tags/{tagId}", {
+        params: { path: { tagId } },
+        body,
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+
+  async delete(
+    tagId: paths["/api/v1/tags/{tagId}"]["delete"]["parameters"]["path"]["tagId"],
+  ) {
+    throwIfEmpty(tagId);
+    return this.client
+      .DELETE("/api/v1/tags/{tagId}", {
+        params: { path: { tagId } },
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+}

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

@@ -238,7 +238,7 @@ export class Profile extends BaseClient<paths> {
           params: { query },
           bodySerializer: (body: unknown) => {
             const parsed = body as { file?: File } | undefined;
-            if (!parsed || !parsed.file) {
+            if (!parsed?.file) {
               throw createError.BadRequest("File is missing!");
             }
             const formData = new FormData();

package/src/client/clients/profile/open-api-definition.json

@@ -5719,6 +5719,55 @@
         }
       }
     },
+    "/api/v1/onboarding/": {
+      "post": {
+        "tags": [
+          "Onboarding"
+        ],
+        "description": "Check SAFE level and assign the onboarded-citizen role to the authenticated user",
+        "responses": {
+          "200": {
+            "description": "Default Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "success": {
+                      "type": "boolean"
+                    },
+                    "safeLevel": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Default Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    },
+                    "safeLevel": {
+                      "type": "number"
+                    },
+                    "required": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/api/v1/organisations/profiles/{profileId}": {
       "patch": {
         "operationId": "adminProfilesPatch",

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

@@ -172,6 +172,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/support/consents/latest": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description Get the latest consent for all available subjects for a user */
+        get: operations["supportLatestConsent"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/support/consents/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Submit consents for the logged in user */
+        post: operations["supportSubmitConsents"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/jobs/import-profiles/{profileImportId}": {
         parameters: {
             query?: never;
@@ -307,6 +341,58 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/onboarding/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Check SAFE level and assign the onboarded-citizen role to the authenticated user */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success?: boolean;
+                            safeLevel?: number;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error?: string;
+                            safeLevel?: number;
+                            required?: number;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/organisations/profiles/{profileId}": {
         parameters: {
             query?: never;
@@ -2268,6 +2354,218 @@ export interface operations {
             };
         };
     };
+    supportLatestConsent: {
+        parameters: {
+            query: {
+                profileId: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            availableSubjects: string[];
+                            consents: {
+                                /** Format: uuid */
+                                id: string;
+                                profileId: string;
+                                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 */
+                            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;
+                    };
+                };
+            };
+        };
+    };
+    supportSubmitConsents: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    profileId: string;
+                    consents: {
+                        subject: string;
+                        status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                    }[];
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** Format: uuid */
+                            id: string;
+                            subject: string;
+                            status: "pending" | "undefined" | "pre-approved" | "opted-out" | "opted-in";
+                            /** Format: date-time */
+                            submittedAt: string;
+                            /** Format: uuid */
+                            consentStatementId: string;
+                            statementVersion: number;
+                            isLatestStatement: boolean;
+                        }[];
+                    };
+                };
+            };
+            /** @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;
+                    };
+                };
+            };
+        };
+    };
     getLifecycleTasks: {
         parameters: {
             query?: never;

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

@@ -22,4 +22,30 @@ export class ProfileSupport {
         (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
+
+  async getLatestConsents(
+    query: paths["/api/v1/support/consents/latest"]["get"]["parameters"]["query"],
+  ) {
+    return this.client
+      .GET("/api/v1/support/consents/latest", {
+        params: { query },
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+
+  async submitConsents(
+    body: paths["/api/v1/support/consents/"]["post"]["requestBody"]["content"]["application/json"],
+  ) {
+    return this.client
+      .POST("/api/v1/support/consents/", {
+        body,
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
 }

package/src/client/clients/scheduler/open-api-definition.json

@@ -24,30 +24,31 @@
           "Tasks"
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
                 "type": "array",
                 "items": {
                   "type": "object",
+                  "required": [
+                    "webhookUrl",
+                    "webhookAuth",
+                    "executeAt"
+                  ],
                   "properties": {
                     "webhookUrl": {
-                      "format": "uri",
-                      "type": "string"
+                      "type": "string",
+                      "format": "uri"
                     },
                     "webhookAuth": {
                       "type": "string"
                     },
                     "executeAt": {
-                      "format": "date-time",
-                      "type": "string"
+                      "type": "string",
+                      "format": "date-time"
                     }
-                  },
-                  "required": [
-                    "webhookUrl",
-                    "webhookAuth",
-                    "executeAt"
-                  ]
+                  }
                 }
               }
             }
@@ -63,28 +64,37 @@
               "application/json": {
                 "schema": {
                   "type": "object",
+                  "required": [
+                    "code",
+                    "detail",
+                    "requestId",
+                    "name"
+                  ],
                   "properties": {
                     "code": {
-                      "description": "Code used to categorize the error",
-                      "type": "string"
+                      "type": "string",
+                      "description": "Code used to categorize the error"
                     },
                     "detail": {
-                      "description": "Description of the error",
-                      "type": "string"
+                      "type": "string",
+                      "description": "Description of the error"
                     },
                     "requestId": {
-                      "description": "Unique request id. This one will be used to troubleshoot the problems",
-                      "type": "string"
+                      "type": "string",
+                      "description": "Unique request id. This one will be used to troubleshoot the problems"
                     },
                     "name": {
-                      "description": "Name of the error type",
-                      "type": "string"
+                      "type": "string",
+                      "description": "Name of the error type"
                     },
                     "validation": {
-                      "description": "List of the validation errors",
                       "type": "array",
                       "items": {
                         "type": "object",
+                        "required": [
+                          "fieldName",
+                          "message"
+                        ],
                         "properties": {
                           "fieldName": {
                             "type": "string"
@@ -92,23 +102,14 @@
                           "message": {
                             "type": "string"
                           }
-                        },
-                        "required": [
-                          "fieldName",
-                          "message"
-                        ]
-                      }
+                        }
+                      },
+                      "description": "List of the validation errors"
                     },
                     "validationContext": {
                       "type": "string"
                     }
-                  },
-                  "required": [
-                    "code",
-                    "detail",
-                    "requestId",
-                    "name"
-                  ]
+                  }
                 }
               }
             }

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

@@ -48,7 +48,7 @@ export interface paths {
                 path?: never;
                 cookie?: never;
             };
-            requestBody?: {
+            requestBody: {
                 content: {
                     "application/json": {
                         /** Format: uri */