@ogcio/building-blocks-sdk 0.2.84 → 0.2.86

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

@@ -5864,6 +5864,361 @@
           }
         }
       }
+    },
+    "/api/v1/support/messages/search": {
+      "post": {
+        "operationId": "SupportListMessagesPost",
+        "tags": [
+          "Messages Support"
+        ],
+        "description": "Returns all the messages for the requested organisation or the requested recipient",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "recipientUserIds"
+                ],
+                "properties": {
+                  "recipientUserIds": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "description": "Unique id of the recipient"
+                    },
+                    "description": "Filter messages by recipient user ids",
+                    "minItems": 1,
+                    "maxItems": 10
+                  }
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "schema": {
+              "type": "string",
+              "pattern": "^[0-9][0-9]*|undefined$",
+              "default": "0"
+            },
+            "in": "query",
+            "name": "offset",
+            "required": false,
+            "description": "Indicates where to start fetching data or how many records to skip, defining the initial position within the list"
+          },
+          {
+            "schema": {
+              "type": "string",
+              "default": "20",
+              "pattern": "^([1-9]|100)|undefined$"
+            },
+            "in": "query",
+            "name": "limit",
+            "required": false,
+            "description": "Indicates the maximum number (100) of items that will be returned in a single request"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Default Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "data"
+                  ],
+                  "properties": {
+                    "data": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "id",
+                          "organisationId",
+                          "recipientUserId",
+                          "threadName",
+                          "isSeen",
+                          "subject",
+                          "richText",
+                          "plainText",
+                          "createdAt",
+                          "scheduledAt",
+                          "attachmentIds"
+                        ],
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Unique Id of the message"
+                          },
+                          "organisationId": {
+                            "type": "string",
+                            "description": "Organisation sender id"
+                          },
+                          "recipientUserId": {
+                            "type": "string",
+                            "description": "Unique id of the recipient"
+                          },
+                          "threadName": {
+                            "anyOf": [
+                              {
+                                "type": "string",
+                                "description": "Thread Name used to group messages"
+                              },
+                              {
+                                "type": "null"
+                              }
+                            ]
+                          },
+                          "isSeen": {
+                            "type": "boolean",
+                            "description": "Whether the message has been seen"
+                          },
+                          "subject": {
+                            "type": "string",
+                            "description": "Subject"
+                          },
+                          "richText": {
+                            "anyOf": [
+                              {
+                                "type": "string",
+                                "description": "Rich text content of the message"
+                              },
+                              {
+                                "type": "null"
+                              }
+                            ]
+                          },
+                          "plainText": {
+                            "type": "string",
+                            "description": "Plain text content of the message"
+                          },
+                          "createdAt": {
+                            "type": "string",
+                            "description": "Creation date time"
+                          },
+                          "scheduledAt": {
+                            "type": "string",
+                            "description": "Scheduled date time"
+                          },
+                          "attachmentIds": {
+                            "type": "array",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment Ids"
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "metadata": {
+                      "type": "object",
+                      "properties": {
+                        "links": {
+                          "type": "object",
+                          "required": [
+                            "self",
+                            "first",
+                            "last",
+                            "pages"
+                          ],
+                          "properties": {
+                            "self": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "type": "string",
+                                  "description": "URL pointing to the request itself"
+                                }
+                              }
+                            },
+                            "next": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "type": "string",
+                                  "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted"
+                                }
+                              }
+                            },
+                            "prev": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "type": "string",
+                                  "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted"
+                                }
+                              }
+                            },
+                            "first": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "type": "string",
+                                  "description": "URL pointing to the first page of results in a paginated response"
+                                }
+                              }
+                            },
+                            "last": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "type": "string",
+                                  "description": "URL pointing to the first page of results in a paginated response"
+                                }
+                              }
+                            },
+                            "pages": {
+                              "type": "object",
+                              "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
+                              "additionalProperties": {
+                                "type": "object",
+                                "properties": {
+                                  "href": {
+                                    "type": "string"
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "description": "Object containing the links to the related endpoints"
+                        },
+                        "totalCount": {
+                          "type": "number",
+                          "description": "Number representing the total number of available items"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "4XX": {
+            "description": "Default Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "code",
+                    "detail",
+                    "requestId",
+                    "name",
+                    "statusCode"
+                  ],
+                  "properties": {
+                    "code": {
+                      "type": "string",
+                      "description": "Code used to categorize the error"
+                    },
+                    "detail": {
+                      "type": "string",
+                      "description": "Description of the error"
+                    },
+                    "requestId": {
+                      "type": "string",
+                      "description": "Unique request id. This one will be used to troubleshoot the problems"
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Name of the error type"
+                    },
+                    "validation": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "fieldName",
+                          "message"
+                        ],
+                        "properties": {
+                          "fieldName": {
+                            "type": "string"
+                          },
+                          "message": {
+                            "type": "string"
+                          }
+                        }
+                      },
+                      "description": "List of the validation errors"
+                    },
+                    "validationContext": {
+                      "type": "string"
+                    },
+                    "statusCode": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "5XX": {
+            "description": "Default Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "code",
+                    "detail",
+                    "requestId",
+                    "name",
+                    "statusCode"
+                  ],
+                  "properties": {
+                    "code": {
+                      "type": "string",
+                      "description": "Code used to categorize the error"
+                    },
+                    "detail": {
+                      "type": "string",
+                      "description": "Description of the error"
+                    },
+                    "requestId": {
+                      "type": "string",
+                      "description": "Unique request id. This one will be used to troubleshoot the problems"
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Name of the error type"
+                    },
+                    "validation": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "required": [
+                          "fieldName",
+                          "message"
+                        ],
+                        "properties": {
+                          "fieldName": {
+                            "type": "string"
+                          },
+                          "message": {
+                            "type": "string"
+                          }
+                        }
+                      },
+                      "description": "List of the validation errors"
+                    },
+                    "validationContext": {
+                      "type": "string"
+                    },
+                    "statusCode": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "security": [

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

@@ -917,6 +917,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/support/messages/search": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Returns all the messages for the requested organisation or the requested recipient */
+        post: operations["SupportListMessagesPost"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -2679,4 +2696,141 @@ export interface operations {
             };
         };
     };
+    SupportListMessagesPost: {
+        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;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description Filter messages by recipient user ids */
+                    recipientUserIds: string[];
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        data: {
+                            /** @description Unique Id of the message */
+                            id: string;
+                            /** @description Organisation sender id */
+                            organisationId: string;
+                            /** @description Unique id of the recipient */
+                            recipientUserId: string;
+                            threadName: string | null;
+                            /** @description Whether the message has been seen */
+                            isSeen: boolean;
+                            /** @description Subject */
+                            subject: string;
+                            richText: string | null;
+                            /** @description Plain text content of the message */
+                            plainText: string;
+                            /** @description Creation date time */
+                            createdAt: string;
+                            /** @description Scheduled date time */
+                            scheduledAt: string;
+                            attachmentIds: 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;
+                    };
+                };
+            };
+        };
+    };
 }

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

