@ogcio/building-blocks-sdk 0.1.17 → 0.2.0

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

@@ -1238,7 +1238,7 @@ export interface paths {
                     content: {
                         "application/json": {
                             data: {
-                                amount?: number;
+                                amount?: string;
                                 runId: string;
                                 journeyId: string;
                                 redirectUrl: string;
@@ -1473,6 +1473,7 @@ export interface paths {
                                     journeyId?: string;
                                     journeyTitle?: string;
                                     redirectUrl?: string;
+                                    amount?: string;
                                 };
                                 description: string;
                                 providerName: string;
@@ -1718,6 +1719,7 @@ export interface paths {
                                     journeyId?: string;
                                     journeyTitle?: string;
                                     redirectUrl?: string;
+                                    amount?: string;
                                 };
                                 description: string;
                                 providerName: string;
@@ -1831,7 +1833,9 @@ export interface paths {
                             journeyId?: string;
                             journeyTitle?: string;
                             redirectUrl?: string;
+                            amount?: string;
                         };
+                        token?: string;
                     };
                 };
             };
@@ -2294,6 +2298,237 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/transactions/{transactionId}/refund": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    transactionId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                id: string;
+                                transactionId: string;
+                                amount: number;
+                                status: "pending" | "succeeded" | "failed" | "requires_action" | "canceled";
+                                type: "full" | "partial";
+                                reason: string;
+                                notes?: string;
+                                createdAt: string;
+                                updatedAt: string;
+                                username: string;
+                                email: string;
+                                organizationId: 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 */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: unknown;
+                            validationContext?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: unknown;
+                            validationContext?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: unknown;
+                            validationContext?: string;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    transactionId: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        amount: number;
+                        reason: string;
+                        notes?: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Default Response */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                status: 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 */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: unknown;
+                            validationContext?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: unknown;
+                            validationContext?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/citizen/transactions": {
         parameters: {
             query?: never;
@@ -2461,6 +2696,7 @@ export interface paths {
                                     journeyId?: string;
                                     journeyTitle?: string;
                                     redirectUrl?: string;
+                                    amount?: string;
                                 };
                                 description: string;
                                 providerName: string;
@@ -2542,6 +2778,8 @@ export interface paths {
                     amount: string;
                     intentId: string;
                     providerId: string;
+                    paymentRequestId: string;
+                    token?: string;
                 };
                 header?: never;
                 path?: never;
@@ -3125,6 +3363,7 @@ export interface paths {
                     "application/json": {
                         paymentRequestId: string;
                         amount: number;
+                        token?: string;
                     };
                 };
             };
@@ -3177,6 +3416,22 @@ export interface paths {
                     };
                 };
                 /** @description Default Response */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            code: string;
