@liaisongroup/assist-api-js-client 1.5.63 → 1.5.65

package/dist/openapi.d.ts

@@ -28,6 +28,36 @@ declare namespace Components {
             attributes: ActionAttributes;
             relationships: ActionRelationships;
         }
+        export interface ActionError {
+            data: ActionErrorData;
+            links: Links;
+            included?: ActionErrorInclusions;
+        }
+        export interface ActionErrorAttributes {
+            error?: string;
+            arguments?: {
+                [key: string]: any;
+            };
+            backtrace?: string[];
+            created_at?: string; // date-time
+            updated_at?: string; // date-time
+        }
+        export interface ActionErrorData {
+            type: "action_error";
+            id: string; // uuid
+            attributes: ActionErrorAttributes;
+            relationships?: ActionErrorRelationships;
+        }
+        export type ActionErrorInclusions = (ActionInclusion)[];
+        export interface ActionErrorRelationships {
+            action?: ActionRelationshipTrigger;
+        }
+        export interface ActionErrors {
+            data: ActionErrorData[];
+            meta: Meta;
+            links: Links;
+            included?: ActionErrorInclusions;
+        }
         export interface ActionInclusion {
             type: "action";
             id: string; // uuid
@@ -226,7 +256,7 @@ declare namespace Components {
                 id?: string; // uuid
             }[];
         }
-        export type ChannelList = "ActionsChannel" | "CasesChannel" | "CaseActivityLogsChannel" | "FieldSettingsChannel" | "FieldsChannel" | "ListSavedFiltersChannel" | "ListsChannel" | "NotesChannel" | "RolesChannel" | "SavedFiltersChannel" | "SsoConfigsChannel" | "TagsChannel" | "TasksChannel" | "TeamMembersChannel" | "TeamsChannel" | "TemplatesChannel" | "UsersChannel";
+        export type ChannelList = "ActionErrorsChannel" | "ActionsChannel" | "CaseActivityLogsChannel" | "CasesChannel" | "FieldSettingsChannel" | "FieldsChannel" | "ListSavedFiltersChannel" | "ListsChannel" | "NotesChannel" | "RolesChannel" | "SavedFiltersChannel" | "SsoConfigsChannel" | "TagsChannel" | "TasksChannel" | "TeamMembersChannel" | "TeamsChannel" | "TemplatesChannel" | "UsersChannel";
         export interface Config {
             data: ConfigData;
             links: Links;
@@ -827,6 +857,19 @@ declare namespace Components {
                 }[];
             };
         }
