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

package/dist/openapi.d.ts

@@ -21,7 +21,7 @@ declare namespace Components {
             links: Links;
             included?: ActionInclusions;
         }
-        export type ActionAttributes = InternalEventAction | CalculationAction | UpdateResourceAction;
+        export type ActionAttributes = InternalEventAction | CalculationAction | UpdateResourceAction | CreateOrUpdateCaseAction;
         export interface ActionData {
             type: "action";
             id: string; // uuid
@@ -59,7 +59,7 @@ declare namespace Components {
             id: string;
             attributes: ActionTypeAttributes;
         }
-        export type ActionTypeInputsOutputs = ("resource_instance" | "value")[];
+        export type ActionTypeInputsOutputs = ("resource_instance" | "value" | "attributes")[];
         export interface ActionTypes {
             data: ActionTypeData[];
             meta: Meta;
@@ -244,6 +244,24 @@ 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
+            };
+        }
         /**
          * Applied when the field_type is `integer` - sets the currency to display the field in.
          *
@@ -1157,6 +1175,35 @@ declare namespace Components {
              */
             client_secret: string;
         }
+        export interface PushSubscription {
+            data: PushSubscriptionData;
+            links: Links;
+        }
+        export interface PushSubscriptionAttributes {
+            /**
+             * The endpoint URL for the push subscription
+             */
+            endpoint: string; // uri
+            /**
+             * The p256dh public key for message encryption
+             */
+            p256dh_key: string;
+            /**
+             * The auth secret for message encryption
+             */
+            auth_key: string;
+            created_at?: string; // date-time
+            updated_at?: string; // date-time
+        }
+        export interface PushSubscriptionData {
+            type: "push_subscription";
+            id: string; // uuid
+            attributes: PushSubscriptionAttributes;
+            relationships: PushSubscriptionRelationships;
+        }
+        export interface PushSubscriptionRelationships {
+            user?: UserRelationship;
+        }
         export interface RefreshTokenGrant {
             grant_type?: "refresh_token";
             /**
@@ -1868,7 +1915,7 @@ declare namespace Components {
             }[];
             links?: Links;
         }
-        export type Type = "action" | "case" | "field" | "field_setting" | "list" | "list_saved_filter" | "note" | "notification" | "role" | "saved_filter" | "sso_config" | "tag" | "task" | "team" | "team_member" | "template" | "user";
+        export type Type = "action" | "case" | "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
@@ -2001,6 +2048,7 @@ declare namespace Components {
             roles?: RolesRelationship;
             assigned_notifications?: NotificationsRelationship;
         }
+        export type UserSpecificChannel = "UserSpecificChannel";
         export interface UserUpdateAttributes {
             name?: UserAttributes.Properties.Name;
             email?: UserAttributes.Properties.Email /* email */;
@@ -2302,6 +2350,19 @@ declare namespace Paths {
             export type $422 = Components.Schemas.Errors;
         }
     }
