tca_client 1.0.0

data/lib/tca_client/models/webhook_with_secret.rb

@@ -0,0 +1,271 @@
+=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
+
+require 'date'
+
+module TCAClient
+  class WebhookWithSecret
+    # a human readable description of the webhook
+    attr_accessor :description
+
+    # the URL to callback with events, this must be https unless (allow_insecure is true)
+    attr_accessor :url
+
+    # if using an non https url, this must be set to true
+    attr_accessor :allow_insecure
+
+    # an array of the types of callbacks that will be sent to this webhook
+    attr_accessor :event_types
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'url' => :'url',
+        :'allow_insecure' => :'allow_insecure',
+        :'event_types' => :'event_types'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'',
+        :'url' => :'',
+        :'allow_insecure' => :'',
+        :'event_types' => :''
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+  
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TCAClient::WebhookWithSecret` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TCAClient::WebhookWithSecret`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'allow_insecure')
+        self.allow_insecure = attributes[:'allow_insecure']
+      end
+
+      if attributes.key?(:'event_types')
+        if (value = attributes[:'event_types']).is_a?(Array)
+          self.event_types = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @event_types.nil?
+        invalid_properties.push('invalid value for "event_types", event_types cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @url.nil?
+      return false if @event_types.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          description == o.description &&
+          url == o.url &&
+          allow_insecure == o.allow_insecure &&
+          event_types == o.event_types
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [description, url, allow_insecure, event_types].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        TCAClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end  end
+end

data/lib/tca_client/version.rb

@@ -0,0 +1,14 @@
+=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
+  VERSION = '1.0.0'
+end

data/lib/tca_client.rb

@@ -0,0 +1,93 @@
+=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
+
+# Common files
+require 'tca_client/api_client'
+require 'tca_client/api_error'
+require 'tca_client/version'
+require 'tca_client/configuration'
+
+# Models
+require 'tca_client/models/add_group_attachment_request'
+require 'tca_client/models/add_group_attachment_response'
+require 'tca_client/models/aggregate_group'
+require 'tca_client/models/author_metadata_override'
+require 'tca_client/models/error'
+require 'tca_client/models/eula'
+require 'tca_client/models/eula_accept_list_item'
+require 'tca_client/models/eula_accept_request'
+require 'tca_client/models/eula_version'
+require 'tca_client/models/features_enabled'
+require 'tca_client/models/features_generation_settings'
+require 'tca_client/models/features_similarity'
+require 'tca_client/models/features_similarity_view_settings'
+require 'tca_client/models/features_tenant'
+require 'tca_client/models/features_viewer_modes'
+require 'tca_client/models/group'
+require 'tca_client/models/group_attachment_response'
+require 'tca_client/models/group_context'
+require 'tca_client/models/index_state_settings'
+require 'tca_client/models/indexing_settings'
+require 'tca_client/models/inline_response_200'
+require 'tca_client/models/pdf_status_response'
+require 'tca_client/models/rate_limit_error'
+require 'tca_client/models/request_pdf_response'
+require 'tca_client/models/sidebar'
+require 'tca_client/models/similarity_generation_settings'
+require 'tca_client/models/similarity_metadata'
+require 'tca_client/models/similarity_metadata_top_matches'
+require 'tca_client/models/similarity_put_request'
+require 'tca_client/models/similarity_score_data'
+require 'tca_client/models/similarity_settings'
+require 'tca_client/models/similarity_settings_modes'
+require 'tca_client/models/similarity_settings_view_settings'
+require 'tca_client/models/similarity_view_settings'
+require 'tca_client/models/similarity_viewer_url_response'
+require 'tca_client/models/similarity_viewer_url_settings'
+require 'tca_client/models/simple_submission_response'
+require 'tca_client/models/submission'
+require 'tca_client/models/submission_base'
+require 'tca_client/models/submission_base_metadata'
+require 'tca_client/models/submission_size_error'
+require 'tca_client/models/success_message'
+require 'tca_client/models/users'
+require 'tca_client/models/viewer_permissions'
+require 'tca_client/models/webhook'
+require 'tca_client/models/webhook_base'
+require 'tca_client/models/webhook_path_request'
+require 'tca_client/models/webhook_with_secret'
+
+# APIs
+require 'tca_client/api/eula_api'
+require 'tca_client/api/features_api'
+require 'tca_client/api/groups_api'
+require 'tca_client/api/index_api'
+require 'tca_client/api/similarity_api'
+require 'tca_client/api/submission_api'
+require 'tca_client/api/webhook_api'
+
+module TCAClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   TCAClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/eula_api_spec.rb

@@ -0,0 +1,90 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TCAClient::EULAApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'EULAApi' do
+  before do
+    # run before each test
+    @instance = TCAClient::EULAApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EULAApi' do
+    it 'should create an instance of EULAApi' do
+      expect(@instance).to be_instance_of(TCAClient::EULAApi)
+    end
+  end
+
+  # unit tests for eula_version_id_accept_post
+  # Accepts a particular EULA version on behalf of an external user
+  # @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 version_id The EULA version ID (or `latest`) 
+  # @param [Hash] opts the optional parameters
+  # @return [EulaAcceptListItem]
+  describe 'eula_version_id_accept_post test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for eula_version_id_accept_user_id_get
+  # Queries the acceptences of a particular EULA version on behalf of an external user
+  # @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 version_id The EULA version ID (or `latest`) 
+  # @param user_id The user associated with the EULA status 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<EulaAcceptListItem>]
+  describe 'eula_version_id_accept_user_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for eula_version_id_get
+  # Gets information about a particular EULA version
+  # @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 version_id The EULA version ID (or &#x60;latest&#x60;) 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :lang The desired language of the specified EULA version
+  # @return [EulaVersion]
+  describe 'eula_version_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for eula_version_id_view_get
+  # Gets the text of a particular EULA version
+  # @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 version_id The EULA version ID (or &#x60;latest&#x60;) 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :lang The desired language of the specified EULA version
+  # @return [String]
+  describe 'eula_version_id_view_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/features_api_spec.rb

@@ -0,0 +1,46 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TCAClient::FeaturesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FeaturesApi' do
+  before do
+    # run before each test
+    @instance = TCAClient::FeaturesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FeaturesApi' do
+    it 'should create an instance of FeaturesApi' do
+      expect(@instance).to be_instance_of(TCAClient::FeaturesApi)
+    end
+  end
+
+  # unit tests for features_enabled_get
+  # Get information about what features are allowed by the current license
+  # @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 [FeaturesEnabled]
+  describe 'features_enabled_get test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/groups_api_spec.rb

@@ -0,0 +1,147 @@
+=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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TCAClient::GroupsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'GroupsApi' do
+  before do
+    # run before each test
+    @instance = TCAClient::GroupsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GroupsApi' do
+    it 'should create an instance of GroupsApi' do
+      expect(@instance).to be_instance_of(TCAClient::GroupsApi)
+    end
+  end
+
+  # unit tests for add_group_attachment
+  # Add attachment to a group. will create a group if it does not exist.
+  # @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 group_id group_id
+  # @param [Hash] opts the optional parameters
+  # @return [AddGroupAttachmentResponse]
+  describe 'add_group_attachment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_group_attachment
+  # Hard delete group attachment
+  # @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 group_id group_id
+  # @param attach_id The attachment ID (returned from a successful group attachment request) 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_group_attachment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_group
+  # Get group, group context and group context owners 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 group_id group_id
+  # @param [Hash] opts the optional parameters
+  # @return [AggregateGroup]
+  describe 'get_group test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_group_attachment
+  # Get group attachment
+  # @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 group_id group_id
+  # @param attach_id The attachment ID (returned from a successful group attachment request) 
+  # @param [Hash] opts the optional parameters
+  # @return [GroupAttachmentResponse]
+  describe 'get_group_attachment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_group_attachments
+  # Get all attachments
+  # @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 group_id group_id
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse200]
+  describe 'get_group_attachments test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for groups_group_id_put
+  # upsert group, group context and group context owners 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 group_id group_id
+  # @param [Hash] opts the optional parameters
+  # @return [AggregateGroup]
+  describe 'groups_group_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_group_attachment
+  # Patch a group attachment
+  # @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 group_id group_id
+  # @param attach_id The attachment ID (returned from a successful group attachment request) 
+  # @param [Hash] opts the optional parameters
+  # @return [GroupAttachmentResponse]
+  describe 'update_group_attachment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for upload_group_attachment
+  # Upload Submitted File
+  # @param body the attachment 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_disposition *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"` 
+  # @param group_id The Group ID (required to already exist) 
+  # @param attach_id The attachment ID (returned from a successful group attachment request) 
+  # @param [Hash] opts the optional parameters
+  # @return [SuccessMessage]
+  describe 'upload_group_attachment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end