@@ -0,0 +1,27 @@
+import type createClient from "openapi-fetch";
+import type { Logger } from "../../../types/index.js";
+import { formatError, formatResponse } from "../../utils/client-utils.js";
+import type { paths } from "./schema.js";
+
+export class MessagingSupport {
+  constructor(
+    private readonly client: ReturnType<typeof createClient<paths>>,
+    private readonly serviceName: string,
+    private readonly logger: Logger | undefined,
+  ) {}
+
+  async postMessagesSearch(
+    query: paths["/api/v1/support/messages/search"]["post"]["parameters"]["query"],
+    body: paths["/api/v1/support/messages/search"]["post"]["requestBody"]["content"]["application/json"],
+  ) {
+    return this.client
+      .POST("/api/v1/support/messages/search", {
+        params: { query },
+        body,
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+}

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

@@ -337,12 +337,17 @@ export class Profile extends BaseClient<paths> {
       "type"
     >,
   ) {
-    return this.client.POST("/api/v1/lifecycle-tasks/", {
-      body: { ...params, type: "export_user_data" },
-      headers: {
-        "Content-Type": "application/json",
-      },
-    });
+    return this.client
+      .POST("/api/v1/lifecycle-tasks/", {
+        body: { ...params, type: "export_user_data" },
+        headers: {
+          "Content-Type": "application/json",
+        },
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
   }
 
   async createDeleteProfileLifecycleTask(
@@ -351,39 +356,32 @@ export class Profile extends BaseClient<paths> {
       "type"
     >,
   ) {
-    return this.client.POST("/api/v1/lifecycle-tasks/", {
-      body: { ...params, type: "delete_profile" },
-      headers: {
-        "Content-Type": "application/json",
-      },
-    });
+    return this.client
+      .POST("/api/v1/lifecycle-tasks/", {
+        body: { ...params, type: "delete_profile" },
+        headers: {
+          "Content-Type": "application/json",
+        },
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
   }
 
   async getLifecycleTasks(
-    params: paths["/api/v1/lifecycle-tasks/search"]["post"]["requestBody"]["content"]["application/json"] = {},
+    params: paths["/api/v1/lifecycle-tasks/search"]["post"]["requestBody"]["content"]["application/json"],
   ) {
-    return this.client.POST("/api/v1/lifecycle-tasks/search", {
-      body: params,
-      headers: {
-        "Content-Type": "application/json",
-      },
-    });
-  }
-
-  async downloadLifecycleTaskContext(params: {
-    profileId: string;
-    lifecycleTaskId: string;
-  }) {
-    return this.client.GET("/api/v1/lifecycle-tasks/{id}/action", {
-      params: {
-        path: {
-          id: params.lifecycleTaskId,
-        },
-        query: {
-          profileId: params.profileId,
-          q: "download",
+    return this.client
+      .POST("/api/v1/lifecycle-tasks/search", {
+        body: params,
+        headers: {
+          "Content-Type": "application/json",
         },
-      },
-    });
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
   }
 }