docs(samples) - streamliine and clarify webhook samples (#264)

* streamline and clarify webhook samples

Change-Id: I80d80b42f60ac6ccc643afb7b2931916d6843813

* remove sessionInfo config

Change-Id: I1b14852ad9e238e7cdc04dbb418ed5ed0fca2992

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: 2 people

dialogflow-cx/configure-webhook-to-set-form-parameter-as-optional-or-required.js

@@ -0,0 +1,49 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * Configures a webhook to set form parameters as optional/required
+ */
+
+// [START dialogflow_cx_v3_configure_webhooks_to_set_form_parameter_as_optional_or_required]
+
+exports.configureOptionalFormParam = (request, response) => {
+  // The value of the parameter that the webhook will set as optional or required.
+  // Note that the webhook cannot add or remove any form parameter
+  const parameter = request.body.pageInfo.formInfo.parameterInfo[0].value;
+
+  const jsonResponse = {
+    pageInfo: {
+      formInfo: {
+        parameterInfo: [
+          {
+            displayName: parameter,
+            // if required: false, the agent will not reprompt for this parameter, even if the state is 'INVALID'
+            required: true,
+            state: 'VALID',
+          },
+        ],
+      },
+    },
+  };
+
+  // Info about form parameter that is sent in the webhook response:
+  console.log(
+    'Parameter Info: \n',
+    jsonResponse.pageInfo.formInfo.parameterInfo[0]
+  );
+
+  response.send(jsonResponse);
+};
+// [END dialogflow_cx_v3_configure_webhooks_to_set_form_parameter_as_optional_or_required]

dialogflow-cx/test/webhook-configure-optional-or-required-form-parameters-test.js renamed to dialogflow-cx/test/configure-webhook-to-set-form-parameter-as-optional-or-required.js

@@ -32,22 +32,21 @@
 
 const {assert} = require('chai');
 const {describe, it} = require('mocha');
-const webhook = require('../webhook-configure-optional-or-required-form-parameters');
-const number = 100;
+const webhook = require('../configure-webhook-to-set-form-parameter-as-optional-or-required');
 
 describe('configure optional or required form parameter', () => {
   it('should test that webhook sets parameter as required', async () => {
     const request = {
       body: {
         fulfillmentInfo: {
-          tag: 'required',
+          tag: 'optional-or-required',
         },
         pageInfo: {
           formInfo: {
             parameterInfo: [
               {
                 displayName: 'number',
-                value: number,
+                value: 100,
               },
             ],
           },
@@ -64,37 +63,6 @@ describe('configure optional or required form parameter', () => {
     };
 
     webhook.configureOptionalFormParam(JSON.parse(temp), res);
-    assert.include(response, 'This parameter is required.');
-  });
-
-  it('should test that webhook sets parameter as optional', async () => {
-    const request = {
-      body: {
-        fulfillmentInfo: {
-          tag: 'optional',
-        },
-        pageInfo: {
-          formInfo: {
-            parameterInfo: [
-              {
-                displayName: 'number',
-                value: number,
-              },
-            ],
-          },
-        },
-      },
-    };
-    const temp = JSON.stringify(request);
-    let response = '';
-
-    const res = {
-      send: function (s) {
-        response = JSON.stringify(s);
-      },
-    };
-
-    webhook.configureOptionalFormParam(JSON.parse(temp), res);
-    assert.include(response, 'This parameter is optional.');
+    assert.include(response, '"required":true');
   });
 });

dialogflow-cx/webhook-configure-optional-or-required-form-parameters.js

@@ -18,8 +18,6 @@
 
 // [START dialogflow_cx_v3_webhook_configure_session_parameters_enable_agent_response]
 
-// TODO (developer): change entry point to enableAgentResponse in Cloud Function
-
 exports.enableAgentResponse = (request, response) => {
   const tag = request.body.fulfillmentInfo.tag;
   // The value of the parameter used to enable agent response

dialogflow-cx/webhook-configure-session-parameters-enable-agent-response.js

@@ -18,8 +18,6 @@
 
 // [START dialogflow_cx_v3_webhook_configure_session_parameters_trigger_transition]
 
-// TODO (developer): change entry point to triggerTransition in Cloud Function
-
 exports.triggerTransition = (request, response) => {
   // The target page to transition to.
   const targetPage = request.body.targetPage; // Must be format projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>

dialogflow-cx/webhook-configure-session-parameters-trigger-transition.js

@@ -18,8 +18,6 @@
 
 // [START dialogflow_cx_v3_webhook_configure_session_parameters]
 
-// TODO (developer): change entry point to configureSessionParams in Cloud Function
-
 exports.configureSessionParams = (request, response) => {
   const tag = request.body.fulfillmentInfo.tag;
   let newSessionParameter;

dialogflow-cx/webhook-configure-session-parameters.js

@@ -18,8 +18,6 @@
 
 // [START dialogflow_cx_v3_webhook_validate_form_parameter]
 
-// TODO (developer): change entry point to validateParameter in Cloud Function
-
 exports.validateParameter = (request, response) => {
   // The value of the parameter to validate
   let paramToValidate = request.body.pageInfo.formInfo.parameterInfo[0].value;

dialogflow-cx/webhook-validate-form-parameter.js

@@ -16,8 +16,6 @@
 
 // [START dialogflow_cx_webhook]
 
-// TODO: change entry point to handleWebhook in cloud function
-
 exports.handleWebhook = (request, response) => {
   const tag = request.body.fulfillmentInfo.tag;
   let text = '';