@liaisongroup/assist-api-js-client 1.5.176 → 1.5.178

package/dist/openapi.d.ts

@@ -211,6 +211,24 @@ declare namespace Components {
                 [key: string]: any;
             };
             structured_values?: StructuredValues;
+            /**
+             * A list of attributes, values and associated values formatted for the index context.
+             *
+             */
+            index_structured_values?: /**
+             * A list of attributes, values and associated values formatted for the index context.
+             *
+             */
+            null | StructuredValues;
+            /**
+             * A list of attributes, values and associated values formatted for the show context.
+             *
+             */
+            show_structured_values?: /**
+             * A list of attributes, values and associated values formatted for the show context.
+             *
+             */
+            null | StructuredValues;
             created_at?: string; // date-time
             updated_at?: string; // date-time
         }
@@ -935,6 +953,8 @@ declare namespace Components {
              * 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.
+             * You can also use associated values by prefixing the key with the resource field key and a pipe character, then the target field key.
+             * For example: "{values/patient|given_name}"
              * 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.
              * You can prefix keys with age: or first_character: to perform calculations on the value.
@@ -1789,6 +1809,24 @@ declare namespace Components {
                 [key: string]: any;
             };
             structured_values?: StructuredValues;
+            /**
+             * A list of attributes, values and associated values formatted for the index context.
+             *
+             */
+            index_structured_values?: /**
+             * A list of attributes, values and associated values formatted for the index context.
+             *
+             */
+            null | StructuredValues;
+            /**
+             * A list of attributes, values and associated values formatted for the show context.
+             *
+             */
+            show_structured_values?: /**
+             * A list of attributes, values and associated values formatted for the show context.
+             *
+             */
+            null | StructuredValues;
             start_at?: string; // date-time
             end_at?: null | string /* date-time */;
             user_ids?: string /* uuid */[];
@@ -2063,6 +2101,18 @@ declare namespace Components {
             schema?: {
                 name?: null | SimpleTemplateName | InterpolatedTemplateName;
             };
+            index_display_configuration?: TemplateSchemaItems;
+            show_display_configuration?: TemplateSchemaItems;
+            /**
+             * A list of schema items which could be used to display the template with supporting metadata.
+             * An array of the value components of these items can be used to populate the index and show schemas in order to determine how instances of the template are rendered in the show and index contexts.
+             *
+             */
+            suggested_display_configuration_items_with_metadata?: {
+                group?: string;
+                label?: string;
+                value?: TemplateSchemaItem;
+            }[];
             created_at?: string; // date-time
             updated_at?: string; // date-time
         }
@@ -2128,6 +2178,15 @@ declare namespace Components {
             };
             links?: Links;
         }
+        export type TemplateSchemaItem = {
+            attribute: string;
+        } | {
+            key: string;
+        } | {
+            field: string;
+            key: string;
+        };
+        export type TemplateSchemaItems = TemplateSchemaItem[];
         export interface Templates {
             data: TemplateData[];
             meta: Meta;
@@ -6661,6 +6720,8 @@ export type TemplateData/properties/relationships = Components.Schemas.TemplateD
 export type TemplateInclusion = Components.Schemas.TemplateInclusion;
 export type TemplateInclusions = Components.Schemas.TemplateInclusions;
 export type TemplateRelationship = Components.Schemas.TemplateRelationship;
+export type TemplateSchemaItem = Components.Schemas.TemplateSchemaItem;
+export type TemplateSchemaItems = Components.Schemas.TemplateSchemaItems;
 export type Templates = Components.Schemas.Templates;
 export type TemplatesRelationship = Components.Schemas.TemplatesRelationship;
 export type Type = Components.Schemas.Type;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Liaison Assist API",
     "description": "![Hero](./hero.svg)\n",
-    "version": "0.0.393",
+    "version": "0.0.396",
     "license": {
       "name": "MIT",
       "url": "https://opensource.org/licenses/MIT"
@@ -9706,6 +9706,28 @@
           "structured_values": {
             "$ref": "#/components/schemas/StructuredValues"
           },
+          "index_structured_values": {
+            "description": "A list of attributes, values and associated values formatted for the index context.\n",
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/StructuredValues"
+              }
+            ]
+          },
+          "show_structured_values": {
+            "description": "A list of attributes, values and associated values formatted for the show context.\n",
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/StructuredValues"
+              }
+            ]
+          },
           "created_at": {
             "type": "string",
             "format": "date-time",
@@ -13466,6 +13488,28 @@
           "structured_values": {
             "$ref": "#/components/schemas/StructuredValues"
           },
+          "index_structured_values": {
+            "description": "A list of attributes, values and associated values formatted for the index context.\n",
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/StructuredValues"
+              }
+            ]
+          },
+          "show_structured_values": {
+            "description": "A list of attributes, values and associated values formatted for the show context.\n",
+            "oneOf": [
+              {
+                "type": "null"
+              },
+              {
+                "$ref": "#/components/schemas/StructuredValues"
+              }
+            ]
+          },
           "start_at": {
             "type": "string",
             "format": "date-time"
@@ -14295,6 +14339,31 @@
               }
             }
           },
+          "index_display_configuration": {
+            "$ref": "#/components/schemas/TemplateSchemaItems"
+          },
+          "show_display_configuration": {
+            "$ref": "#/components/schemas/TemplateSchemaItems"
+          },
+          "suggested_display_configuration_items_with_metadata": {
+            "description": "A list of schema items which could be used to display the template with supporting metadata.\nAn array of the value components of these items can be used to populate the index and show schemas in order to determine how instances of the template are rendered in the show and index contexts.\n",
+            "readOnly": true,
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "group": {
+                  "type": "string"
+                },
+                "label": {
+                  "type": "string"
+                },
+                "value": {
+                  "$ref": "#/components/schemas/TemplateSchemaItem"
+                }
+              }
+            }
+          },
           "created_at": {
             "type": "string",
             "format": "date-time",
@@ -16204,8 +16273,58 @@
         "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.\nYou can prefix keys with age: or first_character: to perform calculations on the value.\n"
+            "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.\nYou can also use associated values by prefixing the key with the resource field key and a pipe character, then the target field key.\nFor example: \"{values/patient|given_name}\"\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.\nYou can prefix keys with age: or first_character: to perform calculations on the value.\n"
+          }
+        }
+      },
+      "TemplateSchemaItem": {
+        "anyOf": [
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "attribute"
+            ],
+            "properties": {
+              "attribute": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "key"
+            ],
+            "properties": {
+              "key": {
+                "type": "string"
+              }
+            }
+          },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "field",
+              "key"
+            ],
+            "properties": {
+              "field": {
+                "type": "string"
+              },
+              "key": {
+                "type": "string"
+              }
+            }
           }
+        ]
+      },
+      "TemplateSchemaItems": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/TemplateSchemaItem"
         }
       },
       "UserSummary": {