@liaisongroup/assist-api-js-client 1.5.170 → 1.5.172

package/dist/openapi.d.ts

@@ -425,6 +425,12 @@ declare namespace Components {
                  */
                 null | (string | number | number)[];
                 resource?: Type;
+                /**
+                 * Only present on resource fields where the resource type is 'case'.
+                 * The IDs of the case templates that should be suggested for this field.
+                 *
+                 */
+                suggested_case_template_ids?: string /* uuid */[];
                 conditions?: null | SavedFilterCondition[];
                 /**
                  * Applied when the field_type is `string` - indicates that the field should be displayed as a multi-line text field.
@@ -469,6 +475,11 @@ declare namespace Components {
                  *
                  */
                 DisplayCurrencySubunit;
+                /**
+                 * Applied when the field_type is `date` - indicates that the amount of time passed since the date should be displayed (e.g 4 years, 3 months and 18 days).
+                 *
+                 */
+                display_time_passed_since_date?: boolean;
                 /**
                  * Only present on composite fields.
                  * The keys of the fields that make up this composite field.
@@ -531,6 +542,12 @@ declare namespace Components {
                      */
                     null | (string | number | number)[];
                     resource?: Type;
+                    /**
+                     * Only present on resource fields where the resource type is 'case'.
+                     * The IDs of the case templates that should be suggested for this field.
+                     *
+                     */
+                    suggested_case_template_ids?: string /* uuid */[];
                     conditions?: null | SavedFilterCondition[];
                     /**
                      * Applied when the field_type is `string` - indicates that the field should be displayed as a multi-line text field.
@@ -575,6 +592,11 @@ declare namespace Components {
                      *
                      */
                     DisplayCurrencySubunit;
+                    /**
+                     * Applied when the field_type is `date` - indicates that the amount of time passed since the date should be displayed (e.g 4 years, 3 months and 18 days).
+                     *
+                     */
+                    display_time_passed_since_date?: boolean;
                     /**
                      * Only present on composite fields.
                      * The keys of the fields that make up this composite field.
@@ -914,6 +936,7 @@ declare namespace Components {
              * 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.
+             * You can prefix keys with age: or first_character: to perform calculations on the value.
              *
              */
             interpolated_name?: string;
@@ -972,12 +995,40 @@ declare namespace Components {
             };
             sort_param?: string;
             hidden_from_dashboard?: boolean;
+            /**
+             * example:
+             * {
+             *   "display_expanded_task_information": true
+             * }
+             */
+            display_configuration?: {
+                /**
+                 * Boolean flag to control display of expanded task information for case lists.
+                 * If this isn't supplied, the list will default to showing task summaries only -- no expanded task information.
+                 *
+                 */
+                display_expanded_task_information?: boolean;
+            };
         }
         namespace ListAttributes {
             namespace Properties {
                 export type Active = boolean;
                 export type AdminId = string; // uuid
                 export type Description = string | null;
+                /**
+                 * example:
+                 * {
+                 *   "display_expanded_task_information": true
+                 * }
+                 */
+                export interface DisplayConfiguration {
+                    /**
+                     * Boolean flag to control display of expanded task information for case lists.
+                     * If this isn't supplied, the list will default to showing task summaries only -- no expanded task information.
+                     *
+                     */
+                    display_expanded_task_information?: boolean;
+                }
                 export type HiddenFromDashboard = boolean;
                 export type ListType = "list" | "task" | "case";
                 /**
@@ -1035,6 +1086,13 @@ declare namespace Components {
              */
             ListAttributes.Properties.Order;
             hidden_from_dashboard?: ListAttributes.Properties.HiddenFromDashboard;
+            display_configuration?: /**
+             * example:
+             * {
+             *   "display_expanded_task_information": true
+             * }
+             */
+            ListAttributes.Properties.DisplayConfiguration;
         }
         export interface ListData {
             type: "list";
@@ -1618,6 +1676,29 @@ declare namespace Components {
              *
              */
             DisplayCurrencySubunit;
+            /**
+             * The amount of time passed since the date broken down into years, months, weeks and days.
+             * When the date is in the future, the values will be negative.
+             * This will not be returned unless display_time_passed_since_date is true.
+             * If display_time_passed_since_date is true but the date is nil then it will not be returned.
+             *
+             */
+            time_passed_since_date?: {
+                years?: number;
+                months?: number;
+                weeks?: number;
+                days?: number;
+                /**
+                 * The long form of the time passed since the date.
+                 *
+                 */
+                long?: string;
+                /**
+                 * The short form of the time passed since the date.
+                 *
+                 */
+                short?: string;
+            };
         }[];
         export interface Tag {
             data: TagData;
@@ -6397,6 +6478,7 @@ export type ListAttributes = Components.Schemas.ListAttributes;
 export type ListAttributes/properties/active = Components.Schemas.ListAttributes.Properties.Active;
 export type ListAttributes/properties/admin_id = Components.Schemas.ListAttributes.Properties.AdminId;
 export type ListAttributes/properties/description = Components.Schemas.ListAttributes.Properties.Description;
+export type ListAttributes/properties/display_configuration = Components.Schemas.ListAttributes.Properties.DisplayConfiguration;
 export type ListAttributes/properties/hidden_from_dashboard = Components.Schemas.ListAttributes.Properties.HiddenFromDashboard;
 export type ListAttributes/properties/list_type = Components.Schemas.ListAttributes.Properties.ListType;
 export type ListAttributes/properties/order = Components.Schemas.ListAttributes.Properties.Order;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Liaison Assist API",
     "description": "![Hero](./hero.svg)\n",
-    "version": "0.0.379-hotfix/1",
+    "version": "0.0.388",
     "license": {
       "name": "MIT",
       "url": "https://opensource.org/licenses/MIT"
@@ -9600,51 +9600,6 @@
           ]
         }
       },
-      "CaseAttributes": {
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "template_id": {
-            "type": "string",
-            "format": "uuid"
-          },
-          "name": {
-            "anyOf": [
-              {
-                "type": "null"
-              },
-              {
-                "type": "string"
-              }
-            ],
-            "readOnly": true
-          },
-          "tag_ids": {
-            "type": "array",
-            "items": {
-              "type": "string",
-              "format": "uuid"
-            }
-          },
-          "values": {
-            "type": "object",
-            "description": "A key-value pair of values.\nThe keys are the field keys and the values are the value for this instance.\nThe values can be strings, integers, floats, booleans, dates, times, datetimes, or resources.\nIf the field expects multiple values then it can be an array of the these.\nIf the field is composite then it is itself and object with the same structure.\n"
-          },
-          "structured_values": {
-            "$ref": "#/components/schemas/StructuredValues"
-          },
-          "created_at": {
-            "type": "string",
-            "format": "date-time",
-            "readOnly": true
-          },
-          "updated_at": {
-            "type": "string",
-            "format": "date-time",
-            "readOnly": true
-          }
-        }
-      },
       "AuthApplicationAttributes": {
         "type": "object",
         "properties": {
@@ -9718,6 +9673,51 @@
           }
         }
       },
