tca_client 1.0.0 → 1.0.1

data/lib/tca_client/api/webhook_api.rb

@@ -3,12 +3,15 @@
 
 #Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
 
-OpenAPI spec version: 1.0.249
+The version of the OpenAPI document: 1.0.258
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.3.0-SNAPSHOT
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.35
 =end
 
+require 'cgi'
+
 module TCAClient
   class WebhookApi
     attr_accessor :api_client
@@ -17,9 +20,9 @@ module TCAClient
       @api_client = api_client
     end
     # Delete Webhook endpoint
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
-    # @param id 
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def delete_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
@@ -28,9 +31,9 @@ module TCAClient
     end
 
     # Delete Webhook endpoint
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
-    # @param id 
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
@@ -50,7 +53,7 @@ module TCAClient
         fail ArgumentError, "Missing the required parameter 'id' when calling WebhookApi.delete_webhook"
       end
       # resource path
-      local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', id.to_s)
+      local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -66,28 +69,35 @@ module TCAClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
 
-      return_type = opts[:return_type] 
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
 
-      auth_names = opts[:auth_names] || ['api_key']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+      new_options = opts.merge(
+        :operation => :"WebhookApi.delete_webhook",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type)
+        :return_type => return_type
+      )
 
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: WebhookApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Get Webhook endpoint info
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
-    # @param id 
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Webhook]
     def get_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
@@ -96,9 +106,9 @@ module TCAClient
     end
 
     # Get Webhook endpoint info
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
-    # @param id 
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
+    # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
     def get_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
@@ -118,7 +128,7 @@ module TCAClient
         fail ArgumentError, "Missing the required parameter 'id' when calling WebhookApi.get_webhook"
       end
       # resource path
-      local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', id.to_s)
+      local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -134,51 +144,54 @@ module TCAClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Webhook'
 
-      return_type = opts[:return_type] || 'Webhook' 
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
 
-      auth_names = opts[:auth_names] || ['api_key']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      new_options = opts.merge(
+        :operation => :"WebhookApi.get_webhook",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type)
+        :return_type => return_type
+      )
 
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: WebhookApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Update Webhook endpoint info
-    # @param body 
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
-    # @param id 
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
+    # @param id [String] 
+    # @param data [WebhookPathRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Webhook]
-    def update_webhook(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
-      data, _status_code, _headers = update_webhook_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+    def update_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, data, opts = {})
+      data, _status_code, _headers = update_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data, opts)
       data
     end
 
     # Update Webhook endpoint info
-    # @param body 
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
-    # @param id 
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
+    # @param id [String] 
+    # @param data [WebhookPathRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
-    def update_webhook_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
+    def update_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WebhookApi.update_webhook ...'
       end
-      # verify the required parameter 'body' is set
-      if @api_client.config.client_side_validation && body.nil?
-        fail ArgumentError, "Missing the required parameter 'body' when calling WebhookApi.update_webhook"
-      end
       # verify the required parameter 'x_turnitin_integration_name' is set
       if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
         fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling WebhookApi.update_webhook"
@@ -191,8 +204,12 @@ module TCAClient
       if @api_client.config.client_side_validation && id.nil?
         fail ArgumentError, "Missing the required parameter 'id' when calling WebhookApi.update_webhook"
       end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling WebhookApi.update_webhook"
+      end
       # resource path
-      local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', id.to_s)
+      local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -202,7 +219,10 @@ module TCAClient
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
       header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
       header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version
 
@@ -210,27 +230,34 @@ module TCAClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
 
-      return_type = opts[:return_type] || 'Webhook' 
+      # return_type
+      return_type = opts[:debug_return_type] || 'Webhook'
 
-      auth_names = opts[:auth_names] || ['api_key']
-      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"WebhookApi.update_webhook",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type)
+        :return_type => return_type
+      )
 
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: WebhookApi#update_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # List registered Webhook endpoints
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
     # @param [Hash] opts the optional parameters
     # @return [Array<Webhook>]
     def webhooks_get(x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
@@ -239,8 +266,8 @@ module TCAClient
     end
 
     # List registered Webhook endpoints
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<Webhook>, Integer, Hash)>] Array<Webhook> data, response status code and response headers
     def webhooks_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
@@ -272,49 +299,52 @@ module TCAClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
-      return_type = opts[:return_type] || 'Array<Webhook>' 
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Webhook>'
 
-      auth_names = opts[:auth_names] || ['api_key']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
+
+      new_options = opts.merge(
+        :operation => :"WebhookApi.webhooks_get",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type)
+        :return_type => return_type
+      )
 
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: WebhookApi#webhooks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
     # Register a Webhook endpoint
-    # @param body 
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
+    # @param data [WebhookWithSecret] 
     # @param [Hash] opts the optional parameters
     # @return [Webhook]
-    def webhooks_post(body, x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
-      data, _status_code, _headers = webhooks_post_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, opts)
+    def webhooks_post(x_turnitin_integration_name, x_turnitin_integration_version, data, opts = {})
+      data, _status_code, _headers = webhooks_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, data, opts)
       data
     end
 
     # Register a Webhook endpoint
-    # @param body 
-    # @param x_turnitin_integration_name a human readable string representing the type of integration being used
-    # @param x_turnitin_integration_version the version of the integration platform being used
+    # @param x_turnitin_integration_name [String] a human readable string representing the type of integration being used
+    # @param x_turnitin_integration_version [String] the version of the integration platform being used
+    # @param data [WebhookWithSecret] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
-    def webhooks_post_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
+    def webhooks_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WebhookApi.webhooks_post ...'
       end
