tca_client 1.0.0

data/lib/tca_client/api/submission_api.rb

@@ -0,0 +1,387 @@
+=begin
+#Turnitin Core API
+
+#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
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+module TCAClient
+  class SubmissionApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a new Submission
+    # @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 [Hash] opts the optional parameters
+    # @return [SimpleSubmissionResponse]
+    def create_submission(body, x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
+      data, _status_code, _headers = create_submission_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, opts)
+      data
+    end
+
+    # Create a new Submission
+    # @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 [Hash] opts the optional parameters
+    # @return [Array<(SimpleSubmissionResponse, Integer, Hash)>] SimpleSubmissionResponse data, response status code and response headers
+    def create_submission_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubmissionApi.create_submission ...'
+      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 SubmissionApi.create_submission"
+      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 SubmissionApi.create_submission"
+      end
+      # verify the required parameter 'x_turnitin_integration_version' is set
+      if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
+        fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SubmissionApi.create_submission"
+      end
+      # resource path
+      local_var_path = '/submissions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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'])
+      header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
+      header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'SimpleSubmissionResponse' 
+
+      auth_names = opts[:auth_names] || ['api_key']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubmissionApi#create_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Deletes a submission and associated similarity report.
+    # @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 The Submission ID (returned upon a successful POST to /submissions) 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :hard Accepts true or false indicating either hard or soft delete. A soft delete removes the associated submission report/index and changes the saved submission state to DELETED. A hard deletion completely removes the submission information from Panda and TCA and removes the associated report/index, which can not be recovered.  (default to false)
+    # @return [SuccessMessage]
+    def delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
+      data, _status_code, _headers = delete_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+      data
+    end
+
+    # Deletes a submission and associated similarity report.
+    # @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 The Submission ID (returned upon a successful POST to /submissions) 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :hard Accepts true or false indicating either hard or soft delete. A soft delete removes the associated submission report/index and changes the saved submission state to DELETED. A hard deletion completely removes the submission information from Panda and TCA and removes the associated report/index, which can not be recovered. 
+    # @return [Array<(SuccessMessage, Integer, Hash)>] SuccessMessage data, response status code and response headers
+    def delete_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubmissionApi.delete_submission ...'
+      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 SubmissionApi.delete_submission"
+      end
+      # verify the required parameter 'x_turnitin_integration_version' is set
+      if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
+        fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SubmissionApi.delete_submission"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SubmissionApi.delete_submission"
+      end
+      # resource path
+      local_var_path = '/submissions/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'hard'] = opts[:'hard'] if !opts[:'hard'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
+      header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'SuccessMessage' 
+
+      auth_names = opts[:auth_names] || ['api_key']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubmissionApi#delete_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get Submission Details
+    # @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 The Submission ID (returned upon a successful POST to /submissions) 
+    # @param [Hash] opts the optional parameters
+    # @return [Submission]
+    def get_submiddion_details(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
+      data, _status_code, _headers = get_submiddion_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+      data
+    end
+
+    # Get Submission Details
+    # @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 The Submission ID (returned upon a successful POST to /submissions) 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Submission, Integer, Hash)>] Submission data, response status code and response headers
+    def get_submiddion_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubmissionApi.get_submiddion_details ...'
+      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 SubmissionApi.get_submiddion_details"
+      end
+      # verify the required parameter 'x_turnitin_integration_version' is set
+      if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
+        fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SubmissionApi.get_submiddion_details"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SubmissionApi.get_submiddion_details"
+      end
+      # resource path
+      local_var_path = '/submissions/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
+      header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'Submission' 
+
+      auth_names = opts[:auth_names] || ['api_key']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubmissionApi#get_submiddion_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Recover a soft deleted submission
+    # @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 The Submission ID (returned upon a successful POST to /submissions) 
+    # @param [Hash] opts the optional parameters
+    # @return [SimpleSubmissionResponse]
+    def recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
+      data, _status_code, _headers = recover_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+      data
+    end
+
+    # Recover a soft deleted submission
+    # @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 The Submission ID (returned upon a successful POST to /submissions) 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SimpleSubmissionResponse, Integer, Hash)>] SimpleSubmissionResponse data, response status code and response headers
+    def recover_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubmissionApi.recover_submission ...'
+      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 SubmissionApi.recover_submission"
+      end
+      # verify the required parameter 'x_turnitin_integration_version' is set
+      if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
+        fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SubmissionApi.recover_submission"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SubmissionApi.recover_submission"
+      end
+      # resource path
+      local_var_path = '/submissions/{id}/recover'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
+      header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'SimpleSubmissionResponse' 
+
+      auth_names = opts[:auth_names] || ['api_key']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubmissionApi#recover_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Upload Submitted File
+    # @param body the user&#x27;s submitted file
+    # @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 content_type *Must be &#x27;binary/octet-stream&#x27; 
+    # @param content_disposition *must include the \&quot;filename\&quot; parameter, e.g. &#x60;inline; filename&#x3D;\&quot;MyFile.docx\&quot;&#x60;. To support UTF-8 filenames, you must URL encode the header 
+    # @param id The Submission ID (returned upon a successful POST to /submissions) 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessMessage]
+    def upload_submitted_file(body, x_turnitin_integration_name, x_turnitin_integration_version, content_type, content_disposition, id, opts = {})
+      data, _status_code, _headers = upload_submitted_file_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, content_type, content_disposition, id, opts)
+      data
+    end
+
+    # Upload Submitted File
+    # @param body the user&#x27;s submitted file
+    # @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 content_type *Must be &#x27;binary/octet-stream&#x27; 
+    # @param content_disposition *must include the \&quot;filename\&quot; parameter, e.g. &#x60;inline; filename&#x3D;\&quot;MyFile.docx\&quot;&#x60;. To support UTF-8 filenames, you must URL encode the header 
+    # @param id The Submission ID (returned upon a successful POST to /submissions) 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessMessage, Integer, Hash)>] SuccessMessage data, response status code and response headers
+    def upload_submitted_file_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, content_type, content_disposition, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SubmissionApi.upload_submitted_file ...'
+      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 SubmissionApi.upload_submitted_file"
+      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 SubmissionApi.upload_submitted_file"
+      end
+      # verify the required parameter 'x_turnitin_integration_version' is set
+      if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
+        fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SubmissionApi.upload_submitted_file"
+      end
+      # verify the required parameter 'content_type' is set
+      if @api_client.config.client_side_validation && content_type.nil?
+        fail ArgumentError, "Missing the required parameter 'content_type' when calling SubmissionApi.upload_submitted_file"
+      end
+      # verify the required parameter 'content_disposition' is set
+      if @api_client.config.client_side_validation && content_disposition.nil?
+        fail ArgumentError, "Missing the required parameter 'content_disposition' when calling SubmissionApi.upload_submitted_file"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SubmissionApi.upload_submitted_file"
+      end
+      # resource path
+      local_var_path = '/submissions/{id}/original'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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(['binary/octet-stream'])
+      header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
+      header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version
+      header_params[:'Content-Type'] = content_type
+      header_params[:'Content-Disposition'] = content_disposition
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'SuccessMessage' 
+
+      auth_names = opts[:auth_names] || ['api_key']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SubmissionApi#upload_submitted_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end