+      "CaseAttributes": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "template_id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "name": {
+            "anyOf": [
+              {
+                "type": "null"
+              },
+              {
+                "type": "string"
+              }
+            ],
+            "readOnly": true
+          },
+          "tag_ids": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "format": "uuid"
+            }
+          },
+          "values": {
+            "type": "object",
+            "description": "A key-value pair of values.\nThe keys are the field keys and the values are the value for this instance.\nThe values can be strings, integers, floats, booleans, dates, times, datetimes, or resources.\nIf the field expects multiple values then it can be an array of the these.\nIf the field is composite then it is itself and object with the same structure.\n"
+          },
+          "structured_values": {
+            "$ref": "#/components/schemas/StructuredValues"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true
+          }
+        }
+      },
       "CaseCreateAttributes": {
         "type": "object",
         "required": [
@@ -10417,6 +10417,14 @@
               "resource": {
                 "$ref": "#/components/schemas/Type"
               },
+              "suggested_case_template_ids": {
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "format": "uuid"
+                },
+                "description": "Only present on resource fields where the resource type is 'case'.\nThe IDs of the case templates that should be suggested for this field.\n"
+              },
               "conditions": {
                 "anyOf": [
                   {
@@ -10469,6 +10477,11 @@
               "display_currency_subunit": {
                 "$ref": "#/components/schemas/DisplayCurrencySubunit"
               },
+              "display_time_passed_since_date": {
+                "type": "boolean",
+                "default": false,
+                "description": "Applied when the field_type is `date` - indicates that the amount of time passed since the date should be displayed (e.g 4 years, 3 months and 18 days).\n"
+              },
               "field_keys": {
                 "type": "array",
                 "items": {
@@ -11465,6 +11478,20 @@
           "hidden_from_dashboard": {
             "type": "boolean",
             "default": false
+          },
+          "display_configuration": {
+            "type": "object",
+            "additionalProperties": false,
+            "default": {},
+            "properties": {
+              "display_expanded_task_information": {
+                "type": "boolean",
+                "description": "Boolean flag to control display of expanded task information for case lists.\nIf this isn't supplied, the list will default to showing task summaries only -- no expanded task information.\n"
+              }
+            },
+            "example": {
+              "display_expanded_task_information": true
+            }
           }
         }
       },
@@ -11504,6 +11531,9 @@
           },
           "hidden_from_dashboard": {
             "$ref": "#/components/schemas/ListAttributes/properties/hidden_from_dashboard"
+          },
+          "display_configuration": {
+            "$ref": "#/components/schemas/ListAttributes/properties/display_configuration"
           }
         }
       },
@@ -15520,6 +15550,33 @@
             },
             "display_currency_subunit": {
               "$ref": "#/components/schemas/DisplayCurrencySubunit"
+            },
+            "time_passed_since_date": {
+              "description": "The amount of time passed since the date broken down into years, months, weeks and days.\nWhen the date is in the future, the values will be negative.\nThis will not be returned unless display_time_passed_since_date is true.\nIf display_time_passed_since_date is true but the date is nil then it will not be returned.\n",
+              "readOnly": true,
+              "type": "object",
+              "properties": {
+                "years": {
+                  "type": "integer"
+                },
+                "months": {
+                  "type": "integer"
+                },
+                "weeks": {
+                  "type": "integer"
+                },
+                "days": {
+                  "type": "integer"
+                },
+                "long": {
+                  "description": "The long form of the time passed since the date.\n",
+                  "type": "string"
+                },
+                "short": {
+                  "description": "The short form of the time passed since the date.\n",
+                  "type": "string"
+                }
+              }
             }
           }
         }
@@ -16128,7 +16185,7 @@
         "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"
+            "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"
           }
         }
       },