ibm_watson 0.5.1 → 0.6.0

data/lib/ibm_watson/discovery_v1.rb

@@ -31,7 +31,7 @@ require_relative "./watson_service"
 module IBMWatson
   ##
   # The Discovery V1 service.
-  class DiscoveryV1
+  class DiscoveryV1 < WatsonService
     include Concurrent::Async
     ##
     # @!method initialize(args)
@@ -72,7 +72,6 @@ module IBMWatson
     #   'https://iam.ng.bluemix.net/identity/token'.
     def initialize(args = {})
       @__async_initialized__ = false
-      super()
       defaults = {}
       defaults[:version] = nil
       defaults[:url] = "https://gateway.watsonplatform.net/discovery/api"
@@ -82,84 +81,11 @@ module IBMWatson
       defaults[:iam_access_token] = nil
       defaults[:iam_url] = nil
       args = defaults.merge(args)
-      @watson_service = WatsonService.new(
-        vcap_services_name: "discovery",
-        url: args[:url],
-        username: args[:username],
-        password: args[:password],
-        iam_apikey: args[:iam_apikey],
-        iam_access_token: args[:iam_access_token],
-        iam_url: args[:iam_url],
-        use_vcap_services: true
-      )
+      args[:vcap_services_name] = "discovery"
+      super
       @version = args[:version]
     end
 
-    # :nocov:
-    def add_default_headers(headers: {})
-      @watson_service.add_default_headers(headers: headers)
-    end
-
-    def _iam_access_token(iam_access_token:)
-      @watson_service._iam_access_token(iam_access_token: iam_access_token)
-    end
-
-    def _iam_apikey(iam_apikey:)
-      @watson_service._iam_apikey(iam_apikey: iam_apikey)
-    end
-
-    # @return [DetailedResponse]
-    def request(args)
-      @watson_service.request(args)
-    end
-
-    # @note Chainable
-    # @param headers [Hash] Custom headers to be sent with the request
-    # @return [self]
-    def headers(headers)
-      @watson_service.headers(headers)
-      self
-    end
-
-    def password=(password)
-      @watson_service.password = password
-    end
-
-    def password
-      @watson_service.password
-    end
-
-    def username=(username)
-      @watson_service.username = username
-    end
-
-    def username
-      @watson_service.username
-    end
-
-    def url=(url)
-      @watson_service.url = url
-    end
-
-    def url
-      @watson_service.url
-    end
-
-    # @!method configure_http_client(proxy: {}, timeout: {})
-    # Sets the http client config, currently works with timeout and proxies
-    # @param proxy [Hash] The hash of proxy configurations
-    # @option proxy address [String] The address of the proxy
-    # @option proxy port [Integer] The port of the proxy
-    # @option proxy username [String] The username of the proxy, if authentication is needed
-    # @option proxy password [String] The password of the proxy, if authentication is needed
-    # @option proxy headers [Hash] The headers to be used with the proxy
-    # @param timeout [Hash] The hash for configuring timeouts. `per_operation` has priority over `global`
-    # @option timeout per_operation [Hash] Timeouts per operation. Requires `read`, `write`, `connect`
-    # @option timeout global [Integer] Upper bound on total request time
-    def configure_http_client(proxy: {}, timeout: {})
-      @watson_service.configure_http_client(proxy: proxy, timeout: timeout)
-    end
-    # :nocov:
     #########################
     # Environments
     #########################
@@ -178,6 +104,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_environment(name:, description: nil, size: nil)
       raise ArgumentError("name must be provided") if name.nil?
