docs(samples): add webhook samples

README.md

@@ -79,6 +79,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-dialogflow-cx
 
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
+| Configure Webhook To Set Form Parameters As Optional Or Required | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/ConfigureWebhookToSetFormParametersAsOptionalOrRequired.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/ConfigureWebhookToSetFormParametersAsOptionalOrRequired.java) |
 | Create Agent | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/CreateAgent.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/CreateAgent.java) |
 | Create Flow | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/CreateFlow.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/CreateFlow.java) |
 | Create Intent | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/CreateIntent.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/CreateIntent.java) |
@@ -92,6 +93,8 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-dialogflow-cx
 | List Test Case Results | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/ListTestCaseResults.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/ListTestCaseResults.java) |
 | List Training Phrases | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/ListTrainingPhrases.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/ListTrainingPhrases.java) |
 | Update Intent | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/UpdateIntent.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/UpdateIntent.java) |
+| Webhook Configure Session Parameters | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/WebhookConfigureSessionParameters.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/WebhookConfigureSessionParameters.java) |
+| Webhook Validate Form Parameter | [source code](https://github.com/googleapis/java-dialogflow-cx/blob/main/samples/snippets/src/main/java/dialogflow/cx/WebhookValidateFormParameter.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-dialogflow-cx&page=editor&open_in_editor=samples/snippets/src/main/java/dialogflow/cx/WebhookValidateFormParameter.java) |
 
 
 

samples/snippets/src/main/java/dialogflow/cx/ConfigureWebhookToSetFormParametersAsOptionalOrRequired.java

@@ -0,0 +1,58 @@
+/*
+ * 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
+ *
+ *     http://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.
+ */
+
+package dialogflow.cx;
+
+// The following snippet is used in https://cloud.google.com/dialogflow/cx/docs/concept/webhook
+
+// [START dialogflow_cx_v3_configure_webhooks_to_set_form_parameter_as_optional_or_required]
+
+// TODO: Change class name to Example
+// TODO: Uncomment the line below before running cloud function
+// package com.example;
+
+import com.google.cloud.functions.HttpFunction;
+import com.google.cloud.functions.HttpRequest;
+import com.google.cloud.functions.HttpResponse;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+import java.io.BufferedWriter;
+
+public class ConfigureWebhookToSetFormParametersAsOptionalOrRequired implements HttpFunction {
+  @Override
+  public void service(HttpRequest request, HttpResponse response) throws Exception {
+    JsonParser parser = new JsonParser();
+    JsonObject responseObject = null;
+
+    // Constructing the response jsonObject
+    responseObject =
+        parser
+            .parse(
+                "{\"page_info\":{\"form_info\":{\"parameter_info\":"
+                    + "[{\"display_name\":\"order-number\",\"required\":"
+                    + "\"true\",\"state\":\"VALID\"}"
+                    + "]}}}")
+            .getAsJsonObject();
+    BufferedWriter writer = response.getWriter();
+
+    System.out.println("Parameter Info: \n");
+    System.out.println(responseObject.toString());
+
+    // Sends the responseObject
+    writer.write(responseObject.toString());
+  }
+}
+// [END dialogflow_cx_v3_configure_webhooks_to_set_form_parameter_as_optional_or_required]

samples/snippets/src/main/java/dialogflow/cx/WebhookConfigureSessionParameters.java

@@ -0,0 +1,55 @@
+/*
+ * 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
+ *
+ *     http://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.
+ */
+
+package dialogflow.cx;
+
+// The following snippet is used in https://cloud.google.com/dialogflow/cx/docs/concept/webhook
+// Configures a webhook to set a session parameter
+
+// [START dialogflow_cx_v3_webhook_configure_session_parameters]
+
+// TODO: Change class name to Example
+// TODO: Uncomment the line below before running cloud function
+// package com.example;
+
+import com.google.cloud.functions.HttpFunction;
+import com.google.cloud.functions.HttpRequest;
+import com.google.cloud.functions.HttpResponse;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+import java.io.BufferedWriter;
+
+public class WebhookConfigureSessionParameters implements HttpFunction {
+  @Override
+  public void service(HttpRequest request, HttpResponse response) throws Exception {
+    JsonParser parser = new JsonParser();
+    JsonObject responseObject = null;
+
+    // Constructing the response jsonObject
+    responseObject =
+        parser
+            .parse("{\"session_info\":{\"parameters\":" + "{\"order-number\":\"12345\"}" + "}}")
+            .getAsJsonObject();
+    BufferedWriter writer = response.getWriter();
+
+    System.out.println("Parameter Info: \n");
+    System.out.println(responseObject.toString());
+
+    // Sends the responseObject
+    writer.write(responseObject.toString());
+  }
+}
+// [END dialogflow_cx_v3_webhook_configure_session_parameters]

samples/snippets/src/main/java/dialogflow/cx/WebhookValidateFormParameter.java

@@ -0,0 +1,59 @@
+/*
+//  * 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
+//  *
+//  *     http://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.
+//  */
+
+package dialogflow.cx;
+
+// The following snippet is used in https://cloud.google.com/dialogflow/cx/docs/concept/webhook
+
+// [START dialogflow_cx_v3_webhook_validate_form_parameter]
+
+// TODO: Change class name to Example
+// TODO: Uncomment the line bellow before running cloud function
+// package com.example;
+
+import com.google.cloud.functions.HttpFunction;
+import com.google.cloud.functions.HttpRequest;
+import com.google.cloud.functions.HttpResponse;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+import java.io.BufferedWriter;
+
+public class WebhookValidateFormParameter implements HttpFunction {
+  @Override
+  public void service(HttpRequest request, HttpResponse response) throws Exception {
+    JsonParser parser = new JsonParser();
+    JsonObject responseObject = null;
+
+    // Constructing the response jsonObject
+    responseObject =
+        parser
+            .parse(
+                "{\"page_info\":{\"form_info\":{\"parameter_info\":"
+                    + "[{\"display_name\":\"order-number\",\"required\":"
+                    + "\"true\",\"state\":\"INVALID\",\"value\":\"123\"}"
+                    + "]}}}")
+            .getAsJsonObject();
+
+    BufferedWriter writer = response.getWriter();
+
+    System.out.println("Parameter Info: \n");
+    System.out.println(responseObject.toString());
+
+    // Sends the responseObject
+    writer.write(responseObject.toString());
+  }
+}
+// [END dialogflow_cx_v3_webhook_validate_form_parameter]

samples/snippets/src/test/java/dialogflow/cx/ConfigureWebhookToSetFormParametersAsOptionalOrRequiredTest.java

@@ -0,0 +1,74 @@
+/*
+ * 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
+ *
+ *     http://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.
+ */
+
+package dialogflow.cx;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.when;
+
+import com.google.cloud.functions.HttpRequest;
+import com.google.cloud.functions.HttpResponse;
+import com.google.gson.Gson;
+import java.io.BufferedReader;
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.io.StringReader;
+import java.io.StringWriter;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class ConfigureWebhookToSetFormParametersAsOptionalOrRequiredTest {
+
+  @Mock private HttpRequest request;
+  @Mock private HttpResponse response;
+
+  private BufferedWriter writerOut;
+  private StringWriter responseOut;
+  private static final Gson gson = new Gson();
+
+  @Before
+  public void beforeTest() throws IOException {
+    MockitoAnnotations.initMocks(this);
+
+    // use an empty string as the default request content
+    BufferedReader reader = new BufferedReader(new StringReader(""));
+    when(request.getReader()).thenReturn(reader);
+
+    responseOut = new StringWriter();
+    writerOut = new BufferedWriter(responseOut);
+    when(response.getWriter()).thenReturn(writerOut);
+  }
+
+  @Test
+  public void helloHttp_bodyParamsPost() throws IOException, Exception {
+    String jsonString = "{'fulfillmentInfo': {'tag': 'optional-or-required'}}";
+
+    BufferedReader jsonReader = new BufferedReader(new StringReader(jsonString));
+
+    when(request.getReader()).thenReturn(jsonReader);
+
+    new ConfigureWebhookToSetFormParametersAsOptionalOrRequired().service(request, response);
+    writerOut.flush();
+
+    String expectedResponse =
+        "{\"page_info\":{\"form_info\":{\"parameter_info\":"
+            + "[{\"display_name\":\"order-number\",\"required\":\"true\",\"state\":\"VALID\"}]}}}";
+
+    assertThat(responseOut.toString()).isEqualTo(expectedResponse);
+  }
+}

samples/snippets/src/test/java/dialogflow/cx/WebhookConfigureSessionParametersTest.java

@@ -0,0 +1,72 @@
+/*
+ * 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
+ *
+ *     http://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.
+ */
+
+package dialogflow.cx;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.when;
+
+import com.google.cloud.functions.HttpRequest;
+import com.google.cloud.functions.HttpResponse;
+import java.io.BufferedReader;
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.io.StringReader;
+import java.io.StringWriter;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class WebhookConfigureSessionParametersTest {
+
+  @Mock private HttpRequest request;
+  @Mock private HttpResponse response;
+
+  private BufferedWriter writerOut;
+  private StringWriter responseOut;
+
+  @Before
+  public void beforeTest() throws IOException {
+    MockitoAnnotations.initMocks(this);
+
+    // use an empty string as the default request content
+    BufferedReader reader = new BufferedReader(new StringReader(""));
+    when(request.getReader()).thenReturn(reader);
+
+    responseOut = new StringWriter();
+    writerOut = new BufferedWriter(responseOut);
+    when(response.getWriter()).thenReturn(writerOut);
+  }
+
+  @Test
+  public void helloHttp_bodyParamsPost() throws IOException, Exception {
+    String jsonString = "{'fulfillmentInfo': {'tag': 'configure-session-parameter'}}";
+
+    BufferedReader jsonReader = new BufferedReader(new StringReader(jsonString));
+
+    when(request.getReader()).thenReturn(jsonReader);
+
+    new WebhookConfigureSessionParameters().service(request, response);
+    writerOut.flush();
+
+    String expectedResponse =
+        "{\"session_info\":{\"parameters\":" + "{\"order-number\":\"12345\"}" + "}}";
+
+    System.out.println(responseOut.toString());
+    assertThat(responseOut.toString()).isEqualTo(expectedResponse);
+  }
+}