zcatalyst-cli 1.13.2 → 1.14.0

package/templates/init/functions/python/integ/cliq/handlers/bot_handler.py

@@ -0,0 +1,174 @@
+import json
+from zcatalyst_cliq.bot_handler import (
+    welcome_handler,
+    message_handler,
+    context_handler,
+    mention_handler,
+    menu_action_handler,
+    webhook_handler,
+    participation_handler,
+    BotWelcomeHandlerRequest,
+    BotMessageHandlerRequest,
+    BotContextHandlerRequest,
+    BotMentionHandlerRequest,
+    BotMenuActionHandlerRequest,
+    BotParticipationHandlerRequest,
+    BotWebHookHandlerRequest,
+    HandlerResponse
+)
+from zcatalyst.catalyst_app import CatalystApp
+import logging
+
+@welcome_handler
+def welcome_handler_fn(req: BotWelcomeHandlerRequest, res: HandlerResponse, *args):
+    res.text = f'hello {req.user.first_name}'
+    return res
+
+
+@message_handler
+def msg_handler(req: BotMessageHandlerRequest, res: HandlerResponse, *args):
+    try:
+        msg = req.message
+        text = ''
+        if not msg:
+            text = 'Please enable \'Message\' in bot settings'
+        elif msg == 'hi' or msg == 'hello':
+            text = f'Hi {req.user.first_name} :smile: . How are you doing ??'
+
+            suggestions = res.new_suggestion_list()
+
+            suggestions.add_suggestions(
+                suggestions.new_suggestion('Good'),
+                suggestions.new_suggestion('Not Bad'),
+                suggestions.new_suggestion('meh'),
+                suggestions.new_suggestion('Worst'),
+            )
+            res.suggestions = suggestions
+        elif msg == 'Good' or msg == 'Not Bad':
+            text = 'That\'s glad to hear :smile:'
+        elif msg == 'meh' or msg == 'Worst':
+            text = "Oops! Don't you worry. Your day is definitely going to get better. :grinning:"
+        elif msg == 'details':
+            text = 'welcome to details collection center :wink:'
+            context = res.new_context()
+            context.id = 'personal_details'
+            context.timeout = 300
+
+            param1 = context.new_param()
+            param1.name = 'name'
+            param1.question = 'Please enter your name: '
+            
+            param2 = context.new_param()
+            param2.name = 'dept'
+            param2.question = 'Please enter your department: '
+            param2.add_suggestion('CSE')
+            param2.add_suggestion('IT')
+            param2.add_suggestion('MECH')
+
+            param3 = context.new_param()
+            param3.name = 'cache'
+            param3.question = "Do you wish to put this detail in Catalyst Cache ?"
+            param3.add_suggestion('YES')
+            param3.add_suggestion('NO')
+            
+            context.add_params(param1, param2, param3)
+            res.context = context
+        else:
+            text = "Oops! Sorry, I'm not programmed yet to do this :sad:"
+        res.set_text(text)
+        return res
+    except Exception as e:
+        logging.error(e)
+        return
+    
+@context_handler
+def ctx_handler(req: BotContextHandlerRequest, res: HandlerResponse, *args):
+    app: CatalystApp = args[0]
+    if req.context_id == 'personal_details':
+        answer = req.answers
+        name = answer.name.text
+        dept = answer.dept.text
+
+        text = f'Nice! I have collected your info: \n*Name*: {name} \n*Department*: {dept}'
+
+        if answer.cache.text == 'YES':
+            try:
+                default_segment = app.cache().segment()
+                default_segment.put('Name', name)
+                default_segment.put('Department', dept)
+                text += '\nThis data is now available in Catalyst Cache\'s default segment.'
+            except Exception as e:
+                logging.error(e)
+        res.set_text(text)
+    return res
+
+
+@mention_handler
+def mention_handler(req: BotMentionHandlerRequest, res: HandlerResponse, *args):
+    text = f"Hey *{req.user.first_name}*, thanks for mentioning me here. I'm from Catalyst city"
+    res.set_text(text);
+    return res
+
+
+@menu_action_handler
+def action(req: BotMenuActionHandlerRequest, res: HandlerResponse, *args):
+    text = '';
+    if req.action_name == 'Say Hi':
+        text = 'Hi'
+    elif req.action_name == 'Look Angry':
+        text = ':angry:'
+    else:
+        text = 'Menu action triggered :fist:'
+
+    res.set_text(text)
+    return res
+
+
+@participation_handler
+def participation(req: BotParticipationHandlerRequest, res: HandlerResponse, *args):
+    text = '';
+    if req.operation == 'added':
+        text = 'Hi. Thanks for adding me to the channel :smile:'
+    elif req.operation == 'removed':
+        text = 'Bye-Bye :bye-bye:'
+    else:
+        text = 'I\'m too a participant of this chat :wink:'
+
+    res.set_text(text)
+    return res
+
+@webhook_handler
+def webhook_fn(req: BotWebHookHandlerRequest, res: HandlerResponse, *args):
+    req_body: dict = json.loads(req.body)
+    post_json_msg = req_body.get('message')
+
+    res.bot = res.new_bot_details('PostPerson', 'https://www.zoho.com/sites/default/files/catalyst/functions-images/icon-robot.jpg')
+    
+    card = res.new_card()
+    card.title = 'New Mail'
+    card.thumbnail = 'https://www.zoho.com/sites/default/files/catalyst/functions-images/mail.svg'
+    res.card = card
+
+    button = res.new_button()
+    button.label = 'open mail'
+    button.type = '+'
+    button.hint = 'Click to open the mail in a new tab'
+
+    action = button.new_action_object()
+    action.type = 'open.url'
+
+    action_data = action.new_action_data_obj()
+    action_data.web = 'https://mail.zoho.com/zm/#mail/folder/inbox/p/${reqBody.messageId}'
+    
+    action.data = action_data
+    button.action= action
+
+    res.add_button(button)
+
+    gif_slide = res.new_slide()
+    gif_slide.type = 'images'
+    gif_slide.title = ''
+    gif_slide.data = ['https://media.giphy.com/media/efyEShk2FJ9X2Kpd7V/giphy.gif']
+    res.add_slides(gif_slide)
+
+    return res

