google-cloud-dialogflow-cx-v3 0.1.0

data/proto_docs/google/cloud/dialogflow/cx/v3/transition_route_group.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # An TransitionRouteGroup represents a group of
+          # {::Google::Cloud::Dialogflow::CX::V3::TransitionRoute `TransitionRoutes`} to be used by a {::Google::Cloud::Dialogflow::CX::V3::Page Page}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique identifier of the transition route group.
+          #     {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client#create_transition_route_group TransitionRouteGroups.CreateTransitionRouteGroup} populates the name
+          #     automatically.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the transition route group, unique within
+          #     the {::Google::Cloud::Dialogflow::CX::V3::Agent Agent}. The display name can be no longer than 30 characters.
+          # @!attribute [rw] transition_routes
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRoute>]
+          #     Transition routes associated with the {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
+          class TransitionRouteGroup
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client#list_transition_route_groups TransitionRouteGroups.ListTransitionRouteGroups}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The flow to list all transition route groups for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return in a single page. By default 100 and
+          #     at most 1000.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous list request.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to list transition route groups for. The following fields are
+          #     language dependent:
+          #
+          #     *  `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages`
+          #     *
+          #     `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
+          #
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     are supported.
+          #     Note: languages must be enabled in the agent before they can be used.
+          class ListTransitionRouteGroupsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client#list_transition_route_groups TransitionRouteGroups.ListTransitionRouteGroups}.
+          # @!attribute [rw] transition_route_groups
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup>]
+          #     The list of transition route groups. There will be a maximum number of
+          #     items returned based on the page_size field in the request. The list may in
+          #     some cases be empty or contain fewer entries than page_size even if this
+          #     isn't the last page.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          class ListTransitionRouteGroupsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client#get_transition_route_group TransitionRouteGroups.GetTransitionRouteGroup}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup}.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language to retrieve the transition route group for. The following
+          #     fields are language dependent:
+          #
+          #     *  `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages`
+          #     *
+          #     `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     are supported.
+          #     Note: languages must be enabled in the agent before they can be used.
+          class GetTransitionRouteGroupRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client#create_transition_route_group TransitionRouteGroups.CreateTransitionRouteGroup}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The flow to create an {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup} for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] transition_route_group
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup]
+          #     Required. The transition route group to create.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language of the following fields in `TransitionRouteGroup`:
+          #
+          #     *  `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages`
+          #     *
+          #     `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     are supported.
+          #     Note: languages must be enabled in the agent before they can be used.
+          class CreateTransitionRouteGroupRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client#update_transition_route_group TransitionRouteGroups.UpdateTransitionRouteGroup}.
+          # @!attribute [rw] transition_route_group
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup]
+          #     Required. The transition route group to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The mask to control which fields get updated.
+          # @!attribute [rw] language_code
+          #   @return [::String]
+          #     The language of the following fields in `TransitionRouteGroup`:
+          #
+          #     *  `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages`
+          #     *
+          #     `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases`
+          #
+          #     If not specified, the agent's default language is used.
+          #     [Many
+          #     languages](https://cloud.google.com/dialogflow/cx/docs/reference/language)
+          #     are supported.
+          #     Note: languages must be enabled in the agent before they can be used.
+          class UpdateTransitionRouteGroupRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client#delete_transition_route_group TransitionRouteGroups.DeleteTransitionRouteGroup}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup TransitionRouteGroup} to delete.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/transitionRouteGroups/<Transition Route Group ID>`.
+          # @!attribute [rw] force
+          #   @return [::Boolean]
+          #     This field has no effect for transition route group that no page is using.
+          #     If the transition route group is referenced by any page:
+          #
+          #     *  If `force` is set to false, an error will be returned with message
+          #        indicating pages that reference the transition route group.
+          #     *  If `force` is set to true, Dialogflow will remove the transition route
+          #        group, as well as any reference to it.
+          class DeleteTransitionRouteGroupRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/cx/v3/validation_message.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # Agent/flow validation message.
+          # @!attribute [rw] resource_type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ValidationMessage::ResourceType]
+          #     The type of the resources where the message is found.
+          # @!attribute [rw] resources
+          #   @return [::Array<::String>]
+          #     The names of the resources where the message is found.
+          # @!attribute [rw] resource_names
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResourceName>]
+          #     The resource names of the resources where the message is found.
+          # @!attribute [rw] severity
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ValidationMessage::Severity]
+          #     Indicates the severity of the message.
+          # @!attribute [rw] detail
+          #   @return [::String]
+          #     The message detail.
+          class ValidationMessage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Resource types.
+            module ResourceType
+              # Unspecified.
+              RESOURCE_TYPE_UNSPECIFIED = 0
+
+              # Agent.
+              AGENT = 1
+
+              # Intent.
+              INTENT = 2
+
+              # Intent training phrase.
+              INTENT_TRAINING_PHRASE = 8
+
+              # Intent parameter.
+              INTENT_PARAMETER = 9
+
+              # Multiple intents.
+              INTENTS = 10
+
+              # Multiple training phrases.
+              INTENT_TRAINING_PHRASES = 11
+
+              # Entity type.
+              ENTITY_TYPE = 3
+
+              # Multiple entity types.
+              ENTITY_TYPES = 12
+
+              # Webhook.
+              WEBHOOK = 4
+
+              # Flow.
+              FLOW = 5
+
+              # Page.
+              PAGE = 6
+
+              # Multiple pages.
+              PAGES = 13
+
+              # Transition route group.
+              TRANSITION_ROUTE_GROUP = 7
+            end
+
+            # Severity level.
+            module Severity
+              # Unspecified.
+              SEVERITY_UNSPECIFIED = 0
+
+              # The agent doesn't follow Dialogflow best practices.
+              INFO = 1
+
+              # The agent may not behave as expected.
+              WARNING = 2
+
+              # The agent may experience failures.
+              ERROR = 3
+            end
+          end
+
+          # Resource name and display name.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Name.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Display name.
+          class ResourceName
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/cx/v3/version.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # Metadata associated with the long running operation for
+          # {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#create_version Versions.CreateVersion}.
+          # @!attribute [rw] version
+          #   @return [::String]
+          #     Name of the created version.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/versions/<Version ID>`.
+          class CreateVersionOperationMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a version of a flow.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/versions/<Version ID>. Version ID is a self-increasing
+          #     number generated by Dialogflow upon version creation.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the version. Limit of 64 characters.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     The description of the version. The maximum length is 500 characters. If
+          #     exceeded, the request is rejected.
+          # @!attribute [r] nlu_settings
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::NluSettings]
+          #     Output only. The NLU settings of the flow at version creation.
+          # @!attribute [r] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Create time of the version.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Version::State]
+          #     Output only. The state of this version. This field is read-only and cannot be set by
+          #     create and update methods.
+          class Version
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The state of the version.
+            module State
+              # Not specified. This value is not used.
+              STATE_UNSPECIFIED = 0
+
+              # Version is not ready to serve (e.g. training is running).
+              RUNNING = 1
+
+              # Training has succeeded and this version is ready to serve.
+              SUCCEEDED = 2
+
+              # Version training failed.
+              FAILED = 3
+            end
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#list_versions Versions.ListVersions}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The {::Google::Cloud::Dialogflow::CX::V3::Flow Flow} to list all versions for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return in a single page. By default 20 and
+          #     at most 100.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous list request.
+          class ListVersionsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#list_versions Versions.ListVersions}.
+          # @!attribute [rw] versions
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::Version>]
+          #     A list of versions. There will be a maximum number of items returned based
+          #     on the page_size field in the request. The list may in some cases be empty
+          #     or contain fewer entries than page_size even if this isn't the last page.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          class ListVersionsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#get_version Versions.GetVersion}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Version Version}.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/versions/<Version ID>`.
+          class GetVersionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#create_version Versions.CreateVersion}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The {::Google::Cloud::Dialogflow::CX::V3::Flow Flow} to create an {::Google::Cloud::Dialogflow::CX::V3::Version Version} for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          # @!attribute [rw] version
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Version]
+          #     Required. The version to create.
+          class CreateVersionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#update_version Versions.UpdateVersion}.
+          # @!attribute [rw] version
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::Version]
+          #     Required. The version to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Required. The mask to control which fields get updated. Currently only `description`
+          #     and `display_name` can be updated.
+          class UpdateVersionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#delete_version Versions.DeleteVersion}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the {::Google::Cloud::Dialogflow::CX::V3::Version Version} to delete.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/versions/<Version ID>`.
+          class DeleteVersionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::Versions::Client#load_version Versions.LoadVersion}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The {::Google::Cloud::Dialogflow::CX::V3::Version Version} to be loaded to draft flow.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>/versions/<Version ID>`.
+          # @!attribute [rw] allow_override_agent_resources
+          #   @return [::Boolean]
+          #     This field is used to prevent accidental overwrite of other agent
+          #     resources, which can potentially impact other flow's behavior. If
+          #     `allow_override_agent_resources` is false, conflicted agent-level resources
+          #     will not be overridden (i.e. intents, entities, webhooks).
+          class LoadVersionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end