@giosg/types - npm Package Compare versions

Comparing version 1.2.12 to 1.2.13

lib/chat.d.ts

@@ -519,3 +519,70 @@ import { NestedAvatar } from "./customer";
 }
-interface DecryptedChatMessageUser {
+interface DecryptedChatMessageCommon {
+  /** Unique identifier of the message */
+  id: ChatMessageUid;
+  /** Defines the type of the message. "msg" by default */
+  type: ChatMessageType;
+  /** Unique identifier of the chat */
+  chat_id: ChatUid;
+  /** Unique identifier of the room in which the chat occurred */
+  room_id: RoomUid;
+  /** Date when the message was sent */
+  created_at: string;
+  /** Display name of the sender as the visitor would see it */
+  sender_public_name: string;
+  /** Display name of the sender as an operator would see it */
+  sender_name: string;
+  /** Avatar image of the sender */
+  sender_avatar: NestedAvatar | null;
+  /**
+   * Content text of the message. The maximum length is 2000 characters.
+   * This will always be the decrypted if the decryption key is still being stored at the server
+   */
+  message: string | null;
+  /**
+   * Whether or not the message is stored encrypted. When true, the "encrypted_message" attribute contains
+   * the encrypted ciphertext of the message
+   */
+  is_encrypted: boolean;
+  /**
+   * The encrypted ciphertext of the message, if encryption is used for the chat.
+   * This attribute is only present if "is_encrypted" is true
+   */
+  encrypted_message?: string | null;
+  /**
+   * Date when the message’s sensitive data was purged. This means that the message and
+   * visitor’s "sender_name" and "sender_public_name" are set as null. It is null if the data was not purged
+   */
+  sensitive_data_purged_at: string | null;
+  /** Unique identifier of the chat reply suggestion that was selected as a basis for the message */
+  selected_reply_suggestion_id: ChatReplySuggestionUid | null;
+  /** Chat reply suggestion that was selected as a basis for the message */
+  selected_reply_suggestion: NestedChatReplySuggestion | null;
+  /**
+   * List of the chat message attachments for the chat message.
+   * No more than one if "attachment_template" is set to "interaction"
+   */
+  attachments: NestedChatMessageAttachment[] | null;
+  /** Type of the chat message attachment template */
+  attachment_template: "generic" | "interaction" | "external";
+  /** Unique identifier of the message this message was a response to */
+  response_to_message_id: ChatMessageUid | null;
+  /** Unique identifier of the chosen attachment this was a response to */
+  response_to_attachment_id: ChatMessageAttachmentUid | null;
+  /** Chosen attachment this was a response to */
+  response_to_attachment: NestedChatMessageResponseAttachment | null;
+  /** Unique identifier of the chosen attachment action this was a response to */
+  response_to_action_id: ChatMessageAttachmentActionUid | null;
+  /** Chosen attachment action this was a response to */
+  response_to_action: NestedChatMessageAttachmentAction | null;
+  /** Response text of the attachment response. This field is required for interaction attachment response */
+  response_text: string | null;
+  /**
+   * Chosen attachment value of the response. If the chosen attachment was an action,
+   * then this is the value of the action. Otherwise this may be the attachment’s "title_link_url",
+   * "image_url", "image_link_url" or a link provided in text field
+   */
+  response_value: string | null;
+}
+interface DecryptedChatMessageUser extends DecryptedChatMessageCommon {
   /** Defines the type of the sender. "user" by default */
@@ -526,3 +593,3 @@ sender_type: "user";
 }
-interface DecryptedChatMessageVisitor {
+interface DecryptedChatMessageVisitor extends DecryptedChatMessageCommon {
   /** Defines the type of the sender. "user" by default */
@@ -533,3 +600,3 @@ sender_type: "visitor";
 }
-interface DecryptedChatMessageRule {
+interface DecryptedChatMessageRule extends DecryptedChatMessageCommon {
   /** Defines the type of the sender. "user" by default */
@@ -536,0 +603,0 @@ sender_type: "rule";

lib/public.d.ts

@@ -178,3 +178,28 @@ import { NestedAvatar } from "./customer";
   | PublicChatMessageRule;
-interface PublicChatMessagePayloadUser extends PublicChatMessageCommon {
+interface PublicChatMessagePayloadCommon {
+  /** Defines the type of the message. "msg" by default */
+  type: ChatMessageType;
+  /** Display name of the sender as the visitor would see it */
+  sender_public_name?: string;
+  /**
+   * Content text of the message. The maximum length is 2000 characters.
+   * This will always be the decrypted if the decryption key is still being stored at the server
+   */
+  message?: string | null;
+  /** Unique identifier of the message this message was a response to */
+  response_to_message_id?: ChatMessageUid | null;
+  /** Unique identifier of the chosen attachment this was a response to */
+  response_to_attachment_id?: ChatMessageAttachmentUid | null;
+  /** Unique identifier of the chosen attachment action this was a response to */
+  response_to_action_id?: ChatMessageAttachmentActionUid | null;
+  /** Response text of the attachment response. This field is required for interaction attachment response */
+  response_text?: string | null;
+  /**
+   * Chosen attachment value of the response. If the chosen attachment was an action,
+   * then this is the value of the action. Otherwise this may be the attachment’s "title_link_url",
+   * "image_url", "image_link_url" or a link provided in text field
+   */
+  response_value?: string | null;
+}
+interface PublicChatMessagePayloadUser extends PublicChatMessagePayloadCommon {
   /** Defines the type of the sender. "user" by default */
@@ -185,3 +210,3 @@ sender_type?: "user";
 }
-interface PublicChatMessagePayloadVisitor extends PublicChatMessageCommon {
+interface PublicChatMessagePayloadVisitor extends PublicChatMessagePayloadCommon {
   /** Defines the type of the sender. "user" by default */
@@ -192,3 +217,3 @@ sender_type?: "visitor";
 }
-interface PublicChatMessagePayloadRule extends PublicChatMessageCommon {
+interface PublicChatMessagePayloadRule extends PublicChatMessagePayloadCommon {
   /** Defines the type of the sender. "user" by default */
@@ -195,0 +220,0 @@ sender_type?: "rule";

package.json

 {
     "name": "@giosg/types",
-    "version": "1.2.12",
+    "version": "1.2.13",
     "description": "TypeScript interfaces for GiosgAPI",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

180916

increased by2.62%

Lines of code

5229

increased by1.79%

No dependency changes