tca_client 1.0.0

data/lib/tca_client/models/similarity_metadata.rb

@@ -0,0 +1,340 @@
+=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 SimilarityMetadata
+    # Represents the percentage match against all sources
+    attr_accessor :overall_match_percentage
+
+    # Represents the percentage match against internet
+    attr_accessor :internet_match_percentage
+
+    # Represents the percentage match against all publications
+    attr_accessor :publication_match_percentage
+
+    # Represents the percentage match against all submitted works
+    attr_accessor :submitted_works_match_percentage
+
+    attr_accessor :submission_id
+
+    # possible values PENDING, COMPLETE
+    attr_accessor :status
+
+    # Time the report finished generating.  If not set the report has not finished generating
+    attr_accessor :time_generated
+
+    # Time the report was requested
+    attr_accessor :time_requested
+
+    # Top matches
+    attr_accessor :top_matches
+
+    # Largest individual matched word count, 0 if there isn't a match to this submission.
+    attr_accessor :top_source_largest_matched_word_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'overall_match_percentage' => :'overall_match_percentage',
+        :'internet_match_percentage' => :'internet_match_percentage',
+        :'publication_match_percentage' => :'publication_match_percentage',
+        :'submitted_works_match_percentage' => :'submitted_works_match_percentage',
+        :'submission_id' => :'submission_id',
+        :'status' => :'status',
+        :'time_generated' => :'time_generated',
+        :'time_requested' => :'time_requested',
+        :'top_matches' => :'top_matches',
+        :'top_source_largest_matched_word_count' => :'top_source_largest_matched_word_count'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'overall_match_percentage' => :'',
+        :'internet_match_percentage' => :'',
+        :'publication_match_percentage' => :'',
+        :'submitted_works_match_percentage' => :'',
+        :'submission_id' => :'',
+        :'status' => :'',
+        :'time_generated' => :'',
+        :'time_requested' => :'',
+        :'top_matches' => :'',
+        :'top_source_largest_matched_word_count' => :''
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'internet_match_percentage',
+        :'publication_match_percentage',
+        :'submitted_works_match_percentage',
+      ])
+    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::SimilarityMetadata` 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::SimilarityMetadata`. 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
+      }
+
+      # call parent's initialize
+      super(attributes)
+
+      if attributes.key?(:'overall_match_percentage')
+        self.overall_match_percentage = attributes[:'overall_match_percentage']
+      end
+
+      if attributes.key?(:'internet_match_percentage')
+        self.internet_match_percentage = attributes[:'internet_match_percentage']
+      end
+
+      if attributes.key?(:'publication_match_percentage')
+        self.publication_match_percentage = attributes[:'publication_match_percentage']
+      end
+
+      if attributes.key?(:'submitted_works_match_percentage')
+        self.submitted_works_match_percentage = attributes[:'submitted_works_match_percentage']
+      end
+
+      if attributes.key?(:'submission_id')
+        self.submission_id = attributes[:'submission_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'time_generated')
+        self.time_generated = attributes[:'time_generated']
+      end
+
+      if attributes.key?(:'time_requested')
+        self.time_requested = attributes[:'time_requested']
+      end
+
+      if attributes.key?(:'top_matches')
+        if (value = attributes[:'top_matches']).is_a?(Array)
+          self.top_matches = value
+        end
+      end
+
+      if attributes.key?(:'top_source_largest_matched_word_count')
+        self.top_source_largest_matched_word_count = attributes[:'top_source_largest_matched_word_count']
+      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 = super
+      if @overall_match_percentage.nil?
+        invalid_properties.push('invalid value for "overall_match_percentage", overall_match_percentage cannot be nil.')
+      end
+
+      if @submission_id.nil?
+        invalid_properties.push('invalid value for "submission_id", submission_id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @time_generated.nil?
+        invalid_properties.push('invalid value for "time_generated", time_generated cannot be nil.')
+      end
+
+      if @time_requested.nil?
+        invalid_properties.push('invalid value for "time_requested", time_requested cannot be nil.')
+      end
+
+      if @top_matches.nil?
+        invalid_properties.push('invalid value for "top_matches", top_matches cannot be nil.')
+      end
+
+      if @top_source_largest_matched_word_count.nil?
+        invalid_properties.push('invalid value for "top_source_largest_matched_word_count", top_source_largest_matched_word_count 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 @overall_match_percentage.nil?
+      return false if @submission_id.nil?
+      return false if @status.nil?
+      return false if @time_generated.nil?
+      return false if @time_requested.nil?
+      return false if @top_matches.nil?
+      return false if @top_source_largest_matched_word_count.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 &&
+          overall_match_percentage == o.overall_match_percentage &&
+          internet_match_percentage == o.internet_match_percentage &&
+          publication_match_percentage == o.publication_match_percentage &&
+          submitted_works_match_percentage == o.submitted_works_match_percentage &&
+          submission_id == o.submission_id &&
+          status == o.status &&
+          time_generated == o.time_generated &&
+          time_requested == o.time_requested &&
+          top_matches == o.top_matches &&
+          top_source_largest_matched_word_count == o.top_source_largest_matched_word_count && super(o)
+    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
+      [overall_match_percentage, internet_match_percentage, publication_match_percentage, submitted_works_match_percentage, submission_id, status, time_generated, time_requested, top_matches, top_source_largest_matched_word_count].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)
+      super(attributes)
+      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 = super
+      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/models/similarity_metadata_top_matches.rb

@@ -0,0 +1,267 @@
+=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 SimilarityMetadataTopMatches
+    # Source name
+    attr_accessor :name
+
+    # Match percentage
+    attr_accessor :percentage
+
+    # Matching submission id
+    attr_accessor :submission_id
+
+    # Matching submission source type (INTERNET, PUBLICATION, SUBMITTED_WORK)
+    attr_accessor :source_type
+
+    # number of matching words
+    attr_accessor :matched_word_count_total
+
+    # date match was submitted
+    attr_accessor :submitted_date
+
+    # intitution name for matched SUBMITTED_WORK types
+    attr_accessor :institution_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'percentage' => :'percentage',
+        :'submission_id' => :'submission_id',
+        :'source_type' => :'source_type',
+        :'matched_word_count_total' => :'matched_word_count_total',
+        :'submitted_date' => :'submitted_date',
+        :'institution_name' => :'institution_name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'Object',
+        :'percentage' => :'Object',
+        :'submission_id' => :'Object',
+        :'source_type' => :'Object',
+        :'matched_word_count_total' => :'Object',
+        :'submitted_date' => :'Object',
+        :'institution_name' => :'Object'
+      }
+    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::SimilarityMetadataTopMatches` 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::SimilarityMetadataTopMatches`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'percentage')
+        self.percentage = attributes[:'percentage']
+      end
+
+      if attributes.key?(:'submission_id')
+        self.submission_id = attributes[:'submission_id']
+      end
+
+      if attributes.key?(:'source_type')
+        self.source_type = attributes[:'source_type']
+      end
+
+      if attributes.key?(:'matched_word_count_total')
+        self.matched_word_count_total = attributes[:'matched_word_count_total']
+      end
+
+      if attributes.key?(:'submitted_date')
+        self.submitted_date = attributes[:'submitted_date']
+      end
+
+      if attributes.key?(:'institution_name')
+        self.institution_name = attributes[:'institution_name']
+      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
+      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?
+      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 &&
+          name == o.name &&
+          percentage == o.percentage &&
+          submission_id == o.submission_id &&
+          source_type == o.source_type &&
+          matched_word_count_total == o.matched_word_count_total &&
+          submitted_date == o.submitted_date &&
+          institution_name == o.institution_name
+    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
+      [name, percentage, submission_id, source_type, matched_word_count_total, submitted_date, institution_name].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