feat: support for data stores

.golangci.yaml

@@ -1,5 +1,5 @@
 run:
-  go: 1.20
+  go: 1.23
 linters:
   enable:
     - thelper

.coderabbit.yaml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
+reviews:
+  path_filters:
+    - "!**/*.mod"
+    - "!**/*.sum"
+    - "!docs/docs/cmd/*.md"
+  auto_review:
+    enabled: true

.vscode/launch.json

@@ -430,5 +430,31 @@
                 "generator", "delete", "my-generator", "--agent-name", "test-agent", "--project-id", "test-cx-346408", "--location-id", "us-central1", "--credentials", "credentials.json"
             ]
         },
+        {
+            "name": "Data store search command",
+            "type": "go",
+            "request": "launch",
+            "mode": "debug",
+            "program": "${workspaceFolder}/main.go",
+            "env": {
+                "ENV": "development"
+            },
+            "args": [
+                "datastore", "search", "cxcli", "--project-id", "test-cx-346408", "--location-id", "global", "--credentials", "credentials.json", "--query", "cxcli"
+            ]
+        },
+        {
+            "name": "Data store delete command",
+            "type": "go",
+            "request": "launch",
+            "mode": "debug",
+            "program": "${workspaceFolder}/main.go",
+            "env": {
+                "ENV": "development"
+            },
+            "args": [
+                "datastore", "delete", "gengar", "--project-id", "test-cx-346408", "--location-id", "global", "--credentials", "credentials.json"
+            ]
+        },
     ]
 }

cmd/datastore/datastore.go

@@ -0,0 +1,35 @@
+package datastore
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/xavidop/dialogflow-cx-cli/cmd/cmdutils"
+	cmdducment "github.com/xavidop/dialogflow-cx-cli/cmd/datastore/document"
+)
+
+// datastoreCmd represents the datastore root command
+var datastoreCmd = &cobra.Command{
+	Use:     "datastore",
+	Aliases: []string{"ds"},
+	Short:   "Actions on datastore commands",
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := cmd.Help(); err != nil {
+			os.Exit(1)
+		}
+		os.Exit(0)
+	},
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		cmdutils.PreRun(cmd.Name())
+	},
+	PersistentPostRun: func(cmd *cobra.Command, args []string) {
+	},
+}
+
+func Register(rootCmd *cobra.Command) {
+	rootCmd.AddCommand(datastoreCmd)
+}
+
+func init() {
+	cmdducment.Register(datastoreCmd)
+}

cmd/datastore/delete.go

@@ -0,0 +1,50 @@
+package datastore
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/xavidop/dialogflow-cx-cli/cmd/cmdutils"
+	"github.com/xavidop/dialogflow-cx-cli/internal/global"
+	"github.com/xavidop/dialogflow-cx-cli/pkg/datastore"
+)
+
+// deleteCmd represents the search datastore set command
+var deleteCmd = &cobra.Command{
+	Use:     "delete [name]",
+	Aliases: []string{"deletes", "d", "del"},
+	Short:   "delete a datastore",
+	Args:    cobra.ExactArgs(1),
+	Run: func(cmd *cobra.Command, args []string) {
+		// Get the information
+		locationID, _ := cmd.Flags().GetString("location-id")
+		projectID, _ := cmd.Flags().GetString("project-id")
+		name := args[0]
+
+		if err := datastore.Delete(name, locationID, projectID); err != nil {
+			global.Log.Errorf("%s", err.Error())
+			os.Exit(1)
+		}
+	},
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		cmdutils.PreRun(cmd.Name())
+	},
+	PersistentPostRun: func(cmd *cobra.Command, args []string) {
+	},
+}
+
+func init() {
+	datastoreCmd.AddCommand(deleteCmd)
+
+	deleteCmd.Flags().StringP("project-id", "p", "", "Data Store Project ID (required)")
+	if err := deleteCmd.MarkFlagRequired("project-id"); err != nil {
+		global.Log.Errorf("%s", err.Error())
+		os.Exit(1)
+	}
+	deleteCmd.Flags().StringP("location-id", "l", "", "Data Store Location ID of the Project (required)")
+	if err := deleteCmd.MarkFlagRequired("location-id"); err != nil {
+		global.Log.Errorf("%s", err.Error())
+		os.Exit(1)
+	}
+
+}

cmd/datastore/document/document.go

@@ -0,0 +1,30 @@
+package document
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/xavidop/dialogflow-cx-cli/cmd/cmdutils"
+)
+
+// documentCmd represents the datastore root command
+var documentCmd = &cobra.Command{
+	Use:     "document",
+	Aliases: []string{"dc"},
+	Short:   "Actions on datastore document commands",
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := cmd.Help(); err != nil {
+			os.Exit(1)
+		}
+		os.Exit(0)
+	},
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		cmdutils.PreRun(cmd.Name())
+	},
+	PersistentPostRun: func(cmd *cobra.Command, args []string) {
+	},
+}
+
+func Register(rootCmd *cobra.Command) {
+	rootCmd.AddCommand(documentCmd)
+}

