google-cloud-dialogflow-v2 0.11.3 → 0.13.0

data/lib/google/cloud/dialogflow/v2/answer_records/client.rb

@@ -197,6 +197,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::AnswerRecords::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::ListAnswerRecordsRequest.new
+            #
+            #   # Call the list_answer_records method.
+            #   result = client.list_answer_records request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dialogflow::V2::AnswerRecord.
+            #     p response
+            #   end
+            #
             def list_answer_records request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -214,9 +235,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -268,6 +291,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::AnswerRecords::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::UpdateAnswerRecordRequest.new
+            #
+            #   # Call the update_answer_record method.
+            #   result = client.update_answer_record request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::AnswerRecord.
+            #   p result
+            #
             def update_answer_record request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -285,9 +323,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "answer_record.name" => request.answer_record.name
-              }
+              header_params = {}
+              if request.answer_record&.name
+                header_params["answer_record.name"] = request.answer_record.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 

data/lib/google/cloud/dialogflow/v2/contexts/client.rb

@@ -188,6 +188,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Contexts::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::ListContextsRequest.new
+            #
+            #   # Call the list_contexts method.
+            #   result = client.list_contexts request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dialogflow::V2::Context.
+            #     p response
+            #   end
+            #
             def list_contexts request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -205,9 +226,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -262,6 +285,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Contexts::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::GetContextRequest.new
+            #
+            #   # Call the get_context method.
+            #   result = client.get_context request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Context.
+            #   p result
+            #
             def get_context request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -279,9 +317,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -339,6 +379,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Contexts::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::CreateContextRequest.new
+            #
+            #   # Call the create_context method.
+            #   result = client.create_context request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Context.
+            #   p result
+            #
             def create_context request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -356,9 +411,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -409,6 +466,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Contexts::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::UpdateContextRequest.new
+            #
+            #   # Call the update_context method.
+            #   result = client.update_context request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::Context.
+            #   p result
+            #
             def update_context request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -426,9 +498,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "context.name" => request.context.name
-              }
+              header_params = {}
+              if request.context&.name
+                header_params["context.name"] = request.context.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -482,6 +556,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Contexts::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::DeleteContextRequest.new
+            #
+            #   # Call the delete_context method.
+            #   result = client.delete_context request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_context request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -499,9 +588,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -555,6 +646,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::Contexts::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::DeleteAllContextsRequest.new
+            #
+            #   # Call the delete_all_contexts method.
+            #   result = client.delete_all_contexts request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_all_contexts request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -572,9 +678,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 

data/lib/google/cloud/dialogflow/v2/conversation_profile_pb.rb

@@ -8,6 +8,7 @@ require 'google/api/resource_pb'
 require 'google/cloud/dialogflow/v2/audio_config_pb'
 require 'google/cloud/dialogflow/v2/participant_pb'
 require 'google/longrunning/operations_pb'
+require 'google/protobuf/duration_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
@@ -28,6 +29,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :new_message_event_notification_config, :message, 8, "google.cloud.dialogflow.v2.NotificationConfig"
       optional :stt_config, :message, 9, "google.cloud.dialogflow.v2.SpeechToTextConfig"
       optional :language_code, :string, 10
+      optional :time_zone, :string, 14
+      optional :security_settings, :string, 13
     end
     add_message "google.cloud.dialogflow.v2.ListConversationProfilesRequest" do
       optional :parent, :string, 1
@@ -141,6 +144,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :TYPE_UNSPECIFIED, 0
       value :ARTICLE_SUGGESTION, 1
       value :FAQ, 2
+      value :SMART_REPLY, 3
     end
   end
 end

data/lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb

@@ -184,6 +184,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::ListConversationProfilesRequest.new
+            #
+            #   # Call the list_conversation_profiles method.
+            #   result = client.list_conversation_profiles request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Dialogflow::V2::ConversationProfile.
+            #     p response
+            #   end
+            #
             def list_conversation_profiles request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -201,9 +222,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -255,6 +278,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::GetConversationProfileRequest.new
+            #
+            #   # Call the get_conversation_profile method.
+            #   result = client.get_conversation_profile request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile.
+            #   p result
+            #
             def get_conversation_profile request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -272,9 +310,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -330,6 +370,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::CreateConversationProfileRequest.new
+            #
+            #   # Call the create_conversation_profile method.
+            #   result = client.create_conversation_profile request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile.
+            #   p result
+            #
             def create_conversation_profile request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -347,9 +402,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -404,6 +461,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::UpdateConversationProfileRequest.new
+            #
+            #   # Call the update_conversation_profile method.
+            #   result = client.update_conversation_profile request
+            #
+            #   # The returned object is of type Google::Cloud::Dialogflow::V2::ConversationProfile.
+            #   p result
+            #
             def update_conversation_profile request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -421,9 +493,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "conversation_profile.name" => request.conversation_profile.name
-              }
+              header_params = {}
+              if request.conversation_profile&.name
+                header_params["conversation_profile.name"] = request.conversation_profile.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
@@ -474,6 +548,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/dialogflow/v2"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Dialogflow::V2::ConversationProfiles::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Dialogflow::V2::DeleteConversationProfileRequest.new
+            #
+            #   # Call the delete_conversation_profile method.
+            #   result = client.delete_conversation_profile request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_conversation_profile request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -491,9 +580,11 @@ module Google
                 gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 

data/lib/google/cloud/dialogflow/v2/conversation_profiles/paths.rb

@@ -60,6 +60,25 @@ module Google
               resource.call(**args)
             end
 
+            ##
+            # Create a fully-qualified CXSecuritySettings resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/securitySettings/{security_settings}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param security_settings [String]
+            #
+            # @return [::String]
+            def cx_security_settings_path project:, location:, security_settings:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/securitySettings/#{security_settings}"
+            end
+
             ##
             # Create a fully-qualified ConversationModel resource string.
             #