@periskope/types 0.6.142 → 0.6.144

package/dist/rules.types.js

@@ -0,0 +1,679 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionNameMap = exports.RuleNameMap = exports.isSendMessageAction = exports.FilterConditionMap = exports.ReactionVariableNameMap = exports.TicketVariableNameMap = exports.ChatVariableNameMap = exports.SenderVariableNameMap = exports.MessageVariableNameMap = exports.FilterNameMap = exports.isFilter = void 0;
+const isFilter = (filter) => {
+    return (typeof filter === 'object' &&
+        'id' in filter &&
+        'condition' in filter &&
+        'variable' in filter &&
+        'value' in filter);
+};
+exports.isFilter = isFilter;
+exports.FilterNameMap = {
+    CONTAINS: {
+        name: 'contains',
+        input: true,
+    },
+    NCONTAINS: {
+        name: 'does not contain',
+        input: true,
+    },
+    EQ: {
+        name: 'equals to',
+        input: true,
+    },
+    NEQ: {
+        name: 'not equals to',
+        input: true,
+    },
+    LT: {
+        name: 'less than',
+        input: true,
+    },
+    LTE: {
+        name: 'less than or equals to',
+        input: true,
+    },
+    GT: {
+        name: 'greater than',
+        input: true,
+    },
+    GTE: {
+        name: 'greater than or equals to',
+        input: true,
+    },
+    KNOWN: {
+        name: 'is known',
+        input: false,
+    },
+    NKNOWN: {
+        name: 'is not known',
+        input: false,
+    },
+    IS: {
+        name: 'is',
+        input: true,
+    },
+    NIS: {
+        name: 'is not',
+        input: true,
+    },
+};
+exports.MessageVariableNameMap = {
+    'message.body': {
+        text: 'Message Body',
+        type: 'string',
+        filters: ['CONTAINS', 'NCONTAINS', 'EQ', 'NEQ', 'KNOWN', 'NKNOWN'],
+    },
+    'message.sender_phone': {
+        text: 'Message Sender Phone',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+    },
+    'message.timestamp': {
+        text: 'Message Timestamp',
+        type: 'date',
+        filters: ['LT', 'LTE', 'GT', 'GTE', 'IS'],
+    },
+    'message.flag_status': {
+        text: 'Message Flag Status',
+        filters: ['IS'],
+        type: 'boolean',
+    },
+    'message.has_quoted_msg': {
+        text: 'Quoted Message',
+        filters: ['IS'],
+        type: 'boolean',
+    },
+    'message.media': {
+        text: 'Message Media',
+        type: 'boolean',
+        filters: ['KNOWN', 'NKNOWN'],
+    },
+    'message.performed_by': {
+        text: 'Message Performed By',
+        type: 'dropdown',
+        value: 'org.members',
+        filters: ['EQ', 'NEQ'],
+    },
+    "message.chat_id": {
+        text: 'Chat ID',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+        hidden: true
+    },
+    "message.message_id": {
+        text: 'Message ID',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+        hidden: true
+    }
+};
+exports.SenderVariableNameMap = {
+    'sender.is_business': {
+        // remove
+        text: 'Sender is business',
+        type: 'boolean',
+        filters: ['IS'],
+    },
+    'sender.is_enterprise': {
+        // remove
+        text: 'Sender is enterprise',
+        type: 'boolean',
+        filters: ['IS'],
+    },
+    'sender.is_internal': {
+        text: 'Sender is internal',
+        type: 'boolean',
+        filters: ['IS'],
+    },
+    'sender.contact_name': {
+        text: 'Sender Name',
+        type: 'string',
+        filters: ['EQ', 'NEQ', 'KNOWN', 'NKNOWN'],
+    },
+    'sender.contact_id': {
+        text: 'Sender Contact Phone',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+    },
+    'sender.labels': {
+        text: 'Sender Labels',
+        type: 'dropdown',
+        value: 'org.labels',
+        filters: ['EQ', 'NEQ'],
+    },
+};
+exports.ChatVariableNameMap = {
+    'chat.assigned_to': {
+        text: 'Chat Assignee',
+        type: 'dropdown',
+        value: 'org.members',
+        filters: ['EQ', 'NEQ', 'KNOWN', 'NKNOWN'],
+    },
+    'chat.chat_name': {
+        text: 'Chat Name',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+    },
+    'chat.org_phone': {
+        text: 'Chat Org Phone',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+    },
+    'chat.chat_type': {
+        text: 'Chat Type',
+        type: 'dropdown',
+        value: [
+            { id: 'user', value: 'user', label: 'User' },
+            { id: 'group', value: 'group', label: 'Group' },
+        ],
+        filters: ['EQ', 'NEQ'],
+    },
+    'chat.members': {
+        text: 'Chat Members',
+        type: 'string',
+        filters: ['CONTAINS', 'NCONTAINS', 'EQ', 'NEQ'],
+    },
+    'chat.labels': {
+        text: 'Chat Labels',
+        type: 'dropdown',
+        value: 'org.labels',
+        filters: ['CONTAINS', 'NCONTAINS'],
+    },
+    "chat.chat_id": {
+        text: 'Chat ID',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+    }
+};
+exports.TicketVariableNameMap = {
+    'ticket.subject': {
+        text: 'Ticket Subject',
+        type: 'string',
+        filters: ['CONTAINS', 'NCONTAINS', 'EQ', 'NEQ'],
+    },
+    'ticket.status': {
+        text: 'Ticket Status',
+        type: 'dropdown',
+        value: [
+            { id: 'open', value: 'open', label: 'Open' },
+            { id: 'closed', value: 'closed', label: 'Closed' },
+            { id: 'inprogress', value: 'inprogress', label: 'In progress' },
+        ],
+        filters: ['EQ', 'NEQ'],
+    },
+    'ticket.priority': {
+        text: 'Ticket Priority',
+        type: 'dropdown',
+        value: [
+            { id: '0', value: '0', label: 'No Prioriy' },
+            { id: '1', value: '1', label: 'Low' },
+            { id: '2', value: '2', label: 'Medium' },
+            { id: '3', value: '3', label: 'High' },
+            { id: '4', value: '4', label: 'Urgent' },
+        ],
+        filters: ['EQ', 'NEQ'],
+    },
+    'ticket.assignee': {
+        text: 'Ticket Assignee',
+        type: 'dropdown',
+        value: 'org.members',
+        filters: ['EQ', 'NEQ'],
+    },
+    'ticket.labels': {
+        text: 'Ticket Labels',
+        type: 'dropdown',
+        value: 'org.labels',
+        filters: ['EQ', 'NEQ'],
+    },
+    'ticket.is_deleted': {
+        text: 'Ticket is deleted',
+        type: 'boolean',
+        filters: ['IS'],
+    },
+    'ticket.raised_by': {
+        text: 'Ticket Raised By',
+        type: 'dropdown',
+        value: 'org.members',
+        filters: ['EQ', 'NEQ'],
+    },
+    'ticket.due_date': {
+        text: 'Ticket Due Date',
+        type: 'date',
+        filters: ['LT', 'LTE', 'GT', 'GTE'],
+    },
+    'ticket.assigned_by': {
+        text: 'Ticket assignee',
+        type: 'dropdown',
+        value: 'org.members',
+        filters: ['EQ', 'NEQ'],
+    },
+    "ticket.ticket_id": {
+        text: 'Ticket ID',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+        hidden: true
+    }
+};
+exports.ReactionVariableNameMap = {
+    'reaction.reaction': {
+        text: 'Reaction',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+    },
+    'reaction.sender_id': {
+        text: 'Reaction Sender Phone',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+    },
+    'reaction.message_id': {
+        text: 'Reaction Message ID',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+        hidden: true
+    },
+    "reaction.chat_id": {
+        text: 'Chat ID',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+        hidden: true
+    },
+    "reaction.reaction_id": {
+        text: 'Reaction ID',
+        type: 'string',
+        filters: ['EQ', 'NEQ'],
+        hidden: true
+    }
+};
+var FilterConditionMap;
+(function (FilterConditionMap) {
+    FilterConditionMap["CONTAINS"] = "contains";
+    FilterConditionMap["NCONTAINS"] = "does not contain";
+    FilterConditionMap["EQ"] = "=";
+    FilterConditionMap["NEQ"] = "<>";
+    FilterConditionMap["LT"] = "<";
+    FilterConditionMap["LTE"] = "<=";
+    FilterConditionMap["GT"] = ">";
+    FilterConditionMap["GTE"] = ">=";
+    FilterConditionMap["KNOWN"] = "is known";
+    FilterConditionMap["NKNOWN"] = "is not known";
+    FilterConditionMap["IS"] = "=";
+    FilterConditionMap["NIS"] = "<>";
+})(FilterConditionMap || (exports.FilterConditionMap = FilterConditionMap = {}));
+const isSendMessageAction = (action) => {
+    return action.type === 'send_message';
+};
+exports.isSendMessageAction = isSendMessageAction;
+exports.RuleNameMap = {
+    'message.created': {
+        title: 'New Message Received',
+        description: 'When a new message is sent or received',
+        base_conditions: {
+            org_phone: true,
+        },
+    },
+    'chat.created': {
+        title: 'New Chat Created',
+        description: 'When a new chat is created',
+        base_conditions: {
+            org_phone: true,
+        },
+    },
+    'ticket.created': {
+        title: 'New Ticket Created',
+        description: 'When a new ticket is created',
+        base_conditions: {
+            org_phone: false,
+        },
+    },
+    'reaction.added': {
+        title: 'New Reaction Added',
+        description: 'When a reaction is added on a message',
+        base_conditions: {
+            org_phone: true,
+        },
+    },
+    'message.updated': {
+        title: 'Message Updated',
+        description: 'When a message is updated',
+        base_conditions: {
+            org_phone: true,
+        },
+    },
+    'ticket.updated': {
+        title: 'Ticket Updated',
+        description: 'When a ticket is updated',
+        base_conditions: {
+            org_phone: false,
+        },
+    },
+    'chat.label.updated': {
+        title: 'Chat Label Added/Removed',
+        description: 'When labels on chats are updated',
+        base_conditions: {
+            org_phone: false,
+        },
+    },
+    'message.flagged': {
+        title: 'Message Flagged',
+        description: 'When a message is flagged',
+        base_conditions: {
+            org_phone: true,
+        },
+    },
+};
+exports.ActionNameMap = {
+    send_message: {
+        title: 'Send Message',
+        description: 'Send a message',
+        inputs: {
+            message: {
+                id: 'message',
+                type: 'editor',
+                label: 'Message',
+                placeholder: 'Enter message',
+                value: null,
+            },
+            media: {
+                id: 'media',
+                type: 'file',
+                label: 'Media',
+                placeholder: 'Upload media',
+                value: null,
+            },
+        },
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'chat.created',
+            'ticket.updated',
+            'ticket.created',
+            'reaction.added',
+            'message.flagged',
+        ],
+    },
+    reply_to_message: {
+        title: 'Reply to message',
+        description: 'Send a message with the quoted message',
+        inputs: {
+            message: {
+                id: 'message',
+                type: 'editor',
+                label: 'Message',
+                placeholder: 'Enter message',
+                value: null,
+            },
+            media: {
+                id: 'media',
+                type: 'file',
+                label: 'Media',
+                placeholder: 'Upload media',
+                value: null,
+            },
+        },
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'reaction.added',
+            'message.flagged',
+        ],
+    },
+    notify_http: {
+        title: 'Notify HTTP',
+        description: 'Notify an HTTP endpoint',
+        inputs: {
+            url: {
+                id: 'url',
+                type: 'text',
+                label: 'URL',
+                placeholder: 'Enter URL',
+                value: null,
+            },
+        },
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'chat.created',
+            'ticket.updated',
+            'ticket.created',
+            'reaction.added',
+            'message.flagged',
+        ],
+    },
+    create_ticket: {
+        title: 'Create Ticket',
+        description: 'Create a ticket',
+        inputs: {
+            assignee: {
+                id: 'assignee',
+                type: 'dropdown',
+                value: 'org.members',
+                label: 'Assignee',
+                placeholder: 'Select assignee',
+            },
+            priority: {
+                id: 'priority',
+                type: 'dropdown',
+                value: [
+                    { id: '0', value: '0', label: 'Low' },
+                    { id: '1', value: '1', label: 'Medium' },
+                    { id: '2', value: '2', label: 'High' },
+                    { id: '3', value: '3', label: 'Urgent' },
+                    { id: '4', value: '4', label: 'Immediate' },
+                ],
+                label: 'Priority',
+                placeholder: 'Select priority',
+            },
+            label: {
+                id: 'label',
+                type: 'dropdown',
+                value: 'ticket.labels',
+                label: 'Label',
+                placeholder: 'Select label',
+            },
+        },
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'chat.created',
+            'reaction.added',
+            'message.flagged',
+        ],
+    },
+    flag_message: {
+        title: 'Update flag status',
+        description: 'Flag/Unflag a message',
+        inputs: {
+            flag: {
+                id: 'flag',
+                type: 'dropdown',
+                value: [
+                    { id: 'flag', value: 'true', label: 'TRUE' },
+                    { id: 'unflag', value: 'false', label: 'FALSE' },
+                ],
+                label: 'Flag status',
+                placeholder: 'Select flag',
+            },
+        },
+        validTriggers: ['message.created', 'message.updated', 'reaction.added'],
+    },
+    assign_ticket: {
+        title: 'Assign Ticket',
+        description: 'Assign a ticket',
+        inputs: {
+            assignee: {
+                id: 'assignee',
+                type: 'dropdown',
+                value: 'org.members',
+                label: 'Assignee',
+                placeholder: 'Select assignee',
+            },
+        },
+        validTriggers: ['ticket.updated', 'ticket.created'],
+    },
+    close_ticket: {
+        title: 'Close Ticket',
+        description: 'Close a ticket',
+        inputs: {
+            closing_note: {
+                id: 'closing_note',
+                type: 'textarea',
+                label: 'Closing Note',
+                placeholder: 'Enter closing note',
+                value: null,
+            },
+        },
+        validTriggers: ['ticket.updated', 'ticket.created'],
+    },
+    add_chat_label: {
+        title: 'Add Chat Label',
+        description: 'Add a label to referred chat',
+        inputs: {
+            label: {
+                id: 'label',
+                type: 'dropdown',
+                value: 'chat.labels',
+                label: 'Label',
+                placeholder: 'Select label',
+            },
+        },
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'chat.created',
+            'ticket.updated',
+            'ticket.created',
+            'reaction.added',
+        ],
+    },
+    add_ticket_label: {
+        title: 'Add Ticket Label',
+        description: 'Add a label to referred ticket',
+        inputs: {
+            label: {
+                id: 'label',
+                type: 'dropdown',
+                value: 'ticket.labels',
+                label: 'Label',
+                placeholder: 'Select label',
+            },
+        },
+        validTriggers: ['ticket.updated', 'ticket.created'],
+    },
+    update_custom_property: {
+        description: 'Update a custom property',
+        title: 'Update Chat Custom Property',
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'chat.created',
+            'ticket.updated',
+            'ticket.created',
+            'reaction.added',
+            'message.flagged',
+        ],
+        inputs: {
+            property_id: {
+                id: 'property_id',
+                type: 'dropdown',
+                value: 'org.custom_properties',
+                label: 'Property',
+                placeholder: 'Select property',
+            },
+            value: {
+                id: 'value',
+                type: 'dynamic',
+                label: 'Value',
+                placeholder: 'Enter value',
+                value: 'custom_property_values',
+            },
+        }
+    },
+    assign_chat: {
+        title: 'Assign Chat',
+        description: 'Assign a chat',
+        inputs: {
+            assignee: {
+                id: 'assignee',
+                type: 'dropdown',
+                value: 'org.members',
+                label: 'Assignee',
+                placeholder: 'Select assignee',
+            },
+        },
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'chat.created',
+            'ticket.updated',
+            'ticket.created',
+            'reaction.added',
+        ],
+    },
+    forward_message: {
+        title: 'Forward Message',
+        description: 'Forward a message',
+        inputs: {
+            chat_id: {
+                id: 'chat_id',
+                type: 'dropdown',
+                value: 'org.chats',
+                label: 'Chat',
+                placeholder: 'Select chat',
+            },
+            prefix: {
+                id: 'prefix',
+                type: 'editor',
+                label: 'Prefix',
+                placeholder: 'Enter prefix',
+                value: null,
+            },
+        },
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'chat.created',
+            'ticket.updated',
+            'ticket.created',
+            'reaction.added',
+            'message.flagged',
+        ],
+    },
+    send_email: {
+        title: 'Send Email',
+        description: 'Send an email',
+        inputs: {
+            email: {
+                id: 'email',
+                type: 'text',
+                label: 'Email',
+                placeholder: 'Enter email',
+                value: null,
+            },
+            subject: {
+                id: 'subject',
+                type: 'text',
+                label: 'Subject',
+                placeholder: 'Enter subject',
+                value: null,
+            },
+            body: {
+                id: 'body',
+                type: 'editor',
+                label: 'Body',
+                placeholder: 'Enter body',
+                value: null,
+            },
+        },
+        validTriggers: [
+            'message.created',
+            'message.updated',
+            'chat.created',
+            'ticket.updated',
+            'ticket.created',
+            'reaction.added',
+            'message.flagged',
+        ],
+    },
+};