+                            detail: string;
+                            requestId: string;
+                            name: string;
+                            validation?: unknown;
+                            validationContext?: string;
+                        };
+                    };
+                };
+                /** @description Default Response */
                 401: {
                     headers: {
                         [name: string]: unknown;

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

@@ -1,24 +1,25 @@
+import createError from "http-errors";
 import type createClient from "openapi-fetch";
 import { PROFILE } from "../../../types/index.js";
 import { BaseClient } from "../../base-client.js";
 import { formatError, formatResponse } from "../../utils/client-utils.js";
 import type { paths } from "./schema.js";
-
 export class Profile extends BaseClient<paths> {
   protected declare client: ReturnType<typeof createClient<paths>>;
   protected serviceName = PROFILE;
 
-  async getAddresses() {
-    return this.client.GET("/api/v1/addresses/").then(
-      (response) => formatResponse(response, this.serviceName, this.logger),
-      (reason) => formatError(reason, this.serviceName, this.logger),
-    );
+  /**
+   * @deprecated Use getProfile() instead of getUser()
+   */
+  async getUser(profileId: string) {
+    console.warn("Warning: getUser() is deprecated. Use getProfile() instead.");
+    return this.getProfile(profileId);
   }
 
-  async getAddress(addressId: string) {
+  async getProfile(profileId: string) {
     return this.client
-      .GET("/api/v1/addresses/{addressId}", {
-        params: { path: { addressId } },
+      .GET("/api/v1/profiles/{profileId}", {
+        params: { path: { profileId } },
       })
       .then(
         (response) => formatResponse(response, this.serviceName, this.logger),
@@ -26,31 +27,27 @@ export class Profile extends BaseClient<paths> {
       );
   }
 
-  async createAddress(
-    data: paths["/api/v1/addresses/"]["post"]["requestBody"]["content"]["application/json"],
+  /**
+   * @deprecated Use getProfile() instead of getUser()
+   */
+  async createUser(
+    data: NonNullable<
+      paths["/api/v1/profiles/import-profiles"]["post"]["requestBody"]
+    >["content"]["application/json"],
   ) {
-    return this.client
-      .POST("/api/v1/addresses/", {
-        body: data,
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
+    console.warn(
+      "Warning: createUser() is deprecated. Use createProfile() instead.",
+    );
+    return this.createProfile(data);
   }
 
-  async patchAddress(
-    addressId: string,
+  async createProfile(
     data: NonNullable<
-      paths["/api/v1/addresses/{addressId}"]["patch"]["requestBody"]
+      paths["/api/v1/profiles/import-profiles"]["post"]["requestBody"]
     >["content"]["application/json"],
   ) {
-    if (!data || Object.keys(data).length === 0) {
-      return;
-    }
     return this.client
-      .PATCH("/api/v1/addresses/{addressId}", {
-        params: { path: { addressId } },
+      .POST("/api/v1/profiles/import-profiles", {
         body: data,
       })
       .then(
@@ -59,25 +56,33 @@ export class Profile extends BaseClient<paths> {
       );
   }
 
-  async updateAddress(
-    addressId: string,
-    data: paths["/api/v1/addresses/{addressId}"]["put"]["requestBody"]["content"]["application/json"],
+  /**
+   * @deprecated Use getProfile() instead of getUser()
+   */
+  async updateUser(
+    profileId: string,
+    data: NonNullable<
+      paths["/api/v1/profiles/{profileId}"]["put"]["requestBody"]
+    >["content"]["application/json"],
+    organizationId?: string,
   ) {
-    return this.client
-      .PUT("/api/v1/addresses/{addressId}", {
-        params: { path: { addressId } },
-        body: data,
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
+    console.warn(
+      "Warning: updateUser() is deprecated. Use updateProfile() instead.",
+    );
+    return this.updateProfile(profileId, data, organizationId);
   }
 
-  async deleteAddress(addressId: string) {
+  async updateProfile(
+    profileId: string,
+    data: NonNullable<
+      paths["/api/v1/profiles/{profileId}"]["put"]["requestBody"]
+    >["content"]["application/json"],
+    organizationId?: string,
+  ) {
     return this.client
-      .DELETE("/api/v1/addresses/{addressId}", {
-        params: { path: { addressId } },
+      .PUT("/api/v1/profiles/{profileId}", {
+        params: { path: { profileId }, query: { organizationId } },
+        body: data,
       })
       .then(
         (response) => formatResponse(response, this.serviceName, this.logger),
@@ -85,17 +90,36 @@ export class Profile extends BaseClient<paths> {
       );
   }
 
-  async getEntitlements() {
-    return this.client.GET("/api/v1/entitlements/").then(
-      (response) => formatResponse(response, this.serviceName, this.logger),
-      (reason) => formatError(reason, this.serviceName, this.logger),
+  /**
+   * @deprecated Use getProfile() instead of getUser()
+   */
+  async patchUser(
+    profileId: string,
+    data: NonNullable<
+      paths["/api/v1/profiles/{profileId}"]["put"]["requestBody"]
+    >["content"]["application/json"],
+    organizationId?: string,
+  ) {
+    console.warn(
+      "Warning: patchUser() is deprecated. Use patchProfile() instead.",
     );
+    return this.patchProfile(profileId, data, organizationId);
   }
 
-  async getUser(userId: string) {
+  async patchProfile(
+    profileId: string,
+    data?: NonNullable<
+      paths["/api/v1/profiles/{profileId}"]["patch"]["requestBody"]
+    >["content"]["application/json"],
+    organizationId?: string,
+  ) {
+    if (!data || Object.keys(data).length === 0) {
+      return;
+    }
     return this.client
-      .GET("/api/v1/users/{userId}", {
-        params: { path: { userId } },
+      .PATCH("/api/v1/profiles/{profileId}", {
+        params: { path: { profileId }, query: { organizationId } },
+        body: data,
       })
       .then(
         (response) => formatResponse(response, this.serviceName, this.logger),
@@ -103,27 +127,26 @@ export class Profile extends BaseClient<paths> {
       );
   }
 
-  async createUser(
-    data: paths["/api/v1/users/"]["post"]["requestBody"]["content"]["application/json"],
+  /**
+   * @deprecated Use getProfile() instead of getUser()
+   */
+  async findUser(
+    query: paths["/api/v1/profiles/find-profile"]["get"]["parameters"]["query"],
   ) {
-    return this.client
-      .POST("/api/v1/users/", {
-        body: data,
-      })
-      .then(
-        (response) => formatResponse(response, this.serviceName, this.logger),
-        (reason) => formatError(reason, this.serviceName, this.logger),
-      );
+    console.warn(
+      "Warning: findUser() is deprecated. Use findProfile() instead.",
+    );
+    return this.findProfile(query);
   }
 
-  async updateUser(
-    userId: string,
-    data: paths["/api/v1/users/{userId}"]["put"]["requestBody"]["content"]["application/json"],
+  async findProfile(
+    query: paths["/api/v1/profiles/find-profile"]["get"]["parameters"]["query"],
   ) {
     return this.client
-      .PUT("/api/v1/users/{userId}", {
-        params: { path: { userId } },
-        body: data,
+      .GET("/api/v1/profiles/find-profile", {
+        params: {
+          query,
+        },
       })
       .then(
         (response) => formatResponse(response, this.serviceName, this.logger),
@@ -131,19 +154,28 @@ export class Profile extends BaseClient<paths> {
       );
   }
 
-  async patchUser(
-    userId: string,
-    data?: NonNullable<
-      paths["/api/v1/users/{userId}"]["patch"]["requestBody"]
-    >["content"]["application/json"],
+  /**
+   * @deprecated Use getProfile() instead of getUser()
+   */
+  async selectUsers(
+    ids: paths["/api/v1/profiles/select-profiles"]["get"]["parameters"]["query"]["ids"],
+  ) {
+    console.warn(
+      "Warning: selectUsers() is deprecated. Use selectProfiles() instead.",
+    );
+    return this.selectProfiles(ids);
+  }
+
+  async selectProfiles(
+    ids: paths["/api/v1/profiles/select-profiles"]["get"]["parameters"]["query"]["ids"],
   ) {
-    if (!data || Object.keys(data).length === 0) {
-      return;
-    }
     return this.client
-      .PATCH("/api/v1/users/{userId}", {
-        params: { path: { userId } },
-        body: data,
+      .GET("/api/v1/profiles/select-profiles", {
+        params: {
+          query: {
+            ids,
+          },
+        },
       })
       .then(
         (response) => formatResponse(response, this.serviceName, this.logger),
@@ -151,11 +183,11 @@ export class Profile extends BaseClient<paths> {
       );
   }
 
-  async findUser(
-    query: paths["/api/v1/users/find"]["get"]["parameters"]["query"],
+  async listProfiles(
+    query: paths["/api/v1/profiles/"]["get"]["parameters"]["query"],
   ) {
     return this.client
-      .GET("/api/v1/users/find", {
+      .GET("/api/v1/profiles/", {
         params: {
           query,
         },
@@ -166,12 +198,36 @@ export class Profile extends BaseClient<paths> {
       );
   }
 
-  async selectUsers(
-    ids: paths["/api/v1/users/select"]["post"]["requestBody"]["content"]["application/json"]["ids"],
-  ) {
+  async importProfiles(toImport: {
+    file?: File;
+    records?: NonNullable<
+      paths["/api/v1/profiles/import-profiles"]["post"]["requestBody"]
+    >["content"]["application/json"]["profiles"];
+  }) {
+    if (toImport.file) {
+      const { data, error } = await this.client.POST(
+        "/api/v1/profiles/import-profiles",
+        {
+          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, error };
+    }
+
     return this.client
-      .POST("/api/v1/users/select", {
-        body: { ids },
+      .POST("/api/v1/profiles/import-profiles", {
+        body: { profiles: toImport.records },
       })
       .then(
         (response) => formatResponse(response, this.serviceName, this.logger),