package/templates/init/functions/python/integ/cliq/handlers/command_handler.py

@@ -0,0 +1,102 @@
+from typing import List
+import zcatalyst_cliq.command_handler as command
+from zcatalyst_cliq.command_handler import (
+    execution_handler,
+    suggestion_handler,
+    CommandHandlerRequest,
+    CommandSuggestion,
+    HandlerResponse
+)
+
+@execution_handler
+def executor(req: CommandHandlerRequest, res: HandlerResponse, *args):
+    text = ''
+    cmd = req.name
+    if cmd == 'catalyst':
+        suggestions = req.selections
+        if not suggestions:
+            text = 'Please select a suggestion from the command'
+        else:
+            prefix = 'Take a look at our ';
+            if suggestions[0].title == 'API doc':
+                text = prefix + '[API Documentation](https://www.zoho.com/catalyst/help/api/introduction/overview.html)'
+            elif suggestions[0].title == 'CLI doc':
+                text = prefix + '[CLI Documentation](https://www.zoho.com/catalyst/help/cli-command-reference.html)'
+            else:
+                text = prefix + '[help documentation](https://www.zoho.com/catalyst/help/)'
+    elif cmd == 'raisereq':
+        return get_form()
+    else:
+        text = 'Command executed successfully!'
+    res.text = text
+    return res
+
+
+@suggestion_handler
+def suggester(req: CommandHandlerRequest, res: List[CommandSuggestion], *args):
+    if req.name == 'catalyst':
+        suggestion1 = command.new_command_suggestion()
+        suggestion1.title = 'API doc'
+        suggestion1.description = 'Catalyst API documentation'
+        suggestion1.imageurl = 'https://www.zohowebstatic.com/sites/default/files/styles/product-home-page/public/catalyst-icon.png'
+
+        suggestion2 = command.new_command_suggestion()
+        suggestion2.title = 'CLI doc'
+        suggestion2.description = 'Catalyst CLI documentation'
+        suggestion2.imageurl = 'https://www.zohowebstatic.com/sites/default/files/styles/product-home-page/public/catalyst-icon.png'
+
+        suggestion3 = command.new_command_suggestion()
+        suggestion3.title = 'Help docs'
+        suggestion3.description = 'Catalyst help documentation'
+        suggestion3.imageurl = 'https://www.zohowebstatic.com/sites/default/files/styles/product-home-page/public/catalyst-icon.png'
+
+        res.extend([suggestion1,suggestion2,suggestion3])
+        return res
+
+
+def get_form():
+    form = command.new_handler_response().new_form()
+    form.title = 'Asset Request'
+    form.hint = 'Raise your asset request'
+    form.name = 'ID'
+    form.button_label = 'Raise Request'
+    form.version = 1
+
+    actions = form.new_form_actions_obj()
+    actions.submit = actions.new_form_action('PyFnForm');  # ENTER YOUR FORM FUNCTION NAME HERE
+
+    form.actions = actions
+
+    user_name = form.new_form_input()
+    user_name.type = 'text'
+    user_name.name = 'username'
+    user_name.label = 'Name'
+    user_name.hint = 'Please enter your name'
+    user_name.placeholder = 'John Reese'
+    user_name.mandatory = True
+    user_name.value = 'Harold Finch'
+    form.add_inputs(user_name)
+
+    email = form.new_form_input()
+    email.type = 'text'
+    email.format = 'email'
+    email.name = 'email'
+    email.label = 'Email'
+    email.hint = 'Enter your email address'
+    email.placeholder = "johnreese@poi.com"
+    email.mandatory = True
+    email.value = "haroldfinch@samaritan.com"
+    
+    asset_type = form.new_form_input()
+    asset_type.type = 'select'
+    asset_type.trigger_on_change = True
+    asset_type.name = 'asset_type'
+    asset_type.label = "Asset Type"
+    asset_type.hint = "Choose your request asset type"
+    asset_type.placeholder = "Mobile"
+    asset_type.mandatory = True
+    asset_type.add_options(asset_type.new_form_value('Laptop', 'laptop'))
+    asset_type.add_options(asset_type.new_form_value('Mobile', 'mobile'))
+    
+    form.add_inputs(email, asset_type)
+    return form