cmd/datastore/search.go

@@ -0,0 +1,56 @@
+package datastore
+
+import (
+	"os"
+
+	"github.com/spf13/cobra"
+	"github.com/xavidop/dialogflow-cx-cli/cmd/cmdutils"
+	"github.com/xavidop/dialogflow-cx-cli/internal/global"
+	"github.com/xavidop/dialogflow-cx-cli/pkg/datastore"
+)
+
+// searchCmd represents the search datastore set command
+var searchCmd = &cobra.Command{
+	Use:     "search [name]",
+	Aliases: []string{"searches", "s"},
+	Short:   "search in a datastore",
+	Args:    cobra.ExactArgs(1),
+	Run: func(cmd *cobra.Command, args []string) {
+		// Get the information
+		locationID, _ := cmd.Flags().GetString("location-id")
+		projectID, _ := cmd.Flags().GetString("project-id")
+		query, _ := cmd.Flags().GetString("query")
+		name := args[0]
+
+		if err := datastore.Search(name, locationID, projectID, query); err != nil {
+			global.Log.Errorf(err.Error())
+			os.Exit(1)
+		}
+	},
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		cmdutils.PreRun(cmd.Name())
+	},
+	PersistentPostRun: func(cmd *cobra.Command, args []string) {
+	},
+}
+
+func init() {
+	datastoreCmd.AddCommand(searchCmd)
+
+	searchCmd.Flags().StringP("query", "r", "", "Query to search (required)")
+	if err := searchCmd.MarkFlagRequired("query"); err != nil {
+		global.Log.Errorf(err.Error())
+		os.Exit(1)
+	}
+	searchCmd.Flags().StringP("project-id", "p", "", "Data Store Project ID (required)")
+	if err := searchCmd.MarkFlagRequired("project-id"); err != nil {
+		global.Log.Errorf(err.Error())
+		os.Exit(1)
+	}
+	searchCmd.Flags().StringP("location-id", "l", "", "Data Store Location ID of the Project (required)")
+	if err := searchCmd.MarkFlagRequired("location-id"); err != nil {
+		global.Log.Errorf(err.Error())
+		os.Exit(1)
+	}
+
+}

cmd/root.go