+        export interface InterpolatedTemplateName {
+            /**
+             * When a template calls for a more complex name you can use an interpolated name.
+             * The interpolated name is a string which contains the keys of the fields which are used to determine the name.
+             * The keys are surrounded by curly braces.
+             * For example: "{id} {values/given_name} {values/surname}"
+             * The interpolated values are looked up in the case or task values and the values are used to replace the keys.
+             * If the interpolated value is not found in the case or task values then it is left blank.
+             * If the interpolated values begins with "values/" then the value is looked up in the case or task values, otherwise it is looked up in the case or task itself.
+             *
+             */
+            interpolated_name?: string;
+        }
         export type KnownConfigIDs = "action_resources" | "admin_resources" | "db_reset" | "field_resources" | "field_setting_restriction_constraints" | "field_setting_restriction_operators" | "hide_tasks" | "hl7_message_lifespan" | "password_regex" | "password_regex_message" | "role_resources" | "skip_rack_attack" | "task_delete_reasons";
         export interface Links {
             self?: string;
@@ -1485,6 +1528,12 @@ declare namespace Components {
         export interface SimpleError {
             error: string;
         }
+        export interface SimpleTemplateName {
+            /**
+             * Key of the field which is used to determine name for instances which use this template.
+             */
+            key?: string;
+        }
         export type StructuredValues = {
             field_key?: string;
             field_type?: "string" | "integer" | "boolean" | "date" | "time" | "datetime" | "float" | "resource" | "composite";
@@ -1825,12 +1874,7 @@ declare namespace Components {
              */
             active?: boolean;
             schema?: {
-                name?: {
-                    /**
-                     * Key of the field which is used to determine name for instances which use this template.
-                     */
-                    key?: string;
-                };
+                name?: null | SimpleTemplateName | InterpolatedTemplateName;
             };
             created_at?: string; // date-time
             updated_at?: string; // date-time
@@ -1847,12 +1891,7 @@ declare namespace Components {
                  */
                 export type Name = string;
                 export interface Schema {
-                    name?: {
-                        /**
-                         * Key of the field which is used to determine name for instances which use this template.
-                         */
-                        key?: string;
-                    };
+                    name?: null | SimpleTemplateName | InterpolatedTemplateName;
                 }
                 /**
                  * Which type of resource should this template be able to be applied to.
@@ -2520,6 +2559,21 @@ declare namespace Paths {
             export type $404 = Components.Schemas.Errors;
         }
     }
+    namespace DeleteActionError {
+        namespace Parameters {
+            export type Id = string; // uuid
+        }
+        export interface PathParameters {
+            id: Parameters.Id /* uuid */;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+            export type $404 = Components.Schemas.Errors;
+        }
+    }
     namespace DeleteCase {
         namespace Parameters {
             export type Id = string; // uuid
@@ -2833,6 +2887,27 @@ declare namespace Paths {
             export type $404 = Components.Schemas.Errors;
         }
     }
+    namespace GetActionError {
+        namespace Parameters {
+            export type Id = string; // uuid
+        }
+        export interface PathParameters {
+            id: Parameters.Id /* uuid */;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.ActionError;
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+            export type $404 = Components.Schemas.Errors;
+        }
+    }
+    namespace GetActionErrors {
+        namespace Responses {
+            export type $200 = Components.Schemas.ActionErrors;
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+        }
+    }
     namespace GetActionType {
         namespace Parameters {
             export type Id = string;
@@ -3871,6 +3946,30 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteAction.Responses.$204>
+  /**
+   * get_action_errors - Get action errors
+   */
+  'get_action_errors'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetActionErrors.Responses.$200>
+  /**
+   * get_action_error - Get action error
+   */
+  'get_action_error'(
+    parameters?: Parameters<Paths.GetActionError.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetActionError.Responses.$200>
+  /**
+   * delete_action_error - Delete action error
+   */
+  'delete_action_error'(
+    parameters?: Parameters<Paths.DeleteActionError.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteActionError.Responses.$204>
   /**
    * get_action_types - Get action types
    */
@@ -4827,6 +4926,34 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteAction.Responses.$204>
   }
+  ['/action_errors']: {
+    /**
+     * get_action_errors - Get action errors
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetActionErrors.Responses.$200>
+  }
+  ['/action_errors/{id}']: {
+    /**
+     * get_action_error - Get action error
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetActionError.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetActionError.Responses.$200>
+    /**
+     * delete_action_error - Delete action error
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteActionError.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteActionError.Responses.$204>
+  }
   ['/action_types']: {
     /**
      * get_action_types - Get action types
@@ -5767,6 +5894,12 @@ export type AccessToken = Components.Schemas.AccessToken;
 export type Action = Components.Schemas.Action;
 export type ActionAttributes = Components.Schemas.ActionAttributes;
 export type ActionData = Components.Schemas.ActionData;
+export type ActionError = Components.Schemas.ActionError;
+export type ActionErrorAttributes = Components.Schemas.ActionErrorAttributes;
+export type ActionErrorData = Components.Schemas.ActionErrorData;
+export type ActionErrorInclusions = Components.Schemas.ActionErrorInclusions;
+export type ActionErrorRelationships = Components.Schemas.ActionErrorRelationships;
+export type ActionErrors = Components.Schemas.ActionErrors;
 export type ActionInclusion = Components.Schemas.ActionInclusion;
 export type ActionInclusions = Components.Schemas.ActionInclusions;
 export type ActionRelationshipTrigger = Components.Schemas.ActionRelationshipTrigger;
@@ -5846,6 +5979,7 @@ export type HL7MessageUpdateAttributes = Components.Schemas.HL7MessageUpdateAttr
 export type HL7Messages = Components.Schemas.HL7Messages;
 export type IdAttribute = Components.Schemas.IdAttribute;
 export type InternalEventAction = Components.Schemas.InternalEventAction;
+export type InterpolatedTemplateName = Components.Schemas.InterpolatedTemplateName;
 export type KnownConfigIDs = Components.Schemas.KnownConfigIDs;
 export type Links = Components.Schemas.Links;
 export type List = Components.Schemas.List;
@@ -5953,6 +6087,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 SimpleTemplateName = Components.Schemas.SimpleTemplateName;
 export type StructuredValues = Components.Schemas.StructuredValues;
 export type Tag = Components.Schemas.Tag;
 export type TagAttributes = Components.Schemas.TagAttributes;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Liaison Assist API",
     "description": "![Hero](./hero.svg)\n",
-    "version": "0.0.292",
+    "version": "0.0.294",
     "license": {
       "name": "MIT",
       "url": "https://opensource.org/licenses/MIT"
@@ -49,7 +49,12 @@
       "description": "In `/schemas/Components/ChannelList` you can find a list of channels that are available for the websocket connection.\nThese channels are used to inform subscribers about changed to the resource type that the channel represents.\nDue to the complexity of permissions we currently only inform subscribers about the type of change and the ID of the changed item - it is then up to the subscribed if they want to make a fetch request to gain additional information (if they are permitted to).\nThe format of the messages in these channels is documents in `/schemas/Components/BroadcastEvent`\n\nThere is also a `UserSpecificChannel` which is used to send notifications to specific users when we are able.\nThe format of the messages in this channel is documented in `/schemas/Components/BroadcastToEvent`.\nTo receive these notifications for a user you should subscribe to `user_specific:<user_id>` channel.\n"
     },
     {
-      "name": "Actions"
+      "name": "Actions",
+      "description": "Actions are used to perform actions on resources.\nThey can be triggered by other actions or by the internal events (like a resource being created or updated) or by\nevents like a HL7 message being received.\n"
+    },
+    {
+      "name": "Action Errors",
+      "description": "Action errors are used to store information about errors that occurred when performing an action.\nThey can be useful for administrators to triage issues with actions.\n"
     },
     {
       "name": "Action Types",
@@ -1201,6 +1206,186 @@
         }
       }
     },
+    "/action_errors": {
+      "get": {
+        "operationId": "get_action_errors",
+        "summary": "Get action errors",
+        "tags": [
+          "Action Errors"
+        ],
+        "security": [
+          {
+            "bearerAuth": []
+          },
+          {
+            "cookieAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ActionErrors"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/action_errors/{id}": {
+      "get": {
+        "operationId": "get_action_error",
+        "summary": "Get action error",
+        "tags": [
+          "Action Errors"
+        ],
+        "security": [
+          {
+            "bearerAuth": []
+          },
+          {
+            "cookieAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ActionError"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "operationId": "delete_action_error",
+        "summary": "Delete action error",
+        "tags": [
+          "Action Errors"
+        ],
+        "security": [
+          {
+            "bearerAuth": []
+          },
+          {
+            "cookieAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No Content"
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/action_types": {
       "get": {
         "operationId": "get_action_types",
@@ -8686,6 +8871,121 @@
           }
         }
       },
+      "ActionError": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "data",
+          "links"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/ActionErrorData"
+          },
+          "links": {
+            "$ref": "#/components/schemas/Links"
+          },
+          "included": {
+            "$ref": "#/components/schemas/ActionErrorInclusions"
+          }
+        }
+      },
+      "ActionErrors": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "data",
+          "meta",
+          "links"
+        ],
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ActionErrorData"
+            }
+          },
+          "meta": {
+            "$ref": "#/components/schemas/Meta"
+          },
+          "links": {
+            "$ref": "#/components/schemas/Links"
+          },
+          "included": {
+            "$ref": "#/components/schemas/ActionErrorInclusions"
+          }
+        }
+      },
+      "ActionErrorData": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "id",
+          "attributes"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "action_error"
+            ]
+          },
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "attributes": {
+            "$ref": "#/components/schemas/ActionErrorAttributes"
+          },
+          "relationships": {
+            "$ref": "#/components/schemas/ActionErrorRelationships"
+          }
+        }
+      },
+      "ActionErrorAttributes": {
+        "type": "object",
+        "properties": {
+          "error": {
+            "type": "string"
+          },
+          "arguments": {
+            "type": "object"
+          },
+          "backtrace": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
+          }
+        }
+      },
+      "ActionErrorRelationships": {
+        "type": "object",
+        "properties": {
+          "action": {
+            "$ref": "#/components/schemas/ActionRelationshipTrigger"
+          }
+        }
+      },
+      "ActionErrorInclusions": {
+        "type": "array",
+        "items": {
+          "oneOf": [
+            {
+              "$ref": "#/components/schemas/ActionInclusion"
+            }
+          ]
+        }
+      },
       "ActionTypeAttributes": {
         "type": "object",
         "properties": {
@@ -13287,14 +13587,17 @@
             "additionalProperties": false,
             "properties": {
               "name": {
-                "type": "object",
-                "additionalProperties": false,
-                "properties": {
-                  "key": {
-                    "type": "string",
-                    "description": "Key of the field which is used to determine name for instances which use this template."
+                "oneOf": [
+                  {
+                    "type": "null"
+                  },
+                  {
+                    "$ref": "#/components/schemas/SimpleTemplateName"
+                  },
+                  {
+                    "$ref": "#/components/schemas/InterpolatedTemplateName"
                   }
-                }
+                ]
               }
             }
           },
@@ -14223,9 +14526,10 @@
       "ChannelList": {
         "type": "string",
         "enum": [
+          "ActionErrorsChannel",
           "ActionsChannel",
-          "CasesChannel",
           "CaseActivityLogsChannel",
+          "CasesChannel",
           "FieldSettingsChannel",
           "FieldsChannel",
           "ListSavedFiltersChannel",
@@ -15069,6 +15373,26 @@
             "$ref": "#/components/schemas/Links"
           }
         }
+      },
+      "SimpleTemplateName": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Key of the field which is used to determine name for instances which use this template."
+          }
+        }
+      },
+      "InterpolatedTemplateName": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "interpolated_name": {
+            "type": "string",
+            "description": "When a template calls for a more complex name you can use an interpolated name.\nThe interpolated name is a string which contains the keys of the fields which are used to determine the name.\nThe keys are surrounded by curly braces.\nFor example: \"{id} {values/given_name} {values/surname}\"\nThe interpolated values are looked up in the case or task values and the values are used to replace the keys.\nIf the interpolated value is not found in the case or task values then it is left blank.\nIf the interpolated values begins with \"values/\" then the value is looked up in the case or task values, otherwise it is looked up in the case or task itself.\n"
+          }
+        }
       }
     },
     "securitySchemes": {