Merge pull request #96 from watson-developer-cloud/release-3-2020

Release 3 2020

Author: Mikemosca

README.md

@@ -129,7 +129,7 @@ IBM Cloud is migrating to token-based Identity and Access Management (IAM) authe
 You supply either an IAM service **API key** or an **access token**:
 
 * Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
-* Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/services/watson?topic=watson-iam).
+* Use the access token if you want to manage the lifecycle yourself. For details, see [Authenticating with IAM tokens](https://cloud.ibm.com/docs/watson?topic=watson-iam).
 
 #### Supplying the IAM API key
 
@@ -423,6 +423,6 @@ We'd love to highlight cool open-source projects that use this SDK! If you'd lik
 [examples]: https://github.com/watson-developer-cloud/ruby-sdk/tree/master/examples
 [CONTRIBUTING]: https://github.com/watson-developer-cloud/ruby-sdk/blob/master/CONTRIBUTING.md
 [license]: http://www.apache.org/licenses/LICENSE-2.0
-[vcap_services]: https://cloud.ibm.com/docs/services/watson?topic=watson-vcapServices
+[vcap_services]: https://cloud.ibm.com/docs/watson?topic=watson-vcapServices
 [ibm-cloud-onboarding]: http://cloud.ibm.com/registration?target=/developer/watson&cm_sp=WatsonPlatform-WatsonServices-_-OnPageNavLink-IBMWatson_SDKs-_-Ruby
 [ivar]: http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/IVar.html

lib/ibm_watson/assistant_v1.rb

@@ -33,6 +33,8 @@ module IBMWatson
   # The Assistant V1 service.
   class AssistantV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "assistant"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/assistant/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Assistant service.
@@ -51,19 +53,23 @@ class AssistantV1 < IBMCloudSdkCore::BaseService
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/assistant/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "assistant"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -706,7 +712,7 @@ def list_examples(workspace_id:, intent:, page_limit: nil, sort: nil, cursor: ni
     # Create user input example.
     # Add a new user input example to an intent.
     #
-    #   If you want to add multiple exaples with a single API call, consider using the
+    #   If you want to add multiple examples with a single API call, consider using the
     #   **[Update intent](#update-intent)** method instead.
     #
     #   This operation is limited to 1000 requests per 30 minutes. For more information,
@@ -2054,7 +2060,8 @@ def list_dialog_nodes(workspace_id:, page_limit: nil, sort: nil, cursor: nil, in
     # @param digress_out_slots [String] Whether the user can digress to top-level nodes while filling out slots.
     # @param user_label [String] A label that can be displayed externally to describe the purpose of the node to
     #   users.
-    # @param disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions.
+    # @param disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions. Valid
+    #   only when **type**=`standard` or `frame`.
     # @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
     #   the response.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
@@ -2189,7 +2196,8 @@ def get_dialog_node(workspace_id:, dialog_node:, include_audit: nil)
     # @param new_digress_out_slots [String] Whether the user can digress to top-level nodes while filling out slots.
     # @param new_user_label [String] A label that can be displayed externally to describe the purpose of the node to
     #   users.
-    # @param new_disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions.
+    # @param new_disambiguation_opt_out [Boolean] Whether the dialog node should be excluded from disambiguation suggestions. Valid
+    #   only when **type**=`standard` or `frame`.
     # @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
     #   the response.
     # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.

lib/ibm_watson/assistant_v2.rb

@@ -33,6 +33,8 @@ module IBMWatson
   # The Assistant V2 service.
   class AssistantV2 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "assistant"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/assistant/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Assistant service.
@@ -51,19 +53,23 @@ class AssistantV2 < IBMCloudSdkCore::BaseService
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/assistant/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "assistant"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################

lib/ibm_watson/compare_comply_v1.rb

@@ -29,6 +29,8 @@ module IBMWatson
   # The Compare Comply V1 service.
   class CompareComplyV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "compare_comply"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/compare-comply/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Compare Comply service.
@@ -47,19 +49,23 @@ class CompareComplyV1 < IBMCloudSdkCore::BaseService
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/compare-comply/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "compare_comply"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -473,10 +479,10 @@ def delete_feedback(feedback_id:, model: nil)
     # Run Compare and Comply methods over a collection of input documents.
     #
     #   **Important:** Batch processing requires the use of the [IBM Cloud Object Storage
-    #   service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
+    #   service](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
     #   The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using
     #   batch
-    #   processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-comply-batching#before-you-batch).
+    #   processing](https://cloud.ibm.com/docs/compare-comply?topic=compare-comply-batching#before-you-batch).
     # @param function [String] The Compare and Comply method to run across the submitted input documents.
     # @param input_credentials_file [File] A JSON file containing the input Cloud Object Storage credentials. At a minimum,
     #   the credentials must enable `READ` permissions on the bucket defined by the

lib/ibm_watson/discovery_v1.rb

@@ -32,6 +32,8 @@ module IBMWatson
   # The Discovery V1 service.
   class DiscoveryV1 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "discovery"
+    DEFAULT_SERVICE_URL = "https://gateway.watsonplatform.net/discovery/api"
     ##
     # @!method initialize(args)
     # Construct a new client for the Discovery service.
@@ -50,19 +52,23 @@ class DiscoveryV1 < IBMCloudSdkCore::BaseService
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = "https://gateway.watsonplatform.net/discovery/api"
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "discovery"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -1312,7 +1318,7 @@ def delete_document(environment_id:, collection_id:, document_id:)
     # Query a collection.
     # By using this method, you can construct long queries. For details, see the
     #   [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts).
+    #   documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts).
     # @param environment_id [String] The ID of the environment.
     # @param collection_id [String] The ID of the collection.
     # @param filter [String] A cacheable query that excludes documents that don't mention the query content.
@@ -1432,7 +1438,7 @@ def query(environment_id:, collection_id:, filter: nil, query: nil, natural_lang
     # Queries for notices (errors or warnings) that might have been generated by the
     #   system. Notices are generated when ingesting documents and performing relevance
     #   training. See the [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts)
+    #   documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts)
     #   for more details on the query language.
     # @param environment_id [String] The ID of the environment.
     # @param collection_id [String] The ID of the collection.
@@ -1532,7 +1538,7 @@ def query_notices(environment_id:, collection_id:, filter: nil, query: nil, natu
     # Query multiple collections.
     # By using this method, you can construct long queries that search multiple
     #   collection. For details, see the [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts).
+    #   documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts).
     # @param environment_id [String] The ID of the environment.
     # @param collection_ids [String] A comma-separated list of collection IDs to be queried against.
     # @param filter [String] A cacheable query that excludes documents that don't mention the query content.
@@ -1646,7 +1652,7 @@ def federated_query(environment_id:, collection_ids:, filter: nil, query: nil, n
     # Queries for notices (errors or warnings) that might have been generated by the
     #   system. Notices are generated when ingesting documents and performing relevance
     #   training. See the [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-query-concepts#query-concepts)
+    #   documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-concepts#query-concepts)
     #   for more details on the query language.
     # @param environment_id [String] The ID of the environment.
     # @param collection_ids [Array[String]] A comma-separated list of collection IDs to be queried against.
@@ -2184,7 +2190,7 @@ def get_training_example(environment_id:, collection_id:, query_id:, example_id:
     #   You associate a customer ID with data by passing the **X-Watson-Metadata** header
     #   with a request that passes data. For more information about personal data and
     #   customer IDs, see [Information
-    #   security](https://cloud.ibm.com/docs/services/discovery?topic=discovery-information-security#information-security).
+    #   security](https://cloud.ibm.com/docs/discovery?topic=discovery-information-security#information-security).
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]
     def delete_user_data(customer_id:)

lib/ibm_watson/discovery_v2.rb

@@ -32,6 +32,8 @@ module IBMWatson
   # The Discovery V2 service.
   class DiscoveryV2 < IBMCloudSdkCore::BaseService
     include Concurrent::Async
+    DEFAULT_SERVICE_NAME = "discovery"
+    DEFAULT_SERVICE_URL = nil
     ##
     # @!method initialize(args)
     # Construct a new client for the Discovery service.
@@ -50,19 +52,23 @@ class DiscoveryV2 < IBMCloudSdkCore::BaseService
     # @option args service_url [String] The base service URL to use when contacting the service.
     #   The base service_url may differ between IBM Cloud regions.
     # @option args authenticator [Object] The Authenticator instance to be configured for this service.
+    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
+    #   any external configuration, if applicable.
     def initialize(args = {})
       @__async_initialized__ = false
       defaults = {}
       defaults[:version] = nil
-      defaults[:service_url] = nil
+      defaults[:service_url] = DEFAULT_SERVICE_URL
+      defaults[:service_name] = DEFAULT_SERVICE_NAME
       defaults[:authenticator] = nil
+      user_service_url = args[:service_url] unless args[:service_url].nil?
       args = defaults.merge(args)
       @version = args[:version]
       raise ArgumentError.new("version must be provided") if @version.nil?
 
-      args[:service_name] = "discovery"
       args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
       super
+      @service_url = user_service_url unless user_service_url.nil?
     end
 
     #########################
@@ -107,7 +113,7 @@ def list_collections(project_id:)
     # @!method query(project_id:, collection_ids: nil, filter: nil, query: nil, natural_language_query: nil, aggregation: nil, count: nil, _return: nil, offset: nil, sort: nil, highlight: nil, spelling_suggestions: nil, table_results: nil, suggested_refinements: nil, passages: nil)
     # Query a project.
     # By using this method, you can construct queries. For details, see the [Discovery
-    #   documentation](https://cloud.ibm.com/docs/services/discovery-data?topic=discovery-data-query-concepts).
+    #   documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-query-concepts).
     # @param project_id [String] The ID of the project. This information can be found from the deploy page of the
     #   Discovery administrative tooling.
     # @param collection_ids [Array[String]] A comma-separated list of collection IDs to be queried against.