@@ -7,6 +7,7 @@ import (
 	"github.com/spf13/cobra"
 	cmdagent "github.com/xavidop/dialogflow-cx-cli/cmd/agent"
 	"github.com/xavidop/dialogflow-cx-cli/cmd/cmdutils"
+	cmddatastore "github.com/xavidop/dialogflow-cx-cli/cmd/datastore"
 	cmdentitytype "github.com/xavidop/dialogflow-cx-cli/cmd/entitytype"
 	environmentCmd "github.com/xavidop/dialogflow-cx-cli/cmd/environment"
 	cmdflow "github.com/xavidop/dialogflow-cx-cli/cmd/flow"
@@ -71,6 +72,8 @@ func init() {
 	cmdflow.Register(rootCmd)
 	cmdflowversion.Register(rootCmd)
 	cmdgenerator.Register(rootCmd)
+	cmddatastore.Register(rootCmd)
+
 
 	// Add the subcommands
 	rootCmd.PersistentFlags().BoolVarP(&global.Verbose, "verbose", "v", false, "verbose error output (with stack trace) (optional)")

docs/docs/cmd/cxcli.md

@@ -31,6 +31,7 @@ cxcli [flags]
 
 * [cxcli agent](/cmd/cxcli_agent/)	 - Actions on agent commands
 * [cxcli completion](/cmd/cxcli_completion/)	 - Generate the autocompletion script for the specified shell
+* [cxcli datastore](/cmd/cxcli_datastore/)	 - Actions on datastore commands
 * [cxcli dialog](/cmd/cxcli_dialog/)	 - Test your CX Agent interactively directly from your terminal
 * [cxcli entity-type](/cmd/cxcli_entity-type/)	 - Actions on entity type commands
 * [cxcli environment](/cmd/cxcli_environment/)	 - Actions on environment

docs/docs/cmd/cxcli_datastore.md

@@ -0,0 +1,28 @@
+# cxcli datastore
+
+Actions on datastore commands
+
+```
+cxcli datastore [flags]
+```
+
+## Options
+
+```
+  -h, --help   help for datastore
+```
+
+## Options inherited from parent commands
+
+```
+  -c, --credentials string     Google Cloud credentials JSON file path (optional)
+  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default "text")
+  -u, --skip-update-check      Skip the check for updates check run before every command (optional)
+  -v, --verbose                verbose error output (with stack trace) (optional)
+```
+
+## See also
+
+* [cxcli](/cmd/cxcli/)	 - Dialogflow CX CLI
+* [cxcli datastore search](/cmd/cxcli_datastore_search/)	 - search in a datastore
+

docs/docs/cmd/cxcli_datastore_search.md

@@ -0,0 +1,30 @@
+# cxcli datastore search
+
+search in a datastore
+
+```
+cxcli datastore search [name] [flags]
+```
+
+## Options
+
+```
+  -h, --help                 help for search
+  -l, --location-id string   Data Store Location ID of the Project (required)
+  -p, --project-id string    Data Store Project ID (required)
+  -r, --query string         Query to search (required)
+```
+
+## Options inherited from parent commands
+
+```
+  -c, --credentials string     Google Cloud credentials JSON file path (optional)
+  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default "text")
+  -u, --skip-update-check      Skip the check for updates check run before every command (optional)
+  -v, --verbose                verbose error output (with stack trace) (optional)
+```
+
+## See also
+
+* [cxcli datastore](/cmd/cxcli_datastore/)	 - Actions on datastore commands
+

docs/docs/datastores/introduction.md

@@ -0,0 +1,31 @@
+# Webhooks
+
+## What is this?
+
+Webhooks serve as platforms for hosting your business logic or invoking other services. Within a session, webhooks enable you to utilize the data extracted through Dialogflow's natural language processing to generate dynamic responses, verify gathered data, or initiate actions on the backend.
+
+There are two types of webhooks: standard webhooks and flexible webhooks. In the case of a standard webhook, the request and response fields are determined by Dialogflow. On the other hand, a flexible webhook allows you to specify the request and response fields according to your requirements.
+
+With `cxcli`, you can easily interact with the webhooks of your Dialogflow CX agents.
+
+All of the commands that you have available in `cxcli` to interact with your webhooks are located within the `cxcli webhook` subcommand.
+
+You can create, update or delete standard and flexible webhooks with `cxcli` for a specific environment by setting the `--environment` parameter. If you do not specify an environment, the `cxcli` will create, update or delete this webhook for all environments.
+
+## Create
+
+The `cxcli` has a command that allows you to create a standard or flexible webhook. You can find a more detailed information [here](/webhooks/create).
+
+## Update
+
+The `cxcli` has a command that allows you to update a standard or flexible webhook. You can find a more detailed information [here](/webhooks/update).
+
+## Delete
+
+The `cxcli` has a command that allows you to delete your standard or flexible webhook. You can find a more detailed explanation [here](/webhooks/delete).
+
+## Useful Links
+
+If you want to see the full usage of the `cxcli webhook` command, please refer to this [page](/cmd/cxcli_webhook).
+
+If you want to learn more about Dialogflow CX webhooks, refer to the [official documentation](https://cloud.google.com/dialogflow/cx/docs/concept/webhook).

docs/docs/datastores/search.md

@@ -0,0 +1,51 @@
+# Create
+
+
+## Usage
+
+You can find the create functionality within the `cxcli webhook create` subcommand. You can read the documentation about this command [here](/cmd/cxcli_webhook_create).
+
+### Flexible Webhook
+
+If you want to create a flexible webhook, you have to set the `--flexible` parameter. When you set these parameters, you have to provide a `--request-body` and a `--parameters-mapping` parameter: 
+
+1. The `--request-body` parameter is a JSON string that will be sent to the webhook.
+2. The `--parameters-mapping` parameter is a comma-separated list of key-value pairs. The key is the name of the parameter that will be sent to the webhook, and the value is a JSON path that will be used to extract the value from the `--request-body` parameter. This parameter has the following format:
+```
+parameter@json-path,paramter2@json-path2
+```
+An example of a parameter mapping: `my-param@$.fully.qualified.path.to.field`
+
+## Example
+
+### Standard Webhook
+
+Here is a simple example of using the `cxcli webhook create` command:
+
+```sh
+cxcli webhook create my-webhook --url "https://my-webhook.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+```
+
+The above command will give you output similar to the following:
+
+```sh
+$ cxcli webhook create my-webhook --url "https://my-webhook.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+INFO Webhook created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/webhooks/55f56aeb-be30-40a2-8bd6-cbbd6b9cc041
+```
+
+### Flexible Webhook
+
+```sh
+cxcli webhook create my-webhook --url "https://my-webhook.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body "{\"hello\": true}" --parameters-mapping "my-param@$.fully.qualified.path.to.field, my-param2@$.fully.qualified.path.to.field2"
+```
+
+The above command will give you output similar to the following:
+
+```sh
+$ cxcli webhook create my-webhook --url "https://my-webhook.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body "{\"hello\": true}" --parameters-mapping "my-param@$.fully.qualified.path.to.field, my-param2@$.fully.qualified.path.to.field2"
+INFO Webhook created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/webhooks/13df6f13-6848-4fab-8cda-752b4f9819fa 
+```
+
+## Useful Links
+
+If you want to learn more about Dialogflow CX webhook creation, refer to the [official documentation](https://cloud.google.com/dialogflow/cx/docs/concept/webhook).