@liaisongroup/assist-api-js-client 1.5.77 → 1.5.79

package/dist/openapi.d.ts

@@ -1528,6 +1528,9 @@ declare namespace Components {
         export interface SimpleError {
             error: string;
         }
+        export interface SimpleErrors {
+            errors: string[];
+        }
         export interface SimpleTemplateName {
             /**
              * Key of the field which is used to determine name for instances which use this template.
@@ -2399,6 +2402,23 @@ declare namespace Paths {
             export type $422 = Components.Schemas.Errors;
         }
     }
+    namespace CreatePasswordReset {
+        export interface RequestBody {
+            email: string; // email
+            destination_url: string; // uri
+            client_id: string;
+            client_secret: string;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * A message indicating that the password reset email has been sent.
+                 */
+                message?: string;
+            }
+            export type $422 = Components.Schemas.SimpleErrors;
+        }
+    }
     namespace CreatePushSubscription {
         export interface RequestBody {
             data: {
@@ -3642,6 +3662,30 @@ declare namespace Paths {
             export type $404 = Components.Schemas.Errors;
         }
     }
+    namespace UpdatePasswordReset {
+        namespace Parameters {
+            export type Token = string; // uuid
+        }
+        export interface PathParameters {
+            token: Parameters.Token /* uuid */;
+        }
+        export interface RequestBody {
+            password: string;
+            password_confirmation: string;
+            client_id: string;
+            client_secret: string;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * A message indicating that the password has been reset.
+                 */
+                message?: string;
+            }
+            export type $410 = Components.Schemas.SimpleErrors;
+            export type $422 = Components.Schemas.SimpleErrors;
+        }
+    }
     namespace UpdateRole {
         namespace Parameters {
             export type Id = string; // uuid
@@ -3916,6 +3960,37 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ConsumeOidcResponse.Responses.$200>
+  /**
+   * create_password_reset - Create password reset
+   * 
+   * Start the password reset journey. by sending an email to the user with a link to reset their password.
+   * You must provide the user's email address, a destination URL, client ID and client secret.
+   * The destination URL is where the email link will send the user too in order to complete the password reset journey.
+   * The URL will have the token added as a query parameter (since it is needed in the next step of the journey).
+   * The token will expire after 6 hours.
+   * In order to not expose which email addresses are registered, we return a success status regardless of whether the user exists or not (and therefore if an email is sent or not).
+   * 
+   */
+  'create_password_reset'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreatePasswordReset.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreatePasswordReset.Responses.$200>
+  /**
+   * update_password_reset - Update password reset
+   * 
+   * Complete the password reset journey.
+   * You must provide the new password, password confirmation, client ID and client secret.
+   * The client ID and client secret are used to authenticate the request.
+   * The token is used to identify the user and the password reset request.
+   * The token will expire after 6 hours.
+   * 
+   */
+  'update_password_reset'(
+    parameters?: Parameters<Paths.UpdatePasswordReset.PathParameters> | null,
+    data?: Paths.UpdatePasswordReset.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdatePasswordReset.Responses.$200>
   /**
    * get_actions - Get actions
    */
@@ -4892,6 +4967,41 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ConsumeOidcResponse.Responses.$200>
   }
+  ['/password_resets']: {
+    /**
+     * create_password_reset - Create password reset
+     * 
+     * Start the password reset journey. by sending an email to the user with a link to reset their password.
+     * You must provide the user's email address, a destination URL, client ID and client secret.
+     * The destination URL is where the email link will send the user too in order to complete the password reset journey.
+     * The URL will have the token added as a query parameter (since it is needed in the next step of the journey).
+     * The token will expire after 6 hours.
+     * In order to not expose which email addresses are registered, we return a success status regardless of whether the user exists or not (and therefore if an email is sent or not).
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreatePasswordReset.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreatePasswordReset.Responses.$200>
+  }
+  ['/password_resets/{token}']: {
+    /**
+     * update_password_reset - Update password reset
+     * 
+     * Complete the password reset journey.
+     * You must provide the new password, password confirmation, client ID and client secret.
+     * The client ID and client secret are used to authenticate the request.
+     * The token is used to identify the user and the password reset request.
+     * The token will expire after 6 hours.
+     * 
+     */
+    'put'(
+      parameters?: Parameters<Paths.UpdatePasswordReset.PathParameters> | null,
+      data?: Paths.UpdatePasswordReset.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdatePasswordReset.Responses.$200>
+  }
   ['/actions']: {
     /**
      * get_actions - Get actions
@@ -6097,6 +6207,7 @@ export type SavedFilterRelationships = Components.Schemas.SavedFilterRelationshi
 export type SavedFilters = Components.Schemas.SavedFilters;
 export type SavedFiltersRelationship = Components.Schemas.SavedFiltersRelationship;
 export type SimpleError = Components.Schemas.SimpleError;
+export type SimpleErrors = Components.Schemas.SimpleErrors;
 export type SimpleTemplateName = Components.Schemas.SimpleTemplateName;
 export type StructuredValues = Components.Schemas.StructuredValues;
 export type Tag = Components.Schemas.Tag;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Liaison Assist API",
     "description": "![Hero](./hero.svg)\n",
-    "version": "0.0.306",
+    "version": "0.0.308",
     "license": {
       "name": "MIT",
       "url": "https://opensource.org/licenses/MIT"
@@ -155,6 +155,10 @@
     {
       "name": "XSLT Maps",
       "description": "XSLT Maps are used to transform HL7 messages into a more usable format.\nIn a usual implementation PAS systems at trusts send messages to us via a Mirth Connect instance.\nThis Mirth Connect instance listens for messages on a specific port, transforms them into an XML format and then sends them to Liaison Assist.\nIn order to make sense of the messages (which are just XML-ified HL7) we use XSLT maps.\nXSLT maps transform XML into a more usable format - allowing you to pluck certain content, concatinate content and so on.\nXSLT maps are used in HL7 actions: you create an action, tell is what type of messages to watch out for and which XSLT map to use to transform the attributes which a subsequent action (like a create / update case action) can use.\nSee [general XSLT documentation](https://developer.mozilla.org/en-US/docs/Web/XML/XSLT) for more information about using XSLT.\n"
+    },
+    {
+      "name": "Password Resets",
+      "description": "Password resets are used to reset a user's password.\nA password reset journey can be started with via the POST `/password_resets` endpoint.\nThe journey can be completed by sending a PUT request to `/password_resets/{token}`.\n"
     }
   ],
   "paths": {
@@ -843,6 +847,165 @@
         }
       }
     },
+    "/password_resets": {
+      "post": {
+        "operationId": "create_password_reset",
+        "summary": "Create password reset",
+        "description": "Start the password reset journey. by sending an email to the user with a link to reset their password.\nYou must provide the user's email address, a destination URL, client ID and client secret.\nThe destination URL is where the email link will send the user too in order to complete the password reset journey.\nThe URL will have the token added as a query parameter (since it is needed in the next step of the journey).\nThe token will expire after 6 hours.\nIn order to not expose which email addresses are registered, we return a success status regardless of whether the user exists or not (and therefore if an email is sent or not).\n",
+        "tags": [
+          "Password Resets"
+        ],
+        "security": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "email",
+                  "destination_url",
+                  "client_id",
+                  "client_secret"
+                ],
+                "properties": {
+                  "email": {
+                    "type": "string",
+                    "format": "email"
+                  },
+                  "destination_url": {
+                    "type": "string",
+                    "format": "uri"
+                  },
+                  "client_id": {
+                    "type": "string"
+                  },
+                  "client_secret": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "description": "A message indicating that the password reset email has been sent."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Unprocessable Entity",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SimpleErrors"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/password_resets/{token}": {
+      "put": {
+        "operationId": "update_password_reset",
+        "summary": "Update password reset",
+        "description": "Complete the password reset journey.\nYou must provide the new password, password confirmation, client ID and client secret.\nThe client ID and client secret are used to authenticate the request.\nThe token is used to identify the user and the password reset request.\nThe token will expire after 6 hours.\n",
+        "tags": [
+          "Password Resets"
+        ],
+        "security": [],
+        "parameters": [
+          {
+            "name": "token",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "password",
+                  "password_confirmation",
+                  "client_id",
+                  "client_secret"
+                ],
+                "properties": {
+                  "password": {
+                    "type": "string"
+                  },
+                  "password_confirmation": {
+                    "type": "string"
+                  },
+                  "client_id": {
+                    "type": "string"
+                  },
+                  "client_secret": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "description": "A message indicating that the password has been reset."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "410": {
+            "description": "Gone",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SimpleErrors"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Unprocessable Entity",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SimpleErrors"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/actions": {
       "get": {
         "operationId": "get_actions",
@@ -14661,6 +14824,20 @@
           }
         }
       },
+      "SimpleErrors": {
+        "type": "object",
+        "required": [
+          "errors"
+        ],
+        "properties": {
+          "errors": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        }
+      },
       "Errors": {
         "type": "object",
         "additionalProperties": false,