-      # verify the required parameter 'body' is set
-      if @api_client.config.client_side_validation && body.nil?
-        fail ArgumentError, "Missing the required parameter 'body' when calling WebhookApi.webhooks_post"
-      end
       # verify the required parameter 'x_turnitin_integration_name' is set
       if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
         fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling WebhookApi.webhooks_post"
@@ -323,6 +353,10 @@ module TCAClient
       if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
         fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling WebhookApi.webhooks_post"
       end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' when calling WebhookApi.webhooks_post"
+      end
       # resource path
       local_var_path = '/webhooks'
 
@@ -334,7 +368,10 @@ module TCAClient
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
       header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
       header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version
 
@@ -342,19 +379,25 @@ module TCAClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Webhook'
 
-      return_type = opts[:return_type] || 'Webhook' 
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['api_key']
 
-      auth_names = opts[:auth_names] || ['api_key']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      new_options = opts.merge(
+        :operation => :"WebhookApi.webhooks_post",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => return_type)
+        :return_type => return_type
+      )
 
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: WebhookApi#webhooks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/tca_client/api_client.rb

@@ -3,18 +3,19 @@
 
 #Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
 
-OpenAPI spec version: 1.0.249
+The version of the OpenAPI document: 1.0.258
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.3.0-SNAPSHOT
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.35
 =end
 
 require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'time'
 require 'typhoeus'
-require 'uri'
 
 module TCAClient
   class ApiClient
@@ -30,7 +31,7 @@ module TCAClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
+      @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -86,12 +87,13 @@ module TCAClient
     # @option opts [Object] :body HTTP body (JSON/XML)
     # @return [Typhoeus::Request] A Typhoeus Request
     def build_request(http_method, path, opts = {})
-      url = build_request_url(path)
+      url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
+      follow_location = opts[:follow_location] || true
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
@@ -108,7 +110,8 @@ module TCAClient
         :ssl_verifyhost => _verify_ssl_host,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        :verbose => @config.debugging,
+        :followlocation => follow_location
       }
 
       # set custom cert, if provided
@@ -155,6 +158,44 @@ module TCAClient
       data
     end
 
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    # The response body is written to the file in chunks in order to handle files which
+    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+    # process can use.
+    #
+    # @see Configuration#temp_folder_path
+    def download_file(request)
+      tempfile = nil
+      encoding = nil
+      request.on_headers do |response|
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = response.body.encoding
+        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        @tempfile = tempfile
+      end
+      request.on_body do |chunk|
+        chunk.force_encoding(encoding)
+        tempfile.write(chunk)
+      end
+      request.on_complete do |response|
+        if tempfile
+          tempfile.close
+          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
+        end
+      end
+    end
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -191,7 +232,7 @@ module TCAClient
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
       rescue JSON::ParserError => e
-        if %w(String Date DateTime).include?(return_type)
+        if %w(String Date Time).include?(return_type)
           data = body
         else
           raise e
@@ -216,9 +257,9 @@ module TCAClient
         data.to_f
       when 'Boolean'
         data == true
-      when 'DateTime'
+      when 'Time'
         # parse date time (expecting ISO 8601 format)
-        DateTime.parse data
+        Time.parse data
       when 'Date'
         # parse date time (expecting ISO 8601 format)
         Date.parse data
@@ -236,46 +277,9 @@ module TCAClient
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        # models, e.g. Pet
-        TCAClient.const_get(return_type).build_from_hash(data)
-      end
-    end
-
-    # Save response body into a file in (the defined) temporary folder, using the filename
-    # from the "Content-Disposition" header if provided, otherwise a random filename.
-    # The response body is written to the file in chunks in order to handle files which
-    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
-    # process can use.
-    #
-    # @see Configuration#temp_folder_path
-    def download_file(request)
-      tempfile = nil
-      encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = response.body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
-      end
-      request.on_body do |chunk|
-        chunk.force_encoding(encoding)
-        tempfile.write(chunk)
-      end
-      request.on_complete do |response|
-        if tempfile
-          tempfile.close
-          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                              "explicitly with `tempfile.delete`"
-        end
+        # models (e.g. Pet) or oneOf
+        klass = TCAClient.const_get(return_type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
       end
     end
 
@@ -288,13 +292,13 @@ module TCAClient
       filename.gsub(/.*[\/\\]/, '')
     end
 
-    def build_request_url(path)
+    def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      @config.base_url + path
+      @config.base_url(opts[:operation]) + path
     end
 
-    # Update hearder and query params based on authentication settings.
+    # Update header and query params based on authentication settings.
     #
     # @param [Hash] header_params Header parameters
     # @param [Hash] query_params Query parameters
@@ -306,14 +310,14 @@ module TCAClient
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
         when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
     end
 
     # Sets user agent in HTTP header
     #
-    # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
+    # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
     def user_agent=(user_agent)
       @user_agent = user_agent
       @default_headers['User-Agent'] = @user_agent
@@ -333,8 +337,8 @@ module TCAClient
     # @param [Array] content_types array for Content-Type
     # @return [String] the Content-Type header  (e.g. application/json)
     def select_header_content_type(content_types)
-      # use application/json by default
-      return 'application/json' if content_types.nil? || content_types.empty?
+      # return nil by default
+      return if content_types.nil? || content_types.empty?
       # use JSON when present, otherwise use the first one
       json_content_type = content_types.find { |s| json_mime?(s) }
       json_content_type || content_types.first

data/lib/tca_client/api_error.rb

@@ -3,10 +3,11 @@
 
 #Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
 
-OpenAPI spec version: 1.0.249
+The version of the OpenAPI document: 1.0.258
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.3.0-SNAPSHOT
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 3.0.35
 =end
 
 module TCAClient
@@ -52,6 +53,5 @@ module TCAClient
 
       msg
     end
-
   end
 end