@ogcio/building-blocks-sdk 0.1.18 → 0.2.1

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

@@ -349,6 +349,23 @@ export class Payments extends BaseClient<paths> {
       );
   }
 
+  async cancelPayment(
+    transactionId: paths["/api/v1/transactions/{transactionId}/cancel-payment"]["post"]["parameters"]["path"]["transactionId"],
+  ) {
+    return this.client
+      .POST("/api/v1/transactions/{transactionId}/cancel-payment", {
+        params: {
+          path: {
+            transactionId,
+          },
+        },
+      })
+      .then(
+        (response) => formatResponse(response, this.serviceName, this.logger),
+        (reason) => formatError(reason, this.serviceName, this.logger),
+      );
+  }
+
   /**
    * Citizen
    */

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

@@ -3413,11 +3413,29 @@
                                   "cancelled"
                                 ]
                               },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "cancellation_requested"
+                                ]
+                              },
                               {
                                 "type": "string",
                                 "enum": [
                                   "failed"
                                 ]
+                              },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "refunded"
+                                ]
+                              },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "refund_failed"
+                                ]
                               }
                             ]
                           },
@@ -3662,11 +3680,29 @@
                                 "cancelled"
                               ]
                             },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "cancellation_requested"
+                              ]
+                            },
                             {
                               "type": "string",
                               "enum": [
                                 "failed"
                               ]
+                            },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "refunded"
+                              ]
+                            },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "refund_failed"
+                              ]
                             }
                           ]
                         },
@@ -3920,11 +3956,29 @@
                           "cancelled"
                         ]
                       },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "cancellation_requested"
+                        ]
+                      },
                       {
                         "type": "string",
                         "enum": [
                           "failed"
                         ]
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "refunded"
+                        ]
+                      },
+                      {
+                        "type": "string",
+                        "enum": [
+                          "refund_failed"
+                        ]
                       }
                     ]
                   }
@@ -4224,11 +4278,29 @@
                                   "cancelled"
                                 ]
                               },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "cancellation_requested"
+                                ]
+                              },
                               {
                                 "type": "string",
                                 "enum": [
                                   "failed"
                                 ]
+                              },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "refunded"
+                                ]
+                              },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "refund_failed"
+                                ]
                               }
                             ]
                           },
@@ -5104,11 +5176,29 @@
                                 "cancelled"
                               ]
                             },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "cancellation_requested"
+                              ]
+                            },
                             {
                               "type": "string",
                               "enum": [
                                 "failed"
                               ]
+                            },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "refunded"
+                              ]
+                            },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "refund_failed"
+                              ]
                             }
                           ]
                         },
@@ -5964,6 +6054,194 @@
         }
       }
     },
