google-cloud-dialogflow-cx-v3 0.14.0 → 0.15.1

data/lib/google/cloud/dialogflow/cx/v3/versions/rest/service_stub.rb

@@ -0,0 +1,467 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "google/cloud/dialogflow/cx/v3/version_pb"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          module Versions
+            module Rest
+              ##
+              # REST service stub for the Versions service.
+              # Service stub contains baseline method implementations
+              # including transcoding, making the REST call, and deserialing the response.
+              #
+              class ServiceStub
+                def initialize endpoint:, credentials:
+                  # These require statements are intentionally placed here to initialize
+                  # the REST modules only when it's required.
+                  require "gapic/rest"
+
+                  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                                                               numeric_enums: true,
+                                                               raise_faraday_errors: false
+                end
+
+                ##
+                # Baseline implementation for the list_versions REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::ListVersionsRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::ListVersionsResponse]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::ListVersionsResponse]
+                #   A result object deserialized from the server's reply
+                def list_versions request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_list_versions_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::ListVersionsResponse.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the get_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::GetVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Version]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::Version]
+                #   A result object deserialized from the server's reply
+                def get_version request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_get_version_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::Version.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the create_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::CreateVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Longrunning::Operation]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Longrunning::Operation]
+                #   A result object deserialized from the server's reply
+                def create_version request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_create_version_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the update_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::UpdateVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::Version]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::Version]
+                #   A result object deserialized from the server's reply
+                def update_version request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_update_version_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::Version.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the delete_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::DeleteVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Protobuf::Empty]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Protobuf::Empty]
+                #   A result object deserialized from the server's reply
+                def delete_version request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_delete_version_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the load_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::LoadVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Longrunning::Operation]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Longrunning::Operation]
+                #   A result object deserialized from the server's reply
+                def load_version request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_load_version_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # Baseline implementation for the compare_versions REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::CompareVersionsRequest]
+                #   A request object representing the call parameters. Required.
+                # @param options [::Gapic::CallOptions]
+                #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+                #
+                # @yield [result, operation] Access the result along with the TransportOperation object
+                # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse]
+                # @yieldparam operation [::Gapic::Rest::TransportOperation]
+                #
+                # @return [::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse]
+                #   A result object deserialized from the server's reply
+                def compare_versions request_pb, options = nil
+                  raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                  verb, uri, query_string_params, body = ServiceStub.transcode_compare_versions_request request_pb
+                  query_string_params = if query_string_params.any?
+                                          query_string_params.to_h { |p| p.split("=", 2) }
+                                        else
+                                          {}
+                                        end
+
+                  response = @client_stub.make_http_request(
+                    verb,
+                    uri:     uri,
+                    body:    body || "",
+                    params:  query_string_params,
+                    options: options
+                  )
+                  operation = ::Gapic::Rest::TransportOperation.new response
+                  result = ::Google::Cloud::Dialogflow::CX::V3::CompareVersionsResponse.decode_json response.body, ignore_unknown_fields: true
+
+                  yield result, operation if block_given?
+                  result
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the list_versions REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::ListVersionsRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_list_versions_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :get,
+                                                            uri_template: "/v3/{parent}/versions",
+                                                            matches: [
+                                                              ["parent", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the get_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::GetVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_get_version_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :get,
+                                                            uri_template: "/v3/{name}",
+                                                            matches: [
+                                                              ["name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the create_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::CreateVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_create_version_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/v3/{parent}/versions",
+                                                            body: "version",
+                                                            matches: [
+                                                              ["parent", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the update_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::UpdateVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_update_version_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :patch,
+                                                            uri_template: "/v3/{version.name}",
+                                                            body: "version",
+                                                            matches: [
+                                                              ["version.name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the delete_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::DeleteVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_delete_version_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :delete,
+                                                            uri_template: "/v3/{name}",
+                                                            matches: [
+                                                              ["name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the load_version REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::LoadVersionRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_load_version_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/v3/{name}:load",
+                                                            body: "*",
+                                                            matches: [
+                                                              ["name", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+
+                ##
+                # @private
+                #
+                # GRPC transcoding helper method for the compare_versions REST call
+                #
+                # @param request_pb [::Google::Cloud::Dialogflow::CX::V3::CompareVersionsRequest]
+                #   A request object representing the call parameters. Required.
+                # @return [Array(String, [String, nil], Hash{String => String})]
+                #   Uri, Body, Query string parameters
+                def self.transcode_compare_versions_request request_pb
+                  transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                          .with_bindings(
+                                                            uri_method: :post,
+                                                            uri_template: "/v3/{base_version}:compareVersions",
+                                                            body: "*",
+                                                            matches: [
+                                                              ["base_version", %r{^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+/?$}, false]
+                                                            ]
+                                                          )
+                  transcoder.transcode request_pb
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dialogflow/cx/v3/versions/rest.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dialogflow/cx/v3/version"
+require "google/cloud/dialogflow/cx/v3/bindings_override"
+
+require "google/cloud/dialogflow/cx/v3/versions/credentials"
+require "google/cloud/dialogflow/cx/v3/versions/paths"
+require "google/cloud/dialogflow/cx/v3/versions/rest/operations"
+require "google/cloud/dialogflow/cx/v3/versions/rest/client"
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          ##
+          # Service for managing {::Google::Cloud::Dialogflow::CX::V3::Version Versions}.
+          #
+          # To load this service and instantiate a REST client:
+          #
+          #     require "google/cloud/dialogflow/cx/v3/versions/rest"
+          #     client = ::Google::Cloud::Dialogflow::CX::V3::Versions::Rest::Client.new
+          #
+          module Versions
+            # Client for the REST transport
+            module Rest
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/dialogflow/cx/v3/versions/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/dialogflow/cx/v3/versions.rb

@@ -26,6 +26,7 @@ require "google/cloud/dialogflow/cx/v3/versions/credentials"
 require "google/cloud/dialogflow/cx/v3/versions/paths"
 require "google/cloud/dialogflow/cx/v3/versions/operations"
 require "google/cloud/dialogflow/cx/v3/versions/client"
+require "google/cloud/dialogflow/cx/v3/versions/rest"
 
 module Google
   module Cloud
@@ -40,6 +41,11 @@ module Google
           #     require "google/cloud/dialogflow/cx/v3/versions"
           #     client = ::Google::Cloud::Dialogflow::CX::V3::Versions::Client.new
           #
+          # @example Load this service and instantiate a REST client
+          #
+          #     require "google/cloud/dialogflow/cx/v3/versions/rest"
+          #     client = ::Google::Cloud::Dialogflow::CX::V3::Versions::Rest::Client.new
+          #
           module Versions
           end
         end

data/lib/google/cloud/dialogflow/cx/v3/webhooks/client.rb

@@ -659,9 +659,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
               #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
               #    *  (`nil`) indicating no credentials