+
       headers = {
       }
       params = {
@@ -231,6 +158,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_environment(environment_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       headers = {
       }
       params = {
@@ -258,6 +186,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def update_environment(environment_id:, name: nil, description: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       headers = {
       }
       params = {
@@ -286,6 +215,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def delete_environment(environment_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       headers = {
       }
       params = {
@@ -312,7 +242,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_fields(environment_id:, collection_ids:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_ids must be provided") if collection_ids.nil?
+
       headers = {
       }
       params = {
@@ -360,7 +292,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_configuration(environment_id:, name:, description: nil, conversions: nil, enrichments: nil, normalizations: nil, source: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("name must be provided") if name.nil?
+
       headers = {
       }
       params = {
@@ -395,6 +329,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_configurations(environment_id:, name: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       headers = {
       }
       params = {
@@ -420,7 +355,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_configuration(environment_id:, configuration_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("configuration_id must be provided") if configuration_id.nil?
+
       headers = {
       }
       params = {
@@ -462,8 +399,11 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def update_configuration(environment_id:, configuration_id:, name:, description: nil, conversions: nil, enrichments: nil, normalizations: nil, source: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("configuration_id must be provided") if configuration_id.nil?
+
       raise ArgumentError("name must be provided") if name.nil?
+
       headers = {
       }
       params = {
@@ -503,7 +443,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def delete_configuration(environment_id:, configuration_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("configuration_id must be provided") if configuration_id.nil?
+
       headers = {
       }
       params = {
@@ -558,6 +500,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def test_configuration_in_environment(environment_id:, configuration: nil, step: nil, configuration_id: nil, file: nil, metadata: nil, file_content_type: nil, filename: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       headers = {
       }
       params = {
@@ -607,7 +550,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_collection(environment_id:, name:, description: nil, configuration_id: nil, language: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("name must be provided") if name.nil?
+
       headers = {
       }
       params = {
@@ -640,6 +585,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_collections(environment_id:, name: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       headers = {
       }
       params = {
@@ -665,7 +611,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_collection(environment_id:, collection_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -693,7 +641,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def update_collection(environment_id:, collection_id:, name:, description: nil, configuration_id: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -724,7 +674,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def delete_collection(environment_id:, collection_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -750,7 +702,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_collection_fields(environment_id:, collection_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -780,7 +734,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_expansions(environment_id:, collection_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -824,8 +780,11 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_expansions(environment_id:, collection_id:, expansions:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("expansions must be provided") if expansions.nil?
+
       headers = {
       }
       params = {
@@ -856,7 +815,9 @@ module IBMWatson
     # @return [nil]
     def delete_expansions(environment_id:, collection_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -920,7 +881,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def add_document(environment_id:, collection_id:, file: nil, metadata: nil, file_content_type: nil, filename: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -965,8 +928,11 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_document_status(environment_id:, collection_id:, document_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("document_id must be provided") if document_id.nil?
+
       headers = {
       }
       params = {
@@ -1005,8 +971,11 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def update_document(environment_id:, collection_id:, document_id:, file: nil, metadata: nil, file_content_type: nil, filename: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("document_id must be provided") if document_id.nil?
+
       headers = {
       }
       params = {
@@ -1050,8 +1019,11 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def delete_document(environment_id:, collection_id:, document_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("document_id must be provided") if document_id.nil?
+
       headers = {
       }
       params = {
@@ -1134,7 +1106,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def query(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, return_fields: nil, offset: nil, sort: nil, highlight: nil, passages_fields: nil, passages_count: nil, passages_characters: nil, deduplicate: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil, logging_opt_out: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
         "X-Watson-Logging-Opt-Out" => logging_opt_out
       }
@@ -1230,7 +1204,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def query_notices(environment_id:, collection_id:, filter: nil, query: nil, natural_language_query: nil, passages: nil, aggregation: nil, count: nil, return_fields: nil, offset: nil, sort: nil, highlight: nil, passages_fields: nil, passages_count: nil, passages_characters: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -1326,7 +1302,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def federated_query(environment_id:, collection_ids:, filter: nil, query: nil, natural_language_query: nil, aggregation: nil, count: nil, return_fields: nil, offset: nil, sort: nil, highlight: nil, deduplicate: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil, passages: nil, passages_fields: nil, passages_count: nil, passages_characters: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_ids must be provided") if collection_ids.nil?
+
       headers = {
       }
       params = {
@@ -1415,7 +1393,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def federated_query_notices(environment_id:, collection_ids:, filter: nil, query: nil, natural_language_query: nil, aggregation: nil, count: nil, return_fields: nil, offset: nil, sort: nil, highlight: nil, deduplicate_field: nil, similar: nil, similar_document_ids: nil, similar_fields: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_ids must be provided") if collection_ids.nil?
+
       headers = {
       }
       params = {
@@ -1466,7 +1446,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def query_entities(environment_id:, collection_id:, feature: nil, entity: nil, context: nil, count: nil, evidence_count: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -1513,7 +1495,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def query_relations(environment_id:, collection_id:, entities: nil, context: nil, sort: nil, filter: nil, count: nil, evidence_count: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -1551,7 +1535,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_training_data(environment_id:, collection_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -1581,7 +1567,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def add_training_data(environment_id:, collection_id:, natural_language_query: nil, filter: nil, examples: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -1613,7 +1601,9 @@ module IBMWatson
     # @return [nil]
     def delete_all_training_data(environment_id:, collection_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       headers = {
       }
       params = {
@@ -1641,8 +1631,11 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_training_data(environment_id:, collection_id:, query_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("query_id must be provided") if query_id.nil?
+
       headers = {
       }
       params = {
@@ -1670,8 +1663,11 @@ module IBMWatson
     # @return [nil]
     def delete_training_data(environment_id:, collection_id:, query_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("query_id must be provided") if query_id.nil?
+
       headers = {
       }
       params = {
@@ -1698,8 +1694,11 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_training_examples(environment_id:, collection_id:, query_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("query_id must be provided") if query_id.nil?
+
       headers = {
       }
       params = {
@@ -1729,8 +1728,11 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_training_example(environment_id:, collection_id:, query_id:, document_id: nil, cross_reference: nil, relevance: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("query_id must be provided") if query_id.nil?
+
       headers = {
       }
       params = {
@@ -1764,9 +1766,13 @@ module IBMWatson
     # @return [nil]
     def delete_training_example(environment_id:, collection_id:, query_id:, example_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("query_id must be provided") if query_id.nil?
+
       raise ArgumentError("example_id must be provided") if example_id.nil?
+
       headers = {
       }
       params = {
@@ -1796,9 +1802,13 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def update_training_example(environment_id:, collection_id:, query_id:, example_id:, cross_reference: nil, relevance: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("query_id must be provided") if query_id.nil?
+
       raise ArgumentError("example_id must be provided") if example_id.nil?
+
       headers = {
       }
       params = {
@@ -1831,9 +1841,13 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_training_example(environment_id:, collection_id:, query_id:, example_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("collection_id must be provided") if collection_id.nil?
+
       raise ArgumentError("query_id must be provided") if query_id.nil?
+
       raise ArgumentError("example_id must be provided") if example_id.nil?
+
       headers = {
       }
       params = {
@@ -1867,6 +1881,7 @@ module IBMWatson
     # @return [nil]
     def delete_user_data(customer_id:)
       raise ArgumentError("customer_id must be provided") if customer_id.nil?
+
       headers = {
       }
       params = {
@@ -1898,7 +1913,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_event(type:, data:)
       raise ArgumentError("type must be provided") if type.nil?
+
       raise ArgumentError("data must be provided") if data.nil?
+
       headers = {
       }
       params = {
@@ -2131,6 +2148,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def list_credentials(environment_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       headers = {
       }
       params = {
@@ -2168,6 +2186,7 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def create_credentials(environment_id:, source_type: nil, credential_details: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       headers = {
       }
       params = {
@@ -2201,7 +2220,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_credentials(environment_id:, credential_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("credential_id must be provided") if credential_id.nil?
+
       headers = {
       }
       params = {
@@ -2239,7 +2260,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def update_credentials(environment_id:, credential_id:, source_type: nil, credential_details: nil)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("credential_id must be provided") if credential_id.nil?
+
       headers = {
       }
       params = {
@@ -2270,7 +2293,9 @@ module IBMWatson
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def delete_credentials(environment_id:, credential_id:)
       raise ArgumentError("environment_id must be provided") if environment_id.nil?
+
       raise ArgumentError("credential_id must be provided") if credential_id.nil?
+
       headers = {
       }
       params = {