+    "/api/v1/transactions/{transactionId}/cancel-payment": {
+      "post": {
+        "parameters": [
+          {
+            "schema": {
+              "type": "string"
+            },
+            "in": "path",
+            "name": "transactionId",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Default Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "data": {
+                      "type": "object",
+                      "properties": {
+                        "success": {
+                          "type": "boolean"
+                        }
+                      },
+                      "required": [
+                        "success"
+                      ]
+                    },
+                    "metadata": {
+                      "type": "object",
+                      "properties": {
+                        "links": {
+                          "description": "Object containing the links to the related endpoints",
+                          "type": "object",
+                          "properties": {
+                            "self": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "description": "URL pointing to the request itself",
+                                  "type": "string"
+                                }
+                              }
+                            },
+                            "next": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
+                                  "type": "string"
+                                }
+                              }
+                            },
+                            "prev": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
+                                  "type": "string"
+                                }
+                              }
+                            },
+                            "first": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "description": "URL pointing to the first page of results in a paginated response",
+                                  "type": "string"
+                                }
+                              }
+                            },
+                            "last": {
+                              "type": "object",
+                              "properties": {
+                                "href": {
+                                  "description": "URL pointing to the first page of results in a paginated response",
+                                  "type": "string"
+                                }
+                              }
+                            },
+                            "pages": {
+                              "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
+                              "type": "object",
+                              "additionalProperties": {
+                                "type": "object",
+                                "properties": {
+                                  "href": {
+                                    "type": "string"
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "required": [
+                            "self",
+                            "first",
+                            "last",
+                            "pages"
+                          ]
+                        },
+                        "totalCount": {
+                          "description": "Number representing the total number of available items",
+                          "type": "number"
+                        }
+                      }
+                    }
+                  },
+                  "required": [
+                    "data"
+                  ]
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Default Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "code": {
+                      "type": "string"
+                    },
+                    "detail": {
+                      "type": "string"
+                    },
+                    "requestId": {
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "validation": {},
+                    "validationContext": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "code",
+                    "detail",
+                    "requestId",
+                    "name"
+                  ]
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Default Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "code": {
+                      "type": "string"
+                    },
+                    "detail": {
+                      "type": "string"
+                    },
+                    "requestId": {
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "validation": {},
+                    "validationContext": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "code",
+                    "detail",
+                    "requestId",
+                    "name"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/api/v1/citizen/transactions": {
       "get": {
         "tags": [
@@ -6035,11 +6313,29 @@
                                   "cancelled"
                                 ]
                               },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "cancellation_requested"
+                                ]
+                              },
                               {
                                 "type": "string",
                                 "enum": [
                                   "failed"
                                 ]
+                              },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "refunded"
+                                ]
+                              },
+                              {
+                                "type": "string",
+                                "enum": [
+                                  "refund_failed"
+                                ]
                               }
                             ]
                           },
@@ -6314,11 +6610,29 @@
                                 "cancelled"
                               ]
                             },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "cancellation_requested"
+                              ]
+                            },
                             {
                               "type": "string",
                               "enum": [
                                 "failed"
                               ]
+                            },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "refunded"
+                              ]
+                            },
+                            {
+                              "type": "string",
+                              "enum": [
+                                "refund_failed"
+                              ]
                             }
                           ]
                         },

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

@@ -1349,7 +1349,7 @@ export interface paths {
                         "application/json": {
                             data: {
                                 transactionId: string;
-                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
+                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
                                 amount: number;
                                 extPaymentId: string;
                                 paymentProviderId: string;
@@ -1461,7 +1461,7 @@ export interface paths {
                         "application/json": {
                             data: {
                                 transactionId: string;
-                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
+                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
                                 amount: number;
                                 extPaymentId: string;
                                 paymentProviderId: string;
@@ -1555,7 +1555,7 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
-                        status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
+                        status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
                     };
                 };
             };
@@ -1707,7 +1707,7 @@ export interface paths {
                         "application/json": {
                             data: {
                                 transactionId: string;
-                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
+                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
                                 amount: number;
                                 extPaymentId: string;
                                 paymentProviderId: string;
@@ -2126,7 +2126,7 @@ export interface paths {
                                 extReferenceCode: string;
                                 paymentMethod: string;
                                 paymentProviderName: string;
-                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
+                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
                                 createdAt: string;
                                 updatedAt: string;
                             };
@@ -2529,6 +2529,112 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/transactions/{transactionId}/cancel-payment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: {
+            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: {
+                                success: boolean;
+                            };
+                            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;
@@ -2557,7 +2663,7 @@ export interface paths {
                         "application/json": {
                             data: {
                                 transactionId: string;
-                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
+                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
                                 title: string;
                                 updatedAt: string;
                                 extPaymentId: string;
@@ -2684,7 +2790,7 @@ export interface paths {
                         "application/json": {
                             data: {
                                 transactionId: string;
-                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "failed";
+                                status: "initiated" | "pending" | "succeeded" | "cancelled" | "cancellation_requested" | "failed" | "refunded" | "refund_failed";
                                 amount: number;
                                 extPaymentId: string;
                                 paymentProviderId: string;