@ogcio/building-blocks-sdk 0.2.89 → 0.2.91

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

@@ -3,6 +3,31 @@ import type { Logger } from "../../../types/index.js";
 import { formatError, formatResponse } from "../../utils/client-utils.js";
 import type { paths } from "./schema.js";
 
+type ListAnnouncementsQuery =
+  paths["/api/v1/support/announcements/"]["get"]["parameters"]["query"];
+type BooleanListAnnouncementsQuery = Omit<
+  ListAnnouncementsQuery,
+  "isEnabled"
+> & {
+  isEnabled: boolean;
+};
+
+type CreateAnnouncementBody =
+  paths["/api/v1/support/announcements/"]["post"]["requestBody"]["content"]["application/json"];
+type TypedCreateAnnouncementBody = Omit<
+  CreateAnnouncementBody,
+  "isEnabled" | "publishDate"
+> & {
+  isEnabled: boolean;
+  publishDate: Date;
+};
+
+type ToggleEnabledBody =
+  paths["/api/v1/support/announcements/{id}/enabled"]["patch"]["requestBody"]["content"]["application/json"];
+type TypedToggleEnabledBody = Omit<ToggleEnabledBody, "isEnabled"> & {
+  isEnabled: boolean;
+};
+
 export class ProfileSupport {
   constructor(
     private readonly client: ReturnType<typeof createClient<paths>>,
@@ -48,4 +73,60 @@ export class ProfileSupport {
         (reason) => formatError(reason, this.serviceName, this.logger),
       );
   }
+
+  public readonly announcements = {
+    list: async (queryParams: BooleanListAnnouncementsQuery) => {
+      let isEnabled: undefined | "true" | "false";
+      if (queryParams.isEnabled !== undefined) {
+        isEnabled = queryParams.isEnabled ? "true" : "false";
+      }
+
+      return this.client
+        .GET("/api/v1/support/announcements/", {
+          params: { query: { ...queryParams, isEnabled } },
+        })
+        .then(
+          (response) => formatResponse(response, this.serviceName, this.logger),
+          (reason) => formatError(reason, this.serviceName, this.logger),
+        );
+    },
+    create: async (body: TypedCreateAnnouncementBody) => {
+      return this.client
+        .POST("/api/v1/support/announcements/", {
+          body: {
+            ...body,
+            isEnabled: body.isEnabled ? "true" : "false",
+            publishDate: body.publishDate.toISOString(),
+          },
+        })
+        .then(
+          (response) => formatResponse(response, this.serviceName, this.logger),
+          (reason) => formatError(reason, this.serviceName, this.logger),
+        );
+    },
+    toggleEnabled: async (id: string, body: TypedToggleEnabledBody) => {
+      return this.client
+        .PATCH("/api/v1/support/announcements/{id}/enabled", {
+          params: { path: { id } },
+          body: {
+            ...body,
+            isEnabled: body.isEnabled ? "true" : "false",
+          },
+        })
+        .then(
+          (response) => formatResponse(response, this.serviceName, this.logger),
+          (reason) => formatError(reason, this.serviceName, this.logger),
+        );
+    },
+    get: async (id: string) => {
+      return this.client
+        .GET("/api/v1/support/announcements/{id}", {
+          params: { path: { id } },
+        })
+        .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 */

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

@@ -15,6 +15,7 @@
           "Files"
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "multipart/form-data": {
               "schema": {
@@ -227,6 +228,7 @@
           "SupportFiles"
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "multipart/form-data": {
               "schema": {
@@ -342,6 +344,7 @@
           "SupportFiles"
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -365,8 +368,7 @@
                 }
               }
             }
-          },
-          "required": true
+          }
         },
         "responses": {
           "200": {
@@ -623,6 +625,7 @@
           "Metadata"
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -637,8 +640,7 @@
                 }
               }
             }
-          },
-          "required": true
+          }
         },
         "responses": {
           "200": {
@@ -1069,6 +1071,7 @@
           "Permissions"
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -1245,6 +1248,7 @@
           "Permissions"
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -1263,8 +1267,7 @@
                 }
               }
             }
-          },
-          "required": true
+          }
         },
         "responses": {
           "4XX": {
@@ -1462,6 +1465,7 @@
           "SupportPermissions"
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {

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

@@ -15,7 +15,7 @@ export interface paths {
                 path?: never;
                 cookie?: never;
             };
-            requestBody?: {
+            requestBody: {
                 content: {
                     "multipart/form-data": unknown | unknown;
                 };
@@ -159,7 +159,7 @@ export interface paths {
                 path?: never;
                 cookie?: never;
             };
-            requestBody?: {
+            requestBody: {
                 content: {
                     "multipart/form-data": unknown | unknown;
                 };
@@ -687,7 +687,7 @@ export interface paths {
                 path?: never;
                 cookie?: never;
             };
-            requestBody?: {
+            requestBody: {
                 content: {
                     "application/json": {
                         fileId: string;
@@ -821,7 +821,7 @@ export interface paths {
                 path?: never;
                 cookie?: never;
             };
-            requestBody?: {
+            requestBody: {
                 content: {
                     "application/json": {
                         fileId: string;