zcatalyst-cli 1.18.0-beta.9 → 1.18.1

package/templates/init/functions/python/event/sample.py

@@ -7,12 +7,16 @@ def handler(event, context):
 
     '''Event Functionalities'''
     data = event.get_data()  # event data
+    raw_data = event.get_raw_data() # raw event data
     time = event.get_time()  # event occurred time
-    action = event.get_action()
-    source_details = event.get_source()
-    source_entity_id = event.get_source_entity_id()
-    event_bus_details = event.get_event_bus_details()
-    project_details = event.get_project_details()
+    action = event.get_action() # get event action
+    source_details = event.get_source() # get event source
+    source_entity_id = event.get_source_entity_id() # get the source entity id
+    event_bus_details = event.get_event_bus_details() # get event bus details
+    project_details = event.get_project_details() # get project details
+
+    logging.info('event data: ' + str(data))
+    logging.info('raw data: ' + str(raw_data))
 
     '''Context Functionalities'''
     # remaining_execution_time_ms = context.get_remaining_execution_time_ms()

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

@@ -1,4 +1,6 @@
 import json
+import logging
+
 from zcatalyst_cliq.bot_handler import (
     welcome_handler,
     message_handler,
@@ -7,6 +9,7 @@ from zcatalyst_cliq.bot_handler import (
     menu_action_handler,
     webhook_handler,
     participation_handler,
+    call_handler,
     BotWelcomeHandlerRequest,
     BotMessageHandlerRequest,
     BotContextHandlerRequest,
@@ -14,10 +17,12 @@ from zcatalyst_cliq.bot_handler import (
     BotMenuActionHandlerRequest,
     BotParticipationHandlerRequest,
     BotWebHookHandlerRequest,
-    HandlerResponse
+    HandlerResponse, 
+    BotCallHandlerRequest
 )
-from zcatalyst_sdk.catalyst_app import CatalystApp
-import logging
+from zcatalyst_cliq.response_types import VoidResponse
+from zcatalyst_sdk import CatalystApp
+
 
 @welcome_handler
 def welcome_handler_fn(req: BotWelcomeHandlerRequest, res: HandlerResponse, *args):
@@ -172,3 +177,8 @@ def webhook_fn(req: BotWebHookHandlerRequest, res: HandlerResponse, *args):
     res.add_slides(gif_slide)
 
     return res
+
+@call_handler
+def call(req: BotCallHandlerRequest, res:VoidResponse):
+    # Logic for bot call post handling
+    return res

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

@@ -1,4 +1,5 @@
 from typing import List
+
 import zcatalyst_cliq.command_handler as command
 from zcatalyst_cliq.command_handler import (
     execution_handler,
@@ -12,7 +13,7 @@ from zcatalyst_cliq.command_handler import (
 def executor(req: CommandHandlerRequest, res: HandlerResponse, *args):
     text = ''
     cmd = req.name
-    if cmd == 'catalyst':
+    if cmd == 'catalystresource':
         suggestions = req.selections
         if not suggestions:
             text = 'Please select a suggestion from the command'
@@ -24,7 +25,7 @@ def executor(req: CommandHandlerRequest, res: HandlerResponse, *args):
                 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':
+    elif cmd == 'getform':
         return get_form()
     else:
         text = 'Command executed successfully!'
@@ -34,7 +35,7 @@ def executor(req: CommandHandlerRequest, res: HandlerResponse, *args):
 
 @suggestion_handler
 def suggester(req: CommandHandlerRequest, res: List[CommandSuggestion], *args):
-    if req.name == 'catalyst':
+    if req.name == 'catalystresource':
         suggestion1 = command.new_command_suggestion()
         suggestion1.title = 'API doc'
         suggestion1.description = 'Catalyst API documentation'
@@ -52,6 +53,7 @@ def suggester(req: CommandHandlerRequest, res: List[CommandSuggestion], *args):
 
         res.extend([suggestion1,suggestion2,suggestion3])
         return res
+    return [command.new_command_suggestion()]
 
 
 def get_form():
@@ -62,10 +64,8 @@ def get_form():
     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
+    action = form.new_form_action('formFunctionLatest') # ENTER YOUR FORM FUNCTION NAME HERE
+    form.action = action
 
     user_name = form.new_form_input()
     user_name.type = 'text'

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

@@ -0,0 +1,25 @@
+from zcatalyst_cliq.extension_handler import validate_installation, ExtensionHandlerRequest, handle_installation, \
+    handle_uninstallation
+from zcatalyst_cliq.response_types import InstallationResponse, VoidResponse
+
+
+@validate_installation
+def validate_installation(req: ExtensionHandlerRequest,res: InstallationResponse, *args):
+    if req.user.first_name == '**INVALID_USER**' and req.app_info.type == 'upgrade':
+        res.status = 400
+        res.title = 'Update not allowed !'
+        res.message = 'Sorry. Update not allowed for the current app. Please contact admin.'
+    else:
+        res.status = 200
+    return res
+
+@handle_installation
+def installation_handler(req: ExtensionHandlerRequest, res: InstallationResponse, *args):
+    '''Logic for installation post handling'''
+    res.status = 200
+    return res
+
+@handle_uninstallation
+def handle_uninstallation(req: ExtensionHandlerRequest, res: VoidResponse, *args):
+    # Logic for uninstallation post handling
+    return res

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

@@ -1,4 +1,5 @@
 from datetime import datetime
+
 from zcatalyst_cliq import function_handler
 from zcatalyst_cliq.function_handler import (
     button_function_handler,
@@ -12,8 +13,10 @@ from zcatalyst_cliq.function_handler import (
     HandlerResponse,
     FormChangeResponse,
     FormDynamicFieldResponse,
-    WidgetResponse
+    WidgetResponse,
+    form_view_handler
 )
+from zcatalyst_cliq.response_types import Form
 
 
 @button_function_handler
@@ -221,6 +224,47 @@ def handle_dynamic_field(req: FormFunctionRequest, res: FormDynamicFieldResponse
                 res.add_options(res.new_form_value(mobile,mobile.lower().replace(' ','_')))
     return res
 
+@form_view_handler
+def form_view_handler(req: FormFunctionRequest, res: Form):
+    res.title = 'Asset Request'
+    res.hint = 'Raise your asset request'
+    res.name = 'ID'
+    res.button_label = 'Raise Request'
+    res.version = 1
+
+    user_name = res.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'
+    res.add_inputs(user_name)
+
+    email = res.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 = res.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'))
+
+    res.add_inputs(email, asset_type)
+    return res
 
 @widget_button_handler
 def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
@@ -274,7 +318,7 @@ def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
         input2.value = id
 
         form.add_inputs(input1, input2)
-        form.action = form.new_form_action('PyFnForm') # ** ENTER YOUR FORM FUNCTION NAME HERE **
+        form.action = form.new_form_action('appletForm') # ** ENTER YOUR FORM FUNCTION NAME HERE **
         return form
 
     elif id == 'breadcrumbs':
@@ -293,7 +337,7 @@ def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
         first_nav = {
             'label': 'Page : ' + page,
             'type': 'invoke.function',
-            'name': 'PyFnWidgetButton',
+            'name': 'appletFunction',
             'id': 'breadcrumbs'
         }
 
@@ -306,7 +350,7 @@ def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
         banner_button = {
             'label': 'Banner',
             'type': 'invoke.function',
-            'name': 'PyFnWidgetButton',
+            'name': 'appletFunction',
             'id': 'banner'
         }
 
@@ -352,7 +396,7 @@ def get_button_section():
     button2 = button_element1.new_widget_button()
     button2.label = 'Banner'
     button2.type = 'invoke.function'
-    button2.name = 'PyFnWidgetButton'
+    button2.name = 'appletFunction'
     button2.id = 'banner'
 
     button3 = button_element1.new_widget_button()
@@ -374,31 +418,31 @@ def get_button_section():
     button5 = button_element2.new_widget_button()
     button5.label = 'Edit Section'
     button5.type = 'invoke.function'
-    button5.name = 'PyFnWidgetButton'
+    button5.name = 'appletFunction'
     button5.id = 'section'
 
     button6 = button_element2.new_widget_button()
     button6.label = 'Form Edit Section'
     button6.type = 'invoke.function'
-    button6.name = 'PyFnWidgetButton'
+    button6.name = 'appletFunction'
     button6.id = 'formsection'
 
     button7 = button_element2.new_widget_button()
     button7.label = 'Banner'
     button7.type = 'invoke.function'
-    button7.name = 'PyFnWidgetButton'
+    button7.name = 'appletFunction'
     button7.id = 'banner'
 
     button8 = button_element2.new_widget_button()
     button8.label = 'Edit Whole Tab'
     button8.type = 'invoke.function'
-    button8.name = 'PyFnWidgetButton'
+    button8.name = 'appletFunction'
     button8.id = 'tab'
 
     button9 = button_element2.new_widget_button()
     button9.label = 'Form Edit Tab'
     button9.type = 'invoke.function'
-    button9.name = 'PyFnWidgetButton'
+    button9.name = 'appletFunction'
     button9.id = 'formTab'
 
     button_element2.add_widget_buttons(button5, button6, button7, button8, button9)

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

@@ -0,0 +1,76 @@
+from typing import List
+
+from zcatalyst_cliq.handler_response import HandlerResponse
+from zcatalyst_cliq.link_preview_handler import (preview_handler, LinkPreviewHandlerRequest, action_handler,
+                                                 menu_handler, after_send_handler, new_oembed_actions)
+from zcatalyst_cliq.response_types import UnfurlResponse, OembedActions, OembedFieldData
+
+
+@preview_handler
+def preview_handler(req: LinkPreviewHandlerRequest,res: UnfurlResponse):
+    res.type = 'link'
+    res.title = 'Release checklist | Zoho Cliq'
+    res.provider_url = 'https://www.zoho.com/cliq/'
+    res.description = 'Release checklist for Cliq 5.0 (Focused on Enterprise and Intelligence)'
+    res.dynamic_actions = True
+
+    fields = res.new_oembed_fields()
+    fieldsData: List[OembedFieldData] = list()
+    fieldsData.append(fields.new_oembed_field_data('Created By', 'Scott fisher'))
+    fieldsData.append(fields.new_oembed_field_data('Created On', '10 Aug, 2023'))
+    fieldsData.append(fields.new_oembed_field_data('Last Modified On', '11 Aug, 2023'))
+    fieldsData.append(fields.new_oembed_field_data('Tags', '#unfurling_via_extensions #images_and_cards #cliq_360 #Cliq_5.0'))
+    fields.data = fieldsData
+    res.fields = fields
+
+    actions: List[OembedActions] = list()
+    action = res.new_oembed_actions()
+    action.type = 'button'
+    action.label = 'Add Comment'
+
+    confirm = action.new_confirm()
+    confirm.title = 'Comment'
+    confirm.description = 'Add your comment to the notes'
+    confirm.input = 'Type here...'
+    action.confirm = confirm
+
+    params = {'action': 'add_comment'}
+    action.params = params
+    actions.append(action)
+    res.actions = actions
+
+    return res
+
+@action_handler
+def action_handler(req: LinkPreviewHandlerRequest,res: HandlerResponse):
+    target: dict = vars(req.target)
+    params = vars(target.get('params'))
+    action = params.get('action')
+    text = ""
+    if action == "add_comment":
+        text = "Your comment has been added successfully"
+    elif action == "delete_note":
+        text = "Release checklist | Zoho Cliq note has been deleted"
+    elif action == "mark_as_favorite":
+        text = "Release checklist | Zoho Cliq note has been marked as favorite"
+    return res.new_banner(text,'success')
+
+@menu_handler
+def menu_handler(req: LinkPreviewHandlerRequest,res: List[OembedActions]):
+    action1 = new_oembed_actions()
+    action1.type = 'button'
+    action1.label = 'Delete'
+    action1.params = {'action': 'delete_note'}
+
+    action2 = new_oembed_actions()
+    action2.type = 'button'
+    action2.label = 'Mark as Favorite'
+    action2.params = {'action': 'mark_as_favorite'}
+    res.extend([action1,action2])
+
+    return res
+
+
+@after_send_handler
+def after_send_handler(req: LinkPreviewHandlerRequest,res: HandlerResponse):
+    return res.new_banner("Release checklist | Zoho Cliq 5.0','success")

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

@@ -1,4 +1,5 @@
 import datetime
+
 from zcatalyst_cliq.widget_handler import (
     view_handler,
     WidgetExecutionHandlerRequest,
@@ -52,7 +53,7 @@ def view_handler(req: WidgetExecutionHandlerRequest, res: WidgetResponse, *args)
         fn_button = fn_title.new_widget_button()
         fn_button.type = 'invoke.function'
         fn_button.label = 'Click here'
-        fn_button.name = 'PyFnWidgetButton' # ** ENTER YOUR WIDGET FUNCTION NAME **
+        fn_button.name = 'appletFunction' # ** ENTER YOUR WIDGET FUNCTION NAME **
         fn_button.id = 'widgetFn'
         fn_title.add_widget_buttons(fn_button)
 
@@ -179,7 +180,7 @@ def view_handler(req: WidgetExecutionHandlerRequest, res: WidgetResponse, *args)
             button2 = button_element1.new_widget_button()
             button2.label = 'Applet Button'
             button2.type = 'invoke.function'
-            button2.name = 'PyFnWidgetButton'
+            button2.name = 'appletFunction'
             button2.id = 'banner'
 
             button3 = button_element1.new_widget_button()
@@ -202,31 +203,31 @@ def view_handler(req: WidgetExecutionHandlerRequest, res: WidgetResponse, *args)
             button5 = button_element2.new_widget_button()
             button5.label = 'Edit Section'
             button5.type = 'invoke.function'
-            button5.name = 'PyFnWidgetButton'
+            button5.name = 'appletFunction'
             button5.id = 'section'
 
             button6 = button_element2.new_button_object()
             button6.label = 'Form Edit Section'
             button6.type = 'invoke.function'
-            button6.name = 'PyFnWidgetButton'
+            button6.name = 'appletFunction'
             button6.id = 'formsection'
 
             button7 = button_element2.new_button_object()
             button7.label = 'Banner'
             button7.type = 'invoke.function'
-            button7.name = 'PyFnWidgetButton'
+            button7.name = 'appletFunction'
             button7.id = 'banner'
 
             button8 = button_element2.new_button_object()
             button8.label = 'Edit Whole Tab'
             button8.type = 'invoke.function'
-            button8.name = 'PyFnWidgetButton'
+            button8.name = 'appletFunction'
             button8.id = 'tab'
 
             button9 = button_element2.new_button_object()
             button9.label = 'Form Edit Tab'
             button9.type = 'invoke.function'
-            button9.name = 'PyFnWidgetButton'
+            button9.name = 'appletFunction'
             button9.id = 'formTab'
 
             button_element2.add_widget_buttons(button5, button6, button7, button8, button9)
@@ -239,7 +240,7 @@ def view_handler(req: WidgetExecutionHandlerRequest, res: WidgetResponse, *args)
     first_nav = {
         'label': 'Page : 1',
         'type': 'invoke.function',
-        'name': 'PyFnWidgetButton',
+        'name': 'appletFunction',
         'id': 'breadcrumbs'
     }
    
@@ -252,7 +253,7 @@ def view_handler(req: WidgetExecutionHandlerRequest, res: WidgetResponse, *args)
     banner_button = {
         'label': 'Banner',
         'type': 'invoke.function',
-        'name': 'PyFnWidgetButton',
+        'name': 'appletFunction',
         'id': 'banner'
     }
 

package/templates/init/functions/python/integ/cliq/sample.py

@@ -5,11 +5,11 @@ config = {
         "handlers": {
             "bot_handler": "handlers/bot_handler.py",
             "function_handler": "handlers/function_handler.py",
-            "installation_validator": "handlers/installation_validator.py",
+            "extension_handler": "handlers/extension_handler.py",
             "command_handler": "handlers/command_handler.py",
             "widget_handler": "handlers/widget_handler.py",
             "messageaction_handler": "handlers/message_action_handler.py",
-            "installation_handler": "handlers/installation_handler.py"
+            "link_preview_handler": "handlers/link_preview_handler.py"
         }
     },
 }

package/templates/init.txt

@@ -7,7 +7,8 @@ catalyst.initApp({
 	zaid : "{{__ZAID__}}", //No I18N
 	auth_domain : "{{__AUTH_DOMAIN__}}",
 	is_appsail : "true",
-	api_domain : ""
+	api_domain : "",
+	stratus_domain: "{{_STRATUS_DOMAIN__}}"
 },{
 	org_id: "{{__ORG_ID__}}" //No I18N
 });

package/templates/init/functions/java/integ/cliq/com/handlers/InstallationHandler.java

@@ -1,20 +0,0 @@
-//$Id$
-package com.handlers;
-
-import com.zc.cliq.enums.STATUS;
-import com.zc.cliq.objects.InstallationResponse;
-import com.zc.cliq.requests.InstallationRequest;
-
-public class InstallationHandler implements com.zc.cliq.interfaces.InstallationHandler {
-	@Override
-	public InstallationResponse handleInstallation(InstallationRequest req) throws Exception {
-		InstallationResponse resp = InstallationResponse.getInstance();
-		/*
-		 * // Logic for installation post handling {
-		 * 
-		 * }
-		 */
-		resp.setStatus(STATUS.SUCCESS);
-		return resp;
-	}
-}

package/templates/init/functions/java/integ/cliq/com/handlers/InstallationValidator.java

@@ -1,22 +0,0 @@
-//$Id$
-package com.handlers;
-
-import com.zc.cliq.enums.EXTENSION_TYPE;
-import com.zc.cliq.enums.STATUS;
-import com.zc.cliq.objects.InstallationResponse;
-import com.zc.cliq.requests.InstallationRequest;
-
-public class InstallationValidator implements com.zc.cliq.interfaces.InstallationValidator {
-	@Override
-	public InstallationResponse validateInstallation(InstallationRequest req) throws Exception {
-		InstallationResponse resp = InstallationResponse.getInstance();
-		if (req.getUser().getFirstName().equals("**INVALID_USER**") && req.getAppInfo().getType().equals(EXTENSION_TYPE.UPGRADE)) {
-			resp.setStatus(STATUS.FAILURE);
-			resp.setTitle("Update not allowed !");
-			resp.setMessage("Sorry. Update not allowed for the current app. Please contact admin.");
-		} else {
-			resp.setStatus(STATUS.SUCCESS);
-		}
-		return resp;
-	}
-}

package/templates/init/functions/node/integ/cliq/handlers/installation-handler.js

@@ -1,15 +0,0 @@
-'use strict';
-import Cliq from 'zcatalyst-integ-cliq';
-const installationHandler = Cliq.installationHandler();
-
-installationHandler.handleInstallation(async (req, res) => {
-    /* 
-    // Logic for installation post handling
-    *{
-    *
-    *}
-    */
-
-   res.status = 200;
-   return res;
-});

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

@@ -1,12 +0,0 @@
-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

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

@@ -1,16 +0,0 @@
-from zcatalyst_cliq.installation_validator import (
-    validate_installation,
-    InstallationRequest,
-    InstallationResponse
-)
-
-
-@validate_installation
-def validate_installation(req: InstallationRequest, res: InstallationResponse, *args):
-    if req.user.first_name == '**INVALID_USER**' and req.app_info.type == 'upgrade':
-        res.status = 400
-        res.title = 'Update not allowed !'
-        res.message = 'Sorry. Update not allowed for the current app. Please contact admin.'
-    else:
-        res.status = 200
-    return res