package/templates/init/functions/python/integ/cliq/handlers/function_handler.py

@@ -0,0 +1,409 @@
+from datetime import datetime
+from zcatalyst_cliq import function_handler
+from zcatalyst_cliq.function_handler import (
+    button_function_handler,
+    form_submit_handler,
+    form_change_handler,
+    form_dynamic_field_handler,
+    widget_button_handler,
+    ButtonFunctionRequest,
+    FormFunctionRequest,
+    WidgetFunctionRequest,
+    HandlerResponse,
+    FormChangeResponse,
+    FormDynamicFieldResponse,
+    WidgetResponse
+)
+
+
+@button_function_handler
+def button_fn_handler(req: ButtonFunctionRequest, res: HandlerResponse, *args):
+    res.text = 'Button function executed'
+    return res
+
+
+
+@form_submit_handler
+def form_submit(req: FormFunctionRequest, res: HandlerResponse, *args):
+    values = req.form.values
+    type = None
+    if hasattr(values,'type'):
+        type = values.type
+    if type:
+        if type == 'formTab':
+            widget_response = function_handler.new_widget_response()
+            widget_response.type = 'applet'
+
+            title_section = widget_response.new_widget_section()
+            title_section.id = '100'
+
+            edited_by = title_section.new_widget_element()
+            edited_by.type = 'title'
+            edited_by.text = 'Edited by ' + values.text + ' :wink:'
+
+            time = title_section.new_widget_element()
+            time.type = 'subtext'
+            time.text = 'Target:buttons\nTime : ' + str(datetime.now())
+
+            title_section.add_elements(edited_by, time)
+            widget_response.add_sections(title_section, get_button_section())
+            return widget_response
+        elif type == 'formsection':
+            section = function_handler.new_widget_response().new_widget_section()
+            section.id = '102'
+            section.type = 'section'
+
+            edited_by = section.new_widget_element()
+            edited_by.type = 'title'
+            edited_by.text = 'Edited by ' + values.text + ' :wink:'
+
+            section.add_elements(edited_by)
+
+            return section
+        else:
+            msg = function_handler.new_handler_response().new_message()
+            msg.text = 'Applet Button executed successfully'
+            msg.type = 'banner'
+            msg.status = 'success'
+            return msg
+        
+    text = f"Hi {values.username}, thanks for raising your request. Your request will be processed based on the device availability."
+    res.set_text(text)
+
+    card = res.new_card()
+    card.title = 'Asset Request'
+    res.card = card
+
+    slide = res.new_slide()
+    slide.type = 'label'
+    slide.title = ''
+
+    data_list = []
+    obj1 = {
+        'Asset type': values.asset_type.label
+    }
+    data_list.append(obj1)
+    if values.asset_type.value == 'mobile':
+        obj2= {
+            'Preferred OS': values.mobile_os.label
+        }
+        data_list.append(obj2)
+        obj3 = {
+            'Preferred Devices': values.mobile_list.label
+        }
+        data_list.append(obj3)
+    else:
+        obj2 = {
+            'Device Preferred': values.os_type.label
+        }
+        data_list.append(obj2)
+    slide.data = data_list
+    res.add_slides(slide)
+    return res
+
+
+@form_change_handler
+def change_form(req: FormFunctionRequest, res: FormChangeResponse, *args):
+    target = req.target.name
+    values = req.form.values
+    field_value = values.asset_type.value
+
+    if target == 'asset_type':
+        if field_value == 'laptop':
+            select_box_action = res.new_form_modification_action()
+            select_box_action.type = 'add_after'
+            select_box_action.name = 'asset_type'
+
+            os = select_box_action.new_form_input()
+            os.trigger_on_change = True
+            os.type = 'select'
+            os.name = 'os_type'
+            os.label = 'Laptop Type'
+            os.hint = 'Choose your preferred OS type'
+            os.placeholder = 'Ubuntu'
+            os.mandatory = True
+
+            mac = os.new_form_value()
+            mac.label = 'Mac OS X'
+            mac.value = 'mac'
+
+            windows = os.new_form_value()
+            windows.label = 'Windows'
+            windows.value = 'windows'
+
+            ubuntu = os.new_form_value()
+            ubuntu.label = 'Ubuntu'
+            ubuntu.value = 'ubuntu'
+
+            os.add_options(mac, windows, ubuntu)
+            select_box_action.input = os
+
+            remove_mobile_OSAction = res.new_form_modification_action()
+            remove_mobile_OSAction.type = 'remove'
+            remove_mobile_OSAction.name = 'mobile_os'
+
+            remove_mobile_list_action = res.new_form_modification_action()
+            remove_mobile_list_action.type = 'remove'
+            remove_mobile_list_action.name = 'mobile_list'
+
+            res.add_actions(select_box_action, remove_mobile_OSAction, remove_mobile_list_action)
+        
+        elif field_value == 'mobile':
+            select_box_action = res.new_form_modification_action()
+            select_box_action.type = 'add_after'
+            select_box_action.name = 'asset_type'
+
+            os = select_box_action.new_form_input()
+            os.trigger_on_change = True
+            os.type = 'select'
+            os.name = 'mobile_os'
+            os.label = 'Mobile OS'
+            os.hint = 'Choose your preferred mobile OS'
+            os.placeholder = 'Android'
+            os.mandatory = True
+
+            android = os.new_form_value()
+            android.label = 'Android'
+            android.value = 'android'
+
+            ios = os.new_form_value()
+            ios.label = 'iOS'
+            ios.value = 'ios'
+
+            os.add_options(android, ios)
+            select_box_action.input = os
+
+            remove_os_type_action = res.new_form_modification_action()
+            remove_os_type_action.type = 'remove'
+            remove_os_type_action.name = 'os_type'
+
+            res.add_actions(select_box_action, remove_os_type_action)
+
+    elif target == 'mobile_os':
+        if field_value:
+            mobile_list_action = res.new_form_modification_action()
+            mobile_list_action.type = 'add_after'
+            mobile_list_action.name = 'mobile_os'
+
+            list_input = mobile_list_action.new_form_input()
+            list_input.type = 'dynamic_select'
+            list_input.name = 'mobile_list'
+            list_input.label = 'Mobile Device'
+            list_input.placeholder = 'Choose your preferred mobile device'
+            list_input.mandatory = True
+            mobile_list_action.input = list_input
+
+            res.add_actions(mobile_list_action)
+        else:
+            remove_mobile_list_action = res.new_form_modification_action()
+            remove_mobile_list_action.type = 'remove';
+            remove_mobile_list_action.name = 'mobile_list'
+
+            res.add_actions(remove_mobile_list_action)
+
+    return res
+
+
+@form_dynamic_field_handler
+def handle_dynamic_field(req: FormFunctionRequest, res: FormDynamicFieldResponse, *args):
+    target = req.target
+    values = req.form.values
+
+    if target.name == 'mobile_list' and values.mobile_os:
+        device = values.mobile_os.value
+        if device == 'android':
+            mobile_list = ['One Plus 6T', 'One Plus 6', 'Google Pixel 3', 'Google Pixel 4']
+            for mobile in mobile_list:
+                res.add_options(res.new_form_value(mobile,mobile.lower().replace(' ','_')))
+        elif device == 'ios':
+            mobile_list = ['IPhone XR', 'IPhone XS', 'IPhone X', 'IPhone 13']
+            for mobile in mobile_list:
+                res.add_options(res.new_form_value(mobile,mobile.lower().replace(' ','_')))
+    return res
+
+
+@widget_button_handler
+def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
+
+    id = req.target.id
+    if id == 'tab':
+        res.type = 'applet'
+
+        title_section = res.new_widget_section()
+        title_section.id = '100'
+
+        time = title_section.new_widget_element()
+        time.type = 'subtext'
+        time.text = 'Target:buttons\nTime : ' + str(datetime.now())
+
+        title_section.add_elements(time)
+        res.add_sections(title_section, get_button_section())
+
+        return res
+    
+    elif id == 'section':
+        section = res.new_widget_section()
+        section.id = '102'
+        section.type = 'section'
+        element = section.new_widget_element()
+        element.type = 'title'
+        element.text = 'Edited :wink: '
+
+        section.add_elements(element)
+        return section
+
+    elif id == 'formTab' or id == 'formsection':
+        form = function_handler.new_handler_response().new_form()
+        form.title = 'Zylker Annual Marathon'
+        form.name = 'a'
+        form.hint = 'Register yourself for the Zylker Annual Marathon'
+        form.button_label = 'Submit'
+
+        input1 = form.new_form_input()
+        input1.type = 'text'
+        input1.name = 'text'
+        input1.label = 'Name'
+        input1.placeholder = 'Scott Fischer'
+        input1.min_length = '0'
+        input1.max_length = '25'
+        input1.mandatory = True
+
+        input2 = form.new_form_input()
+        input2.type = 'hidden'
+        input2.name = 'type'
+        input2.value = id
+
+        form.add_inputs(input1, input2)
+        form.action = form.new_form_action('PyFnForm'); # ** ENTER YOUR FORM FUNCTION NAME HERE **
+        return form
+
+    elif id == 'breadcrumbs':
+        page = str(int(req.target.label.split("Page : ")[1].rstrip()) + 1)
+
+        
+        section = res.new_widget_section()
+        section.id = '12345'
+
+        elem = section.new_widget_element()
+        elem.type = 'subtext';
+        elem.text = 'Page : ' + page
+        section.add_elements(elem)
+        res.add_sections(section)
+
+        first_nav = {
+            'label': 'Page : ' + page,
+            'type': 'invoke.function',
+            'name': 'PyFnWidgetButton',
+            'id': 'breadcrumbs'
+        }
+
+        link_button = {
+            'label': 'Link',
+            'type': 'open.url',
+            'url': 'https://www.zoho.com'
+        }
+
+        banner_button = {
+            'label': 'Banner',
+            'type': 'invoke.function',
+            'name': 'PyFnWidgetButton',
+            'id': 'banner'
+        }
+
+        res.header = {
+            'title' : 'Header ' + page,
+            'navigation' : 'continue',
+            'buttons' : [first_nav, link_button, banner_button]
+        }
+
+        res.footer = {
+            'text' : 'Footer text',
+            'buttons' : [link_button, banner_button]
+        }
+
+        res.type = 'applet'
+        return res
+    else:
+        msg = function_handler.new_handler_response().new_message()
+        msg.text = 'Applet Button executed successfully'
+        msg.type = 'banner'
+        msg.status = 'success'
+        return msg
+
+
+
+def get_button_section():
+    widget_response = function_handler.new_widget_response()
+
+    button_section = widget_response.new_widget_section()
+
+    title = button_section.new_widget_element()
+    title.type = 'title'
+    title.text = 'Buttons'
+
+    button_element1 = button_section.new_widget_element()
+    button_element1.type = 'buttons'
+
+    button1 = button_element1.new_widget_button()
+    button1.label = 'link'
+    button1.type = 'open.url'
+    button1.url = 'https://www.zoho.com'
+
+    button2 = button_element1.new_widget_button()
+    button2.label = 'Banner'
+    button2.type = 'invoke.function'
+    button2.name = 'PyFnWidgetButton'
+    button2.id = 'banner'
+
+    button3 = button_element1.new_widget_button()
+    button3.label = 'Open Channel'
+    button3.type = 'system.api'
+    button3.set_api('joinchannel/{{id}}', 'CT_1407724818712687474_72317143'); # ** ENTER YOUR CHANNEL ID HERE **
+
+    button4 = button_element1.new_widget_button()
+    button4.label = 'Preview'
+    button4.type = 'preview.url'
+    button4.url = 'https://www.zoho.com/catalyst/features.html'
+
+    button_element1.add_widget_buttons(button1,button2,button3)
+
+    #Buttons - Row2
+    button_element2 = button_section.new_widget_element()
+    button_element2.type = 'buttons'
+
+    button5 = button_element2.new_widget_button()
+    button5.label = 'Edit Section'
+    button5.type = 'invoke.function'
+    button5.name = 'PyFnWidgetButton'
+    button5.id = 'section'
+
+    button6 = button_element2.new_widget_button()
+    button6.label = 'Form Edit Section'
+    button6.type = 'invoke.function'
+    button6.name = 'PyFnWidgetButton'
+    button6.id = 'formsection'
+
+    button7 = button_element2.new_widget_button()
+    button7.label = 'Banner'
+    button7.type = 'invoke.function'
+    button7.name = 'PyFnWidgetButton'
+    button7.id = 'banner'
+
+    button8 = button_element2.new_widget_button()
+    button8.label = 'Edit Whole Tab'
+    button8.type = 'invoke.function'
+    button8.name = 'PyFnWidgetButton'
+    button8.id = 'tab'
+
+    button9 = button_element2.new_widget_button()
+    button9.label = 'Form Edit Tab'
+    button9.type = 'invoke.function'
+    button9.name = 'PyFnWidgetButton'
+    button9.id = 'formTab'
+
+    button_element2.add_widget_buttons(button5, button6, button7, button8, button9)
+
+    button_section.add_elements(title, button_element1, button_element2);
+    button_section.id = '101'
+
+    return button_section

package/templates/init/functions/python/integ/cliq/handlers/installation_handler.py

@@ -0,0 +1,12 @@
+from zcatalyst_cliq.installation_handler import (
+    handle_installation,
+    InstallationRequest,
+    InstallationResponse
+)
+
+
+@handle_installation
+def installation_handler(req: InstallationRequest, res: InstallationResponse, *args):
+    '''Logic for installation post handling'''
+    res.status = 200
+    return res