@liaisongroup/assist-api-js-client 1.5.182 → 1.5.183

package/dist/openapi.d.ts

@@ -21,7 +21,17 @@ declare namespace Components {
             links: Links;
             included?: ActionInclusions;
         }
-        export type ActionAttributes = InternalEventAction | CalculationAction | UpdateResourceAction | CreateOrUpdateCaseAction | GetValueAction | TriggerQuestionnaireAction;
+        export interface ActionAttributes {
+            name?: string;
+            updated_at?: string; // date-time
+            created_at?: string; // date-time
+            active?: boolean;
+            trigger_id?: string; // uuid
+            action_type?: "at_time" | "calculation" | "create_or_update_case" | "create_task" | "each_case" | "each_task" | "extract_questionnaire_response" | "find_cases" | "find_tasks" | "get_case_from_task" | "get_value" | "hl7_message" | "internal_event" | "trigger_questionnaire" | "update_resource" | "update_task";
+            config?: {
+                [key: string]: never;
+            } | AtTimeConfig | CalculationConfig | CreateOrUpdateCaseConfig | CreateTaskConfig | ExtractQuestionnaireResponseConfig | FindCasesOrTasksConfig | GetValueConfig | InternalEventConfig | TriggerQuestionnaireConfig | UpdateResourceConfig | UpdateTaskConfig;
+        }
         export interface ActionData {
             type: "action";
             id: string; // uuid
@@ -94,7 +104,7 @@ declare namespace Components {
             id: string;
             attributes: ActionTypeAttributes;
         }
-        export type ActionTypeInputsOutputs = ("resource_instance" | "value" | "attributes")[];
+        export type ActionTypeInputsOutputs = ("attributes" | "case" | "cases" | "resource_instance" | "task" | "tasks" | "value" | "values")[];
         export interface ActionTypes {
             data: ActionTypeData[];
             meta: Meta;
@@ -107,6 +117,13 @@ declare namespace Components {
             included?: ActionInclusions;
         }
         export type AdministrableResources = ("user" | "field" | "template" | "saved_filter" | "list" | "tag" | "role")[];
+        export interface AtTimeConfig {
+            /**
+             * A cron expression that is used to schedule the action.
+             *
+             */
+            cron: string;
+        }
         export interface AuthApplication {
             data: AuthApplicationData;
             links: Links;
@@ -141,17 +158,9 @@ declare namespace Components {
                 unread_notification_count: number;
             };
         }
-        export interface CalculationAction {
-            name?: string;
-            updated_at?: string; // date-time
-            created_at?: string; // date-time
-            active?: boolean;
-            trigger_id?: string; // uuid
-            action_type?: "calculation";
-            config?: {
-                fields: string[];
-                operation: "sum" | "average" | "minimum" | "maximum";
-            };
+        export interface CalculationConfig {
+            fields: string[];
+            operation: "sum" | "average" | "minimum" | "maximum";
         }
         export interface Case {
             data: CaseData;
@@ -320,23 +329,20 @@ declare namespace Components {
             meta: Meta;
             links: Links;
         }
-        export interface CreateOrUpdateCaseAction {
-            name?: string;
-            updated_at?: string; // date-time
-            created_at?: string; // date-time
-            active?: boolean;
-            trigger_id?: string; // uuid
-            action_type?: "create_or_update_case";
-            config?: {
-                /**
-                 * The fields that are used to identify the case. If no identifying fields are provided, a new case will be created.
-                 */
-                identifying_fields: string[];
-                /**
-                 * The template ID of the case to create or update.
-                 */
-                template_id: string; // uuid
-            };
+        export interface CreateOrUpdateCaseConfig {
+            /**
+             * The fields that are used to identify the case. If no identifying fields are provided, a new case will be created.
+             */
+            identifying_fields: string[];
+            /**
+             * The template ID of the case to create or update.
+             */
+            template_id: string; // uuid
+        }
+        export interface CreateTaskConfig {
+            template_id: string; // uuid
+            title?: string;
+            status?: "completed" | "in_progress" | "cancelled" | "pending" | "accepted";
         }
         /**
          * Applied when the field_type is `integer` - sets the currency to display the field in.
@@ -365,6 +371,23 @@ declare namespace Components {
                 };
             }[];
         }
+        export interface ExtractQuestionnaireResponseConfig {
+            /**
+             * The key of the field to get the questionnaire ID from.
+             *
+             */
+            questionnaire_id_field_key: string;
+            /**
+             * The key of the field to get the NHS number from.
+             *
+             */
+            nhs_number_field_key: string;
+            /**
+             * The key of the field to set the questionnaire response to.
+             *
+             */
+            questionnaire_response_field_key: string;
+        }
         export interface Field {
             data: FieldData;
             links: Links;
@@ -899,21 +922,16 @@ declare namespace Components {
             }[];
             links?: Links;
         }
-        export interface GetValueAction {
-            name?: string;
-            updated_at?: string; // date-time
-            created_at?: string; // date-time
-            active?: boolean;
-            trigger_id?: string; // uuid
-            action_type?: "get_value";
-            config?: {
-                /**
-                 * The key of the field to get the value from.
-                 * If the key is prefixed with "case/" then the value is looked up in the associated case, otherwise the value is looked up in the task or case itself.
-                 *
-                 */
-                field_key: string;
-            };
+        export interface FindCasesOrTasksConfig {
+            rules: SavedFilterCondition[];
+        }
+        export interface GetValueConfig {
+            /**
+             * The key of the field to get the value from.
+             * If the key is prefixed with "case/" then the value is looked up in the associated case, otherwise the value is looked up in the task or case itself.
+             *
+             */
+            field_key: string;
         }
         export interface HL7Message {
             data: HL7MessageData;
@@ -942,25 +960,17 @@ declare namespace Components {
         export interface IdAttribute {
             id?: string; // uuid
         }
-        export interface InternalEventAction {
-            name?: string;
-            updated_at?: string; // date-time
-            created_at?: string; // date-time
-            active?: boolean;
-            trigger_id?: string; // uuid
-            action_type?: "internal_event";
-            config?: {
-                resource: Type;
-                actions: ("create" | "update" | "destroy")[];
-                conditions?: {
-                    /**
-                     * From the matchers available for the resource on the resource attributes endpoint.
-                     *
-                     */
-                    matcher: string;
-                    value: any;
-                }[];
-            };
+        export interface InternalEventConfig {
+            resource: Type;
+            actions: ("create" | "update" | "destroy")[];
+            conditions?: {
+                /**
+                 * From the matchers available for the resource on the resource attributes endpoint.
+                 *
+                 */
+                matcher: string;
+                value: any;
+            }[];
         }
         export interface InterpolatedTemplateName {
             /**
@@ -2216,32 +2226,26 @@ declare namespace Components {
             }[];
             links?: Links;
         }
-        export interface TriggerQuestionnaireAction {
-            name?: string;
-            updated_at?: string; // date-time
-            created_at?: string; // date-time
-            active?: boolean;
-            trigger_id?: string; // uuid
-            action_type?: "trigger_questionnaire";
-            config?: {
-                /**
-                 * The ID of the questionnaire to trigger in PKB.
-                 * This is the ID of the questionnaire as it appears in the PKB API.
-                 *
-                 */
-                pkb_questionnaire_id: string;
-            };
+        export interface TriggerQuestionnaireConfig {
+            /**
+             * The ID of the questionnaire to trigger in PKB.
+             * This is the ID of the questionnaire as it appears in the PKB API.
+             *
+             */
+            pkb_questionnaire_id: string;
         }
         export type Type = "action" | "case" | "case_activity_log" | "field" | "field_setting" | "list" | "list_saved_filter" | "note" | "notification" | "push_subscription" | "role" | "saved_filter" | "sso_config" | "tag" | "task" | "team" | "team_member" | "template" | "user";
-        export interface UpdateResourceAction {
-            name?: string;
-            updated_at?: string; // date-time
-            created_at?: string; // date-time
-            active?: boolean;
-            trigger_id?: string; // uuid
-            action_type?: "update_resource";
-            config?: {
-                field_to_update: string;
+        export interface UpdateResourceConfig {
+            field_to_update: string;
+        }
+        export interface UpdateTaskConfig {
+            /**
+             * Optional map of task attribute updates to apply.
+             * If omitted or empty, the action applies no attribute updates.
+             *
+             */
+            attribute_changes?: {
+                [key: string]: any;
             };
         }
         export interface User {
@@ -3752,6 +3756,21 @@ declare namespace Paths {
             export type $403 = Components.Schemas.Errors;
         }
     }
+    namespace PerformAction {
+        namespace Parameters {
+            export type Id = string; // uuid
+        }
+        export interface PathParameters {
+            id: Parameters.Id /* uuid */;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.Action;
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+            export type $404 = Components.Schemas.Errors;
+            export type $422 = Components.Schemas.Errors;
+        }
+    }
     namespace PreviewXsltMap {
         namespace Parameters {
             export type Id = string; // uuid
@@ -4409,6 +4428,14 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteAction.Responses.$204>
+  /**
+   * perform_action - Perform action
+   */
+  'perform_action'(
+    parameters?: Parameters<Paths.PerformAction.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.PerformAction.Responses.$200>
   /**
    * get_action_errors - Get action errors
    */
@@ -5468,6 +5495,16 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteAction.Responses.$204>
   }
+  ['/actions/{id}/perform']: {
+    /**
+     * perform_action - Perform action
+     */
+    'post'(
+      parameters?: Parameters<Paths.PerformAction.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.PerformAction.Responses.$200>
+  }
   ['/action_errors']: {
     /**
      * get_action_errors - Get action errors
@@ -6493,13 +6530,14 @@ export type ActionTypeInputsOutputs = Components.Schemas.ActionTypeInputsOutputs
 export type ActionTypes = Components.Schemas.ActionTypes;
 export type Actions = Components.Schemas.Actions;
 export type AdministrableResources = Components.Schemas.AdministrableResources;
+export type AtTimeConfig = Components.Schemas.AtTimeConfig;
 export type AuthApplication = Components.Schemas.AuthApplication;
 export type AuthApplicationAttributes = Components.Schemas.AuthApplicationAttributes;
 export type AuthApplicationData = Components.Schemas.AuthApplicationData;
 export type AuthApplications = Components.Schemas.AuthApplications;
 export type BroadcastEvent = Components.Schemas.BroadcastEvent;
 export type BroadcastToEvent = Components.Schemas.BroadcastToEvent;
-export type CalculationAction = Components.Schemas.CalculationAction;
+export type CalculationConfig = Components.Schemas.CalculationConfig;
 export type Case = Components.Schemas.Case;
 export type CaseActivityLog = Components.Schemas.CaseActivityLog;
 export type CaseActivityLogData = Components.Schemas.CaseActivityLogData;
@@ -6523,10 +6561,12 @@ export type Config = Components.Schemas.Config;
 export type ConfigAttributes = Components.Schemas.ConfigAttributes;
 export type ConfigData = Components.Schemas.ConfigData;
 export type Configs = Components.Schemas.Configs;
-export type CreateOrUpdateCaseAction = Components.Schemas.CreateOrUpdateCaseAction;
+export type CreateOrUpdateCaseConfig = Components.Schemas.CreateOrUpdateCaseConfig;
+export type CreateTaskConfig = Components.Schemas.CreateTaskConfig;
 export type Currency = Components.Schemas.Currency;
 export type DisplayCurrencySubunit = Components.Schemas.DisplayCurrencySubunit;
 export type Errors = Components.Schemas.Errors;
+export type ExtractQuestionnaireResponseConfig = Components.Schemas.ExtractQuestionnaireResponseConfig;
 export type Field = Components.Schemas.Field;
 export type FieldAttributes = Components.Schemas.FieldAttributes;
 export type FieldAttributes/properties/description = Components.Schemas.FieldAttributes.Properties.Description;
@@ -6560,14 +6600,15 @@ export type FieldSettingsRelationship = Components.Schemas.FieldSettingsRelation
 export type FieldUpdateAttributes = Components.Schemas.FieldUpdateAttributes;
 export type Fields = Components.Schemas.Fields;
 export type FieldsRelationship = Components.Schemas.FieldsRelationship;
-export type GetValueAction = Components.Schemas.GetValueAction;
+export type FindCasesOrTasksConfig = Components.Schemas.FindCasesOrTasksConfig;
+export type GetValueConfig = Components.Schemas.GetValueConfig;
 export type HL7Message = Components.Schemas.HL7Message;
 export type HL7MessageAttributes = Components.Schemas.HL7MessageAttributes;
 export type HL7MessageData = Components.Schemas.HL7MessageData;
 export type HL7MessageUpdateAttributes = Components.Schemas.HL7MessageUpdateAttributes;
 export type HL7Messages = Components.Schemas.HL7Messages;
 export type IdAttribute = Components.Schemas.IdAttribute;
-export type InternalEventAction = Components.Schemas.InternalEventAction;
+export type InternalEventConfig = Components.Schemas.InternalEventConfig;
 export type InterpolatedTemplateName = Components.Schemas.InterpolatedTemplateName;
 export type KnownConfigIDs = Components.Schemas.KnownConfigIDs;
 export type Links = Components.Schemas.Links;
@@ -6757,9 +6798,10 @@ 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 TriggerQuestionnaireAction = Components.Schemas.TriggerQuestionnaireAction;
+export type TriggerQuestionnaireConfig = Components.Schemas.TriggerQuestionnaireConfig;
 export type Type = Components.Schemas.Type;
-export type UpdateResourceAction = Components.Schemas.UpdateResourceAction;
+export type UpdateResourceConfig = Components.Schemas.UpdateResourceConfig;
+export type UpdateTaskConfig = Components.Schemas.UpdateTaskConfig;
 export type User = Components.Schemas.User;
 export type UserAttributes = Components.Schemas.UserAttributes;
 export type UserAttributes/properties/active = Components.Schemas.UserAttributes.Properties.Active;