@ogcio/building-blocks-sdk 0.1.18 → 0.2.0

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

@@ -328,248 +328,8 @@ export class Messaging extends BaseClient<paths> {
   async deleteEmailProvider(providerId: string) {
     return this.client
       .DELETE("/api/v1/providers/{providerId}", {
-        params: { path: { providerId } },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async getSmsProviders(
-    params?: {
-      primary?: boolean;
-    } & PaginationParams,
-  ) {
-    const { primary } = params || {};
-    const { error, data } = await this.client.GET("/api/v1/providers/", {
-      params: {
-        query: {
-          type: "sms",
-          ...preparePaginationParams(params),
-          primary:
-            primary !== undefined ? (primary ? "true" : "false") : undefined,
-        },
-      },
-    });
-
-    return {
-      error,
-      data: data?.data
-        .filter((item: { type?: string }) => item.type === "sms")
-        .map(
-          (item: { id: string; providerName: string; isPrimary: boolean }) => ({
-            id: item.id,
-            providerName: item.providerName,
-            isPrimary: item.isPrimary,
-          }),
-        ),
-    };
-  }
-
-  async getSmsProvider(providerId: string) {
-    const { data, error } = await this.client.GET(
-      "/api/v1/providers/{providerId}",
-      {
-        params: { path: { providerId }, query: { type: "sms" } },
-      },
-    );
-
-    // Let's do some type plumbing for the implementor
-    if (data?.data.type === "sms") {
-      return { data: data.data };
-    }
-
-    // Can we throw or return a new NotFoundError here?
-    return { error };
-  }
-
-  async updateSmsProvider(provider: {
-    id: string;
-    providerName: string;
-    isPrimary: boolean;
-    // Union other config types
-    config: {
-      type: "AWS";
-      accessKey: string;
-      secretAccessKey: string;
-      region: string;
-    };
-  }) {
-    return this.client
-      .PUT("/api/v1/providers/{providerId}", {
-        params: { path: { providerId: provider.id } },
-        body: {
-          type: "sms",
-          ...provider,
-        },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async createSmsProvider(provider: {
-    providerName: string;
-    isPrimary: boolean;
-    // Union other config types
-    config: {
-      type: "AWS";
-      accessKey: string;
-      secretAccessKey: string;
-      region: string;
-    };
-  }) {
-    return this.client
-      .POST("/api/v1/providers/", {
-        body: {
-          type: "sms",
-          ...provider,
-        },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async deleteSmsProvider(providerId: string) {
-    return this.client
-      .DELETE("/api/v1/providers/{providerId}", {
-        params: { path: { providerId } },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async importUsers(toImport: { file?: File; records?: object[] }) {
-    if (toImport.file) {
-      const { data, error } = await this.client.POST("/api/v1/user-imports/", {
-        body: {
-          file: toImport.file,
-        },
-        bodySerializer: (body: unknown) => {
-          const parsed = body as { file?: File } | undefined;
-          if (!parsed || !parsed.file) {
-            throw createError.BadRequest("File is missing!");
-          }
-          const formData = new FormData();
-          formData.set("file", parsed.file);
-          return formData;
-        },
-      });
-      return { data: data?.data, error };
-    }
-
-    return this.client
-      .POST("/api/v1/user-imports/", {
-        body: toImport.records,
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async downloadUsersCsvTemplate() {
-    return this.client
-      .GET("/api/v1/user-imports/template-download", {
-        parseAs: "blob",
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async getUsersImports(
-    pagination: { limit: number; offset: number } = { limit: 100, offset: 0 },
-  ) {
-    return this.client
-      .GET("/api/v1/user-imports/", {
-        params: {
-          query: {
-            limit: toStringOrUndefined(pagination?.limit),
-            offset: toStringOrUndefined(pagination?.offset),
-          },
-        },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async getUsersImport(importId: string, includeUsersData?: boolean) {
-    const includeImportedData =
-      typeof includeUsersData === "undefined"
-        ? undefined
-        : includeUsersData
-          ? "true"
-          : "false";
-    return this.client
-      .GET("/api/v1/user-imports/{importId}", {
-        params: {
-          path: { importId },
-          query: {
-            includeImportedData,
-          },
-        },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async getUsersForImport(importId: string, activeOnly: boolean) {
-    return this.client
-      .GET("/api/v1/users/", {
-        params: { query: { importId, activeOnly: String(activeOnly) } },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async getOrganisationsSettings(filter?: PaginationParams) {
-    return this.client
-      .GET("/api/v1/organisation-settings/", {
-        params: {
-          query: {
-            ...preparePaginationParams(filter),
-          },
-        },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async getOrganisationSettings(organisationSettingId: string) {
-    return this.client
-      .GET("/api/v1/organisation-settings/{organisationSettingId}", {
-        params: { path: { organisationSettingId } },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async updateOrganisationSettings(
-    organisationSettingId: string,
-    body: paths["/api/v1/organisation-settings/{organisationSettingId}"]["patch"]["requestBody"]["content"]["application/json"],
-  ) {
-    return this.client
-      .PATCH("/api/v1/organisation-settings/{organisationSettingId}", {
-        body,
-        params: { path: { organisationSettingId } },
+        // biome-ignore lint/suspicious/noExplicitAny: <explanation>
+        params: { path: { providerId }, query: { type: "email" } as any },
       })
       .then(
         (response) => formatResponse(response, this.serviceName, this.logger),
@@ -601,42 +361,6 @@ export class Messaging extends BaseClient<paths> {
       );
   }
 
-  async getUsers(
-    query?: paths["/api/v1/users/"]["get"]["parameters"]["query"],
-  ) {
-    return this.client
-      .GET("/api/v1/users/", {
-        params: {
-          query: { ...query, ...preparePaginationParams(query) },
-        },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
-  async getUser(
-    userId: paths["/api/v1/users/{userId}"]["get"]["parameters"]["path"]["userId"],
-    activeOnly: boolean,
-  ) {
-    return this.client
-      .GET("/api/v1/users/{userId}", {
-        params: {
-          path: {
-            userId,
-          },
-          query: {
-            activeOnly: toStringOrUndefined(activeOnly),
-          },
-        },
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
-  }
-
   async seeMessage(messageId: string) {
     return this.client
       .PUT("/api/v1/message-actions/{messageId}", {

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

@@ -18,6 +18,7 @@
   "paths": {
     "/api/v1/messages/": {
       "get": {
+        "operationId": "ListMessages",
         "tags": [
           "Messages"
         ],
@@ -351,6 +352,7 @@
         }
       },
       "post": {
+        "operationId": "CreateMessage",
         "tags": [
           "Messages"
         ],
@@ -686,6 +688,7 @@
     },
     "/api/v1/messages/{messageId}": {
       "get": {
+        "operationId": "GetMessage",
         "tags": [
           "Messages"
         ],
@@ -983,6 +986,7 @@
     },
     "/api/v1/providers/": {
       "get": {
+        "operationId": "ListProviders",
         "tags": [
           "Providers"
         ],
@@ -1007,8 +1011,8 @@
             "schema": {
               "type": "string",
               "enum": [
-                "sms",
-                "email"
+                "email",
+                "sms"
               ]
             },
             "in": "query",
@@ -1068,8 +1072,8 @@
                           "type": {
                             "type": "string",
                             "enum": [
-                              "sms",
-                              "email"
+                              "email",
+                              "sms"
                             ],
                             "description": "Provider types that can be manipulated"
                           }
@@ -1283,6 +1287,7 @@
         }
       },
       "post": {
+        "operationId": "CreateProvider",
         "tags": [
           "Providers"
         ],
@@ -1647,8 +1652,8 @@
             "schema": {
               "type": "string",
               "enum": [
-                "sms",
-                "email"
+                "email",
+                "sms"
               ]
             },
             "in": "query",
@@ -2007,6 +2012,7 @@
         }
       },
       "put": {
+        "operationId": "UpdateProvider",
         "tags": [
           "Providers"
         ],
@@ -2381,6 +2387,7 @@
         }
       },
       "delete": {
+        "operationId": "DeleteProvider",
         "tags": [
           "Providers"
         ],
@@ -2619,6 +2626,7 @@
     },
     "/api/v1/templates/": {
       "get": {
+        "operationId": "ListTemplates",
         "tags": [
           "Templates"
         ],
@@ -2897,6 +2905,7 @@
         }
       },
       "post": {
+        "operationId": "CreateTemplate",
         "tags": [
           "Templates"
         ],
@@ -3206,6 +3215,7 @@
     },
     "/api/v1/templates/{templateId}": {
       "get": {
+        "operationId": "GetTemplate",
         "tags": [
           "Templates"
         ],
@@ -3503,6 +3513,7 @@
         }
       },
       "put": {
+        "operationId": "UpdateTemplate",
         "tags": [
           "Templates"
         ],
@@ -3826,6 +3837,7 @@
         }
       },
       "delete": {
+        "operationId": "DeleteTemplate",
         "tags": [
           "Templates"
         ],
@@ -4180,8 +4192,8 @@
                             "items": {
                               "type": "string",
                               "enum": [
-                                "sms",
-                                "email"
+                                "email",
+                                "sms"
                               ],
                               "description": "Provider types that can be manipulated"
                             }
@@ -4726,8 +4738,8 @@
                           "items": {
                             "type": "string",
                             "enum": [
-                              "sms",
-                              "email"
+                              "email",
+                              "sms"
                             ],
                             "description": "Provider types that can be manipulated"
                           }
@@ -5194,8 +5206,8 @@
                     "items": {
                       "type": "string",
                       "enum": [
-                        "sms",
-                        "email"
+                        "email",
+                        "sms"
                       ],
                       "description": "Provider types that can be manipulated"
                     }
@@ -5306,8 +5318,8 @@
                           "items": {
                             "type": "string",
                             "enum": [
-                              "sms",
-                              "email"
+                              "email",
+                              "sms"
                             ],
                             "description": "Provider types that can be manipulated"
                           }
@@ -7204,8 +7216,8 @@
                             "items": {
                               "type": "string",
                               "enum": [
-                                "sms",
-                                "email"
+                                "email",
+                                "sms"
                               ],
                               "description": "Provider types that can be manipulated"
                             }
@@ -7769,8 +7781,8 @@
                           "items": {
                             "type": "string",
                             "enum": [
-                              "sms",
-                              "email"
+                              "email",
+                              "sms"
                             ],
                             "description": "Provider types that can be manipulated"
                           }