+    namespace CreatePushSubscription {
+        export interface RequestBody {
+            data: {
+                attributes: Components.Schemas.PushSubscriptionAttributes;
+            };
+        }
+        namespace Responses {
+            export type $201 = Components.Schemas.PushSubscription;
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+            export type $422 = Components.Schemas.Errors;
+        }
+    }
     namespace CreateRole {
         export interface RequestBody {
             data: {
@@ -4635,6 +4696,14 @@ export interface OperationMethods {
     data?: Paths.CreateHl7.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateHl7.Responses.$201>
+  /**
+   * create_push_subscription - Create push subscription
+   */
+  'create_push_subscription'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreatePushSubscription.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreatePushSubscription.Responses.$201>
 }
 
 export interface PathsDictionary {
@@ -5679,6 +5748,16 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.CreateHl7.Responses.$201>
   }
+  ['/push_subscriptions']: {
+    /**
+     * create_push_subscription - Create push subscription
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreatePushSubscription.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreatePushSubscription.Responses.$201>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -5724,6 +5803,7 @@ 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 Currency = Components.Schemas.Currency;
 export type DisplayCurrencySubunit = Components.Schemas.DisplayCurrencySubunit;
 export type Errors = Components.Schemas.Errors;
@@ -5824,6 +5904,10 @@ export type NotificationsRelationship = Components.Schemas.NotificationsRelation
 export type OidcConfig = Components.Schemas.OidcConfig;
 export type OperationTypes = Components.Schemas.OperationTypes;
 export type PasswordGrant = Components.Schemas.PasswordGrant;
+export type PushSubscription = Components.Schemas.PushSubscription;
+export type PushSubscriptionAttributes = Components.Schemas.PushSubscriptionAttributes;
+export type PushSubscriptionData = Components.Schemas.PushSubscriptionData;
+export type PushSubscriptionRelationships = Components.Schemas.PushSubscriptionRelationships;
 export type RefreshTokenGrant = Components.Schemas.RefreshTokenGrant;
 export type ResourceAttribute = Components.Schemas.ResourceAttribute;
 export type ResourceAttributeAttributes = Components.Schemas.ResourceAttributeAttributes;
@@ -5958,6 +6042,7 @@ export type UserInclusion = Components.Schemas.UserInclusion;
 export type UserInclusions = Components.Schemas.UserInclusions;
 export type UserRelationship = Components.Schemas.UserRelationship;
 export type UserRelationships = Components.Schemas.UserRelationships;
+export type UserSpecificChannel = Components.Schemas.UserSpecificChannel;
 export type UserUpdateAttributes = Components.Schemas.UserUpdateAttributes;
 export type Users = Components.Schemas.Users;
 export type UsersRelationship = Components.Schemas.UsersRelationship;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Liaison Assist API",
     "description": "![Hero](./hero.svg)\n",
-    "version": "0.0.287",
+    "version": "0.0.292",
     "license": {
       "name": "MIT",
       "url": "https://opensource.org/licenses/MIT"
@@ -46,7 +46,7 @@
     },
     {
       "name": "Websocket Channels",
-      "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 `UserNotificationsChannel` 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_notifications:<user_id>` channel.\n"
+      "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"
@@ -91,6 +91,10 @@
       "name": "Notifications",
       "description": "Notifications are used to inform users about events that have happened in the system.\n"
     },
+    {
+      "name": "Push Subscriptions",
+      "description": "Push subscriptions are used to register devices for receiving push notifications from the browser's push service.\n"
+    },
     {
       "name": "Operations",
       "description": "Operations are used to perform atomic actions (to create, update and destroy multiple resouces at once.)\n"
@@ -8434,6 +8438,89 @@
           }
         }
       }
+    },
+    "/push_subscriptions": {
+      "post": {
+        "operationId": "create_push_subscription",
+        "summary": "Create push subscription",
+        "tags": [
+          "Push Subscriptions"
+        ],
+        "security": [
+          {
+            "bearerAuth": []
+          },
+          {
+            "cookieAuth": []
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/vnd.api+json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "data"
+                ],
+                "properties": {
+                  "data": {
+                    "required": [
+                      "attributes"
+                    ],
+                    "properties": {
+                      "attributes": {
+                        "$ref": "#/components/schemas/PushSubscriptionAttributes"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "OK",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PushSubscription"
+                }
+              }
+            }
+          },
+          "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"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Unprocessable Entity",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -8448,6 +8535,9 @@
           },
           {
             "$ref": "#/components/schemas/UpdateResourceAction"
+          },
+          {
+            "$ref": "#/components/schemas/CreateOrUpdateCaseAction"
           }
         ]
       },
@@ -8616,7 +8706,8 @@
           "type": "string",
           "enum": [
             "resource_instance",
-            "value"
+            "value",
+            "attributes"
           ]
         }
       },
@@ -14151,6 +14242,12 @@
           "UsersChannel"
         ]
       },
+      "UserSpecificChannel": {
+        "type": "string",
+        "enum": [
+          "UserSpecificChannel"
+        ]
+      },
       "BroadcastEvent": {
         "type": "object",
         "required": [
@@ -14500,6 +14597,7 @@
           "list_saved_filter",
           "note",
           "notification",
+          "push_subscription",
           "role",
           "saved_filter",
           "sso_config",
@@ -14833,6 +14931,144 @@
             }
           }
         }
+      },
+      "CreateOrUpdateCaseAction": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "active": {
+            "type": "boolean"
+          },
+          "trigger_id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "action_type": {
+            "type": "string",
+            "enum": [
+              "create_or_update_case"
+            ]
+          },
+          "config": {
+            "type": "object",
+            "required": [
+              "identifying_fields",
+              "template_id"
+            ],
+            "properties": {
+              "identifying_fields": {
+                "description": "The fields that are used to identify the case. If no identifying fields are provided, a new case will be created.",
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "template_id": {
+                "description": "The template ID of the case to create or update.",
+                "type": "string",
+                "format": "uuid"
+              }
+            }
+          }
+        }
+      },
+      "PushSubscriptionAttributes": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "endpoint",
+          "p256dh_key",
+          "auth_key"
+        ],
+        "properties": {
+          "endpoint": {
+            "type": "string",
+            "format": "uri",
+            "description": "The endpoint URL for the push subscription"
+          },
+          "p256dh_key": {
+            "type": "string",
+            "description": "The p256dh public key for message encryption"
+          },
+          "auth_key": {
+            "type": "string",
+            "description": "The auth secret for message encryption"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "readOnly": true
+          }
+        }
+      },
+      "PushSubscriptionData": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "id",
+          "attributes",
+          "relationships"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "push_subscription"
+            ]
+          },
+          "id": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "attributes": {
+            "$ref": "#/components/schemas/PushSubscriptionAttributes"
+          },
+          "relationships": {
+            "$ref": "#/components/schemas/PushSubscriptionRelationships"
+          }
+        }
+      },
+      "PushSubscriptionRelationships": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "user": {
+            "$ref": "#/components/schemas/UserRelationship"
+          }
+        }
+      },
+      "PushSubscription": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "data",
+          "links"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/PushSubscriptionData"
+          },
+          "links": {
+            "$ref": "#/components/schemas/Links"
+          }
+        }
       }
     },
     "securitySchemes": {