@liaisongroup/assist-api-js-client 1.5.57 → 1.5.59

package/dist/openapi.d.ts

@@ -78,6 +78,16 @@ declare namespace Components {
                 id: string; // uuid
             };
         }
+        export interface BroadcastToEvent {
+            type: "unread_notification_count_change";
+            data: {
+                /**
+                 * example:
+                 * 10
+                 */
+                unread_notification_count: number;
+            };
+        }
         export interface CalculationAction {
             name?: string;
             updated_at?: string; // date-time
@@ -104,6 +114,7 @@ declare namespace Components {
                 target_type?: "Case" | "Note" | "Tag" | "Task";
                 target_name?: string;
                 event_type?: "create" | "destroy" | "update";
+                event_reason?: null | string;
                 created_at?: string; // date-time
                 changes?: {
                     key?: string;
@@ -1048,6 +1059,48 @@ declare namespace Components {
                 id?: string; // uuid
             }[];
         }
+        export interface Notification {
+            data: NotificationData;
+            links: Links;
+            included?: NotificationInclusions;
+        }
+        export interface NotificationAttributes {
+            message?: string;
+            body?: string;
+            read?: boolean;
+            created_at?: string; // date-time
+            updated_at?: string; // date-time
+        }
+        export interface NotificationData {
+            type: "notification";
+            id: string; // uuid
+            attributes: NotificationAttributes;
+            relationships: NotificationRelationships;
+        }
+        export interface NotificationInclusion {
+            type: "notification";
+            id: string; // uuid
+            attributes: NotificationAttributes;
+            relationships: NotificationRelationships;
+        }
+        export type NotificationInclusions = (TaskInclusion | UserInclusion)[];
+        export interface NotificationRelationships {
+            subject?: TaskRelationship;
+            assignee?: UserRelationship;
+            assigner?: UserRelationship;
+        }
+        export interface Notifications {
+            data: NotificationData[];
+            meta: Meta;
+            links: Links;
+            included?: NotificationInclusions;
+        }
+        export interface NotificationsRelationship {
+            data?: {
+                type?: "notification";
+                id?: string; // uuid
+            }[];
+        }
         export interface OidcConfig {
             client_id: string;
             secret: string;
@@ -1527,6 +1580,13 @@ declare namespace Components {
             relationships: TaskRelationships;
         }
         export type TaskInclusions = (CaseInclusion | FieldInclusion | NoteInclusion | TeamInclusion | TemplateInclusion | UserInclusion | VersionInclusion)[];
+        export interface TaskRelationship {
+            data?: {
+                type?: "task";
+                id?: string; // uuid
+            };
+            links?: Links;
+        }
         export interface TaskRelationships {
             case?: CaseRelationship;
             fields?: FieldsRelationship;
@@ -1780,7 +1840,7 @@ declare namespace Components {
             }[];
             links?: Links;
         }
-        export type Type = "action" | "case" | "field" | "field_setting" | "list" | "list_saved_filter" | "note" | "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" | "role" | "saved_filter" | "sso_config" | "tag" | "task" | "team" | "team_member" | "template" | "user";
         export interface UpdateResourceAction {
             name?: string;
             updated_at?: string; // date-time
@@ -1837,10 +1897,16 @@ declare namespace Components {
                 sso_config: RoleActions[];
                 field_setting: RoleActions[];
                 note: RoleActions[];
+                notification: RoleActions[];
             };
             team_ids?: string /* uuid */[];
             created_at?: string; // date-time
             updated_at?: string; // date-time
+            /**
+             * example:
+             * 0
+             */
+            unread_notification_count?: number;
         }
         namespace UserAttributes {
             namespace Properties {
@@ -1892,7 +1958,7 @@ declare namespace Components {
             attributes: UserAttributes;
             relationships?: UserRelationships;
         }
-        export type UserInclusions = (TaskInclusion | TeamInclusion | TeamMemberInclusion | RoleInclusion)[];
+        export type UserInclusions = (TaskInclusion | TeamInclusion | TeamMemberInclusion | RoleInclusion | NotificationInclusion)[];
         export interface UserRelationship {
             data?: {
                 type?: "user";
@@ -1905,6 +1971,7 @@ declare namespace Components {
             teams?: TeamsRelationship;
             team_members?: TeamMembersRelationship;
             roles?: RolesRelationship;
+            assigned_notifications?: NotificationsRelationship;
         }
         export interface UserUpdateAttributes {
             name?: UserAttributes.Properties.Name;
@@ -2412,6 +2479,21 @@ declare namespace Paths {
             export type $404 = Components.Schemas.Errors;
         }
     }
+    namespace DeleteNotification {
+        namespace Parameters {
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export interface $204 {
+            }
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+            export type $404 = Components.Schemas.Errors;
+        }
+    }
     namespace DeleteRole {
         namespace Parameters {
             export type Id = string; // uuid
@@ -2785,6 +2867,13 @@ declare namespace Paths {
             export type $403 = Components.Schemas.Errors;
         }
     }
+    namespace GetNotifications {
+        namespace Responses {
+            export type $200 = Components.Schemas.Notifications;
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+        }
+    }
     namespace GetResourceAttribute {
         namespace Parameters {
             export type Id = string;
@@ -3040,6 +3129,14 @@ declare namespace Paths {
             }
         }
     }
+    namespace MarkAllNotificationsAsRead {
+        namespace Responses {
+            export interface $204 {
+            }
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+        }
+    }
     namespace RevokeAccessToken {
         export interface RequestBody {
             token: string; // jwt
@@ -3219,6 +3316,25 @@ declare namespace Paths {
             export type $422 = Components.Schemas.Errors;
         }
     }
+    namespace UpdateNotification {
+        namespace Parameters {
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        export interface RequestBody {
+            data: {
+                attributes: Components.Schemas.NotificationAttributes;
+            };
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.Notification;
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+            export type $404 = Components.Schemas.Errors;
+        }
+    }
     namespace UpdateRole {
         namespace Parameters {
             export type Id = string; // uuid
@@ -3413,6 +3529,7 @@ declare namespace Paths {
     }
 }
 
+
 export interface OperationMethods {
   /**
    * create_access_token - Create access token
@@ -4198,6 +4315,38 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteNote.Responses.$204>
+  /**
+   * get_notifications - Get notifications
+   */
+  'get_notifications'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetNotifications.Responses.$200>
+  /**
+   * mark_all_notifications_as_read - Mark all notifications for current user as read
+   */
+  'mark_all_notifications_as_read'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.MarkAllNotificationsAsRead.Responses.$204>
+  /**
+   * update_notification - Update notification
+   */
+  'update_notification'(
+    parameters?: Parameters<Paths.UpdateNotification.PathParameters> | null,
+    data?: Paths.UpdateNotification.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateNotification.Responses.$200>
+  /**
+   * delete_notification - Delete notification
+   */
+  'delete_notification'(
+    parameters?: Parameters<Paths.DeleteNotification.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteNotification.Responses.$204>
   /**
    * atomic_operations - Perform atomic operations
    * 
@@ -5104,6 +5253,44 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteNote.Responses.$204>
   }
+  ['/notifications']: {
+    /**
+     * get_notifications - Get notifications
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetNotifications.Responses.$200>
+  }
+  ['/notifications/mark_all_as_read']: {
+    /**
+     * mark_all_notifications_as_read - Mark all notifications for current user as read
+     */
+    'patch'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.MarkAllNotificationsAsRead.Responses.$204>
+  }
+  ['/notifications/{id}']: {
+    /**
+     * update_notification - Update notification
+     */
+    'patch'(
+      parameters?: Parameters<Paths.UpdateNotification.PathParameters> | null,
+      data?: Paths.UpdateNotification.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateNotification.Responses.$200>
+    /**
+     * delete_notification - Delete notification
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteNotification.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteNotification.Responses.$204>
+  }
   ['/operations']: {
     /**
      * atomic_operations - Perform atomic operations
@@ -5141,6 +5328,7 @@ export interface PathsDictionary {
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
+
 export type AccessToken = Components.Schemas.AccessToken;
 export type Action = Components.Schemas.Action;
 export type ActionAttributes = Components.Schemas.ActionAttributes;
@@ -5157,6 +5345,7 @@ export type ActionTypes = Components.Schemas.ActionTypes;
 export type Actions = Components.Schemas.Actions;
 export type AdministrableResources = Components.Schemas.AdministrableResources;
 export type BroadcastEvent = Components.Schemas.BroadcastEvent;
+export type BroadcastToEvent = Components.Schemas.BroadcastToEvent;
 export type CalculationAction = Components.Schemas.CalculationAction;
 export type Case = Components.Schemas.Case;
 export type CaseActivityLog = Components.Schemas.CaseActivityLog;
@@ -5264,6 +5453,14 @@ export type NoteInclusions = Components.Schemas.NoteInclusions;
 export type NoteRelationships = Components.Schemas.NoteRelationships;
 export type Notes = Components.Schemas.Notes;
 export type NotesRelationship = Components.Schemas.NotesRelationship;
+export type Notification = Components.Schemas.Notification;
+export type NotificationAttributes = Components.Schemas.NotificationAttributes;
+export type NotificationData = Components.Schemas.NotificationData;
+export type NotificationInclusion = Components.Schemas.NotificationInclusion;
+export type NotificationInclusions = Components.Schemas.NotificationInclusions;
+export type NotificationRelationships = Components.Schemas.NotificationRelationships;
+export type Notifications = Components.Schemas.Notifications;
+export type NotificationsRelationship = Components.Schemas.NotificationsRelationship;
 export type OidcConfig = Components.Schemas.OidcConfig;
 export type OperationTypes = Components.Schemas.OperationTypes;
 export type PasswordGrant = Components.Schemas.PasswordGrant;
@@ -5341,6 +5538,7 @@ export type TaskCreateAttributes = Components.Schemas.TaskCreateAttributes;
 export type TaskData = Components.Schemas.TaskData;
 export type TaskInclusion = Components.Schemas.TaskInclusion;
 export type TaskInclusions = Components.Schemas.TaskInclusions;
+export type TaskRelationship = Components.Schemas.TaskRelationship;
 export type TaskRelationships = Components.Schemas.TaskRelationships;
 export type Tasks = Components.Schemas.Tasks;
 export type TasksRelationship = Components.Schemas.TasksRelationship;